禁用根中的策略类型 - DisablePolicyType

功能介绍

禁用根中的策略类型。只有在根中启用了特定类型的策略，才能将该类型的策略绑定到根中的实体。执行此操作后，您不能再将指定类型的策略绑定到该根或该根中的任何组织单元或账号。这是在后台执行的异步请求。您可以使用ListRoots查看指定根的策略类型的状态。此操作只能由组织的管理账号调用。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

organizations:policies:disable

Write

root *

g:ResourceTag/<tag-key>

-

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
organizations:policies:disable	Write	root *	g:ResourceTag/<tag-key>	-	-

URI

POST /v1/organizations/policies/disable

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-Security-Token	否	String	参数解释：如果正在使用临时安全凭据，则此 header 是必需的，该值是临时安全凭据的安全令牌（会话令牌）。约束限制：不涉及取值范围：最小长度0、最大长度32768。默认取值：无默认值

表2 请求Body参数
参数	是否必选	参数类型	描述
policy_type	是	String	参数解释：策略类型的名称，service_control_policy服务控制策略；tag_policy：标签策略。约束限制：必填字段取值范围：枚举值："service_control_policy"、"tag_policy" 默认取值：无
root_id	是	String	参数解释：根的唯一标识符（ID）。约束限制：必填字段取值范围：符合正则表达式：^r-[0-9a-z]{4,32}$ 最大长度34。默认取值：无

响应参数

状态码：202

表3 响应Body参数
参数	参数类型	描述
root	RootDto object	参数解释：根的详细信息。约束限制：必填字段取值范围：不涉及默认取值：无默认值

表4 RootDto
参数	参数类型	描述
id	String	参数解释：根的唯一标识符（ID）。约束限制：必填字段取值范围：符合正则表达式：^r-[0-9a-z]{4,32}$ 最小长度1、最大长度34。默认取值：无默认值
urn	String	参数解释：根的统一资源名称。约束限制：必填字段取值范围：最小长度1、最大长度1500。默认取值：无默认值
name	String	参数解释：根的名称。约束限制：必填字段取值范围：符合正则表达式：^[a-zA-Z][0-9a-zA-Z_-]+$ 最小长度1、最大长度64。默认取值：无默认值
policy_types	Array of PolicyTypeSummaryDto objects	参数解释：策略类型在当前根已启用，则该类型策略可以绑定到根或其组织单元或账号。约束限制：必填字段取值范围：无默认取值：无默认值
created_at	String	参数解释：根的创建时间。约束限制：必填字段取值范围：符合ISO 8601日期时间格式。默认取值：无默认值

表5 PolicyTypeSummaryDto
参数	参数类型	描述
status	String	参数解释：与根关联的策略类型状态。要将指定类型的策略绑定到根或该根中的组织单元或账号，该策略必须在组织中可用，并在该根已启用。enabled：启用；pending_enable：启用中；disabled：禁用；pending_disable：禁用中。约束限制：必填字段取值范围：最小长度1、最大长度64。默认取值：无默认值
type	String	参数解释：策略类型的名称，service_control_policy：服务控制策略；tag_policy：标签策略。约束限制：必填字段取值范围：最小长度1、最大长度64。默认取值：无默认值

请求示例

禁用根中的策略类型

POST https://{endpoint}/v1/organizations/policies/disable

{
  "policy_type" : "service_control_policy",
  "root_id" : "r-o1qqtqfo7xl427v7g"
}

响应示例

状态码：202

Successful.

{
  "root" : {
    "id" : "05261f923e80d3890f33c0056e9b3f80",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:policy:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/service_control_policy/p-b4wpejd02o66g0pvfinvsatp4t9krfum",
    "name" : "paas_iam_573331",
    "policy_types" : [ {
      "status" : "enabled",
      "type" : "service_control_policy"
    } ],
    "created_at" : "2022-09-22T02:23:21Z"
  }
}