GetControlPolicy - Resource Management - Alibaba Cloud Documentation Center

Queries the details of an access control policy.

Operation description

This topic provides an example on how to call the API operation to query the details of the access control policy whose ID is cp-SImPt8GCEwiq****.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
resourcemanager:GetControlPolicy	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PolicyId	string	Yes	The ID of the access control policy.	cp-SImPt8GCEwiq****
Language	string	No	The language in which you want to return the description of the access control policy. Valid values: zh-CN (default value): Chinese en: English ja: Japanese Note This parameter is valid only for system access control policies.	zh-CN

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

Response parameters

Parameter	Type	Description	Example
	object
ControlPolicy	object	The details of the access control policy.
PolicyDocument	string	The document of the access control policy.	{\"Version\":\"1\",\"Statement\":[{\"Effect\":\"Deny\",\"Action\":[\"ram:UpdateRole\",\"ram:DeleteRole\",\"ram:AttachPolicyToRole\",\"ram:DetachPolicyFromRole\"],\"Resource\":\"acs:ram:::role/ResourceDirectoryAccountAccessRole\"}]}
UpdateDate	string	The time when the access control policy was updated.	2021-03-18T08:51:33Z
Description	string	The description of the access control policy.	ExampleControlPolicy
EffectScope	string	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.	RAM
AttachmentCount	string	The number of times that the access control policy is referenced.	0
PolicyName	string	The name of the access control policy.	test
PolicyId	string	The ID of the access control policy.	cp-SImPt8GCEwiq****
CreateDate	string	The time when the access control policy was created.	2021-03-18T08:51:33Z
PolicyType	string	The type of the access control policy. Valid values: System: system access control policy Custom: custom access control policy	Custom
RequestId	string	The ID of the request.	AB769936-CDFA-4D52-8CE2-A3581800044A

Examples

Sample success responses

JSONformat

{
  "ControlPolicy": {
    "PolicyDocument": "{\\\"Version\\\":\\\"1\\\",\\\"Statement\\\":[{\\\"Effect\\\":\\\"Deny\\\",\\\"Action\\\":[\\\"ram:UpdateRole\\\",\\\"ram:DeleteRole\\\",\\\"ram:AttachPolicyToRole\\\",\\\"ram:DetachPolicyFromRole\\\"],\\\"Resource\\\":\\\"acs:ram:*:*:role/ResourceDirectoryAccountAccessRole\\\"}]}",
    "UpdateDate": "2021-03-18T08:51:33Z",
    "Description": "ExampleControlPolicy",
    "EffectScope": "RAM",
    "AttachmentCount": "0",
    "PolicyName": "test",
    "PolicyId": "cp-SImPt8GCEwiq****",
    "CreateDate": "2021-03-18T08:51:33Z",
    "PolicyType": "Custom"
  },
  "RequestId": "AB769936-CDFA-4D52-8CE2-A3581800044A"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history