用途
该技能用于通过阿里云 OpenAPI(RPC)配合官方 SDK 或 OpenAPI Explorer 管理云防火墙(Cloud Firewall)资源。当用户提出防火墙策略或资源操作、变更管理、状态查询等请求时适用。
主要能力
- 通过 OpenAPI 元数据端点发现 API 列表并获取接口 schema。
- 支持清单/查询类操作(List* / Describe*)、变更/配置类操作(Create* / Update* / Modify* / Set*)以及状态/排障类操作(Get* / Query* / Describe*Status)。
- 提供元数据优先的快速开始脚本,可在调用业务 API 前先发现可用接口。
使用方式
工作流程:
- 确认地域、资源标识与目标操作。
- 发现 API 列表及所需参数(参见 references)。
- 通过 SDK 或 OpenAPI Explorer 调用 API。
- 使用 describe/list 类 API 验证结果。
凭证优先级(须遵循):
- 环境变量:ALICLOUD_ACCESS_KEY_ID / ALICLOUD_ACCESS_KEY_SECRET / ALICLOUD_REGION_ID。
- 地域策略:ALICLOUD_REGION_ID 为可选默认值;若未设置,需为任务选择最合理的地域,若仍不明确则询问用户。
- 共享配置文件:~/.alibabacloud/credentials。
API 发现:
- 产品代码:Cloudfw
- 默认 API 版本:2017-12-07
- 使用 OpenAPI 元数据端点列出 API 并获取 schema(参见 references)。
最小可执行快速开始(先做元数据发现,再调用业务 API):
python scripts/list_openapi_meta_apis.py
可选覆盖参数:
python scripts/list_openapi_meta_apis.py --product-code <ProductCode> --version <Version>
脚本会将 API 清单产物写入技能输出目录。
输出策略:如需保存响应或生成的产物,写入 output/alicloud-security-cloudfw/ 目录。
验证:
mkdir -p output/alicloud-security-cloudfw
for f in skills/security/firewall/alicloud-security-cloudfw/scripts/*.py; do
python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/alicloud-security-cloudfw/validate.txt
通过标准:命令退出码为 0,且生成 output/alicloud-security-cloudfw/validate.txt。
输出与证据:将产物、命令输出和 API 响应摘要保存到 output/alicloud-security-cloudfw/ 下;在证据文件中包含关键参数(地域/资源 ID/时间范围)以便复现。
适用场景
- 需要查询或列出云防火墙现有资源与策略。
- 需要创建、更新或修改云防火墙配置。
- 需要诊断云防火墙状态或进行排障。
限制与前置条件
- 执行前需配置最小权限的阿里云凭证。
- 优先使用环境变量:ALICLOUD_ACCESS_KEY_ID、ALICLOUD_ACCESS_KEY_SECRET,以及可选的 ALICLOUD_REGION_ID。
- 若地域不明确,应在执行变更类操作前询问用户。
- 参考资料:references/sources.md。
关于收费、价格、平台支持范围及具体效果等细节,资料暂未提供。