You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /视频直播/API 参考/限额管理/添加或更新推拉流限额配置
添加或更新推拉流限额配置
最近更新时间：2024.05.10 16:57:12首次发布时间：2023.09.25 14:34:02
我的收藏

调用 UpdateStreamQuotaConfig 接口，为域名设置限额。

使用说明

您可以为拉流域名和推流域名分别配置限额。

  • 为拉流域名设置带宽限额及告警阈值，防止拉流带宽被突发大流量占用，以此保证正常业务的稳定。
  • 为推流域名设置推流路数限额及告警阈值，控制单个推流域名可承载的最大直播路数。

注意事项

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

请求说明

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainString是live.push.example.com需要配置限额的推流域名或拉流域名。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看域名信息。
QuotaDetailListArray of QuotaDetailList是-限额配置详情。

QuotaDetailList

参数类型是否必选示例值描述

BandwidthConfig

Object of BandwidthConfig

否

-

拉流域名的带宽限额配置。

说明

Domain 为拉流域名时，本参数为必选参数。

StreamConfig

Object of StreamConfig

否

-

推流域名的推流路数限额配置。

说明

Domain 为推流域名时，本参数为必选参数。

ErrCodeInteger否403超过限额时返回的错误码，默认值为 403。
ErrMsgString否forbid超过限额时返回的错误信息，默认值为 forbid。

BandwidthConfig

参数类型是否必选示例值描述
QuotaInteger是1000带宽限额，下行带宽峰值超过此限额的额外访问将会被拒绝，取值范围为 [1,10000]。

QuotaUnit

String

是

Mbps

拉流带宽限额的计量单位，支持的取值如下所示。

  • Mbps
  • Gbps
  • Tbps

AlarmThreshold

Integer

否

900

拉流带宽限额告警阈值，取值范围为 [1,10000]，缺省情况表示不设置告警。

说明

该参数的取值需要小于等于拉流带宽限额 Quota，否则会报错。

AlarmThresholdUnit

String

否

Mbps

拉流带宽限额告警的计量单位，缺省情况表示不设置告警。支持的取值如下所示。

  • Mbps
  • Gbps
  • Tbps

StreamConfig

参数类型是否必选示例值描述
QuotaInteger是20推流路数限额，取值[10~200000]。

AlarmThreshold

Integer

否

20

推流路数限额告警阈值，缺省情况表示不设置告警。取值范围为 [10,200000]。

说明

该参数的取值需要小于等于推流路数限额 Quota，否则会报错。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://live.volcengineapi.com?Action=UpdateStreamQuotaConfig&Version=2023-01-01
{
  "Domain": "live.push.example.com",
  "QuotaDetailList": [
    {
      "BandwidthConfig": {
        "Quota": 1000,
        "QuotaUnit": "Mbps",
        "AlarmThreshold": 900,
        "AlarmThresholdUnit": "Mbps"
      }
    }
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "UpdateStreamQuotaConfig",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
400InvalidParam.OutOfRange%s should be one of {[%s]}%s should be between %d and %d参数超出允许范围，请检查错误消息中指定参数的取值是否超出取值范围。
400InvalidParam.Empty%s is required参数缺失，请检查错误消息中指定的参数是否传入。
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.出现与数据库相关的内部错误，请联系技术支持。
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.内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。