ModifyInstancePre

Last updated: 2025-11-21 20:32:38

ModifyInstancePre

Last updated: 2025-11-21 20:32:38

1. API Description

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

This API is used to change the configuration of prepaid instances, adjust disks, modify bandwidth, and manage partitions.

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	ckafka cluster instance Id. obtain through the API DescribeInstances.
DiskSize	No	Integer	Specifies the disk capacity in GB. value range: 100 to 500000 with a step length of 100. Specification limits can be viewed through the following link: https://www.tencentcloud.comom/document/product/597/122562.?from_cn_redirect=1
BandWidth	No	Integer	Peak bandwidth in MB/s. Specifies the specification limits and corresponding step length through the following link: https://www.tencentcloud.comom/document/product/597/11745.?from_cn_redirect=1
Partition	No	Integer	Partition upper bound. maximum value of 40000. step length of 100. Specifies the specifications and limits that can be viewed through the following link: https://www.tencentcloud.comom/document/product/597/122563.?from_cn_redirect=1

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, 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 Modifying an Instance (Prepaid Annual and Monthly)

Input Example

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

{
    "InstanceId": "ckafka-test",
    "BandWidth": 40,
    "DiskSize": 600
}

Output Example

{
    "Response": {
        "Result": {
            "ReturnCode": "0",
            "ReturnMessage": "ok",
            "Data": {
                "FlowId": 0,
                "DealNames": [
                    "name"
                ],
                "InstanceId": "ckafka-test",
                "DealNameInstanceIdMapping": [
                    {
                        "DealName": "name",
                        "InstanceIdList": [
                            "name"
                        ]
                    }
                ]
            },
            "DeleteRouteTimestamp": "2024-12-02 12:21:23"
        },
        "RequestId": "84770b4b-df34-4ccf-8e22-41d3b1d0fe0d"
    }
}

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

Tencent Cloud CLI 3.0

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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud