查询离线全量key分析任务节点信息 - ListOfflineKeyAnalysisNodes

功能介绍

查询离线全量key分析任务节点信息，不支持3.0实例。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
instance_id	是	String	参数解释：实例ID。可通过DCS控制台进入实例详情界面查看。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
task_id	是	String	参数解释：任务ID。可通过离线全量Key分析详情界面查看。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
nodes	Array of AnalysisNode objects	离线key分析节点详情

表3 AnalysisNode
参数	参数类型	描述
id	String	节点ID
name	String	节点名称
group_name	String	group名称
node_ipv6	String	ipv6地址

状态码：400

表4 响应Body参数
参数	参数类型	描述
error_msg	String	参数解释：错误信息。取值范围：不涉及。
error_code	String	参数解释：错误码。取值范围：请参见错误码。
error_ext_msg	String	参数解释：扩展错误信息（暂未使用，不返回）。取值范围：不涉及。

状态码：401

表5 响应Body参数
参数	参数类型	描述
error_msg	String	参数解释：错误信息。取值范围：不涉及。
error_code	String	参数解释：错误码。取值范围：请参见错误码。
error_ext_msg	String	参数解释：扩展错误信息（暂未使用，不返回）。取值范围：不涉及。

状态码：403

表6 响应Body参数
参数	参数类型	描述
error_msg	String	参数解释：错误信息。取值范围：不涉及。
error_code	String	参数解释：错误码。取值范围：请参见错误码。
error_ext_msg	String	参数解释：扩展错误信息（暂未使用，不返回）。取值范围：不涉及。

状态码：404

表7 响应Body参数
参数	参数类型	描述
error_msg	String	参数解释：错误信息。取值范围：不涉及。
error_code	String	参数解释：错误码。取值范围：请参见错误码。
error_ext_msg	String	参数解释：扩展错误信息（暂未使用，不返回）。取值范围：不涉及。

状态码：500

表8 响应Body参数
参数	参数类型	描述
error_msg	String	参数解释：错误信息。取值范围：不涉及。
error_code	String	参数解释：错误码。取值范围：请参见错误码。
error_ext_msg	String	参数解释：扩展错误信息（暂未使用，不返回）。取值范围：不涉及。

请求示例

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

响应示例

状态码：200

离线全量key分析任务节点信息列表。

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

状态码

状态码	描述
200	离线全量key分析任务节点信息列表。
400	非法请求。
401	认证信息非法。
403	请求被拒绝访问。
404	所请求的资源不存在。
500	内部服务错误。