tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

RenewDBInstance

Last updated: 2024-01-30 10:25:54

    1. API Description

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

    This API is used to renew a monthly subscribed TencentDB instance, and a pay-as-you-go instance can be renewed as a monthly subscribed one by this API.

    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: RenewDBInstance.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String ID of the instance to be renewed in the format of cdb-c1nl9rpv, which is the same as the instance ID displayed in the TencentDB console. You can use the DescribeDBInstances API to query the ID.
    TimeSpan Yes Integer Renewal period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    ModifyPayType No String To renew a pay-as-you-go instance to a monthly subscribed one, you need to set this parameter to PREPAID.

    3. Output Parameters

    Parameter Name Type Description
    DealId String Order ID
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Renewing a TencentDB instance

    Input Example

    POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RenewDBInstance
<Common request parameters>

{
    "InstanceId": "cdb-ezq1vzem",
    "TimeSpan": "12"
}

    Output Example

    {
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "DealId": "20170320233333"
    }
}

    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
    InternalError.CdbCgwError Internal system error.
    InternalError.TradeError Transaction system error.
    InternalError.UndefinedError Unknown error
    InvalidParameter Parameter error.
    InvalidParameter.InstanceNotFound The instance does not exist.
    OperationDenied.ActionNotSupport Unsupported operation.
    OperationDenied.UserHasNoStrategy This account is not authorized to access the requested resource.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy