Kueri resource yang tersedia menggunakan DescribeAvailableResource - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Mengkueri sumber daya yang tersedia di zona tertentu.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeAvailableResource

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk mengkueri wilayah terbaru yang tersedia.	cn-hangzhou
ZoneId	string	No	ID zona. Anda dapat memanggil operasi DescribeRegions untuk mengkueri zona yang tersedia.	cn-hangzhou-h
InstanceChargeType	string	No	Metode penagihan instans. Nilai valid: PrePaid (default): langganan PostPaid: pay-as-you-go.	PrePaid
DbType	string	No	Arsitektur instans. Nilai valid: normal: instans replica set sharding: instans kluster sharded.	sharding
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-acfmyiu4ekp****
StorageType	string	No	Tipe penyimpanan instans. Nilai valid: local_ssd: SSD lokal cloud_essd1: SSD Enhanced (ESSD) PL1 cloud_essd2: ESSD PL2 cloud_essd3: ESSD PL3 cloud_auto: disk ESSD AutoPL Parameter ini kosong secara default, yang menunjukkan bahwa semua tipe sumber daya penyimpanan dikueri.	local_ssd
DBInstanceClass	string	No	Tipe instans dari instans.	dds.mongo.standard
EngineVersion	string	No	Versi mesin utama instans.	5.0
ReplicationFactor	string	No	Jumlah node. Parameter ini hanya berlaku untuk instans replica set. Valid values: 1 : 1 3 : 3 5 : 5 7 : 7	3

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	344EE51D-8850-4935-B68B-58A8F4DCE3BD
SupportedDBTypes	object
SupportedDBType	array<object>	The supported database types.
	array<object>
AvailableZones	object
AvailableZone	array<object>	The available zones.
	array<object>
SupportedEngineVersions	object
SupportedEngineVersion	array<object>	The supported storage engine versions.
	array<object>
SupportedEngines	object
SupportedEngine	array<object>	The supported storage engines.
	array<object>
SupportedNodeTypes	object
SupportedNodeType	array<object>	The supported instance types.
	array<object>
NodeType	string	The number of nodes in the instance.	3
NetworkTypes	string	The network type of the instance.	VPC
AvailableResources	object
AvailableResource	array<object>	The details of the available resources.
	array<object>
InstanceClassRemark	string	The type of the instance.	4核8GB（独享型）（当前选择规格：mdb.shard.2x.xlarge.d（4核8G（独享型云盘版），最大连接数：3000，最大IOPS：min{1800+50*存储空间, 21000}））
InstanceClass	string	The instance family.	mdb.shard.2x.xlarge.d
DBInstanceStorageRange	object	The storage capacity range of the instance.
Min	integer	The minimum storage capacity. Unit: GB.	20
Max	integer	The maximum storage capacity. Unit: GB.	16000
Step	integer	The step size for adjusting the storage capacity. Unit: GB.	10
Engine	string	The storage engine of the instance.	WiredTiger
Version	string	The database engine version of the instance.	4.0
ZoneId	string	The ID of the zone.	cn-hangzhou-h
RegionId	string	The ID of the region.	cn-hangzhou
DbType	string	The architecture of the instance. Valid values: normal: replica set instance sharding: sharded cluster instance	sharding

Contoh

Respons sukses

JSONformat

{
  "RequestId": "344EE51D-8850-4935-B68B-58A8F4DCE3BD",
  "SupportedDBTypes": {
    "SupportedDBType": [
      {
        "AvailableZones": {
          "AvailableZone": [
            {
              "SupportedEngineVersions": {
                "SupportedEngineVersion": [
                  {
                    "SupportedEngines": {
                      "SupportedEngine": [
                        {
                          "SupportedNodeTypes": {
                            "SupportedNodeType": [
                              {
                                "NodeType": "3",
                                "NetworkTypes": "VPC",
                                "AvailableResources": {
                                  "AvailableResource": [
                                    {
                                      "InstanceClassRemark": "4核8GB（独享型）（当前选择规格：mdb.shard.2x.xlarge.d（4核8G（独享型云盘版），最大连接数：3000，最大IOPS：min{1800+50*存储空间, 21000}））",
                                      "InstanceClass": "mdb.shard.2x.xlarge.d",
                                      "DBInstanceStorageRange": {
                                        "Min": 20,
                                        "Max": 16000,
                                        "Step": 10
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          },
                          "Engine": "WiredTiger"
                        }
                      ]
                    },
                    "Version": "4.0"
                  }
                ]
              },
              "ZoneId": "cn-hangzhou-h",
              "RegionId": "cn-hangzhou"
            }
          ]
        },
        "DbType": "sharding"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.