UpdateControlPolicy-阿里云帮助中心

Updates a custom control policy.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

resourcemanager:UpdateControlPolicy

update

*ControlPolicy

acs:resourcemanager::{#accountId}:policy/controlpolicy/{#PolicyId}

None

Request parameters

Parameter	Type	Required	Description	Example
PolicyId	string	Yes	The ID of the control policy.	cp-jExXAqIYkwHN****
NewPolicyName	string	No	The new name of the control policy. The name must be 1 to 128 characters long. It must start with a letter and can contain only letters, digits, and hyphens (-).	NewControlPolicy
NewDescription	string	No	The new description of the control policy. The description must be 1 to 1,024 characters long. It must start with a letter and can contain only letters, digits, underscores (_), and hyphens (-).	ExampleControlPolicy
NewPolicyDocument	string	No	The new policy document. The policy document can be up to 4,096 characters long. For more information about the control policy language, see control policy language. For policy examples, see custom control policy examples.	{"Version":"1","Statement":[{"Effect":"Deny","Action":["ram:UpdateRole","ram:DeleteRole","ram:AttachPolicyToRole","ram:DetachPolicyFromRole"],"Resource":"acs:ram:::role/ResourceDirectoryAccountAccessRole"}]}

Response elements

Element	Type	Description	Example
	object	The response.
ControlPolicy	object	The details of the control policy.
UpdateDate	string	The time when the control policy was last updated.	2021-03-18T10:04:55Z
Description	string	The description of the control policy.	ExampleControlPolicy
EffectScope	string	The scope of the control policy. Valid values: All: The control policy applies to Alibaba Cloud accounts, RAM users, and RAM roles. RAM: The control policy applies only to RAM users and RAM roles.	RAM
AttachmentCount	string	The number of entities to which the control policy is attached.	0
PolicyName	string	The name of the control policy.	NewControlPolicy
PolicyId	string	The ID of the control policy.	cp-jExXAqIYkwHN****
CreateDate	string	The time when the control policy was created.	2021-03-18T09:24:19Z
PolicyType	string	The type of the control policy. Valid values: System: A system control policy. Custom: A custom control policy.	Custom
ControlPolicyType	string		RESOURCE_CONTROL_POLICY
RequestId	string	The request ID.	2DFCE4C9-04A9-4C83-BB14-FE791275EC53

Examples

Success response

JSON format

{
  "ControlPolicy": {
    "UpdateDate": "2021-03-18T10:04:55Z",
    "Description": "ExampleControlPolicy",
    "EffectScope": "RAM",
    "AttachmentCount": "0",
    "PolicyName": "NewControlPolicy",
    "PolicyId": "cp-jExXAqIYkwHN****",
    "CreateDate": "2021-03-18T09:24:19Z",
    "PolicyType": "Custom",
    "ControlPolicyType": "RESOURCE_CONTROL_POLICY"
  },
  "RequestId": "2DFCE4C9-04A9-4C83-BB14-FE791275EC53"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.NewPolicyDocument.Length	Unable to save your policy. A policy contains a maximum of 4096 characters.	Failed to save the policy. The policy document can be up to 4,096 characters in length.
404	EntityNotExists.ResourceControlPolicy	The specified resource control policy does not exist.
409	DeleteConflict.SystemResourceControlPolicy	The system resource control policy cannot be deleted.
409	InvalidResourceControlPolicyEnablementStatus	The resource control policy enablement status is not valid to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.