更新试运行策略 - UpdateDryRunPolicy
功能介绍
更新试运行策略,可以更新试运行策略的名称、描述或内容。如果不提供任何参数,则策略将保持不变。您不能更改策略的类型。此操作只能由组织的管理账号调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
organizations:policies:updateDryRunPolicy
Write
policy *
g:ResourceTag/<tag-key>
-
-
URI
PATCH /v1/organizations/dry-run-policies/{policy_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| policy_id | 是 | String | 参数解释: 策略的唯一标识符(ID)。可通过调用列出策略接口获取。 约束限制: 不涉及 取值范围: 符合正则表达式:^p-[0-9a-zA-Z_]{8,128}$ 最大长度130。 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此 header 是必需的,该值是临时安全凭据的安全令牌(会话令牌)。通过IAM服务的获取临时访问密钥接口获取临时安全凭据。 约束限制: 不涉及 取值范围: 不涉及字符类型限制。 最小长度0、最大长度32768。 默认取值: 不涉及 |
| X-Language | 否 | String | 参数解释: 选择接口返回的信息的语言,支持zh-cn(中文)和en-us(英文)。 约束限制: 不涉及 取值范围: 无 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| content | 否 | String | 参数解释: 更新后的策略文本内容。 约束限制: 无 取值范围: 符合正则表达式:^[\s\S]*$ 最小长度0、最大长度20000。 默认取值: 不涉及 |
| description | 否 | String | 参数解释: 要分配给策略的说明。 约束限制: 不涉及 取值范围: 符合正则表达式:^[\s\S]*$ 最大长度512。 默认取值: 不涉及 |
| name | 否 | String | 参数解释: 要分配给策略的名称。 约束限制: 不涉及 取值范围: 符合正则表达式:^[\u4e00-\u9fa5a-zA-Z0-9_- ]+$ 最小长度1、最大长度64。 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| policy | PolicyDto object | 参数解释: 策略的详细信息。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| content | String | 参数解释: 策略的文本内容。 取值范围: 符合正则表达式:^[\s\S]*$ 最小长度0、最大长度20000。 |
| policy_summary | PolicySummaryDto object | 参数解释: 包含有关策略的信息,但不包括内容。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| is_builtin | Boolean | 参数解释: 一个布尔值,指示指定的策略是否为系统策略。如果为true,即为系统策略,则可以将策略附加到根、组织单元或账号,但不能编辑它。 取值范围: 布尔值:true:系统策略;false:非系统策略。 |
| description | String | 参数解释: 策略说明。 取值范围: 符合正则表达式:^[\s\S]*$ 最大长度512。 |
| id | String | 参数解释: 策略的唯一标识符(ID)。 取值范围: 符合正则表达式:^p-[0-9a-zA-Z_]{8,128}$ 最小长度10、最大长度130。 |
| urn | String | 参数解释: 策略的统一资源名称。 取值范围: 符合URN格式,由英文字母、数字、冒号(:)、连字符(-)、正斜杠(/)等组成。最小长度1、最大长度1500。 |
| name | String | 参数解释: 策略的名称。 取值范围: 符合正则表达式:^[\u4e00-\u9fa5a-zA-Z0-9_- ]+$ 最小长度1、最大长度64。 |
| type | String | 参数解释: 策略的类型。service_control_policy:服务控制策略;tag_policy:标签策略。 取值范围: service_control_policy、tag_policy。 |
请求示例
更新试运行策略
PATCH https://{hostname}/v1/organizations/dry-run-policies/{policy_id}
{
"content" : "{\"Version\":\"5.0\",\"Statement\":[{\"Sid\":\"Statement1\",\"Effect\":\"Allow\",\"Action\":[\"*\"],\"Resource\":[\"*\"]}]}",
"description" : "newdesc",
"name" : "auto09231619598990t1HPolicyName"
} 响应示例
状态码:200
Successful.
{
"policy" : {
"content" : "{\"Version\":\"5.0\",\"Statement\":[{\"Sid\":\"Statement1\",\"Effect\":\"Allow\",\"Action\":[\"*\"],\"Resource\":[\"*\"]}]}",
"policy_summary" : {
"is_builtin" : false,
"description" : "newdesc",
"id" : "p-xce633owqm0o1c929wno7l850z2rdr4m",
"urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:policy:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/service_control_policy/p-b4wpejd02o66g0pvfinvsatp4t9krfum",
"name" : "auto09231619598990t1HPolicyName",
"type" : "service_control_policy"
}
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Successful. |
错误码
请参见错误码。