- name
- aliyun-openapi-discovery
- description
- Use when discovering and reconciling Alibaba Cloud product catalogs from Ticket System, Support & Service, and BSS OpenAPI; fetch OpenAPI product/version/API metadata; and summarize API coverage to plan new skills. Use when you need a complete product list, product-to-API mapping, or coverage/gap reports for skill generation.
- version
- 1.0.0
Alibaba Cloud Product + API Discovery
Follow this workflow to collect products, resolve API metadata, and build summaries for skill planning.
Workflow
1) Fetch product lists from the three sources
- Ticket System (ListProducts)
- Support & Service (ListProductByGroup)
- BSS OpenAPI (QueryProductList)
Run the bundled scripts (from this skill folder):
python scripts/products_from_ticket_system.py
python scripts/products_from_support_service.py
python scripts/products_from_bssopenapi.pyProvide required env vars in each script (see references).
2) Merge product lists
python scripts/merge_product_sources.pyThis writes output/product-scan/merged_products.json and .md.
3) Fetch OpenAPI metadata product list
python scripts/products_from_openapi_meta.pyThis writes output/product-scan/openapi-meta/products.json and products_normalized.json.
4) Fetch OpenAPI API docs per product/version
python scripts/apis_from_openapi_meta.pyBy default this can be large. Use filters for dry runs:
OPENAPI_META_MAX_PRODUCTS=10OPENAPI_META_PRODUCTS=Ecs,OnsOPENAPI_META_VERSIONS=2014-05-26
5) Join products with API counts
python scripts/join_products_with_api_meta.py6) Summarize products by category/group
python scripts/summarize_openapi_meta_products.py6) (Optional) Compare products vs existing skills
python scripts/analyze_products_vs_skills.pyOutput discipline
All generated files must go under output/. Do not place temporary files elsewhere.
Validation
mkdir -p output/aliyun-openapi-discovery
for f in skills/platform/openapi/aliyun-openapi-discovery/scripts/*.py; do
python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/aliyun-openapi-discovery/validate.txtPass criteria: command exits 0 and output/aliyun-openapi-discovery/validate.txt is generated.
Output And Evidence
- Save artifacts, command outputs, and API response summaries under
output/aliyun-openapi-discovery/. - Include key parameters (region/resource id/time range) in evidence files for reproducibility.
Prerequisites
- Configure least-privilege Alibaba Cloud credentials before execution.
- Prefer environment variables:
ALICLOUD_ACCESS_KEY_ID,ALICLOUD_ACCESS_KEY_SECRET, optionalALICLOUD_REGION_ID. - If region is unclear, ask the user before running mutating operations.
References
- Product source APIs: see
references/product-sources.md - OpenAPI meta endpoints: see
references/openapi-meta.md