All Products
Search
Document Center

Intelligent Media Services:ListSystemTemplates

Last Updated:Dec 16, 2024

Queries a list of system templates.

Operation description

Template types:

  1. 1: transcoding template.
  2. 2: snapshot template.
  3. 3: animated image template.
  4. 4. image watermark template.
  5. 5: text watermark template.
  6. 6: subtitle template.
  7. 7: AI-assisted content moderation template.
  8. 8: AI-assisted intelligent thumbnail template.
  9. 9: AI-assisted intelligent erasure template.

Subtypes of transcoding templates:

  1. 1 (Normal): regular template.
  2. 2 (AudioTranscode): audio transcoding template.
  3. 3 (Remux): container format conversion template.
  4. 4 (NarrowBandV1): Narrowband HD 1.0 template.
  5. 5 (NarrowBandV2): Narrowband HD 2.0 template.

Subtypes of snapshot templates:

  1. 1 (Normal): regular template.
  2. 2 (Sprite): sprite template.
  3. 3 (WebVtt): WebVTT template.

Subtypes of AI-assisted content moderation templates:

  1. 1 (Video): video moderation template.
  2. 2 (Audio): audio moderation template.
  3. 3 (Image): image moderation template.

Subtypes of AI-assisted intelligent erasure templates:

  1. 1 (VideoDelogo): logo erasure template.
  2. 2 (VideoDetext): subtitle erasure template.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ice:ListSystemTemplates
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TypestringYes

The template type. Separate multiple types with commas (,).

1,2
SubtypestringNo

The subtype ID of the template.

1
NamestringNo

The template name.

SampleTemplate
TemplateIdstringNo

The template ID.

****96e8864746a0b6f3****
StatusstringNo

The template state. Valid values: Normal, Invisible, and All.

Normal
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page. Default value: 20 Valid values: 1 to 100.

20

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

******11-DB8D-4A9A-875B-275798******
Totalinteger

The total number of templates.

20
SystemTemplateListarray<object>

The queried templates.

SystemTemplateobject

The information about the system template.

TemplateIdstring

The template ID.

S00000001-000000
TemplateNamestring

The template name.

FLV-COPY
Typeinteger

The type ID of the template.

1
TypeNamestring

The type name of the template.

TranscodeTemplate
Subtypeinteger

The subtype ID of the template.

1
SubtypeNamestring

The subtype name of the template.

Remux
Statusstring

The template state.

Normal
TemplateConfigstring

The template parameters.

{"Container":{"Format":"flv"},"Video":{},"Audio":{}}

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Total": 20,
  "SystemTemplateList": [
    {
      "TemplateId": "S00000001-000000",
      "TemplateName": "FLV-COPY",
      "Type": 1,
      "TypeName": "TranscodeTemplate",
      "Subtype": 1,
      "SubtypeName": "Remux",
      "Status": "Normal",
      "TemplateConfig": "{\"Container\":{\"Format\":\"flv\"},\"Video\":{},\"Audio\":{}}"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2022-07-15Add OperationView Change Details
2022-07-11Add OperationView Change Details