All Products
Search
Document Center

Intelligent Media Services:InsertMediaToSearchLib

Last Updated:Dec 16, 2024

Adds a media asset in a search library. Before you call this operation, you must create a search library.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:InsertMediaToSearchLib
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SearchLibNamestringNo

The name of the search library. Default value: ims-default-search-lib.

test1
MediaIdstringNo

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***
MediaTypestringNo

The type of the media asset. Valid values:

  • video (default)
  • image
  • audio
video
InputstringYes

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.

http://example-test-****.mp4
MsgBodystringNo

The message body.

{}

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

*****ACB-44F2-5F2D-88D7-1283E70*****
MediaIdstring

The ID of the media asset.

****20b48fb04483915d4f2cd8ac****
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

The status code returned.

200

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2023-11-22The response structure of the API has changedView Change Details