CreateSearchIndex-阿里云帮助中心

Operation description

Before using this API, ensure that you fully understand the Intelligent Search billing method and pricing.

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	Search library name. If no search library name is specified, the search index is created under the default IMS search library by default. The default value is ims-default-search-lib. You can also use the QuerySearchLib API to retrieve information about existing search libraries.	test1
IndexType	string	Yes	The category of the index. Valid values: mm: large visual model. You can use this model to describe complex visual features and identify and search for specific actions, movements, and events in videos, such as when athletes score a goal or get injured. Note This feature is in the public preview phase. You can use this feature for free for 1,000 hours of videos. face: face recognition. You can use the face recognition technology to describe face characteristics and automatically mark or search for faces in videos. aiLabel: smart tagging. The smart tagging category is used to describe content such as subtitles and audio in videos. You can use the speech recognition technology to automatically extract, mark, and search for subtitles and dialog content from videos. This helps you quickly locate the video content that is related to specific topics or keywords. Valid values: mm : mm face : face aiLabel : aiLabel	mm
IndexStatus	string	No	Index status. Default value is Active. Valid values: Active: Activated. Deactive: Deactivated. Valid values: Active : Active Deactive : Deactive	Active
IndexConfig	string	No	Index configuration	{}

IndexConfig Description

Feature	Name	Type	Required	Description	Example Value
	IndexConfig	object	No	This parameter contains the configuration parameters for the index.	{"level":"Shared"}
Specification	level	string	No	Resource specification parameter for face or LLM (large model) analysis. Default value is "Shared". Valid values: Shared – Shared type, supports 1 million faces or 1,000 hours of video LLM analysis S.large – Dedicated type, supports 1 million faces or 10,000 hours of video LLM analysis S.2xlarge – Dedicated type, supports 2 million faces or 20,000 hours of video LLM analysis S.4xlarge – Dedicated type, supports 4 million faces or 40,000 hours of video LLM analysis S.8xlarge – Dedicated type, supports 8 million faces or 80,000 hours of video LLM analysis S.16xlarge – Dedicated type, supports 16 million faces or 160,000 hours of video LLM analysis	"Shared"

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	***ACB-44F2-5F2D-88D7-1283E70***
Success	string	Indicates whether the invocation succeeded. Valid values: true: Invocation succeeded false: Failed to invoke	true
Code	string	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.