查看終端節點詳情
更新時間 2023-07-06 09:29:19
最近更新時間: 2023-07-06 09:29:19
分享文章
接口功能介紹
查看終端節點詳情
接口約束
無
URI
GET /v4/vpce/show-endpoint
請求參數
Query 參數
| 參數 | 參數類型 | 是否必填 | 說明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 資源池ID | 81f7728662dd11ec810800155d307d5b |
| endpointID | String | 是 | 終端節點 ID | endpoint-xxx |
響應參數
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| 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 |
| returnObj | Object | 接口業務數據 | 見下表 |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| endpoint | Object | 終端節點列表數據 | 見下表 |
表 endpoint
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| 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 | Array of String | dns名稱列表 |
請求示例
GET /v4/vpce/show-endpoint?regionID=81f7728662dd11ec810800155d307d5b&endpointID=endpoint-tmncs8h97b
請求體Body
無
響應示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"endpoint": {
"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"
}
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
請參考 錯誤碼說明。
