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=DescribeStreamQuotaConfig&Version=2020-08-01

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainString是live.push.example.com待查询限额配置的推流域名或拉流域名

返回参数

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

参数类型示例值描述
QuotaListArray of QuotaList-限额配置列表

QuotaList

参数类型示例值描述
VhostStringlive.push.example.com域名空间名称
DomainStringlive.push.example.com推流域名或拉流域名
QuotaDetailListArray of QuotaDetailList-配置详情列表

QuotaDetailList

参数类型示例值描述

BandwidthConfig

Object of BandwidthConfig

-

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

说明

Domain 为拉流域名时返回。

StreamConfig

Object of StreamConfig

-

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

说明

Domain 为推流域名时返回。

BandwidthConfig

参数类型示例值描述
QuotaInteger1000拉流带宽限额
QuotaUnitStringMbps拉流带宽限额的计量单位
AlarmThresholdInteger900拉流带宽限额告警阈值，缺省情况表示未设置告警
AlarmThresholdUnitStringMbps拉流带宽限额告警的计量单位，缺省情况表示不未设置告警

StreamConfig

参数类型示例值描述
QuotaInteger20推流路数限额
AlarmThresholdInteger20推流路数限额告警阈值，缺省情况表示未设置告警

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeStreamQuotaConfig&Version=2020-08-01
{
  "Domain": "live.push.example.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "DescribeStreamQuotaConfig",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "QuotaList": [
      {
        "Vhost": "live.push.example.com",
        "Domain": "live.push.example.com",
        "QuotaDetailList": [
          {
            "BandwidthConfig": {
              "Quota": 1000,
              "QuotaUnit": "Mbps",
              "AlarmThresholdUnit": "Mbps",
              "AlarmThreshold": 900
            }
          }
        ]
      }
    ]
  }
}

错误码

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