You need to enable JavaScript to run this app.
导航
云数据库 MySQL 版
  • 文档首页
    • /云数据库 MySQL 版/API 参考/V2（2022-01-01）/实例管理/CreateDBInstance
CreateDBInstance
最近更新时间：2024.07.26 14:50:52首次发布时间：2023.02.02 17:41:21
我的收藏

调用 CreateDBInstance 接口创建实例。

请求类型

异步请求。

请求参数

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

DBEngineVersion

String

是

MySQL_8_0

兼容版本。取值：

  • MySQL_5_7：表示 MySQL 5.7。
  • MySQL_8_0：表示 MySQL 8.0。

NodeInfo

Array of NodeInfoObject

是

[
    {
        "NodeType": "Primary",
        "ZoneId": "cn-beijing-a",
        "NodeSpec": "rds.mysql.1c2g"
},
{
"NodeType": "Secondary",
"ZoneId": "cn-beijing-a",
"NodeSpec": "rds.mysql.1c2g"
},
{
"NodeType": "ReadOnly",
"ZoneId": "cn-beijing-a",
"NodeSpec": "rds.mysql.1c2g"
}
]

实例规格配置。主节点和备节点有且只有 1 个，只读节点可选 0~10 个。云数据库 MySQL 版支持将主节点、备节点创建在不同可用区，但只读节点必须添加在主节点或备节点的可用区。更多关于 NodeInfo 信息，请参见数据结构。

StorageType

String

是

LocalSSD

实例存储类型。取值为 LocalSSD，表示本地 SSD 盘。

StorageSpaceInteger是100实例存储空间。取值范围：[20, 3000]，单位为 GB，步长 10GB。
InstanceTypeString否DoubleNode实例类型。取值为 DoubleNode。
VpcIdString是vpc-2d70di2hrnbpc58ozfdx9****专有网络（VPC） ID。可调用 DescribeVpcs 查询。
SubnetIdString是subnet-2d70dj20bob9c58ozfek6****子网 ID。 可调用 DescribeSubnets 通过指定 VpcId 和 ZoneId （主节点或备节点所在的可用区）查询可用的子网。

InstanceName

String

否

Name123

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

  • 不能以数字、中划线开头。
  • 只能包含中文、字母、数字、下划线和中划线。
  • 长度限制在 1 ~ 128 之间。

SuperAccountName

String

否

Test1

高权限账号名称。不传此参数默认不创建高权限账号。
高权限账号名称命名规则如下：

  • 账号长度为 2~32 个字符。
  • 以字母开头，以字母或数字结尾。
  • 由字母、数字、下划线（_）或中划线（-）组成。
  • 不能使用某些预留字，被禁用的预留字请参见禁用词列表。
  • 账号名称在实例内必须是唯一的。

SuperAccountPassword

String

否

Test@123456

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

  • 长度为 8~32 个字符。
  • 由大写字母、小写字母、数字、特殊字符中的至少三种组成。
  • 特殊字符为 !@#$%^&*()_+-=,.&?|/。

LowerCaseTableNames

String

否

1

表名是否区分大小写，默认取值为“1”。后端忽略大小写。
取值范围：

  • 0：表名被存储成固定且表名称大小写敏感。
  • 1：表名将被存储成小写且表名称大小写不敏感。
DBTimeZoneString否UTC +08:00时区。支持 UTC -12:00 ~ +13:00。默认值为 Region 所在的 TimeZone。
DBParamGroupIdString否mysql-sys-6013c7b8f7ef****参数模板 ID。默认值为数据库引擎版本对应的默认参数模板。
ProjectNameString否Test实例所属的项目。如需在创建时指定项目，需确保项目已存在。可通过调用 ListProjects 接口查询项目列表，也可通过调用 CreateProject 接口创建新的项目。

ChargeInfo

ChargeInfoObject

是

{
"ChargeType": "PostPaid"
}

付费方式。更多关于 ChargeInfo 信息，请参见数据结构。

AllowListIds

Array of String

否

[
"acl-a29be2559dc4406883d358892b90****",
"acl-ded4c0b707e44efd8f0dbc4e88f5****"
]

白名单 ID。如需绑定多个白名单，白名单 ID 用英文逗号（,）分隔。一个实例最多可绑定 100 个白名单。

Port

Integer

否

3306

默认终端的私网端口。端口号的取值范围为 1000~65534，默认值为 3306。
创建新的连接终端或开启新地址时，将使用默认终端的私网端口实时配置为默认端口。

InstanceTagsArray of InstanceTagsObject否[{"Key":"key", "Value":"value"}]实例标签。更多关于 InstanceTags 信息，请参见数据结构。

MaintenanceWindow

MaintenanceWindowObject

否

{
  "DayKind": "Week",
  "DayOfWeek": [ ,
    "Monday",
    "Tuesday",
    "Wednesday",
    "Thursday",
    "Friday",
    "Saturday",
    "Sunday"
    ]
    "MaintenanceTime": "18:00Z-21:59Z"
}

在创建实例时指定实例的可维护时间段。该字段为可选，不设置时默认为一周内每一天的 UTC18:00Z-21:59Z（即北京时间 02:00-05:59）。更多关于 MaintenanceWindowObject 的详细信息，请参见数据结构。

返回参数

名称类型示例值描述
InstanceIdStringmysql-06f13c93****实例 ID。
OrderIdStringOrder709899242175681****订单 ID。

请求示例

POST /?Action=CreateDBInstance&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlk****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c****

{
    "DBEngineVersion": "MySQL_5_7",
    "NodeInfo":[
        {
            "NodeType": "Primary",
            "ZoneId": "cn-beijing-a",
            "NodeSpec": "rds.mysql.1c2g"
        },
        {
            "NodeType": "Secondary",
            "ZoneId": "cn-beijing-b",
            "NodeSpec": "rds.mysql.1c2g"
        }
    ],
    "StorageType": "LocalSSD",
    "StorageSpace": 20,
    "SubnetId": "subnet-2gcy3ey5i9reo50ztyzo6****",
    "VpcId": "vpc-3jhamu8itr5ds3pncmf9q****",
    "AllowListIds":[
        "acl-3929ba6fd27049e88ee772dc7b46****"
    ],
    "Port":3306,
    "InstanceName": "测试样例",
    "ChargeInfo": {
        "ChargeType": "PostPaid",
        "Number": 1
    },
    "MaintenanceWindow": {
        "DayKind": "Week",
        "DayOfWeek": [
            "Monday",
            "Tuesday",
            "Wednesday",
            "Thursday",
            "Friday",
            "Saturday",
            "Sunday"
        ],
        "MaintenanceTime": "18:00Z-21:59Z"
    }
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230508104043BEB227FB89B4F73A1436",
        "Action": "CreateDBInstance",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "mysql-06f13c93****",
        "OrderId": "Order7230634971667632428"
    }
}

错误码

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