查詢應用點接入列表
更新時間 2025-01-09 13:52:23
最近更新時間: 2025-01-09 13:52:23
分享文章
接口功能介紹
查詢應用接入點列表
接口約束
無
URI
POST /v1/applicationAccessPointManage/listApplicationAccessPoint
路徑參數
無
Query參數
無
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池id | fecnjniakfkn2314ndekqldedcsadfg |
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| pageNum | 否 | Integer | 當前頁碼 | 1 | |
| pageSize | 否 | Integer | 頁碼大小 | 10 |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | String | 狀態碼 取值范圍:200 成功 | 200 | |
| message | 是 | String | 提示信息 | Success | |
| returnObj | 是 | Object | 返回數據結構體 | {} | result |
| error | 否 | String | 錯誤碼 僅錯誤時返回 格式為{服務編碼}.{錯誤編號} | KMS.0269 |
表 result
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| list | 是 | Array of Objects | 應用接入點列表 | applicationList | |
| totalCount | 是 | Integer | 總數量 | 5 | |
| pageNum | 是 | Integer | 當前頁碼 | 1 | |
| pageSize | 是 | Integer | 頁碼大小 | 10 |
表 applicationList
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| vpcId | 是 | String | vpc id | vpc-r5ka3qk24m | |
| subnetId | 是 | String | 子網id | subnet-6mojt0h30o | |
| endpointId | 是 | String | 終端節點id | 96126272-5262-4b61-bf5c-d66ca3c7a0b3 | |
| url | 是 | String | 接入地址 | ||
| vpcName | 是 | String | vpc名稱 | vpc-cfw-user-test | |
| subnetName | 是 | String | 子網名稱 | subnet-cfw-server | |
| applicationStatus | 是 | String | 接入點狀態 | 1 | |
| applicationId | 是 | String | 接入點id | 12345-89018 | |
| applicationName | 是 | String | 接入點名稱 | test | |
| description | 是 | String | 接入點描述 | aaa |
枚舉參數
參數名 applicationStatus
| 枚舉值 | 類型 | 說明 |
|---|---|---|
| 1 | String | 啟用 |
| 2 | String | 創建中 |
| 0 | String | 凍結 |
| -1 | String | 刪除 |
| -2 | String | 創建失敗 |
請求示例
請求url
//{host}/v1/applicationAccessPointManage/listApplicationAccessPoint請求頭header
{
"regionid": "fecnjniakfkn2314ndekqldedcsadfg"
}請求體body
{
"pageNum": 1,
"pageSize": 10
}響應示例
{
"statusCode": 200,
"message": "獲取vpce列表成功",
"returnObj": {
"pageSize": 10,
"list": [
{
"subnetId": "subnet-6mojt0h30o",
"vpcName": "vpc-cfw-user-test",
"endpointId": "96126272-5262-4b61-bf5c-d66ca3c7a0b3",
"vpcId": "vpc-r5ka3qk24m",
"subnetName": "subnet-cfw-server",
"url": "//192.168.11.8:9091",
"applicationStatus": "1",
"applicationId": "12345-89018",
"applicationName": "test",
"description": "aaa"
}
],
"totalCount": 1,
"pageNum": 1
}
}狀態碼
請參考狀態碼章節
錯誤碼
請參考錯誤碼章節