You need to enable JavaScript to run this app.
导航
ListUsers - 用户列表
最近更新时间:2024.10.09 17:05:55首次发布时间:2024.10.09 17:01:20

获取租户下的用户列表

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

ListUsers

要执行的操作,取值:ListUsers。

Version
String

2024-08-31

API的版本,取值:2024-08-31。

Offset
Integer

0

分页查询起始位置

Limit
Integer

10

分页大小

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Message
String

top响应信息

Data
Object

{
"Users": [
{
"ID": 123,
"UserID": 12345678,
"AccountID": 12345678,
"Username": "user1",
"CloudName": "cloudname",
"UserType": "MAIN",
"Status": "ACTIVE",
"Emaill": "xxx@xxx.com",
"Description": "description",
"Readonly": true,
"IsSystemAdmin": true,
"LastLoginAt": 0,
"CreatedAt": 1716264720906,
"UpdatedAt": 1716264720906,
"Clusters": [
"UGyGxMqpT"
]
}
],
"Message": ""
}

返回数据

Meta
Object

{
"Offset": 0,
"Total": 184
}

分页相关数据

请求示例

GET /?Action=ListUsers&Version=2024-08-31&Offset=0&Limit=10 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240912T132732Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240912/cn-beijing/bytehouse_ce/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f


返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240925120141117050224247117731",
    "Action": "ListUsers",
    "Version": "2024-08-31",
    "Service": "bytehouse_ce",
    "Region": "cn-beijing"
  },
  "Result": {
    "Message": "",
    "Data": {
      "Users": [
        {
          "ID": 123,
          "UserID": 12345678,
          "AccountID": 12345678,
          "Username": "user1",
          "CloudName": "cloudname",
          "UserType": "MAIN",
          "Status": "ACTIVE",
          "Emaill": "xxx@xxx.com",
          "Description": "description",
          "Readonly": true,
          "IsSystemAdmin": true,
          "LastLoginAt": 0,
          "CreatedAt": 1716264720906,
          "UpdatedAt": 1716264720906,
          "Immutable": true,
          "Clusters": [
            "98Al3s"
          ]
        }
      ]
    },
    "Meta": {
      "Offset": 0,
      "Total": "1"
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
Bad Request
api service received invalid request format

参数错误

401
SignatureNotMatch
The request signature provided is incorrect.
500
InternalError
The request has failed due to an unknown error.
503
ServiceUnavailable
The request has failed due to a temporary failure of the server.