DescribeAvailableSpec - 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:DescribeAvailableSpec

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	OceanBase クラスターの ID。	ob317v4uif****
UpgradeType	string	必須	スペック変更のタイプ。列挙値: downgradedisk : ディスクのダウングレード。 upgradenodenum : ノード数のアップグレード。 downgradespec : downgradespec。 upgradespec : upgradespec。 upgradedisk : ディスクのアップグレード。 downgradenodenum : ノード数のダウングレード。	upgradespec
Spec	string	任意	ノードスペック。	oceanbase.cluster.cd8.xlarge

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	object	返されたデータ。
AvailableSpecifications	array<object>	クラスターの使用可能な構成情報。
	array<object>	クラスターの使用可能な構成のリスト。
Spec	string	移行インスタンスの仕様です。	oceanbase.cluster.cd8.xlarge
InstanceClass	string	クラスターのインスタンスクラスです。	4C16GB
NodeNum	array	ノード数です。
	integer	ノード数です。	3
DiskSizeRange	object	ストレージサイズです。
Step	integer	最小の調整ステップです。	5
Max	integer	パラメーターの最大値です。	40000
Min	integer	パラメーターの最小値です。	1000
LogDiskSizeRange	object	ログディスクのサイズです。
Step	integer	最小の調整ステップです。	5
Max	integer	パラメーターの最大値です。	4000
Min	integer	パラメーターの最小値です。	100
DiskTypes	array	ディスクタイプのリストです。
	string	ディスクタイプです。	cloud_essd_pl1

例

成功レスポンス

JSONJSON

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "AvailableSpecifications": [
      {
        "Spec": "oceanbase.cluster.cd8.xlarge",
        "InstanceClass": "4C16GB",
        "NodeNum": [
          3
        ],
        "DiskSizeRange": {
          "Step": 5,
          "Max": 40000,
          "Min": 1000
        },
        "LogDiskSizeRange": {
          "Step": 5,
          "Max": 4000,
          "Min": 100
        },
        "DiskTypes": [
          "cloud_essd_pl1"
        ]
      }
    ]
  }
}

エラーコード

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

変更履歴

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