All Products
Search
Document Center

Basic data types

Last Updated: Aug 08, 2019

Video

Specifies the information about a video.

Parameter Type Description
VideoId String The ID of the video.
Title String The title of the video.
Description String The description of the video.
Duration Float The video duration. Unit: seconds.
CoverURL String The URL of the video thumbnail.
Status String The video status.
CreationTime String The time when the video was created. The time is displayed in UTC.
Size Long The size of the video mezzanine file. Unit: bytes.
Snapshots String[] The URL array of video snapshots.
CateId Long The ID of the video category.
CateName String The name of the video category.
Tags String The tag of the video. Separate multiple tags with commas (,).
TemplateGroupId String The template group ID used to transcode the video.
StorageLocation String The bucket for storing the video file.
AppId String The application ID.

VideoBase

Specifies the basic information about a video.

ParameterTypeDescription
VideoIdStringThe ID of the video.
TitleStringThe title of the video.
DurationStringThe video duration. Unit: seconds.
CoverURL StringThe URL of the video thumbnail.
StatusStringThe video status.
CreationTimeStringThe time when the video was created. The time is displayed in UTC.
MediaTypeStringThe type of the media file. Valid values:
  • video
  • audio

Note: The GetPlayInfo operation returns a CDN URL by default. If no CDN domain name is specified, the GetPlayInfo operation returns an OSS URL. In this case, only the URL of the .mp4 video is available for playback.

Media

Specifies the information about a media file.

ParameterTypeDescription
MediaIdStringThe ID of the media file.
CreationTimeStringThe time when the media file was created. The time is displayed in UTC.
MediaTypeStringThe type of the media file. Valid values:
  • video
  • audio
  • image
  • attached
VideoVideoThe video information.
Audio AudioThe audio information.
Image ImageThe image information.
AttachedMedia AttachedMediaThe attached media asset information.

PlayInfo

Specifies the playback information (stream information) about a media file.

ParameterTypeDescription
BitrateStringThe bitrate of the media stream. Unit: kbit/s.
DefinitionStringThe definition of the media stream. Valid values:
  • FD: indicates low definition.
  • LD: indicates standard definition.
  • SD: indicates high definition.
  • HD: indicates ultra high definition.
  • OD: indicates original quality.
  • 2K: indicates 2K resolution.
  • 4K: indicates 4K resolution.
DurationStringThe duration of the media stream. Unit: seconds.
EncryptLongIndicates whether the media stream is encrypted. Valid values:
  • 0: indicates that the media stream is not encrypted.
  • 1: indicates that the media stream is encrypted.
EncryptTypeStringThe encryption type of the media stream. Valid values:
  • AliyunVoDEncryption: indicates Alibaba Cloud video encryption.
  • HLSEncryption: indicates standard HLS encryption.
PlayURLStringThe playback URL of the media stream.
FormatStringThe format of the media stream.
Valid values for a video:
  • mp4
  • m3u8
Valid values for an audio stream:
  • mp3
FpsStringThe frame rate of the media stream.
SizeLongThe size of the media stream. Unit: bytes.
WidthLongThe width of the media stream. Unit: pixels.
HeightLongThe height of the media stream. Unit: pixels.
StreamTypeStringThe type of the media stream.
Valid value for a video stream:
  • video
Valid value for an audio stream:
  • audio
JobIdStringThe ID of the media stream transcoding job. This ID uniquely identifies a media stream.
WatermarkIdStringThe ID of the watermark associated with the media stream .
Status StringThe status of the media stream. Valid values:
  • Normal
  • Invisible
NarrowBandType StringThe Narrowband HD™ type. Valid values:
  • 0: indicates normal transcoding.
  • 1.0: indicates Narrowband HD™ 1.0.
  • 2.0: indicates Narrowband HD™ 2.0.
This parameter is valid only when the definition of the built-in Narrowband HD™ 1.0 transcoding template is configured. For more information, see the description of the Definition parameter in the TranscodeTemplate structure.
CreationTimeStringThe time when the media stream was created. The time is displayed in UTC.
ModificationTimeStringThe time when the media stream was last modified. The time is displayed in UTC.

VideoMeta

Specifies the metadata of a video.

Parameter Type Description
VideoId String The ID of the video.
Title String The title of the video.
Duration Float The video duration. Unit: seconds.
CoverURL String The URL of the video thumbnail.
Status String The video status.

Status

Specifies the valid values of the Status parameter for a video.

Value Description Remarks
Uploading Indicates that the video is being uploaded. The initial status.
UploadFail Indicates that the video fails to be uploaded. This value is temporarily not used because the video is uploaded in resumable mode and the system is unable to determine whether the resumable upload failed.
UploadSucc Indicates that the video has been uploaded. -
Transcoding Indicates that the video is being transcoded. -
TranscodeFail Indicates that the video fails to be transcoded. A transcoding failure is usually caused by an error in the video mezzanine file. You can obtain the error message from the TranscodeComplete event notification or submit a ticket.
Checking Indicates that the video is being reviewed. Log on to the ApsaraVideo for VOD console and choose Global Settings > Review Settings in the left-side navigation pane. On the Review Settings page that appears, if Review Before Publish is selected, the video status changes to Checking after the video is transcoded. In this case, the video can be played only in the console.
Blocked Indicates that the video is blocked. The video is blocked when it is being reviewed.
Normal Indicates that the video is normal. The video can be played properly.

Status

Specifies the valid values of the Status parameter for an image.

Value Description Remarks
Uploading Indicates that the image is being uploaded. The initial status.
Normal Indicates that the image has been uploaded. -
UploadFail Indicates that the image fails to be uploaded. -

Category

Parameter Type Description
CateId Long The ID of the video category.
CateName String The name of the category. Length constraint: Maximum length of 64 bytes. Encoding: UTF-8.
ParentId Long The ID of the parent category. The parent category ID of a level-1 category is -1.
Level Long The category level. The level of a level-1 category is 0.

Mezzanine

Parameter Type Description
VideoId String The ID of the video.
FileName String The name of the mezzanine file.
Duration String The duration of the mezzanine file. Unit: seconds.
Status String The status of the mezzanine file.
CreationTime String The time when the mezzanine file was created. The time is displayed in UTC.
Height Long The height of the mezzanine file. Unit: pixels.
Width Long The width of the mezzanine file. Unit: pixels.
Fps String The frame rate of the mezzanine file.
FileURL String The URL of the mezzanine file.
Bitrate String The bitrate of the mezzanine file. Unit: kbit/s.
Size Long The size of the mezzanine file. Unit: bytes.
OutputType String The type of the output file URL. Valid values: oss and cdn.
VideoStreamList VideoStream[] The video stream information list.
AudioStreamList AudioStream[] The audio stream information list.

VideoStream

Specifies the information about a video stream.

Parameter Type Description
Index String The sequence number of the video stream. The value identifies the position of the video stream in the whole media streams.
CodecName String The short name of the codec format.
CodecLongName String The full name of the codec format.
Profile String The codec profile.
CodecTimeBase String The codec time base.
CodecTagString String The text string representation of the codec format tag.
CodecTag String The hexadecimal string representation of the codec format tag.
Width Long The width of the video resolution.
Height Long The height of the video resolution.
HasBFrames String Indicates whether the video has B frames.
Sar String The sample aspect ratio (SAR).
Dar String The display aspect ratio (DAR).
PixFmt String The pixel format.
Level String The codec level.
Fps String The target frame rate.
AvgFPS String The average frame rate.
Timebase String The time base.
StartTime String The start time.
Duration String The duration.
NumFrames String The total number of frames.
Lang String The language.
Rotate String The video rotation angle. Valid values: [0, 360).

AudioStream

Specifies the information about an audio stream.

Parameter Type Description
Index String The sequence number of the audio stream. The value identifies the position of the audio stream in the whole media streams.
CodecName String The short name of the codec format.
CodecLongName String The full name of the codec format.
CodecTimeBase String The codec time base.
CodecTagString String The text string representation of the codec format tag.
CodecTag String The hexadecimal string representation of the codec format tag.
SampleFmt String The sampling format.
SampleRate String The sampling rate.
Channels String The number of sound channels.
ChannelLayout String The output format of sound channels.
Timebase String The time base.
StartTime String The start time.
Duration String The duration.
Bitrate String The bitrate.
NumFrames String The total number of frames.
Lang String The language.

Status

Specifies the valid values of the Status parameter for a mezzanine file.

Value Description Remarks
Uploading Indicates that the file is being uploaded. The initial status.
Normal Indicates that the file has been uploaded. -
UploadFail Indicates that the file fails to be uploaded. -
Deleted Indicates that the file has been deleted. -

LiveRecordVideo

Specifies the information about VOD files created from live streams.

Parameter Type Description
StreamName String The name of the live stream.
DomainName String The domain name.
AppName String The name of the application.
PlaylistId String The ID of the playlist.
RecordStartTime String The start time of recording.
RecordEndTime String The end time of recording.
Video Video The video information.

TopPlayVideoStatis

Specifies the daily playback statistics for top videos.

Parameter Type Description
VideoId String The ID of the video.
PlayDuration String The playback duration. Unit: milliseconds.
Title String The name of the video.
VV String The number of video views.
UV String The number of unique visitors.

VideoPlayStatisDetail

Specifies the daily playback statistics for a specific video.

Parameter Type Description
Date String The date in yyyyMMdd format, for example, 20170120.
PlayDuration String The playback duration. Unit: milliseconds.
Title String The name of the video.
VV String The number of video views.
UV String The number of unique visitors.
PlayRange String The distribution of playback duration.

UserPlayStatisTotals

Specifies the total daily playback statistics for videos.

Parameter Type Description
Date String The date in yyyyMMdd format, for example, 20170120.
PlayDuration String The total playback duration. Unit: milliseconds.
PlayRange String The distribution of playback duration.
VV VV The total number of video views.
UV UV The total number of unique visitors.

UserPlayStatisAvgs

Specifies the average daily playback statistics for videos.

Parameter Type Description
Date String The date in yyyyMMdd format, for example, 20170120.
AvgPlayDuration String The average playback duration. Unit: milliseconds.
AvgPlayCount String The average number of playback times.

VV distribution

Playback statistics are collected only from videos played through the ApsaraVideo Player SDK.

Parameter Type Description
Android String The total number of video views through the ApsaraVideo Player SDK for Android.
iOS String The total number of video views through the ApsaraVideo Player SDK for iOS.
Flash String The total number of video views through the ApsaraVideo Player SDK for Flash.
HTML5 String The total number of video views through the ApsaraVideo Player SDK for HTML5.

UV distribution

Playback statistics are collected only from videos played through the ApsaraVideo Player SDK.

Parameter Type Description
Android String The total number of unique visitors who use the ApsaraVideo Player SDK for Android.
iOS String The total number of unique visitors who use the ApsaraVideo Player SDK for iOS.
Flash String The total number of unique visitors who use the ApsaraVideo Player SDK for Flash.
HTML5 String The total number of unique visitors who use the ApsaraVideo Player SDK for HTML5.

EditingProject

Parameter Type Description
ProjectId String The ID of the online editing project.
Title String The title of the online editing project.
CreationTime String The time when the online editing project was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. For example, a value of 2017-01-11T12:00:00Z indicates 20:00:00 on January 11, 2017, China Standard Time.
ModifiedTime String The time when the online editing project was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. For example, a value of 2017-01-11T12:00:00Z indicates 20:00:00 on January 11, 2017, China Standard Time.
Status String The status of the online editing project.
Description String The description of the online editing project.
Timeline String The timeline of the online editing project, in JSON format.
Duration String The duration of the online editing project. The duration must be the same as that of the timeline.
CoverURL String The thumbnail URL of the online editing project.

Timeline

Parameter Type Description
Id String The ID of the online editing project.
Title String The title of the online editing project.
CreationTime String The time when the timeline was created.
ModifiedTime String The time when the timeline was last modified.
Duration Float The duration of the timeline. Unit: seconds. The value is precise to four decimal places.
CurrentRuler Float The current ruler of the timeline. You do not need to set this parameter if the timeline is used only for video production, but not for data storage during editing.
CurrentPosition Float The current position of the playhead for the online editing project. Unit: seconds. The value is precise to four decimal places. You do not need to set this parameter if the timeline is used only for video production, but not for data storage during editing.
VideoTracks VideoTrack[] The list of video tracks.

VideoTrack

Parameter Type Description
Count Int The total number of video track clips.
Duration String The duration of the video track.
VideoTrackClips VideoTrackClip[] The list of video track clips.

VideoTrackClip

Parameter Type Description
Id String The ID of the video track clip. You do not need to set this parameter if the timeline is used only for video production, but not for data storage during editing. If the timeline is used to edit data, you must set a unique value for this parameter within the timeline.
VideoId String The video ID corresponding to the video track clip.
Type String The type of the video track clip. Valid values: Video and Image. Default value: Video.
Title String The title of the video track clip. The title must be the same as that of the corresponding video.
Index Int The sequence number of the video track clip in the timeline, starting from zero.
CutFlag Boolean Indicates whether the video track clip has been cut. Valid values: true and false. You do not need to set this parameter if the timeline is used only for video production, but not for data storage during editing.
TextFlag Boolean Indicates whether banner text has been added to the video track clip. Valid values: true and false. You do not need to set this parameter if the timeline is used only for video production, but not for data storage during editing.
DeWatermarkFlag Boolean Indicates whether any part of the video track clip has been masked. Valid values: true and false. You do not need to set this parameter if the timeline is used only for video production, but not for data storage during editing.
URL String The URL of the stream used during the video track clip editing. You do not need to set this parameter if the timeline is used only for video production, but not for data storage during editing.
CoverURL String The thumbnail URL of the video track clip. The thumbnail URL must be the same as that of the corresponding video. You do not need to set this parameter if the timeline is used only for video production, but not for data storage during editing.
SpriteURLs String The sprite snapshot URL of the video track clip. Separate multiple sprite snapshot URLs with commas (,). You do not need to set this parameter if the timeline is used only for video production, but not for data storage during editing.
Width Int The width of the stream used during the video track clip editing. Unit: pixels. You do not need to set this parameter if both of the following conditions are met: The timeline is used only for video production, but not for data storage during editing. No effect such as banner text or masking is added during video production.
Height Int The height of the stream used during the video track clip editing. Unit: pixels. You do not need to set this parameter if both of the following conditions are met: The timeline is used only for video production, but not for data storage during editing. No effect such as banner text or masking is added during video production.
Fps Float The frame rate of the video track clip. You do not need to set this parameter if the timeline is used only for video production, but not for data storage during editing.
Bitrate Float The bitrate of the stream used during the video track clip editing. You do not need to set this parameter if the timeline is used only for video production, but not for data storage during editing.
In Float The start time of the video track clip relative to the video. Unit: seconds. The value is precise to four decimal places.
Out Float The end time of the video track clip relative to the video. Unit: seconds. The value is precise to four decimal places.
Duration Float The duration of the video track clip. Unit: seconds. The value is precise to four decimal places.
VirginDuration Float The total duration of the video corresponding to the video track clip. Unit: seconds. The value is precise to four decimal places. You do not need to set this parameter if the timeline is used only for video production, but not for data storage during editing.
TimelineIn Float The start time of the video track clip relative to the timeline. Unit: seconds. The value is precise to four decimal places.
TimelineOut Float The end time of the video track clip relative to the timeline. Unit: seconds. The value is precise to four decimal places.
Effects Effect[] The effect list for the video track clip.

Effect

Parameter Type Description
Type String The type of the effect. Valid values:
Text: indicates banner text added to the video track clip.
DeWatermark: indicates video track clip masking.
Name String The name of the effect.
SubType String The subtype of the effect.
If the Type parameter is set to DeWatermark, set this parameter to Delogo_Blur.
In Float The start time of the effect relative to the video track clip. Unit: seconds. The value is precise to four decimal places.
Out Float The end time of the effect relative to the video track clip. Unit: seconds. The value is precise to four decimal places.
TimelineIn Float The start time of the effect relative to the timeline. Unit: seconds. The value is precise to four decimal places.
TimelineOut Float The end time of the effect relative to the timeline. Unit: seconds. The value is precise to four decimal places.
X String The X coordinate of the effect relative to the upper-left corner of the video image.
Valid values:
   An integer: indicates the pixel value. Valid values: [8,4096]. Unit: pixels.
   A decimal: indicates the ratio of the pixel value to the width in pixels of the resolution of the output video image. Valid values: (0,1). The value is precise to four decimal places, for example, 0.9999. Excessive digits are automatically deleted.
Y String The Y coordinate of the effect relative to the upper-left corner of the video image.
Valid values:
   An integer: indicates the pixel value. Valid values: [8,4096]. Unit: pixels.
   A decimal: indicates the ratio of the pixel value to the height in pixels of the resolution of the output video image. Valid values: (0,1). The value is precise to four decimal places, for example, 0.9999. Excessive digits are automatically deleted.
Width Int The width of the area where the effect is added.
Valid values:
   An integer: indicates the pixel value. Valid values: [8,4096]. Unit: pixels.
   A decimal: indicates the ratio of the pixel value to the width in pixels of the resolution of the output video image. Valid values: (0,1). The value is precise to four decimal places, for example, 0.9999. Excessive digits are automatically deleted.
Height Int The height of the area where the effect is added.
Valid values:
   An integer: indicates the pixel value. Valid values: [8,4096]. Unit: pixels.
   A decimal: indicates the ratio of the pixel value to the width in pixels of the resolution of the output video image. Valid values: (0,1). The value is precise to four decimal places, for example, 0.9999. Excessive digits are automatically deleted.
FEWidth Float The actually displayed width of the video image during editing. Unit: pixels.
FEHeight Float The actually displayed height of the video image during editing. Unit: pixels.
Font String The font. Valid value: SimSun.
FontFace FontFace The appearance of the font. For more information, see FontFace.
FontColor String The color of the font, in hexadecimal format. The value starts with a number sign (#). For example, #ffffff.
FontSize Int The size of the font.
FontColorOpacity Float The transparency of the font. Valid values: 0 and 1. 1: indicates that the font is not transparent. 0: indicates that the font is completely transparent.
Content String The content of banner text.

FontFace

Parameter Type Description
Bold Boolean Indicates whether the font is bold.
Italic Boolean Indicates whether the font is italic.
Underline Boolean Indicates whether the font is underlined.

MediaMetadata

Parameter Type Description
Title String The title of the produced video. Length constraint: Maximum length of 128 bytes. Encoding: UTF-8.
Description String The description of the produced video. Length constraint: Maximum length of 1,024 bytes. Encoding: UTF-8.
CoverURL String The URL of the custom thumbnail for the produced video.
CateId String The category ID of the produced video. To view the category ID, log on to the ApsaraVideo for VOD console and choose Global Settings > Categories in the left-side navigation pane.
Tags String The tags of the produced video. Length constraint per tag: Maximum length of 32 bytes. You can enter a maximum of 16 tags. Separate multiple tags with commas (,). Encoding: UTF-8.

ProduceConfig

Parameter Type Description
TemplateGroupId String The ID of the transcoding template group used to transcode the files produced from videos. The produced files are used as the mezzanine files for transcoding. The transcoding process is similar to that performed after a file is uploaded. This parameter is optional. If you do not set this parameter, the system uses the default template group to transcode the file. If you set this parameter, the system uses the specified template group to transcode the file. To view the template group ID, log on to the ApsaraVideo for VOD console and choose Global Settings > Transcode in the left-side navigation pane.
TemplateId String The ID of the transcoding template used for video production. This parameter is optional. If you do not set this parameter, the system uses the template built in the online editing service for video production, where the codec format is H.264 and the container format is .mp4. If you set this parameter, the system uses the specified template for video production.

Material

Note: Materials for an online editing project can be materials from media assets or videos in the media library.

Parameter Type Description
MaterialId String The ID of the material.
Title String The title of the material.
Description String The description of the material.
Duration Float The material duration. Unit: seconds. The value is precise to four decimal places.
CoverURL String The thumbnail URL of the material.
Status String The material status.
CreationTime String The time when the material was created. The time is displayed in UTC.
Size Long The size of the material mezzanine file. Unit: bytes.
CateId Long The ID of the material category.
CateName String The name of the material category.
Tags String The tag of the material. Separate multiple tags with commas (,).
Snapshots String[] The URL array of material snapshots.
Sprites String[] The URL array of material sprite snapshots.

ProjectStatus

Value Description Remarks
Normal Indicates that the online editing project is in the draft status. The initial status.
Producing Indicates that video production is being performed. -
Produced Indicates that video production succeeds. -
ProduceFailed Indicates that video production fails. -

TranscodeJob

Specifies the information about a media transcoding job.

Parameter Type Description
JobId String The ID of the job.

SnapshotJob

Specifies the information about a video snapshot job.

Parameter Type Description
JobId String The ID of the job.

MediaSnapshot

Specifies the media snapshot data.

Parameter Type Description
JobId String The ID of the video snapshot job.
CreationTime String The time when the video snapshot job was created. The time is displayed in UTC.
Total Long The total number of snapshots.
Regular String The generation rule for the snapshot URL.
Snapshots Snapshot[] The snapshot data.

Snapshot

Specifies the information about a snapshot.

Parameter Type Description
Index String The snapshot index.
Url String The URL of the snapshot.

WatermarkInfo

Parameter Type Required Description
CreationTime String Yes The time when the watermark was created.
Name String Yes The name of the watermark.
IsDefault String Yes Indicates whether the watermark is the default watermark. Valid values: Default and NotDefault.
Type String Yes The type of the watermark. Valid values: Image and Text.
WatermarkId String Yes The ID of the watermark.
FileUrl String No The OSS or CDN URL of the watermark file. A text watermark has no file URL.
WatermarkConfig WatermarkConfig Yes The watermark configurations, such as the display position and effects. The value is a JSON-formatted string. For more information, see Text watermark and Image watermark.

VodTemplateInfo

Parameter Type Description
Name String The name of the template.
VodTemplateId String The ID of the template.
TemplateType String The type of the template.
IsDefault String Indicates whether the template is the default template. Valid values: Default and NotDefault.
TemplateConfig SnapshotTemplateConfig The detailed template configuration. The value is a JSON-formatted string.
CreationTime String The time when the template was created. The time is displayed in UTC.
ModifyTime String The time when the template was last modified. The time is displayed in UTC.

TranscodeTemplateGroup

Parameter Type Required Description
Name String Yes The name of the transcoding template group.
TranscodeTemplateGroupId String Yes The ID of the transcoding template group.
IsDefault String Yes Indicates whether the transcoding template group is the default one. Valid values:
  • Default
  • NotDefault
CreationTime String Yes The time when the transcoding template group was created.
ModifyTime String Yes The time when the transcoding template group was last modified.
TranscodeTemplateList TranscodeTemplate[] Yes The configuration list of the transcoding template group.

TranscodeTemplate

Parameter Type Required Description
Video Video Yes The transcoding configuration parameters of the video stream. The value is a JSON-formatted string.
Audio Audio Yes The transcoding configuration parameters of the audio stream. The value is a JSON-formatted string.
Definition String Yes
    Valid values for the definition of a normal transcoding template:
  • LD: indicates low definition.
  • SD: indicates standard definition.
  • HD: indicates high definition.
  • FHD: indicates ultra high definition.
  • OD: indicates original quality (used for format conversion).
  • 2K.
  • 4K.
  • SQ: indicates standard sound quality.
  • HQ: indicates high sound quality.
    Valid values for the definition of a built-in Narrowband HD™ 1.0 transcoding template:
  • LD-NBV1: indicates low definition.
  • SD-NBV1: indicates standard definition.
  • HD-NBV1: indicates high definition.
  • FHD-NBV1: indicates ultra high definition.
  • 2K-NBV1.
  • 4K-NBV1.
    Note:
  • 1. You are not allowed to modify the definition of any transcoding templates.
  • 2. You are not allowed to modify the system parameters, such as the video resolution, audio resolution, and bitrate, of Narrowband HD™ 1.0 transcoding templates. For more information about the parameters, see Narrowband HD.
  • 3. You can only create Narrowband HD™ 1.0 transcoding templates that support the FLV, M3U8 (HLS), and MP4 output formats.
Container Container Yes The format of the container used to encapsulate audio and video streams. The value is a JSON-formatted string.
MuxConfig MuxConfig No The transcoding segment configuration. You must set this parameter if Format in the Container parameter is set to HLS. The value is a JSON-formatted string.
TransConfig TransConfig No The conditional transcoding configuration. You can set this parameter if you need to determine the basic logic based on the bitrate and resolution of the mezzanine file before generating the transcoded video. The value is a JSON-formatted string.
TranscodeFileRegular String No The custom transcoding output path.
    Note:
  • The following wildcards are supported: {MediaId} (indicates the video ID), {JobId} (indicates the transcoding job ID), and {PlayDefinition} (indicates the definition returned by the GetPlayInfo operation).
  • The value can only contain digits, English characters, braces ({}), slashes (/), hyphens (-), and underscores (_). Length constraint: Maximum length of 128 characters.
  • The value must start with {MediaId}.
  • Configuration example:{MediaId}/watermark-{PlayDefinition}. During transcoding, the system replaces {MediaId} with the corresponding video ID (for example,8ff5cc93f6da4079a47a77bf71d) and replaces {PlayDefinition} with the definition (for example, fd).
  • Output example: 8ff5cc93f6da4079a47a77bf71d/watermark-fd.mp4 (The system automatically adds the file name extension, such as .mp4, .m3u8, or .flv.)
Clip Clip No The video clipping configuration. The value is a JSON-formatted string. For example, you can set this parameter to extract 5 seconds of content from a video to generate a new video.
Rotate String No The video rotation identifier, used to control the image rotation angle. For example, if you set this parameter to 180, the video image is turned upside down.
  • Valid values:[0,360]
EncryptSetting EncryptSetting No The transcoding encryption configuration.
PackageSetting PackageSetting No The packaging configuration. Only HLS packaging and DASH packaging are supported. The value is a JSON-formatted string.
SubtitleList SubtitleConfig No The subtitle configuration. The value is a JSON-formatted string.
WatermarkIds String[] No The ID of the associated watermark.
  • A transcoding template ID can be associated with a maximum of four watermark IDs.
  • USER_DEFAULT_WATERMARK indicates the ID of the default watermark.
TranscodeTemplateId String No The ID of the transcoding template. You must set this parameter when modifying a transcoding template.
TemplateName String No The name of the transcoding template. You must set this parameter when adding a transcoding template.

Example of the TranscodeTemplate parameter

  1. {
  2. "Video":{
  3. "Codec":"H. 264",
  4. "Bitrate":"900",
  5. "Width":"960",
  6. "Remove":"false",
  7. "Fps":"30"
  8. },
  9. "Audio":{
  10. "Codec":"AAC",
  11. "Bitrate":"128",
  12. "Samplerate":"44100"
  13. },
  14. "Container":{
  15. "Format":"m3u8"
  16. },
  17. "MuxConfig":{
  18. "Segment":{
  19. "Duration":"6"
  20. }
  21. },
  22. "EncryptSetting":{
  23. "EncryptType":"Private"
  24. },
  25. "PackageSetting":{
  26. "PackageType":"HLSPackage"
  27. "PackageConfig":{
  28. "BandWidth":"900000"
  29. }
  30. },
  31. "WatermarkIds":["USER_DEFAULT_WATERMARK","ddddddddd"],
  32. "Definition":"SD",
  33. "TemplateName":"test"
  34. }

Video

Note:

  • Unless otherwise required, you only need to set the Codec, Bitrate, Height, and Width parameters and set the Remove parameter to false.
  • We recommend that you set only one of the Width and Height parameters for a transcoded video.This ensures that the aspect ratio of the transcoded video is the same as that of the mezzanine file.
Parameter Type Required Description
Codec String Yes The video codec format. Valid values: H. 264 and H. 265.
Remove String Yes Indicates whether to delete the video stream. Valid values: true and false.
  • A value of true indicates that the video stream is deleted for the transcoded video file.
  • A value of false indicates that the video stream is retained for the transcoded video file.
  • Default value: false.
Bitrate String No The target bitrate of the transcoded video file. If you do not set this parameter, the bitrate is generated based on the value of the Crf parameter.
  • Valid values: [10,50000].
  • Unit: kbit/s.
Height String No The image height of the transcoded video file. The value must be a multiple of 2. If you do not set this parameter, the image height of the mezzanine file is used.
  • Valid values: [128,4096].
  • Unit: pixels.
Width String No The image width of the transcoded video file. The value must be a multiple of 2. If you do not set this parameter, the image width of the mezzanine file is used.
  • Valid values: [128,4096].
  • Unit: pixels.
Fps String No The frame rate of the transcoded video file. If you do not set this parameter, the frame rate of the mezzanine file is used.
  • Valid values: (0,60].
  • Unit: fps.
Gop String No The gap between adjacent keyframes.
  • Valid values:[1-100000].
  • Unit: frames.
LongShortMode String No Indicates whether to enable auto-rotate screen (the long-short side mode). The image width of the transcoded video file corresponds to the long side of the mezzanine file (the image height of the mezzanine file in portrait mode). The image height of the transcoded video file corresponds to the short side of the mezzanine file (the image width of the mezzanine file in portrait mode).
  • Valid values: true and false.
  • true: indicates that auto-rotate screen is enabled.
  • false: indicates that auto-rotate screen is disabled.
  • Default value: true.
  • This feature is applicable to videos in portrait mode.
(We recommend that you enable this feature.)
Crf String No The bitrate quality control factor. If you set this parameter, the Bitrate parameter is invalid. A greater value indicates a poorer image quality of the transcoded video file and a smaller file size. A smaller value indicates a better image quality of the transcoded video file, a larger file size, and a longer transcoding time.
  • Valid values: [0,51].
  • Default value: 26.
(We recommend that you do not modify the value of this parameter.)
Profile String No The encoding level.
  • Valid values: baseline, main, and high.
  • Default value: high.
  • baseline: applicable to mobile devices.
  • main: applicable to standard-definition devices.
  • high: applicable to high-definition devices.
  • Currently, this parameter is valid only when the Codec parameter is set to H.264.
Best practice: If multiple definitions exist, we recommend that you set the Profile parameter to baseline for the lowest definition to guarantee normal playback on low-end devices. Set the Profile parameter to main or high for other definitions.
Preset String No The preset video algorithm.
  • Valid values: veryfast, fast, medium, slow, and slower.
  • Default value: medium.
  • Currently, this parameter is valid only when the Codec parameter is set to H.264.
(We recommend that you do not modify the value of this parameter.)
ScanMode String No The scan mode. Valid values:
  • interlaced
  • progressive
Bufsize String No The buffer size.
  • Valid values: [1000,128000].
  • Default value: 6000.
  • Unit: KB.
Maxrate String No The peak video bitrate.
  • Valid values: [1000,50000].
  • Unit: kbit/s.
PixFmt String No The video color format.
  • Valid values: standard color formats, such as yuv420p and yuvj420p.
  • Default value: yuv420p or the original color format.

Example of the Video parameter

  1. {
  2. "Codec":"H. 264",
  3. "Bitrate":"128",
  4. "Remove":"false",
  5. "Width":"640",
  6. "Fps":"30"
  7. }

Audio

Note: Unless otherwise required, you only need to set the Codec and Bitrate parameters and set the Remove parameter to false.

Parameter Type Required Description
Codec String Yes The audio codec format. Valid values: AAC and MP3.
Bitrate String Yes The target bitrate of the transcoded audio file.
  • Valid values: [8,1000].
  • Unit: kbit/s.
Remove String Yes Indicates whether to delete the audio stream. Valid values: true and false.
  • A value of true indicates that the audio stream is deleted for the transcoded audio file.
  • A value of false indicates that the audio stream is retained for the transcoded audio file.
  • Default value: false.
Samplerate String Yes The sampling rate.
  • Valid values: 22050, 32000, 44100, 48000, and 96000.
  • Default value: 44100.
  • Unit: Hz.
  • If Format of the Container parameter is set to flv and the Codec parameter in the Audio structure is set to MP3, this parameter cannot be set to 32000, 48000, or 96000.
  • If the Codec parameter in the Audio structure is set to MP3, this parameter cannot be set to 96000.
Channels String No The number of sound channels.
  • Default value: 2.
  • If the Codec parameter is set to MP3, this parameter can only be set to 1 or 2.
  • If the Codec parameter is set to AAC, this parameter can only be set to 1, 2, 4, 5, 6, or 8.
Profile String No The audio codec profile.
  • Valid values if the Codec parameter is set to AAC: aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.
Volume Volume No The volume.

Example of the Audio parameter

  1. {
  2. "Codec":"AAC",
  3. "Bitrate":"128",
  4. "Remove":"false",
  5. "Samplerate":"44100"
  6. }

Container

Parameter Type Required Description
Format String Yes The container format.
  • Valid values of video streams: flv, mp4, HLS (m3u8+ts).
  • Valid values of audio streams: mp3 and mp4.
  • If this parameter is set to flv, the Codec parameter in the Video structure cannot be set to H. 265.

Example of the Container parameter

  1. {
  2. "Format":"mp4"
  3. }

MuxConfig

Note: You must set this parameter if Format of the Container parameter is set to m3u8.

Parameter Type Required Description
Segment Segment Yes The segment configuration. The value is a JSON object.

Segment

Parameter Type Required Description
Duration String Yes The TS segment duration. The value is an integer.
  • Valid values:[1,60].
  • Unit: seconds.
  • Example: {“Duration”:”10”}.

Example of the MuxConfig parameter

  1. {
  2. "Segment":{
  3. "Duration":"10"
  4. }
  5. }

TransConfig

Parameter Type Required Description
TransMode String No The transcoding mode.
  • Valid values: onepass, twopass, and CBR.
  • Default value: onepass.
IsCheckReso String No Indicates whether to check the resolution of the mezzanine file. The system then determines whether to use the resolution of the mezzanine file for transcoding based on the check result. Valid values: true and false.
  • true: indicates that the resolution of the mezzanine file is checked. If the system determines, based on the width or height, that the target resolution is higher than the resolution of the mezzanine file, the resolution of the mezzanine file is retained after transcoding.
  • false: indicates that the resolution of the mezzanine file is not checked.
  • Default value: false.
IsCheckResoFail String No Indicates whether to check the resolution of the mezzanine file to determine a transcoding failure. Valid values: true and false.
  • true: indicates that the resolution of the mezzanine file is checked. If the system determines, based on the width or height, that the target resolution is higher than the resolution of the mezzanine file, an error indicating a transcoding failure is returned.
  • false: indicates that the resolution of the mezzanine file is not checked.
  • Default value: false.
IsCheckVideoBitrate String No Indicates whether to check the video stream bitrate of the mezzanine file. The system then determines whether to use the video stream bitrate of the mezzanine file for transcoding based on the check result. Valid values: true and false.
  • true: indicates that the video stream bitrate of the mezzanine file is checked. If the system determines that the target video stream bitrate is higher than the video stream bitrate of the mezzanine file, the video stream bitrate of the mezzanine file is retained after transcoding.
  • false: indicates that the video stream bitrate of the mezzanine file is not checked.
  • Default value: false.
IsCheckVideoBitrateFail String No Indicates whether to check the video stream bitrate of the mezzanine file to determine a transcoding failure. Valid values: true and false.
  • true: indicates that the video stream bitrate of the mezzanine file is checked. If the system determines that the target video stream bitrate is higher than the video stream bitrate of the mezzanine file, no transcoding is performed.
  • false: indicates that the video stream bitrate of the mezzanine file is not checked.
  • Default value: false.
  • The priority of this parameter is higher than that of the IsCheckVideoBitrate parameter.
IsCheckAudioBitrate String No Indicates whether to check the audio stream bitrate of the mezzanine file. The system then determines whether to use the audio stream bitrate of the mezzanine file for transcoding based on the check result. Valid values: true and false.
  • true: indicates that the audio stream bitrate of the mezzanine file is checked. If the system determines that the target audio stream bitrate is higher than the audio stream bitrate of the mezzanine file, the audio stream bitrate of the mezzanine file is retained after transcoding.
  • false: indicates that the audio stream bitrate of the mezzanine file is not checked.
  • Default value: false.
IsCheckAudioBitrateFail String No Indicates whether to check the audio stream bitrate of the mezzanine file to determine a transcoding failure. Valid values: true and false.
  • true: indicates that the audio stream bitrate of the mezzanine file is checked. If the system determines that the target audio stream bitrate is higher than the audio stream bitrate of the mezzanine file, no transcoding is performed.
  • false: indicates that the audio stream bitrate of the mezzanine file is not checked.
  • Default value: false.
  • The priority of this parameter is higher than that of the IsCheckAudioBitrate parameter.

Example of the TransConfig parameter

  1. {
  2. "IsCheckReso":"true",
  3. "IsCheckResoFail":"false",
  4. "IsCheckVideoBitrate":"false",
  5. "IsCheckVideoBitrateFail":"false",
  6. "IsCheckAudioBitrate":"false",
  7. "IsCheckAudioBitrateFail":"false"
  8. }

Clip

Parameter Type Required Description
TimeSpan TimeSpan Yes The time span configuration for video clipping.

TimeSpan

Parameter Type Required Description
Seek String Yes The start time for video clipping.
    (Recommended) Format 1:
  • sssss[.SSS]
  • Valid values: [0.000, 86399.999]
  • Example: 12000.556
    Format 2:
  • hh:mm:ss[.SSS]
  • Valid values: [00:00:00.000,23:59:59.999]
  • Example: 00:00:05.003
Duration String No The video clipping duration.
    (Recommended) Format 1:
  • sssss[.SSS]
  • Valid values: [0.000, 86399.999]
  • Example: 12000.556
    Format 2:
  • hh:mm:ss[.SSS]
  • Valid values: [00:00:00.000,23:59:59.999]
  • Example: 00:00:05.003
End String No The duration of the tail to be discarded during video clipping.
    (Recommended) Format 1:
  • sssss[.SSS]
  • Valid values: [0.000, 86399.999]
  • Example: 12000.556
    Format 2:
  • hh:mm:ss[.SSS]
  • Valid values: [00:00:00.000,23:59:59.999]
  • Example: 00:00:05.003
    Note:
  • If you set this parameter, the Duration parameter is invalid.
  • The sum of the Seek and End parameter values cannot be greater than the total video duration.

Note: You must set either of the Duration and End parameters.

EncryptSetting

Note: Before standard HLS encryption, you need to set EncryptType to AliyunVoDEncryption and call the SubmitTranscodeJobs operation to start standard HLS encryption and transcoding.

Parameter Type Required Description
EncryptType String Yes The encryption type.
  • Valid value: AliyunVoDEncryption, which is valid only for HLS (m3u8) encryption.

Example of the EncryptSetting parameter

  1. {
  2. "EncryptType":"AliyunVoDEncryption"
  3. }

PackageSetting

Note:

  • Currently, you cannot package video and audio streams after extracting them from files.
  • In HLS packaging mode, the output video must be in M3U8 format.
  • In DASH packaging mode, the output video must be in MPD format.
Parameter Type Required Description
PackageType String Yes The packaging type.
  • Valid values: HLSPackage and DASHPackage.
PackageConfig PackageConfig Yes The packaging configuration.

PackageConfig

Note: You must set this parameter only if the PackageType parameter is set to HLSPackage.

Parameter Type Required Description
BandWidth String Yes The maximum bandwidth. You must set this parameter for HLS packaging.
  • Unit: bit/s.

Example of the PackageSetting parameter

  1. {
  2. "PackageType":"HLSPackage",
  3. "PackageConfig":{
  4. "BandWidth":"400000"
  5. }
  6. }

SubtitleConfig

Parameter Type Required Description
SubtitleUrl String Yes The OSS URL of the subtitle file. (The HTTPS URL is not supported.)
CharEnc String Yes The codec format.
  • Valid values: auto (indicating automatic detection), UTF-8, GBK, and BIG5.
  • Default value: UTF-8.

Note: For more information about how to upload a subtitle file, see Obtain the upload URL and credential for an attached media asset and Upload files to OSS.

Example of the SubtitleConfig parameter

  1. {
  2. "SubtitleUrl": "http://outin-40564284ef058b2d300163e1403e7.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8edde0e.ass",
  3. "CharEncode": "UTF-8"
  4. }

Example of the SubtitleList parameter

  1. [
  2. {
  3. "SubtitleUrl": "http://outin-40564284ef058b2163e1403e7.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8edde0e-cn.ass",
  4. "CharEncode": "UTF-8"
  5. },
  6. {
  7. "SubtitleUrl": "http://outin-40564284ef058b2d3001403e7.oss-cn-shanghai.aliyuncs.com/subtitles/rrrr-14f1-4364-b107-d5f7f8edde0e-en.srt",
  8. "CharEncode": "auto"
  9. }
  10. ]

Volume

Parameter Type Required Description
Method String No The volume adjustment method. Valid values: auto, dynamic, and linear.
IntegratedLoudnessTarget String No The target volume. The value is a number. Value range: [-70, -5]. This parameter is valid only when Method is set to dynamic. Default value: -6.
TruePeak String No The peak value. The value is a number. Valid values: [-9, 0]. This parameter is valid only when Method is set to dynamic. Default value: -1.
LoudnessRangeTarget String No The volume range. The value is a number. Valid values: [1, 20]. This parameter is valid only when Method is set to dynamic. Default value: 8.

Example of the Volume parameter

  1. {
  2. "Method":"dynamic",
  3. "IntegratedLoudnessTarget":"auto",
  4. "TruePeak":"-1",
  5. "LoudnessRangeTarget":"8"
  6. }

Supported combinations of Container and Codec in the Audio structure

Container Codec in Audio
mp3 MP3
mp4 AAC
ogg VORBIS and FLAC
flac FLAC

Supported combinations of Container and Codec in the Audio and Video structures

Container Codec in Video Codec in Audio
flv H.264 AAC and MP3
mp4 H.264 and H. 265 AAC and MP3
ts H.264 and H. 265 AAC and MP3
m3u8 H.264 and H. 265 AAC and MP3
gif GIF Not supported

Supported combinations of Codec in the Video structure and various video stream parameters

Codec in Video H.264 H.265 GIF
Profile × ×
Bitrate ×
Crf ×
Width
Height
Fps
Gop ×
Preset × ×
ScanMode
Bufsize ×
Maxrate ×
PixFmt bgr8

TranscodeSummary

Parameter Type Description
VideoId String The ID of the video.
TranscodeTemplateGroupId String The ID of the transcoding template group.
TranscodeStatus String The transcoding status. Valid values:
  • Processing: indicates that the video is being processed.
  • Partial: indicates that the transcoding process is completed only on certain code streams.
  • CompleteAllSucc: indicates that the transcoding process is completed on all code streams and all code streams have been transcoded.
  • CompleteAllFail: indicates that the transcoding process is completed on all code streams but all code streams fail to be transcoded. If the video mezzanine file has a problem, no transcoding job is started, and the transcoding fails.
  • CompletePartialSucc: indicates that the transcoding process is completed on all code streams but only certain code streams have been transcoded.
TranscodeJobInfoSummaryList TranscodeJobInfoSummary[] The list of the transcoding job summary.
CreationTime String The time when the transcoding job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
CompleteTime String The completion time of the transcoding job. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

TranscodeJobInfoSummary

Parameter Type Description
TranscodeTemplateId String The ID of the transcoding template.
Width String The image width of the transcoded video. Unit: pixels.
Height String The image height of the transcoded video. Unit: pixels.
Duration String The duration of the transcoded video. Unit: seconds.
Filesize String The size of the transcoded video file. Unit: bytes.
Bitrate String The average bitrate of the transcoded video. Unit: kbit/s.
Fps String The frame rate of the transcoded video. Unit: fps.
Format String The container format of the transcoded video.
WatermarkIdList String[] The ID list of watermarks used for the transcoded video.
TranscodeProgress Long The transcoding progress.
  • Valid value:[0,100]
TranscodeJobStatus String The transcoding job status. Valid values:
  • Transcoding
  • TranscodeSuccess
  • TranscodeFail
CreationTime String The time when the transcoding job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
CompleteTime String The completion time of the transcoding job. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
ErrorCode String The error code of the transcoding failure.
ErrorMessage String The error message of the transcoding failure.

TranscodeTask

Parameter Type Description
TranscodeTaskId String The ID of the transcoding job.
TranscodeTemplateGroupId String The ID of the transcoding template group.
VideoId String The ID of the video.
TaskStatus String The transcoding job status. Valid values:
  • Processing: indicates that the video is being processed.
  • Partial: indicates that the transcoding process is completed only on certain code streams.
  • CompleteAllSucc: indicates that the transcoding process is completed on all code streams and all code streams have been transcoded.
  • CompleteAllFail: indicates that the transcoding process is completed on all code streams but all code streams fail to be transcoded. If the video mezzanine file has a problem, no transcoding job is started, and the transcoding fails.
  • CompletePartialSucc: indicates that the transcoding process is completed on all code streams but only certain code streams have been transcoded.
CreationTime String The time when the transcoding job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
CompleteTime String The completion time of the transcoding job. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
Trigger String The trigger type. Valid values:
  • Auto: indicates that transcoding is automatically triggered after a video is uploaded.
  • Manual: indicates that transcoding is triggered through the SubmitTranscodeJobs operation.
TranscodeJobInfoList TranscodeJobInfo The transcoding job information.

TranscodeJobInfo

Parameter Type Description
TranscodeTaskId String The ID of the transcoding job.
TranscodeJobId String The ID of the transcoding job.
VideoId String The ID of the video.
TranscodeProgress Long The transcoding job progress.
  • Valid values: [0,100]
TranscodeJobStatus String The transcoding job status. Valid values:
  • Transcoding
  • TranscodeSuccess
  • TranscodeFail
Priority String The priority of the transcoding job.
Definition String The definition.
  • Note: This parameter indicates the definition configured for the transcoding template and does not indicate the actual resolution range of the transcoded video.
TranscodeTemplateId String The ID of the transcoding template.
CreationTime String The time when the transcoding job was created.
CompleteTime String The completion time of the transcoding job.
InputFileUrl String The OSS URL of the mezzanine file.
OutputFile OutputFile The transcoded file information.
ErrorCode String The error code of the transcoding failure.
ErrorMessage String The error message of the transcoding failure.

OutputFile

Parameter Type Description
OutputFileUrl String The OSS URL of the transcoded video.
Format String The container format of the transcoded video.
Width String The image width of the transcoded video. Unit: pixels.
Height String The image height of the transcoded video. Unit: pixels.
Duration String The duration of the transcoded video. Unit: seconds.
Bitrate String The average bitrate of the transcoded video. Unit: kbit/s.
Fps String The frame rate of the transcoded video. Unit: fps.
Filesize Long The size of the transcoded video file. Unit: bytes.
EncryptType String The encryption type used for the transcoded video. The value is a JSON-formatted string.
WatermarkIdList String The ID list of watermarks used for the transcoded video.
VideoStreamList String The list of video streams. For more information, see the description of VideoStream.
AudioStreamList String The list of audio streams. For more information, see the description of AudioStreamList.

ImageInfo

Specifies the information about an image.

Parameter Type Description
ImageId String The ID of the image.
URL String The URL of the image. If a CDN domain name was specified, a CDN URL was returned. Otherwise, an OSS URL was returned.
Title String The title of the image.
Tags String The tag of the image.
ImageType String The type of the image.
CateId Long The ID of the category.
CateName String The name of the category.
Description String The description of the image.
StorageLocation String The bucket for storing files.
Mezzanine Mezzanine The image mezzanine file information.
CreationTime String The time when the image was created. The time is displayed in UTC.
Status String The image status.
AppId String The application ID.

Mezzanine

Parameter Type Description
FileURL String The OSS URL of the image.
OriginalFileName String The name of the mezzanine file.
FileSize Long The size of the mezzanine file. Unit: bytes.
Width Integer The width of the image. Unit: pixels.
Height Integer The height of the image. Unit: pixels.

URLUploadInfo

Specifies the information about an upload job based on the mezzanine file URL.

Parameter Type Description
JobId String The ID of the upload job.
UploadURL String The URL of the video to be uploaded.
MediaId String The ID of the video to be uploaded.
Status String The upload status.
CreationTime String The start time of the upload job.
CompleteTime Long The completion time of the upload job.
UserData String The user-defined field.
ErrorCode String The error code.
ErrorMessage String The error message.

Status

Specifies the valid values of the Status parameter for an upload job based on the mezzanine file URL.

Value Description
PENDING The job is submitted and is to be processed.
PROCESSING The job is being processed.
DOWNLOADING The file is being downloaded.
DOWNLOAD_SUCCESS The file is downloaded.
DOWNLOAD_FAIL The file fails to be downloaded.
UPLOADING The file is being uploaded.
UPLOAD_SUCCESS The file is uploaded.
UPLOAD_FAIL The file fails to be uploaded.
SUCCESS The job is successful and the callback is completed.

AttachedMediaInfo

Specifies the information about an attached media asset.

Parameter Type Description
MediaId String The ID of the attached media asset.
URL String The URL of the attached media asset. If a CDN domain name was specified, a CDN URL was returned. Otherwise, an OSS URL was returned.
Title String The title of the attached media asset.
Tags String The tag of the attached media asset.
Type String The type of the attached media asset.
Categories Category[] The category list.
Description String The description of the attached media asset.
StorageLocation String The bucket for storing files.
CreationTime String The time when the attached media asset was created. The time is displayed in UTC.
ModificationTime String The time when the attached media asset was last modified. The time is displayed in UTC.
Status String The status of the attached media asset.
AppId String The application ID.

Status

Specifies the valid values of the Status parameter for an attached media asset.

Value Description Remarks
Uploading Indicates that the attached media asset is being uploaded. The initial status.
Normal Indicates that the attached media asset has been uploaded. -
UploadFail Indicates that the attached media asset fails to be uploaded. -

MessageCallback

Specifies the configuration of an event notification.

Parameter Type Description
CallbackType String The callback method. Valid values: HTTP and MNS.
CallbackURL String When you set the CallbackType parameter to HTTP, this parameter indicates the callback URL.
MnsEndpoint String When you set the CallbackType parameter to MNS, this parameter indicates the Internet endpoint of Message Service (MNS).
MnsQueueName String When you set the CallbackType parameter to MNS, this parameter indicates the name of the MNS queue.
EventTypeList String The type of the callback event.
AuthSwitch String When you set the CallbackType parameter to HTTP, this parameter indicates whether to enable callback authentication. Valid values: on and off.
AuthKey String When you set the CallbackType parameter to HTTP, this parameter indicates the cryptographic key.

AppInfo

Specifies the information about an application.

Parameter Type Description
AppId String The ID of the application.
AppName String The name of the application.
Description String The description of the application.
Type String The type of the application. Valid values: System (indicating the default application) and Custom (indicating the custom application).
Status String The application status. Valid values: Normal and Disable.
CreationTime String The time when the application was created. The time is displayed in UTC.
ModificationTime String The time when the application was last modified. The time is displayed in UTC.

AppPolicy

Specifies the information about an authorization policy for an application.

Parameter Type Description
AppId String The ID of the application.
PolicyType String The type of the policy. Valid values: System and Custom.
PolicyName String The name of the policy.
CreationTime String The time when the policy was created. The time is displayed in UTC.
Description String The description of the policy.