tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateDBInstance

Last updated: 2023-09-05 10:26:29

1. API Description

Domain name for API request: mariadb.tencentcloudapi.com.

This API is used to create a monthly subscribed TencentDB for MariaDB instance by passing in information such as instance specifications, database version number, validity period, and quantity.

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: CreateDBInstance.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
Zones.N Yes Array of String AZs to deploy instance nodes. You can specify up to two AZs (one as primary AZ and another as replica AZ). When the shard specification is 1-primary-2-replica, the primary and one of the replicas are deployed in the primary AZ.
NodeCount Yes Integer Number of nodes, which can be obtained
by querying the instance specification through the DescribeDBInstanceSpecs API.
Memory Yes Integer Memory size in GB, which can be obtained
by querying the instance specification through the DescribeDBInstanceSpecs API.
Storage Yes Integer Storage capacity in GB. The maximum and minimum storage space can be obtained
by querying instance specification through the DescribeDBInstanceSpecs API.
Period No Integer Validity period in months
Count No Integer The number of instances to be purchased. Only one instance is queried for price by default.
AutoVoucher No Boolean Whether to automatically use vouchers. This option is disabled by default.
VoucherIds.N No Array of String Voucher ID list. Currently, you can specify only one voucher.
VpcId No String VPC ID. If this parameter is not passed in, the instance will be created on the classic network.
SubnetId No String VPC subnet ID, which is required when VpcId is specified.
ProjectId No Integer Project ID, which can be obtained through the DescribeProjects API. If this parameter is not passed in, the instance will be associated with the default project.
DbVersionId No String Database engine version. Valid values: 5.7, 8.0, 10.0, 10.1.
InstanceName No String Name of the instance, which can be customized.
SecurityGroupIds.N No Array of String List of security group IDs
AutoRenewFlag No Integer Auto-renewal flag. Valid values: 1 (auto-renewal), 2 (no renewal upon expiration).
Ipv6Flag No Integer Whether IPv6 is supported. Valid values: 0 (unsupported), 1 (supported).
ResourceTags.N No Array of ResourceTag Array of tag key-value pairs
InitParams.N No Array of DBParamValue List of parameters. Valid values: character_set_server (character set; required); lower_case_table_names (table name case sensitivity; required; 0: case-sensitive; 1: case-insensitive); innodb_page_size (InnoDB data page size; default size: 16 KB); sync_mode (sync mode; 0: async; 1: strong sync; 2: downgradable strong sync; default value: 2).
DcnRegion No String DCN source region
DcnInstanceId No String DCN source instance ID

3. Output Parameters

Parameter Name Type Description
DealName String Order ID, which is used for calling the DescribeOrders API.
The parameter can be used to either query order details or call the user account APIs to make another payment when this payment fails.
InstanceIds Array of String IDs of the instances you have purchased in this order. If no instance IDs are returned, you can query them with the DescribeOrders API. You can also use the DescribeDBInstances API to check whether an instance has been created successfully.
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a monthly subscribed TencentDB for MariaDB instance

This example shows you how to create a monthly subscribed TencentDB for MariaDB instance.

Input Example

https://mariadb.tencentcloudapi.com/?Action=CreateDBInstance&Zones.0=ap-guangzhou-2&Zones.1=ap-guangzhou-2&Memory=2000&Storage=10000&NodeCount=1&Count=1&Period=1&AutoVoucher=true&<common request parameters>

Output Example

{
    "Response": {
        "RequestId": "8c4fba95-01e4-61d9-4146-59fc5afdf962",
        "DealName": "20171103110163",
        "InstanceIds": null
    }
}

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 an order.
FailedOperation.PayFailed Failed to make order payment.
FailedOperation.TagDryRunError Either tag key/value verification or tag API authentication failed.
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.CheckVipStatusFailed Failed to verify the VIP status
InternalError.GetSubnetFailed Failed to query the VPC subnet information.
InternalError.GetVpcFailed Failed to query the VPC information.
InternalError.OperateDatabaseFailed Database operation failed.
InvalidParameter.CheckParamNotPass Verification of input parameters failed.
InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
InvalidParameter.SubnetNotFound The specified VPC subnet was not found.
InvalidParameter.VpcNotFound The specified VPC subnet was not found.
InvalidParameterValue.IllegalCount The number of products exceeds the upper limit.
InvalidParameterValue.IllegalQuantity The number of products exceeds the upper limit.
InvalidParameterValue.IllegalZone Information of the specified AZ was not found.
InvalidParameterValue.SpecIdIllegal The specification information of the database instance was not found.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
UnsupportedOperation.DbVersionNotSupported This database version is not supported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy