更新时间:2023-07-27 GMT+08:00
分享

响应(任务类)

  • 正常响应要素说明

    名称

    参数类型

    说明

    job_id

    String

    提交任务成功后返回的任务ID,用户可以使用该ID对任务执行情况进行查询。如何根据job_id来查询Job的执行状态,请参考查询Job状态

  • 异常响应要素说明

    名称

    参数类型

    说明

    error

    Object

    提交任务异常时返回的异常信息,详情请参见表1

    表1 error数据结构

    名称

    参数类型

    说明

    message

    String

    任务异常错误信息描述。

    code

    String

    任务异常错误信息编码。

    details

    Array of objects

    任务异常时错误详情。

    该信息主要包含任务异常时的细化错误编码和错误描述信息,便于使用本服务API的客户端应用代码处理错误。

    该字段属于非必选字段。

    表2 details数据结构

    名称

    参数类型

    说明

    message

    String

    任务异常错误信息描述。

    该字段属于非必选字段。

    code

    String

    任务异常错误信息编码。

    该字段属于非必选字段。

  • 响应示例

    正常响应:

    { 
        "job_id": "ff80808288d41e1b018990260955686a"
    } 

    异常响应:

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

    包含错误详情的异常响应:

    {
        "error": {
            "message": "xxxx",
            "code": "xxxx",
            "details": [
                {
                    "code": "xxxx",
                    "message": "xxxx"
                }
            ]
        }
    }
分享:

    相关文档

    相关产品