All Products
Search

This Product

    ApsaraDB for MyBase:DescribeDedicatedHostAttribute

    Document Center

    ApsaraDB for MyBase:DescribeDedicatedHostAttribute

    Last Updated:Mar 01, 2024

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

    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
    RegionIdstringNo

    The region ID.

    		cn-hangzhou
    DedicatedHostIdstringYes

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

    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 parameters

    ParameterTypeDescriptionExample
    object
    HostTypestring

    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
    HostStorageinteger

    The total storage of the host. Unit: GB.

    		100
    InstanceNumberROSlaveinteger

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

    		1
    AccountTypestring

    The account type of the host. Valid values:

    • Normal: standard account.
    • Admin: administrator account.
    		Admin
    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-34639v1jt4y4****
    RequestIdstring

    The request ID.

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

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

    		1
    AllocationStatusstring

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

    • Allocatable: yes.
    • Suspended: no.
    		Suspended
    StorageUsedstring

    The storage usage of the host. Unit: GB.

    		588800
    EcsClassCodestring

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

    		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.

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

    The IP address of the host.

    		192.168.XX.XX
    AutoRenewstring

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

    • true
    • false (default)
    		false
    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. This ensures data integrity.
    		1
    HostNamestring

    The name of the host.

    		ch-8vbj9x74z874o****
    HostCPUinteger

    The number of CPU cores of the host.

    		16
    OpenPermissionstring

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

    • 0: no.
    • 1: yes.
    		1
    InstanceNumberinteger

    The number of instances deployed on the host.

    		3
    CpuUsedstring

    The number of CPU cores used by the host.

    		36
    VPCIdstring

    The virtual private cloud (VPC) ID.

    		vpc-wz9vu1jb32wn3sdd6****
    HostClassstring

    The instance type of the host.

    		mssql.host.c2xlarge
    RegionIdstring

    The region ID.

    		cn-hangzhou
    InstanceNumberMasterinteger

    The number of primary instances deployed on the host.

    		4
    VSwitchIdstring

    The vSwitch ID.

    		vsw-bp1kaugqyrzb58oc1****
    InstanceNumberSlaveinteger

    The number of secondary instances deployed on the host.

    		1
    ExpiredTimestring

    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
    ZoneIdstring

    The zone ID.

    		cn-hangzhou-h
    CPUAllocationRatiostring

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

    		200
    ImageCategorystring

    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
    DiskAllocationRatiostring

    The storage overcommit ratio of the dedicated cluster.

    		200
    HostMeminteger

    The memory size of the host. Unit: MB.

    		2048
    AccountNamestring

    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
    DistributionTagstring

    The distribution tag of the host.

    		tag

    Examples

    Sample success responses

    JSONformat

    {
  "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 codeError codeError messageDescription
    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.
    403Permission.NotSupportThe user permission does not support the operation.The user does not have permission to perform the operation.
    404InvalidDedicatedHostGroup.NotFoundSpecified DedicatedHostGroup does not exists.-

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