DescribeInstances - 查詢叢集列表 - ApsaraDB for OceanBase (Deprecated)

查詢 OceanBase 叢集列表資訊。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeInstances

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	否	OceanBase 叢集 ID。	ob317v4uif****
ResourceGroupId	string	否	資源群組 ID 資訊。如果不填寫，返回全部資源。	group1
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值：100。預設值：10。	10
PageNumber	integer	否	分頁查詢的頁碼。起始值：1。預設值：1。	1
InstanceName	string	否	OceanBase 叢集名稱。長度為 1~20 個英文或中文字元。如未指定該參數，預設值為叢集的 InstanceId。	ob4prod
SearchKey	string	否	根據執行個體 ID、執行個體名稱、租戶 ID 和租戶名稱進行模糊搜尋。	pay
WithOBCloudInstances	boolean	否

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果。
Instances	array<object>	OceanBase 叢集資訊列表。
	array<object>	OceanBase 叢集資訊。
VpcId	string	vpcId	vpc-8vb8qjrixzovjpy******
CommodityCode	string	OceanBase 叢集的產品碼。 oceanbase_oceanbasepre_public_cn：中國站雲資料庫訂用帳戶套餐。 oceanbase_oceanbasepost_public_cn：中國站雲資料庫按小時付費套餐。 oceanbase_obpre_public_intl：國際站雲資料庫訂用帳戶套餐。 oceanbase_obpost_public_intl：國際站雲資料庫按小時付費套餐。	oceanbase_oceanbasepost_public_cn
ExpireTime	string	叢集到期時間（UTC 格式）。說明該參數僅適用於訂用帳戶付費方式的執行個體。	2021-10-17T16:00:00Z
State	string	叢集狀態。 ONLINE("online") : 運行中。 PENDING_CREATE("pending_create"): 建立中。 ARREARS_CLOSED("arrears_closed")：後付費逾期欠費關閉。 PREPAID_EXPIRE_CLOSED("prepaid_expire_closed")：預付費到期關閉。 WHITE_LIST_MODIFYING("white_list_modifying")：白名單修改中。 SSL_MODIFYING("ssl_modifying")：ssl 配置變更中。 PARAMETER_MODIFYING("parameter_modifying")：參數修改中。 TENANT_CREATING("tenant_creating")：租戶建立中。 TENANT_SPEC_MODIFYING("tenant_spec_modifying")：租戶規格修改中。 EXPANDING("expanding")：節點擴容中。 REDUCING("reducing")：節點縮容中。 ZONE_CHANGING("zone_changing")：可用性區域變更中。 SPEC_UPGRADING("spec_upgrading")：套餐規格擴容中。 SPEC_DOWNGRADING("spec_downgrading")：套餐規格縮容中。 DISK_UPGRADING("disk_upgrading")：儲存規格擴容中。 UPGRADING("upgrading")：版本升級中。 PENDING_DELETE("pending_delete")：叢集刪除中。 DELETED("deleted")：叢集已刪除。 ABNORMAL("abnormal")：異常。 OFFLINE("offline")：下線。 STANDBY_CREATING("standby_creating")：備叢集建立中。 STANDBY_DELETING("standby_deleting")：備叢集刪除中。 SWITCHOVER_SWITCHING("switchover_switching")：主備切換中。 STANDBY_DISCONNECTING("standby_disconnecting")：備庫解耦中。 LOG_DISK_UPGRADING("log_disk_upgrading")：日誌盤擴容中。 ISOLATION_OPTIMIZATION_MODIFYING("isolation_optimization_modifying")：隔離最佳化變更中。 DISKTYPE_MODIFYING("disktype_modifying")：資料盤類型變更中。 PROXY_SERVICE_CREATING("proxy_service_creating")：代理服務開通中。 PROXY_SERVICE_DELETING("proxy_service_deleting")：代理服務關閉中。 PROXY_SERVICE_SPEC_MODIFYING("proxy_service_spec_modifying")：代理服務規格修改中。 READONLY_ADD_NODE("readonly_add_node")：新增唯讀節點中。 READONLY_REDUCE_NODE("readonly_reduce_node")：刪除唯讀節點中。 READONLY_REDUCE_ZONE("readonly_reduce_zone")：刪除唯讀副本可用性區域中。 READONLY_ADD_ZONE("readonly_add_zone")：新增唯讀副本可用性區域。 READONLY_UPGRADE_SPEC("readonly_upgrade_spec")：唯讀副本規格升配中。 READONLY_UPGRADE_DISK("readonly_upgrade_disk")：唯讀副本儲存擴容中。 READONLY_DOWNGRADE_SPEC("readonly_downgrade_spec")：唯讀副本規格降配中。 READONLY_DOWNGRADE_DISK("readonly_downgrade_disk")：唯讀副本磁碟縮容中。 CREATING_TENANT_READONLY_REPLICA("creating_tenant_readonly_replica")：租戶建立唯讀副本中。 DELETING_TENANT_READONLY_REPLICA("deleting_tenant_readonly_replica")：租戶刪除唯讀副本中。 DISK_DOWNGRADING("disk_downgrading")：磁碟縮容中。 DEPLOY_MODE_MODIFYING("deploy_mode_modifying")：部署模式切換中。說明叢集一般為運行中的狀態（ONLINE）。	ONLINE
InstanceClass	string	叢集規格資訊。當前支援以下套餐： 4C16GB：4 核 16GB。 8C32GB：8 核 32GB。 14C70GB：14 核 70GB。 24C120GB：24 核 120GB。 30C180GB：30 核 180GB。 62C400GB：62 核 400GB。 104C600GB：104 核 600GB。 16C70GB：16 核 70GB。 32C160GB：32 核 160GB。 64C380GB：64 核 380GB。 20C32GB：20 核 32GB。 40C64GB：40 核 64GB。 16C32GB：16 核 32GB。 32C70GB：32 核 70GB。 64C180GB：64 核 180GB。 32C180GB：32 核 180GB。 64C400GB：64 核 400GB。	14C70G
CreateTime	string	叢集的建立時間，UTC 時間。	2021-10-19T07:13:41Z
DeployMode	string	叢集的資料副本模式。無論叢集為單機房、雙機房或多機房部署，傳回值均為 n-n-n，其中 n 為各機房的 OBServer 節點數。	1-1-1
CpuArchitecture	string	叢集的 CPU 架構	X86_64、 AARCH64
MaintainTime	string	叢集的每天例行維護時間，UTC 時間。	19:00Z-20:00Z
DeployType	string	叢集的部署類型。 multiple：多機房； single：單機房； dual：雙機房。	multiple
PayType	string	OceanBase 叢集的付費類型： PREPAY：預付費； POSTPAY：隨用隨付。	PREPAY
DiskSize	integer	儲存空間大小，單位 GB。	200
DiskType	string	叢集部署的儲存類型。	cloud_essd_pl1
InstanceId	string	OceanBase 叢集 ID。	ob317v4uif****
ExpireSeconds	integer	叢集已到期時間，單位：秒(s)。說明訂用帳戶付費模式下，若叢集還未到期，該參數表示叢集剩餘有效使用時間。叢集到期後，該參數表示叢集已到期時間。	2606682
Mem	integer	執行個體的記憶體大小，單位 GB。	70
EnableUpgradeNodes	boolean	是否允許新增節點。	true
Cpu	integer	叢集的 CPU 核心數。	14
AvailableZones	array	叢集部署所在的可用性區域資訊。
	string	叢集部署所在的可用性區域資訊。	cn-hangzhou-i
Version	string	OBServer 版本資訊。	2.2.77
InstanceName	string	OceanBase 叢集名稱。長度為 1~20 個英文或中文字元。如果沒有指定該參數，預設值為叢集的 InstanceId。	ob4test
Series	string	Oceanbase 執行個體的系列。 normal（預設）：標準叢集版（雲端硬碟）。 normal_ssd：標準叢集版（本地碟）。 history：歷史庫叢集版。 normal_kv：obkv 叢集。 normal_hg：信創叢集。	NORMAL
UsedDiskSize	integer	已使用的儲存空間，單位 GB。	20
ResourceGroupId	string	資源群組 ID 資訊。	group1
Resource	object	叢集的資源資訊。
Cpu	object	叢集的 CPU 資源資訊。
TotalCpu	number	叢集總 CPU，單位：核心數。	14
UsedCpu	number	叢集已使用的 CPU，單位：核心數。	10
UnitCpu	number	叢集中每個副本節點的 CPU，單位：核心數。	10
OriginalTotalCpu	number	原始 CPU。	14
Memory	object	叢集的記憶體資源資訊。
TotalMemory	number	叢集總記憶體，單位：GB。	70
UsedMemory	integer	叢集已使用的記憶體，單位：GB。	10
UnitMemory	integer	叢集中每個副本的記憶體，單位：GB。	10
OriginalTotalMemory	number	原始記憶體。	72
DiskSize	object	叢集的儲存資源資訊。
TotalDiskSize	number	叢集總儲存空間，單位：GB。	200
UsedDiskSize	integer	叢集已使用的儲存空間，單位：GB。	100
UnitDiskSize	number	叢集每個副本的儲存空間，單位：GB。	200
OriginalTotalDiskSize	number	原始磁碟。	200
UnitCount	integer	叢集的資源 Unit 數量。	1
CapacityUnit	object	容量單元。
MaxCapacityUnit	integer	最大容量單元。	4
MinCapacityUnit	integer	最小容量單元。	1
UsedCapacityUnit	integer	已用容量單位。	2
InstanceType	string	執行個體類型。 cluster：叢集執行個體。 mtenant：MySQL 模式的租戶執行個體。 mtenant_serverless：MySQL 模式的 Serverless 執行個體。	CLUSTER
InstanceRole	string	執行個體角色。	NORMAL
InTempCapacityStatus	boolean	臨時容量狀態。	false
DataDiskAutoScaleConfig	object	資料盤自動協調配置。
AutoScale	boolean	是否開啟。	true
Upperbound	number	擴容上限。	16
UpperThreshold	number	日常擴容閾值。	80
UpperMergeThreshold	number	合并擴容閾值。	90
MaxDiskSize	integer	磁碟最大值。	80000
ScaleStepInNormal	number	日常擴容步長。	50
ScaleStepInMerge	number	合并擴容步長。	100
UpperScaleStrategy	string	擴容策略（RAW/PERCENTAGE）	RAW
EnableReadOnlyReplicaManagement	boolean	該叢集是否允許購買唯讀副本。	yes
SpecType	string	規格類型	dedicatedspec
ObRpmVersion	string	叢集的 RPM 版本資訊	4.2.1.7-107030032024062709
ReplicaMode	string	叢集的副本模式	3F、2F1A
Migratable	boolean
MigrationInfo	object	切換到雲市場資訊
Migratable	boolean	是否可切換
CheckResult	object	如果不支援切換，此處有詳細原因
Level	string	結果等級
Code	string	檢查項代碼
CodeName	string	檢查項文案
Module	string	模組名
ModuleName	string	模組名文案
SubModule	string	子模組名
SubModuleName	string	子模組文案
Iops	integer		10000
TotalCount	integer	所查詢的 OceanBase 叢集個數。	2
RequestId	string	請求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C

樣本

正常返回樣本

JSON格式

{
  "Instances": [
    {
      "VpcId": "vpc-8vb8qjrixzovjpy******",
      "CommodityCode": "oceanbase_oceanbasepost_public_cn",
      "ExpireTime": "2021-10-17T16:00:00Z",
      "State": "ONLINE",
      "InstanceClass": "14C70G",
      "CreateTime": "2021-10-19T07:13:41Z",
      "DeployMode": "1-1-1",
      "CpuArchitecture": "X86_64、 AARCH64",
      "MaintainTime": "19:00Z-20:00Z",
      "DeployType": "multiple",
      "PayType": "PREPAY",
      "DiskSize": 200,
      "DiskType": "cloud_essd_pl1",
      "InstanceId": "ob317v4uif****",
      "ExpireSeconds": 2606682,
      "Mem": 70,
      "EnableUpgradeNodes": true,
      "Cpu": 14,
      "AvailableZones": [
        "cn-hangzhou-i"
      ],
      "Version": "2.2.77",
      "InstanceName": "ob4test",
      "Series": "NORMAL",
      "UsedDiskSize": 20,
      "ResourceGroupId": "group1",
      "Resource": {
        "Cpu": {
          "TotalCpu": 14,
          "UsedCpu": 10,
          "UnitCpu": 10,
          "OriginalTotalCpu": 14
        },
        "Memory": {
          "TotalMemory": 70,
          "UsedMemory": 10,
          "UnitMemory": 10,
          "OriginalTotalMemory": 72
        },
        "DiskSize": {
          "TotalDiskSize": 200,
          "UsedDiskSize": 100,
          "UnitDiskSize": 200,
          "OriginalTotalDiskSize": 200
        },
        "UnitCount": 1,
        "CapacityUnit": {
          "MaxCapacityUnit": 4,
          "MinCapacityUnit": 1,
          "UsedCapacityUnit": 2
        }
      },
      "InstanceType": "CLUSTER",
      "InstanceRole": "NORMAL",
      "InTempCapacityStatus": false,
      "DataDiskAutoScaleConfig": {
        "AutoScale": true,
        "Upperbound": 16,
        "UpperThreshold": 80,
        "UpperMergeThreshold": 90,
        "MaxDiskSize": 80000,
        "ScaleStepInNormal": 50,
        "ScaleStepInMerge": 100,
        "UpperScaleStrategy": "RAW"
      },
      "EnableReadOnlyReplicaManagement": true,
      "SpecType": "dedicatedspec",
      "ObRpmVersion": "4.2.1.7-107030032024062709",
      "ReplicaMode": "3F、2F1A",
      "Migratable": true,
      "MigrationInfo": {
        "Migratable": true,
        "CheckResult": {
          "Level": "",
          "Code": "",
          "CodeName": "",
          "Module": "",
          "ModuleName": "",
          "SubModule": "",
          "SubModuleName": ""
        }
      },
      "Iops": 10000
    }
  ],
  "TotalCount": 2,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}

錯誤碼

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

變更歷史

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