All Products
Search
Document Center

Resource Access Management:UpdatePolicyDescription

Last Updated:Jan 29, 2024

Modifies the description of a custom policy.

Operation description

You can call this operation to modify only the description of a custom policy. You cannot modify the description of a system policy.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ram:UpdatePolicyDescriptionWrite
  • Policy
    acs:ram:*:{#accountId}:policy/{#PolicyName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PolicyNamestringNo

The name of the policy.

TestPolicy
NewDescriptionstringNo

The description of the policy.

The value of the parameter must be 1 to 1,024 characters in length.

This is a test policy.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

7572DEBD-0ECE-518E-8682-D8CB82F8FE8E
Policyobject

The information about the policy.

PolicyNamestring

The name of the policy.

TestPolicy
PolicyTypestring

The type of the policy. Valid values:

  • Custom: custom policy
  • System: system policy
Custom
CreateDatestring

The time when the policy was created.

2022-02-28T07:04:15Z
UpdateDatestring

The time when the policy was modified.

2022-02-28T07:05:37Z
Descriptionstring

The description of the policy.

This is a test policy.
DefaultVersionstring

The version of the policy. Default value: v1.

v1

Examples

Sample success responses

JSONformat

{
  "RequestId": "7572DEBD-0ECE-518E-8682-D8CB82F8FE8E",
  "Policy": {
    "PolicyName": "TestPolicy",
    "PolicyType": "Custom",
    "CreateDate": "2022-02-28T07:04:15Z",
    "UpdateDate": "2022-02-28T07:05:37Z",
    "Description": "This is a test policy.",
    "DefaultVersion": "v1"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-02-21Add Operationsee changesets