最近更新时间：2023.09.25 21:10:01
首次发布时间：2023.04.06 14:32:08
添加或更新推拉流限额配置。更新时，会对所有的限额参数做全量覆盖更新。
说明
该接口数据历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版添加或更新推拉流限额配置接口。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateStreamQuotaConfig | 接口名称。当前 API 的名称为 UpdateStreamQuotaConfig。 |
| Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Domain | String | 是 | live.push.example.com | 需要配置限额的推流域名或拉流域名 |
| QuotaDetailList | Array of QuotaDetailList | 是 | - | 限额配置详情 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
BandwidthConfig | Object of BandwidthConfig | 否 |
| 拉流域名的带宽限额配置。 说明
|
StreamConfig | Object of StreamConfig | 否 |
| 推流域名的推流路数限额配置。 说明
|
| ErrCode | Integer | 否 | 403 | 超过限额时返回的错误码，默认值为 403 |
| ErrMsg | String | 否 | forbid | 超过限额时返回的错误信息，默认值为 forbid |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Quota | Integer | 是 | 1000 | 带宽限额，取值[1~1000] |
QuotaUnit | String | 是 |
| 拉流带宽限额的计量单位，支持的取值如下所示。
|
AlarmThreshold | Integer | 否 |
| 拉流带宽限额告警阈值，取值范围为 [1,1000]，缺省情况表示不设置告警。 说明 该参数的取值需要小于等于拉流带宽限额 |
AlarmThresholdUnit | String | 否 |
| 拉流带宽限额告警的计量单位，缺省情况表示不设置告警。支持的取值如下所示。
|
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Quota | Integer | 是 | 20 | 推流路数限额，取值[10~200000] |
AlarmThreshold | Integer | 是 |
| 推流路数限额告警阈值，缺省情况表示不设置告警。取值范围为 [10,200000] 说明 该参数的取值需要小于等于推流路数限额 |
本接口无特有的返回参数。更多信息请见返回结构。
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" } }
访问公共错误码获取详细信息。