Help & DocumentationAPIsGlobal Application Acceleration PlatformConnection APIsDescribeSecurityPolicyDetail

DescribeSecurityPolicyDetail

Last updated: 2019-11-25 22:37:11

Contents：

1. API Description

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

This API is used to obtain security policy details.

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

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 parameter. The value used for this API: DescribeSecurityPolicyDetail
Version Yes String Common parameter. The value used for this API: 2018-05-29
Region No String Common parameter. This parameter is not required for this API.
PolicyId Yes String Security policy ID

3. Output Parameters

Parameter Name Type Description
ProxyId String Connection ID
Status String Security policy status:
BOUND (security policies enabled)
UNBIND (security policies disabled)
BINDING (enabling security policies)
UNBINDING (disabling security policies)
DefaultAction String Default policy: ACCEPT or DROP.
PolicyId String Policy ID
RuleList Array of SecurityPolicyRuleOut List of rules
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the Security Policy Details

Input Example

https://gaap.tencentcloudapi.com/?Action=DescribeSecurityPolicyDetail
&PolicyId=sp-xxxx
&<Common request parameters>

Output Example

{
  "Response": {
    "Status": "UNBIND",
    "ProxyId": "link-gw4sxx8j",
    "DefaultAction": "ACCEPT",
    "RequestId": "1eea4c85-e088-4512-9c6c-480dff91677e",
    "RuleList": [
      {
        "Action": "DROP",
        "DestPortRange": null,
        "SourceCidr": "2.2.2.2",
        "AliasName": "test1",
        "RuleId": "sr-bf0yxxpp"
      },
      {
        "Action": "ACCEPT",
        "DestPortRange": null,
        "SourceCidr": "1.1.1.1",
        "AliasName": "test2",
        "RuleId": "sr-ivgxkdxz"
      }
    ],
    "PolicyId": "sp-9scxxhdh"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
FailedOperation Operation failed
InternalError Internal error
InvalidParameter Parameter error
InvalidParameterValue Parameter value error
MissingParameter Parameter missing
ResourceNotFound Resource does not exist
ResourceUnavailable Resource is unavailable
UnauthorizedOperation Unauthorized operation
UnknownParameter Unknown parameter error