1. 接口描述
接口请求域名: yunsou.tencentcloudapi.com 。
上传云搜数据的API接口。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DataManipulation。 |
Version | 是 | String | 公共参数,本接口取值:2019-11-15。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
OpType | 是 | String | 操作类型,add或del |
Encoding | 是 | String | 数据编码类型 |
Contents | 是 | String | 数据 |
ResourceId | 是 | Integer | 应用Id |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | DataManipulationResult | 数据操作结果 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 数据上传接口
通过API往云搜实例上传数据。
其中Contents内容说明如下:
- 应用结构定义中的所有字段都必须出现, 如果是空字段, 则传"";
- 数字都要用引号引起来, 但里面内容必须是数字;
- 主键相同的多次上传, 以最后一次上传的内容为准.
以下输入示例中Contents的内容URL编码前为:
[{"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
&OpType=add
&Encoding=utf8
&ResourceId=80680002
&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
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "b65234af-9eb4-4e4d-a25e-d5b32c189545",
"Data": {
"AppId": 80680002,
"Seq": 1574405237,
"TotalResult": "succ",
"Result": [
{
"Result": "succ",
"DocId": "122",
"Errno": 0
}
]
}
}
}
示例2 数据删除接口
通过API删除云搜的某条数据(通过doc_id指定,即应用结构中主键的值)。
以下示例中Contents的内容URL编码前为:
[{"doc_id":"1000"}]
输入示例
https://yunsou.tencentcloudapi.com/?Action=DataManipulation
&OpType=del
&Encoding=utf8
&ResourceId=80680002
&Contents=%5B%7B%22doc_id%22%3A%221000%22%7D%5D
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "b65234af-9eb4-4e4d-a25e-d5b32c189545",
"Data": {
"AppId": 80680002,
"Seq": 1575441376,
"TotalResult": "succ",
"Result": [
{
"Result": "succ",
"DocId": "1000",
"Errno": 0
}
],
"ErrorResult": ""
}
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.AccountInfo | 查询用户信息失败。 |
FailedOperation.AppInfo | 查询应用信息失败。 |
FailedOperation.Search | 搜索接口异常。 |
FailedOperation.UploadDataApiFail | 数据上传异常。 |
InvalidParameter | 参数错误。 |
InvalidParameter.DataContent | 数据文件无效。 |
LimitExceeded.Search | 请求的次数超过了频率限制。 |
UnauthorizedOperation | 未授权操作。 |