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 ペア
データエージェント
|
API |
タイトル |
説明 |
| MCP サーバー管理 | MCP サーバー管理 | |
| CreateMcpServer | MCP サーバーを作成します。 | MCP サーバーを作成します。 |
| DeleteMcpServer | MCP サーバーを削除します | MCP サーバーを削除します。 |
| UpdateMcpServer | MCP サーバーを更新します。 | MCP サーバーを更新します。 |
| GetMcpServer | GetMcpServer | MCP Server の詳細を返します。 |
| ListMcpServers | ListMcpServers | MCPサーバーのページネーション付きリストを取得します。 |
| スキル管理 | スキル管理 | |
| CreateSkill | スキルを作成します。 | DataWorks に新しいスキルを作成します。 |
| UpdateSkill | スキルを更新します。 | 指定されたスキルを更新し、新しいバージョンを生成します。 |
| DeleteSkill | Delete Skill | スキルを削除します。 |
| GetSkill | GetSkill | 指定されたスキルの詳細を名前で取得します。SKILL.md ファイルの本文やバンドルのダウンロードリンクを含みます。 |
| ListSkills | ListSkills | アカウント内のSkillを一覧表示します。 |
| エージェント管理 | エージェント管理 | |
| CreateAgent | エージェントを作成します。 | エージェントを作成します。 |
| ListCustomAgents | ListCustomAgents | カスタムエージェントのページネーション付きリストを取得します。 |
| DeleteAgent | エージェントを削除します。 | エージェントを削除します。 |
| GetAgent | GetAgent | 名前でエージェントの詳細を取得します。 |
| ListAgents | エージェントリストの照会。 | 現在のテナントで利用可能なエージェントのリストを照会します。名前によるフィルターおよびページングがサポートされています。 |
| エージェントセッション管理 | エージェントセッション管理 | |
| PromptAgentSession | 会話プロンプトの送信。 | 既存の会話にユーザープロンプトを送信し、ストリーミングモードでエージェントの応答を返します。 |
| LoadAgentSession | LoadAgentSession | 既存のセッションのメッセージ履歴をロードし、SSE ストリームとして返します。セッションが存在しない場合、サーバーは SSE ストリームを通じてコード 400 の JSONRPCResponse.error を送信します。Content-Type は text/event-stream です。この操作を使用して、セッションコンテキストを復元します。 |
| ListAgentSessions | 会話リストを照会します。 | エージェントセッションの会話履歴リストを読み込みます。 |
| ListAgentSessionArtifacts | 会話のアーティファクトリストを照会します。 | 指定された会話によって生成されたアーティファクトファイルのリストを照会します。 |
| GetAgentSessionTokenUsage | GetAgentSessionTokenUsage | 指定されたセッションの AI トークン使用量を累計で取得します。 |
| GetAgentSessionArtifactMeta | GetAgentSessionArtifactMeta | セッション ID およびアーティファクトパスに基づき、アーティファクトのメタデータとコンテンツを取得します。 |
| CreateAgentSession | セッションを作成します。 | 新しいエージェントセッションを作成し、セッション ID を返します。 |
| CancelAgentSession | 会話をキャンセルします。 | 指定された会話のエージェント呼び出しを中断します。ストリーミング応答中の中断もサポートしています。 |
スペース管理
|
API |
タイトル |
説明 |
| ワークスペース | ワークスペース | |
| CreateProject | ワークスペースを作成します。 | ワークスペースを作成します。 |
| DeleteProject | ワークスペースの削除。 | DataWorks ワークスペースを削除します。 |
| UpdateProject | UpdateProject | この操作では、DataWorks ワークスペースを更新します。 |
| ListProjects | ListProjects | ご利用のアカウントが所属するテナントの DataWorks ワークスペース一覧を照会します。 |
| GetProject | ワークスペースの詳細を取得します。 | DataWorks ワークスペースの詳細を照会します。 |
| スペースロール | スペースロール | |
| CreateProjectRole | CreateProjectRole | ワークスペースのカスタムロールを作成します。 |
| DeleteProjectRole | DeleteProjectRole | ワークスペースからカスタムロールを削除します。 |
| UpdateProjectRole | ワークスペースのカスタムロールを更新します。 | ワークスペース内のカスタムロールの権限を更新します。 |
| GetProjectRole | GetProjectRole | ワークスペースロールの詳細を照会します。 |
| ListProjectRoles | ListProjectRoles | ワークスペース内のロールのページ分割されたリストを返します。 |
| スペースメンバー | スペースメンバー | |
| CreateProjectMember | ワークスペースメンバーを作成します。 | ワークスペースメンバーを追加し、そのメンバーにワークスペースロールを付与します。 |
| DeleteProjectMember | ワークスペースメンバーの削除。 | ワークスペースのメンバーと、そのメンバーに付与されたワークスペースロールを削除します。 |
| GrantMemberProjectRoles | GrantMemberProjectRoles | ワークスペースのメンバーにロールを割り当てます。 |
| RevokeMemberProjectRoles | ワークスペースメンバーからワークスペースロールを取り消します。 | ワークスペースメンバーからロールを取り消します。 |
| GetProjectMember | GetProjectMember | ワークスペース内の特定のメンバーの詳細情報を取得します。 |
| ListProjectMembers | ListProjectMembers | ワークスペースメンバーの詳細のページングされたリストを取得します。 |
データソース
|
API |
タイトル |
説明 |
| UpdateDataSource | UpdateDataSource | ID を指定してデータソースを更新します。 |
| TestDataSourceConnectivity | TestDataSourceConnectivity | リソースグループ上のデータソースのネットワーク接続性をテストします。 |
| CreateDataSource | データソースを作成します。 | 指定されたプロジェクトワークスペースの開発環境または本番環境にデータソースを作成します。 |
| DeleteDataSource | DeleteDataSource | ID を指定してデータソースを削除します。 |
| CloneDataSource | データソースをクローンします | 既存のデータソースに基づいて新しいデータソースをクローンします。 |
| ListDataSources | ListDataSources | データソースのビジネス情報を基に、データソースの一覧をクエリします。 |
| データソース共有ルール | データソース共有ルール | |
| CreateDataSourceSharedRule | CreateDataSourceSharedRule | 他のワークスペースまたは RAM ユーザーへデータソースを共有するためのルールを作成します。 |
| DeleteDataSourceSharedRule | DeleteDataSourceSharedRule | ID に基づいてデータソースの共有ルールを削除します。 |
| ListDataSourceSharedRules | ListDataSourceSharedRules | データソースの共有ルールの一覧を照会します。 |
計算リソース
|
API |
タイトル |
説明 |
| DeleteComputeResource | DeleteComputeResource | 指定されたコンピューティングリソース ID を基に、該当のコンピューティングリソースを削除します。 |
| GetComputeResource | GetComputeResource | 指定されたコンピューティングリソース ID を基に、該当のコンピューティングリソースを照会します。 |
| UpdateComputeResource | UpdateComputeResource | コンピューティングリソース ID に基づいて、指定されたコンピューティングリソースを変更します。 |
| ListComputeResources | ListComputeResources | 指定されたビジネス情報に一致する計算リソースのリストを照会します。 |
| CreateComputeResource | 計算リソースを作成します。 | 指定されたワークスペースに計算リソースを作成します。計算リソースは開発環境または本番環境に配置できます。 |
リソースグループ管理
|
API |
タイトル |
説明 |
| リソースグループ | リソースグループ | |
| CreateResourceGroup | リソースグループを作成します。 | リソースグループを作成します。 |
| DeleteResourceGroup | DeleteResourceGroup | リソースグループを削除します。 |
| UpdateResourceGroup | UpdateResourceGroup | リソースグループの基本情報を更新します。 |
| GetResourceGroup | ID によるリソースグループ情報の取得。 | ID を指定してリソースグループの情報を取得します。 |
| ListResourceGroups | ListResourceGroups | リソースグループのリストを取得します。 |
| DissociateProjectFromResourceGroup | DissociateProjectFromResourceGroup | ワークスペースからリソースグループの関連付けを解除します。 |
| AssociateProjectToResourceGroup | リソースグループをワークスペースに関連付けます。 | リソースグループをワークスペースに関連付けます。 |
| ListResourceGroupAssociateProjects | ListResourceGroupAssociateProjects | リソースグループが関連付けられているワークスペースのリストを照会します。 |
| ListResourceGroupMetricData | ListResourceGroupMetricData | リソースグループのメトリックデータを照会します。 |
| ルート | ルート | |
| CreateRoute | CreateRoute | ネットワークのルートを作成します。 |
| DeleteRoute | DeleteRoute | ネットワークリソースからルートを削除します。 |
| UpdateRoute | UpdateRoute | ルートに関する情報を更新します。 |
| GetRoute | GetRoute | 指定された ID を基に、ルートの情報を照会します。 |
| ListRoutes | ネットワークリソースのルートリストを取得します。 | ネットワークリソースのルートリストを取得します。 |
| ネットワーク | ネットワーク | |
| CreateNetwork | CreateNetwork | ネットワークを作成し、そのネットワークを汎用リソースグループに関連付けます。 |
| DeleteNetwork | 汎用リソースグループからネットワークリソースの関連付けを解除して削除します。 | 汎用リソースグループからネットワークリソースの関連付けを解除し、削除します。 |
| GetNetwork | GetNetwork | ネットワークリソースの情報を照会します。 |
| ListNetworks | ListNetworks | サーバーレスリソースグループのネットワークリソース一覧を照会します。 |
イメージ管理
|
API |
タイトル |
説明 |
| CreateImage | イメージを作成します。 | イメージを作成します。 |
| UpdateImage | イメージを更新します。 | イメージを更新します。 |
| RunImageTest | イメージテストを実行します。 | イメージテストを実行します。 |
| ListImageTestResults | イメージのテスト結果を取得します。 | イメージのテスト結果リストを取得します。 |
| GetImageTestResult | 指定されたイメージテストタスクの結果を取得します。 | イメージテスト結果の詳細を取得します。 |
| CancelImageTest | イメージテストのキャンセル | イメージテストをキャンセルします。 |
| PublishImage | イメージを公開します。 | イメージを公開します。 |
| BuildImage | イメージをビルドします | イメージをビルドします。 |
| RollbackImage | イメージをロールバックします | イメージをロールバックします。 |
| EnableImage | イメージを有効にします。 | イメージを有効にします。 |
| DisableImage | イメージを無効にします。 | イメージを無効にします。 |
| GetImage | ID によるイメージ詳細の取得。 | イメージ ID を指定して、特定のイメージの詳細を取得します。 |
| ListImages | ListImages | イメージのリストを取得します。 |
| ListImageVersions | ListImageVersions | 指定されたイメージバージョンの詳細を取得します。 |
| DeleteImage | イメージを削除します。 | イメージを削除します。 |
| AssociateProjectToImage | イメージをワークスペースに関連付けます。 | イメージをワークスペースに関連付けます。 |
| DissociateProjectFromImage | DissociateProjectFromImage | イメージとワークスペースの関連付けを解除します。 |
| ListImageAssociatedProjects | ListImageAssociatedProjects | イメージに関連付けられているワークスペースを一覧表示します。 |
データ開発 (新バージョン)
|
API |
タイトル |
説明 |
| スナップショット | スナップショット | |
| GetSnapshot | バージョンスナップショットの詳細を取得します。 | バージョンスナップショットの詳細を取得します。 |
| ListSnapshots | バージョンスナップショットリストを取得します。 | バージョンスナップショットのリストを取得します。 |
| コンポーネント | コンポーネント | |
| CreateComponent | コンポーネントを作成します。 | コンポーネントを作成します。 |
| DeleteComponent | コンポーネントを削除します。 | コンポーネントを削除します。 |
| GetComponent | GetComponent | コンポーネント情報を取得します。 |
| UpdateComponent | UpdateComponent | コンポーネントを更新します。 |
| ListComponents | ListComponents | コンポーネントの一覧を取得します。 |
| ノード | ノード | |
| CreateNode | データ開発ノードを作成します。 | DataStudio の新バージョンでデータ開発ノードを作成します。 |
| DeleteNode | データ開発ノードを削除します。 | 指定されたデータ開発ノードを削除します。 |
| UpdateNode | UpdateNode | DataStudio のノードに関する基本情報を更新します。この API オペレーションは増分更新を実行します。更新情報は FlowSpec を使用して記述されます。 |
| MoveNode | MoveNode | DataStudio でノードを指定されたパスに移動します。 |
| RenameNode | RenameNode | DataStudio 内のノード名を変更します。 |
| GetNode | GetNode | DataStudio 内のノード情報をクエリします。 |
| ListNodes | データ開発ノードの一覧表示。 | ページネーションを使用してデータ開発ノードのリストを取得し、指定された条件によるフィルターをサポートします。 |
| ListNodeDependencies | DataStudio ノードの依存関係ノードを取得します。 | 指定された DataStudio ノードの依存関係ノードをページネーション付きで取得します。 |
| ワークフロー定義 | ワークフロー定義 | |
| CreateWorkflowDefinition | DataStudio ワークフローの作成。 | DataStudio の指定されたフォルダにワークフローを作成します。 |
| ImportWorkflowDefinition | DataStudio ワークフローをインポートします。 | FlowSpec で定義されたワークフローノードとその内部の子ノードを DataStudio にインポートします。 |
| DeleteWorkflowDefinition | データ開発ワークフローの削除。 | データ開発で指定されたワークフローを削除します。 |
| UpdateWorkflowDefinition | UpdateWorkflowDefinition | DataStudio のワークフローに関する基本情報を更新します。この API オペレーションは、増分更新を実行します。更新情報は FlowSpec を使用して記述されます。 |
| MoveWorkflowDefinition | MoveWorkflowDefinition | ワークフローを DataStudio のパスに移動します。 |
| RenameWorkflowDefinition | RenameWorkflowDefinition | DataStudio におけるワークフローの名前を変更します。 |
| GetWorkflowDefinition | GetWorkflowDefinition | ワークフローの情報を照会します。 |
| ListWorkflowDefinitions | ListWorkflowDefinitions | DataStudio のワークフローのリストをクエリします。特定のワークフローをクエリするために、フィルター条件を指定することもできます。 |
| リソース | リソース | |
| CreateResource | データ開発ファイルリソースを作成します。 | データ開発用のファイルリソースを作成します。ファイルリソース情報は FlowSpec フォーマットで定義されます。 |
| DeleteResource | DeleteResource | DataStudio からファイルリソースを削除します。 |
| UpdateResource | UpdateResource | DataStudio のファイルリソースの基本情報を更新します。この API オペレーションは増分更新を実行します。更新情報は FlowSpec を使用して記述されます。 |
| GetResource | GetResource | ファイルリソースの情報を照会します。 |
| ListResources | データ開発ファイルリソースの一覧表示。 | ページネーションおよびフィルター機能をサポートしてリソースファイルを照会します。 |
| MoveResource | MoveResource | DataStudio 内のパスへファイルリソースを移動します。 |
| RenameResource | RenameResource | DataStudio におけるファイルリソースの名前変更 |
| 関数 | 関数 | |
| CreateFunction | DataStudio 関数を作成します。 | 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 | データ開発関数を一覧表示します。 | DataStudio 内の UDF 関数のページネーション付きリストを取得します。フィルター条件を使用して UDF 関数を絞り込むこともできます。 |
| 公開プロセス | 公開プロセス | |
| CreatePipelineRun | 公開プロセスを作成します。 | 新バージョンの DataStudio でエンティティの公開プロセスを作成します。 |
| AbolishPipelineRun | Deployment プロセスを停止します。 | 指定された Deployment プロセスのステータスを終了済みに変更します。Deployment プロセスは削除されず、クエリ操作で引き続き照会できます。 |
| ExecPipelineRunStage | 公開フローの指定されたステージを実行します。 | 公開フローの指定されたステージを実行します。 |
| GetPipelineRun | Deployment プロセスの詳細を取得します。 | Deployment プロセスの詳細を取得します。 |
| ListPipelineRuns | ListPipelineRuns | デプロイメントプロセスのページ分割されたリストを取得します。特定の基準に基づいてこのリストをフィルターすることもできます。 |
| ListPipelineRunItems | ListPipelineRunItems | デプロイメントプロセス ID を指定して、デプロイメント対象の情報を照会します。 |
| 個人開発環境 | 個人開発環境 | |
| ListServerIdeInstances | 個人開発環境インスタンスを照会します。 | 個人開発環境インスタンスのページングリストを照会します。 |
| GetServerIdeInstance | 個人用開発環境インスタンスの照会。 | 指定された個人用開発環境インスタンスの詳細を照会します。 |
| ListServerIdeImages | 個人用開発環境のイメージを照会します。 | ページネーションを使用して、個人用開発環境で利用可能なイメージのリストを照会します。 |
| ListServerIdeEcsSpecs | 個人用開発環境の ECS インスタンスタイプを照会します。 | 個人用開発環境で利用可能な ECS インスタンスタイプのリストを照会します。 |
| CreateServerIdeInstance | 個人用開発環境インスタンスを作成します。 | 個人用開発環境インスタンスを作成します。 |
| UpdateServerIdeInstance | 個人用開発環境インスタンスを更新します。 | 指定された個人用開発環境インスタンスの構成を更新します。 |
| StopServerIdeInstance | 個人用開発環境インスタンスを停止します。 | 指定された個人用開発環境インスタンスを停止します。 |
| StartServerIdeInstance | 個人用開発環境インスタンスを起動します。 | 指定された個人用開発環境インスタンスを起動します。 |
| DeleteServerIdeInstance | 個人用開発環境インスタンスを削除します。 | 指定された個人用開発環境インスタンスを削除します。 |
データ開発 (レガシ)
|
API |
タイトル |
説明 |
| ファイル | ファイル | |
| CreateFile | DataStudio にファイルを作成します。 | DataStudio にファイルを作成します。この操作では Data Integration ノードの作成はサポートされていません。 |
| CreateResourceFile | CreateResourceFile | DataWorks のデータ開発向けリソースファイルを作成する際に、ユーザーが自身のファイル(JAR、PY、アーカイブ、または通常のファイルなど)を指定できるようにサポートします。 |
| CreateUdfFile | CreateUdfFile | DataStudio で関数用のファイルを作成します。 |
| UpdateFile | UpdateFile | ファイルを更新します。 |
| UpdateUdfFile | UpdateUdfFile | 関数のファイル情報を更新します。 |
| GetFile | GetFile | この API は、ファイルの詳細を取得するために使用されます。 |
| ListFiles | ファイルリストの照会。 | ファイルのリストを照会します。 |
| SubmitFile | SubmitFile | ファイルをスケジューリングシステムの開発環境にコミットして、タスクを生成します。 |
| DeployFile | ファイルのデプロイ | ファイルを本番環境にデプロイします。 |
| フォルダ | フォルダ | |
| CreateFolder | CreateFolder | フォルダを作成します。 |
| DeleteFolder | DeleteFolder | Data Development ページでフォルダを削除するには、DeleteFolder を呼び出します。 |
| UpdateFolder | UpdateFolder | UpdateFolder を呼び出して、フォルダ情報を更新します。 |
| GetFolder | GetFolder | フォルダの情報を照会します。 |
| ListFolders | フォルダリストの照会。 | フォルダのリストを照会します。 |
| ビジネスフロー | ビジネスフロー | |
| CreateBusiness | ビジネスプロセスを作成します。 | データ開発用のビジネスプロセスを DataStudio に作成します。 |
| DeleteBusiness | DeleteBusiness | ワークフローを削除します。 |
| UpdateBusiness | UpdateBusiness | ワークフローを更新します。 |
| GetBusiness | ビジネスプロセスの詳細を照会します。 | ビジネスプロセスの詳細を照会します。 |
| ListBusiness | ListBusiness | ワークフローのリストを照会します。 |
| 公開パッケージ | 公開パッケージ | |
| GetDeploymentPackage | デプロイメントパッケージの詳細を取得します。 | デプロイメントパッケージの詳細を取得します。 |
| ListDeploymentPackages | デプロイメントパッケージを照会します。 | デプロイメントパッケージのリストを照会します。 |
| ListDeploymentPackageFiles | Deployment 待ちのファイルバージョンを取得します。 | デプロイメント待ちのファイルバージョンのリストを取得します。 |
| ファイルバージョン | ファイルバージョン | |
| GetFileVersion | ファイルバージョンの詳細を取得します。 | ファイルのバージョンの詳細を取得します。 |
| ListFileVersions | ファイルバージョンの照会。 | ファイルのバージョンリストを照会します。 |
| 拡張ポイントイベント | 拡張ポイントイベント | |
| UpdateIDEEventResult | 拡張ポイントイベントのチェック結果を更新します。 | 拡張ポイントイベントメッセージのチェック結果を返します。 |
| GetIDEEventDetail | GetIDEEventDetail | DataWorks OpenEvent のメッセージ ID を指定して、関連する拡張ポイントイベントがトリガーされた際に生成される拡張ポイントのデータスナップショットを照会します。 |
| テーブル | テーブル | |
| EstablishRelationTableToBusiness | EstablishRelationTableToBusiness | テーブルをワークフローにインポートします。この API オペレーションの呼び出しは、以下の操作と同等です:DataStudio ページに移動し、目的のワークフローを見つけ、ワークフロー名をクリックします。その後、目的のフォルダ内の **[テーブル]** を右クリックして、**[テーブルのインポート]** を選択します。 |
Data Integration
|
API |
タイトル |
説明 |
| 同期タスク | 同期タスク | |
| CreateDIJob | Data Integration 同期タスクを作成します。 | Data Integration タスクを作成します。 |
| UpdateDIJob | UpdateDIJob | データ統合タスクを更新します。 |
| DeleteDIJob | DeleteDIJob | 新バージョンの同期タスクを削除します。 |
| StopDIJob | Data Integration 同期タスクを停止します。 | Data Integration タスクを中止します。 |
| StartDIJob | StartDIJob | 新バージョンの同期タスクを開始します。 |
| GetDIJob | GetDIJob | データ統合タスクを表示します。 |
| GetDIJobLog | Data Integration 同期タスクの実行ログを表示します。 | Data Integration ノードのタスクログを取得します。 |
| ListDIJobs | ListDIJobs | データ統合ジョブを一覧表示します。 |
| ListDIJobRunDetails | ListDIJobRunDetails | 同期タスクの実行情報を照会します。 |
| ListDIJobMetrics | ListDIJobMetrics | 同期タスクのメトリックをクエリします。 |
| ListDIJobEvents | ListDIJobEvents | 同期タスクのイベントを照会します。 |
| タスクアラート | タスクアラート | |
| CreateDIAlarmRule | Data Integration 同期タスクのアラートルールを作成します。 | Data Integration タスクのアラートルールを作成します。 |
| UpdateDIAlarmRule | UpdateDIAlarmRule | 同期タスクに対して設定されたアラートルールを更新します。 |
| DeleteDIAlarmRule | DeleteDIAlarmRule | 同期タスクに設定されたアラートルールを削除します。 |
| ListDIAlarmRules | ListDIAlarmRules | 同期タスクに設定されたアラートルールを表示します。 |
データマップ
|
API |
タイトル |
説明 |
| セマンティック分析 | セマンティック分析 | |
| ListSemanticJobs | セマンティックタスクの一覧表示。 | 現在のテナントのセマンティックノード解像度をページングしてクエリします。リスト項目の Name、ProjectId、Source フィールドは、それぞれノードの実行/削除、実行詳細のクエリ、入力範囲の確認に使用できます。 |
| CreateSemanticJob | セマンティックタスクを作成します。 | 再利用可能なセマンティックタスク定義を保存します。単一ファイルソースを使用する場合は、事前に添付ファイルのアップロードを申請して完了してください。作成後、返された Name を使用して RunSemanticJob を呼び出します。 |
| DeleteSemanticJob | セマンティックタスクを削除します。 | 作成済みのタスクの名前を指定して、セマンティックタスク解像度を削除します。タスクが現在実行中の場合は、その実行の ExecutorJobId を指定して KillSemanticJob を呼び出し、停止を確認してから削除してください。 |
| DownloadSemanticResults | 意味理解タスクの結果ダウンロード URL を取得します。 | タスク名とオプションの実行 ID を指定して、実行完了後にアーティファクトのダウンロード URL を取得します。JobRunId が指定されていない場合は、そのタスクの最新の実行結果が返されます。 |
| GetSemanticJobDetail | セマンティックジョブの実行詳細を照会します。 | RunSemanticJob または ListSemanticJobRuns が返す ExecutorJobId を使用して、エグゼキュータのステータスとランタイム構成を照会します。 |
| RunSemanticJob | セマンティックタスクを実行します。 | 名前を指定して保存済みのセマンティックタスクを実行用に送信し、実行 ID およびエグゼキュータ識別子を返します。呼び出しが成功したことはタスクが送信されたことを示しており、意味理解モデルの結果が生成されたことを示すものではありません。 |
| ListSemanticJobRuns | セマンティックタスクの実行 Record をクエリします。 | 名前を指定して、作成されたノードの実行 Record をページング付きでクエリします。各 Record の JobRunId は特定の実行結果を取得するためにアクティブな値であり、ExecutorJobId は詳細のクエリ、ログの取得、または実行の停止にアクティブな値です。 |
| GetSemanticJobLog | セマンティックジョブの実行ログを照会します。 | RunSemanticJob または ListSemanticJobRuns が返す ExecutorJobId を使用して、実行ログを照会します。現在の POP コントラクトでは、タスクおよびワークスペースの識別子のみが公開されており、デフォルトのログセグメントが返されます。 |
| KillSemanticJob | セマンティックジョブの実行を停止します。 | RunSemanticJob または ListSemanticJobRuns によって返された ExecutorJobId を使用して、指定された実行を停止します。呼び出しが成功したことは、停止リクエストが受け入れられたことのみを示します。最終的なステータスは GetSemanticJobDetail を呼び出して照会してください。 |
| UploadSemanticFile | セマンティックタスクの添付ファイル用アップロード URL をリクエストします。 | 一時的な OSS PUT アップロード URL をリクエストします。URL の有効期限が切れる前に PUT アップロードを完了し、返された FileId を CreateSemanticJob の ReferenceFileIds パラメーターに渡してください。 |
| カスタム属性 | カスタム属性 | |
| ListCustomAttributes | カスタム属性の一覧表示。 | カスタム属性解像度のリストを照会します。 |
| GetCustomAttribute | GetCustomAttribute | カスタム属性の定義を取得します。 |
| CreateCustomAttribute | カスタム属性を作成します。 | カスタム属性の定義を作成します。 |
| UpdateCustomAttribute | UpdateCustomAttribute | カスタム属性を更新します。 |
| DeleteCustomAttribute | DeleteCustomAttribute | カスタム属性解像度を削除します。 |
| カスタムメタデータエンティティ定義 | カスタムメタデータエンティティ定義 | |
| ListMetaEntityDefs | メタデータエンティティ解像度リストの照会。 | カスタムエンティティタイプおよび拡張テーブルタイプを含む、カスタムエンティティ解像度のリストを照会します。 |
| GetMetaEntityDef | GetMetaEntityDef | カスタムエンティティ解像度の詳細を取得します。 |
| CreateMetaEntityDef | メタデータエンティティタイプ定義を作成します。 | メタデータエンティティ定義を作成します。カスタムタイプおよび拡張テーブルタイプを含みます。 |
| UpdateMetaEntityDef | メタデータエンティティ解像度の更新。 | カスタムエンティティタイプおよび拡張テーブルタイプを含むメタデータエンティティ解像度を更新します。 |
| DeleteMetaEntityDef | メタデータエンティティ解像度の削除。 | カスタムエンティティタイプおよび拡張テーブルタイプを含むメタデータエンティティ解像度を削除します。 |
| メタデータコレクター | メタデータコレクター | |
| ListCrawlerTypes | ListCrawlerTypes | Data Map でサポートされるメタデータクローラーの種類の一覧を照会します。また、各種類のサブタイプおよびサブタイプ間の階層関係も返されます。 |
| GetCrawlerTypeCapabilities | クローラータイプの機能の照会。 | 現在のリージョンでサポートされているクローラータイプ、およびそのコレクション範囲、スケジューリング、拡張構成機能に関する情報を照会します。 |
| CreateCrawler | メタデータクローラーを作成します。 | メタデータクローラーを作成し、データソース、コレクションの範囲、リソースグループ、およびスケジューリングメソッドを構成します。 |
| ListCrawlers | メタデータクロールの一覧表示。 | ワークスペース、データソース、タイプ、環境、オーナー、名前でフィルターして、メタデータクロールをページングクエリします。 |
| GetCrawler | メタデータクローラーの詳細を照会します。 | 指定されたメタデータクローラーの構成、ステータス、および最新の実行情報を照会します。 |
| UpdateCrawler | メタデータクローラーの更新。 | 指定されたメタデータクローラーのリソースグループ、コレクション範囲、スケジューリング、および拡張構成を更新します。 |
| RunCrawler | メタデータクローラーを実行します。 | 指定されたメタデータクローラーを実行し、送信ステータスおよび関連するタスクインスタンス情報を返します。 |
| StopCrawler | メタデータクローラーの実行を停止します。 | 指定されたメタデータクローラーの現在実行中のタスクを停止します。 |
| ListCrawlerRuns | クローラー実行 Record の照会。 | 指定されたメタデータクローラーの実行 Record をページングして照会します。時間範囲および実行ステータスによるフィルタリングも可能です。 |
| DeleteCrawler | メタデータクローラーを削除します。 | 指定されたメタデータクローラーを削除します。 |
| メタデータエンティティ | メタデータエンティティ | |
| カスタムエンティティ | カスタムエンティティ | |
| ListMetaEntities | メタデータエンティティリストの照会。 | メタデータエンティティのリストを照会します。現在、カスタムエンティティタイプのみがサポートされています。 |
| GetMetaEntity | GetMetaEntity | カスタムエンティティの詳細を取得します。 |
| BatchCreateMetaEntities | メタデータエンティティのバッチ作成。 | メタデータエンティティをバッチで作成します。同じバッチ内のすべてのエンティティは同じタイプである必要があります。現在、カスタムエンティティタイプと拡張テーブルタイプ(データベース/テーブルに対応)のみがサポートされています。 |
| UpdateMetaEntity | UpdateMetaEntity | メタデータエンティティを更新します。カスタムエンティティや、データベース、テーブル、カラムなどの拡張テーブルタイプのオブジェクトを更新できます。 |
| BatchDeleteMetaEntities | メタデータエンティティのバッチ削除。 | メタデータエンティティオブジェクトをバッチで削除します。カスタムエンティティおよび拡張テーブルタイプオブジェクト(データベース/テーブル)の削除をサポートします。カラムを個別に削除することはできません。Table を削除することで、関連する Column オブジェクトを削除できます。 |
| データカタログ | データカタログ | |
| ListCatalogs | ListCatalogs | Data Map におけるカタログの一覧をクエリします。対応しているのは、Data Lake Formation (DLF) 型および StarRocks メタデータクローラー型のカタログのみです。DLF メタデータクローラー型の場合、すべてのサポート対象データカタログが返されます。StarRocks メタデータクローラー型の場合、特定のインスタンスに属するデータカタログが返されます。 |
| GetCatalog | データマップでデータカタログの詳細を取得します。 | DataWorks データマップで指定されたデータカタログの詳細を取得します。現在、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 | データマップのテーブル詳細を取得します。 | データマップ内の指定されたテーブルの詳細を取得します。ビジネスメタデータを返すかどうかを選択できます。 |
| UpdateTableBusinessMetadata | データマップテーブルのビジネスメタデータを更新します。 | データマップ内のテーブルのビジネスメタデータを更新します。現在、テーブルの使用量の説明とカスタム属性のみを更新できます。 |
| SubmitBatchChangeTableOwner | テーブルオーナーの一括更新。 | テーブルのオーナーを転送するためのバッチリクエストを送信します。 |
| GetBatchChangeTableOwnerStatus | バッチテーブルオーナー転送ステータスの取得。 | バッチテーブルオーナー転送タスクのステータスを照会します。 |
| フィールド | フィールド | |
| ListColumns | データマップテーブルのカラムを照会します。 | DataWorks データマップの指定されたテーブルのカラムリストを照会します。 |
| GetColumn | データマップテーブルのカラム情報を取得します。 | データマップテーブルの指定されたカラムの詳細を取得します。 |
| UpdateColumnBusinessMetadata | UpdateColumnBusinessMetadata | データマップ内の列のビジネスメタデータを更新します。このオペレーションでは、ビジネス記述とカスタム属性のみを更新できます。 |
| データセット | データセット | |
| ListDatasets | ListDatasets | データセットの一覧を照会します。現在、DataWorks データセットおよび PAI データセットがサポートされています。 |
| GetDataset | GetDataset | データセットの**詳細**を取得します。 |
| CreateDataset | データセットを作成します。 | データセットを作成します。参加しているワークスペースでのみデータセットを作成できます。DataWorks データセットのみがサポートされています。テナントあたりのデータセットの最大値は 2000 です。 |
| UpdateDataset | UpdateDataset | データセットの情報を更新します。対象は DataWorks データセットのみです。実行者は、当該データセットの作成者または、データセットが配置されているワークスペースの管理者である必要があります。 |
| DeleteDataset | データセットを削除します。 | データセットを削除します。DataWorks データセットのみがサポートされています。対応するデータセットバージョンはカスケード削除されます。演算子は、データセットの作成者であるか、またはデータセットが属するワークスペースの管理者である必要があります。 |
| データセットバージョン | データセットバージョン | |
| ListDatasetVersions | ListDatasetVersions | 指定されたデータセットのバージョン一覧を取得します。 |
| GetDatasetVersion | GetDatasetVersion | 指定されたデータセットバージョンの情報を取得します。 |
| CreateDatasetVersion | データセットバージョンを作成します。 | データセットバージョンを作成します。現在、DataWorks データセットのみがサポートされています。バージョンの最大値は 20 です。 |
| UpdateDatasetVersion | UpdateDatasetVersion | データセットのバージョン情報を更新します。DataWorks データセットのみがサポートされています。データセットの作成者またはワークスペース管理者の権限が必要です。 |
| 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 | データマップテーブルのパーティションを照会します。 | DataWorks データマップで指定されたテーブルのパーティションリストを照会します。現在、MaxCompute および HMS (EMR クラスター) タイプがサポートされています。 |
| GetPartition | GetPartition | データマップテーブルのパーティション詳細を取得します。現在は MaxCompute および HMS(EMR クラスター)タイプのみ対応しています。 |
| リネージ | リネージ | |
| ListLineageRelationships | データマップでデータリネージ関係リストを照会します。 | DataWorks データマップで、2 つの指定されたエンティティ(テーブル、フィールド、OSS ファイルなど)間のデータリネージ関係のリストを照会します。 |
| GetLineageRelationship | データリネージ関係の詳細を取得します。 | DataWorks データマップで指定されたデータリネージ関係の詳細を取得します。 |
| DeleteLineageRelationship | データリネージ関係を削除します。 | DataWorks データマップから指定されたデータリネージ関係を削除します。 |
| CreateLineageRelationship | データマップにデータリネージ関係を登録します | DataWorks データマップにデータリネージ関係を登録します。この操作を使用して、DataWorks が管理するメタデータエンティティ間のリネージ関係を確立できます。テーブル間、カラム間、テーブルとカラム間、データセットとテーブル間のシナリオに対応しています。また、管理対象エンティティとユーザーが登録したカスタムエンティティオブジェクト間のリネージ関係も確立できます。この操作は非管理カスタムオブジェクトと互換性がありますが、このアプローチは推奨されなくなりました。この操作を呼び出す前に、リネージ登録に関連する管理対象エンティティが DataWorks プラットフォーム上に既に存在していることを確認してください。 |
| ListLineages | データマップエンティティのデータリネージリストを照会します。 | DataWorks データマップで指定されたエンティティの上流および下流のリネージエンティティを照会します。詳細なリネージ関係情報を含めるオプションがあります。 |
| メタデータコレクション | メタデータコレクション | |
| ListMetaCollections | データマップコレクションリストの照会。 | データマップコレクションのリストをクエリします。データマップカテゴリとデータアルバムの両方のクエリをサポートします。 |
| CreateMetaCollection | CreateMetaCollection | データマップにコレクションを作成します。コレクションには、カテゴリ、サブカテゴリ、データアルバム、およびデータアルバム内に作成されるカテゴリが含まれます。 |
| GetMetaCollection | GetMetaCollection | Data Map のコレクションに関する情報を照会します。コレクションにはカテゴリおよびデータアルバムが含まれます。 |
| UpdateMetaCollection | UpdateMetaCollection | Data Map のコレクションオブジェクト(データマップカテゴリおよびデータアルバム)を更新します。コレクション名、説明文、管理者情報を変更できます。データアルバムを更新する場合、呼び出し元は `AliyunDataWorksFullAccess` 権限を持つユーザーであるか、当該アルバムの作成者または管理者である必要があります。 |
| DeleteMetaCollection | DeleteMetaCollection | 指定されたデータマップ内のコレクションオブジェクト(データマップのカテゴリおよびデータアルバムを含む)を削除します。 データアルバムを削除する場合、呼び出し元は AliyunDataWorksFullAccess 権限を持つユーザーであるか、アルバムの作成者または管理者である必要があります。 |
| ListEntitiesInMetaCollection | ListEntitiesInMetaCollection | Data Map 内のコレクションに登録されたエンティティの一覧を照会します。コレクションにはカテゴリおよびデータアルバムが含まれます。エンティティとしてサポートされるのはテーブルのみです。 |
| 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 | カスタム監視アラートルールを取得します。 | カスタム監視アラートルールを取得します。 |
| UpdateAlertRule | UpdateAlertRule | カスタムアラート監視ルールの情報を更新します。 |
| DeleteAlertRule | カスタムルールを削除します。 | カスタム監視アラートルールを削除します。 |
| CreateAlertRule | カスタム監視アラートルールを作成します。 | カスタム監視アラートルールを作成します。 |
| タスク | タスク | |
| GetUpdateTaskResult | ノード更新タスクの結果を取得します。 | ワークフローインスタンスの非同期作成結果を照会します。 |
| UpdateTaskAsync | ノードを更新します。 | 指定されたノードを更新し、変更を DataStudio に同期して新しい保存バージョンを作成します。 |
| DeleteTask | DeleteTask | タスクを削除します。 |
| UpdateTask | ノードを更新します。 | 指定されたノードを更新します。変更内容は DataStudio に同期され、新しい保存バージョンが作成されます。 |
| BatchUpdateTasks | ノードの一括更新。 | 増分更新を使用して複数のノードを一括更新します。 |
| GetTask | GetTask | タスクの情報を照会します。 |
| ListTasks | ListTasks | ページごとにタスクのリストをクエリします。フィルター条件を指定してタスクをクエリすることもできます。 |
| ListUpstreamTasks | ListUpstreamTasks | タスクの祖先タスクの一覧をページ単位で照会します。 |
| ListDownstreamTasks | ListDownstreamTasks | タスクの子孫タスクの一覧をページ単位で照会します。 |
| ListTaskOperationLogs | ListTaskOperationLogs | タスクの操作ログをページ単位で一覧表示します。 |
| タスクインスタンス | タスクインスタンス | |
| UpdateTaskInstances | UpdateTaskInstances | 複数のタスクインスタンスのプロパティ (優先度、リソースグループ、データソースなど) をバッチで変更します。 |
| GetTaskInstance | タスクインスタンスの詳細を取得します。 | 指定されたタスクインスタンスの詳細を取得します。 |
| GetTaskInstanceLog | GetTaskInstanceLog | インスタンスの特定の実行中に生成された実行ログを照会します。 |
| ListTaskInstances | インスタンスを一覧表示します。 | ノードインスタンスをページごとに一覧表示し、条件によるフィルターをサポートします。 |
| ListUpstreamTaskInstances | 上流インスタンスの一覧表示。 | 指定されたインスタンスの上流インスタンスをページごとに取得します。 |
| ListTaskInstanceOperationLogs | ListTaskInstanceOperationLogs | インスタンスの操作ログをページ単位で一覧表示します。 |
| ListDownstreamTaskInstances | 下流インスタンスの一覧表示。 | 指定されたインスタンスの下流インスタンスのページネーションリストを取得します。 |
| SuspendTaskInstances | SuspendTaskInstances | 複数のインスタンスを一度に中断します。 |
| ResumeTaskInstances | ResumeTaskInstances | 複数の中断済みタスクインスタンスを一度に再開します。 |
| StopTaskInstances | インスタンスを停止します。 | 複数のインスタンスをバッチで停止します。 |
| SetSuccessTaskInstances | SetSuccessTaskInstances | 複数のタスクインスタンスのステータスを一度に「成功」に設定します。 |
| RerunTaskInstances | ノードインスタンスの再実行。 | 複数のノードインスタンスをバッチで再実行します。 |
| RemoveTaskInstanceDependencies | RemoveTaskInstanceDependencies | インスタンスの複数の上流依存関係を一度に削除します。 |
| TriggerSchedulerTaskInstance | TriggerSchedulerTaskInstance | 指定された時刻に HTTP トリガーノードを用いてタスクを実行します。 |
| ワークフロー | ワークフロー | |
| DeleteWorkflow | ワークフローを削除します。 | 指定されたワークフローを削除します。 |
| ワークフローインスタンス | ワークフローインスタンス | |
| GetRerunWorkflowInstancesResult | GetRerunWorkflowInstancesResult | 非同期で再実行されたワークフローインスタンスの結果をクエリします。 |
| RerunWorkflowInstances | RerunWorkflowInstances | ワークフローインスタンスの再実行 |
| CreateWorkflowInstances | ワークフローインスタンスを作成します。 | データバックフィルワークフローインスタンスなど、構成に基づいてワークフローインスタンスを作成します。 |
| GetCreateWorkflowInstancesResult | GetCreateWorkflowInstancesResult | ワークフローインスタンスの非同期作成結果をクエリします。 |
| GetWorkflowInstance | GetWorkflowInstance | ワークフローインスタンスの情報を照会します。 |
| ListWorkflowInstances | ワークフローインスタンスの一覧表示。 | ワークフローインスタンスのページネーションリストを取得します。指定された条件で結果をフィルターできます。 |
| StartWorkflowInstances | ワークフローインスタンスを開始します。 | 複数のワークフローインスタンスをバッチで開始します。 |
| StopWorkflowInstances | StopWorkflowInstances | 複数のワークフローインスタンスを一度に停止します。 |
| ExecuteAdhocWorkflowInstance | 一時的なワークフローインスタンスを実行します。 | 指定された構成に基づいて一時的なワークフローインスタンスを作成します。 |
Data Quality
|
API |
タイトル |
説明 |
| Data Quality ルールテンプレート | Data Quality ルールテンプレート | |
| CreateDataQualityTemplate | Data Quality ルールテンプレートを作成します。 | 指定されたプロジェクトに Data Quality ルールテンプレートを作成します。 |
| UpdateDataQualityTemplate | UpdateDataQualityTemplate | プロジェクト内のデータ品質ルールテンプレートを更新します。 |
| ListDataQualityTemplates | Data Quality ルールテンプレートの一覧表示。 | 指定されたプロジェクトの Data Quality ルールテンプレートのリストを照会します。 |
| GetDataQualityTemplate | GetDataQualityTemplate | ID に基づいてデータ品質ルールテンプレートの詳細を照会します。 |
| DeleteDataQualityTemplate | DeleteDataQualityTemplate | 指定された ID でデータ品質ルールテンプレートを削除します。 |
| Data Quality モニタリング | Data Quality モニタリング | |
| CreateDataQualityScan | CreateDataQualityScan | データ品質モニターを作成します。 |
| UpdateDataQualityScan | UpdateDataQualityScan | データ品質モニターを更新します。 |
| ListDataQualityScans | ListDataQualityScans | プロジェクト内のデータ品質スキャンタスクの一覧を照会します。 |
| GetDataQualityScan | GetDataQualityScan | データ品質モニタリングの詳細を取得します。 |
| DeleteDataQualityScan | DeleteDataQualityScan | データ品質モニターを削除します。 |
| アラートルール | アラートルール | |
| CreateDataQualityAlertRule | Data Quality アラートルールを作成します。 | 指定されたプロジェクトに Data Quality モニタリングアラートルールを作成します。 |
| UpdateDataQualityAlertRule | Data Quality アラートルールの更新。 | 指定された Data Quality モニタリングアラートルールを更新します。 |
| ListDataQualityAlertRules | ListDataQualityAlertRules | プロジェクト内のデータ品質アラートルールの一覧を照会します。 |
| GetDataQualityAlertRule | GetDataQualityAlertRule | アラートルール ID に基づいて、データ品質モニタリングおよびアラートルールの詳細を照会します。 |
| DeleteDataQualityAlertRule | Data Quality アラートルールの削除。 | 指定された ID に基づいて Data Quality モニタリングのアラートルールを削除します。 |
| Data Quality 実行 | Data Quality 実行 | |
| CreateDataQualityScanRun | Data Quality スキャン実行の作成。 | 指定された Data Quality モニタリングタスクの実行をトリガーし、実行インスタンス ID を返します。 |
| ListDataQualityScanRuns | ListDataQualityScanRuns | 指定されたプロジェクトにおけるデータ品質スキャン実行の履歴を照会します。 |
| GetDataQualityScanRunLog | Data Quality スキャン実行ログを取得します。 | 指定された Data Quality モニタリングタスクインスタンスのログ内容を照会します。 |
| 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 | ID 認証情報を作成します。 | ID 認証情報を作成します。 |
タグ管理
|
API |
タイトル |
説明 |
| CreateDataAssetTag | ラベルを作成します。 | ラベルを作成します。 |
| DeleteDataAssetTag | DeleteDataAssetTag | タグを削除します。 |
| UpdateDataAssetTag | ラベルを更新します。 | ラベルを更新します。 |
| ListDataAssetTags | ListDataAssetTags | タグの一覧を照会します。 |
| TagDataAssets | TagDataAssets | データ資産にタグを追加します。 |
| UnTagDataAssets | UnTagDataAssets | データ資産からタグを削除します。 |
| ListDataAssets | タグに関連付けられたデータ資産のクエリ。 | タグに関連付けられた DataWorks データ資産をページ単位で照会します。 |
オープンプラットフォーム
|
API |
タイトル |
説明 |
| GetJobStatus | 非同期 API の実行ステータスを取得します。 | 非同期タスクのステータスを返します。非同期 API を呼び出した後、この API をポーリングして成功ステータスを取得します。 |
その他
|
API |
タイトル |
説明 |
| ListDataQualityEvaluationTasks | 品質モニタリングタスクの一覧表示。 | 品質モニタリングノードのページングリストを照会します。 |
| ListDataQualityRules | 品質ルールの一覧表示。 | 品質モニタリングルールをページ単位で照会します。 |
| ListDataQualityEvaluationTaskInstances | 品質モニタリングタスクインスタンスのリストを照会します | 品質モニタリングタスクインスタンスリストのページング照会を実行します。 |
| ListDataQualityResults | Data Quality の結果を照会します | ページングを使用して Data Quality の結果リストを照会します。 |
| DetachDataQualityRulesFromEvaluationTask | データ品質ルールとモニタリングタスクの関連付けを解除する | データ品質ルールとデータ品質モニタリングタスクの関連付けを解除します。 |
| DeleteDataQualityEvaluationTask | Data Quality モニターを削除します | Data Quality モニタリングタスクを削除します。 |
| GetDataQualityEvaluationTaskInstance | データ検証チェックタスクインスタンスの詳細を取得します | データ検証チェックタスクインスタンスの詳細を取得します。 |
| GetDataQualityEvaluationTask | Data Quality モニタリングの詳細を照会します | Data Quality データ有効性検証タスクの詳細を照会します。 |
| AttachDataQualityRulesToEvaluationTask | Data Quality ルールを品質モニタリングに関連付けます。 | Data Quality ルールを Data Quality チェックタスクに関連付けます。 |
| UpdateDataQualityEvaluationTask | Data Quality モニタリングを更新します | Data Quality データ検証タスクを更新します。 |
| CreateDataQualityEvaluationTaskInstance | Data Quality チェックモニタリングインスタンスを作成します。 | Data Quality チェックタスクインスタンスを作成します。 |
| CreateDataQualityEvaluationTask | Data Quality モニターを作成します。 | DataWorks Data Quality モニターを作成します。 |
| 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 | Data Quality ルールテンプレートの一覧表示。 | Data Quality ルールテンプレートのリストを照会します。 |
| DeleteCertificate | 証明書ファイルを削除します。 | 証明書ファイルを削除します。 |
| GetCertificate | GetCertificate | 認証ファイルを表示できます。 |
| GetDataSource | データソースの詳細を表示します。 | データソース ID を指定してデータソースを照会します。 |
| ImportCertificate | ImportCertificate | 証明書ファイルをインポートします。 |
| ListCertificates | ListCertificates | 証明書ファイルの一覧をクエリします。 |
| DeleteFile | DeleteFile | DataStudio からファイルを削除します。ファイルがコミット済みの場合、スケジューリングシステムでファイルを削除するための非同期プロセスがトリガーされます。返された DeploymentId パラメーターの値は、GetDeployment 操作を呼び出して非同期プロセスのステータスをポーリングするために使用されます。 |
| GetWorkflow | GetWorkflow | ワークフローの情報を照会します。 |
| ListWorkflows | ListWorkflows | ページごとにワークフローのリストをクエリします。フィルター条件を指定してワークフローをクエリすることもできます。 |
| UpdateWorkflow | ワークフローを更新します。 | フルアップデートメソッドを使用して、指定されたワークフローを更新します。DataStudio に同期して更新できるフィールドには、オーナー、データソース、スケジュールリソースグループ、説明、およびトリガー実行モード(Normal、Skip、または Pause)が含まれます。 |
| AbolishCrossProjectPipelineRun | クロスワークスペース公開フローを停止します。 | クロスワークスペース公開フローを停止します。 |
| CreateCrossProjectPipelineRun | クロスワークスペース Deployment フローを作成します。 | クロスワークスペース Deployment フローを作成します。 |
| ExecCrossProjectPipelineRun | クロスワークスペース公開フローを実行します。 | クロスワークスペース公開フローを実行します。 |
| GetCrossProjectPipelineRun | クロスワークスペースDeploymentフローの詳細を照会します。 | クロスワークスペースDeploymentフローの詳細を照会します。 |
| ListCrossProjectDeploymentCandidates | クロスワークスペース Deployment の候補オブジェクトを照会します。 | クロスワークスペース Deployment の候補オブジェクトを照会します。 |
| ListCrossProjectDeploymentEnvironments | クロスワークスペース Deployment 環境を照会します。 | クロスワークスペース Deployment 環境を照会します。 |
| ListCrossProjectPipelineRunItems | クロスワークスペース公開パイプラインの項目を照会します。 | クロスワークスペース公開パイプラインの公開項目を照会します。 |
| ListCrossProjectPipelineRuns | クロスワークスペース公開フローを照会します。 | クロスワークスペース公開フローのリストを照会します。 |
Others
|
API |
タイトル |
説明 |
| ReplyAgentSession | 会話入力リクエストに応答します。 | DataAgent の会話で保留中のユーザーインタラクションに応答します。 |