Query basic host information for an instance using QueryHostBaseInfoByInstance - ApsaraDB for MyBase - Alibaba Cloud - ApsaraDB for MyBase

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 of the instance. For more information, see Region IDs.	cn-hangzhou
DBInstanceId	string	Yes	The instance ID.	rm-bp15rszyxs4t3****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22E12CV
HostInstanceConsoleInfos	array<object>	The host and instance information.
	object
VpcId	string	The virtual private cloud (VPC) ID of the host on which the instance is deployed.	vpc-bp1ov7as4yvz4kxei****
Status	string	The state of the instance.	RUNNING
ExpiredTime	string	The expiration time of the instance.	2021.07.20
ClusterName	string	The instance type.	rds.ebmr6.26xlarge
Ip	string	The IP address of the host on which the instance is deployed.	172.22.0.***
HostName	string	The name of the host on which the instance is deployed.	ch-bp1fgj3kt7fsb****
Engine	string	The database engine of the instance.	mysql
Role	string	The role of the instance.	master
Port	string	The port number of the host on which the instance is deployed.	3443
EngineVersion	string	The version of the database engine.	5.7

Examples

Success response

JSON format

{
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E12CV",
  "HostInstanceConsoleInfos": [
    {
      "VpcId": "vpc-bp1ov7as4yvz4kxei****",
      "Status": "RUNNING",
      "ExpiredTime": "2021.07.20",
      "ClusterName": "rds.ebmr6.26xlarge",
      "Ip": " 172.22.0.***",
      "HostName": "ch-bp1fgj3kt7fsb****",
      "Engine": "mysql",
      "Role": "master",
      "Port": "3443",
      "EngineVersion": "5.7"
    }
  ]
}

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.
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.	The specified instance does not exist or is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.