Class ListVmInstancesRequest

Inheritance

object

ListVmInstancesRequest

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.DataccService.Requests

Assembly: OCI.DotNetSDK.Datacc.dll

Syntax

public class ListVmInstancesRequest : IOciRequest

Examples

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

Properties

BaseServerId

Declaration

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

Property Value

Type	Description
string	The OCID of the Database Infrastructure Server Id.

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. For list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided, it will be validated against the caller's tenant and then treated as tenant scope (compartmentId filtering is not applied).

Remarks

Required

DisplayName

Declaration

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

Property Value

Type	Description
string	A filter to return resources that match the entire display name given. The match is case sensitive.

InfrastructureId

Declaration

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

Property Value

Type	Description
string	The OCID of the Database Infrastructure.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState", CollectionFormatType.Multi)]
public List<VmInstanceLifecycleState> LifecycleState { get; set; }

Property Value

Type	Description
List<VmInstanceLifecycleState>	A filter to return resources that match the specified lifecycle state.

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of items to return in a page.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	The client request identifier.

Page

Declaration

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

Property Value

Type	Description
string	The page token representing the page at which you want to start retrieving results. This token is usually retrieved from a previous list call.

SortBy

Declaration

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

Property Value

Type

Description

ListVmInstancesRequest.SortByEnum?

The field by which you want to sort. You can provide only one type of sort order. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. When listing software images within the same version, using sortBy=buildIdentifier is recommended. buildIdentifier is a monotonically increasing, time-ordered string marker (yyyy-mm-dd-hh:mm:ss) stored with the image.

SortOrder

Declaration

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

Property Value

Type	Description
SortOrder?	The sort order that you want to use, which is either ASC or DESC.

Implements

IOciRequest