QueryHostBaseInfoByInstance - ApsaraDB for MyBase - Alibaba Cloud Documentation Center

Queries the basic information about the host on which an instance is deployed.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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 parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22E12CV
HostInstanceConsoleInfos	object []	The queried host and instance information.
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 of the instance.	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

Sample success responses

JSONformat

{
  "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.

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