You need to enable JavaScript to run this app.
导航
云数据库 veDB MySQL 版
  • 文档首页
    • /云数据库 veDB MySQL 版/API 参考/v1（2022-01-01）/实例管理/CreateDBInstance
CreateDBInstance
最近更新时间：2024.11.08 10:24:15首次发布时间：2022.04.12 19:05:15
我的收藏

调用 CreateDBInstance 接口创建 veDB MySQL 实例。

请求类型

异步请求。

调试

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

注意事项

自 2022 年 05 月 17 日起，新开通 veDB MySQL 产品的客户和存量实例都需要进行跨服务访问授权。跨服务访问授权方法如下：

注意

您需尽快完成授权，否则在调用 CreateDBInstance 接口时将会报错。

请求参数

名称类型是否必选示例值描述

InstanceName

String

否

test

实例名称。命名规则：

  • 不能以数字、中划线（-）开头。
  • 只能包含中文、字母、数字、下划线（_）和中划线（-）。
  • 长度需在 1~128 个字符内。

说明

  • 如果未填写实例名称，则会使用实例 ID 作为实例名称。
  • 批量创建实例时，如果传入了实例名称，则会自动在实例名称后加序号。
DBEngineVersionString是MySQL_8_0数据库引擎版本，取值固定为 MySQL_8_0。

DBMinorVersion

String

否

3.0

veDB MySQL 小版本，关于版本号的详细说明请参见版本号管理。

  • 3.0（默认）：veDB MySQL 稳定版，100% 兼容 MySQL 8.0。
  • 3.1：原生支持 HTAP 应用场景，加速复杂查询。
  • 3.2：原生支持 HTAP 应用场景，加速复杂查询。此外，内置冷数据归档能力，可将低频访问的数据归档至对象存储 TOS 中，降低存储成本，详情请参见冷热分离介绍。

说明

  • 实例创建成功后，您需要立即为该实例创建分析节点，才能正常使用 HTAP 功能，详情请参见 ModifyDBInstanceSpec。
  • HTAP 和冷热分离目前为白名单功能，如需使用，请提交工单联系技术支持。

NodeSpec

String

是

vedb.mysql.x4.xlarge

实例的节点规格代码。

说明

关于实例节点规格的详细信息，请参见产品规格。

ZoneIds

String

是

cn-beijing-b

可用区 ID。

说明

可调用 DescribeAvailabilityZones 接口查询 veDB MySQL 实例支持的可用区资源。

NodeNumberInteger是2实例节点数量。取值范围为 2~16 个。

VpcId

String

是

vpc-3ajzohyfaru9s340jz1rp****

私有网络（VPC） ID。

说明

您可以调用 DescribeVpcs 接口查询要创建实例的 VPC ID。

SubnetId

String

是

subnet-1g15j13jtzgu88ibuxwqp****

子网 ID。子网必须属于所选的可用区。

说明

  • 子网是私有网络内的 IP 地址块，私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网 IP 地址。
  • 您可以调用 CreateSubnet 接口创建子网，调用 DescribeSubnets 接口查询指定可用区内的所有子网列表信息，包括子网 ID。

Port

Integer

否

3306

为实例默认创建的连接终端指定私网端口号。默认取值为 3306，取值范围为 1000~65534。

说明

  • 该配置项仅对主节点终端、默认终端、HTAP集群终端生效。即实例创建成功后，新建的自定义终端，端口号依旧默认为 3306。
  • 实例创建成功后，您也可以随时修改端口号，当前仅支持通过控制台修改端口号，操作详情请参见修改连接地址前缀和端口。

SuperAccountName

String

否

vedbuser

高权限用户的账号名称。账号名称需满足以下要求：

  • 名称唯一。
  • 以字母开头，以字母或数字结尾。由小写字母、数字或下划线（_）组成。
  • 长度为 2~32 个字符。
  • 名称内不能包含某些关键词。详细信息，请参见禁用关键词。

说明

您可以在实例创建成功后，调用 CreateDBAccount 接口为实例创建高权限账号或普通账户。

SuperAccountPassword

String

否

kira****

高权限账号的密码。账号密码需满足以下要求：

  • 只能包含大小写字母、数字和特殊字符（如 _#!@$%^&*()+=-）。
  • 长度需在 8~32 个字符内。
  • 至少包含大写字母、小写字母、数字或特殊字符中的 3 种。
DBTimeZoneString否UTC +08:00实例的时区。国内所有地域默认时区为 UTC +08:00。

LowerCaseTableNames

String

否

1

表名是否区分大小写，默认取值为 1。
取值范围：

  • 0：表名称大小写敏感，后端根据实际表名存储。
  • 1：（默认）表名称不区分大小写，后端存储时将表名称统一为小写字母。

说明

创建实例后不支持修改此规则，请根据业务需求合理设置。

ProjectName

String

否

default

实例所属的项目名称，当该参数留空时，新建的实例默认加入 default 项目。

说明

项目是一个虚拟的概念，包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理，并且控制项目内用户和角色管理这些资源的权限。更多详情，请参见资源管理。

Tags

Array of TagObject

否

请参见请求示例。

需要绑定的标签键和标签值数组对象。关于 Tags 的更多详情，请参见 TagObject。

说明

  • 支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。单次最多同时传入 20 组标签键值对，单个实例最多绑定 50 个标签。
  • 标签键值需满足设置规则，具体规则请参见标签设置规则。

DeletionProtection

String

否

disabled

开启或关闭实例删除保护功能，取值范围：

  • enabled：开启。
  • disabled：关闭（默认）。

说明

开启后，将无法删除该实例。如需删除实例，您需要先调用 ModifyDBInstanceDeletionProtectionPolicy 接口关闭该功能。关于删除保护的更多信息，请参见实例删除保护。

ChargeType

String

是

PostPaid

计算计费类型。创建实例时计算计费类型可取值如下：

  • PostPaid：按量计费（后付费）。
  • PrePaid：包年包月（预付费）。

StorageChargeType

String

否

PostPaid

存储计费类型。不传入该参数时，存储计费类型默认与计算计费类型取值一致，取值如下：

  • PostPaid：按量计费（后付费）。
  • PrePaid：包年包月（预付费）。

注意

  • 当计算计费类型取值为 PostPaid 时，存储计费类型也只能取值为 PostPaid。
  • 当计算计费类型取值为 PrePaid 时，存储计费类型可取值为 PrePaid 或 PostPaid。

AutoRenew

Boolean

否

false

预付费场景下是否自动续费。取值：

  • true：自动续费。
  • false：不自动续费。

说明

当 ChargeType（计费类型） 取值为 PrePaid（包年包月） 时，该参数必填。

PeriodUnit

String

否

Month

预付费场景下的购买周期。

  • Month：包月。
  • Year：包年。

说明

当 ChargeType（计算计费类型） 取值为 PrePaid（包年包月） 时，该参数必填。

Period

Integer

否

1

预付费场景下的购买时长。

说明

当 ChargeType（计算计费类型） 取值为 PrePaid（包年包月） 时，该参数必填。

PrePaidStorageInGB

Integer

否

50

预付费场景下的存储空间大小。

说明

当 StorageChargeType（存储计费类型） 取值为 PrePaid（包年包月） 时，该参数必填。

NumberInteger否1创建的实例数量，取值范围 1~50，默认值为 1。

返回参数

名称类型示例值描述
InstanceIdStringvedbm-d4mx2akm****实例 ID。
OrderIdStringOrder707643373078888****订单 ID。

请求示例

POST /?Action=CreateDBInstance&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20220101T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c8701d16****
{
    "DBEngineVersion":"MySQL_8_0",
    "ZoneIds":"cn-beijing-b",
    "NodeSpec":"vedb.mysql.x4.xlarge",
    "NodeNumber":2,
    "VpcId":"vpc-3ajzohyfaru9s340jz1rp****",
    "SubnetId":"subnet-1g15j13jtzgu88ibuxwqp****",
    "InstanceName":"test",
    "SuperAccountName":"vedbuser",
    "SuperAccountPassword":"Kira****",
    "DBTimeZone":"UTC +08:00",
    "Tags":[
        {
            "Key":"chargetype",
            "Value":"postpaid"
        }
    ],
    "ChargeType":"PostPaid"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202204102136280102090801470751****",
        "Action": "CreateDBInstance",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "vedbm-d4mx2akm****",
        "OrderId": "Order707643373078888****"
    }
}

错误码

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