All Products
Search

This Product

    ApsaraDB for MyBase:DescribeDedicatedHosts

    Document Center

    ApsaraDB for MyBase:DescribeDedicatedHosts

    Last Updated:Aug 28, 2026

    Queries host information in a dedicated cluster.

    Operation description

    After hosts are created in a dedicated cluster, you can query host details including performance metrics, CPU cores, memory size, 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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID.

    cn-hangzhou
    DedicatedHostGroupId

    string

    No

    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****
    OrderId

    integer

    No

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

    123456789
    HostType

    string

    No

    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
    HostStatus

    string

    No

    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
    AllocationStatus

    string

    No

    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
    ZoneId

    string

    No

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

    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 go to the Hosts page to view the host ID.

    ch-bp10a5id3boqi****
    PageNumbers

    integer

    No

    The page number.

    50
    PageSize

    integer

    No

    The number of entries per page.

    20
    Tags

    string

    No

    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 elements

    Element

    Type

    Description

    Example

    object

    TotalRecords

    integer

    The total number of entries returned.

    40
    PageSize

    integer

    The number of entries per page.

    20
    RequestId

    string

    The request ID.

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

    integer

    The page number.

    2
    DedicatedHostGroupId

    string

    The dedicated cluster ID.

    dhg-6w7q18iwt5jo****
    DedicatedHosts

    object

    DedicatedHosts

    array<object>

    The queried hosts.

    object

    HostType

    string

    The storage type of the host.

    dhg_cloud_ssd
    HostStorage

    string

    The total storage of the host. Unit: GB.

    1234
    MemoryUsed

    string

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

    24576
    DedicatedHostGroupId

    string

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

    dhg-6w7q18iwt5jo****
    AllocationStatus

    string

    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
    StorageUsed

    string

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

    588800
    EcsClassCode

    string

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

    ecs.r5.16xlarge
    DedicatedHostId

    string

    The host ID.

    ch-bp10a5id3boqi****
    MemAllocationRatio

    string

    The memory usage of the host. Unit: %.

    90
    CreatedTime

    string

    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
    IPAddress

    string

    The IP address of the host.

    192.168.XX.XX
    HostStatus

    string

    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
    HostName

    string

    The name of the host.

    ch-bp15xfnp706tl****
    HostCPU

    string

    The number of CPU cores of the host.

    16
    CpuUsed

    string

    The number of used CPU cores.

    10
    InstanceNumber

    string

    The number of instances deployed on the host.

    1
    OpenPermission

    string

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

    • 0: no.

    • 1 (default): yes.

    1
    DistributionSymbol

    string

    The distribution symbol of the host.

    Note

    This parameter is returned only when the host runs Tair.

    0
    VPCId

    string

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

    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 ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    2021-10-16 16:30:19
    VSwitchId

    string

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

    vsw-bp133c8ifzxd3iv6q****
    ZoneId

    string

    The ID of the zone in which the host resides.

    ap-southeast-1a
    CPUAllocationRatio

    string

    The CPU utilization of the host.

    10
    ImageCategory

    string

    The image type of the host.

    ALinux
    Engine

    string

    The database engine of the host.

    mysql
    DiskAllocationRatio

    string

    The disk usage of the host. Unit: %.

    10
    HostMem

    string

    The memory size of the host. Unit: GB.

    65536
    BastionInstanceId

    string

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

    bastionhost-cn-i7m2fgw****
    AccountName

    string

    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
    AccountType

    string

    The account type of the host. Valid values:

    Normal: standard 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: Proprietary MyBase.

    • Standard: Managed MyBase.

    Note

    This parameter is returned only for the China site (aliyun.com).

    Standard
    EcsId

    string

    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
    DiskInfo

    string

    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\"}
    ChargeType

    string

    The billing method.

    PREPAY
    MssqlSupportVersion

    string

    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
    MaxAutoScaleHostStorage

    integer

    The maximum storage of local SSDs for auto scaling. 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.