ModifyLiveSnapshotTemplate

Last updated: 2020-08-20 18:02:10

1. API Description

Domain name for API request: live.tencentcloudapi.com.

This API is used to modify the screencapturing template configuration.

A maximum of 200 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ModifyLiveSnapshotTemplate.
Version Yes String Common parameter. The value used for this API: 2018-08-01.
Region No String Common parameter. This parameter is not required for this API.
TemplateId Yes Integer Template ID.
TemplateName No String Template name.
Maximum length: 255 bytes.
Description No String Description.
Maximum length: 1,024 bytes.
SnapshotInterval No Integer Screencapturing interval in seconds. Default value: 10s.
Value range: 5-300s.
Width No Integer Screenshot width. Default value: 0 (original width).
Height No Integer Screenshot height. Default value: 0 (original height).
PornFlag No Integer Whether to enable porn detection. Default value: 0.
0: do not enable.
1: enable.
CosAppId No Integer COS application ID.
CosBucket No String COS bucket name.
Note: the value of CosBucket cannot contain -[appid].
CosRegion No String COS region.
CosPrefix No String COS bucket folder prefix.
CosFileName No String COS filename.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

https://live.tencentcloudapi.com/?Action=ModifyLiveSnapshotTemplate
&TemplateId=1000
&TemplateName=testName
&Description=testDesc
&SnapshotInterval=10
&Width=250
&Height=250
&PornFlag=0
&CosAppId=123
&CosBucket=bucket
&CosRegion=beijing
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.NotFound No records found.
InternalError Internal error.
InternalError.ArgsNotMatch For the transcoding template adding API.
InternalError.ConfInUsed The template is in use.
InternalError.ConfNotFound The template does not exist.
InternalError.ConfOutLimit The number of templates exceeds the limit.
InternalError.InvalidInput Parameter check failed.
InternalError.NotFound The record does not exist.
InternalError.RuleAlreadyExist The rule has already been configured.
InternalError.RuleInUsing The rule is in use.
InternalError.RuleNotFound The rule does not exist.
InternalError.RuleOutLimit The rule exceeds the limit.
InvalidParameter Invalid parameter.
InvalidParameterValue Wrong parameter value.
MissingParameter Missing parameter.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help