Updated on 2025-01-14 GMT+08:00

Obtaining the Replica Status

Function

This API is used to obtain the status of a shard replica.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instance/{instance_id}/groups/{group_id}/group-nodes-state

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

group_id

Yes

String

Shard ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

[items]

Array of InstanceReplicationListInfo objects

Replica list.

Table 3 InstanceReplicationListInfo

Parameter

Type

Description

replication_role

String

Parameter description:

Replica role.

Value range:

  • master: master node

  • slave: standby node.

replication_ip

String

Parameter description:

Replica IP address.

Value range:

N/A.

is_replication

Boolean

Parameter description:

Whether the replica is newly added.

Value range:

  • true

  • false

replication_id

String

Parameter description:

Replica ID.

Value range:

N/A.

node_id

String

Parameter description:

Node ID.

Value range:

N/A.

status

String

Parameter description:

Replica status.

Value range:

N/A.

az_code

String

Parameter description:

AZ where the replica is in.

Value range:

N/A.

dimensions

Array of InstanceReplicationDimensionsInfo objects

Parameter description:

Monitoring metric dimension of the replica used to call the Cloud Eye API for querying monitoring metrics.

  • Replica monitoring is multi-dimensional. The returned array contains information about two dimensions. When querying monitoring data from Cloud Eye, transfer parameters of multiple dimensions to obtain the metric data.

  • The first dimension is the primary dimension of the replica. The dimension name is dcs_instance_id, and the dimension value corresponds to the ID of the instance to which the replica belongs.

  • The name of the second dimension is dcs_cluster_redis_node, and the dimension value is the ID of the monitored object of the replica, which is different from the replica ID or node ID.

Value range:

N/A.

Table 4 InstanceReplicationDimensionsInfo

Parameter

Type

Description

name

String

Parameter description:

Monitoring dimension name.

Value range:

  • dcs_instance_id: instance dimension

  • dcs_cluster_redis_node: data node dimension

value

String

Parameter description:

Dimension value.

Value range:

N/A.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups/{group_id}/group-nodes-state

Example Responses

Status code: 200

Details of shards and replicas queried successfully.

[ {
  "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"
  } ]
} ]

SDK Sample Code

The SDK sample code is as follows.

 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
49
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 ShowReplicationStatesSolution {

    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();
        ShowReplicationStatesRequest request = new ShowReplicationStatesRequest();
        request.withInstanceId("{instance_id}");
        request.withGroupId("{group_id}");
        try {
            ShowReplicationStatesResponse response = client.showReplicationStates(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
33
# 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 = ShowReplicationStatesRequest()
        request.instance_id = "{instance_id}"
        request.group_id = "{group_id}"
        response = client.show_replication_states(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"
    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.ShowReplicationStatesRequest{}
	request.InstanceId = "{instance_id}"
	request.GroupId = "{group_id}"
	response, err := client.ShowReplicationStates(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

Details of shards and replicas queried successfully.

500

Internal service error.

400

Invalid request.

Error Codes

See Error Codes.