1. 接口描述
本接口(GetMongoDBJobInfo)用于查询任务执行情况
接口请求域名:mongodb.api.qcloud.com
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为GetMongoDBJobInfo。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
jobId | 是 | String | 执行任务时返回的任务ID |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码,0表示成功,其他值表示失败。详见错误码页面的公共错误码。 |
message | String | 错误信息描述, 成功时,该值为空 |
codeDesc | String | 业务侧错误码英文描述。成功时返回Success,错误时返回具体业务错误原因。 |
data | Object | 任务执行结果 |
其中,data 表示任务执行结果,其参数构成如下:
参数名称 | 类型 | 描述 |
---|---|---|
data.status | Int | 任务状态,0:待执行,1:执行中,2:成功,3:失败,-1 执行出错 |
4. 错误码
以下错误码表列出了该接口的业务逻辑错误码。
错误代码 | 英文提示 | 错误描述 |
---|---|---|
11050 | InvalidParameter | 业务参数错误 |
5. 示例
https://mongodb.api.qcloud.com/v2/index.php?Action=GetMongoDBJobInfo &<公共请求参数> &jobId=11963
返回示例如下:
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"status": 2
}
}