更新时间:2023-12-11 GMT+08:00
修改图片信息
功能介绍
修改图像索引库中已存在的图片信息。
URI
PUT /v1/{project_id}/{instance_name}/image
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| instance_name | 是 | String | 实例名称。 |
| project_id | 是 | String | 用户的项目ID。获取方法请参见获取项目ID和名称。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| path | 是 | String | 图片URL路径,作为图片库中索引图片的ID。 |
| tags | 是 | Object | 自定义标签,格式为key:value对,其中:
|
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | String | 调用成功时表示调用结果。 调用失败时无此字段。 |
状态码: 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 |
| error_msg | String | 调用失败时的错误信息。 调用成功时无此字段。 |
请求示例
输入图片路径,设置自定义标签,修改图像索引库中已存在的图片信息。
PUT https://{endpoint}/v1/{project_id}/{instance_name}/image
{
"path" : "https://bucketName.obs.myhuaweicloud.com/image/test1.jpg",
"tags" : {
"test-tags" : "test-image"
}
} 响应示例
状态码: 200
成功响应示例
{
"result" : "Success"
} 状态码: 400
失败响应示例
{
"error_code" : "IS.0003",
"error_msg" : "Arguments of path can not be null."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功响应示例。 |
| 400 | 失败响应示例。 |
错误码
请参见错误码。
父主题: API