All Products
Search
Document Center

Intelligent Media Services:QuerySearchIndex

Last Updated:Dec 16, 2024

Queries the details of a search index.

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:QuerySearchIndex
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SearchLibNamestringNo

The name of the search library.

  • If you leave this parameter empty, the search index is created in the default search library of Intelligent Media Service (IMS). Default value: ims-default-search-lib.
  • To query information about an existing search library, call the QuerySearchLib API operation.
test1
IndexTypestringYes

The category of the index. Valid values:

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

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

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

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

The status code returned.

200
SearchLibNamestring

The name of the search library.

test1
IndexTypestring

The category of the index. Valid values:

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

The state of the index. Valid values:

  • active: the index is enabled.
  • Deactive: the index is not enabled.
Enumeration Value:
  • Active: Active.
  • Deactive: Deactive.
Active
MediaTotalstring

The total number of media assets.

12

Examples

Sample success responses

JSONformat

{
  "RequestId": "4E84BE44-58A7-****-****-FBEBEA16EF94",
  "Success": "true",
  "Code": "200",
  "SearchLibName": "test1",
  "IndexType": "mm",
  "IndexStatus": "Active",
  "MediaTotal": "12"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-11-22The response structure of the API has changedView Change Details