ModifyDBProxy--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

ModifyDBProxy

最近更新时间：2025.01.22 12:04:50首次发布时间：2025.01.22 12:04:50

调用 ModifyDBProxy 接口开启或关闭数据库代理功能。

请求类型

异步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-cf4f3ddc****	实例 ID。
EnableDBProxy	Boolean	否	false	实例的代理功能的状态。取值范围： `true`：开启。 `false`：关闭。说明在开启或关闭数据库代理功能时，可能会遇到“操作不支持”或其他的报错，可通过调用 DescribeDBProxyConfig 接口查询具体原因。
ProxyNodeCustom	Object	否	请参见请求示例。	实例数据库代理服务的核数。说明在开启代理时，即 EnableDBProxy 取值为 `true` 时需传入该参数。该字段仅用于在开启数据库代理功能时指定代理节点的 CPU 核数，不能用于在开启数据库代理功能后变更代理节点的配置。如果变更代理节点的配置功能，请使用 ModifyDBProxySpec 接口。

返回参数

参数	类型	示例值	描述
OrderId	String	Order2002000002284548640	订单 ID。

示例

请求示例

POST /?Action=ModifyDBProxy&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-cf4f3ddc****",
    "EnableDBProxy": true,
    "ProxyNodeCustom": {
        "CpuNum": 4
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202410121445576B08EFFCA6DD57334FDC-efdcec",
        "Action": "ModifyDBProxy",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "OrderId": "Order2180000007639198690"
    }
}

错误码

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