更新时间:2023-09-18 13:55:55
对于所有的API接口,以json格式为例,返回如下格式的内容
成功时返回
参数名 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | int | 是 | 200,表示请求成功 |
message | string | 是 | 请求成功 |
data | obj | 否 | 请求成功时返回的数据,如果请求失败,该字段为空 |
例如:
{
"code": 200,
"message": "操作成功",
"data": {
"taskId": "b123456789012345678912",
"transNo": "a123456789012345678912"
}
}
失败时返回
参数名 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | int | 是 | 请求失败错误响应码 |
message | string | 是 | 请求失败提示信息 |
例如:
{
"code": 1000,
"message": "参数错误"
}
同时在响应的头部中返回服务端生成唯一请求标识
参数名 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X-WS-RequestId | string | 是 | 请求唯一标识,用于方便问题排查 |
例如
Response Headers
X-WS-RequestId: 3728d44912a711e4348190e221012d52
错误码 | 描述 |
---|---|
200 | 操作成功 |
300 | 操作失败,请联系管理员 |
900 | 系统异常 |
1000 | 参数错误 |
1001 | token错误 |
1002 | timeStamp,token,userId都不能为空 |
1003 | userId输入有误 |
1004 | 参数错误,请确保所有必填项都已经填写 |
1006 | 请求方式错误 |
1008 | 无权限请求点播api |
1010 | 请传入正确的timeStamp |
1011 | timeStamp超过5分钟有效期,请重新传入 |
1012 | 参数值超出合法范围 |
1013 | 非法的format参数 |
4001 | 鉴权参数错误,请检查所有必填参数是否都有传值 |
4002 | X-WS-AccessKey参数错误,请检查该key是否存在,是否少复制了字符或者多了字符 |
4003 | X-WS-Timestamp参数错误,时间格式为秒级时间戳 |
4004 | X-WS-Timestamp过期,与服务器接收到请求的时间相差不得超过五分钟 |
4005 | host参数错误,请检查 |
4006 | content-type参数错误,请检查 |
4007 | 鉴权失败,请检查参数是否正确 |
4008 | 鉴权失败,请检查签名计算是否错误,或者签名与实际发送的内容不相符合,也有可能是密钥secretKey错误导致的 |
4009 | 签名已被使用,请重新生成鉴权参数 |
4021 | API鉴权参数错误 |
4022 | API鉴权操作失败 |