Querying the Duration of Transcoded Outputs
Function
Queries the transcoded output duration per hour.
The maximum query time span is 31 days. You can query data over the past one year.
Data about the transcoded output duration is delayed for one hour.
Constraints
Only the data of domain names added to the new Live console in regions excluding CN North-Beijing1 can be queried. This restriction applies only to the HUAWEI CLOUD Chinese Mainland website.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/stats/transcode
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
publish_domain |
No |
String |
Ingest domain name. |
stream |
No |
String |
Stream name. |
start_time |
No |
String |
Start time. The format must comply with the ISO 8601 standard (UTC time) and is YYYY-MM-DDThh:mm:ssZ. The value will be rounded to the nearest hour. For example, if this parameter is set to 2020-08-18T07:20:40Z, the actual query start time will be 2020-08-18T07:00:00Z. If this parameter is left empty, data over the past 24 hours is queried by default. |
end_time |
No |
String |
End time. The format must comply with the ISO 8601 standard (UTC time) and is YYYY-MM-DDThh:mm:ssZ. The value will be rounded to the nearest hour. For example, if this parameter is set to 2020-08-18T08:20:40Z, the actual query start time will be 2020-08-18T08:00:00Z. If this parameter is not specified, the current time is used by default. The end time must be later than the start time.
NOTE:
If the expenditures of a pay-per-use resource are charged by hour or day, the resource usage for the final settlement period of one month is deducted on the first day of the next month and settled in the next month. Example: The expenditures of pay-per-use resources are charged by hour. The transcoding usage from 2021/11/30 23:00:00 to 2021/12/01 00:00:00 started to be reported to the billing system at 2021/12/01 00:00:00. The billing system deducted the fee at 2021/12/01 00:36:00. The usage duration was from 2021/11/30 23:00:00 to 2021/12/01 00:00:00, and the transaction time was 2021/12/01 00:00. Therefore, the corresponding expenditures were included in the bill for the billing cycle of December 2021. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Authorization |
No |
String |
Authentication information. This parameter is mandatory when AK/SK-based authentication is used. |
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used. |
X-Project-Id |
No |
String |
Project ID, which is the same as that used in the URI. This parameter is mandatory when AK/SK-based authentication is used. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-Request-Id |
String |
Unique ID of the request. |
Parameter |
Type |
Description |
---|---|---|
transcode_data_list |
Array of TranscodeData objects |
Sampled data list. |
summary_list |
Array of TranscodeSummary objects |
Total duration of all transcoded outputs in a specified time range |
Parameter |
Type |
Description |
---|---|---|
spec_list |
Array of TranscodeSpec objects |
Transcoding duration in each sampling period |
time |
String |
Sampling time. The format must comply with the ISO 8601 standard (UTC time). The format is YYYY-MM-DDThh:mm:ssZ. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Output specifications. The format is codec_resolution (low-bitrate HD disabled) or codecPVCresolution (low-bitrate HD enabled). The codec format can be H.264 or H.265. The resolution can be 4K (3840 x 2160) and lower, 2K (2560 x 1440) and lower, FHD (1920 x 1080) and lower, HD (1280 x 720) and lower, or SD (640 x 480) and lower. |
value |
Double |
Duration of transcoded outputs collected at each sampling time, in minutes. A maximum of two decimal places are allowed. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Output specifications. The format is codec_resolution (low-bitrate HD disabled) or codecPVCresolution (low-bitrate HD enabled). The codec format can be H.264 or H.265. The resolution can be 4K (3840 x 2160) and lower, 2K (2560 x 1440) and lower, FHD (1920 x 1080) and lower, HD (1280 x 720) and lower, or SD (640 x 480) and lower. |
value |
Double |
Output specifications. The format is codec_resolution (low bitrate HD disabled) or codec_PVC_resolution (low bitrate HD enabled). Codecs include H.264 and H.265. Resolution levels include: 4K (3840 x 2160) or lower, 2K (2560 x 1440) or lower, FHD (1920 x 1080) or lower, HD (1280 x 720) or lower, and SD (640 x 480) or lower. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-Request-Id |
String |
Unique ID of the request. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
Example Requests
Queries the transcoding usage of an ingest domain name.
GET /v2/{project_id}/stats/transcode?publish_domain=livepull-test.huaweicloud.com&start_time=2020-08-18T07:00:00Z&end_time=2020-08-18T08:00:00Z
Example Responses
Status code: 200
This code is returned if the request succeeds.
{ "transcode_data_list" : [ { "time" : "2020-08-18T07:00:00Z", "spec_list" : [ { "type" : "H265_PVC_SD", "value" : 256.23 }, { "type" : "H265_PVC_HD", "value" : 128.41 } ] }, { "time" : "2020-08-18T08:00:00Z", "spec_list" : [ { "type" : "H265_PVC_SD", "value" : 52.35 }, { "type" : "H265_PVC_HD", "value" : 136.32 } ] } ], "summary_list" : [ { "type" : "H265_PVC_SD", "value" : 308.58 }, { "type" : "H265_PVC_HD", "value" : 264.73 } ] }
Status code: 400
Incorrect parameter.
{ "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: publish_domain" }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.live.v2.region.LiveRegion; import com.huaweicloud.sdk.live.v2.*; import com.huaweicloud.sdk.live.v2.model.*; public class ListTranscodeDataSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); LiveClient client = LiveClient.newBuilder() .withCredential(auth) .withRegion(LiveRegion.valueOf("<YOUR REGION>")) .build(); ListTranscodeDataRequest request = new ListTranscodeDataRequest(); try { ListTranscodeDataResponse response = client.listTranscodeData(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklive.v2.region.live_region import LiveRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklive.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = LiveClient.new_builder() \ .with_credentials(credentials) \ .with_region(LiveRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListTranscodeDataRequest() response = client.list_transcode_data(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := live.NewLiveClient( live.LiveClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListTranscodeDataRequest{} response, err := client.ListTranscodeData(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
This code is returned if the request succeeds. |
400 |
Incorrect parameter. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot