aliyun-kms-manage

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Category: service
分类:服务

Key Management Service

密钥管理服务(KMS)

Validation

验证

bash
mkdir -p output/aliyun-kms-manage
python -m py_compile skills/security/key-management/aliyun-kms-manage/scripts/list_openapi_meta_apis.py && echo "py_compile_ok" > output/aliyun-kms-manage/validate.txt
Pass criteria: command exits 0 and
output/aliyun-kms-manage/validate.txt
is generated.
bash
mkdir -p output/aliyun-kms-manage
python -m py_compile skills/security/key-management/aliyun-kms-manage/scripts/list_openapi_meta_apis.py && echo "py_compile_ok" > output/aliyun-kms-manage/validate.txt
通过标准:命令退出码为0,且成功生成
output/aliyun-kms-manage/validate.txt
文件。

Output And Evidence

输出与佐证材料

  • Save KMS API discovery outputs and operation results in
    output/aliyun-kms-manage/
    .
  • Keep at least one request parameter example per operation type.
Use Alibaba Cloud OpenAPI (RPC) with official SDKs or OpenAPI Explorer to manage resources for KeyManagementService.
  • 请将KMS API发现结果和操作结果保存在
    output/aliyun-kms-manage/
    目录下。
  • 每种操作类型至少保留一个请求参数示例。
请使用阿里云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. 使用describe/list类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:
    Kms
  • Default API version:
    2016-01-20
  • Use OpenAPI metadata endpoints to list APIs and get schemas (see references).
  • 产品代码:
    Kms
  • 默认API版本:
    2016-01-20
  • 请使用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/aliyun-kms-manage/
如果需要保存响应或生成的产物,请写入到以下目录:
output/aliyun-kms-manage/

Prerequisites

前置条件

  • Configure least-privilege Alibaba Cloud credentials before execution.
  • Prefer environment variables:
    ALICLOUD_ACCESS_KEY_ID
    ,
    ALICLOUD_ACCESS_KEY_SECRET
    , optional
    ALICLOUD_REGION_ID
    .
  • If region is unclear, ask the user before running mutating operations.
  • 执行前请配置最小权限的阿里云凭证。
  • 优先使用环境变量:
    ALICLOUD_ACCESS_KEY_ID
    ALICLOUD_ACCESS_KEY_SECRET
    ,可选配置
    ALICLOUD_REGION_ID
  • 如果无法确定地域,请在执行变更操作前询问用户。

References

参考资料

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