CreateDBEndpointPublicAddress--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

CreateDBEndpointPublicAddress

最近更新时间：2024.11.08 10:14:36首次发布时间：2022.08.20 16:54:39

调用 CreateDBEndpointPublicAddress 接口为指定实例创建公网连接地址，即开启实例的公网访问功能。

请求类型

异步请求。

调试

API Explorer

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

去调试

前提条件

已调用 AllocateEipAddress 接口，申请公网 IP。

费用说明

公网地址将绑定您的弹性公网 IP（EIP），费用由 EIP 收取。更多详情，请参见 EIP 计费指引。

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	vedbm-ca12cbqv****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 veDB MySQL 实例的基本信息，包括实例 ID。
EndpointId	String	是	vedbm-h5u625wj****-Primary	实例连接终端 ID。说明您可以调用 DescribeDBInstanceDetail 接口查询 veDB MySQL 实例的详细信息，包括实例连接终端 ID。
EipId	String	是	eip-2fef2qcfbfw8w5oxruw3w****	实例需要绑定的 EIP ID。说明您可以调用 DescribeEipAddresses 接口查询已创建的 EIP 的详细信息，包括 EIP ID。

返回参数

null

请求示例

POST /action/?Action=CreateDBEndpointPublicAddress&Version=2022-01-01 HTTP/1.1
Host: vedbm.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20201103/cn-beijing/Redis/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****

{
    "InstanceId":"vedbm-h5u625wj****",
    "EndpointId":"vedbm-h5u625wj****-Primary",
    "EipId":"eip-3rfb9a0cyyg3k5zsk2ili****"
}

返回示例

正常返回示例

{
     "ResponseMetadata": {
          "RequestId": "2022042511062201022509900802EB****",
          "Action": "CreateDBEndpointPublicAddress",
          "Version": "2022-01-01",
          "Service": "vedbm",
          "Region": "cn-beijing",
     },
     "Result": null
}

错误码

更多信息，请参见错误码。