更新时间:2023-08-18 GMT+08:00
分享

查询终端节点列表

功能介绍

查询终端节点列表,单次最多查询100个,只支持云端管理实例使用且只返回创建成功的终端节点

URI

GET /v2/{project_id}/huaweicloudchain/instances/{instance_id}/endpoints

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:32

最大长度:32

instance_id

String

实例ID

最小长度:36

最大长度:36

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

分页查询起始位置

最小值:0

limit

Integer

每页返回的条目数量

最小值:1

最大值:100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token

最小长度:1

最大长度:65535

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

终端节点总数

最小值:0

最大值:100

endpoints

Array of EndpointInfo objects

终端节点列表

数组长度:0 - 100

表5 EndpointInfo

参数

参数类型

描述

id

String

终端节点ID

name

String

终端节点名称

ip

String

终端节点IP

状态码: 400

表6 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度:3

最大长度:3

error_code

String

错误码

最小长度:12

最大长度:12

error_msg

String

错误信息

最小长度:1

最大长度:65535

message

String

错误详细信息

最小长度:1

最大长度:65535

状态码: 401

表7 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度:3

最大长度:3

error_code

String

错误码

最小长度:12

最大长度:12

error_msg

String

错误信息

最小长度:1

最大长度:65535

message

String

错误详细信息

最小长度:1

最大长度:65535

状态码: 500

表8 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度:3

最大长度:3

error_code

String

错误码

最小长度:12

最大长度:12

error_msg

String

错误信息

最小长度:1

最大长度:65535

message

String

错误详细信息

最小长度:1

最大长度:65535

请求示例

响应示例

状态码: 200

请求成功

{
  "count" : 1,
  "endpoints" : [ {
    "id" : "ec674773-2626-47df-b8c8-38e39c6ddeb8",
    "name" : "vpc-bcs-yyno.subnet-bcs-yjei.ec674773",
    "ip" : "x.x.x.x"
  } ]
}

状态码

状态码

描述

200

请求成功

400

请求参数校验不通过

401

鉴权失败

500

服务内部执行错误

分享:

    相关文档

    相关产品