Querying a Host Cluster List (Recommended)

project_id

Yes

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

Default value:

N/A

name

No

String

Parameter description:

Keyword in the host cluster name.

Constraints:

N/A

Value range:

The value consists of 3-128 characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

Default value:

N/A

os

No

String

Parameter description:

OS of the host cluster.

Constraints:

N/A

Value range:

• Windows: Windows OS.

• Linux: Linux OS.

Default value:

N/A

page_index

No

Integer

Parameter description:

Page number for pagination query.

Constraints:

N/A

Value range:

1-2,147,483,647

Default value:

1

page_size

No

Integer

Parameter description:

Number of items displayed on each page.

Constraints:

N/A

Value range:

1-1,000

Default value:

1,000

sort_field

No

String

Parameter description:

Sorting field query.

Constraints:

N/A

Value range:

• nick_name: Nickname.

• name: Host cluster name.

Default value:

N/A

sort_type

No

String

Parameter description:

Sorting order.

Constraints:

N/A

Value range:

• desc: Descending order.

• asc: Ascending order.

Default value:

desc

is_proxy_mode

No

Integer

Definition

Whether the host cluster is in the agent mode.

Constraints

N/A

Range

• 0: Non-agent-mode host cluster.

• 1: Agent-mode host cluster.

Default value

N/A

slave_cluster_id

No

String

Parameter description:

Transfer default to query host clusters using the official resource pool. Transfer a self-hosted resource pool ID to query host clusters using the self-hosted resource pool.

Constraints:

N/A

Value range:

The value consists of 32 characters. Only letters and digits are allowed. Or default is transferred to query the host clusters using the official resource pool.

Default value:

N/A

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used for.

Constraints:

N/A.

Value range:

String. Max. 20,000 characters.

Default value:

N/A.

status

String

Parameter description:

Request success or failure status.

Value range:

• success: Request succeeded

• failed: Request failed

total

Integer

Parameter description:

Number of host clusters.

Value range:

0-1,000

result

Array of HostClusterInfo objects

Definition:

Host cluster list.

id

String

Parameter description:

Host cluster ID.

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

host_count

Integer

Parameter description:

Number of hosts in a cluster.

Value range:

0-200

name

String

Parameter description:

Host cluster name.

Value range:

The value consists of 3-128 characters. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

project_id

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

os

String

Parameter description:

OS of the host cluster.

Value range:

• Windows: Windows OS.

• Linux: Linux OS.

slave_cluster_id

String

Parameter description:

Self-hosted resource pool ID.

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

description

String

Parameter description:

Host cluster description.

Value range:

The value is a string of 0 to 500 characters.

permission

PermissionClusterDetail object

Parameter description:

Operation permission matrix of the current user on the host cluster.

nick_name

String

Definition:

Nickname of the creator.

Value range:

String. 1 to 30 characters.

env_count

Integer

Parameter description:

Number of environments associated with a host cluster.

Value range:

0-200

is_proxy_mode

Integer

Definition

Whether the host cluster is in the agent mode.

Constraints

N/A

Range

• 0: Non-agent-mode host cluster.

• 1: Agent-mode host cluster.

Default value

N/A

can_view

Boolean

Parameter description:

Whether a user has the view permission.

Value range:

• true: With the view permission

• false: Without the view permission

can_edit

Boolean

Parameter description:

Whether a user has the edit permission.

Value range:

• true: With the edit permission

• false: Without the edit permission

can_delete

Boolean

Parameter description:

Whether a user has the delete permission.

Value range:

• true: With the delete permission

• false: Without the delete permission

can_add_host

Boolean

Parameter description:

Whether a user has the permission to add hosts

Value range:

• true: With the permission to add hosts

• false: Without the permission to add hosts

can_manage

Boolean

Parameter description:

Whether a user has permission to manage the host cluster permission matrix

Value range:

• true: With the permission to manage the host cluster permission matrix

• false: Without the permission to manage the host cluster permission matrix

can_copy

Boolean

Parameter description:

Whether the user has permission to clone hosts.

Value range:

• true: The user has permission to copy hosts.

• false: The user does not have permission to copy hosts.

200

OK: The request is successful.