最近更新时间:2023.09.25 21:10:01
首次发布时间:2023.04.06 14:32:08
查询指定推/拉流域名的限额配置。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询推拉流限额配置接口。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeStreamQuotaConfig | 接口名称。当前 API 的名称为 DescribeStreamQuotaConfig 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Domain | String | 是 | live.push.example.com | 待查询限额配置的推流域名或拉流域名 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
QuotaList | Array of QuotaList | - | 限额配置列表 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Vhost | String | live.push.example.com | 域名空间名称 |
Domain | String | live.push.example.com | 推流域名或拉流域名 |
QuotaDetailList | Array of QuotaDetailList | - | 配置详情列表 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
BandwidthConfig | Object of BandwidthConfig |
| 推流域名的推流路数限额配置信息。 说明
|
StreamConfig | Object of StreamConfig |
| 推流域名的推流路数限额配置信息。 说明
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Quota | Integer | 1000 | 拉流带宽限额 |
QuotaUnit | String | Mbps | 拉流带宽限额的计量单位 |
AlarmThreshold | Integer | 900 | 拉流带宽限额告警阈值,缺省情况表示未设置告警 |
AlarmThresholdUnit | String | Mbps | 拉流带宽限额告警的计量单位,缺省情况表示不未设置告警 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Quota | Integer | 20 | 推流路数限额 |
AlarmThreshold | Integer | 20 | 推流路数限额告警阈值,缺省情况表示未设置告警 |
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 } } ] } ] } }
访问公共错误码获取详细信息。