Help Center/ Elastic Cloud Server/ API Reference/ Common Parameters/ Task Request Result/ Responses (Task)
Updated on 2023-08-03 GMT+08:00
View PDF
Share

Responses (Task)

  • Normal response description

    Parameter

    Type

    Description

    job_id

    String

    Specifies the returned task ID after delivering the task. Users can query the task progress using this ID. For how to query the execution status of the task based on the task ID, see Task Status Management.
  • Abnormal response description

    Parameter

    Type

    Description

    error

    Object

    Specifies the returned error message when an error occurs. For details, see Table 1.
    Table 1 error field structure

    Parameter

    Type

    Description

    message

    String

    Describes the error message when an error occurs.

    code

    String

    Specifies the error code when an error occurs.

    details

    Array of objects

    Specifies error details.

    Error details provide the error code and fault description, facilitating error handling.

    This field is optional.
    Table 2 details field description

    Parameter

    Type

    Description

    message

    String

    Describes the error message when an error occurs.

    This field is optional.

    code

    String

    Specifies the error code when an error occurs.

    This field is optional.
  • Example response

    Normal response

    { 
    "job_id": "ff80808288d41e1b018990260955686a"
}

    Abnormal response

    { 
    "error": {"message": "", "code": XXX,""}
}

    Abnormal response containing error details:

    {
    "error": {
        "message": "xxxx",
        "code": "xxxx",
        "details": [
            {
                "code": "xxxx",
                "message": "xxxx"
            }
        ]
    }
}
Parent topic: Task Request Result