tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateHourDBInstance

Last updated: 2024-11-20 12:15:14

    1. API Description

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

    This API is used to create a pay-as-you-go TencentDB for MariaDB instance.

    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: CreateHourDBInstance.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    Zones.N Yes Array of String AZs to deploy instance nodes. You can specify up to two AZs.
    NodeCount Yes Integer Number of nodes.
    Memory Yes Integer Memory size in GB.
    Storage Yes Integer Storage size in GB.
    Count No Integer Number of instances to purchase.
    ProjectId No Integer Project ID. If this parameter is not passed in, the default project will be used.
    VpcId No String Unique ID of the network. If this parameter is not passed in, the classic network will be used.
    SubnetId No String Unique ID of the subnet. If VpcId is specified, this parameter is required.
    DbVersionId No String Database engine version. Valid values: 5.7, 8.0, 10.0, 10.1.
    InstanceName No String Custom name of the instance.
    SecurityGroupIds.N No Array of String Security group ID. If this parameter is not passed in, no security groups will be associated when the instance is created.
    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.
    DcnRegion No String If you create a disaster recovery instance, you need to use this parameter to specify the region of the associated primary instance so that the disaster recovery instance can sync data with the primary instance over the Data Communication Network (DCN).
    DcnInstanceId No String If you create a disaster recovery instance, you need to use this parameter to specify the ID of the associated primary instance so that the disaster recovery instance can sync data with the primary instance over the Data Communication Network (DCN).
    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).
    RollbackInstanceId No String ID of the instance to be rolled back, such as “2021-11-22 00:00:00”.
    RollbackTime No String Rollback time.

    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.
    FlowId Integer Async task ID, which can be used in the DescribeFlow API to query the async task result.
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Creating a pay-as-you-go TencentDB for MariaDB instance

    This example shows you how to create a pay-as-you-go TencentDB for MariaDB instance.

    Input Example

    POST / HTTP/1.1Host: mariadb.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreateHourDBInstance<common request parameters>{    "DbVersionId": "5.7.17",    "VpcId": "vpc-n2vdqxdx",    "Storage": "10",    "Zones": [        "ap-guangzhou-1",        "ap-guangzhou-1"    ],    "SubnetId": "subnet-j2ezrypg",    "Memory": "2",    "NodeCount": "2"}

    Output Example

    {
    "Response": {
        "DealName": "20200409111543",
        "InstanceIds": [
            "tdsql-dup8gl6t"
        ],
        "FlowId": 22051110000,
        "RequestId": "05ad9b30-ac0a-4945-afd5-3d405d537a93"
    }
}

    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.TagDryRunError Either tag key/value verification or tag API authentication failed.
    FailedOperation.UserNotAuthed Unauthenticated user
    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.InnerSystemError Internal system error.
    InternalError.OperateDatabaseFailed Database operation failed.
    InvalidParameter Parameter error.
    InvalidParameter.CheckParamNotPass Verification of input parameters failed.
    InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
    InvalidParameter.InstanceNotFound Failed to find the requested instance.
    InvalidParameter.SubnetNotFound The specified VPC subnet was not found.
    InvalidParameter.VpcNotFound The specified VPC subnet was not found.
    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.
    ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
    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