该接口用于查询RDS实例的数据库独享代理设置详情。
接口说明
已调用ModifyDBProxy接口开通数据库代理。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeDBProxy | READ |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | RDS实例ID。可调用DescribeDBInstances接口查询。 | rm-bp1ja4f56s7us**** |
| RegionId | string | 否 | 地域ID，可以通过接口DescribeRegions查看地域ID。 | cn-hangzhou |
| DBProxyEngineType | string | 否 | 内部参数，无需传入值。 | normal |
| ResourceGroupId | string | 否 | 资源组ID。 | rg-acfmy***** |
返回参数
示例
正常返回示例
JSON格式
{
"DBProxyInstanceLatestMinorVersion": "1.13.12",
"RequestId": "909A69EE-71C8-4417-A0B9-FF085407E1E3",
"DBProxyInstanceCurrentMinorVersion": "1.13.11",
"DBProxyInstanceNum": 1,
"DBProxyInstanceType": "2",
"DBProxyInstanceStatus": "Running",
"DBProxyServiceStatus": "Startup",
"DBProxyInstanceName": "gos787jog2wk0ye1****",
"DBProxyInstanceSize": "4/8",
"DBProxyEngineType": "normal",
"DBProxyConnectStringItems": {
"DBProxyConnectStringItems": [
{
"DBProxyConnectStringNetWorkType": "2",
"DBProxyConnectStringNetType": "InnerString",
"DBProxyVpcInstanceId": "rm-bp145737x5****131161274792****",
"DBProxyEndpointName": "gos787jog2wk0ye1****",
"DBProxyEndpointId": "20****",
"DBProxyConnectStringPort": "3306",
"DBProxyConnectString": "gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com",
"DBProxyVpcId": "vpc-uf6oobt****",
"DBProxyVswitchId": "vsw-uf6l0pic17****"
}
]
},
"DbProxyEndpointItems": {
"DbProxyEndpointItems": [
{
"DbProxyEndpointAliases": "proxy-test",
"DbProxyEndpointName": "gos787jog2wk0ye1****",
"DbProxyEndpointType": "RWSplit",
"DbProxyReadWriteMode": "ReadWrite"
}
]
},
"ResourceGroupId": "rg-acfmy*****",
"DBProxyAVZones": {
"DBProxyAVZones": [
"cn-shanghai-e"
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | RWSplitNetTypeNotExists | Specified rw split net type is not eixsts. | - |
| 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. | 操作失败，当前数据库类型不支持该操作。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-03-14 | OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更 | |||||||||||||
| ||||||||||||||
| 2022-06-08 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更，OpenAPI 返回结构发生变更 | |||||||||||||
|