跳到主要内容

更新指定文本名单的属性

1. 请求

1.1 请求地址

区域请求地址
国内https://api.open.tuputech.com/v3/management/thesaurus/update/<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 格式私钥
  • 点击 签名及验证示例 查看签名示例
thesaurusIdString文本名单 ID
nameString文本名单库名称
labelString文本名单一级标签, ,详见 label 说明
subLabelString文本名单一级标签, 英文
statusString状态, 其中开启为 0, 关闭为 1, 默认为开启
secretIdsArray<String>1. 当请求中没有该字段时,不修改名单库绑定的应用(SID);
2. 不支持解绑当前 secretId,即传入一个空的数组时,不修改名单库绑定的应用(SID);
3. 当传入一个不包含当前 secretId 的数组时,自动填充当前应用(SID);
4. 不支持绑定未开启的应用(SID)

1.5 请求示例

{
"timestamp": "<timestamp>",
"nonce": "<nonce>",
"signature": "<signature>",
"thesaurusId": "<thesaurusId>",
"label": "ADs"
}

2. 响应

2.1 响应内容

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

2.2 响应参数

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

Thesaurus 结果说明

参数名称类型是否可能为空说明
codeNumber状态码,标识该文本名单库是否成功更新,详见公共服务状态码
errorString错误原因
nameString文本名单库名称
nameString文本名单名称
labelString文本名单一级标签
subLabelString文本名单二级标签
statusString状态
secretIdsArray<String>绑定的应用 (SID)

2.3 响应示例

{
"json": "{\"code\":0,\"message\":\"success\",\"nonce\":0.15634935255278337,\"thesaurus\":{\"name\":\"xxx\",\"label\":\"ADs\",\"subLabel\":\"xxxx\",\"secretIds\":[\"xxxx\"]},\"timestamp\":1672132071}",
"signature": "Im1agAngnCEvXv+aOaoRKs+TTv55Y/e7nIa6sC/0FXaliYIBJreX5q2a3V0NidanNf7ZLS+IvMAnT3pfkKAxMDYr98Ue1YUNIQh8msOyKfio8dmDWEnNNuLFzwGfmNUXWOsvN9sn7ks57Z6kc+6nUa1QIyLHY17DXQZl5AhGTHg="
}