Querying Node Information of an Offline Key Analysis Task

Function

This API is used to query node information about an offline key analysis task. It is not supported by Redis 3.0 instances.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/{project_id}/instances/{instance_id}/offline/key-analysis/{task_id}/nodes

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. It can be viewed on the instance details page on the DCS console. Constraints N/A Range N/A Default Value N/A
task_id	Yes	String	Definition Task ID. You can view the task ID on the offline key analysis details page. Constraints N/A Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
nodes	Array of AnalysisNode objects	Offline key analysis node details.

**Table 3** AnalysisNode
Parameter	Type	Description
id	String	Node ID.
name	String	Node name.
group_name	String	Group name.
node_ipv6	String	IPv6 address.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Definition: Error message. Range: N/A
error_code	String	Definition: Error code. Range: For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is not returned. Range N/A

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Definition: Error message. Range: N/A
error_code	String	Definition: Error code. Range: For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is not returned. Range N/A

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Definition: Error message. Range: N/A
error_code	String	Definition: Error code. Range: For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is not returned. Range N/A

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Definition: Error message. Range: N/A
error_code	String	Definition: Error code. Range: For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is not returned. Range N/A

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Definition: Error message. Range: N/A
error_code	String	Definition: Error code. Range: For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is not returned. Range N/A

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/offline/key-analysis/{task_id}/nodes

Example Responses

Status code: 200

List of nodes in an offline key analysis task.

{
  "nodes" : [ {
    "id" : "ff808081985e368101985e3bcedb00bb",
    "name" : "(group-0)(replica)192.168.149.153:6379",
    "group_name" : "group-0",
    "node_ipv6" : "192.168.149.153:6379"
  }, {
    "id" : "ff808081985e368101985e3bcedc00bf",
    "name" : "(group-2)(replica)192.168.154.82:6379",
    "group_name" : "group-2",
    "node_ipv6" : "192.168.154.82:6379"
  }, {
    "id" : "ff808081985e368101985e3bcedc00bd",
    "name" : "(group-1)(replica)192.168.182.163:6379",
    "group_name" : "group-1",
    "node_ipv6" : "192.168.182.163:6379"
  } ]
}

Status Codes

Status Code	Description
200	List of nodes in an offline key analysis task.
400	Invalid request.
401	Invalid authentication information.
403	Request denied.
404	The requested resource does not exist.
500	Internal server error.