文档

ListRamUsers - 获取RAM用户列表

更新时间:

调用ListRamUsers获取未导入指定实例下的RAM用户列表。

接口说明

一个 RAM 用户可以作为坐席导入到多个实例下,但是一个坐席只能指向一个 RAM 账户,如果我们在实例下创建坐席,实际上是创建了一个 RAM 账户的,此时如果想创建一个新的实例又不想创建多余的 RAM 账户,就可以调用 ListRamUsers 接口获取未导入实例下的 RAM 用户列表,然后再调用导入 RAM 用户的接口将 RAM 用户导入到实例下。这样可以避免过多的创建 RAM 账户,造成资源浪费。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

ccc-test
SearchPatternstring

根据坐席登录名或坐席展示名进行模糊匹配,非必填,默认为空,为空表示不过滤。

agent
PageNumberinteger

分页序号,范围 1-1000。

1
PageSizeinteger

分页大小,范围 1-100。

10

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

24753D71-C91D-1A38-A8AD-372BF12453F6
Dataobject

数据。

PageNumberinteger

分页序号,范围 1-1000。

1
PageSizeinteger

分页大小,范围 1-100。

10
TotalCountinteger

总数。

100
Listobject []

RAM 用户列表。

DisplayNamestring

RAM 账户姓名。

测试账号
Emailstring

邮箱。

username@example.com
LoginNamestring

RAM 用户名。

agent
Mobilestring

RAM 账户预留的个人电话号码。

1382114****
AliyunUidlong

RAM 账户所属的阿里云主账号 UID。

15772400000****
Primaryboolean

RAM 账号是否为主账号。

false
RamIdstring

RAM 用户的 UID。

28036411123456****
Paramsarray
string

响应参数。

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "24753D71-C91D-1A38-A8AD-372BF12453F6",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "List": [
      {
        "DisplayName": "测试账号",
        "Email": "username@example.com",
        "LoginName": "agent",
        "Mobile": "1382114****",
        "AliyunUid": 0,
        "Primary": false,
        "RamId": "28036411123456****"
      }
    ]
  },
  "Params": [
    "无"
  ]
}

错误码

HTTP status code错误码错误信息描述
400Parameter.MaximumThe parameter %s must be less than or equal to %s.参数必须小于或等于系统规定的最大值。
400Parameter.MinimumThe parameter %s must be greater than or equal to %s.参数必须大于或等于系统规定的最小值。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-11-06OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈