全部產品
Search
文件中心

Data Management:ListUserTenants - 擷取當前的租戶列表

更新時間:Mar 21, 2026

擷取當前的租戶列表。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:ListUserTenants

list

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

Tid

integer

租戶 ID,可通過調用介面 GetUserActiveTenant 擷取該參數的值。

3***

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

C478D9DA-3615-50F6-A2BC-7855AD65****

TenantList

array<object>

租戶資訊列表。

object

租戶資訊列表。

Status

string

租戶狀態,傳回值如下:

  • ACTIVE:活躍,表示使用者正處於當前租戶下。

  • IN_ACTIVE:非活躍。

ACTIVE

Tid

integer

租戶 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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情