查询主机集群 (推荐)
功能介绍
根据主机集群id查询主机集群详情。
调用方法
请参见如何调用API。
URI
GET /v1/resources/host-groups/{group_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
是 |
String |
参数解释: 主机集群id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释: 请求成功、失败状态。 取值范围:
|
result |
HostClusterInfoDetailDetail object |
参数解释: 主机集群信息。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 主机集群id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
name |
String |
参数解释: 主机集群名称。 取值范围: 只能由中文字符、英文字母、数字及"-"、"_"、"."组成,且长度为[3-128]个字符。 |
os |
String |
参数解释: 主机集群的操作系统类型。 取值范围:
|
slave_cluster_id |
String |
参数解释: 自托管资源池id。 取值范围: 只能由英文字母、数字组成,且长度为[1-32]个字符。 |
created_by |
UserInfo object |
参数解释: 用户信息,包含用户id、用户名等。 约束限制: 不涉及。 |
description |
String |
参数解释: 主机集群描述信息。 取值范围: 字符串,长度为[0-500]个字符。 |
permission |
PermissionClusterDetail object |
参数解释: 主机集群权限信息。 约束限制: 不涉及。 |
nick_name |
String |
参数解释: 用户昵称。 取值范围: 字符串,长度为[1-30]个字符。 |
is_proxy_mode |
Integer |
参数解释: 是否为代理模式主机集群。 取值范围:
|
created_time |
String |
参数解释: 主机集群创建时间,格式为yyyy-MM-dd HH:mm:ss。例如:'2021-04-01 17:05:53'。 取值范围: 不涉及。 |
updated_time |
String |
参数解释: 主机集群更新时间,格式为yyyy-MM-dd HH:mm:ss。例如:'2021-04-01 17:05:53'。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
user_id |
String |
参数解释: 用户id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
user_name |
String |
参数解释: 用户名。 取值范围: 只能由英文字母、数字组成,且长度为[1-255]个字符。 |
参数 |
参数类型 |
描述 |
---|---|---|
can_view |
Boolean |
参数解释: 是否有查看权限。 取值范围:
|
can_edit |
Boolean |
参数解释: 是否有编辑权限。 取值范围:
|
can_delete |
Boolean |
参数解释: 是否有删除权限。 取值范围:
|
can_add_host |
Boolean |
参数解释: 是否有添加主机权限。 取值范围:
|
can_manage |
Boolean |
参数解释: 是否有管理主机集群权限矩阵的权限。 取值范围:
|
can_copy |
Boolean |
参数解释: 是否有复制主机的权限。 取值范围:
|
请求示例
https://{endpoint}/v1/resources/host-groups/ab7647b0863c4e969c8949d38d591339
响应示例
状态码: 200
OK 请求响应成功
{ "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" : "AB边账号", "created_time" : "2021-04-01 17:05:53", "updated_time" : "2021-04-21 14:29:14" } }
SDK代码示例
SDK代码示例如下。
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) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功 |
错误码
请参见错误码。