All Products
Search
Document Center

Resource Management:EnableControlPolicy

Last Updated:Jun 05, 2024

Enables the Control Policy feature.

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.

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
resourcemanager:EnableControlPolicyWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

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

Response parameters

ParameterTypeDescriptionExample
object
EnablementStatusstring

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
RequestIdstring

The ID of the request.

8CE7BD95-EFFA-4911-A1E0-BD4412697FEB

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
409Throttling.EnableControlPolicyThe 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).

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

Change history

Change timeSummary of changesOperation
No change history