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

文档中心

立即注册

导航

ListRecordPlans - 录像计划列表

最近更新时间：2025.06.06 14:20:33首次发布时间：2023.06.27 11:40:49

查询录像计划列表。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListRecordPlans&Version=2021-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListRecordPlans	要执行的操作，取值：ListRecordPlans。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
FilterName	String	是	plan name	名称过滤

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
List	Array of Object		查询到的录像计划列表信息。

请求示例

GET /?Action=ListRecordPlans&Version=2021-01-01&FilterName=UwqpM HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20241219T074805Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241219/cn-beijing/aiotvideo/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202412191548090130592171293BE9B8",
    "Action": "ListRecordPlans",
    "Version": "2021-01-01",
    "Service": "aiotvideo",
    "Region": "cn-beijing"
  },
  "Result": {
    "List": [
      {
        "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
      }
    ]
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。