AlterSearchIndex - Intelligent Media Services - Alibaba Cloud Documentation Center

Modifies search index information including index status and configurations.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ice:AlterSearchIndex		All Resources ``	none	none

Request parameters

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.	{}

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

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