ListUserTenants - 获取当前的租户列表 - 数据管理 DMS

获取当前的租户列表。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dms:ListUserTenants	list	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。	3***

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	C478D9DA-3615-50F6-A2BC-7855AD65****
TenantList	array<object>	租户信息列表。
Tenant	object	租户信息列表。
Status	string	租户状态，返回值如下： ACTIVE：活跃，表示用户正处于当前租户下。 IN_ACTIVE：非活跃。	ACTIVE
Tid	long	租户 ID。	3***
TenantName	string	租户名称。	test_name
ErrorCode	string	错误码。	TenantNotExist
ErrorMessage	string	错误信息。	The specified tenant does not exist.
Success	boolean	请求是否成功，返回值如下： 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
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史