调用DescribeDBProxy接口查询RDS实例的数据库代理设置详情。
已调用ModifyDBProxy接口开通数据库代理。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBProxy |
系统规定参数。取值:DescribeDBProxy。 |
DBInstanceId | String | 是 | rm-bp1ja4f56s7us**** |
RDS实例ID。可调用DescribeDBInstances接口查询。 |
RegionId | String | 否 | cn-hangzhou |
地域ID,可以通过接口DescribeRegions查看地域ID。 |
DBProxyEngineType | String | 否 | normal |
内部参数,无需传入值。 |
ResourceGroupId | String | 否 | rg-acfmy***** |
资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBProxyInstanceLatestMinorVersion | String | 1.13.12 |
代理实例最新版本。 |
RequestId | String | 909A69EE-71C8-4417-A0B9-FF085407E1E3 |
请求ID。 |
DBProxyInstanceCurrentMinorVersion | String | 1.13.11 |
代理实例当前版本。 |
DBProxyInstanceNum | Integer | 1 |
开通的代理实例数量。 |
DBProxyInstanceType | String | 2 |
代理服务类型。取值:
说明 RDS PostgreSQL只支持独享代理。
|
DBProxyInstanceStatus | String | Running |
代理实例的运行状态,取值:
|
DBProxyServiceStatus | String | Startup |
数据库代理功能开关状态,取值:
|
DBProxyInstanceName | String | gos787jog2wk0ye1**** |
代理实例名称。 |
DBProxyInstanceSize | String | 4/8 |
该参数仅RDS PostgreSQL支持。表示代理实例规格实际大小。 格式:CPU/内存,例如4/8表示4核CPU 8GB内存。 |
DBProxyEngineType | String | normal |
内部参数,无需关注。 |
DBProxyConnectStringItems | Array of DBProxyConnectStringItems |
数据库代理的连接地址信息列表。 |
|
DBProxyConnectStringItems | |||
DBProxyConnectStringNetWorkType | String | 2 |
代理网络类型,取值:
|
DBProxyConnectStringNetType | String | InnerString |
代理连接地址的网络类型。取值:
|
DBProxyVpcInstanceId | String | rm-bp145737x5****131161274792**** |
代理的实例ID。 |
DBProxyEndpointName | String | gos787jog2wk0ye1**** |
代理终端名称,真实服务的代理终端ID。 |
DBProxyEndpointId | String | 20**** |
后端代理终端ID。 |
DBProxyConnectStringPort | String | 3306 |
代理连接地址的端口。 |
DBProxyConnectString | String | gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com |
代理终端连接地址。 |
DbProxyEndpointItems | Array of DbProxyEndpointItems |
代理终端信息列表。 |
|
DbProxyEndpointItems | |||
DbProxyEndpointAliases | String | proxy-test |
代理终端的备注信息。 |
DbProxyEndpointName | String | gos787jog2wk0ye1**** |
代理终端ID。 |
DbProxyEndpointType | String | RWSplit |
代理终端类型,取值:
|
DbProxyReadWriteMode | String | ReadWrite |
代理终端模式,取值:
|
ResourceGroupId | String | rg-acfmy***** |
资源组ID。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeDBProxy
&DBInstanceId=rm-bp1ja4f56s7us****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/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
格式
HTTP/1.1 200 OK
Content-Type:application/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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | 指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。 |
403 | IncorrectKindCode | Current custins kindCode does not support this operation. | 操作失败,当前实例所属环境类型不支持,请检查接口支持的实例类型。 |
403 | IncorrectDBInstanceType | The database instance type does not support the operation. | 操作失败,当前数据库类型不支持该操作。 |
访问错误中心查看更多错误码。