文档

ListUserTenants - 获取当前的租户列表

获取当前的租户列表。

调试

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

授权信息

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

请求参数

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

租户 ID,可通过调用接口 GetUserActiveTenant 获取该参数的值。

3***

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

C478D9DA-3615-50F6-A2BC-7855AD65****
TenantListarray<object>

租户信息列表。

object

租户信息列表。

Statusstring

租户状态,返回值如下:

  • ACTIVE:活跃,表示用户正处于当前租户下。
  • IN_ACTIVE:非活跃。
ACTIVE
Tidlong

租户 ID。

3***
TenantNamestring

租户名称。

test_name
ErrorCodestring

错误码。

TenantNotExist
ErrorMessagestring

错误信息。

The specified tenant does not exist.
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true

示例

正常返回示例

JSON格式

{
  "RequestId": "C478D9DA-3615-50F6-A2BC-7855AD65****",
  "TenantList": [
    {
      "Status": "ACTIVE",
      "Tid": 0,
      "TenantName": "test_name"
    }
  ],
  "ErrorCode": "TenantNotExist",
  "ErrorMessage": "The specified tenant does not exist.",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史