Dataphin:OpenAPI 操作のリスト

API (旧インターフェイス)

API (新インターフェイス)

API の説明

インスタンス O&M

GetInstanceDownstream

-

指定されたインスタンスの下流インスタンスをクエリします。

GetPhysicalInstanceLog

-

インスタンスの実行ログを取得します。インスタンスが複数回再実行されると、複数のログが生成されます。

GetScriptInstance

-

インスタンスのステータスやランタイムなど、スクリプトインスタンスの情報をクエリします。

InstanceFixData

-

下流インスタンスを再実行して、トレースデータを修正します。影響を受ける下流インスタンスの強制再実行ができます。この操作は、

• コンピュートコストを生成します。

• データ出力に影響します。

ListNormalInstance

-

指定されたクエリ条件に基づいて、インスタンスのページ分割されたリストを取得します。インスタンスタイプには、定期インスタンスとワンタイムインスタンスが含まれます。

OperateBatchInstance

-

• 物理インスタンスおよび論理テーブルタスクインスタンスに対してバッチ操作を実行します。この機能はバージョン 295-2 からサポートされています。

• ノードまたはその下流ノードを再実行すると、データが更新され、既存データに影響します。

• ノードまたはその下流ノードを再実行すると、コンピュートコストとストレージコストが発生します。

• インスタンスの一時停止はリスクの高い操作であり、スケジューリングが妨げられる可能性があります。このコマンドは注意して使用してください。

インスタンスでは、以下の O&M 操作がサポートされています。

• RERUN: ノードを再実行し、現在のデータタイムスタンプのデータを更新します。

• PAUSE: インスタンスを一時停止します。その下流インスタンスが実行されていない場合、それらも一時停止され、スケジューリングできなくなります。

• RESUME: 一時停止したインスタンスを再開します。再開後、インスタンスはスケジューリング条件が満たされたときに実行されるようにスケジュールされます。

• TERMINATE: インスタンスを停止します。停止後、インスタンスは実行されるようにスケジュールされません。その下流インスタンスが実行されていない場合、それらもスケジューリングから一時停止されます。

• SET_SUCCESS: インスタンスのステータスを成功に設定します。これは下流のスケジューリングに影響します。これは主に、手動でデータを更新した後にインスタンスのスケジューリングステータスを強制的に更新し、下流インスタンスがスケジューリングできるようにするために使用されます。

下流インスタンスを再実行するには、InstanceFixData API を使用します。

OperateInstance

-

(代わりに新しい OperateBatchInstanceRequest API を使用してください) インスタンスに対して O&M 操作を実行します。利用可能なコマンドは次のとおりです。

• RERUN: インスタンスを再実行します。成功したインスタンスまたは失敗したインスタンスのみ再実行できます。再実行後、データは再送信され、リソース使用料が発生します。

• PAUSE: インスタンスを一時停止します。その下流インスタンスが実行されていない場合、それらもスケジューリングから一時停止されます。

• RESUME: 一時停止したインスタンスを再開します。再開後、インスタンスはスケジューリング条件が満たされたときに実行されるようにスケジュールされます。

• TERMINATE: インスタンスを停止します。停止後、インスタンスは実行されるようにスケジュールされません。その下流インスタンスが実行されていない場合、それらもスケジューリングから一時停止されます。

• SET_SUCCESS: インスタンスのステータスを成功に設定します。これは下流のスケジューリングに影響します。これは主に、手動でデータを更新した後にインスタンスのスケジューリングステータスを強制的に更新し、下流インスタンスがスケジューリングできるようにするために使用されます。

• RERUN_DOWNSTREAM: 下流インスタンスを再実行します。これにより、インスタンスとその選択された下流インスタンスの現在のデータタイムスタンプのデータが更新されます。

インスタンスまたはその下流インスタンスを再実行すると、ノードの実行に追加料金が発生します。

タスクの運用保守

ListSupplementDagrun

-

クエリ条件に基づいて、データ バックフィル ワークフローの各データ タイムスタンプの DagRun 情報を一覧表示します。

ListSupplementInstance

-

データバックフィルワークフロー内の特定のデータタイムスタンプのすべてのノードインスタンスを一覧表示します。

QueryInstanceUpDownStream

-

インスタンスの先祖ノードと子孫ノードをクエリします。この API は論理テーブルとコードノードをサポートしています。この機能はバージョン 295-2 からサポートされています。

NodeSupplementCommand

-

データバックフィルリクエストのパラメーターを指定します。

CreateNodeSupplement

-

汎用のデータバックフィル API を提供します。この機能はバージョン 295-2 からサポートされています。

• 実行するデータバックフィルインスタンスを生成し、関連する出力テーブルのデータに影響を与えます。

• ノードを実行すると、コンピュートコストとストレージコストが発生します。

CreatePhysicalNodeSupplement

-

物理ノードのデータバックフィルインスタンスを作成します。CreateNodeSupplement API の使用をお勧めします。

• データを更新し、既存データに影響を与えます。

• ノードデータを更新すると、コンピュートコストとストレージコストが発生します。

GetPhysicalNode

-

物理スケジューリングノードをクエリします。

GetPhysicalNodeByOutput

-

出力名で物理ノードをクエリします。

GetPhysicalNodeContent

-

スケジューリングノードのコードをクエリします。

GetPhysicalNodeOperationLog

-

ノードの操作ログを照会します。

ListDevDependency

-

開発者ノードに設定された上流依存関係をクエリします。

ListNodes

-

スケジューリングノードのリストをクエリします。

PausePhysicalNode

-

物理ノードのスケジューリングを一時停止します。これはリスクの高い操作です。ノードのスケジューリングが一時停止され、下流ノードはトリガーできません。この API は現在、オフラインコードノードと統合ノードのみをサポートしています。

QueryDagFromPhysicalNode

-

物理ノードから開始して、ノードの先祖ノードと子孫ノードをクエリします。

QueryNodeUpDownStream

-

先祖ノードと子孫ノードをクエリするための汎用 API を提供します。この機能はバージョン 295-2 からサポートされています。

クエリ操作送信ステータス

-

大量モードで実行された後のデータバックフィルの送信ステータスをクエリします。この機能はバージョン 295-2 からサポートされています。

ResumePhysicalNode

-

物理ノードのスケジューリングを再開します。

RunManualNode

-

ワンタイムノードを実行します。この機能はバージョン 295-2 からサポートされています。

• ワンタイムスケジューリングノードを生成し、関連テーブルに影響を与えます。

• ノードを実行すると、コンピュートコストとストレージコストが発生します。

RunTriggerNode

-

トリガーベースのノードを実行します。

SearchSupplementDownStream

-

データバックフィルの下流ノードをクエリします。この機能はバージョン 295-2 からサポートされています。

• マルチノードデプロイメントをサポートします。

• 論理テーブル フィールドをサポートします。

GetJobInfo

-

リアルタイム ジョブ情報を照会します。

SyncEngineJobGraph

-

内部の DLab プラットフォームがシャドウトレースノードのパラメーターを Dataphin ノードに同期できるようにします。

アラートメッセージ

GetAlertEvent

-

アラートイベントの詳細を取得します。

QueryAlertEvents

ListAlertEvent

指定された条件に基づいて複数のアラートイベントをクエリします。

QueryAlertNotifications

ListAlertNotification

指定された条件に基づいて複数のプッシュレコードをクエリします。

API (古いインターフェイス)

API (新しいインターフェイス)

API の説明

データアーキテクチャ

CreateBusinessEntity

CreateBizEntity

ビジネスオブジェクトとビジネスアクティビティを含むビジネスエンティティを作成します。

DeleteBusinessEntity

DeleteBizEntity

ビジネスエンティティを削除します。同じタイプのビジネスエンティティをバッチ削除できます。削除する際は、ビジネスエンティティのタイプを指定します。サポートされているタイプは、ビジネスオブジェクトとビジネスアクティビティです。

DescribeBusinessEntity

GetBizEntityInfo

ビジネスオブジェクトとビジネスアクティビティを含むビジネスエンティティの詳細をクエリします。

DescribeBusinessEntityByVersion

GetBizEntityInfoByVersion

開発環境におけるビジネスエンティティのバージョン詳細をクエリします。基本プロジェクトの場合、これは本番環境です。詳細には、ビジネスオブジェクトとビジネスアクティビティが含まれます。

ListBusinessEntities

ListBizEntities

フラットな構造でビジネスエンティティリストのページングクエリを実行します。

ドメイン ID と名前、主題領域 ID と名前、ビジネスエンティティのサブタイプ、オーナー ID、インスタンス化ステータス、ビジネスエンティティステータス、ビジネスエンティティ名に基づいてあいまい検索を実行できます。検索条件を設定しない場合、ビジネスエンティティリストはテナントスコープ内でクエリされます。

OfflineBusinessEntity

OfflineBizEntity

ビジネスエンティティをオフラインにします。同じタイプのビジネスエンティティをバッチでオフラインにできます。オフラインにする際は、ビジネスエンティティのタイプを指定します。サポートされているタイプは、ビジネスオブジェクトとビジネスアクティビティです。

SubmitBusinessEntity

OnlineBizEntity

ビジネスエンティティを公開します。同じタイプのビジネスエンティティをバッチで公開できます。公開する際は、ビジネスエンティティのタイプを指定します。サポートされているタイプは、ビジネスオブジェクトとビジネスアクティビティです。

UpdateBusinessEntity

UpdateBizEntity

ビジネスオブジェクトとビジネスアクティビティを含むビジネスエンティティを更新します。

CreateBizUnit

-

データドメインを作成します。

CreateDataDomain

-

件名エリアを作成します。

DeleteBizUnit

-

データドメインを削除します。プロジェクト、主題領域、業務フィルタ、アトミックメトリック、派生メトリック、論理ファクトテーブル、論理ディメンションテーブル、または集計テーブルに関連付けられている場合、データドメインは削除できません。

DeleteDataDomain

-

主題領域を削除します。主題領域に子の主題領域またはビジネスエンティティがある場合、削除できません。

DescribeBizUnit

GetBizUnitInfo

データドメイン ID に基づいてドメイン情報を取得します。

DescribeDataDomain

GetDataDomainInfo

主題領域情報を表示します。

ListBizUnits

-

DEV 環境と PROD 環境を区別せずに、すべてのデータドメインをリストします。

ListDataDomains

-

主題領域のリストを取得します。データドメイン ID、親主題領域 ID、主題領域名、コード、または説明で検索できます。

UpdateBizUnit

-

既存のデータドメインを更新します。

UpdateDataDomain

-

件名エリアを更新します。

共通定義

UpdateGlobalVariable

-

グローバル変数を編集します。通常変数とアカウントパスワード用のグローバル変数を編集できます。

アドホッククエリファイル

CreateAdHocFile

-

アドホッククエリファイルを作成します。

CreateAdHocFileNew

CreateAdHocFile

アドホッククエリファイルを作成します。

CreateFolder

-

ナビゲーションツリーにフォルダを作成します。これは、計算ノードやデータ統合同期ノードなどの機能をサポートします。

DeleteAdHocFile

-

アドホッククエリファイルを削除します。

DeleteFolder

-

ナビゲーションツリーからフォルダを削除します。

GetAdHocFile

-

アドホッククエリファイルをクエリします。

ListFiles

-

ナビゲーションツリーフォルダ内のファイルをクエリします。

MoveFile

-

ナビゲーションツリー内のファイルを移動します。

RenameFile

-

ナビゲーションツリー内のファイルの名前を変更します。

UpdateAdHocFile

-

アドホッククエリファイルを更新します。

UpdateAdHocFileNew

UpdateAdHocFileNew

アドホッククエリファイルを更新します。

モデリング開発共通

QueryObjectVersionListById

-

モデリング開発オブジェクトのバージョン情報のリストを取得します。アトミックメトリック、業務フィルタ、派生メトリックのバージョン情報をクエリできます。

ビジネスフィルター

ListBizCondition

-

業務フィルタのリストのページングクエリを実行します。検索条件を設定しない場合、デフォルトで指定されたプロジェクト内の業務フィルタがクエリされます。

QueryBizConditionById

-

業務フィルタデータを取得します。

QueryBizConditionVerDetailById

-

業務フィルタのバージョンの詳細を取得します。

QueryHomoBizConditionById

-

同じソースからの業務フィルタのデータを取得します。同じソースとは、業務フィルタが同じ論理テーブルから派生していることを意味します。業務フィルタは異なる時間粒度を持つ 3 つの計算ロジックを持つことができるため、異なる時間粒度を持つ 3 つの論理テーブルから派生する可能性があります。

メトリック

GetLogicalDefinitionSubTree

-

モデリング開発定義オブジェクトのナビゲーションツリー構造を取得します。これには、アトミックメトリック、業務フィルタ、派生メトリックのナビゲーションツリー構造が含まれます。

ListAtomicIndex

-

アトミックメトリックのリストのページングクエリを実行します。検索条件を設定しない場合、デフォルトで指定されたプロジェクト内のすべての元のアトミックメトリックと複合指標がクエリされます。

ListDerivedIndex

-

派生メトリックのリストのページングクエリを実行します。検索条件を設定しない場合、デフォルトで指定されたプロジェクト内のすべての派生メトリック、複合指標、および登録済みメトリックがクエリされます。

QueryAtomicIndexById

-

アトミックメトリックデータを取得します。

QueryAtomicIndexVerDetailById

-

アトミックメトリックのバージョンの詳細を取得します。

QueryDerivedIndexById

-

派生メトリックデータを取得します。

QueryDerivedIndexVerDetailById

-

派生メトリックバージョンの詳細をクエリします。

QueryHomoAtomicIndexById

-

同じソースからのアトミックメトリックのデータを取得します。同じソースとは、アトミックメトリックが同じ論理テーブルから派生していることを意味します。アトミックメトリックは異なる時間粒度を持つ 3 つの計算ロジックを持つことができるため、異なる時間粒度を持つ 3 つの論理テーブルから派生する可能性があります。

論理テーブル

GetLogicalModelSubTree

-

論理テーブルオブジェクトのナビゲーションツリー構造を取得します。

QueryDimTableById

-

論理ディメンションテーブルの詳細をクエリします。

QueryFactTableById

-

論理ファクトテーブルの詳細をクエリします。

QueryGranularityBySummaryId

-

論理集計テーブルの統計粒度に関連するディメンション情報をクエリします。

オフラインコードノード

CancelTask

-

ノードを停止します。この機能はバージョン 3.5.3 からサポートされています。この API はべき等です。ノードがすでに停止している場合、呼び出しは通常の応答を返します。

CloseJdbcConnection

-

Java Database Connectivity (JDBC) 接続を閉じます。この機能はバージョン 3.5.3 からサポートされています。

CreateBatchTaskFile

CreateBatchTask

オフラインコンピューティングノードを作成します。

CreateJdbcConnection

-

JDBC 接続を作成します。この機能はバージョン 3.5.3 からサポートされています。

DeleteBatchTaskFile

DeleteBatchTask

オフラインコンピューティングノードを削除します。削除する前にノードをオフラインにする必要があります。

ExecSqlByJdbc

-

JDBC を使用して SQL 文を実行します。この機能はバージョン 3.5.1 からサポートされています。

ExecTask

ExecuteAdHocTask

アドホッククエリノードを実行します。

FetchSqlResult

-

SQL 実行の結果を取得します。この機能はバージョン 3.5.3 からサポートされています。ノードが正常に実行された後、この API を使用してその実行結果をクエリできます。ノードがまだ実行を完了していないか、失敗した場合、この API は空のデータを返します。

GetBatchTaskFile

GetBatchTaskInfo

オフラインコンピューティングノードの詳細をクエリします。

GetBatchTaskFileByVersion

GetBatchTaskInfoByVersion

開発環境におけるオフラインコンピューティングノードのバージョン詳細をクエリします。基本プロジェクトの場合、これは本番環境です。

GetLineages

GetBatchTaskUdfLineages

ノードのカスタムリネージ情報をクエリします。

KillTask

StopAdHocTask

アドホッククエリノードを停止します。

ListBatchTaskFileVersions

GetBatchTaskVersions

オフラインコンピューティングノードの過去のバージョンをクエリします。

OfflineBatchTaskFile

OfflineBatchTask

オフラインコンピューティングノードをオフラインにします。

ParseDependency

ParseBatchTaskDependency

オフラインコンピューティングノードの論理テーブル依存関係を解析します。解析結果の上流依存関係情報には、自己依存ノードが含まれる場合があることに注意してください。この場合、先祖ノード ID は解析されたコードのノード ID と同じになります。これはご自身で処理する必要があります。

QuerySqlTaskStatus

-

SQL ノードのステータスを取得します。この機能はバージョン 3.5.1 からサポートされています。

QueryTaskLog

GetAdHocTaskLog

アドホッククエリノードの実行ログを取得します。

QueryTaskResult

GetAdHocTaskResult

アドホッククエリノードの実行結果を取得します。

SaveLineages

UpdateBatchTaskUdfLineages

ノードのカスタムリネージを保存します。

SubmitBatchTaskFile

SubmitBatchTaskFileV2

オフラインコンピューティングノードを送信します。

SubmitBatchTaskFileV2

SubmitBatchTask

オフラインコンピューティングタスクを送信します。この操作は SubmitBatchTaskFile 操作の代替です。SubmitBatchTaskFileV2 と SubmitBatchTaskFile 操作の違い:

タスクが正常に送信された場合、SubmitBatchTaskFileV2 操作は公開されるオブジェクトの ID も返します。

UpdateBatchTaskFile

UpdateBatchTask

オフラインコンピューティングノードを更新します。

リアルタイム開発ノード

GetDirectoryTree

-

リアルタイムノードのストレージフォルダを取得します。

GetClusterQueueInfoByEnv

-

リアルタイムノードのリソースキューを取得します。

GetQueueEngineVersionByEnv

-

リアルタイムノードのエンジンバージョンを取得します。

CreateStreamBatchJobMapping

-

Flink SQL ノードを作成します。

GetStreamJobs

-

リアルタイムノードのリストを取得します。

パイプライン

PipelineAsyncExeResult

-

非同期実行のステータスと結果を取得します。

FileInfo

-

パイプラインに保存されているファイルの情報を取得します。

HopCommand

-

パイプラインエッジを構成します。

NodeRelationInternal

-

スケジューリング依存関係を構成します。

PipelineCommand

-

パイプラインを構成します。

PipelineObject

-

パイプラインオブジェクトを指定します。

PipelineSettings

-

ノードチャンネルを構成します。

PipelineTreeNodeBriefDTO

-

パイプラインディレクトリツリーの概要情報。

QueryPipelineDirectoryTreeCommand

-

パイプラインディレクトリツリーをクエリします。

ScheduleCommand

-

パイプラインスケジューリングを構成します。

StepCommand

-

パイプラインステップを構成します。

AsyncCreatePipeline

-

ワンクリックでパイプラインを非同期的に作成します。

CreatePipeline

-

パイプラインノードを作成します。

CreatePipelineNode

-

リアルタイム統合ノードを作成します。これには基本的なノード情報のみが含まれます。

GetAsyncExeResult

-

非同期実行のステータスと結果をクエリします。

GetPipeline

-

パイプラインノードの詳細をクエリします。

GetPipelineByVersion

-

開発環境のパイプラインバージョンの詳細を表示します。基本プロジェクトの場合、これは本番環境です。

ListAsyncExeResult

-

非同期実行のステータスと結果をバッチクエリします。

ListPipeline

-

パイプラインノードをバッチクエリします。

ListPipelineDirectoryTree

-

統合ディレクトリリストをバッチクエリします。

OfflineAndDeletePipeline

-

パイプラインをオフラインにして削除します。削除されたパイプラインは回復できません。

OfflinePipeline

-

パイプラインノードをオフラインにします。

SubmitPipeline

-

パイプラインノードを送信します。

UpdatePipeline

-

パイプラインノードを更新します。

コンポーネント (インターフェース)

ADB for MySQL 2.0

-

出力ウィジェット。

ADB for MySQL 3.0

-

入出力ウィジェット。

ADB for PostgreSQL

-

入出力ウィジェット。

Column

-

組み込みの Builder を使用してこれを構築します。

ColumnCalculation

-

フィールド計算ウィジェット。

ColumnFilter

-

フィルターウィジェット。

ColumnMapping

-

組み込みの Builder を使用してこれを構築します。

ColumnSelection

-

フィールド選択ウィジェット。

ConditedDistribution

-

条件付き配布ウィジェット。

IBM DB2

-

入出力ウィジェット。

HBase

-

入出力ウィジェット。

Hive

-

入出力ウィジェット。

LogicTable

-

論理テーブル入力ウィジェット。

MaxCompute

-

入出力ウィジェット。

MySQL

-

入出力ウィジェット。

OSS

-

入出力ウィジェット。

OceanBase

-

入出力ウィジェット。

Oracle

-

入出力ウィジェット。

PolarDB

-

入出力ウィジェット。

PolarDB-X (formerly DRDS)

-

入出力ウィジェット。

PostgreSQL

-

入出力ウィジェット。

SpeedLimit

-

スロットリングウィジェット。

SQL Server

-

入出力ウィジェット。

Tera Data

-

入出力ウィジェット。

Vertica

-

入出力ウィジェット。

公開

GetLatestSubmitDetail

GetLatestSubmitDetail

公開される最新のレコードの詳細を取得します。これは、データ処理、パイプラインオブジェクト、またはアセット分離から特定のノードレコードを公開するための詳細を取得します。

ListObjectsToPublish

ListSubmitRecords

公開されるレコードを一覧表示します。これには、データ処理、パイプラインオブジェクト、およびアセット分離ノードのレコードが含まれます。

ListPublishingHistory

ListPublishRecords

公開レコードを一覧表示します。これには、データ処理、パイプラインオブジェクト、およびアセット分離ノードの公開レコードが含まれます。

PublishObject

PublishObjectList

オブジェクトを公開します。これは、データ処理、パイプラインオブジェクト、およびアセット分離ノードの公開 API です。公開するオブジェクトの ID は、ListObjectsToPublish (公開されるレコードのリスト) API から取得します。

リソース

CreateResource

-

リソースを作成します。

DeleteResource

-

リソースを削除します。

GetGlobalResourceStorageCredential

GetFileStorageCredential

リソースファイルをアップロードするためのストレージ構成を取得します。

GetResource

-

リソースの詳細を取得します。

GetResourceByVersion

-

開発環境のリソースバージョンの詳細をクエリします。基本プロジェクトの場合、これは本番環境です。

GetResourceStorageCredential

GetFileStorageCredential

リソースファイルをアップロードするためのストレージ構成を取得します。これは、OSS ソフトウェア開発キット (SDK) を呼び出してファイルをアップロードするために使用されます。

UpdateResource

-

リソースを更新します。

関数

CreateUdf

-

ユーザー定義関数を作成します。

DeleteUdf

-

ユーザー定義関数を削除します。

GetUdf

-

ユーザー定義関数の詳細をクエリします。

GetUdfByVersion

-

ユーザー定義関数のバージョンの詳細をクエリします。

UpdateUdf

-

ユーザー定義関数を更新します。

古いインターフェイスの API

新しいインターフェイスの API

API の説明

BindGroupToApp

-

オーディエンスグループをアプリケーションに関連付けます。

CreateGroupByImport

-

オーディエンスグループをインポートします。

CreateGroupPageQuery

-

オーディエンスグループのページングクエリを作成します。

DeleteGroup

-

オーディエンスグループを削除します。

DeleteGroupPage

-

オーディエンスグループのページングサービスを削除します。

DeleteGroupVersion

-

オーディエンスグループのバージョンを削除します。

EditGroupPageQuery

-

オーディエンスグループのページングクエリを編集します。

GetComputeSourceFileStorageCredentials

-

コンピュートソース構成ファイルのアップロード資格情報を取得します。この資格情報を使用して構成ファイルをアップロードできます。

GetGroupPageApiCode

-

オーディエンスグループのページングクエリのサービス呼び出しコードを取得します。

GetOnlineClusterById

-

オーディエンスグループ ID に基づいてオーディエンスグループの詳細を取得します。

GetOnlineFeatureById

-

タグ ID に基づいてタグの詳細を取得します。

ListOnlineFeatures

-

公開されたタグのリストを取得します。

ListApplyFeaturesInProject

-

現在のプロジェクトでリクエストされたタグのリストを取得します。

ListApps

-

アプリケーションのリストを取得します。(V3.14.1 で追加)

ListFeaturesInProject

-

現在のプロジェクトで開発されたタグのリストを取得します。

ListGroupPageSubscription

-

公開されたオーディエンスグループのページングクエリサービスのリストを取得します。

ListGroupsInApp

-

アプリケーションでリクエストされたオーディエンスグループのリストをクエリします。(V3.14.1 で追加)

ListOnlineClusters

-

公開されたオーディエンスグループのリストを取得します。

ListTagsInApp

-

アプリケーションでリクエストされたタグのリストをクエリします。(V3.14.1 で追加)

ListingGroup

-

マーケットプレイスでオーディエンスグループをリストします。

OfflineGroup

-

オーディエンスグループをオフラインにします。

OfflineGroupPage

-

オーディエンスグループのページングサービスをオフラインにします。

OnlineGroupPageQuery

-

オーディエンスグループのページングクエリを公開します。

PublishAndOnlineGroup

-

オーディエンスグループのバージョンを公開およびリストします。

PublishGroup

-

オーディエンスグループのバージョンを公開します。

QueryGroupStatus

-

オーディエンスグループのステータスを取得します。

QueryGroupVersionStatus

-

オーディエンスグループのバージョンのステータスを取得します。

QuerySubscriptionStatus

-

オーディエンスグループのオフラインサービスのステータスを取得します。

RevokeGroup

-

オーディエンスグループを取り消します。

SaveGroup

-

初めてオーディエンスグループを作成します。

SaveGroupVersion

-

オーディエンスグループのバージョンを作成します。

SubmitGroupVersion

-

オーディエンスグループのバージョンを送信します。

SupplementGroupData

-

オーディエンスグループのデータバックフィルを実行します。

SupplementGroupPageData

-

オーディエンスグループのページングクエリサービスのデータバックフィルを実行します。

UnlistingGroup

-

オーディエンスグループを非公開にします。この操作には承認は必要ありません。

API (古いインターフェイス)

API (新しいインターフェイス)

API の説明

メタデータ

GetTableColumnLineage

-

フィールドリネージ情報をクエリします。

GetTableLineage

-

テーブルリネージ情報をクエリします。

GetTableLineageByTaskId

GetTableLineageByTaskId

ノード ID に基づいて関連するテーブルリネージをクエリします。

GetTableColumnLineageByTaskId

GetTableColumnLineageByTaskId

ノード ID に関連するフィールドリネージをクエリします。

ListCatalogTableColumns

-

アセットテーブルの列をクエリします。

ListLogicTableColumns

-

論理テーブルの列をクエリします。

ListRealtimeTableColumns

-

ストリーミングテーブルの列をクエリします。

ListTableColumns

-

物理テーブルの列をクエリします。

ListTablePartitions

-

物理パーティションデータをクエリします。

ListTables

-

テーブルメタデータをクエリします。

QueryLogicTable

-

論理テーブルの詳細をクエリします。

QueryRealtimeTable

-

ストリーミングテーブルの詳細をクエリします。

QueryTable

-

物理テーブルをクエリするための API を提供します。

QueryTableLineage

-

[非推奨] フィールドリネージ関係をクエリします。ストリーミングテーブルはサポートされていません。

代わりに新しい GetTableColumnLineage API を使用してください。

RegisterAssetMetaData

-

新しいアセットタイプのメタデータを登録します。

ReportAsset

-

アセットを Dataphin に報告します。

SearchCatalogTable

-

非推奨。アセットテーブルのメタデータをクエリします。新しい SearchCatalogTableV2 API を使用してください。

データ標準

CancelInvalidMappingRelation

-

無効なマッピング関係をキャンセルします。

CancelValidMappingRelation

-

有効なマッピング関係をキャンセルします。

ChangeValidMappingRelationToInvalid

-

有効なマッピング関係を無効なものに変更します。

CreateLookupTable

-

ルックアップテーブルを作成します。

CreateMappingRelations

-

有効なマッピングと無効なマッピングを含むマッピング関係を作成します。

CreateStandard

-

データ標準を作成します。

CreateStandardRelations

-

データ標準の関連付け関係を作成します。

CreateStandardSet

-

データ標準セットを作成します。

CreateStandardTemplate

-

データ標準テンプレートを作成します。

CreateWordRoot

-

ルートを作成します。

DeleteLookupTable

-

ルックアップテーブルを削除します。

DeleteStandardRelations

-

データ標準の関連付け関係を削除します。

DeleteStandardSet

-

データ標準セットを削除します。

DeleteWordRoot

-

ルートを削除します。

FuzzySearchStandard

-

指定されたクエリ条件を満たすデータ標準のページングクエリを実行します。

DeleteStandard

-

データ標準を削除します。

GetStandardStatisticsOfType

-

フォルダ内のデータ標準の数を、標準タイプ別にカウントしてクエリします。

QueryLookupTable

-

ルックアップテーブルをクエリします。

QueryMappingRelationByAsset

-

アセットオブジェクトに基づいてマッピング関係をクエリします。

QueryMappingRelationByBelongAsset

-

所有アセットに基づいてマッピング関係をクエリします。

QueryStandard

-

標準 ID に基づいて、指定されたバージョンとステータスのデータ標準をクエリします。

QueryStandardSet

-

標準セット ID に基づいてデータ標準セットをクエリします。

QueryStandardTemplate

-

標準テンプレート ID に基づいてデータ標準テンプレートをクエリします。

QueryWordRoot

-

ルートをクエリします。

SubmitStandard

-

データ標準を公開します。

UnpublishStandard

-

公開されたデータ標準をオフラインにします。

UpdateLookupTable

-

ルックアップテーブルを更新します。

UpdateStandard

-

データ標準を更新します。

UpdateStandardSet

-

データ標準セットを更新します。

UpdateStandardTemplate

-

データ標準テンプレートを更新します。

UpdateWordRoot

-

ルートを更新します。

Data Quality

AssignQualityRuleSchedules

-

ルールをスケジュール設定にアタッチします。

GetQualityAlert

-

監視対象 ID によってアラート設定を取得します。

GetQualityRule

-

ID によって品質ルールオブジェクトを取得します。

GetQualityRuleTask

-

ID によって品質タスクオブジェクトを取得します。

GetQualityRuleTaskLog

-

ID によって品質タスクオブジェクトのログコンテンツを取得します。

GetQualitySchedule

-

ID によって品質スケジュールオブジェクトを取得します。

GetQualityTemplate

-

ID によって品質テンプレートオブジェクトを取得します。

GetQualityWatch

-

ID によって品質監視対象オブジェクトを取得します。

GetQualityWatchByObjectId

-

データソース、テーブル、メトリックの ID などの元の ID によって監視対象オブジェクトのレコードを取得します。

GetQualityWatchTask

-

ID によって監視タスクオブジェクトを取得します。

GetQualityWatchTaskLog

-

ID によって監視タスクオブジェクトのログコンテンツを取得します。

ListQualitySchedules

-

監視対象 ID によってスケジュール設定のリストを取得します。

OpenCloseQualityRules

-

品質ルールをバッチで有効または無効にします。

OpenCloseQualityWatches

-

品質監視対象オブジェクトをバッチで有効または無効にします。

PagedQueryQualityRuleTasks

-

品質ルールタスクのページングクエリを実行します。

PagedQueryQualityRules

-

品質ルールのページングクエリを実行します。

PagedQueryQualityTemplates

-

品質テンプレートのページングクエリを実行します。

PagedQueryQualityWatchTasks

-

品質監視オブジェクトタスクのページングクエリを実行します。

PagedQueryQualityWatches

-

品質監視対象オブジェクトのページングクエリを実行します。

RemoveQualityRuleSchedules

-

品質ルールとスケジュールの間のバインディング関係をバッチで削除します。

RemoveQualityRules

-

品質ルールオブジェクトをバッチで削除します。

RemoveQualitySchedules

-

品質スケジュールオブジェクトをバッチで削除します。

RemoveQualityTemplates

-

品質テンプレートオブジェクトをバッチで削除します。

RemoveQualityWatches

-

品質監視対象オブジェクトをバッチで削除します。

SaveQualityAlert

-

監視対象オブジェクトのアラート設定を作成または変更します。

SaveQualityRule

-

品質ルールを作成または変更します。

SaveQualitySchedule

-

スケジュール設定を作成または変更します。

SaveQualityTemplate

-

品質テンプレートを作成または変更します。

SaveQualityWatch

-

品質監視対象オブジェクトを追加します。Dataphin テーブル、グローバルテーブル、データソース、メトリック、ストリーミングテーブルなど、複数のタイプの品質監視対象オブジェクトを追加できます。

SubmitQualityRuleTasks

-

ルールタスクをバッチで送信します。試用実行がサポートされています。

SubmitQualityWatchTasks

-

監視対象オブジェクトの検証タスクをバッチで送信します。

データセキュリティ

AddSecurityLabel

-

セキュリティ検出結果を作成します。上書きモードを選択するか、オンラインのセキュリティ検出結果を変更できます。

CreateClassifyCatalog

-

データ分類フォルダを作成します。 データ分類 - 管理 権限を持つロールは、任意のフォルダを作成できます。レベル 1 フォルダの管理者は、そのレベル 1 フォルダの下にのみフォルダを作成できます。

CreateSecurityClassify

-

セキュリティ分類を作成します。

CreateSecurityLevel

-

セキュリティレベルを作成します。

GetSecretKeyByName

-

キー名に基づいてキーの詳細をクエリします。

GetSecurityClassifyDetail

-

分類 ID に基づいてデータ分類の詳細をクエリします。

GetSecurityLabelById

-

ID によって検出結果オブジェクトを取得します。

GetSecurityLevelDetail

-

レベル ID に基づいてデータセキュリティレベルの詳細をクエリします。

PagedQuerySecurityIdentifyRecordsOfField

-

セキュリティ検出結果の検出詳細のページングクエリを実行します。

PagedQuerySecurityLabels

-

セキュリティ検出結果のページングクエリを実行します。

RemoveClassifyCatalog

-

データ分類フォルダを削除します。 データ分類 - 管理 権限を持つカスタムロールは、任意のフォルダを削除できます。レベル 1 フォルダの管理者は、そのレベル 1 フォルダとそのサブディレクトリのみを削除できます。

RemoveSecurityClassify

-

セキュリティ分類を削除します。

RemoveSecurityLabels

-

セキュリティ検出結果をバッチで削除します。

RemoveSecurityLevel

-

セキュリティレベルを削除します。

UpdateClassifyCatalog

-

データ分類フォルダを更新します。データ分類 - 管理 権限を持つカスタムロールは、任意のフォルダを変更できます。レベル 1 フォルダの管理者は、そのレベル 1 フォルダとそのサブディレクトリのみを変更できます。移動操作の場合、オペレーターはソースとターゲットの両方のレベル 1 フォルダの管理者権限を持っている必要があります。

UpdateSecurityClassify

-

セキュリティ分類を更新します。

UpdateSecurityLabelsEnableStatus

-

セキュリティ検出結果のアクティブステータスをバッチで更新します。

UpdateSecurityLabelsIdentifyRule

-

セキュリティ検出結果にアタッチされた検出ルールをバッチで更新します。

UpdateSecurityLevel

-

セキュリティレベルを更新します。

DataService Studio

CreateDataServiceApi

-

新しい DataService Studio API を作成して送信します。

PublishDataServiceApi

-

API の指定されたバージョンを本番環境に公開します。

ListApiByApp

-

アプリケーション内の承認済み API の詳細リストをクエリします。

QueryApiDocument

GetDataServiceApiDocument

API ドキュメントを取得します。

QueryApiLogPage

ListDataServiceApiCalls

サービスモニタリングで API 呼び出しのログクエリを実行します。

QueryApiServiceGroup

GetDataServiceApiGroups

API サービスグループのリストをクエリします。

QueryApiServicePage

ListDataServicePublishedApis

公開された API のリストのページングクエリを実行します。

QueryErrorImpact

GetDataServiceApiErrorImpactSummary

API エラーの影響を分析します。

QueryIndicators

GetDataServiceApiCallSummary

サービスモニタリング呼び出しの概要統計を取得します。

QueryVisitTrend

GetDataServiceApiCallTrend

サービスモニタリングのアクセス傾向を分析します。

ApplyApi

ApplyDataServiceApiPermission

API 権限をリクエストします。

QueryApiAuthPage

ListDataServiceAuthorizedApis (既存の ListAuthorizedDataServiceApiDetails API で置き換え可能)

現在のユーザーがアクセス権を持つ API のリストをクエリします。

QueryApiGroup

GetDataServiceAuthorizedApiGroups

現在のプロジェクトの API グループのリストをクエリします。

QueryGroupApi

-

グループ内の API のリストをクエリします。

QueryPrivateApp

GetDataServiceAuthorizedAppsByGroupId

アカウントがアクセス権を持つアプリケーションのリストをクエリします。

ApplyApp

ApplyDataServiceAppPermission

アプリケーション権限をリクエストします。

QueryAppAuthPage

ListDataServiceAuthorizedApps

現在のユーザーがアクセス権を持つアプリケーションのリストをクエリします。

QueryAppGroup

GetDataServiceAuthorizedAppGroups

現在のプロジェクトのアプリケーショングループのリストをクエリします。

QueryGroupApp

GetDataServiceAppsByGroupId

グループ内のアプリケーションのリストをクエリします。

ApplyDataSource

-

Dataphin データソースの権限をリクエストします。

QueryDataSourceAppGroup

-

Dataphin データソースグループのリストをクエリします。

QueryDataSourceAuthPage

-

プロジェクトに基づいて、権限がリクエストされた Dataphin データソースのページ分割されたリストをクエリします。

QueryDataSourceGroup

-

現在のテナントプロジェクトのグループをクエリします。

QueryGroupDataSource

-

Dataphin データソースグループ内の Dataphin データソースを一覧表示します。

QueryLogicalTable

-

指定された Dataphin データソース内の論理テーブルをクエリします。

QueryPhysicalTable

-

指定された Dataphin データソース内の物理テーブルをクエリします。

QueryTableColumn

-

Dataphin データソースのテーブルフィールドをクエリします。

AuthorizeApi

GrantDataServiceApiPermission

API 権限を付与します。

QueryMyApiPage

ListDataServiceMyApiPermissions

API 権限を一覧表示します。

RecycleApi

RevokeDataServiceApiPermission

API 権限を取り消します。

AuthorizeApp

GrantDataServiceAppPermission

アプリケーション権限を付与します。

GrantAppToUser

GetDataServiceAppAdmins

アプリケーション所有者をクエリします。

ListAppAuthUser

GetDataServiceAppAuthorizedUsers

アプリケーション権限を持つユーザーを一覧表示します。

QueryMyAppPage

ListDataServiceMyAppPermissions

権限を持つアプリケーションをクエリします。

RecycleApp

RevokeDataServiceAppPermission

アプリケーション権限を取り消します。

AuthorizeDataSource

-

Dataphin データソースのアプリケーション承認をリクエストします。

QueryMyDataSourcePage

-

権限を持つデータソースのリストをクエリします。

RecycleDataSource

-

Dataphin データソースの権限を取り消します。

ListAuthorizedDataServiceApiDetails

-

承認された DataService Studio API に関する情報を一覧表示します。

ListManagerProject

GetDataServiceMyProjects

現在のユーザーがオーナーであるプロジェクトのドロップダウンリストを提供します。

ListDataphinDsPermissions

-

現在のアカウントのテナントが DataService Studio (Dataphin) の権限を持っているかどうかを確認します。

QueryDataSourceDocument

-

データソース ID に基づいてデータソースの詳細をクエリします (Dataphin データソースドキュメント)。

QueryDataSourceServicePage

-

Dataphin データソースのページ分割されたリストをクエリします。

QueryApiImpactDetail

ListDataServiceApiImpacts

API の影響分析結果を一覧表示します。

QueryApiMonitor

ListDataServiceApiMaintanceStatistics

API の O&M 統計をクエリします。

CreateProjectUser

AddDataServiceProjectMember

プロジェクトユーザーを追加し、ロールを設定します。

ListDataphinUser

GetDataServiceProjectMembers

現在のテナントプロジェクトのユーザーリストをクエリします。

ListPrivilegedProject

GetDataServiceAuthorizedProjects

権限を持つプロジェクトのリストをクエリします。

QueryProjectPage

ListDataServiceProjects

プロジェクトのページングクエリを実行します。

QueryProjectUserPage

-

プロジェクトメンバーのリストのページングクエリを実行します。

pageInfo

-

なし。

ParseSql

ParseDataServiceSql

SQL を翻訳

SqlLegalityVerify

CheckDataServiceSqlLegality

SQL を検証および認証します。

API (旧インターフェイス)

API (新インターフェイス)

API の説明

購入済みの特徴

ListFeatures

-

現在のテナントで利用可能な機能のリストを取得します。

プロジェクト管理

AddProjectMembers

AddProjectMember

プロジェクトメンバーを追加します。基本プロジェクトと DEV-PROD プロジェクトにメンバーを追加できます。

DeleteProjectMembers

DeleteProjectMember

プロジェクトメンバーを削除します。基本プロジェクトと DEV-PROD プロジェクトからメンバーを削除できます。

GetProject

-

プロジェクト ID と環境コンテキストに基づいてプロジェクト情報を取得します。

GetProjectByName

-

プロジェクト名に基づいてプロジェクト情報を取得します。開発環境でプロジェクトをクエリする場合、プロジェクト名に _dev サフィックスを追加する必要があります。

ListProjectByProjectType

-

プロジェクトタイプでプロジェクトをフィルタリングします。

ListProjectMembers

-

プロジェクト ID と環境コンテキストに基づいてプロジェクトメンバーのリストを取得します。

ListProjects

-

プロジェクトタイプでプロジェクトをフィルタリングします。

QueryProjectWhiteList

GetProjectWhiteLists

プロジェクト ID に基づいてプロジェクトホワイトリストをクエリします。

UpdateProjectMembers

UpdateProjectMember

プロジェクトメンバーを更新します。基本プロジェクトと DEV-PROD プロジェクトのメンバーを更新できます。

データソース

CheckDataSourceConnectivity

-

データソースの接続性を確認します。

CheckExistDataSourceConnectivity

-

既存のデータソースの接続性を確認します。

CreateDataSource

-

データソースを作成します。この API は、本番データソースのみを作成する、開発データソースと本番データソースの両方を作成する、または既存の本番データソース用に開発データソースを作成するという 3 つのモードをサポートしています。

DeleteDevProdModeDataSource

-

データソースを削除します。開発環境のデータソースのみを削除するか、開発データソースと本番データソースの両方を削除できます。Dataphin では、開発データソースが独立して存在することは許可されていません。

ListDataSourceDependency

GetDataSourceDependencies

データソースの依存関係を検索します。API は結果をリストとして返します。

SearchDataSourceConfig

-

データソースを検索します。結果はページで返されます。データソースの構造は、開発-本番のペアです。

UpdateDataSourceBasicInfo

-

データソースの名前や説明などの基本情報を更新します。

UpdateDataSourceConfiguration

-

接続 URL、ユーザー名、パスワードなど、データソースの構成を更新します。

行レベル権限

ListRowPermission

-

V5.1 の新しい API。行レベルの権限のリストを取得します。

GetAccountByRowPermissionId

-

V5.1 の新しい API。行レベルの権限 ID に基づいて、特定の行レベルの権限に対して承認されたすべてのアカウントを取得します。

ListAccountByRowPermissionId

-

行レベルの権限 ID に基づいてアカウントのリストを取得します。

CreateRowPermission

-

V5.1 の新しい API。行レベルの権限を作成します。

DeleteRowPermission

-

V5.1 の新しい API。ID に基づいて行レベルの権限を削除します。

UpdateRowPermissionBasicInfo

-

行レベル権限の基本情報を更新します。

AddControlRule

-

行レベル権限のコントロールルールを追加します。

UpdateControlRule

-

行レベルの権限の制御ルールを更新します。

DeleteControlRule

-

行レベル権限のコントロールルールを削除します。

AddAssociatedTable

-

関連テーブルの行レベルの権限情報を追加します。

DeleteAssociatedTable

-

関連テーブルの行レベル権限情報を削除します。

ListRowPermissionByUserId

-

V5.1 の新しい API。ユーザーの行レベルの権限のリストを取得します。

UpdateRowPermission

-

V5.1 の新しい API。行レベルの権限を更新します。

計算ソース

CheckComputeSourceConnectivity

-

計算ソース構成の接続性を確認します。

CheckComputeSourceConnectivityById

-

プロジェクト ID に基づいてプロジェクトの接続性を確認します。

CreateComputeSource

-

計算ソースを作成します。

DeleteComputeSource

-

コンピュートソースを削除します。

GetComputeSource

GetComputeSourceInfo

コンピュートソース ID に基づいてコンピュートソース情報を取得します。

GetComputeSourceFileCredentials

GetFileStorageCredential

コンピュートソース構成ファイルのアップロード資格情報を取得します。この資格情報を使用して構成ファイルをアップロードできます。

QueryComputeSource

ListComputeSources

コンピュートソースをバッチクエリします。

SetTenantComputeEngine

UpdateTenantComputeEngine

テナント計算エンジンを設定します。

UpdateComputeSource

-

計算ソースを更新します。

ユーザーと承認

AddUser

-

テナントにユーザーを追加します。

BatchAddTenantMember

-

テナントにユーザーを一括追加します。

BatchGetUsers

-

UserId に基づいてユーザー情報を一括取得します。

BatchSyncUsers

-

テナントメンバー情報を同期します。

CheckResourcePermission

-

個人アカウントまたはテナントアカウントが特定のリソースを操作する権限を持っているかどうかを確認します。

CreateUserGroup

-

ユーザーグループを作成します。

DeleteUserGroup

-

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

GetDataSourceUserList

-

データソース ID に基づいて、データソースの権限を持つユーザーをクエリします。

GetOpsTenant

-

O&M テナント情報を取得します。

GetPermissionChangeObjects

-

権限変更オブジェクトの詳細を取得します。

GetProjectProduceUser

-

プロジェクトのテナントアカウントを取得します。

GetRoleListByUserId

-

ユーザーが持つロールのリストを取得します。

GetUserGroup

-

ユーザーグループの詳細を取得します。

GetUserInfoBySourceId

-

外部アカウント ID に基づいて、対応する Dataphin ユーザー情報をクエリします。

GrantByResource

-

リソースに基づいてユーザーに権限を付与します。

GrantPermissionToDataSource

-

データソースの複数の権限を複数のユーザーに付与します。新しい GrantByResource API の使用をお勧めします。

GrantRole

-

ユーザーにロールを付与します。この API は非推奨です。テナントレベルのロールを設定するには、UpdateTenantMembers API を使用してください。

IsProductAdmin

-

現在のユーザーが特定のプロダクトのスーパー管理者であるかどうかを確認します。

ListAddableRoles

-

メンバーに設定可能なユーザーロール ([管理センター] > [メンバー管理])。

ListAssetPermissionAudit

-

権限操作の監査情報のページ分割されたリストを取得します。

ListPermissionChangeLog

-

カーソルを使用して権限変更レコードを取得します。

ListPermissionOperationAudit

-

権限操作の監査情報のページ分割されたリストを取得します。

ListDepts

-

テナントの部署を一覧表示します。

ListUserGroup

-

ユーザーグループ情報をページ分割されたリストで取得します。

ListUserGroupMember

-

ユーザーグループのメンバー情報をページ分割されたリストで取得します。

ListUsers

-

ユーザー情報をページ分割されたリストで取得します。

MineTenants

-

自分のテナント情報を一覧表示します。

QueryPagedAddableUsers

-

テナントに追加できるユーザーをクエリします。

QueryPagedDept

-

レベル 1 の部署情報のページングクエリを実行します。

QueryPagedMembers

-

メンバーリストのページングクエリを実行します。

RemoveUser

-

テナントからユーザーを削除します。

RevokeByResource

-

リソースに基づいてユーザーの権限を取り消します。

RevokePermissionFromDataSource

-

データソースからユーザーの権限を削除します。新しい RevokeByResource API の使用をお勧めします。

UpdateTenantMemberStatus

-

テナントメンバーの有効または無効ステータスを更新します。

UpdateTenantMembers

-

テナントメンバー情報を更新します。

UpdateUserGroup

-

ユーザーグループメンバーリスト情報を更新します。

UpdateUserGroupSwitch

-

ユーザーグループの有効ステータスを変更します。

AddUserToUserGroup

-

ユーザーをユーザーグループに追加します。

RemoveUserFromUserGroup

-

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

UpdateTenantMembersStatus

-

ユーザーを有効または無効にします。

ListTenantRolesByUserId

-

ユーザー ID に基づいてテナントレベルのロールを取得します。

ListTenantRoles

-

テナントレベルのロールを取得します。

Python サードパーティパッケージ

ListPythonModule

-

Python サードパーティパッケージのページングクエリを実行します。