首页 数据管理 DMS API参考 API目录 用户管理 GetUserActiveTenant - 获取当前所处的租户信息

GetUserActiveTenant - 获取当前所处的租户信息

获取当前所处的租户信息。

调试

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

调试

授权信息

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

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

请求参数

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

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

3***

返回参数

名称类型描述示例值
object
Tenantobject

租户信息。

Statusstring

租户状态,返回值如下:

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

租户ID。

3***
TenantNamestring

租户名称。

test_name
RequestIdstring

请求ID。

4B63CAC5-BD7F-5C7C-82C9-59DFFBC3C5C2
ErrorCodestring

错误码。

TenantNotExist
ErrorMessagestring

错误信息。

The specified tenant does not exist.
Successboolean

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

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

示例

正常返回示例

JSON格式

{
  "Tenant": {
    "Status": "ACTIVE",
    "Tid": 0,
    "TenantName": "test_name"
  },
  "RequestId": "4B63CAC5-BD7F-5C7C-82C9-59DFFBC3C5C2",
  "ErrorCode": "TenantNotExist",
  "ErrorMessage": "The specified tenant does not exist.",
  "Success": true
}

错误码

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

阿里云首页 数据管理 DMS 相关技术圈