AlterSearchIndex - Intelligent Media Services - Alibaba Cloud Documentation Center

Modifies search index information including index status and configurations.

Debugging

There is currently no authorization information disclosed in the API.

Parameter	Type	Required	Description	Example
SearchLibName	string	No	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
IndexType	string	Yes	The category of the index. Valid values: mm: large visual model. face: face recognition. aiLabel: smart tagging.	mm
IndexStatus	string	No	The state of the index. Valid values: active (default): the index is enabled. Deactive: the index is not enabled. Note You must specify either IndexStatus or IndexConfig. Enumeration Value: Active: Active. Deactive: Deactive.	Active
IndexConfig	string	No	The configurations of the index. Note You must specify either IndexStatus or IndexConfig.	{}

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	****3B-0E1A-586A-AC29-742247****
Success	string	Indicates whether the request was successful. Valid values: true false	true
Code	string	The status code returned.	200

Sample success responses

JSONformat

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Success": "true",
  "Code": "200"
}

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

Change time	Summary of changes	Operation
2023-11-23	The request parameters of the API has changed	View Change Details
2023-11-22	The request parameters of the API has changed. The response structure of the API has changed	View Change Details