DescribeSecurityGroups
获取一个或多个安全组信息。
可根据安全组ID,名称作过滤条件,来获取安全组列表。 如果不指定任何过滤条件,默认返回你所拥有的所有安全组。 如果指定不存在的安全组ID,或非法状态值,则会返回错误信息。
请求参数
参数 | 参数类型 | 说明 | 是否必选 |
---|---|---|---|
security_groups.n |
String |
安全组ID |
No |
search_word |
String |
搜索关键词,支持安全组ID,安全组名称 |
No |
tags.n |
String |
按照标签ID过滤, 只返回已绑定某标签的资源 |
No |
verbose |
Integer |
是否返回冗长的信息,若为1,则返回应用了此安全组的其他资源的信息,默认为0. |
No |
offset |
Integer |
数据偏移量,默认为0 |
No |
limit |
Integer |
返回数据长度,默认为20,最大100 |
No |
zone |
String |
区域 ID,注意要小写 |
Yes |
除上述请求参数外,还包含公共参数。
返回数据
参数 | 参数类型 | 说明 |
---|---|---|
action |
String |
响应动作 |
security_group_set |
Array |
JSON 格式的安全组数据列表,每项数据可见下面 Response Item |
total_count |
Integer |
根据过滤条件得到的安全组总数 |
ret_code |
Integer |
执行成功与否,0 表示成功,其他值则为错误代码 |
Response Item
参数 | 参数类型 | 说明 |
---|---|---|
security_group_id |
String |
安全组ID |
security_group_name |
String |
安全组名称 |
description |
String |
安全组描述 |
is_applied |
Integer |
是否已更新规则,1为已更新,0为还未更新。 |
is_default |
Integer |
是否是系统默认安全组,1为是,0为不是 |
resources |
Array |
应用了此安全组的资源列表,每项资源数据格式为: |
create_time |
TimeStamp |
安全组创建时间,为UTC时间,格式可参见 ISO8601. |
请求示例
https://api.qingcloud.com/iaas/?action=DescribeSecurityGroups
&verbose=1
&COMMON_PARAMS
返回示例
{
"action":"DescribeSecurityGroupsResponse",
"total_count":1,
"security_group_set":[
{
"is_applied":1,
"description":null,
"security_group_id":"sg-z13kokni",
"is_default":1,
"create_time":"2013-03-19T08:27:05Z",
"security_group_name":"default security group",
"resources":[
{
"resource_name":"",
"resource_type":"instance",
"resource_id":"i-ogbndull"
}
]
}
],
"ret_code":0
}