跳到主要内容

更新指定图片名单的属性

1. 请求

1.1 请求地址

区域请求地址
国内https://api.open.tuputech.com/v3/management/image-library/update/<secretId>
提示

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

1.2 请求方法

POST

1.3 请求头

Content-Type: application/json

1.4 请求参数

参数名称类型是否必需说明
timestampInt当前服务器的 Unix 时间戳,可以是毫秒或秒级。
nonceFloat随机数(建议使用 Unix 时间戳或若干位随机整数)
signatureString

RSA-SHA256 算法签名。

当前已废弃,仅保持兼容(采用该鉴权方式的调用不受影响)。新接入请使用 API Key 接口鉴权。

签名步骤:

  1. 将参与签名的参数(secretIdtimestampnonce)用英文半角逗号 , 拼接,得到 SignString
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名,然后进行 Base64 编码,得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsapkcs8 两种格式,通常 Golang,Python 使用 rsa 格式私钥,Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例
imageLibraryIdString图片名单 ID
nameString图片名单库名称, 当请求中没有该字段时,不修改图片名单库状态
typeInt图片名单类型(黑、白名单),其中黑名单为 0, 白名单为 1,当请求中没有该字段时,不修改图片名单库状态
statusInt状态, 其中开启为 0,关闭为 1,当请求中没有该字段时,不修改图片名单库状态
thresholdInt阈值, 范围 (0,1],当请求中没有该字段时,不修改图片名单库状态
secretIdsArray<String>名单绑定的应用(SID)数组。

说明:
1. 当该字段不存在(或值为 null/nil)时,不修改名单库绑定的应用;
2. 当该字段不包含当前应用(或值为空数组 [ ])时,自动填充当前应用;
3. 当该字段包含未启用状态的应用时,接口返回参数错误;
4. 该字段中的文本/语音类型应用会被忽略;
5. 若需要禁用当前应用,请关闭或删除该名单;
(当前应用指您在接口 URL 中填写的 SID)

示例:假设名单已经绑定了 [A, B, C] 三个应用,其中 A 为当前应用。
1. 指定 [A, B]:更新成功后解绑 C,绑定的应用为 [A, B]
2. 指定 [B]:更新成功后解绑 C,绑定的应用为 [A, B]
3. 指定 [ ]:实际生效的为 [A],更新成功后解绑 B, C,绑定的应用为 [A]

1.5 请求示例

{
"imageLibraryId": "<imageLibraryId>",
"timestamp": "<timestamp>",
"nonce": "<nonce>",
"signature": "<signature>",
"name": "<name>"
}

2. 响应

2.1 响应内容

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

2.2 响应参数

参数名称类型是否可能为空说明
codeInt状态码
nonceFloat随机数(建议使用 Unix 时间戳或若干位随机整数)
messageString相关信息
timestampInt时间戳
imageLibraryObject<ImageLibrary>名单信息,详见 imageLibrary 说明

ImageLibrary 说明

参数名称类型是否可能为空说明
codeInt状态码,标识该图片名单库是否更新成功,详见公共服务状态码
errorString错误原因
nameString图片名单库名称
thresholdInt阈值
secretIdsArray<String>名单绑定的应用(SID)数组

2.3 响应示例

{
"json": "{\"code\":0,\"imageLibrary\":{\"code\":0,\"error\":\"\",\"name\":\"xxx\",\"status\":0,\"threshold\":0.95,\"secretIds\":[\"xxx\"]},\"message\":\"success\",\"nonce\":0.65333554465516,\"timestamp\":1669602627}",
"signature": "iq72eJlFhYrbMJQxwPOG9my9kGSAVZnnW5GeH8kTOUaxj1sn0J2nDMSBi/5EnOU6nhUm2sgEWEoR4C/Oou4CD3++jV4BYfg/wAq5Vs953IaPJESGt+k9bgkxtijlYhKWyMtWecl41A9JkQAt+Vh2I7JxCy5n5/MRfRlqw49XSac="
}

3. 更新日志

日期说明
2024-10-16更新请求中的 secretIds 字段描述