Class ListInstancesRequest

Inheritance

object

ListInstancesRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CoreService.Requests

Assembly: OCI.DotNetSDK.Core.dll

Syntax

public class ListInstancesRequest : IOciRequest

Examples

Click here to see an example of how to use ListInstances request.

Properties

AvailabilityDomain

Declaration

[HttpConverter(TargetEnum.Query, "availabilityDomain")]
public string AvailabilityDomain { get; set; }

Property Value

Type	Description
string	The name of the availability domain. Example: Uocm:PHX-AD-1

CapacityReservationId

Declaration

[HttpConverter(TargetEnum.Query, "capacityReservationId")]
public string CapacityReservationId { get; set; }

Property Value

Type	Description
string	The OCID of the compute capacity reservation.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

ComputeClusterId

Declaration

[HttpConverter(TargetEnum.Query, "computeClusterId")]
public string ComputeClusterId { get; set; }

Property Value

Type	Description
string	The OCID of the compute cluster. A compute cluster is a remote direct memory access (RDMA) network group.

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the given display name exactly.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public Instance.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Instance.LifecycleStateEnum?	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see List Pagination.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListInstancesRequest.SortByEnum? SortBy { get; set; }

Property Value

Type Description

Type	Description
ListInstancesRequest.SortByEnum?	The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

ListInstancesRequest.SortByEnum?

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListInstancesRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListInstancesRequest.SortOrderEnum?	The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.

Implements

IOciRequest