查看終端節點列表
更新時間 2023-07-20 11:03:37
最近更新時間: 2023-07-20 11:03:37
分享文章
接口功能介紹
查看終端節點列表
接口約束
無。
URI
GET /v4/vpce/list-endpoint
請求參數
Query 參數
| 參數 | 參數類型 | 是否必填 | 說明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 資源池ID | 81f7728662dd11ec810800155d307d5b |
| page | Integer | 否 | 分頁參數, 默認 1 | 1 |
| pageNo | Integer | 否 | 列表的頁碼，默認值為 1, 推薦使用該字段, page 后續會廢棄 | 1 |
| pageSize | Integer | 否 | 每頁數據量大小, 默認 10 | 10 |
| endpointName | String | 否 | 終端節點名，該字段為精確匹配, 與 endpointID 是或的條件進行查詢 | test |
| queryContent | String | 否 | 支持對終端節點名進行模糊匹配, 與 endpointName 和 endpointID 是且條件進行查詢 | tes |
| endpointID | String | 否 | 終端節點 ID | a2009322-41db-466d-bd32-01ff51bff327 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗） | 800 |
| message | String | statusCode為900時的錯誤信息; statusCode為800時為success, 英文 | success |
| description | String | statusCode為900時的錯誤信息; statusCode為800時為成功, 中文 | 成功 |
| errorCode | String | statusCode為900時為業務細分錯誤碼，三段式：product.module.code; statusCode為800時為SUCCESS | SUCCESS |
| totalCount | Integer | 總條數 | 1 |
| totalPage | Integer | 總頁數 | 1 |
| currentCount | Integer | 總頁數 | 1 |
| returnObj | Array of Objects | 接口業務數據 | 見下表 |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| endpoints | Array of Objects | 終端節點列表數據 | 見下表 |
表 endpoints
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| ID | String | 終端節點ID | a2009322-41db-466d-bd32-01ff51bff327 |
| endpointServiceID | String | 終端節點服務ID | fab93dbd-84ba-4b07-a55d-c6f5d5789b27 |
| type | String | 接口還是反向，interface:接口，reverse:反向 | interface |
| name | String | 終端節點名稱 | endpoint name |
| vpcID | String | 所屬的專有網絡id | vpc-xxxx |
| vpcAddress | String | 私網地址 | 192.168.1.1 |
| whitelist | String | 白名單 | 10.150.0.0/24,10.150.0.0/25 |
| status | Integer | endpoint狀態, 1 表示已鏈接，2 表示未鏈接 | 1 |
| description | String | 描述 | null |
| endpointObj | Object | 后端節點信息，可能為 null | null |
| createdTime | String | 創建時間 | 2022-07-07T09:29:55Z |
| updatedTime | String | 更新時間 | 2022-10-12T08:15:57Z |
表 endpointObj
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| subnetID | String | 子網id | subnet-whm7dbxzki |
| portID | String | 端口id | port-hgoj5cy8d6 |
| ip | String | 私網地址 | 192.168.1.1 |
| enableDns | Integer | 是否開啟 dns | 0 |
| dnsNames | String of Array | dns名稱列表 |
請求示例
GET /v4/vpce/list-endpoint?regionID=81f7728662dd11ec810800155d307d5b
請求體body
響應示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": {
"endpoints": [
{
"ID": "a2009322-41db-466d-bd32-01ff51bff327",
"endpointServiceID": "fab93dbd-84ba-4b07-a55d-c6f5d5789b27",
"type": "interface",
"name": "test",
"vpcID": "vpc-bxlui8nvd9",
"vpcAddress": "192.168.20.11",
"whitelist": "10.150.0.0/24,10.150.0.0/25",
"status": 1,
"description": null,
"endpointObj": {
"subnetID": "subnet-whm7dbxzki",
"portID": "port-hgoj5cy8d6",
"ip": "192.168.20.11",
"enableDns": 0,
"dnsNames": [
""
]
},
"createdTime": "2022-07-07T09:29:55Z",
"updatedTime": "2022-10-12T08:15:57Z"
},
{
"ID": "9f7d0009-fc2c-4312-8d98-0d1fe0316430",
"endpointServiceID": "544a83d3-f221-4f72-acc9-70228ed51d13",
"type": "interface",
"name": "test",
"vpcID": "vpc-bxlui8nvd9",
"vpcAddress": "192.168.20.16",
"whitelist": "10.150.0.0/24,10.150.1.0/24",
"status": 1,
"description": null,
"endpointObj": {
"subnetID": "subnet-whm7dbxzki",
"portID": "port-0fxxwzt03j",
"ip": "192.168.20.16",
"enableDns": 0,
"dnsNames": [
""
]
},
"createdTime": "2022-07-05T09:05:25Z",
"updatedTime": "2022-10-13T05:53:15Z"
}
]
},
"currentCount": 2,
"totalCount": 11,
"totalPage": 6
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
請參考 錯誤碼說明。
