API の概要 - Database Autonomy Service - Alibaba Cloud ドキュメントセンター

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

本製品 (DAS/2020-01-16) の 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	タイトル	説明
AddHDMInstance	データベースインスタンスを接続します。	AddHDMInstance を呼び出して、データベースインスタンスを Database Autonomy Service (DAS) に接続します。

検査とスコアリング

API	タイトル	説明
GetInstanceInspections	GetInstanceInspections	検査およびスコアリング機能を使用して、データベースインスタンスで実行される検査の結果を照会します。

イベント通知

API	タイトル	説明
SetEventSubscription	SetEventSubscription	データベースインスタンスのイベントサブスクリプション設定を構成します。
GetEventSubscription	GetEventSubscription	データベースインスタンスのイベントサブスクリプション設定を照会します。
GetAutonomousNotifyEventContent	GetAutonomousNotifyEventContent	データベースインスタンスの通知イベントの詳細をクエリします。
GetAutonomousNotifyEventsInRange	GetAutonomousNotifyEventsInRange	1つ以上の緊急度レベルの通知イベントを期間内にクエリします。

診断レポート

API	タイトル	説明
CreateDiagnosticReport	CreateDiagnosticReport	診断レポートを作成します。
DescribeDiagnosticReportList	DescribeDiagnosticReportList	診断レポートをクエリします。
GetDBInstanceConnectivityDiagnosis	データベースインスタンスのネットワーク接続性診断結果を取得します。	ユーザー指定の IP アドレスから指定されたデータベースインスタンスへのネットワーク接続性診断結果を取得します。

キャッシュ解析

API	タイトル	説明
CreateCacheAnalysisJob	キャッシュ解析タスクを作成します。	CreateCacheAnalysisJob 操作を呼び出して、キャッシュ解析タスクを作成します。
DescribeCacheAnalysisJob	DescribeCacheAnalysisJob	キャッシュ解析タスクの詳細を照会します。
DescribeCacheAnalysisJobs	DescribeCacheAnalysisJobs	キャッシュ解析タスクのリストをクエリします。

SQL スロットリング

API	タイトル	説明
EnableSqlConcurrencyControl	EnableSqlConcurrencyControl	SQL スロットリングを有効化し、データベースへのアクセス要求および同時実行される SQL ステートメントの数を制御します。
DisableSqlConcurrencyControl	DisableSqlConcurrencyControl	速度制限ルールを無効化します。
DisableAllSqlConcurrencyControlRules	DisableAllSqlConcurrencyControlRules	有効なすべての速度制限ルールを無効にします。
GetRunningSqlConcurrencyControlRules	GetRunningSqlConcurrencyControlRules	有効な速度制限ルールを照会します。
GetSqlConcurrencyControlRulesHistory	GetSqlConcurrencyControlRulesHistory	実行中またはトリガーされた速度制限ルールを照会します。
GetSqlConcurrencyControlKeywordsFromSqlText	GetSqlConcurrencyControlKeywordsFromSqlText	SQL ステートメントに基づいて、速度制限キーワード文字列を生成します。

SQL 診断

API	タイトル	説明
CreateRequestDiagnosis	CreateRequestDiagnosis	SQL ステートメントの診断リクエストを開始します。
GetRequestDiagnosisResult	GetRequestDiagnosisResult	GetRequestDiagnosisResult を呼び出して、SQL 診断結果を取得します。
GetRequestDiagnosisPage	GetRequestDiagnosisPage	SQL 診断レコードをページ単位で照会します。
DescribeQueryExplain	DescribeQueryExplain	SQL ステートメントの実行計画を取得します。

キー分析

API	タイトル	説明
DescribeHotBigKeys	現在のホットキーとビッグキーをリアルタイムで取得します。	DescribeHotBigKeys 操作を呼び出し、現在のメモリ内のホットキーとビッグキーをリアルタイムで取得します。
DescribeTopHotKeys	DescribeTopHotKeys	指定された期間内のトップ 100 のホットキーをクエリします。
DescribeTopBigKeys	DescribeTopBigKeys	指定された期間の上位 100 件のビッグキーを照会します。
DescribeHotKeys	インスタンスのホットキーを照会します。	DescribeHotKeys 操作を呼び出して、Redis インスタンスのホットキーを照会します。

クエリガバナンス

API	タイトル	説明
CreateQueryOptimizeTag	対象の SQL 文にタグを追加します。	CreateQueryOptimizeTag 操作を呼び出して、対象の SQL 文にタグを追加します。
GetQueryOptimizeExecErrorStats	GetQueryOptimizeExecErrorStats	実行に失敗した SQL テンプレートを照会します。
GetQueryOptimizeExecErrorSample	GetQueryOptimizeExecErrorSample	SQL テンプレート配下で失敗した SQL 文をクエリします。
GetQueryOptimizeSolution	GetQueryOptimizeSolution	クエリガバナンスが提供する SQL テンプレートの最適化に関する提案を照会します。
GetQueryOptimizeRuleList	GetQueryOptimizeRuleList	クエリガバナンス機能によって指定されたデータベースインスタンスに追加されたタグを照会します。
GetQueryOptimizeDataTrend	GetQueryOptimizeDataTrend	クエリガバナンスの傾向データを照会します。
GetQueryOptimizeDataTop	GetQueryOptimizeDataTop	クエリガバナンスデータに基づいて、パフォーマンスが最も高いインスタンスとパフォーマンスが最も低いインスタンスに関する情報を照会します。
GetQueryOptimizeDataStats	GetQueryOptimizeDataStats	クエリガバナンスデータに基づいて、SQL テンプレートに関する情報を照会します。
GetQueryOptimizeTag	SQL タグの取得。	指定された SQL ステートメントのタグを照会します。
GetQueryOptimizeShareUrl	GetQueryOptimizeShareUrl	クエリガバナンス機能によって提供される共有 URL をクエリします。

SQL Explorer

API	タイトル	説明
GetErrorRequestSample	GetErrorRequestSample	SQL Explorer データ内の失敗した SQL クエリに関する情報を非同期でクエリします。指定した時間範囲内で最大 20 件の失敗した SQL クエリを照会できます。
GetAsyncErrorRequestStatResult	GetAsyncErrorRequestStatResult	GetAsyncErrorRequestStatResult を呼び出して、データベースインスタンスの SQL 監査結果から、特定の SQL ステートメントの実行エラー数を非同期で取得します。
GetAsyncErrorRequestListByCode	GetAsyncErrorRequestListByCode	データベースインスタンスの SQL Explorer 結果で MySQL エラーコードを生成する SQL ステートメントの ID を非同期的にクエリします。
GetAsyncErrorRequestStatByCode	GetAsyncErrorRequestStatByCode	SQL Explorer のデータにある MySQL のエラーコードと、各エラーコードに対応する SQL クエリの数を非同期で照会します。
GetFullRequestOriginStatByInstanceId	GetFullRequestOriginStatByInstanceId	データベースインスタンスの SQL Explorer 結果から、アクセス元別に完全なリクエスト統計を収集します。
GetFullRequestStatResultByInstanceId	GetFullRequestStatResultByInstanceId	SQL ID を使用して、データベースインスタンスの SQL Explorer の結果からフルリクエスト統計を非同期で収集します。
GetFullRequestSampleByInstanceId	SQL ID を指定して SQL サンプルデータを照会します。	SQL ID を指定して、データベースインスタンスの SQL Explorer の結果から SQL サンプルデータを照会します。最大 20 件のサンプルレコードが返されます。

Enterprise Edition 管理

API	タイトル	説明
DescribeSqlLogConfig	DAS Enterprise Edition 構成の照会	データベースインスタンスの DAS Enterprise Edition 構成を照会します。
ModifySqlLogConfig	ModifySqlLogConfig	`ModifySqlLogConfig` 操作を呼び出して、データベースインスタンスの DAS Enterprise Edition を有効化または設定します。
DescribeSqlLogStatistic	DAS Enterprise Edition の統計情報を照会します	DAS Enterprise Edition の統計情報を照会します。
GetDasSQLLogHotData	GetDasSQLLogHotData	SQL 監査ログからホットデータを取得します。
CreateSqlLogTask	DAS Enterprise Edition バッチタスクを作成します	詳細データ用の非同期タスクを作成します。
DescribeSqlLogTask	DAS Enterprise Edition バッチタスクの詳細を照会します	DAS Enterprise Edition のバッチタスクの詳細を照会します。
DescribeSqlLogTasks	DAS Enterprise Edition のバッチタスクを一覧表示します	インスタンスの監査ログタスクのリストを照会します。

インスタンスセッション

API	タイトル	説明
GetRedisAllSession	GetRedisAllSession	ApsaraDB for Redis インスタンスの現在のセッションを照会します。
GetMongoDBCurrentOp	GetMongoDBCurrentOp	ApsaraDB for MongoDB (MongoDB) インスタンスの現在のセッションを照会します。
KillInstanceAllSession	すべてのセッションを終了します。	KillInstanceAllSession 操作を呼び出して、指定されたインスタンスのすべてのセッションを終了します。
CreateKillInstanceSessionTask	セッションの終了タスクを作成します。	セッションの終了タスクを作成します。
GetKillInstanceSessionTaskResult	GetKillInstanceSessionTaskResult	セッションを終了するタスクの結果を照会します。
GetMySQLAllSessionAsync	GetMySQLAllSessionAsync	インスタンスのセッションを非同期で照会し、ディメンションごとにセッション統計情報を収集します。

ストレージ分析

API	タイトル	説明
CreateStorageAnalysisTask	CreateStorageAnalysisTask	1 つ以上のデータベースおよびテーブルの使用量詳細をクエリするためのストレージ分析タスクを作成します。
GetStorageAnalysisResult	GetStorageAnalysisResult	ストレージ分析タスクのステータスと結果を照会します。
GetAutoIncrementUsageStatistic	GetAutoIncrementUsageStatistic	自動増分テーブル ID の使用量をクエリします。

ロック最適化

API	タイトル	説明
GetDeadLockDetailList	GetDeadLockDetailList	ApsaraDB RDS for SQL Server インスタンスのデッドロック詳細をクエリします。
GetBlockingDetailList	GetBlockingDetailList	ApsaraDB RDS for SQL Server インスタンスのブロックデータをクエリします。
CreateLatestDeadLockAnalysis	最新のデッドロック分析タスクを作成します。	最新のデッドロック分析タスクを作成します。
GetDeadLockHistory	GetDeadLockHistory	最近のデッドロック分析と全量デッドロック分析の履歴分析タスクを取得します。
GetDeadLockDetail	GetDeadLockDetail	単一のデッドロックイベントの詳細情報を取得します。
GetDeadlockHistogram	時間範囲内の完全なデッドロック分析数の推移を照会します。	指定された時間範囲内のエラーログの完全なデッドロック分析に基づいて、デッドロック数の推移を照会します。

インデックス診断

API	タイトル	説明
GetInstanceMissingIndexList	GetInstanceMissingIndexList	インスタンスに欠落しているすべてのインデックスの詳細を照会します。

スローログ

API	タイトル	説明
DescribeSlowLogHistogramAsync	インスタンスのスロークエリログの傾向データを非同期で取得します。	インスタンスのスロークエリログの傾向データを非同期で取得します。
DescribeSlowLogStatistic	スロークエリログの統計情報。	スロークエリログの統計情報をフォーマットして照会します。
DescribeSlowLogRecords	スロークエリログレコードの照会。	複数の条件によるフィルターおよびソートをサポートする、データベースインスタンスのスロークエリログレコードを照会します。

自動 SQL スロットリング

API	タイトル	説明
UpdateAutoThrottleRulesAsync	自動 SQL スロットリングパラメーターの設定。	UpdateAutoThrottleRulesAsync 操作を呼び出し、指定されたデータベースインスタンスの自動 SQL スロットリングパラメーターをバッチで非同期に設定します。
DisableAutoThrottleRules	DisableAutoThrottleRules	複数のデータベースインスタンスに対して、自動 SQL スロットリング機能を一括で無効化します。
GetAutoThrottleRules	GetAutoThrottleRules	データベースインスタンスの自動 SQL スロットリングルールを照会します。

自動 SQL 最適化

API	タイトル	説明
UpdateAutoSqlOptimizeStatus	UpdateAutoSqlOptimizeStatus	複数のデータベースインスタンスに対して、自動 SQL 最適化機能を有効化、変更、または無効化します。
GetSqlOptimizeAdvice	自動 SQL 最適化によって生成された診断提案を照会します。	DAS の自動 SQL 最適化機能によって生成された診断提案を照会します。
GetInstanceSqlOptimizeStatistic	GetInstanceSqlOptimizeStatistic	指定された期間内の自動 SQL 最適化イベントに関する統計 (最適化イベントの総数や最大改善倍率など) をクエリします。

自動スペース最適化

API	タイトル	説明
UpdateAutoResourceOptimizeRulesAsync	UpdateAutoResourceOptimizeRulesAsync	複数のデータベースインスタンスに対して、自動フラグメントリサイクル機能に関連するパラメーターを非同期で構成します。
DisableAutoResourceOptimizeRules	DisableAutoResourceOptimizeRules	一度に複数のデータベースインスタンスに対して、テーブルスペースフラグメントの自動リサイクル機能を無効にします。
GetAutoResourceOptimizeRules	GetAutoResourceOptimizeRules	データベースインスタンスの自動フラグメント回収ルールを照会します。

自動弾力的スケーリング

API	タイトル	説明
ModifyAutoScalingConfig	ModifyAutoScalingConfig	インスタンスの自動スケーリング設定を変更します。
DescribeAutoScalingConfig	インスタンスの auto scaling 設定を照会します	インスタンスの auto scaling 設定を照会します。
DescribeAutoScalingHistory	インスタンスの弾力的スケーリング履歴を照会します。	インスタンスの弾力的スケーリング履歴を照会します。
DisableInstanceDasConfig	DisableInstanceDasConfig	データベースインスタンスの自動スケーリング機能を無効にします。

パーティションヒートマップ

API	タイトル	説明
GetPartitionsHeatmap	GetPartitionsHeatmap	PolarDB-X 2.0 インスタンスのパーティションに対するアクセス頻度の統計とホットデータをクエリします。

Performance Insight (新バージョン)

API	タイトル	説明
GetPfsSqlSample	GetPfsSqlSample	データベースインスタンスのパフォーマンスインサイト (新バージョン) 機能の SQL サンプルデータを照会します。
GetPfsMetricTrends	GetPfsMetricTrends	データベースインスタンスのパフォーマンスインサイト (新バージョン) 機能のメトリックの傾向をクエリします。
GetPfsSqlSummaries	GetPfsSqlSummaries	GetPfsSqlSummaries API を呼び出して、データベースインスタンスの Performance Insight (新バージョン) の SQL ID ディメンションを使用して、すべてのリクエストデータをクエリします。

エラーログ

API	タイトル	説明
DescribeErrorLogRecords	エラーログの詳細を照会します。	指定された時間範囲内のインスタンスのエラーログの詳細を照会します。

DAS エージェント

API	タイトル	説明
Chat	DAS エージェントインタラクションインターフェイス。	DAS large モデル機能の非同期ロジックインターフェイスを提供します。
GetInstanceGroupInspectReportList	DAS Agent 運用保守レポートリストの照会	DAS Agent によって生成された運用保守レポートのリストを照会します。
GetInstanceGroupInspectReportDetail	DAS エージェントの運用レポートの詳細を照会します。	DAS エージェントの自動運用レポートの詳細を取得します。

クロスプロダクトホワイトリスト

API	タイトル	説明
CreateSecurityIPGroup	クロスサービスホワイトリストテンプレートの作成。	ユーザー用のクロスサービスホワイトリストテンプレートを作成します。
DescribeSecurityIPGroup	クロスエンジンホワイトリストテンプレートの詳細を表示します。	ユーザーのクロスエンジンホワイトリストテンプレートの詳細を表示します。
DescribeSecurityIPGroupRelation	クロスエンジンホワイトリストテンプレートのバインド情報を表示します。	ユーザーのクロスエンジンホワイトリストテンプレートとインスタンス間のバインド情報を表示します。
ModifySecurityIPGroup	ModifySecurityIPGroup	クロスプロダクトホワイトリストテンプレートを変更します。
ModifySecurityIPGroupRelation	クロスエンジンホワイトリストテンプレートのアタッチまたはデタッチ	クロスエンジンホワイトリストテンプレートをユーザーにアタッチまたはデタッチします。
DeleteSecurityIPGroup	クロスプロダクトホワイトリストテンプレートの削除。	ユーザーのクロスプロダクトホワイトリストテンプレートを削除します。

その他

API	タイトル	説明
GetDasAgentSSE	(非推奨) DAS エージェントデータストリームインターフェイス [_single.resp.200.props.Event.enum. error ]エラー情報 [_single.resp.200.props.Event.enum.agent_message ]large モデルによって生成された応答	DAS large モデルのインタラクティブな SSE インターフェイスを提供します。AI チャットやパフォーマンス診断などの特徴をサポートしています。
DescribeSqlLogRecords	DescribeSqlLogRecords	DescribeSqlLogRecords を呼び出して、DAS Enterprise Edition のログ詳細を照会します。
EnableDasPro	EnableDasPro	Database Autonomy Service (DAS) Professional Editionを有効にします。
DisableDasPro	DisableDasPro	Database Autonomy Service (DAS) Professional Edition を無効化します。
DescribeInstanceDasPro	DescribeInstanceDasPro	データベースインスタンスに対して Database Autonomy Service (DAS) Enterprise Edition V1 または V2 が有効になっているかどうかを照会します。
GetDasProServiceUsage	DAS Enterprise Edition (V1 または V2) のストレージ使用量の照会	データベースインスタンスの DAS Enterprise Edition V1 または V2 のストレージ使用量を照会します。
RunCloudBenchTask	RunCloudBenchTask	RunCloudBenchTask 操作を呼び出して、ストレステストタスクを実行します。
DescribeCloudbenchTask	ストレステストタスクの照会。	ストレステストタスクを照会します。
DescribeCloudBenchTasks	ストレステストタスクリストの照会。	ストレステストタスクのリストを照会します。
CreateCloudBenchTasks	CreateCloudBenchTasks	CreateCloudBenchTasks 操作を呼び出して、ストレステストタスクを作成できます。
DescribeCloudbenchTaskConfig	DescribeCloudbenchTaskConfig	特定のストレステストタスクに関する詳細な構成、ファイルパス、および実行コマンドを取得します。
DeleteCloudBenchTask	DeleteCloudBenchTask	ストレステストタスクを削除します。
DeleteStopGateway	DeleteStopGateway	停止済みのデータベースゲートウェイのメタデータを削除します。
GetYaoChiAgent	ApsaraDB エージェント基盤モデル機能インターフェイスを呼び出します。	AI チャット、パフォーマンス診断、およびその他の特徴のための Alibaba Cloud ApsaraDB エージェント基盤モデル機能インターフェイスを提供します。
DescribeAuditLogs	監査アラートログの照会。	アラート検索およびアラート対応のための監査アラートログのリストを照会します。
DescribeDasOpsConfig	Alibaba Cloud マネージドサービスの構成を表示します。	Alibaba Cloud マネージドサービスの有効化された項目を照会します。
DescribeSqlInsightStatistic	SQL Explorer の統計情報を照会します。	DescribeSqlInsightStatistic 操作を呼び出し、指定されたタイムウィンドウ内で、SQL テンプレート、アクセスソース、データベースユーザーなどのディメンションごとに、指定されたインスタンスの SQL Explorer データを集約し、統計情報を収集します。
ModifyDasOpsConfig	DAS O&M サービスの有効化または無効化。	Alibaba Cloud マネージドサービスの設定項目を変更します。

Others

API	タイトル	説明
ModifyForwardSqlLogConfig	ログ転送配信の有効化または無効化。	監査ログの転送構成を変更します。