IndexFileMeta - Intelligent Media Management - Alibaba Cloud Documentation Center

Operation description

Make sure you understand the billing methods and pricing of Intelligent Media Management before you use this API.
For a list of supported data processing operations for indexing object metadata, see Workflow templates and operators.
The total number and size of files that can be indexed are limited. For more information, see the Dataset limits section in Limits. For information about how to create a dataset, see the parameter descriptions.
For a list of regions where you can index object metadata, see the 'Features supported by region, Datasets and indexes' section in Limits.
After you index object metadata, you can retrieve data using Simple query. For information about other retrieval features, see Query and statistics. You can also create face groups using Create a face clustering task. For information about other clustering features, see Intelligent management.

Note

This is an asynchronous operation. After you submit a request, the file is processed. The processing time can range from several seconds to several minutes or longer, depending on the workflow template and operators and file content. After the processing is complete, the metadata is stored in the dataset. You can use the message subscription feature to receive a notification when the task is complete.

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

create

*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. To get the project name, see Create a project.	test-project
DatasetName	string	Yes	The name of the dataset. To get the dataset name, see Create a dataset.	test-dataset
File	InputFile	Yes	The file to be indexed, in JSON format. For more information, see the struct definition.
UserData	string	No	Custom information that is returned in the asynchronous notification message. This helps you associate the notification with your services. The maximum length is 2048 bytes.	{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
Notification	Notification	No	The message notification configuration. For more information, see Notification. For the format of the asynchronous notification message, 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.	6E93D6C9-5AC0-49F9-914D-E02678D3****
EventId	string	The event ID.	30F-1D8FxFzDXKJH9YQdve4CjR****

Examples

Success response

JSON format

{
  "RequestId": "6E93D6C9-5AC0-49F9-914D-E02678D3****",
  "EventId": "30F-1D8FxFzDXKJH9YQdve4CjR****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.