Call ListControlPolicies to query access control policies - Resource Management - Alibaba Cloud - Resource Management

Call ListControlPolicies to retrieve a list of control policies.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PolicyType	string	No	The type of control policy. Valid values: System: A system control policy. Custom: A custom control policy.	System
PageNumber	integer	No	The page number. Starting value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid range: 1 to 100. Default value: 10.	10
Language	string	No	The language of the returned descriptions for control policies. Valid values: `zh-CN` (default): Chinese. `en`: English. `ja`: Japanese. Note This parameter takes effect only for system control policies.	zh-CN
Tag	array<object>	No	The tags of the policy.
	object	No	A tag.
Key	string	No	The key of the tag.	tag_key
Value	string	No	The value of the tag.	tag_value

Response elements

Element	Type	Description	Example
	object	The data returned.
TotalCount	integer	The total number of control policies.	1
RequestId	string	The request ID.	9424A34C-3471-45AD-B6AB-924BBDFE42F9
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
ControlPolicies	object	The control policies.
ControlPolicy	array<object>	The list of control policies.
	array<object>	A control policy.
UpdateDate	string	The time the control policy was last updated.	2020-08-05T06:32:24Z
Description	string	The description of the control policy.	支持阿里云所有操作的系统管控策略
EffectScope	string	The effective 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.	All
AttachmentCount	string	The number of times the control policy is attached.	44
PolicyName	string	The name of the control policy.	FullAliyunAccess
PolicyId	string	The ID of the control policy.	cp-FullAliyunAccess
CreateDate	string	The time the control policy was created.	2020-08-05T06:32:24Z
PolicyType	string	The type of the control policy. Valid values: `System`: system control policy. `Custom`: custom control policy.	System
Tags	object	The tags attached to the control policy.
Tag	array<object>	The list of tags.
	object	A tag.
Key	string	The tag key.	tag_key
Value	string	The tag value.	tag_value
ControlPolicyType	string	The type of the control policy. This parameter is available only in the China (Shenzhen) Finance and China (Shanghai) Finance regions.	RESOURCE_CONTROL_POLICY

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "9424A34C-3471-45AD-B6AB-924BBDFE42F9",
  "PageSize": 10,
  "PageNumber": 1,
  "ControlPolicies": {
    "ControlPolicy": [
      {
        "UpdateDate": "2020-08-05T06:32:24Z",
        "Description": "支持阿里云所有操作的系统管控策略",
        "EffectScope": "All",
        "AttachmentCount": "44",
        "PolicyName": "FullAliyunAccess",
        "PolicyId": "cp-FullAliyunAccess",
        "CreateDate": "2020-08-05T06:32:24Z",
        "PolicyType": "System",
        "Tags": {
          "Tag": [
            {
              "Key": "tag_key",
              "Value": "tag_value"
            }
          ]
        },
        "ControlPolicyType": "RESOURCE_CONTROL_POLICY"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.