查看終端節點服務列表
更新時間 2023-07-20 11:03:37
最近更新時間: 2023-07-20 11:03:37
分享文章
接口功能介紹
查看終端節點服務列表
接口約束
無
URI
GET /v4/vpce/list-endpoint-service
請求參數
Query 參數
| 參數 | 參數類型 | 是否必填 | 說明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 資源池ID | 81f7728662dd11ec810800155d307d5b |
| page | Integer | 否 | 分頁參數 | 1 |
| pageNo | Integer | 否 | 列表的頁碼，默認值為 1, 推薦使用該字段, page 后續會廢棄 | 1 |
| pageSize | Integer | 否 | 每頁數據量大小 | 10 |
| id | String | 否 | 節點服務id | endpser-9hzaohgug8 |
| endpointServiceName | String | 否 | 終端節點服務名稱，該字段為精確匹配 | test |
| queryContent | String | 否 | 支持對終端節點服務名稱進行模糊匹配 | tes |
響應參數
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| 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
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| ID | String | 終端節點服務ID | endpser-4bz2ogmq11 |
| name | String | 終端節點服務名稱 | szyy2 |
| vpcID | String | 所屬的專有網絡id | vpc-srsiebllhc |
| description | String | 描述 | |
| type | String | 接口還是反向，interface:接口，reverse:反向 | interface |
| autoConnection | Boolean | 是否自動連接 | true |
| rules | Array of Objects | 接口規則數據 | 見下表 |
| backends | Array of Objects | 后端數據 | 見下表 |
| createdAt | String | 創建時間 | 2022-10-24T01:20:06Z |
| updatedAt | String | 更新時間 | 2022-10-24T01:20:06Z |
表 rule
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| protocol | String | 協議，TCP:TCP協議,UDP:UDP協議 | TCP |
| serverPort | Integer | 服務端口(用于創建backend傳入) | 100 |
| endpointPort | Integer | 節點端口(用于創建rule傳入) | 100 |
表 backend
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| instanceType | String | vm:虛機類型,bm:智能網卡類型,vip:vip類型,lb:負載均衡類型 | lb |
| instanceID | String | 實例id | lb-tfa20qb11w |
| protocolPort | Integer | 端口 | 100 |
| weight | Integer | 權重 | 50 |
請求示例
GET /v4/vpce/list-endpoint-service?regionID=81f7728662dd11ec810800155d307d5b
請求體body
響應示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"ID": "endpser-4bz2ogmq11",
"name": "szyy2",
"vpcID": "vpc-srsiebllhc",
"description": "aaa",
"type": "interface",
"autoConnection": true,
"rules": [
{
"protocol": "TCP",
"serverPort": 100,
"endpointPort": 100,
}
],
"backends": [
{
"instanceType": "lb",
"instanceID": "lb-tfa20qb11w",
"protocolPort": 100,
"weight": 50
}
],
"createdAt": "2022-10-24T01:20:06Z",
"updatedAt": "2022-10-24T01:20:06Z"
}
],
"currentCount": 1,
"totalCount": 1,
"totalPage": 1
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
請參考 錯誤碼說明。
