调用ListInstances进行实例列表检索并获取实例详情

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListInstances

系统规定参数。取值：ListInstances。
DbType String 是 mysql

数据库类型
SearchKey String 是 test

搜索关键字
Tid Long 是 -1

DMS企业版租户ID
EnvType String 否 product

环境类型
InstanceSource String 否 RDS

实例来源
InstanceState String 否 NORMAL

实例状态，取值和解释如下：

  • NORMAL: 正常使用
  • DISABLE: 禁用
NetType String 否 vpc

实例网络环境，经典网络 or VPC，取值参考RegisterInstance
PageNumber Integer 否 1

第几页
PageSize Integer 否 50

每页多少条数据，取值不超过100

返回数据

名称 类型 示例值 描述
ErrorCode String UnknownError

错误码
ErrorMessage String UnknownError

错误信息
InstanceList

实例列表
Instance

实例列表
DataLinkName String dblink_test

datalink名称
DatabasePassword String ******

数据库用户密码
DatabaseUser String dbUser

数据库用户名
DbaId String 1

实例dba id
DbaNickName String dbaName

dba昵称
DdlOnline Integer 1

实例onlineddl配置
EcsInstanceId String xxx

实例ecs id
EcsRegion String cn-hangzhou

实例region
EnvType String product

环境
ExportTimeout Integer 600

导出超时时间
Host String xxx.xxx.xxx.xxx

实例连接地址
InstanceAlias String test

实例别名
InstanceId String 1

实例id
InstanceSource String RDS

实例来源
InstanceType String mysql

实例db类型
Port Integer 3306

实例端口
QueryTimeout Integer 60

查询超时时间
SafeRuleId String 1

实例安全规则id
Sid String test

实例sid
State String NORMAL

实例状态
UseDsql Integer 1

实例是否开启跨库查询
VpcId String xxx

实例vpc id
RequestId String B4B07137-F6AE-4756-8474-7F92BB6C4E04

API请求ID
Success Boolean true

请求是否成功
TotalCount Long 0

满足条件的实例总个数

示例

请求示例


http(s)://[Endpoint]/?Action=ListInstances
&<公共请求参数>

正常返回示例

XML 格式 

<TotalCount>7</TotalCount>
<RequestId>98D35416-2B92-4CE5-8FD2-B1E61E165536</RequestId>
<Success>true</Success>
<InstanceList>
</InstanceList>

JSON 格式 

{
	"TotalCount":7,
	"RequestId":"98D35416-2B92-4CE5-8FD2-B1E61E165536",
	"Success":true,
	"InstanceList":{
		"Instance":[]
	}
}

错误码

访问错误中心查看更多错误码。