Help Center/ Elastic Cloud Server/ API Reference/ Common Parameters/ Job Request Results/ Responses (Jobs)
Updated on 2025-10-22 GMT+08:00
View PDF

Responses (Jobs)

  • Normal response description

    Parameter

    Type

    Description

    job_id

    String

    Specifies the returned job ID after delivering the job. Users can query the job progress using this ID. For details about how to query the job execution status based on job_id, see Job 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.
    Table 2 details field description

    Parameter

    Type

    Description

    message

    String

    Describes the error message when an error occurs.

    code

    String

    Specifies the error code when an error occurs.
  • 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: Job Request Results