更新时间:2024-07-25 GMT+08:00
分享

查询转码用量接口

功能介绍

查询直播域名每小时的转码时长数据。

最大查询跨度31天,最大查询周期1年。

转码用量的数据是延时1小时。

接口约束

该接口暂只支持查询部署在新版视频直播服务上的域名的相关数据(不包含“华北-北京一”)。此约束条件仅适用于中国站。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/stats/transcode

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

publish_domain

String

推流域名。

stream

String

流名。

start_time

String

起始时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。非整点时间按小时取整,若start_time为2020-08-18T07:20:40Z,则实际查询起始时间为2020-08-18T07:00:00Z。若start_time为空,则默认查询最近24小时数据。

end_time

String

结束时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

非整点时间按小时取整,若end_time为2020-08-18T08:20:40Z,则实际查询起始时间为2020-08-18T08:00:00Z。

若参数为空,默认为当前时间。结束时间需大于起始时间。

说明:

当按需产品按小时或按天进行结算费用时,当月最后一个结算周期的用量会在次月1号完成扣费,因此账单费用归属到次月。

按小时结算的按需资源示例:

2021/11/30 23:00:00-2021/12/01 00:00:00的转码用量在2021/12/01 00:00:00开始上报用量给计费系统,

计费系统在2021/12/01 00:36:00完成扣费处理。

这条用量对应的账单消费时间是2021/11/30 23:00:00-2021/12/01 00:00:00,交易时间是2021/12/0:00,因此账期归属在2021年12月。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求的唯一标识。

表5 响应Body参数

参数

参数类型

描述

transcode_data_list

Array of TranscodeData objects

采样数据列表。

summary_list

Array of TranscodeSummary objects

指定时间区间内各转码规格转码时长总和。

表6 TranscodeData

参数

参数类型

描述

spec_list

Array of TranscodeSpec objects

每个采样时间中的转码时长信息。

time

String

采样时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ 。

表7 TranscodeSpec

参数

参数类型

描述

type

String

转码规格,格式是“编码格式_分辨率档位”(未开启高清低码)和“编码格式_PVC_分辨率档位”(开启高清低码)。其中编码格式包括H264、H265,分辨率档位包括:4K(3840 x 2160)及以下,2K(2560 x 1440)及以下,FHD(1920 x 1080)及以下,HD(1280 x 720)及以下,SD(640 x 480)及以下。

value

Double

采样时间点转码时长,单位为分钟,保留两位小数。

表8 TranscodeSummary

参数

参数类型

描述

type

String

转码规格,格式是“编码格式_分辨率档位”(未开启高清低码)和“编码格式_PVC_分辨率档位”(开启高清低码)。其中编码格式包括H264、H265,分辨率档位包括:4K(3840 x 2160)及以下,2K(2560 x 1440)及以下,FHD(1920 x 1080)及以下,HD(1280 x 720)及以下,SD(640 x 480)及以下。

value

Double

总转码时长,单位为分钟,保留两位小数。

状态码: 400

表9 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求的唯一标识。

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询推流域名转码用量

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

响应示例

状态码: 200

处理成功返回。

{
  "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
  } ]
}

状态码: 400

参数错误。

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Invalid request parameter: publish_domain"
}

SDK代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

处理成功返回。

400

参数错误。

错误码

请参见错误码

相关文档