API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 云数据库 SQL Server > 只读实例管理相关接口 > 创建只读实例 (云盘)

创建只读实例 (云盘)

最近更新时间：2024-03-12 01:47:26

我的收藏

本页目录：

1. 接口描述

接口请求域名： sqlserver.tencentcloudapi.com 。

本接口（CreateCloudReadOnlyDBInstances）用于创建只读实例 (云盘)。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateCloudReadOnlyDBInstances。
Version 是 String 公共参数，本接口取值：2018-03-28。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 主实例ID，格式如：mssql-3l3fgqn7
示例值：mssql-6upluvd5
Zone 是 String 实例可用区，类似ap-guangzhou-1（广州一区）；实例可售卖区域可以通过接口DescribeZones获取
示例值：ap-guangzhou-2
ReadOnlyGroupType 是 Integer 只读组类型选项，1-按照一个实例一个只读组的方式发货，2-新建只读组后发货，所有实例都在这个只读组下面， 3-发货的所有实例都在已有的只读组下面
示例值：2
Memory 是 Integer 实例内存大小，单位GB
示例值：2
Storage 是 Integer 实例磁盘大小，单位GB
示例值：10
Cpu 是 Integer 实例核心数
示例值：2
MachineType 是 String 购买实例的宿主机磁盘类型,CLOUD_HSSD-虚拟机加强型SSD云盘，CLOUD_TSSD-虚拟机极速型SSD云盘，CLOUD_BSSD-虚拟机通用型SSD云盘
示例值：CLOUD_BSSD
ReadOnlyGroupForcedUpgrade 否 Integer 0-默认不升级主实例，1-强制升级主实例完成ro部署；主实例为非集群版时需要填1，强制升级为集群版。填1 说明您已同意将主实例升级到集群版实例。
示例值：1
ReadOnlyGroupId 否 String ReadOnlyGroupType=3时必填,已存在的只读组ID
示例值：mssqlrg-dj5i29c5n
ReadOnlyGroupName 否 String ReadOnlyGroupType=2时必填，新建的只读组名称
示例值：default_name
ReadOnlyGroupIsOfflineDelay 否 Integer ReadOnlyGroupType=2时必填，新建的只读组是否开启延迟剔除功能，1-开启，0-关闭。当只读副本与主实例延迟大于阈值后，自动剔除。
示例值：1
ReadOnlyGroupMaxDelayTime 否 Integer ReadOnlyGroupType=2 且 ReadOnlyGroupIsOfflineDelay=1时必填，新建的只读组延迟剔除的阈值。
示例值：10
ReadOnlyGroupMinInGroup 否 Integer ReadOnlyGroupType=2 且 ReadOnlyGroupIsOfflineDelay=1时必填，新建的只读组延迟剔除后至少保留只读副本的个数。
示例值：1
InstanceChargeType 否 String 付费模式，取值支持 PREPAID（预付费），POSTPAID（后付费）。
示例值：POSTPAID
GoodsNum 否 Integer 本次即将购买的实例数量，默认取值2。
示例值：2
SubnetId 否 String VPC子网ID，形如subnet-bdoe83fa；SubnetId和VpcId需同时设置或者同时不设置
示例值：subnet-gdy95gfs
VpcId 否 String VPC网络ID，形如vpc-dsp338hz；SubnetId和VpcId需同时设置或者同时不设置
示例值：vpc-3xq2t5al
Period 否 Integer 购买实例周期，默认取值为1，表示一个月。取值不超过48
示例值：1
SecurityGroupList.N 否 Array of String 安全组列表，填写形如sg-xxx的安全组ID
示例值：sg-xxx
AutoVoucher 否 Integer 是否自动使用代金券；1 - 是，0 - 否，默认不使用
示例值：1
VoucherIds.N 否 Array of String 代金券ID数组，目前单个订单只能使用一张
示例值：xxx
ResourceTags.N 否 Array of ResourceTag 新建实例绑定的标签集合
Collation 否 String 系统字符集排序规则，默认：Chinese_PRC_CI_AS
示例值：Chinese_PRC_CI_AS
TimeZone 否 String 系统时区，默认：China Standard Time
示例值：China Standard Time

3. 输出参数

参数名称 类型 描述
DealNames Array of String 订单名称数组
示例值：["20200722117963"]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建只读实例

创建基于通用型SSD云硬盘的只读副本

输入示例

POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudReadOnlyDBInstances
<公共请求参数>

{
    "ReadOnlyGroupMaxDelayTime": "10",
    "VpcId": "vpc-3xq2t5al",
    "GoodsNum": "1",
    "Zone": "ap-guangzhou-2",
    "InstanceId": "mssql-6upluvd5",
    "Period": "1",
    "Storage": "10",
    "ReadOnlyGroupIsOfflineDelay": "1",
    "ReadOnlyGroupMinInGroup": "1",
    "ReadOnlyGroupName": "default_name",
    "Collation": "Chinese_PRC_CI_AS",
    "ReadOnlyGroupType": "2",
    "InstanceChargeType": "POSTPAID",
    "Memory": "2",
    "SubnetId": "subnet-gdy95gfs",
    "TimeZone": "China Standard Time",
    "ReadOnlyGroupForcedUpgrade": "1",
    "Cpu": 2,
    "MachineType": "CLOUD_BSSD"
}

输出示例

{
    "Response": {
        "DealNames": [
            "20200722117963"
        ],
        "RequestId": "0509b6b8-8906-479f-9489-10620ec6d4ce"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.CreateOrderFailed 创建订单失败。
FailedOperation.DBError 数据库错误。
FailedOperation.GetVpcFailed 获取VPC网络信息失败。
InternalError.DBError 数据库错误。
InternalError.SystemError 系统错误。
InternalError.VPCError VPC错误。
InvalidParameter.InputIllegal 输入错误。
InvalidParameter.ParamsAssertFailed 参数断言转换错误。
InvalidParameter.PayOrderFailed 支付订单失败。
InvalidParameterValue.IllegalSpec 实例规格信息错误。
InvalidParameterValue.ParameterTypeError 参数类型错误。
InvalidParameterValue.RoGroupNameIsIllegal 只读组名称包含非法字符。
InvalidParameterValue.SecurityGroupIdIsIllegal 安全组ID非法。
ResourceNotFound.InstanceNotFound 实例不存在。
ResourceNotFound.VpcNotExist VPC网络不存在。
ResourceUnavailable.InstanceStatusInvalid 实例状态无效。
ResourceUnavailable.VpcNotExist VPC不存在。
UnauthorizedOperation.PermissionDenied cam鉴权错误。
中国站