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

文档中心

立即注册

导航

ModifyDBEndpointAddress

最近更新时间：2024.11.05 16:00:06首次发布时间：2023.02.02 17:41:21

调用 ModifyDBEndpointAddress 接口修改连接地址的前缀或端口。

请求类型

异步请求。

注意事项

新连接地址在成功调用接口后生效。老连接地址会在新连接地址生效三分钟后失效，请同步修改应用程序的连接配置，否则可能会影响业务，请谨慎操作。
新端口生效后，老端口会即刻关闭，请同步修改应用程序的连接配置，否则可能会影响业务，请谨慎操作。
在一次调用中，不能同时修改连接地址前缀和端口。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-935479e57cbf***	实例 ID。
EndpointId	String	是	mysql-935479e5****-cluster	实例连接终端 ID。
NetworkType	String	是	Private	网络地址类型，取值为： `Private`：私网地址。 `Public`：公网地址。
DomainPrefix	String	否	mysql935479e57cbf***	连接地址前缀。连接地址的前缀需满足以下规则：以小写字母开头，以小写字母或数字结尾。由小写字母、数字和中划线（-）中的至少两种组成。连接地址前缀应至少包含 8 个字符，连接地址总长度（前缀+后缀）不得超过 63个字符。
Port	Integer	否	3306	端口。端口号取值范围为 1000~65534。说明如不设定，将自动使用默认终端的私网端口实时配置为其默认端口。

返回参数

null

示例

请求示例

POST /?Action=ModifyDBEndpointAddress&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-935479e57cbf***",
    "EndpointId": "mysql-935479e5****-cluster",
    "NetworkType": "Private",
    "Port": 3306
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230111161007B09FD872D02C2F8AE508",
        "Action": "ModifyDBEndpointAddress",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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