All Products
Search

This Product

    Cloud Parallel File Storage:CancelDataFlowSubTask

    Document Center

    Cloud Parallel File Storage:CancelDataFlowSubTask

    Last Updated:Dec 11, 2024

    Cancels a data streaming task.

    Operation description

    • Only Cloud Parallel File Storage (CPFS) for LINGJUN V2.6.0 and later support this operation. You can view the version information on the file system details page in the console.
    • You can cancel a data streaming task only when the task is in the CREATED or RUNNING state.
    • Data streaming tasks are executed asynchronously. You can call the DescribeDataFlowSubTasks operation to query the task execution status.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    nas:CancelDataFlowSubTaskupdate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    FileSystemIdstringYes

    The ID of the file system.

    		bmcpfs-370lx1ev9ss27o0****
    DataFlowIdstringYes

    The ID of the data flow.

    		df-194433a5be31****
    DataFlowTaskIdstringYes

    The ID of the data flow task.

    		task-38aa8e890f45****
    DryRunbooleanNo

    Specifies whether to perform a dry run.

    During the dry run, the system checks whether the request parameters are valid and whether the requested resources are available. During the dry run, no data streaming task is created and no fee is incurred.

    Valid values:

    • true: performs a dry run. The system checks the required parameters, request syntax, service limits, and available File Storage NAS (NAS) resources. If the request fails the dry run, an error message is returned. If the request passes the dry run, the HTTP status code 200 is returned.
    • false (default): performs a dry run and sends the request. If the request passes the dry run, a data streaming task is created.
    		false
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.

    The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How do I ensure the idempotence?

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		123e4567-e89b-12d3-a456-42665544****
    DataFlowSubTaskIdstringYes

    The ID of the data streaming task.

    		subTaskId-370kyfmyknxcyzw****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalCharactersThe parameter contains illegal characters.The parameter contains illegal characters.
    400MissingFileSystemIdFileSystemId is mandatory for this action.-
    400MissingDataFlowIdDataFlowId is mandatory for this action.-
    400MissingTaskIdTaskId is mandatory for this action.-
    403OperationDenied.ConflictOperationThe operation is denied due to a conflict with an ongoing operation.-
    403OperationDenied.DependencyViolationThe operation is denied due to dependancy violation.-
    403OperationDenied.DataFlowNotSupportedThe operation is not supported.-
    404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.
    404InvalidDataFlow.NotFoundThe specified data flow does not exist.-
    404InvalidTaskId.NotFoundThe specified task ID does not exist.-

    For a list of error codes, visit the Service error codes.