ListPublicMediaBasicInfos

Updated at:

Lists the basic information of up to 100 media assets in the public material library that meet the specified conditions.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

MediaTagId

string

No

The media asset tag. The system matches media assets based on this mediaTagId and returns all media assets that contain this tag. Valid values:

  • sticker: stickers
    • sticker-atmosphere: atmosphere

    • sticker-bubble: bubble

    • sticker-cute: cute

    • sticker-daily: daily

    • sticker-expression: expression

    • sticker-gif: GIF

  • bgm: background music
    • bgm-romantic: romantic

    • bgm-cuisine: cuisine

    • bgm-chinese-style: Chinese style

    • bgm-upbeat: upbeat

    • bgm-dynamic: dynamic

    • bgm-relaxing: relaxing

    • bgm-quirky: quirky

    • bgm-beauty: fashion and beauty

  • bgi: background images
    • bgi-grad: gradient background

    • bgi-solid: solid color background

    • bgi-pic: image background

sticker-atmosphere

NextToken

string

No

The token that indicates the position from which the next query starts. An empty value indicates that all data has been read.

pSa1SQ0wCe5pzVrQ6mWZEw==

MaxResults

integer

No

The maximum number of entries to return for a single request.

Maximum value: 100. Default value: 10.

5

PageNo

integer

No

The current page number. Default value: 1.

1

PageSize

integer

No

The number of entries to return on each page. Default value: 10. Maximum value: 100.

10

IncludeFileBasicInfo

boolean

No

Specifies whether to include basic file information in the response.

true

BusinessType

string

No

The business type of the media asset. Valid values:

  • sticker: sticker

  • bgm: background music

  • bgi: background image

sticker

Response elements

Element

Type

Description

Example

object

Schema of Response

MaxResults

integer

The maximum number of records returned for the current request.

2

MediaInfos

array<object>

The collection of matching media assets.

array<object>

FileInfoList

array<object>

The file information.

array<object>

FileBasicInfo

object

The basic file information, including duration and size.

Bitrate

string

The bitrate.

270112.12

Duration

string

The duration.

10.040000

FileName

string

The file name.

example.mp4

FileSize

string

The file size in bytes.

338990717

FileStatus

string

The file status.

Normal

FileType

string

The file type.

source_file

FileUrl

string

The OSS URL of the file.

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=

FormatName

string

The container format.

mov,mp4,m4a,3gp,3g2,mj2

Height

string

The height.

1080

Region

string

The storage region of the file.

cn-shanghai

Width

string

The width.

1920

MediaBasicInfo

object

The basic media asset information.

BusinessType

string

The business type of the media asset.

general

Category

string

The category.

video

CoverURL

string

The URL of the cover image.

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=

CreateTime

string

The time when the media asset was created. The time follows the ISO 8601 standard and is displayed in UTC.

2021-01-08T16:52:04Z

DeletedTime

string

The time when the media asset was deleted. The time follows the ISO 8601 standard and is displayed in UTC.

2021-01-08T16:52:04Z

Description

string

The description.

description

InputURL

string

The URL of the media asset to be registered in the corresponding system.

https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4

MediaId

string

The media asset ID.

****019b82e24b37a1c2958dec38****

MediaTags

string

The tags.

sticker-daily

MediaType

string

The media type of the media asset.

video

ModifiedTime

string

The time when the media asset was modified. The time follows the ISO 8601 standard and is displayed in UTC.

2021-01-08T16:52:04Z

Snapshots

string

The snapshots.

null

Source

string

The source.

oss

Status

string

The status of the resource.

Normal

Title

string

The title.

Sample title

TranscodeStatus

string

The transcoding status.

Init

UserData

string

The user data.

userData

MediaId

string

The media asset ID.

****019b82e24b37a1c2958dec38****

NextToken

string

The token that indicates the position from which the next query starts. An empty value indicates that all data has been read.

8EqYpQbZ6Eh7+Zz8DxVYoQ==

RequestId

string

The request ID.

******B7-7F87-4792-BFE9-63CD21******

TotalCount

integer

The total number of matching media assets.

2

Examples

Success response

JSON format

{
  "MaxResults": 2,
  "MediaInfos": [
    {
      "FileInfoList": [
        {
          "FileBasicInfo": {
            "Bitrate": "270112.12",
            "Duration": "10.040000",
            "FileName": "example.mp4",
            "FileSize": "338990717",
            "FileStatus": "Normal",
            "FileType": "source_file",
            "FileUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=&OSSAccessKeyId=&Signature=&security-token=",
            "FormatName": "mov,mp4,m4a,3gp,3g2,mj2",
            "Height": "1080",
            "Region": "cn-shanghai",
            "Width": "1920"
          }
        }
      ],
      "MediaBasicInfo": {
        "BusinessType": "general",
        "Category": "video",
        "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=",
        "CreateTime": "2021-01-08T16:52:04Z",
        "DeletedTime": "2021-01-08T16:52:04Z",
        "Description": "description",
        "InputURL": "https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4",
        "MediaId": "****019b82e24b37a1c2958dec38****",
        "MediaTags": "sticker-daily",
        "MediaType": "video",
        "ModifiedTime": "2021-01-08T16:52:04Z",
        "Snapshots": "null",
        "Source": "oss",
        "Status": "Normal",
        "Title": "Sample title",
        "TranscodeStatus": "Init",
        "UserData": "userData"
      },
      "MediaId": "****019b82e24b37a1c2958dec38****"
    }
  ],
  "NextToken": "8EqYpQbZ6Eh7+Zz8DxVYoQ==",
  "RequestId": "******B7-7F87-4792-BFE9-63CD21******",
  "TotalCount": 2
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.