すべてのプロダクト
Search

このプロダクト

    ApsaraDB for OceanBase (Deprecated):DescribeTenants

    ドキュメントセンター

    ApsaraDB for OceanBase (Deprecated):DescribeTenants

    最終更新日:May 26, 2026

    指定された OceanBase クラスターのテナント情報を一覧表示します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    oceanbase:DescribeTenants

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンスの ID。

    ob317v4uif****
    TenantName

    string

    任意

    テナント名。
    名前は 2 ～ 20 文字である必要があり、先頭は英字またはアンダースコアで始まり、英字、数字、アンダースコア (_) で構成されます。名前は大文字と小文字を区別します。「sys」は予約済みの名前のため使用できません。

    pay_online
    PageSize

    integer

    任意

    1 ページあたりに返す項目数。

    • 最大値： 100

    • デフォルト値： 10

    10
    PageNumber

    integer

    任意

    返すページ番号。

    • 最小値： 1

    • デフォルト値： 1

    1
    TenantId

    string

    任意

    テナントの ID。

    ob2mr3oae0****
    SearchKey

    string

    任意

    クエリ結果をフィルターするキーワード。

    pay

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答データ。

    TotalCount

    integer

    指定された OceanBase クラスター内のテナントの総数。

    1
    RequestId

    string

    リクエスト ID。

    EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
    Tenants

    array<object>

    テナントオブジェクトのリスト。

    object

    テナントオブジェクト。

    VpcId

    string

    VPC の ID。
    適切な VPC が利用できない場合は、ページ上のプロンプトに従って作成してください。詳細については、「VPC とは」をご参照ください。

    vpc-bp1d2q3mhg9i23ofi****
    Status

    string

    テナントのステータス。

    • PENDING_CREATE：作成中

    • RESTORE：復元中

    • ONLINE：稼働中

    • SPEC_MODIFYING：仕様の変更中

    • ALLOCATING_INTERNET_ADDRESS：パブリックエンドポイントの割り当て中

    • PENDING_OFFLINE_INTERNET_ADDRESS：パブリックエンドポイントの無効化中

    • PRIMARY_ZONE_MODIFYING：プライマリゾーンの切り替え中

    • PARAMETER_MODIFYING：パラメータの変更中

    • WHITE_LIST_MODIFYING：ホワイトリストの変更中

    ONLINE
    PrimaryZone

    string

    テナントのプライマリゾーン。

    cn-hangzhou-i
    DeployType

    string

    テナントのデプロイタイプ。

    • multiple：マルチデータセンターデプロイ

    • single：シングルデータセンターデプロイ

    • dual：デュアルデータセンターデプロイ

    multiple
    DeployMode

    string

    テナントのデプロイモード。

    • 高可用性エディションの場合、3 ゾーンデプロイでは N-N-N、2 ゾーンおよび単一ゾーンデプロイでは N-N です。

    • ベーシックエディションの場合、値は N です。

    説明


    N はアベイラビリティーゾーンあたりのノード数を表します。

    1-1-1
    CreateTime

    string

    テナントが作成された日時。

    2021-09-17 15:52:17.0
    TenantName

    string

    テナント名。

    pay_online
    Mem

    integer

    テナントの合計メモリ (単位: GB)。

    20
    Cpu

    integer

    テナントの CPU コアの合計数。

    10
    Description

    string

    テナントの説明。

    paycore database
    TenantMode

    string

    テナントモード。
    有効な値：

    • Oracle：Oracle 互換モード

    • MySQL：MySQL 互換モード

    Oracle
    TenantId

    string

    テナント ID。

    t33h8y08k****
    UnitCpu

    integer

    テナントユニットあたりの CPU コア数。

    5
    UnitMem

    integer

    テナントユニットあたりのメモリサイズ (単位: GB)。

    10
    UnitNum

    integer

    テナント内のユニット数。

    2
    UsedDiskSize

    number

    テナントが使用しているディスク領域のサイズ。

    10
    Charset

    string

    文字セット。

    utf8mb4
    Collation

    string

    照合順序。

    utf8mb4_general_ci
    EnableReadOnlyReplica

    boolean

    true

    ParameterTemplate

    string

    パラメータテンプレート。

    express_oltp
    Iops

    integer

    10000

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Tenants": [
    {
      "VpcId": "vpc-bp1d2q3mhg9i23ofi****",
      "Status": "ONLINE",
      "PrimaryZone": "cn-hangzhou-i",
      "DeployType": "multiple",
      "DeployMode": "1-1-1",
      "CreateTime": "2021-09-17 15:52:17.0",
      "TenantName": "pay_online",
      "Mem": 20,
      "Cpu": 10,
      "Description": "paycore database",
      "TenantMode": "Oracle",
      "TenantId": "t33h8y08k****",
      "UnitCpu": 5,
      "UnitMem": 10,
      "UnitNum": 2,
      "UsedDiskSize": 10,
      "Charset": "utf8mb4",
      "Collation": "utf8mb4_general_ci",
      "EnableReadOnlyReplica": true,
      "ParameterTemplate": "express_oltp",
      "Iops": 10000
    }
  ]
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。