tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSecurityGroupPolicies

Last updated: 2023-08-23 14:11:17

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 No String Common Params. This parameter is not required for this API.
SecurityGroupId Yes String The security group instance ID, such as sg-33ocnj9n. It can be obtained through DescribeSecurityGroups.
Filters.N No Array of Filter Filters
  • security-group-id - String - Security group ID in the rule.
  • 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 - Port. Fuzzy matching is supported. Query all ports when the protocol value is ALL.
  • poly - String - Policy type. Valid values: ALL, ACCEPT and DROP.
  • direction - String - Direction of the rule. Valid values: ALL, INBOUND and OUTBOUND.
  • description - String - Policy description. Fuzzy matching is supported.
    		•

    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

    POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityGroupPolicies
<Common request parameters>

{
    "SecurityGroupId": "sg-ohuuioma"
}

    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.
    InvalidParameter.FilterNotDict The specified filter condition should be a key-value pair.
    InvalidParameter.FilterValuesNotList The specified filter value should be a list.
    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy