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

:概要

最終更新日:Nov 05, 2024

DataWorksは、テナント、メタデータ、DataStudio、Operation Center、Data Integrationなどの複数のモジュールのAPI操作を提供します。 1秒あたりのクエリ数 (QPS) の制限、1日の最大呼び出し数、および適用可能なDataWorksエディションは、API操作によって異なります。 このトピックでは、適用可能なエディションとリージョン、課金ルール、およびAPI操作の呼び出し制限について説明し、API操作を関数ごとに一覧表示します。

該当するスコープ

  • 該当するエディション:

    DataWorksモジュールに関連するAPI操作には、DataWorksモジュールと同じエディション要件があります。

    • さまざまなDataWorksエディションで呼び出すことができるAPI操作の制限については、「呼び出し制限」をご参照ください。

    • DataWorksは、各暦月にAPI操作を呼び出すための無料のクォータを提供します。 無料クォータが使い果たされると、従量課金に基づいて課金されます。 無料クォータと課金ルールの詳細については、「無料クォータと課金ルール」をご参照ください。

    • API操作とDataWorksエディション間のマッピングについては、「関数別の操作のリスト」をご参照ください。

  • 該当するリージョン:

    中国 (杭州) 、中国 (上海) 、中国 (深セン) 、中国 (北京) 、中国 (張家口) 、中国 (張家口) 、中国北部2 Ali Gov、中国東部2金融、中国 (成都) 、中国 (香港) 、シンガポール、インドネシア (ジャカルタ) 、米国 (シリコンバレー) 、インド (ムンバイ) サービス終了、米国 (バージニア) 、ドイツ (フランクフルト) 、英国 (ロンドン) 、日本 (東京) 、オーストラリア (シドニー) サービス終了、マレーシア (クアラルンプール)

コール制限

DataWorks API操作は、API操作呼び出しを標準化し、システムの安定性を確保するために3つのレベルに分類されます。 詳細については、「機能別操作一覧」をご参照ください。 次の表に、さまざまなDataWorksエディションのさまざまなレベルでのAPI操作のQPS制限と1日の最大呼び出し数を示します。

説明

DataWorksがAPI呼び出しに対して提供する無料クォータの表示方法、実行したAPI呼び出しの数、およびAPI呼び出しの詳細については、「API呼び出しに関する情報の表示」をご参照ください。

エディション

QPS制限

1日の最大通話数

Basic Edition

レベル1、レベル2、またはレベル3のAPI操作の場合、≤ 5

≤ 100

Standard Edition

≤ 1,000

Professional Edition

≤ 10,000

Enterprise Edition

  • レベル1でのAPI操作の場合は ≤ 50

  • レベル2でのAPI操作の場合は ≤ 20

  • レベル3でのAPI操作の場合は ≤ 5

  • レベル1またはレベル2のAPI操作には無制限

  • レベル3でのAPI操作のための ≤ 10,000

重要
  • QPSとAPI呼び出しの数は、Alibaba CloudアカウントとAlibaba Cloudアカウント内のRAMユーザーの各リージョンのすべてのAPI操作の呼び出しの合計数を累積して計算されます。

  • QPSまたは1日の呼び出し数が上限を超えると、API呼び出しは失敗します。 呼び出しの同時実行性と開始されるAPI呼び出しの数を制御することをお勧めします。

  • 1日の呼び出しの最大数には、成功したAPI呼び出しの数と失敗したAPI呼び出しの数が含まれます。

無料のクォータと課金ルール

DataWorksは、API操作を呼び出すための無料のクォータを提供します。 無料クォータを使い切った後、従量課金方法に基づいて課金されます。 次の表に、DataWorksのさまざまなエディションの課金ルールを示します。

エディション

無料クォータ

従量課金に基づく料金

Basic Edition

1か月あたりの3,100通話

API操作への呼び出しは制限されています。 従量課金方式はサポートされていません。

Standard Edition

1か月あたりの31,000通話

Professional Edition

1か月あたりの310,000通話

Enterprise Edition

1か月あたりの1,000,000通話

USD 0.05 10,000呼び出し

重要
  • DataWorksは、各リージョンの各暦月にAPI操作を呼び出すための無料クォータを提供します。 この無料クォータは、Alibaba CloudアカウントとAlibaba Cloudアカウント内のRAMユーザーによって共有されます。 無料クォータは、DataWorksエディションによって異なります。

  • さまざまなDataWorksエディションでのAPI操作の1日の最大呼び出し数の制限により、DataWorks Basic Edition、DataWorks Standard Edition、およびDataWorks Professional EditionでAPI操作を呼び出すための実際の月次クォータは、DataWorksが提供する無料クォータよりも少ない場合があります。 詳細については、「コール制限」をご参照ください。

  • DataWorks Enterprise Editionが提供する無料クォータが使い果たされた後、従量課金に基づいて課金されます。

    あなたの請求書の実際の価格が優先されます。

  • 無料クォータは、API操作が正常に呼び出された後にのみ使用されます。 無料クォータが使い果たされると、従量課金に基づいて課金されます。 API操作の呼び出しに失敗した場合、無料のクォータは使用されず、課金されません。

機能別操作一覧

次の表に、DataWorksで使用できるAPI操作を示します。 API操作は、テナント、メタデータ、DataStudio、Data Integration、Data Modeling、Operation Center、Data Quality、DataService Studio、Data Security Guard、Migration Assistant、およびSecurity Centerに関連しています。

テナント

API 操作

説明

レベル

最小版

(このエディションとより高度なエディションでサポートされています)

ListCalcEngines

計算エンジンのリストを照会します。

レベル2

基础版

CreateDataSource

DataWorksにデータソースを追加します。

レベル2

ListDataSources

DataWorksのデータソースのリストを照会します。

レベル3

UpdateDataSource

データソースを更新します。

レベル2

DeleteDataSource

データソースを削除します。

レベル2

ListResourceGroups

リソースグループのリストを照会します。

レベル1

GetProject

DataWorksワークスペースに関する情報を照会します。

レベル1

AddProjectMemberToRole

DataWorksワークスペースのメンバーにロールを割り当てます。 この操作を呼び出す前に、DataWorksワークスペースにメンバーとしてユーザーを追加する必要があります。

レベル2

CreateProjectMember

DataWorksワークスペースにユーザーを追加します。

レベル2

DeleteProjectMember

DataWorksワークスペースからユーザーを削除します。

レベル2

ListProjectRoles

DataWorksワークスペースのロールのリストを照会します。

レベル1

RemoveProjectMemberFromRole

DataWorksワークスペースのユーザーからロールを削除します。

レベル2

ListProjectMembers

DataWorksワークスペースのメンバーのリストを照会します。

レベル1

ListProjects

ユーザーが属するテナントのDataWorksワークスペースの一覧をページごとに照会します。

レベル1

ListProjectIds

Alibaba CloudアカウントまたはRAMユーザーが権限を持つDataWorksワークスペースのIDのリストを照会します。

レベル1

DeleteProject

DataWorksワークスペースを削除します。

レベル3

CreateProject

DataWorksワークスペースを作成します。

レベル3

UpdateProject

DataWorksワークスペースを更新します。

レベル3

ChangeResourceManagerResourceGroup

リソースが属するリソースグループを変更します。

レベル3

メタデータ

API 操作

説明

レベル

最小版

(このエディションとより高度なエディションでサポートされています)

GetMetaDBInfo

計算エンジンに関する基本的なメタデータ情報を照会します。

レベル1

基础版

GetMetaDBTableList

計算エンジンのメタテーブルのリストを照会します。

レベル1

基础版

CheckMetaTable

metatableが存在するかどうかをチェックします。

レベル1

基础版

CheckMetaPartition

パーティションが存在するかどうかをチェックします。

レベル1

基础版

SearchMetaTables

特定の条件に基づいてメタテーブルを照会します。

レベル1

基础版

GetMetaTableBasicInfo

metatableに関する基本情報を照会します。

レベル1

基础版

GetMetaTableColumn

メタテーブルに関するフィールド情報を照会します。

レベル1

基础版

GetMetaTablePartition

メタテーブルのパーティションのリストを照会します。

レベル1

基础版

GetMetaTableOutput

メタテーブルの出力情報を照会します。

レベル1

基础版

GetMetaTableChangeLog

メタテーブルの変更ログを照会します。

レベル1

基础版

GetMetaTableIntroWiki

metatableを使用する方法の指示を照会します。

レベル1

基础版

CreateMetaCategory

カテゴリを作成します。

レベル2

基础版

DeleteMetaCategory

カテゴリを削除します。

レベル2

基础版

UpdateMetaCategory

カテゴリを更新します。

レベル2

基础版

GetMetaCategory

カテゴリツリーを照会します。

レベル1

基础版

GetMetaTableListByCategory

カテゴリ内のメタテーブルのリストを照会します。

レベル1

基础版

AddToMetaCategory

metatableをカテゴリに追加します。

レベル2

基础版

DeleteFromMetaCategory

カテゴリからメタテーブルを削除します。

レベル2

基础版

UpdateMetaTable

テーブルに関するメタデータ情報を更新します。

レベル2

企业版

UpdateMetaTableIntroWiki

metatableを使用する方法の指示を更新します。 メタテーブルの使用方法に関する指示がない場合、この操作を呼び出すことによって指定された指示が追加されます。

レベル2

基础版

ListMetaDB

メタデータベースのリストを照会します。

レベル1

基础版

UpdateTableModelInfo

テーマ、レベル、カテゴリなど、テーブルに関する情報を更新します。

レベル2

企业版

CreateTableTheme

テーブルテーマを作成します。

レベル2

基础版

DeleteTableTheme

テーブルテーマを削除します。

レベル2

基础版

UpdateTableTheme

テーブルテーマを更新します。

レベル2

基础版

ListTableTheme

テーブルテーマのリストを照会します。

レベル1

基础版

CreateTableLevel

テーブルレベルを作成します。

レベル2

基础版

DeleteTableLevel

テーブルレベルを削除します。

レベル2

基础版

UpdateTableLevel

テーブルレベルを更新します。

レベル2

基础版

ListTableLevel

テーブルレベルのリストを照会します。

レベル1

基础版

GetMetaTableThemeLevel

テーブルテーマとテーブルレベルに関する情報を照会します。

レベル1

专业版

UpdateMetaCollection

コレクションを更新します。

レベル2

专业版

ListMetaCollections

コレクションのリストを照会します。

レベル2

专业版

ListMetaCollectionEntities

コレクション内のエンティティのリストを照会します。

レベル2

专业版

DeleteMetaCollection

コレクションを削除します。

レベル2

专业版

GetMetaCollectionDetail

コレクションに関する情報を照会します。

レベル2

专业版

DeleteMetaCollectionEntity

コレクションからエンティティを削除します。

レベル2

专业版

AddMetaCollectionEntity

コレクションにエンティティを追加します。

レベル2

专业版

CreateMetaCollection

コレクションを作成します。

レベル2

专业版

GetMetaTableProducingTasks

メタテーブルの出力タスクのリストを照会します。

レベル1

专业版

ListLineage

エンティティの祖先または子孫系統を照会します。

レベル2

image.png

DeleteLineageRelation

エンティティ間の系統を削除します。

レベル2

image.png

RegisterLineageRelation

自己管理エンティティ間の系統をDataWorksに登録し、その系統をDataWorksのシステムエンティティ間の既存の系統と組み合わせてフルリンクの系統を形成できるようにします。

レベル2

image.png

DataStudio

API 操作

説明

レベル

最小版

(このエディションとより高度なエディションでサポートされています)

CreateFile

DataStudioでファイルを作成します。

レベル3

基础版

CreateUdfFile

DataStudioで関数のファイルを作成します。

レベル2

基础版

CreateBusiness

ワークフローを作成します。

レベル2

基础版

DeleteBusiness

ワークフローを削除します。

レベル3

基础版

CreateFolder

フォルダを作成します。

レベル2

基础版

UpdateBusiness

ワークフローを更新します。

レベル2

基础版

ListFiles

ファイルのリストを照会します。

レベル1

基础版

EstablishRelationTableToBusiness

テーブルをワークフローにインポートします。 このAPI操作の呼び出しは、次の操作に相当します。DataStudioページに移動し、[スケジュール済みワークフロー] ペインでテーブルをインポートするワークフローを見つけて、ワークフロー名をクリックします。 MaxComputeフォルダーをクリックし、Tableフォルダーを右クリックして、[テーブルのインポート] を選択します。

レベル2

基础版

SubmitFile

スケジューリングシステムの開発環境にファイルをコミットしてタスクを生成します。

レベル3

基础版

ListBusiness

ワークフローのリストを照会します。

レベル1

基础版

GetFileVersion

ファイルバージョンに関する情報を照会します。

レベル1

基础版

DeleteFolder

DataStudioからフォルダーを削除します。

レベル3

基础版

DeleteFile

DataStudioからファイルを削除します。

レベル3

基础版

GetDeployment

配置パッケージに関する情報を照会します。

レベル1

基础版

UpdateFile

ファイルを更新します。

レベル2

基础版

GetFolder

フォルダーに関する情報を照会します。

レベル1

基础版

ListFileVersions

ファイルバージョンの一覧を照会します。

レベル1

基础版

GetFile

ファイルに関する情報を照会します。

レベル1

基础版

ListFolders

フォルダのリストを照会します。

レベル1

基础版

DeployFile

ファイルを本番環境に配置します。

レベル3

基础版

UpdateUdfFile

関数に関するファイル情報を更新します。

レベル2

基础版

GetBusiness

ワークフローに関する情報を照会します。

レベル1

基础版

UpdateFolder

フォルダを更新します。

レベル2

基础版

ListDeployments

配置パッケージの一覧を照会します。 この操作は、DataWorksコンソールの [デプロイメントパッケージ] ページでデプロイメントパッケージのリストを表示するのと同じです。

レベル1

基础版

UpdateIDEEventResult

拡張ポイントイベントがトリガーされ、拡張ポイントイベントが拡張ポイントイベントをチェックした後、拡張ポイントイベントのチェック結果をDataStudioに返します。

レベル2

企业版

GetIDEEventDetail

関連する拡張ポイントイベントがトリガーされたときに、DataWorks OpenEventのメッセージのIDに基づいて拡張ポイントのデータスナップショットを照会します。

レベル1

企业版

CreateResourceFile

DataStudioでリソースファイルを作成またはアップロードします。 この操作を呼び出して実装される機能は、統合開発環境 (IDE) で提供されるリソース作成機能と同じです。

レベル3

image.png

Data Integration

API 操作

説明

レベル

最小版

(このエディションとより高度なエディションでサポートされています)

CreateDISyncTask

同期タスクを作成します。

レベル3

基础版

DeleteDISyncTask

同期タスクを削除します。 この操作では、リアルタイム同期タスクのみを削除できます。

レベル3

基础版

UpdateDISyncTask

同期タスクを更新します。

レベル3

基础版

TestNetworkConnection

データソースとリソースグループ間のネットワーク接続をテストします。

レベル3

基础版

GetDataSourceMeta

データソースのメタデータを照会します。

レベル3

基础版

ListDIProjectConfig

DataWorksワークスペースの同期タスクの既定のグローバル構成を照会します。

レベル3

基础版

UpdateDIProjectConfig

DataWorksワークスペースの同期タスクのデフォルトのグローバル設定を更新します。

レベル3

基础版

GetDISyncTask

リアルタイム同期タスクに関する情報を照会します。

レベル3

基础版

DeployDISyncTask

リアルタイム同期タスクを展開します。

レベル3

基础版

GetDISyncInstanceInfo

リアルタイム同期タスクのステータスを照会します。

レベル3

基础版

StartDISyncInstance

リアルタイム同期タスクを開始します。

レベル3

基础版

StopDISyncInstance

リアルタイム同期タスクを停止します。

レベル3

基础版

TerminateDISyncInstance

リアルタイム同期タスクを展開します。

レベル3

基础版

GenerateDISyncTaskConfigForCreating

Data Integrationで同期タスクを作成するために使用される非同期スレッドのIDを生成します。

レベル3

基础版

GenerateDISyncTaskConfigForUpdating

Data Integrationで同期タスクを更新するために使用される非同期スレッドのIDを生成します。

レベル3

基础版

QueryDISyncTaskConfigProcessResult

非同期スレッドのIDに基づいて、非同期で生成されたパラメーターを取得します。 パラメーターは、Data Integrationでリアルタイム同期タスクを作成または更新するために使用されます。

レベル3

基础版

CreateDIJob

新しいバージョンの同期タスクを作成します。

レベル3

基础版

DeleteDIJob

新しいバージョンの同期タスクを削除します。

レベル3

基础版

GetDIJob

新しいバージョンの同期タスクに関する情報を照会します。

レベル3

基础版

ListDIJobs

新しいバージョンの同期タスクのリストを照会します。

レベル3

基础版

StartDIJob

新しいバージョンの同期タスクを開始します。

レベル3

基础版

StopDIJob

新しいバージョンの同期タスクを停止します。

レベル3

基础版

UpdateDIJob

新しいバージョンの同期タスクを更新します。

レベル3

基础版

CreateDIAlarmRule

新しいバージョンの同期タスクのアラートルールを作成します。

レベル3

基础版

GetDIAlarmRule

新しいバージョンの同期タスクのアラートルールに関する情報を照会します。

レベル3

基础版

ListDIAlarmRules

新しいバージョンの同期タスクのアラートルールのリストを照会します。

レベル3

基础版

UpdateDIAlarmRule

新しいバージョンの同期タスクのアラートルールを更新します。

レベル3

基础版

API操作を呼び出してData Integrationで同期タスクを作成する方法については、「API操作を使用してバッチ同期タスクを作成、変更、および削除する」をご参照ください。

Operation Center

API 操作

説明

レベル

最小版

(このエディションとより高度なエディションでサポートされています)

ListAlertMessages

アラートのリストを照会します。

レベル1

专业版

GetBaselineConfig

ベースラインの設定を照会します。

レベル1

专业版

ListNodesByBaseline

ベースライン内のノードのリストを照会します。

レベル1

标准版

ListBaselineConfigs

ベースラインのリストを照会します。

レベル1

标准版

GetBaselineKeyPath

ベースラインインスタンスのキーパスを照会します。

レベル1

标准版

GetBaselineStatus

ベースラインインスタンスに関する情報を照会します。

レベル1

标准版

ListBaselineStatuses

ベースラインインスタンスのリストを照会します。

レベル1

标准版

DeleteRemind

カスタムアラートルールを削除します。

レベル2

基础版

UpdateRemind

カスタムアラートルールを更新します。

レベル3

基础版

CreateRemind

カスタムアラートルールを作成します。

レベル3

基础版

GetRemind

カスタムアラートルールに関する情報を照会します。

レベル1

基础版

ListReminds

カスタム警告ルールのリストを照会します。

レベル1

基础版

ListTopics

イベントのリストを照会します。

レベル1

标准版

GetTopic

イベントに関する情報を照会します。

レベル1

标准版

GetTopicInfluence

イベントの影響を受けるベースラインインスタンスのリストを照会します。

レベル1

标准版

GetNode

ノードに関する情報を照会します。

レベル1

基础版

ListNodeInputOrOutput

ノードの祖先または子孫ノードを照会します。 毎回、最も近いレベルの祖先ノードまたは子孫ノードのみを照会できます。

レベル1

基础版

リストノード

ノードのリストを照会します。

レベル1

基础版

GetNodeCode

ノードのコードを照会します。

レベル1

基础版

GetInstance

インスタンスに関する情報を照会します。

レベル1

基础版

リストインスタンス

インスタンスのリストを照会します。

レベル1

基础版

GetInstanceLog

インスタンスのログを照会します。

レベル1

基础版

StopInstance

インスタンスを終了します。

レベル2

基础版

RestartInstance

インスタンスを再起動します。

レベル2

基础版

SetSuccessInstance

失敗したインスタンスの状態を成功に設定します。

レベル2

基础版

SuspendInstance

インスタンスを一時停止します。

レベル2

基础版

ResumeInstance

中断されたインスタンスを再開します。

レベル2

基础版

RunCycleDagNodes

データをバックフィルするワークフローを作成します。

レベル2

基础版

RunSmokeTest

煙テストを実行するワークフローを作成します。

レベル2

基础版

ListSuccessInstanceAmount

当日の1時間ごとに正常に実行された自動トリガーノードインスタンスの数の傾向を照会します。

レベル3

基础版

ListInstanceAmount

特定の期間内に自動トリガーされたノードインスタンスの数の傾向を照会します。

レベル1

基础版

TopTenElapsedTimeInstance

インスタンスの実行期間のランキングを照会します。

レベル1

基础版

TopTenErrorTimesInstance

前月にエラーが発生したノードのランキングを照会します。

レベル1

基础版

GetFileTypeStatistic

ノードタイプの分布を照会します。

レベル1

基础版

GetInstanceStatusStatistic

各状態のインスタンス数を照会します。

レベル1

基础版

ListFileType

ノードタイプのコードや名前など、1つ以上のノードタイプに関する情報を照会します。

レベル1

基础版

RunManualDagNodes

手動でトリガーされるワークフローでノードを実行します。 この操作を呼び出す前に、手動でトリガーされたワークフローがコミットされ、デプロイされていることを確認します。 手動でトリガーされたワークフローは、[オペレーションセンター] ページで確認できます。

レベル2

基础版

ListManualDagInstances

手動でトリガーされたワークフローのインスタンスに関する情報を照会します。

レベル1

基础版

GetDag

DAGのIDに基づいて、有向非巡回グラフ (DAG) に関する情報を照会します。

レベル1

基础版

ListDags

OpSeqに基づいて、単一のデータバックフィルインスタンスのDAGのリストを照会します。

レベル1

基础版

ListNodesByOutput

ノードの出力に基づいてノードのリストを照会します。

レベル1

基础版

RunTriggerNode

手動でトリガーされたノードを実行します。

レベル2

基础版

GetNodeParents

ノードの祖先ノードのリストを照会します。

レベル2

基础版

GetNodeChildren

ノードの子孫ノードのリストを照会します。

レベル2

基础版

UpdateNodeRunMode

ノードをフリーズまたはアンフリーズします。

レベル2

基础版

UpdateNodeOwner

ノードの所有者を変更します。

レベル2

基础版

UpdateWorkbenchEventResult

オペレーションセンターのプロセスが拡張機能によってブロックされた後に、拡張機能によって送信された処理結果を返します。

レベル2

基础版

ListShiftPersonnels

シフトスケジュールで勤務中のエンジニアのリストを照会します。

レベル1

基础版

ListShiftSchedules

オペレーションセンターでシフトスケジュールのリストを照会します。

レベル1

基础版

ListInstanceHistory

すべてのインスタンスの履歴レコードのリストを照会します。 インスタンスが1回再実行されると、履歴レコードが1つ生成されます。

レベル1

基础版

ListInnerNodes

内部ノードのリストを照会します。 たとえば、この操作を呼び出して、ノードグループまたはdo-whileノードの内部ノードを照会できます。 この操作を呼び出して、Platform for AI (PAI) ノードの内部ノードを照会することはできません。

レベル1

基础版

OfflineNode

ノードの展開を解除します。

レベル3

基础版

CreateBaseline

ベースラインを作成します。

レベル3

标准版

UpdateBaseline

ベースラインを更新します。

レベル3

标准版

GetBaseline

IDに基づいてベースラインの設定を照会します。

レベル1

标准版

ListBaselines

ベースラインのリストを照会します。

レベル1

标准版

DeleteBaseline

IDに基づいてベースラインを削除します。

レベル2

标准版

Data Quality

API 操作

説明

レベル

最小版

(このエディションとより高度なエディションでサポートされています)

UpdateQualityFollower

サブスクリプション関係を更新します。

レベル2

基础版

UpdateQualityRule

モニタリングルールを更新します。

レベル2

GetQualityRule

モニタリングルールに関する情報を照会します。

レベル1

ListQualityRules

パーティションフィルター式に基づいてモニタリングルールのリストを照会します。

レベル3

CreateQualityRule

監視ルールを作成します。

レベル3

DeleteQualityFollower

パーティションフィルター式のサブスクライバを削除します。

レベル2

DeleteQualityRule

監視ルールを削除します。

レベル2

GetQualityFollower

パーティションフィルター式のサブスクライバーを照会します。

レベル1

CreateQualityFollower

パーティションフィルター式のサブスクライバーを作成します。

レベル3

DeleteQualityEntity

パーティションフィルター式を削除します。

レベル2

GetQualityEntity

パーティションフィルター式に関する情報を照会します。

レベル1

CreateQualityEntity

パーティションフィルター式を作成します。

レベル2

CreateQualityRelativeNode

ノードをパーティションフィルター式に関連付けます。

レベル3

DeleteQualityRelativeNode

パーティションフィルター式からノードの関連付けを解除します。

レベル2

ListQualityResultsByEntity

パーティションフィルター式に基づいて、履歴モニタリング結果のリストを照会します。

レベル1

ListQualityResultsByRule

監視ルールに基づいて監視結果の一覧を照会します。

レベル1

DataService Studio

API 操作

説明

レベル

最小版

(このエディションとより高度なエディションでサポートされています)

CreateDataServiceApi

APIを作成します。

レベル3

基础版

PublishDataServiceApi

APIを発行します。

レベル3

DeleteDataServiceApi

APIを削除します。

レベル3

ListDataServiceApis

開発状態のAPIのリストを照会します。

レベル1

GetDataServiceApi

開発状態のAPIに関する情報を照会します。

レベル1

UpdateDataServiceApi

開発状態のAPIを更新します。

レベル3

GetDataServicePublishedApi

公開済み状態のAPIに関する情報を照会します。

レベル1

ListDataServicePublishedApis

公開済み状態のAPIのリストを照会します。

レベル1

ListDataServiceApiAuthorities

他のユーザーにアクセス権限が付与されているAPIのリストを照会します。

レベル1

ListDataServiceAuthorizedApis

アクセスを許可されているAPIのリストを照会します。

レベル1

AbolishDataServiceApi

APIの公開を解除します。

レベル3

GetDataServiceApplication

アプリケーションに関する情報を照会します。

レベル1

ListDataServiceApplications

アプリケーションのリストを照会します。

レベル1

CreateDataServiceFolder

フォルダを作成します。

レベル2

GetDataServiceFolder

フォルダーに関する情報を照会します。

レベル1

ListDataServiceFolders

フォルダのリストを照会します。

レベル1

CreateDataServiceGroup

ビジネスプロセスを作成します。

レベル2

GetDataServiceGroup

ビジネスプロセスに関する情報を照会します。

レベル1

ListDataServiceGroups

業務プロセスのリストを照会します。

レベル1

CreateDataServiceApiAuthority

APIのアクセス権限を付与します。

レベル1

DeleteDataServiceApiAuthority

APIのアクセス権限を取り消します。

レベル1

DataAnalysis

API 操作

説明

レベル

最小版

(このエディションとより高度なエディションでサポートされています)

UmountDirectory

DataAnalysisの左側のナビゲーションウィンドウからディレクトリを削除します。

レベル2

基础版

MountDirectory

DataAnalysisの左側のナビゲーションペインにディレクトリを追加します。

レベル2

基础版

Data Security Guard

API 操作

説明

レベル

最小版

(このエディションとより高度なエディションでサポートされています)

GetOpSensitiveData

テナントのすべてのDataWorksワークスペースの機密データにアクセスするために、指定された日付に生成されたレコードを照会します。

レベル1

标准版

DesensitizeData

マスクデータ。

レベル1

专业版

GetOpRiskData

テナントのすべてのDataWorksワークスペース内の高リスク機密データにアクセスするために、指定された日付に生成されたレコードを照会します。

レベル1

标准版

GetSensitiveData

テナントのすべてのDataWorksワークスペースの最新の機密データを照会します。

レベル1

标准版

ScanSensitiveData

入力データに機密データが含まれているかどうかを確認します。

レベル1

标准版

DsgQuerySensResult

機密データの識別結果を照会します。

レベル1

专业版

QueryDefaultTemplate

デフォルトのデータカテゴリと機密度レベルテンプレートを照会します。

レベル1

标准版

DsgStopSensIdentify

機密データ識別タスクを停止します。

レベル1

标准版

QuerySensClassification

データカテゴリを照会します。

レベル1

标准版

QuerySensLevel

データ機密レベルを照会します。

レベル1

标准版

QueryRecognizeRulesType

機密フィールドの設定に使用される組み込みの機密データ識別ルールを照会します。

レベル1

标准版

DsgRunSensIdentify

機密データ識別タスクを開始します。

レベル1

标准版

DeleteRecognizeRule

機密フィールドタイプを削除します。

レベル1

标准版

QuerySensNodeInfo

機密データ識別ルールを照会します。

レベル1

标准版

AddRecognizeRule

data Security Guardのデータのカテゴリと機密レベルに基づいて定義された機密フィールドを追加します。

レベル1

标准版

EditRecognizeRule

data Security Guardのデータのカテゴリと機密レベルに基づいて定義されている機密フィールドを編集します。

レベル1

标准版

QueryRecognizeDataByRuleType

機密データ識別ルールのタイプを照会します。

レベル1

标准版

QueryRecognizeRuleDetail

機密フィールドに関する情報を照会します。

レベル1

标准版

DsgUserGroupGetOdpsRoleGroups

Data Security Guardのテナントによってユーザーグループが作成または変更されたときに、ユーザーグループのメンバーが選択できるMaxComputeロールのリストを照会します。

レベル1

标准版

DsgDesensPlanAddOrUpdate

データマスキングルールを追加または変更します。

レベル1

标准版

DsgPlatformQueryProjectsAndSchemaFromMeta

現在のテナント内の異なるタイプの計算エンジンのリストを照会します。

レベル1

标准版

DsgUserGroupDelete

ユーザーグループを削除します。

レベル1

标准版

DsgWhiteListDeleteList

データマスキングのホワイトリストを削除します。

レベル1

标准版

DsgScenedDeleteScene

レベル2のデータマスキングシナリオを削除します。

レベル1

标准版

DsgDesensPlanDelete

データマスキングルールを削除します。

レベル1

标准版

DsgDesensPlanUpdateStatus

データマスキングルールのステータスを変更します。

レベル1

标准版

DsgWhiteListQueryList

データマスキングホワイトリストを照会します。

レベル1

标准版

DsgSceneAddOrUpdateScene

レベル2のデータマスキングシナリオを追加または変更します。

レベル1

标准版

DsgSceneQuerySceneListByName

データマスキングシナリオのリストを照会します。

レベル1

标准版

DsgUserGroupAddOrUpdate

ユーザーグループを追加または変更します。

レベル1

标准版

DsgUserGroupQueryList

ユーザーグループのリストを照会します。

レベル1

标准版

DsgUserGroupQueryUserList

現在のテナントのユーザーまたはロールのリストを照会します。

レベル1

标准版

DsgDesensPlanQueryList

データマスキングルールのリストを照会します。

レベル1

标准版

DsgWhiteListAddOrUpdate

データマスキングホワイトリストを追加または変更します。

レベル1

标准版

DsgQueryDefaultTemplates

使用可能な機密フィールドタイプテンプレートと、テンプレートでサポートされているデータマスキングルールの一覧を照会します。 この操作のレスポンスパラメーターを参照して、データマスキングルールを設定できます。

レベル1

标准版

移行アシスタント

API 操作

説明

レベル

最小版

(このエディションとより高度なエディションでサポートされています)

CreateImportMigration

インポートタスクを作成します。 インポートタスクには、データソース、ノード、およびテーブルのインポートパッケージが含まれます。

レベル2

基础版

GetMigrationProcess

移行タスクの進行状況を照会します。

レベル1

移行開始

移行タスクを開始します。

レベル2

CreateExportMigration

エクスポートタスクを作成します。 この操作を使用してエクスポートタスクを作成できますが、この操作を使用して作成されたエクスポートタスクを開始することはできません。

レベル2

GetMigrationSummary

移行タスクに関する情報を照会します。

レベル2

ListMigrations

移行タスクのリストを照会します。

レベル2

Security Center

API 操作

説明

レベル

最小版

(このエディションとより高度なエディションでサポートされています)

CreatePermissionApplyOrder

権限リクエスト注文を作成します。

レベル2

基础版

GetPermissionApplyOrderDetail

権限要求の順序に関する情報を照会します。

レベル2

ListPermissionApplyOrders

権限要求注文のリストを照会します。

レベル3

ApprovePermissionApplyOrder

権限リクエスト注文を処理します。

レベル2

RevokeColumnPermission

ユーザーからテーブルフィールドに対する権限を取り消します。

レベル2

RevokeTablePermission

ユーザーからテーブルに対する権限を取り消します。

レベル2

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

API 操作

説明

レベル

最小版

ListExtensions

拡張機能のリストを照会します。

レベル1

企业版

GetExtension

拡張機能に関する情報を照会します。

レベル1

GetOptionValueForProject

ワークスペースの拡張機能のオプション設定を照会します。

レベル1

ListEnabledExtensionsForProject

ワークスペースで有効になっている組み込み拡張機能とカスタム拡張機能の一覧を照会します。

レベル1

CallbackExtension

拡張ポイントイベントの処理結果を拡張子を介してDataWorksに送信します。

レベル1

必要な情報を取得する方法

  • ユーザーに関する情報の表示

    1. RAMコンソールにログインします。

    2. 左側のナビゲーションペインで、[Identities] > [Users] を選択します。 [ユーザー] ページで、目的のユーザーの名前をクリックします。 表示されるページの [基本情報] セクションで、UIDなどのユーザーに関する基本情報を表示できます。

    3. ユーザーの詳細ページの [認証] タブの [ユーザーAccessKey] セクションで、ユーザーのAccessKeyペアを表示できます。

  • ワークスペースのリージョンIDの表示

    ワークスペースのリージョンIDは、DataWorksのDataStudioサービスのURLから取得できます。 次の図は、中国 (上海) リージョンのワークスペースのURLを示しています。

    説明

    DataStudioページへの移動方法については、「DataStudioページへの移動」をご参照ください。

    工作空间

  • ワークスペースのIDの表示

    ワークスペースのIDは、ワークスペースの一意の識別子です。 ワークスペースIDを表示するには、次の手順を実行します。

    1. [Management Center] ページに移動します。

      DataWorks コンソールにログインします。 上部のナビゲーションバーで、目的のリージョンを選択します。 左側のナビゲーションウィンドウで、[詳細] > [管理センター] を選択します。 表示されるページで、ドロップダウンリストから目的のワークスペースを選択し、[管理センターに移動] をクリックします。

    2. 左側のナビゲーションウィンドウで、[ワークスペース] をクリックします。 [基本設定] タブの [基本プロパティ] セクションで、ワークスペースIDを取得します。

  • テナントのIDの表示

    各Alibaba Cloudアカウントには、現在のAlibaba Cloudアカウントを他のAlibaba Cloudアカウントと区別するためのテナントIDがあります。 Alibaba Cloudアカウント内のRAMユーザーは、同じテナントに属しています。 これは、Alibaba CloudアカウントのテナントIDがAlibaba Cloudアカウント内のRAMユーザーのテナントIDと同じであることを示します。 テナントのIDを取得するには、次の手順を実行します。

    1. DataStudioページに移動します。

    2. DataStudioページの右上隅で、現在のユーザーの名前をクリックし、[メニュー] セクションの [ユーザー情報] をクリックします。 [ユーザー情報] ダイアログボックスで、テナントのIDを表示できます。

よくある質問