tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

CreateReadOnlyDBInstances

最后更新时间：2024-11-26 16:33:00

1. API Description

Domain name for API request: sqlserver.intl.tencentcloudapi.com.

This API is used to create read-only instances (local disk).

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateReadOnlyDBInstances.
Version Yes String Common Params. The value used for this API: 2018-03-28.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String
Zone Yes String
ReadOnlyGroupType Yes Integer
Memory Yes Integer
Storage Yes Integer
ReadOnlyGroupForcedUpgrade No Integer
ReadOnlyGroupId No String
ReadOnlyGroupName No String
ReadOnlyGroupIsOfflineDelay No Integer
ReadOnlyGroupMaxDelayTime No Integer
ReadOnlyGroupMinInGroup No Integer
InstanceChargeType No String
GoodsNum No Integer
SubnetId No String
VpcId No String
Period No Integer
SecurityGroupList.N No Array of String
AutoVoucher No Integer
VoucherIds.N No Array of String
ResourceTags.N No Array of ResourceTag
Collation No String
TimeZone No String

3. Output Parameters

Parameter Name Type Description
DealNames Array of String
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 创建只读实例

Input Example

POST / HTTP/1.1
Host: sqlserver.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateReadOnlyDBInstances
<common request parameters>

{
    "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"
}

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.CreateOrderFailed Failed to create order.
FailedOperation.GetVpcFailed Failed to get VPC information.
InternalError.DBError Database error
InternalError.SystemError System error.
InternalError.VPCError VPC error
InvalidParameter.InputIllegal Input error.
InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
InvalidParameter.PayOrderFailed Failed to make order payment.
InvalidParameterValue.IllegalSpec Incorrect instance specification information.
InvalidParameterValue.ParameterTypeError Incorrect parameter type.
InvalidParameterValue.RoGroupNameIsIllegal Read-only group name contains invalid characters.
InvalidParameterValue.SecurityGroupIdIsIllegal Invalid security group ID.
ResourceNotFound.InstanceNotFound The instance does not exist.
ResourceNotFound.VpcNotExist The VPC does not exist.
ResourceUnavailable.InstanceStatusInvalid Invalid instance status.
UnauthorizedOperation.PermissionDenied CAM authentication error.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款