DescribeDedicatedHosts - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengkueri detail satu atau beberapa host spesifikasi khusus. Anda dapat mengambil informasi seperti metrik performa fisik, kode mesin, status penggunaan, dan daftar instans ECS yang dibuat pada host spesifikasi khusus. Anda dapat menentukan parameter seperti ID host spesifikasi khusus, ID kluster host spesifikasi khusus, hostname, dan status untuk mengkueri detail host spesifikasi khusus.

Deskripsi operasi

Anda dapat mengkueri detail satu atau beberapa host spesifikasi khusus dengan menggunakan salah satu metode berikut:

Tentukan DedicatedHostIds untuk mengkueri detail host spesifikasi khusus.
Tentukan DedicatedHostClusterId untuk mengkueri detail host spesifikasi khusus dalam sebuah kluster host spesifikasi khusus.

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

get

Host khusus

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

Host khusus

acs:ecs:{#regionId}:{#accountId}:ddh/{#ddhId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah host khusus. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
ZoneId	string	No	ID zona. Anda dapat memanggil DescribeZones untuk mengkueri daftar zona terbaru.	cn-hangzhou-g
DedicatedHostIds	string	No	Daftar ID host khusus. Anda dapat menentukan hingga 100 ID, dipisahkan dengan koma (,).	["dh-bp165p6xk2tlw61e**", "dh-bp1f9vxmno7emy96**"]
DedicatedHostName	string	No	Nama host khusus.	MyDDHTestName
Status	string	No	Status penggunaan host spesifikasi khusus. Nilai valid: Available: Host spesifikasi khusus berjalan sesuai harapan. UnderAssessment: Mesin fisik memiliki potensi risiko. Mesin fisik tersedia tetapi dapat menyebabkan masalah pada instans ECS di host spesifikasi khusus. PermanentFailure: Host spesifikasi khusus mengalami kegagalan permanen dan tidak tersedia. TempUnavailable: Host spesifikasi khusus tidak tersedia untuk sementara waktu. Redeploying: Host spesifikasi khusus sedang dipulihkan. Nilai default: Available.	Available
DedicatedHostType	string	No	Tipe host spesifikasi khusus. Anda dapat memanggil DescribeDedicatedHostTypes untuk mengkueri daftar tipe host spesifikasi khusus terbaru.	ddh.g5
LockReason	string	No	Alasan host khusus terkunci. Nilai valid: financial: Host khusus terkunci karena pembayaran tertunda. security: Host khusus terkunci karena alasan keamanan.	financial
PageNumber	integer	No	Catatan Parameter ini akan segera dihentikan. Gunakan NextToken dan MaxResults untuk melakukan operasi kueri berhalaman.	1
PageSize	integer	No	Catatan Parameter ini akan segera dihentikan. Gunakan NextToken dan MaxResults untuk melakukan operasi kueri berhalaman.	10
ResourceGroupId	string	No	ID kelompok sumber daya tempat host khusus berada. Saat Anda menggunakan parameter ini untuk memfilter resource, jumlah resource tidak boleh melebihi 1000. Catatan Pemfilteran berdasarkan kelompok sumber daya default tidak didukung.	rg-aek3b6jzp66****
NeedHostDetail	string	No	Informasi detail host spesifikasi khusus.	false
Tag	array<object>	No	Tag. Nilai valid untuk N: 0 hingga 20.
	object	No
Key	string	No	Kunci tag host khusus. Jika Anda menentukan parameter ini, nilainya tidak boleh berupa string kosong. Kunci tag dapat memiliki panjang hingga 128 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Kunci tag tidak boleh mengandung `http://` atau `https://`.	TestKey
Value	string	No	Nilai tag host khusus. Jika Anda menentukan parameter ini, nilainya dapat berupa string kosong. Nilai tag dapat memiliki panjang hingga 128 karakter dan tidak boleh mengandung `http://` atau `https://`.	TestValue
DedicatedHostClusterId	string	No	ID kluster host khusus.	dc-bp12wlf6am0vz9v2****
SocketDetails	string	No	Apakah akan menampilkan informasi kapasitas tingkat socket. Anda dapat menggunakan informasi kapasitas tingkat socket untuk melihat Sumber daya yang tersisa (vCPU, penggunaan memori, kapasitas tersisa, dan kapasitas total) guna menentukan apakah instans ECS dengan tipe instans tertentu dapat dibuat. Nilai valid: true: Menampilkan informasi kapasitas tingkat socket. Hanya tipe host spesifikasi khusus tertentu yang mendukung tampilan informasi Sumber daya tingkat socket. Untuk informasi selengkapnya, lihat Melihat dan mengekspor informasi DDH. false: Tidak menampilkan informasi kapasitas tingkat socket. Penting Setiap host spesifikasi khusus biasanya memiliki dua CPU, bernomor Socket 0 dan Socket 1. Pada host spesifikasi khusus, instans ECS tidak dibuat melintasi socket untuk memastikan performa maksimum. Instans ECS hanya dibuat berdasarkan satu socket. Jika Sumber daya komputasi tersisa pada satu socket lebih besar atau sama dengan tipe instans ECS yang akan dibuat, instans ECS akan dibuat. Jika Sumber daya komputasi tersisa pada setiap socket lebih kecil dari tipe instans ECS yang akan dibuat, instans ECS gagal dibuat, meskipun gabungan Sumber daya tersisa dari kedua socket melebihi persyaratan tipe instans ECS.	true
NextToken	string	No	Token pagination. Atur parameter ini ke nilai NextToken yang dikembalikan pada pemanggilan sebelumnya. Anda tidak perlu mengatur parameter ini untuk permintaan pertama.	e71d8a535bd9cc11
MaxResults	integer	No	Jumlah maksimum entri per halaman untuk kueri berhalaman. Jika Anda mengatur parameter ini, hal ini menunjukkan bahwa metode paging menggunakan parameter MaxResults dan NextToken digunakan. Nilai maksimum: 100. Nilai default: 10.	10
QueryInventory	boolean	No

Elemen respons

Element	Type	Description	Example
	object
DedicatedHosts	object
DedicatedHost	array<object>	Detail host khusus.
	array<object>	ID Managed Private Space tempat host khusus berada.
ActionOnMaintenance	string	Rencana migrasi untuk instans pada host khusus saat terjadi kegagalan. Nilai valid: Migrate: Host khusus dimigrasi ke server fisik lain. Instans yang tidak dihentikan sebelum kegagalan akan dimulai. Stop: Instans dihentikan pada host khusus saat ini. Setelah host khusus dikonfirmasi tidak dapat diperbaiki, instans dimigrasi ke server fisik lain dan dimulai ulang. Nilai default saat host khusus menggunakan penyimpanan cloud disk: Migrate. Nilai default saat host khusus menggunakan penyimpanan local disk: Stop.	Migrate
AutoPlacement	string	Apakah host khusus ditambahkan ke kolam sumber daya penyebaran otomatis. Nilai valid: on: Host khusus ditambahkan ke kolam sumber daya penyebaran otomatis. off: Host khusus tidak ditambahkan ke kolam sumber daya penyebaran otomatis. Untuk informasi lebih lanjut tentang penyebaran otomatis, lihat Penyebaran otomatis.	on
AutoReleaseTime	string	Waktu pelepasan otomatis. Waktu mengikuti standar ISO 8601 dalam format `yyyy-MM-ddTHH:mmZ`. Waktu ditampilkan dalam UTC+0.	2017-01-01T12:00Z
Capacity	object	Metrik performa host khusus.
AvailableInstanceTypes	object
AvailableInstanceType	array<object>	Tipe instans yang tersedia.
	object	Informasi tipe instans yang tersedia.
AvailableInstanceCapacity	integer	Kapasitas yang tersedia untuk tipe instans.
InstanceType	string	Tipe instans. Untuk informasi lebih lanjut, lihat keluarga instans. Catatan Parameter ini wajib diisi.
AvailableLocalStorage	integer	Kapasitas disk lokal yang tersisa. Unit: GiB.	65
AvailableMemory	number	Kapasitas memori yang tersisa. Unit: GiB.	25
AvailableVcpus	integer	Jumlah vCPU yang tersisa.	5
AvailableVgpus	integer	Jumlah GPU virtual yang tersedia.	2
LocalStorageCategory	string	Kategori local disk.	i2
SocketCapacities	object
SocketCapacity	array<object>	Informasi kapasitas tingkat socket.
	object
AvailableMemory	number	Kapasitas memori yang tersisa. Unit: GiB.	65
AvailableVcpu	integer	Jumlah vCPU yang tersisa.	64
SocketId	integer	ID socket.	1
TotalMemory	number	Kapasitas memori total. Unit: GiB.	128
TotalVcpu	integer	Jumlah vCPU total.	128
TotalLocalStorage	integer	Kapasitas disk lokal total. Unit: GiB.	512
TotalMemory	number	Kapasitas memori total. Unit: GiB.	1024
TotalVcpus	integer	Jumlah vCPU total.	56
TotalVgpus	integer	Jumlah GPU virtual total.	10
ChargeType	string	Metode penagihan host khusus.	Prepaid
Cores	integer	Jumlah core per CPU fisik.	3
CpuOverCommitRatio	number	Rasio overcommit, rasio overprovisioning CPU. Nilai valid: 1 hingga 5.	1
CreationTime	string	Waktu pembuatan host khusus. Waktu mengikuti standar ISO 8601 dalam format `yyyy-MM-ddTHH:mmZ`. Waktu ditampilkan dalam UTC+0.	2018-01-01T12:00Z
DedicatedHostClusterId	string	ID kluster host khusus tempat host khusus berada.	dc-bp12wlf6am0vz9v2****
DedicatedHostId	string	ID host khusus.	dh-bp165p6xk2tlw61e****
DedicatedHostName	string	Nama host khusus.	MyDDHTestName
DedicatedHostOwnerId	integer	ID pengguna pemilik host khusus.	100************7
DedicatedHostType	string	Tipe host khusus.	ddh.g5
Description	string	Deskripsi host khusus.	this-is-my-DDH
ExpiredTime	string	Waktu kedaluwarsa host khusus langganan. Waktu mengikuti standar ISO 8601 dalam format `yyyy-MM-ddTHH:mmZ`. Waktu ditampilkan dalam UTC+0.	2019-01-01T12:00Z
GPUSpec	string	Model GPU.	gpu
HostDetailInfo	object	Parameter ini akan segera ditinggalkan. Untuk kompatibilitas yang lebih baik, gunakan parameter lain.
SerialNumber	string	Parameter ini akan segera ditinggalkan. Untuk kompatibilitas yang lebih baik, gunakan parameter lain.	null
VgpuVersion	string	Parameter ini akan segera ditinggalkan. Untuk kompatibilitas yang lebih baik, gunakan parameter lain.	null
Instances	object
Instance	array<object>	Instance ECS yang dibuat pada host khusus.
	object	Instance ECS yang dibuat pada host khusus.
InstanceId	string	ID instans Instance ECS yang dibuat pada host khusus.	i-bp14ot0ykf8w13a1****
InstanceOwnerId	integer	ID pengguna pemilik Instance ECS.	128************0
InstanceType	string	Tipe instans Instance ECS yang dibuat pada host khusus.	ecs.g5.large
SocketId	string	ID socket tempat instans berada.	0,1
MachineId	string	Kode mesin host khusus.	12aaa123456ff19dec12345d3026e****
NetworkAttributes	object	Atribut jaringan host khusus.
SlbUdpTimeout	integer	Periode pengatur waktu UDP SLB. Unit: detik. Hanya 60 detik yang didukung.	60
UdpTimeout	integer	Periode pengatur waktu UDP. Unit: detik. Hanya 60 detik yang didukung.	60
OperationLocks	object
OperationLock	array<object>	Alasan host khusus terkunci.
	object
LockReason	string	Alasan host khusus terkunci. Nilai valid: financial: Host khusus terkunci karena pembayaran tertunda. security: Host khusus terkunci karena alasan keamanan.	financial
PhysicalGpus	integer	Jumlah GPU fisik.	10
RegionId	string	ID wilayah host khusus.	cn-hangzhou
ResourceGroupId	string	ID kelompok sumber daya tempat host khusus berada.	rg-aek3b6jzp66****
SaleCycle	string	Unit langganan. Nilai valid: Month. Year.	Month
SchedulerOptions.ManagedPrivateSpaceId	string	ID Managed Private Space tempat host khusus berada.	mps-iq81z6pkbqjx61php46e
Sockets	integer	Jumlah CPU fisik.	5
Status	string	Status host khusus. Nilai valid: Available: Host khusus berjalan sesuai harapan. UnderAssessment: Mesin fisik memiliki risiko potensial. Mesin fisik tersedia tetapi dapat menyebabkan masalah pada Instance ECS di host khusus. PermanentFailure: Host khusus mengalami kegagalan permanen dan tidak tersedia.	Available
SupportedCustomInstanceTypeFamilies	object
SupportedCustomInstanceTypeFamily	array	Keluarga tipe instans kustom yang didukung oleh host khusus.
	string	keluarga instans kustom yang didukung oleh host khusus.	ecs.ddh6s.custom
SupportedInstanceTypeFamilies	object
SupportedInstanceTypeFamily	array	Keluarga instans ECS yang didukung oleh host khusus.
	string	Keluarga instans ECS yang didukung oleh host khusus.	ecs.g5
SupportedInstanceTypesList	object
SupportedInstanceTypesList	array	Tipe instans ECS yang didukung oleh host khusus.
	string	Tipe instans ECS yang didukung oleh host khusus.	ecs.g5.large
Tags	object
Tag	array<object>	Tag host khusus.
	object	Pasangan kunci tag dan nilai tag.
TagKey	string	Kunci tag host khusus.	TestKey
TagValue	string	Nilai tag host khusus.	TestValue
ZoneId	string	ID zona.	cn-hangzhou-g
NextToken	string	Token kueri yang dikembalikan dalam pemanggilan ini. Jika nilai kembalian kosong saat Anda menggunakan MaxResults dan NextToken untuk paging, tidak ada data lagi yang tersedia.	e71d8a535bd9cc11
PageNumber	integer	Nomor halaman daftar host khusus.	5
PageSize	integer	Jumlah entri per halaman.	1
RequestId	string	ID permintaan.	7654525A-9964-4ABB-8BCD-98F8835E809A
TotalCount	integer	Jumlah total host khusus.	3

Contoh

Respons sukses

JSONformat

{
  "DedicatedHosts": {
    "DedicatedHost": [
      {
        "ActionOnMaintenance": "Migrate",
        "AutoPlacement": "on",
        "AutoReleaseTime": "2017-01-01T12:00Z",
        "Capacity": {
          "AvailableInstanceTypes": {
            "AvailableInstanceType": [
              {
                "AvailableInstanceCapacity": 0,
                "InstanceType": ""
              }
            ]
          },
          "AvailableLocalStorage": 65,
          "AvailableMemory": 25,
          "AvailableVcpus": 5,
          "AvailableVgpus": 2,
          "LocalStorageCategory": "i2",
          "SocketCapacities": {
            "SocketCapacity": [
              {
                "AvailableMemory": 65,
                "AvailableVcpu": 64,
                "SocketId": 1,
                "TotalMemory": 128,
                "TotalVcpu": 128
              }
            ]
          },
          "TotalLocalStorage": 512,
          "TotalMemory": 1024,
          "TotalVcpus": 56,
          "TotalVgpus": 10
        },
        "ChargeType": "Prepaid",
        "Cores": 3,
        "CpuOverCommitRatio": 1,
        "CreationTime": "2018-01-01T12:00Z",
        "DedicatedHostClusterId": "dc-bp12wlf6am0vz9v2****",
        "DedicatedHostId": "dh-bp165p6xk2tlw61e****",
        "DedicatedHostName": "MyDDHTestName",
        "DedicatedHostOwnerId": 0,
        "DedicatedHostType": "ddh.g5",
        "Description": "this-is-my-DDH",
        "ExpiredTime": "2019-01-01T12:00Z",
        "GPUSpec": "gpu",
        "HostDetailInfo": {
          "SerialNumber": "null",
          "VgpuVersion": "null"
        },
        "Instances": {
          "Instance": [
            {
              "InstanceId": "i-bp14ot0ykf8w13a1****",
              "InstanceOwnerId": 0,
              "InstanceType": "ecs.g5.large",
              "SocketId": "0,1"
            }
          ]
        },
        "MachineId": "12aaa123456ff19dec12345d3026e****",
        "NetworkAttributes": {
          "SlbUdpTimeout": 60,
          "UdpTimeout": 60
        },
        "OperationLocks": {
          "OperationLock": [
            {
              "LockReason": "financial"
            }
          ]
        },
        "PhysicalGpus": 10,
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-aek3b6jzp66****",
        "SaleCycle": "Month",
        "SchedulerOptions.ManagedPrivateSpaceId": "mps-iq81z6pkbqjx61php46e",
        "Sockets": 5,
        "Status": "Available",
        "SupportedCustomInstanceTypeFamilies": {
          "SupportedCustomInstanceTypeFamily": [
            "ecs.ddh6s.custom"
          ]
        },
        "SupportedInstanceTypeFamilies": {
          "SupportedInstanceTypeFamily": [
            "ecs.g5"
          ]
        },
        "SupportedInstanceTypesList": {
          "SupportedInstanceTypesList": [
            "ecs.g5.large"
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "ZoneId": "cn-hangzhou-g"
      }
    ]
  },
  "NextToken": "e71d8a535bd9cc11",
  "PageNumber": 5,
  "PageSize": 1,
  "RequestId": "7654525A-9964-4ABB-8BCD-98F8835E809A",
  "TotalCount": 3
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidStatus.ValueNotSupported	The pecified dedicated host status is not supported.	Status disk yang ditentukan tidak mendukung operasi ini.
400	MissingParamter.RegionId	The regionId should not be null.	Parameter RegionId tidak boleh kosong.
400	InvalidParameter.DedicatedHostIds	The specified parameter dedicatedHostIds is not valid.	Parameter DedicatedHostIds yang ditentukan tidak valid. Host khusus tidak didukung.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	Parameter RegionId tidak valid.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	ZoneId yang ditentukan tidak valid.
403	InvalidDedicatedHostIds.Malformed	The amount of specified dedicatedHostIds exceeds the limit.	Parameter spesifikasi khusus dapat berisi maksimal 100 entri.
404	InvalidLockReason.NotFound	The specified LockReason is not found.	Tipe kunci yang ditentukan tidak ada.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.