DescribeModifyType

Last updated: 2025-12-29 11:41:51

DescribeModifyType

Last updated: 2025-12-29 11:41:51

1. API Description

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

This API is used to query instance specification change types.

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: DescribeModifyType.
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.
BandWidth	Yes	Integer	Specifies the bandwidth after upgrade. measurement unit: mb.
DiskSize	Yes	Integer	Specifies the disk after upgrade, in gb.
DiskType	Yes	String	Disk type, such as CLOUD_PREMIUM.
Partition	Yes	Integer	Number of partitions.
Topic	Yes	Integer	Number of Topics
Type	Yes	String	Instance type, such as sp_ckafka_profession.
ModifyEntry	No	String	Configuration change portal.

3. Output Parameters

Parameter Name	Type	Description
Result	DescModifyType	Specifies the structure of the returned renewal type.
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 Querying Instance Resizing Types Example

Input Example

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

{
    "InstanceId": "ckafka-6er88krk",
    "BandWidth": 320,
    "DiskSize": 1000,
    "DiskType": "CLOUD_PREMIUM",
    "Partition": 1200,
    "Topic": 120,
    "Type": "sp_ckafka_profession"
}

Output Example

{
    "Response": {
        "Result": {
            "ModifyType": 1,
            "MigrateFlag": true,
            "MigrateCostTime": 17066
        },
        "RequestId": "7118b7f95-43de-4d27-8sdadsa-9999999a"
    }
}

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
AuthFailure	CAM signature/authentication error.
DryRunOperation	DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful.
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
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.
LimitExceeded	The quota limit has been reached.
LimitExceeded.RouteOverLimit	The number of routes exceeds the limit.
LimitExceeded.RouteSASLOverLimit	SASL route exceeds the limit.
MissingParameter	Missing parameter
OperationDenied	Operation denied.
RequestLimitExceeded	The number of requests exceeds the frequency limit.
ResourceInUse	The resource is occupied.
ResourceInsufficient	Insufficient resources.
ResourceNotFound	The resource does not exist.
ResourceUnavailable	The resource is unavailable.
ResourcesSoldOut	Resources are sold out.
UnauthorizedOperation	Unauthorized operation.
UnknownParameter	Unknown parameter error.
UnsupportedOperation	Unsupported operation.
UnsupportedOperation.BatchDelInstanceLimit	The batch instance deletion limit is reached.
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