调用 DescribeSecurityGroupAttributes 接口，在指定安全组内查询满足指定条件的安全组规则。
传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的安全组规则，若没有符合条件的安全组规则，则返回指定安全组的基础信息。
若请求参数非必选参数均未传入，则返回指定安全组下的所有安全组规则。
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeSecurityGroupAttributes | 系统规定参数。取值：DescribeSecurityGroupAttributes。 |
| Version | String | 是 | 2020-04-01 | API版本信息，取值为：2020-04-01。 |
SecurityGroupId | String | 是 | sg-bp1gxw6bznjjvhu3**** | 规则所属安全组的ID。 |
Direction | String | 否 | egress | 安全组规则授权方向。 取值如下：
|
Protocol | String | 是 | all | 协议类型。取值如下：
|
CidrIp | String | 否 | 10.XX.XX.1/8 | IP地址段，用于安全组出入方向规则的授权。
说明 当参数 |
SourceGroupId | string | 否 | sg-bp67acfmxazb4p**** | 源地址或目的地址的安全组ID。 说明 当参数 |
PrefixListId | String | 否 | pl-bp1fg655nh68xyz9**** | 前缀列表的ID。 说明 当参数 |
参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 2021062415303301022514515207C4**** | 请求ID。 |
| AccountId | string | 2000**** | 安全组所属主账号。 |
| VpcId | String | vpc-bp1opxu1zkhn00gzv**** | VPC的ID。 |
| SecurityGroupId | String | sg-bp1gxw6bznjjvhu3**** | 目标安全组ID。 |
| SecurityGroupName | String | testSecurityGroupName2 | 目标安全组名称。 |
| Description | String | sg_1 | 安全组描述信息。 |
| Type | String | normal | 安全组的类型。 |
ServiceManaged | Boolean | true | 待创建的安全组是否为托管安全组。
|
Status | String | Available | 安全组的状态。
|
| Permissions | Array of Struct | - | 安全组规则集合。具体请参见下表“ Permissions结构 ”。 |
| ProjectName | String | default | 安全组所在项目的名称。 |
| Tags | Array of Struct | - | 安全组的标签信息。具体请参见下表“Tags结构”。 |
| CreationTime | String | 2021-07-12T07:28:20+08:00 | 创建安全组的时间。 |
| UpdateTime | String | 2021-08-12T07:30:38+08:00 | 更新安全组的时间。 |
Permissions结构
参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| SourceGroupId | String | sg-bp1gxw6bznjjvhu3**** | 安全组ID。 |
| Direction | String | egress | 授权方向。 |
| Priority | Integer | 1 | 规则优先级。 |
| Policy | String | accept | 访问策略。 |
| Protocol | String | TCP | 协议类型。 |
| PortStart | Integer | 80 | 端口起始。 |
| PortEnd | Integer | 80 | 端口结束。 |
CidrIp | String | 10.XX.XX.1/8 | IP地址段，用于安全组出入方向规则的授权。根据返回数据
|
| PrefixListId | String | pl-bp1fg655nh68xyz9**** | 前缀列表的ID。 |
| PrefixListCidrs | List | [" 8.XX.XX.0/16"," 16.XX.XX.0/16"] | 前缀列表的CIDR。 |
| Description | String | sg rule for default | 安全组规则的描述信息。 |
| CreationTime | String | 2021-12-12T07:28:38+08:00 | 创建安全组规则的时间。 |
| UpdateTime | String | 2021-2-10T07:28:30+08:00 | 更新安全组规则的时间。 |
Tags结构
参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Key | String | k1 | 标签的标签键。 |
| Value | String | v1 | 标签的标签值。 |
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****", "AccountId": "2000****", "VpcId": "vpc-1g1is592sit4w8ibuxxqz***", "SecurityGroupId": "sg-1g1is5ezvuz288ibuxwpy****", "SecurityGroupName": "Default", "Description": "SGTestDescription", "Type": "normal", "ServiceManaged": false, "Status": "Available", "Permissions": [ { "SourceGroupId": "sg-bp12kc4rqohaf2js****", "Direction": "egress", "Priority": 100, "Policy": "accept", "Protocol": "all", "PortStart": -1, "PortEnd": -1, "CidrIp": "10.XX.XX.1/24", "PrefixListId": "pl-bp1fg655nh68xyz9****", "PrefixListCidrs":[ "8.XX.XX.0/16", "16.XX.XX.0/16" ]， "Description": "放通全部流量", "CreationTime": "2021-07-22T15:02:12+08:00", "UpdateTime": "2021-07-22T15:02:12+08:00" } ], "ProjectName": "default", "Tags": [ { "Key":"k1", "Value":"v1" }, { "Key":"k2", "Value":"" } ], "CreationTime": "2021-08-31T13:16:11+08:00", "UpdateTime": "2021-08-31T13:16:11+08:00" } }
此处仅展示当前API的错误码，更多错误码请参见公共错误码。
HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | Forbidden | You are not authorized to perform operations on the default resource. | 无权限对指定资源进行操作。 |
| 404 | InvalidSecurityGroupId.NotFound | The specified security group does not exist. | 指定的安全组不存在。 |