调用 ReorderVideoRoomMedias 接口,修改指定点播间内视频的顺序。
注意事项
- 请求频率:单用户请求频率限制为 120 次/分钟。
- 前提条件:确保您拥有火山引擎主账号或具备点播间的 视频管理 > 可编辑权限的子账号。有关如何添加子账号,详见子账号管理。
请求说明
- 请求方式:POST
- 请求地址:https://livesaas.volcengineapi.com/?Action=ReorderVideoRoomMedias&Version=2023-08-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
去调试请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | ReorderVideoRoomMedias | 接口名称。当前 API 的名称为 ReorderVideoRoomMedias。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| VideoRoomId | Integer | 是 | 20001 | 点播间的 ID。您可通过调用 ListVideoRooms 接口获取 ID。 |
| VodReorderIndex | Array of VodReorderIndex | 是 | - | 视频顺序配置。建议传入全部视频及其对应 Index 以确保排序结果一致。 |
VodReorderIndex
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| MediaId | Integer | 是 | 50001 | 当前点播间内视频列表中的视频 ID。您可通过调用 ListVideoRoomMedias 接口,获取 MediaId 的值。 |
| Index | Integer | 是 | 1 | 视频的排序权重,视频展示顺序将按 Index 从小到大排列。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| Status | Boolean | true | 修改排序是否执行成功。成功返回 true。 |
请求示例
POST https://livesaas.volcengineapi.com/?Action=ReorderVideoRoomMedias&Version=2023-08-01
{
"VideoRoomId": 20001,
"VodReorderIndex": [
{
"MediaId": 50001,
"Index": 1
},
{
"MediaId": 50002,
"Index": 2
},
{
"MediaId": 50003,
"Index": 3
}
]
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "ReorderVideoRoomMedias",
"Version": "2023-08-01",
"Service": "livesaas",
"Region": "cn-north-1",
"SystemTime": 1697446406
},
"Result": {
"Status": true
}
}
错误码
访问公共错误码和错误码获取详细信息。