EnableControlPolicy API reference for the Control Policy feature - Resource Management - Alibaba Cloud - Resource Management

Operation description

The Control Policy feature allows you to manage the permission boundaries of the folders or member accounts in a resource directory in a centralized manner. This feature is implemented based on the resource directory. You can use this feature to develop common or dedicated rules for access control. The Control Policy feature does not grant permissions but only defines permission boundaries. A member account in a resource directory can be used to access resources only after it is granted the required permissions by using the Resource Access Management (RAM) service. For more information, see Overview of the Control Policy feature.

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:EnableControlPolicy

update

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
EnablementStatus	string	The status of the Control Policy feature. Valid values: Enabled: The Control Policy feature is enabled. PendingEnable: The Control Policy feature is being enabled. Disabled: The Control Policy feature is disabled. PendingDisable: The Control Policy feature is being disabled.	PendingEnable
RequestId	string	The ID of the request.	8CE7BD95-EFFA-4911-A1E0-BD4412697FEB

Examples

Success response

JSON format

{
  "EnablementStatus": "PendingEnable",
  "RequestId": "8CE7BD95-EFFA-4911-A1E0-BD4412697FEB"
}

Error codes

HTTP status code	Error code	Error message	Description
409	Throttling.EnableControlPolicy	The enable operation is too frequent. Please try again in %s minute(s).	The enable operation is too frequent. Please try again in %s minute(s).

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.