Indexes metadata of multiple objects into the specified dataset. The process involves data processing operations such as label detection, face detection, and location detection. Metadata indexing helps meet diverse data retrieval requirements.
Operation description
- Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****
- Data processing operations supported for metadata processing vary with workflow templates. For more information, see Workflow templates and operators.
- Metadata indexing poses limits on the total number and size of objects. For more information about these limits, see Limits . For more information about how to create
- Metadata indexing is available in specific regions. For information about regions that support metadata indexing, see the "Data management and indexing" section of the Limits topic.
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:BatchIndexFileMeta | create | *Dataset acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectName | string | Yes | test-project | |
| DatasetName | string | Yes | test-dataset | |
| Files | array | Yes | The objects in Object Storage Service (OSS). Specify OSS objects by using a JSON array. You can specify up to 100 objects in an array. | |
| InputFile | Yes | The information about the OSS object. | ||
| Notification | Notification | No | The notification settings. For more information, see the "Metadata indexing" section of the Asynchronous message examples topic. |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "8F93E6D9-5AC0-49F9-914D-E02678A3****",
"EventId": "387-1DAPFFZplUZhuCuhnB6I9H****"
}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-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 |