DescribeInstance - 查詢叢集資訊 - ApsaraDB for OceanBase (Deprecated)

查詢一個 OceanBase 叢集的詳細資料。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeInstance

get

*Instance

acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	OceanBase 叢集 ID。	ob317v4uif****
PageNumber	integer	否	分頁查詢的頁碼。起始值：1。預設值：1。	1

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果。
RequestId	string	請求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Instance	object	OceanBase 叢集資訊。
InstanceId	string	OceanBase 叢集 ID。	ob317v4uif****
InstanceName	string	OceanBase 叢集名稱。	ob4test
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
Series	string	執行個體的系列。 normal（預設）：標準叢集版（雲端硬碟）。 normal_ssd：標準叢集版（本地碟）。 history：歷史庫叢集版。 normal_kv: obkv 叢集。 normal_hg：信創叢集。	Normal
PayType	string	OceanBase 叢集的付費類型。 PREPAY：預付費。 POSTPAY：隨用隨付。	PREPAY
CreateTime	string	叢集的建立時間（UTC 時間）。	2021-10-19T07:13:41Z
ExpireTime	string	叢集到期時間（UTC 格式）。	2021-10-17T16:00:00Z
Version	string	OBServer 版本資訊。	2.2.77
DeployType	string	叢集的部署類型。 multiple：多機房。 single：單機房。 dual：雙機房。	multiple
DeployMode	string	叢集的資料副本模式。單機房為 n。雙機房為 n-n。多機房為 n-n-n。說明其中，n 為各機房的 OBServer 節點數。	1-1-1
DiskType	string	叢集部署的儲存類型。預設為 cloud_essd_pl1：ESSD 雲端硬碟。	cloud_essd_pl1
MaintainTime	string	叢集的每天例行維護時間，UTC 時間。	19:00Z-20:00Z
DataMergeTime	string	叢集的資料合併時間。	02:00
AutoRenewal	boolean	是否開啟自動續約。該參數只在預付費（PREPAY）叢集有意義。	true
IsTrustEcs	boolean	是否使用可信 ecs。	true
Status	string	叢集狀態。 PENDING_CREATE: 建立中。 ONLINE: 運行中。 TENANT_CREATING：租戶建立中。 TENANT_SPEC_MODIFYING：租戶規格修改中。 EXPANDING: 節點擴容中。 REDUCING: 節點縮容中。 SPEC_UPGRADING:套餐規格擴容中。 DISK_UPGRADING:儲存規格擴容中。 WHITE_LIST_MODIFYING: 修改白名單中。 PARAMETER_MODIFYING: 修改參數中。 SSL_MODIFYING: SSL 變更中。 PREPAID_EXPIRE_CLOSED: 預付費叢集欠費中。 ARREARS_CLOSED: 後付費叢集欠費中。 PENDING_DELETE: 刪除中。叢集一般為運行中的狀態（ONLINE）。	ONLINE
Resource	object	叢集的資源資訊。
Cpu	object	叢集的 CPU 資源資訊。
TotalCpu	integer	叢集總 CPU，單位：核心數。	14
UsedCpu	integer	叢集已使用的 CPU，單位：核心數。	10
UnitCpu	integer	叢集中每個副本節點的 CPU，單位：核心數。	10
OriginalTotalCpu	integer	原始 CPU。	14
Memory	object	叢集的記憶體資源資訊。
TotalMemory	integer	叢集總記憶體，單位：GB。	70
UsedMemory	integer	叢集已使用的記憶體，單位：GB。	10
UnitMemory	integer	叢集中每個副本的記憶體，單位：GB	10
OriginalTotalMemory	integer	原始記憶體。	72
DiskSize	object	叢集的儲存資源資訊。
TotalDiskSize	integer	叢集總儲存空間，單位：GB。	200
UsedDiskSize	integer	叢集已使用的儲存空間，單位：GB。	100
UnitDiskSize	integer	叢集每個副本的儲存空間，單位：GB	200
DataUsedSize	number	資料盤大小規格，單位 GB。	200
MaxDiskUsedPercent	number	磁碟使用率最大值（百分比）。	0.14
MaxDiskUsedObServer	array	磁碟伺服器使用率最大值。
	string	資料盤使用量最大的 OB Server 節點列表。	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	integer	原始磁碟。	200
MaxDiskSize	number	最大可建立磁碟大小。	80000
UnitCount	integer	叢集的資源 Unit 數量。	1
LogDiskSize	object	叢集的日誌盤資源資訊。
TotalDiskSize	integer	叢集總日誌盤空間，單位 GB。	400
UnitDiskSize	integer	叢集每個副本的日誌儲存空間，單位：GB。	200
LogAssignedSize	string	分配的日誌儲存空間，單位：GB。	0.0
MaxLogAssignedObServer	array	分配的伺服器最大儲存空間資訊。
	string	日誌盤使用量最大的 OB Server 節點列表。	["i-bp1g**","i-bp11","i-bp19**"]
MaxLogAssignedPercent	string	分配的最大日誌儲存空間百分比。	6.68
OriginalTotalDiskSize	integer	日誌盤原始大小。	200
CapacityUnit	object	容量單元。
MaxCapacityUnit	integer	最大容量單元。	4
MinCapacityUnit	integer	最小容量單元。	1
UsedCapacityUnit	string	已用容量單位。	2
AutoUpgradeObVersion	boolean	是否開啟自動升級 OBServer 版本。	true
ObRpmVersion	string	OBServer 詳細版本資訊。	2.2.77-20210526202046
IsLatestObVersion	boolean	OBServer 版本是否為最新版本。	true
AvailableZones	array	可用性區域列表。
	string	可用性區域列表。	cn-hangzhou-i
EnableUpgradeLogDisk	boolean	是否允許升級日誌盤規格。	false
Zones	array	執行個體所屬的可用性區域 ID。更多詳情，請參見 DescribeZones 擷取可用性區域列表。
	string	執行個體所屬的可用性區域 ID。更多詳情，請參見 DescribeZones 擷取可用性區域列表。	cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j
InstanceRole	string	執行個體角色。	NORMAL
NodeNum	integer	叢集節點個數資訊。如果部署模式為 n-n-n，則節點個數為 n * 3。	6
ReplicaMode	string	全功能型副本數。傳回值僅包含 3 和 2。 3：表示 3 個全功能型副本。 2：表示 2 個全功能型副本。三可用性區域部署時，只支援 3 個全功能型副本，雙可用性區域部署時，僅支援 2 個全功能型副本，單可用性區域部署時，可以支援 2 個或者 3 個全功能型副本。	2
IsolationOptimization	boolean	是否開啟 Cgroup。	false
EnableIsolationOptimization	boolean	是否允許開通隔離最佳化。	false
InTempCapacityStatus	boolean	臨時容量狀態。	false
DataDiskAutoScale	boolean	是否開啟資料自動協調。說明此參數已廢棄。	-
TenantCreatable	object	可建立的租戶。
EnableCreateTenant	boolean	叢集是否允許建立租戶。	true
DisableCreateTenantReason	string	叢集不允許建立租戶的原因。	CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT
DataDiskAutoScaleConfig	object	資料盤自動協調配置。
AutoScale	boolean	是否開啟。	true
Upperbound	integer	擴容上限。	16
UpperThreshold	integer	日常擴容閾值。	80
UpperMergeThreshold	integer	合并擴容閾值。	90
MaxDiskSize	integer	磁碟最大值。	80000
ScaleStepInNormal	integer	日常擴容步長。	50
ScaleStepInMerge	integer	合并擴容步長。	100
UpperScaleStrategy	string	擴容策略（RAW/PERCENTAGE）	RAW
UpperScaleStep	string	擴容步長	5
EnableProxyService	boolean	是否 Enable 代理服務。 true false	true
ProxyServiceStatus	string	代理服務狀態。	ONLINE
ProxyClusterId	string	Proxy 叢集 ID。說明僅 EnableProxyService 為 true 時，才會包含該參數。	proxy-56****a6tg2o
CpuArchitecture	string	叢集的 CPU 架構。	X86
ReadOnlyResource	object	叢集的資源資訊
Cpu	object	叢集的 CPU 資源資訊
TotalCpu	integer	叢集總 CPU，單位：核心數	14
UsedCpu	integer	叢集已使用的 CPU，單位：核心數	10
UnitCpu	integer	叢集中每個副本節點的 CPU，單位：核心數	10
OriginalTotalCpu	integer	原始 CPU	14
Memory	object	叢集的記憶體資源資訊
TotalMemory	integer	叢集總記憶體，單位：GB	70
UsedMemory	integer	叢集已使用的記憶體，單位：GB	10
UnitMemory	integer	叢集中每個副本的記憶體，單位：GB	10
OriginalTotalMemory	integer	原始記憶體	72
DiskSize	object	叢集的儲存資源資訊
TotalDiskSize	integer	叢集總儲存空間，單位：GB	200
UsedDiskSize	integer	叢集已使用的儲存空間，單位：GB	100
UnitDiskSize	integer	叢集每個副本的儲存空間，單位：GB	200
DataUsedSize	number	已使用的儲存空間，單位：GB。	200
MaxDiskUsedPercent	number	磁碟使用率最大值（百分比）。	0.14
MaxDiskUsedObServer	array	磁碟伺服器使用率最大值。
	string	磁碟伺服器使用率最大值。	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	integer	原始磁碟。	200
MaxDiskSize	number	最大可建立磁碟大小。	80000
UnitCount	integer	叢集的資源 Unit 數量。	1
LogDiskSize	object	叢集的日誌盤資源資訊。
TotalDiskSize	integer	叢集總日誌盤空間，單位：GB。	400
UnitDiskSize	integer	叢集每個副本的日誌儲存空間，單位：GB	200
LogAssignedSize	string	已指派的日誌儲存空間.。	0.0
MaxLogAssignedObServer	array	已指派的最大 OBServer。
	string	已指派的最大 OBServer。	["i-bp1g**","i-bp11","i-bp19**"]
MaxLogAssignedPercent	string	已指派的最大日誌百分比。	6.68
CapacityUnit	object	容量單元。
MaxCapacityUnit	integer	最大容量單元。	4
MinCapacityUnit	integer	最小容量單元。	1
UsedCapacityUnit	string	已用容量單位。	2
UnitSpec	string	代理服務的單元規格	2C4G
SharedUnitNumLimit	integer	共用模式代理服務的單元數量上限	3
ExclusiveUnitNumLimit	integer	獨佔模式代理服務的單元數量上限	1
EnableReadOnlyReplica	boolean	是否支援唯讀副本	true
EnableReadOnlyReplicaManagement	boolean	該叢集是否允許購買唯讀副本。	false
PrimaryInstance	string	主執行個體 Id	ob3h8ytroxxxxx
PrimaryRegion	string	主執行個體 Region	cn-hangzhou
SpecType	string	規格類型	dedicatedspec
AllowModifyInternetAddressConnectionLimit	boolean	是否允許修改公網最大串連數	false
AllowCreateProxySqlFirewallRule	boolean	是否允許使用 ODP SQL 防火牆	false
Iops	integer		10000

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Instance": {
    "InstanceId": "ob317v4uif****",
    "InstanceName": "ob4test",
    "InstanceClass": "14C70G",
    "Series": "Normal",
    "PayType": "PREPAY",
    "CreateTime": "2021-10-19T07:13:41Z",
    "ExpireTime": "2021-10-17T16:00:00Z",
    "Version": "2.2.77",
    "DeployType": "multiple",
    "DeployMode": "1-1-1",
    "DiskType": "cloud_essd_pl1",
    "MaintainTime": "19:00Z-20:00Z",
    "DataMergeTime": "02:00",
    "AutoRenewal": true,
    "IsTrustEcs": true,
    "Status": "ONLINE",
    "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,
        "DataUsedSize": 200,
        "MaxDiskUsedPercent": 0.14,
        "MaxDiskUsedObServer": [
          "i-bp1fhj23fs32dfbg4****"
        ],
        "OriginalTotalDiskSize": 200,
        "MaxDiskSize": 80000
      },
      "UnitCount": 1,
      "LogDiskSize": {
        "TotalDiskSize": 400,
        "UnitDiskSize": 200,
        "LogAssignedSize": "0.0",
        "MaxLogAssignedObServer": [
          "[\"i-bp1g****\",\"i-bp11****\",\"i-bp19****\"]"
        ],
        "MaxLogAssignedPercent": "6.68",
        "OriginalTotalDiskSize": 200
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 4,
        "MinCapacityUnit": 1,
        "UsedCapacityUnit": "2"
      }
    },
    "AutoUpgradeObVersion": true,
    "ObRpmVersion": "2.2.77-20210526202046",
    "IsLatestObVersion": true,
    "AvailableZones": [
      "cn-hangzhou-i"
    ],
    "EnableUpgradeLogDisk": false,
    "Zones": [
      "cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j"
    ],
    "InstanceRole": "NORMAL",
    "NodeNum": 6,
    "ReplicaMode": "2",
    "IsolationOptimization": false,
    "EnableIsolationOptimization": false,
    "InTempCapacityStatus": false,
    "DataDiskAutoScale": true,
    "TenantCreatable": {
      "EnableCreateTenant": true,
      "DisableCreateTenantReason": "CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT"
    },
    "DataDiskAutoScaleConfig": {
      "AutoScale": true,
      "Upperbound": 16,
      "UpperThreshold": 80,
      "UpperMergeThreshold": 90,
      "MaxDiskSize": 80000,
      "ScaleStepInNormal": 50,
      "ScaleStepInMerge": 100,
      "UpperScaleStrategy": "RAW",
      "UpperScaleStep": "5"
    },
    "EnableProxyService": true,
    "ProxyServiceStatus": "ONLINE",
    "ProxyClusterId": "proxy-56****a6tg2o",
    "CpuArchitecture": "X86",
    "ReadOnlyResource": {
      "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,
        "DataUsedSize": 200,
        "MaxDiskUsedPercent": 0.14,
        "MaxDiskUsedObServer": [
          "i-bp1fhj23fs32dfbg4****"
        ],
        "OriginalTotalDiskSize": 200,
        "MaxDiskSize": 80000
      },
      "UnitCount": 1,
      "LogDiskSize": {
        "TotalDiskSize": 400,
        "UnitDiskSize": 200,
        "LogAssignedSize": "0.0",
        "MaxLogAssignedObServer": [
          "[\"i-bp1g****\",\"i-bp11****\",\"i-bp19****\"]"
        ],
        "MaxLogAssignedPercent": "6.68"
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 4,
        "MinCapacityUnit": 1,
        "UsedCapacityUnit": "2"
      }
    },
    "UnitSpec": "2C4G",
    "SharedUnitNumLimit": 3,
    "ExclusiveUnitNumLimit": 1,
    "EnableReadOnlyReplica": true,
    "EnableReadOnlyReplicaManagement": false,
    "PrimaryInstance": "ob3h8ytroxxxxx",
    "PrimaryRegion": "cn-hangzhou",
    "SpecType": "dedicatedspec",
    "AllowModifyInternetAddressConnectionLimit": false,
    "AllowCreateProxySqlFirewallRule": false,
    "Iops": 10000
  }
}

錯誤碼

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

變更歷史

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