You need to enable JavaScript to run this app.
导航

生成推流地址

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

首次发布时间2023.09.25 14:34:03

调用接口生成推流地址。

注意事项

请求频率:单用户请求频率限制为 25 次/秒

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostStringpush.example.com域名空间名称。
AppStringlive应用名称。
StreamStringstream001流名称。

ValidDuration

Integer

5

有效时长,推流地址的有效时间,过期后需要重新生成。单位为秒,取值 ﹥0,缺省情况下表示 7 天。

说明

如果同时设置 ValidDurationExpiredTime,以 ExpiredTime 的时间为准。

ExpiredTime

String

2023-08-19T16:07:25+08:00

过期时间,推流地址的有效时间,过期后需要重新生成。RFC3339 格式的 UTC 时间,精度为秒,缺省情况下表示 7 天。

说明

如果同时设置 ValidDurationExpiredTime,以 ExpiredTime 的时间为准。

DomainStringpush.example.com推流域名名称,需要推流地址的域名,不填返回Vhost下所有推流域名生成的地址。

返回参数

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

参数类型示例值描述
PushURLListArray of String["rtmp://push.example.com/live/stream001"]RTMP 推流地址。
PushURLListDetailArray of PushURLListDetail-推流地址详情。
TsOverSrtURLListArray of String["srt://push.example.com:9000?streamid=#!::h=push.example.com,r=live/stream001,m=publish"]TS over SRT 推流地址。
RtmpOverSrtURLListArray of String["rtmp://push.example.com:1999/live/stream001"]RTMP over SRT 推流地址。
RtmURLListArray of String["http://push.example.com/live/stream001.sdp"]RTM 推流地址。
WebTransportURLListArray of String["https://push.example.com/live/stream001"]网络传输推流地址。

PushURLListDetail

参数类型示例值描述
URLStringrtmp://live.push.example.com/live/stream001推流地址。
DomainAppStringrtmp://push.example.com/live/OBS 推流地址,例如,rtmp://push.example.com/live/
StreamSignStringstream001OBS 推流名称,例如,streamname1?volcTime=1675652376&volcSecret=c57d247c2f19b395b6ec9b182******7

示例

请求示例

POST https://live.volcengineapi.com?Action=GeneratePushURL&Version=2023-01-01
{
  "Vhost": "push.example.com",
  "Domain": "push.example.com",
  "App": "live",
  "Stream": "stream001",
  "ExpiredTime": "2022-08-19T16:07:25+08:00"
}

返回示例

{
  "ResponseMetadata":{
    "RequestId":"2022081915573801022524312506B8B2EA",
    "Action":"GeneratePushURL",
    "Version":"2023-01-01",
    "Service":"live",
    "Region": "cn-north-1"
  },
  "Result": {
    "PushURLList": [
      "rtmp://example.org/live/test1"
    ],
    "PushURLListDetail": [
      {
        "DomainApp": "rtmp://example.org/live/",
        "StreamSign": "test1",
        "URL": "rtmp://example.org/live/test1"
      }
    ],
    "RtmURLList": [
      "http://example.org/live/test1.sdp"
    ],
    "RtmpOverSrtURLList": [
      "rtmp://example.org:1999/live/test1"
    ],
    "TsOverSrtURLList": [
      "srt://example.org:9000?streamid=#!::h=example.org,r=live/test1,m=publish",
      "WebTransportURLList": ["https://example.org/live/test1"]
    ]
  } 
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
400InvalidParam.Format%s format error参数格式错误,请检查错误消息中指定参数中是否存在非法字符或 URL 格式错误。
400InvalidParam.OutOfRange%s should be one of {[%s]}%s should be between %d and %d参数超出允许范围,请检查错误消息中指定参数的取值是否超出取值范围。
400InvalidParam.TimeLogicstartTime later than endTime, etc.传入的时间参数不符合时间逻辑,请检查是否存在以下问题。开始时间晚于结束时间过期时间早于当前时间
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.VhostOrDomainan internal error related to vhost or domain occurred, please contact the administrator.出现与域名空间(Vhost)或域名(Domain)相关的内部错误。请联系技术支持
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.内部服务超时,请联系技术支持