DescribeDBProxy
调用DescribeDBProxy接口查询RDS实例的数据库独享代理详情。
RDS提供数据库独享代理服务,包括读写分离、短连接优化等能力。详情请参见数据库独享代理。
调用该接口时,实例必须为MySQL 8.0高可用版(本地SSD盘)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBProxy |
系统规定参数,取值:DescribeDBProxy。 |
DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxx |
实例ID。 |
RegionId | String | 否 | cn-hangzhou |
地域ID,可以通过接口DescribeRegions查看地域ID。 |
AccessKeyId | String | 否 | LTAIfCxxxxxxx |
阿里云颁发给用户的访问服务所用的密钥ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBProxyConnectStringItems |
独享代理的连接地址信息列表。 |
||
DBProxyConnectStringItems |
独享代理的连接地址信息列表。 |
||
DBProxyConnectString | String | ta9umxxxxx.rwlb.singapore.rds.aliyuncs.com |
代理连接地址,也是读写分离的地址。 |
DBProxyConnectStringNetType | String | InnerString |
代理连接地址的网络类型。当前仅支持内网地址,取值:InnerString。 |
DBProxyConnectStringPort | String | 3306 |
代理连接地址的端口。 |
DBProxyEndpointId | String | 330 |
代理连接地址ID。 |
DBProxyVpcInstanceId | String | rm-t4n4xxxxxxx |
代理的实例ID。 |
DBProxyInstanceNum | Integer | 2 |
开通的代理实例数量。 |
DBProxyInstanceStatus | String | Running |
代理地址的运行状态。 |
DBProxyInstanceType | String | DedicatedProxy |
代理服务类型。当前仅支持独享代理服务,取值:DedicatedProxy。 |
DBProxyServiceStatus | String | Startup |
数据库独享代理功能开关状态。 |
RequestId | String | C6F00DF0-23F4-466F-BE43-DC9283A8D512 |
请求ID。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeDBProxy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
<DescribeDBProxyResponse>
<DBProxyInstanceStatus>Running</DBProxyInstanceStatus>
<RequestId>C6F00DF0-23F4-466F-BE43-DC9283A8D512</RequestId>
<DBProxyConnectStringItems>
<DBProxyConnectStringItems>
<DBProxyEndpointId>330</DBProxyEndpointId>
<DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
<DBProxyConnectString>ta9umxxxxx.rwlb.singapore.rds.aliyuncs.com</DBProxyConnectString>
<DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
<DBProxyVpcInstanceId>rm-t4n4xxxxxx</DBProxyVpcInstanceId>
</DBProxyConnectStringItems>
</DBProxyConnectStringItems>
<DBProxyInstanceNum>2</DBProxyInstanceNum>
<DBProxyInstanceType>2</DBProxyInstanceType>
<DBProxyServiceStatus>Startup</DBProxyServiceStatus>
</DescribeDBProxyResponse>
JSON
格式
{
"DBProxyInstanceStatus":"Running",
"RequestId":"C6F00DF0-23F4-466F-BE43-DC9283A8D512",
"DBProxyConnectStringItems":{
"DBProxyConnectStringItems":[
{
"DBProxyEndpointId":330,
"DBProxyConnectString":"ta9umxxxxx.rwlb.singapore.rds.aliyuncs.com",
"DBProxyConnectStringNetType":"InnerString",
"DBProxyVpcInstanceId":"rm-t4n4xxxxxx",
"DBProxyConnectStringPort":"3306"
}
]
},
"DBProxyInstanceNum":2,
"DBProxyInstanceType":"2",
"DBProxyServiceStatus":"Startup"
}
错误码
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论