Querying a Host Cluster (Recommended)
Function
This API is used to query details about a host cluster by ID.
Calling Method
For details, see Calling APIs.
URI
GET /v1/resources/host-groups/{group_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
status |
String |
Parameter description: Request success or failure state. Value range:
|
result |
HostClusterInfoDetailDetail object |
Parameter description: Host cluster information. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
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:
|
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:
|
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 |
Parameter |
Type |
Description |
---|---|---|
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. |
Parameter |
Type |
Description |
---|---|---|
can_view |
Boolean |
Parameter description: Whether a user has the view permission. Value range:
|
can_edit |
Boolean |
Parameter description: Whether a user has the edit permission. Value range:
|
can_delete |
Boolean |
Parameter description: Whether a user has the delete permission. Value range:
|
can_add_host |
Boolean |
Parameter description: Whether a user has the permission to add hosts Value range:
|
can_manage |
Boolean |
Parameter description: Whether a user has permission to manage the host cluster permission matrix Value range:
|
can_copy |
Boolean |
Parameter description: Whether the user has permission to clone hosts. Value range:
|
Example Requests
https://{endpoint}/v1/resources/host-groups/ab7647b0863c4e969c8949d38d591339
Example Responses
Status code: 200
OK: The request is successful.
{ "status" : "success", "result" : { "id" : "ab7647b0863c4e969c8949d38d591339", "name" : "test", "description" : "11122211", "os" : "linux", "created_by" : { "user_id" : "6baa7454109d47c192f22078fe6cda20", "user_name" : "devcloud_devcloud_l00490255_01" }, "permission" : { "can_view" : true, "can_edit" : true, "can_delete" : true, "can_add_host" : true, "can_manage" : true, "can_copy" : true }, "is_proxy_mode" : 0, "slave_cluster_id" : "", "nick_name" : "A/B Side Account", "created_time" : "2021-04-01 17:05:53", "updated_time" : "2021-04-21 14:29:14" } }
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsdeploy.v2.region.CodeArtsDeployRegion; import com.huaweicloud.sdk.codeartsdeploy.v2.*; import com.huaweicloud.sdk.codeartsdeploy.v2.model.*; public class ShowHostClusterDetailSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>")) .build(); ShowHostClusterDetailRequest request = new ShowHostClusterDetailRequest(); request.withGroupId("{group_id}"); try { ShowHostClusterDetailResponse response = client.showHostClusterDetail(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsdeploy.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsDeployClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsDeployRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowHostClusterDetailRequest() request.group_id = "{group_id}" response = client.show_host_cluster_detail(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsdeploy.NewCodeArtsDeployClient( codeartsdeploy.CodeArtsDeployClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowHostClusterDetailRequest{} request.GroupId = "{group_id}" response, err := client.ShowHostClusterDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK: The request is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot