接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeDBProxy | Read |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 |
实例ID。可调用DescribeDBInstances获取。 |
rm-bp1ja4f56s7us**** |
RegionId | string | 否 |
地域ID。可调用DescribeRegions获取。 |
cn-hangzhou |
DBProxyEngineType | string | 否 |
预留参数,无需配置。 |
normal |
ResourceGroupId | string | 否 |
资源组ID。 |
rg-acfmy**** |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object |
返回参数详情。 |
||
DBProxyInstanceLatestMinorVersion | string |
代理实例最新版本。 |
1.13.12 |
RequestId | string |
请求ID。 |
909A69EE-71C8-4417-A0B9-FF085407E1E3 |
DBProxyInstanceCurrentMinorVersion | string |
代理实例当前版本。 |
1.13.11 |
DBProxyInstanceNum | integer |
开通的代理实例数量。 |
1 |
DBProxyInstanceType | string |
代理服务类型。
说明 | 2 |
DBProxyPersistentConnectionSupport | string | 内部参数,无需关注。 |
test |
DBProxyInstanceStatus | string |
代理实例的运行状态。
|
Running |
DBProxyServiceStatus | string |
数据库代理功能开关状态。
|
Startup |
DBProxyInstanceName | string |
代理实例名称。 |
gos787jog2wk0ye1**** |
DBProxyInstanceSize | string |
该参数仅RDS PostgreSQL支持。表示代理实例规格实际大小。 格式: 例如:4/8表示4核CPU 8GB内存。 |
4/8 |
DBProxyEngineType | string |
内部参数,无需关注。 |
normal |
DBProxyConnectStringItems | object [] |
数据库代理的连接地址信息列表。 |
|
DBProxyConnectStringNetWorkType | string |
代理网络类型。
|
2 |
DBProxyConnectStringNetType | string |
代理连接地址的网络类型。
|
InnerString |
DBProxyVpcInstanceId | string |
代理的实例ID。 |
rm-bp145737x5****131161274792**** |
DBProxyEndpointName | string |
代理终端名称,真实服务的代理终端ID。 |
gos787jog2wk0ye1**** |
DBProxyEndpointId | string |
后端代理终端ID。 |
20**** |
DBProxyConnectStringPort | string |
代理连接地址的端口。 |
3306 |
DBProxyConnectString | string |
代理终端连接地址。 |
gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com |
DBProxyVpcId | string |
代理服务地址的VPC。 |
vpc-uf6oobt**** |
DBProxyVswitchId | string |
代理服务地址的vSwitch。 |
vsw-uf6l0pic17**** |
DbProxyEndpointItems | object [] |
代理终端信息列表。 |
|
DbProxyEndpointAliases | string |
代理终端的备注信息。 |
proxy-test |
DbProxyEndpointName | string |
代理终端ID。 |
gos787jog2wk0ye1**** |
DbProxyEndpointType | string |
代理终端类型。
|
RWSplit |
DbProxyReadWriteMode | string |
代理终端模式。
|
ReadWrite |
ResourceGroupId | string |
资源组ID。 |
rg-acfmy**** |
DBProxyAVZones | array |
代理服务所在的可用区列表。 |
|
string |
代理服务所在的可用区。 |
cn-shanghai-e |
示例
正常返回示例
JSON
格式
{
"DBProxyInstanceLatestMinorVersion": "1.13.12",
"RequestId": "909A69EE-71C8-4417-A0B9-FF085407E1E3",
"DBProxyInstanceCurrentMinorVersion": "1.13.11",
"DBProxyInstanceNum": 1,
"DBProxyInstanceType": "2",
"DBProxyPersistentConnectionSupport": "test",
"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-11-23 | OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||
|
||||||||||||||
2023-03-14 | OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||
|
||||||||||||||
2022-06-08 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/155883.html