查詢iaas層安全組列表信息
更新時間 2023-08-29 15:13:47
最近更新時間: 2023-08-29 15:13:47
分享文章
接口功能介紹
調用describeSecurityGroup查詢安全組列表信息。
接口約束
無
URI
GET /v1/extApi/describeSecurityGroup
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 下級對象 | |
|---|---|---|---|---|---|
| spuInstId | 是 | String | 實例ID | 7eb8d17d789047d2892d9f1ec89a20a | |
| pageNow | 否 | Integer | 當前頁 | 不填則默認為1 | |
| pageSize | 否 | Integer | 當前頁數量 | 不填則默認為10 |
請求參數
請求頭header參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 下級對象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 響應碼 取值范圍：800為成功，900為失敗 |
800 | |
| message | 是 | String | 響應信息 | 查詢iaas層安全組列表成功 | |
| returnObj | 是 | Object | 返回對象數組 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 下級對象 | |
|---|---|---|---|---|---|
code |
是 | Integer | 接口調用狀態碼，0為成功，非0為失敗 | 0 | |
| data | 是 | Object | 返回對象 | data |
表data
| 參數 | 是否必填 | 參數類型 | 說明 | 下級對象 | |
|---|---|---|---|---|---|
| lastPage | 是 | Integer | 最后一頁 | 8 | |
| navigatepageNums | 是 | Integer[] | 導航頁碼數 | ||
| startRow | 是 | Object | 當前頁面第一個元素在數據庫中的行號 | returnObj | |
| hasNextPage | 是 | Boolean | 是否有下一頁 | ||
| prePage | 是 | Integer | 前一頁 | ||
| nextPage | 是 | Integer | 下一頁 | ||
| endRow | 是 | Integer | 當前頁面最后一個元素在數據庫中的行號 | ||
| pageSize | 是 | Integer | 每頁的數量 | ||
| list | 是 | Object[] | list | ||
| pageNum | 是 | Integer | 當前頁 | ||
| navigatePages | 是 | Integer | 導航頁碼數 | ||
| total | 是 | Long | 總記錄數 | ||
| pages | 是 | Integer | 總頁數 | ||
| firstPage | 是 | Integer | 第一頁 | ||
| size | 是 | Integer | 當前頁的數量 | ||
| isLastPage | 是 | Boolean | 是否為最后一頁 | ||
| hasPreviousPage | 是 | Boolean | 是否有前一頁 | ||
| isFirstPage | 是 | Boolean | 是否為第一頁 |
表list
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池標識 | 100054c0416811e9a6690242ac110002 | |
| resSecurityGroupId | 是 | String | 安全組標識 | 3d510445-8ec4-48e7-95b6-2db12c89ed95 | |
| vpcId | 是 | String | vpc標識 | ||
| name | 是 | String | 安全組名稱 | sgs-95601111 | |
| zoneId | 是 | String | zone標識 | 100054c0416811e9a6690242ac110002 | |
| zoneName | 是 | String | zone名稱 | 保定os |
請求示例
請求頭header
無
請求參數query
GET /v1/extApi/describeSecurityGroup?spuInstId=7eb8d17d789047d2892d9f1ec89a20ac&pageNow=1&pageSize=10
響應示例
{
"statusCode": 800,
"message": "查詢iaas層安全組列表成功",
"returnObj": {
"code": 0,
"data": {
"startRow": 0,
"navigatepageNums": [
1
],
"lastPage": 1,
"prePage": 0,
"hasNextPage": false,
"nextPage": 0,
"pageSize": 10,
"endRow": 3,
"list": [
{
"regionId": "100054c0416811e9a6690242ac110002",
"resSecurityGroupId": "3d510445-8ec4-48e7-95b6-2db12c89ed95",
"vpcId": null,
"name": "sgs-htap",
"zoneId": "100054c0416811e9a6690242ac110002",
"zoneName": "保定os"
},
{
"regionId": "100054c0416811e9a6690242ac110002",
"resSecurityGroupId": "aa8ddfb7-f042-4c57-bb25-7df09d5c732a",
"vpcId": null,
"name": "sgs-95601111",
"zoneId": "100054c0416811e9a6690242ac110002",
"zoneName": "保定os"
},
{
"regionId": "100054c0416811e9a6690242ac110002",
"resSecurityGroupId": "b625798c-06d7-4e57-b0c1-95f2d9a9eb4f",
"vpcId": null,
"name": "sgs-eb3e",
"zoneId": "100054c0416811e9a6690242ac110002",
"zoneName": "保定os"
},
{
"regionId": "100054c0416811e9a6690242ac110002",
"resSecurityGroupId": "f2036ce1-029c-426a-b6af-6afef5dbd487",
"vpcId": null,
"name": "default",
"zoneId": "100054c0416811e9a6690242ac110002",
"zoneName": "保定os"
}
],
"pageNum": 1,
"navigatePages": 8,
"total": 4,
"navigateFirstPage": 1,
"pages": 1,
"size": 4,
"firstPage": 1,
"isLastPage": true,
"hasPreviousPage": false,
"navigateLastPage": 1,
"isFirstPage": true
}
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求失敗 |
錯誤碼
無
