本接口用于获取外网防火墙详情。
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeSecurityGroup | 公共参数。该参数表示接口名称。取值:DescribeSecurityGroup。 |
Version | String | 是 | 2021-04-30 | 公共参数。该参数表示接口版本。取值:2021-04-30。 |
group_identity | String | 是 | veew-sg-2551200256591525**** | 外网防火墙的 ID。您可以通过 DescribeSecurityGroups 接口查询外网防火墙的 ID。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
security_group | 请参见返回示例 | 外网防火墙的详细信息。 |
GET https://veenedge.volcengineapi.com/?Action=DescribeSecurityGroup&Version=2021-04-30 &group_identity=veew-sg-2551200256591525**** &<其他公共参数>
{ "ResponseMetadata": { "RequestId": "202110222135390102250842170003****", "Action": "DescribeSecurityGroup", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-north-1" }, "Result": { "security_group": { "group_identity": "veew-sg-2551200256591525****", "account_identity": 210000****, "user_identity": 0, "name": "**联通01-默认外网防火墙", "region": "CentralChina", "city": "410100", "cluster_name": "**cu01", "vpc_identity": "vpc-sbjngs****", "vpc_name": "**联通01-默认VPC", "vpc_cidr": [ "172.**.**.64/26" ], "group_type": "default", "remark": "**联通01-默认外网防火墙", "ingress_rule": { "total": 2, "rules": [ { "rule_identity": "veew-sgr-9125118880000838****", "direction": "ingress", "rule": "allow", "protocol": "TCP", "ports": "22,3389", "ip_type": "ipv4", "ip_cidr": "0.0.0.0/0", "remark": "", "group_identity": "veew-sg-2551200256591525****", "status": 2, "create_time": 1632808737, "update_time": 1632808741 } ] }, "egress_rule": { "total": 0, "rules": [] }, "binds": { "total": 2, "binds": [ { "group_identity": "veew-sg-2551200256591525****", "bind_type": "veen", "bind_identity": "veen1122001021132113****", "status": 2 } ] }, "cluster_name_alias": "", "create_time": 1632808737, "update_time": 1632808737 } } }
如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码。