调用DescribeDBProxy接口查询RDS实例的数据库独享代理设置详情。
RDS提供数据库独享代理服务,包括读写分离、短连接优化等能力。详情请参见数据库独享代理。
调用该接口时,需要实例为如下版本:
- MySQL 8.0三节点企业版(内核小版本20191204或以上)
- MySQL 8.0高可用版(内核小版本20190915或以上)
- MySQL 5.7三节点企业版(内核小版本20191128或以上)
- MySQL 5.7高可用版(内核小版本20190925或以上)
- MySQL 5.6高可用版(内核小版本20200229或以上)
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBProxy |
系统规定参数,取值:DescribeDBProxy。 |
DBInstanceId | String | 是 | rm-bp1ja4f56s7us**** |
实例ID。 |
RegionId | String | 否 | cn-hangzhou |
地域ID,可以通过接口DescribeRegions查看地域ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBProxyConnectStringItems | Array of DBProxyConnectStringItems |
独享代理的连接地址信息列表。 |
|
DBProxyConnectStringItems | |||
DBProxyConnectString | String | gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com |
代理终端连接地址。 |
DBProxyConnectStringNetType | String | InnerString |
代理连接地址的网络类型。取值:
|
DBProxyConnectStringNetWorkType | String | 1 |
代理网络类型,取值:
|
DBProxyConnectStringPort | String | 3306 |
代理连接地址的端口。 |
DBProxyEndpointId | String | 20**** |
后端代理终端ID。 |
DBProxyEndpointName | String | gos787jog2wk0ye1**** |
代理终端名称,真实服务的代理终端ID。 |
DBProxyVpcInstanceId | String | rm-bp145737x5****131161274792**** |
代理的实例ID。 |
DBProxyInstanceCurrentMinorVersion | String | 1.13.11 |
代理实例当前版本。 |
DBProxyInstanceLatestMinorVersion | String | 1.13.12 |
代理实例最新版本。 |
DBProxyInstanceName | String | gos787jog2wk0ye1**** |
代理实例名称。 |
DBProxyInstanceNum | Integer | 1 |
开通的代理实例数量。 |
DBProxyInstanceStatus | String | Running |
代理地址的运行状态,取值:
|
DBProxyInstanceType | String | 2 |
代理服务类型。取值:
|
DBProxyServiceStatus | String | Startup |
数据库独享代理功能开关状态,取值:
|
DbProxyEndpointItems | Array of DbProxyEndpointItems |
代理终端信息列表。 |
|
DbProxyEndpointItems | |||
DbProxyEndpointAliases | String | proxy-test |
代理终端的备注信息。 |
DbProxyEndpointName | String | gos787jog2wk0ye1**** |
代理终端ID。 |
DbProxyEndpointType | String | RWSplit |
代理终端类型,取值:
|
DbProxyReadWriteMode | String | ReadWrite |
代理终端模式,取值:
|
RequestId | String | 909A69EE-71C8-4417-A0B9-FF085407E1E3 |
请求ID。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeDBProxy
&DBInstanceId=rm-bp1ja4f56s7us****
&<公共请求参数>
正常返回示例
XML
格式
<DescribeDBProxyResponse>
<DBProxyInstanceName>gos787jog2wk0ye1****</DBProxyInstanceName>
<DBProxyInstanceCurrentMinorVersion>1.13.11</DBProxyInstanceCurrentMinorVersion>
<DBProxyServiceStatus>Startup</DBProxyServiceStatus>
<DBProxyInstanceNum>1</DBProxyInstanceNum>
<DBProxyInstanceLatestMinorVersion>1.13.12</DBProxyInstanceLatestMinorVersion>
<RequestId>909A69EE-71C8-4417-A0B9-FF085407E1E3</RequestId>
<DbProxyEndpointItems>
<DbProxyEndpointItems>
<DbProxyEndpointName>gos787jog2wk0ye1****</DbProxyEndpointName>
<DbProxyEndpointAliases>proxy-test</DbProxyEndpointAliases>
<DbProxyEndpointType>RWSplit</DbProxyEndpointType>
<DbProxyReadWriteMode>ReadWrite</DbProxyReadWriteMode>
</DbProxyEndpointItems>
</DbProxyEndpointItems>
<DBProxyConnectStringItems>
<DBProxyConnectStringItems>
<DBProxyConnectString>gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com</DBProxyConnectString>
<DBProxyEndpointId>209090</DBProxyEndpointId>
<DBProxyEndpointName>gos787jog2wk0ye1****</DBProxyEndpointName>
<DBProxyConnectStringNetWorkType>2</DBProxyConnectStringNetWorkType>
<DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
<DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
<DBProxyVpcInstanceId>rm-bp145737x5****131161274792****</DBProxyVpcInstanceId>
</DBProxyConnectStringItems>
</DBProxyConnectStringItems>
<DBProxyInstanceStatus>Running</DBProxyInstanceStatus>
<DBProxyInstanceType>2</DBProxyInstanceType>
</DescribeDBProxyResponse>
JSON
格式
{
"DBProxyInstanceName": "gos787jog2wk0ye1****",
"DBProxyInstanceCurrentMinorVersion": "1.13.11",
"DBProxyServiceStatus": "Startup",
"DBProxyInstanceNum": 1,
"DBProxyInstanceLatestMinorVersion": "1.13.12",
"RequestId": "909A69EE-71C8-4417-A0B9-FF085407E1E3",
"DbProxyEndpointItems": {
"DbProxyEndpointItems": [
{
"DbProxyEndpointName": "gos787jog2wk0ye1****",
"DbProxyEndpointAliases": "proxy-test",
"DbProxyEndpointType": "RWSplit",
"DbProxyReadWriteMode": "ReadWrite"
}
]
},
"DBProxyConnectStringItems": {
"DBProxyConnectStringItems": [
{
"DBProxyConnectString": "gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com",
"DBProxyEndpointId": 209090,
"DBProxyEndpointName": "gos787jog2wk0ye1****",
"DBProxyConnectStringNetWorkType": 2,
"DBProxyConnectStringNetType": "InnerString",
"DBProxyConnectStringPort": "3306",
"DBProxyVpcInstanceId": "rm-bp145737x5****131161274792****"
}
]
},
"DBProxyInstanceStatus": "Running",
"DBProxyInstanceType": "2"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | IncorrectDBInstanceType | The database instance type does not support the operation. | 当前数据库类型不支持该操作 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交