All Products
Search
Document Center

Resource Management:ListControlPolicies

Last Updated:Jan 16, 2025

Queries access control policies.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:ListControlPolicieslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PolicyTypestringNo

The type of the access control policies. Valid values:

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

The number of the page to return.

Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

Valid values: 1 to 100. Default value: 10.

10
LanguagestringNo

The language in which you want to return the descriptions of the access control policies. Valid values:

  • zh-CN (default value): Chinese
  • en: English
  • ja: Japanese
Note This parameter is available only for system access control policies.
zh-CN

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

TotalCountinteger

The number of access control policies.

1
RequestIdstring

The ID of the request.

9424A34C-3471-45AD-B6AB-924BBDFE42F9
PageSizeinteger

The number of entries returned per page.

10
PageNumberinteger

The page number of the returned page.

1
ControlPoliciesarray<object>

The information of the access control policies.

ControlPolicyobject

The information of an access control policy.

UpdateDatestring

The time when the access control policy was updated.

2020-08-05T06:32:24Z
Descriptionstring

The description of the access control policy.

System access control policy available for all operations on the cloud
EffectScopestring

The effective scope of the access control policy. Valid values:

  • All: The access control policy is in effect for Alibaba Cloud accounts, RAM users, and RAM roles.
  • RAM: The access control policy is in effect only for RAM users and RAM roles.
All
AttachmentCountstring

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

44
PolicyNamestring

The name of the access control policy.

FullAliyunAccess
PolicyIdstring

The ID of the access control policy.

cp-FullAliyunAccess
CreateDatestring

The time when the access control policy was created.

2020-08-05T06:32:24Z
PolicyTypestring

The type of the access control policy. Valid values:

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

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "9424A34C-3471-45AD-B6AB-924BBDFE42F9",
  "PageSize": 10,
  "PageNumber": 1,
  "ControlPolicies": {
    "ControlPolicy": [
      {
        "UpdateDate": "2020-08-05T06:32:24Z",
        "Description": "System access control policy available for all operations on the cloud\n",
        "EffectScope": "All",
        "AttachmentCount": "44",
        "PolicyName": "FullAliyunAccess",
        "PolicyId": "cp-FullAliyunAccess",
        "CreateDate": "2020-08-05T06:32:24Z",
        "PolicyType": "System"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history