製品概要
サブ製品の説明
基本概念
製品機能
ユースケース
製品の優位性
使用制限
Domain name for API request: live.intl.tencentcloudapi.com.
This API is used to create a screencapturing task that has a specific start and end time and takes screenshots according to the template configured.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: CreateScreenshotTask. |
| Version | Yes | String | Common Params. The value used for this API: 2018-08-01. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| StreamName | Yes | String | The stream name. |
| DomainName | Yes | String | The push domain. |
| AppName | Yes | String | The push path. |
| EndTime | Yes | Integer | The task end time, which must be a Unix timestamp and later than StartTime and the current time. The end time and start time cannot be more than 24 hours apart. |
| TemplateId | Yes | Integer | The ID of the screencapturing template, which is returned by CreateLiveSnapshotTemplate. If an incorrect template ID is passed in, the screencapturing task will fail. |
| StartTime | No | Integer | The task start time, which must be a Unix timestamp and cannot be later than six days from the current time. If you do not specify this parameter, the task will start immediately. |
| StreamType | No | Integer | The publishing type. Valid values:0 (default): Live stream1: Mixed stream |
| Extension | No | String | An extension field, which is not defined currently and is empty by default. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | A unique task ID. If this parameter is returned, the screencapturing task is created successfully. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://live.intl.tencentcloudapi.com/?Action=CreateScreenshotTask
&AppName=live
&DomainName=5000.live.push.com
&StreamName=livetest
&StartTime=1589889600
&EndTime=1589904000
&TemplateId=0
&<Common request parameters>{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397",
"TaskId": "UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InternalError.GetConfigError | Error getting the configuration. |
| InternalError.NetworkError | Internal network error. |
| InvalidParameter | Invalid parameter. |
| LimitExceeded.MaximumRunningTask | The current number of concurrent tasks exceeds the limit. |
| ResourceNotFound.ForbidService | You are blocked. |
| ResourceNotFound.FreezeService | Service suspended. |
| ResourceNotFound.StopService | The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first. |
| ResourceNotFound.UserDisableService | You disabled the service. |
| UnsupportedOperation | Unsupported operation. |
フィードバック