You need to enable JavaScript to run this app.
导航
限额管理
最近更新时间:2024.09.14 11:16:49首次发布时间:2023.12.28 21:21:52

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

说明

本文的调用示例包含接口的部分参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。

调用说明

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

前提条件

调用接口前,请先完成 Go SDK 的安装及初始化操作。

调用示例

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

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

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

接口调用示例如下所示。

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/volcengine/volc-sdk-golang/base"
	live "github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func Int32Ptr(v int32) *int32 {
	return &v
}

func StringPtr(v string) *string {
	return &v
}

func main() {
	// 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
	// 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
	service := live.NewInstance()
	service.SetCredential(base.Credentials{
		AccessKeyID:     os.Getenv("VOLC_ACCESSKEY"),
		SecretAccessKey: os.Getenv("VOLC_SECRETKEY"),
	})

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

	// 限额配置详情。
	QuotaDetailList1 := live.UpdateStreamQuotaConfigBodyQuotaDetailListItem{
		// 超过限额时返回的错误码,默认值为 403。
		ErrCode: Int32Ptr(403),
		// 超过限额时返回的错误信息,默认值为 forbid。
		ErrMsg: StringPtr(`forbid`),
	}

	// 拉流域名的带宽限额配置。
	// note:
	// Domain 为拉流域名时,本参数为必选参数。
	BandwidthConfig := live.UpdateStreamQuotaConfigBodyQuotaDetailListItemBandwidthConfig{
		// 带宽限额,下行带宽峰值超过此限额的额外访问将会被拒绝,取值范围为 [1,10000]。
		Quota: 1000,
		// 拉流带宽限额的计量单位,支持的取值如下所示。
		// <li> Mbps </li>
		// <li> Gbps </li>
		// <li> Tbps </li>
		QuotaUnit: `Mbps`,
		// 拉流带宽限额告警阈值,取值范围为 [1,10000],缺省情况表示不设置告警。
		// note:
		// 该参数的取值需要小于等于拉流带宽限额 Quota,否则会报错。
		AlarmThreshold: Int32Ptr(900),
		// 拉流带宽限额告警的计量单位,缺省情况表示不设置告警。支持的取值如下所示。
		// <li> Mbps </li>
		// <li> Gbps </li>
		// <li> Tbps </li>
		AlarmThresholdUnit: StringPtr(`Mbps`),
	}

	QuotaDetailList1.BandwidthConfig = &BandwidthConfig

	// 推流域名的推流路数限额配置。
	// note:
	// Domain 为推流域名时,本参数为必选参数。
	StreamConfig := live.UpdateStreamQuotaConfigBodyQuotaDetailListItemStreamConfig{
		// 推流路数限额,取值[10~200000]。
		Quota: 20,
		// 推流路数限额告警阈值,缺省情况表示不设置告警。取值范围为 [10,200000]。
		// note:
		// 该参数的取值需要小于等于推流路数限额 Quota,否则会报错。
		AlarmThreshold: Int32Ptr(20),
	}

	QuotaDetailList1.StreamConfig = &StreamConfig

	body.QuotaDetailList = append(body.QuotaDetailList, QuotaDetailList1)

	resp, err := service.UpdateStreamQuotaConfig(context.Background(), body)

	if err != nil {
		fmt.Printf("error %v", err)
	} else {
		fmt.Printf("success %+v", resp)
	}
}

查询推拉流限额配置

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

接口调用示例如下所示。

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/volcengine/volc-sdk-golang/base"
	live "github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main() {
	// 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
	// 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
	service := live.NewInstance()
	service.SetCredential(base.Credentials{
		AccessKeyID:     os.Getenv("VOLC_ACCESSKEY"),
		SecretAccessKey: os.Getenv("VOLC_SECRETKEY"),
	})

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

	resp, err := service.DescribeStreamQuotaConfig(context.Background(), body)

	if err != nil {
		fmt.Printf("error %v", err)
	} else {
		fmt.Printf("success %+v", resp)
	}
}

删除推拉流限额配置

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

接口调用示例如下所示。

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/volcengine/volc-sdk-golang/base"
	live "github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main() {
	// 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
	// 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
	service := live.NewInstance()
	service.SetCredential(base.Credentials{
		AccessKeyID:     os.Getenv("VOLC_ACCESSKEY"),
		SecretAccessKey: os.Getenv("VOLC_SECRETKEY"),
	})

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

	resp, err := service.DeleteStreamQuotaConfig(context.Background(), body)

	if err != nil {
		fmt.Printf("error %v", err)
	} else {
		fmt.Printf("success %+v", resp)
	}
}