InsertMediaToSearchLib-阿里云帮助中心

Operation description

Prerequisites

Before inserting a media asset into the search library, you must call the CreateSearchLib API to create the search library.

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:InsertMediaToSearchLib

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SearchLibName	string	No	The name of the search library. Default value: ims-default-search-lib.	test1
MediaId	string	No	The ID of the media asset. Each media ID is unique. If you leave this parameter empty, a media ID is automatically generated for this parameter.	411bed50018971edb60b0764a0ec6***
MediaType	string	No	The type of the media asset. Valid values: video (default) image audio Valid values: image : image video : video audio : audio	video
Input	string	Yes	The URL of the video, audio, or image file that you want to import to the search library. Note: Make sure that you specify a correct file name and the bucket in which the file resides is in the same region where this operation is called. Otherwise, the file cannot be found or the operation may fail. Specify an Object Storage Service (OSS) URL in the following format: oss://[Bucket name]/[File path]. For example, you can specify oss://[example-bucket-]/[object_path-]. Specify an HTTP URL in the following format: public endpoint. For example, you can specify http://example-test-****.mp4.	oss://[example-bucket-]/[object_path-]
MsgBody	string	No	The message body.	{"title":"test","customFields":{"intField1":12,"strField1":"abc"}}
ImagesInput	string	No	Image set information. Supports only the IPCamera scenario, and MediaType must be video.	{ "images": [ "oss://[example-bucket-]/[object_path-]xxx1.jpg", "oss://[example-bucket-]/[object_path-]xxx2.jpg", "oss://[example-bucket-]/[object_path-]xxx3.jpg", "oss://[example-bucket-]/[object_path-]xxx4.jpg" ] }
Namespace	string	No	Namespace.	name-1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	***ACB-44F2-5F2D-88D7-1283E70***
MediaId	string	The ID of the media asset.	**20b48fb04483915d4f2cd8ac**
Success	string	Indicates whether the request was successful. Valid values: true false	true
Code	string	The status code returned.	200

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.