BatchIndexFileMeta - Intelligent Media Management - Alibaba Cloud Documentation Center

This operation performs a batch index of object metadata by processing input files for tasks such as label detection, face detection, and location detection. The object metadata is then indexed into a dataset to support various data retrieval methods.

Operation description

Before you use this API, review the billing methods and pricing of Intelligent Media Management.
For a list of supported data processing tasks, see Define a workflow.
The files to be indexed are subject to limits on their total number and size. For more information about dataset limits, see Limits. For information about how to create a dataset, see the parameter descriptions.
For information about the regions that support file indexing, see the dataset and index information in Limits.

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:BatchIndexFileMeta

create

*Dataset

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

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The project name. For more information about how to obtain the project name, see Create a project.	test-project
DatasetName	string	Yes	The dataset name. For more information about how to obtain the dataset name, see Create a dataset.	test-dataset
Files	array	Yes	A list of OSS files. This is an array in JSON format that can contain up to 100 files.
	InputFile	No	The struct of an OSS file.
UserData	string	No	Custom user data. This parameter takes effect only when you specify an MNS configuration for the Notification parameter. The data is returned in the asynchronous notification message, which you can use to associate the message with your services. The maximum length is 2048 bytes.	{ "id": "test-id", "name": "test-name" }
Notification	Notification	No	The notification configuration. For more information, click Notification. For the format of asynchronous notification messages, see the metadata indexing section in Asynchronous notification message formats.

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	8F93E6D9-5AC0-49F9-914D-E02678A3****
EventId	string	The event ID.	387-1DAPFFZplUZhuCuhnB6I9H****

Examples

Success response

JSON format

{
  "RequestId": "8F93E6D9-5AC0-49F9-914D-E02678A3****",
  "EventId": "387-1DAPFFZplUZhuCuhnB6I9H****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.