调用GetInstance获取实例详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetInstance |
系统规定参数。取值:GetInstance。 |
Host | String | 是 | xxxx.mysql.rds.aliyuncs.com |
实例连接地址。 |
Port | Integer | 是 | 3306 |
实例连接端口。 |
Tid | Long | 是 | -1 |
租户ID。 说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息。
|
Sid | String | 否 | test |
实例Sid。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrorCode | String | UnknownError |
错误码。 |
ErrorMessage | String | UnknownError |
错误信息。 |
Instance | Struct |
实例详细信息。 |
|
DataLinkName | String | test |
实例datalink名称 |
DatabasePassword | String | ****** |
实例登录账号密码 |
DatabaseUser | String | dbuser |
实例登录用户名 |
DbaId | String | 1 |
实例DBA ID,与ListUsers中的ID对应。 |
DbaNickName | String | dbaname |
实例DBA昵称。 |
DdlOnline | Integer | 1 |
实例onlineddl配置 |
EcsInstanceId | String | xxx |
实例EcsInstanceId |
EcsRegion | String | cn-hangzhou |
实例所属Region |
EnvType | String | test |
实例所属环境 |
ExportTimeout | Integer | 600 |
实例导出超时时间 |
Host | String | xxx.rwlb.rds.aliyuncs.com |
实例连接地址 |
InstanceAlias | String | test |
实例别名 |
InstanceId | String | 1 |
实例ID。 |
InstanceSource | String | RDS |
实例来源 |
InstanceType | String | polardb |
实例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 | 8BE73E78-76E2-46AA-970D-A4579A16CD4A |
API请求ID。 |
Success | Boolean | true |
接口调用是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetInstance
&Host=xxxx.mysql.rds.aliyuncs.com
&Port=3306
&Tid=-1
&<公共请求参数>
正常返回示例
XML
格式
<Instance>
<SafeRuleId>1037</SafeRuleId>
<UseDsql>1</UseDsql>
<EcsInstanceId>pc-xxx</EcsInstanceId>
<QueryTimeout>80</QueryTimeout>
<Host>xxx.rwlb.rds.aliyuncs.com</Host>
<InstanceAlias>test</InstanceAlias>
<InstanceSource>RDS</InstanceSource>
<InstanceId>24710</InstanceId>
<DataLinkName>dblink_test</DataLinkName>
<EnvType>dev</EnvType>
<DdlOnline>0</DdlOnline>
<VpcId>vpc-xxx</VpcId>
<InstanceType>polardb</InstanceType>
<DbaId>104442</DbaId>
<Port>3306</Port>
<DbaNickName>test[子账号]</DbaNickName>
<State>NORMAL</State>
<DatabaseUser>dmstest</DatabaseUser>
<DatabasePassword>******</DatabasePassword>
<EcsRegion>cn-hangzhou</EcsRegion>
<ExportTimeout>300</ExportTimeout>
</Instance>
<RequestId>8BE73E78-76E2-46AA-970D-A4579A16CD4A</RequestId>
<Success>true</Success>
JSON
格式
{
"Instance": {
"SafeRuleId": 1037,
"UseDsql": "1",
"EcsInstanceId": "pc-xxx",
"QueryTimeout": 80,
"Host": "xxx.rwlb.rds.aliyuncs.com",
"InstanceAlias": "test",
"InstanceSource": "RDS",
"InstanceId": 24710,
"DataLinkName": "dblink_test",
"EnvType": "dev",
"DdlOnline": 0,
"VpcId": "vpc-xxx",
"InstanceType": "polardb",
"DbaId": 104442,
"Port": 3306,
"DbaNickName": "test[子账号]",
"State": "NORMAL",
"DatabaseUser": "dmstest",
"DatabasePassword": "******",
"EcsRegion": "cn-hangzhou",
"ExportTimeout": 300
},
"RequestId": "8BE73E78-76E2-46AA-970D-A4579A16CD4A",
"Success": true
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交