All Products
Search

This Product

    Resource Management:GetPolicy

    Document Center

    Resource Management:GetPolicy

    Last Updated:Jun 05, 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:*:{#accountId}:policy/{#PolicyName}
    • Policy
      acs:ram:*:system:policy/{#PolicyName}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    PolicyNamestringYes

    The name of the policy.

    The name must be 1 to 128 characters in length and can contain letters, digits, and hyphens (-).

    		OSS-Administrator
    PolicyTypestringYes

    The type of the policy. Valid values:

    • Custom: custom policy
    • System: system policy
    		Custom
    LanguagestringNo

    The language that is used to return the description of the system policy. Valid values:

    • en: English
    • zh-CN: Chinese
    • ja: Japanese
    		zh-CN

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

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

    The information of the policy.

    DefaultVersionstring

    The default version of the policy.

    		v1
    UpdateDatestring

    The time when the policy was updated.

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

    The description of the policy.

    		OSS administrator
    PolicyDocumentstring

    The document of the policy.

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

    The number of times the policy is referenced.

    		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. Valid values:

    • Custom: custom policy
    • System: system policy
    		Custom

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameter.PolicyTypeThe specified policy type is invalid.The specified policy type is invalid.
    400InvalidParameter.PolicyName.InvalidCharsThe 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 (-).
    400InvalidParameter.PolicyName.LengthThe length of the policy name is invalid. It must be 1 to 64 characters in length.-
    404EntityNotExist.PolicyThe policy does not exist.The policy does not exist.

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

    Change history

    Change timeSummary of changesOperation
    No change history