QueryHostInstanceConsoleInfo API to query host instance information - ApsaraDB for MyBase - Alibaba Cloud - ApsaraDB for MyBase

Queries information about instances deployed on a dedicated host.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the dedicated host. You can view the region ID in the ApsaraDB for MyBase console.	cn-qingdao
DedicatedHostId	string	Yes	The host ID. You can view the host ID on the Hosts page in the ApsaraDB for MyBase console.	ch-bp1fgj3kt7fsb****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22ECB1F
HostInstanceConsoleInfos	array<object>	The queried instances.
	array<object>
Status	string	The status of the instance.	RUNNING
MaxConnIncreaseRatioValue	integer	The maximum number of connections to the instance.	1300
MemSize	integer	The memory size of the instance. Unit: GB.	16
DiskSize	integer	The storage capacity of the instance. Unit: GB.	500
Ip	string	The IP address of the host on which the instance is deployed.	172.22.XX.XX
Port	string	The port number of the host.	3443
EngineVersion	string	The version of the database engine.	5.8
MemoryIncreaseRatioValue	integer	The maximum memory size of the instance.	64
CpuIncreaseRatioValue	integer	The maximum number of CPU cores of the instance.	16
DBInstanceId	string	The instance ID.	rm-bp1m5z8002gyj****
Engine	string	The database engine of the instance.	mysql
LevelName	string	The instance type.	mysql.z2.medium.2
Role	string	The role of the instance.	master
DBInstanceDescription	string	The description of the instance.	rm-bp1m5z8002gyj****
CpuCores	integer	The number of CPU cores of the instance.	8
PerfInfo	object	The performance information of the host on which the instance is deployed.
PerfIdbPio	number	The number of physical I/O operations performed on the host.	30
DiskCurr	number	The disk storage of the host. Unit: GB.	1000
MemRatio	number	The memory size of the host. Unit: GB.	64
CpuRatio	number	The number of CPU cores of the host.	16

Examples

Success response

JSON format

{
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "HostInstanceConsoleInfos": [
    {
      "Status": "RUNNING",
      "MaxConnIncreaseRatioValue": 1300,
      "MemSize": 16,
      "DiskSize": 500,
      "Ip": "172.22.XX.XX",
      "Port": "3443",
      "EngineVersion": "5.8",
      "MemoryIncreaseRatioValue": 64,
      "CpuIncreaseRatioValue": 16,
      "DBInstanceId": "rm-bp1m5z8002gyj****",
      "Engine": "mysql",
      "LevelName": "mysql.z2.medium.2",
      "Role": "master",
      "DBInstanceDescription": "rm-bp1m5z8002gyj****",
      "CpuCores": 8,
      "PerfInfo": {
        "PerfIdbPio": 30,
        "DiskCurr": 1000,
        "MemRatio": 64,
        "CpuRatio": 16
      }
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
403	Permission.NotSupport	You are not authorized to perform this action.	You are not authorized to perform the action.
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	HostInfo.NotFound	The host is not found.	The host is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.