Enable Custom File Tagging with BatchUpdateFileMeta in IMM - Intelligent Media Management - Alibaba Cloud - Intelligent Media Management

Operation description

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

imm:BatchUpdateFileMeta

update

*Dataset

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project.	test-project
DatasetName	string	Yes	The name of the dataset.	test-dataset
Files	array	Yes	The files whose metadata you want to update.
	InputFile	No	The file and the metadata fields to update. The value must be in the JSON format.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F5BF215E-3237-0852-B9C6-F233D44A****
Files	array<object>	The files whose metadata was updated.
	object	The file.
URI	string	The URI of the file.	oss://examplebucket/example.jpg
Success	boolean	Indicates whether the metadata update was successful. Valid values: Enumerated values: true false Valid values: true : true false : false	false
Message	string	The error message returned when Success is false.	*error.OpError : InvalidArgument \| Index KV count exceeded, should be no more than 100.

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.