Creates an index from metadata extracted by using techniques such as label recognition, face detection, and location detection from input files. You can retrieve data from the same dataset by using multiple methods.
Operation description
- Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****
- For information about how to create indexes from metadata, see Workflow templates and operators.
- For information about the limits on the maximum number and size of index files that you can create, see the "Limits on datasets" section of the Limits topic. For information about how to create a dataset, see the "CreateDataset" topic.
- For information about the regions in which you can create index files from metadata, see the "Datasets and indexes" section of the Limits topic.
- After you create an index from metadata, you can try simple query to retrieve data. For information about other query capabilities, see Query and statistics. You can also create a face clustering task to group faces. For information about other clustering capabilities, see Intelligent management.
**
Usage notes
- The IndexFileMeta operation is asynchronous, indicating that it takes some time to process the data after a request is submitted. After the processing is complete, the metadata is stored in your dataset. The amount of time it takes for this process varies based on the workflow template, the operator, and the content of the file, ranging from several seconds to several minutes or even longer. You can subscribe to Simple Message Service for task completion notifications.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| 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. You can obtain the name of the project from the response of the CreateProject operation. | test-project |
| DatasetName | string | Yes | The name of the dataset. You can obtain the name of the dataset from the response of the CreateDataset operation. | test-dataset |
| File | InputFile | Yes | The file for which you want to create an index. The value must be in the JSON format. | |
| Notification | Notification | No | The notification settings. For more information, click Notification. For information about the formats of asynchronous notifications, see the "Metadata indexing" section of the Asynchronous message examples topic. |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "6E93D6C9-5AC0-49F9-914D-E02678D3****",
"EventId": "30F-1D8FxFzDXKJH9YQdve4CjR****"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-04-15 | The request parameters of the API has changed | View Change Details |
| 2023-04-23 | The API operation is not deprecated. | View Change Details |
| 2023-03-27 | The request parameters of the API has changed | View Change Details |
| 2023-03-09 | The request parameters of the API has changed | View Change Details |
| 2022-08-16 | The request parameters of the API has changed | View Change Details |
| 2022-08-16 | The request parameters of the API has changed | View Change Details |
| 2021-06-15 | Add Operation | View Change Details |