All Products
Search
Document Center

Intelligent Media Management:BatchUpdateFileMeta

Last Updated:Dec 11, 2024

Updates some metadata items of files indexed into a dataset.

Operation description

  • Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****
  • You cannot call this operation to update all metadata. You can update only metadata fields such as CustomLabels, CustomId, and Figures. For more information, see the "Request parameters" section of this topic.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
imm:BatchUpdateFileMetaupdate
*Dataset
acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectNamestringYes

The name of the project.

test-project
DatasetNamestringYes

The name of the dataset.

test-dataset
FilesarrayYes

The files whose metadata you want to update.

InputFileYes

The file and its metadata items to update. The value must be in the JSON format.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The files whose metadata was updated.

Filesobject

The file.

URIstring

The URI of the file.

oss://examplebucket/example.jpg
Successboolean

Indicates whether the request was successful. Valid values:

Enumerated values:

  • true
  • false
false
Messagestring

The error message returned when the value of the Success parameter is false.

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

Examples

Sample success responses

JSONformat

{
  "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."
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-04-23The API operation is not deprecated.View Change Details
2021-06-15Add OperationView Change Details