CreateDBEndpoint--表格数据库 HBase 版-火山引擎

文档中心

立即注册

导航

CreateDBEndpoint

最近更新时间：2024.06.25 10:03:51首次发布时间：2023.03.07 10:35:39

调用 CreateDBEndpoint 接口开启指定连接地址的公网访问。

请求类型

异步请求。

注意事项

申请公网地址时需要绑定弹性公网 IP（EIP），费用由 EIP 收取。更多详情，请参见 EIP 计费指引。您可以调用 AllocateEipAddress 接口申请公网 IP。
如需开启 Thrift2 公网连接地址，需先申请 Thrift2 私网连接地址。您可以调用 StartThrift2 接口申请指定实例的 Thrift2 私网连接地址。
不支持为 ZK 连接地址和 Thrift2 连接地址同时开启公网访问。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	hb-cn016dc3297a****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 HBase 实例的基本信息，包括实例 ID。
AddressType	String	是	Zk	需要开启公网访问的连接地址类型。取值范围如下： Zk：ZK 连接地址。 Thrift：Thrift2 连接地址。
EipList	String[]	是	["eip-30uwfh8l9a5ts7r2qr29o** ", "eip-3jhhte3gs0ruo3pncmfzm** "]	公网访问连接地址需要绑定的 EIP ID 列表。说明若需要为 ZK 连接地址开启公网访问，您需要同时传入 2 个 EIP ID。其中 ZK 节点需要绑定 1 个 EIP；实例中其他组件（如 RS 节点、Master 节点等）需要共享一个 EIP。若需要为 Thrift2 连接地址开启公网访问，您仅需传入 1 个 EIP ID。您可以调用 DescribeEipAddresses 接口查看当前账号下的所有公网 IP 信息，包括 EIP ID（即返回数据中的 `AllocationId` 参数值）。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

无。

示例

请求示例 1

创建 ZK 公网访问连接地址

POST https://hbase.volcengineapi.com?Action=CreateDBEndpoint&Version=2018-01-01 HTTP/1.1
Host: hbase.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/hbase/request,SignedHeaders=content-type;host;x-date,  Signature=****
{
    "InstanceId": "hb-cn016dc3297a****",
    "EipList": [
        "eip-30uwfh8l9a5ts7r2qr29o****",
        "eip-3jhhte3gs0ruo3pncmfzm****"
    ],
    "AddressType": "Zk"
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "20230109205853EB443C38324455CA****",
        "Action": "CreateDBEndpoint",
        "Version": "2018-01-01",
        "Service": "hbase",
        "Region": "cn-beijing"
    },
    "Result": null
}

请求示例 2

创建 Thrift2 公网访问连接地址

POST https://hbase.volcengineapi.com?Action=CreateDBEndpoint&Version=2018-01-01 HTTP/1.1
Host: hbase.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/hbase/request,SignedHeaders=content-type;host;x-date,  Signature=****
{
    "InstanceId": "hb-cn016dc3297a****",
    "EipList": [
        "eip-30uwfh8l9a5ts7r2qr29o****"
    ],
    "AddressType": "Thrift"
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "20230109205853EB443C38324455CA****",
        "Action": "CreateDBEndpoint",
        "Version": "2018-01-01",
        "Service": "hbase",
        "Region": "cn-beijing"
    },
    "Result": null
}