tencent cloud



Last updated: 2023-07-05 15:57:45

1. API Description

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

This API is used to change the configurations of a prepaid instance, such as disk capacity and bandwidth.

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: ModifyInstancePre.
Version Yes String Common Params. The value used for this API: 2019-08-19.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance name.
DiskSize Yes Integer Estimated disk capacity, which can be increased by increment.
BandWidth Yes Integer Estimated bandwidth, which can be increased by increment.
Partition No Integer Estimated partition count, which can be increased by increment.

3. Output Parameters

Parameter Name Type Description
Result CreateInstancePreResp Response structure of modifying the configurations of a prepaid instance.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Changing the configurations of a monthly subscribed (prepaid) instance

Input Example

Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstancePre
<Common request parameters>

    "InstanceId": "ckafka-xxxx",
    "BandWidth": "40",
    "DiskSize": "600"

Output Example

    "Response": {
        "Result": {
            "DeleteRouteTimestamp": "xx",
            "ReturnCode": "0",
            "ReturnMessage": "ok",
            "Data": {
                "FlowId": 0,
                "InstanceId": "ckafka-xxxx",
                "DealNames": [
        "RequestId": "1ba4ac83-1e9e-497b-b3e1-4c10872a4068"

5. Developer Resources


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 Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.InstanceNotExist The instance does not exist.
InvalidParameterValue.NotAllowedEmpty The parameter is required.
InvalidParameterValue.RepetitionValue The parameter already exists.
InvalidParameterValue.SubnetIdInvalid Invalid subnet ID.
InvalidParameterValue.SubnetNotBelongToZone The subnet is not in the zone.
InvalidParameterValue.VpcIdInvalid Invalid VPC ID.
InvalidParameterValue.WrongAction The value of the Action parameter is incorrect.
InvalidParameterValue.ZoneNotSupport The zone is not supported.
ResourceNotFound The resource does not exist.
UnsupportedOperation.OssReject Oss rejected the operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support