文档中心

查询推拉流限流配置

最近更新时间：2024.03.27 17:13:23

首次发布时间：2023.09.25 14:34:02

调用 DescribeStreamQuotaConfig 接口，查询指定推流域名的推流路数限额配置或查询指定拉流域名的拉流带宽限额配置。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeStreamQuotaConfig`	接口名称。当前 API 的名称为 `DescribeStreamQuotaConfig`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
Domain	String	是	`live.push.example.com`	待查询限额配置的推流域名或拉流域名。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看域名信息。

返回参数

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

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

QuotaList

参数	类型	示例值	描述
Vhost	String	`push.example.com`	域名空间。
Domain	String	`push.example.com`	推流域名或拉流域名。
QuotaDetailList	Array of QuotaDetailList	`-`	配置详情列表。

QuotaDetailList

参数	类型	示例值	描述
BandwidthConfig	Object of BandwidthConfig	`-`	拉流域名的带宽限额配置信息。说明 `Domain` 为拉流域名时返回。
StreamConfig	Object of StreamConfig	`-`	推流域名的推流路数限额配置信息。说明 `Domain` 为推流域名时返回。

BandwidthConfig

参数	类型	示例值	描述
Quota	Integer	`1000`	拉流域名的带宽限额。
QuotaUnit	String	`Mbps`	带宽限额的计量单位。
AlarmThreshold	Integer	`900`	带宽限额的告警阈值，缺省情况表示未设置告警。
AlarmThresholdUnit	String	`Mbps`	带宽限额告警的计量单位，缺省情况表示不未设置告警。

StreamConfig

参数	类型	示例值	描述
Quota	Integer	`20`	推流域名的推流路数限额。
AlarmThreshold	Integer	`20`	推流路数限额告警阈值，缺省情况表示未设置告警。

请求示例

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

返回示例

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

错误码

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

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
500	InternalError.DB	an internal error related to database occurred, please contact the administrator.	出现与数据库相关的内部错误，请联系技术支持。
500	InternalError.VhostOrDomain	an internal error related to vhost or domain occurred, please contact the administrator.	出现与域名空间（Vhost）或域名（Domain）相关的内部错误。请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。

服务端 SDK

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