调用ListInstances接口获取实例信息列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListInstances |
系统规定参数。取值:ListInstances。 |
| Tid | Long | 否 | 3*** |
租户ID,可通过调用接口GetUserActiveTenant获取该参数的值。 |
| SearchKey | String | 否 | test |
搜索关键字。 |
| DbType | String | 否 | MySQL |
数据库类型,取值请参见DbType参数说明。 |
| EnvType | String | 否 | product |
环境类型,取值如下:
|
| InstanceSource | String | 否 | RDS |
实例来源,取值如下:
|
| NetType | String | 否 | VPC |
实例网络类型,取值如下:
|
| InstanceState | String | 否 | NORMAL |
实例状态,取值如下:
|
| PageNumber | Integer | 否 | 1 |
第几页。 |
| PageSize | Integer | 否 | 50 |
每页多少条数据,取值不超过100。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TotalCount | Long | 1 |
满足条件的实例总个数。 |
| RequestId | String | B4B07137-F6AE-4756-8474-7F92BB6C4E04 |
请求ID。 |
| ErrorCode | String | UnknownError |
错误码。 |
| ErrorMessage | String | UnknownError |
错误信息。 |
| InstanceList | Array of Instance |
实例列表。 |
|
| Instance | |||
| VpcId | String | vpc-o6wrloqsdqc9io3mg**** |
实例所属VPC的ID。 |
| DatabaseUser | String | dbUser |
数据库用户名。 |
| DbaId | String | 31**** |
实例DBA ID。 |
| UseDsql | Integer | 1 |
实例是否开启跨库查询:
|
| Port | Integer | 3306 |
实例连接端口。 |
| EcsInstanceId | String | 150**** |
实例ECS ID。 |
| EnvType | String | product |
实例环境类型,返回值如下:
|
| Sid | String | test |
实例Sid。 |
| OwnerIdList | Array of String | 123453 |
实例Owner UserId。 |
| SafeRuleId | String | 1 |
实例安全规则ID。 |
| OwnerNameList | Array of String | yuyang_test |
实例Owner昵称。 |
| DbaNickName | String | dbaName |
实例DBA昵称。 |
| QueryTimeout | Integer | 60 |
实例查询超时时间。 |
| InstanceSource | String | RDS |
实例来源。 |
| Host | String | ****.mysql.rds.aliyuncs.com |
实例连接地址。 |
| State | String | NORMAL |
实例状态。 |
| DataLinkName | String | dblink_test |
DataLink名称。 |
| ExportTimeout | Integer | 86400 |
导出超时时间。 |
| InstanceId | String | 150*** |
实例ID。 |
| InstanceType | String | mysql |
实例DB类型。 |
| DatabasePassword | String | ****** |
数据库用户密码。 |
| InstanceAlias | String | test |
实例别名。 |
| DdlOnline | Integer | 1 |
实例DdlOnline配置。 |
| EcsRegion | String | cn-hangzhou |
实例所属地域。 |
| StandardGroup | Object |
实例对应的管控模式信息。 |
|
| GroupName | String | test |
管控模式对应的安全规则名称。 |
| GroupMode | String | COMMON |
管控模式类型,取值如下:
|
| SellSitd | Boolean | true |
敏感数据保护是否开启,取值:
|
| Success | Boolean | true |
请求是否成功:
|
示例
请求示例
http(s)://dms-enterprise.aliyuncs.com/?Action=ListInstances
&Tid=3***
&SearchKey=test
&DbType=MySQL
&EnvType=product
&InstanceSource=RDS
&NetType=VPC
&InstanceState=NORMAL
&PageNumber=1
&PageSize=50
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListInstancesResponse>
<TotalCount>1</TotalCount>
<RequestId>B4B07137-F6AE-4756-8474-7F92BB6C4E04</RequestId>
<InstanceList>
<VpcId>vpc-o6wrloqsdqc9io3mg****</VpcId>
<DatabaseUser>dbUser</DatabaseUser>
<DbaId>31****</DbaId>
<UseDsql>1</UseDsql>
<Port>3306</Port>
<EcsInstanceId>150****</EcsInstanceId>
<EnvType>product</EnvType>
<Sid>test</Sid>
<OwnerIdList>123453</OwnerIdList>
<SafeRuleId>1</SafeRuleId>
<OwnerNameList>yuyang_test</OwnerNameList>
<DbaNickName>dbaName</DbaNickName>
<QueryTimeout>60</QueryTimeout>
<InstanceSource>RDS</InstanceSource>
<Host>****.mysql.rds.aliyuncs.com</Host>
<State>NORMAL</State>
<DataLinkName>dblink_test</DataLinkName>
<ExportTimeout>86400</ExportTimeout>
<InstanceId>150***</InstanceId>
<InstanceType>mysql</InstanceType>
<DatabasePassword>******</DatabasePassword>
<InstanceAlias>test</InstanceAlias>
<DdlOnline>1</DdlOnline>
<EcsRegion>cn-hangzhou</EcsRegion>
<StandardGroup>
<GroupName>test</GroupName>
<GroupMode>COMMON</GroupMode>
</StandardGroup>
<SellSitd>true</SellSitd>
</InstanceList>
<Success>true</Success>
</ListInstancesResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 1,
"RequestId" : "B4B07137-F6AE-4756-8474-7F92BB6C4E04",
"InstanceList" : [ {
"VpcId" : "vpc-o6wrloqsdqc9io3mg****",
"DatabaseUser" : "dbUser",
"DbaId" : "31****",
"UseDsql" : 1,
"Port" : 3306,
"EcsInstanceId" : "150****",
"EnvType" : "product",
"Sid" : "test",
"OwnerIdList" : [ "123453" ],
"SafeRuleId" : "1",
"OwnerNameList" : [ "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
}
错误码
访问错误中心查看更多错误码。