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

添加或更新推拉流限额配置

最近更新时间2023.10.12 17:39:59

首次发布时间2023.04.06 14:32:08

添加或更新推拉流限额配置。更新时,会对所有的限额参数做全量覆盖更新

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版添加或更新推拉流限额配置接口。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainStringlive.push.example.com需要配置限额的推流域名或拉流域名
QuotaDetailListArray of QuotaDetailList-限额配置详情

QuotaDetailList

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

BandwidthConfig

Object of BandwidthConfig

-

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

说明

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

StreamConfig

Object of StreamConfig

-

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

说明

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

ErrCodeInteger403超过限额时返回的错误码,默认值为 403
ErrMsgStringforbid超过限额时返回的错误信息,默认值为 forbid

BandwidthConfig

参数类型是否必选示例值描述
QuotaInteger1000带宽限额,取值[1~1000]

QuotaUnit

String

Mbps

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

  • Mbps
  • Gbps
  • Tbps

AlarmThreshold

Integer

900

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

说明

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

AlarmThresholdUnit

String

Mbps

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

  • Mbps
  • Gbps
  • Tbps

StreamConfig

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

AlarmThreshold

Integer

20

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

说明

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

返回参数

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

示例

请求示例

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

返回示例

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

错误码

访问公共错误码获取详细信息。