调用 DescribeSecurityGroups 接口，查询满足指定条件的安全组。

使用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的安全组，若没有符合条件的安全组，则返回空值。

若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有安全组。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：DescribeSecurityGroups

接口名称。当前 API 的名称为DescribeSecurityGroups。

Version String 必选示例值：2020-04-01

接口版本。当前 API 的版本为 2020-04-01。

VpcId String 可选示例值：vpc-bp67acfmxazb4p****

安全组所在VPC的ID。

您可以调用 DescribeVpcs 接口，查询VPC的ID。

SecurityGroupIds.N String 可选示例值：sg-bp67acfmxazb4p****

安全组的ID列表。

参数 - N：表示安全组ID的序号，单次调用数量上限为100个。

多个安全组用&分隔。

说明

参数SecurityGroupIds.N和SecurityGroupNames.N二者不可同时传入。

SecurityGroupNames.N String 可选示例值：test-sg-1

安全组名称列表。

参数 - N：表示安全组名称的序号，单次调用数量上限为100个。

多个安全组用&分隔。

说明

参数SecurityGroupIds.N和SecurityGroupNames.N二者不可同时传入。

ProjectName String 可选示例值：default

安全组所属的项目。

TagFilters.N.Key String 可选示例值：k1

标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的安全组。

不允许重复。

TagFilters.N.Values.N String 可选示例值：v1

标签的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的安全组。

多个标签值之间用&分隔。

说明

若传入该参数，则必须先传入TagFilters.N.Key。

传入空字符串时，表示查询标签值为空的安全组。

PageNumber Integer 可选示例值：1

列表的页码。默认值为1。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 可选示例值：20

分页查询时每页的行数。最大值为100，默认值为20。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 可选示例值：caeba0bbb2be03f84eb48b699f0a****

分页查询凭证，用于标记分页的位置。

不填则从头开始查询。

传入之前调用本API返回的NextToken，则从该次API调用标记分页的位置往后开始查询。

MaxResults Integer 可选示例值：50

查询的数量，默认为 10，最大为100。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

RequestId String 示例值：2021062415303301022514515207C4****

请求ID。

TotalCount Integer 示例值：2

符合条件的安全组总数。

说明

本参数即将下线，使用NextToken和MaxResults分页查询时，此参数无意义。

PageNumber Integer 示例值：1

当前页码。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 示例值：10

当前分页的行数。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 示例值：caeba0bbb2be03f84eb48b699f0a****

本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。

SecurityGroups Object[] 示例值：-

安全组信息集合。

AccountId String 示例值：2000****

安全组所属主账号。

CreationTime String 示例值：2020-12-05T22:40:00+08:00

安全组的创建时间。

Description String 示例值：TestDescription

安全组描述信息。

SecurityGroupId String 示例值：sg-bp67acfmxazb4p****

安全组ID。

SecurityGroupName String 示例值：SGTestName

安全组名称。

VpcId String 示例值：vpc-bp67acfmxazb4p****

安全组所属的VPC。

Status String 示例值：Available

安全组的状态。

Available：可用。

Creating：创建中。

Type String 示例值：normal

安全组的类型。

default：默认安全组。

normal：自定义安全组。

VpnGW： VPN网关安全组。

NatGW： Nat网关安全组。

cidr_only：CIDR-Only安全组。

ServiceManaged Boolean 示例值：false

安全组是否为托管安全组。

true：是。

false：否。

ProjectName String 示例值：default

安全组所属项目的名称。

Tags Object[] 示例值：-

安全组的标签信息。

Key String 示例值：k1

标签的标签键。

Value String 示例值：v1

标签的标签值。

UsedIpCount Integer 示例值：2000

当前安全组已配置IP数。

AvailableIpCount Integer 示例值：4000

当前安全组剩余可使用IP数。

UsedNetworkInterfaceCount Integer 示例值：1500

已关联的网卡数量。

AvailableNetworkInterfaceCount Integer 示例值：14500

安全组剩余可关联网卡的数量。

请求示例

返回示例

错误码

状态码	错误码	错误信息	说明
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。
400	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	查询数量不合法。
400	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	查询 NextToken 不合法。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	InvalidSecurityGroup.NotAuthorized	You are not authorized to operate invisible security group.	无权限操作隐藏安全组。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.SecurityGroupIDs	You've reached the limit on the number of security group IDs that you can describe.	已达到可查询的安全组ID数量上限。
400	LimitExceeded.SecurityGroupNames	You've reached the limit on the number of security group names that you can describe.	已达到可查询的安全组名数量上限。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。
409	InvalidParameter.ParameterConflict	The parameters of security group id and security group name cannot be specified at the same time.	该请求传入了非法或不支持的参数。不能同时指定安全组ID和名字。

私有网络