BatchUpdateFileMeta - 批量更新文件元信息

更新批量数据集内已索引的文件的部分元数据。

接口说明

  • 请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格
  • 并非所有的元数据都允许您自定义更新。当前您可以更新其 CustomLabels、CustomId、Figures 人脸信息等字段,具体请参考请求参数一节。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imm:BatchUpdateFileMetaupdate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ProjectNamestring

项目名称,获取方式请参见创建项目

test-project
DatasetNamestring

数据集名称,获取方式请参见创建数据集

test-dataset
Filesarray

需要更新的元数据列表。

InputFile

需要更新元数据的文件及要更新的信息,格式为 JSON。

返回参数

名称类型描述示例值
object

响应结构体。

RequestIdstring

请求 ID。

F5BF215E-3237-0852-B9C6-F233D44A****
Filesarray<object>

本次更新的文件列表。

Filesobject

文件对象。

URIstring

文件地址。

oss://examplebucket/example.jpg
Successboolean

更新是否成功。

枚举值:
  • truetrue
  • falsefalse
false
Messagestring

当参数 Success 返回 false 时,返回的错误信息。

*error.OpError : InvalidArgument | Index KV count exceeded, should be no more than 100.

示例

正常返回示例

JSON格式

{
  "RequestId": "F5BF215E-3237-0852-B9C6-F233D44A****",
  "Files": [
    {
      "URI": "oss://examplebucket/example.jpg",
      "Success": false,
      "Message": "*error.OpError : InvalidArgument | Index KV count exceeded, should be no more than 100."
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-04-23OpenAPI 去除了 deprecated 标记查看变更详情
2021-06-15新增 OpenAPI查看变更详情