查询分片信息
功能介绍
查询Redis 4.0及以上版本实例的分片和副本信息,单机实例不支持。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instance/{instance_id}/groups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
group_list |
Array of InstanceGroupListInfo objects |
分片列表。 |
group_count |
Integer |
实例分片总数。 |
参数 |
参数类型 |
描述 |
---|---|---|
group_id |
String |
分片ID。 |
group_name |
String |
分片名称。 |
replication_list |
Array of InstanceReplicationListInfo objects |
每个分片包含的副本列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
replication_role |
String |
副本角色,取值有:
|
replication_ip |
String |
副本IP。 |
is_replication |
Boolean |
是否是新加副本。 |
replication_id |
String |
副本ID。 |
node_id |
String |
节点ID。 |
status |
String |
副本状态。 |
az_code |
String |
副本所在的可用区。 |
dimensions |
Array of InstanceReplicationDimensionsInfo objects |
副本对应的监控指标维度信息。可用于调用云监控服务的查询监控数据指标相关接口
|
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 |
请求示例
GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups
响应示例
状态码: 200
查询分片和副本信息成功。
{ "group_list" : [ { "group_id" : "35e1bed6-7de5-4898-9eb2-c362c783df15", "group_name" : "group-0", "replication_list" : [ { "az_code" : "region01", "is_replication" : false, "node_id" : "8abfa7aa73291f15017329e1cda0002d", "replication_id" : "dfbd3f84-08bc-42f0-b538-01d03e6dc178", "replication_ip" : "192.168.76.25", "replication_role" : "master", "status" : "Active", "dimensions" : [ { "name" : "dcs_instance_id", "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" }, { "name" : "dcs_cluster_redis_node", "value" : "8263dc69629c5b2d840e9816fa9c6200" } ] }, { "az_code" : "region01", "is_replication" : false, "node_id" : "8abfa7aa73291f15017329e1cdb0002e", "replication_id" : "63d4c880-7050-464f-ab19-c8a297474d7d", "replication_ip" : "192.168.78.207", "replication_role" : "slave", "status" : "Active", "dimensions" : [ { "name" : "dcs_instance_id", "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" }, { "name" : "dcs_cluster_redis_node", "value" : "8263dc69629c5b2d840e9816fa9c6201" } ] } ] }, { "group_id" : "579a281f-6e63-4822-b0c7-e45c44b7c807", "group_name" : "group-1", "replication_list" : [ { "az_code" : "region01", "is_replication" : false, "node_id" : "8abfa7aa73291f15017329e1cdbd002f", "replication_id" : "6284c192-48d1-462b-8fd9-45dad067c1a2", "replication_ip" : "192.168.73.164", "replication_role" : "master", "status" : "Active", "dimensions" : [ { "name" : "dcs_instance_id", "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" }, { "name" : "dcs_cluster_redis_node", "value" : "8263dc69629c5b2d840e9816fa9c6202" } ] }, { "az_code" : "region01", "is_replication" : false, "node_id" : "8abfa7aa73291f15017329e1cdc80030", "replication_id" : "b927de3b-42f3-45b5-b0e4-8547f0ef6727", "replication_ip" : "192.168.77.172", "replication_role" : "slave", "status" : "Active", "dimensions" : [ { "name" : "dcs_instance_id", "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" }, { "name" : "dcs_cluster_redis_node", "value" : "8263dc69629c5b2d840e9816fa9c6203" } ] } ] }, { "group_id" : "c17305c6-6651-42d9-86bf-5a6087076eb7", "group_name" : "group-2", "replication_list" : [ { "az_code" : "region01", "is_replication" : false, "node_id" : "8abfa7aa73291f15017329e1cdd90031", "replication_id" : "caa6636d-a5c1-43b8-990a-3dc134da4522", "replication_ip" : "192.168.76.143", "replication_role" : "master", "status" : "Active", "dimensions" : [ { "name" : "dcs_instance_id", "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" }, { "name" : "dcs_cluster_redis_node", "value" : "8263dc69629c5b2d840e9816fa9c6204" } ] }, { "az_code" : "region01", "is_replication" : false, "node_id" : "8abfa7aa73291f15017329e1cde50032", "replication_id" : "4f46790d-a0b0-4a1b-aa02-1c554fccf62d", "replication_ip" : "192.168.72.66", "replication_role" : "slave", "status" : "Active", "dimensions" : [ { "name" : "dcs_instance_id", "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" }, { "name" : "dcs_cluster_redis_node", "value" : "8263dc69629c5b2d840e9816fa9c6205" } ] } ] } ], "group_count" : 3 }
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 48 |
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.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class ListGroupReplicationInfoSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); ListGroupReplicationInfoRequest request = new ListGroupReplicationInfoRequest(); request.withInstanceId("{instance_id}"); try { ListGroupReplicationInfoResponse response = client.listGroupReplicationInfo(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 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListGroupReplicationInfoRequest() request.instance_id = "{instance_id}" response = client.list_group_replication_info(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListGroupReplicationInfoRequest{} request.InstanceId = "{instance_id}" response, err := client.ListGroupReplicationInfo(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询分片和副本信息成功。 |
500 |
内部服务错误。 |
400 |
非法请求。 |
错误码
请参见错误码。