aliyun-gbi-analytics

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Category: service
分类:service

DataAnalysisGBI

DataAnalysisGBI

Use Alibaba Cloud OpenAPI (RPC) with official SDKs or OpenAPI Explorer to manage resources for DataAnalysisGBI.
通过官方SDK或OpenAPI Explorer调用阿里云OpenAPI(RPC)来管理DataAnalysisGBI的资源。

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:
    DataAnalysisGBI
  • Default API version:
    2024-08-23
  • Use OpenAPI metadata endpoints to list APIs and get schemas (see references).
  • 产品代码:
    DataAnalysisGBI
  • 默认API版本:
    2024-08-23
  • 使用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-gbi-analytics/
如果需要保存响应或生成的产物,请写入到以下路径:
output/aliyun-gbi-analytics/

Validation

验证

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

Output And Evidence

输出与留存凭证

  • Save artifacts, command outputs, and API response summaries under
    output/aliyun-gbi-analytics/
    .
  • Include key parameters (region/resource id/time range) in evidence files for reproducibility.
  • 将产物、命令输出和API响应摘要保存到
    output/aliyun-gbi-analytics/
    目录下。
  • 在凭证文件中包含关键参数(区域/资源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