All Products
Search
Document Center

Intelligent Media Services:QueryMediaIndexJob

Last Updated:Dec 16, 2024

Queries the indexing jobs enabled for a media asset.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:QueryMediaIndexJob
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SearchLibNamestringNo

The name of the search library. Default value: ims-default-search-lib.

test1
MediaIdstringYes

The ID of the media asset.

c2e77390f75271ec802f0674a2ce6***

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

4E84BE44-58A7-****-****-FBEBEA16EF94
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

The response code.

200
IndexJobInfoListarray<object>

The indexing jobs enabled for the media asset.

IndexJobInfoListobject

The indexing job enabled for the media asset.

GmtSubmitstring

The time when the index job was submitted.

2023-11-21 11:33:50
GmtFinishstring

The end time of the indexing job.

2023-11-21 11:33:51
IndexTypestring

The index type. Valid values:

  • mm: large visual model.
  • face: face recognition.
  • aiLabel: smart tagging.
mm
Statusstring

The job status. Valid values:

  • Running
  • Success
  • Fail
Success

Examples

Sample success responses

JSONformat

{
  "RequestId": "4E84BE44-58A7-****-****-FBEBEA16EF94",
  "Success": "true",
  "Code": "200",
  "IndexJobInfoList": [
    {
      "GmtSubmit": "2023-11-21 11:33:50",
      "GmtFinish": "2023-11-21 11:33:51",
      "IndexType": "mm",
      "Status": "Success"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history