すべてのプロダクト
Search

このプロダクト

    Data Management:API の概要

    ドキュメントセンター

    Data Management:API の概要

    最終更新日:Jul 15, 2026

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

    本製品 (dms-enterprise/2018-11-01) の 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

    タイトル

    説明
    DeleteUser DeleteUser 使用されなくなった Alibaba Cloud アカウントを削除します。
    UpdateUser UpdateUser ユーザー情報を更新します。
    DisableUser DisableUser Data Management (DMS) で一時的に使用されなくなったユーザーを無効にします。
    EnableUser EnableUser 無効になっているユーザーを有効にします。
    ListUsers ListUsers ユーザーの詳細を照会します。
    GetUser GetUser ユーザーの情報を照会します。
    GetUserActiveTenant GetUserActiveTenant アクティブなテナントの詳細を照会します。
    ListUserTenants ListUserTenants テナントを照会します。
    RegisterUser RegisterUser 企業向けユーザーを追加します。

    インスタンス管理

    API

    タイトル

    説明
    AddInstance AddInstance この操作は、データベースインスタンスを Data Management (DMS) に追加し、インスタンスのセキュリティホスティングを有効にするために使用します。
    ModifyInstance ModifyInstance Data Management (DMS) のデータベースインスタンスに関する基本情報と詳細情報を変更します。基本情報には、インスタンスのホスティングモード、インスタンスアカウントのユーザー名とパスワード、およびインスタンスで有効化されている機能が含まれます。詳細情報には、環境タイプ、DMS 内のインスタンス名、データクエリおよびエクスポートのタイムアウト期間が含まれます。
    ListInstances インスタンスのリストを取得します ListInstances 操作を呼び出してインスタンスのリストを取得します。
    GetInstance GetInstance 指定されたインスタンスの詳細情報を取得します。
    DeleteInstance DeleteInstance Data Management (DMS) のインスタンス一覧からデータベースインスタンスを削除します。
    RegisterInstance RegisterInstance DMS にデータベースインスタンスを登録します。
    UpdateInstance UpdateInstance データベースインスタンスの情報を更新し、データベースインスタンスの接続性を確認します。

    監査

    API

    タイトル

    説明
    GetOpLog GetOpLog 指定された期間内に生成された操作ログの詳細を照会します。
    ListInstanceLoginAuditLog ListInstanceLoginAuditLog インスタンスのログイン記録をクエリします。
    ListProxySQLExecAuditLog ListProxySQLExecAuditLog セキュアアクセスプロキシ機能によって生成された監査ログをクエリします。
    ListSQLExecAuditLog ListSQLExecAuditLog Data Management (DMS) で実行された SQL ステートメントの監査ログをクエリします。

    承認プロセス

    API

    タイトル

    説明
    ListWorkFlowTemplates ListWorkFlowTemplates 承認テンプレートをクエリします。
    ListWorkFlowNodes ListWorkFlowNodes 承認ノードを照会します。
    SetWorkflowExtraInfo SetWorkflowExtraInfo DMS コンソールのチケット承認セクションにおいて、「同意」、「却下」、「署名」などの操作ボタンを表示するかどうかを設定します。

    データベースおよびテーブルのメタデータ

    API

    タイトル

    説明
    論理データベースおよびテーブル 論理データベースおよびテーブル
    CreateLogicDatabase CreateLogicDatabase DMS の論理データベースを作成します。
    AddLogicTableRouteConfig AddLogicTableRouteConfig 論理テーブルにルーティングアルゴリズムを追加します。
    DeleteLogicDatabase DeleteLogicDatabase Data Management (DMS) から論理データベースを削除します。 この操作は指定された論理データベースのみを削除し、物理データベースは削除しません。
    DeleteLogicTableRouteConfig DeleteLogicTableRouteConfig 論理テーブルからルーティングアルゴリズムを削除します。
    ListLogicDatabases ListLogicDatabases 論理データベースの詳細情報を照会します。
    GetLogicDatabase GetLogicDatabase 論理データベースの詳細情報を照会します。
    ListLogicTables ListLogicTables 論理データベース内の論理テーブルの詳細をクエリします。
    GetDBTopology GetDBTopology 論理データベースとその物理データベースシャードのトポロジーを照会します。
    GetTableDBTopology GetTableDBTopology データテーブルのトポロジーを照会します。
    ListLogicTableRouteConfig ListLogicTableRouteConfig 論理テーブルのルーティングアルゴリズムを照会します。
    EditLogicDatabase EditLogicDatabase 論理データベース情報を編集します。
    データレイクのデータベースおよびテーブル データレイクのデータベースおよびテーブル
    ListDataLakeDatabase ListDataLakeDatabase データレイク内のデータベース一覧をクエリします。
    GetDataLakeDatabase GetDataLakeDatabase データレイク内のデータベースに関する情報を照会します。
    ListDataLakeCatalog ListDataLakeCatalog データレイク内のデータカタログのリストをクエリします。
    GetDataLakeCatalog GetDataLakeCatalog データレイクのデータカタログを照会します。
    ListDataLakeTablebaseInfo ListDataLakeTablebaseInfo データレイク内のテーブルの基本情報をクエリします。
    GetDataLakeTable GetDataLakeTable データレイク内のテーブルの基本情報をクエリします。
    BatchCreateDataLakePartitions BatchCreateDataLakePartitions この API は、データレイクのテーブルパーティションを一括で作成するために使用します。
    UpdateDataLakeTable UpdateDataLakeTable データレイクハウス内のテーブルに関する情報を更新します。
    UpdateDataLakePartition UpdateDataLakePartition データレイクハウス内のテーブルのパーティション情報を更新します。
    UpdateDataLakeDatabase UpdateDataLakeDatabase データレイクハウス内のデータベースに関する情報を更新します。
    ListDataLakeTableName ListDataLakeTableName データレイク内のテーブル名のリストをクエリします。
    ListDataLakeTable ListDataLakeTable データレイク内のテーブルのリストをクエリします。
    ListDataLakePartitionName ListDataLakePartitionName データレイク内のテーブルのパーティション名リストを照会します。
    ListDataLakePartitionByFilter ListDataLakePartitionByFilter フィルター条件に一致するデータレイクテーブルのパーティションをリスト表示します。
    ListDataLakePartition ListDataLakePartition この API を呼び出して、データレイクテーブルのパーティションをリスト表示できます。
    GetDataLakePartition GetDataLakePartition この API を呼び出して、レイクハウスのテーブルパーティションの詳細を取得します。
    DeleteDataLakeTable DeleteDataLakeTable データレイクハウスからテーブルを削除します。
    DeleteDataLakePartition DeleteDataLakePartition データレイクハウス内のテーブルからパーティションを削除します。
    DeleteDataLakeDatabase DeleteDataLakeDatabase データレイクハウスからデータベースを削除します。
    CreateDataLakeTable CreateDataLakeTable データレイクハウスにテーブルを作成します。
    CreateDataLakePartition CreateDataLakePartition データレイクハウス内のテーブルに対してパーティションを作成します。
    CreateDataLakeDatabase CreateDataLakeDatabase データレイクハウス内にデータベースを作成します。
    BatchUpdateDataLakePartitions BatchUpdateDataLakePartitions データレイクハウス内のテーブルの複数のパーティションを一度に更新します。
    BatchDeleteDataLakePartitions BatchDeleteDataLakePartitions データレイクハウス内のテーブルの複数のパーティションを一度に削除します。
    CreateDataLakeFunction CreateDataLakeFunction この API を呼び出して、新しいデータレイクのユーザー定義関数を作成します。
    GetDataLakeFunction GetDataLakeFunction この API を呼び出して、データレイクのユーザー定義関数の詳細を取得します。
    UpdateDataLakeFunction UpdateDataLakeFunction データレイクハウス内のユーザー定義関数を更新します。
    DeleteDataLakeFunction DeleteDataLakeFunction データレイクハウス内のユーザー定義関数を削除します。
    ListDataLakeFunction ListDataLakeFunction この API を呼び出して、データレイクの関数一覧を取得します。
    ListDataLakeFunctionName ListDataLakeFunctionName データレイクの関数名一覧を取得します。
    SearchDatabase SearchDatabase インデックスの詳細。
    SearchTable SearchTable テーブルの詳細情報を照会します。
    ListDatabases ListDatabases ListDatabases API を呼び出して、インスタンスに属するデータベースの一覧を取得します。
    ListTables ListTables データベース内のすべてのテーブルの詳細を一覧表示します。
    ListTableColumns ListTableColumns テーブル内の列の詳細を照会します。
    ListColumns ListColumns テーブルのカラム情報を返します。
    ListIndexes ListIndexes テーブルのインデックスを照会します。
    GetDatabase GetDatabase 指定されたデータベースの詳細を取得します。
    GetPhysicalDatabase GetPhysicalDatabase 物理データベースの詳細情報を照会します。
    GetTableTopology GetTableTopology テーブルのトポロジーを照会します。
    GetMetaTableDetailInfo GetMetaTableDetailInfo GetMetaTableDetailInfo 操作を呼び出して、フィールドやインデックスなど、テーブルの詳細情報を取得します。
    GetMetaTableColumn GetMetaTableColumn テーブル内のカラムの詳細を照会します。
    SyncInstanceMeta SyncInstanceMeta データベースインスタンス内のすべてのデータベースのメタデータを同期します。
    SyncDatabaseMeta SyncDatabaseMeta データベースのメタデータを同期します。
    GetTableKnowledgeInfo GetTableKnowledgeInfo 指定された GUID のメタデータ情報を取得します。
    EditMetaKnowledgeAsset EditMetaKnowledgeAsset 指定された GUID のメタデータのビジネスナレッジを編集します。

    チケット操作

    API

    タイトル

    説明
    全般 全般
    CreateOrder Create Ticket チケットを作成します。
    GetApprovalDetail GetApprovalDetail チケットの承認詳細を照会します。
    ListOrders ListOrders ListOrders を呼び出して、チケットのリストを取得できます。
    GetOrderBaseInfo GetOrderBaseInfo チケットの基本情報を照会します。
    SubmitOrderApproval SubmitOrderApproval 承認のためにチケットを送信します。
    ApproveOrder ApproveOrder チケットをレビューします。
    CloseOrder CloseOrder チケットをクローズします。
    GetOrderAttachmentFile GetOrderAttachmentFile チケットの添付ファイルのダウンロード URL を照会します。
    PreviewWorkflow PreviewWorkflow チケットの送信前に、その承認プロセスをプレビューします。
    権限申請 権限申請
    GetOwnerApplyOrderDetail GetOwnerApplyOrderDetail Database-OWNER、Table-OWNER、Instance-OWNER のチケットの詳細を照会します。
    GetPermApplyOrderDetail GetPermApplyOrderDetail GetPermApplyOrderDetail を呼び出して、権限申請チケットの詳細情報を取得します。
    データベースおよびテーブルの同期 データベースおよびテーブルの同期
    CreateStructSyncOrder CreateStructSyncOrder スキーマ同期チケットを作成します。
    GetStructSyncOrderDetail GetStructSyncOrderDetail スキーマ同期チケットの詳細を照会します。
    GetStructSyncJobDetail GetStructSyncJobDetail スキーマ同期タスクの情報を照会します。
    GetStructSyncJobAnalyzeResult GetStructSyncJobAnalyzeResult スキーマ同期タスクの分析結果を照会します。
    GetStructSyncExecSqlDetail GetStructSyncExecSqlDetail スキーマ同期チケットに関連付けられた SQL ステートメントを照会します。
    SubmitStructSyncOrderApproval SubmitStructSyncOrderApproval スキーマ同期のチケットを承認のために送信します。
    ExecuteStructSync ExecuteStructSync スキーマ同期タスクを実行します。
    データ変更 データ変更
    CreateDataCorrectOrder CreateDataCorrectOrder Data Management (DMS) でデータを変更するためのチケットを作成します。
    CreateDataCronClearOrder CreateDataCronClearOrder 既存データのクリーンアップチケットを作成します。
    CreateDataImportOrder CreateDataImportOrder データインポートチケットを作成します。
    CreateFreeLockCorrectOrder CreateFreeLockCorrectOrder ロックレス変更チケットを作成します。
    ModifyDataCorrectExecSQL ModifyDataCorrectExecSQL データ変更チケットで提出された SQL スクリプトを修正します。
    PauseDataCorrectSQLJob PauseDataCorrectSQLJob データ変更用の SQL ジョブを一時停止します。
    GetDataCorrectTaskDetail GetDataCorrectTaskDetail データ変更、ロックフリーのデータ変更、またはデータインポートタスクに関する情報を照会します。
    GetDataCronClearTaskDetailList GetDataCronClearTaskDetailList 過去のデータクリーニングチケットの詳細をクエリします。
    GetDataCorrectRollbackFile GetDataCorrectRollbackFile データ変更チケットとともに提出されたロールバック添付ファイルのダウンロード URL をクエリします。
    GetDataCorrectBackupFiles GetDataCorrectBackupFiles データ変更チケットのバックアップファイルのダウンロード URL を取得します。
    GetDataCorrectOrderDetail GetDataCorrectOrderDetail Data Management (DMS) におけるデータ変更チケットの情報を照会します。
    GetDataCronClearConfig GetDataCronClearConfig 履歴データのクリーンアップ用チケットのスケジューリング構成を照会します。
    GetDataCorrectSQLFile GetDataCorrectSQLFile データ変更タスクに対応する SQL スクリプトのダウンロード URL を照会します。
    ListDataCorrectPreCheckSQL ListDataCorrectPreCheckSQL データ変更チケットの事前チェックに関連する SQL ステートメントの情報をクエリします。
    ListDataCorrectPreCheckDB ListDataCorrectPreCheckDB データ変更チケットの事前チェックに含まれるデータベースを照会します。
    ExecuteDataCorrect ExecuteDataCorrect データ変更チケットを実行します。
    RetryDataCorrectPreCheck RetryDataCorrectPreCheck データ変更チケットの事前チェックステップを再実行します。
    RestartDataCorrectSQLJob RestartDataCorrectSQLJob 実行に失敗したデータ変更 SQL タスクを再試行します。
    ListDataImportSQLPreCheckDetail ListDataImportSQLPreCheckDetail チケットにおけるデータインポート用 SQL ステートメントの事前チェック情報を照会します。
    ListDataImportSQLType ListDataImportSQLType チケットにおけるデータインポートで使用される SQL ステートメントの種類を照会します。
    GetDataImportSQL GetDataImportSQL チケットにおけるデータインポートに使用される SQL ステートメントをクエリします。
    SkipDataCorrectRowCheck SkipDataCorrectRowCheck データ変更の事前チェックで、行数検証をスキップします。
    CreateProcCorrectOrder CreateProcCorrectOrder プログラム可能なオブジェクトチケットを作成します。
    スキーマ設計 スキーマ設計
    CreatePublishGroupTask CreatePublishGroupTask スキーマ設計チケットを実行します。
    ListDDLPublishRecords ListDDLPublishRecords スキーマ設計チケットの公開詳細を照会します。
    GetTableDesignProjectFlow GetTableDesignProjectFlow スキーマ設計チケットに関する情報 (チケットの現在のノード、チケットをスキーマ設計ノードに戻せるかどうか、公開戦略など) をクエリします。
    GetTableDesignProjectInfo GetTableDesignProjectInfo スキーマ設計チケットのプロジェクト情報および変更ベースデータベース情報を照会します。たとえば、チケットの状態、チケットを作成したユーザーの ID、変更ベースデータベースの名前および ID などが含まれます。
    データエクスポート データエクスポート
    CreateDatabaseExportOrder CreateDatabaseExportOrder データベースエクスポートチケットを作成します。
    CreateDataExportOrder CreateDataExportOrder SQL 結果セットをエクスポートするチケットを作成します。
    ExecuteDataExport ExecuteDataExport データエクスポートチケットを実行します。
    GetDataExportPreCheckDetail GetDataExportPreCheckDetail SQL 結果セットのエクスポートチケットに関する事前チェックの詳細を照会します。
    GetDataExportDownloadURL GetDataExportDownloadURL データエクスポートチケットのエクスポート結果のダウンロード URL をクエリします。
    GetDatabaseExportOrderDetail GetDatabaseExportOrderDetail データベースエクスポートチケットの詳細を照会します。
    GetDataExportOrderDetail GetDataExportOrderDetail データエクスポートチケットの情報をクエリします。
    GetDbExportDownloadURL GetDbExportDownloadURL データベースエクスポートチケットの結果のダウンロード URL を照会します。
    SuspendDataExportJob SuspendDataExportJob 実行中またはスケジュール済みの SQL 結果セットエクスポートタスクを一時停止します。
    PauseDataExportJob PauseDataExportJob SQL 結果セットのエクスポートタスクを終了します。
    RemoveDataExportJob RemoveDataExportJob データエクスポートタスクを削除します。
    RestartDataExportJob RestartDataExportJob SQL 結果セットのエクスポートタスクを再開します。
    SQL レビュー SQL レビュー
    CreateSQLReviewOrder CreateSQLReviewOrder SQL レビュー依頼（チケット）を作成します。
    GetSQLReviewCheckResultStatus GetSQLReviewCheckResultStatus SQL レビューの実行結果を照会します。
    ListSQLReviewOriginSQL ListSQLReviewOriginSQL SQL レビュー チケットに関連付けられた SQL ステートメントの詳細情報を照会します。
    GetSQLReviewOptimizeDetail GetSQLReviewOptimizeDetail 最適化の提案に関する詳細情報を照会します。この操作は、データ変更および SQL レビューのチケットにのみ適用されます。
    データ追跡 データ追跡
    CreateDataTrackOrder CreateDataTrackOrder データ追跡チケットを作成します。
    GetDataTrackJobDegree GetDataTrackJobDegree データ追跡タスクの進捗状況を照会します。
    GetDataTrackJobTableMeta GetDataTrackJobTableMeta データ追跡タスクに関与するテーブルのメタデータを照会します。
    GetDataTrackOrderDetail GetDataTrackOrderDetail データ追跡チケットの詳細を照会します。
    SearchDataTrackResult SearchDataTrackResult データ追跡タスクの解析結果を検索します。
    DownloadDataTrackResult DownloadDataTrackResult データ追跡タスクの解析結果をダウンロードします。
    QueryDataTrackResultDownloadStatus QueryDataTrackResultDownloadStatus データ追跡ログのダウンロードおよび解析の進捗状況を照会します。
    添付ファイルのアップロード 添付ファイルのアップロード
    CreateUploadFileJob CreateUploadFileJob 添付ファイルのアップロードタスクを作成します。
    CreateUploadOSSFileJob CreateUploadOSSFileJob OSS（Object Storage Service）ファイルのアップロードタスクを作成し、そのタスクのキーを取得します。
    GetUserUploadFileJob GetUserUploadFileJob ファイルアップロードタスクの情報を取得します。
    データアーカイブ データアーカイブ
    CreateDataArchiveOrder CreateDataArchiveOrder 専用ストレージスペースや ApsaraDB RDS for MySQL インスタンスなどの送信先にデータをアーカイブするためのデータアーカイブチケットを作成します。
    GetDataArchiveOrderDetail GetDataArchiveOrderDetail データアーカイブチケットの詳細情報を照会します。これには、チケットの作成時刻、データアーカイブタスクのスケジューリング情報、データアーカイブタスクのログ、およびデータがアーカイブされるデータベースが含まれます。
    GetDataArchiveCount GetDataArchiveCount データアーカイブチケットの統計をクエリします。これには、成功したデータアーカイブ、失敗したデータアーカイブ、進行中のデータアーカイブのチケット数、およびデータアーカイブチケットの総数が含まれます。
    GetPagedInstance GetPagedInstance チケットのタスク情報をクエリします。

    SQL タスク

    API

    タイトル

    説明
    ListDBTaskSQLJob ListDBTaskSQLJob SQL タスクの一覧を照会します。
    ListDBTaskSQLJobDetail ListDBTaskSQLJobDetail SQL タスクの詳細を取得します。
    GetDBTaskSQLJobLog GetDBTaskSQLJobLog SQL タスクのスケジューリング詳細を記録したログをクエリします。
    GetOnlineDDLProgress GetOnlineDDLProgress OnlineDDL タスクの詳細および進行状況を照会します。

    権限管理

    API

    タイトル

    説明
    SetOwners SetOwners インスタンス、データベース、またはテーブルのオーナーを設定します。
    ListInstanceUserPermissions ListInstanceUserPermissions インスタンスに対するユーザーの権限をクエリします。
    ListDatabaseUserPermssions ListDatabaseUserPermssions データベースに対するユーザーの権限を照会します。
    ListUserPermissions ListUserPermissions ユーザーのデータベースおよびテーブルに対する権限を照会します。
    GrantUserPermission GrantUserPermission インスタンス、データベース、またはテーブルに対するユーザーの権限を付与します。
    RevokeUserPermission RevokeUserPermission ユーザーからインスタンス、データベース、およびテーブルに対する権限を取り消します。
    ListAuthorizedInstancesForUser ListAuthorizedInstancesForUser 指定されたユーザーが権限を持つデータベースインスタンスの一覧を取得します。
    ListAuthorizedUsersForInstance ListAuthorizedUsersForInstance 指定されたインスタンスに対する権限を持つユーザーのリストをクエリします。
    ListAuthorizedDatabasesForUser ListAuthorizedDatabasesForUser 指定されたユーザーが権限を持つデータベースを照会します。
    ListAuthorizedUsersForDatabase ListAuthorizedUsersForDatabase 指定されたデータベースに権限を持つユーザーのリストをクエリします。

    セキュリティ管理

    API

    タイトル

    説明
    セキュリティルール セキュリティルール
    CreateStandardGroup CreateStandardGroup セキュリティルールセットを作成します。
    ListStandardGroups ListStandardGroups セキュリティルールセットを照会します。
    UpdateStandardGroup UpdateStandardGroup 特定のセキュリティルールセットの名前と説明を変更します。
    DeleteStandardGroup DeleteStandardGroup セキュリティルールセットを削除します。
    GetStandardGroup GetStandardGroup テナントのセキュリティルールセットに関する情報をクエリします。この情報には、セキュリティルールの名前と説明、およびセキュリティルールに関連付けられているインスタンスが含まれます。
    機密データ管理 機密データ管理
    AddDesensitizationRule AddDesensitizationRule マスキングルールを追加します。
    ListDesensitizationRule ListDesensitizationRule マスキングルールの一覧を照会します。
    ModifyDesensitizationStrategy ModifyDesensitizationStrategy 指定されたフィールドにバインドされているマスキングルールを変更します。
    ListClassificationTemplates ListClassificationTemplates 分類テンプレートの一覧を取得します。
    ListSensitiveDataAuditLog ListSensitiveDataAuditLog 機密データに関する監査ログをクエリします。
    ListSensitiveColumns ListSensitiveColumns データベースのテーブル内のセンシティブフィールドをクエリします。
    ListSensitiveColumnsDetail ListSensitiveColumnsDetail 機密フィールドの詳細情報を照会します。
    ChangeColumnSecLevel ChangeColumnSecLevel フィールドの感度レベルを調整します。
    ChangeColumnSecurityLevel ChangeColumnSecurityLevel カラムのセキュリティレベルを変更します。
    GetClassificationTemplate GetClassificationTemplate インスタンスに関連付けられている分類と等級付けテンプレートの情報をクエリします。
    ListSensitivityLevel ListSensitivityLevel 分類テンプレートの感度レベルを照会します。
    ListSensitiveColumnInfo ListSensitiveColumnInfo 機密フィールドに関する情報をクエリします。この情報には、マスキングアルゴリズム ID、マスキングアルゴリズム名、フィールドのセキュリティレベルが含まれます。
    セキュアアクセスプロキシ セキュアアクセスプロキシ
    CreateProxy CreateProxy データベースインスタンスの安全なアクセスプロキシ機能を有効にします。
    DeleteProxy DeleteProxy この操作を呼び出して、DB インスタンスのデータセキュリティ保護プロキシを無効化できます。
    ListProxies ListProxies セキュアアクセスプロキシ機能によって生成されたプロキシをクエリします。
    GetProxy GetProxy セキュアアクセスプロキシの詳細を照会します。
    CreateProxyAccess CreateProxyAccess セキュリティ保護プロキシ機能を使用して、ユーザーにデータベースインスタンスへのアクセス権限を付与します。
    DeleteProxyAccess DeleteProxyAccess ユーザーに付与された、セキュアアクセスプロキシ機能経由でのデータベースインスタンスへのアクセス権限を取り消します。
    ListProxyAccesses ListProxyAccesses セキュアアクセスプロキシ機能を用いてデータベースインスタンスにアクセスする権限が付与されたユーザー情報を照会します。
    InspectProxyAccessSecret InspectProxyAccessSecret この操作を呼び出すことで、セキュリティ保護エージェントの権限付与パスワード（AccessSecret）を取得できます。
    GetProxyAccess GetProxyAccess セキュアアクセスプロキシ機能の権限付与情報を照会します。
    権限テンプレート 権限テンプレート
    GrantTemplateAuthority GrantTemplateAuthority 権限テンプレートを使用して、リソースに対する権限をユーザーに付与します。
    RevokeTemplateAuthority RevokeTemplateAuthority 権限テンプレートを使用して、Data Management (DMS) ユーザーからリソースに対する権限を取り消します。
    CreateAuthorityTemplate CreateAuthorityTemplate 権限テンプレートを作成します。
    UpdateAuthorityTemplate UpdateAuthorityTemplate 権限テンプレートを変更します。
    AddAuthorityTemplateItems AddAuthorityTemplateItems 指定した権限テンプレートにインスタンス、データベース、およびテーブルを追加します。
    GetAuthorityTemplateItem GetAuthorityTemplateItem 権限テンプレート内のリソースをクエリします。
    GetAuthorityTemplate GetAuthorityTemplate 権限テンプレートの情報を照会します。
    ListAuthorityTemplate ListAuthorityTemplate 権限テンプレートの情報を照会します。照会対象には、テンプレート作成者、テンプレート名、およびテンプレート総数が含まれます。
    DeleteAuthorityTemplate DeleteAuthorityTemplate 権限テンプレートを削除します。
    権限ポリシー 権限ポリシー
    CreateAbacPolicy CreateAbacPolicy DMS で管理される機能およびデータリソースに対する権限を、詳細なレベルで制御するポリシーを作成します。
    ListAbacPolicies ListAbacPolicies ユーザーによって作成されたポリシーのリストを照会します。
    UpdateAbacPolicy UpdateAbacPolicy ポリシーの名前、説明、または内容を更新します。
    DeleteAbacPolicy DeleteAbacPolicy 作成された権限ポリシーを削除します。
    GetAbacPolicy GetAbacPolicy ポリシーの名前、コンテンツ、ポリシーを作成したユーザーなど、ポリシーの詳細を照会します。
    CreateAbacAuthorization CreateAbacAuthorization システムポリシーまたはカスタムポリシーを DMS ユーザーまたはカスタムロールにアタッチします。
    ListAbacAuthorizations ListAbacAuthorizations 指定されたポリシーがアタッチされているユーザーのリストとユーザーの数をクエリします。
    DeleteAbacAuthorization DeleteAbacAuthorization ユーザーまたはロールからポリシーをデタッチします。

    データクエリ

    API

    タイトル

    説明
    ExecuteScript ExecuteScript SQL スクリプトを実行します。

    データ開発

    API

    タイトル

    説明
    タスクオーケストレーション タスクオーケストレーション
    UpdateTaskFlowConstants UpdateTaskFlowConstants 指定されたタスクフローの定数を更新します。
    DeleteTaskFlow DeleteTaskFlow タスクフローを削除します。
    OfflineTaskFlow OfflineTaskFlow Data Management (DMS) で公開済みのタスクフローを非公開化します。
    ListTaskFlow ListTaskFlow タスクフローの一覧を照会します。
    GetTaskInstanceRelation GetTaskInstanceRelation タスクフローインスタンスのタスクノードを照会します。
    ListTaskFlowInstance ListTaskFlowInstance タスクフローの実行レコードをクエリします。
    ListDAGVersions ListDAGVersions タスクフローの公開バージョンをクエリします。
    ReDeployLhDagVersion ReDeployLhDagVersion タスクフローの公開済みバージョンを再デプロイします。
    UpdateScenario UpdateScenario 指定されたタスクフローのビジネスシナリオの名前と説明を更新します。
    ResumeTaskFlowInstance ResumeTaskFlowInstance 一時停止されたタスクフローインスタンスを再開します。
    UpdateTaskContent UpdateTaskContent タスクフロー内のタスクを更新します。
    ListTaskFlowsByPage ListTaskFlowsByPage タスクフローの詳細をページ単位で照会します。
    ListScenarios ListScenarios ビジネスシナリオを照会します。
    UpdateTaskConfig UpdateTaskConfig タスクノードの詳細設定を更新します。
    ListTaskFlowConstants ListTaskFlowConstants タスクフローの定数をクエリします。
    BackFill BackFill タスクフローのデータバックフィルを実行します。
    UpdateTaskTimeVariables UpdateTaskTimeVariables タスクの時間変数を更新します。
    ListTaskFlowTimeVariables ListTaskFlowTimeVariables タスクフローの時間変数をリスト表示します。
    UpdateTaskFlowTimeVariables UpdateTaskFlowTimeVariables タスクフローの時間変数を更新します。
    UpdateTaskFlowCooperators UpdateTaskFlowCooperators タスクフローに関与するユーザーの ID を更新します。
    CreateScenario CreateScenario ビジネスシナリオごとにタスクフローをグループ化するためのビジネスシナリオを作成します。
    DeleteScenario DeleteScenario ビジネスシナリオを削除します。
    UpdateSLARules UpdateSLARules タスクフローのサービスレベルアグリーメント (SLA) ルールのタイムアウトリマインダーを更新します。
    GetRuleNumLimitOfSLA GetRuleNumLimitOfSLA タスクオーケストレーションにおけるカスタムサービスレベルアグリーメント（SLA）ルールの最大数を照会します。
    GetIntervalLimitOfSLA GetIntervalLimitOfSLA SLA（Service Level Agreement）タイムアウトルールがタスクフローに設定されている場合の、そのタスクフローの最小スケジューリング周期をクエリします。
    ListDefaultSLARules ListDefaultSLARules デフォルトのサービスレベルアグリーメント (SLA) タイムアウトルールを照会します。
    ListTaskFlowCooperators ListTaskFlowCooperators タスクフローに関与するユーザーのリストをクエリします。
    ListSLARules ListSLARules タスクフローのカスタムサービスレベルアグリーメント（SLA）ルールを照会します。
    GetTask GetTask 指定されたタスクノードの ID を使用して、そのタスクノードの構成（時間変数を含む）をクエリします。
    MoveTaskFlowToScenario MoveTaskFlowToScenario タスクフローを指定のビジネスシナリオに移行します。
    GetTaskFlowNotification GetTaskFlowNotification タスクフローの通知設定をクエリします。
    UpdateTaskName UpdateTaskName 指定されたタスクの名前を更新します。
    UpdateTaskOutput UpdateTaskOutput タスクノードの出力変数を更新します。
    DeleteTaskFlowEdgesByCondition DeleteTaskFlowEdgesByCondition 複数の条件に基づいてタスクフローのエッジを削除します。
    ListTaskFlowEdgesByCondition ListTaskFlowEdgesByCondition 複数の条件に基づいて、タスクフローの有向非循環グラフ (DAG) のエッジをクエリします。
    AddTaskFlowEdges AddTaskFlowEdges タスクフローの既存のタスクノードに対して有向エッジを作成します。
    UpdateTaskFlowNameAndDesc UpdateTaskFlowNameAndDesc タスクフローの名前と説明を更新します。
    GetTaskFlowGraph GetTaskFlowGraph タスクフローの有向非巡回グラフ (DAG) を照会します。
    UpdateTaskFlowEdges UpdateTaskFlowEdges タスクフローにおける複数のエッジの開始ノードおよび終了ノードを一度に更新します。
    UpdateTaskFlowOwner UpdateTaskFlowOwner タスクフローのオーナーを変更します。
    UpdateTaskFlowSchedule UpdateTaskFlowSchedule タスクフローのスケジューリングプロパティを更新します。
    UpdateTaskFlowRelations UpdateTaskFlowRelations タスクフローのエッジを完全に更新します。
    UpdateTaskFlowNotification UpdateTaskFlowNotification タスクフローの通知設定を更新します。
    ListTasksInTaskFlow ListTasksInTaskFlow 指定されたタスクフロー内のタスクをクエリします。
    CreateTaskFlow CreateTaskFlow タスクフローを作成します。
    SuspendTaskFlowInstance SuspendTaskFlowInstance タスクフローインスタンスを一時停止します。
    ReRunTaskFlowInstance ReRunTaskFlowInstance タスクフローの実行インスタンスを再実行します。
    MakeTaskFlowInstanceSuccess MakeTaskFlowInstanceSuccess タスクフローのステータスを「成功」に設定します。
    DeleteTask DeleteTask 指定されたタスクフロー内のタスクを削除します。
    PublishAndDeployTaskFlow PublishAndDeployTaskFlow タスクフローを公開およびデプロイします。
    StopTaskFlowInstance StopTaskFlowInstance タスクフローインスタンスを停止します。
    CreateTask CreateTask タスクフローのタスクノードを作成します。
    UpdateTaskContentV2 UpdateTaskContentV2 大規模な SQL ファイルのノードコンテンツを更新します。
    TryRunTaskFlow TryRunTaskFlow タスクオーケストレーションにおけるタスクフローの実行テストを行います。
    データウェアハウス開発 データウェアハウス開発
    CreateLakeHouseSpace CreateLakeHouseSpace Data Management (DMS) でデータウェアハウス開発用のワークスペースを作成します。
    GetLhSpaceByName GetLhSpaceByName Data Management (DMS) におけるワークスペース名を指定して、対応するワークスペースの情報を照会します。
    DeleteLakeHouseSpace DeleteLakeHouseSpace ワークスペースを削除します。
    ListLhTaskFlowAndScenario ListLhTaskFlowAndScenario Data Management (DMS) のワークスペース内のビジネスシナリオにおけるタスクフローの情報をクエリします。
    AddLhMembers AddLhMembers DMS データウェアハウス開発プロジェクトスペースに管理者、メンバー、またはタスクストリーム開発者を追加するには、AddLhMembers API を呼び出します。
    DeleteLhMembers DeleteLhMembers DeleteLhMembers API を呼び出して、DMS データウェアハウス開発プロジェクトのワークスペースからメンバーを削除するか、タスクストリームから開発者を削除します。
    ChangeLhDagOwner ChangeLhDagOwner Data Management (DMS) のワークスペースにあるタスクフローの所有権を転送します。

    販売注文

    API

    タイトル

    説明
    ListEffectiveOrders ListEffectiveOrders 有効な注文を照会します。
    RefundPayAsYouGoOrder RefundPayAsYouGoOrder Data Management (DMS) の従量課金リソースを解約します。

    資産カテゴリ

    API

    タイトル

    説明
    CreateMetaCategory CreateMetaCategory アセットカテゴリを作成します。
    ListMetaCategory ListMetaCategory カテゴリの一覧をクエリします
    UpdateMetaCategory UpdateMetaCategory アセットカテゴリ情報の更新。
    DeleteMetaCategory DeleteMetaCategory アセットカテゴリを削除します。
    ListTablesInCategory ListTablesInCategory カテゴリ内のテーブルのリストを取得します。
    AddTableToCategory AddTableToCategory テーブルをアセットカテゴリに追加します。
    RemoveTableFromCategory RemoveTableFromCategory カテゴリからテーブルを削除します。

    ワークスペース

    API

    タイトル

    説明
    CreateWorkspace CreateWorkspace ワークスペースを作成します。
    DeleteWorkspace DeleteWorkspace ワークスペースを削除します。
    GetWorkspace GetWorkspace ワークスペースの詳細情報を照会します。
    ListWorkspaces ListWorkspaces テナントのワークスペース一覧を照会します。
    UpdateWorkspace UpdateWorkspace ワークスペースの情報を更新します。

    その他

    API

    タイトル

    説明
    OptimizeSqlByMetaAgent OptimizeSqlByMetaAgent 指定されたデータベース内の SQL ステートメントを解析および最適化します。
    FixSqlByMetaAgent FixSqlByMetaAgent 指定された SQL ステートメント、エラーメッセージ、およびデータベース ID を使用して、SQL エラーを分析・修正します。
    AnswerSqlSyntaxByMetaAgent AnswerSqlSyntaxByMetaAgent 指定されたデータベース ID に基づいて、対応するエンジンの構文に関する質問に回答します。
    ListUserOwnedResources ListUserOwnedResources 取得する
    CheckBatchTableAccessPermission CheckBatchTableAccessPermission テーブル権限を一括で検証します。
    ListTagMetaAsset ListTagMetaAsset DataAgent ワークスペース内の特定のタグに関連付けられているデータベースおよびテーブルアセットをリストアップします。
    SearchTableKnowledge SearchTableKnowledge ユーザーのクエリに基づいてテーブルナレッジを検索します。
    GetAIOrderApprovalCommentSSE GetAIOrderApprovalCommentSSE 大規模言語モデル (LLM) からチケットの承認に関する提案を取得します。
    AddWorkspaceUser AddWorkspaceUser ユーザーをワークスペースに追加します。
    UpdateWorkspaceUser UpdateWorkspaceUser ワークスペース内のユーザーのロールを更新します。
    ListWorkspaceUsers ListWorkspaceUsers 指定されたワークスペース内のユーザーを一覧表示します。
    RemoveWorkspaceUser RemoveWorkspaceUser ワークスペースからユーザーを削除します。
    SearchWorkspaceRoles SearchWorkspaceRoles ワークスペース内のロールを検索します。
    ConfirmInventoryKnowledge ConfirmInventoryKnowledge 在庫タスクから特定の知識エンティティを認定済みとしてマークします。
    CreateInventoryJob 在庫タスクを作成します 資産在庫タスクを作成し、指定されたインスタンス、データベース、またはテーブルに対してナレッジ在庫を実行します。
    SearchInventoryKnowledge SearchInventoryKnowledge 在庫タスクによって生成されたナレッジのページ分割されたリストを取得します。キーワード、ナレッジタイプ、およびその他の基準で結果をフィルターできます。
    CheckInventoryJob CheckInventoryJob アセット在庫タスクの実行ステータスと進捗を照会します。
    SearchTableAssetKnowledge SearchTableAssetKnowledge 特定のテーブルに関連するアセットナレッジのページネーションされた一覧を照会します。このナレッジには、テーブル、カラム、SQL ステートメント、スニペットに関する情報が含まれます。
    GetTableKnowledgeDetails GetTableKnowledgeDetails テーブルのアセットナレッジ詳細（メタデータ、ビジネス記述、フィールド一覧を含む）を取得します。
    GetTableColumnList GetTableColumnList テーブル内の各カラムの詳細情報を取得します。メタデータ、ビジネス上の説明、セキュリティレベルを含みます。
    GetTableInstructions GetTableInstructions テーブルの使用方法およびビジネスコンテキスト（ビジネス説明、まとめ、関連アセットなど）を取得します。
    ListInventoryJobs ListInventoryJobs 資産インベントリジョブのページ分割されたリストを取得します。
    SearchInventoryAsset SearchInventoryAsset 特定のインベントリタスクからテーブルアセットのページ分割されたリストを取得します。
    CreateForecastAgent CreateForecastAgent 予測エージェントを作成します。
    SetForecastAgentInstance SetForecastAgentInstance インスタンスの認証情報を設定します。
    GetForecastAgentInstance GetForecastAgentInstance 予測エージェントインスタンスのリストを取得します。

    Others

    API

    タイトル

    説明
    AsyncExportInventoryAsset 在庫結果を非同期でエクスポートします。 在庫テーブルの完全なアセットエクスポートタスクを非同期で送信します。
    AsyncExportInventoryKnowledge 在庫アセットの非同期エクスポートタスクを送信します。 在庫ナレッジのフルエクスポートノードに対して非同期コミットを送信します。
    DescribeInventoryFileUploadSignature 資産情報収集のアップロード認証情報を取得 資産情報収集ファイルのOSSダイレクトアップロード認証情報を取得します。
    ExportInventoryAsset 在庫アセットナレッジのエクスポート 在庫タスク配下のテーブルアセットの完全なリストを XLSX ファイルとしてエクスポートします。
    ExportInventoryKnowledge 在庫結果からナレッジをエクスポートします 在庫タスクによって生成されたナレッジの完全なリストを XLSX ファイルとしてエクスポートします。
    GetInventoryExportTaskStatus 非同期エクスポートタスクのステータスを取得します。 在庫結果の非同期エクスポートタスクのステータスを照会します。