tencent cloud

Tencent Cloud Organization

Product Introduction
Overview
Concepts
Purchase Guide
Operation Guide
Console Overview
Organization Settings
Department Management
Member Account Management
Member Finance Management
Member Access Management
Resource Management
Member Audit
Identity Center Management
API Documentation
History
Introduction
API Category
Making API Requests
Organization Settings APIs
Department and Member Management APIs
ListOrganizationIdentity
Unified Member Login APIs
Organization Service Management APIs
Organization Management Policy APIs
Resource Sharing APIs
Identity Center Management APIs
Identity Center User Management APIs
Identity Center User Group Management APIs
Identity Center Management SCIM Synchronization APIs
Identity Center Single Sign-On Management APIs
Identity Center Permission Configuration Management APIs
Identity Center Multi-Account Authorization Management APIs
Identity Center Sub-User Synchronization Management APIs
Data Types
Error Codes
TCO API 2018-12-25
Related Agreement
Statement of Tencent Cloud Customers’ Tencent Cloud Organization
FAQs
Concept
Basic
Operation
Glossary
DocumentaçãoTencent Cloud OrganizationAPI DocumentationOrganization Management Policy APIsDescribePolicy

DescribePolicy

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2026-03-20 00:28:46

1. API Description

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

This API is used to query 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 Params. The value used for this API: DescribePolicy.
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.
PolicyId Yes Integer Policy Id. you can call the ListPolicies api to obtain it.
PolicyType No String Policy type. Valid values: SERVICE_CONTROL_POLICY: service control policy; TAG_POLICY: tag policy. The default value is SERVICE_CONTROL_POLICY.

3. Output Parameters

Parameter Name Type Description
PolicyId Integer Policy ID.
PolicyName String Policy name.
Type Integer Policy type. Valid values: 1 (custom) and 2 (preset).
Description String Policy description
PolicyDocument String Policy document.
UpdateTime String Policy update time.
AddTime String Policy creation time.
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 Viewing the Details of a Policy

Viewing the Details of a Policy

Input Example

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

{
    "PolicyId": 10001
}

Output Example

{
    "Response": {
        "RequestId": "152482ca-5968-4557-ac1d-1e7ac28ce0da",
        "AddTime": "2022-08-04 16:04:17",
        "Description": "cvm policy",
        "PolicyDocument": "{\"strategyInfo\":{\"version\":\"2.0\",\"statement\":[{\"effect\":\"allow\",\"action\":\"*\",\"resource\":\"qcs::cam::*:*\"}]},\"version\":\"2.0\"}",
        "PolicyId": 10001,
        "PolicyName": "policy_name",
        "Type": 1,
        "UpdateTime": "2022-08-04 17:04:17"
    }
}

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
InternalError An internal error occurred.
InvalidParameter The parameter is incorrect.
InvalidParameter.InterfaceNotExist The API does not exist.
InvalidParameter.OrganizationMemberNotExist The organization member does not exist.
InvalidParameter.OrganizationMemberNotManager The member is not an enterprise administrator.
InvalidParameter.OrganizationNodeNotExist The organization node does not exist.
InvalidParameter.OrganizationNotExist Enterprise organization does not exist.
MissingParameter Parameters are missing.
ResourceNotFound.MemberNotExist The member does not exist.
ResourceNotFound.NotFound The resource does not exist.
ResourceNotFound.OrganizationNotExist The organization does not exist.
ResourceNotFound.PolicyIdNotFound Policy does not exist.
ResourceNotFound.PolicyNotExist Policy does not exist.
Anterior: DeletePolicyPróximo: AttachPolicy

Ajuda e Suporte

Esta página foi útil?

comentários