更新时间:2024-10-21 GMT+08:00

查询策略相关信息

功能介绍

检索策略的相关信息。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET https://{endpoint}/v1/organizations/policies/{policy_id}

表1 路径参数

参数

是否必选

参数类型

描述

policy_id

String

策略的唯一标识符(ID)。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

X-Language

String

选择接口返回的信息的语言

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

policy

PolicyDto object

包含有关策略的详细信息的结构。

表4 PolicyDto

参数

参数类型

描述

content

String

策略的文本内容。

policy_summary

PolicySummaryDto object

包含有关策略的信息,但不包括内容。

表5 PolicySummaryDto

参数

参数类型

描述

is_builtin

Boolean

一个布尔值,指示指定的策略是否为系统策略。如果为true,即为系统策略,则可以将策略附加到根、组织单元或账号,但不能编辑它。

description

String

策略说明。

id

String

策略的唯一标识符(ID)。

urn

String

策略的统一资源名称。

name

String

策略的名称。

type

String

策略的类型,service_control_policy:服务控制策略;tag_policy:标签策略。

请求示例

查询策略相关信息

GET https://{endpoint}/v1/organizations/policies/{policy_id}

响应示例

状态码: 200

Successful.

{
  "policy" : {
    "content" : "{\"Version\":\"5.0\",\"Statement\":[{\"Sid\":\"Statement1\",\"Effect\":\"Allow\",\"Action\":[\"*\"],\"Resource\":[\"*\"]}]}",
    "policy_summary" : {
      "is_builtin" : false,
      "description" : "auto0923161647582JIeTPolicydesc",
      "id" : "p-scnsbv8byvfjp612ooojkdamzcgtp6l9",
      "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:policy:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/service_control_policy/p-b4wpejd02o66g0pvfinvsatp4t9krfum",
      "name" : "auto0923161647583CXosPolicyName",
      "type" : "service_control_policy"
    }
  }
}

状态码

状态码

描述

200

Successful.

错误码

请参见错误码