Back to Details

alibabacloud-dataworks-data-ops

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

DataWorks Data Operations

DataWorks数据运维

DataWorks Operations Center assistant for task and workflow operations, alert rule creation and management. Supports periodic, manual, and triggered tasks/workflows (excludes real-time/streaming tasks).
DataWorks运维中心助手，用于任务与工作流操作、告警规则创建和管理。 支持周期性、手动和触发式任务/工作流（不包含实时/流式任务）。

Installation

安装

Pre-check: Aliyun CLI >= 3.3.3 required Run 
aliyun version
to verify >= 3.3.3. If not installed or version too low, run 
curl -fsSL https://aliyuncli.alicdn.com/setup.sh | bash
to update, or see references/cli-installation-guide.md for installation instructions.
Pre-check: Aliyun CLI plugin update required [MUST] run 
aliyun configure set --auto-plugin-install true
to enable automatic plugin installation.
[MUST] CLI AI-Mode & User-Agent — Before executing any business CLI command:
bash
aliyun configure ai-mode enable
aliyun configure ai-mode set-user-agent --user-agent "AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops"
aliyun plugin update
After the workflow is complete:
bash
aliyun configure ai-mode disable
前置检查：需Aliyun CLI >= 3.3.3版本 运行
aliyun version
验证版本是否≥3.3.3。若未安装或版本过低， 运行
curl -fsSL https://aliyuncli.alicdn.com/setup.sh | bash
进行更新， 或查看references/cli-installation-guide.md获取安装说明。
前置检查：需更新Aliyun CLI插件 [必须] 运行
aliyun configure set --auto-plugin-install true
启用插件自动安装功能。
[必须] CLI AI模式与User-Agent设置 — 执行任何业务CLI命令前：
bash
aliyun configure ai-mode enable
aliyun configure ai-mode set-user-agent --user-agent "AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops"
aliyun plugin update
工作流执行完成后：
bash
aliyun configure ai-mode disable

Environment Variables

环境变量

The aliyun CLI default timeout may cause indefinite hangs. You [MUST] set the following environment variables before executing any API command:
VariableDescriptionDefault
ALIBABA_CLOUD_CONNECT_TIMEOUT
Connection timeout in milliseconds10000
ALIBABA_CLOUD_READ_TIMEOUT
Read timeout in milliseconds30000
For large-volume queries (e.g., paginated task instance lists with 500+ results), 
ALIBABA_CLOUD_READ_TIMEOUT
may be increased to 60000 ms.
If an API call times out, [MUST] retry once with a doubled read timeout value. If the second attempt also fails, report the timeout to the user and suggest checking network connectivity, project ID validity, or RAM permissions.
No other special environment variable requirements.
Aliyun CLI默认超时时间可能导致无限挂起。执行任何API命令前[必须]设置以下环境变量：
变量名称描述默认值
ALIBABA_CLOUD_CONNECT_TIMEOUT
连接超时时间（毫秒）10000
ALIBABA_CLOUD_READ_TIMEOUT
读取超时时间（毫秒）30000
对于大体积查询（如返回500+结果的分页任务实例列表），可将
ALIBABA_CLOUD_READ_TIMEOUT
增加至60000毫秒。
若API调用超时，[必须]将读取超时时间翻倍后重试一次。若第二次尝试仍失败，需告知用户超时情况，并建议检查网络连接、项目ID有效性或RAM权限。
无其他特殊环境变量要求。

Authentication

身份认证

Pre-check: Alibaba Cloud Credentials Required
Security Rules:
  • NEVER read, echo, or print AK/SK values (e.g., 
    echo $ALIBABA_CLOUD_ACCESS_KEY_ID
    is FORBIDDEN)
  • NEVER ask the user to input AK/SK directly in the conversation or command line
  • NEVER use 
    aliyun configure set
    with literal credential values
  • ONLY use 
    aliyun configure list
    to check credential status
bash
aliyun configure list
Check the output for a valid profile (AK, STS, or OAuth identity).
If no valid profile exists, STOP here.
  1. Obtain credentials from Alibaba Cloud Console
  2. Configure credentials outside of this session (via 
    aliyun configure
    in terminal or environment variables in shell profile)
  3. Return and re-run after 
    aliyun configure list
    shows a valid profile
前置检查：需阿里云凭证
安全规则：
  • 禁止读取、回显或打印AK/SK值（例如
    echo $ALIBABA_CLOUD_ACCESS_KEY_ID
    是违规操作）
  • 禁止要求用户在对话或命令行中直接输入AK/SK
  • 禁止使用
    aliyun configure set
    命令传入明文凭证值
  • 仅允许使用
    aliyun configure list
    检查凭证状态
bash
aliyun configure list
检查输出是否包含有效配置文件（AK、STS或OAuth身份）。
若无有效配置文件，请停止操作。
  1. 从阿里云控制台获取凭证
  2. 在本次会话外配置凭证（通过终端执行
    aliyun configure
    或在Shell配置文件中设置环境变量）
  3. 待
    aliyun configure list
    显示有效配置文件后再返回操作

RAM Permissions

RAM权限

This skill requires the following RAM permissions:
本Skill需要以下RAM权限：

Task Management

任务管理

APIPermission ActionDescription
GetTask
dataworks:GetTask
Get task details
ListTasks
dataworks:ListTasks
Query task list
ListUpstreamTasks
dataworks:ListUpstreamTasks
Query upstream task list
ListDownstreamTasks
dataworks:ListDownstreamTasks
Query downstream task list
ListTaskOperationLogs
dataworks:ListTaskOperationLogs
Query task operation logs
API权限操作描述
GetTask
dataworks:GetTask
获取任务详情
ListTasks
dataworks:ListTasks
查询任务列表
ListUpstreamTasks
dataworks:ListUpstreamTasks
查询上游任务列表
ListDownstreamTasks
dataworks:ListDownstreamTasks
查询下游任务列表
ListTaskOperationLogs
dataworks:ListTaskOperationLogs
查询任务操作日志

Task Instance Management

任务实例管理

APIPermission ActionDescription
ListTaskInstances
dataworks:ListTaskInstances
Query task instance list
GetTaskInstance
dataworks:GetTaskInstance
Get task instance details
GetTaskInstanceLog
dataworks:GetTaskInstanceLog
Get task instance logs
ListUpstreamTaskInstances
dataworks:ListUpstreamTaskInstances
Query upstream task instances
ListDownstreamTaskInstances
dataworks:ListDownstreamTaskInstances
Query downstream task instances
ListTaskInstanceOperationLogs
dataworks:ListTaskInstanceOperationLogs
Query task instance operation logs
API权限操作描述
ListTaskInstances
dataworks:ListTaskInstances
查询任务实例列表
GetTaskInstance
dataworks:GetTaskInstance
获取任务实例详情
GetTaskInstanceLog
dataworks:GetTaskInstanceLog
获取任务实例日志
ListUpstreamTaskInstances
dataworks:ListUpstreamTaskInstances
查询上游任务实例
ListDownstreamTaskInstances
dataworks:ListDownstreamTaskInstances
查询下游任务实例
ListTaskInstanceOperationLogs
dataworks:ListTaskInstanceOperationLogs
查询任务实例操作日志

Workflow (Operations Center, read-only)

工作流（运维中心，只读）

APIPermission ActionDescription
GetWorkflow
dataworks:GetWorkflow
Get workflow details
ListWorkflows
dataworks:ListWorkflows
Query workflow list
API权限操作描述
GetWorkflow
dataworks:GetWorkflow
获取工作流详情
ListWorkflows
dataworks:ListWorkflows
查询工作流列表

Workflow Instance (Operations Center, read-only)

工作流实例（运维中心，只读）

APIPermission ActionDescription
ListWorkflowInstances
dataworks:ListWorkflowInstances
Query workflow instance list
GetWorkflowInstance
dataworks:GetWorkflowInstance
Get workflow instance details
API权限操作描述
ListWorkflowInstances
dataworks:ListWorkflowInstances
查询工作流实例列表
GetWorkflowInstance
dataworks:GetWorkflowInstance
获取工作流实例详情

Alert Rules (Custom Monitoring, read-only)

告警规则（自定义监控，只读）

APIPermission ActionDescription
ListAlertRules
dataworks:ListAlertRules
Query alert rule list
GetAlertRule
dataworks:GetAlertRule
Get alert rule details
[MUST] Permission Failure Handling: When any command or API call fails due to permission errors at any point during execution, follow this process:
  1. Read 
    references/ram-policies.md
    to get the full list of permissions required by this SKILL
  2. Use 
    ram-permission-diagnose
    skill to guide the user through requesting the necessary permissions
  3. Pause and wait until the user confirms that the required permissions have been granted
API权限操作描述
ListAlertRules
dataworks:ListAlertRules
查询告警规则列表
GetAlertRule
dataworks:GetAlertRule
获取告警规则详情
[必须] 权限失败处理流程： 若执行过程中任何命令或API调用因权限错误失败，请遵循以下步骤：
  1. 查看
    references/ram-policies.md
    获取本Skill所需的完整权限列表
  2. 使用
    ram-permission-diagnose
    Skill引导用户申请必要权限
  3. 暂停操作，等待用户确认权限已授予

Parameter Confirmation

参数确认

IMPORTANT: Parameter Confirmation — Before executing any command or API call, ALL user-customizable parameters (e.g., ProjectId, RegionId, bizdate, instance IDs, etc.) MUST be confirmed with the user. Do NOT assume or use default values without explicit user approval.
ParameterRequired/OptionalDescriptionDefault
RegionRequiredTarget regionNone
ProjectIdRequiredDataWorks Workspace IDNone
BizdateRequired (instance-related)Business date (millisecond timestamp)Today's business date
Instance status enum values (used for 
--status
parameter):
  • NotRun
    - Not Run
  • Running
    - Running
  • Failure
    - Failed
  • Success
    - Success
  • WaitTime
    - Waiting for Time
  • WaitResource
    - Waiting for Resources
Workflow instance type enum values (used for 
--type
parameter):
  • Normal
    - Normal Scheduling
  • Manual
    - Manual Run
  • SmokeTest
    - Smoke Test
  • SupplementData
    - Backfill Data
  • ManualWorkflow
    - Manual Workflow
  • TriggerWorkflow
    - Trigger Workflow
重要提示：参数确认 — 执行任何命令或API调用前， 所有用户可自定义参数（如ProjectId、RegionId、bizdate、实例ID等） 必须与用户确认。未经用户明确同意，不得假设或使用默认值。
参数必填/可选描述默认值
Region必填目标地域无
ProjectId必填DataWorks工作空间ID无
Bizdate必填（实例相关操作）业务日期（毫秒时间戳）当日业务日期
实例状态枚举值（用于
--status
参数）：
  • NotRun
    - 未运行
  • Running
    - 运行中
  • Failure
    - 失败
  • Success
    - 成功
  • WaitTime
    - 等待时间
  • WaitResource
    - 等待资源
工作流实例类型枚举值（用于
--type
参数）：
  • Normal
    - 正常调度
  • Manual
    - 手动运行
  • SmokeTest
    - 冒烟测试
  • SupplementData
    - 补数据
  • ManualWorkflow
    - 手动工作流
  • TriggerWorkflow
    - 触发工作流

Core Workflows

核心工作流

0. Confirm Target Region

0. 确认目标地域

Confirm the target region with the user. Common regions:
  • cn-hangzhou
    - East China 1 (Hangzhou)
  • cn-shanghai
    - East China 2 (Shanghai)
  • cn-beijing
    - North China 2 (Beijing)
  • cn-shenzhen
    - South China 1 (Shenzhen)
与用户确认目标地域。常见地域：
  • cn-hangzhou
    - 华东1（杭州）
  • cn-shanghai
    - 华东2（上海）
  • cn-beijing
    - 华北2（北京）
  • cn-shenzhen
    - 华南1（深圳）

Task Management

任务管理

bash
undefined
bash
undefined

Query task list

查询任务列表

aliyun dataworks-public list-tasks
--region <REGION>
--project-id <PROJECT_ID>
[--name <TASK_NAME>]
[--page-size <SIZE>]
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops
aliyun dataworks-public list-tasks
--region <REGION>
--project-id <PROJECT_ID>
[--name <TASK_NAME>]
[--page-size <SIZE>]
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

Get task details

获取任务详情

aliyun dataworks-public get-task
--region <REGION>
--id <TASK_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

> For more command parameters and the full command list, see [references/related-commands.md](references/related-commands.md)

---
aliyun dataworks-public get-task
--region <REGION>
--id <TASK_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

> 更多命令参数及完整命令列表，请查看[references/related-commands.md](references/related-commands.md)

---

Task Instance Management

任务实例管理

bash
undefined
bash
undefined

Query task instance list (filter by status)

查询任务实例列表（按状态过滤）

aliyun dataworks-public list-task-instances
--region <REGION>
--project-id <PROJECT_ID>
--bizdate <BIZDATE_TIMESTAMP>
[--status NotRun|Running|Failure|Success|WaitTime|WaitResource]
[--task-name <TASK_NAME>]
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops
aliyun dataworks-public list-task-instances
--region <REGION>
--project-id <PROJECT_ID>
--bizdate <BIZDATE_TIMESTAMP>
[--status NotRun|Running|Failure|Success|WaitTime|WaitResource]
[--task-name <TASK_NAME>]
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

Get task instance details (use instance ID from list above)

获取任务实例详情（使用上述列表中的实例ID）

aliyun dataworks-public get-task-instance
--region <REGION>
--id <TASK_INSTANCE_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops
aliyun dataworks-public get-task-instance
--region <REGION>
--id <TASK_INSTANCE_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

Get task instance log

获取任务实例日志

aliyun dataworks-public get-task-instance-log
--region <REGION>
--id <TASK_INSTANCE_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

> For more commands (instance details, upstream/downstream instances, operation logs, etc.) see [references/related-commands.md](references/related-commands.md)

---
aliyun dataworks-public get-task-instance-log
--region <REGION>
--id <TASK_INSTANCE_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

> 更多命令（实例详情、上下游实例、操作日志等）请查看[references/related-commands.md](references/related-commands.md)

---

Workflow (Operations Center, read-only)

工作流（运维中心，只读）

bash
undefined
bash
undefined

Query workflow list

查询工作流列表

aliyun dataworks-public list-workflows
--region <REGION>
--project-id <PROJECT_ID>
[--name <WORKFLOW_NAME>]
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops
aliyun dataworks-public list-workflows
--region <REGION>
--project-id <PROJECT_ID>
[--name <WORKFLOW_NAME>]
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

Get workflow details

获取工作流详情

aliyun dataworks-public get-workflow
--region <REGION>
--id <WORKFLOW_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

---
aliyun dataworks-public get-workflow
--region <REGION>
--id <WORKFLOW_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

---

Workflow Instance (Operations Center, read-only)

工作流实例（运维中心，只读）

bash
undefined
bash
undefined

Query workflow instance list

查询工作流实例列表

aliyun dataworks-public list-workflow-instances
--region <REGION>
--project-id <PROJECT_ID>
--biz-date <BIZDATE_TIMESTAMP>
[--type Normal|Manual|SmokeTest|SupplementData|ManualWorkflow|TriggerWorkflow]
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops
aliyun dataworks-public list-workflow-instances
--region <REGION>
--project-id <PROJECT_ID>
--biz-date <BIZDATE_TIMESTAMP>
[--type Normal|Manual|SmokeTest|SupplementData|ManualWorkflow|TriggerWorkflow]
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

Get workflow instance details

获取工作流实例详情

aliyun dataworks-public get-workflow-instance
--region <REGION>
--id <WORKFLOW_INSTANCE_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

---
aliyun dataworks-public get-workflow-instance
--region <REGION>
--id <WORKFLOW_INSTANCE_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

---

Alert Rules (Custom Monitoring, read-only)

告警规则（自定义监控，只读）

bash
undefined
bash
undefined

Query alert rule list

查询告警规则列表

aliyun dataworks-public list-alert-rules
--region <REGION>
--page-number <PAGE_NUMBER>
--page-size <PAGE_SIZE>
[--name <RULE_NAME>]
[--owner <OWNER_UID>]
[--receiver <RECEIVER_UID>]
[--task-ids <ID1> <ID2> ...]
[--types <TYPE1> <TYPE2> ...]
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops
aliyun dataworks-public list-alert-rules
--region <REGION>
--page-number <PAGE_NUMBER>
--page-size <PAGE_SIZE>
[--name <RULE_NAME>]
[--owner <OWNER_UID>]
[--receiver <RECEIVER_UID>]
[--task-ids <ID1> <ID2> ...]
[--types <TYPE1> <TYPE2> ...]
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

Get alert rule details

获取告警规则详情

aliyun dataworks-public get-alert-rule
--region <REGION>
--id <ALERT_RULE_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

---
aliyun dataworks-public get-alert-rule
--region <REGION>
--id <ALERT_RULE_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

---

Command Examples

命令示例

bash
undefined
bash
undefined

Step 1: Query failed task instances

步骤1：查询失败的任务实例

aliyun dataworks-public list-task-instances
--region cn-hangzhou
--project-id 240863
--bizdate 1775404800000
--status Failure
--page-size 100
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops
aliyun dataworks-public list-task-instances
--region cn-hangzhou
--project-id 240863
--bizdate 1775404800000
--status Failure
--page-size 100
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

Step 2: View instance log

步骤2：查看实例日志

aliyun dataworks-public get-task-instance-log
--region cn-hangzhou
--id <INSTANCE_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops
undefined
aliyun dataworks-public get-task-instance-log
--region cn-hangzhou
--id <INSTANCE_ID>
--user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops
undefined

Success Verification

成功验证

  1. Query Verification: 
    ListTaskInstances
    returns a 
    TaskInstances
    list, containing instance ID, status, task name, and other information
  2. Log Verification: 
    GetTaskInstanceLog
    returns a 
    TaskInstanceLog
    field containing log content
For detailed verification steps, see references/verification-method.md
  1. 查询验证：
    ListTaskInstances
    返回
    TaskInstances
    列表，包含实例ID、状态、任务名称等信息
  2. 日志验证：
    GetTaskInstanceLog
    返回包含日志内容的
    TaskInstanceLog
    字段
详细验证步骤，请查看references/verification-method.md

Cleanup

清理操作

This skill does not create resources. No cleanup required.
本Skill不会创建资源，无需执行清理操作。

Best Practices

最佳实践

  1. Business Date Calculation: 
    Bizdate
    is typically the millisecond timestamp for 00:00:00 the day before the scheduling date
  2. Paginated Queries: Use 
    --page-number
    and 
    --page-size
    for pagination, maximum 500 per page
  3. Pre-operation Check: It is recommended to check instance logs first to confirm the status and avoid repeated failures
  1. 业务日期计算：
    Bizdate
    通常为调度日期前一天00:00:00的毫秒时间戳
  2. 分页查询：使用
    --page-number
    和
    --page-size
    进行分页，每页最多500条结果
  3. 操作前检查：建议先查看实例日志确认状态，避免重复失败

References

参考文档

DocumentDescription
references/ram-policies.mdRAM permission policies
references/related-commands.mdCLI command quick reference
references/verification-method.mdSuccess verification methods
related_apis.yamlFull API list
文档描述
references/ram-policies.mdRAM权限策略
references/related-commands.mdCLI命令速查
references/verification-method.md成功验证方法
related_apis.yaml完整API列表