You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/点播播放器/获取点播播放器列表
获取点播播放器列表
最近更新时间：2024.06.25 12:10:43首次发布时间：2024.04.28 14:37:34
我的收藏

您可通过此接口获取当前账号下的点播播放器列表。

注意事项

请求频率：单用户请求频率限制为 1 次/秒。

请求说明

  • 请求方式：GET
  • 请求地址：https://livesaas.volcengineapi.com/?Action=ListVodPlayerConfig&Version=2023-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListVodPlayerConfig接口名称。当前 API 的名称为 ListVodPlayerConfig。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
PageNumberInteger否1分页查询页码。默认取值为 1。
PageSizeInteger否10分页查询数量。取值范围为 [1,1000]。默认取值为 10。
SearchKeyString否播放器1根据点播播放器名称进行模糊搜索。最多支持输入 100 个字符。

返回参数

参数类型示例值描述
VodPlayerConfigsArray of VodPlayerConfigs-点播播放器列表。
PageNumberInteger1分页查询页码。
PageSizeInteger10分页查询数量。
TotalCountInteger1查询结果总数。

VodPlayerConfigs

参数类型示例值描述
VodPlayerConfigIdStringvcid-175866815156点播播放器 ID。

IsDefaultVodPlayerConfig

Integer

1

是否为默认点播播放器。支持以下取值：

  • 0：否
  • 1：是
VodPlayerNameString播放器1点播播放器名称。
UpdateTimeInteger1642070520最近一次更新点播播放器配置信息的时间。Unix 时间戳，单位为秒。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListVodPlayerConfig&Version=2023-08-01&PageSize=10&PageNumber=1&SearchKey=“播放器1”

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "ListVodPlayerConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1712067132
    },
    "Result": {
        "VodPlayerConfigs": [
            {
                "VodPlayerConfigId": "vcid-175866815156",
                "IsDefaultVodPlayerConfig": 1,
                "VodPlayerName": "播放器1",
                "UpdateTime": 1642070520
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1
    }
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。

状态码错误码错误信息说明
400InvalidParameter.InvalidAccountIdThe specified parameter AccountId is invalid.当前账号的鉴权信息错误。
400InvalidParameter.SearchKeyTooLongThe SearchKey is too long.搜索关键词超出限制。请修改后重试。