tencent cloud

文档反馈

DescribeSecurityGroupPolicies

最后更新时间:2022-05-31 16:37:45

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API (DescribeSecurityGroupPolicies) is used to query security group policies.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeSecurityGroupPolicies.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
SecurityGroupId Yes String The security group instance ID, such as sg-33ocnj9n. It can be obtained through DescribeSecurityGroups.
Filters.N No Array of Filter Filter conditions. SecurityGroupId and Filters cannot be specified at the same time.
  • security-group-id - String - Security group ID.
  • ip - String - IP. IPV4 and IPV6 fuzzy matching is supported.
  • address-module - String - IP address or address group template ID.
  • service-module - String - Protocol port or port group template ID.
  • protocol-type - String - Protocol supported by the security group policy. Valid values: TCP, UDP, ICMP, ICMPV6, GRE, ALL.
  • port - String - Optional - Protocol port. Fuzzy matching is supported. Query all ports when the protocol value is ALL.
  • poly - String - Protocol policy. Valid values: ALL (means "all policies"), ACCEPT (means "allow") and DROP (means "reject").
  • direction - String - Protocol rule. Valid values: ALL (means "all rules"), INBOUND(means "inbound rules") and OUTBOUND (means "outbound rules").
  • description - String - Protocol description. Fuzzy matching is supported in this filter condition.
  • 3. Output Parameters

    Parameter Name Type Description
    SecurityGroupPolicySet SecurityGroupPolicySet Security group policy set.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying security group rules

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeSecurityGroupPolicies
    &SecurityGroupId=sg-ohuuioma
    &<Common request parameters>
    

    Output Example

    {
      "Response": {
        "SecurityGroupPolicySet": {
          "Ingress": [
            {
              "PolicyIndex": 0,
              "ServiceTemplate": {
                "ServiceId": "ppm-f5n1f8da",
                "ServiceGroupId": ""
              },
              "AddressTemplate": {
                "AddressGroupId": "ipmg-2uw6ujo6",
                "AddressId": ""
              },
              "Action": "ACCEPT",
              "ModifyTime": "2017-03-12 10:00:00",
              "PolicyDescription": "ModifyPolicies"
            },
            {
              "PolicyIndex": 1,
              "ServiceTemplate": {
                "ServiceId": "ppm-f5n1f8da",
                "ServiceGroupId": ""
              },
              "AddressTemplate": {
                "AddressGroupId": "ipmg-2uw6ujo6",
                "AddressId": ""
              },
              "Action": "ACCEPT",
              "ModifyTime": "2017-03-12 10:00:00",
              "PolicyDescription": "2"
            }
          ],
          "Egress": [
            {
              "PolicyIndex": 0,
              "ServiceTemplate": {
                "ServiceId": "ppm-f5n1f8da",
                "ServiceGroupId": ""
              },
              "AddressTemplate": {
                "AddressGroupId": "ipmg-2uw6ujo6",
                "AddressId": ""
              },
              "Action": "ACCEPT",
              "ModifyTime": "2017-03-12 10:00:00",
              "PolicyDescription": "E1"
            }
          ],
          "Version": 60
        },
        "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
      }
    }
    

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidParameter.FilterInvalidKey The specified filter condition does not exist.
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.Malformed Invalid input parameter format.
    InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
    ResourceNotFound The resource does not exist.
    UnsupportedOperation Unsupported operation.
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持