alicloud-security-cloudfw

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Category: service
类别:服务

Cloud Firewall

Cloud Firewall

Use Alibaba Cloud OpenAPI (RPC) with official SDKs or OpenAPI Explorer to manage resources for Cloud Firewall.
使用阿里云OpenAPI(RPC)结合官方SDK或OpenAPI Explorer管理云防火墙资源。

Workflow

工作流程

  1. Confirm region, resource identifiers, and desired action.
  2. Discover API list and required parameters (see references).
  3. Call API with SDK or OpenAPI Explorer.
  4. Verify results with describe/list APIs.
  1. 确认地域、资源标识符及所需操作。
  2. 查阅API列表及必填参数(参见参考资料)。
  3. 通过SDK或OpenAPI Explorer调用API。
  4. 使用查询/列举类API验证结果。

AccessKey priority (must follow)

AccessKey优先级(必须遵循)

  1. Environment variables:
    ALICLOUD_ACCESS_KEY_ID
    /
    ALICLOUD_ACCESS_KEY_SECRET
    /
    ALICLOUD_REGION_ID
    Region policy:
    ALICLOUD_REGION_ID
    is an optional default. If unset, decide the most reasonable region for the task; if unclear, ask the user.
  2. Shared config file:
    ~/.alibabacloud/credentials
  1. 环境变量:
    ALICLOUD_ACCESS_KEY_ID
    /
    ALICLOUD_ACCESS_KEY_SECRET
    /
    ALICLOUD_REGION_ID
    地域策略:
    ALICLOUD_REGION_ID
    为可选默认值。若未设置,需为任务选择最合理的地域;若不确定,请询问用户。
  2. 共享配置文件:
    ~/.alibabacloud/credentials

API discovery

API发现

  • Product code:
    Cloudfw
  • Default API version:
    2017-12-07
  • Use OpenAPI metadata endpoints to list APIs and get schemas (see references).
  • 产品代码:
    Cloudfw
  • 默认API版本:
    2017-12-07
  • 使用OpenAPI元数据端点列举API并获取Schema(参见参考资料)。

High-frequency operation patterns

高频操作模式

  1. Inventory/list: prefer
    List*
    /
    Describe*
    APIs to get current resources.
  2. Change/configure: prefer
    Create*
    /
    Update*
    /
    Modify*
    /
    Set*
    APIs for mutations.
  3. Status/troubleshoot: prefer
    Get*
    /
    Query*
    /
    Describe*Status
    APIs for diagnosis.
  1. 盘点/列举:优先使用
    List*
    /
    Describe*
    类API获取当前资源。
  2. 变更/配置:优先使用
    Create*
    /
    Update*
    /
    Modify*
    /
    Set*
    类API执行变更操作。
  3. 状态/故障排查:优先使用
    Get*
    /
    Query*
    /
    Describe*Status
    类API进行诊断。

Minimal executable quickstart

最简可执行快速入门

Use metadata-first discovery before calling business APIs:
bash
python scripts/list_openapi_meta_apis.py
Optional overrides:
bash
python scripts/list_openapi_meta_apis.py --product-code <ProductCode> --version <Version>
The script writes API inventory artifacts under the skill output directory.
在调用业务API前,优先使用元数据优先的发现方式:
bash
python scripts/list_openapi_meta_apis.py
可选覆盖参数:
bash
python scripts/list_openapi_meta_apis.py --product-code <ProductCode> --version <Version>
该脚本会将API盘点产物写入技能输出目录。

Output policy

输出策略

If you need to save responses or generated artifacts, write them under:
output/alicloud-security-cloudfw/
若需要保存响应或生成的产物,请写入以下路径:
output/alicloud-security-cloudfw/

References

参考资料

  • Sources:
    references/sources.md
  • 来源:
    references/sources.md