GetRecordPlan - 查询录像计划--慢直播-火山引擎

文档中心

立即注册

导航

GetRecordPlan - 查询录像计划

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

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetRecordPlan	要执行的操作，取值：GetRecordPlan。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
PlanID	String	是	plan0xxxx	需要查询的录像计划 ID，

返回参数

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

参数	类型	示例值	描述
PlanID	String	plan0xxxx	录像计划唯一 ID
PlanName	String	全天计划	录像计划名称
BindTemplate	String	plan01	绑定的录像模板 ID
TemplateInfo	Object		录像模板信息，参考以下 TemplateInfo 结构说明
Description	String	全天录制	录像计划描述
Status	String	enabled	录像计划状态： enabled（启用） disabled（禁用）
CreatedAt	Integer	1687663000	录像计划创建时间，Unix 秒级时间戳
UpdatedAt	Integer	1687693000	录像计划更新时间，Unix 秒级时间戳
BindStreamNum	Integer	2	录像计划绑定的视频流数量

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241219154409058170088005B4932A",
    "Action": "GetRecordPlan",
    "Version": "2021-01-01",
    "Service": "aiotvideo",
    "Region": "cn-beijing"
  },
  "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
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
400	MissingParameter	The required parameter %s is missing.
400	InvalidParameter	The specified parameter %s is invalid.
400	OperationDenied	Operation is denied because the specified resource is in use.
400	InvalidParameter.RecordPlanArg	The request is failed due to plan not found.