1. 接口描述
接口请求域名: yunsou.tencentcloudapi.com 。
上传云搜数据的API接口
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DataManipulation |
Version | 是 | String | 公共参数,本接口取值:2018-05-04 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
OpType | 是 | String | 操作类型,add或del |
Encoding | 是 | String | 数据编码类型 |
Contents | 是 | String | 数据 |
ResourceId | 是 | Integer | 应用Id |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RetMsg | String | 返回信息 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 数据上传
通过API往云搜实例上传数据.
其中Contents内容说明如下:
- 应用结构定义中的所有字段都必须出现, 如果是空字段, 则传"";
- 数字都要用引号引起来, 但里面内容必须是数字;
- 主键相同的多次上传, 以最后一次上传的内容为准.
以下输入示例中Contents的内容编码前为:
[{"NC":"9999","TD" : "中文","NA" : "1000","NB" : "9999","TA" : "中文","TB" : "abcde","TC" : "中文","TE":"tttteeee","TF":"efeefe","countrycode":"cn","renderType":"rrr"}]
输入示例
https://yunsou.tencentcloudapi.com/?Action=DataManipulation
&Contents=%5B%7B%22NC%22%3A%229999%22%2C%22TD%22+%3A+%22%E4%B8%AD%E6%96%87%22%2C%22NA%22+%3A+%221000%22%2C%22NB%22+%3A+%229999%22%2C%22TA%22+%3A+%22%E4%B8%AD%E6%96%87%22%2C%22TB%22+%3A+%22abcde%22%2C%22TC%22+%3A+%22%E4%B8%AD%E6%96%87%22%2C%22TE%22%3A%22tttteeee%22%2C%22TF%22%3A%22efeefe%22%2C%22countrycode%22%3A%22cn%22%2C%22renderType%22%3A%22rrr%22%7D%5D
&Encoding=utf8
&OpType=add
&ResourceId=76340002
&<公共请求参数>
输出示例
{
"Response": {
"RetMsg": "{\"data\":{\"app_id\":76340002,\"seq\":1561028398,\"total_result\":\"succ\",\"result\":[{\"result\":\"succ\",\"doc_id\":\"1000\",\"errno\":0}]},\"retcode\":0,\"retmsg\":\"succ\"}",
"RequestId": "981604f6-c5c5-4b0c-8f35-a782543f90bf"
}
}
示例2 数据删除
通过API删除云搜的某条数据(通过doc_id指定, 即应用结构中主键的值)
以下示例中Contents的内容编码前为:
[{"doc_id":"1000"}]
输入示例
https://yunsou.tencentcloudapi.com/?Action=DataManipulation
&Contents=%5B%7B%22doc_id%22%3A%221000%22%7D%5D
&Encoding=utf8
&OpType=del
&ResourceId=76340002
&<公共请求参数>
输出示例
{
"Response": {
"RetMsg": "{\"data\":{\"app_id\":76340002,\"seq\":1561028364,\"total_result\":\"succ\",\"result\":[{\"result\":\"succ\",\"doc_id\":\"1000\",\"errno\":0}]},\"retcode\":0,\"retmsg\":\"succ\"}",
"RequestId": "4bbad2a0-0f76-42ca-8c13-b366bd88332f"
}
}
5. 开发者资源
API Explorer
该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。