All Products
Search
Document Center

ApsaraVideo VOD:GetAITemplate

Last Updated:Mar 27, 2024

Queries the details of an AI template.

Operation description

  • Regions that support this operation: China (Beijing), China (Shanghai), and Singapore.
  • Before you call this operation to query details of an AI template, you must obtain the ID of the AI template.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
vod:GetAITemplateRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TemplateIdstringYes

The ID of the AI template. You can use one of the following methods to obtain the ID:

  • Call the AddAITemplate operation to add an AI template if no AI template exists. The value of TemplateId in the response is the ID of the AI template.
  • Call the ListAITemplate operation if the template already exists. The value of TemplateId in the response is the ID of the AI template.
1706a0063dd733f6a823ef32e0a5****

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The ID of the request.

080DA371-8AC0-4CD4-4476-33E64282****
TemplateInfoobject

The information about the AI template.

CreationTimestring

The time when the AI template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2020-07-08T06:50:45Z
IsDefaultstring

Indicates whether the template is the default AI template. Valid values:

  • Default
  • NotDefault
NotDefault
TemplateTypestring

The type of the AI template. Valid values:

  • AIMediaAudit: automated review
  • AIImage: smart thumbnail
AIMediaAudit
TemplateConfigstring

The detailed configurations of the AI template. The value is a JSON string. For more information, see AITemplateConfig .

{"AuditRange":["text-title","video"],"AuditContent":["screen"],"AuditItem":["terrorism","porn"],"AuditAutoBlock":"yes"}
TemplateNamestring

The name of the AI template.

DemoAITemplate
Sourcestring

The source of the AI template. Valid values:

  • System
  • Custom
Custom
TemplateIdstring

The ID of the AI template.

1706a0063dd733f6a823ef32e0a5****
ModifyTimestring

The time when the AI template was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2020-07-08T06:58:45Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "080DA371-8AC0-4CD4-4476-33E64282****",
  "TemplateInfo": {
    "CreationTime": "2020-07-08T06:50:45Z",
    "IsDefault": "NotDefault",
    "TemplateType": "AIMediaAudit",
    "TemplateConfig": "{\"AuditRange\":[\"text-title\",\"video\"],\"AuditContent\":[\"screen\"],\"AuditItem\":[\"terrorism\",\"porn\"],\"AuditAutoBlock\":\"yes\"}",
    "TemplateName": "DemoAITemplate",
    "Source": "Custom",
    "TemplateId": "1706a0063dd733f6a823ef32e0a5****",
    "ModifyTime": "2020-07-08T06:58:45Z"
  }
}

Error codes

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