All Products
Search
Document Center

Resource Management:ListPolicyAttachments

Last Updated:Jun 05, 2024

Queries policy attachment records.

Operation description

You can view the following information:

  • Policy attachment records under an Alibaba Cloud account or a resource group
  • Policies attached to RAM users, RAM user groups, or RAM roles
  • RAM users, RAM user groups, or RAM roles to which policies are attached under an Alibaba Cloud account or a resource group

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:ListPolicyAttachmentsList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

The ID of the resource group or the ID of the Alibaba Cloud account to which the resource group belongs. If you do not specify this parameter, the system lists all policy attachment records under the current account.

rg-001
PolicyTypestringNo

The type of the policy. If you do not specify this parameter, the system lists all types of policies. Valid values:

  • Custom: custom policy
  • System: system policy
System
PolicyNamestringNo

The name of the policy.

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

AdministratorAccess
PrincipalTypestringNo

The type of the object to which the policy is attached. If you do not specify this parameter, the system lists all types of objects. Valid values:

  • IMSUser: RAM user
  • IMSGroup: RAM user group
  • ServiceRole: RAM role
IMSUser
PrincipalNamestringNo

The name of the object to which the policy is attached.

alice@demo.onaliyun.com
PageNumberintegerNo

The number of the page to return.

Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

Valid values: 1 to 100. Default value: 10.

10
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.

7B8A4E7D-6CFF-471D-84DF-195A7A241ECB
PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of returned entries.

2
PolicyAttachmentsobject []

The policy attachment records.

Descriptionstring

The description of the policy.

The description of the policy.
ResourceGroupIdstring

The ID of the resource group or the ID of the Alibaba Cloud account to which the resource group belongs.

rg-9gLOoK****
PolicyNamestring

The name of the policy.

AdministratorAccess
PrincipalNamestring

The name of the object to which the policy is attached.

alice@demo.onaliyun.com
AttachDatestring

The time when the policy was attached.

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

The type of the policy. Valid values:

  • Custom: custom policy
  • System: system policy
System
PrincipalTypestring

The type of the object to which the policy is attached. Valid values:

  • IMSUser: RAM user
  • IMSGroup: RAM user group
  • ServiceRole: RAM role
IMSUser

Examples

Sample success responses

JSONformat

{
  "RequestId": "7B8A4E7D-6CFF-471D-84DF-195A7A241ECB",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 2,
  "PolicyAttachments": {
    "PolicyAttachment": [
      {
        "Description": "The description of the policy.",
        "ResourceGroupId": "rg-9gLOoK****",
        "PolicyName": "AdministratorAccess",
        "PrincipalName": "alice@demo.onaliyun.com",
        "AttachDate": "2015-01-23T12:33:18Z",
        "PolicyType": "System",
        "PrincipalType": "IMSUser"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.PolicyTypeThe specified policy type is invalid.The specified policy type is invalid.
404EntityNotExists.ResourceGroupThe specified resource group does not exist. You must first create a resource group.The specified resource group does not exist. You must first create a resource group.
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