📦 BytePlusCDN
v1.0.0用于BytePlus CDN域名和策略管理、清除和预取,以及日志投递的技能。当您需要使用BytePlus CDN加速服务时,可以使用此技能来...
运行时依赖
安装命令
点击复制技能文档
BytePlus CDN 技能安装和配置 在使用 BytePlus CDN 技能之前,请按照以下步骤配置您的环境。
- 安装依赖
cd /path/to/byteplus-cdn
pip3 install -r reference/requirements.txt
- 配置身份验证(凭证)
BYTEPLUS_AK 和 BYTEPLUS_SK 以进行安全身份验证。这是调用 BytePlus OpenAPI 的前提条件。您可以在项目根目录创建一个 .env 文件来存储 AK 和 SK 环境变量:
BYTEPLUS_AK=您的 Access Key
BYTEPLUS_SK=您的 Secret Key
Windows PowerShell:
$env:BYTEPLUS_AK="您的 Access Key"
$env:BYTEPLUS_SK="您的 Secret Key"
Linux / macOS:
export BYTEPLUS_AK="您的 Access Key"
export BYTEPLUS_SK="您的 Secret Key"
- 验证安装
python3 scripts/cli.py --help
如果帮助信息成功输出,则表示环境配置完成。功能概述 这是一个用于操作 BytePlus CDN 的本地命令行工具,完全对应 CLI.md 中的所有指令要求。它包括以下核心功能:
添加 CDN 域名 - 支持两种方法: + 方法 1:直接配置源站(支持 Alibaba Cloud OSS、Tencent Cloud COS、AWS S3、BytePlus TOS、IP、域名) + 方法 2:绑定现有的分发策略模板 创建策略模板 - 预配置和发布 CDN 分发策略 清除缓存 - 文件刷新和目录刷新 预加载缓存 - 从源站预加载文件到 CDN 节点 创建离线/实时日志投递任务 - 配置日志投递目的地,支持投递到 S3、BytePlus TOS、Splunk 等平台
新功能:交互式指南(交互模式)
如果您运行一个命令没有任何参数(例如,python3 scripts/cli.py add-domain oss),CLI 将像向导一样引导您完成所需的参数。
代理交互指南 当代理(AI)发现需要从用户收集缺失的参数时,必须遵循这些交互规范:
选项类型参数:必须使用 AskUserQuestion 工具让用户进行单选或多选(例如,源站类型、服务类型)。 深入理解和透明度的底层提示:在调用 AskUserQuestion 收集参数之前,您必须阅读对应参数在 scripts/cli.py 中的提示和帮助定义。 构造精确的收集表单:在呈现给用户的收集表单(AskUserQuestion)中,您提供的描述或选项必须完全包含来自 cli.py 的特殊提示!例如:如果 cli.py 指定 --domain 可以输入 "all" 来表示所有域名,您必须在表单中提供一个特殊的 ["所有域名 (all)"] 选项,并且不能自行添加不相关的测试选项。 字符串输入类型参数:除非底层支持特殊值(例如 "all"),否则始终提供一个 ["手动输入 (请选择 Other 来输入)"] 选项,允许用户通过系统自己的 Other 选项调用友好的文本输入提示。
命令列表(对应 CLI 列表) 以下示例都演示了非交互模式(一次性带入所有参数)的使用。如果您想使用交互模式,只需省略 --xxx 参数即可。
1-6. 添加 CDN 域名(add-domain) Alibaba Cloud OSS(CLI 1)
python3 scripts/cli.py add-domain oss --domain YOUR_DOMAIN_NAME --origin YOUR_BUCKET_NAME.YOUR_OSS_REGION.aliyuncs.com --service-type web --private-bucket yes --bucket-ak YOUR_AK --bucket-sk YOUR_SK --apply-recommended yes
Tencent Cloud COS(CLI 2)
python3 scripts/cli.py add-domain cos --domain YOUR_DOMAIN_NAME --origin YOUR_BUCKET_NAME.cos.YOUR_COS_REGION.myqcloud.com --service-type download --private-bucket no --apply-recommended yes
AWS S3(CLI 3)
python3 scripts/cli.py add-domain aws --domain YOUR_DOMAIN_NAME --origin YOUR_BUCKET_NAME.s3.YOUR_AWS_REGION.amazonaws.com --service-type video --private-bucket yes --bucket-ak YOUR_AK --bucket-sk YOUR_SK --region YOUR_AWS_REGION --apply-recommended yes
BytePlus TOS(CLI 4)
python3 scripts/cli.py add-domain tos --domain YOUR_DOMAIN_NAME --origin YOUR_BUCKET_NAME.YOUR_TOS_REGION.bytepluses.com --service-type web --private-bucket yes --apply-recommended yes
IP 源站(CLI 5)
python3 scripts/cli.py add-domain ip --domain YOUR_DOMAIN_NAME --origin YOUR_IP_ADDRESS --service-type web --apply-recommended yes
* 域名源站(CLI 6)
python3 scripts/cli.py add-domain domain --domain YOUR_DOMAIN_NAME --origin YOUR_ORIGIN_DOMAIN --service-type web --apply-recommended yes
绑定策略模板 - 通过绑定已发布的分发策略添加域名
基本用法
python3 scripts/cli.py add-domain temp