接口功能介绍
终端节点服务连接查询
接口约束
无
URI
GET /v4/vpce/show-endpoint-service-connections
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 资源池ID | 81f7728662dd11ec810800155d307d5b |
| endpointServiceID | String | 是 | 终端节点服务id | endpser-9hzaohgug8 |
| page | Integer | 否 | 分页参数 | 1 |
| pageNo | Integer | 否 | 列表的页码，默认值为 1, 推荐使用该字段, page 后续会废弃 | 1 |
| pageSize | Integer | 否 | 每页数据量大小 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| descritption | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| returnObj | Array of Objects | 接口业务数据 | 见下表 |
| totalCount | Integer | 总条数 | 1 |
| totalPage | Integer | 总页数 | 1 |
| currentCount | Integer | 当前页数 | 1 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| endpointID | String | 终端节点ID | endpoint-p8auf4nuui |
| endpointName | String | 终端节点名称 | yacos_test |
| endpointServiceID | String | 终端节点服务ID | endpser-9hzaohgug8 |
| endpointType | String | 接口还反向 | 反向类型 |
| connectionStatus | String | 连接状态 | 未连接 |
| status | String | 状态：UP/DOWN | UP |
| account | String | 账户信息 | 当前账户 |
请求示例
GET /v4/vpce/show-endpoint-service-connections?regionID=81f7728662dd11ec810800155d307d5b&endpointServiceID=endpser-9hzaohgug8
请求体body
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"endpointID": "endpoint-p8auf4nuui",
"endpointName": "yacos_test",
"endpointServiceID": "endpser-9hzaohgug8",
"connectionStatus": "未连接",
"endpointType": "反向类型",
"status": "UP",
"account": "当前账户"
}
],
"currentCount": 1,
"totalCount": 1,
"totalPage": 1
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
