ModifyRoutineMaintenanceTask

Last updated:2026-01-13 21:46:01

ModifyRoutineMaintenanceTask

Last updated: 2026-01-13 21:46:01

1. API Description

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

This API is used to set automated ops attributes.

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: ModifyRoutineMaintenanceTask.
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	Specifies the ckafka cluster instance id. can be obtained through the DescribeInstances api.
MaintenanceType	Yes	String	Automated operation and maintenance category. valid values: QUOTA, ANALYSIS, RE_BALANCE, ELASTIC_BANDWIDTH.
MaintenanceSubtype	Yes	String	INSTANCE_STORAGE_CAPACITY (automatic disk scale-out)/MESSAGE_RETENTION_PERIOD (dynamic MESSAGE RETENTION policy).
TopicName	No	String	Topic name
ConfigureThreshold	No	Integer	Task trigger threshold.
ConfigureStepSize	No	Integer	Specifies the step length for task adjustment.
ConfigureLimit	No	Integer	Task adjustment upper limit.
PlannedTime	No	Integer	Specifies the expected trigger time of the task, storing the offset in seconds from 0 AM of the current day.
ExtraConfig	No	String	Additional task information.
Status	No	Integer	Task status. 0: enabled, 1: disabled.
Week	No	String	Specifies the day of the week.

3. Output Parameters

Parameter Name	Type	Description
Result	JgwOperateResponse	Returned results.
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 Setting Instance Attributes

Input Example

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

{
    "InstanceId": "ckafka-9jnejnb9",
    "MaintenanceType": "RE_BALANCE",
    "MaintenanceSubtype": "INSTANCE_PARTITION_RE_BALANCE",
    "PlannedTime": 79200,
    "Status": 1,
    "Week": "1,2,3,4,5,6,7"
}

Output Example

{
    "Response": {
        "Result": {
            "ReturnCode": "0",
            "ReturnMessage": "success",
            "Data": {
                "FlowId": 0,
                "RouteDTO": {
                    "RouteId": 0
                }
            }
        },
        "RequestId": "fcfb7c89-3973-44f1-9a3e-a2811c67434e"
    }
}

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.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.
ResourceUnavailable	The resource is unavailable.
UnauthorizedOperation	Unauthorized 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