GetRole - Data Lake Formation - Alibaba Cloud Documentation Center

Retrieves a role.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /dlf/v1/auth/roles HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
rolePrincipal	string	No	The resource descriptor of the role.	acs:dlf::[accountId]:role/role_name

Response elements

Element	Type	Description	Example
	Role	The role details.

Examples

Success response

JSON format

{
  "createdAt": 0,
  "isPredefined": "",
  "updatedBy": "",
  "createdBy": "",
  "displayName": "",
  "roleName": "",
  "description": "",
  "rolePrincipal": "",
  "users": [
    {
      "createdAt": 0,
      "updatedBy": "",
      "createdBy": "",
      "displayName": "",
      "userName": "",
      "type": "",
      "userId": "",
      "userPrincipal": "",
      "updatedAt": 0
    }
  ],
  "updatedAt": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.