调用ListInstances接口，获取实例信息列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dms:ListInstances |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Tid |
integer |
否 |
租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。 |
3*** |
| SearchKey |
string |
否 |
搜索关键字。 |
test |
| DbType |
string |
否 |
数据库类型，取值请参见 DbType 参数说明。 |
MySQL |
| EnvType |
string |
否 |
环境类型，取值如下：
|
product |
| InstanceSource |
string |
否 |
实例来源，取值如下：
|
RDS |
| NetType |
string |
否 |
实例网络类型，取值如下：
|
VPC |
| InstanceState |
string |
否 |
实例状态，取值如下：
|
NORMAL |
| PageNumber |
integer |
否 |
第几页。 |
1 |
| PageSize |
integer |
否 |
每页多少条数据，取值不超过 100。 |
50 |
| Region |
string |
否 |
实例所在的 regionId |
cn-hangzhou |
| RealLoginUserUid |
string |
否 |
实际调用 API 的用户的阿里云账号 UID |
21400447956867**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
描述。 |
||
| TotalCount |
integer |
满足条件的实例总个数。 |
1 |
| RequestId |
string |
请求 ID。 |
B4B07137-F6AE-4756-8474-7F92BB6C4E04 |
| ErrorCode |
string |
错误码。 |
UnknownError |
| ErrorMessage |
string |
错误信息。 |
UnknownError |
| InstanceList |
object |
||
| Instance |
array<object> |
实例列表。 |
|
|
array<object> |
实例信息。 |
||
| VpcId |
string |
实例所属 VPC 的 ID。 |
vpc-o6wrloqsdqc9io3mg**** |
| DatabaseUser |
string |
数据库用户名。 |
dbUser |
| DbaId |
string |
实例 DBA ID。 |
31**** |
| UseDsql |
integer |
实例是否开启跨库查询：
|
1 |
| Port |
integer |
实例连接端口。 |
3306 |
| EcsInstanceId |
string |
实例 ECS ID。 |
150**** |
| EnvType |
string |
实例环境类型，返回值如下：
|
product |
| Sid |
string |
实例 Sid。 |
test |
| OwnerIdList |
object |
||
| OwnerIds |
array |
实例 Owner UserId 列表。 |
|
|
string |
实例 Owner UserId。 |
12**** |
|
| SafeRuleId |
string |
实例安全规则 ID。 |
1 |
| OwnerNameList |
object |
||
| OwnerNames |
array |
实例 Owner 昵称列表。 |
|
|
string |
实例 Owner 昵称。 |
yuyang_test |
|
| DbaNickName |
string |
实例 DBA 昵称。 |
dbaName |
| QueryTimeout |
integer |
实例查询超时时间。 |
60 |
| InstanceSource |
string |
实例来源。 |
RDS |
| Host |
string |
实例连接地址。 |
****.mysql.rds.aliyuncs.com |
| State |
string |
实例状态。 |
NORMAL |
| DataLinkName |
string |
DataLink 名称。 |
dblink_test |
| ExportTimeout |
integer |
导出超时时间。 |
86400 |
| InstanceId |
string |
实例 ID。 |
150*** |
| InstanceType |
string |
实例 DB 类型。 |
mysql |
| DatabasePassword |
string |
数据库用户密码。 |
****** |
| InstanceAlias |
string |
实例别名。 |
test |
| DdlOnline |
integer |
实例 DdlOnline 配置。 |
1 |
| EcsRegion |
string |
实例所属地域。 |
cn-hangzhou |
| StandardGroup |
object |
实例对应的管控模式信息。 |
|
| GroupName |
string |
管控模式对应的安全规则名称。 |
test |
| GroupMode |
string |
管控模式类型，取值如下：
|
COMMON |
| SellSitd |
boolean |
敏感数据保护是否开启，取值：
|
true |
| SellTrust |
string |
是否开启安全托管。取值：
|
true |
| Success |
boolean |
请求是否成功：
|
true |
示例
正常返回示例
JSON格式
{
"TotalCount": 1,
"RequestId": "B4B07137-F6AE-4756-8474-7F92BB6C4E04",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"InstanceList": {
"Instance": [
{
"VpcId": "vpc-o6wrloqsdqc9io3mg****",
"DatabaseUser": "dbUser",
"DbaId": "31****",
"UseDsql": 1,
"Port": 3306,
"EcsInstanceId": "150****",
"EnvType": "product",
"Sid": "test",
"OwnerIdList": {
"OwnerIds": [
"12****"
]
},
"SafeRuleId": "1",
"OwnerNameList": {
"OwnerNames": [
"yuyang_test"
]
},
"DbaNickName": "dbaName",
"QueryTimeout": 60,
"InstanceSource": "RDS",
"Host": "****.mysql.rds.aliyuncs.com",
"State": "NORMAL",
"DataLinkName": "dblink_test",
"ExportTimeout": 86400,
"InstanceId": "150***",
"InstanceType": "mysql",
"DatabasePassword": "******",
"InstanceAlias": "test",
"DdlOnline": 1,
"EcsRegion": "cn-hangzhou",
"StandardGroup": {
"GroupName": "test",
"GroupMode": "COMMON"
},
"SellSitd": true,
"SellTrust": "true"
}
]
},
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。