跳到主要内容

词条/应用关联的名单信息查询

1. 请求

1.1 请求地址

区域请求地址
国内https://api.open.tuputech.com/v3/management/thesaurus/search/<secretId>
提示

<secretId> 需替换为您的应用 SID,请联系客户经理为您开通及配置。关于 SID 详见 常见问题(FAQ)

1.2 请求方法

POST

1.3 请求头

Content-Type: application/json

1.4 请求参数

参数名称类型是否必需说明
timestampNumber当前服务器的 Unix 时间戳,可以是毫秒或秒级。
nonceNumber随机数
signatureString

RSA-SHA256 算法签名。签名步骤:

  1. 将参与签名的参数(secretIdtimestampnonce)用英文半角逗号 , 拼接,得到 SignString
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名,然后进行 Base64 编码,得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsapkcs8 两种格式,通常 Golang,Python 使用 rsa 格式私钥,Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例
contentString文本内容
isFuzzySearchBoolean是否模糊搜索, 默认为 false

1.5 请求示例

{
"timestamp": "<timestamp>",
"nonce": "<nonce>",
"signature": "<signature>",
"content": "<content>",
"isFuzzySearch": false
}

2. 响应

2.1 响应内容

参数名称类型说明
jsonString响应内容 JSON 转义后的字符串
signatureString响应内容签名

2.2 响应参数

参数名称类型是否可能为空说明
codeNumber状态码
nonceNumber随机数
messageString相关信息
timestampNumber时间戳
thesaurusesArray<Thesaurus>名单信息,详见 thesaurus 参数说明

Thesaurus 参数说明

参数名称类型是否可能为空说明
idString文本名单 ID
nameString文本名单名称
labelString文本名单一级标签
subLabelString文本名单二级标签
statusNumber文本名单状态
secretIdsArray<String>生效应用
keywordsNumber文本名单词条数量

2.3 响应示例

{
"json": "{\"code\":0,\"thesauruses\":[{\"id\":\"xxxxxx\",\"name\":\"文本名单测试\",\"label\":\"Sensitive\",\"subLabel\":\"\",\"status\":0,\"secretIds\":[\"xxxx\",\"yyyy\"],\"keywords\":172}],\"message\":\"success\",\"nonce\":0.65333554465516,\"timestamp\":1669602627}",
"signature": "iq72eJlFhYrbMJQxwPOG9my9kGSAVZnnW5GeH8kTOUaxj1sn0J2nDMSBi/5EnOU6nhUm2sgEWEoR4C/Oou4CD3++jV4BYfg/wAq5Vs953IaPJESGt+k9bgkxtijlYhKWyMtWecl41A9JkQAt+Vh2I7JxCy5n5/MRfRlqw49XSac="
}