You need to enable JavaScript to run this app.
导航
云数据库 MySQL 版
  • 文档首页
    • /
  • 云数据库 MySQL 版

DescribeDBProxyConfig

最近更新时间：2023.12.04 15:06:15

首次发布时间：2023.08.14 13:15:55

我的收藏

调用 DescribeDBProxyConfig 接口查询指定 MySQL 实例的数据库代理信息。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述
InstanceIdString是mysql-46609cf2****实例 ID。

返回参数

名称类型示例值描述
InstanceIdStringmysql-46609cf2****实例 ID。

ConnectionPoolType

String

Transaction

连接池类型，当开启了数据库代理后，才会返回该参数，取值范围：

  • Direct：直连模式。
  • Transaction：事务级连接池。

BinlogDump

Boolean

true

是否支持 binlog 能力，当开启了数据库代理后，才会返回该参数，取值：

  • true：是。
  • false：否。

GlobalReadOnly

Boolean

true

是否开启全局只读。

  • true：是。
  • false：否。

DBProxyStatus

String

Creating

代理实例的运行状态，当开启了数据库代理后，才返回该参数，取值：

  • Creating：代理开启中。
  • Running：代理运行中。
  • Shutdown：代理已关闭。
  • Deleting：代理关闭中。

CheckModifyDBProxyAllowed

CheckModifyDBProxyAllowedObject

{
"Allowed": false,
"Reason": "Other"
}

是否允许执行 ModifyDBProxy 接口：

  • Allowed：如果已关闭，返回是否可开启代理，如果已开启，返回是否可关闭代理。取值：true（是）；false（否）。
  • Reason：当 Allowed 为 false 时，返回具体原因。

FeatureStates

Array of FeatureStateObject

[
{
"Enable": true,
"FeatureName": "ProxyBinlogDump",
"Support": true
}
]

功能状态。关于 FeatureStates 的详细信息，请参见数据结构。

请求示例

POST /?Action=DescribeDBProxyConfig&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20230810T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20230810/cn-beijing/rds_mysql/request, SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645a****

{
    "InstanceId":"mysql-46609cf2****"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230809195305F4B9418A25C0D091AECF",
        "Action": "DescribeDBProxyConfig",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BinlogDump": false,
        "CheckModifyDBProxyAllowed": {
            "Allowed": false,
            "Reason": "Other"
        },
        "ConnectionPoolType": "Transaction",
        "DBProxyStatus": "Running",
        "FeatureStates": [
            {
                "Enable": false,
                "FeatureName": "ProxyBinlogDump",
                "Support": true
            }
        ],
        "GlobalReadOnly": false,
        "InstanceId": "mysql-46609cf2****"
    }
}

错误码

更多详情，请参见错误码。