ListRoles - - Alibaba Cloud Documentation Center

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /api/metastore/auth/roles/list

Request parameters

Parameter	Type	Required	Description	Example
NextPageToken	string	No	Next PageToken	token!

Response parameters

Parameter	Type	Description	Example
	object	Response
RequestId	string	requestId	B7F4B621-E41E-4C84-B97F-42B5380A32BB
Code	string	code	OK
Message	string	message	.
Success	boolean	success	True
NextPageToken	string	data	2cb472ec1bf84f8d92f9c4baa0d21c19aa
Roles	Roles	role list data	[ { "Description":"reserved by the system", "DisplayName":"admin", "UpdateTime":0, "IsPredefined":1, "Name":"admin" } ]

Examples

Sample success responses

JSONformat

{
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Code": "OK",
  "Message": ".",
  "Success": true,
  "NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa",
  "Roles": [
    {
      "Name": "role_name",
      "Description": "role description",
      "Users": [
        {
          "PrincipalArn": "acs:ram::[AliyunAccountId]:user/username_abc"
        }
      ],
      "DisplayName": "显示名称，允许中文",
      "PrincipalArn": "acs:dlf::111:role/role_name",
      "CreateTime": 1647323053,
      "UpdateTime": 1647323053,
      "IsPredefined": 1
    }
  ]
}

Error codes

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