1)接口功能介绍
查询安全组列表。
2)接口约束
无。
3)URI
GET /v1/describeSecurityGroup。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
keyword | 否 | String | 筛选关键字. 查询关键字。默认为空。 | test | |
page | 否 | Integer | 当前页数.默认值为1。 | 1 | |
perPageNum | 否 | Integer | 每页显示的记录条数. 每页显示的记录条数。默认值为10。 | 10 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
totalPage | 是 | Integer | 1 | 总页数 | |
total | 是 | Integer | 6 | 记录总个数 | |
page | 是 | Integer | 1 | 当前页数 | |
perPageNum | 是 | Integer | 10 | 每页显示的记录条数 | |
securityGroupObjects | 是 | List | * | NAT网关信息列表 | securityGroupObjects |
表 securityGroupObjects
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
securityGroupId | 是 | String | 安全组ID | ts232 | |
securityGroupName | 是 | String | 安全组名称 | 10 | |
description | 是 | String | 安全组描述 | ttttttt | |
ruleCount | 是 | Integer | 规则数量 | 10 | |
vmCount | 是 | Integer | 关联的虚机数量 | 5 | |
created | 是 | String | 安全组创建时间(Unix时间戳,秒) | 1610327761 | |
updated | 是 | String | 安全组更新时间(Unix时间戳,秒) | 1610334171 | |
default | 是 | Bool | 是否默认 | false |
6)请求示例
GET "http://{host}/v1/describeSecurityGroup?keyword=&page=1&perPageNum=10"
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"securityGroupObjects": [
{
"updated": "1656067912",
"description": "paas",
"created": "1625727938",
"default": true,
"securityGroupId": "51",
"securityGroupName": "paas-default",
"vmCount": 0,
"ruleCount": 2
}
],
"totalPage": 1,
"total": 1,
"page": 1,
"perPageNum": 10
},
"requestId": "35c83fc1-a824-44fa-9abe-1feefcb1b472"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |