修改自定义身份策略的描述 - UpdatePolicyV5
功能介绍
该接口可以用于修改自定义身份策略的描述字段。
授权信息
当前API调用无需身份策略权限。
URI
PUT /v5/policies/{policy_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| policy_id | 是 | String | 参数解释: 身份策略ID。获取方式请参见查询身份策略列表接口(ListPoliciesV5)获取或在IAM控制台的身份策略列表页查看。 约束限制: 不涉及。 取值范围: 长度为1到64个字符,只包含字母、数字和"-"的字符串。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| description | 否 | String | 参数解释: 身份策略描述。 约束限制: 不涉及 取值范围: 长度范围为[0,1000]。 默认取值: 不涉及。 |
响应参数
状态码:204
无
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如 PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API 请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 认证失败时返回的加密详细信息,用于定位认证问题。 可以通过STS5解密接口进行解密,请参见接口链接。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如 PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API 请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
状态码:409
请求示例
修改指定身份策略的描述。
PUT https://{endpoint}/v5/policies/{policy_id}
{
"description" : "description"
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 204 | 请求成功。 |
| 400 | 请求体异常。 |
| 403 | 没有操作权限。 |
| 404 | 未找到相应的资源。 |
| 409 | 请求冲突。 |
错误码
请参见错误码。