CreateSearchIndex-Intelligent Media Services(IMS)-阿里云帮助中心

Operation description

Before calling this operation, make sure that you fully understand the billing methods and pricing of Intelligent Search.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:CreateSearchIndex

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SearchLibName	string	No	The name of the search library. If you do not specify a search library name, the search index is created in the default search library of IMS by default. Default value: ims-default-search-lib. You can also call the QuerySearchLib operation to query existing search library information.	test1
IndexType	string	Yes	The index type. Valid values: mm: large model visual state. Describes complex visual features and actions in videos, which helps identify and search for specific actions, movements, and events in videos, such as a football player scoring a goal or a basketball player getting injured. Note The shared edition supports 1,000 hours of video. After the quota is exceeded, the system no longer performs large model visual state analysis. face: automatic face recognition. Describes facial features in videos. By using face recognition technology, faces in videos can be automatically tagged and searched. Note The shared edition supports 1 million face analyses. After the quota is exceeded, the system no longer performs face analysis. aiLabel: intelligent tag. Describes subtitles, speech, and other content in videos. By using text and speech recognition technologies, language information such as subtitles and dialogues in videos can be automatically extracted for tagging and searching. This helps users quickly search for and locate content involving specific topics or keywords in videos. Valid values: mm : mm face : face aiLabel : aiLabel	mm
IndexStatus	string	No	The index status. Default value: Active. Valid values: Active: activated. Deactive: deactivated. Valid values: Active : Active Deactive : Deactive	Active
IndexConfig	string	No	The index configuration.	{}

IndexConfig description

Feature	Name	Type	Required	Description	Example value
	IndexConfig	object	No	This parameter contains the relevant parameters for index configuration.	{"level":"Shared"}
Specification	level	string	No	The resource specification parameter for the face and mm index types. Default value: Shared. Valid values: Shared: shared edition. Supports 1 million faces or 1,000 hours of video for large model analysis. S.large: dedicated edition. Supports 1 million faces or 10,000 hours of video for large model analysis. S.2xlarge: dedicated edition. Supports 2 million faces or 20,000 hours of video for large model analysis. S.4xlarge: dedicated edition. Supports 4 million faces or 40,000 hours of video for large model analysis. S.8xlarge: dedicated edition. Supports 8 million faces or 80,000 hours of video for large model analysis. S.16xlarge: dedicated edition. Supports 16 million faces or 160,000 hours of video for large model analysis.	"Shared"

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	***ACB-44F2-5F2D-88D7-1283E70***
Success	string	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
Code	string	The return code.	200

Examples

Success response

JSON format

{
  "RequestId": "*****ACB-44F2-5F2D-88D7-1283E70*****",
  "Success": "true",
  "Code": "200"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.