调用ListUserTenants获取当前的租户列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListUserTenants

系统规定参数。取值：ListUserTenants。

RegionId String 是 cn-hangzhou

DMS服务地域，请您根据应用所在地就近选择。取值请参见RegionID参数说明。

Tid Long 否 3***

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

返回数据

名称 类型 示例值 描述
RequestId String C478D9DA-3615-50F6-A2BC-7855AD65****

请求ID。
TenantList Array of Tenant

租户信息列表。
Status String ACTIVE

租户状态，返回值如下：

  • ACTIVE：活跃，表示用户正处于当前租户下。
  • IN_ACTIVE：非活跃。
Tid Long 3***

租户ID。
TenantName String test_name

租户名称。
ErrorCode String TenantNotExist

错误码。
ErrorMessage String The specified tenant does not exist.

错误信息。
Success Boolean true

请求是否成功，返回值如下：

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

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListUserTenants
&Tid=3***
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListUserTenantsResponse>
    <RequestId>C478D9DA-3615-50F6-A2BC-7855AD65****</RequestId>
    <TenantList>
        <Status>ACTIVE</Status>
        <TenantName>test_name</TenantName>
        <Tid>3***</Tid>
    </TenantList>
    <Success>true</Success>
</ListUserTenantsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C478D9DA-3615-50F6-A2BC-7855AD65****",
  "TenantList" : [ {
    "Status" : "ACTIVE",
    "TenantName" : "test_name",
    "Tid" : "3***"
  } ],
  "Success" : true
}

错误码

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