すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for OceanBase (Deprecated):DescribeInstanceCreatableZone

最終更新日:May 26, 2026

インスタンスを作成できるゾーンを照会します。

今すぐお試しください

この 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:DescribeInstanceCreatableZone

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

InstanceId

string

必須

インスタンスの ID です。

ob317v4uif****

レスポンスフィールド

フィールド

説明

object

レスポンスボディ。

RequestId

string

リクエスト ID です。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

ZoneList

array<object>

ゾーンのリストです。

object

ゾーンオブジェクト。

IsInCluster

boolean

ゾーンがクラスターのデプロイメントで使用されているかどうかを示します。

true

Zone

string

ゾーンの ID です。

cn-hangzhou-i

FullCopyId

string

レプリカの序数です。

1

LogicalZoneName

string

論理ゾーン名です。

cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2

ReplicateZoneIndex

integer

レプリカゾーンのインデックスです。

1

成功レスポンス

JSONJSON

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "ZoneList": [
    {
      "IsInCluster": true,
      "Zone": "cn-hangzhou-i",
      "FullCopyId": "1",
      "LogicalZoneName": "cn-shanghai-g-z0,cn-shanghai-g-z1, cn-shanghai-g-z2",
      "ReplicateZoneIndex": 1
    }
  ]
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

500 InternalError The request processing has failed due to some unknown error.

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

変更履歴

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