GetPolicy - Resource Management - Alibaba Cloud Documentation Center

Queries the information about a permission policy.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PolicyName	string	Yes	The name of the permission policy. The 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 permission policy. Valid values: Custom System	Custom
Language	string	No	The language in which you want to return the description of the system permission policy. Valid values: en: English zh-CN: Chinese ja: Japanese	zh-CN

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
Policy	object	The information about the permission policy.
AttachmentCount	integer	The number of references to the permission policy.	0
CreateDate	string	The time when the permission policy was created.	2015-01-23T12:33:18Z
DefaultVersion	string	The default version of the permission policy.	v1
Description	string	The description of the permission policy.	OSS administrator
PolicyDocument	string	The document of the permission policy.	{ "Statement": [{ "Action": ["oss:"], "Effect": "Allow", "Resource": ["acs:oss:::"]}], "Version": "1"}
PolicyName	string	The name of the permission policy.	OSS-Administrator
PolicyType	string	The type of the permission policy. Valid values: Custom System	Custom
UpdateDate	string	The time when the permission policy was updated.	2016-01-23T12:33:18Z
RequestId	string	The request ID.	697852FB-50D7-44D9-9774-530C31EAC572

Examples

Sample success responses

JSONformat

{
  "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.

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

Change history

Change time	Summary of changes	Operation

No change history