Call GetPolicy to query permission policy information - Resource Management - Alibaba Cloud - Resource Management

Retrieves information about 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PolicyName	string	Yes	Policy Name of the access policy. Policy Name must be 1 to 128 characters in length and can contain letters, digits, and hyphens (-).	OSS-Administrator
PolicyType	string	Yes	The type of the access policy. Valid values: Custom: custom policy. System: system policy. Valid values: Custom : Custom policy. System : System policy.	Custom
Language	string	No	The language type. The description of the system access policy is returned in the specified language. Valid values: en: English. zh-CN: Chinese. ja: Japanese.	zh-CN

Response elements

Element	Type	Description	Example
	object	The response parameters.
Policy	object	The access policy information.
AttachmentCount	integer	The number of references.	0
CreateDate	string	The time when the access policy was created. The time is in RFC 3339 UTC format, indicated by Z.	2015-01-23T12:33:18Z
DefaultVersion	string	The default version of the access policy.	v1
Description	string	The description of the access policy.	OSS administrator permissions
PolicyDocument	string	The content of the access policy.	{ "Statement": [{ "Action": ["oss:"], "Effect": "Allow", "Resource": ["acs:oss:::"]}], "Version": "1"}
PolicyName	string	The Policy Name of the access policy.	OSS-Administrator
PolicyType	string	The type of the access policy. Valid values: Custom: custom policy. System: system policy.	Custom
UpdateDate	string	The time when the access policy was last updated. The time is in RFC 3339 UTC format, indicated by Z.	2016-01-23T12:33:18Z
RequestId	string	The request ID.	697852FB-50D7-44D9-9774-530C31EAC572

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.PolicyType	The specified policy type is invalid.	The specified policy type is invalid.
400	InvalidParameter.PolicyName.InvalidChars	The policy name contains invalid characters. It must only contain upper or lower case letters, numbers, and dash (-).	The policy name contains invalid characters. It must only contain upper or lower case letters, numbers, and dash (-).
400	InvalidParameter.PolicyName.Length	The length of the policy name is invalid. It must be 1 to 128 characters in length.	The maximum length of the policy name is exceeded. It must be 1 to 128 characters in length.
404	EntityNotExist.Policy	The policy does not exist.	The policy does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.