DescribeSecurityGroups--私有网络-火山引擎

文档中心

立即注册

导航

DescribeSecurityGroups

最近更新时间：2024.07.09 08:30:22首次发布时间：2021.07.29 14:11:53

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

调用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的安全组，若没有符合条件的安全组，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有安全组。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSecurityGroups	系统规定参数。取值：DescribeSecurityGroups。
Version	String	是	2020-04-01	API版本信息，取值为：2020-04-01。
VpcId	String	否	vpc-bp67acfmxazb4p****	安全组所在VPC的ID。您可以调用 DescribeVpcs 接口，查询VPC的ID。
SecurityGroupIds.N	String	否	SecurityGroupId.1=sg-bp67acfmxazb4p**&SecurityGroupId.2=sg-fds32jvnfjnf0f9**	安全组的ID列表。参数 - N：表示安全组ID的序号，单次调用数量上限为100个。多个安全组用&分隔。说明参数`SecurityGroupIds.N`和`SecurityGroupNames.N`二者不可同时传入。
SecurityGroupNames.N	String	否	SecurityGroupNames.1=test-sg-1&SecurityGroupNames.2=test-sg-2	安全组名称列表。参数 - N：表示安全组名称的序号，单次调用数量上限为100个。多个安全组用&分隔。说明参数`SecurityGroupIds.N`和`SecurityGroupNames.N`二者不可同时传入。
ProjectName	String	否	default	安全组所属的项目。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3	标签的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的安全组。不允许重复。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=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	Array of Struct	-	安全组信息集合。具体请见下表“ SecurityGroups结构 ”。

SecurityGroups结构

参数名称	类型	示例值	描述
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网关安全组。
ServiceManaged	Boolean	false	安全组是否为托管安全组。 true：是。 false：否。
ProjectName	String	default	安全组所属项目的名称。
Tags	Array of Struct	-	安全组的标签信息。具体请参见下表“Tags结构”。

Tags结构

参数名称	类型	示例值	描述
Key	String	k1	标签的标签键。
Value	String	v1	标签的标签值。

请求示例

GET /?Action=DescribeSecurityGroups&Version=2020-04-01&VpcId=vpc-bp67acfmxazb4p**** HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeSecurityGroups",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
   "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 20,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "SecurityGroups": [
            {
                "AccountId": "2000****",
                "VpcId": "vpc-2ff3bpyczwc1s5oxruwe8****",
                "SecurityGroupName": "Default",
                "Description": "默认安全组",
                "SecurityGroupId": "sg-2ff3bq4a38hz45oxruwc0****",
                "Status": "Available",
                "ProjectName": "default",
                "Type": "normal",
                "ServiceManaged": false,
                "Tags": [ 
                    { 
                        "Key":"k1", 
                        "Value":"v1" 
                    }, 
                    { 
                        "Key":"k2", 
                        "Value":"" 
                    } 
                ],
               "CreationTime": "2021-07-23T16:15:45+08:00"
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
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	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
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.	已达到单次可指定过滤标签值数量的上限。
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	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
409	InvalidParameter.ParameterConflict	The parameters of security group id and security group name cannot be specified at the same time.	该请求传入了非法或不支持的参数。不能同时指定安全组ID和名称。