You need to enable JavaScript to run this app.
导航
DescribeSecurityGroupAttributes
最近更新时间:2024.05.17 08:35:45首次发布时间:2021.07.29 14:11:53

调用 DescribeSecurityGroupAttributes 接口,在指定安全组内查询满足指定条件的安全组规则。

调用说明

  • 传入多个请求参数,按照传入的参数进行查询,返回符合所有条件的安全组规则,若没有符合条件的安全组规则,则返回指定安全组的基础信息。

  • 若请求参数非必选参数均未传入,则返回指定安全组下的所有安全组规则。

调试

请求参数

参数名称
类型
是否必选
示例值
描述
ActionStringDescribeSecurityGroupAttributes系统规定参数。取值:DescribeSecurityGroupAttributes。
VersionString2020-04-01API版本信息,取值为:2020-04-01。

SecurityGroupId

String

sg-bp1gxw6bznjjvhu3****

规则所属安全组的ID。
您可以调用 DescribeSecurityGroups 接口,查询安全组的ID。

Direction

String

egress

安全组规则授权方向。 取值如下:

  • egress:安全组出方向
  • ingress:安全组入方向

Protocol

String

all

协议类型。取值如下:

  • tcp:TCP协议。
  • udp:UDP协议。
  • icmp:ICMP协议。
  • icmpv6:ICMPV6协议。

    说明

    IPv6功能正在邀测中,如需试用,请联系客户经理。

  • all:支持所有协议。

CidrIp

String

10.XX.XX.1/8

IP地址段,用于安全组出入方向规则的授权。
根据参数Direction的取值不同,含义也不同:

  • Direction取值为“egress”时,表示目的IP地址段。
  • Direction取值为“ingress”时,表示源IP地址段。

说明

当参数 CidrIpSourceGroupId、PrefixListId传入值时,仅生效一个,生效的优先级为CidrIp > SourceGroupId > PrefixListId

SourceGroupId

string

sg-bp67acfmxazb4p****

源地址或目的地址的安全组ID。

说明

当参数 CidrIpSourceGroupId、PrefixListId传入值时,仅生效一个,生效的优先级为CidrIp > SourceGroupId > PrefixListId

PrefixListId

String

pl-bp1fg655nh68xyz9****

前缀列表的ID。

说明

当参数 CidrIpSourceGroupId、PrefixListId传入值时,仅生效一个,生效的优先级为CidrIp > SourceGroupId > PrefixListId

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。
SecurityGroupIdStringsg-bp1gxw6bznjjvhu3****目标安全组ID。
SecurityGroupNameStringtestSecurityGroupName2目标安全组名称。
DescriptionStringsg_1安全组描述信息。
VpcIdStringvpc-bp1opxu1zkhn00gzv****VPC的ID。
CreationTimeString2021-07-12T07:28:20+08:00创建安全组的时间。
UpdateTimeString2021-08-12T07:30:38+08:00更新安全组的时间。
TypeStringnormal安全组的类型。
  • default:默认安全组
  • normal:自定义安全组
  • VpnGW:VPN网关安全组
  • NatGW:NAT网关安全组
  • ProjectNameStringdefault安全组所在项目的名称。

    ServiceManaged

    Boolean

    true

    待创建的安全组是否为托管安全组。

    • true:表示待创建的安全组是托管安全组。
    • false:表示待创建的安全组不是托管安全组。

    Status

    String

    Available

    安全组的状态。

    • Available:可用
    • Creating:创建中
    TagsArray of Struct-安全组的标签信息。具体请参见下表“Tags结构”。
    PermissionsArray of Struct-安全组规则集合。具体请参见下表“ Permissions结构 ”。

    Permissions结构

    参数名称
    类型
    示例值
    描述
    CreationTimeString2021-12-12T07:28:38+08:00创建安全组规则的时间。
    UpdateTimeString2021-2-10T07:28:30+08:00更新安全组规则的时间。
    DescriptionStringsg rule for default安全组规则的描述信息。
    DirectionStringegress授权方向。
    ProtocolStringTCPIP协议。
    PolicyStringaccept访问策略。
  • accept:接受访问。
  • drop:拒绝访问。
  • PortStartInteger80端口起始。
    PortEndInteger80端口结束。
    PriorityInteger1规则优先级。

    CidrIp

    String

    10.XX.XX.1/8

    IP地址段,用于安全组出入方向规则的授权。根据返回数据Direction的取值不同,含义也不同:

    • Direction取值为“egress”时,表示目的IP地址段。
    • Direction取值为“ingress”时,表示源IP地址段。
    PrefixListIdStringpl-bp1fg655nh68xyz9****前缀列表的ID。
    PrefixListCidrsList[" 8.XX.XX.0/16"," 16.XX.XX.0/16"]前缀列表的CIDR。
    SourceGroupIdStringsg-bp1gxw6bznjjvhu3****源地址或目的地址的安全组ID。

    Tags结构

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

    请求示例

    GET /?Action=DescribeSecurityGroupAttributes&Version=2020-04-01&SecurityGroupId=sg-bp1gxw6bznjjvhu3**** HTTP/1.1
    Host: open.volcengineapi.com
    Service: vpc
    Region: cn-beijing
    

    返回示例

    {
        "ResponseMetadata": {
            "RequestId": "2021062415303301022514515207C4****",
            "Action": "DescribeSecurityGroupAttributes",
            "Version": "2020-04-01",
            "Service": "vpc",
            "Region": "cn-beijing"
        },
       "Result": {
            "RequestId": "2021062415303301022514515207C4****",
            "SecurityGroupId": "sg-1g1is5ezvuz288ibuxwpy****",
            "SecurityGroupName": "Default",
            "VpcId": "vpc-1g1is592sit4w8ibuxxqz***",
            "Permissions": [
                {
                    "Description": "放通全部流量",
                    "CreationTime": "2021-07-22T15:02:12+08:00",
                    "UpdateTime": "2021-07-22T15:02:12+08:00",
                    "Priority": 100,
                    "Direction": "egress",
                    "Protocol": "all",
                    "Policy": "accept",
                    "CidrIp": "10.XX.XX.1/24",
                    "PrefixListId": "pl-bp1fg655nh68xyz9****",
                    "PrefixListCidrs":[
                         "8.XX.XX.0/16",
                         "16.XX.XX.0/16"
                    ], 
                    "SourceGroupId": "sg-bp12kc4rqohaf2js****",
                    "PortStart": -1,
                    "PortEnd": -1
                 }
            ],
            "CreationTime": "2021-08-31T13:16:11+08:00",
            "Description": "SGTestDescription",
            "UpdateTime": "2021-08-31T13:16:11+08:00",
            "ProjectName": "default",
            "Type": "normal",
            "ServiceManaged": false,
            "Status": "Available",
            "Tags": [ 
                { 
                    "Key":"k1", 
                    "Value":"v1" 
                }, 
                { 
                    "Key":"k2", 
                    "Value":"" 
                } 
            ]
        }
    }
    

    错误码

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

    HttpCode
    错误码
    错误信息
    描述
    404InvalidSecurityGroupId.NotFoundThe specified security group does not exist.指定的安全组不存在。