DescribeAvailabilityZones を使用したサポート対象の可用ゾーンのクエリ - MongoDB

ApsaraDB for MongoDB インスタンスがサポートするゾーンのリストを照会します。

操作説明

指定された購入条件で ApsaraDB for MongoDB インスタンスをデプロイできるゾーンを照会します。購入条件にはリージョン ID が必須です。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:DescribeAvailabilityZones

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスのリージョン ID。DescribeRegions 操作を呼び出して、利用可能な最新のリージョンを照会できます。	cn-hangzhou
ZoneId	string	任意	インスタンスのゾーン ID。DescribeRegions 操作を呼び出して、利用可能なゾーンを照会できます。	cn-hangzhou-b
InstanceChargeType	string	任意	プロダクトの課金方法。有効値： PrePaid：サブスクリプション PostPaid：従量課金	PrePaid
DbType	string	任意	インスタンスのアーキテクチャ。有効値： normal：レプリカセットインスタンス sharding：シャードクラスターインスタンス	normal
ResourceGroupId	string	任意	リソースグループの ID。詳細については、「リソースグループの基本情報の表示」をご参照ください。	rg-acfmx2m4rqu7pry
AcceptLanguage	string	任意	返される RegionName および ZoneName パラメーター値の言語。有効値： zh (デフォルト)：中国語 en：英語	zh
StorageSupport	string	任意	ストレージタイプ。有効値： cloud：クラウドディスクを使用するインスタンスで利用可能なゾーンのみを表示します。 local：ローカルディスクを使用するインスタンスで利用可能なゾーンのみを表示します。 default または未指定：クラウドディスクを使用するインスタンスとローカルディスクを使用するインスタンスで利用可能なゾーンを表示します。	local
MongoType	string	任意	インスタンスのエディション。高可用性エディションとプレビューエディション (dbfs) がサポートされています。	dbfs
StorageType	string	任意	ストレージタイプ。有効値： cloud_essd1：PL1 企業向け SSD (ESSD) cloud_essd2：PL2 ESSD cloud_essd3：PL3 ESSD local_ssd：ローカル SSD 説明 MongoDB 4.4 以降を実行するインスタンスは、クラウドディスクのみを使用してデータを保存します。このパラメーターを指定しない場合、デフォルトで cloud_essd1 の値が使用されます。 MongoDB 4.2 以前を実行するインスタンスは、ローカルディスクのみを使用してデータを保存します。このパラメーターを指定しない場合、デフォルトで local_ssd の値が使用されます。	local_ssd
ExcludeZoneId	string	任意	クエリ結果から除外するゾーン ID。	cn-shanghai-g
ExcludeSecondaryZoneId	string	任意	クエリ結果から除外するセカンダリゾーン ID。ExcludeZoneId および ExcludeSecondaryZoneId パラメーターを設定して、クエリ結果から除外する複数のゾーンの ID を指定できます。	cn-shanghai-b
DBInstanceClass	string	任意	インスタンスのインスタンスタイプ。	dds.mongo.standard
EngineVersion	string	任意	インスタンスのデータベースエンジンバージョン。	5.0
ReplicationFactor	string	任意	インスタンス内のノード数。説明このパラメーターはレプリカセットインスタンスでのみ利用可能です。有効値： 1 3 5 7 列挙値: 1 : 1 3 : 3 5 : 5 7 : 7	3
InstanceType	string	任意	インスタンスのアーキテクチャ。有効値： sharding：シャードクラスターインスタンス replicate：レプリカセットまたはスタンドアロンインスタンス	replicate

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	19A13A33-0FAD-5120-8AE1-B1636F74DD80
AvailableZones	array<object>	ApsaraDB for MongoDB インスタンスを作成できるゾーンの詳細。
	object
ZoneId	string	ゾーンの ID。	cn-beijing-f
ZoneName	string	ゾーンの名前。 ZoneName パラメーターの戻り値は、AcceptLanguage パラメーターで指定された言語になります。たとえば、応答の ZoneId パラメーターの値が cn-hangzhou-h の場合、ZoneName パラメーターには次の値が返されます： AcceptLanguage パラメーターの値が zh の場合、ZoneName パラメーターには H が返されます。 AcceptLanguage パラメーターの値が en の場合、ZoneName パラメーターには Hangzhou Zone H が返されます。	杭州可用区H
RegionId	string	リージョンの ID。DescribeRegions 操作を呼び出して、利用可能な最新のリージョンを照会できます。	cn-beijing

例

成功レスポンス

JSONJSON

{
  "RequestId": "19A13A33-0FAD-5120-8AE1-B1636F74DD80",
  "AvailableZones": [
    {
      "ZoneId": "cn-beijing-f",
      "ZoneName": "杭州 可用区H",
      "RegionId": "cn-beijing"
    }
  ]
}

エラーコード

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

変更履歴

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