ModifySyncTaskAttribute

Last updated: 2021-12-01 10:57:56

1. API Description

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

This API is used to modify sync task attributes (currently, only the task name can be modified).

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 parameter. The value used for this API: ModifySyncTaskAttribute.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
TaskIds.N Yes Array of String IDs of tasks for which to modify the attributes. The IDs can be obtained by the return value of the DescribeSyncTasks API. Up to 100 tasks can be operated at a time.
TaskName No String Task name. You can specify any name you like, but its length cannot exceed 100 characters.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample 1. Renaming a task

Input Example

https://mariadb.tencentcloudapi.com/?Action=ModifySyncTaskAttribute
&TaskIds.0=1001
&TaskName=Data analysis sync task
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "7f642839-f40d-4faf-8d84-be7894ce048a"
  }
}

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.OperateDatabaseFailed Database operation failed.
ResourceNotFound.SyncTaskDeleted The sync task has been deleted.