查询逻辑集群列表
功能介绍
该接口用于查询逻辑集群列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法,请参见获取项目ID。 |
cluster_id |
是 |
String |
集群ID。获取方法,请参见获取集群ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
分页查询,偏移。 |
limit |
否 |
Integer |
分页查询,每页显示的条目数量。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
logical_clusters |
Array of LogicalClusterInfo objects |
逻辑集群列表信息。 |
count |
Integer |
逻辑集群总数量。 |
add_enable |
Boolean |
是否可以添加逻辑集群。如果集群内有其他运维操作,该值为false,此时不能添加逻辑集群。true表示可以添加逻辑集群。 |
参数 |
参数类型 |
描述 |
---|---|---|
logical_cluster_id |
String |
逻辑集群ID。 |
logical_cluster_name |
String |
逻辑集群名称。 |
cluster_rings |
Array of ClusterRing objects |
逻辑集群主机信息。 |
status |
String |
逻辑集群状态。状态如下所示:
|
first_logical_cluster |
Boolean |
是否为第一个逻辑集群。第一个创建或者转换的逻辑集群不能删除,因为其中包含了一些系统视图。 |
action_info |
ActionInfo object |
逻辑集群操作信息。 |
edit_enable |
Boolean |
是否允许编辑。 |
restart_enable |
Boolean |
是否允许重启。 |
delete_enable |
Boolean |
是否允许删除。 |
add_to_elastic |
Boolean |
是否允许弹性伸缩。 |
mode |
String |
逻辑集群模式。 |
waiting_for_killing |
Integer |
等待被销毁。 |
cluster_type |
String |
集群类型。 |
请求示例
GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/logical-clusters
响应示例
状态码: 200
查询集群列表成功。
{ "logical_clusters" : [ { "logical_cluster_id" : "fa9d69a0-3814-4fb9-98df-d9f4f5ef53ca", "logical_cluster_name" : "elastic_group", "cluster_rings" : [ { "ring_hosts" : [ { "host_name" : "host-172-16-20-246", "back_ip" : "172.16.73.90", "cpu_cores" : 8, "memory" : 32.0, "disk_size" : 800.0 }, { "host_name" : "host-172-16-4-26", "back_ip" : "172.16.123.5", "cpu_cores" : 8, "memory" : 32.0, "disk_size" : 800.0 }, { "host_name" : "host-172-16-43-90", "back_ip" : "172.16.92.175", "cpu_cores" : 8, "memory" : 32.0, "disk_size" : 800.0 } ] } ], "status" : "Normal", "first_logical_cluster" : false, "action_info" : { "progress" : 100, "completed" : true, "result" : "success", "logs" : null, "action_name" : "Grow", "start_time" : "2023-06-05 01:58:43", "end_time" : "2023-06-05 02:11:50" }, "edit_enable" : true, "restart_enable" : true, "delete_enable" : false, "add_to_elastic" : true, "mode" : null, "cluster_type" : null } ], "count" : 1, "add_enable" : true }
SDK代码示例
SDK代码示例如下。
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 47 |
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.dws.v2.region.DwsRegion; import com.huaweicloud.sdk.dws.v2.*; import com.huaweicloud.sdk.dws.v2.model.*; public class ListLogicalClustersSolution { 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); DwsClient client = DwsClient.newBuilder() .withCredential(auth) .withRegion(DwsRegion.valueOf("<YOUR REGION>")) .build(); ListLogicalClustersRequest request = new ListLogicalClustersRequest(); request.withOffset(<offset>); request.withLimit(<limit>); try { ListLogicalClustersResponse response = client.listLogicalClusters(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()); } } } |
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 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdws.v2.region.dws_region import DwsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdws.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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = DwsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DwsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListLogicalClustersRequest() request.offset = <offset> request.limit = <limit> response = client.list_logical_clusters(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/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 := dws.NewDwsClient( dws.DwsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListLogicalClustersRequest{} offsetRequest:= int32(<offset>) request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest response, err := client.ListLogicalClusters(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询集群列表成功。 |
400 |
请求错误。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误。 |
503 |
服务不可用。 |