一、公共参数
1.1 请求地址
1.2 公共请求参数
参数 |
类型 |
是否必须 |
最大长度 |
描述 |
示例值 |
access_key_id |
int |
是 |
10 |
龙猫分配给开发者的应用ID |
10005 |
method |
string |
是 |
128 |
接口名称 |
固定值: longmao.tags.upload |
format |
string |
是 |
40 |
仅支持JSON |
固定值: JSON |
timestamp |
string |
是 |
19 |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
2019-11-11 00:00:00 |
version |
string |
是 |
10 |
调用的接口版本, 固定值: 1.0 |
1.0 |
sign |
string |
否 |
32 |
请求参数的签名串,详见签名 |
详见示例 |
二、请求参数
参数 |
类型 |
是否必须 |
最大长度 |
描述 |
示例值 |
title |
string |
是 |
100 |
csv文件描述 |
201911110001 |
url |
string |
是 |
255 |
csv文件链接地址 |
https://xxx/xxx/1.csv |
三、公共响应参数
参数 |
类型 |
是否必须 |
最大长度 |
描述 |
示例值 |
code |
string |
是 |
20 |
返回码 |
200 |
message |
string |
是 |
255 |
错误描述信息 |
请求成功 |
四、响应参数
参数 |
类型 |
是否必须 |
最大长度 |
描述 |
示例值 |
task_id |
string |
是 |
32 |
任务ID |
b2f3b1455262fe984082938f562820b6 |
五、响应示例
{
"code":"200",
"message":"",
"object":{
"task_id": "b2f3b1455262fe984082938f562820b6"
}
}
六、SDK调用示例
6.1 JavaSDK调用示例
@Test
public void test() {
LongMaoCredentials credentials = new LongMaoCredentials("100002", "xxxx");
LongMaoClient client = new DefaultLongMaoClient("https://xxx/gateway.do", credentials);
TagsUploadDataCsvRequest request = new TagsUploadDataCsvRequest();
request.setTitle("20191111");
request.setUrl("https://xxx/xxx/1.csv");
TagsUploadDataCsvResponse response = client.request(request);
System.out.println(response.getCode() + ":" + response.getMessage());
}
6.2 PythonSDK调用示例
import json
import logging
from longmao.api.tags.ApiTagsUploadCsv import ApiTagsUploadCsv
from longmao.core.DefaultLongMaoClient import DefaultLongMaoClient
from longmao.core.LongMaoClientConfig import LongMaoClientConfig
longmao_client_config = LongMaoClientConfig()
longmao_client_config.domain = 'https://xxx/gateway.do'
longmao_client_config.access_key_id = '100002'
longmao_client_config.access_key_secret = 'xxxx'
logging.basicConfig(
level=logging.INFO,
format='%(asctime)s %(levelname)s %(message)s',
filemode='a',)
logger = logging.getLogger('')
client = DefaultLongMaoClient(longmao_client_config, logger)
api = ApiTagsUploadCsv()
api.title = '20191111'
api.url = 'https://xxx/xxx/1.csv'
result = client.execute(api)
print(json.dumps(result, ensure_ascii=False, encoding='utf-8'))
七、业务错误码
错误码 |
错误描述 |
解决方案 |
200 |
成功 |
|
400 |
参数校验失败 |
请查看具体失败描述信息 |
400001 |
access_key_id是必传参数 |
请检查请求参数 |
400002 |
access_key_id参数无效 |
检查参数,格式不对、非法值、越界等 |
400003 |
method是必传参数 |
请检查请求参数 |
400004 |
method参数无效 |
检查参数,格式不对、非法值、越界等 |
400005 |
format参数无效 |
检查参数,格式不对、非法值、越界等 |
400006 |
timestamp是必传参数 |
检查参数,格式不对、非法值、越界等 |
400007 |
timestamp参数无效 |
检查参数,格式不对、非法值、越界等 |
400008 |
version参数无效 |
检查参数,格式不对、非法值、越界等 |
400009 |
错误的签名(sign) |
查看签名文档 |
500 |
系统异常 |
请联系龙猫人员处理 |
504 |
接口正在升级 |
请稍候重试 |
501001 |
第N行,数据格式错误 |
检查数据格式,参考:CSV格式 |