Resource Access Management:GetPolicy - Resource Access Management - Alibaba Cloud - Resource Access Management

Retrieves the information of a specified access policy.

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

ram:GetPolicy

get

Policy

acs:ram:*:system:policy/{#PolicyName}

Policy

acs:ram:*:{#accountId}:policy/{#PolicyName}

None

Request parameters

Parameter	Type	Required	Description	Example
PolicyType	string	No	The type of the access policy. Valid values: `System`, `Custom`.	Custom
PolicyName	string	No	The name of the access policy.	OSS-Administrator

Response elements

Element	Type	Description	Example
	object	The response parameters.
Policy	object	The basic information of the access policy.
DefaultVersion	string	The default version.	v1
UpdateDate	string	The time when the policy was last modified. The time is in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`.	2015-01-23T12:33:18Z
Description	string	The description of the access policy.	OSS administrator permissions
PolicyDocument	string	Deprecated.	N/A
AttachmentCount	integer	The number of references.	0
PolicyName	string	The name of the access policy.	OSS-Administrator
CreateDate	string	The time when the policy was created. The time is in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`.	2015-01-23T12:33:18Z
PolicyType	string	The type of the access policy.	Custom
RequestId	string	The request ID.	697852FB-50D7-44D9-9774-530C31EAC572
DefaultPolicyVersion	object	The default version of the access policy.
IsDefaultVersion	boolean	The data structure returned by `DefaultPolicyVersion` is always the default version. Therefore, the value of `IsDefaultVersion` is always `true`.	true
PolicyDocument	string	The policy document of the access policy.	{ "Statement": [{ "Action": ["oss:"], "Effect": "Allow", "Resource": ["acs:oss:::"]}], "Version": "1"}
VersionId	string	The version of the access policy.	v1
CreateDate	string	The time when the policy was created. The time is in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`.	2015-01-23T12:33:18Z

Examples

Success response

JSON format

{
  "Policy": {
    "DefaultVersion": "v1",
    "UpdateDate": "2015-01-23T12:33:18Z",
    "Description": "OSS administrator permission",
    "PolicyDocument": "N/A",
    "AttachmentCount": 0,
    "PolicyName": "OSS-Administrator",
    "CreateDate": "2015-01-23T12:33:18Z",
    "PolicyType": "Custom"
  },
  "RequestId": "697852FB-50D7-44D9-9774-530C31EAC572",
  "DefaultPolicyVersion": {
    "IsDefaultVersion": true,
    "PolicyDocument": "{ \"Statement\": [{ \"Action\": [\"oss:*\"], \"Effect\": \"Allow\", \"Resource\": [\"acs:oss:*:*:*\"]}], \"Version\": \"1\"}",
    "VersionId": "v1",
    "CreateDate": "2015-01-23T12:33:18Z"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.