All Products
Search

This Product

    ApsaraDB for MyBase:DescribeDedicatedHostAttribute

    Document Center

    ApsaraDB for MyBase:DescribeDedicatedHostAttribute

    Last Updated:Aug 28, 2026

    Queries the parameter settings of a host in a dedicated cluster.

    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

    No

    The region ID.

    cn-hangzhou
    DedicatedHostId

    string

    Yes

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

    ch-bp10a5id3boqi****
    DedicatedHostGroupId

    string

    Yes

    The ID of the dedicated cluster in which the host is created. You can log on to the ApsaraDB for MyBase console and go to the Dedicated Clusters page to view the dedicated cluster ID.

    dhg-34639v1jt4y4****

    Response elements

    Element

    Type

    Description

    Example

    object

    HostType

    string

    The storage type of the host. Valid values:

    • dhg_cloud_ssd or dhg_cloud_essd: enhanced SSD (ESSD).

    • dhg_local_ssd: local SSD.

    dhg_cloud_ssd
    HostStorage

    integer

    The total storage of the host. Unit: GB.

    100
    InstanceNumberROSlave

    integer

    The number of secondary instances of the read-only instance deployed on the host.

    1
    AccountType

    string

    The account type of the host. Valid values:

    • Normal: standard account.

    • Admin: administrator account.

    Admin
    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-34639v1jt4y4****
    RequestId

    string

    The request ID.

    00A001D6-2630-5CBD-A23C-80BC1BAFDC31
    InstanceNumberROMaster

    integer

    The number of primary instances of the read-only instance deployed on the host.

    1
    AllocationStatus

    string

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

    • Allocatable: yes.

    • Suspended: no.

    Suspended
    StorageUsed

    string

    The storage usage of the host. Unit: GB.

    588800
    EcsClassCode

    string

    The instance type of the Elastic Compute Service (ECS) instance.

    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.

    2021-11-13T07:14:22Z
    IPAddress

    string

    The IP address of the host.

    192.168.XX.XX
    AutoRenew

    string

    Indicates whether auto-renewal is enabled on the host. Valid values:

    • true

    • false (default)

    false
    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. This ensures data integrity.

    1
    HostName

    string

    The name of the host.

    ch-8vbj9x74z874o****
    HostCPU

    integer

    The number of CPU cores of the host.

    16
    OpenPermission

    string

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

    • 0: no.

    • 1: yes.

    1
    InstanceNumber

    integer

    The number of instances deployed on the host.

    3
    CpuUsed

    string

    The number of CPU cores used by the host.

    36
    VPCId

    string

    The virtual private cloud (VPC) ID.

    vpc-wz9vu1jb32wn3sdd6****
    HostClass

    string

    The instance type of the host.

    mssql.host.c2xlarge
    RegionId

    string

    The region ID.

    cn-hangzhou
    InstanceNumberMaster

    integer

    The number of primary instances deployed on the host.

    4
    VSwitchId

    string

    The vSwitch ID.

    vsw-bp1kaugqyrzb58oc1****
    InstanceNumberSlave

    integer

    The number of secondary instances deployed on the host.

    1
    ExpiredTime

    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.

    2022-03-16T16:00:00Z
    ZoneId

    string

    The zone ID.

    cn-hangzhou-h
    CPUAllocationRatio

    string

    The CPU overcommit ratio of the dedicated cluster. Unit: %. The value is accurate to the tens digit.

    200
    ImageCategory

    string

    The image of the host. This parameter is returned only when the database engine is SQL Server. Valid values:

    • WindowsWithMssqlEntAlwaysonLicense: SQL Server Cluster Edition (AlwaysOn).

    • WindowsWithMssqlStdLicense: SQL Server Standard Edition.

    • WindowsWithMssqlEntLicense: SQL Server Enterprise Edition.

    • WindowsWithMssqlWebLicense: SQL Server Web Edition.

    WindowsWithMssqlStdLicense
    DiskAllocationRatio

    string

    The storage overcommit ratio of the dedicated cluster.

    200
    HostMem

    integer

    The memory size of the host. Unit: MB.

    2048
    AccountName

    string

    The 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.

    cdp_system
    DistributionTag

    string

    The distribution tag of the host.

    tag

    Examples

    Success response

    JSON format

    {
  "HostType": "dhg_cloud_ssd",
  "HostStorage": 100,
  "InstanceNumberROSlave": 1,
  "AccountType": "Admin",
  "MemoryUsed": "24576",
  "DedicatedHostGroupId": "dhg-34639v1jt4y4****",
  "RequestId": "00A001D6-2630-5CBD-A23C-80BC1BAFDC31",
  "InstanceNumberROMaster": 1,
  "AllocationStatus": "Suspended",
  "StorageUsed": "588800",
  "EcsClassCode": "ecs.r5.16xlarge",
  "DedicatedHostId": "ch-bp10a5id3boqi****",
  "MemAllocationRatio": "90",
  "CreatedTime": "2021-11-13T07:14:22Z",
  "IPAddress": "192.168.XX.XX",
  "AutoRenew": "false",
  "HostStatus": "1",
  "HostName": "ch-8vbj9x74z874o****",
  "HostCPU": 16,
  "OpenPermission": "1",
  "InstanceNumber": 3,
  "CpuUsed": "36",
  "VPCId": "vpc-wz9vu1jb32wn3sdd6****",
  "HostClass": "mssql.host.c2xlarge",
  "RegionId": "cn-hangzhou",
  "InstanceNumberMaster": 4,
  "VSwitchId": "vsw-bp1kaugqyrzb58oc1****",
  "InstanceNumberSlave": 1,
  "ExpiredTime": "2022-03-16T16:00:00Z",
  "ZoneId": "cn-hangzhou-h",
  "CPUAllocationRatio": "200",
  "ImageCategory": "WindowsWithMssqlStdLicense",
  "DiskAllocationRatio": "200",
  "HostMem": 2048,
  "AccountName": "cdp_system",
  "DistributionTag": "tag"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    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.
    403 Permission.NotSupport The user permission does not support the operation. The user does not have permission to perform the operation.
    404 InvalidDedicatedHostGroup.NotFound Specified DedicatedHostGroup does not exists.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.