限额管理

阅读本文，您可以获取 PHP SDK 限额管理的接口调用示例，实现快速开发。

调用说明

• 本文提供的接口调用示例均通过 AK 和 SK 初始化实例。
• 接口的参数说明和错误码等信息可通过接口文档或打开 API Explorer 的文档说明页签查看。

前提条件

调用接口前，请先完成 PHP SDK 的安装及初始化操作

调用示例

本节为您介绍限额管理相关接口的功能和调用示例。

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

您可以调用 UpdateStreamQuotaConfig 接口添加或更新推拉流限额配置。详细的参数说明可参见 UpdateStreamQuotaConfig 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [];
     
  // 需要配置限额的推流域名或拉流域名。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面，查看域名信息。
  $body["Domain"] = "live.push.example.com";

  // 限额配置详情。
  
  $UpdateStreamQuotaConfigBodyQuotaDetailList = [];

  $UpdateStreamQuotaConfigBodyQuotaDetailListItem = [];

  // 拉流域名的带宽限额配置。
  // note：
  // `Domain` 为拉流域名时，本参数为必选参数。
  $UpdateStreamQuotaConfigBodyQuotaDetailListItemBandwidthConfig =[];
    
  // 带宽限额，下行带宽峰值超过此限额的额外访问将会被拒绝，取值范围为 [1,10000]。
  $UpdateStreamQuotaConfigBodyQuotaDetailListItemBandwidthConfig["Quota"] = 1000;

  // 拉流带宽限额的计量单位，支持的取值如下所示。
  // <li> Mbps </li>
  // <li> Gbps </li>
  // <li> Tbps </li>
  $UpdateStreamQuotaConfigBodyQuotaDetailListItemBandwidthConfig["QuotaUnit"] = "Mbps";

  // 拉流带宽限额告警阈值，取值范围为 [1,10000]，缺省情况表示不设置告警。
  // note：
  // 该参数的取值需要小于等于拉流带宽限额 `Quota`，否则会报错。
  $UpdateStreamQuotaConfigBodyQuotaDetailListItemBandwidthConfig["AlarmThreshold"] = 900;

  // 拉流带宽限额告警的计量单位，缺省情况表示不设置告警。支持的取值如下所示。
  // <li> Mbps </li>
  // <li> Gbps </li>
  // <li> Tbps </li>
  $UpdateStreamQuotaConfigBodyQuotaDetailListItemBandwidthConfig["AlarmThresholdUnit"] = "Mbps";

  $UpdateStreamQuotaConfigBodyQuotaDetailListItem["BandwidthConfig"] = $UpdateStreamQuotaConfigBodyQuotaDetailListItemBandwidthConfig;
  // 推流域名的推流路数限额配置。
  // note：
  // `Domain` 为推流域名时，本参数为必选参数。
  $UpdateStreamQuotaConfigBodyQuotaDetailListItemStreamConfig =[];
    
  // 推流路数限额，取值[10~200000]。
  $UpdateStreamQuotaConfigBodyQuotaDetailListItemStreamConfig["Quota"] = 20;

  // 推流路数限额告警阈值，缺省情况表示不设置告警。取值范围为 [10,200000]。
  // note：
  // 该参数的取值需要小于等于推流路数限额 `Quota`，否则会报错。
  $UpdateStreamQuotaConfigBodyQuotaDetailListItemStreamConfig["AlarmThreshold"] = 20;

  $UpdateStreamQuotaConfigBodyQuotaDetailListItem["StreamConfig"] = $UpdateStreamQuotaConfigBodyQuotaDetailListItemStreamConfig;
  // 超过限额时返回的错误码，默认值为 `403`。
  $UpdateStreamQuotaConfigBodyQuotaDetailListItem["ErrCode"] = 403;

  // 超过限额时返回的错误信息，默认值为 `forbid`。
  $UpdateStreamQuotaConfigBodyQuotaDetailListItem["ErrMsg"] = "forbid";

  array_push($UpdateStreamQuotaConfigBodyQuotaDetailList, $UpdateStreamQuotaConfigBodyQuotaDetailListItem);

  $body["QuotaDetailList"]= $UpdateStreamQuotaConfigBodyQuotaDetailList;

  $response = $client->updateStreamQuotaConfig($body);
  print_r($response);

查询推拉流限流配置

您可以调用 DescribeStreamQuotaConfig 接口查询推拉流限流配置。详细的参数说明可参见 DescribeStreamQuotaConfig 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [];
     
  // 待查询限额配置的推流域名或拉流域名。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面，查看域名信息。
  $body["Domain"] = "live.push.example.com";

  $response = $client->describeStreamQuotaConfig($body);
  print_r($response);

删除推拉流限额配置

您可以调用 DeleteStreamQuotaConfig 接口删除推拉流限额配置。详细的参数说明可参见 DeleteStreamQuotaConfig 接口文档。

接口调用示例如下所示。

<?php
  include_once('./vendor/autoload.php');

  use Volc\Service\Live\v20230101\Live;

  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  $client = Live::getInstance();
 
  $client->setAccessKey(getenv("ACCESS_KEY_ID"));

  $client->setSecretKey(getenv("ACCESS_KEY_SECRET"));

  $body = [];
     
  // 待删除限额配置的推流域名或拉流域名。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面，查看域名信息。
  $body["Domain"] = "push.example.com";

  $response = $client->deleteStreamQuotaConfig($body);
  print_r($response);