API 標準および多言語対応の SDK
本製品 (SysOM/2023-12-30) の API は、ROA 標準に準拠した 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 |
タイトル |
説明 |
| GetInspectionReport | 検査レポートの取得 | SysOM検査レポートを取得します。 |
| CreateInstanceInspection | インスタンス検査を作成します | SysOM インスタンス検査を作成します。 |
アラート通知
|
API |
タイトル |
説明 |
| ListAlertDestinations | アラート連絡先一覧の取得 | アラート連絡先の一覧を取得します。 |
| UpdateAlertDestination | アラート連絡先を更新します | アラート連絡先を更新します。 |
| GetAlertDestination | アラート連絡先の取得 | 指定されたアラート連絡先の情報を取得します。 |
| UpdateAlertEnabled | アラートポリシーステータスの更新 | プッシュアラートポリシーのステータスを更新します。 |
| GetAlertStrategy | アラートポリシーを取得します | ポリシー ID に基づいてユーザーのアラートを取得します。 |
| DeleteAlertStrategy | アラートポリシーを削除します | プッシュ通知のアラートポリシーを削除します。 |
| ListAlertItems | アラートメトリクスリストの取得 | すべてのアラートメトリクスを取得します。 |
| ListAlertStrategies | アラートポリシーリストを取得します | 現在のユーザーのすべてのプッシュアラートポリシーを取得します。 |
| DeleteAlertDestination | アラート連絡先を削除します | アラート連絡先を削除します。 |
| CreateAlertDestination | アラート連絡先を作成します | アラート通知の連絡先を作成します。 |
| CreateAlertStrategy | CreateAlertStrategy | アラートプッシュストラテジーを作成します。 |
| UpdateAlertStrategy | アラートポリシーの更新 | プッシュアラートポリシーを更新します。 |
ホットスポット分析
|
API |
タイトル |
説明 |
| UpdateFuncSwitchRecord | サービス特徴モジュールの構成を更新します | サービス特徴モジュールの構成を更新します。 |
| GetServiceFuncStatus | サービス構成ステータスを取得します | 特徴モジュールの構成を取得します。 |
| GetHotSpotUniqList | ホットスポットタイプリストを取得します | インスタンス配下の特定フィールドのリストを取得します。 |
| GetHotspotTracking | ホットスポットトラッキングの結果を取得します | ホットスポットトラッキングの結果を取得します。 |
| GetHotspotPidList | PIDリストの取得 | 指定されたインスタンスのPIDリストを取得します。 |
| GetHotspotInstanceList | インスタンスリストを取得します | ホットスポットインスタンスのリストを取得します。 |
| GetHotspotCompare | ホットスポット比較トレーシング結果の取得 | ホットスポット比較トレーシング結果を取得します。 |
| GetHotspotAnalysis | ホットスポット分析結果を取得します | ホットスポット分析結果を取得します。 |
AI 可観測性
|
API |
タイトル |
説明 |
| StartAIAnalysis | AI インフラ観測を開始します | AI タスク分析を開始します。 |
| GetListRecord | AIインフラ分析レコードの取得 | AIインフラ分析レコードのリストを取得します。 |
| GetAIQueryResult | AI Infra の観測結果を取得します | AI Infra の分析結果を照会します。 |
コンポーネント管理
|
API |
タイトル |
説明 |
| GetResources | クラスターまたはノードのリアルタイムのリソース使用量を取得します | クラスターまたはノードのリアルタイムのリソース使用量を取得します。 |
| GetHostCount | クラスターのノード数またはノードのPod数の取得 | クラスター内のノード数またはノード上のPod数を取得します。 |
| InitialSysom | Alinux コンソールの有効化 | SysOM を初期化して、サービスにリンクされたロールが存在することを確認します。 |
| ListClusters | 現在のユーザーのマネージドクラスターリストを取得する | 現在のユーザーのすべてのマネージドクラスターを取得する |
| ListInstances | ホストインスタンスリストを取得します | インスタンスのリストを取得します。 |
| ListPluginsInstances | コンポーネントのインスタンスリストを取得します | プラグインのインストール、更新、またはアンインストール用のインスタンスリストを取得します。 |
| ListPodsOfInstance | クラスターまたはインスタンス内のPodの一覧を取得 | クラスターまたはインスタンス内のPodの一覧を取得します。 |
| UpgradeAgentForCluster | ACK クラスターのコンポーネントを更新します | クラスターのコンポーネントを更新します。 |
| UpgradeAgent | コンポーネントを更新します | インストール済みのコンポーネントを指定されたバージョンに更新します。 |
| UninstallAgentForCluster | ACK クラスターからコンポーネントをアンインストールします | クラスターからコンポーネントをアンインストールします。 |
| UninstallAgent | コンポーネントのアンインストール | コンポーネントの指定バージョンをアンインストールします。 |
| ListRegions | マネージドインスタンスのリージョンをリストします | マネージドインスタンスが存在するすべてのリージョンをリストします。 |
| ListInstancesWithEcsInfo | ECS 情報を含むインスタンスリストを取得します | マネージドおよびアンマネージドインスタンスの情報（ECS 情報を含む）を取得します。 |
| ListInstanceStatus | 管理対象インスタンスのステータスの取得 | インスタンスのステータスを取得します。 |
| ListInstancesEcsInfoList | インスタンスの ECS 情報リストを取得します | インスタンスの ECS 情報リスト（タグリストやパブリック IP アドレスリストなど）を取得します。 |
| ListClusterAgentInstallRecords | ACK クラスターのコンポーネントインストールレコードを取得します | ACK クラスター内のコンポーネントのインストールレコードを取得します。 |
| ListAgentInstallRecords | コンポーネントのインストール記録を一覧表示します | エージェントのインストール記録を一覧表示します。 |
| InstallAgentForCluster | ACK クラスターにコンポーネントをインストールします | ACK クラスターにコンポーネントをインストールします。 |
| InstallAgent | コンポーネントをインストールします | 指定されたインスタンスにエージェントをインストールします。 |
| ListAgents | コンポーネントリストの取得 | エージェントのリストを取得します。 |
| GetAgentTask | コンポーネントタスクの実行ステータスを取得します | エージェントインストールタスクの実行ステータスを取得します。 |
| GetAgent | エージェントの詳細を取得します | 特定のエージェントの詳細を取得します。 |
| ListAllInstances | すべてのインスタンスとその完全な情報を取得します | 管理対象または非管理対象のインスタンスとそのインスタンス情報のリストを取得します。 |
ヘルスステータス
|
API |
タイトル |
説明 |
| UpdateEventsAttention | アノマリー項目のアテンションレベルを更新します | アノマリー項目のアテンションレベルを更新します。アテンションレベルを調整すると、異常検知アルゴリズムの秘密度に影響します。 |
| ListAbnormalyEvents | アノマリーイベントの詳細を取得します | 指定された時間範囲内のクラスター、ノード、または Pod のアノマリーイベント情報を取得します。 |
| ListInstanceHealth | クラスター内のノードまたはPodのヘルスステータスリストの取得 | 指定した時間範囲内のクラスターノードまたはPodのヘルスステータスリストを取得します。 |
| InvokeAnomalyDiagnosis | アノマリー診断を開始します | アノマリー診断タスクを開始します。 |
| GetRangeScore | ヘルススコアトレンドの取得 | ヘルススコアのトレンドを取得します。 |
| GetProblemPercentage | 異常問題の割合の取得 | 指定された時間範囲内のクラスターノードまたはPodにおける異常問題の割合を取得します。 |
| GetInstantScore | クラスター/ノードのリアルタイムヘルススコアを取得します | クラスターまたはノードのリアル時間ヘルススコアを取得します。 |
| GetHealthPercentage | ノード/Pod のヘルスステータスディストリビューションを取得します | 指定された期間におけるノードまたは Pod のヘルスステータスディストリビューションを取得します。 |
| GetAbnormalEventsCount | 異常イベントの件数を取得します | ノードまたは Pod の未処理（未診断）の異常イベントのレベル別件数を取得します。 |
診断
|
API |
タイトル |
説明 |
| ListDiagnosis | 診断リストを取得します | 診断履歴のリストを取得します。 |
| GetDiagnosisResult | 診断結果の取得 | 診断結果を取得します。 |
| InvokeDiagnosis | 診断の開始 | 診断を開始します。 |
| AuthDiagnosis | 診断の認可 | 現在のアカウントのECSインスタンスをSysOMで診断することを認可します。InvokeDiagnosis オペレーションを呼び出して診断を開始する前に、このオペレーションを呼び出して特定のECSインスタンスの診断を認可する必要があります。 |
OS コパイロット
|
API |
タイトル |
説明 |
| GetCopilotHistory | Copilot ストリーミングインターフェイスのチャット履歴を取得します | Copilot のチャット履歴を取得します。 |
| GenerateCopilotStreamResponse | OS Copilot ストリーミング SSE エンドポイントを呼び出します | OS Copilot サービスのストリーミング SSE エンドポイントを呼び出します。 |
| GenerateCopilotResponse | コパイロットサービスをリクエストします | コパイロットサービスの応答結果を取得します。 |
その他
|
API |
タイトル |
説明 |
| CheckInstanceSupport | インスタンスがサポートされているかどうかを確認します | ターゲットインスタンスが SysOM でサポートされているかどうかを確認します。 |
| StartAIDiffAnalysis | AIインフラ差分分析の開始 | AIインフラの差分分析を開始します。 |
| DescribeMetricList | メトリックデータの照会 | メトリックデータを照会します。 |
| CreateVmcoreDiagnosisTask | 障害診断タスクの作成 | 入力パラメータに基づいて、指定されたvmcoreまたはdmesgログファイルを診断するインテリジェントな障害診断ノードを作成します。 |
| GetVmcoreDiagnosisTask | 診断タスクを照会します | タスク ID を指定して、診断タスクの実行ステータスと診断結果を照会します。 |
| ListVmcoreDiagnosisTask | クラッシュ診断タスクリストを照会します | 過去のクラッシュ診断タスクリストを照会します。 |
| CpuHighAgentStreamResponse | CPU High Agent ストリーミング SSE インターフェイスを呼び出します | CPU High Agent ストリーミング SSE インターフェイスを呼び出します。 |