1. API Description
Domain name for API request: ckafka.intl.tencentcloudapi.com.
This API is used to add a partition in a topic.
A maximum of 100 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.
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: CreatePartition. |
| 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 |
The ckafka cluster instance Id, which can be obtained through the DescribeInstances api. |
| TopicName |
Yes |
String |
Specifies the topic name, which can be obtained through the DescribeTopic api. |
| PartitionNum |
Yes |
Integer |
Topic partition count. the input parameter is the number of partitions after modification rather than adding partitions. therefore, the input parameter must exceed the current topic partition count. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Result |
JgwOperateResponse |
Returned result set |
| 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 Increasing Topic Partitions
https:
&InstanceId=ckafka-test
&TopicName=mytopic
&PartitionNum=3
&<Common request parameters>
Output Example
{
"Response": {
"Result": {
"ReturnCode": "0",
"ReturnMessage": "ok[apply success]",
"Data": null
},
"RequestId": "483c3edd-a2ac-420c-905d-47a5ec7de4ad"
}
}
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 |
Operation failed. |
| InternalError |
Internal error. |
| InvalidParameter |
Invalid parameter. |
| InvalidParameterValue.InstanceNotExist |
The instance does not exist. |
| 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. |
| ResourceUnavailable |
The resource is unavailable. |
| UnauthorizedOperation |
Unauthorized operation. |
| UnsupportedOperation.BatchDelInstanceLimit |
The batch instance deletion limit is reached. |
| UnsupportedOperation.OssReject |
Oss rejected the operation. |