You need to enable JavaScript to run this app.
导航
慢直播
  • 文档首页
    • /
  • 慢直播

查询录像计划

最近更新时间：2023.06.27 11:40:49

首次发布时间：2023.06.27 11:40:49

我的收藏

根据录像计划 ID，查询录像计划的详细信息。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段
位置
类型
必填
说明
值
ActionQueryString是公共参数，OpenAPI 接口名称GetRecordPlan
VersionQueryString是公共参数，OpenAPI 接口版本2021-01-01
PlanIDQueryString是需要查询的录像计划 ID

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段
类型
说明
PlanIDString录像计划唯一 ID
PlanNameString录像计划名称
BindTemplateString绑定的录像模板 ID
TemplateInfoObject录像模板信息，参考以下 TemplateInfo 结构说明
DescriptionString录像计划描述

Status

String

录像计划状态：

  • enabled（启用）

  • disabled（禁用）

CreatedAtInteger录像计划创建时间，Unix 秒级时间戳
UpdatedAtInteger录像计划更新时间，Unix 秒级时间戳
BindStreamNumInteger录像计划绑定的视频流数量

TemplateInfo 结构说明

字段
类型
说明
TTLObject录像文件存储周期，参考以下 TTL 结构说明
FormatString模板转封装格式，默认：hls

TTL 结构说明

字段
类型
说明
DaysInteger录像文件标准存储时长（天）
TransConfigArray of Objects录像文件在对象存储中的生命周期配置，参考以下 TransConfig 结构说明

TransConfig 结构说明

字段
类型
说明

StorageClass

在对象存储中保存录像文件的类型，可选项：

  • STANDARD（标准存储）

  • IA（低频存储）

  • ARCHIVE_FR（归档闪回存储）

  • COLD_ARCHIVE（冷归档存储）

详细说明，参考 生命周期规则

DaysInteger与指定的存储类型对应的存储时长（天）

示例

请求示例

GET https://open.volcengineapi.com?Action=GetRecordPlan
&Version=2021-01-01
&PlanID=plan0xxxx
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202209141449260102020891370D037571",
        "Action": "GetStreamRecord",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        {
            "PlanID": "plan0xxxx",
            "PlanName": "全天计划",
            "BindTemplate": "plan01",
            "TemplateInfo": {
                "TTL": {
                    "Days": 7,
                    "TransConfig": [
                        {
                            "StorageClass": "COLD_ARCHIVE",
                            "Days": 10
                        }
                    ]
                }
                "Format": "hls"
            }
            "Description": "全天录制",
            "Status": "enabled",
            "CreatedAt": 1687663000,
            "UpdatedAt": 1687693000,
            "BindStreamNum": 2
        }
    }
}