すべてのプロダクト
Search

このプロダクト

    ApsaraDB for OceanBase (Deprecated):DescribeInstanceTopology

    ドキュメントセンター

    ApsaraDB for OceanBase (Deprecated):DescribeInstanceTopology

    最終更新日: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:DescribeInstanceTopology

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    OceanBase クラスターの ID です。

    ob317v4uif****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    リクエストに対して返されるデータです。

    RequestId

    string

    リクエスト ID です。

    EE205C00-30E4-****-****-87E3A8A2AA0C
    InstanceTopology

    object

    クラスターのトポロジーです。

    Tenants

    array<object>

    テナントのリストです。

    array<object>

    テナントの詳細です。

    TenantId

    string

    テナント ID です。

    t33h8y08k****
    TenantName

    string

    テナント名です。

    pay_online
    TenantCpu

    number

    テナントの CPU コア数です。

    2
    TenantMemory

    number

    テナントのメモリサイズです。単位：GB

    10
    TenantMode

    string

    テナントモードです。

    • Oracle：Oracle モード

    • MySQL：MySQL モード

    Oracle
    TenantZones

    array<object>

    テナントのゾーンリストです。

    array<object>

    テナントゾーンの詳細です。

    TenantZoneRole

    string

    ゾーンのアクセスロールです。

    • ReadWrite：読み取り/書き込みが可能なゾーン

    • ReadOnly：読み取り専用ゾーン

    ReadWrite
    IsPrimaryTenantZone

    boolean

    ゾーンがプライマリゾーンかどうかを示します。

    true
    TenantZoneId

    string

    ゾーン ID です。

    cn-hangzhou-h
    Units

    array<object>

    リソースユニットのリストです。

    object

    ユニットの詳細です。

    UnitId

    string

    リソースユニット ID です。

    1002
    UnitStatus

    string

    リソースユニットのステータスです。

    • ONLINE：ユニットは実行中です

    • IMMIGRATING：ユニットは移行 (転入) 中です

    • EMIGRATING：ユニットは移行 (転出) 中です

    • CANCEL_IMMIGRATING：移行 (転入) をキャンセル中です

    • CANCEL_EMIGRATING：移行 (転出) をキャンセル中です

    • DELETING：ユニットは削除中です

    ONLINE
    NodeId

    string

    リソースユニットが配置されている OBServer ノードの ID です。

    i-bp16niirq4zdmgvm****
    UnitCpu

    number

    ユニットの CPU コア数です。

    2
    UnitMemory

    number

    ユニットのメモリサイズです。単位：GB

    10
    EnableMigrateUnit

    boolean

    ユニットが移行可能かどうかを示します。

    true
    ManualMigrate

    boolean

    移行が手動であるかどうかを示します。

    true
    EnableCancelMigrateUnit

    boolean

    移行をキャンセルできるかどうかを示します。
    このパラメーターは、手動で移行中のユニットにのみ適用されます。

    true
    UnitDataSize

    integer

    ユニットが使用するデータ量です。

    10
    ReplicaType

    string

    レプリカタイプです。
    OceanBase クラスターのモニタリングでは、このパラメーターを使用してノードをフィルタリングします。

    • デフォルトでは、このパラメーターは指定されません。この設定は、OceanBase のモニタリングとアクセスプロキシのモニタリングに適用されます。OceanBase のモニタリングクエリの場合、このパラメーターを指定しないと、すべてのレプリカタイプのノードのデータが返されます。

    • FULL：この値は OceanBase のモニタリングでのみ有効です。フル機能レプリカのモニタリングデータのみを照会します。

    • READONLY：この値は OceanBase のモニタリングでのみ有効です。読み取り専用レプリカのモニタリングデータのみを照会します。

    FULL
    LogicalZone

    string

    論理ゾーンです。

    cn-hangzhou-h-z0
    ReplicaType

    string

    テナントのレプリカタイプです。

    FULL
    ReadOnlyReplicaType

    string

    読み取り専用レプリカタイプです。

    ROW_STORE
    TenantStatus

    string

    テナントのステータスです。

    • PENDING_CREATE：テナントを作成中です

    • RESTORE：テナントを復元中です

    • ONLINE：テナントは実行中です

    • SPEC_MODIFYING：仕様を変更中です

    • ALLOCATING_INTERNET_ADDRESS：パブリック IP アドレスを割り当て中です

    • PENDING_OFFLINE_INTERNET_ADDRESS：パブリック IP アドレスを無効化中です

    • PRIMARY_ZONE_MODIFYING：プライマリゾーンを変更中です

    • PARAMETER_MODIFYING：パラメーターを変更中です

    • WHITE_LIST_MODIFYING：ホワイトリストを変更中です

    ONLINE
    TenantDeployType

    string

    テナントのデプロイメントタイプです。

    • multiple：複数のデータセンター

    • single：単一のデータセンター

    • dual：2つのデータセンター

    multiple
    TenantUnitNum

    integer

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

    1
    PrimaryZoneDeployType

    string

    プライマリゾーンのデプロイモードです。

    列挙値:

    • RANDOM :

      ランダム

    • STATIC :

      静的

    RANDOM
    TenantDiskSize

    number

    テナントのデータサイズです。

    2
    TenantUnitCpu

    number

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

    4
    TenantUnitMemory

    number

    テナントのユニットあたりのメモリサイズです。

    16
    Zones

    array<object>

    クラスターのゾーン情報です。

    array<object>

    ゾーンの詳細です。

    ZoneId

    string

    ゾーン ID です。

    cn-hangzhou-i
    Region

    string

    リージョン ID です。

    cn-hangzhou
    ZoneDisk

    string

    ゾーンのストレージ容量です。

    200 GB
    Nodes

    array<object>

    ノードのリストです。

    array<object>

    ノードの詳細です。

    NodeId

    string

    ノード ID です。

    i-bp16niirq4zdmgvm****
    NodeCopyId

    integer

    ノードが属するレプリカの ID です。

    1
    NodeStatus

    string

    ノードの実行ステータスです。

    ONLINE
    NodeResource

    object

    ノードのリソース情報です。

    Cpu

    object

    ノードの CPU リソースです。

    UsedCpu

    number

    ノードが使用する CPU コア数です。

    4
    TotalCpu

    integer

    ノードの合計 CPU コア数です。

    14
    Memory

    object

    ノードのメモリリソースです。

    UsedMemory

    number

    ノードが使用するメモリ量です。単位：GB

    10
    TotalMemory

    integer

    ノードの合計メモリサイズです。単位：GB

    70
    DiskSize

    object

    ノードのストレージリソースです。

    TotalDiskSize

    number

    ノードの合計ディスク領域です。単位：GB

    100
    UsedDiskSize

    number

    ノードの使用済みディスク領域です。単位：GB

    50
    ReplicaType

    string

    レプリカタイプです。有効な値：

    • FULL

    • READONLY

    FULL
    FullCopyId

    integer

    フル機能レプリカの ID です。

    1
    ReadOnlyCopyId

    integer

    読み取り専用レプリカの ID です。

    1
    LogicalZone

    string

    論理ゾーンです。

    cn-hangzhou-h-z0
    ReadOnlyReplicaType

    string

    読み取り専用レプリカタイプです。

    ROW_STORE
    ZoneResource

    object

    ゾーン情報です。

    DiskSize

    object

    ゾーンのストレージリソースです。

    MaxDiskUsedPercent

    number

    最大ディスク使用率 (パーセント) です。

    0.14
    MaxDiskUsedObServer

    array

    ディスク使用率が最も高い OBServer ノードの ID のリストです。

    string

    ディスク使用率が最も高い OBServer ノードの ID です。

    i-bp1fhj23fs32dfbg4****
    Replicas

    array<object>

    レプリカ情報です。

    array<object>

    レプリカの詳細です。

    LogicalZone

    string

    論理ゾーンです。

    cn-hangzhou-h-z0
    NodeNum

    integer

    レプリカノードの数です。

    1
    ZoneLogicalName

    string

    レプリカのリージョンです。

    cn-hangzhou-h
    ZoneRegionName

    string

    レプリカのゾーンです。

    cn-hangzhou-h
    ReplicaResource

    object

    レプリカのリソース情報です。

    Memory

    object

    レプリカのメモリリソースです。

    UsedMemory

    integer

    レプリカが使用するメモリ量です。

    16
    TotalMemory

    integer

    レプリカの合計メモリです。

    32
    DiskSize

    object

    レプリカのディスクリソースです。

    UsedDiskSize

    number

    レプリカが使用するディスク領域の量です。

    50
    TotalDiskSize

    integer

    レプリカの合計ディスク領域です。

    100
    Cpu

    object

    レプリカの CPU リソースです。

    TotalCpu

    integer

    レプリカの合計 CPU コア数です。

    16
    UsedCpu

    integer

    レプリカが使用する CPU コア数です。

    8
    ZoneLogicalId

    integer

    ゾーンの論理 ID です。

    1

    ReplicaType

    string

    レプリカタイプです。

    FULL
    Status

    string

    レプリカのステータスです。有効な値： ACTIVE、INACTIVE、UNKNOWN

    ACTIVE
    ReadOnlyReplicaType

    string

    読み取り専用レプリカタイプです。

    ROW_STORE
    OnlineNodeNum

    integer

    オンラインノードの数です。

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "InstanceTopology": {
    "Tenants": [
      {
        "TenantId": "t33h8y08k****",
        "TenantName": "pay_online",
        "TenantCpu": 2,
        "TenantMemory": 10,
        "TenantMode": "Oracle",
        "TenantZones": [
          {
            "TenantZoneRole": "ReadWrite",
            "IsPrimaryTenantZone": true,
            "TenantZoneId": "cn-hangzhou-h",
            "Units": [
              {
                "UnitId": "1002",
                "UnitStatus": "ONLINE",
                "NodeId": "i-bp16niirq4zdmgvm****",
                "UnitCpu": 2,
                "UnitMemory": 10,
                "EnableMigrateUnit": true,
                "ManualMigrate": true,
                "EnableCancelMigrateUnit": true,
                "UnitDataSize": 10,
                "ReplicaType": "FULL"
              }
            ],
            "LogicalZone": "cn-hangzhou-h-z0",
            "ReplicaType": "FULL",
            "ReadOnlyReplicaType": "ROW_STORE"
          }
        ],
        "TenantStatus": "ONLINE",
        "TenantDeployType": "multiple",
        "TenantUnitNum": 1,
        "PrimaryZoneDeployType": "RANDOM",
        "TenantDiskSize": 2,
        "TenantUnitCpu": 4,
        "TenantUnitMemory": 16
      }
    ],
    "Zones": [
      {
        "ZoneId": "cn-hangzhou-i",
        "Region": "cn-hangzhou",
        "ZoneDisk": "200 GB",
        "Nodes": [
          {
            "NodeId": "i-bp16niirq4zdmgvm****",
            "NodeCopyId": 1,
            "NodeStatus": "ONLINE",
            "NodeResource": {
              "Cpu": {
                "UsedCpu": 4,
                "TotalCpu": 14
              },
              "Memory": {
                "UsedMemory": 10,
                "TotalMemory": 70
              },
              "DiskSize": {
                "TotalDiskSize": 100,
                "UsedDiskSize": 50
              }
            },
            "ReplicaType": "FULL",
            "FullCopyId": 1,
            "ReadOnlyCopyId": 1,
            "LogicalZone": "cn-hangzhou-h-z0",
            "ReadOnlyReplicaType": "ROW_STORE"
          }
        ],
        "ZoneResource": {
          "DiskSize": {
            "MaxDiskUsedPercent": 0.14,
            "MaxDiskUsedObServer": [
              "i-bp1fhj23fs32dfbg4****"
            ]
          }
        }
      }
    ],
    "Replicas": [
      {
        "LogicalZone": "cn-hangzhou-h-z0",
        "NodeNum": 1,
        "ZoneLogicalName": "cn-hangzhou-h",
        "ZoneRegionName": "cn-hangzhou-h",
        "ReplicaResource": {
          "Memory": {
            "UsedMemory": 16,
            "TotalMemory": 32
          },
          "DiskSize": {
            "UsedDiskSize": 50,
            "TotalDiskSize": 100
          },
          "Cpu": {
            "TotalCpu": 16,
            "UsedCpu": 8
          }
        },
        "ZoneLogicalId": 1,
        "ReplicaType": "FULL",
        "Status": "ACTIVE",
        "ReadOnlyReplicaType": "ROW_STORE",
        "OnlineNodeNum": 0
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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