接口功能介绍
调用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 | 表示请求失败 |
错误码
无
