DescribeDedicatedHosts - ApsaraDB RDS - Alibaba Cloud Documentation Center

Mengkueri informasi host di klaster khusus.

Deskripsi operasi

Fitur klaster khusus mengelola instance secara batch dalam bentuk klaster. Anda dapat membuat beberapa klaster khusus di satu wilayah. Sebuah klaster khusus berisi beberapa host, dan sebuah host berisi beberapa instance. Untuk informasi lebih lanjut, lihat Ikhtisar klaster 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

rds:DescribeDedicatedHosts

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.	cn-hangzhou
DedicatedHostGroupId	string	No	ID klaster khusus. Anda dapat memanggil operasi DescribeDedicatedHostGroups untuk mengkueri ID klaster khusus.	dhg-7a9xxxxxxxx
OrderId	integer	No	ID pesanan.	102565235
HostType	string	No	Tipe penyimpanan host. Nilai yang valid: dhg_cloud_ssd: enhanced SSD (ESSD). dhg_local_ssd: SSD lokal.	dhg_cloud_ssd
HostStatus	string	No	Status host. Nilai yang valid: 0: Sedang dibuat 1: Sedang digunakan 2: Bermasalah 3: Offline karena kesalahan (host sedang diganti) 4: Offline 5: Dihapus 6: Sedang memulai ulang	1
AllocationStatus	string	No	Menentukan apakah instance dapat di-deploy pada host. Nilai yang valid: 0: Instance tidak dapat di-deploy. 1: Instance dapat di-deploy.	1
ZoneId	string	No	ID zona.	cn-hangzhou-i
DedicatedHostId	string	No	ID host di klaster khusus.	ch-t4nn100ddxxxxxxxx

Elemen respons

Element	Type	Description	Example
	object
DedicatedHostGroupId	string	ID grup host.	dhg-7a9xxxxxxxx
DedicatedHosts	object
DedicatedHosts	array<object>	Daftar informasi host.
	object
AccountName	string	The host account. You can call the CreateDedicatedHostAccount operation to create a host account.	test123
AllocationStatus	string	Specifies whether instances can be deployed on the host. Valid values: 0: Instances cannot be deployed on the host. 1: Instances can be deployed on the host.	1
BastionInstanceId	string	The bastion host ID.	bastionhost-cn-m7xxxxxxxx
CPUAllocationRatio	string	The core overcommitment ratio of the dedicated cluster. Unit: percentage. For more information about the core overcommitment ratio, see Manage a dedicated cluster.	200
CpuUsed	string	The number of used CPU cores on the host. Unit: cores.	4
CreatedTime	string	The time when the host was created.	2021-03-25 17:29:06.0
DedicatedHostGroupId	string	The dedicated cluster ID.	dhg-7a9xxxxxxxx
DedicatedHostId	string	The host ID.	i-bpxxxxxxx
DiskAllocationRatio	string	The disk overcommitment ratio of the dedicated cluster. Unit: percentage. For more information about the core overcommitment ratio, see Manage a dedicated cluster.	200
EndTime	string	The time when the host expires.	2021-04-25T16:00:00Z
Engine	string	The database engine of instances that are created on the host.	mysql
HostCPU	string	The total number of CPU cores that are configured for the host. Unit: cores.	8
HostClass	string	The instance type of the host.	ecs.i2.16xlarge
HostMem	string	The total memory space of the host. Unit: MB.	32238
HostName	string	The host name.	testHost1
HostStatus	string	The status of the host. Valid values: 0: creating 1: running 2: faulty 3: being replaced 4: deprecated 5: deleting 6: restarting	1
HostStorage	string	The storage capacity of the host. Unit: MB.	2097152
HostType	string	The storage type of the host. Valid values: dhg_cloud_ssd: ESSD dhg_local_ssd: local SSD	dhg_cloud_ssd
IPAddress	string	The internal IP address of the host.	192.xx.xx.xx
ImageCategory	string	The host image. This parameter is returned only when the Engine parameter is set to mssql. Valid values: WindowsWithMssqlStdLicense: a Windows image that contains the licenses of SQL Server Standard Edition WindowsWithMssqlEntLisence: a Windows image that contains the licenses of SQL Server Enterprise Edition WindowsWithMssqlWebLisence: a Windows image that contains the licenses of SQL Server Web Edition	WindowsWithMssqlStdLicense
InstanceNumber	string	The total number of instances that are created on the host.	4
MemAllocationRatio	string	The maximum memory usage per host in the dedicated cluster.	90
MemoryUsed	string	The size of the used memory. Unit: MB.	16384
OpenPermission	string	Indicates whether the feature that allows you to have the OS permissions on the host is enabled. Valid values: 0 or null: The permissions cannot be granted. 1: The permissions can be granted. 3: The permissions have been granted.	3
StorageUsed	string	The amount of used storage space on the host.	0
VPCId	string	The ID of the virtual private cloud (VPC) to which the host belongs.	vpc-bpxxxxxxx
VSwitchId	string	The ID of the vSwitch associated with the specified VPC.	vsw-bpxxxxxxx
ZoneId	string	The zone ID of the host.	cn-hangzhou-i
RequestId	string	ID permintaan.	C860658E-68A6-46C1-AF6E-3AE7C4D3CACF

Contoh

Respons sukses

JSONformat

{
  "DedicatedHostGroupId": "dhg-7a9xxxxxxxx",
  "DedicatedHosts": {
    "DedicatedHosts": [
      {
        "AccountName": "test123",
        "AllocationStatus": "1",
        "BastionInstanceId": "bastionhost-cn-m7xxxxxxxx",
        "CPUAllocationRatio": "200",
        "CpuUsed": "4",
        "CreatedTime": "2021-03-25 17:29:06.0",
        "DedicatedHostGroupId": "dhg-7a9xxxxxxxx",
        "DedicatedHostId": "i-bpxxxxxxx",
        "DiskAllocationRatio": "200",
        "EndTime": "2021-04-25T16:00:00Z",
        "Engine": "mysql",
        "HostCPU": "8",
        "HostClass": "ecs.i2.16xlarge",
        "HostMem": "32238",
        "HostName": "testHost1",
        "HostStatus": "1",
        "HostStorage": "2097152",
        "HostType": "dhg_cloud_ssd",
        "IPAddress": "192.xx.xx.xx",
        "ImageCategory": "WindowsWithMssqlStdLicense",
        "InstanceNumber": "4",
        "MemAllocationRatio": "90",
        "MemoryUsed": "16384",
        "OpenPermission": "3",
        "StorageUsed": "0",
        "VPCId": "vpc-bpxxxxxxx",
        "VSwitchId": "vsw-bpxxxxxxx",
        "ZoneId": "cn-hangzhou-i"
      }
    ]
  },
  "RequestId": "C860658E-68A6-46C1-AF6E-3AE7C4D3CACF"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidUserId.NotSupport	The userid have no permission.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidDedicatedHostGroup.NotFound	Specified DedicatedHostGroup does not exists.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.