接口功能介绍
查询安全组列表。
接口约束
URI
GET /v1/open-api/instance/security-group-of-iaas-list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例ID | 562b89493b1a40e1b97ea05e50dd8170 | |
pageNow | 否 | Integer | 当前页 | 1 | |
pageSize | 否 | Integer | 单页记录条数 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码取值范围:0 成功; 2001 参数异常;3001 业务异常;5001 请求响应失败 | 0 | |
returnObj | 否 | Object | 返回对象 | returnObj | |
message | 否 | String | 结果信息 | success |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pageNum | 是 | Integer | 当前页 | 1 | |
pageSize | 是 | Integer | 每页的数量 | 1 | |
size | 是 | Integer | 当前页的数量 | 0 | |
startRow | 是 | Integer | 当前页面第一个元素在数据库中的行号 | 0 | |
endRow | 是 | Integer | 当前页面最后一个元素在数据库中的行号 | 0 | |
total | 是 | Integer | 总记录数 | ||
pages | 是 | Integer | 总页数 | ||
firstPage | 是 | Integer | 第一页 | ||
prePage | 是 | Integer | 前一页 | ||
isFirstPage | 是 | Boolean | 是否为第一页 | ||
isLastPage | 是 | Boolean | 是否为最后一页 | ||
hasPreviousPage | 是 | Boolean | 是否有前一页 | ||
hasNextPage | 是 | Boolean | 是否有下一页 | ||
navigatePages | 是 | Integer | 导航页码数 | ||
navigatepageNums | 是 | Array of Integer | 所有导航页号 | ||
list | 是 | Array of Object | 结果集(每页显示的数据 | T |
表T
字段 | 数据类型 | 字段说明 |
---|---|---|
vpcId | String | vpc标识 |
zoneId | String | zone标识 |
zoneName | String | Zone名称 |
regionId | String | 资源池标识 |
name | String | 安全组名称 |
resSecurityGroupId | String | 安全组标识 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"startRow": 0,
"navigatepageNums": [
1
],
"lastPage": 1,
"prePage": 0,
"hasNextPage": false,
"nextPage": 0,
"pageSize": 10,
"endRow": 3,
"list": [{
"regionId": "100054c0416811e9a6690242ac11000a",
"resSecurityGroupId": "3d510445-8ec4-48e7-95b6-2db12c89ed95",
"vpcId": null,
"name": "sgs-htap",
"zoneId": "100054c0416811e9a6690242ac11000a",
"zoneName": "保定os"
},
{
"regionId": "100054c0416811e9a6690242ac11000a",
"resSecurityGroupId": "aa8ddfb7-f042-4c57-bb25-7df09d5c732a",
"vpcId": null,
"name": "sgs-95601111",
"zoneId": "100054c0416811e9a6690242ac11000a",
"zoneName": "保定os"
},
{
"regionId": "100054c0416811e9a6690242ac11000a",
"resSecurityGroupId": "b625798c-06d7-4e57-b0c1-95f2d9a9eb4f",
"vpcId": null,
"name": "sgs-eb3e",
"zoneId": "100054c0416811e9a6690242ac11000a",
"zoneName": "保定os"
},
{
"regionId": "100054c0416811e9a6690242ac11000a",
"resSecurityGroupId": "f2036ce1-029c-426a-b6af-6afef5dbd487",
"vpcId": null,
"name": "default",
"zoneId": "100054c0416811e9a6690242ac11000a",
"zoneName": "保定os"
}
],
"pageNum": 1,
"navigatePages": 8,
"total": 4,
"navigateFirstPage": 1,
"pages": 1,
"size": 4,
"firstPage": 1,
"isLastPage": true,
"hasPreviousPage": false,
"navigateLastPage": 1,
"isFirstPage": true
}
}
状态码
状态码 | 描述 |
---|---|
0 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败, 失败原因见message |