幫助中心
首頁 ApsaraDB for OceanBase (Deprecated) 開發參考 API參考 API目錄 叢集管理 DescribeInstanceTopology - 查詢叢集拓撲資訊

DescribeInstanceTopology - 查詢叢集拓撲資訊

更新時間：
Copy as MD

查詢某個 OceanBase 叢集的拓撲資訊。

調試

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

調試

授權資訊

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

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

  • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeInstanceTopology

get

*全部資源

*

 無 無

請求參數

名稱

類型

必填

描述

樣本值
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_EMIGRATING: 取消遷入中；

  • 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

是否可以取消遷移。
該欄位只對正在手動遷入中或手動遷出中的 unit 有效。

true
UnitDataSize

integer

Unit 使用的資料量大小。

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: 公網地址分配中。

  • PENDING_OFFLINE_INTERNET_ADDRESS: 公網地址關閉中。

  • PRIMARY_ZONE_MODIFYING: 切主可用性區域中。

  • PARAMETER_MODIFYING: 參數修改中。

  • WHITE_LIST_MODIFING: 白名單修改中。

ONLINE
TenantDeployType

string

租戶的部署類型。

  • multiple：多機房。

  • single：單機房。

  • dual：雙機房。

multiple
TenantUnitNum

integer

租戶的 unit 個數。

1
PrimaryZoneDeployType

string

主可用性區域部署模式。

枚舉值：

  • RANDOM :

    RANDOM

  • STATIC :

    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

節點歸屬的複本識別碼。

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

全功能複本識別碼。

1
ReadOnlyCopyId

integer

唯讀複本識別碼。

1
LogicalZone

string

複本識別碼

cn-hangzhou-h-z0
ReadOnlyReplicaType

string

唯讀副本類型

ROW_STORE
ZoneResource

object

可用性區域資訊。

DiskSize

object

節點儲存資源資訊。

MaxDiskUsedPercent

number

磁碟使用率最大值（百分比）。

0.14
MaxDiskUsedObServer

array

磁碟伺服器使用率最大值。

string

磁碟伺服器使用率最大值。

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

副本編號

1

ReplicaType

string

副本類型

FULL
Status

string

副本狀態，返回枚舉類型（ACTIVE/INACTIVE/UNKNOWN）

ACTIVE
ReadOnlyReplicaType

string

唯讀副本類型

ROW_STORE
OnlineNodeNum

integer

線上節點數

樣本

正常返回樣本

JSON格式

{
  "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
      }
    ]
  }
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。

上一篇：DescribeInstances - 查詢叢集列表下一篇：DescribeAvailableSpec