DescribeDedicatedHostClusters - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengkueri detail dari satu atau beberapa kluster host khusus.

Deskripsi operasi

Deskripsi

Parameter permintaan bekerja seperti filter, dan filter memiliki hubungan logis AND. Jika sebuah parameter kosong, filter tidak akan berlaku. Namun, jika nilai parameter DedicatedHostClusterIds adalah array JSON kosong ([]), filter dianggap berlaku dan nilai kosong akan dikembalikan.

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

ecs:DescribeDedicatedHostClusters

get

DedicatedHostCluster

acs:ecs:{#regionId}:{#accountId}:ddhcluster/{#ddhclusterId}

DedicatedHostCluster

acs:ecs:{#regionId}:{#accountId}:ddhcluster/*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Status	string	No	Catatan Parameter ini belum tersedia dan tidak didukung.	null
LockReason	string	No	Catatan Parameter ini belum tersedia dan tidak didukung.	null
ResourceGroupId	string	No	ID grup sumber daya tempat kluster host khusus berada. Saat Anda menggunakan parameter ini untuk memfilter sumber daya, jumlah sumber daya tidak boleh melebihi 1.000. Catatan Grup sumber daya default tidak didukung untuk pemfilteran.	rg-bp67acfmxazb4p****
Tag	array<object>	No	Daftar tag.
	object	No	Daftar tag.
Key	string	No	Kunci tag kluster host khusus. Nilai N yang valid: 1 hingga 20. Setelah nilai ditentukan, nilai tersebut tidak boleh berupa string kosong. Panjangnya dapat mencapai 64 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Tidak boleh berisi `http://` atau `https://`. Saat Anda menggunakan satu tag untuk memfilter sumber daya, jumlah sumber daya yang dikueri di bawah tag tersebut tidak boleh melebihi 1.000. Saat Anda menggunakan beberapa tag untuk memfilter sumber daya, jumlah sumber daya yang terikat ke semua tag yang ditentukan tidak boleh melebihi 1.000. Jika jumlah sumber daya melebihi 1.000, panggil operasi ListTagResources untuk melakukan kueri.	TestKey
Value	string	No	Nilai tag kluster host khusus. Nilai N yang valid: 1 hingga 20. Setelah nilai ditentukan, nilai tersebut tidak boleh berupa string kosong. Panjangnya dapat mencapai 64 karakter dan tidak boleh berisi `http://` atau `https://`.	TestValue
RegionId	string	Yes	ID wilayah tempat kluster host khusus berada. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah Alibaba Cloud terbaru.	cn-hangzhou
ZoneId	string	No	ID zona tempat kluster host khusus berada. Anda dapat memanggil operasi DescribeZones untuk mengkueri zona dalam suatu wilayah Alibaba Cloud.	cn-hangzhou-f
DedicatedHostClusterIds	string	No	Daftar ID kluster host khusus. Nilainya dapat berupa array JSON yang terdiri dari beberapa ID kluster host khusus, dalam format `["dc-xxxxxxxxx", "dc-yyyyyyyyy", … ,"dc-zzzzzzzzz"]`. Mendukung hingga 100 ID, dipisahkan dengan koma (,).	["dc-bp12wlf6am0vz9v2**", "dc-bp12wlf6am0vz9v3**"]
DedicatedHostClusterName	string	No	Nama kluster host khusus.	myDDHCluster
PageNumber	integer	No	Nomor halaman daftar status kluster host khusus. Nilai minimum: 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai maksimum: 100. Nilai default: 10.	5

Elemen respons

Element	Type	Description	Example
	object
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	5
RequestId	string	ID permintaan.	214A2187-B06F-4E49-A081-4D053466A8C7
PageNumber	integer	Nomor halaman daftar status kluster host khusus.	1
TotalCount	integer	Jumlah total host khusus.	2
DedicatedHostClusters	object
DedicatedHostCluster	array<object>	Array yang terdiri dari informasi tentang satu atau lebih kluster host khusus.
	array<object>
Description	string	The description of the host group.	This-is-my-DDHCluster
DedicatedHostClusterId	string	The ID of the host group.	dc-bp12wlf6am0vz9v2****
ResourceGroupId	string	The resource group ID of the host group.	rg-bp67acfmxazb4p****
ZoneId	string	The zone ID of the host group.	cn-hangzhou-f
RegionId	string	The region ID of the host group.	cn-hangzhou
DedicatedHostClusterName	string	The name of the host group.	myDDHCluster
Tags	object
Tag	array<object>	The tags of the host group.
	object
TagValue	string	The tag value.	TestValue
TagKey	string	The tag key.	TestKey
DedicatedHostIds	object
DedicatedHostId	array	The IDs of dedicated hosts in the host group.
	string	The ID of the dedicated host.	dh-bp181e5064b5sotr****
DedicatedHostClusterCapacity	object	The capacity of the host group.
AvailableVcpus	integer	The number of available vCPUs.	2
AvailableMemory	integer	The size of available memory. Unit: GiB	4
TotalMemory	integer	The total memory size. Unit: GiB	8
TotalVcpus	integer	The total number of vCPUs.	4
LocalStorageCapacities	object
LocalStorageCapacity	array<object>	The local storage capacity.
	object
DataDiskCategory	string	The category of data disks. Valid values: cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD ephemeral_ssd: local SSD cloud_essd: Enterprise SSD (ESSD)	cloud
AvailableDisk	integer	The available capacity of the local disk. Unit: GiB	20
TotalDisk	integer	The total capacity of the local disk. Unit: GiB	40
AvailableInstanceTypes	object
AvailableInstanceType	array<object>	The available capacity of ECS instances in the host group.
	object
InstanceType	string	The ECS instance type.	ecs.c6.26xlarge
AvailableInstanceCapacity	integer	The available capacity of the ECS instance type.	0

Contoh

Respons sukses

JSONformat

{
  "PageSize": 5,
  "RequestId": "214A2187-B06F-4E49-A081-4D053466A8C7",
  "PageNumber": 1,
  "TotalCount": 2,
  "DedicatedHostClusters": {
    "DedicatedHostCluster": [
      {
        "Description": "This-is-my-DDHCluster",
        "DedicatedHostClusterId": "dc-bp12wlf6am0vz9v2****",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ZoneId": "cn-hangzhou-f",
        "RegionId": "cn-hangzhou",
        "DedicatedHostClusterName": "myDDHCluster",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "DedicatedHostIds": {
          "DedicatedHostId": [
            "dh-bp181e5064b5sotr****"
          ]
        },
        "DedicatedHostClusterCapacity": {
          "AvailableVcpus": 2,
          "AvailableMemory": 4,
          "TotalMemory": 8,
          "TotalVcpus": 4,
          "LocalStorageCapacities": {
            "LocalStorageCapacity": [
              {
                "DataDiskCategory": "cloud",
                "AvailableDisk": 20,
                "TotalDisk": 40
              }
            ]
          },
          "AvailableInstanceTypes": {
            "AvailableInstanceType": [
              {
                "InstanceType": "ecs.c6.26xlarge",
                "AvailableInstanceCapacity": 0
              }
            ]
          }
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	MissingParamter.RegionId	The regionId should not be null.
400	InvalidParameter.DedicatedHostClusterIds	The specified parameter dedicatedHostClusterIds is not valid.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.
403	InvalidDedicatedHostIds.Malformed	The amount of specified dedicatedHostClusterIds exceeds the limit.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.