aliyun-dlf-manage
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseCategory: service
分类:服务
Data Lake Formation
Data Lake Formation
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
工作流程
- Confirm region, resource identifiers, and desired action.
- Discover API list and required parameters (see references).
- Call API with SDK or OpenAPI Explorer.
- Verify results with describe/list APIs.
- 确认地域、资源标识符和所需执行的操作。
- 查找API列表及所需参数(见参考资料)。
- 使用SDK或OpenAPI Explorer调用API。
- 通过describe/list类API验证结果。
AccessKey priority (must follow)
AccessKey优先级(必须遵守)
- Environment variables: /
ALIBABACLOUD_ACCESS_KEY_ID/ALIBABACLOUD_ACCESS_KEY_SECRETRegion policy:ALIBABACLOUD_REGION_IDis an optional default. If unset, decide the most reasonable region for the task; if unclear, ask the user.ALIBABACLOUD_REGION_ID - Shared config file:
~/.alibabacloud/credentials
- 环境变量:/
ALIBABACLOUD_ACCESS_KEY_ID/ALIBABACLOUD_ACCESS_KEY_SECRET地域策略:ALIBABACLOUD_REGION_ID是可选的默认配置。若未设置,需为任务选择最合理的地域;若不明确,询问用户。ALIBABACLOUD_REGION_ID - 共享配置文件:
~/.alibabacloud/credentials
API discovery
API发现
- Product code:
DataLake - Default API version:
2020-07-10 - Use OpenAPI metadata endpoints to list APIs and get schemas (see references).
- 产品代码:
DataLake - 默认API版本:
2020-07-10 - 使用OpenAPI元数据端点列出API并获取schema(见参考资料)。
High-frequency operation patterns
高频操作模式
- Inventory/list: prefer /
List*APIs to get current resources.Describe* - Change/configure: prefer /
Create*/Update*/Modify*APIs for mutations.Set* - Status/troubleshoot: prefer /
Get*/Query*APIs for diagnosis.Describe*Status
- 清单/列表:优先使用 /
List*类API获取当前资源。Describe* - 变更/配置:优先使用 /
Create*/Update*/Modify*类API执行变更操作。Set* - 状态/排查:优先使用 /
Get*/Query*类API进行诊断。Describe*Status
Minimal executable quickstart
最小可执行快速入门
Use metadata-first discovery before calling business APIs:
bash
python scripts/list_openapi_meta_apis.pyOptional 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-dlf-manage/如需保存响应或生成的产物,请写入以下路径:
output/aliyun-dlf-manage/Validation
验证
bash
mkdir -p output/aliyun-dlf-manage
for f in skills/data-lake/aliyun-dlf-manage/scripts/*.py; do
python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/aliyun-dlf-manage/validate.txtPass criteria: command exits 0 and is generated.
output/aliyun-dlf-manage/validate.txtbash
mkdir -p output/aliyun-dlf-manage
for f in skills/data-lake/aliyun-dlf-manage/scripts/*.py; do
python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/aliyun-dlf-manage/validate.txt通过标准:命令退出码为0,且生成 文件。
output/aliyun-dlf-manage/validate.txtOutput And Evidence
输出与凭证
- Save artifacts, command outputs, and API response summaries under .
output/aliyun-dlf-manage/ - Include key parameters (region/resource id/time range) in evidence files for reproducibility.
- 将产物、命令输出和API响应摘要保存在 目录下。
output/aliyun-dlf-manage/ - 在凭证文件中包含关键参数(地域/资源ID/时间范围),以便复现操作。
Prerequisites
前提条件
- Configure least-privilege Alibaba Cloud credentials before execution.
- Prefer environment variables: ,
ALIBABACLOUD_ACCESS_KEY_ID, optionalALIBABACLOUD_ACCESS_KEY_SECRET.ALIBABACLOUD_REGION_ID - If region is unclear, ask the user before running mutating operations.
- 执行前请配置最小权限的阿里云凭证。
- 优先使用环境变量:、
ALIBABACLOUD_ACCESS_KEY_ID,可选ALIBABACLOUD_ACCESS_KEY_SECRET。ALIBABACLOUD_REGION_ID - 若地域不明确,在执行变更操作前询问用户。
References
参考资料
- Sources:
references/sources.md
- 来源:
references/sources.md