All Products
Search
Document Center

ApsaraDB for MyBase:DescribeDedicatedHosts

Last Updated:Mar 01, 2024

Queries the information about hosts in a dedicated cluster.

Operation description

After hosts are created in a dedicated cluster, you can query the information about the hosts such as performance metrics, total number of CPU cores, total memory size, and total storage.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYescn-hangzhou
DedicatedHostGroupIdstringYes

The dedicated cluster ID. You can log on to the ApsaraDB for MyBase console and go to the Dedicated Clusters page to view the dedicated cluster ID.

dhg-h5i4p331f509****
OrderIdlongNo

The order ID. You can log on to the Billing Management console and go to the Orders page to view the order ID.

123456789
HostTypestringNo

The storage type of the host. Valid values:

  • dhg_local_ssd: local SSD.
  • dhg_cloud_ssd or dhg_cloud_essd: enhanced SSD (ESSD).
dhg_cloud_ssd
HostStatusstringNo

The state of the host. Valid values:

  • 0: The host is being created.
  • 1: The host is running.
  • 2: The host is faulty.
  • 3: The host is ready for disabling.
  • 4: The host is being maintained.
  • 5: The host is disabled.
  • 6: The host is restarting.
  • 7: The host is locked.
Note When a host fails, the host is disabled. Before the host is disabled, the data of the instances that run on the host is migrated to another host.
1
AllocationStatusstringNo

Specifies whether instances can be deployed on the host. Valid values:

  • Allocatable: Instances can be deployed on the host.
  • Suspended: Instances cannot be deployed on the host.
Allocatable
ZoneIdstringNo

The zone ID. You can call the DescribeRegions operation to query the most recent zone list.

ap-southeast-1a
DedicatedHostIdstringNo

The ID of the host in the dedicated cluster. You can log on to the ApsaraDB for MyBase console and go to the Hosts page to view the host ID.

ch-bp10a5id3boqi****
PageNumbersintegerNo

The page number.

50
PageSizeintegerNo

The number of entries per page.

20
TagsstringNo

The tags that are added to the host. Each tag is a key-value pair that consists of TagKey and TagValue. You can specify a maximum of five tags in the following format for each request: {"key1":"value1","key2":"value2"...}.

Note If you want to filter hosts based on tags, do not specify the DedicatedHostId parameter. Otherwise, the DedicatedHostId parameter is used to filter hosts.
{"key1":"value1"}

Response parameters

ParameterTypeDescriptionExample
object
TotalRecordsinteger

The total number of entries returned.

40
PageSizeinteger

The number of entries per page.

20
RequestIdstring

The request ID.

D6E068C3-25BC-455A-85FE-45F0B22EASER
PageNumbersinteger

The page number.

2
DedicatedHostGroupIdstring

The dedicated cluster ID.

dhg-6w7q18iwt5jo****
DedicatedHostsobject []

The queried hosts.

HostTypestring

The storage type of the host.

dhg_cloud_ssd
HostStoragestring

The total storage of the host. Unit: GB.

1234
MemoryUsedstring

The amount of memory used by the host. Unit: GB.

24576
DedicatedHostGroupIdstring

The ID of the dedicated cluster in which the host is created.

dhg-6w7q18iwt5jo****
AllocationStatusstring

Specifies whether instances can be deployed on the host. Valid values:

  • Allocatable: Instances can be deployed on the host.
  • Suspended: Instances cannot be deployed on the host.
Suspended
StorageUsedstring

The amount of storage used by the host. Unit: GB.

588800
EcsClassCodestring

The instance type of the Elastic Compute Service (ECS) instance. For more information, see Overview of instance families.

ecs.r5.16xlarge
DedicatedHostIdstring

The host ID.

ch-bp10a5id3boqi****
MemAllocationRatiostring

The memory usage of the host. Unit: %.

90
CreatedTimestring

The time when the host was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2020-10-16 16:30:19
IPAddressstring

The IP address of the host.

192.168.XX.XX
HostStatusstring

The state of the host. Valid values:

  • 0: The host is being created.
  • 1: The host is running.
  • 2: The host is faulty.
  • 3: The host is ready for disabling.
  • 4: The host is being maintained.
  • 5: The host is disabled.
  • 6: The host is restarting.
  • 7: The host is locked.
Note When a host fails, the host is disabled. Before the host is disabled, the data of the instances that run on the host is migrated to another host.
1
HostNamestring

The name of the host.

ch-bp15xfnp706tl****
HostCPUstring

The number of CPU cores of the host.

16
CpuUsedstring

The number of used CPU cores.

10
InstanceNumberstring

The number of instances deployed on the host.

1
OpenPermissionstring

Indicates whether the host OS permissions are granted. Valid values:

  • 0: no.
  • 1 (default): yes.
3
DistributionSymbolstring

The distribution symbol of the host.

Note This parameter is returned only when the host runs Tair.
0
VPCIdstring

The virtual private cloud (VPC) ID of the dedicated cluster in which the host is created.

vpc-bp1roz55mrbj3ka1s****
HostClassstring

The instance type of the host.

rds.g6.4xlarge
EndTimestring

The expiration time of the host. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2021-10-16 16:30:19
VSwitchIdstring

The ID of the vSwitch to which the host is connected.

vsw-bp133c8ifzxd3iv6q****
ZoneIdstring

The ID of the zone in which the host resides.

ap-southeast-1a
CPUAllocationRatiostring

The CPU utilization of the host.

10
ImageCategorystring

The image type of the host.

ALinux
Enginestring

The database engine of the host.

mysql
DiskAllocationRatiostring

The disk usage of the host. Unit: %.

10
HostMemstring

The memory size of the host. Unit: GB.

65536
BastionInstanceIdstring

The ID of the bastion host with which the host is associated.

bastionhost-cn-i7m2fgw****
AccountNamestring

The custom account name of the host.

  • The name can contain lowercase letters, digits, and underscores (_).
  • The name must start with a lowercase letter and end with a lowercase letter or a digit.
  • The name must be 2 to 16 characters in length.
test
AccountTypestring

The account type of the host. Valid values:

Normal: standard account.

Admin: administrator account.

Normal
DistributionTagstring

The distribution tag of the host.

t4n9uz07h3r1tmcejtxf:1
Categorystring

The type of the dedicated cluster. Valid values:

  • Pro: Proprietary MyBase.
  • Standard: Managed MyBase.
Note This parameter is returned only for the China site (aliyun.com).
Standard
EcsIdstring

The ID of the ECS instance.

Note This parameter is returned only for the China site (aliyun.com) when the dedicated cluster is of the Proprietary MyBase type.
i-2zec7l031p0jtru3pn7a
DiskInfostring

The disk information of the ECS instance.

Note This parameter is returned only for the China site (aliyun.com) when the dedicated cluster is of the Proprietary MyBase type.
{\"SystemDiskSize\":20,\"DataDiskCount\":0,\"DataDiskSize\":0,\"DataDiskCategory\":[\"\"],\"SystemDiskCategory\":\"cloud_essd\"}
ChargeTypestring

The billing method.

PREPAY
MssqlSupportVersionstring

The versions supported by hosts in ApsaraDB MyBase for SQL Server.

2012_std_ha,2012_std,2016_std_ha,2016_std,2017_std_ha,2017_std,2019_std_ha,2019_std
MaxAutoScaleHostStoragelong

The maximum storage of local SSDs for auto scaling. Unit: GB.

3661824

Examples

Sample success responses

JSONformat

{
  "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": "3",
        "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 codeError codeError messageDescription
400Tag.InvalidTagsParametertags parameter is invalid-
400InvalidUserId.NotSupportThe userid have no permission.-
403Forbidden.RAMUser 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.
404InvalidDedicatedHostGroup.NotFoundSpecified DedicatedHostGroup does not exists.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history