调用ListInstances进行实例列表检索并获取实例详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListInstances |
系统规定参数。取值:ListInstances。 |
Tid | Long | 否 | -1 |
租户ID。 说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息。
|
SearchKey | String | 否 | test |
搜索关键字。 |
DbType | String | 否 | MySQL |
数据库类型。 |
EnvType | String | 否 | product |
环境类型。 |
InstanceSource | String | 否 | RDS |
实例来源。 |
NetType | String | 否 | VPC |
实例网络环境,经典网络或VPC,取值参考RegisterInstance接口。 |
InstanceState | String | 否 | NORMAL |
实例状态,取值和解释如下:
|
PageNumber | Integer | 否 | 1 |
第几页。 |
PageSize | Integer | 否 | 50 |
每页多少条数据,取值不超过100。 |
RegionId | String | 否 | cn-hangzhou |
Region化API请求参数。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrorCode | String | UnknownError |
错误码。 |
ErrorMessage | String | UnknownError |
错误信息。 |
InstanceList | Array of Instance |
实例列表。 |
|
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": [
]
}
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交