tencent cloud

APIs

Data Types

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-09-18 15:52:32

AIAnalysisTemplateItem

Used by actions: DescribeAIAnalysisTemplates.

Name Type Description
Definition Integer
Name String
Comment String
ClassificationConfigure ClassificationConfigureInfo
TagConfigure TagConfigureInfo
CoverConfigure CoverConfigureInfo
FrameTagConfigure FrameTagConfigureInfo
HighlightConfigure HighlightsConfigureInfo
CreateTime String
UpdateTime String

AIRecognitionTemplateItem

Used by actions: DescribeAIRecognitionTemplates.

Name Type Description
Definition Integer
Name String
Comment String
Type String
HeadTailConfigure HeadTailConfigureInfo
SegmentConfigure SegmentConfigureInfo
FaceConfigure FaceConfigureInfo
OcrFullTextConfigure OcrFullTextConfigureInfo
OcrWordsConfigure OcrWordsConfigureInfo
AsrFullTextConfigure AsrFullTextConfigureInfo
AsrWordsConfigure AsrWordsConfigureInfo
AsrTranslateConfigure AsrTranslateConfigureInfo
ObjectConfigure ObjectConfigureInfo
ScreenshotInterval Float
CreateTime String
UpdateTime String

AbnormalLightingConfigureInfo

Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

Name Type Required Description
Switch String Yes

AbnormalLightingConfigureInfoForUpdate

Used by actions: ModifyQualityInspectTemplate.

Name Type Required Description
Switch String No

AccelerateAreaInfo

Used by actions: DescribeVodDomains.

Name Type Description
Area String
TencentDisableReason String
TencentEdgeDomain String

AdaptiveDynamicStreamingInfoItem

Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

Name Type Description
Definition Integer
Package String
DrmType String
Url String
Size Integer
DigitalWatermarkType String
SubStreamSet Array of MediaSubStreamInfoItem
CopyRightWatermarkText String
BlindWatermarkDefinition Integer
SubtitleSet Array of MediaSubtitleItem
DefaultSubtitleId String
DrmEncryptType String

AdaptiveDynamicStreamingTaskInput

Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

Name Type Required Description
Definition Integer Yes
WatermarkSet Array of WatermarkInput No
TraceWatermark TraceWatermarkInput No
CopyRightWatermark CopyRightWatermarkInput No
BlindWatermark BlindWatermarkInput No
SubtitleSet Array of String No
SubtitleInfoSet Array of SubtitleInfoInput No
DrmInfo ThirdPartyDrmInfo No

AdaptiveDynamicStreamingTemplate

Used by actions: DescribeAdaptiveDynamicStreamingTemplates.

Name Type Description
Definition Integer
Type String
Name String
Comment String
Format String
DrmType String
DrmKeyProvider String
DrmEncryptType String
StreamInfos Array of AdaptiveStreamTemplate
DisableHigherVideoBitrate Integer
DisableHigherVideoResolution Integer
CreateTime String
UpdateTime String
SegmentType String
SegmentDuration Integer

AdaptiveStreamTemplate

Used by actions: CreateAdaptiveDynamicStreamingTemplate, DescribeAdaptiveDynamicStreamingTemplates, ModifyAdaptiveDynamicStreamingTemplate.

Name Type Required Description
Video VideoTemplateInfo Yes
Audio AudioTemplateInfo Yes
RemoveAudio Integer No
RemoveVideo Integer No
TEHDConfig TEHDConfig No
EnhanceConfig EnhanceConfig No
StdExtInfo String No

AdvancedElementInfo

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
ElementId String
ElementInfo String

AdvancedSuperResolutionConfig

Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

Name Type Required Description
Switch String No
Type String No
Mode String No
Percent Float No
Width Integer No
Height Integer No
LongSide Integer No
ShortSide Integer No

AiAnalysisResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Type String
ClassificationTask AiAnalysisTaskClassificationResult
CoverTask AiAnalysisTaskCoverResult
TagTask AiAnalysisTaskTagResult
FrameTagTask AiAnalysisTaskFrameTagResult
HighlightTask AiAnalysisTaskHighlightResult

AiAnalysisTaskClassificationInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiAnalysisTaskClassificationOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
ClassificationSet Array of MediaAiAnalysisClassificationItem
ClassificationSetFileUrl String
ClassificationSetFileUrlExpireTime String

AiAnalysisTaskClassificationResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiAnalysisTaskClassificationInput
Output AiAnalysisTaskClassificationOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiAnalysisTaskCoverInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiAnalysisTaskCoverOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
CoverSet Array of MediaAiAnalysisCoverItem
CoverSetFileUrl String
CoverSetFileUrlExpireTime String

AiAnalysisTaskCoverResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiAnalysisTaskCoverInput
Output AiAnalysisTaskCoverOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiAnalysisTaskFrameTagInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiAnalysisTaskFrameTagOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
SegmentSet Array of MediaAiAnalysisFrameTagSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiAnalysisTaskFrameTagResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiAnalysisTaskFrameTagInput
Output AiAnalysisTaskFrameTagOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiAnalysisTaskHighlightInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiAnalysisTaskHighlightOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
HighlightSet Array of MediaAiAnalysisHighlightItem
HighlightSetFileUrl String
HighlightSetFileUrlExpireTime String

AiAnalysisTaskHighlightResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiAnalysisTaskHighlightInput
Output AiAnalysisTaskHighlightOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiAnalysisTaskInput

Used by actions: CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ProcessMediaByUrl, ResetProcedureTemplate.

Name Type Required Description
Definition Integer Yes

AiAnalysisTaskTagInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiAnalysisTaskTagOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
TagSet Array of MediaAiAnalysisTagItem
TagSetFileUrl String
TagSetFileUrlExpireTime String

AiAnalysisTaskTagResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiAnalysisTaskTagInput
Output AiAnalysisTaskTagOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiContentReviewResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Type String
PornTask AiReviewTaskPornResult
TerrorismTask AiReviewTaskTerrorismResult
PoliticalTask AiReviewTaskPoliticalResult
PornAsrTask AiReviewTaskPornAsrResult
PornOcrTask AiReviewTaskPornOcrResult
PoliticalAsrTask AiReviewTaskPoliticalAsrResult
PoliticalOcrTask AiReviewTaskPoliticalOcrResult
TerrorismOcrTask AiReviewTaskTerrorismOcrResult
ProhibitedOcrTask AiReviewTaskProhibitedOcrResult
ProhibitedAsrTask AiReviewTaskProhibitedAsrResult

AiContentReviewTaskInput

Used by actions: CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ProcessMediaByUrl, ResetProcedureTemplate.

Name Type Required Description
Definition Integer Yes

AiCutOutConfig

Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

Name Type Required Description
Switch String No
Type String No
PatternConfig PatternConfig No
Model String No

AiRecognitionResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Type String
HeadTailTask AiRecognitionTaskHeadTailResult
SegmentTask AiRecognitionTaskSegmentResult
FaceTask AiRecognitionTaskFaceResult
AsrWordsTask AiRecognitionTaskAsrWordsResult
AsrFullTextTask AiRecognitionTaskAsrFullTextResult
AsrTranslateTask AiRecognitionTaskAsrTranslateResult
OcrWordsTask AiRecognitionTaskOcrWordsResult
OcrFullTextTask AiRecognitionTaskOcrFullTextResult
ObjectTask AiRecognitionTaskObjectResult

AiRecognitionTaskAsrFullTextResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiRecognitionTaskAsrFullTextResultInput
Output AiRecognitionTaskAsrFullTextResultOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiRecognitionTaskAsrFullTextResultInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiRecognitionTaskAsrFullTextResultOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
SegmentSet Array of AiRecognitionTaskAsrFullTextSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String
SubtitleSet Array of AiRecognitionTaskAsrFullTextResultOutputSubtitleItem
SubtitleUrl String

AiRecognitionTaskAsrFullTextResultOutputSubtitleItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Id String
Name String
Language String
Format String
Url String

AiRecognitionTaskAsrFullTextSegmentItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
StartTimeOffset Float
EndTimeOffset Float
Text String

AiRecognitionTaskAsrTranslateResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiRecognitionTaskAsrTranslateResultInput
Output AiRecognitionTaskAsrTranslateResultOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiRecognitionTaskAsrTranslateResultInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiRecognitionTaskAsrTranslateResultOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
SegmentSet Array of AiRecognitionTaskAsrTranslateSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String
SubtitleSet Array of AiRecognitionTaskAsrFullTextResultOutputSubtitleItem

AiRecognitionTaskAsrTranslateSegmentItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
StartTimeOffset Float
EndTimeOffset Float
Text String
Translation String

AiRecognitionTaskAsrWordsResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiRecognitionTaskAsrWordsResultInput
Output AiRecognitionTaskAsrWordsResultOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiRecognitionTaskAsrWordsResultInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiRecognitionTaskAsrWordsResultItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Word String
SegmentSet Array of AiRecognitionTaskAsrWordsSegmentItem

AiRecognitionTaskAsrWordsResultOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
ResultSet Array of AiRecognitionTaskAsrWordsResultItem
ResultSetFileUrl String
ResultSetFileUrlExpireTime String

AiRecognitionTaskAsrWordsSegmentItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
StartTimeOffset Float
EndTimeOffset Float
Confidence Float

AiRecognitionTaskFaceResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiRecognitionTaskFaceResultInput
Output AiRecognitionTaskFaceResultOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiRecognitionTaskFaceResultInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiRecognitionTaskFaceResultItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Id String
Type String
Name String
SegmentSet Array of AiRecognitionTaskFaceSegmentItem

AiRecognitionTaskFaceResultOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
ResultSet Array of AiRecognitionTaskFaceResultItem
ResultSetFileUrl String
ResultSetFileUrlExpireTime String

AiRecognitionTaskFaceSegmentItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
StartTimeOffset Float
EndTimeOffset Float
Confidence Float
AreaCoordSet Array of Integer

AiRecognitionTaskHeadTailResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiRecognitionTaskHeadTailResultInput
Output AiRecognitionTaskHeadTailResultOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiRecognitionTaskHeadTailResultInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiRecognitionTaskHeadTailResultOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
HeadConfidence Float
HeadTimeOffset Float
TailConfidence Float
TailTimeOffset Float

AiRecognitionTaskInput

Used by actions: CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ProcessMediaByUrl, ResetProcedureTemplate.

Name Type Required Description
Definition Integer Yes

AiRecognitionTaskObjectResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiRecognitionTaskObjectResultInput
Output AiRecognitionTaskObjectResultOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiRecognitionTaskObjectResultInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiRecognitionTaskObjectResultItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Name String
RecognitionSegmentSet Array of AiRecognitionTaskObjectSegmentItem

AiRecognitionTaskObjectResultOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
ResultSet Array of AiRecognitionTaskObjectResultItem
ResultSetFileUrl String
ResultSetFileUrlExpireTime String

AiRecognitionTaskObjectSegmentItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
StartTimeOffset Float
EndTimeOffset Float
Confidence Float
AreaCoordSet Array of Integer

AiRecognitionTaskOcrFullTextResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiRecognitionTaskOcrFullTextResultInput
Output AiRecognitionTaskOcrFullTextResultOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiRecognitionTaskOcrFullTextResultInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiRecognitionTaskOcrFullTextResultOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
SegmentSet Array of AiRecognitionTaskOcrFullTextSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiRecognitionTaskOcrFullTextSegmentItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
StartTimeOffset Float
EndTimeOffset Float
TextSet Array of AiRecognitionTaskOcrFullTextSegmentTextItem

AiRecognitionTaskOcrFullTextSegmentTextItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
AreaCoordSet Array of Integer
Text String

AiRecognitionTaskOcrWordsResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiRecognitionTaskOcrWordsResultInput
Output AiRecognitionTaskOcrWordsResultOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiRecognitionTaskOcrWordsResultInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiRecognitionTaskOcrWordsResultItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Word String
SegmentSet Array of AiRecognitionTaskOcrWordsSegmentItem

AiRecognitionTaskOcrWordsResultOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
ResultSet Array of AiRecognitionTaskOcrWordsResultItem
ResultSetFileUrl String
ResultSetFileUrlExpireTime String

AiRecognitionTaskOcrWordsSegmentItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
StartTimeOffset Float
EndTimeOffset Float
Confidence Float
AreaCoordSet Array of Integer

AiRecognitionTaskSegmentResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiRecognitionTaskSegmentResultInput
Output AiRecognitionTaskSegmentResultOutput
Progress Integer
BeginProcessTime String
FinishTime String

AiRecognitionTaskSegmentResultInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiRecognitionTaskSegmentResultOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
SegmentSet Array of AiRecognitionTaskSegmentSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiRecognitionTaskSegmentSegmentItem

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
FileId String
SegmentUrl String
Confidence Float
StartTimeOffset Float
EndTimeOffset Float
CovImgUrl String
SpecialInfo String

AiReviewPoliticalAsrTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiReviewPoliticalAsrTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
Suggestion String
SegmentSet Array of MediaContentReviewAsrTextSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiReviewPoliticalOcrTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiReviewPoliticalOcrTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
Suggestion String
SegmentSet Array of MediaContentReviewOcrTextSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiReviewPoliticalTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiReviewPoliticalTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
Suggestion String
Label String
SegmentSet Array of MediaContentReviewPoliticalSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiReviewPornAsrTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiReviewPornAsrTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
Suggestion String
SegmentSet Array of MediaContentReviewAsrTextSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiReviewPornOcrTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiReviewPornOcrTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
Suggestion String
SegmentSet Array of MediaContentReviewOcrTextSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiReviewPornTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Required Description
Definition Integer Yes

AiReviewPornTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
Suggestion String
Label String
SegmentSet Array of MediaContentReviewSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiReviewProhibitedAsrTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiReviewProhibitedAsrTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
Suggestion String
SegmentSet Array of MediaContentReviewAsrTextSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiReviewProhibitedOcrTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiReviewProhibitedOcrTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
Suggestion String
SegmentSet Array of MediaContentReviewOcrTextSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiReviewTaskPoliticalAsrResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiReviewPoliticalAsrTaskInput
Output AiReviewPoliticalAsrTaskOutput
Progress Integer

AiReviewTaskPoliticalOcrResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiReviewPoliticalOcrTaskInput
Output AiReviewPoliticalOcrTaskOutput
Progress Integer

AiReviewTaskPoliticalResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiReviewPoliticalTaskInput
Output AiReviewPoliticalTaskOutput
Progress Integer

AiReviewTaskPornAsrResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiReviewPornAsrTaskInput
Output AiReviewPornAsrTaskOutput
Progress Integer

AiReviewTaskPornOcrResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiReviewPornOcrTaskInput
Output AiReviewPornOcrTaskOutput
Progress Integer

AiReviewTaskPornResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiReviewPornTaskInput
Output AiReviewPornTaskOutput
Progress Integer

AiReviewTaskProhibitedAsrResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiReviewProhibitedAsrTaskInput
Output AiReviewProhibitedAsrTaskOutput
Progress Integer

AiReviewTaskProhibitedOcrResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiReviewProhibitedOcrTaskInput
Output AiReviewProhibitedOcrTaskOutput
Progress Integer

AiReviewTaskTerrorismOcrResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiReviewTerrorismOcrTaskInput
Output AiReviewTerrorismOcrTaskOutput
Progress Integer

AiReviewTaskTerrorismResult

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Status String
ErrCodeExt String
ErrCode Integer
Message String
Input AiReviewTerrorismTaskInput
Output AiReviewTerrorismTaskOutput
Progress Integer

AiReviewTerrorismOcrTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiReviewTerrorismOcrTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
Suggestion String
SegmentSet Array of MediaContentReviewOcrTextSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiReviewTerrorismTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Definition Integer

AiReviewTerrorismTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
Confidence Float
Suggestion String
Label String
SegmentSet Array of MediaContentReviewSegmentItem
SegmentSetFileUrl String
SegmentSetFileUrlExpireTime String

AiSampleFaceInfo

Used by actions: CreatePersonSample, DescribePersonSamples, ModifyPersonSample.

Name Type Description
FaceId String
Url String

AiSampleFaceOperation

Used by actions: ModifyPersonSample.

Name Type Required Description
Type String Yes
FaceIds Array of String No
FaceContents Array of String No

AiSampleFailFaceInfo

Used by actions: CreatePersonSample, ModifyPersonSample.

Name Type Description
Index Integer
ErrCode Integer
Message String

AiSamplePerson

Used by actions: CreatePersonSample, DescribePersonSamples, ModifyPersonSample.

Name Type Description
PersonId String
Name String
Description String
FaceInfoSet Array of AiSampleFaceInfo
TagSet Array of String
UsageSet Array of String
CreateTime String
UpdateTime String

AiSampleTagOperation

Used by actions: ModifyPersonSample, ModifyWordSample.

Name Type Required Description
Type String Yes
Tags Array of String Yes

AiSampleWord

Used by actions: DescribeWordSamples.

Name Type Description
Keyword String
TagSet Array of String
UsageSet Array of String
CreateTime String
UpdateTime String

AiSampleWordInfo

Used by actions: CreateWordSamples.

Name Type Required Description
Keyword String Yes
Tags Array of String No

AiTryOnConfig

Used by actions: CreateSceneAigcImageTask.

Name Type Required Description
Model String Yes
ClothesFileInfos Array of SceneAigcImageTaskInputFileInfo No
Prompt String No

AigcAdvancedCustomElementInfo

Used by actions: DescribeAigcAdvancedCustomElements.

Name Type Description
Id String
Name String
VoiceId String
Description String
CreateTime String

AigcAudioCloneInputFileInfo

Used by actions: CreateAigcAudioClone, DescribeTaskDetail.

Name Type Required Description
Type String No
FileId String No
Url String No

AigcAudioOutputConfig

Used by actions: CreateAigcAudioTask, DescribeTaskDetail.

Name Type Required Description
StorageMode String No
MediaName String No
ClassId Integer No
ExpireTime String No
Duration Integer No
OutputAudioFormat String No

AigcAudioReferenceAudioInfo

Used by actions: CreateAigcAudioTask, DescribeTaskDetail.

Name Type Required Description
Type String No
FileId String No
Url String No

AigcAudioReferenceVideoInfo

Used by actions: CreateAigcAudioTask, DescribeTaskDetail.

Name Type Required Description
Type String No
FileId String No
Url String No

AigcAudioTask

Used by actions: DescribeTaskDetail.

Name Type Description
TaskId String
Status String
ErrCode Integer
ErrCodeExt String
Message String
Progress Integer
Input AigcAudioTaskInput
Output AigcAudioTaskOutput

AigcAudioTaskInput

Used by actions: DescribeTaskDetail.

Name Type Description
ModelName String
ModelVersion String
SceneType String
Prompt String
NegativePrompt String
AudioInfos Array of AigcAudioReferenceAudioInfo
VideoInfos Array of AigcAudioReferenceVideoInfo
EnhancePrompt Boolean
OutputConfig AigcAudioOutputConfig
AdditionalParameters String

AigcAudioTaskOutput

Used by actions: DescribeTaskDetail.

Name Type Description
AudioInfos Array of AigcAudioTaskOutputFileInfo
VideoInfos Array of AigcAudioTaskOutputFileInfo

AigcAudioTaskOutputFileInfo

Used by actions: DescribeTaskDetail.

Name Type Description
StorageMode String
MediaName String
ClassId Integer
ExpireTime String
FileType String
FileUrl String
FileId String
MetaData MediaMetaData
Duration Float

AigcFaceIdentityInfo

Used by actions: DescribeAigcFaceInfo.

Name Type Description
FaceId String
FaceImage String
StartTime Integer
EndTime Integer

AigcFaceInfo

Used by actions: DescribeAigcFaceInfo, DescribeTaskDetail, PullEvents.

Name Type Description
SessionId String
FaceInfoList Array of AigcFaceIdentityInfo

AigcFaceInputFileInfo

Used by actions: DescribeAigcFaceInfo, DescribeAigcFaceInfoAsync, DescribeTaskDetail, PullEvents.

Name Type Required Description
Type String No
FileId String No
Url String No

AigcHunyuan3DMeshInfo

Used by actions: CreateAigcHunyuan3DTask, DescribeTaskDetail, PullEvents.

Name Type Required Description
Type String No
FileId String No
Url String No

AigcHunyuan3DMultiViewImageInfo

Used by actions: CreateAigcHunyuan3DTask, DescribeTaskDetail, PullEvents.

Name Type Required Description
Type String No
FileId String No
Url String No
ViewType String No

AigcHunyuan3DOutputConfig

Used by actions: CreateAigcHunyuan3DTask, DescribeTaskDetail, PullEvents.

Name Type Required Description
StorageMode String No

AigcHunyuan3DReferenceImageInfo

Used by actions: CreateAigcHunyuan3DTask, DescribeTaskDetail, PullEvents.

Name Type Required Description
Type String No
FileId String No
Url String No

AigcHunyuan3DTask

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
TaskId String
Status String
ErrCode Integer
ErrCodeExt String
Message String
Progress Integer
Input AigcHunyuan3DTaskInput
Output AigcHunyuan3DTaskOutput
SessionId String
SessionContext String

AigcHunyuan3DTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
ImageInfos Array of AigcHunyuan3DReferenceImageInfo
MultiViewImageInfos Array of AigcHunyuan3DMultiViewImageInfo
Prompt String
GenerateType String
MeshInfos Array of AigcHunyuan3DMeshInfo
EnablePBR String
FaceCount Integer
KeepUV String
ResultFormat String
Seed Integer
Style String
OutputConfig AigcHunyuan3DOutputConfig

AigcHunyuan3DTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
FileInfos Array of AigcHunyuan3DTaskOutputFileInfo

AigcHunyuan3DTaskOutputFileInfo

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
StorageMode String
ExpireTime String
FileType String
FileUrl String
PreviewFileUrl String

AigcImageOutputConfig

Used by actions: CreateAigcImageTask, DescribeTaskDetail, PullEvents.

Name Type Required Description
StorageMode String No
MediaName String No
ClassId Integer No
ExpireTime String No
Resolution String No
AspectRatio String No
PersonGeneration String No
InputComplianceCheck String No
OutputComplianceCheck String No
OutputImageCount Integer No
OutputFormat String No
LogoAdd String No

AigcImageSceneInfo

Used by actions: CreateSceneAigcImageTask, DescribeTaskDetail, PullEvents.

Name Type Required Description
Type String Yes
AiTryOnConfig AiTryOnConfig No
ChangeClothesConfig ChangeClothesConfig No
ProductImageConfig ProductImageConfig No

AigcImageTask

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
TaskId String
Status String
ErrCode Integer
ErrCodeExt String
Message String
Progress Integer
Input AigcImageTaskInput
Output AigcImageTaskOutput
SessionId String
SessionContext String

AigcImageTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
ModelName String
ModelVersion String
FileInfos Array of AigcImageTaskInputFileInfo
Prompt String
NegativePrompt String
EnhancePrompt String
GenerationMode String
OutputConfig AigcImageOutputConfig
Seed Integer
SceneType String
ExtInfo String

AigcImageTaskInputFileInfo

Used by actions: CreateAigcImageTask, DescribeTaskDetail, PullEvents.

Name Type Required Description
Type String No
FileId String No
Url String No
Base64 String No
Text String No
ReferenceType String No

AigcImageTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
FileInfos Array of AigcImageTaskOutputFileInfo

AigcImageTaskOutputFileInfo

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
StorageMode String
MediaName String
ClassId Integer
ExpireTime String
FileType String
FileUrl String
FileId String
MetaData MediaMetaData

AigcQuotaItem

Used by actions: DescribeAigcQuotas.

Name Type Description
QuotaType String
ApiToken String
QuotaLimit Integer
Usage Integer

AigcTextDetail

Used by actions: DescribeAigcUsageData.

Name Type Required Description
PageSize Integer No
ScrollToken String No
Data Array of AigcTextDetailData No

AigcTextDetailData

Used by actions: DescribeAigcUsageData.

Name Type Required Description
Timestamp String No
ReqId String No
ChatId String No
StatusCode Integer No
Model String No
SubAppId Integer No
ApiKey String No
Stream Boolean No
InputTokens Integer No
OutputTokens Integer No
CacheInputTokens Integer No
TotalTokens Integer No
TPS Float No
TTFT Float No
Total Float No
ApiType String No

AigcUsageDataItem

Used by actions: DescribeAigcUsageData.

Name Type Description
Specification String
DataSet Array of TaskStatDataItem

AigcVideoOutputConfig

Used by actions: CreateAigcVideoTask, DescribeTaskDetail, PullEvents.

Name Type Required Description
StorageMode String No
MediaName String No
ClassId Integer No
ExpireTime String No
Duration Float No
Resolution String No
AspectRatio String No
AudioGeneration String No
PersonGeneration String No
InputComplianceCheck String No
OutputComplianceCheck String No
EnhanceSwitch String No
OffPeak String No
FrameInterpolate String No
LogoAdd String No
EnableBGM String No

AigcVideoRedrawOutputConfig

Used by actions: CreateAigcVideoRedrawTask, DescribeTaskDetail.

Name Type Required Description
StorageMode String No
MediaName String No
ClassId Integer No
ExpireTime String No

AigcVideoRedrawOutputFileInfo

Used by actions: DescribeTaskDetail.

Name Type Description
StorageMode String
MediaName String
ClassId Integer
ExpireTime String
FileType String
FileUrl String
FileId String
MetaData MediaMetaData

AigcVideoRedrawTask

Used by actions: DescribeTaskDetail.

Name Type Description
TaskId String
Status String
ErrCode Integer
ErrCodeExt String
Message String
Progress Integer
Input AigcVideoRedrawTaskInput
Output AigcVideoRedrawTaskOutput
SessionId String
SessionContext String

AigcVideoRedrawTaskInfo

Used by actions: CreateAigcVideoRedrawTask, DescribeTaskDetail.

Name Type Required Description
Style String No

AigcVideoRedrawTaskInput

Used by actions: DescribeTaskDetail.

Name Type Description
FileInfo AigcVideoRedrawTaskInputFileInfo
TaskInfo AigcVideoRedrawTaskInfo
OutputConfig AigcVideoRedrawOutputConfig

AigcVideoRedrawTaskInputFileInfo

Used by actions: CreateAigcVideoRedrawTask, DescribeTaskDetail.

Name Type Required Description
Type String No
FileId String No
Url String No

AigcVideoRedrawTaskOutput

Used by actions: DescribeTaskDetail.

Name Type Description
FileInfo AigcVideoRedrawOutputFileInfo

AigcVideoSceneInfo

Used by actions: CreateSceneAigcVideoTask, DescribeTaskDetail.

Name Type Required Description
Type String Yes
ProductShowcaseConfig ProductShowcaseConfig No

AigcVideoTask

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
TaskId String
Status String
ErrCode Integer
ErrCodeExt String
Message String
Progress Integer
Input AigcVideoTaskInput
Output AigcVideoTaskOutput
SessionId String
SessionContext String

AigcVideoTaskInput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
ModelName String
ModelVersion String
FileInfos Array of AigcVideoTaskInputFileInfo
SubjectInfos Array of AigcVideoTaskInputSubjectInfo
LastFrameFileId String
LastFrameUrl String
Prompt String
NegativePrompt String
EnhancePrompt String
GenerationMode String
OutputConfig AigcVideoOutputConfig
InputRegion String
SceneType String
Seed Integer
ExtInfo String

AigcVideoTaskInputFileInfo

Used by actions: CreateAigcVideoTask, DescribeTaskDetail, PullEvents.

Name Type Required Description
Type String No
Category String No
FileId String No
Url String No
Base64 String No
ReferenceType String No
ObjectId String No
VoiceId String No
KeepOriginalSound String No
Usage String No
Text String No

AigcVideoTaskInputSubjectInfo

Used by actions: CreateAigcVideoTask, DescribeTaskDetail, PullEvents.

Name Type Required Description
Id String No
Name String No
VoiceId String No
ImageUrls Array of String No
VideoUrls Array of String No

AigcVideoTaskOutput

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
FileInfos Array of AigcVideoTaskOutputFileInfo
ProcedureTaskIds Array of String
Usage AigcVideoTaskUsage

AigcVideoTaskOutputFileInfo

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
StorageMode String
MediaName String
ClassId Integer
ExpireTime String
FileType String
FileUrl String
FileContent String
FileId String
MetaData MediaMetaData
UsageType String

AigcVideoTaskUsage

Used by actions: DescribeTaskDetail, PullEvents.

Name Type Description
InputTokens Integer
ThoughtTokens Integer
InputImageCount Integer
InputSeconds Integer
OutputSeconds Integer
TotalSeconds Integer

AnimatedGraphicTaskInput

Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

Name Type Required Description
Definition Integer Yes
StartTimeOffset Float Yes
EndTimeOffset Float Yes

AnimatedGraphicsTemplate

Used by actions: DescribeAnimatedGraphicsTemplates.

Name Type Description
Definition Integer
Type String
Name String
Comment String
Width Integer
Height Integer
ResolutionAdaptive String
Format String
Fps Integer
Quality Float
CreateTime String
UpdateTime String

AreaCLSTargetInfo

Used by actions: DescribeCLSPushTargets, SetCLSPushTarget.

Name Type Required Description
CLSRegion String Yes
TopicId String Yes
LogsetId String Yes
Switch String No

ArtifactRepairInfo

Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

Name Type Required Description
Switch String Yes
Type String No

AsrFullTextConfigureInfo

Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

Name Type Required Description
Switch String Yes
SubtitleFormats Array of String No
SrcLanguage String No
SubtitleName String No

AsrFullTextConfigureInfoForUpdate

Used by actions: ModifyAIRecognitionTemplate.

Name Type Required Description
Switch String No
SubtitleFormatsOperation SubtitleFormatsOperation No
SrcLanguage String No
SubtitleName String No

AsrTranslateConfigureInfo

Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

Name Type Required Description
Switch String Yes
SrcLanguage String No
DstLanguage String No
SubtitleFormats Array of String No
SubtitleName String No

AsrTranslateConfigureInfoForUpdate

Used by actions: ModifyAIRecognitionTemplate.

Name Type Required Description
Switch String No
SrcLanguage String No
DstLanguage String No
SubtitleFormatsOperation SubtitleFormatsOperation No
SubtitleName String No

AsrWordsConfigureInfo

Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

Name Type Required Description
Switch String Yes
LabelSet Array of String No

AsrWordsConfigureInfoForUpdate

Used by actions: ModifyAIRecognitionTemplate.

Name Type Required Description
Switch String No
LabelSet Array of String No

AudioBeautifyInfo

Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

Name Type Required Description
Switch String Yes
Types Array of String No

AudioDenoiseInfo

Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

Name Type Required Description
Switch String Yes
Type String No

AudioEnhanceConfig

Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

Name Type Required Description
Denoise AudioDenoiseInfo No
Separate AudioSeparateInfo No
VolumeBalance AudioVolumeBalanceInfo No
Beautify AudioBeautifyInfo No

AudioSeparateInfo

Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

Name Type Required Description
Switch String Yes
Type String No
Track String No

AudioTemplateInfo

Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate.

Name Type Required Description
Codec String Yes
Bitrate Integer Yes
SampleRate Integer Yes
AudioChannel Integer No

AudioTemplateInfoForUpdate

Used by actions: CreateProcedureTemplate, ModifyTranscodeTemplate, ProcessMedia, ResetProcedureTemplate.

Name Type Required Description
Codec String No
Bitrate Integer No
SampleRate Integer No
AudioChannel Integer No
StreamSelects Array of Integer No

AudioTrackItem

Used by actions: ComposeMedia.

Name Type Required Description
SourceMedia String Yes
SourceMediaStartTime Float No
Duration Float No
TargetDuration Float No
AudioOperations Array of AudioTransform No

AudioTransform

Used by actions: ComposeMedia.

Name Type Required Description
Type String Yes
VolumeParam AudioVolumeParam No

AudioVolumeBalanceInfo

Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

Name Type Required Description
Switch String Yes
Type String No

AudioVolumeParam

Used by actions: ComposeMedia.

Name Type Required Description
Mute Integer No
Gain Float No

Authentication

Timestamp hotlink protection configuration

Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

Name Type Required Description
Switch String Yes Hotlink protection configuration switch. Value:
  • on: Enable;
  • off: Cache.

  • TypeA AuthenticationTypeA No Configuration of timestamp hotlink protection mode A.
    TypeB AuthenticationTypeB No Configuration of timestamp hotlink protection mode B.
    TypeC AuthenticationTypeC No Configuration of timestamp hotlink protection mode C.
    TypeD AuthenticationTypeD No Configuration of timestamp hotlink protection mode D.

    AuthenticationTypeA

    Timestamp hotlink protection mode A configuration;
    The access URL format of timestamp hotlink protection mode A is: http://DomainName/Filename?sign=timestamp-rand-uid-md5hash;
    Among them, timestamp is a decimal UNIX timestamp.
    rand is a random string of 0 to 100 upper- and lower-case letters and digits.
    uid is 0;
    md5hash: MD5 (file path-timestamp-rand-uid-custom key).

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    SecretKey String Yes Key used for signature calculation.
    Only allow upper- and lower-case letters and digits, with a length of 6 to 32 characters.
    SignParam String Yes Signature parameter name setting;
    Only allow upper- and lower-case letters, digits, or underscores. The length is 1–100 characters and cannot start with a digit.
    ExpireTime Integer Yes Signature expiration time setting;
    In seconds. Maximum settable value: 630720000.
    FileExtensions Array of String Yes List of filename extensions for authentication/no authentication settings;
    If it contains the character *, it means all files.
    FilterType String Yes whitelist: allowlist, means to authenticate all types except those in the FileExtensions list.
    blacklist: blocklist, which means authentication is only applicable to the types in FileExtensions.
    BackupSecretKey String No Secondary key for signature calculation.
    Only allow upper- and lower-case letters and digits, with a length of 6 to 32 characters.

    AuthenticationTypeB

    Timestamp hotlink protection mode B configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    SecretKey String Yes Key used for signature calculation.
    Only allow upper- and lower-case letters and digits, with a length of 6 to 32 characters.
    ExpireTime Integer Yes Signature expiration time settings;
    In seconds. Maximum settable value: 630720000.
    FileExtensions Array of String Yes List of filename extensions for authentication/no authentication settings;
    If it contains the character *, it means all files.
    FilterType String Yes whitelist: allowlist, means to authenticate all types except the FileExtensions list;
    blacklist: blocklist, which means authentication is only applicable to the types in FileExtensions.
    BackupSecretKey String No Secondary key for signature calculation.
    Only allow upper- and lower-case letters and digits, with a length of 6 to 32 characters.

    AuthenticationTypeC

    Timestamp hotlink protection mode C configuration;
    The access URL format of timestamp hotlink protection mode C is: http://DomainName/md5hash/timestamp/FileName;
    Among them, timestamp is a hexadecimal UNIX timestamp;
    md5hash: MD5 (custom key + file path + timestamp).

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    SecretKey String Yes Key used for signature calculation.
    Only allow upper- and lower-case letters and digits, with a length of 6 to 32 characters.
    ExpireTime Integer Yes Signature expiration time settings;
    In seconds. Maximum settable value: 630720000.
    FileExtensions Array of String Yes List of filename extensions for authentication/no authentication settings;
    If it contains the character *, it means all files.
    FilterType String Yes whitelist: allowlist, means to authenticate all types except the FileExtensions list;
    blacklist: blocklist, which means authentication is only applicable to the types in FileExtensions.
    TimeFormat String Yes Timestamp base settings:
  • dec: decimal
  • hex: hexadecimal
  • BackupSecretKey String No Secondary key for signature calculation.
    Only allow upper- and lower-case letters and digits, with a length of 6 to 32 characters.

    AuthenticationTypeD

    Timestamp hotlink protection mode D configuration;
    The access URL format of timestamp hotlink protection mode D is: http://DomainName/FileName?sign=md5hash&t=timestamp;
    Among them, timestamp is a decimal or hexadecimal UNIX timestamp;
    md5hash: MD5 (custom key + file path + timestamp).

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    SecretKey String Yes Key used for signature calculation.
    Only allow upper- and lower-case letters and digits, with a length of 6 to 32 characters.
    ExpireTime Integer Yes Signature expiration time setting;
    In seconds. Maximum settable value: 630720000.
    FileExtensions Array of String Yes List of filename extensions for authentication/no authentication settings;
    If it contains the character *, it means all files.
    FilterType String Yes whitelist: allowlist, means to authenticate all types except those in the FileExtensions list.
    blacklist: blocklist, which means authentication is only applicable to the types in FileExtensions.
    SignParam String Yes Signature parameter name setting;
    Only allow upper- and lower-case letters, digits, or underscores, with a length of 1 to 100 characters, and cannot start with a digit.
    TimeParam String Yes Timestamp parameter name settings;
    Only allow upper- and lower-case letters, digits, or underscores, with a length of 1 to 100 characters, and cannot start with a digit.
    TimeFormat String Yes Timestamp base settings:
  • dec: decimal
  • hex: hexadecimal
  • BackupSecretKey String No Secondary key for signature calculation.
    Only allow upper- and lower-case letters and digits, with a length of 6 to 32 characters.

    AwsPrivateAccess

    Aws S3 origin-pull authentication

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Switch for Aws S3 origin-pull authentication configuration. Valid values:
  • on: Enable;
  • off: Cache.
  • AccessKey String No Access ID.
    SecretKey String No Key.
    Region String No Region.
    Bucket String No Bucket Name.

    BeautyEffectItem

    Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    Switch String No
    Type String No
    Value Integer No
    ResourcePath String No
    ExtInfo String No

    BeautyFilterItem

    Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    Switch String No
    Type String No
    Value Integer No

    BlackWhiteEdgeConfigureInfo

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes

    BlackWhiteEdgeConfigureInfoForUpdate

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No

    BlindWatermarkInput

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes

    BlindWatermarkTemplate

    Used by actions: DescribeBlindWatermarkTemplates.

    Name Type Description
    Definition Integer
    Type String
    Name String
    TextContent String
    Comment String
    CreateTime String
    UpdateTime String

    BlurConfigureInfo

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes

    BlurConfigureInfoForUpdate

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No

    CDNCertInfo

    https acceleration configuration for the domain name. Disabled by default.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    CertId String No Server certificate ID is automatically generated when hosting a certificate in SSL certificate management.
    Certificate String No Certificate information.
    PrivateKey String No Key information.
    ExpireTime Timestamp ISO8601 No Certificate expiration time;
    No need to fill when used as an input parameter configuration.

    CDNDomainConfig

    Cdn domain configuration information

    Used by actions: CreateCDNDomain, DescribeCDNDomains.

    Name Type Required Description
    Area String Yes Domain acceleration region:
  • mainland: domestic acceleration in China;
  • overseas: acceleration outside China;
  • global: global acceleration.
  • Origin Origin Yes Origin server configuration.
    IpFilter IpFilter No IP allowlist/blocklist configuration.
    UserAgentFilter UserAgentFilter No UA Blocklist/Allowlist Configuration.
    FollowRedirect FollowRedirect No 301/302 origin-pull follow configuration.
    RequestHeader RequestHeader No Request header configuration.
    ResponseHeader ResponseHeader No header configuration.
    Cache Cache No Cache expiration time configuration.
    Https Https No Https configuration.
    Authentication Authentication No Timestamp hotlink protection configuration.
    ForceRedirect ForceRedirect No Forced redirect configuration for access protocols.
    Referer Referer No Referer anti-leech configuration.
    MaxAge MaxAge No Browser cache configuration.
    Ipv6Access Ipv6Access No Ipv6 access configuration.
    Quic Quic No Quic access configuration.
    AwsPrivateAccess AwsPrivateAccess No Authentication configuration for AWS S3 origin-pull.
    OssPrivateAccess OssPrivateAccess No Authentication configuration for origin-pull from Alibaba Cloud OSS.
    HwPrivateAccess HwPrivateAccess No Authentication configuration for origin-pull from Huawei Cloud Object Storage.
    OthersPrivateAccess OthersPrivateAccess No Authentication configuration for origin-pull from other vendors' object storage.

    CDNDomainConfigForUpdate

    Cdn domain configuration information

    Used by actions: ModifyCDNDomainConfig.

    Name Type Required Description
    Area String No Domain acceleration region:
  • mainland: domestic acceleration in China;
  • overseas: acceleration outside China;
  • global: global acceleration.
  • Origin Origin No Origin server configuration.
    IpFilter IpFilter No IP allowlist/blocklist configuration.
    UserAgentFilter UserAgentFilter No UA Blocklist/Allowlist Configuration.
    FollowRedirect FollowRedirect No 301/302 origin-pull follow configuration.
    RequestHeader RequestHeader No Request header configuration.
    ResponseHeader ResponseHeader No header configuration.
    Cache Cache No Cache expiration time configuration.
    Https Https No Https configuration.
    Authentication Authentication No Timestamp hotlink protection configuration.
    ForceRedirect ForceRedirect No Forced redirect configuration for access protocols.
    Referer Referer No Referer anti-leech configuration.
    MaxAge MaxAge No Browser cache configuration.
    Ipv6Access Ipv6Access No Ipv6 access configuration.
    Quic Quic No Quic access configuration.
    AwsPrivateAccess AwsPrivateAccess No Authentication configuration for AWS S3 origin-pull
    OssPrivateAccess OssPrivateAccess No Authentication configuration for origin-pull from Alibaba Cloud OSS.
    HwPrivateAccess HwPrivateAccess No Authentication configuration for origin-pull from Huawei Cloud Object Storage.
    OthersPrivateAccess OthersPrivateAccess No Authentication configuration for origin-pull from other vendors' object storage.

    CDNDomainInfo

    cdn domain information

    Used by actions: DescribeCDNDomains.

    Name Type Description
    Domain String Domain name.
    DeployStatus String Deployment state.
    Cname String Cname record.
    CreateTime String Creation time.
    Config CDNDomainConfig cdn domain configuration information.

    CLSLogsetInfo

    Used by actions: DescribeCLSLogsets.

    Name Type Description
    LogsetId String
    LogsetName String

    CLSTopicInfo

    Used by actions: DescribeCLSTopics.

    Name Type Description
    TopicId String
    TopicName String
    LogsetId String

    Cache

    Node cache expiration time configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    RuleCache Array of RuleCache No Path cache configuration.

    CacheConfigCache

    Path cache configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Path cache configuration switch. Valid values:
  • on: Enable;
  • off: Cache.
  • CacheTime Integer Yes Cache expiration time settings. Unit: second. The maximum value is 365 days.
    CompareMaxAge String Yes Advanced cache expiration configuration. When enabled, the max-age value returned by the origin server will be compared with the cache expiration time set in CacheRules, and the minimum value will be used for node cache. Valid values:
  • on: Enable;
  • off: Cache.
  • IgnoreCacheControl String Yes Force cache. Value:
  • on: Enable;
  • off: Cache.
  • IgnoreSetCookie String Yes Whether to cache the Set-Cookie header and body on the node when the origin server returns the Set-Cookie header.
  • on: Enable. Do not cache the header or body;
  • off: disabled, following user-defined node cache rules.
  • CacheConfigFollowOrigin

    Path cache follows the origin site configuration.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Path cache follows the origin site configuration switch. Valid values:
  • on: Enable;
  • off: Cache.
  • HeuristicCache HeuristicCache No Heuristic cache configuration.

    CacheConfigNoCache

    Path cache no cache configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Path cache no cache configuration toggle, Value:
  • on: Enable;
  • off: Cache.
  • Revalidate String Yes Always validate against the origin server. Value:
  • on: Enable;
  • off: Cache.
  • Canvas

    Used by actions: ComposeMedia, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Color String No
    Width Integer No
    Height Integer No

    CdnLogInfo

    Used by actions: DescribeCdnLogs.

    Name Type Description
    Date String
    Name String
    Url String
    StartTime String
    EndTime String

    ChangeClothesConfig

    Used by actions: CreateSceneAigcImageTask.

    Name Type Required Description
    ClothesFileInfos Array of SceneAigcImageTaskInputFileInfo No
    Prompt String No

    ClassificationConfigureInfo

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes

    ClassificationConfigureInfoForUpdate

    Used by actions: ModifyAIAnalysisTemplate.

    Name Type Required Description
    Switch String No

    ClipFileInfo2017

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ErrCode Integer
    Message String
    FileId String
    FileUrl String
    FileType String

    ClipTask2017

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    SrcFileId String
    FileInfo ClipFileInfo2017

    CloneVoiceAsyncInput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    AudioUrl String
    AudioFileId String
    LanguageBoost String
    ExtParam String

    CloneVoiceAsyncOutput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    VoiceId String
    DemoAudio String
    ExtInfo String

    CloneVoiceAsyncTask

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    ErrCodeExt String
    Input CloneVoiceAsyncInput
    Output CloneVoiceAsyncOutput
    SessionId String
    SessionContext String
    Progress Integer

    ColorEnhanceInfo

    Used by actions: CreateEnhanceMediaTemplate, CreateProcessImageAsyncTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyProcessImageAsyncTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes
    Type String No

    ComplexAdaptiveDynamicStreamingTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ComplexAdaptiveDynamicStreamingTaskResultSet Array of ComplexAdaptiveDynamicStreamingTaskResult

    ComplexAdaptiveDynamicStreamingTaskAudioInput

    Used by actions: CreateComplexAdaptiveDynamicStreamingTask.

    Name Type Required Description
    FileId String Yes
    Name String Yes
    Language String Yes
    Default String No
    AudioTrackIdx Integer No

    ComplexAdaptiveDynamicStreamingTaskInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Required Description
    StreamPara ComplexAdaptiveDynamicStreamingTaskStreamPara Yes

    ComplexAdaptiveDynamicStreamingTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Definition Integer
    Format String
    DrmType String
    Url String

    ComplexAdaptiveDynamicStreamingTaskResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String
    ErrCodeExt String
    Message String
    Progress Integer
    Input ComplexAdaptiveDynamicStreamingTaskInput
    Output ComplexAdaptiveDynamicStreamingTaskOutput

    ComplexAdaptiveDynamicStreamingTaskStreamPara

    Used by actions: CreateComplexAdaptiveDynamicStreamingTask, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Definition Integer Yes

    ComplexAdaptiveDynamicStreamingTaskSubtitleInput

    Used by actions: CreateComplexAdaptiveDynamicStreamingTask.

    Name Type Required Description
    Id String Yes
    Default String No

    ComposeMediaOutput

    Used by actions: ComposeMedia, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    FileName String Yes
    Description String No
    ClassId Integer No
    ExpireTime String No
    Container String No
    VideoStream OutputVideoStream No
    AudioStream OutputAudioStream No
    RemoveVideo Integer No
    RemoveAudio Integer No

    ComposeMediaTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    Progress Integer
    Input ComposeMediaTaskInput
    Output ComposeMediaTaskOutput
    MetaData MediaMetaData
    SessionId String
    SessionContext String

    ComposeMediaTaskInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Tracks Array of MediaTrack
    Canvas Canvas
    Output ComposeMediaOutput

    ComposeMediaTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileType String
    FileId String
    FileUrl String
    MediaName String
    ClassId Integer
    ExpireTime String

    ConcatFileInfo2017

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ErrCode Integer
    Message String
    FileId String
    FileUrl String
    FileType String

    ConcatTask2017

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    FileInfoSet Array of ConcatFileInfo2017

    ContentReviewTemplateItem

    Used by actions: DescribeContentReviewTemplates.

    Name Type Description
    Definition Integer
    Name String
    Comment String
    PornConfigure PornConfigureInfo
    TerrorismConfigure TerrorismConfigureInfo
    PoliticalConfigure PoliticalConfigureInfo
    ProhibitedConfigure ProhibitedConfigureInfo
    UserDefineConfigure UserDefineConfigureInfo
    ReviewWallSwitch String
    ScreenshotInterval Float
    CreateTime String
    UpdateTime String

    CopyRightWatermarkInput

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Text String Yes

    CoverBySnapshotTaskInput

    Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes
    PositionType String Yes
    PositionValue Float Yes
    WatermarkSet Array of WatermarkInput No

    CoverBySnapshotTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    CoverUrl String

    CoverConfigureInfo

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes

    CoverConfigureInfoForUpdate

    Used by actions: ModifyAIAnalysisTemplate.

    Name Type Required Description
    Switch String No

    CrashScreenConfigureInfo

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes

    CrashScreenConfigureInfoForUpdate

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No

    CreateAigcAdvancedCustomElementInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ElementName String
    ElementDescription String
    ReferenceType String
    ElementVoiceId String
    ElementVideoList String
    ElementImageList String
    TagList String

    CreateAigcAdvancedCustomElementOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    InfoList Array of AdvancedElementInfo

    CreateAigcAdvancedCustomElementTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    ErrCodeExt String
    Message String
    Progress Integer
    Input CreateAigcAdvancedCustomElementInput
    Output CreateAigcAdvancedCustomElementOutput
    SessionId String
    SessionContext String

    CreateAigcAudioCloneInput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    AudioFileInfo AigcAudioCloneInputFileInfo
    VoiceId String
    Text String
    PromptAudioFileInfo AigcAudioCloneInputFileInfo
    PromptText String
    Payload String

    CreateAigcAudioCloneOutput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String
    State String
    VoiceId String
    DemoAudio String
    Payload String
    CreatedAt String

    CreateAigcAudioCloneTask

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    ErrCodeExt String
    Message String
    Progress Integer
    Input CreateAigcAudioCloneInput
    Output CreateAigcAudioCloneOutput
    SessionId String
    SessionContext String

    CreateAigcCustomVoiceInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    VoiceName String
    VoiceUrl String
    VideoId String

    CreateAigcCustomVoiceOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    InfoList Array of CustomVoiceInfo

    CreateAigcCustomVoiceTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    ErrCodeExt String
    Message String
    Progress Integer
    Input CreateAigcCustomVoiceInput
    Output CreateAigcCustomVoiceOutput
    SessionId String
    SessionContext String

    CreateAigcSubjectInput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    SubjectName String
    SubjectImages Array of String
    SubjectVideos Array of String
    VoiceId String

    CreateAigcSubjectOutput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    SubjectId String
    SubjectInfo String

    CreateAigcSubjectTask

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    ErrCodeExt String
    Message String
    Input CreateAigcSubjectInput
    Output CreateAigcSubjectOutput
    SessionId String
    SessionContext String

    CreateImageSpriteTask2017

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    ErrCode Integer
    Message String
    FileId String
    Definition Integer
    TotalCount Integer
    ImageSpriteUrlSet Array of String
    WebVttUrl String

    CustomVoiceInfo

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    VoiceId String
    VoiceInfo String

    DNSVerifyInfo

    Used by actions: CreateDomainVerifyRecord.

    Name Type Description
    SubDomain String
    Record String
    RecordType String

    DailyPlayStatInfo

    Used by actions: DescribeDailyMediaPlayStat, DescribeDailyMostPlayedStat.

    Name Type Description
    Date String
    FileId String
    PlayTimes Integer
    Traffic Integer

    DescribeAigcFaceInfoAsyncInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileInfos Array of AigcFaceInputFileInfo

    DescribeAigcFaceInfoAsyncOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FaceInfoSet Array of AigcFaceInfo

    DescribeAigcFaceInfoAsyncTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    ErrCodeExt String
    Message String
    Progress Integer
    Input DescribeAigcFaceInfoAsyncInput
    Output DescribeAigcFaceInfoAsyncOutput
    SessionId String
    SessionContext String

    DescribeFileAttributesTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    ErrCodeExt String
    Message String
    Progress Integer
    FileId String
    Output DescribeFileAttributesTaskOutput
    SessionId String
    SessionContext String

    DescribeFileAttributesTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Md5 String
    Sha1 String

    DesignVoiceAsyncInput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    Prompt String
    VoiceSettings VoiceSettings
    PreviewText String
    ExtParam String

    DesignVoiceAsyncOutput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    VoiceId String
    TrialAudio String

    DesignVoiceAsyncTask

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    ErrCodeExt String
    Input DesignVoiceAsyncInput
    Output DesignVoiceAsyncOutput
    SessionId String
    SessionContext String
    Progress Integer

    DiffusionEnhanceInfo

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Switch String Yes
    Type String No

    DomainCLSTargetInfo

    Used by actions: DescribeCLSPushTargets.

    Name Type Description
    Domain String
    ChineseMainlandCLSTargetInfo AreaCLSTargetInfo
    OutsideChineseMainlandCLSTargetInfo AreaCLSTargetInfo

    DomainDetailInfo

    Used by actions: DescribeVodDomains.

    Name Type Description
    Domain String
    AccelerateAreaInfos Array of AccelerateAreaInfo
    DeployStatus String
    HTTPSConfig DomainHTTPSConfig
    UrlSignatureAuthPolicy UrlSignatureAuthPolicy
    RefererAuthPolicy RefererAuthPolicy
    CreateTime String
    QUICConfig DomainQUICConfig
    IPFilterPolicy IPFilterPolicy
    Type String

    DomainHTTPSConfig

    Used by actions: DescribeVodDomains.

    Name Type Required Description
    CertExpireTime String Yes
    CloudCertId String No

    DomainQUICConfig

    Used by actions: DescribeVodDomains, ModifyVodDomainConfig.

    Name Type Required Description
    Status String Yes

    DrmStreamingsInfo

    Used by actions: CreateSuperPlayerConfig, DescribeSuperPlayerConfigs.

    Name Type Required Description
    SimpleAesDefinition Integer No
    WidevineDefinition Integer No
    FairPlayDefinition Integer No

    DrmStreamingsInfoForUpdate

    Used by actions: ModifySuperPlayerConfig.

    Name Type Required Description
    SimpleAesDefinition Integer No
    WidevineDefinition Integer No
    FairPlayDefinition Integer No

    DynamicRangeInfo

    Dynamic range information of the frame.

    Used by actions: LiveRealTimeClip, SimpleHlsClip.

    Name Type Description
    Type String Visual dynamic range information. Valid values:
  • SDR: Standard Dynamic Range;
  • HDR: High Dynamic Range.
  • HDRType String High dynamic range type. Valid when Type is HDR. Currently supported valid values:
  • hdr10: refers to the hdr10 standard;
  • hlg: refers to the hlg standard.
  • EditMediaFileInfo

    Used by actions: DescribeTaskDetail, EditMedia, PullEvents.

    Name Type Required Description
    FileId String Yes
    StartTimeOffset Float No
    EndTimeOffset Float No

    EditMediaOutputConfig

    Used by actions: EditMedia.

    Name Type Required Description
    MediaName String No
    Type String No
    ClassId Integer No
    ExpireTime String No
    VideoStream EditMediaVideoStream No
    TEHDConfig EditMediaTEHDConfig No

    EditMediaStreamInfo

    Used by actions: DescribeTaskDetail, EditMedia, PullEvents.

    Name Type Required Description
    StreamId String Yes
    StartTime String No
    EndTime String No

    EditMediaTEHDConfig

    Used by actions: EditMedia.

    Name Type Required Description
    Type String Yes
    MaxVideoBitrate Integer No

    EditMediaTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    ErrCodeExt String
    Message String
    Progress Integer
    Input EditMediaTaskInput
    Output EditMediaTaskOutput
    MetaData MediaMetaData
    ProcedureTaskId String
    ReviewAudioVideoTaskId String
    SessionId String
    SessionContext String

    EditMediaTaskInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    InputType String
    FileInfoSet Array of EditMediaFileInfo
    StreamInfoSet Array of EditMediaStreamInfo

    EditMediaTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileType String
    FileUrl String
    FileId String
    MediaName String
    ClassId Integer
    ExpireTime String

    EditMediaVideoStream

    Used by actions: EditMedia.

    Name Type Required Description
    Codec String No
    Bitrate Integer No
    ResolutionAdaptive String No
    Width Integer No
    Height Integer No
    Fps Integer No

    ElementReferInfo

    Used by actions: CreateAigcCustomElement.

    Name Type Required Description
    ImageUrl String No

    EmptyTrackItem

    Used by actions: ComposeMedia.

    Name Type Required Description
    Duration Float Yes

    EnhanceConfig

    Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate.

    Name Type Required Description
    VideoEnhance VideoEnhanceConfig No
    AudioEnhance AudioEnhanceConfig No

    EnhanceConfigForUpdate

    Used by actions: ModifyTranscodeTemplate.

    Name Type Required Description
    VideoEnhance VideoEnhanceConfig No
    AudioEnhance AudioEnhanceConfig No

    EnhanceMediaQualityOutputConfig

    Used by actions: EnhanceMediaQuality.

    Name Type Required Description
    MediaName String No
    ClassId Integer No
    ExpireTime String No

    EventContent

    Used by actions: PullEvents.

    Name Type Description
    EventHandle String
    EventType String
    FileUploadEvent FileUploadTask
    ProcedureStateChangeEvent ProcedureTask
    FileDeleteEvent FileDeleteTask
    PullCompleteEvent PullUploadTask
    EditMediaCompleteEvent EditMediaTask
    SplitMediaCompleteEvent SplitMediaTask
    ComposeMediaCompleteEvent ComposeMediaTask
    ClipCompleteEvent ClipTask2017
    TranscodeCompleteEvent TranscodeTask2017
    CreateImageSpriteCompleteEvent CreateImageSpriteTask2017
    ConcatCompleteEvent ConcatTask2017
    SnapshotByTimeOffsetCompleteEvent SnapshotByTimeOffsetTask2017
    WechatPublishCompleteEvent WechatPublishTask
    WechatMiniProgramPublishCompleteEvent WechatMiniProgramPublishTask
    RemoveWatermarkCompleteEvent RemoveWatermarkTask
    RestoreMediaCompleteEvent RestoreMediaTask
    RebuildMediaCompleteEvent RebuildMediaTask
    ExtractTraceWatermarkCompleteEvent ExtractTraceWatermarkTask
    ExtractCopyRightWatermarkCompleteEvent ExtractCopyRightWatermarkTask
    ReviewAudioVideoCompleteEvent ReviewAudioVideoTask
    ReduceMediaBitrateCompleteEvent ReduceMediaBitrateTask
    DescribeFileAttributesCompleteEvent DescribeFileAttributesTask
    QualityInspectCompleteEvent QualityInspectTask
    QualityEnhanceCompleteEvent QualityEnhanceTask
    MediaCastStatusChangedEvent MediaCastEvent
    PersistenceCompleteEvent PersistenceCompleteTask
    ComplexAdaptiveDynamicStreamingCompleteEvent ComplexAdaptiveDynamicStreamingTask
    ProcessMediaByMPSCompleteEvent ProcessMediaByMPS
    AigcImageCompleteEvent AigcImageTask
    AigcVideoCompleteEvent AigcVideoTask
    ExtractBlindWatermarkComplete ExtractBlindWatermarkTask
    SceneAigcImageCompleteEvent SceneAigcImageTask
    ProcessImageAsyncCompleteEvent ProcessImageAsyncTask
    CreateAigcAdvancedCustomElementCompleteEvent CreateAigcAdvancedCustomElementTask
    CreateAigcCustomVoiceCompleteEvent CreateAigcCustomVoiceTask
    DescribeAigcFaceInfoAsyncCompleteEvent DescribeAigcFaceInfoAsyncTask
    AigcHunyuan3DCompleteEvent AigcHunyuan3DTask

    ExtractBlindWatermarkInputInfo

    Used by actions: DescribeTaskDetail, ExtractBlindWatermark, PullEvents.

    Name Type Required Description
    Type String Yes
    FileId String No
    Url String No

    ExtractBlindWatermarkTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    InputInfo ExtractBlindWatermarkInputInfo
    Type String
    IsDetected Boolean
    Result String
    ResultUV String
    ExtractBlindWatermarkConfig ExtractBlindWatermarkTaskConfig
    SessionContext String
    SessionId String

    ExtractBlindWatermarkTaskConfig

    Used by actions: DescribeTaskDetail, ExtractBlindWatermark, PullEvents.

    Name Type Required Description
    SegmentDuration Integer Yes

    ExtractCopyRightWatermarkTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    ErrCodeExt String
    Input ExtractCopyRightWatermarkTaskInput
    Output ExtractCopyRightWatermarkTaskOutput
    SessionId String
    SessionContext String

    ExtractCopyRightWatermarkTaskInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Url String

    ExtractCopyRightWatermarkTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Text String

    ExtractTraceWatermarkTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    ErrCodeExt String
    Input ExtractTraceWatermarkTaskInput
    Output ExtractTraceWatermarkTaskOutput
    SessionId String
    SessionContext String

    ExtractTraceWatermarkTaskInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Url String
    FileId String

    ExtractTraceWatermarkTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Uv String

    FaceConfigureInfo

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes
    Score Float No
    DefaultLibraryLabelSet Array of String No
    UserDefineLibraryLabelSet Array of String No
    FaceLibrary String No

    FaceConfigureInfoForUpdate

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No
    Score Float No
    DefaultLibraryLabelSet Array of String No
    UserDefineLibraryLabelSet Array of String No
    FaceLibrary String No

    FaceEnhanceInfo

    Used by actions: CreateEnhanceMediaTemplate, CreateProcessImageAsyncTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyProcessImageAsyncTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes
    Intensity Float No

    FaceRecognitionInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    FaceRecognitionTasks Array of FaceRecognitionTask

    FaceRecognitionOutputFileInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    FileType String
    Url String

    FaceRecognitionTask

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Definition Integer
    OutputFile Array of FaceRecognitionOutputFileInfo

    FastEditMediaFileInfo

    Used by actions: FastEditMedia.

    Name Type Required Description
    FileId String Yes
    AudioVideoType String Yes
    TranscodeDefinition Integer No
    StartTimeOffset Float No
    EndTimeOffset Float No

    FileContent

    Used by actions: ListFiles.

    Name Type Description
    Key String
    LastModified String
    ETag String
    Size Integer
    StorageClass String
    FileId String
    Category String
    FileType String
    Definition Integer
    SubtitleID String

    FileDeleteResultItem

    Used by actions: PullEvents.

    Name Type Description
    FileId String
    DeleteParts Array of MediaDeleteItem

    FileDeleteTask

    Used by actions: PullEvents.

    Name Type Description
    FileIdSet Array of String
    FileDeleteResultInfo Array of FileDeleteResultItem

    FileReviewInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    MediaReviewInfo ReviewInfo
    CoverReviewInfo ReviewInfo

    FileUploadTask

    Used by actions: PullEvents.

    Name Type Description
    FileId String
    MediaBasicInfo MediaBasicInfo
    ProcedureTaskId String
    ReviewAudioVideoTaskId String
    MetaData MediaMetaData

    FileVerifyInfo

    Used by actions: CreateDomainVerifyRecord.

    Name Type Description
    FileVerifyUrl String
    FileVerifyDomains Array of String
    FileVerifyName String

    FollowRedirect

    Automatic Follow Configuration for 301/302 status codes during origin-pull, disabled by default

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Follow origin-pull configuration switch. Valid values:
  • on: Enable;
  • off: Cache.
  • ForceRedirect

    Forced redirect configuration for access protocols. Disabled by default.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Access the forced redirect configuration switch. Value:
  • on: Enable;
  • off: Cache.
  • RedirectType String No Access forced redirect type:
  • http: Force HTTP redirection
  • https: Force HTTPS redirection
  • RedirectStatusCode Integer No Status code returned for forced redirection. Supports 301 and 302.
    CarryHeaders String No Whether to return the added header during forced redirection.

    FrameRateWithDenInfo

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    Switch String Yes
    FpsNum Integer No
    FpsDen Integer No

    FrameTagConfigureInfo

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes
    ScreenshotInterval Float No

    FrameTagConfigureInfoForUpdate

    Used by actions: ModifyAIAnalysisTemplate.

    Name Type Required Description
    Switch String No
    ScreenshotInterval Float No

    HDRInfo

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes
    Type String No

    HeadTailConfigureInfo

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes

    HeadTailConfigureInfoForUpdate

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No

    HeadTailTaskInput

    Used by actions: CreateComplexAdaptiveDynamicStreamingTask, CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes

    HeadTailTemplate

    Used by actions: DescribeHeadTailTemplates.

    Name Type Description
    Definition Integer
    Name String
    Comment String
    HeadCandidateSet Array of String
    TailCandidateSet Array of String
    FillType String
    CreateTime String
    UpdateTime String

    HeuristicCache

    Heuristic cache configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Heuristic cache configuration switch. Valid values:
  • on: Enable;
  • off: Cache.
  • CacheConfig HeuristicCacheConfig No Custom heuristic cache time configuration.

    HeuristicCacheConfig

    Heuristic custom time cache configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    HeuristicCacheTimeSwitch String Yes Heuristic custom time cache configuration switch. Valid values:
  • on: Enable;
  • off: Cache.
  • HeuristicCacheTime Integer Yes Unit: seconds.

    HighlightSegmentItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Confidence Float
    StartTimeOffset Float
    EndTimeOffset Float

    HighlightsConfigureInfo

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes

    HighlightsConfigureInfoForUpdate

    Used by actions: ModifyAIAnalysisTemplate.

    Name Type Required Description
    Switch String No

    HttpHeaderPathRule

    Http header setting rules, with a maximum of 100.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    HeaderMode String Yes http header setting method:
  • set: Set. Change the value of the specified header parameter to the configured value; if the configured header does not exist, it will be added; if there are multiple duplicate header parameters, all will be updated and merged into one header;
  • del: delete. Delete specified HTTP header parameters;
  • add: Add. Add the specified header parameter. Duplicate addition is allowed by default, meaning the same header can be repeatedly added (Note: Repeated addition may affect browser response. Use the set operation preferentially).
  • HeaderName String Yes http header name, up to 100 characters.
    HeaderValue String Yes http header value, up to 1000 characters;
    Optional when Mode is del.
    Required if Mode is add/set.
    RuleType String Yes Rule type:
  • all: take effect for all files;
  • file: The specified file suffix takes effect;
  • directory: specify the path to take effect;
  • path: The absolute path takes effect.
  • RulePaths Array of String Yes Matching content under the corresponding type of RuleType:
  • Fill with * when set to all;
  • For file, fill in the extension, such as jpg or txt;
  • For directory, fill in the path, such as /xxx/test/;
  • For path, fill in the absolute path, such as /xxx/test.html.
  • Https

    https acceleration configuration for the domain name. Disabled by default.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes https configuration switch. Value:
  • on: Enable;
  • off: Cache.
  • Http2 String No http/2 configuration switch. Value:
  • on: Enable;
  • off: Cache.
  • CertInfo CDNCertInfo No Certificate configuration information.

    HwPrivateAccess

    Huawei Cloud object storage origin-pull authentication

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Huawei Cloud object storage origin-pull authentication configuration switch. Valid values:
  • on: Enable;
  • off: Cache.
  • AccessKey String No Access ID.
    SecretKey String No Key.
    Bucket String No Bucket Name.

    IPFilterPolicy

    Used by actions: DescribeVodDomains, ModifyVodDomainConfig.

    Name Type Required Description
    Status String Yes
    FilterType String No
    IPList Array of String No

    ImageBeautyConfig

    Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    BeautyEffectItems Array of BeautyEffectItem No
    BeautyFilterItems Array of BeautyFilterItem No

    ImageBlur

    Used by actions: CreateImageProcessingTemplate.

    Name Type Required Description
    Type String Yes
    Radius Integer No
    Sigma Integer No

    ImageCenterCut

    Used by actions: CreateImageProcessingTemplate.

    Name Type Required Description
    Type String Yes
    Width Integer No
    Height Integer No
    Radius Integer No

    ImageDenoiseConfig

    Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    Switch String No
    Type String No

    ImageEncodeConfig

    Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    Format String No
    Quality Integer No

    ImageEnhanceConfig

    Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    SuperResolution SuperResolutionInfo No
    AdvancedSuperResolution AdvancedSuperResolutionConfig No
    Denoise ImageDenoiseConfig No
    ImageQualityEnhance ImageQualityEnhanceInfo No
    ColorEnhance ColorEnhanceInfo No
    SharpEnhance SharpEnhanceInfo No
    FaceEnhance FaceEnhanceInfo No
    LowLightEnhance LowLightEnhanceInfo No

    ImageOperation

    Used by actions: CreateImageProcessingTemplate, DescribeImageProcessingTemplates.

    Name Type Required Description
    Type String Yes
    Scale ImageScale No
    CenterCut ImageCenterCut No
    Blur ImageBlur No

    ImageProcessingTemplate

    Used by actions: DescribeImageProcessingTemplates.

    Name Type Description
    Definition Integer
    Type String
    Name String
    Comment String
    Operations Array of ImageOperation
    CreateTime String

    ImageQualityEnhanceInfo

    Used by actions: CreateProcessImageAsyncTemplate, CreateTranscodeTemplate, ModifyProcessImageAsyncTemplate, ModifyTranscodeTemplate, PullEvents.

    Name Type Required Description
    Switch String Yes
    Type String No

    ImageReviewUsageDataItem

    Used by actions: DescribeImageReviewUsageData.

    Name Type Description
    Time String
    Count Integer

    ImageScale

    Used by actions: CreateImageProcessingTemplate.

    Name Type Required Description
    Type String Yes
    Height Integer No
    Width Integer No
    LongEdge Integer No
    ShortEdge Integer No

    ImageSceneAigcEncodeConfig

    Used by actions: CreateSceneAigcImageTask.

    Name Type Required Description
    Format String No
    Quality Integer No

    ImageSpriteTaskInput

    Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes

    ImageSpriteTemplate

    Used by actions: DescribeImageSpriteTemplates.

    Name Type Description
    Definition Integer
    Type String
    Name String
    Width Integer
    Height Integer
    ResolutionAdaptive String
    SampleType String
    SampleInterval Integer
    RowCount Integer
    ColumnCount Integer
    CreateTime String
    UpdateTime String
    FillType String
    Comment String
    Format String

    ImageTransform

    Used by actions: ComposeMedia.

    Name Type Required Description
    Type String Yes
    RotateAngle Float No
    Flip String No

    ImageUnderstandingInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    ImageUnderstandingSet Array of ImageUnderstandingItem

    ImageUnderstandingItem

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Definition Integer
    OutputFile Array of MPSOutputFileInfo

    ImageWatermarkInput

    Used by actions: CreateWatermarkTemplate.

    Name Type Required Description
    ImageContent String Yes
    Width String No
    Height String No
    RepeatType String No
    Transparency Integer No

    ImageWatermarkInputForUpdate

    Used by actions: ModifyWatermarkTemplate.

    Name Type Required Description
    ImageContent String No
    Width String No
    Height String No
    RepeatType String No
    Transparency Integer No

    ImageWatermarkTemplate

    Used by actions: DescribeWatermarkTemplates.

    Name Type Description
    ImageUrl String
    Width String
    Height String
    RepeatType String
    Transparency Integer

    ImportMediaKnowledgeTask

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String
    FileId String
    Input ImportMediaKnowledgeTaskInput
    Status String
    ErrCode Integer
    Message String

    ImportMediaKnowledgeTaskInput

    Used by actions: CreateProcedureTemplate, DescribeProcedureTemplates, DescribeTaskDetail, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes
    KnowledgeBaseIds Array of String No

    IpFilter

    IP allowlist/blocklist configuration, disabled by default

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes IP allowlist/blocklist configuration switch. Parameter value:
  • on: Enable;
  • off: Cache.
  • FilterType String No IP allowlist/blocklist type:
  • whitelist: allowlist;
  • blacklist: blocklist.
  • Filters Array of String No IP allowlist or blocklist. It supports IPs in the X.X.X.X format or network segments in the /8, /16, or /24 format.
    Fill up to 50 allowlist entries or 50 blocklist entries.
    FilterRules Array of IpFilterPathRule No IP allowlist/blocklist path-specific configuration.

    IpFilterPathRule

    IP allowlist/blocklist path-specific configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    FilterType String Yes IP allowlist/blocklist type:
  • whitelist: allowlist;
  • blacklist: blocklist.
  • Filters Array of String Yes IP blocklist and allowlist. Supports IPs in X.X.X.X format or network segments in /8, /16, or /24 format.
    Fill up to 50 allowlist entries or 50 blocklist entries.
    RuleType String Yes Rule type:
  • all: take effect for all files;
  • file: The specified file suffix takes effect;
  • directory: specify the path to take effect;
  • path: The absolute path takes effect.
  • RulePaths Array of String Yes Matching content under the corresponding type of RuleType:
  • Fill with * when set to all;
  • For file, fill in the extension, such as jpg or txt;
  • For directory, fill in the path, such as /xxx/test/;
  • For path, fill in the absolute path, such as /xxx/test.html.
  • Ipv6Access

    Ipv6 access configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Domain name activation switch for ipv6 access configuration. Valid values:
  • on: Enable;
  • off: Cache.
  • JitterConfigureInfo

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes

    JitterConfigureInfoForUpdate

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No

    JustInTimeTranscodeTemplate

    Used by actions: DescribeJustInTimeTranscodeTemplates.

    Name Type Description
    Type String
    Name String
    Comment String
    VideoConfigure VideoConfigureInfo
    WatermarkConfigure WatermarkConfigureData

    KnowledgeAnalysisInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Definition Integer
    AnalysisResults Array of KnowledgeAnalysisResult

    KnowledgeAnalysisResult

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    TaskType String
    File MPSOutputFileInfo

    KnowledgeBaseDetail

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    KnowledgeBaseId String
    Definition Integer
    ImportTime Timestamp ISO8601

    KnowledgeBaseInfo

    Used by actions: DescribeKnowledgeBases.

    Name Type Description
    KnowledgeBaseId String
    Name String
    Description String
    Status String
    CreateTime Timestamp ISO8601

    KnowledgeBasesInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Bases Array of String
    KnowledgeAnalysisInfos Array of KnowledgeAnalysisInfo
    KnowledgeBaseDetails Array of KnowledgeBaseDetail

    LLMComprehendAsr

    Used by actions: CreateLLMComprehendTemplate, DescribeLLMComprehendTemplates.

    Name Type Required Description
    Switch String Yes

    LLMComprehendAsrForUpdate

    Used by actions: ModifyLLMComprehendTemplate.

    Name Type Required Description
    Switch String No

    LLMComprehendFaceRecognition

    Used by actions: CreateLLMComprehendTemplate, DescribeLLMComprehendTemplates.

    Name Type Required Description
    Switch String Yes
    Score Float No
    DefaultLibraryLabelSet Array of String No
    UserDefineLibraryLabelSet Array of String No
    FaceLibrary String No

    LLMComprehendFaceRecognitionForUpdate

    Used by actions: ModifyLLMComprehendTemplate.

    Name Type Required Description
    Switch String No
    Score Float No
    DefaultLibraryLabelSet Array of String No
    UserDefineLibraryLabelSet Array of String No
    FaceLibrary String No

    LLMComprehendSummary

    Used by actions: CreateLLMComprehendTemplate, DescribeLLMComprehendTemplates.

    Name Type Required Description
    Switch String Yes
    ExtendedParameter String No

    LLMComprehendSummaryForUpdate

    Used by actions: ModifyLLMComprehendTemplate.

    Name Type Required Description
    Switch String No
    ExtendedParameter String No

    LLMComprehendTemplateItem

    Used by actions: DescribeLLMComprehendTemplates.

    Name Type Description
    Definition Integer
    Name String
    Comment String
    Type String
    Level String
    Summary LLMComprehendSummary
    Asr LLMComprehendAsr
    FaceRecognition LLMComprehendFaceRecognition
    CreateTime Timestamp ISO8601
    UpdateTime Timestamp ISO8601

    LicenseUsageDataItem

    Used by actions: DescribeLicenseUsageData.

    Name Type Description
    Time String
    Count Integer

    LiveRealTimeClipMediaSegmentInfo

    Segment information of the media after real-time clipping.

    Used by actions: LiveRealTimeClip.

    Name Type Description
    StartTime String Segment start time. Format reference: ISO date format description.
    EndTime String Segment end time. For the format, see ISO date format description.

    LiveRealTimeClipStreamInfo

    Live streaming Instant Editing stream information

    Used by actions: LiveRealTimeClip.

    Name Type Required Description
    Type String No Live stream type. Valid values:
  • Original (original stream, default value).
  • Transcoding (transcoding stream).
  • TemplateId Integer No Live streaming transcoding template ID.
    Required when Type is "Transcoding".

    LiveRecordInfo

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Domain String
    Path String
    StreamId String
    RecordStartTime String
    RecordEndTime String

    LowLightEnhanceInfo

    Used by actions: CreateEnhanceMediaTemplate, CreateProcessImageAsyncTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyProcessImageAsyncTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes
    Type String No

    MPSAIAnalysisConfigureInfo

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate.

    Name Type Required Description
    Switch String No

    MPSAIAnalysisTemplate

    Used by actions: CreateMPSTemplate.

    Name Type Required Description
    Name String Yes
    Comment String Yes
    ClassificationConfigure MPSAIAnalysisConfigureInfo No
    TagConfigure MPSAIAnalysisConfigureInfo No
    CoverConfigure MPSAIAnalysisConfigureInfo No
    FrameTagConfigure MPSAIAnalysisConfigureInfo No
    SplitConfigure MPSAIAnalysisConfigureInfo No
    HighlightConfigure MPSAIAnalysisConfigureInfo No
    OpeningAndEndingConfigure MPSAIAnalysisConfigureInfo No

    MPSAIAnalysisTemplateForUpdate

    Used by actions: ModifyMPSTemplate.

    Name Type Required Description
    Definition Integer Yes
    Name String Yes
    Comment String Yes
    ClassificationConfigure MPSAIAnalysisConfigureInfo No
    TagConfigure MPSAIAnalysisConfigureInfo No
    CoverConfigure MPSAIAnalysisConfigureInfo No
    FrameTagConfigure MPSAIAnalysisConfigureInfo No
    SplitConfigure MPSAIAnalysisConfigureInfo No
    HighlightConfigure MPSAIAnalysisConfigureInfo No
    OpeningAndEndingConfigure MPSAIAnalysisConfigureInfo No

    MPSAiAnalysisTaskInput

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    Definition Integer Yes
    ExtendedParameter String No

    MPSAiMediaInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    AiMediaList Array of MPSAiMediaItem

    MPSAiMediaItem

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    TaskType String
    AiMediaTasks Array of MPSAiMediaTask

    MPSAiMediaTask

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Definition Integer
    OutputFile Array of MPSOutputFileInfo
    OutputText String

    MPSEmbedSubtitleTemplate

    Used by actions: CreateMPSTemplate.

    Name Type Required Description
    Name String No
    Comment String No
    SubtitleEmbedConfig MPSSubtitleEmbedConfig No

    MPSEmbedSubtitleTemplateForUpdate

    Used by actions: ModifyMPSTemplate.

    Name Type Required Description
    Definition Integer Yes
    Name String No
    Comment String No
    SubtitleEmbedConfig MPSSubtitleEmbedConfig No

    MPSEraseArea

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate, ProcessMediaByMPS.

    Name Type Required Description
    LeftTopX Float Yes
    LeftTopY Float Yes
    RightBottomX Float Yes
    RightBottomY Float Yes
    Unit Integer Yes

    MPSEraseTimeArea

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate, ProcessMediaByMPS.

    Name Type Required Description
    BeginMs Integer Yes
    EndMs Integer Yes
    Areas Array of MPSEraseArea Yes

    MPSOutputFile

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileType String
    StorageMode String
    FileId String
    Url String
    Definition String
    ExpiredTime Integer

    MPSOutputFileInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    FileType String
    Url String

    MPSOverrideEraseParameter

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    EraseType String No
    EraseSubtitleConfig MPSUpdateSmartEraseSubtitleConfig No
    EraseWatermarkConfig MPSUpdateSmartEraseWatermarkConfig No
    ErasePrivacyConfig MPSSmartErasePrivacyConfig No
    SubtitleEmbedId Integer No

    MPSRawSmartEraseParameter

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    EraseType String Yes
    EraseSubtitleConfig MPSSmartEraseSubtitleConfig No
    EraseWatermarkConfig MPSSmartEraseWatermarkConfig No
    ErasePrivacyConfig MPSSmartErasePrivacyConfig No
    SubtitleEmbedId Integer No
    UseOriginalPos Integer No
    UseOriginalSize Integer No

    MPSRawSmartSubtitleParameter

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    SubtitleType Integer Yes
    VideoSrcLanguage String Yes
    SubtitleFormat String No
    TranslateSwitch String No
    TranslateDstLanguage String No
    ExtInfo String No
    ProcessType Integer No
    SelectingSubtitleAreasConfig MPSSelectingSubtitleAreasConfig No
    SubtitleEmbedId Integer No
    SpeakerMode Integer No
    SpeakerLabel Integer No

    MPSSelectingSubtitleAreasConfig

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate, ProcessMediaByMPS.

    Name Type Required Description
    AutoAreas Array of MPSEraseArea No
    SampleWidth Integer No
    SampleHeight Integer No

    MPSSmartErasePrivacyConfig

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate, ProcessMediaByMPS.

    Name Type Required Description
    PrivacyModel String Yes
    PrivacyTargets Array of String Yes

    MPSSmartEraseSubtitleConfig

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate, ProcessMediaByMPS.

    Name Type Required Description
    SubtitleEraseMethod String Yes
    SubtitleModel String Yes
    OcrSwitch String No
    SubtitleLang String No
    SubtitleFormat String No
    TransSwitch String No
    TransDstLang String No
    AutoAreas Array of MPSEraseArea No
    CustomAreas Array of MPSEraseTimeArea No
    SubtitleEmbedId Integer No
    UseOriginalPos Integer No
    UseOriginalSize Integer No

    MPSSmartEraseTaskInput

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    Definition Integer No
    RawParameter MPSRawSmartEraseParameter No
    OverrideParameter MPSOverrideEraseParameter No

    MPSSmartEraseTemplate

    Used by actions: CreateMPSTemplate.

    Name Type Required Description
    Name String Yes
    EraseType String Yes
    Comment String No
    EraseSubtitleConfig MPSSmartEraseSubtitleConfig No
    EraseWatermarkConfig MPSSmartEraseWatermarkConfig No
    ErasePrivacyConfig MPSSmartErasePrivacyConfig No
    SampleWidth Integer No
    SampleHeight Integer No

    MPSSmartEraseTemplateForUpdate

    Used by actions: ModifyMPSTemplate.

    Name Type Required Description
    Definition Integer Yes
    Name String Yes
    EraseType String Yes
    Comment String No
    EraseSubtitleConfig MPSSmartEraseSubtitleConfig No
    EraseWatermarkConfig MPSSmartEraseWatermarkConfig No
    ErasePrivacyConfig MPSSmartErasePrivacyConfig No
    SampleWidth Integer No
    SampleHeight Integer No

    MPSSmartEraseWatermarkConfig

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate, ProcessMediaByMPS.

    Name Type Required Description
    WatermarkEraseMethod String Yes
    WatermarkModel String Yes
    AutoAreas Array of MPSEraseArea No
    CustomAreas Array of MPSEraseTimeArea No

    MPSSmartSubtitleTemplate

    Used by actions: CreateMPSTemplate.

    Name Type Required Description
    Name String Yes
    Comment String Yes
    SubtitleType Integer Yes
    VideoSrcLanguage String No
    SubtitleFormat String No
    TranslateSwitch String No
    TranslateDstLanguage String No
    ProcessType Integer No
    SelectingSubtitleAreasConfig MPSSelectingSubtitleAreasConfig No
    SubtitleEmbedId Integer No
    SpeakerMode Integer No
    SpeakerLabel Integer No

    MPSSmartSubtitleTemplateForUpdate

    Used by actions: ModifyMPSTemplate.

    Name Type Required Description
    Definition Integer Yes
    Name String Yes
    Comment String Yes
    SubtitleType Integer Yes
    VideoSrcLanguage String No
    SubtitleFormat String No
    TranslateSwitch String No
    TranslateDstLanguage String No
    ProcessType Integer No
    SelectingSubtitleAreasConfig MPSSelectingSubtitleAreasConfig No
    SubtitleEmbedId Integer No
    SpeakerMode Integer No
    SpeakerLabel Integer No

    MPSSmartSubtitlesTaskInput

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    Definition Integer No
    RawParameter MPSRawSmartSubtitleParameter No

    MPSSubTaskResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskType String
    Status String
    ErrCode String
    Message String
    Input String
    Output MPSTaskOutput

    MPSSubtitleBoardConfig

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate.

    Name Type Required Description
    SubtitleBoardConfigSwitch Integer No
    BoardX Integer No
    BoardXUnit Integer No
    BoardY Integer No
    BoardYUnit Integer No
    BoardWidth Integer No
    BoardWidthUnit Integer No
    BoardHeight Integer No
    BoardHeightUnit Integer No
    BoardColor String No
    BoardAlpha Float No

    MPSSubtitleEmbedConfig

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate.

    Name Type Required Description
    FontType String No
    FontPath String No
    FontSize Integer No
    FontSizeUnit Integer No
    FontColor String No
    FontAlpha Float No
    PosX Integer No
    PosXUnit Integer No
    PosY Integer No
    PosYUnit Integer No
    SubtitleBoardConfig MPSSubtitleBoardConfig No
    SubtitleLayoutConfig MPSSubtitleLayoutConfig No
    SubtitleOutlineConfig MPSSubtitleOutlineConfig No
    SubtitleShadowConfig MPSSubtitleShadowConfig No
    SampleWidth Integer No
    SampleHeight Integer No

    MPSSubtitleLayoutConfig

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate.

    Name Type Required Description
    SubtitleLayoutConfigSwitch Integer No
    LineSpacing Integer No
    LineSpacingUnit Integer No
    Alignment String No

    MPSSubtitleOutlineConfig

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate.

    Name Type Required Description
    SubtitleOutlineConfigSwitch Integer No
    OutlineWidth Float No
    OutlineWidthUnit Integer No
    OutlineColor String No
    OutlineAlpha Float No

    MPSSubtitleShadowConfig

    Used by actions: CreateMPSTemplate, ModifyMPSTemplate.

    Name Type Required Description
    SubtitleShadowConfigSwitch Integer No
    ShadowWidth Float No
    ShadowWidthUnit Integer No
    ShadowColor String No
    ShadowAlpha Float No

    MPSTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    OutputFiles Array of MPSOutputFile
    OutputText String

    MPSTemplate

    MPS task template detail.

    Used by actions: DescribeMPSTemplates.

    Name Type Description
    TaskType String MPS template type. Valid values:
  • Transcode: transcoding template.
  • MPSTemplateInfo String MPS task template detail.

    MPSUpdateSmartEraseSubtitleConfig

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    SubtitleEraseMethod String No
    SubtitleModel String No
    OcrSwitch String No
    SubtitleLang String No
    SubtitleFormat String No
    TransSwitch String No
    TransDstLang String No
    AutoAreas Array of MPSEraseArea No
    CustomAreas Array of MPSEraseTimeArea No

    MPSUpdateSmartEraseWatermarkConfig

    Used by actions: ProcessMediaByMPS.

    Name Type Required Description
    WatermarkEraseMethod String No
    WatermarkModel String No
    AutoAreas Array of MPSEraseArea No
    CustomAreas Array of MPSEraseTimeArea No

    MaxAge

    Browser cache rule configuration, used to set the default MaxAge value. Disabled by default.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    MaxAgeRules Array of MaxAgeRule No MaxAge rule.

    MaxAgeRule

    MagAge rule configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    MaxAgeType String Yes

    Rule type:

  • all: takes effect for all files;
  • file: takes effect for a specified file extension;
  • directory: takes effect for a specified path;
  • path: takes effect for an absolute path.
  • MaxAgeContents Array of String Yes

    Matching content for the corresponding type of MaxAgeType:

  • For all, fill in *;
  • For file, fill in the extension, such as jpg, txt;
  • For directory, fill in the path, such as /xxx/test/;
  • For path, fill in the absolute path, such as /xxx/test.html.
  • Note: The all rule is non-deletable, follows the origin site by default, and is modifiable.
    MaxAgeTime Integer Yes

    MaxAge time setting, in seconds;
    Note: If the time is 0, no cache is used.

    FollowOrigin String No

    Whether to follow the origin site. Valid values: on, off. When enabled, the time setting is ignored.

    MediaAdaptiveDynamicStreamingInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    AdaptiveDynamicStreamingSet Array of AdaptiveDynamicStreamingInfoItem

    MediaAiAnalysisClassificationItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Classification String
    Confidence Float

    MediaAiAnalysisCoverItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    CoverUrl String
    Confidence Float

    MediaAiAnalysisFrameTagItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Tag String
    CategorySet Array of String
    Confidence Float

    MediaAiAnalysisFrameTagSegmentItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float
    EndTimeOffset Float
    TagSet Array of MediaAiAnalysisFrameTagItem

    MediaAiAnalysisHighlightItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    HighlightUrl String
    CovImgUrl String
    Confidence Float
    Duration Float
    SegmentSet Array of HighlightSegmentItem

    MediaAiAnalysisTagItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Tag String
    Confidence Float

    MediaAnimatedGraphicsInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    AnimatedGraphicsSet Array of MediaAnimatedGraphicsItem

    MediaAnimatedGraphicsItem

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Url String
    Definition Integer
    Container String
    Height Integer
    Width Integer
    Bitrate Integer
    Size Integer
    Md5 String
    StartTimeOffset Float
    EndTimeOffset Float

    MediaAudioStreamItem

    Audio stream information of VOD files

    Used by actions: DescribeMediaInfos, LiveRealTimeClip, SearchMedia, SimpleHlsClip.

    Name Type Description
    Bitrate Integer

    Audio stream bitrate, in bps.

    SamplingRate Integer

    Sampling rate of the audio stream. Unit: hz.

    Codec String

    Audio stream encoding format, for example, aac.

    MediaBasicInfo

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Name String
    Description String
    CreateTime String
    UpdateTime String
    ExpireTime String
    ClassId Integer
    ClassName String
    ClassPath String
    CoverUrl String
    Type String
    MediaUrl String
    SourceInfo MediaSourceData
    StorageRegion String
    StoragePath String
    TagSet Array of String
    Vid String
    Category String
    Status String
    StorageClass String

    MediaCastEvent

    Used by actions: PullEvents.

    Name Type Required Description
    CastId String No
    Status String No

    MediaClassInfo

    Used by actions: DescribeAllClass.

    Name Type Description
    ClassId Integer
    ParentId Integer
    Name String
    Level Integer
    SubClassIdSet Array of Integer
    ClassName String

    MediaContentReviewAsrTextSegmentItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float
    EndTimeOffset Float
    Confidence Float
    Suggestion String
    KeywordSet Array of String

    MediaContentReviewOcrTextSegmentItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float
    EndTimeOffset Float
    Confidence Float
    Suggestion String
    KeywordSet Array of String
    AreaCoordSet Array of Integer
    Url String
    PicUrlExpireTime String

    MediaContentReviewPoliticalSegmentItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float
    EndTimeOffset Float
    Confidence Float
    Suggestion String
    Name String
    Label String
    Url String
    AreaCoordSet Array of Integer
    PicUrlExpireTime String

    MediaContentReviewSegmentItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float
    EndTimeOffset Float
    Confidence Float
    Label String
    Suggestion String
    Url String
    PicUrlExpireTime String

    MediaDeleteItem

    Used by actions: DeleteMedia, PullEvents.

    Name Type Required Description
    Type String Yes
    Definition Integer No

    MediaImageSpriteInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    ImageSpriteSet Array of MediaImageSpriteItem

    MediaImageSpriteItem

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Definition Integer
    Height Integer
    Width Integer
    TotalCount Integer
    ImageUrlSet Array of String
    WebVttUrl String

    MediaInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    BasicInfo MediaBasicInfo
    MetaData MediaMetaData
    TranscodeInfo MediaTranscodeInfo
    AnimatedGraphicsInfo MediaAnimatedGraphicsInfo
    SampleSnapshotInfo MediaSampleSnapshotInfo
    ImageSpriteInfo MediaImageSpriteInfo
    SnapshotByTimeOffsetInfo MediaSnapshotByTimeOffsetInfo
    KeyFrameDescInfo MediaKeyFrameDescInfo
    AdaptiveDynamicStreamingInfo MediaAdaptiveDynamicStreamingInfo
    MiniProgramReviewInfo MediaMiniProgramReviewInfo
    SubtitleInfo MediaSubtitleInfo
    FileId String
    ReviewInfo FileReviewInfo
    MPSAiMediaInfo MPSAiMediaInfo
    ImageUnderstandingInfo ImageUnderstandingInfo
    KnowledgeBasesInfo KnowledgeBasesInfo
    FaceRecognitionInfo FaceRecognitionInfo

    MediaInputInfo

    Used by actions: ProcessMediaByUrl.

    Name Type Required Description
    Url String Yes
    Name String No
    Id String No

    MediaKeyFrameDescInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    KeyFrameDescSet Array of MediaKeyFrameDescItem

    MediaKeyFrameDescItem

    Used by actions: DescribeMediaInfos, ModifyMediaInfo, SearchMedia.

    Name Type Required Description
    TimeOffset Float Yes
    Content String Yes

    MediaMetaData

    Meta-information of on-demand media files

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, LiveRealTimeClip, PullEvents, SearchMedia, SimpleHlsClip.

    Name Type Description
    Size Integer Size of the uploaded media file (for HLS videos, the size is the sum of the m3u8 and ts file sizes), unit: byte.
    Container String Container type, for example, m4a, mp4.
    Bitrate Integer Sum of the mean video stream bitrate and mean audio stream bitrate, in bps.
    Height Integer Maximum video stream height in px.
    Width Integer Maximum video stream width in px.
    Duration Float Video duration, unit: seconds.
    Rotate Integer Selection angle during video shooting. Unit: degree.
    VideoStreamSet Array of MediaVideoStreamItem Video stream information.
    AudioStreamSet Array of MediaAudioStreamItem Audio stream information.
    VideoDuration Float Video duration, unit: seconds.
    AudioDuration Float Audio duration, in seconds.
    Md5 String Md5 value of the media file.
  • Note: To get the Md5 of a media file, call the DescribeFileAttributes API and get it after the task is completed.
  • MediaMiniProgramReviewElem

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Type String
    Suggestion String
    Confidence Float

    MediaMiniProgramReviewInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    MiniProgramReviewList Array of MediaMiniProgramReviewInfoItem

    MediaMiniProgramReviewInfoItem

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Definition Integer
    MetaData MediaMetaData
    Url String
    ReviewResult String
    ReviewSummary Array of MediaMiniProgramReviewElem

    MediaOutputInfo

    Used by actions: ProcessMediaByUrl.

    Name Type Required Description
    Region String No
    Bucket String No
    Dir String No

    MediaProcessTaskAdaptiveDynamicStreamingResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String
    ErrCodeExt String
    ErrCode Integer
    Message String
    Progress Integer
    Input AdaptiveDynamicStreamingTaskInput
    Output AdaptiveDynamicStreamingInfoItem
    BeginProcessTime String
    FinishTime String

    MediaProcessTaskAnimatedGraphicResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String
    ErrCodeExt String
    ErrCode Integer
    Message String
    Input AnimatedGraphicTaskInput
    Output MediaAnimatedGraphicsItem
    Progress Integer
    BeginProcessTime String
    FinishTime String

    MediaProcessTaskCoverBySnapshotResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String
    ErrCodeExt String
    ErrCode Integer
    Message String
    Input CoverBySnapshotTaskInput
    Output CoverBySnapshotTaskOutput
    Progress Integer
    BeginProcessTime String
    FinishTime String

    MediaProcessTaskImageSpriteResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String
    ErrCodeExt String
    ErrCode Integer
    Message String
    Input ImageSpriteTaskInput
    Output MediaImageSpriteItem
    Progress Integer
    BeginProcessTime String
    FinishTime String

    MediaProcessTaskInput

    Used by actions: CreateProcedureTemplate, DescribeProcedureTemplates, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    TranscodeTaskSet Array of TranscodeTaskInput No
    AnimatedGraphicTaskSet Array of AnimatedGraphicTaskInput No
    SnapshotByTimeOffsetTaskSet Array of SnapshotByTimeOffsetTaskInput No
    SampleSnapshotTaskSet Array of SampleSnapshotTaskInput No
    ImageSpriteTaskSet Array of ImageSpriteTaskInput No
    CoverBySnapshotTaskSet Array of CoverBySnapshotTaskInput No
    AdaptiveDynamicStreamingTaskSet Array of AdaptiveDynamicStreamingTaskInput No

    MediaProcessTaskResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Type String
    TranscodeTask MediaProcessTaskTranscodeResult
    AnimatedGraphicTask MediaProcessTaskAnimatedGraphicResult
    SnapshotByTimeOffsetTask MediaProcessTaskSnapshotByTimeOffsetResult
    SampleSnapshotTask MediaProcessTaskSampleSnapshotResult
    ImageSpriteTask MediaProcessTaskImageSpriteResult
    CoverBySnapshotTask MediaProcessTaskCoverBySnapshotResult
    AdaptiveDynamicStreamingTask MediaProcessTaskAdaptiveDynamicStreamingResult

    MediaProcessTaskSampleSnapshotResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String
    ErrCodeExt String
    ErrCode Integer
    Message String
    Input SampleSnapshotTaskInput
    Output MediaSampleSnapshotItem
    Progress Integer
    BeginProcessTime String
    FinishTime String

    MediaProcessTaskSnapshotByTimeOffsetResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String
    ErrCodeExt String
    ErrCode Integer
    Message String
    Input SnapshotByTimeOffsetTaskInput
    Output MediaSnapshotByTimeOffsetItem
    Progress Integer
    BeginProcessTime String
    FinishTime String

    MediaProcessTaskTranscodeResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String
    ErrCodeExt String
    ErrCode Integer
    Message String
    Input TranscodeTaskInput
    Output MediaTranscodeItem
    Progress Integer
    BeginProcessTime String
    FinishTime String

    MediaSampleSnapshotInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    SampleSnapshotSet Array of MediaSampleSnapshotItem

    MediaSampleSnapshotItem

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Definition Integer
    SampleType String
    Interval Integer
    ImageUrlSet Array of String
    WaterMarkDefinition Array of Integer

    MediaSnapshotByTimeOffsetInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    SnapshotByTimeOffsetSet Array of MediaSnapshotByTimeOffsetItem

    MediaSnapshotByTimeOffsetItem

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Definition Integer
    PicInfoSet Array of MediaSnapshotByTimePicInfoItem

    MediaSnapshotByTimePicInfoItem

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    TimeOffset Float
    Url String
    WaterMarkDefinition Array of Integer

    MediaSourceData

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    SourceType String
    SourceContext String
    LiveRecordInfo LiveRecordInfo
    TrtcRecordInfo TrtcRecordInfo
    WebPageRecordInfo WebPageRecordInfo

    MediaSubStreamInfoItem

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Type String
    Width Integer
    Height Integer
    Size Integer

    MediaSubtitleInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    SubtitleSet Array of MediaSubtitleItem

    MediaSubtitleInput

    Used by actions: ModifyMediaInfo.

    Name Type Required Description
    Name String Yes
    Language String Yes
    Format String Yes
    Content String Yes
    Id String No

    MediaSubtitleItem

    Used by actions: DescribeMediaInfos, ModifyMediaInfo, SearchMedia.

    Name Type Description
    Id String
    Name String
    Language String
    Format String
    Url String
    Source String

    MediaTrack

    Used by actions: ComposeMedia, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Type String Yes
    TrackItems Array of MediaTrackItem Yes

    MediaTrackItem

    Used by actions: ComposeMedia.

    Name Type Required Description
    Type String Yes
    VideoItem VideoTrackItem No
    AudioItem AudioTrackItem No
    StickerItem StickerTrackItem No
    TransitionItem MediaTransitionItem No
    EmptyItem EmptyTrackItem No

    MediaTranscodeInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    TranscodeSet Array of MediaTranscodeItem

    MediaTranscodeItem

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    Url String
    Definition Integer
    Bitrate Integer
    Height Integer
    Width Integer
    Size Integer
    Duration Float
    Md5 String
    Container String
    VideoStreamSet Array of MediaVideoStreamItem
    AudioStreamSet Array of MediaAudioStreamItem
    DigitalWatermarkType String
    CopyRightWatermarkText String
    BlindWatermarkDefinition Integer
    FileId String

    MediaTransitionItem

    Used by actions: ComposeMedia.

    Name Type Required Description
    Duration Float Yes
    MediaTransitions Array of TransitionOperation No

    MediaVideoStreamItem

    Video stream information of VOD files

    Used by actions: DescribeMediaInfos, LiveRealTimeClip, SearchMedia, SimpleHlsClip.

    Name Type Description
    Bitrate Integer Bitrate of the video stream. Unit: bps.
    Height Integer Video stream height in px.
    Width Integer Video stream width in px.
    Codec String Video stream encoding format, for example, h264.
    Fps Integer Frame rate. Measurement unit: hz.
    CodecTag String Encoding tag. It is valid only when Codec is hevc.
    DynamicRangeInfo DynamicRangeInfo Dynamic range information of the frame.
  • Note: This field is valid for transcoded files processed after 2023-01-10T00:00:00Z.
  • MosaicConfigureInfo

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes

    MosaicConfigureInfoForUpdate

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No

    MosaicInput

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    CoordinateOrigin String No
    XPos String No
    YPos String No
    Width String No
    Height String No
    StartTimeOffset Float No
    EndTimeOffset Float No

    NoiseConfigureInfo

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes

    NoiseConfigureInfoForUpdate

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No

    ObjectConfigureInfo

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes
    ObjectLibrary String No

    ObjectConfigureInfoForUpdate

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No
    ObjectLibrary String No

    OcrFullTextConfigureInfo

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes

    OcrFullTextConfigureInfoForUpdate

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No

    OcrWordsConfigureInfo

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes
    LabelSet Array of String No

    OcrWordsConfigureInfoForUpdate

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No
    LabelSet Array of String No

    Origin

    Origin server configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Origins Array of String No Primary origin server list.
    When modifying the primary origin server, fill in the corresponding OriginType at the same time.
    OriginType String No Primary origin server type. Input supports the following types:
  • domain: Domain type;
  • ip: IP list as the origin server;
  • third_party: third-party object storage origin.
  • ServerName String No Host header when pulling from the primary origin server. If not filled, the acceleration domain name is used by default.
    When the origin server type is COS, the ServerName field is required.
    OriginPullProtocol String No Origin-pull protocol configuration.
  • http: Force HTTP origin-pull.
  • follow: follow protocol for origin-pull;
  • https: Switch HTTP requests to HTTPS. This only supports port 443 on the origin server.
  • BackupOrigins Array of String No Backup origin list.
    When modifying the backup origin server, fill in the corresponding OriginType at the same time.
    BackupOriginType String No Secondary origin type. Input supports the following types:
  • domain: Domain type;
  • ip: IP list as the origin server;
  • third_party: third-party object storage origin.
  • BackupServerName String No Host header when pulling from the backup origin server. If not filled, the ServerName of the primary origin server is used by default.
    OriginCompany String No Object storage origin service vendor. Required when the origin server type is third-party object storage origin (third_party). Optional values include the following:
  • aws_s3:AWS S3;
  • ali_oss: Alibaba Cloud OSS;
  • hw_obs: Huawei OBS;
  • others: other vendor's object storage. Only object storage compatible with the AWS signature algorithm is supported, such as Tencent Cloud COS.
  • OssPrivateAccess

    Authentication for origin-pull from Alibaba Cloud OSS

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Switch for authentication configuration for origin-pull from Alibaba Cloud OSS. Valid values:
  • on: Enable;
  • off: Cache.
  • AccessKey String No Access ID.
    SecretKey String No Key.
    Region String No Region.
    Bucket String No Bucket Name.

    OthersPrivateAccess

    Authentication for origin-pull from other vendors' object storage

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Authentication configuration switch for origin-pull from other vendors. Valid values:
  • on: Enable;
  • off: Cache.
  • AccessKey String No Access ID.
    SecretKey String No Key.
    Region String No Region.
    Bucket String No Bucket Name.

    OutputAudioStream

    Used by actions: ComposeMedia.

    Name Type Required Description
    Codec String No
    SampleRate Integer No
    AudioChannel Integer No
    Bitrate Integer No

    OutputVideoStream

    Used by actions: ComposeMedia.

    Name Type Required Description
    Codec String No
    Fps Integer No

    OverrideTranscodeParameter

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Container String No
    RemoveVideo Integer No
    RemoveAudio Integer No
    VideoTemplate VideoTemplateInfoForUpdate No
    AudioTemplate AudioTemplateInfoForUpdate No
    TEHDConfig TEHDConfigForUpdate No
    StdExtInfo String No

    PatternConfig

    Used by actions: CreateProcessImageAsyncTemplate, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    TransparencyThreshold Integer No
    OpaqueThreshold Integer No
    EdgeSamplingStep Integer No
    EdgeExpansionStep Integer No
    EdgeBlendingIntensity Float No

    PersistenceCompleteTask

    Used by actions: PullEvents.

    Name Type Description
    FileId String
    PersistenceSource String

    PlayStatFileInfo

    Used by actions: DescribeDailyPlayStatFileList.

    Name Type Description
    Date String
    Url String

    PlayStatInfo

    Used by actions: DescribeMediaPlayStatDetails.

    Name Type Description
    Time String
    FileId String
    PlayTimes Integer
    Traffic Integer

    PlayerConfig

    Used by actions: DescribeSuperPlayerConfigs.

    Name Type Description
    Name String
    Type String
    AudioVideoType String
    DrmSwitch String
    AdaptiveDynamicStreamingDefinition Integer
    DrmStreamingsInfo DrmStreamingsInfo
    TranscodeDefinition Integer
    ImageSpriteDefinition Integer
    ResolutionNameSet Array of ResolutionNameInfo
    CreateTime String
    UpdateTime String
    Domain String
    Scheme String
    Comment String

    PoliticalAsrReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    ReviewConfidence Integer No
    BlockConfidence Integer No

    PoliticalAsrReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    PoliticalConfigureInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    ImgReviewInfo PoliticalImgReviewTemplateInfo No
    AsrReviewInfo PoliticalAsrReviewTemplateInfo No
    OcrReviewInfo PoliticalOcrReviewTemplateInfo No

    PoliticalConfigureInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    ImgReviewInfo PoliticalImgReviewTemplateInfoForUpdate No
    AsrReviewInfo PoliticalAsrReviewTemplateInfoForUpdate No
    OcrReviewInfo PoliticalOcrReviewTemplateInfoForUpdate No

    PoliticalImgReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    LabelSet Array of String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    PoliticalImgReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    LabelSet Array of String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    PoliticalOcrReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    BlockConfidence Integer No
    ReviewConfidence Integer No

    PoliticalOcrReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    PornAsrReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    BlockConfidence Integer No
    ReviewConfidence Integer No

    PornAsrReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    PornConfigureInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    ImgReviewInfo PornImgReviewTemplateInfo No
    AsrReviewInfo PornAsrReviewTemplateInfo No
    OcrReviewInfo PornOcrReviewTemplateInfo No

    PornConfigureInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    ImgReviewInfo PornImgReviewTemplateInfoForUpdate No
    AsrReviewInfo PornAsrReviewTemplateInfoForUpdate No
    OcrReviewInfo PornOcrReviewTemplateInfoForUpdate No

    PornImgReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    LabelSet Array of String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    PornImgReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    LabelSet Array of String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    PornOcrReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    BlockConfidence Integer No
    ReviewConfidence Integer No

    PornOcrReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    ProcedureReviewAudioVideoTaskInput

    Used by actions: CreateProcedureTemplate, DescribeProcedureTemplates, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes
    ReviewContents Array of String No

    ProcedureTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    FileId String
    FileName String
    FileUrl String
    MetaData MediaMetaData
    MediaProcessResultSet Array of MediaProcessTaskResult
    AiContentReviewResultSet Array of AiContentReviewResult
    AiAnalysisResultSet Array of AiAnalysisResult
    AiRecognitionResultSet Array of AiRecognitionResult
    TasksPriority Integer
    TasksNotifyMode String
    SessionContext String
    SessionId String
    Operator String
    OperationType String

    ProcedureTemplate

    Used by actions: DescribeProcedureTemplates.

    Name Type Description
    Name String
    Type String
    Comment String
    MediaProcessTask MediaProcessTaskInput
    AiContentReviewTask AiContentReviewTaskInput
    AiAnalysisTask AiAnalysisTaskInput
    AiRecognitionTaskSet Array of AiRecognitionTaskInput
    MiniProgramPublishTask WechatMiniProgramPublishTaskInput
    ReviewAudioVideoTask ProcedureReviewAudioVideoTaskInput
    ImportMediaKnowledgeTaskSet Array of ImportMediaKnowledgeTaskInput
    CreateTime String
    UpdateTime String

    ProcessImageAsync

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    Progress Integer
    Input ProcessImageAsyncInput
    Output ProcessImageAsyncOutput
    SessionId String
    SessionContext String

    ProcessImageAsyncInput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    FileId String
    Url String
    ImageTaskInput ProcessImageAsyncTaskInput
    OutputConfig ProcessImageAsyncOutputConfig

    ProcessImageAsyncInputExtendedParameter

    Used by actions: ProcessImageAsync.

    Name Type Required Description
    Prompts Array of String No

    ProcessImageAsyncOutput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    FileInfo ProcessImageAsyncOutputFileInfo
    OutputText String

    ProcessImageAsyncOutputConfig

    Used by actions: DescribeTaskDetail, ProcessImageAsync.

    Name Type Required Description
    MediaName String No
    ClassId Integer No
    ExpireTime String No

    ProcessImageAsyncOutputFileInfo

    Used by actions: DescribeTaskDetail.

    Name Type Description
    MediaName String
    ClassId Integer
    ExpireTime String
    FileType String
    FileUrl String
    FileId String
    MetaData MediaMetaData

    ProcessImageAsyncTask

    Used by actions: CreateProcessImageAsyncTemplate, DescribeProcessImageAsyncTemplates, ModifyProcessImageAsyncTemplate, PullEvents.

    Name Type Required Description
    EncodeConfig ImageEncodeConfig No
    EnhanceConfig ImageEnhanceConfig No
    BeautyConfig ImageBeautyConfig No
    AiCutOutConfig AiCutOutConfig No

    ProcessImageAsyncTaskInput

    Used by actions: DescribeTaskDetail, ProcessImageAsync.

    Name Type Required Description
    Definition Integer Yes
    ExtendedParameter ProcessImageAsyncInputExtendedParameter No

    ProcessImageAsyncTemplateItem

    Used by actions: DescribeProcessImageAsyncTemplates.

    Name Type Description
    Definition Integer
    Type String
    Name String
    Comment String
    CreateTime String
    UpdateTime String
    ProcessImageConfigure ProcessImageAsyncTask

    ProcessMediaByMPS

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    SubTaskSet Array of MPSSubTaskResult

    ProductImageConfig

    Used by actions: CreateSceneAigcImageTask.

    Name Type Required Description
    Prompt String No
    NegativePrompt String No
    ProductDesc String No
    MoreRequirement String No
    OutputImageCount Integer No

    ProductShowcaseConfig

    Used by actions: CreateSceneAigcVideoTask.

    Name Type Required Description
    CameraMovement String No

    ProhibitedAsrReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    BlockConfidence Integer No
    ReviewConfidence Integer No

    ProhibitedAsrReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    ProhibitedConfigureInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    AsrReviewInfo ProhibitedAsrReviewTemplateInfo No
    OcrReviewInfo ProhibitedOcrReviewTemplateInfo No

    ProhibitedConfigureInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    AsrReviewInfo ProhibitedAsrReviewTemplateInfoForUpdate No
    OcrReviewInfo ProhibitedOcrReviewTemplateInfoForUpdate No

    ProhibitedOcrReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    BlockConfidence Integer No
    ReviewConfidence Integer No

    ProhibitedOcrReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    PullUploadTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    FileId String
    MediaBasicInfo MediaBasicInfo
    MetaData MediaMetaData
    FileUrl String
    ProcedureTaskId String
    ReviewAudioVideoTaskId String
    SessionContext String
    SessionId String
    Progress Integer

    QRCodeConfigureInfo

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes

    QRCodeConfigureInfoForUpdate

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No

    QualityEnhanceTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    ErrCodeExt String
    Progress Integer
    Input QualityEnhanceTaskInput
    Output QualityEnhanceTaskOutput
    MetaData MediaMetaData
    SessionId String
    SessionContext String

    QualityEnhanceTaskInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String
    Definition Integer

    QualityEnhanceTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileType String
    FileUrl String
    FileId String
    MediaName String
    ClassId Integer
    ExpireTime String

    QualityEvaluationConfigureInfo

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes
    Score Integer No

    QualityEvaluationConfigureInfoForUpdate

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No
    Score Integer No

    QualityInspectConfig

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates, ModifyQualityInspectTemplate.

    Name Type Required Description
    Type String Yes
    Switch String No
    Sampling String No
    IntervalTime Integer No
    Duration Integer No
    Threshold String No

    QualityInspectContainerDiagnoseResultItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Category String
    Type String
    SeverityLevel String
    TimestampSet Array of Float

    QualityInspectItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float
    EndTimeOffset Float
    AreaCoordSet Array of Integer
    Confidence Integer

    QualityInspectLLMDetectionIssue

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Tag String
    Description String
    Score Float
    Confidence Float
    StartTimeMs Integer
    EndTimeMs Integer
    ExtraData String

    QualityInspectLLMDetectionReport

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ResultCount Integer
    ResultSet Array of QualityInspectLLMDetectionResultItem

    QualityInspectLLMDetectionResultItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Category String
    Group String
    Type String
    Score Float
    Confidence Float
    IssueSet Array of QualityInspectLLMDetectionIssue

    QualityInspectResultItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Type String
    SegmentSet Array of QualityInspectItem
    SegmentSetFileUrl String
    SegmentSetFileUrlExpireTime String

    QualityInspectStrategy

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates, ModifyQualityInspectTemplate.

    Name Type Required Description
    StrategyType String No
    TimeSpotCheck QualityInspectTimeSpotCheck No

    QualityInspectTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCodeExt String
    Message String
    MetaData MediaMetaData
    Input QualityInspectTaskInput
    Output QualityInspectTaskOutput
    SessionId String
    SessionContext String

    QualityInspectTaskInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String
    Definition Integer

    QualityInspectTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    NoAudio Integer
    NoVideo Integer
    QualityEvaluationScore Integer
    QualityInspectResultSet Array of QualityInspectResultItem
    QualityEvaluationMeanOpinionScore Float
    AestheticEvaluationScore Integer
    ContainerDiagnoseResultSet Array of QualityInspectContainerDiagnoseResultItem
    LLMDetectionReport QualityInspectLLMDetectionReport

    QualityInspectTemplateItem

    Used by actions: DescribeQualityInspectTemplates.

    Name Type Description
    Definition Integer
    Type String
    Name String
    Comment String
    Configs Array of QualityInspectConfig
    Strategy QualityInspectStrategy
    CreateTime String
    UpdateTime String
    ScreenshotInterval Float
    JitterConfigure JitterConfigureInfo
    BlurConfigure BlurConfigureInfo
    AbnormalLightingConfigure AbnormalLightingConfigureInfo
    CrashScreenConfigure CrashScreenConfigureInfo
    BlackWhiteEdgeConfigure BlackWhiteEdgeConfigureInfo
    NoiseConfigure NoiseConfigureInfo
    MosaicConfigure MosaicConfigureInfo
    QRCodeConfigure QRCodeConfigureInfo
    QualityEvaluationConfigure QualityEvaluationConfigureInfo
    VoiceConfigure VoiceConfigureInfo

    QualityInspectTimeSpotCheck

    Used by actions: CreateQualityInspectTemplate, ModifyQualityInspectTemplate.

    Name Type Required Description
    CheckDuration Integer No
    CheckInterval Integer No
    SkipDuration Integer No
    CirclesNumber Integer No

    Quic

    Quic configuration item

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Quic feature configuration switch. Valid values:
  • on: Enable;
  • off: Cache.
  • RebuildAudioInfo

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate.

    Name Type Required Description
    AudioDenoiseInfo AudioDenoiseInfo No

    RebuildMediaOutputConfig

    Used by actions: EnhanceMediaByTemplate, RebuildMediaByTemplate.

    Name Type Required Description
    MediaName String No
    ClassId Integer No
    ExpireTime String No

    RebuildMediaTargetAudioStream

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, RebuildMedia.

    Name Type Required Description
    Codec String No
    Bitrate Integer No
    SampleRate Integer No
    AudioChannel Integer No

    RebuildMediaTargetInfo

    Used by actions: DescribeTaskDetail, PullEvents, RebuildMedia.

    Name Type Required Description
    MediaName String No
    Description String No
    ClassId Integer No
    ExpireTime String No
    Container String No
    VideoStream RebuildMediaTargetVideoStream No
    AudioStream RebuildMediaTargetAudioStream No
    RemoveVideo Integer No
    RemoveAudio Integer No

    RebuildMediaTargetVideoStream

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, RebuildMedia.

    Name Type Required Description
    Codec String No
    Bitrate Integer No
    Fps Integer No
    ResolutionAdaptive String No
    Width Integer No
    Height Integer No
    FillType String No
    Gop Integer No

    RebuildMediaTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    ErrCodeExt String
    Progress Integer
    Input RebuildMediaTaskInput
    Output RebuildMediaTaskOutput
    MetaData MediaMetaData
    SessionId String
    SessionContext String

    RebuildMediaTaskInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String
    StartTimeOffset Float
    EndTimeOffset Float
    Definition Integer
    RepairInfo RepairInfo
    VideoFrameInterpolationInfo VideoFrameInterpolationInfo
    SuperResolutionInfo SuperResolutionInfo
    HDRInfo HDRInfo
    VideoDenoiseInfo VideoDenoiseInfo
    AudioDenoiseInfo AudioDenoiseInfo
    ColorInfo ColorEnhanceInfo
    SharpInfo SharpEnhanceInfo
    FaceInfo FaceEnhanceInfo
    LowLightInfo LowLightEnhanceInfo
    ScratchRepairInfo ScratchRepairInfo
    ArtifactRepairInfo ArtifactRepairInfo
    TargetInfo RebuildMediaTargetInfo

    RebuildMediaTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileType String
    FileUrl String
    FileId String
    MediaName String
    ClassId Integer
    ExpireTime String

    RebuildMediaTemplate

    Used by actions: DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates.

    Name Type Description
    Definition Integer
    Type String
    Name String
    Comment String
    RebuildVideoInfo RebuildVideoInfo
    RebuildAudioInfo RebuildAudioInfo
    TargetVideoInfo RebuildMediaTargetVideoStream
    TargetAudioInfo RebuildMediaTargetAudioStream
    Container String
    RemoveVideo Integer
    RemoveAudio Integer
    CreateTime String
    UpdateTime String

    RebuildVideoInfo

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeEnhanceMediaTemplates, DescribeRebuildMediaTemplates, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate.

    Name Type Required Description
    RepairInfo RepairInfo No
    VideoFrameInterpolationInfo VideoFrameInterpolationInfo No
    SuperResolutionInfo SuperResolutionInfo No
    HDRInfo HDRInfo No
    VideoDenoiseInfo VideoDenoiseInfo No
    ColorInfo ColorEnhanceInfo No
    SharpInfo SharpEnhanceInfo No
    FaceInfo FaceEnhanceInfo No
    LowLightInfo LowLightEnhanceInfo No
    ScratchRepairInfo ScratchRepairInfo No
    ArtifactRepairInfo ArtifactRepairInfo No

    ReduceMediaBitrateAdaptiveDynamicStreamingResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String
    ErrCodeExt String
    Message String
    Input AdaptiveDynamicStreamingTaskInput
    Output AdaptiveDynamicStreamingInfoItem

    ReduceMediaBitrateMediaProcessTaskResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Type String
    TranscodeTask ReduceMediaBitrateTranscodeResult
    AdaptiveDynamicStreamingTask ReduceMediaBitrateAdaptiveDynamicStreamingResult

    ReduceMediaBitrateTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    FileId String
    FileName String
    FileUrl String
    MetaData MediaMetaData
    MediaProcessResultSet Array of ReduceMediaBitrateMediaProcessTaskResult
    TasksPriority Integer
    TasksNotifyMode String
    SessionContext String
    SessionId String

    ReduceMediaBitrateTranscodeResult

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Status String
    ErrCodeExt String
    Message String
    Input TranscodeTaskInput
    Output MediaTranscodeItem
    Progress Integer
    BeginProcessTime String
    FinishTime String

    Referer

    Referer blocklist/allowlist configuration, disabled by default

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Referrer blocklist/allowlist configuration switch. Value:
  • on: Enable;
  • off: Cache.
  • RefererRules Array of RefererRule No referer blocklist/allowlist rule configuration

    RefererAuthPolicy

    Used by actions: DescribeVodDomains, ModifyVodDomainConfig.

    Name Type Required Description
    Status String Yes
    AuthType String No
    Referers Array of String No
    BlankRefererAllowed String No

    RefererRule

    Referer blocklist/allowlist rule configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    RuleType String Yes Rule type:
  • all: take effect for all files;
  • file: The specified file suffix takes effect;
  • directory: The specified path takes effect;
  • path: The absolute path takes effect.
  • RulePaths Array of String Yes Matching content under the corresponding type of RuleType:
  • Fill with * when set to all;
  • For file, fill in the extension, such as jpg or txt;
  • For directory, fill in the path, such as /xxx/test/;
  • For path, fill in the absolute path, such as /xxx/test.html.
  • RefererType String Yes referer configuration type. Value:
  • whitelist: allowlist;
  • blacklist: blocklist.
  • Referers Array of String Yes referer list.
    AllowEmpty Boolean Yes Whether to allow empty referer:
    When the anti-hotlinking type is allowlist, true indicates that empty referer is allowed, and false indicates that empty referer is not allowed;
    If the anti-hotlinking type is blocklist, true indicates to deny empty referers, and false indicates not to deny empty referers.

    RemoveWaterMarkTaskInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String

    RemoveWaterMarkTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String
    FileType String
    FileUrl String
    MediaName String
    MetaData MediaMetaData

    RemoveWatermarkTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCodeExt String
    ErrCode Integer
    Message String
    Input RemoveWaterMarkTaskInput
    Output RemoveWaterMarkTaskOutput
    SessionId String
    SessionContext String

    RepairInfo

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes
    Type String No

    RequestHeader

    Custom request header configuration, disabled by default

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Custom request header configuration switch. Valid values:
  • on: Enable;
  • off: Cache.
  • HeaderRules Array of HttpHeaderPathRule No Custom request header rule configuration.

    ResolutionNameInfo

    Used by actions: CreateSuperPlayerConfig, DescribeSuperPlayerConfigs, ModifySuperPlayerConfig.

    Name Type Required Description
    MinEdgeLength Integer Yes
    Name String Yes

    ResourceTag

    Used by actions: CreateSubAppId, DescribeSubAppIds.

    Name Type Required Description
    TagKey String Yes
    TagValue String Yes

    ResponseHeader

    Custom response header configuration, disabled by default

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes Custom response header configuration switch. Valid values:
  • on: Enable;
  • off: Cache.
  • HeaderRules Array of HttpHeaderPathRule No Custom response header rule.

    RestoreMediaTask

    Used by actions: PullEvents.

    Name Type Description
    FileId String
    OriginalStorageClass String
    TargetStorageClass String
    RestoreTier String
    RestoreDay Integer

    ReviewAudioVideoSegmentItem

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StartTimeOffset Float
    EndTimeOffset Float
    Confidence Float
    Suggestion String
    Label String
    SubLabel String
    Form String
    AreaCoordSet Array of Integer
    Text String
    KeywordSet Array of String
    Url String
    PicUrlExpireTime String

    ReviewAudioVideoTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCodeExt String
    Message String
    Input ReviewAudioVideoTaskInput
    Output ReviewAudioVideoTaskOutput
    SessionId String
    SessionContext String

    ReviewAudioVideoTaskInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String
    Definition Integer
    ReviewContents Array of String

    ReviewAudioVideoTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Suggestion String
    Label String
    Form String
    SegmentSet Array of ReviewAudioVideoSegmentItem
    SegmentSetFileUrl String
    SegmentSetFileUrlExpireTime String
    CoverReviewResult ReviewImageResult

    ReviewImageResult

    Used by actions: DescribeTaskDetail, PullEvents, ReviewImage.

    Name Type Description
    Suggestion String
    Label String
    Form String
    SegmentSet Array of ReviewImageSegmentItem
    SegmentSetFileUrl String
    SegmentSetFileUrlExpireTime String

    ReviewImageSegmentItem

    Used by actions: ReviewImage.

    Name Type Description
    Confidence Float
    Suggestion String
    Label String
    SubLabel String
    Form String
    AreaCoordSet Array of Integer
    Text String
    KeywordSet Array of String

    ReviewInfo

    Used by actions: DescribeMediaInfos, SearchMedia.

    Name Type Description
    Definition Integer
    Suggestion String
    TypeSet Array of String
    ReviewTime String

    ReviewTemplate

    Used by actions: DescribeReviewTemplates.

    Name Type Description
    Definition Integer
    Name String
    Comment String
    Type String
    Labels Array of String
    CreateTime String
    UpdateTime String

    RoundPlayFilePlayInfo

    Used by actions: DescribeCurrentPlaylist.

    Name Type Description
    ItemId String
    FileId String
    StartPlayTime String
    Duration Float
    Progress Float

    RoundPlayInfo

    Used by actions: DescribeRoundPlays.

    Name Type Description
    RoundPlayId String
    StartTime String
    RoundPlaylist Array of RoundPlayListItemInfo
    Name String
    Desc String
    Status String
    PlayBackMode String
    Url String
    CreateTime String
    UpdateTime String
    ExpiredTime String

    RoundPlayListItemInfo

    Used by actions: CreateRoundPlay, DescribeRoundPlays, HandleCurrentPlaylist, ModifyRoundPlay.

    Name Type Required Description
    FileId String Yes
    AudioVideoType String Yes
    ItemId String No
    Definition Integer No

    RuleCache

    Path cache configuration.
    By default, the cache expiration time for all files is 30 days.

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    RuleType String Yes Rule type:
  • all: take effect for all files;
  • file: The specified file suffix takes effect;
  • directory: specify the path to take effect;
  • path: The absolute path takes effect.
  • RulePaths Array of String Yes Matching content under the corresponding type of RuleType:
  • Fill with * when set to all;
  • For file, fill in the extension, such as jpg or txt;
  • For directory, fill in the path, such as /xxx/test/;
  • For path, fill in the absolute path, such as /xxx/test.html.
  • CacheConfig RuleCacheConfig Yes Cache configuration.

    RuleCacheConfig

    Path cache configuration (select one of the three cache modes)

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Cache CacheConfigCache No Cache configuration.
    NoCache CacheConfigNoCache No No cache configuration.
    FollowOrigin CacheConfigFollowOrigin No Follow the origin server configuration.

    SDMCDrmKeyProviderInfo

    Used by actions: DescribeDrmKeyProviderInfo, SetDrmKeyProviderInfo.

    Name Type Required Description
    Uid String Yes
    SecretId String Yes
    SecretKey String Yes
    FairPlayCertificateUrl String Yes

    SPEKEDrm

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    ResourceId String Yes
    KeyServerUrl String Yes
    Vector String Yes
    EncryptionMethod String No
    EncryptionPreset String No
    KeyAcquireMode String No

    SampleSnapshotTaskInput

    Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes
    WatermarkSet Array of WatermarkInput No

    SampleSnapshotTemplate

    Used by actions: DescribeSampleSnapshotTemplates.

    Name Type Description
    Definition Integer
    Type String
    Name String
    Comment String
    Width Integer
    Height Integer
    ResolutionAdaptive String
    Format String
    SampleType String
    SampleInterval Integer
    CreateTime String
    UpdateTime String
    FillType String

    SceneAigcImageOutputConfig

    Used by actions: CreateSceneAigcImageTask, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    StorageMode String No
    MediaName String No
    ClassId Integer No
    ExpireTime String No
    AspectRatio String No
    EncodeConfig ImageSceneAigcEncodeConfig No
    ImageWidth Integer No
    ImageHeight Integer No
    Resolution String No

    SceneAigcImageTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    Progress Integer
    Input SceneAigcImageTaskInput
    Output SceneAigcImageTaskOutput
    SessionId String
    SessionContext String

    SceneAigcImageTaskInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    SceneInfo AigcImageSceneInfo
    FileInfos Array of SceneAigcImageTaskInputFileInfo
    OutputConfig SceneAigcImageOutputConfig

    SceneAigcImageTaskInputFileInfo

    Used by actions: CreateSceneAigcImageTask, DescribeTaskDetail, PullEvents.

    Name Type Required Description
    Type String No
    FileId String No
    Url String No

    SceneAigcImageTaskOutput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileInfos Array of SceneAigcImageTaskOutputFileInfo

    SceneAigcImageTaskOutputFileInfo

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    StorageMode String
    MediaName String
    ClassId Integer
    ExpireTime String
    FileType String
    FileUrl String
    FileId String
    MetaData MediaMetaData

    SceneAigcVideoOutputConfig

    Used by actions: CreateSceneAigcVideoTask, DescribeTaskDetail.

    Name Type Required Description
    StorageMode String No
    MediaName String No
    ClassId Integer No
    ExpireTime String No
    AspectRatio String No
    Duration Float No

    SceneAigcVideoTask

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    Progress Integer
    Input SceneAigcVideoTaskInput
    Output SceneAigcVideoTaskOutput
    SessionId String
    SessionContext String

    SceneAigcVideoTaskInput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    SceneInfo AigcVideoSceneInfo
    FileInfos Array of SceneAigcVideoTaskInputFileInfo
    OutputConfig SceneAigcVideoOutputConfig

    SceneAigcVideoTaskInputFileInfo

    Used by actions: CreateSceneAigcVideoTask, DescribeTaskDetail.

    Name Type Required Description
    Type String No
    FileId String No
    Url String No

    SceneAigcVideoTaskOutput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    FileInfos Array of SceneAigcImageTaskOutputFileInfo

    ScratchRepairInfo

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes
    Intensity Float No
    Type String No

    SegmentConfigureInfo

    Used by actions: CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates.

    Name Type Required Description
    Switch String Yes

    SegmentConfigureInfoForUpdate

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Switch String No

    SemanticsSearchResult

    Used by actions: SearchMediaBySemantics.

    Name Type Description
    FileId String
    Title String
    Score Float
    StartTimeOffset Float
    EndTimeOffset Float

    SharpEnhanceInfo

    Used by actions: CreateEnhanceMediaTemplate, CreateProcessImageAsyncTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyProcessImageAsyncTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes
    Intensity Float No

    SnapshotByTimeOffset2017

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    ErrCode Integer
    TimeOffset Integer
    Url String

    SnapshotByTimeOffsetTask2017

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    FileId String
    Definition Integer
    SnapshotInfoSet Array of SnapshotByTimeOffset2017

    SnapshotByTimeOffsetTaskInput

    Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes
    ExtTimeOffsetSet Array of String No
    TimeOffsetSet Array of Float No
    WatermarkSet Array of WatermarkInput No

    SnapshotByTimeOffsetTemplate

    Used by actions: DescribeSnapshotByTimeOffsetTemplates.

    Name Type Description
    Definition Integer
    Type String
    Name String
    Comment String
    Width Integer
    Height Integer
    ResolutionAdaptive String
    Format String
    CreateTime String
    UpdateTime String
    FillType String

    SortBy

    Used by actions: DescribeLLMComprehendTemplates, DescribeProcedureTemplates, DescribeTasks, SearchMedia.

    Name Type Required Description
    Field String Yes
    Order String Yes

    SpecificationDataItem

    Used by actions: DescribeMediaProcessUsageData.

    Name Type Description
    Specification String
    Data Array of TaskStatDataItem

    SplitMediaOutputConfig

    Used by actions: DescribeTaskDetail, PullEvents, SplitMedia.

    Name Type Required Description
    MediaName String No
    Type String No
    ClassId Integer No
    ExpireTime String No

    SplitMediaTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCodeExt String
    ErrCode Integer
    Message String
    FileInfoSet Array of SplitMediaTaskSegmentInfo
    SessionContext String
    SessionId String
    Progress Integer

    SplitMediaTaskConfig

    Used by actions: SplitMedia.

    Name Type Required Description
    StartTimeOffset Float No
    EndTimeOffset Float No
    ProcedureName String No
    OutputConfig SplitMediaOutputConfig No

    SplitMediaTaskInput

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String
    StartTimeOffset Float
    EndTimeOffset Float
    ProcedureName String
    OutputConfig SplitMediaOutputConfig

    SplitMediaTaskSegmentInfo

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Input SplitMediaTaskInput
    Output TaskOutputMediaInfo
    ProcedureTaskId String
    ReviewAudioVideoTaskId String

    StatDataItem

    Used by actions: DescribeCDNStatDetails, DescribeCDNUsageData, DescribeClientUploadAccelerationUsageData, DescribeReviewDetails, DescribeStorageDetails.

    Name Type Description
    Time String
    Value Integer

    StickerTrackItem

    Used by actions: ComposeMedia.

    Name Type Required Description
    SourceMedia String Yes
    Duration Float Yes
    StartTime Float No
    CoordinateOrigin String No
    XPos String No
    YPos String No
    Width String No
    Height String No
    ImageOperations Array of ImageTransform No

    StorageRegionInfo

    Used by actions: DescribeStorageRegions.

    Name Type Description
    Region String
    Description String
    Status String
    IsDefault Boolean
    Area String

    StorageStatData

    Used by actions: DescribeStorageData.

    Name Type Description
    Area String
    TotalStorage Integer
    InfrequentStorage Integer
    StandardStorage Integer
    ArchiveStorage Integer
    DeepArchiveStorage Integer

    SubAppIdInfo

    Used by actions: DescribeSubAppIds.

    Name Type Description
    SubAppId Integer
    SubAppIdName String
    Description String
    CreateTime String
    Status String
    Name String
    Mode String
    StorageRegions Array of String
    Tags Array of ResourceTag

    SubtitleFormatsOperation

    Used by actions: ModifyAIRecognitionTemplate.

    Name Type Required Description
    Type String Yes
    Formats Array of String Yes

    SubtitleInfoInput

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Id String Yes
    StreamIndex Integer No
    FontType String No
    FontSize String No
    FontColor String No
    FontAlpha Float No
    YPos String No
    BoardY String No
    BoardWidth String No
    BoardHeight String No
    BoardColor String No
    BoardAlpha Float No
    Alignment String No
    OutlineWidth String No
    OutlineColor String No
    OutlineAlpha Float No
    ShadowWidth String No
    ShadowColor String No
    ShadowAlpha Float No
    LineSpacing String No

    SuperResolutionInfo

    Used by actions: CreateEnhanceMediaTemplate, CreateProcessImageAsyncTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyProcessImageAsyncTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes
    Type String No
    Size Integer No

    SvgWatermarkInput

    Used by actions: CreateWatermarkTemplate, DescribeWatermarkTemplates.

    Name Type Required Description
    Width String No
    Height String No

    SvgWatermarkInputForUpdate

    Used by actions: ModifyWatermarkTemplate.

    Name Type Required Description
    Width String No
    Height String No

    TEHDConfig

    Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate.

    Name Type Required Description
    Type String Yes
    MaxVideoBitrate Integer No

    TEHDConfigForUpdate

    Used by actions: CreateProcedureTemplate, ModifyTranscodeTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Type String No
    MaxVideoBitrate Integer No

    TagConfigureInfo

    Used by actions: CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates.

    Name Type Required Description
    Switch String Yes

    TagConfigureInfoForUpdate

    Used by actions: ModifyAIAnalysisTemplate.

    Name Type Required Description
    Switch String No

    TaskOutputMediaInfo

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    FileId String
    MediaBasicInfo MediaBasicInfo

    TaskSimpleInfo

    Used by actions: DescribeTasks.

    Name Type Description
    TaskId String
    Status String
    FileId String
    TaskType String
    CreateTime String
    BeginProcessTime String
    FinishTime String
    SessionId String
    SessionContext String

    TaskStatData

    Used by actions: DescribeMediaProcessUsageData.

    Name Type Description
    TaskType String
    Summary Array of TaskStatDataItem
    Details Array of SpecificationDataItem

    TaskStatDataItem

    Used by actions: DescribeAigcUsageData, DescribeMediaProcessUsageData.

    Name Type Description
    Time String
    Count Integer
    Usage Integer

    TempCertificate

    Used by actions: ApplyUpload.

    Name Type Description
    SecretId String
    SecretKey String
    Token String
    ExpiredTime Integer

    TerrorismConfigureInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    ImgReviewInfo TerrorismImgReviewTemplateInfo No
    OcrReviewInfo TerrorismOcrReviewTemplateInfo No

    TerrorismConfigureInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    ImgReviewInfo TerrorismImgReviewTemplateInfoForUpdate No
    OcrReviewInfo TerrorismOcrReviewTemplateInfoForUpdate No

    TerrorismImgReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    LabelSet Array of String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    TerrorismImgReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    LabelSet Array of String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    TerrorismOcrReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    BlockConfidence Integer No
    ReviewConfidence Integer No

    TerrorismOcrReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    TextToSpeechAsyncInput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    VoiceId String
    Text String
    LanguageBoost String
    ExtParam String

    TextToSpeechAsyncOutput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    AudioUrl String
    VoiceId String
    ExtInfo String
    FileId String

    TextToSpeechAsyncOutputOption

    Used by actions: TextToSpeechAsync.

    Name Type Required Description
    Type String No

    TextToSpeechAsyncTask

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    ErrCodeExt String
    Input TextToSpeechAsyncInput
    Output TextToSpeechAsyncOutput
    SessionId String
    SessionContext String
    Progress Integer

    TextToSpeechSyncOutputOption

    Output parameter setting for synchronous text to speech.

    Used by actions: TextToSpeechSync.

    Name Type Required Description
    Type String No

    Output type of the synthesis result.

    Enumeration values:

    • hex: Audio base64 encoding,
    • url: Audio URL, valid for 24 hours.

    TextWatermarkTemplateInput

    Used by actions: CreateWatermarkTemplate, DescribeWatermarkTemplates.

    Name Type Required Description
    FontType String Yes
    FontSize String Yes
    FontColor String Yes
    FontAlpha Float Yes

    TextWatermarkTemplateInputForUpdate

    Used by actions: ModifyWatermarkTemplate.

    Name Type Required Description
    FontType String No
    FontSize String No
    FontColor String No
    FontAlpha Float No

    ThirdPartyDrmInfo

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    DrmTypes Array of String Yes
    SPEKEDrm SPEKEDrm No

    TimeRange

    Used by actions: DescribeRoundPlays, DescribeTasks, SearchMedia.

    Name Type Required Description
    After String No
    Before String No

    TraceWatermarkInput

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Switch String No

    TranscodePlayInfo2017

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    Url String
    Definition Integer
    Bitrate Integer
    Height Integer
    Width Integer

    TranscodeTask2017

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    ErrCode Integer
    Message String
    FileId String
    FileName String
    Duration Integer
    CoverUrl String
    PlayInfoSet Array of TranscodePlayInfo2017

    TranscodeTaskInput

    Used by actions: CreateProcedureTemplate, DescribeTaskDetail, ProcessMedia, PullEvents, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes
    WatermarkSet Array of WatermarkInput No
    TraceWatermark TraceWatermarkInput No
    CopyRightWatermark CopyRightWatermarkInput No
    BlindWatermark BlindWatermarkInput No
    MosaicSet Array of MosaicInput No
    HeadTailSet Array of HeadTailTaskInput No
    StartTimeOffset Float No
    EndTimeOffset Float No
    OverrideParameter OverrideTranscodeParameter No
    SubtitleInfoSet Array of SubtitleInfoInput No

    TranscodeTemplate

    Used by actions: DescribeTranscodeTemplates.

    Name Type Description
    Definition String
    Container String
    Name String
    Comment String
    Type String
    RemoveVideo Integer
    RemoveAudio Integer
    VideoTemplate VideoTemplateInfo
    AudioTemplate AudioTemplateInfo
    TEHDConfig TEHDConfig
    EnhanceConfig EnhanceConfig
    ContainerType String
    CreateTime String
    UpdateTime String
    SegmentType String
    StdExtInfo String

    TransitionOperation

    Used by actions: ComposeMedia.

    Name Type Required Description
    Type String Yes

    TrtcRecordInfo

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Description
    SdkAppId Integer
    RoomId String
    TaskId String
    UserIds Array of String

    UrlSignatureAuthPolicy

    Used by actions: DescribeVodDomains, ModifyVodDomainConfig.

    Name Type Required Description
    Status String Yes
    EncryptedKey String No

    UserAgentFilter

    UserAgent allowlist and blocklist configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    Switch String Yes UserAgent allowlist/blocklist configuration switch. Valid values:
  • on: Enable;
  • off: Cache.
  • FilterRules Array of UserAgentFilterRule No List of effective rules for the UserAgent blocklist and allowlist.

    UserAgentFilterRule

    UserAgent blocklist and allowlist rule configuration

    Used by actions: CreateCDNDomain, ModifyCDNDomainConfig.

    Name Type Required Description
    FilterType String Yes UA allowlist/blocklist type:
  • whitelist: allowlist;
  • blacklist: blocklist.
  • UserAgents Array of String Yes User agent list.
    RuleType String Yes Rule type:
  • all: take effect for all files;
  • file: The specified file suffix takes effect;
  • directory: specify the path to take effect;
  • path: The absolute path takes effect.
  • RulePaths Array of String Yes Matching content under the corresponding type of RuleType:
  • Fill with * when set to all;
  • For file, fill in the extension, such as jpg or txt;
  • For directory, fill in the path, such as /xxx/test/;
  • For path, fill in the absolute path, such as /xxx/test.html.
  • UserDefineAsrTextReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    LabelSet Array of String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    UserDefineAsrTextReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    LabelSet Array of String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    UserDefineConfigureInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    FaceReviewInfo UserDefineFaceReviewTemplateInfo No
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfo No
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfo No

    UserDefineConfigureInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    FaceReviewInfo UserDefineFaceReviewTemplateInfoForUpdate No
    AsrReviewInfo UserDefineAsrTextReviewTemplateInfoForUpdate No
    OcrReviewInfo UserDefineOcrTextReviewTemplateInfoForUpdate No

    UserDefineFaceReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    LabelSet Array of String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    UserDefineFaceReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    LabelSet Array of String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    UserDefineOcrTextReviewTemplateInfo

    Used by actions: CreateContentReviewTemplate, DescribeContentReviewTemplates.

    Name Type Required Description
    Switch String Yes
    LabelSet Array of String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    UserDefineOcrTextReviewTemplateInfoForUpdate

    Used by actions: ModifyContentReviewTemplate.

    Name Type Required Description
    Switch String No
    LabelSet Array of String No
    BlockConfidence Integer No
    ReviewConfidence Integer No

    VideoConfigureInfo

    Used by actions: CreateJustInTimeTranscodeTemplate, DescribeJustInTimeTranscodeTemplates.

    Name Type Required Description
    Width Integer No
    Height Integer No
    ResolutionAdaptive String No
    Bitrate Integer No

    VideoConfigureInfoForUpdate

    Used by actions: ModifyJustInTimeTranscodeTemplate.

    Name Type Required Description
    Width Integer No
    Height Integer No
    ResolutionAdaptive String No
    Bitrate Integer No

    VideoDenoiseInfo

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, CreateTranscodeTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, ModifyTranscodeTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes
    Type String No

    VideoDubbingAsyncInput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    InputUrl String
    InputFileId String
    SrcLanguage String
    DstLanguage String
    Model String

    VideoDubbingAsyncOutput

    Used by actions: DescribeTaskDetail.

    Name Type Description
    ResultUrl String
    FileId String

    VideoDubbingAsyncTask

    Used by actions: DescribeTaskDetail.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    ErrCodeExt String
    Input VideoDubbingAsyncInput
    Output VideoDubbingAsyncOutput
    SessionId String
    SessionContext String
    Progress Integer

    VideoEnhanceConfig

    Used by actions: CreateTranscodeTemplate, ModifyTranscodeTemplate.

    Name Type Required Description
    EnhanceScenarioType String No
    SuperResolution SuperResolutionInfo No
    Hdr HDRInfo No
    Denoise VideoDenoiseInfo No
    ImageQualityEnhance ImageQualityEnhanceInfo No
    ColorEnhance ColorEnhanceInfo No
    LowLightEnhance LowLightEnhanceInfo No
    ScratchRepair ScratchRepairInfo No
    ArtifactRepair ArtifactRepairInfo No
    DiffusionEnhance DiffusionEnhanceInfo No
    FrameRateWithDen FrameRateWithDenInfo No

    VideoFrameInterpolationInfo

    Used by actions: CreateEnhanceMediaTemplate, CreateRebuildMediaTemplate, DescribeTaskDetail, ModifyEnhanceMediaTemplate, ModifyRebuildMediaTemplate, PullEvents, RebuildMedia.

    Name Type Required Description
    Switch String Yes
    Fps Integer No

    VideoTemplateInfo

    Used by actions: CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate.

    Name Type Required Description
    Codec String Yes
    Fps Integer Yes
    Bitrate Integer Yes
    ResolutionAdaptive String No
    Width Integer No
    Height Integer No
    FillType String No
    Vcrf Integer No
    Gop Integer No
    GopUnit String No
    PreserveHDRSwitch String No
    CodecTag String No
    Mode String No
    Bframes Integer No
    HlsTime Integer No
    VideoProfile String No

    VideoTemplateInfoForUpdate

    Used by actions: CreateProcedureTemplate, ModifyTranscodeTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Codec String No
    Fps Integer No
    Bitrate Integer No
    ResolutionAdaptive String No
    Width Integer No
    Height Integer No
    FillType String No
    Vcrf Integer No
    Gop Integer No
    PreserveHDRSwitch String No
    CodecTag String No
    GopUnit String No
    Mode String No
    Bframes Integer No
    HlsTime Integer No
    VideoProfile String No

    VideoTrackItem

    Used by actions: ComposeMedia.

    Name Type Required Description
    SourceMedia String Yes
    SourceMediaStartTime Float No
    Duration Float No
    TargetDuration Float No
    CoordinateOrigin String No
    XPos String No
    YPos String No
    Width String No
    Height String No
    AudioOperations Array of AudioTransform No
    ImageOperations Array of ImageTransform No

    VoiceConfigureInfo

    Used by actions: CreateQualityInspectTemplate, DescribeQualityInspectTemplates.

    Name Type Required Description
    Switch String Yes

    VoiceConfigureInfoForUpdate

    Used by actions: ModifyQualityInspectTemplate.

    Name Type Required Description
    Switch String No

    VoiceInfo

    Used by actions: DescribeVoices, UpdateVoice.

    Name Type Required Description
    VoiceId String No
    Name String No
    Description String No
    Category String No
    Gender String No
    Age String No
    Languages Array of String No
    AudioUrl String No
    Labels Array of String No
    Scenes Array of String No

    VoiceSettings

    Used by actions: DescribeTaskDetail, DesignVoiceAsync.

    Name Type Required Description
    Name String No
    Description String No
    Gender String No
    Age String No
    Languages Array of String No
    Labels Array of String No
    Scenes Array of String No

    VoiceUpdateFields

    Used by actions: UpdateVoice.

    Name Type Required Description
    Name String No
    Description String No
    Gender String No
    Age String No
    Languages Array of String No
    Labels Array of String No
    Scenes Array of String No
    AudioUrl String No

    WatermarkConfigureData

    Used by actions: DescribeJustInTimeTranscodeTemplates.

    Name Type Description
    Switch String
    Url String
    Width String
    Height String
    XPos String
    YPos String

    WatermarkConfigureInfo

    Used by actions: CreateJustInTimeTranscodeTemplate.

    Name Type Required Description
    Switch String Yes
    ImageContent String No
    Width String No
    Height String No
    XPos String No
    YPos String No

    WatermarkConfigureInfoForUpdate

    Used by actions: ModifyJustInTimeTranscodeTemplate.

    Name Type Required Description
    Switch String No
    ImageContent String No
    Width String No
    Height String No
    XPos String No
    YPos String No

    WatermarkInput

    Used by actions: CreateProcedureTemplate, ProcessMedia, ResetProcedureTemplate.

    Name Type Required Description
    Definition Integer Yes
    TextContent String No
    SvgContent String No
    StartTimeOffset Float No
    EndTimeOffset Float No

    WatermarkTemplate

    Used by actions: DescribeWatermarkTemplates.

    Name Type Description
    Definition Integer
    Type String
    Name String
    Comment String
    XPos String
    YPos String
    ImageTemplate ImageWatermarkTemplate
    TextTemplate TextWatermarkTemplateInput
    SvgTemplate SvgWatermarkInput
    CreateTime String
    UpdateTime String
    CoordinateOrigin String

    WebPageRecordInfo

    Used by actions: DescribeMediaInfos, DescribeTaskDetail, PullEvents, SearchMedia.

    Name Type Required Description
    RecordUrl String No
    RecordTaskId String No

    WechatMiniProgramPublishTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    FileId String
    SourceDefinition Integer
    PublishResult String

    WechatMiniProgramPublishTaskInput

    Used by actions: DescribeProcedureTemplates.

    Name Type Required Description
    SourceDefinition Integer Yes

    WechatPublishTask

    Used by actions: DescribeTaskDetail, PullEvents.

    Name Type Description
    TaskId String
    Status String
    ErrCode Integer
    Message String
    FileId String
    Definition Integer
    SourceDefinition Integer
    WechatStatus String
    WechatVid String
    WechatUrl String

    도움말 및 지원

    문제 해결에 도움이 되었나요?

    피드백