alicloud-ai-content-aicontent

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Category: service
Category: service

AIContent

AIContent

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

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. 使用查询/列表类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:
    AiContent
  • Default API version:
    20240611
  • Use OpenAPI metadata endpoints to list APIs and get schemas (see references).
  • 产品代码:
    AiContent
  • 默认API版本:
    20240611
  • 使用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前,先通过元数据优先的方式发现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/alicloud-ai-content-aicontent/
若需保存响应结果或生成的文件,请写入以下路径:
output/alicloud-ai-content-aicontent/

References

参考资料

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