You need to enable JavaScript to run this app.
导航
云数据库 SQL Server 版
  • 文档首页
    • /云数据库 SQL Server 版/API 参考/实例/CreateDBInstance
CreateDBInstance
最近更新时间：2025.03.24 15:30:15首次发布时间：2023.04.24 11:01:04
我的收藏
有用
有用
无用
无用

调用 CreateDBInstance 接口创建实例。

请求类型

异步请求。

请求参数

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

DBEngineVersion

String

是

SQLServer_2019_Std

兼容版本。取值如下：

  • SQLServer_2019_Std：表示 SQL Server 2019 标准版。

  • SQLServer_2019_Ent：表示 SQL Server 2019 企业版。

  • SQLServer_2019_Web：表示 SQL Server 2019 Web 版。

InstanceType

String

是

HA

实例类型。取值如下：

  • HA：表示高可用类型。

  • Basic：表示基础版类型。

  • Cluster：表示集群版类型。

说明

  • 在 DBEngineVersion 设置为 SQLServer_2019_Std 时，InstanceType 支持设置为 HA 或 Basic。

  • 在 DBEngineVersion 设置为 SQLServer_2019_Ent 时，InstanceType 支持设置为 Cluster 或 Basic。

  • 在 DBEngineVersion 设置为 SQLServer_2019_Web 时，InstanceType 支持设置为 Basic。

ZoneId

String

是

cn-beijing-a

节点所在可用区。在创建的实例包含主备节点，需要跨可用区部署主备节点时，您可以使用英文分号（;）隔开，默认第一个为主节点可用区，第二个为备节点可用区。

说明

您可以调用 DescribeAvailabilityZones 接口查询可用区。

NodeSpecString是rds.mssql.se.ha.d4.4c16g实例规格代码。更多关于实例规格代码的详细信息，请参见产品规格。
StorageSpaceInteger是100存储空间大小，单位为 GiB。取值范围：20GiB ~ 4000GiB，步长为 10GiB。

VpcId

String

是

VPC123456

私有网络（VPC） ID。

说明

您可以调用 DescribeVpcs 接口查询满足指定条件的私有网络。

SubnetId

String

是

Subnet123456

子网 ID。在跨可用区部署主备节点时，主备节点的子网也需设置为对应可用区私有网络下的子网，多个可用区需使用英文分号（;）隔开。

说明

您可以调用 DescribeSubnets 接口查询子网 ID。

SuperAccountPassword

String

是

Test@123456

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

  • 长度为 8~32 个字符。

  • 由大写字母、小写字母、数字、特殊字符中的至少三种组成。特殊字符包括 ~!@#$%^&*()-_+=?。

ServerCollation

String

否

Chinese_PRC_CS_AS

实例字符集排序规则，默认取值为 Chinese_PRC_CI_AS。目前已支持的字符集取值如下：

  • Latin1_General_CI_AS

  • Latin1_General_CS_AS

  • SQL_Latin1_General_CP1_CI_AS

  • SQL_Latin1_General_CP1_CS_AS

  • Chinese_PRC_CI_AS

  • Chinese_PRC_CS_AS

  • Chinese_PRC_BIN

  • Japanese_CI_AS

  • Japanese_CS_AS

  • Chinese_Taiwan_Stroke_CI_AS

  • Chinese_Taiwan_Stroke_CS_AS

  • Thai_CI_AS

说明

即便选择了区分大小写的实例字符集，也不支持创建大小写敏感的数据库，例如数据库名称为 A 和 a 会被视为同一个数据库。

DBTimeZoneString是China Standard Time时区。当前仅支持取值 China Standard Time。
ChargeInfoChargeInfoObject是{ "ChargeType": "PostPaid", "Number": 1 }付费方式。更多关于 ChargeInfo 信息，请参见 数据结构。

InstanceName

String

否

Name123

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

  • 不能以数字、中划线（-）开头。

  • 只能包含中文、字母、数字、下划线（_）和中划线（-）。

  • 长度限制在 1~128 之间。

StorageType

String

否

ESSDPL1

实例的存储类型。取值如下：

  • ESSDPL1：（默认值）表示极速型 SSD PL1 云盘。

Tags

Array of TagsObject

否

{
"Key":"key", "Value":"value"
}

实例标签。详细信息，请参见数据结构。

ServerCollationString否Chinese_PRC_CI_ASSQL Server 排序规则，当前仅支持 Chinese_PRC_CI_AS （默认值）取值。

ProjectName

String

否

default

所属项目，默认值为空。

说明

您可以调用 GetProject 接口查看项目信息。

MaintenanceTime

String

否

22:00Z-02:59Z

实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC时间）。默认取值为 UTC18:00Z-21:59Z（即北京时间 02:00-05:59）

说明

  • 为保护云数据库的稳定性，系统会不定期对实例进行维护。可维护时间段建议设置在业务低峰期，避免对业务造成影响。

  • 在可维护时间段内，实例可能会出现 1~2 次的连接闪断，需确保应用程序具有自动重连机制。

  • 可维护时间段最小时间间隔 1 小时，最大时间间隔 24 小时，不允许跨天选择可维护时间段。

AllowListIds

Array of String

否

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

白名单 ID。如需绑定多个白名单，白名单 ID 用英文逗号（,）分隔。

说明

一个实例最多可绑定 100 个白名单。

返回参数

名称类型示例值描述
InstanceIdStringmssql-44171da8****实例 ID。
OrderIdStringOrder719479011897090****订单 ID。

请求示例

POST /?Action=CreateDBInstance&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.volcengineapi.com
X-Date: 20230131T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "DBEngineVersion":"SQLServer_2019_Std",
    "InstanceType":"HA",
    "ZoneId":"cn-beijing-a",
    "NodeSpec":"rds.mssql.se.ha.d4.4c16g",
    "StorageSpace":20,
    "VpcId":"vpc-2d5xeur6hiscg58ozfcuq****",
    "SubnetId":"subnet-2bzup883l93402dx0efe1****",
    "InstanceName":"实例样例",
    "SuperAccountPassword":"Admin@123",
    "ServerCollation":"Chinese_PRC_CI_AS",
    "Tags":[
        {
            "Key":"key1",
            "Value":"value1"
        },
        {
            "Key":"key2",
            "Value":"value2"
        }
    ],
    "DBTimeZone":"China Standard Time",
    "ProjectName":"default",
    "ChargeInfo":{
        "ChargeType":"PostPaid",
        "Number":1
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202301312022404400C80FE28234E9F81D",
        "Action": "CreateDBInstance",
        "Version": "2022-01-01",
        "Service": "rds_mssql",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "mssql-44171da8****",
        "OrderId": "Order719479011897090****"
    }
}

错误码

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