DescribeInstance - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud ドキュメントセンター

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: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 コア 16 GB。 8C32GB：8 コア 32 GB。 14C70GB：14 コア 70 GB。 24C120GB：24 コア 120 GB。 30C180GB：30 コア 180 GB。 62C400GB：62 コア 400 GB。 104C600GB：104 コア 600 GB。 16C70GB：16 コア 70 GB。 32C160GB：32 コア 160 GB。 64C380GB：64 コア 380 GB。 20C32GB：20 コア 32 GB。 40C64GB：40 コア 64 GB。 16C32GB：16 コア 32 GB。 32C70GB：32 コア 70 GB。 64C180GB：64 コア 180 GB。 32C180GB：32 コア 180 GB。 64C400GB：64 コア 400 GB。	14C70G
Series	string	インスタンスのシリーズ。 normal (デフォルト)：標準クラスター版 (クラウドディスク)。 normal_ssd：標準クラスター版 (ローカルディスク)。 history：Archive Database Cluster Edition。 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	自動更新が有効かどうかを示します。このパラメーターは、サブスクリプションクラスターに対してのみ有効です。	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	データディスク使用率が最も高い OBServer ノードのリスト。	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	integer	元のディスクサイズ。	200
MaxDiskSize	number	作成可能な最大ディスクサイズ。	80000
UnitCount	integer	クラスター内のリソースユニット数。	1
LogDiskSize	object	クラスターのログディスクリソース情報。
TotalDiskSize	integer	クラスターの合計ログディスク容量 (GB)。	400
UnitDiskSize	integer	クラスター内の各レプリカのログストレージ容量 (GB)。	200
LogAssignedSize	string	割り当てられたログストレージ容量 (GB)。	0.0
MaxLogAssignedObServer	array	サーバーに割り当てられた最大ストレージ容量に関する情報。
	string	ログディスク使用率が最も高い OBServer ノードのリスト。	["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	string	クラスター内のノード数。デプロイモードが n-n-n の場合、ノード数は n × 3 です。	6
ReplicaMode	string	フル機能レプリカの数。戻り値は 3 または 2 です。 3：3つのフル機能レプリカ。 2：2つのフル機能レプリカ。 3ゾーンデプロイは3つのフル機能レプリカをサポートします。2ゾーンデプロイは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	プロキシサービスが有効かどうかを示します。 true false	true
ProxyServiceStatus	string	プロキシサービスのステータス。	ONLINE
ProxyClusterId	string	プロキシクラスターの 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	クラスター内のリソースユニット数。	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	プライマリインスタンスのリージョン。	cn-hangzhou
SpecType	string	仕様タイプ。	dedicatedspec
AllowModifyInternetAddressConnectionLimit	boolean	インターネット経由の最大接続数を変更できるかどうかを示します。	false
AllowCreateProxySqlFirewallRule	boolean	ODP SQL ファイアウォールが許可されているかどうかを示します。	false
Iops	integer		10000

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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