All Products
Search

This Product

    ApsaraDB for MyBase:DescribeDedicatedHostAttribute

    Document Center

    ApsaraDB for MyBase:DescribeDedicatedHostAttribute

    Last Updated:Oct 26, 2026

    Queries the parameter information 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

    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:DescribeDedicatedHostAttribute

    get

    *All Resource

    *

    		 None None

    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 dedicated cluster console and obtain the host ID on the Hosts page.

    ch-bp10a5id3boqi****
    DedicatedHostGroupId

    string

    Yes

    The ID of the dedicated cluster to which the host belongs. You can log on to the ApsaraDB dedicated cluster console and obtain the cluster ID on the Clusters page.

    dhg-34639v1jt4y4****

    Response elements

    Element

    Type

    Description

    Example

    object

    HostType

    string

    The storage type of the host. Valid values:

    • dhg_cloud_ssd and dhg_cloud_essd: ESSD cloud disk

    • dhg_local_ssd: local SSD

    dhg_cloud_ssd
    HostStorage

    integer

    The total storage capacity of the host. Unit: GB.

    100
    InstanceNumberROSlave

    integer

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

    1
    AccountType

    string

    The account type. Valid values:

    • Normal: standard account

    • Admin: administrator account

    Admin
    MemoryUsed

    string

    The memory usage of the host. Unit: GB.

    24576
    DedicatedHostGroupId

    string

    The ID of the dedicated cluster to which the host belongs.

    dhg-34639v1jt4y4****
    RequestId

    string

    The request ID.

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

    integer

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

    1
    AllocationStatus

    string

    Specifies whether instances can be allocated to the host. Valid values:

    • Allocatable: Instances can be allocated.

    • Suspended: Instance allocation is suspended.

    Suspended
    StorageUsed

    string

    The storage usage of the host. Unit: GB.

    588800
    EcsClassCode

    string

    The ECS instance type code.

    ecs.r5.16xlarge
    DedicatedHostId

    string

    The host ID.

    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 and is displayed in UTC.

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

    string

    The IP address of the host.

    192.168.XX.XX
    AutoRenew

    string

    Specifies whether auto-renewal is enabled. Valid values:

    • true: Enabled.

    • false: Disabled. This is the default value.

    false
    HostStatus

    string

    The status of the host. Valid values:

    • 0: Creating.

    • 1: Running.

    • 2: Faulty.

    • 3: Pending offline.

    • 4: Under maintenance.

    • 5: Offline.

    • 6: Restarting.

    • 7: Locked.

    Note

    When a host becomes faulty, it will be taken offline. Before the host is taken offline, instances on the faulty host are migrated to ensure 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

    Specifies whether the OS permissions of the host in the dedicated cluster are granted. Valid values:

    • 0: Not granted.

    • 1: Granted.

    1
    InstanceNumber

    integer

    The number of instances deployed on the host.

    3
    CpuUsed

    string

    The CPU usage of the host.

    36
    VPCId

    string

    The VPC ID.

    vpc-wz9vu1jb32wn3sdd6****
    HostClass

    string

    The host specifications.

    mssql.host.c2xlarge
    RegionId

    string

    The region ID.

    cn-hangzhou
    InstanceNumberMaster

    integer

    The number of primary nodes on the host.

    4
    VSwitchId

    string

    The vSwitch ID.

    vsw-bp1kaugqyrzb58oc1****
    InstanceNumberSlave

    integer

    The number of secondary nodes on the host.

    1
    ExpiredTime

    string

    The expiration time of the host. The time follows the yyyy-MM-ddTHH:mm:ssZ format and 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: %. Accurate to 10%.

    200
    ImageCategory

    string

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

    • WindowsWithMssqlEntAlwaysonLicense: SQL Server Cluster Edition

    • 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 capacity of the host. Unit: MB.

    2048
    AccountName

    string

    The name of the host account.

    • It must contain lowercase letters, digits, and underscores (_).

    • It must start with a letter and end with a letter or digit.

    • It 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.