すべてのプロダクト
Search
ドキュメントセンター

DataWorks:API の概要

最終更新日:Jul 27, 2026

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

本製品 (dataworks-public/2020-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 セキュリティを確保するには、以下を作成し、設定する必要があります。

テナント

API

タイトル

説明

ListCalcEngines ListCalcEngines Queries a list of compute engines that are associated with a DataWorks workspace.
CreateDataSource CreateDataSource DataWorks (データワークス) にデータソースを追加します。
ListDataSources ListDataSources DataWorks ワークスペースに追加されたデータソースを照会します。
UpdateDataSource UpdateDataSource データソースを更新します。
DeleteDataSource DeleteDataSource データソースを削除します。
ListResourceGroups ListResourceGroups 指定されたタイプのリソースグループのリストを照会します。
GetProject GetProject DataWorks ワークスペースの情報を照会します。
AddProjectMemberToRole AddProjectMemberToRole DataWorks ワークスペースのメンバーにロールを割り当てます。このオペレーションを呼び出す前に、ご利用のアカウントを DataWorks ワークスペースにメンバーとして追加する必要があります。
CreateProjectMember CreateProjectMember DataWorks ワークスペースにユーザーを追加します。
DeleteProjectMember DeleteProjectMember DataWorks ワークスペースからユーザーを削除します。
ListProjectRoles ListProjectRoles DataWorks ワークスペース内のロール一覧を照会します。
RemoveProjectMemberFromRole RemoveProjectMemberFromRole DataWorks ワークスペース内のユーザーからロールを削除します。
ListProjectMembers ListProjectMembers DataWorks ワークスペース内の既存のメンバーのリストを照会します。
ListProjects ListProjects ユーザーが属するテナントの DataWorks ワークスペースのリストを照会します。
ListProjectIds ListProjectIds 特定の Alibaba Cloud アカウントまたは RAM ユーザーが特定のリージョンで権限を持つワークスペースの ID を照会します。
CreateProject CreateProject DataWorks ワークスペースを作成します。
ChangeResourceManagerResourceGroup ChangeResourceManagerResourceGroup リソースのリソースグループを変更します。
ListMeasureData ListMeasureData ご利用のアカウントが所属するテナント内で、過去 30 日間に報告された電話ベースのアラートまたはショートメッセージベースのアラートの件数に関する統計情報を照会します。

メタデータ

API

タイトル

説明

ListTables ListTables テナント内における、さまざまなデータソース種別のテーブルをページ単位で取得します。
GetMetaDBInfo GetMetaDBInfo コンピュートエンジンインスタンスの基本的なメタデータ情報を照会します。
GetMetaDBTableList GetMetaDBTableList 指定されたエンジンインスタンス内のすべてのテーブルを取得します。
CheckMetaTable CheckMetaTable メタテーブルが存在するかどうかを確認します。
CheckMetaPartition CheckMetaPartition MaxCompute メタテーブル内のパーティションが存在するかどうかを確認します。
SearchMetaTables SearchMetaTables 特定の条件に基づいてメタテーブルをクエリします。
GetMetaTableBasicInfo GetMetaTableBasicInfo メタテーブルの基本情報を照会します。
GetMetaTableColumn GetMetaTableColumn メタテーブルのフィールド情報をクエリします。
GetMetaTablePartition GetMetaTablePartition テーブルのパーティションのリストを取得します。
GetMetaTableOutput GetMetaTableOutput メタテーブルの出力情報を照会します。
GetMetaTableChangeLog GetMetaTableChangeLog メタテーブルの変更ログをクエリします。
GetMetaTableIntroWiki GetMetaTableIntroWiki テーブルの使用方法に関する説明を照会します。
CreateMetaCategory CreateMetaCategory カテゴリを作成します。
DeleteMetaCategory DeleteMetaCategory カテゴリを削除します。
UpdateMetaCategory UpdateMetaCategory カテゴリを更新します。
GetMetaCategory GetMetaCategory カテゴリツリーに関する情報を照会します。
GetMetaTableListByCategory GetMetaTableListByCategory 指定されたカテゴリ内のメタテーブルを照会します。
AddToMetaCategory AddToMetaCategory メタテーブルを指定されたカテゴリに追加します。
DeleteFromMetaCategory DeleteFromMetaCategory 指定されたカテゴリからテーブルを削除します。
UpdateMetaTable UpdateMetaTable この操作では、テーブルのメタデータを更新します。
UpdateMetaTableIntroWiki UpdateMetaTableIntroWiki テーブルの使用方法に関する説明を更新します。テーブルの使用方法に関する既存の説明が存在しない場合、本操作を呼び出して設定した説明が追加されます。
ListMetaDB ListMetaDB メタデータベースの一覧をクエリします。
UpdateTableModelInfo UpdateTableModelInfo テーブルの情報(例:テーブルフォルダ、レベル、カテゴリ)を変更します。
CreateTableTheme CreateTableTheme テーブルテーマを作成します。この操作は間もなく置き換えられます。この操作を呼び出さないことを推奨します。
DeleteTableTheme DeleteTableTheme テーブルテーマを削除します。この操作は、間もなく非推奨となります。呼び出さないことを推奨します。
UpdateTableTheme UpdateTableTheme テーブルテーマを更新します。この操作は、今後非推奨となります。呼び出さないことを推奨します。
ListTableTheme ListTableTheme テーブルテーマの一覧を取得します。この操作は今後、置き換えられる予定です。そのため、本操作の呼び出しは推奨されません。
GetMetaTableThemeLevel GetMetaTableThemeLevel テーブルのトピックおよび階層メタデータを取得します
CreateTableLevel CreateTableLevel 階層レベルを作成します。この操作は、間もなく置き換えられます。この操作を呼び出さないことを推奨します。
UpdateTableLevel UpdateTableLevel 階層レベルを更新します。この操作は、間もなく置き換えられる予定です。そのため、本操作の呼び出しは推奨されません。
DeleteTableLevel DeleteTableLevel 階層レベルを削除します。この操作は間もなく置き換えられます。この操作を呼び出さないことを推奨します。
ListTableLevel ListTableLevel テーブルの階層レベルを一覧表示します。この操作は、近日中に置き換えられる予定です。呼び出さないことを推奨します。
UpdateMetaCollection UpdateMetaCollection コレクションの名前およびコメントを更新します。
ListMetaCollections ListMetaCollections コレクションに関する情報をクエリします。コレクションには、データマップページに表示されるデータアルバムと、データアルバム内に作成されるカテゴリが含まれます。この API オペレーションを呼び出すことで、コレクションのタイプ別にクエリできます。
ListMetaCollectionEntities ListMetaCollectionEntities コレクション内のエンティティを照会します。
DeleteMetaCollection DeleteMetaCollection コレクションを削除します。
GetMetaCollectionDetail GetMetaCollectionDetail コレクションの情報を照会します。
DeleteMetaCollectionEntity DeleteMetaCollectionEntity コレクションからエンティティを削除します。
AddMetaCollectionEntity AddMetaCollectionEntity コレクションにエンティティを追加します。
CreateMetaCollection CreateMetaCollection コレクションを作成します。
ListLineage ListLineage エンティティの祖先または子孫の系統(ラインエイジ)を照会します。
DeleteLineageRelation DeleteLineageRelation 系統の削除、ユーザー定義の系統関係の削除をサポートします
RegisterLineageRelation RegisterLineageRelation DataWorks へ、ユーザーが独自に管理するエンティティ間の系統(ライネージ)を登録します。
GetMetaTableLineage GetMetaTableLineage メタテーブルのリネージを照会します。
GetMetaColumnLineage GetMetaColumnLineage メタテーブル内のフィールドの系統(ラインアージ)をクエリします。

データ開発

API

タイトル

説明

CreateFile DataStudio にファイルを作成します。 DataStudio にファイルを作成します。この操作では、Data Integration ノードタスクの作成はサポートされていません。
CreateUdfFile CreateUdfFile DataStudio で関数用のファイルを作成します。
CreateBusiness CreateBusiness DataStudio でワークフローを作成します。
DeleteBusiness DeleteBusiness ワークフローを削除します。
CreateFolder CreateFolder 実行する操作を指定します。値は CreateFolder に設定します。
UpdateBusiness UpdateBusiness ワークフローを更新します。
ListFiles ListFiles ファイルの一覧を照会します。
EstablishRelationTableToBusiness EstablishRelationTableToBusiness テーブルをワークフローにインポートします。この API オペレーションを呼び出す操作は、以下の手順と同等です:DataStudio ページに移動し、目的のワークフローを見つけ、ワークフロー名をクリックします。その後、対象フォルダ内の **[テーブル]** を右クリックして、**[テーブルのインポート]** を選択します。
SubmitFile SubmitFile ファイルを開発環境に送信し、対応するタスクを作成します。
ListBusiness ListBusiness ワークフローのリストを照会します。
GetFileVersion GetFileVersion ファイルバージョンの情報を照会します。
DeleteFolder DeleteFolder データ開発ページからフォルダを削除します。
DeleteFile DeleteFile DataStudio からファイルを削除します。ファイルがコミットされている場合、非同期プロセスがトリガーされ、スケジューリングシステム内のファイルが削除されます。返された `DeploymentId` パラメーターの値は、`GetDeployment` 操作を呼び出して非同期プロセスのステータスをポーリングするために使用されます。
GetDeployment GetDeployment デプロイメントパッケージの情報を照会します。
UpdateFile UpdateFile ファイルを更新します。
GetFolder GetFolder GetFolder を呼び出して、フォルダの詳細を取得できます。
ListFileVersions ListFileVersions ファイルのバージョン一覧をクエリします。
GetFile GetFile ファイルに関する情報を照会します。
ListFolders ListFolders ListFolders 操作を呼び出して、フォルダを照会します。
DeployFile DeployFile ファイルを本番環境にデプロイします。
UpdateUdfFile UpdateUdfFile 関数のファイル情報を更新します。
GetBusiness GetBusiness ワークフローの情報を照会します。
UpdateFolder UpdateFolder フォルダを更新します。
ListDeployments ListDeployments デプロイメントパッケージのリストを照会します。この操作は、DataWorks コンソールの [デプロイメントパッケージ] ページでデプロイメントパッケージのリストを表示することと同等です。
UpdateIDEEventResult UpdateIDEEventResult データ開発中に拡張ポイントイベントがトリガーされ、拡張機能によってチェックされた後、そのチェック結果を DataStudio に返します。
GetIDEEventDetail GetIDEEventDetail DataWorks OpenEvent で拡張ポイントイベントがトリガーされた際に、そのメッセージ ID を基に拡張ポイントのデータスナップショットを照会します。
CreateResourceFile CreateResourceFile DataStudio でリソースファイルを作成またはアップロードします。この操作を呼び出すことで実現される機能は、統合開発環境 (IDE) で提供されているリソース作成機能と同じです。

Data Integration

API

タイトル

説明

CreateDISyncTask CreateDISyncTask データ同期タスクを作成します。
DeleteDISyncTask DeleteDISyncTask 同期タスクを削除します。この操作は、リアルタイム同期タスクのみを削除するために呼び出すことができます。
UpdateDISyncTask UpdateDISyncTask データ同期タスクを更新します。
TestNetworkConnection TestNetworkConnection データソースとリソースグループ間のネットワーク接続をテストします。
GetDataSourceMeta GetDataSourceMeta 指定されたデータソースのメタデータを照会します。
ListDIProjectConfig ListDIProjectConfig 指定された DataWorks ワークスペースにおける同期ソリューションのデフォルトのグローバル構成をクエリします。
UpdateDIProjectConfig UpdateDIProjectConfig DataWorks ワークスペース内の同期ソリューションのデフォルトグローバル構成を変更します。
GetDISyncTask GetDISyncTask リアルタイム同期タスクまたはデータ同期ソリューションの詳細をクエリします。
DeployDISyncTask DeployDISyncTask リアルタイム同期タスクをデプロイします。
GetDISyncInstanceInfo GetDISyncInstanceInfo リアルタイム同期タスクまたはデータ同期ソリューションのステータスをクエリします。
TerminateDISyncInstance TerminateDISyncInstance リアルタイム同期タスクを停止します。
GenerateDISyncTaskConfigForCreating GenerateDISyncTaskConfigForCreating Data Integration で同期タスクを作成する際に使用される非同期スレッドの ID を生成します。
GenerateDISyncTaskConfigForUpdating GenerateDISyncTaskConfigForUpdating Data Integration におけるリアルタイム同期タスクの更新に使用される非同期スレッド用の JSON を生成します。
StartDISyncInstance StartDISyncInstance リアルタイム同期タスクまたはデータ同期ソリューションを開始します。
StopDISyncInstance StopDISyncInstance リアルタイム同期タスクを停止します。
QueryDISyncTaskConfigProcessResult QueryDISyncTaskConfigProcessResult 非同期タスクの実行結果を照会します。
CreateDIJob CreateDIJob 新バージョンの同期タスクを作成します。サポートされる同期タスクの種類は、MySQL データベース内の全データを Hologres にリアルタイム同期するものと、MySQL データベース内の全データを Hive にバッチ同期するものです。
DeleteDIJob DeleteDIJob 新バージョンのデータ統合タスクを削除します。MySQL データベースから Hologres へのリアルタイムデータ同期タスクのみがサポートされています。
GetDIJob GetDIJob Data Integration で作成した新バージョンの同期タスクに関する情報を照会します。サポートされる同期タスクの種類には、MySQL データベース内の全データを Hologres へリアルタイム同期するものがあります。
ListDIJobs ListDIJobs 新バージョンの同期タスクのリストを照会します。MySQL データベースから Hologres へのリアルタイムデータ同期がサポートされています。
StartDIJob StartDIJob 新しいバージョンの同期タスクを開始します。サポートされるタスクの種類は、MySQL データベースから Hologres へのリアルタイムデータ同期のみです。
StopDIJob StopDIJob 新バージョンの同期タスクを停止します。サポートされる同期タスクの種類は、MySQL データベース内の全データを Hologres へリアルタイム同期するタスクです。
UpdateDIJob UpdateDIJob 新バージョンの同期タスクを更新します。サポートされるタスクの種類は、MySQL データベース内の全データを Hologres へリアルタイム同期するものです。
CreateDIAlarmRule CreateDIAlarmRule 新しいバージョンのデータ統合タスクのアラートルールを作成します。MySQL データベースから Hologres へのリアルタイムデータ同期タスクのみがサポートされています。
DeleteDIAlarmRule DeleteDIAlarmRule 新しいバージョンの Data Integration タスクのアラートルールを削除します。サポートされているタスクのタイプは、MySQL データベースから Hologres へのリアルタイムデータ同期のみです。
GetDIAlarmRule GetDIAlarmRule 新バージョンの同期タスクに設定されたアラートルールの詳細を照会します。サポートされるタスクの種類は、MySQL データベースから Hologres へのリアルタイムデータ同期のみです。
ListDIAlarmRules ListDIAlarmRules 新バージョンの同期タスクに設定されたアラートルールの一覧を取得します。対応しているタスクの種類は、MySQL データベースから Hologres へのリアルタイムデータ同期です。
UpdateDIAlarmRule UpdateDIAlarmRule 新バージョンの同期タスク向けアラートルールを更新します。対応するタスクの種類は、MySQL データベース内の全データを Hologres へリアルタイム同期するタスクです。

データモデリング

API

タイトル

説明

QueryPublicModelEngine QueryPublicModelEngine 高速モデリング言語 (FML) ステートメントを用いて、Data Modeling で作成されたオブジェクトの情報を照会します。

オペレーションセンター

API

タイトル

説明

CreateDataServiceApi CreateDataServiceApi API を作成します。
PublishDataServiceApi PublishDataServiceApi API を公開します。
DeleteDataServiceApi DeleteDataServiceApi DataService Studio で API を削除します。
ListDataServiceApis ListDataServiceApis 開発ステータスの API のリストを照会します。
GetDataServiceApi GetDataServiceApi DataService Studio API の開発状態における詳細情報を照会します。
UpdateDataServiceApi UpdateDataServiceApi DataService Studio で開発状態の API の情報を更新します。
GetDataServicePublishedApi GetDataServicePublishedApi DataService Studio の公開状態にある API の情報を照会します。
ListDataServicePublishedApis ListDataServicePublishedApis 公開状態の API のリストを照会します。
ListDataServiceApiAuthorities ListDataServiceApiAuthorities 他のユーザーにアクセス権限が付与された API を照会します。
ListDataServiceAuthorizedApis ListDataServiceAuthorizedApis ご利用者がアクセス可能な API を照会します。
AbolishDataServiceApi AbolishDataServiceApi DataService Studio API を非公開にします。
GetDataServiceApplication GetDataServiceApplication アプリケーションの詳細情報を照会します。
ListDataServiceApplications ListDataServiceApplications アプリケーションの基本情報を照会します。
CreateDataServiceFolder CreateDataServiceFolder DataService Studio にフォルダを作成します。
GetDataServiceFolder GetDataServiceFolder フォルダを照会します。
ListDataServiceFolders ListDataServiceFolders フォルダを照会します。
CreateDataServiceGroup CreateDataServiceGroup ビジネスプロセスを作成します。
GetDataServiceGroup GetDataServiceGroup ビジネスプロセスを照会します。
ListDataServiceGroups ListDataServiceGroups ビジネスプロセスを照会します。
CreateDataServiceApiAuthority CreateDataServiceApiAuthority DataService Studio における API へのアクセス権限を付与します。
DeleteDataServiceApiAuthority DeleteDataServiceApiAuthority API へのアクセス権限を取り消します。
ListDataServiceApiTest ListDataServiceApiTest DataService Studio API のテストレコードを照会します。本 API オペレーションでは、直近 1 ヶ月以内に生成されたテストレコードのみを照会できます。
TestDataServiceApi TestDataServiceApi DataService Studio API の非同期モードでのテストを実行します。テスト結果の照会には、`GetDataServiceApiTest` 操作を呼び出してください。
GetDataServiceApiTest GetDataServiceApiTest DataService Studio における API のテスト結果を照会します。
SubmitDataServiceApi SubmitDataServiceApi DataService Studio で API を提出します。
SaveDataServiceApiTestResult SaveDataServiceApiTestResult API のテスト結果を保存します。

Data Quality

API

タイトル

説明

AddRecognizeRule AddRecognizeRule データセキュリティガードにおけるデータのカテゴリおよび感度レベルに基づき、カスタムの機密フィールドを追加します。
ApprovePermissionApplyOrder 権限リクエスト注文を承認します 権限リクエスト注文を承認します。 注意: 2020 エディションの OpenAPI は廃止される予定です。できるだけ早く 2024 エディションの OpenAPI ApproveProcessInstance に移行してください。
CallbackExtension CallbackExtension 拡張機能が拡張ポイントイベントの処理結果を DataWorks に送信します。
CheckFileDeployment ファイルデプロイのチェック DataWorks DataStudioページで作成されたファイルが正常に送信されると、ファイルはリリースチェックステータスに入り、DataWorksはファイルリリースチェックイベントを返します。イベントの内容に基づいて、ファイルがリリース検証を続行できるかどうかを判断する必要があります。この時点で、リリース対象ファイルのチェック結果をDataWorksに返すことができます。
CreateBaseline CreateBaseline ベースラインを作成します。
CreateConnection データソースを作成します CreateConnection を呼び出してデータソースを作成します。
CreateDagComplement データ補填ワークフローを作成する CreateDagComplementを呼び出して、データ補填ワークフローを作成します。
CreateDagTest スモークテストワークフローを作成します CreateDagTest を呼び出してスモークテストワークフローを作成します。
CreateExportMigration CreateExportMigration エクスポートタスクを作成します。この操作を使用してエクスポートタスクを作成できますが、作成済みのエクスポートタスクを開始することはできません。
CreateImportMigration CreateImportMigration インポートタスクを作成します。このタスクには、データソース、ノード、およびテーブルのインポートパッケージが含まれます。
CreateManualDag 手動ワークフローの実行をトリガーする 手動ワークフローは UI で既に送信およびデプロイされている必要があり、運用センターで対応する手動ワークフローを見つけられる必要があります。これらの条件が満たされた場合にのみ、この API を使用できます。
CreatePermissionApplyOrder 権限リクエスト注文を作成します。 権限リクエスト注文を作成します。 注意: 2020 エディションの OpenAPI は間もなく廃止されます。できるだけ早く 2024 エディションの OpenAPI に移行してください — ApplyResourceAccessPermission。
CreateQualityEntity CreateQualityEntity データ品質のパーティション式を作成します。
CreateQualityFollower CreateQualityFollower パーティション式にフォロワーを追加し、データ品質アラートを受信します。
CreateQualityRelativeNode CreateQualityRelativeNode パーティション式関連付けを作成します。
CreateQualityRule CreateQualityRule CreateQualityRule を呼び出して、品質ルールを作成します。
CreateRemind CreateRemind カスタムアラートルールを作成します。
CreateTable MaxComputeテーブルを作成する MaxComputeテーブルを作成します。
DeleteBaseline DeleteBaseline ID に基づいてベースラインを削除します。 ベースライン内のノードに先祖ノードがない場合にのみ、ベースラインを削除できます。 UpdateBaseline 操作を呼び出して、ノードとその先祖ノード間の関係を削除できます。
DeleteConnection DeleteConnection データソースを削除します。
DeleteQualityEntity DeleteQualityEntity パーティション式を削除します。
DeleteQualityFollower DeleteQualityFollower パーティション式からフォロワーを削除します。
DeleteQualityRelativeNode DeleteQualityRelativeNode DeleteQualityRelativeNode は、スケジューリングの関連付けを削除します。
DeleteQualityRule DeleteQualityRule データ品質ルールを削除します。
DeleteRecognizeRule DeleteRecognizeRule 機微フィールドタイプを削除します。
DeleteRemind DeleteRemind カスタム監視アラートルールを削除します。
DeleteTable MaxCompute テーブルを削除する MaxCompute テーブルを削除します。
DesensitizeData DesensitizeData データをマスキングします。
DsgDesensPlanAddOrUpdate DsgDesensPlanAddOrUpdate データマスキング (data desensitization) ルールを作成または編集するには、`DsgDesensPlanAddOrUpdate` API を呼び出します。
DsgDesensPlanDelete DsgDesensPlanDelete データセキュリティガードで作成されたデータマスキングルールを削除します。
DsgDesensPlanQueryList DsgDesensPlanQueryList `DsgDesensPlanQueryList` API を呼び出して、Data Security Guard (DSG) のデータマスキングルールをクエリします。
DsgDesensPlanUpdateStatus DsgDesensPlanUpdateStatus データマスキングルールのステータスを変更します。
DsgGetVisitDetail アクセス動作の詳細を照会します。 アクセス動作の詳細を照会します。
DsgGetVisitStat データアクセス動作 Record を照会します。 データアクセスのアクセス Record を照会します。
DsgPlatformQueryProjectsAndSchemaFromMeta DsgPlatformQueryProjectsAndSchemaFromMeta 現在のテナントで、異なるタイプのコンピュートエンジンの一覧を照会します。
DsgQueryDefaultTemplates DsgQueryDefaultTemplates 利用可能な機密データ型テンプレートおよびそれらがサポートする非識別化ルールを取得します。このAPI の応答を使用して、非識別化ルールを設定します。
DsgQueryDesensStatusList データマスキングスイッチの照会 データマスキングスイッチのステータスを照会します
DsgQueryDetails Data shield - データアクセス - クエリのエクスポート。 詳細なクエリ結果をエクスポートします。
DsgQueryRowDetail データ保護アンブレラ - データアクセス - 詳細リストクエリのエクスポート。 行レベルの詳細リストクエリをエクスポートします。
DsgQuerySensResult 機密データ識別結果の取得。 Data Security Guard から機密データの識別結果を取得します。
DsgRunSensIdentify DsgRunSensIdentify Data Security Guard で機密データ識別タスクを開始します。
DsgSceneAddOrUpdateScene DsgSceneAddOrUpdateScene レベル 2 のデータマスキングシナリオを追加または変更します。
DsgSceneQuerySceneListByName DsgSceneQuerySceneListByName `DsgSceneQuerySceneListByName` API を呼び出して、データマスキングシナリオのリストを取得します。
DsgScenedDeleteScene DsgScenedDeleteScene Data Security Guard で作成したレベル 2 のデータマスキングシナリオを削除します。
DsgStopSensIdentify DsgStopSensIdentify 機密データ識別タスクを停止します。
DsgUpdateDesensStatusList データマスキングスイッチのステータスを更新します データマスキングスイッチのステータスを更新します。
DsgUserGroupAddOrUpdate DsgUserGroupAddOrUpdate データセキュリティガードでユーザーグループを作成または更新します。
DsgUserGroupDelete DsgUserGroupDelete データセキュリティガードで設定されたユーザーグループを削除します。
DsgUserGroupGetOdpsRoleGroups DsgUserGroupGetOdpsRoleGroups Data Security Guard でテナントがユーザーグループを作成または変更する際に、ユーザーグループのメンバーが選択できる MaxCompute ロールのリストをクエリします。
DsgUserGroupQueryList DsgUserGroupQueryList `DsgUserGroupQueryList` を呼び出して、Data Security Guard (DSG) 内のユーザーグループをクエリします。
DsgUserGroupQueryUserList DsgUserGroupQueryUserList 現在のテナントのユーザーまたはロールのリストを照会します。
DsgWhiteListAddOrUpdate DsgWhiteListAddOrUpdate データマスキングホワイトリストを追加または更新します。
DsgWhiteListDeleteList DsgWhiteListDeleteList Data Security Guard で設定されたデータマスキング ホワイトリストを削除します。
DsgWhiteListQueryList DsgWhiteListQueryList データマスキングホワイトリストをクエリします。
EditRecognizeRule EditRecognizeRule データセキュリティガードでデータのカテゴリと感度レベルに基づいて定義された機密フィールドを編集します。
ExportDataSources データソースリストのエクスポート データソースリストをエクスポートします。
GetAlertMessage GetAlertMessage AlertId パラメーターで指定されたアラート ID を基に、アラート情報を照会します。
GetBaseline GetBaseline ベースライン ID を指定して、対応するベースラインの情報を照会します。
GetBaselineConfig GetBaselineConfig ベースラインの構成をクエリします。
GetBaselineKeyPath GetBaselineKeyPath インスタンスに関連付けられているイベントに関する情報です。
GetBaselineStatus GetBaselineStatus ベースラインインスタンスの詳細を照会します。
GetDDLJobStatus テーブルの作成、更新、削除タスクのステータスを取得 GetDDLJobStatusを呼び出して、テーブルの作成、更新、削除タスクのステータスを取得します。
GetDag GetDag 有向非循環グラフ (DAG) の情報を照会します。この操作では、手動トリガーワークフロー、手動トリガーのノード、またはデータバックフィルインスタンスに対応する DAG の情報を照会できます。ただし、自動トリガーのノードまたは自動トリガーワークフローに対応する DAG の情報は照会できません。
GetExtension GetExtension 拡張の詳細を照会します。
GetFileTypeStatistic GetFileTypeStatistic ノードタイプの分布を照会します。
GetInstance GetInstance インスタンスに関する情報を照会します。
GetInstanceConsumeTimeRank 実行時間によるインスタンスのランキングを照会します 実行時間によるインスタンスのランキングを照会します。
GetInstanceCountTrend 自動トリガーノードインスタンス数のトレンドを照会します GetInstanceCountTrendを呼び出して、自動トリガーノードインスタンス数のトレンドを照会します。
GetInstanceErrorRank 過去1か月のノードのエラーランキングを取得します GetInstanceErrorRankを呼び出して、過去1か月のノードのエラーランキングを取得します。
GetInstanceLog GetInstanceLog インスタンスのログをクエリします。
GetInstanceStatusCount GetInstanceStatusCount 異なるステータスのインスタンスの統計情報を照会します。
GetInstanceStatusStatistic GetInstanceStatusStatistic 各状態にあるインスタンス数をクエリします。
GetManualDagInstances GetManualDagInstances 手動でトリガーされたワークフローのインスタンスに関する情報を照会します。
GetMetaTableFullInfo フィールド情報を含む、テーブルの完全な情報を取得します フィールド情報を含む、テーブルの完全な情報を取得します。
GetMigrationProcess GetMigrationProcess 移行タスクの進捗状況をクエリします。
GetMigrationSummary GetMigrationSummary 移行タスクの情報をクエリします。
GetNode GetNode リクエストが成功したかどうかを示します。
GetNodeChildren GetNodeChildren インスタンスのリストを照会します。
GetNodeCode GetNodeCode ノードのコードを照会します。
GetNodeOnBaseline ベースライン上のノードを照会します ベースライン上のノードを照会します。
GetNodeParents GetNodeParents ノードの先祖ノードの一覧を照会します。
GetNodeTypeListInfo GetNodeTypeListInfo ノードタイプのコードや名前を含む、ノードタイプに関する情報を照会します。
GetOpRiskData GetOpRiskData テナントのすべての DataWorks ワークスペースにおいて、指定した日付に生成された高リスク機密データへのアクセス記録をクエリします。
GetOpSensitiveData GetOpSensitiveData テナントのすべての DataWorks ワークスペースにおける、指定した日付に生成された機密データへのアクセス記録をクエリします。
GetOptionValueForProject GetOptionValueForProject ワークスペース内の拡張のオプション設定を照会します。
GetPermissionApplyOrderDetail 権限リクエスト注文の詳細を照会します 権限リクエスト注文の詳細を照会します。 注意: 2020 バージョンの OpenAPI は廃止される予定です。できるだけ早く 2024 バージョンの OpenAPI に移行してください — GetApplicationContents/GetProcessInstance。
GetProjectDetail GetProjectDetail DataWorks ワークスペースに関する情報をクエリします。
GetQualityEntity GetQualityEntity `GetQualityEntity` を呼び出して、パーティションフィルター式を取得します。
GetQualityFollower GetQualityFollower パーティション式のフォロワーを取得します。
GetQualityRule GetQualityRule 品質ルールの情報を取得します。
GetRemind GetRemind カスタムアラートルールの情報を照会します。
GetSensitiveData GetSensitiveData テナントに属するすべての DataWorks ワークスペース内の最新の機密データをクエリします。
GetSuccessInstanceTrend 時間帯別の本日のタスクの統計トレンドを取得します GetSuccessInstanceTrendを呼び出して、時間帯別の本日のタスクの統計トレンドを取得します。
GetTopic GetTopic イベントの情報をクエリします。
GetTopicInfluence GetTopicInfluence イベントの影響を受けるベースラインインスタンスを照会します。
ImportDataSources オンプレミスのデータソースをバッチでインポートします オンプレミスのデータソースを送信先の DataWorks ワークスペースにバッチでインポートします。
ListAlertMessages ListAlertMessages アラートのリストをクエリします。
ListBaselineConfigs ListBaselineConfigs ベースラインのリストをクエリします。
ListBaselineStatuses ListBaselineStatuses ベースラインインスタンスの一覧を照会します。
ListBaselines ListBaselines ベースラインのリストを取得します。
ListCheckProcesses ListCheckProcesses 拡張ポイントイベントのチェック結果を照会します。
ListClusterConfigs ListClusterConfigs ワークスペース内のサブモジュールの構成をクエリします。SPARK パラメーターに関する情報をクエリできます。
ListClusters ListClusters DataWorks に登録されているクラスターをクエリします。E-MapReduce (EMR) クラスターと Cloudera's Distribution Including Apache Hadoop (CDH) クラスターがサポートされています。
ListConnections ListConnections データソースのリストを照会します。
ListDags ListDags OpSeq を基に、単一のデータバックフィルインスタンスに関連する有向非循環グラフ (DAG) の詳細を照会します。
ListEnabledExtensionsForProject ListEnabledExtensionsForProject ワークスペースで有効化されている組み込みおよびカスタム拡張機能のリストをクエリします。
ListEntitiesByTags タグに基づくエンティティの一覧表示 タグに基づいてエンティティを一覧表示します。現在、maxcompute-table タイプのエンティティのみがサポートされています。
ListEntityTags エンティティのタグを一覧表示 エンティティのタグを一覧表示します。現在、maxcompute-tableタイプのエンティティのみサポートされています。
ListExtensions ListExtensions 拡張の一覧を照会します。
ListFileType ListFileType ノードタイプ(コードおよび名称など)に関する情報を照会します。
ListInnerNodes ListInnerNodes 内部ノードに関する情報を照会します。たとえば、ノードグループまたは do-while ノードの内部ノードを照会できますが、PAI ノードの内部ノードは照会できません。
ListInstanceAmount ListInstanceAmount 指定された期間内に自動トリガーされたノードインスタンス数の傾向を照会します。
ListInstanceHistory ListInstanceHistory すべてのインスタンスの履歴レコードに関する情報をクエリします。インスタンスが再実行されるたびに、1 つの履歴レコードが生成されます。
ListInstances ListInstances インスタンスの一覧をクエリします。
ListManualDagInstances ListManualDagInstances 手動トリガーワークフロー内のインスタンス情報を照会します。
ListMigrations ListMigrations 移行タスクの一覧を照会します。
ListNodeIO ListNodeIO ノードの先祖ノードまたは子孫ノードの1レベルに関する情報を照会します。
ListNodeInputOrOutput ListNodeInputOrOutput ノードの入力および出力情報をクエリします。1 回のクエリでは、最も近いレベルにある先祖ノードまたは子孫ノードのみを取得できます。
ListNodes ListNodes ワークスペースの ID です。
ListNodesByBaseline ListNodesByBaseline ベースライン内のノードを照会します。
ListNodesByOutput ListNodesByOutput ノードの出力に基づいてノードを照会します。
ListPermissionApplyOrders 権限申請オーダーリストのクエリ 権限申請オーダーのリストをクエリします。 ご注意:2020版のOpenAPIは予定された日程で廃止されます。できるだけ早く2024版のOpenAPIに移行してください — ListMyApplications/ListPendingApprovals/ListMyRelatedApprovals。
ListProgramTypeCount ListProgramTypeCount さまざまなタイプのノードの分布をクエリします。
ListQualityResultsByEntity ListQualityResultsByEntity `ListQualityResultsByEntity` を使用して、パーティション式に基づいて検証結果を取得します。
ListQualityResultsByRule ListQualityResultsByRule データソースの品質を検証ルールに照らして検証し、検証結果を返します。
ListQualityRules ListQualityRules ListQualityRules を呼び出して、パーティションフィルター式に一致する品質ルールを取得します。
ListRefDISyncTasks 対象のデータソースに関連付けられているデータ統合同期タスクをクエリします。 対象のデータソースに関連付けられているデータ統合同期タスクをクエリします。
ListReminds ListReminds カスタムアラートルールのリストを照会します。
ListShiftPersonnels ListShiftPersonnels シフト勤務表に登録された当直エンジニアの一覧をクエリします。
ListShiftSchedules ListShiftSchedules オペレーションセンター内の勤怠表の一覧をクエリします。
ListSuccessInstanceAmount ListSuccessInstanceAmount 現在の日付において、毎時00分に自動トリガーされたノードインスタンスのうち、正常に実行完了したインスタンス数の推移を照会します。
ListTopics ListTopics イベントをクエリします。
OfflineNode OfflineNode ノードのデプロイを解除します。
QueryDefaultTemplate QueryDefaultTemplate Data Security Guard で定義されたデフォルトのデータカテゴリおよびデータ感度レベルテンプレートを照会します。
QueryRecognizeDataByRuleType QueryRecognizeDataByRuleType 機密データ識別ルールのタイプを照会します。
QueryRecognizeRuleDetail QueryRecognizeRuleDetail Data Security Guard における指定された機微フィールドの詳細を照会します。
QueryRecognizeRulesType QueryRecognizeRulesType 機密フィールドの設定に使用される、組み込みの機密データ識別ルールを照会します。
QuerySensClassification QuerySensClassification データカテゴリを照会します。
QuerySensLevel QuerySensLevel Data Security Guard のデータ感度レベルをクエリします。
QuerySensNodeInfo QuerySensNodeInfo 機密データ識別ルールをクエリします。
RemoveEntityTags エンティティからラベルを削除します エンティティからラベルを削除します。現在、maxcompute-table タイプのエンティティのみがサポートされています。
RestartInstance RestartInstance インスタンスを再起動します。
ResumeInstance ResumeInstance 一時停止中のインスタンスを再開します。
RevokeTablePermission RevokeTablePermission ユーザーからテーブルに対する権限を取り消します。
RunCycleDagNodes RunCycleDagNodes データバックフィル用のワークフローを作成します。
RunManualDagNodes RunManualDagNodes 手動トリガーワークフロー内のノードを実行します。この操作を呼び出す前に、手動トリガーワークフローがコミットおよびデプロイされていることを確認してください。手動トリガーワークフローは、コミットおよびデプロイされた後にのみ、オペレーションセンターで見つけることができます。
RunSmokeTest RunSmokeTest スモークテストを実行するワークフローを作成します。
RunTriggerNode RunTriggerNode 手動トリガーによるノードを実行します。
ScanSensitiveData ScanSensitiveData 入力データに機密データが含まれているかどうかをチェックします。
SearchNodesByOutput SearchNodesByOutput 出力に基づいてノードをクエリします。
SetDataSourceShare データソースを共有します データソースを指定された DataWorks ワークスペースまたは指定されたユーザーと共有します。
SetEntityTags エンティティタグを設定します エンティティのタグを設定します。現在、maxcompute-table タイプのエンティティのみがサポートされています。
SetSuccessInstance SetSuccessInstance 失敗したインスタンスの状態を成功に設定します。
StartMigration StartMigration 移行タスクを開始します。
StopInstance StopInstance インスタンスを停止します。
SuspendInstance SuspendInstance インスタンスを一時停止します。
TopTenElapsedTimeInstance TopTenElapsedTimeInstance 実行中のインスタンスの実行持続時間のランキングをクエリします。
TopTenErrorTimesInstance TopTenErrorTimesInstance 直近 1 ヶ月間にエラーが発生したノードのランキングをクエリします。
UpdateBaseline UpdateBaseline ベースラインを更新します。
UpdateClusterConfigs UpdateClusterConfigs ワークスペース内のサブモジュールの構成を更新します。SPARK パラメーターを設定できます。
UpdateConnection UpdateConnection データソースを更新します。
UpdateNodeOwner UpdateNodeOwner ノードのオーナーを変更します。
UpdateNodeRunMode UpdateNodeRunMode ノードのフリーズ/フリーズ解除を行います。
UpdateQualityFollower UpdateQualityFollower サブスクリプションを更新します。
UpdateQualityRule UpdateQualityRule 指定された品質ルールを更新します。
UpdateRemind UpdateRemind カスタムアラートルールを変更します。
UpdateTable MaxCompute テーブルを更新します UpdateTable を呼び出して MaxCompute テーブルを更新します。
UpdateTableAddColumn テーブルのフィールド情報を更新します MaxCompute テーブルのフィールド情報を更新します。
UpdateWorkbenchEventResult UpdateWorkbenchEventResult オペレーションセンターのプロセスが拡張によってブロックされた後に、その拡張から送信される処理結果を返します。