All Products
Search
Document Center

Resource Management:CreateControlPolicy

Last Updated:Jun 25, 2024

Creates a custom access control policy.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PolicyNamestringYes

The name of the access control policy.

The name must be 1 to 128 characters in length. The name can contain letters, digits, and hyphens (-) and must start with a letter.

ExampleControlPolicy
DescriptionstringNo

The description of the access control policy.

The description must be 1 to 1,024 characters in length. The description can contain letters, digits, underscores (_), and hyphens (-) and must start with a letter.

ExampleControlPolicy
EffectScopestringYes

The effective scope of the access control policy.

The value RAM indicates that the access control policy takes effect only for RAM users and RAM roles.

RAM
PolicyDocumentstringYes

The document of the access control policy.

The document can be a maximum of 4,096 characters in length.

For more information about the languages of access control policies, see Languages of access control policies.

For more information about the examples of access control policies, see Examples of custom access control policies.

{"Version":"1","Statement":[{"Effect":"Deny","Action":["ram:UpdateRole","ram:DeleteRole","ram:AttachPolicyToRole","ram:DetachPolicyFromRole"],"Resource":"acs:ram:*:*:role/ResourceDirectoryAccountAccessRole"}]}

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

ControlPolicyobject

The details of the access control policy.

UpdateDatestring

The time when the access control policy was updated.

2021-03-18T09:24:19Z
Descriptionstring

The description of the access control policy.

ExampleControlPolicy
EffectScopestring

The effective scope of the access control policy.

The value RAM indicates that the access control policy takes effect only for RAM users and RAM roles.

RAM
AttachmentCountstring

The number of times that the access control policy is referenced.

0
PolicyNamestring

The name of the access control policy.

ExampleControlPolicy
PolicyIdstring

The ID of the access control policy.

cp-jExXAqIYkwHN****
CreateDatestring

The time when the access control policy was created.

2021-03-18T09:24:19Z
PolicyTypestring

The type of the access control policy. Valid values:

  • System: system access control policy
  • Custom: custom access control policy
Custom
RequestIdstring

The ID of the request.

776B05B3-A0B0-464B-A191-F4E1119A94B2

Examples

Sample success responses

JSONformat

{
  "ControlPolicy": {
    "UpdateDate": "2021-03-18T09:24:19Z",
    "Description": "ExampleControlPolicy",
    "EffectScope": "RAM",
    "AttachmentCount": "0",
    "PolicyName": "ExampleControlPolicy",
    "PolicyId": "cp-jExXAqIYkwHN****",
    "CreateDate": "2021-03-18T09:24:19Z",
    "PolicyType": "Custom"
  },
  "RequestId": "776B05B3-A0B0-464B-A191-F4E1119A94B2"
}

Error codes

HTTP status codeError codeError message
409InvalidParameter.PolicyDocument.LengthThe maximum length of the policy document is exceeded. It must not exceed 4096 characters.

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

Change history

Change timeSummary of changesOperation
No change history