Querying a Host Cluster (Recommended)

group_id

Yes

String

Parameter description:

Host cluster ID.

Constraints:

N/A

Value range:

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

Default value:

N/A

X-Auth-Token

Yes

String

User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

status

String

Parameter description:

Request success or failure status.

Value range:

• success: Request succeeded

• failed: Request failed

result

HostClusterInfoDetailDetail object

Parameter description:

Host cluster information.

Value range:

N/A

id

String

Parameter description:

Host cluster ID.

Value range:

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

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.

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 1-32 characters. Only letters and digits are allowed.

created_by

UserInfo object

Parameter description:

User information, including user ID and username.

Constraints:

N/A

description

String

Parameter description:

Host cluster description.

Value range:

The value is a string of 0 to 500 characters.

permission

PermissionClusterDetail object

Parameter description:

Host cluster permission information.

Constraints:

N/A

nick_name

String

Parameter description:

User nickname.

Value range:

The value is a string of 1 to 30 characters.

is_proxy_mode

Integer

Parameter description:

Whether the host cluster is in the proxy mode.

Value range:

• 0: Non-proxy mode host cluster.

• 1: Proxy mode host cluster.

created_time

String

Parameter description:

Time when a host cluster is created. The value format is yyyy-MM-dd HH:mm:ss. For example, '2021-04-01 17:05:53'.

Value range:

N/A

updated_time

String

Parameter description:

Time when a host cluster is updated. The value format is yyyy-MM-dd HH:mm:ss. For example, '2021-04-01 17:05:53'.

Value range:

N/A

user_id

String

Parameter description:

User ID.

Value range:

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

user_name

String

Parameter description:

Username.

Value range:

The value consists of 1-255 characters. Only letters and digits are allowed.

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.