You need to enable JavaScript to run this app.
导航
云数据库 MySQL 版
  • 文档首页
    • /
  • 云数据库 MySQL 版

CreateDBInstance

最近更新时间：2023.09.05 21:27:31

首次发布时间：2021.11.12 19:16:58

我的收藏

调用 CreateDBInstance 接口创建一个 MySQL 实例。

注意事项

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

注意

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

请求类型

异步请求。

请求参数

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

InstanceName

String

否

test

设置实例的名称。命名规则如下：

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

    说明

    如果不填实例名称，则实例名称与实例 ID 一致。

    • Region

    String

    是

    beijing

    地域 ID 。

    说明

    您可以调用 ListRegions 接口查询实例支持的所有地域信息，包括地域 ID 。

    Zone

    String

    是

    cn-beijing-a

    可用区 ID 。

    说明

    您可以调用 ListZones 接口查询实例支持的可用区信息，包括可用区 ID 。

    DBEngineString否MySQL数据库类型。取值：
    MySQL （默认值）。
    DBEngineVersionString是MySQL_Community_5_7实例类型。取值：
  • MySQL_Community_5_7
  • MySQL_8_0
    • InstanceTypeString是HA实例类型。 取值：
    HA ：高可用版。
    InstanceSpecNameString是rds.mysql.2c4g实例规格名称，您可指定选择要创建实例的规格名称。取值：
  • rds.mysql.1c2g
  • rds.mysql.2c4g
  • rds.mysql.2c8g
  • rds.mysql.2c16g
  • rds.mysql.4c8g
  • rds.mysql.4c16g
  • rds.mysql.4c32g
  • rds.mysql.8c16g
  • rds.mysql.8c32g
  • rds.mysql.8c64g
  • rds.mysql.16c32g
  • rds.mysql.16c64g
  • rds.mysql.16c96g
  • rds.mysql.16c128g
  • rds.mysql.32c64g
  • rds.mysql.32c128g
  • rds.mysql.32c256g
  • rds.mysql.64c128g
  • rds.mysql.64c256g
  • rds.mysql.64c512g
  • rds.mysql.88c720g
  • rds.mysql.108c864g
    • StorageTypeString是LocalSSD实例存储类型。取值：
    LocalSSD ：本地 SSD 盘。
    StorageSpaceGBInteger是100实例存储空间，每个规格对应的存储空间取值范围详情请参见实例规格。

    VpcID

    String

    是

    vpc-3ajzohyfaru9s340jz1rp****

    私有网络（VPC ）ID 。

    说明

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

    NumberInteger否1实例购买数量。取值为 1~10 间的整数，默认值为 1。

    SuperAccountName

    String

    否

    rdsuser

    填写高权限用户账号名称。命名规则如下：

    • 名称唯一。
    • 以字母开头，以字母或数字结尾。
    • 由字母、数字、下划线（_）或中划线（-）组成。
    • 长度为 2~32 个字符。
    • 账号名称禁用关键词。

    SuperAccountPassword

    String

    否

    kira****

    设置高权限账号密码。规则如下：

    • 长度为 2~32 个字符。
    • 由大写字母、小写字母、数字和特殊字符中至少三种组成。
    • 特殊字符为 _#!@$%^*()+=-。
    ChargeTypeString是PostPaid计费类型。取值：
  • PostPaid ：后付费（按量计费）。
  • Prepaid ：预付费（包年包月）。

    • AutoRenew

    Boolean

    否

    true

    是否自动续费。默认值： false 。取值：

  • true ：是。
  • false ：否。

    说明

    若 ChargeType 设置了预付费（即 Prepaid），该参数必填。

    • PrepaidPeriod

    String

    否

    Month

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

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

    说明

    若ChargeType设置了预付费（即 Prepaid），该参数必填。

    • UsedTime

    Integer

    否

    1

    购买时长。

    说明

    若ChargeType设置了预付费（即 Prepaid），该参数必填。

    ProjectName

    String

    否

    default

    选择实例所属的项目。若该参数留空，新建实例不会加入任何项目。

    说明

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

    SubnetId

    String

    是

    subnet-1g15j13jtzgu88ibuxwqp****

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

    说明

    • 子网是私有网络内的 IP 地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网 IP 地址，您可以调用 CreateSubnet 接口创建子网。
    • 您可以调用 DescribeSubnets 接口查询指定可用区内的所有子网列表信息，包括子网 ID 。
    ParameterTemplateIdString否mysql-aa8b7dfbb41f****参数模板 ID。如不指定参数模板 ID，则使用和 MySQL 版本对应的系统参数模板。

    返回参数

    名称类型示例值描述
    InstanceIdStringmysql-55951954****实例 ID。
    OrderNOStringOrder709899242175681****订单编号。

    请求示例

    POST /?Action=CreateDBInstance&Version=2018-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=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****

{
      "InstanceName" : "test",
      "Zone" : "cn-beijing-a",
      "DBEngineVersion" : "MySQL_Community_5_7",
      "InstanceType" : "HA",
      "InstanceSpecName" : "rds.mysql.2c4g",
      "StorageType" : "LocalSSD",
      "StorageSpaceGB" : 100,
      "ChargeType" : "PostPaid",
      "SubnetId":"subnet-mj1kvgmlpclc5smt1avo2***",
      "VpcID" : "vpc-3ajzohyfaru9s340jz1rp****",
      "Number" : 1,
      "ParameterTemplateId" : "mysql-aa8b7dfbb41f****"
}

    返回示例

    正常返回示例

    {
    "ResponseMetadata" : {
        "RequestId": "d78bbf4e-63a5-4937-ac3c-3767e7eddfbe",
        "Action": "CreateDBInstance",
        "Version": "2018-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
 
    "Result": {
          "InstanceId" : "rds-mysql-h441603c68aaa****",
          "OrderNO": "Order7098992421756817700"
    }
}

    错误码

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