Class ListComputeHostsRequest

Inheritance

object

ListComputeHostsRequest

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 ListComputeHostsRequest : IOciRequest

Examples

Click here to see an example of how to use ListComputeHosts 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

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

ComputeHostGroupId

Declaration

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

Property Value

Type	Description
string	The OCID of the compute host group.

ComputeHostHealth

Declaration

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

Property Value

Type	Description
string	A filter to return only ComputeHostSummary resources that match the given Compute Host health State OCID exactly.

ComputeHostInSubtree

Declaration

[HttpConverter(TargetEnum.Query, "computeHostInSubtree")]
public bool? ComputeHostInSubtree { get; set; }

Property Value

Type	Description
bool?	When set to true, all the compartments in the tenancy are traversed and the hosts in the specified tenancy and its compartments are fetched. Default is false.

ComputeHostLifecycleState

Declaration

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

Property Value

Type	Description
string	A filter to return only ComputeHostSummary resources that match the given Compute Host lifecycle State OCID exactly.

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.

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

NetworkResourceId

Declaration

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

Property Value

Type	Description
string	The OCID of the compute host network resoruce. Customer-unique HPC island ID Customer-unique network block ID Customer-unique local block ID

Type

Description

string

The OCID of the compute host network resoruce.

Customer-unique HPC island ID
Customer-unique network block ID
Customer-unique local block ID

OpcRequestId

Declaration

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

Property Value

Type	Description
string	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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 ListComputeHostsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type Description

Type	Description
ListComputeHostsRequest.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.

ListComputeHostsRequest.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 ListComputeHostsRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

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

Implements

IOciRequest