終端節點服務連接查詢
更新時間 2023-09-19 14:18:53
最近更新時間: 2023-09-19 14:18:53
分享文章
接口功能介紹
終端節點服務連接查詢
接口約束
無
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 | 表示請求成功。 |
錯誤碼
請參考 錯誤碼說明。
