Use DescribeDedicatedHosts to query dedicated host information - ApsaraDB for MyBase - Alibaba Cloud - ApsaraDB for MyBase

Queries the host information of a dedicated cluster.

Operation description

After you add a host, you can view the detailed information of the host, including performance monitoring, total number of CPUs, total memory, and total storage.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cddc:DescribeDedicatedHosts

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
DedicatedHostGroupId	string	No	The ID of the dedicated cluster. You can log on to the ApsaraDB for MyBase console and view and obtain the ID of the dedicated cluster in the Dedicated Clusters list.	dhg-h5i4p331f509****
OrderId	integer	No	The order ID. You can go to the Expenses and Costs page, click Order Management in the left-side navigation pane, and view and obtain the order ID on the Orders page.	123456789
HostType	string	No	The storage type of the host. Valid values: dhg_local_ssd: local SSD. dhg_cloud_ssd and dhg_cloud_essd: ESSD cloud disk.	dhg_cloud_ssd
HostStatus	string	No	The status of the host. Valid values: 0: creating 1: running 2: faulty 3: preparing to go offline 4: under maintenance 5: offline 6: restarting 7: locked Note When a host has a fault, the host goes offline. During the offline process, instance data on the host is migrated.	1
AllocationStatus	string	No	Specifies whether instances can be allocated to the host. Valid values: Allocatable: Instances can be allocated to the host. Suspended: Instance allocation to the host is suspended.	Allocatable
ZoneId	string	No	The zone ID. You can call the DescribeRegions operation to query the zone ID.	ap-southeast-1a
DedicatedHostId	string	No	The ID of the host in the dedicated cluster. You can log on to the ApsaraDB for MyBase console and view and obtain the host ID in the Hosts list.	ch-bp10a5id3boqi****
PageNumbers	integer	No	The total number of pages returned.	50
PageSize	integer	No	The number of entries returned per page.	20
Tags	string	No	The tags that are bound to the hosts to be queried, including TagKey and TagValue. You can specify up to 5 key-value pairs at a time in the following format: {"key1":"value1","key2":"value2"...}. Note When you filter hosts by tag, you do not need to specify the DedicatedHostId parameter. Otherwise, the hosts are filtered by DedicatedHostId.	{"key1":"value1"}

Response elements

Element	Type	Description	Example
	object
TotalRecords	integer	The total number of hosts returned.	40
PageSize	integer	The number of entries returned per page.	20
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22EASER
PageNumbers	integer	The total number of pages returned.	2
DedicatedHostGroupId	string	The ID of the dedicated cluster.	dhg-6w7q18iwt5jo****
DedicatedHosts	object
DedicatedHosts	array<object>	The list of host information.
	object
HostType	string	The storage type of the host.	dhg_cloud_ssd
HostStorage	string	The total storage capacity of the host. Unit: GB.	1234
MemoryUsed	string	The used memory. Unit: GB.	24576
DedicatedHostGroupId	string	The ID of the dedicated cluster to which the host belongs.	dhg-6w7q18iwt5jo****
AllocationStatus	string	Specifies whether instances can be allocated to the host. Valid values: Allocatable: Instances can be allocated to the host. Suspended: Instance allocation to the host is suspended.	Suspended
StorageUsed	string	The used storage capacity. Unit: GB.	588800
EcsClassCode	string	The ECS instance type code. For more information, see ECS instance types.	ecs.r5.16xlarge
DedicatedHostId	string	The ID of the host.	ch-bp10a5id3boqi****
MemAllocationRatio	string	The memory usage. Unit: %.	90
CreatedTime	string	The time when the host was created. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2020-10-16 16:30:19
IPAddress	string	The IP address of the host.	192.168.XX.XX
HostStatus	string	The status of the host. Valid values: 0: creating 1: running 2: faulty 3: preparing to go offline 4: under maintenance 5: offline 6: restarting 7: locked Note When a host has a fault, the host goes offline. Before the host goes offline, instance data on the host is migrated to other hosts.	1
HostName	string	The name of the host.	ch-bp15xfnp706tl****
HostCPU	string	The CPU of the host.	16
CpuUsed	string	The number of used CPU cores. Unit: cores.	10
InstanceNumber	string	The number of instances deployed on the host.	1
OpenPermission	string	The status of the host OS permissions. Valid values: 0: disabled 1 (default): enabled	1
DistributionSymbol	string	The distribution identifier of the host. Note This parameter is returned only when the host type is Tair.	0
VPCId	string	The VPC ID of the dedicated cluster to which the host belongs.	vpc-bp1roz55mrbj3ka1s****
HostClass	string	The instance type of the host.	rds.g6.4xlarge
EndTime	string	The expiration time of the host. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-10-16 16:30:19
VSwitchId	string	The vSwitch ID of the host.	vsw-bp133c8ifzxd3iv6q****
ZoneId	string	The zone where the host resides.	ap-southeast-1a
CPUAllocationRatio	string	The CPU usage.	10
ImageCategory	string	The image type of the host.	ALinux
Engine	string	The database engine of the host.	mysql
DiskAllocationRatio	string	The disk usage. Unit: %.	10
HostMem	string	The memory of the host. Unit: GB.	65536
BastionInstanceId	string	The ID of the associated Bastionhost instance.	bastionhost-cn-i7m2fgw****
AccountName	string	The name of the custom host account. The name can contain lowercase letters, digits, and underscores (_). The name must start with a letter and end with a letter or a digit. The name must be 2 to 16 characters in length.	test
AccountType	string	The type of the host account. Valid values: Normal: regular account Admin: administrator account	Normal
DistributionTag	string	The distribution tag of the host.	t4n9uz07h3r1tmcejtxf:1
Category	string	The type of the dedicated cluster. Valid values: Pro: MyBase Pro Edition Standard: MyBase Standard Edition Note This parameter is returned only on the China site.	Standard
EcsId	string	The ECS instance ID. Note This parameter is returned only on the China site and when the dedicated cluster type is MyBase Pro Edition.	i-2zec7l031p0jtru3pn7a
DiskInfo	string	The ECS disk information. Note This parameter is returned only on the China site and when the dedicated cluster type is MyBase Pro Edition.	{\"SystemDiskSize\":20,\"DataDiskCount\":0,\"DataDiskSize\":0,\"DataDiskCategory\":[\"\"],\"SystemDiskCategory\":\"cloud_essd\"}
ChargeType	string	The billing method.	PREPAY
MssqlSupportVersion	string	The supported SQL Server versions for the MyBase host.	2012_std_ha,2012_std,2016_std_ha,2016_std,2017_std_ha,2017_std,2019_std_ha,2019_std
MaxAutoScaleHostStorage	integer	The upper limit for automatic scaling of local disks. Unit: GB.	3661824

Examples

Success response

JSON format

{
  "TotalRecords": 40,
  "PageSize": 20,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22EASER",
  "PageNumbers": 2,
  "DedicatedHostGroupId": "dhg-6w7q18iwt5jo****",
  "DedicatedHosts": {
    "DedicatedHosts": [
      {
        "HostType": "dhg_cloud_ssd",
        "HostStorage": "1234",
        "MemoryUsed": "24576",
        "DedicatedHostGroupId": "dhg-6w7q18iwt5jo****",
        "AllocationStatus": "Suspended",
        "StorageUsed": "588800",
        "EcsClassCode": "ecs.r5.16xlarge",
        "DedicatedHostId": "ch-bp10a5id3boqi****",
        "MemAllocationRatio": "90",
        "CreatedTime": "2020-10-16 16:30:19",
        "IPAddress": "192.168.XX.XX",
        "HostStatus": "1",
        "HostName": "ch-bp15xfnp706tl****",
        "HostCPU": "16",
        "CpuUsed": "10",
        "InstanceNumber": "1",
        "OpenPermission": "1",
        "DistributionSymbol": "0",
        "VPCId": "vpc-bp1roz55mrbj3ka1s****",
        "HostClass": "rds.g6.4xlarge",
        "EndTime": "2021-10-16 16:30:19",
        "VSwitchId": "vsw-bp133c8ifzxd3iv6q****",
        "ZoneId": "ap-southeast-1a",
        "CPUAllocationRatio": "10",
        "ImageCategory": "ALinux",
        "Engine": "mysql",
        "DiskAllocationRatio": "10",
        "HostMem": "65536",
        "BastionInstanceId": "bastionhost-cn-i7m2fgw****",
        "AccountName": "test",
        "AccountType": "Normal",
        "DistributionTag": "t4n9uz07h3r1tmcejtxf:1",
        "Category": "Standard",
        "EcsId": "i-2zec7l031p0jtru3pn7a",
        "DiskInfo": "{\\\"SystemDiskSize\\\":20,\\\"DataDiskCount\\\":0,\\\"DataDiskSize\\\":0,\\\"DataDiskCategory\\\":[\\\"\\\"],\\\"SystemDiskCategory\\\":\\\"cloud_essd\\\"}",
        "ChargeType": "PREPAY",
        "MssqlSupportVersion": "2012_std_ha,2012_std,2016_std_ha,2016_std,2017_std_ha,2017_std,2019_std_ha,2019_std"
      }
    ]
  },
  "MaxAutoScaleHostStorage": 3661824
}

Error codes

HTTP status code	Error code	Error message	Description
400	Tag.InvalidTagsParameter	tags parameter is invalid
400	InvalidUserId.NotSupport	The userid have no permission.
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.	The user is not authorized to operate on the specified resource.
404	InvalidDedicatedHostGroup.NotFound	Specified DedicatedHostGroup does not exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.