All Products
Search
Document Center

Resource Access Management:GetPolicy

Last Updated:Mar 11, 2024

Queries the information of a policy.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
ram:GetPolicyRead
  • Policy
    acs:ram:*:system:policy/{#PolicyName}
  • Policy
    acs:ram:*:{#accountId}:policy/{#PolicyName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PolicyTypestringYes

The type of the policy. Valid values: System and Custom.

Custom
PolicyNamestringYes

The name of the policy.

OSS-Administrator

Response parameters

ParameterTypeDescriptionExample
object
Policyobject

The basic information of the policy.

DefaultVersionstring

The default version ID of the policy.

v1
UpdateDatestring

The time when the policy was modified.

2015-01-23T12:33:18Z
Descriptionstring

The description of the policy.

OSS administrator
PolicyDocumentstring

This parameter is deprecated.

N/A
AttachmentCountinteger

The number of references to the policy.

0
PolicyNamestring

The name of the policy.

OSS-Administrator
CreateDatestring

The time when the policy was created.

2015-01-23T12:33:18Z
PolicyTypestring

The type of the policy.

Custom
RequestIdstring

The ID of the request.

697852FB-50D7-44D9-9774-530C31EAC572
DefaultPolicyVersionobject

The information of the default policy version.

IsDefaultVersionboolean

An attribute in the DefaultPolicyVersion parameter. The value of the IsDefaultVersion parameter is true.

true
PolicyDocumentstring

The script of the default policy version.

{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}
VersionIdstring

The ID of the default policy version.

v1
CreateDatestring

The time when the default policy version was created.

2015-01-23T12:33:18Z

Examples

Sample success responses

JSONformat

{
  "Policy": {
    "DefaultVersion": "v1",
    "UpdateDate": "2015-01-23T12:33:18Z",
    "Description": "OSS administrator",
    "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

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

Change history

Change timeSummary of changesOperation
No change history