最近更新时间:2023.11.13 13:47:54
首次发布时间:2023.09.25 14:34:05
本接口支持根据 Vhost
信息,查询对应的播放触发的拉流回源配置信息。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeRelaySourceV3 | 接口名称。当前 API 的名称为 DescribeRelaySourceV3 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Vhost | String | 是 | push.example.com | 域名空间名称。 |
App | String | 否 | live | App名称。 |
Group | String | 否 | relay1 | 组名称。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
RelaySourceConfigList | Array of RelaySourceConfigList | - | 回源配置列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Vhost | String | push.example.com | 域名空间名称。 |
App | String | live | App名称。 |
GroupDetails | Array of GroupDetails | - | 回源组配置详情。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Group | String | relay1 | 回源组名称。 |
Servers | Array of Servers | - | 回源服务器配置列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
RelaySourceDomain | String | rtmp | 回源地址。 |
RelaySourceProtocol | String | example.org | 回源协议。 |
RelaySourceParams | JSON 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" } } ] } ] } ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | CommonErr | - | 未分类错误。建议重试,如果仍返回该错误码,请联系技术支持。 |
400 | InvalidParam | - | 输入的参数无效或不符合要求,请参照请求参数说明进行检查。 |
400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验,请检查参数类型是否正确。 |
403 | RequestForbidden | - | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
403 | RequestForbidden.AccountIDNotAllow | this AccountID does not have permission to access the corresponding resource, please check the request parameters | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
403 | RequestForbidden.BillingStatus | Billing status is not available for the AccountID, please activate the service or recharge. | 未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。 |
404 | ResourceNotFound | - | 未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持。 |
500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误,请联系技术支持。 |
500 | InternalError.DB | an internal error related to database occurred, please contact the administrator. | 出现与数据库相关的内部错误,请联系技术支持。 |
502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时,请联系技术支持。 |