该接口用于查询RDS实例的数据库代理设置详情。
接口说明
调试
您可以在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**** |
返回参数
示例
正常返回示例
JSON
格式
{
"DBProxyInstanceLatestMinorVersion": "1.13.12",
"RequestId": "909A69EE-71C8-4417-A0B9-FF085407E1E3",
"DBProxyInstanceCurrentMinorVersion": "1.13.11",
"DBProxyInstanceNum": 1,
"DBProxyInstanceType": "2",
"DBProxyPersistentConnectionStatus": "Disabled",
"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或空字符串。 |
400 | InvalidInstanceLevelExtraInfo | Specified class code has error extra info. | 指定的类代码包含错误额外信息。 |
400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐实例不允许单独操作。 |
400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定价计划价格结果没有找到。 |
400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | 您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。 |
403 | IncorrectKindCode | Current custins kindCode does not support this operation. | 操作失败,当前实例所属环境类型不支持,请检查接口支持的实例类型。 |
403 | IncorrectDBInstanceType | The database instance type does not support the operation. | 操作失败,当前数据库类型不支持该操作。 |
403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | 操作失败,数据库引擎不支持。 |
404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-12-19 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2023-12-12 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2023-11-23 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2023-03-14 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2022-06-08 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||
|