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

ApsaraDB for 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:DescribeInstances

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	OceanBase クラスターのインスタンス ID です。	ob317v4uif****
ResourceGroupId	string	任意	リソースグループの ID です。このパラメーターを省略すると、API はすべてのリソースグループのインスタンスを返します。	group1
PageSize	integer	任意	1 ページあたりに返すエントリ数です。最大値：100。デフォルト値：10。	10
PageNumber	integer	任意	ページ番号です。 1 から始まります。デフォルト値：1。	1
InstanceName	string	任意	OceanBase クラスターの名前です。名前は 1～20 文字の長さで、英語または中国語の文字を使用できます。このパラメーターを指定しない場合、デフォルト値はクラスターのインスタンス ID になります。	ob4prod
SearchKey	string	任意	インスタンス ID、インスタンス名、テナント ID、およびテナント名に対するあいまい検索のキーワードです。	pay
WithOBCloudInstances	boolean	任意	応答に OceanBase Cloud のインスタンスを含めるかどうかを指定します。有効な値：true、false。デフォルト値は false です。

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータです。
Instances	array<object>	OceanBase クラスターの詳細です。
	array<object>	単一の OceanBase クラスターの詳細です。
VpcId	string	VPC の ID です。	vpc-8vb8qjrixzovjpy******
CommodityCode	string	OceanBase クラスターのプロダクトコードです。 `oceanbase_oceanbasepre_public_cn`：中国サイトのサブスクリプション版 OceanBase クラスターを示します。 `oceanbase_oceanbasepost_public_cn`：中国サイトの従量課金版 OceanBase クラスターを示します。 `oceanbase_obpre_public_intl`：国際サイトのサブスクリプション版 OceanBase クラスターを示します。 `oceanbase_obpost_public_intl`：国際サイトの従量課金版 OceanBase クラスターを示します。	oceanbase_oceanbasepost_public_cn
ExpireTime	string	クラスターの有効期限 (UTC) です。説明このパラメーターは、サブスクリプションインスタンスの場合にのみ返されます。	2021-10-17T16:00:00Z
State	string	クラスターのステータスです。 `ONLINE`：実行中。 `PENDING_CREATE`：作成中。 `ARREARS_CLOSED`：支払い延滞によりシャットダウンされた従量課金クラスター。 `PREPAID_EXPIRE_CLOSED`：有効期限切れによりシャットダウンされたサブスクリプションクラスター。 `WHITE_LIST_MODIFYING`：IP ホワイトリストを変更中です。 `SSL_MODIFYING`：SSL 設定を変更中です。 `PARAMETER_MODIFYING`：パラメーターを変更中です。 `TENANT_CREATING`：テナントを作成中です。 `TENANT_SPEC_MODIFYING`：テナントのインスタンスタイプを変更中です。 `EXPANDING`：ノードをスケールアウト中です。 `REDUCING`：ノードをスケールイン中です。 `ZONE_CHANGING`：アベイラビリティーゾーンを変更中です。 `SPEC_UPGRADING`：インスタンスタイプをスケールアップ中です。 `SPEC_DOWNGRADING`：インスタンスタイプをスケールダウン中です。 `DISK_UPGRADING`：ストレージ容量をスケールアップ中です。 `UPGRADING`：クラスターをアップグレード中です。 `PENDING_DELETE`：クラスターを削除中です。 `DELETED`：クラスターは削除されました。 `ABNORMAL`：クラスターが異常な状態です。 `OFFLINE`：クラスターがオフラインです。 `STANDBY_CREATING`：スタンバイクラスターを作成中です。 `STANDBY_DELETING`：スタンバイクラスターを削除中です。 `SWITCHOVER_SWITCHING`：プライマリ/スタンバイ切り替えが進行中です。 `STANDBY_DISCONNECTING`：スタンバイクラスターをデタッチ中です。 `LOG_DISK_UPGRADING`：ログディスクをスケールアップ中です。 `ISOLATION_OPTIMIZATION_MODIFYING`：分離最適化設定を変更中です。 `DISKTYPE_MODIFYING`：データディスクタイプを変更中です。 `PROXY_SERVICE_CREATING`：プロキシサービスを有効化中です。 `PROXY_SERVICE_DELETING`：プロキシサービスを無効化中です。 `PROXY_SERVICE_SPEC_MODIFYING`：プロキシサービスの仕様を変更中です。 `READONLY_ADD_NODE`：読み取り専用ノードを追加中です。 `READONLY_REDUCE_NODE`：読み取り専用ノードを削除中です。 `READONLY_REDUCE_ZONE`：読み取り専用レプリカのアベイラビリティーゾーンを削除中です。 `READONLY_ADD_ZONE`：読み取り専用レプリカのアベイラビリティーゾーンを追加中です。 `READONLY_UPGRADE_SPEC`：読み取り専用レプリカのインスタンスタイプをスケールアップ中です。 `READONLY_UPGRADE_DISK`：読み取り専用レプリカのストレージ容量をスケールアップ中です。 `READONLY_DOWNGRADE_SPEC`：読み取り専用レプリカのインスタンスタイプをスケールダウン中です。 `READONLY_DOWNGRADE_DISK`：読み取り専用レプリカのストレージ容量をスケールダウン中です。 `CREATING_TENANT_READONLY_REPLICA`：テナントの読み取り専用レプリカを作成中です。 `DELETING_TENANT_READONLY_REPLICA`：テナントの読み取り専用レプリカを削除中です。 `DISK_DOWNGRADING`：ストレージ容量をスケールダウン中です。 `DEPLOY_MODE_MODIFYING`：デプロイメントモードを変更中です。説明通常、クラスターは実行中 (`ONLINE`) の状態です。	ONLINE
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
CreateTime	string	クラスターが作成された時刻 (UTC) です。	2021-10-19T07:13:41Z
DeployMode	string	データレプリカの分散モードで、`n-n-n` の形式です。各 `n` は、データセンター内の OceanBase サーバーノードの数を表します。	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	クラスターの残りの有効期間 (秒) です。説明サブスクリプションクラスターの場合、このパラメーターは、有効期限が切れていなければ残りの有効期間を、有効期限が切れていれば期限切れからの経過時間を示します。	2606682
Mem	integer	メモリサイズ (GB) です。	70
EnableUpgradeNodes	boolean	新しいノードを追加可能かどうかを示します。	true
Cpu	integer	CPU コア数です。	14
AvailableZones	array	クラスターがデプロイされているアベイラビリティーゾーンです。
	string	クラスターがデプロイされているアベイラビリティーゾーンです。	cn-hangzhou-i
Version	string	OceanBase サーバーのバージョンです。	2.2.77
InstanceName	string	OceanBase クラスターの名前です。長さは 1〜20 文字で、英字または漢字が使用可能です。このパラメーターが指定されていない場合、デフォルトで `InstanceId` の値が使用されます。	ob4test
Series	string	OceanBase インスタンスのシリーズです。 `normal` (デフォルト)：Standard Cluster Edition (クラウドディスク)。 `normal_ssd`：Standard Cluster Edition (ローカルディスク)。 `history`：History Database Cluster Edition。 `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	クラスター内のリソースユニット数です。	1
CapacityUnit	object	キャパシティユニットです。
MaxCapacityUnit	integer	最大キャパシティユニットです。	4
MinCapacityUnit	integer	最小キャパシティユニットです。	1
UsedCapacityUnit	integer	使用済みキャパシティユニット数です。	2
InstanceType	string	インスタンスのタイプです。 `cluster`：クラスターインスタンス。 `mtenant`：MySQL モードのテナントインスタンス。 `mtenant_serverless`：MySQL モードのサーバーレスインスタンス。	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	Alibaba Cloud Marketplace への移行に関する情報です。
Migratable	boolean	インスタンスを移行可能かどうかを示します。
CheckResult	object	移行がサポートされていない場合の理由です。
Level	string	チェック結果のレベルです。
Code	string	チェック項目のコードです。
CodeName	string	チェック項目の説明です。
Module	string	モジュールの名前です。
ModuleName	string	モジュールの表示名です。
SubModule	string	サブモジュールの名前です。
SubModuleName	string	サブモジュールの表示名です。
Iops	integer		10000
TotalCount	integer	返されるクラスターの総数です。	2
RequestId	string	リクエスト ID です。	EE205C00-30E4-**-**-87E3A8A2AA0C

例

成功レスポンス

JSONJSON

{
  "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": false,
      "MigrationInfo": {
        "Migratable": false,
        "CheckResult": {
          "Level": "",
          "Code": "",
          "CodeName": "",
          "Module": "",
          "ModuleName": "",
          "SubModule": "",
          "SubModuleName": ""
        }
      },
      "Iops": 10000
    }
  ],
  "TotalCount": 2,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}

エラーコード

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

変更履歴

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