機能別操作一覧 - - Alibaba Cloud ドキュメントセンター

次の表は、データ管理 (DMS) で使用できるAPI操作の一覧です。

順序

API	説明
BuyPayAsYouGoOrder	従量課金制のDMSリソースを購入します。
RefundPayAsYouGoOrder	従量課金DMSリソースからの登録解除。
ListEffectiveOrders	有効注文に関する情報を照会します。

ユーザー管理

API	説明
RegisterUser	企業のユーザーを追加します。
DisableUser	一時的に使用されていないユーザーを無効にします。
EnableUser	無効になっているユーザーを有効にします。
DeleteUser	不要になったユーザーを削除します。
UpdateUser	ユーザーに関する情報を更新します。
ListUsers	ユーザーを照会します。
ListUserTenants	テナントを照会します。
GetUserActiveTenant	現在のテナントに関する情報を照会します。
GetUser	ユーザーに関する情報を照会します。

インスタンス管理

API	説明
RegisterInstance	企業のデータベースインスタンスを登録します。
UpdateInstance	データベースインスタンスに関する情報を更新し、データベースインスタンスの接続性を確認します。
GetInstance	データベースインスタンスの詳細を照会します。
DeleteInstance	DMS Enterpriseからデータベースインスタンスを削除します。
リストインスタンス	データベースインスタンスと個々のデータベースインスタンスの詳細を照会します。

操作監査

API	説明
GetOpLog	指定した期間内に生成された操作ログの詳細を照会します。
ListSQLExecAuditLog	SQL操作の監査ログを照会します。
ListProxySQLExecAuditLog	セキュアアクセスプロキシ機能によって生成されたプロキシエンドポイントの監査ログを照会します。
ListInstanceLoginAuditLog	インスタンスのログインレコードを照会します。
ListSensitiveDataAuditLog	機密データの監査ログを照会します。

承認プロセス管理

API	説明
ListWorkFlowNodes	承認ノードを照会します。
ListWorkFlowTemplates	承認テンプレートを照会します。

データベースとテーブルのメタデータ管理

API	説明
SearchDatabase	データベースを照会します。
SearchTable	テーブルを照会します。
ListDatabases	データベースインスタンス内のデータベースを照会します。
リストテーブル	データベース内のテーブルを照会します。
リスト列	テーブル内の列を照会します。
ListIndexes	テーブルのインデックスを照会します。
GetDatabase	データベースの詳細を照会します。
GetPhysicalDatabase	物理データベースの詳細を照会します。
GetTableTopology	テーブルのトポロジを照会します。
GetMetaTableDetailInfo	テーブル内の列とインデックスの詳細を照会します。
GetMetaTableColumn	テーブル内の列の詳細を照会します。
SyncInstanceMeta	データベースインスタンス内のすべてのデータベースのメタデータを同期します。
SyncDatabaseMeta	データベースのメタデータを同期します。

論理データベースとテーブル

API	説明
CreateLogicDatabase	DMSに論理データベースを作成します。
EditLogicDatabase	論理データベースに関する情報を変更します。
DeleteLogicDatabase	DMSから論理データベースを削除します。
ListLogicDatabases	論理データベースの詳細を照会します。
GetLogicDatabase	論理データベースの詳細を照会します。
GetDBTopology	論理データベースと、論理データベースに対応する物理データベースシャードのトポロジを照会します。
ListLogicTables	論理データベース内の論理テーブルを照会します。
GetTableDBTopology	論理データベース内のテーブルのトポロジと、論理データベースに対応する物理データベースシャードを照会します。
AddLogicTableRouteConfig	論理テーブルにルーティングアルゴリズムを追加します。
DeleteLogicTableRouteConfig	論理テーブルからルーティングアルゴリズムを削除します。
ListLogicTableRouteConfig	論理テーブルのルーティングアルゴリズムを照会します。

チケット管理

カテゴリ	API	説明
一般操作	ApproveOrder	チケットを承認します。
	CloseOrder	チケットを閉じます。
	GetApprovalDetail	チケットの承認詳細を照会します。
	GetOrderBaseInfo	チケットに関する基本情報を照会します。
	リスト注文	チケットを照会します。
	CreateOrder	チケットを作成します。
	SubmitOrderApproval	承認のためにチケットを提出します。
権限申請	GetOwnerApplyOrderDetail	インスタンス、データベース、またはテーブルの所有者を構成するために使用されるチケットの詳細を照会します。
権限申請	GetPermApplyOrderDetail	チケットの詳細を照会して権限を申請します。
データベース間のテーブル同期	CreateStructSyncOrder	スキーマ同期チケットを作成します。
	GetStructSyncOrderDetail	スキーマ同期チケットの詳細を照会します。
	GetStructSyncJobDetail	スキーマ同期タスクの詳細を照会します。
	GetStructSyncJobAnalyzeResult	スキーマ同期タスクの分析結果を照会します。
	GetStructSyncExecSqlDetail	スキーマ同期チケットに含まれるSQL文を照会します。
	SubmitStructSyncOrderApproval	承認のためにスキーマ同期チケットを送信します。
	ExecuteStructSync	スキーマ同期チケットを実行します。
データ変更	CreateDataCorrectOrder	データ変更チケットを作成します。
	CreateDataCronClearOrder	履歴データクリーニングチケットを作成します。
	CreateDataImportOrder	データインポートチケットを作成します。
	CreateFreeLockCorrectOrder	ロックフリーの変更チケットを作成します。
	ExecuteDataCorrect	データ変更チケットを実行します。
	GetDataCorrectTaskDetail	データの変更、ロックフリーの変更の実行、またはデータのインポートに使用されるタスクの詳細を照会します。
	GetDataCronClearTaskDetailList	履歴データのクリーニングタスクを照会します。
	GetDataCorrectOrderDetail	データ変更チケットの詳細を照会します。
	GetDataCorrectBackupFiles	データ変更チケットのバックアップファイルのダウンロードURLを照会します。
	GetDataCorrectSQLFile	データ変更チケットのSQL添付ファイルを照会します。
	ModifyDataCorrectExecSQL	データ変更チケットを使用して送信されるSQLスクリプトを変更します。
	ListDataCorrectPreCheckSQL	データ変更チケットで指定されているSQL文の事前チェック情報を照会します。
	ListDataCorrectPreCheckDB	データ変更チケットの事前チェックに関与するデータベースを照会します。
	PauseDataCorrectSQLJob	データ変更のためにSQLタスクを一時停止します。
	RetryDataCorrectPreCheck	データ変更チケットの事前チェックを再実行します。
	RestartDataCorrectSQLJob	データ変更のために失敗したSQLタスクを再実行します。
スキーマデザイン	CreatePublishGroupTask	スキーマデザインチケットを実行します。
スキーマデザイン	ListDDLPublishRecords	スキーマデザインチケットの発行の詳細を照会します。
データのエクスポート	GetDataExportDownloadURL	データエクスポートチケットのエクスポート結果のダウンロードURLを照会します。
	ExecuteDataExport	データエクスポートチケットを実行します。
	GetDataExportOrderDetail	データエクスポートチケットの詳細を照会します。
SQLレビュー	CreateSQLReviewOrder	SQLレビューチケットを作成します。
	GetSQLReviewCheckResultStatus	SQLレビューチケットのレビュー結果を照会します。
	ListSQLReviewOriginSQL	SQLレビューチケットに含まれるSQL文の詳細を照会します。
	GetSQLReviewOptimizeDetail	SQL最適化の提案の詳細を照会します。
ファイルのアップロード	CreateUploadFileJob	ファイルアップロードタスクを作成します。
	CreateUploadOSSFileJob	object Storage Service (OSS) からオブジェクトをアップロードするタスクを作成します。
	GetUserUploadFileJob	ファイルアップロードタスクに関する情報を照会します。

SQLタスク管理

API	説明
ListDBTaskSQLJob	SQLタスクを照会します。
ListDBTaskSQLJobDetail	SQLタスクの詳細を照会します。
GetDBTaskSQLJobLog	SQLタスクのスケジューリングの詳細を記録するログを照会します。
GetOnlineDDLProgress	オンラインDDLタスクの進行状況を照会します。

権限管理

API	説明
SetOwners	インスタンス、データベース、またはテーブルの所有者を構成します。
RevokeUserPermission	ユーザーからリソースに対する権限を取り消します。
ListUserPermissions	データベースとテーブルに対するユーザーの権限を照会します。
ListDatabaseUserPermssions	データベースに対するユーザーの権限を照会します。
GrantUserPermission	データベースまたはテーブルに対する権限をユーザーに付与します。
ListInstanceUserPermissions	インスタンスに対するユーザーの権限を照会します。

セキュリティ管理

カテゴリ	API	説明
セキュリティルールセット管理	CreateStandardGroup	セキュリティルールセットを作成します。
セキュリティルールセット管理	ListStandardGroups	セキュリティルールセットを照会します。
安全なアクセスプロキシ	CreateProxy	データベースインスタンスのセキュアアクセスプロキシ機能を有効にします。
	CreateProxyAccess	セキュアアクセスプロキシ機能によって生成されたプロキシエンドポイントを使用して、ユーザーにデータベースインスタンスへのアクセスを許可します。
	ListProxyAccesses	セキュアアクセスプロキシ機能によって生成されたプロキシエンドポイントを使用して、データベースインスタンスへのアクセスを許可されているユーザーを照会します。
	InspectProxyAccessSecret	許可されたユーザーがデータベースインスタンスのセキュアアクセスプロキシ機能によって生成されたプロキシエンドポイントに接続するために使用するAccessKeyシークレットを照会します。
	ListProxies	セキュアアクセスプロキシ機能によって生成されたプロキシエンドポイントを照会します。
	GetProxy	セキュアアクセスプロキシ機能によって生成されたプロキシエンドポイントの詳細を照会します。
	DeleteProxyAccess	セキュアアクセスプロキシ機能によって生成されたプロキシエンドポイントを使用して、データベースインスタンスにアクセスしなくなった許可ユーザーから権限を取り消します。
	DeleteProxy	データベースインスタンスのセキュアアクセスプロキシ機能を無効にします。
敏感なフィールド管理	ListSensitiveColumns	機密フィールドを照会します。
	ListSensitiveColumnsDetail	機密フィールドの詳細を照会します。
	AddDesensitizationRule	マスキングルールを追加します。
	ListDesensitizationRule	マスキングルールを照会します。
	ModifyDesensitizationStrategy	指定されたフィールドにバインドされたマスキングルールを変更します。
	ListClassificationTemplates	分類テンプレートを照会します。
	ChangeColumnSecLevel	フィールドの感度レベルを調整します。

データクエリ

API	説明
ExecuteScript	SQL文を実行します。

データ開発

カテゴリ	API	説明
データウェアハウスの開発	CreateLakeHouseSpace	データウェアハウス開発用のワークスペースを作成します。
	GetLhSpaceByName	指定されたワークスペース名で識別されるワークスペースの詳細を照会します。
	DeleteLakeHouseSpace	データウェアハウス開発のワークスペースを削除します。
	ListLhTaskFlowAndScenario	データウェアハウス開発のワークスペース内のさまざまなビジネスシナリオに対応するタスクフローに関する情報を照会します。
	AddLhMembers	データウェアハウス開発のために、1人以上の管理者、メンバー、またはタスクフロー開発者をワークスペースに追加します。
	DeleteLhMembers	データウェアハウス開発のワークスペースから1人以上のメンバーまたはタスクフロー開発者を削除します。
	ChangeLhDagOwner	タスクフローの所有者を変更します。
タスクオーケストレーション	ListTaskFlow	タスクフローを照会します。
	DeleteTaskFlow	タスクフローを削除します。
	OfflineTaskFlow	公開済みタスクフローの公開を解除します。
	ListTaskFlowInstance	タスクフローの実行レコードを照会します。
	GetTaskInstanceRelation	タスクフローの実行レコード内のノードに関する情報を照会します。
	ListDAGVersions	タスクフローの公開済みバージョンを照会します。
	ReDeployLhDagVersion	タスクフローの公開済みバージョンの1つまたはすべてを再デプロイします。
	CreateTaskFlow	タスクフローを作成します。
	DeleteTask	指定したタスクフローのタスクを削除します。
	MakeTaskFlowInstanceSuccess	指定されたタスクフローのステータスを「成功」に設定します。
	SuspendTaskFlowInstance	実行中のタスクフローインスタンスを一時停止します。
	PublishAndDeployTaskFlow	指定されたタスクフローを発行およびデプロイします。
	ListTasksInTaskFlow	指定したタスクフロー内のタスクを照会します。
	UpdateTaskConfig	指定されたタスクの詳細設定を更新します。
	ListTaskFlowConstants	指定したタスクフローの定数を照会します。
	UpdateTaskFlowConstants	指定したタスクフローの定数を更新します。
	ResumeTaskFlowInstance	中断したタスクフローを再開します。
	ListTaskFlowsByPage	タスクフローの実行記録をページ単位で照会します。
	UpdateTaskContent	指定されたタスクノードの構成を更新します。
	UpdateScenario	タスクフローの指定された業務シナリオの名前と説明を更新します。
	ListScenarios	ビジネスシナリオを照会します。
	DeleteScenario	ビジネスシナリオを削除します。
	CreateScenario	ビジネスシナリオを作成します。
	UpdateTaskTimeVariables	指定したタスクの時間変数を更新します。
	UpdateTaskFlowTimeVariables	指定したタスクフローの時間変数を更新します。
	ListTaskFlowTimeVariables	指定したタスクフローの時間変数を照会します。
	UpdateTaskFlowCooperators	指定したタスクフローに関与するユーザーを更新します。
	MoveTaskFlowToScenario	タスクフローを指定されたビジネスシナリオに移動します。
	UpdateTaskName	指定したタスクノードの名前を更新します。
	ListTaskFlowCooperators	指定されたタスクフローに関与するユーザーを照会します。
	UpdateTaskOutput	指定したタスクノードの出力変数を更新します。
	GetTask	タスクの時間変数を含む、指定されたタスクノードの構成を照会します。
	UpdateTaskFlowSchedule	指定したタスクフローのスケジューリング設定を更新します。
	StopTaskFlowInstance	実行中のタスクフローインスタンスを停止します。
	ReRunTaskFlowInstance	タスクフローインスタンスを再実行します。
	CreateTask	指定したタスクフローのタスクノードを作成します。
	UpdateTaskFlowNotification	タスクフローの通知設定を更新します。
	DeleteTaskFlowEdgesByCondition	複数の条件に基づいてタスクフローのエッジを削除します。
	ListTaskFlowEdgesByCondition	複数の条件に基づいて、指定されたタスクフローの有向非巡回グラフ (DAG) のエッジをクエリします。
	UpdateTaskFlowEdges	指定されたタスクフローの指定されたエッジの複数の開始ノードと終了ノードを一度に更新します。
	GetTaskFlowGraph	タスクフローのDAGを照会します。
	UpdateTaskFlowRelations	指定したタスクフローのすべてのエッジを更新します。
	UpdateTaskFlowNameAndDesc	指定したタスクフローの名前と説明を更新します。
	UpdateTaskFlowOwner	指定されたタスクフローの所有者を更新します。
	バックフィル	タスクオーケストレーションのデータを埋め戻します。