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 |
タイトル |
説明 |
| CreateInstanceInspection | インスタンス検査を作成します。 | SysOM インスタンス検査を作成します。 |
アラート通知
|
API |
タイトル |
説明 |
| ListAlertDestinations | アラート連絡先リストを取得します。 | アラート連絡先のリストを取得します。 |
| UpdateAlertDestination | アラート連絡先を更新します。 | アラート連絡先を更新します。 |
| GetAlertDestination | アラート連絡先を取得します。 | 指定されたアラート連絡先の情報を取得します。 |
| UpdateAlertEnabled | アラートポリシーのステータスを更新します。 | プッシュアラートポリシーのステータスを更新します。 |
| GetAlertStrategy | アラートポリシーを取得します。 | ポリシー ID でユーザーのアラートルールを取得します。 |
| DeleteAlertStrategy | アラートポリシーを削除します。 | プッシュアラート機能のアラートポリシーを削除します。 |
| ListAlertItems | アラートメトリクスリストの取得 | すべてのアラートメトリクスを取得します。 |
| ListAlertStrategies | アラートポリシーリストを取得します。 | ユーザーがプッシュ通知用に設定したすべてのアラートポリシーを取得します。 |
| DeleteAlertDestination | アラート連絡先を削除します。 | アラート連絡先を削除します。 |
| CreateAlertDestination | アラート連絡先を作成します。 | アラート通知用の連絡先を作成します。 |
| CreateAlertStrategy | アラートポリシーを作成します。 | プッシュ通知のアラートポリシーを作成します。 |
| UpdateAlertStrategy | アラートポリシーを更新します。 | プッシュアラートポリシーを更新します。 |
ホットスポット分析
|
API |
タイトル |
説明 |
| UpdateFuncSwitchRecord | サービス特徴モジュールの構成を更新します。 | サービス特徴モジュールの構成を更新します。 |
| GetServiceFuncStatus | サービス構成ステータスを取得します。 | 特徴モジュールの構成を取得します。 |
| GetHotSpotUniqList | ホットスポットタイプリストを取得します。 | インスタンスの特定のフィールドのリストを取得します。 |
| GetHotspotTracking | ホットスポット追跡結果を取得します。 | ホットスポット追跡結果を取得します。 |
| GetHotspotPidList | PID リストを取得します。 | 指定されたインスタンスの PID リストを取得します。 |
| GetHotspotInstanceList | インスタンスリストを取得します。 | ホットスポットインスタンスのリストを取得します。 |
| GetHotspotCompare | ホットスポット比較トレースの結果を取得します。 | ホットスポット比較トレースの結果を取得します。 |
| GetHotspotAnalysis | ホットスポット分析結果を取得します。 | ホットスポット分析結果を取得します。 |
AI 可観測性
|
API |
タイトル |
説明 |
| StartAIAnalysis | AI インフラ観測を開始します。 | AI タスク分析を開始します。 |
| GetListRecord | AI Infra 分析 Record を取得します。 | AI Infra 分析 Record のリストを取得します。 |
| GetAIQueryResult | AI Infra 観測結果を取得します。 | AI Infra 分析結果を照会します。 |
コンポーネント管理
|
API |
タイトル |
説明 |
| InstallAgentWithType | コンポーネントをインストールします | 指定されたインスタンスにエージェントをインストールします。 |
| UninstallAgentWithType | コンポーネントをアンインストールします | コンポーネントの指定されたバージョンをアンインストールします。 |
| UpgradeAgentWithType | コンポーネントを更新します。 | インストール済みコンポーネントのバージョンを指定されたバージョンに更新します。 |
| GetResources | クラスターまたはノードのリアルタイムリソース使用量を取得します。 | クラスターまたはノードのリアルタイムリソース使用量を取得します。 |
| GetHostCount | クラスターのノード数またはノード Pod 数を取得します。 | クラスター内のノード数またはノード Pod 数を取得します。 |
| InitialSysom | alinux コンソールを有効にします。 | SysOM を初期化し、サービスリンクロールが存在することを確認します。 |
| ListClusters | 現在のユーザーのマネージドクラスターを照会します。 | 現在のユーザーのすべてのマネージドクラスターを取得します。 |
| ListPluginsInstances | コンポーネントのインスタンスリストを取得します。 | プラグインのインストール、更新、またはアンインストール用のインスタンスのリストを取得します。 |
| ListPodsOfInstance | クラスターまたはインスタンスの Pod のリストを取得します。 | クラスターまたはインスタンスの Pod のリストを取得します。 |
| UpgradeAgentForCluster | ACK クラスターのコンポーネントを更新します。 | クラスターのコンポーネントを更新します。 |
| UpgradeAgent | コンポーネントを更新します。 | インストール済みのコンポーネントを指定されたバージョンに更新します。 |
| UninstallAgentForCluster | ACK クラスターからコンポーネントをアンインストールします。 | クラスターからコンポーネントをアンインストールします。 |
| UninstallAgent | コンポーネントをアンインストールします | コンポーネントの指定されたバージョンをアンインストールします。 |
| ListInstancesWithEcsInfo | ECS 情報を含むインスタンスリストを取得します。 | ECS 情報を含む、管理対象および非管理対象のインスタンスに関する情報を取得します。 |
| ListInstanceStatus | ホストインスタンスのステータスを取得します。 | インスタンスステータスを取得します。 |
| ListInstancesEcsInfoList | インスタンスの ECS 情報リストを取得します。 | タグリストやパブリック IP アドレスリストなど、インスタンスの ECS 情報リストを取得します。 |
| ListClusterAgentInstallRecords | ACK クラスターコンポーネントのインストール記録を取得します。 | クラスターコンポーネントのインストール記録を取得します。 |
| ListAgentInstallRecords | コンポーネントのインストール記録を一覧表示します。 | エージェントのインストール記録を一覧表示します。 |
| InstallAgentForCluster | ACK クラスターにコンポーネントをインストールします。 | ACK クラスターにコンポーネントをインストールします。 |
| InstallAgent | コンポーネントをインストールします | 指定されたインスタンスにエージェントをインストールします。 |
| GetAgentTask | コンポーネントタスクの実行ステータスを取得します。 | エージェントインストールタスクの実行ステータスを取得します。 |
| GetAgent | コンポーネントの詳細を取得します。 | 特定のコンポーネントの詳細を取得します。 |
| ListAllInstances | すべてのインスタンスを完全な情報とともに取得します。 | 管理対象または非管理対象のインスタンスのリストと、そのインスタンス情報を取得します。 |
正常性スコア
|
API |
タイトル |
説明 |
| UpdateEventsAttention | アノマリー項目のアテンションレベルを更新します。 | アノマリー項目のアテンションレベルを更新します。アテンションレベルを調整すると、異常検知アルゴリズムの秘密度に影響します。 |
| ListAbnormalyEvents | アノマリーイベントの詳細を取得します。 | 指定された時間範囲内のクラスター、ノード、または Pod のアノマリーイベント情報を取得します。 |
| ListInstanceHealth | クラスター内のノードまたは Pod のヘルスステータスリストを取得します。 | 指定された時間範囲内のクラスターのノードまたは Pod のヘルスステータスリストを取得します。 |
| InvokeAnomalyDiagnosis | 異常診断を開始します。 | 異常診断を開始します。 |
| GetRangeScore | ヘルススコアの傾向を取得します。 | ヘルススコアの傾向を取得します。 |
| GetProblemPercentage | アノマリー発行の割合を取得します。 | 指定された時間範囲内で、クラスター内のノードまたはノード内のポッドにおけるアノマリー発行の割合を取得します。 |
| GetInstantScore | クラスター/ノードのリアル時間ヘルススコアを取得します。 | クラスターまたはノードのリアル時間ヘルススコアを取得します。 |
| GetHealthPercentage | ノードまたは Pod のヘルスステータスのディストリビューションを取得します。 | 指定された期間におけるノードまたは Pod のヘルスステータスのディストリビューションを取得します。 |
| GetAbnormalEventsCount | 異常イベント数を取得します。 | ノードまたは Pod に関する、重大度レベル別の未処理 (未診断) 異常イベントの数を取得します。 |
診断
|
API |
タイトル |
説明 |
| ListDiagnosis | 診断リストを取得します。 | 診断履歴 Record のリストを取得します。 |
| GetDiagnosisResult | 診断結果を取得します。 | 診断結果を取得します。 |
| InvokeDiagnosis | 診断タスクを開始します。 | 診断タスクを開始します。 |
| AuthDiagnosis | 診断の権限を付与します。 | SysOM に対して、現在のアカウント配下の ECS インスタンスを診断する権限を付与します。特定の ECS インスタンスで診断を開始する InvokeDiagnosis 操作を呼び出す前に、この操作を呼び出して対象インスタンスの診断権限を付与する必要があります。 |
OS コパイロット
|
API |
タイトル |
説明 |
| GetCopilotHistory | Copilot ストリーミング API からチャット Record を取得します。 | Copilot の過去のチャット Record を取得します。 |
| GenerateCopilotStreamResponse | OS Copilot ストリーミング SSE サービスをリクエストします。 | OS Copilot サービスのストリーミング SSE インターフェイスを提供します。 |
| GenerateCopilotResponse | Copilot サービスをリクエストします。 | Copilot サービスから応答結果を取得します。 |
その他
|
API |
タイトル |
説明 |
| CheckInstanceSupport | インスタンスがサポートされているかどうかを確認します。 | 対象インスタンスが SysOM でサポートされているかどうかを確認します。 |
| StartAIDiffAnalysis | AI Infra 差分分析を開始します。 | AI Infra 差分分析を開始します。 |
| CreateVmcoreDiagnosisTask | 機能停止診断ノードを作成します。 | 入力パラメーターとして提供された vmcore または dmesg ログファイルを診断する、システム機能停止用のインテリジェント診断ノードを作成します。 |
| GetVmcoreDiagnosisTask | 診断タスクを照会します。 | タスク ID を指定して診断タスクの実行ステータスと診断結果を照会します。 |
| ListVmcoreDiagnosisTask | ダウン診断リストを照会します。 | 過去のダウン診断タスクのリストを照会します。 |
| CpuHighAgentStreamResponse | CPU high エージェントのストリーミング SSE インターフェイスを呼び出します。 | CPU high エージェントのストリーミング SSE インターフェイスを呼び出します。 |
| CreateClusterVpcEndpointConnection | クラスターの VPC エンドポイント接続を作成します。 | クラスターの VPC エンドポイント接続を作成します。 |
| DescribeMetricList | メトリックデータを照会します。 | メトリックデータを照会します。 |
| GetAifgResult | 診断結果を取得します。 | 診断結果を取得します。 |
| GetAifgUrl | 診断結果の URL リンクを取得します。 | 診断結果の URL リンクを取得します。 |
| GetConfigByName | 構成名で構成内容を取得します。 | 構成名で構成情報を取得します。 |
| GetGpuClusterArgsOptions | GPU リソーストポロジオプションパラメーターを取得します。 | GPU クラスターパラメーターのリストを取得します。 |
| GetGpuClusterListAlarmRecord | GPU リソーストポロジアノマリーイベントのリストを取得します。 | GPU クラスターアラートのリストを取得します。 |
| GetInspectionReport | 検査レポートを取得します。 | SysOM 検査レポートを取得します。 |
| GetListGpuCluster | GPU クラスターのリストを取得します。 | GPU クラスターのリストを取得します。 |
| ListAgents | エージェントリストを取得します。 | エージェントのリストを取得します。 |
| ListAifgJobs | 診断タスクのリストを取得します。 | 診断タスクのリストを取得します。 |
| ListInstanceInfo | インスタンス情報リストを取得します。 | 特定のタイプのインスタンス情報のすべての値を取得します。 |
| ListInstances | ホストインスタンスリストを取得します。 | ホストインスタンスのリストを取得します。 |
| ListRegions | マネージドインスタンスのリージョンをリストします | マネージドインスタンスが存在するすべてのリージョンをリストします。 |
| StartAifgAnalysis | 診断をトリガーします。 | AI アプリケーション診断をトリガーします。 |