You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询播放触发回源配置

最近更新时间：2023.11.13 13:47:54

首次发布时间：2023.09.25 14:34:05

我的收藏

本接口支持根据 Vhost 信息，查询对应的播放触发的拉流回源配置信息。

注意事项

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

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=DescribeRelaySourceV3&Version=2023-01-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是DescribeRelaySourceV3接口名称。当前 API 的名称为 DescribeRelaySourceV3。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间名称。
AppString否liveApp名称。
GroupString否relay1组名称。

返回参数

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

参数类型示例值描述
RelaySourceConfigListArray of RelaySourceConfigList-回源配置列表。

RelaySourceConfigList

参数类型示例值描述
VhostStringpush.example.com域名空间名称。
AppStringliveApp名称。
GroupDetailsArray of GroupDetails-回源组配置详情。

GroupDetails

参数类型示例值描述
GroupStringrelay1回源组名称。
ServersArray of Servers-回源服务器配置列表。

Servers

参数类型示例值描述
RelaySourceDomainStringrtmp回源地址。
RelaySourceProtocolStringexample.org回源协议。
RelaySourceParamsJSON Map{"key1": "value1","key2": "value2"}自定义回源参数。

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeRelaySourceV3&Version=2023-01-01
{
  "Vhost": "push.example.com",
  "App": "live"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "DescribeRelaySource",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "RelaySourceConfigList": [
      {
        "Vhost": "push.example.com",
        "App": "live",
        "GroupDetails": [
          {
            "Group": "relay1",
            "Servers": [
              {
                "RelaySourceProtocol": "rtmp",
                "RelaySourceDomain": "example.org",
                "RelaySourceParams": {
                  "key1": "value1",
                  "key2": "value2"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.DBan internal error related to database occurred, please contact the administrator.出现与数据库相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。