DescribeEffectivePolicy

Last updated:2026-03-20 00:28:47

DescribeEffectivePolicy

Last updated: 2026-03-20 00:28:47

1. API Description

Domain name for API request: organization.intl.tencentcloudapi.com.

This API is used to query the valid policy associated with the target.

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 Params. The value used for this API: DescribeEffectivePolicy.
Version	Yes	String	Common Params. The value used for this API: 2021-03-31.
Region	No	String	Common Params. This parameter is not required for this API.
TargetId	Yes	Integer	Account UIN or node ID.

3. Output Parameters

Parameter Name	Type	Description
EffectivePolicy	EffectivePolicy	Valid policy.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 This API is used to query the valid policy associated with the target.

This API is used to query the valid policy associated with the target.

Input Example

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

{
    "TargetId": 10001
}

Output Example

{
    "Response": {
        "EffectivePolicy": {
            "TargetId": 111111111111,
            "PolicyContent": "{\"tags\":{\"aaa\":{\"tag_key\":\"aaa\",\"tag_value\":[\"111\",\"222\"],\"resource_type_scope\":[\"cvm:instance\",\"cvm:volume\",\"cvm:keypair\",\"cvm:image\"]},\"bbb\":{\"tag_key\":\"bbb\",\"tag_value\":[\"333\"]}}}",
            "LastUpdatedTimestamp": 1668394639
        },
        "RequestId": "b46d2afe-6893-4529-bc96-2c82d9214957"
    }
}

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

Tencent Cloud CLI 3.0

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
InternalError	An internal error occurred.
InvalidParameter	The parameter is incorrect.
InvalidParameter.InterfaceNotExist	The API does not exist.
InvalidParameter.OrganizationMemberNotManager	The member is not an enterprise administrator.
InvalidParameter.OrganizationNotExist	Enterprise organization does not exist.
MissingParameter	Parameters are missing.
ResourceNotFound.EffectivePolicyNotFound	Valid policy does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud