调用ListInstances接口,获取实例信息列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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
}
]
},
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史