查看策略详情

最近更新时间:2024-04-17 14:48:55

我的收藏

1. 接口描述

接口请求域名: organization.tencentcloudapi.com 。

本接口(DescribePolicy)可用于查询查看策略详情。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePolicy。
Version String 公共参数,本接口取值:2021-03-31。
Region String 公共参数,本接口不需要传递此参数。
PolicyId Integer 策略Id。
示例值:133495775
PolicyType String 策略类型。默认值SERVICE_CONTROL_POLICY,取值范围:SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略
示例值:SERVICE_CONTROL_POLICY

3. 输出参数

参数名称 类型 描述
PolicyId Integer 策略Id。
示例值:10098
PolicyName String 策略名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test_policy
Type Integer 策略类型。1-自定义 2-预设策略
示例值:1
Description String 策略描述。
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试权限
PolicyDocument String 策略文档。
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"version":"2.0","statement":[{"effect":"allow","action":["name\
UpdateTime String 策略更新时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-07-29 21:18:40
AddTime String 策略创建时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-07-29 21:18:40
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看一个策略的详情

查看一个策略的详情

输入示例

POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePolicy
<公共请求参数>

{
    "PolicyId": 1001
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.InterfaceNotExist 接口不存在。
InvalidParameter.OrganizationMemberNotExist 组织成员不存在。
InvalidParameter.OrganizationMemberNotManager 该成员不是企业管理员。
InvalidParameter.OrganizationNodeNotExist 组织节点不存在。
InvalidParameter.OrganizationNotExist 企业组织不存在。
MissingParameter 缺少参数错误。
ResourceNotFound.MemberNotExist 成员不存在。
ResourceNotFound.NotFound 资源不存在。
ResourceNotFound.OrganizationNotExist 企业组织不存在。
ResourceNotFound.PolicyIdNotFound 策略不存在。
ResourceNotFound.PolicyNotExist 策略不存在。