All Products
Search

This Product

    CloudFlow:ReportTaskFailed

    Document Center

    CloudFlow:ReportTaskFailed

    Last Updated:Aug 22, 2024

    Reports a failed task.

    Operation description

    Usage notes

    In the previous service (Serverless Workflow), the task step that ReportTaskFailed is used to call back pattern: waitForCallback indicates that the current task fails to be executed.

    In the new service (CloudFlow), the task step that ReportTaskFailed is used to call back TaskMode: WaitForCustomCallback indicates that the current task fails to be executed.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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
    fnf:ReportTaskFailedget
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    TaskTokenstringYes

    The token of the task whose execution you want to report. The task token is passed to the called service, such as Message Service (MNS) or Function Compute. For MNS, the value of this parameter can be obtained from a message. For Function Compute, the value of this parameter can be obtained from an event. For more information, see Service integration modes.

    		emptyString
    ErrorstringYes

    The error code for the failed task. The error code must be 1 to 128 characters in length.

    		nill
    CausestringNo

    The cause of the failure. The value must be 1 to 4,096 characters in length.

    		emptyString

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    EventIdlong

    The ID of the event.

    		1
    RequestIdstring

    The request ID.

    		testRequestId

    Examples

    Sample success responses

    JSONformat

    {
  "EventId": 1,
  "RequestId": "testRequestId"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ActionNotSupportedThe requested API operation '%s' is incorrect. Please check.-
    400APIVersionNotSupportedThe requested API version '%s' is not supported yet. Please check.-
    400EntityTooLargeThe payload size exceeds maximum allowed size (%s bytes).The payload size exceeds maximum allowed size (%s bytes).
    400InvalidArgumentParameter error.Parameter error.
    400MissingRequiredHeaderThe HTTP header '%s' must be specified.The HTTP header '%s' must be specified.
    400MissingRequiredParamsThe HTTP query '%s' must be specified.The HTTP query '%s' must be specified.
    400TaskAlreadyCompletedTask %s has already completed.Task %s has already completed.
    403AccessDeniedThe resources doesn't belong to you.-
    403InvalidAccessKeyIDThe AccessKey ID %s is invalid.The AccessKey ID %s is invalid.
    403RequestTimeTooSkewedThe difference between the request time %s and the current time %s is too large.The difference between the request time %s and the current time %s is too large.
    403SignatureNotMatchThe request signature we calculated does not match the signature you provided. Check your access key and signing method.The calculated signature of the request does not match the signature you provided. Check your AccessKey Secret and signing algorithm.
    409TaskInvalidStateTask is in an invalid state, please retry.Task is in an invalid state, please retry.
    415UnsupportedMediaTypeThe content type must be "application/json".The content type must be "application/json".
    429ResourceThrottledThe request is throttled. Please try again later.The request is throttled. Please try again later.
    500InternalServerErrorAn internal error has occurred. Please retry.An internal error has occurred. Please retry.

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

    Change history

    Change timeSummary of changesOperation
    2024-03-21The Error code has changed. The request parameters of the API has changedView Change Details