All Products
Search
Document Center

:GetRole

Last Updated:May 20, 2024

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /api/metastore/auth/roles

Request parameters

ParameterTypeRequiredDescriptionExample
RoleNamestringNo

roleName

role_name

Response parameters

ParameterTypeDescriptionExample
object

Response

RequestIdstring

requestId

4316D7DA-9816-596D-A3D7-12676FA59BDA
Codestring

code

OK
Messagestring

message

.
Successboolean

success

true
RoleRole

role

Examples

Sample success responses

JSONformat

{
  "RequestId": "4316D7DA-9816-596D-A3D7-12676FA59BDA",
  "Code": "OK",
  "Message": ".",
  "Success": true,
  "Role": {
    "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.