API の概要 - DataWorks - Alibaba Cloud ドキュメントセンター

API 標準および多言語対応の SDK

本製品 (dataworks-public/2024-05-18) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。

カスタム署名

署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。

はじめに

Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。

API セキュリティを確保するには、以下を作成し、設定する必要があります。

RAM ユーザー
RAM ユーザー用の AccessKey ペア

Data Agent

API	タイトル	説明
MCP サーバー管理	MCP サーバー管理
CreateMcpServer	CreateMcpServer	MCPサーバーを作成します。
DeleteMcpServer	MCP サーバーを削除します	MCP サーバーを削除します。
UpdateMcpServer	UpdateMcpServer	MCP Server を更新します。
GetMcpServer	GetMcpServer	MCP Server の詳細を返します。
ListMcpServers	ListMcpServers	MCPサーバーのページネーション付きリストを取得します。
スキル管理	スキル管理
DeleteSkill	Delete Skill	スキルを削除します。
GetSkill	GetSkill	指定されたスキルの詳細を名前で取得します。SKILL.md ファイルの本文やバンドルのダウンロードリンクを含みます。
ListSkills	ListSkills	アカウント内のSkillを一覧表示します。
エージェント管理	エージェント管理
CreateAgent	エージェントの作成	エージェントの作成
ListCustomAgents	ListCustomAgents	カスタムエージェントのページネーション付きリストを取得します。
GetAgent	GetAgent	名前でエージェントの詳細を取得します。
ListAgents	ListAgents	現在のテナントのエージェントを一覧表示し、名前によるフィルタリングとページネーションにも対応しています。
エージェント会話管理	エージェント会話管理
PromptAgentSession	PromptAgentSession	既存のセッションにプロンプトを送信し、エージェントの応答をストリーミングします。
LoadAgentSession	LoadAgentSession	既存のセッションのメッセージ履歴をロードし、SSE ストリームとして返します。セッションが存在しない場合、サーバーは SSE ストリームを通じてコード 400 の JSONRPCResponse.error を送信します。Content-Type は text/event-stream です。この操作を使用して、セッションコンテキストを復元します。
ListAgentSessions	ListAgentSessions	エージェントセッションの会話履歴を取得します。
ListAgentSessionArtifacts	ListAgentSessionArtifacts	指定されたセッションからアーティファクトのリストを取得します。
GetAgentSessionTokenUsage	GetAgentSessionTokenUsage	指定されたセッションの AI トークン使用量を累計で取得します。
GetAgentSessionArtifactMeta	GetAgentSessionArtifactMeta	セッション ID およびアーティファクトパスに基づき、アーティファクトのメタデータとコンテンツを取得します。
CreateAgentSession	CreateAgentSession	新しいエージェントセッションを作成し、セッション ID を返します。
CancelAgentSession	CancelAgentSession	指定されたセッション内のエージェント呼び出しをキャンセルします。この操作は、ストリーミング応答の中断にも対応しています。

スペース管理

API	タイトル	説明
ワークスペース	ワークスペース
CreateProject	CreateProject	ワークスペースを作成します。
DeleteProject	DeleteProject	DataWorks ワークスペースを削除します。
UpdateProject	UpdateProject	この操作では、DataWorks ワークスペースを更新します。
ListProjects	ListProjects	ご利用のアカウントが所属するテナントの DataWorks ワークスペース一覧を照会します。
GetProject	GetProject	DataWorks ワークスペースの情報を照会します。
スペースロール	スペースロール
CreateProjectRole	CreateProjectRole	ワークスペースのカスタムロールを作成します。
DeleteProjectRole	DeleteProjectRole	ワークスペースからカスタムロールを削除します。
UpdateProjectRole	UpdateProjectRole	ワークスペース内のカスタムロールの権限を更新します。
GetProjectRole	GetProjectRole	ワークスペースロールの詳細を照会します。
ListProjectRoles	ListProjectRoles	ワークスペース内のロールのページ分割されたリストを返します。
スペースメンバー	スペースメンバー
CreateProjectMember	CreateProjectMember	ワークスペースメンバーを追加し、ワークスペースレベルのロールをそのメンバーに割り当てます。
DeleteProjectMember	DeleteProjectMember	ワークスペースのメンバーおよびそのメンバーに割り当てられたワークスペースレベルのロールを削除します。
GrantMemberProjectRoles	GrantMemberProjectRoles	ワークスペースのメンバーにロールを割り当てます。
RevokeMemberProjectRoles	RevokeMemberProjectRoles	ワークスペース内のメンバーに割り当てられたロールを取り消します。
GetProjectMember	GetProjectMember	ワークスペース内の特定のメンバーの詳細情報を取得します。
ListProjectMembers	ListProjectMembers	ワークスペースメンバーの詳細のページングされたリストを取得します。

データソース

API	タイトル	説明
UpdateDataSource	UpdateDataSource	ID を指定してデータソースを更新します。
TestDataSourceConnectivity	TestDataSourceConnectivity	リソースグループ上のデータソースのネットワーク接続性をテストします。
CreateDataSource	CreateDataSource	ワークスペースの開発環境または本番環境にデータソースを追加します。
DeleteDataSource	DeleteDataSource	ID を指定してデータソースを削除します。
CloneDataSource	CloneDataSource	既存のデータソースをクローンします。
ListDataSources	ListDataSources	データソースのビジネス情報を基に、データソースの一覧をクエリします。
データソース共有ルール	データソース共有ルール
CreateDataSourceSharedRule	CreateDataSourceSharedRule	他のワークスペースまたは RAM ユーザーへデータソースを共有するためのルールを作成します。
DeleteDataSourceSharedRule	DeleteDataSourceSharedRule	ID に基づいてデータソースの共有ルールを削除します。
ListDataSourceSharedRules	ListDataSourceSharedRules	データソースの共有ルールの一覧を照会します。

計算リソース

API	タイトル	説明
DeleteComputeResource	DeleteComputeResource	指定されたコンピューティングリソース ID を基に、該当のコンピューティングリソースを削除します。
GetComputeResource	GetComputeResource	指定されたコンピューティングリソース ID を基に、該当のコンピューティングリソースを照会します。
UpdateComputeResource	UpdateComputeResource	コンピューティングリソース ID に基づいて、指定されたコンピューティングリソースを変更します。
ListComputeResources	ListComputeResources	指定されたビジネス情報に一致する計算リソースのリストを照会します。
CreateComputeResource	CreateComputeResource	指定されたワークスペース内にコンピューティングリソースを作成します。このリソースは開発環境または本番環境用です。

リソースグループ管理

API	タイトル	説明
リソースグループ	リソースグループ
CreateResourceGroup	CreateResourceGroup	リソースグループを作成します。
DeleteResourceGroup	DeleteResourceGroup	リソースグループを削除します。
UpdateResourceGroup	UpdateResourceGroup	リソースグループの基本情報を更新します。
GetResourceGroup	GetResourceGroup	リソースグループの ID を指定して、そのリソースグループの情報を照会します。
ListResourceGroups	ListResourceGroups	リソースグループのリストを取得します。
DissociateProjectFromResourceGroup	DissociateProjectFromResourceGroup	ワークスペースからリソースグループの関連付けを解除します。
AssociateProjectToResourceGroup	AssociateProjectToResourceGroup	リソースグループを DataWorks ワークスペース (プロジェクト) に関連付けます。
ListResourceGroupAssociateProjects	ListResourceGroupAssociateProjects	リソースグループが関連付けられているワークスペースのリストを照会します。
ListResourceGroupMetricData	ListResourceGroupMetricData	リソースグループのメトリックデータを照会します。
ルート	ルート
CreateRoute	CreateRoute	ネットワークのルートを作成します。
DeleteRoute	DeleteRoute	ネットワークリソースからルートを削除します。
UpdateRoute	UpdateRoute	ルートに関する情報を更新します。
GetRoute	GetRoute	指定された ID を基に、ルートの情報を照会します。
ListRoutes	ListRoutes	ネットワークリソースのルート一覧を照会します。
ネットワーク	ネットワーク
CreateNetwork	CreateNetwork	ネットワークを作成し、そのネットワークを汎用リソースグループに関連付けます。
DeleteNetwork	DeleteNetwork	一般リソースグループからネットワークの関連付けを解除し、削除します。
GetNetwork	GetNetwork	ネットワークリソースの情報を照会します。
ListNetworks	ListNetworks	サーバーレスリソースグループのネットワークリソース一覧を照会します。

イメージ管理

API	タイトル	説明
GetImage	GetImage	ID に基づいてイメージの詳細を取得します。
ListImages	ListImages	イメージのリストを取得します。
ListImageVersions	ListImageVersions	指定されたイメージバージョンの詳細を取得します。
AssociateProjectToImage	AssociateProjectToImage	イメージをワークスペースに関連付けます。
DissociateProjectFromImage	DissociateProjectFromImage	イメージとワークスペースの関連付けを解除します。
ListImageAssociatedProjects	ListImageAssociatedProjects	イメージに関連付けられているワークスペースを一覧表示します。

データ開発 (新バージョン)

API	タイトル	説明
コンポーネント	コンポーネント
CreateComponent	CreateComponent	コンポーネントを作成します。
DeleteComponent	DeleteComponent	コンポーネントを削除します。
GetComponent	GetComponent	コンポーネント情報を取得します。
UpdateComponent	UpdateComponent	コンポーネントを更新します。
ListComponents	ListComponents	コンポーネントの一覧を取得します。
ノード	ノード
CreateNode	CreateNode	DataStudio でノードを作成します。ノードの情報は FlowSpec を使用して記述されます。
DeleteNode	DeleteNode	DataStudio からノードを削除します。
UpdateNode	UpdateNode	DataStudio のノードに関する基本情報を更新します。この API オペレーションは増分更新を実行します。更新情報は FlowSpec を使用して記述されます。
MoveNode	MoveNode	DataStudio でノードを指定されたパスに移動します。
RenameNode	RenameNode	DataStudio 内のノード名を変更します。
GetNode	GetNode	DataStudio 内のノード情報をクエリします。
ListNodes	ListNodes	指定された条件でフィルター処理可能な、データ開発ノードのページングされたリストを取得します。
ListNodeDependencies	ListNodeDependencies	指定されたデータ開発ノードの依存ノードの一覧をページネーション形式で取得します。
ワークフロー定義	ワークフロー定義
CreateWorkflowDefinition	CreateWorkflowDefinition	DataStudio のディレクトリにワークフローを作成します。
ImportWorkflowDefinition	DataStudio ワークフローをインポートします。	FlowSpec で定義されたワークフローノードとその子ノードを DataStudio にインポートします。
DeleteWorkflowDefinition	DeleteWorkflowDefinition	DataStudio からワークフローを削除します。
UpdateWorkflowDefinition	UpdateWorkflowDefinition	DataStudio のワークフローに関する基本情報を更新します。この API オペレーションは、増分更新を実行します。更新情報は FlowSpec を使用して記述されます。
MoveWorkflowDefinition	MoveWorkflowDefinition	ワークフローを DataStudio のパスに移動します。
RenameWorkflowDefinition	RenameWorkflowDefinition	DataStudio におけるワークフローの名前を変更します。
GetWorkflowDefinition	GetWorkflowDefinition	ワークフローの情報を照会します。
ListWorkflowDefinitions	ListWorkflowDefinitions	DataStudio のワークフローのリストをクエリします。特定のワークフローをクエリするために、フィルター条件を指定することもできます。
リソース	リソース
CreateResource	CreateResource	\\> この API オペレーションでは、一度に複数のファイルリソースを作成することはできません。FlowSpec を使用して複数のファイルリソースを指定した場合、システムは最初に指定されたリソースのみを作成します。
DeleteResource	DeleteResource	DataStudio からファイルリソースを削除します。
UpdateResource	UpdateResource	DataStudio のファイルリソースの基本情報を更新します。この API オペレーションは増分更新を実行します。更新情報は FlowSpec を使用して記述されます。
GetResource	GetResource	ファイルリソースの情報を照会します。
ListResources	ListResources	DataStudio のファイルリソースのリストを照会します。特定のファイルリソースを照会するために、フィルター条件を指定することもできます。
MoveResource	MoveResource	DataStudio 内のパスへファイルリソースを移動します。
RenameResource	RenameResource	DataStudio におけるファイルリソースの名前変更
関数	関数
CreateFunction	CreateFunction	DataStudio でユーザー定義関数 (UDF) を作成します。UDF の情報は FlowSpec を使用して記述されます。
DeleteFunction	DeleteFunction	DataStudio のユーザー定義関数 (UDF) を削除します。
UpdateFunction	UpdateFunction	DataStudio におけるユーザー定義関数 (UDF) の基本情報を更新します。この API オペレーションは増分更新を実行します。更新内容は FlowSpec を使用して記述されます。
MoveFunction	MoveFunction	ユーザー定義関数 (UDF) を DataStudio のパスに移動します。
RenameFunction	RenameFunction	DataStudio におけるユーザー定義関数 (UDF) の名前を変更します。
GetFunction	GetFunction	DataStudio におけるユーザー定義関数 (UDF) の情報を照会します。
ListFunctions	ListFunctions	DataStudio でユーザー定義関数 (UDF) の一覧を照会します。また、フィルター条件を指定して特定の UDF を検索することもできます。
公開プロセス	公開プロセス
CreatePipelineRun	デプロイワークフローを作成します。	新バージョンの DataStudio でエンティティの Deployment ワークフローを作成します。
AbolishPipelineRun	AbolishPipelineRun	指定されたデプロイメントプロセスを終了します。この操作により、プロセスのステータスは「Terminated（終了）」に変更されますが、プロセス自体は削除されません。その後も、プロセスのクエリは可能です。
ExecPipelineRunStage	ExecPipelineRunStage	プロセス内のステージを実行します。
GetPipelineRun	GetPipelineRun	デプロイメントプロセスの詳細情報を取得します。
ListPipelineRuns	ListPipelineRuns	デプロイメントプロセスのページ分割されたリストを取得します。特定の基準に基づいてこのリストをフィルターすることもできます。
ListPipelineRunItems	ListPipelineRunItems	デプロイメントプロセス ID を指定して、デプロイメント対象の情報を照会します。

データ開発 (レガシ)

API	タイトル	説明
ファイル	ファイル
CreateFile	CreateFile	DataStudio でファイルを作成します。この操作では、Data Integration ノードの作成はできません。
CreateResourceFile	CreateResourceFile	DataWorks のデータ開発向けリソースファイルを作成する際に、ユーザーが自身のファイル（JAR、PY、アーカイブ、または通常のファイルなど）を指定できるようにサポートします。
CreateUdfFile	CreateUdfFile	DataStudio で関数用のファイルを作成します。
UpdateFile	UpdateFile	ファイルを更新します。
UpdateUdfFile	UpdateUdfFile	関数のファイル情報を更新します。
GetFile	GetFile	この API は、ファイルの詳細を取得するために使用されます。
ListFiles	ListFiles	ファイルの一覧を照会します。
SubmitFile	SubmitFile	ファイルをスケジューリングシステムの開発環境にコミットして、タスクを生成します。
DeployFile	DeployFile	ファイルを本番環境にデプロイします。
フォルダ	フォルダ
CreateFolder	CreateFolder	フォルダを作成します。
DeleteFolder	DeleteFolder	Data Development ページでフォルダを削除するには、DeleteFolder を呼び出します。
UpdateFolder	UpdateFolder	UpdateFolder を呼び出して、フォルダ情報を更新します。
GetFolder	GetFolder	フォルダの情報を照会します。
ListFolders	ListFolders	フォルダの一覧をクエリします。
ビジネスプロセス	ビジネスプロセス
CreateBusiness	CreateBusiness	DataStudio でワークフローを作成します。
DeleteBusiness	DeleteBusiness	ワークフローを削除します。
UpdateBusiness	UpdateBusiness	ワークフローを更新します。
GetBusiness	GetBusiness	ワークフローの情報をクエリします。
ListBusiness	ListBusiness	ワークフローのリストを照会します。
公開パッケージ	公開パッケージ
GetDeploymentPackage	GetDeploymentPackage	デプロイメントパッケージの情報を照会します。
ListDeploymentPackages	ListDeploymentPackages	デプロイメントパッケージの一覧をクエリします。
ListDeploymentPackageFiles	ListDeploymentPackageFiles	デプロイされるファイルのバージョンリストをクエリします。
ファイルバージョン	ファイルバージョン
GetFileVersion	GetFileVersion	GetFileVersion を呼び出して、ファイルのバージョン情報を取得します。
ListFileVersions	ListFileVersions	ファイルのバージョン一覧をクエリします。
拡張ポイントイベント	拡張ポイントイベント
UpdateIDEEventResult	UpdateIDEEventResult	拡張ポイントイベントのメッセージのチェック結果を取得します。
GetIDEEventDetail	GetIDEEventDetail	DataWorks OpenEvent のメッセージ ID を指定して、関連する拡張ポイントイベントがトリガーされた際に生成される拡張ポイントのデータスナップショットを照会します。
テーブル	テーブル
EstablishRelationTableToBusiness	EstablishRelationTableToBusiness	テーブルをワークフローにインポートします。この API オペレーションの呼び出しは、以下の操作と同等です：DataStudio ページに移動し、目的のワークフローを見つけ、ワークフロー名をクリックします。その後、目的のフォルダ内の [テーブル] を右クリックして、[テーブルのインポート] を選択します。

Data Integration

API	タイトル	説明
同期タスク	同期タスク
CreateDIJob	CreateDIJob	データ統合タスクの新しいバージョンを作成します。
UpdateDIJob	UpdateDIJob	データ統合タスクを更新します。
DeleteDIJob	DeleteDIJob	新バージョンの同期タスクを削除します。
StopDIJob	StopDIJob	同期タスクを停止します。
StartDIJob	StartDIJob	新バージョンの同期タスクを開始します。
GetDIJob	GetDIJob	データ統合タスクを表示します。
GetDIJobLog	GetDIJobLog	同期タスクで生成されたログを取得します。
ListDIJobs	ListDIJobs	データ統合ジョブを一覧表示します。
ListDIJobRunDetails	ListDIJobRunDetails	同期タスクの実行情報を照会します。
ListDIJobMetrics	ListDIJobMetrics	同期タスクのメトリックをクエリします。
ListDIJobEvents	ListDIJobEvents	同期タスクのイベントを照会します。
タスクアラート	タスクアラート
CreateDIAlarmRule	CreateDIAlarmRule	同期タスク向けのアラートルールを作成します。
UpdateDIAlarmRule	UpdateDIAlarmRule	同期タスクに対して設定されたアラートルールを更新します。
DeleteDIAlarmRule	DeleteDIAlarmRule	同期タスクに設定されたアラートルールを削除します。
ListDIAlarmRules	ListDIAlarmRules	同期タスクに設定されたアラートルールを表示します。

データマップ

API	タイトル	説明
カスタムプロパティ	カスタムプロパティ
ListCustomAttributes	ListCustomAttributes	カスタム属性定義のリストを取得します。
GetCustomAttribute	GetCustomAttribute	カスタム属性の定義を取得します。
CreateCustomAttribute	CreateCustomAttribute	カスタム属性の解像度を作成します。
UpdateCustomAttribute	UpdateCustomAttribute	カスタム属性を更新します。
DeleteCustomAttribute	DeleteCustomAttribute	カスタム属性解像度を削除します。
カスタムメタデータエンティティ定義	カスタムメタデータエンティティ定義
ListMetaEntityDefs	ListMetaEntityDefs	カスタムエンティティタイプや拡張テーブルタイプを含む、カスタムエンティティ解像度のリストを取得します。
GetMetaEntityDef	GetMetaEntityDef	カスタムエンティティ解像度の詳細を取得します。
CreateMetaEntityDef	CreateMetaEntityDef	メタデータエンティティ定義を作成します。定義は、純粋なカスタム型または拡張テーブル型のいずれかになります。
UpdateMetaEntityDef	UpdateMetaEntityDef	メタエンティティ定義を更新します。この操作は、カスタムエンティティタイプと拡張テーブルエンティティタイプの両方をサポートします。
DeleteMetaEntityDef	DeleteMetaEntityDef	純粋なカスタムタイプおよび拡張テーブルタイプを含む、メタデータエンティティ定義を削除します。
メタデータコレクタータイプ	メタデータコレクタータイプ
ListCrawlerTypes	ListCrawlerTypes	Data Map でサポートされるメタデータクローラーの種類の一覧を照会します。また、各種類のサブタイプおよびサブタイプ間の階層関係も返されます。
メタデータエンティティ	メタデータエンティティ
カスタムエンティティ	カスタムエンティティ
ListMetaEntities	ListMetaEntities	メタデータエンティティの一覧を取得します。現在はカスタムタイプのみサポートされています。
GetMetaEntity	GetMetaEntity	カスタムエンティティの詳細を取得します。
BatchCreateMetaEntities	BatchCreateMetaEntities	メタデータエンティティをバッチで作成します。バッチ内のすべてのエンティティは同じエンティティタイプである必要があります。この操作は現在、カスタムタイプと拡張テーブルタイプ（データベースとテーブルを表す）のみをサポートしています。
UpdateMetaEntity	UpdateMetaEntity	メタデータエンティティを更新します。カスタムエンティティや、データベース、テーブル、カラムなどの拡張テーブルタイプのオブジェクトを更新できます。
BatchDeleteMetaEntities	BatchDeleteMetaEntities	メタエンティティを一括で削除します。この操作では、カスタムメタエンティティ、およびデータベースやテーブルなどのテーブルベースの拡張オブジェクトを削除します。カラムを個別に削除することはできません。関連するカラムを削除するには、テーブル全体を削除する必要があります。
データカタログ	データカタログ
ListCatalogs	ListCatalogs	Data Map におけるカタログの一覧をクエリします。対応しているのは、Data Lake Formation (DLF) 型および StarRocks メタデータクローラー型のカタログのみです。DLF メタデータクローラー型の場合、すべてのサポート対象データカタログが返されます。StarRocks メタデータクローラー型の場合、特定のインスタンスに属するデータカタログが返されます。
GetCatalog	GetCatalog	Data Map におけるカタログの情報を照会します。対応しているのは、Data Lake Formation (DLF) および StarRocks メタデータクローラーのカタログのみです。
データベース	データベース
ListDatabases	ListDatabases	Data Map で、インスタンス、クラスター、またはデータカタログ内のデータベース一覧をクエリします。DLF または StarRocks データソースの場合、この API オペレーションを呼び出してデータカタログ内のデータベースをクエリできます。StarRocks データソースの場合、内部カタログ（Internal catalog）内のデータベースをクエリできます。その他のタイプのデータソースでは、インスタンスまたはクラスター内のデータベースをクエリできます。
GetDatabase	GetDatabase	データマップ内の特定のデータベースに関する情報を照会します。
スキーマ	スキーマ
ListSchemas	ListSchemas	Data Map で指定されたデータベースまたは MaxCompute プロジェクト配下のスキーマ一覧をクエリします。現在、MaxCompute および Hologres 型に対応しています。
GetSchema	GetSchema	Data Map 内のスキーマ情報をクエリします。この API オペレーションを呼び出すことで、MaxCompute および Hologres のスキーマ情報のみをクエリできます。
データテーブル	データテーブル
ListTables	データマップのデータテーブルをクエリします	DataWorks データマップのデータテーブルのリストをクエリします。スキーマレベルをサポートしないタイプの場合、指定されたデータベース配下のデータテーブルをクエリできます。スキーマレベルをサポートするタイプの場合、指定されたデータベース、MaxCompute プロジェクト、またはスキーマ配下のデータテーブルをクエリできます。応答には基本的なテーブル情報のみが含まれ、技術メタデータやビジネスメタデータは含まれません。
GetTable	データマップのデータテーブル詳細を取得します。	DataWorks データマップ内の指定されたデータテーブルの詳細を取得します。ビジネスメタデータを返すかどうかを指定できます。
UpdateTableBusinessMetadata	UpdateTableBusinessMetadata	データマップ内のデータテーブルのビジネスメタデータを更新します。更新できるのは、テーブルの Readme とカスタム属性のみです。
フィールド	フィールド
ListColumns	データマップでデータテーブルのカラムを照会します。	DataWorks データマップで指定されたデータテーブルのカラムリストを照会します。
GetColumn	データマップテーブルのカラム情報を取得します。	データマップテーブルの指定されたカラムの詳細を取得します。
UpdateColumnBusinessMetadata	UpdateColumnBusinessMetadata	データマップ内の列のビジネスメタデータを更新します。このオペレーションでは、ビジネス記述とカスタム属性のみを更新できます。
データセット	データセット
ListDatasets	ListDatasets	データセットの一覧を照会します。現在、DataWorks データセットおよび PAI データセットがサポートされています。
GetDataset	GetDataset	データセットの詳細を取得します。
CreateDataset	CreateDataset	データセットを作成します。この操作は、ユーザーが参加しているワークスペースでのみサポートされます。現在、DataWorks データセットのみがサポートされています。テナントあたりのデータセット作成可能数の上限は 2,000 個です。
UpdateDataset	UpdateDataset	データセットの情報を更新します。対象は DataWorks データセットのみです。実行者は、当該データセットの作成者または、データセットが配置されているワークスペースの管理者である必要があります。
DeleteDataset	DeleteDataset	データセットを削除します。対応しているのは DataWorks のみのデータセットです。この操作は、関連付けられたすべてのデータセットバージョンをカスケード削除します。実行には、データセットの作成者またはワークスペース管理者権限が必要です。
データセットバージョン	データセットバージョン
ListDatasetVersions	ListDatasetVersions	指定されたデータセットのバージョン一覧を取得します。
GetDatasetVersion	GetDatasetVersion	指定されたデータセットバージョンの情報を取得します。
CreateDatasetVersion	CreateDatasetVersion	データセットバージョンを作成します。現在、DataWorks データセットのみをサポートしており、最大 20 バージョンまで作成できます。
UpdateDatasetVersion	UpdateDatasetVersion	データセットのバージョン情報を更新します。DataWorks データセットのみがサポートされています。データセットの作成者またはワークスペース管理者の権限が必要です。
DeleteDatasetVersion	DeleteDatasetVersion	データセットのバージョンを削除します。v1 以外の DataWorks データセットのみがサポートされます。v1 データセットを削除する場合は、DeleteDataset 操作をご利用ください。データセットの作成者またはワークスペース管理者権限が必要です。
PreviewDatasetVersion	PreviewDatasetVersion	指定されたデータセットバージョンのコンテンツをプレビューします。現在、OSS タイプのデータセットではテキストファイルのプレビューのみがサポートされています。サポートされている MIME タイプ：1. application/json 2. application/xml 3. text/html 4. text/plain 5. application/octet-stream
パーティション	パーティション
ListPartitions	ListPartitions	データマップ内のテーブルに登録されたパーティションの一覧を取得します。対応しているのは、MaxCompute および E-MapReduce (EMR) 型 Hive Metastore Service (HMS) メタデータクローラーが対象とするテーブルのみです。
GetPartition	GetPartition	データマップテーブルのパーティション詳細を取得します。現在は MaxCompute および HMS（EMR クラスター）タイプのみ対応しています。
リネージ	リネージ
ListLineageRelationships	ListLineageRelationships	テーブル、カラム、OSS オブジェクトなどの指定されたエンティティ間のデータリネージ関係についてデータマップをクエリします。
GetLineageRelationship	GetLineageRelationship	データマップ内の特定のリネージ関係の詳細を取得します。
DeleteLineageRelationship	DeleteLineageRelationship	データマップ内のリネージを削除します。
CreateLineageRelationship	データマップにデータリネージ関係を登録します	DataWorks データマップにデータリネージ関係を登録します。この操作を使用して、DataWorks が管理するメタデータエンティティ間のリネージ関係を確立できます。テーブル間、カラム間、テーブルとカラム間、データセットとテーブル間のシナリオに対応しています。また、管理対象エンティティとユーザーが登録したカスタムエンティティオブジェクト間のリネージ関係も確立できます。この操作は非管理カスタムオブジェクトと互換性がありますが、このアプローチは推奨されなくなりました。この操作を呼び出す前に、リネージ登録に関連する管理対象エンティティが DataWorks プラットフォーム上に既に存在していることを確認してください。
ListLineages	ListLineages	データマップ内の指定されたエンティティの上流および下流のエンティティを照会します。オプションで、詳細なリネージ関係情報を含めることができます。
メタデータコレクション	メタデータコレクション
ListMetaCollections	ListMetaCollections	Data Map におけるコレクションの一覧を照会します。コレクションにはカテゴリおよびデータアルバムが含まれます。
CreateMetaCollection	CreateMetaCollection	データマップにコレクションを作成します。コレクションには、カテゴリ、サブカテゴリ、データアルバム、およびデータアルバム内に作成されるカテゴリが含まれます。
GetMetaCollection	GetMetaCollection	Data Map のコレクションに関する情報を照会します。コレクションにはカテゴリおよびデータアルバムが含まれます。
UpdateMetaCollection	UpdateMetaCollection	Data Map のコレクションオブジェクト（データマップカテゴリおよびデータアルバム）を更新します。コレクション名、説明文、管理者情報を変更できます。データアルバムを更新する場合、呼び出し元は `AliyunDataWorksFullAccess` 権限を持つユーザーであるか、当該アルバムの作成者または管理者である必要があります。
DeleteMetaCollection	DeleteMetaCollection	指定されたデータマップ内のコレクションオブジェクト（データマップのカテゴリおよびデータアルバムを含む）を削除します。データアルバムを削除する場合、呼び出し元は AliyunDataWorksFullAccess 権限を持つユーザーであるか、アルバムの作成者または管理者である必要があります。
ListEntitiesInMetaCollection	ListEntitiesInMetaCollection	Data Map 内のコレクションに登録されたエンティティの一覧を照会します。コレクションにはカテゴリおよびデータアルバムが含まれます。エンティティとしてサポートされるのはテーブルのみです。
AddEntityIntoMetaCollection	AddEntityIntoMetaCollection	データマップのコレクションにエンティティを追加します。コレクションには、カテゴリとデータアルバムが含まれます。エンティティはテーブルのみです。データアルバムにエンティティを追加する場合、ご利用のアカウントには AliyunDataWorksFullAccess ポリシーがアタッチされているか、またはお客様がデータアルバムの作成者か管理者である必要があります。
RemoveEntityFromMetaCollection	RemoveEntityFromMetaCollection	Data Map コレクションからエンティティオブジェクトを削除します。このコレクションは Data Map カテゴリおよびデータアルバムをサポートしており、対応するエンティティは現在、データテーブルのみです。データアルバムからエンティティを削除する場合、呼び出し元は AliyunDataWorksFullAccess 権限を持つ必要があります。また、アルバムの作成者または管理者であることも条件となります。

運用センター

API	タイトル	説明
パラメーター	パラメーター
CreateParameter	CreateParameter	パラメーターを作成します。
DeleteParameter	DeleteParameter	指定されたパラメーターを削除します。
UpdateParameter	UpdateParameter	パラメーターを更新します。この操作は増分更新を実行し、指定されたフィールドのみを変更します。
RollbackParameter	RollbackParameter	指定されたパラメーターをロールバックします。
GetParameter	GetParameter	ID に基づいてパラメーターの詳細を取得します。
ListParameters	ListParameters	クエリパラメーター。
ListParameterVersions	ListParameterVersions	パラメーターのバージョンをリスト表示します。
モニタリングとアラート	モニタリングとアラート
ListAlertRules	ListAlertRules	カスタム監視アラートルールの一覧を照会します。
GetAlertRule	GetAlertRule	カスタムアラートモニタリングルールを照会します。
UpdateAlertRule	UpdateAlertRule	カスタムアラート監視ルールの情報を更新します。
DeleteAlertRule	DeleteAlertRule	カスタム監視のアラートルールを削除します。
CreateAlertRule	CreateAlertRule	カスタム監視アラートルールを作成します。
ノード	ノード
DeleteTask	DeleteTask	タスクを削除します。
UpdateTask	UpdateTask	タスクを更新します。変更は Data Studio に同期され、新しい保存済みバージョンが作成されます。
BatchUpdateTasks	BatchUpdateTasks	複数のタスクに対して一度に増分更新を実行します。
GetTask	GetTask	タスクの情報を照会します。
ListTasks	ListTasks	ページごとにタスクのリストをクエリします。フィルター条件を指定してタスクをクエリすることもできます。
ListUpstreamTasks	ListUpstreamTasks	タスクの祖先タスクの一覧をページ単位で照会します。
ListDownstreamTasks	ListDownstreamTasks	タスクの子孫タスクの一覧をページ単位で照会します。
ListTaskOperationLogs	ListTaskOperationLogs	タスクの操作ログをページ単位で一覧表示します。
ノードインスタンス	ノードインスタンス
UpdateTaskInstances	UpdateTaskInstances	複数のタスクインスタンスのプロパティ (優先度、リソースグループ、データソースなど) をバッチで変更します。
GetTaskInstance	GetTaskInstance	インスタンスの情報を照会します。
GetTaskInstanceLog	GetTaskInstanceLog	インスタンスの特定の実行中に生成された実行ログを照会します。
ListTaskInstances	ListTaskInstances	タスクインスタンスの一覧を照会します。また、フィルター条件を指定して特定のタスクインスタンスを絞り込んで照会することもできます。
ListUpstreamTaskInstances	ListUpstreamTaskInstances	指定されたタスクインスタンスの上流（祖先）インスタンスの一覧をページ単位で照会します。
ListTaskInstanceOperationLogs	ListTaskInstanceOperationLogs	インスタンスの操作ログをページ単位で一覧表示します。
ListDownstreamTaskInstances	ListDownstreamTaskInstances	指定されたインスタンスの子孫インスタンス一覧をページ単位で照会します。
SuspendTaskInstances	SuspendTaskInstances	複数のインスタンスを一度に中断します。
ResumeTaskInstances	ResumeTaskInstances	複数の中断済みタスクインスタンスを一度に再開します。
StopTaskInstances	StopTaskInstances	複数のインスタンスを一度に停止します。
SetSuccessTaskInstances	SetSuccessTaskInstances	複数のタスクインスタンスのステータスを一度に「成功」に設定します。
RerunTaskInstances	ノードインスタンスを再実行します	複数のノードインスタンスをバッチで再実行します。
RemoveTaskInstanceDependencies	RemoveTaskInstanceDependencies	インスタンスの複数の上流依存関係を一度に削除します。
TriggerSchedulerTaskInstance	TriggerSchedulerTaskInstance	指定された時刻に HTTP トリガーノードを用いてタスクを実行します。
ワークフロー	ワークフロー
DeleteWorkflow	DeleteWorkflow	ワークフローを削除します。
ワークフローインスタンス	ワークフローインスタンス
GetRerunWorkflowInstancesResult	GetRerunWorkflowInstancesResult	非同期で再実行されたワークフローインスタンスの結果をクエリします。
RerunWorkflowInstances	RerunWorkflowInstances	ワークフローインスタンスの再実行
CreateWorkflowInstances	CreateWorkflowInstances	構成に基づき、データバックフィルワークフローインスタンスなどのワークフローインスタンスを作成します。
GetCreateWorkflowInstancesResult	GetCreateWorkflowInstancesResult	ワークフローインスタンスの非同期作成結果をクエリします。
GetWorkflowInstance	GetWorkflowInstance	ワークフローインスタンスの情報を照会します。
ListWorkflowInstances	ListWorkflowInstances	特定の条件でフィルタリングされたワークフローインスタンスのページ分割されたリストを返します。
StartWorkflowInstances	StartWorkflowInstances	複数のワークフローインスタンスをバッチで開始します。
StopWorkflowInstances	StopWorkflowInstances	複数のワークフローインスタンスを一度に停止します。
ExecuteAdhocWorkflowInstance	ExecuteAdhocWorkflowInstance	構成に基づいて一時的なワークフローインスタンスを作成します。

Data Quality

API	タイトル	説明
Data Quality ルールテンプレート	Data Quality ルールテンプレート
CreateDataQualityTemplate	CreateDataQualityTemplate	データ品質テンプレートを作成します。
UpdateDataQualityTemplate	UpdateDataQualityTemplate	プロジェクト内のデータ品質ルールテンプレートを更新します。
ListDataQualityTemplates	ListDataQualityTemplates	プロジェクト内のデータ品質ルールテンプレートの一覧を照会します。
GetDataQualityTemplate	GetDataQualityTemplate	ID に基づいてデータ品質ルールテンプレートの詳細を照会します。
DeleteDataQualityTemplate	DeleteDataQualityTemplate	指定された ID でデータ品質ルールテンプレートを削除します。
Data Quality モニタリング	Data Quality モニタリング
CreateDataQualityScan	CreateDataQualityScan	データ品質モニターを作成します。
UpdateDataQualityScan	UpdateDataQualityScan	データ品質モニターを更新します。
ListDataQualityScans	ListDataQualityScans	プロジェクト内のデータ品質スキャンタスクの一覧を照会します。
GetDataQualityScan	GetDataQualityScan	データ品質モニタリングの詳細を取得します。
DeleteDataQualityScan	DeleteDataQualityScan	データ品質モニターを削除します。
アラートルール	アラートルール
CreateDataQualityAlertRule	CreateDataQualityAlertRule	プロジェクト内にデータ品質モニタリングのアラートルールを作成します。
UpdateDataQualityAlertRule	UpdateDataQualityAlertRule	指定されたデータ品質モニタリングアラートルールを更新します。
ListDataQualityAlertRules	ListDataQualityAlertRules	プロジェクト内のデータ品質アラートルールの一覧を照会します。
GetDataQualityAlertRule	GetDataQualityAlertRule	アラートルール ID に基づいて、データ品質モニタリングおよびアラートルールの詳細を照会します。
DeleteDataQualityAlertRule	DeleteDataQualityAlertRule	指定された ID でデータ品質アラートルールを削除します。
Data Quality 実行	Data Quality 実行
CreateDataQualityScanRun	CreateDataQualityScanRun	指定されたデータ品質スキャンをトリガーし、実行 ID を返します。
ListDataQualityScanRuns	ListDataQualityScanRuns	指定されたプロジェクトにおけるデータ品質スキャン実行の履歴を照会します。
GetDataQualityScanRunLog	GetDataQualityScanRunLog	データ品質モニタリングの特定タスクインスタンスのログを照会します。
GetDataQualityScanRun	GetDataQualityScanRun	データ品質モニタリング実行インスタンスを作成します。

セキュリティセンター

API	タイトル	説明
権限リクエストと承認	権限リクエストと承認
ApplyResourceAccessPermission	リソースアクセス権限申請の送信	特定のリソースに対するアクセス権限の申請を送信します。
StopProcessInstance	StopProcessInstance	指定されたプロセスインスタンスを取り下げまたは終了します。
ApproveProcessInstance	ワークフローインスタンスを承認します	指定された承認プロセスインスタンスを承認または拒否します。
GetApplicationContents	リソース権限アプリケーション詳細を取得します	指定されたプロセスインスタンス ID に基づくリソース権限アプリケーションの内容を照会します。
GetProcessInstance	GetProcessInstance	指定された承認プロセスインスタンスの詳細を取得します。承認ノードおよびタスクリストを含みます。
ListPendingApprovals	保留中の権限リクエスト注文を照会します	現在のユーザーが承認者である保留中の権限リクエスト注文のリストを取得します。
ListMyRelatedApprovals	自分に関連する権限アプリケーション注文を照会します	現在のユーザーが承認者または関係者であるすべての権限アプリケーション注文を照会します。
ListMyApplications	自分が発行した権限申請注文を照会します	現在のユーザーが発行したすべてのリソースアクセス権限アプリケーション注文を照会します。
クエリ結果コントロールポリシー	クエリ結果コントロールポリシー
CreateSecurityStrategy	CreateSecurityStrategy	さまざまなモジュールとサブモジュールを設定するための新しいセキュリティコントロールポリシーを作成します。この操作には、DataWorks のテナント管理者とセキュリティ管理者の両方の権限が必要です。
DeleteSecurityStrategy	DeleteSecurityStrategy	ID を指定してセキュリティ戦略を削除します。この操作を呼び出すには、DataWorks テナント管理者およびセキュリティ管理者の権限が必要です。
UpdateSecurityStrategy	UpdateSecurityStrategy	既存のセキュリティポリシーの設定を変更するには、DataWorksテナント管理者およびセキュリティ管理者の両方である必要があります。
GetSecurityStrategy	GetSecurityStrategy	ID を指定してセキュリティポリシーの詳細を取得します。このオペレーションには、DataWorks テナント管理者とセキュリティ管理者の両方の権限が必要です。
ListSecurityStrategies	ListSecurityStrategies	指定された条件に基づいて、セキュリティポリシーのページ分割されたリストを取得します。この操作には、DataWorks のテナント管理者またはセキュリティ管理者の権限が必要です。
FindBestMatchSecurityStrategy	最適なセキュリティポリシーをマッチング	指定された条件に最も適したセキュリティポリシーを検索します。
承認ポリシー	承認ポリシー
CreateProcessDefinition	CreateApprovalProcessDefinition	新しい承認プロセス定義を作成します。承認ルールと通知サービスのカスタム設定をサポートします。
DeleteProcessDefinition	DeleteProcessDefinition	指定されたIDのプロセス定義を削除します。
EnableProcessDefinition	EnableProcessDefinition	指定した ID のプロセス定義を有効化します。
DisableProcessDefinition	DisableProcessDefinition	指定された承認プロセス解像度を無効にします。
UpdateProcessDefinition	UpdateProcessDefinition	既存の承認プロセス定義を更新します。
GetProcessDefinition	GetProcessDefinition	指定されたプロセス定義IDの承認ポリシーを取得します。
ListProcessDefinitions	ListProcessDefinitions	指定されたタイプのプロセス定義を照会します。
CreateIdentifyCredential	CreateIdentifyCredential	ID 認証情報を作成します。

タグ管理

API	タイトル	説明
CreateDataAssetTag	CreateDataAssetTag	タグを作成します。
DeleteDataAssetTag	DeleteDataAssetTag	タグを削除します。
UpdateDataAssetTag	UpdateDataAssetTag	タグを更新します。
ListDataAssetTags	ListDataAssetTags	タグの一覧を照会します。
TagDataAssets	TagDataAssets	データ資産にタグを追加します。
UnTagDataAssets	UnTagDataAssets	データ資産からタグを削除します。
ListDataAssets	ListDataAssets	DataWorks のタグが付与されたデータ資産の情報をページ単位で照会します。

オープンプラットフォーム

API	タイトル	説明
GetJobStatus	GetJobStatus	非同期タスクのステータス情報を照会します。非同期操作を呼び出すと、対応する非同期タスクが生成されます。この操作では、生成された非同期タスクの実行状況を取得できます。

その他

API	タイトル	説明
ListDataQualityEvaluationTasks	品質監視タスクの一覧表示	ページングクエリで品質監視ノードを一覧表示します。
ListDataQualityRules	データ品質ルールのリストを照会します	データ品質モニタリングルールをページネーションで照会します。
ListDataQualityEvaluationTaskInstances	品質モニタリングタスクインスタンスのリストを照会します	品質モニタリングタスクインスタンスリストのページング照会を実行します。
ListDataQualityResults	Data Quality の結果を照会します	ページングを使用して Data Quality の結果リストを照会します。
DetachDataQualityRulesFromEvaluationTask	データ品質ルールとモニタリングタスクの関連付けを解除する	データ品質ルールとデータ品質モニタリングタスクの関連付けを解除します。
DeleteDataQualityEvaluationTask	Data Quality モニターを削除します	Data Quality モニタリングタスクを削除します。
GetDataQualityEvaluationTaskInstance	データ検証チェックタスクインスタンスの詳細を取得します	データ検証チェックタスクインスタンスの詳細を取得します。
GetDataQualityEvaluationTask	Data Quality モニタリングの詳細を照会します	Data Quality データ有効性検証タスクの詳細を照会します。
AttachDataQualityRulesToEvaluationTask	データ品質ルールをデータ品質モニタリングタスクに関連付ける	データ品質ルールをデータ品質モニタリングタスクに関連付けます。
UpdateDataQualityEvaluationTask	Data Quality モニタリングを更新します	Data Quality データ検証タスクを更新します。
CreateDataQualityEvaluationTaskInstance	Data Quality 評価モニタリングインスタンスを作成します	Data Quality 評価タスクインスタンスを作成します。
CreateDataQualityEvaluationTask	データ品質モニターを作成します	DataWorks のデータ品質モニターを作成します。
DeleteDataQualityRule	DeleteDataQualityRule	データ品質監視ルールを削除します。
UpdateDataQualityRuleTemplate	データ品質ルールテンプレートを更新する	データ品質ルールテンプレートを更新します。
CreateDataQualityRuleTemplate	データ品質ルールテンプレートを作成する	ルールテンプレートを作成します。
DeleteDataQualityRuleTemplate	カスタム Data Quality ルールテンプレートを削除します	カスタム Data Quality ルールテンプレートを削除します。
GetDataQualityRuleTemplate	データ品質ルールテンプレートの詳細をクエリする	データ品質ルールテンプレートの詳細をクエリします。
CreateDataQualityRule	Data Quality ルールを作成します	Data Quality ルールを作成します。
UpdateDataQualityRule	Data Quality ルールを更新します	Data Quality ルールを更新します。
GetDataQualityRule	Data Quality ルールの詳細を照会します	Data Quality ルールの詳細を照会します。
ListDataQualityRuleTemplates	データ品質ルールテンプレートの一覧をクエリする	データ品質ルールテンプレートの一覧をクエリします。
DeleteCertificate	DeleteCertificate	証明書ファイルを削除します。
GetCertificate	GetCertificate	認証ファイルを表示できます。
GetDataSource	GetDataSource	ID を指定してデータソースを照会します。
ImportCertificate	ImportCertificate	証明書ファイルをインポートします。
ListCertificates	ListCertificates	証明書ファイルの一覧をクエリします。
DeleteFile	DeleteFile	DataStudio からファイルを削除します。ファイルがコミット済みの場合、スケジューリングシステムでファイルを削除するための非同期プロセスがトリガーされます。返された DeploymentId パラメーターの値は、GetDeployment 操作を呼び出して非同期プロセスのステータスをポーリングするために使用されます。
GetWorkflow	GetWorkflow	ワークフローの情報を照会します。
ListWorkflows	ListWorkflows	ページごとにワークフローのリストをクエリします。フィルター条件を指定してワークフローをクエリすることもできます。
UpdateWorkflow	UpdateWorkflow	指定されたワークフローをフルアップデートモードで更新します。