使用DescribeLiveStreamTranscodeMetricData按流粒度查询转码指标数据-视频直播-阿里云

查询指定域名app及流粒度转码数据。

接口说明

最大查询跨度：24 小时。
最小查询粒度：5 分钟。
最大查询范围：最近 31 天的数据。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeLiveStreamTranscodeMetricData

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-shanghai
DomainName	string	是	域名名称。仅支持单个域名查询。	example.com
StartTime	string	是	开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2023-06-11T02:46:40Z
EndTime	string	是	结束时间。需晚于开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2023-06-11T03:46:40Z
AppName	string	否	应用名称。	app
StreamName	string	否	流的名称。	stream
NextPageToken	string	否	分页查询 token，每次查询最多返回 5000 行数据，当要查询的数据超过 5000 行时，响应数据会提供下次查询数据的起始索引。请求时传入该 token，将从上一次查询结束的下一行继续查询未获取的数据。	UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

返回参数

名称	类型	描述	示例值
	object	返回参数。
DomainName	string	域名名称。	example.com
EndTime	string	结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2023-06-11T02:46:40Z
NextPageToken	string	分页查询 token，每次查询最多返回 5000 行数据，当要查询的数据超过 5000 行时，响应数据会提供下次查询数据的起始索引。请求时传入该 token，将从上一次查询结束的下一行继续查询未获取的数据。	UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=
PageSize	integer	返回数据行数。	5000
RequestId	string	请求 ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
StartTime	string	起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2023-06-11T03:46:40Z
StreamDetailData	object
StreamData	array<object>	返回数据组。
	object	流数据。
AppName	string	应用名称。	app
Duration	integer	时长。单位：秒。	300
Fps	string	帧率。枚举值： normal : normal high : high def : def	high
Region	string	地区。	cn-shanghai
Resolution	string	分辨率。取值： 2K：2K。 4K：4K。 LD：流畅。 SD：标清。 HD：高清。 def：音频。枚举值： SD : SD def : def 4K : 4K LD : LD 2K : 2K HD : HD	4K
StreamName	string	流名称。	stream
TimeStamp	string	时间片起始时刻。	2023-06-11T02:45:00Z
TranscodeType	string	转码类型。取值： H264STD：H.264 普通转码。 H264NBHD：H.264 窄带高清转码。 H265STD：H.265 普通转码。 AUDIO：音频转码。枚举值： H264NBHD : H264NBHD AUDIO : AUDIO H264STD : H264STD H265STD : H265STD	H264STD

示例

正常返回示例

JSON格式

{
  "DomainName": "example.com",
  "EndTime": "2023-06-11T02:46:40Z",
  "NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
  "PageSize": 5000,
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "StartTime": "2023-06-11T03:46:40Z\n",
  "StreamDetailData": {
    "StreamData": [
      {
        "AppName": "app",
        "Duration": 300,
        "Fps": "high",
        "Region": "cn-shanghai",
        "Resolution": "4K",
        "StreamName": "stream",
        "TimeStamp": "2023-06-11T02:45:00Z",
        "TranscodeType": "H264STD"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	结束时间与开始时间不匹配，请您确认时间的匹配度。
400	InvalidTimeSpan	The time span exceeds the limit.	时间跨度超过限制，请参照接口文档，配置合理查询跨度。
400	InvalidPageToken	The token of page is invalid.	指定的分页token错误，请传入上次查询返回的正确索引，并确认没有修改您的请求参数。
400	InvalidAppName.Mismatch	The AppName param must be passed.	AppName参数不匹配，请确认传入了正确的AppName参数。
400	InvalidStreamProtocol.NotSupport	The specified stream protocol is not support.	指定的流协议不支持，请参照文档查询所需的流协议。
400	InvalidStreamName.LengthTooLong	The specified stream name is too long.	StreamName的长度超过限制，请传入合法的StreamName。
400	InvalidAppName.LengthTooLong	The specified app name is too long.	AppName的长度超过限制，请传入合法的AppName。
400	InvalidTime.ValueNotSupported	Specified Time is malformed.	指定的时间无效。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。