调用ListInstances接口，获取实例信息列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dms:ListInstances | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Tid | long | 否 | 租户 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 |
返回参数
示例
正常返回示例
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": ""
}
]
},
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史