tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

StartCpuExpand

Last updated: 2024-11-20 11:14:51

    1. API Description

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

    u200cThis API is used to enable elastic CPU expansion manually or automatically.

    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: StartCpuExpand.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID.
    Type Yes String Scale-out mode. Valid values: auto and
    manual.
    ExpandCpu No Integer Number of CPU cores to increase during manual scale-out. This parameter is required when Type is set to manual.
    AutoStrategy No AutoStrategy Automatic scale-out policy. This parameter is required when Type is set to auto.

    3. Output Parameters

    Parameter Name Type Description
    AsyncRequestId String Async task ID, which can be passed in by calling the DescribeAsyncRequest API for task progress query.
    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 Enable elastic scale-out

    This API can be called to increase CPU cores for an instance.

    Input Example

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

{
    "InstanceId": "cdb-test",
    "Type": "manual",
    "ExpandCpu": 4
}

    Output Example

    {
    "Response": {
        "AsyncRequestId": "xxxxxxxxxxxxxx-xxxxxxxxxxx",
        "RequestId": "xxxxxxxxxxxxxxxxxxxxxxxx"
    }
}

    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.InstanceTaskConflictError An error occurred due to instance task conflict.
    FailedOperation.NotChangeStrategy No policy modification detected
    InternalError.UnknownError Unknown error
    InvalidParameter.ExceptionParam Parameter exception.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value
    MissingParameter.MissingParamError Required parameters are missing.
    UnsupportedOperation.NotSupportNormalInstance The current operation is not supported for instances with no resource usage limit.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy