mcpField
A
alibabacloud-dataworks-data-ops

alibabacloud-dataworks-data-ops

github.com/aliyunデータ・データベース281377 回インストール1 日前に更新
リポジトリ

alibabacloud-dataworks-data-ops について

alibabacloud-dataworks-data-opsは、Aliyun CLIでDataWorks Operations Centerを操作するスキルです。データ基盤の運用担当者向けに、タスク、インスタンス、ログ、依存関係を調べます。ワークフローとアラートルールの参照は読み取り専用です。

主な機能

  1. 01タスクとインスタンスの検索
  2. 02インスタンスログと操作履歴の確認
  3. 03上流・下流タスクの検索
  4. 04ワークフローとアラートルールの参照

活用シーン

  1. 01失敗したタスクインスタンスの抽出
  2. 02調査時のインスタンスログ確認
  3. 03ワークフロー実行インスタンスの確認
  4. 04アラートルールの検索

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/aliyun/alibabacloud-aiops-skills --skill alibabacloud-dataworks-data-ops

インストール後、Claude Code で/alibabacloud-dataworks-data-opsを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
acceptance-criteria.md
cli-installation-guide.md
ram-policies.md
related-commands.md
verification-method.md

詳細

DataWorks データ運用

タスクやワークフローの操作、アラートルールの作成と管理に対応する DataWorks オペレーションセンターのアシスタントです。 定期、手動、トリガーによるタスク／ワークフローに対応しています（リアルタイム／ストリーミングタスクは対象外です）。

インストール

事前確認：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-Mode と User-Agent — ビジネス CLI コマンドを実行する前に：

aliyun configure ai-mode enable
aliyun configure ai-mode set-user-agent --user-agent "AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops"
aliyun plugin update

ワークフローの完了後：

aliyun configure ai-mode disable

環境変数

aliyun CLI のデフォルトのタイムアウト設定により、処理が無期限に停止する場合があります。API コマンドを実行する前に、以下の環境変数を[必ず]設定してください。

変数説明デフォルト
ALIBABA_CLOUD_CONNECT_TIMEOUT接続タイムアウト（ミリ秒）10000
ALIBABA_CLOUD_READ_TIMEOUT読み取りタイムアウト（ミリ秒）30000

大量のデータを取得するクエリ（例：500 件以上の結果を含むページネーション付きタスクインスタンス一覧）では、ALIBABA_CLOUD_READ_TIMEOUT を 60000 ms に増やすことができます。

API 呼び出しがタイムアウトした場合は、読み取りタイムアウトの値を 2 倍にして[必ず]一度再試行してください。2 回目も失敗した場合は、タイムアウトが発生したことをユーザーに伝え、ネットワーク接続、プロジェクト ID の有効性、RAM 権限を確認するよう案内してください。

その他に特別な環境変数の要件はありません。

認証

事前確認：Alibaba Cloud の認証情報が必要です

セキュリティルール：

  • AK/SK の値を読み取ったり、エコーしたり、出力したりすることは絶対にしないでください（例：echo $ALIBABA_CLOUD_ACCESS_KEY_ID は禁止です）。
  • 会話やコマンドラインで、ユーザーに AK/SK を直接入力するよう求めることは絶対にしないでください。
  • 認証情報の値を直接指定して aliyun configure set を使用することは絶対にしないでください。
  • 認証情報の状態の確認には、aliyun configure list のみを使用してください。
aliyun configure list

出力を確認し、有効なプロファイル（AK、STS、または OAuth ID）があることを確認してください。

有効なプロファイルがない場合は、ここで停止してください。

  1. Alibaba Cloud Console から認証情報を取得します。
  2. このセッションの外で認証情報を設定します（ターミナルで aliyun configure を実行するか、シェルプロファイルで環境変数を設定します）。
  3. aliyun configure list に有効なプロファイルが表示されたら、戻って再実行します。

RAM 権限

このスキルには、以下の RAM 権限が必要です。

タスク管理
API権限アクション説明
GetTaskdataworks:GetTaskタスクの詳細を取得
ListTasksdataworks:ListTasksタスク一覧を照会
ListUpstreamTasksdataworks:ListUpstreamTasks上流タスク一覧を照会
ListDownstreamTasksdataworks:ListDownstreamTasks下流タスク一覧を照会
ListTaskOperationLogsdataworks:ListTaskOperationLogsタスク操作ログを照会
タスクインスタンス管理
API権限アクション説明
ListTaskInstancesdataworks:ListTaskInstancesタスクインスタンス一覧を照会
GetTaskInstancedataworks:GetTaskInstanceタスクインスタンスの詳細を取得
GetTaskInstanceLogdataworks:GetTaskInstanceLogタスクインスタンスのログを取得
ListUpstreamTaskInstancesdataworks:ListUpstreamTaskInstances上流タスクインスタンス一覧を照会
ListDownstreamTaskInstancesdataworks:ListDownstreamTaskInstances下流タスクインスタンス一覧を照会
ListTaskInstanceOperationLogsdataworks:ListTaskInstanceOperationLogsタスクインスタンス操作ログを照会
ワークフロー（オペレーションセンター、読み取り専用）
API権限アクション説明
GetWorkflowdataworks:GetWorkflowワークフローの詳細を取得
ListWorkflowsdataworks:ListWorkflowsワークフローの一覧を照会
ワークフローインスタンス（オペレーションセンター、読み取り専用）
API権限アクション説明
ListWorkflowInstancesdataworks:ListWorkflowInstancesワークフローインスタンスの一覧を照会
GetWorkflowInstancedataworks:GetWorkflowInstanceワークフローインスタンスの詳細を取得
アラートルール（カスタムモニタリング、読み取り専用）
API権限アクション説明
ListAlertRulesdataworks:ListAlertRulesアラートルールの一覧を照会
GetAlertRuledataworks:GetAlertRuleアラートルールの詳細を取得

[MUST] 権限エラーへの対応： 実行中にコマンドまたは API 呼び出しが権限エラーで失敗した場合は、次の手順に従ってください。

  1. references/ram-policies.md を読み、この SKILL に必要な権限の一覧をすべて確認します
  2. ram-permission-diagnose スキルを使用して、必要な権限を申請する手順をユーザーに案内します
  3. 必要な権限が付与されたことをユーザーが確認するまで待ちます

パラメーターの確認

重要：パラメーターの確認 — コマンドまたは API 呼び出しを実行する前に、 ユーザーがカスタマイズ可能なすべてのパラメーター（例：ProjectId、RegionId、bizdate、インスタンス ID など）を 必ずユーザーに確認してください。明示的な承認なしに値を推測したり、デフォルト値を使用したりしないでください。

パラメーター必須／任意説明デフォルト
Region必須対象リージョンなし
ProjectId必須DataWorks ワークスペース IDなし
Bizdate必須（インスタンス関連）業務日付（ミリ秒単位のタイムスタンプ）今日の業務日付

インスタンスステータスの列挙値（--status パラメーターで使用）：

  • NotRun - 未実行
  • Running - 実行中
  • Failure - 失敗
  • Success - 成功
  • WaitTime - 実行時刻待ち
  • WaitResource - リソース待ち

ワークフローインスタンスタイプの列挙値（--type パラメーターで使用）：

  • Normal - 通常スケジュール
  • Manual - 手動実行
  • SmokeTest - スモークテスト
  • SupplementData - データ補完
  • ManualWorkflow - 手動ワークフロー
  • TriggerWorkflow - トリガーワークフロー

コアワークフロー

0. 対象リージョンの確認

対象リージョンをユーザーに確認します。一般的なリージョン：

  • cn-hangzhou - 中国東部 1（杭州）
  • cn-shanghai - 中国東部 2（上海）
  • cn-beijing - 中国北部 2（北京）
  • cn-shenzhen - 中国南部 1（深圳）
タスク管理
# 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

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

コマンドのパラメーターとコマンド一覧については、references/related-commands.md を参照してください

タスクインスタンス管理
# 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

# Get task instance details (use instance ID from list above)
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

その他のコマンド（インスタンスの詳細、上流／下流インスタンス、操作ログなど）については、references/related-commands.md を参照してください

ワークフロー（オペレーションセンター、読み取り専用）
# 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

# Get workflow details
aliyun dataworks-public get-workflow \
  --region <REGION> \
  --id <WORKFLOW_ID> \
  --user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops
ワークフローインスタンス（オペレーションセンター、読み取り専用）
# 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

# 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
アラートルール（カスタムモニタリング、読み取り専用）
# 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

# 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
コマンド例
# Step 1: Query failed task instances
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
aliyun dataworks-public get-task-instance-log \
  --region cn-hangzhou \
  --id <INSTANCE_ID> \
  --user-agent AlibabaCloud-Agent-Skills/alibabacloud-dataworks-data-ops

成功の確認

  1. クエリの確認：ListTaskInstances が TaskInstances リストを返し、インスタンス ID、ステータス、タスク名などの情報が含まれていること
  2. ログの確認：GetTaskInstanceLog がログ内容を含む TaskInstanceLog フィールドを返すこと

詳細な確認手順については、references/verification-method.md を参照してください。

クリーンアップ

このスキルではリソースを作成しません。クリーンアップは不要です。

ベストプラクティス

  1. 業務日付の計算：Bizdate は通常、スケジュール日付の前日の 00:00:00 を示すミリ秒単位のタイムスタンプです
  2. ページネーションを使用したクエリ：ページネーションには --page-number と --page-size を使用します。1 ページあたり最大 500 件です
  3. 操作前の確認：ステータスを確認し、失敗の繰り返しを避けるため、まずインスタンスログを確認することをおすすめします

参考資料

ドキュメント説明
references/ram-policies.mdRAM 権限ポリシー
references/related-commands.mdCLI コマンドのクイックリファレンス
references/verification-method.md成功確認の方法
related_apis.yamlAPI の全一覧

コメント

Markdown 対応