录像计划列表--慢直播-火山引擎

文档中心

立即注册

导航

录像计划列表

最近更新时间：2023.06.27 12:09:59首次发布时间：2023.06.27 11:40:49

查询录像计划列表。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListRecordPlans
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
List	Array of Objects	查询到的录像计划列表信息，详细信息，参考 GetRecordPlan 接口的返回参数说明

示例

请求示例

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

返回示例

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