ListPolicyAttachments - Resource Management - Alibaba Cloud Documentation Center

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

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
ResourceGroupId	string	No	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
PolicyType	string	No	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
PolicyName	string	No	The name of the policy. The name must be 1 to 128 characters in length and can contain letters, digits, and hyphens (-).	AdministratorAccess
PrincipalType	string	No	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
PrincipalName	string	No	The name of the object to which the policy is attached.	alice@demo.onaliyun.com
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10
Language	string	No	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

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	7B8A4E7D-6CFF-471D-84DF-195A7A241ECB
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	2
PolicyAttachments	array<object>	The policy attachment records.
PolicyAttachment	object	The policy attachment records.
Description	string	The description of the policy.	The description of the policy.
ResourceGroupId	string	The ID of the resource group or the ID of the Alibaba Cloud account to which the resource group belongs.	rg-9gLOoK****
PolicyName	string	The name of the policy.	AdministratorAccess
PrincipalName	string	The name of the object to which the policy is attached.	alice@demo.onaliyun.com
AttachDate	string	The time when the policy was attached.	2015-01-23T12:33:18Z
PolicyType	string	The type of the policy. Valid values: Custom: custom policy System: system policy	System
PrincipalType	string	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 code	Error code	Error message	Description
400	InvalidParameter.PolicyType	The specified policy type is invalid.	The specified policy type is invalid.
404	EntityNotExists.ResourceGroup	The 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.
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