Modifying a Combined Task
Function
Modify a combined task.
URI
PUT /v2/{project_id}/fdi/instances/{instance_id}/multi-tasks/{task_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference. Minimum: 1 Maximum: 64 |
instance_id |
Yes |
String |
Instance ID. Minimum: 1 Maximum: 64 |
task_id |
Yes |
String |
Task ID, the unique identifier of a task. Minimum: 1 Maximum: 64 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
description |
No |
String |
Description. Minimum: 1 Maximum: 1024 |
task_tag |
No |
String |
Task tag, which can contain only letters, digits, hyphens (-), and underscores (_). Minimum: 4 Maximum: 64 |
operation_types |
Yes |
Array of strings |
Operation type to be supported. You can select multiple operation types. At least one of the following operation types must be selected:
|
repulling_snapshot |
Yes |
Boolean |
Whether to synchronize existing data. This parameter is valid only when you edit a task. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Task ID. This parameter can be left empty. Minimum: 1 Maximum: 64 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Example Requests
{ "description" : "test", "task_tag" : "combinationaa", "operation_types" : [ "INSERT", "UPDATE" ], "repulling_snapshot" : true }
Example Responses
Status code: 400
Bad Request
{ "error_code" : "FDI.3021", "error_msg" : "One or more tasks do not exist." }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
404 |
Not Found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot