ListRoles

更新时间:
复制 MD 格式

You can invoke ListRoles to obtain all roles under a specified instance.

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 parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

Instance ID.

ccc-test

Response elements

Element

Type

Description

Example

object

Code

string

Response code.

OK

HttpStatusCode

integer

HTTP status code.

200

Message

string

Response message.

RequestId

string

Request ID.

711D948F-C616-4E23-8573-0F260513CE09

Data

array<object>

List of roles.

object

Name

string

Role name.

Valid values:

  • Agent :

    Agent

  • Admin :

    Administrator

  • Manager :

    Skill Group Leader

Admin

RoleId

string

Role ID, in the format: role@instance ID.

Admin@ccc-test

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "711D948F-C616-4E23-8573-0F260513CE09",
  "Data": [
    {
      "Name": "Admin",
      "RoleId": "Admin@ccc-test"
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 Parameter.Invalid The parameter %s is invalid. %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.