文档中心

云数据库 SQL Server 版

实例管理

CreateDBInstance - 创建实例

调用 CreateDBInstance 接口创建实例。

调试

API Explorer

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

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：CreateDBInstance

要执行的操作，取值：CreateDBInstance。

Version string 必选示例值：2022-01-01

API的版本，取值：2022-01-01。

MaintenanceTime string 可选示例值：22:00Z-02:59Z

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

说明

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

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

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

DBEngineVersion string 必选示例值：SQLServer_2019_Std

兼容版本。取值如下：

SQLServer_2019_Std：表示 SQL Server 2019 标准版。

SQLServer_2019_Ent：表示 SQL Server 2019 企业版。

SQLServer_2019_Web：表示 SQL Server 2019 Web 版。

SQLServer_2022_Std：表示 SQL Server 2022 标准版。

SQLServer_2022_Ent：表示 SQL Server 2022 企业版。

SQLServer_2022_Web：表示 SQL Server 2022 Web 版。

InstanceType string 必选示例值：HA

实例类型。取值如下：

HA：表示高可用类型。

Basic：表示基础版类型。

Cluster：表示集群版类型。

说明

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

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

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

ZoneId string 必选示例值：cn-beijing-a

节点所在可用区。当主备节点不在同一个可用区时，您可以使用英文分号（;）隔开，默认第一个为主节点可用区，第二个为备节点可用区。

说明

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

NodeSpec string 必选示例值：rds.mssql.se.ha.d4.4c16g

实例规格代码。更多关于实例规格代码的详细信息，请参见产品规格。

StorageSpace integer 必选示例值：100

存储空间大小，单位为 GiB。取值范围：20GiB ~ 4000GiB，步长为 10GiB。

VpcId string 必选示例值：VPC123456

私有网络（VPC） ID。

说明

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

SubnetId string 必选示例值：Subnet123456

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

说明

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

SuperAccountPassword string 必选示例值：Test@123456

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

长度为 8~32 个字符。

由大写字母、小写字母、数字、特殊字符中的至少三种组成。

特殊字符为 !@#$%^&*()_+-=。

DBTimeZone string 必选示例值：China Standard Time

时区。当前仅支持取值 China Standard Time。

ChargeInfo object 必选示例值：{ "ChargeType": "PostPaid", "Number": 1 }

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

ChargeType string 必选示例值：PostPaid

付费类型。取值：

PostPaid：按量付费。

PrePaid：包年包月。

AutoRenew boolean 可选示例值：true

预付费场景下是否自动续费。当 ChargeType 为 Prepaid 时，可设置该参数。

true：表示开启自动续费（默认值）。

false：表示不开启自动续费。

PeriodUnit string 可选示例值：Month

预付费场景下的购买周期。当 ChargeType 为 Prepaid 时，可设置该参数。

Month：表示包月(默认)。

Year：表示包年。

Period integer 可选示例值：1

预付费场景下的购买时长。当 ChargeType 为 Prepaid 时，必须设置该参数。

Number integer 可选示例值：1

实例购买数量。默认值：1，取值范围为 [1,10]。

InstanceName string 可选示例值：Name123

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

不能以数字、中划线开头。

只能包含中文、字母、数字、下划线和中划线。

长度限制在 1~128 之间。

Tags object[] 可选示例值：{"Key":"key", "Value":"value"}

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

Key string 必选示例值：aa

实例标签的标签键。

Value string 必选示例值：bb

实例标签的标签值。

ServerCollation string 可选示例值：Chinese_PRC_CI_AS

实例字符集排序规则，默认取值为 Chinese_PRC_CI_AS。目前已支持大多数原生字符集具体取值如下：

Chinese_PRC_90_CI_AI

Chinese_PRC_CI_AI

Chinese_PRC_CI_AS

Chinese_PRC_CS_AS

Chinese_PRC_BIN

Chinese_PRC_BIN2

Cyrillic_General_CI_AS

Latin1_General_CI_AS

Latin1_General_CS_AS

SQL_Latin1_General_CP1_CI_AS

SQL_Latin1_General_CP1_CS_AS

Japanese_CI_AS

Japanese_CS_AS

Chinese_Taiwan_Stroke_CI_AS

Chinese_Taiwan_Stroke_CS_AS

Thai_CI_AS

ProjectName string 可选示例值：default

所属项目，默认值为空。

说明

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

AllowListIds string[] 可选示例值：[ "acl-a29be2559dc4406883d358892b90****", "acl-ded4c0b707e44efd8f0dbc4e88f5****" ]

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

说明

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

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InstanceId string 示例值：mssql-44171da8****

实例 ID。

OrderId string 示例值：Order719479011897090****

订单 ID。

请求示例

POST /?Action=CreateDBInstance&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mssql.cn-beijing.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****"​
    }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	OperationDenied_ImportJobExists	The operation is not permitted due to exist running import job.	当前实例正在执行数据导入任务，无法执行该操作。
400	UserBackupAmountOverTheLimit	The operation is not permitted due to the user backup amount over the limit.	手动备份的数量超过上限。
400	OperationDenied_BackupJobExists	The operation is not permitted due to exist running backup job.	当前实例正在执行备份任务，无法执行该操作。
400	OperationUnsupported	The operation is unsupported for the specified instance.	操作不支持。
400	InstanceIsNotRunning	The specified instance is not running.	当前实例状态不在运行中。
400	OperationDenied_IncrBackupUnsupportRecovery	The operation is not permitted due to incr backup unsupport recovery.	增量备份无法执行该操作。
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	缺少 {parameter1} 参数。
400	InvalidDBName_Duplicate	The specified DBName already exists.	数据库已存在。
400	TosRestoreTaskDbVerifyFailed	db verify failed, reason:%s.	DB 校验失败，原因是 {parameter1}。
400	InvalidParameter	The specified parameter %s is not valid.	参数 {parameter1} 值无效。
400	InvalidParameterFormat	The input parameter is not valid.	异常参数。
400	QuotaExceeded	The Instance Number has exceeded quota %d.	当前实例个数超出配额{parameter1}。
403	QuotaExceeded_RestoreDB	The quota of restore db exceeds.	恢复数据库超过配额限制。
403	OperationDenied_ResourceSoldOut	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.	当前可用区资源不足。
404	BackupNotFound	The specified instance does not exist available backup records.	未找到可用的备份记录。
404	InstanceNotFound	The specified instance does not exist.	未找到该实例。
500	InternalError	The request has failed with internal server error.	内部错误。
500	TosRestoreTaskNumExceedLimit	Too many tasks are being executed. Please submit them later.	正在执行的任务数量过多，请稍后再提交。

最近更新时间：2026.01.29 11:10:03

这个页面对您有帮助吗？

有用

无用