Updated on 2022-08-02 GMT+08:00

Stopping a Migration Task

Function

This API is used to stop a migration task based on a specified ID.

URI

POST /v1/sms/tasks/{id}/action

For details about the parameter, see Table 1.
Table 1 Parameter description

Parameter

Mandatory

Description

id

Yes

Task ID. For details, see the returned ID in Creating a Migration Task.

Request

Request parameters

For details about the request parameter, see Table 2.

Table 2 Request parameter

Parameter

Mandatory

Type

Description

operation

Yes

String

The value is fixed at stop when a task is stopped.

Response

None

Example

  • Example request
    { 
      "operation":"stop"
    } 
  • Example response

    None

Status Codes

See Status Codes.