该接口用于查询RDS实例独享代理的连接地址信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeDBProxyEndpoint | READ |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | rm-bp1ja4f56s7us**** |
| DBProxyEndpointId | string | 否 | 代理终端名称。可调用DescribeDBProxy接口查询。 | keaxncrjluwu0gue**** |
| DBProxyConnectString | string | 否 | 代理连接地址。可调用DescribeDBProxy接口查询。 | testproxy****.rwlb.rds.aliyuncs.com |
| RegionId | string | 是 | 地域ID。可调用DescribeRegions获取。 | cn-hangzhou |
| DBProxyEngineType | string | 否 | 预留参数，无需配置。 | normal |
返回参数
示例
正常返回示例
JSON格式
{
"DBProxyConnectStringNetType": "InnerString",
"DBProxyFeatures": "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1",
"RequestId": "847BA085-B377-4BFA-8267-F82345ECE1D2",
"ReadOnlyInstanceWeight": "[{\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\"，\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-t2****\\\",\\\"NodeType\\\":\\\"Primary\\\",\\\"Weight\\\":0}, {\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\"，\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-z9****\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",,\\\"DBInstanceId\\\":\\\"rm-2z****\\\"，\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-1c****\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}]]",
"ReadOnlyInstanceDistributionType": "Standard",
"ReadOnlyInstanceMaxDelayTime": "30",
"DbProxyEndpointReadWriteMode": "ReadWrite",
"DbProxyEndpointAliases": "proxyterminal-test",
"DBProxyEndpointId": "keaxncrjluwu0gue****",
"DBProxyConnectStringPort": "3306",
"DBProxyConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
"DBProxyEngineType": "normal",
"EndpointConnectItems": {
"EndpointConnectItems": [
{
"DbProxyEndpointPort": "3306",
"DbProxyEndpointConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
"DbProxyEndpointNetType": "2"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MaxscaleNotSupport | Current custins can not support Maxscale. | - |
| 400 | InvalidEndPoint.Format | The specified EndPoint is not valid. | 独享代理连接地址ID（DBProxyEndpointId）未传，查询不存在， 请检查Endpoint参数。 |
| 400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | 指定的实例名称（DBInstanceName）无效，请检查参数值是否为null或空字符串。 |
| 400 | Endpoint.NotFound | The specified EndPoint is not valid. | 指定的代理终端不存在 |
| 400 | InvalidParameter | Specified parameter is invalid. | - |
| 403 | IncorrectKindCode | The current KindCode of the custins does not support the operation. | 操作失败，当前实例所属环境类型不支持，请检查接口支持的实例类型。 |
| 403 | IncorrectDBInstanceType | The current database instance type does not support the operation. | 当前数据库实例类型不支持此操作。 |
| 404 | Endpoint.NotFound | Specified endpoint is not found. | 未找到指定独享代理连接地址的端口。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2022-09-01 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||
| ||||||||||||||||
| 2022-06-08 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更，OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||||
|
