aliyun-dlf-manage-next

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Category: service
类别:service

Data Lake Formation (Next)

数据湖构建(Next)

Use Alibaba Cloud OpenAPI (RPC) with official SDKs or OpenAPI Explorer to manage resources for Data Lake Formation.
使用阿里云OpenAPI(RPC)搭配官方SDK或OpenAPI Explorer来管理Data Lake Formation的资源。

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)

访问密钥优先级(必须遵守)

  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:
    DlfNext
  • Default API version:
    2025-03-10
  • Use OpenAPI metadata endpoints to list APIs and get schemas (see references).
  • 产品代码:
    DlfNext
  • 默认API版本:
    2025-03-10
  • 使用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清单产物写入skill输出目录下。

Output policy

输出规则

If you need to save responses or generated artifacts, write them under:
output/aliyun-dlf-manage-next/
如果需要保存响应或生成的产物,请写入以下路径:
output/aliyun-dlf-manage-next/

Validation

验证

bash
mkdir -p output/aliyun-dlf-manage-next
for f in skills/data-lake/aliyun-dlf-manage-next/scripts/*.py; do
  python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/aliyun-dlf-manage-next/validate.txt
Pass criteria: command exits 0 and
output/aliyun-dlf-manage-next/validate.txt
is generated.
bash
mkdir -p output/aliyun-dlf-manage-next
for f in skills/data-lake/aliyun-dlf-manage-next/scripts/*.py; do
  python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/aliyun-dlf-manage-next/validate.txt
通过标准:命令退出码为0,且成功生成
output/aliyun-dlf-manage-next/validate.txt
文件。

Output And Evidence

输出与存证

  • Save artifacts, command outputs, and API response summaries under
    output/aliyun-dlf-manage-next/
    .
  • Include key parameters (region/resource id/time range) in evidence files for reproducibility.
  • 将产物、命令输出和API响应摘要保存在
    output/aliyun-dlf-manage-next/
    目录下。
  • 在存证文件中包含关键参数(地域/资源ID/时间范围)以便操作复现。

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