Contents:
## 1. API Description
API request domain name: live.tencentcloudapi.com.
This API gets the screencapture template list.
Default API request rate limit: 500 requests/second.
2. Request Parameters
The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.
Parameter name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common parameter; the name of this API: DescribeLiveSnapshotTemplates |
Version | Yes | String | Common parameter; the version of this API: 2018-08-01 |
Region | No | String | Common parameter; optional for this API |
3. Return Parameters
Parameter name | Type | Description |
---|---|---|
Templates | Array of SnapshotTemplateInfo | Screencapture template list. |
RequestId | String | The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues. |
4. Sample
Request Sample
Input Sample Code
https://live.tencentcloudapi.com/?Action=DescribeLiveSnapshotTemplates
&<Common request parameter>
Output Sample Code
{
"Response": {
"Templates": [{
"TemplateId":1000,
"TemplateName":"testName",
"Description":"test",
"SnapshotInterval":10,
"Width":250,
"Height":250,
"PornFlag":0,
"CosAppId":123,
"CosBucket":"bucket",
"CosRegion":"beijing",
"CosVersion":"1.0"
}],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
5. Developer Resources
API Explorer
API Explorer is a tool that provides ease of use in requesting APIs, authenticating identities, generating SDK and exploring APIs in Tencent Cloud environment.
SDK
Cloud API 3.0 comes with a set of complementary development toolkits (SDKs) that support multiple programming languages and make it easier to call the API.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
TCCLI
6. Error Codes
The following error codes are API business logic-related. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error |
InternalError.ArgsNotMatch | For the API that is used for adding transcoding template |
InternalError.ConfInUsed | The template is in use. |
InternalError.ConfNotFound | The template does not exist. |
InternalError.ConfOutLimit | The number of templates exceeds the display. |
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 | Parameter error |
InvalidParameterValue | Incorrect parameter value |
MissingParameter | Missing parameter |