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 一覧表
|
API |
タイトル |
説明 |
| AddHDMInstance | AddHDMInstance | データベースインスタンスを Database Autonomy Service (DAS) に追加します。 |
| Chat | Chat | Database Autonomy Service (DAS) の大規模言語モデル機能にアクセスするための非同期 API です。 |
| CreateCacheAnalysisJob | CreateCacheAnalysisJob | キャッシュ分析タスクを作成します。 |
| CreateCloudBenchTasks | CreateCloudBenchTasks | CreateCloudBenchTasks 操作を呼び出して、ストレステストタスクを作成できます。 |
| CreateDiagnosticReport | CreateDiagnosticReport | 診断レポートを作成します。 |
| CreateKillInstanceSessionTask | CreateKillInstanceSessionTask | セッションを終了するタスクを作成します。 |
| CreateLatestDeadLockAnalysis | CreateLatestDeadLockAnalysis | データベースインスタンスによって捕捉された最新のデッドロックイベントのオンデマンド分析をトリガーします。 |
| CreateQueryOptimizeTag | CreateQueryOptimizeTag | SQL テンプレートにタグを追加します。 |
| CreateRequestDiagnosis | CreateRequestDiagnosis | SQL ステートメントの診断リクエストを開始します。 |
| CreateSecurityIPGroup | CreateSecurityIPGroup | 複数のプロダクトで共用可能な IP アドレスホワイトリストテンプレートを作成します。 |
| CreateSqlLogTask | CreateSqlLogTask | Database Autonomy Service (DAS) Enterprise Edition 用のオフラインタスクを作成します。 |
| CreateStorageAnalysisTask | CreateStorageAnalysisTask | 1 つ以上のデータベースとテーブルの使用状況詳細を照会するためのストレージ分析タスクを作成します。 |
| DeleteCloudBenchTask | DeleteCloudBenchTask | ストレステストタスクを削除します。 |
| DeleteSecurityIPGroup | DeleteSecurityIPGroup | クロスプロダクトホワイトリストテンプレートを削除します。 |
| DeleteStopGateway | DeleteStopGateway | 停止済みのデータベースゲートウェイのメタデータを削除します。 |
| DescribeAuditLogs | DescribeAuditLogs | データ監査アラートログを照会して、アラートを検出およびハンドルします。 |
| DescribeAutoScalingConfig | DescribeAutoScalingConfig | インスタンスの自動スケーリング機能の設定を照会します。 |
| DescribeAutoScalingHistory | DescribeAutoScalingHistory | インスタンスの自動スケーリング履歴を照会します。 |
| DescribeCacheAnalysisJob | DescribeCacheAnalysisJob | キャッシュ解析タスクの詳細を照会します。 |
| DescribeCacheAnalysisJobs | DescribeCacheAnalysisJobs | キャッシュ解析タスクのリストをクエリします。 |
| DescribeCloudBenchTasks | DescribeCloudBenchTasks | DescribeCloudBenchTasks 操作を呼び出して、ストレステスト タスクをクエリできます。 |
| DescribeCloudbenchTask | DescribeCloudbenchTask | 特定のストレステストタスクを照会します。 |
| DescribeCloudbenchTaskConfig | DescribeCloudbenchTaskConfig | 特定のストレステストタスクに関する詳細な構成、ファイルパス、および実行コマンドを取得します。 |
| DescribeDiagnosticReportList | DescribeDiagnosticReportList | 診断レポートをクエリします。 |
| DescribeErrorLogRecords | DescribeErrorLogRecords | 指定された時間範囲内の特定のデータベースインスタンスのエラーログの詳細を照会します。 |
| DescribeHotBigKeys | DescribeHotBigKeys | DescribeHotBigKeys 操作を呼び出して、メモリ内のホットキーとビッグキーに関するリアルタイム情報を取得します。 |
| DescribeHotKeys | DescribeHotKeys | DescribeHotKeys 操作を呼び出して、Redis インスタンスのホットキーをクエリします。 |
| DescribeInstanceDasPro | DescribeInstanceDasPro | データベースインスタンスに対して Database Autonomy Service (DAS) Enterprise Edition V1 または V2 が有効になっているかどうかを照会します。 |
| DescribeQueryExplain | DescribeQueryExplain | SQL ステートメントの実行計画を取得します。 |
| DescribeSecurityIPGroup | DescribeSecurityIPGroup | クロスプロダクトホワイトリストテンプレートの詳細を照会します。 |
| DescribeSecurityIPGroupRelation | DescribeSecurityIPGroupRelation | クロスプロダクトのホワイトリストテンプレートがインスタンスにどのようにアタッチされているかを照会します。 |
| DescribeSlowLogHistogramAsync | DescribeSlowLogHistogramAsync | インスタンスのスロークエリログの傾向データを非同期で取得します。 |
| DescribeSlowLogRecords | DescribeSlowLogRecords | この API では、複数の条件に基づいて、データベースインスタンスからスローログレコードをクエリ、フィルター、ソートできます。 |
| DescribeSlowLogStatistic | DescribeSlowLogStatistic | スロークエリログ統計を取得します。 |
| DescribeSqlLogConfig | DescribeSqlLogConfig | データベースインスタンスに対して有効化されている Database Autonomy Service (DAS) Enterprise Edition の構成を照会します。 |
| DescribeSqlLogRecords | DescribeSqlLogRecords | DescribeSqlLogRecords を呼び出して、DAS Enterprise Edition のログ詳細を照会します。 |
| DescribeSqlLogStatistic | DescribeSqlLogStatistic | `DescribeSqlLogStatistic` 操作を呼び出して、DAS Enterprise Edition のデータ統計をクエリします。 |
| DescribeSqlLogTask | DescribeSqlLogTask | `DescribeSqlLogTask` 操作を呼び出して、DAS Enterprise Edition のオフラインタスクの詳細をクエリします。 |
| DescribeSqlLogTasks | DescribeSqlLogTasks | インスタンスの監査ログタスクを一覧表示します。 |
| DescribeTopBigKeys | DescribeTopBigKeys | 指定された期間の上位 100 件のビッグキーを照会します。 |
| DescribeTopHotKeys | DescribeTopHotKeys | 指定された期間内のトップ 100 のホットキーをクエリします。 |
| DisableAllSqlConcurrencyControlRules | DisableAllSqlConcurrencyControlRules | 有効なすべての速度制限ルールを無効にします。 |
| DisableAutoResourceOptimizeRules | DisableAutoResourceOptimizeRules | 一度に複数のデータベースインスタンスに対して、テーブルスペースフラグメントの自動リサイクル機能を無効にします。 |
| DisableAutoThrottleRules | DisableAutoThrottleRules | 複数のデータベースインスタンスに対して、自動 SQL スロットリング機能を一括で無効化します。 |
| DisableDasPro | DisableDasPro | Database Autonomy Service (DAS) Professional Edition を無効化します。 |
| DisableInstanceDasConfig | DisableInstanceDasConfig | データベースインスタンスの自動スケーリング機能を無効にします。 |
| DisableSqlConcurrencyControl | DisableSqlConcurrencyControl | 速度制限ルールを無効化します。 |
| EnableDasPro | EnableDasPro | Database Autonomy Service (DAS) Professional Editionを有効にします。 |
| EnableSqlConcurrencyControl | EnableSqlConcurrencyControl | SQL スロットリングを有効化し、データベースへのアクセス要求および同時実行される SQL ステートメントの数を制御します。 |
| GetAsyncErrorRequestListByCode | GetAsyncErrorRequestListByCode | データベースインスタンスの SQL Explorer 結果で MySQL エラーコードを生成する SQL ステートメントの ID を非同期的にクエリします。 |
| GetAsyncErrorRequestStatByCode | GetAsyncErrorRequestStatByCode | SQL Explorer のデータにある MySQL のエラーコードと、各エラーコードに対応する SQL クエリの数を非同期で照会します。 |
| GetAsyncErrorRequestStatResult | GetAsyncErrorRequestStatResult | GetAsyncErrorRequestStatResult を呼び出して、データベースインスタンスの SQL 監査結果から、特定の SQL ステートメントの実行エラー数を非同期で取得します。 |
| GetAutoIncrementUsageStatistic | GetAutoIncrementUsageStatistic | 自動増分テーブル ID の使用量をクエリします。 |
| GetAutoResourceOptimizeRules | GetAutoResourceOptimizeRules | データベースインスタンスの自動フラグメント回収ルールを照会します。 |
| GetAutoThrottleRules | GetAutoThrottleRules | データベースインスタンスの自動 SQL スロットリングルールを照会します。 |
| GetAutonomousNotifyEventContent | GetAutonomousNotifyEventContent | データベースインスタンスの通知イベントの詳細をクエリします。 |
| GetAutonomousNotifyEventsInRange | GetAutonomousNotifyEventsInRange | 1つ以上の緊急度レベルの通知イベントを期間内にクエリします。 |
| GetBlockingDetailList | GetBlockingDetailList | ApsaraDB RDS for SQL Server インスタンスのブロックデータをクエリします。 |
| GetDBInstanceConnectivityDiagnosis | GetDBInstanceConnectivityDiagnosis | IP アドレスを指定して特定のデータベースインスタンスにアクセスする際のネットワーク接続を診断します。 |
| GetDasAgentSSE | GetDasAgentSSE | この API は、サーバー送信イベント (SSE) を使用して DAS エージェントと対話します。この API は、Q&A やパフォーマンス診断などの機能に使用できます。 |
| GetDasProServiceUsage | GetDasProServiceUsage | Database Autonomy Service (DAS) Enterprise Edition V1 または V2 が有効化されているデータベースインスタンスのストレージ使用量を照会します。 |
| GetDasSQLLogHotData | GetDasSQLLogHotData | SQL 監査ログからホットデータを取得します。 |
| GetDeadLockDetail | GetDeadLockDetail | 単一のデッドロックイベントの詳細情報を取得します。 |
| GetDeadLockDetailList | GetDeadLockDetailList | ApsaraDB RDS for SQL Server インスタンスのデッドロック詳細をクエリします。 |
| GetDeadLockHistory | GetDeadLockHistory | 最近のデッドロック分析と全量デッドロック分析の履歴分析タスクを取得します。 |
| GetDeadlockHistogram | GetDeadlockHistogram | 指定された時間範囲内のエラーログの全量デッドロック分析に基づいて、デッドロック発生の時系列ヒストグラムを取得します。 |
| GetErrorRequestSample | GetErrorRequestSample | SQL Explorer データ内の失敗した SQL クエリに関する情報を非同期でクエリします。指定した時間範囲内で最大 20 件の失敗した SQL クエリを照会できます。 |
| GetEventSubscription | GetEventSubscription | データベースインスタンスのイベントサブスクリプション設定を照会します。 |
| GetFullRequestOriginStatByInstanceId | GetFullRequestOriginStatByInstanceId | データベースインスタンスの SQL Explorer 結果から、アクセス元別に完全なリクエスト統計を収集します。 |
| GetFullRequestSampleByInstanceId | GetFullRequestSampleByInstanceId | SQL ID に基づいて、データベースインスタンスの SQL Explorer データ内のサンプル SQL 文を照会します。最大 20 件のサンプル SQL 文を照会できます。 |
| GetFullRequestStatResultByInstanceId | GetFullRequestStatResultByInstanceId | SQL ID を使用して、データベースインスタンスの SQL Explorer の結果からフルリクエスト統計を非同期で収集します。 |
| GetInstanceGroupInspectReportDetail | DAS Agent 運用レポートの詳細を照会します | DAS Agent 運用レポートの詳細を取得します。 |
| GetInstanceGroupInspectReportList | DAS Agent 運用保守レポートリストの照会 | DAS Agent によって生成された運用保守レポートのリストを照会します。 |
| GetInstanceInspections | GetInstanceInspections | 検査およびスコアリング機能を使用して、データベースインスタンスで実行される検査の結果を照会します。 |
| GetInstanceMissingIndexList | GetInstanceMissingIndexList | インスタンスに欠落しているすべてのインデックスの詳細を照会します。 |
| GetInstanceSqlOptimizeStatistic | GetInstanceSqlOptimizeStatistic | 指定された期間内の自動 SQL 最適化イベントに関する統計 (最適化イベントの総数や最大改善倍率など) をクエリします。 |
| GetKillInstanceSessionTaskResult | GetKillInstanceSessionTaskResult | セッションを終了するタスクの結果を照会します。 |
| GetMongoDBCurrentOp | GetMongoDBCurrentOp | ApsaraDB for MongoDB (MongoDB) インスタンスの現在のセッションを照会します。 |
| GetMySQLAllSessionAsync | GetMySQLAllSessionAsync | インスタンスのセッションを非同期で照会し、ディメンションごとにセッション統計情報を収集します。 |
| GetPartitionsHeatmap | GetPartitionsHeatmap | PolarDB-X 2.0 インスタンスのパーティションに対するアクセス頻度の統計とホットデータをクエリします。 |
| GetPfsMetricTrends | GetPfsMetricTrends | データベースインスタンスのパフォーマンスインサイト (新バージョン) 機能のメトリックの傾向をクエリします。 |
| GetPfsSqlSample | GetPfsSqlSample | データベースインスタンスのパフォーマンスインサイト (新バージョン) 機能の SQL サンプルデータを照会します。 |
| GetPfsSqlSummaries | GetPfsSqlSummaries | GetPfsSqlSummaries API を呼び出して、データベースインスタンスの Performance Insight (新バージョン) の SQL ID ディメンションを使用して、すべてのリクエストデータをクエリします。 |
| GetQueryOptimizeDataStats | GetQueryOptimizeDataStats | クエリガバナンスデータに基づいて、SQL テンプレートに関する情報を照会します。 |
| GetQueryOptimizeDataTop | GetQueryOptimizeDataTop | クエリガバナンスデータに基づいて、パフォーマンスが最も高いインスタンスとパフォーマンスが最も低いインスタンスに関する情報を照会します。 |
| GetQueryOptimizeDataTrend | GetQueryOptimizeDataTrend | クエリガバナンスの傾向データを照会します。 |
| GetQueryOptimizeExecErrorSample | GetQueryOptimizeExecErrorSample | SQL テンプレート配下で失敗した SQL 文をクエリします。 |
| GetQueryOptimizeExecErrorStats | GetQueryOptimizeExecErrorStats | 実行に失敗した SQL テンプレートを照会します。 |
| GetQueryOptimizeRuleList | GetQueryOptimizeRuleList | クエリガバナンス機能によって指定されたデータベースインスタンスに追加されたタグを照会します。 |
| GetQueryOptimizeShareUrl | GetQueryOptimizeShareUrl | クエリガバナンス機能によって提供される共有 URL をクエリします。 |
| GetQueryOptimizeSolution | GetQueryOptimizeSolution | クエリガバナンスが提供する SQL テンプレートの最適化に関する提案を照会します。 |
| GetQueryOptimizeTag | GetQueryOptimizeTag | SQL ステートメントのタグをクエリします。 |
| GetRedisAllSession | GetRedisAllSession | ApsaraDB for Redis インスタンスの現在のセッションを照会します。 |
| GetRequestDiagnosisPage | GetRequestDiagnosisPage | SQL 診断レコードをページ単位で照会します。 |
| GetRequestDiagnosisResult | GetRequestDiagnosisResult | GetRequestDiagnosisResult を呼び出して、SQL 診断結果を取得します。 |
| GetRunningSqlConcurrencyControlRules | GetRunningSqlConcurrencyControlRules | 有効な速度制限ルールを照会します。 |
| GetSqlConcurrencyControlKeywordsFromSqlText | GetSqlConcurrencyControlKeywordsFromSqlText | SQL ステートメントに基づいて、速度制限キーワード文字列を生成します。 |
| GetSqlConcurrencyControlRulesHistory | GetSqlConcurrencyControlRulesHistory | 実行中またはトリガーされた速度制限ルールを照会します。 |
| GetSqlOptimizeAdvice | GetSqlOptimizeAdvice | Database Autonomy Service (DAS) の SQL 診断機能によって生成された最適化の提案を照会します。 |
| GetStorageAnalysisResult | GetStorageAnalysisResult | ストレージ分析タスクのステータスと結果を照会します。 |
| GetYaoChiAgent | GetYaoChiAgent | Yaochi Agent 大規模モデルインターフェースは、質問応答およびパフォーマンス診断の機能を提供します。 |
| KillInstanceAllSession | KillInstanceAllSession | インスタンス上のすべてのセッションを終了させます。 |
| ModifyAutoScalingConfig | ModifyAutoScalingConfig | インスタンスの自動スケーリング設定を変更します。 |
| ModifySecurityIPGroup | ModifySecurityIPGroup | クロスプロダクトホワイトリストテンプレートを変更します。 |
| ModifySecurityIPGroupRelation | ModifySecurityIPGroupRelation | クロスプロダクトのホワイトリストテンプレートをアタッチまたはデタッチします。 |
| ModifySqlLogConfig | ModifySqlLogConfig | `ModifySqlLogConfig` 操作を呼び出して、データベースインスタンスの DAS Enterprise Edition を有効化または設定します。 |
| RunCloudBenchTask | RunCloudBenchTask | RunCloudBenchTask 操作を呼び出して、ストレステストタスクを実行します。 |
| SetEventSubscription | SetEventSubscription | データベースインスタンスのイベントサブスクリプション設定を構成します。 |
| UpdateAutoResourceOptimizeRulesAsync | UpdateAutoResourceOptimizeRulesAsync | 複数のデータベースインスタンスに対して、自動フラグメントリサイクル機能に関連するパラメーターを非同期で構成します。 |
| UpdateAutoSqlOptimizeStatus | UpdateAutoSqlOptimizeStatus | 複数のデータベースインスタンスに対して、自動 SQL 最適化機能を有効化、変更、または無効化します。 |
| UpdateAutoThrottleRulesAsync | UpdateAutoThrottleRulesAsync | 複数のデータベースインスタンスに対して、自動 SQL 速度制限機能に関連するパラメーターを一度に非同期で設定します。 |