Last updated: 2020-09-25 14:26:54

1. API Description

Domain name for API request:

This API is used to obtain security policy details.

A maximum of 20 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 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
Note: this field may return null, indicating that no valid values can be obtained.
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
&<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": "",
        "AliasName": "test1",
        "RuleId": "sr-bf0yxxpp"
        "Action": "ACCEPT",
        "DestPortRange": null,
        "SourceCidr": "",
        "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.


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
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback