You need to enable JavaScript to run this app.
导航
DescribeSecurityGroups
最近更新时间:2024.02.26 11:38:44首次发布时间:2021.07.29 14:11:53

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

调用说明

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

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

调试

请求参数

参数名称
类型
是否必选
示例值
描述
ActionStringDescribeSecurityGroups系统规定参数。取值:DescribeSecurityGroups。
VersionString2020-04-01API版本信息,取值为: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.NSecurityGroupNames.N二者不可同时传入。

SecurityGroupNames.N

String

SecurityGroupNames.1=test-sg-1&SecurityGroupNames.2=test-sg-2

安全组名称列表。

  • 参数 - N:表示安全组名称的序号,单次调用数量上限为100个。
  • 多个安全组用&分隔。

说明

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

ProjectNameStringdefault安全组所属的项目。

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。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

PageSize

Integer

20

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

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

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

  • 不填则从头开始查询。
  • 传入之前调用本API返回的NextToken,则从该次API调用标记分页的位置往后开始查询。
MaxResultsInteger50查询的数量,默认为 10,最大为100。

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。

TotalCount

Integer

2

符合条件的安全组总数。

说明

本参数即将下线,使用NextTokenMaxResults分页查询时,此参数无意义。

PageNumber

Integer

1

当前页码。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

PageSize

Integer

10

当前分页的行数。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

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

SecurityGroupsArray of Struct-安全组信息集合。具体请见下表“ SecurityGroups结构 ”。

SecurityGroups结构

参数名称
类型
示例值
描述
CreationTimeString2020-12-05T22:40:00+08:00安全组的创建时间。
DescriptionStringTestDescription安全组描述信息。
SecurityGroupIdStringsg-bp67acfmxazb4p****安全组ID。
SecurityGroupNameStringSGTestName安全组名称。
VpcIdStringvpc-bp67acfmxazb4p****安全组所属的VPC。

Status

String

Available

安全组的状态。

  • Available:可用。
  • Creating:创建中。

Type

String

normal

安全组的类型。

  • default:默认安全组。
  • normal:自定义安全组。
  • VpnGW: VPN网关安全组。
  • NatGW: Nat网关安全组。

ServiceManaged

Boolean

false

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

  • true:是。
  • false:否。
ProjectNameStringdefault安全组所属项目的名称。
TagsArray of Struct-安全组的标签信息。具体请参见下表“Tags结构”。

Tags结构

参数名称
类型
示例值
描述
KeyStringk1标签的标签键。
ValueStringv1标签的标签值。

请求示例

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": [
            {
                "VpcId": "vpc-2ff3bpyczwc1s5oxruwe8****",
                "CreationTime": "2021-07-23T16:15:45+08:00",
                "Description": "默认安全组",
                "SecurityGroupName": "Default",
                "SecurityGroupId": "sg-2ff3bq4a38hz45oxruwc0****",
                "Status": "Available",
                "ProjectName": "default",
                "Type": "normal",
                "ServiceManaged": false,
                "Tags": [ 
                    { 
                        "Key":"k1", 
                        "Value":"v1" 
                    }, 
                    { 
                        "Key":"k2", 
                        "Value":"" 
                    } 
                ]
            }
        ]
    }
}

错误码

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

HttpCode
错误码
错误信息
描述
400InvalidMaxResults.MalformedThe specified parameter MaxResults is malformed.查询数量不合法。
400InvalidNextToken.MalformedThe specified parameter NextToken is invalid.查询 NextToken 不合法。
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400InvalidTagFilterKey.MalformedThe specified parameter tag filter key is invalid.过滤标签键不合法。
400InvalidTagFilterValue.MalformedThe specified parameter tag filter value is invalid.过滤标签值不合法。
400LimitExceeded.TagFilterKeyYou've reached the limit on the number of tag keys that you can filter.已达到单次可指定过滤标签键数量的上限。
400LimitExceeded.TagFilterValueYou've reached the limit on the number of tag values that you can filter.已达到单次可指定过滤标签值数量的上限。
400LimitExceeded.SecurityGroupIDsYou've reached the limit on the number of security group IDs that you can describe.已达到可查询的安全组ID数量上限。
400LimitExceeded.SecurityGroupNamesYou've reached the limit on the number of security group names that you can describe.已达到可查询的安全组名数量上限。
400InvalidTagFilter.DisorderThe specified index order of tag filter is malformed.指定标签过滤项的索引顺序参数格式不合法。
409InvalidParameter.ParameterConflictThe parameters of security group id and security group name cannot be specified at the same time.该请求传入了非法或不支持的参数。不能同时指定安全组ID和名称。