名称 | 描述 | 类型 | 需要 | 默认 |
---|---|---|---|---|
Accept-Language |
返回数据中使用的首选语言代码。如果指定语言的翻译本不可用,则默认为英语可通过查询参数query或使用Accept-Language头来应用。
en —— 英语 zh —— 中文 ru —— 俄语 id —— 印尼语 jp —— 日语
Accepted Values: [
en ,zh ,ru ,id ,jp ]
|
String | en | |
Accept |
Response data format. Default is application/json . Can be used through the query parameter format or using the header Accept .
Accepted Values: [
application/json ,application/xml ]
|
String | json |
名称 | 描述 | 类型 | 需要 | 默认 |
---|---|---|---|---|
lang |
返回数据中将使用的首选语言代码。如果指定语言的翻译本不可用,则默认为英语可通过查询参数query或使用Accept-Language头来应用。
en—— 英语 zh—— 中文 ru—— 俄语 id—— 印尼语 jp—— 日语
Accepted Values: [
en ,zh ,ru ,id ,jp ]
|
String | en | |
format |
Response data format. Default is json . Can be used through the query parameter format or using the header Accept .
Accepted Values: [
json ,xml ]
|
String | json | |
token | 访问API密钥。可通过查询参数token或使用Authorization头来使用 | String | ||
with_model_information | 如果设置为True,则返回作为响应部分的模型名称 | Boolean | false |
名称 | 描述 | 类型 | 需要 | 默认 |
---|---|---|---|---|
name | 新记录的名称。最大长度100 | String | ||
description | 新记录的描述。最大长度1000 | String | ||
filter_id | 筛选器ID | String | ||
consolidation |
合并方法
Accepted Values: [
zip ,single ,singlezip ]
|
String | zip | |
delivery |
传输方法
Accepted Values: [
web ,ceicftp ,userftp ]
|
String | web | |
user_ftp_url | 本地FTP服务器的结果传输URL。仅在选择localftp传输方法时有效。 | String | ||
user_ftp_path | 本地FTP服务器的结果传输路径。仅在选择localftp传输方法时有效。 | String | /ceic_data_dumps/ | |
user_ftp_username | 本地FTP服务器的用户名。仅在选择localftp传输方法时有效。 | String | ||
user_ftp_password | 本地FTP服务器的密码。仅在选择localftp传输方法并且指定了local_ftp_username时有效。 | String | ||
notification_email | 设置后,用户将通过指定的电子邮件地址接收通知。可以设置多个用逗号分隔的电子邮件地址。 | String | ||
notification_url | 转存完成时推送通知消息的URL。 | String | ||
notification_http_method |
推送通知消息的HTTP方法。
Accepted Values: [
GET ,POST ]
|
String | GET |
All API calls have response size limit of 10MB! If you are planning to request a bulky item collection, please consider using the corresponding API request parameters to limit your response.
状态码 | 描述 | 类型 |
---|---|---|
201 | 转存创建过程已开始 | DumpResult |
400 | 输入参数不正确 | BadRequest |
401 | 授权错误。 | AuthorizationError |
403 | 用户权限不正确。 | PermissionsError |
404 | 找不到请求的实体。 | NotFound |
415 | 不支持的数据格式。仅支持Only json、xml、csv。 | UnsupportedMedia |
429 | Too many requests were send or limit exceeded. | TooManyRequests |
500 | 内部服务器错误。 | InternalError |