1. 接口描述
接口请求域名: tiia.tencentcloudapi.com 。
本接口支持根据图库ID、物品ID、图片名称来修改图片信息(暂仅支持修改Tags)
- 可前往 图像搜索 产品文档中查看更多产品信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpdateImage。 |
Version | 是 | String | 公共参数,本接口取值:2019-05-29。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
GroupId | 是 | String | 图库ID。 示例值:xxxxx |
EntityId | 是 | String | 物品ID,最多支持64个字符。 示例值:xxxxx |
PicName | 否 | String | 图片名称,最多支持64个字符。 示例值:xxxxx |
Tags | 否 | String | 新的自定义标签,最多不超过10个,格式为JSON。 示例值:{} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新图片接口调用失败示例
输入示例
POST / HTTP/1.1
Host: tiia.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateImage
<公共请求参数>
{
"GroupId": "",
"EntityId": "1",
"PicName": "test"
}
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameter.InvalidParameter",
"Message": "参数不合法。"
},
"RequestId": "cac925c7-c939-4eb6-8db5-d64123385c30"
}
}
示例2 更新图片接口调用成功示例
输入示例
POST / HTTP/1.1
Host: tiia.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateImage
<公共请求参数>
{
"GroupId": "123",
"EntityId": "1",
"PicName": "test",
"Tags": ""
}
输出示例
{
"Response": {
"RequestId": "cac925c7-c939-4e26-8db5-d642f7385c30"
}
}
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.DownloadError | 文件下载错误。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.ImageGroupEmpty | 图库为空。 |
FailedOperation.ImageNotFoundInfo | 未找到图片信息。 |
FailedOperation.ImageNotSupported | 不支持的图片文件。 |
FailedOperation.ImageSizeExceed | base64编码后的图片数据过大。 |
FailedOperation.ImageUrlInvalid | url地址不合法,无法下载。 |
FailedOperation.RequestError | 后端服务请求失败。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.RpcFail | RPC请求失败,一般为算法微服务故障。 |
FailedOperation.ServerError | 算法服务异常,请重试。 |
InvalidParameter.ImageFormatNotSupport | 不支持的图片格式。 |
InvalidParameter.InvalidParameter | 参数取值错误。 |
InvalidParameterValue.EntityIdEmpty | 物品ID为空。 |
InvalidParameterValue.ImageGroupIdIllegal | 图库ID不合法。 |
InvalidParameterValue.ImageGroupIdNotExist | 图库ID不存在。 |
InvalidParameterValue.ImageGroupIdTooLong | 图库ID超出长度限制。 |
InvalidParameterValue.PicNameEmpty | 图片名称为空。 |
InvalidParameterValue.PicNameTooLong | 图片名称超出长度限制。 |
InvalidParameterValue.TagsKeysExceed | 标签数量过多。 |
InvalidParameterValue.TagsValueIllegal | 标签值类型不合法。 |
InvalidParameterValue.TagsValueSizeExceed | 标签值长度过长。 |
MissingParameter.ErrorParameterEmpty | 必选参数为空。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.NotExist | 计费状态未知,请确认是否已在控制台开通服务。 |