InvokeDiagnosis - Alibaba Cloud Linux - Alibaba Cloud ドキュメントセンター

操作説明

対象の ECS インスタンスを診断するには、以下の要件を満たす必要があります。

対象の ECS インスタンスステータスが実行中である必要があります。
対象の ECS インスタンスにクラウドアシスタントがインストールされている必要があります。インストールされていない場合は、クラウドアシスタントエージェントのインストールを参照してインストールしてください。
AuthDiagnosis 操作を呼び出して、SysOM による対象の ECS インスタンスの診断を許可する必要があります。権限が付与されていない場合、この操作は直接失敗します。
この操作は、SysOM サービスリンクロール (AliyunServiceRoleForSysom) が作成されていることに依存します。この操作では、サービスリンクロールは自動的には作成されません。サービスリンクロールが存在しない場合は、まず AuthDiagnosis を呼び出して権限付与を関連付けます。その操作により、前述のサービスリンクロールが作成されます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sysom:InvokeDiagnosis

create

*診断。

acs:sysom::{#accountId}:diagnosis/*

なし

リクエスト構文

POST /api/v1/openapi/diagnosis/invoke_diagnosis HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	リクエストボディのパラメーター。
channel	string	必須	診断チャンネル。現在は ECS チャンネルに固定されています。列挙値: ecs : ECS チャンネル。	ecs
params	string	必須	診断パラメーター。診断タイプごとに異なるパラメーターが必須です。各診断タイプに必須のパラメーターについては、以下のリクエストパラメーターの補足説明を参照してください。重要 JSON 形式の文字列を渡します。	{ "インスタンス": "i-wz9gdv7qmdhusamc4dl01", "uid": "xxxxxxxxxxxxxx", "region": "cn-shenzhen" }
service_name	string	必須	診断タイプ。実行する診断のタイプを指定します。列挙値: iofsstat : I/O トラフィック分析。 iodiagnose : ワンクリック I/O 診断。 oomcheck : OOM 診断。 diskanalysis : ディスク分析診断。 javamem : Java メモリ診断。 iolatency : I/O レイテンシ分析。 netjitter : ネットワークジッター診断。 loadtask : システム負荷診断。 vmcore : クラッシュ診断。 packetdrop : ネットワークパケットロス診断。 memgraph : メモリ概要診断。	memgraph

診断パラメーターの説明。

メモリ概要診断 (memgraph) パラメーター

memgraph (メモリパノラマ分析) ツールは、メモリ使用率が高いが、具体的なメモリ消費量を明確に特定できないエラーのシナリオ向けに設計されています。メモリパノラマ分析診断機能を使用すると、現在のシステムメモリ使用状況をスキャンし、メモリ使用量の詳細な内訳を取得できます。このツールは、システムメモリとアプリケーションメモリの分布を示し、アプリケーションメモリ使用量、ファイルキャッシュ、および共有メモリキャッシュ使用量の上位 30 件のランキングをリスト表示します。

パラメーター	タイプ	パラメーターの説明	必須	デフォルト	備考
uid	文字列	ユーザー UID	はい		ユーザー UID。
region	文字列	インスタンスリージョン	はい		インスタンスが存在するリージョン。
instance	文字列	インスタンス ID	はい		診断するインスタンスの ID を入力します。診断はこのインスタンス内部で開始されます。
pod	文字列	Pod 名	いいえ		Pod 名。

Java メモリ診断 (javamem) パラメーター

javamem (Java メモリ診断) ツールは、Java アプリケーションのメモリ使用状況を診断するために使用されます。Java ヒープメモリと非ヒープメモリの分布と構成を理解し、潜在的なメモリリークとメモリ不足のエラーを特定し、観測可能、測定可能、追跡可能な Java メモリ管理を実現するのに役立ちます。

パラメーター	タイプ	パラメーターの説明	必須	デフォルト	備考
uid	文字列	ユーザー UID	はい		ユーザー UID。
region	文字列	インスタンスリージョン	はい		インスタンスが存在するリージョン。
instance	文字列	インスタンス ID	はい		診断するインスタンスの ID を入力します。診断はこのインスタンス内部で開始されます。
Pid	文字列	Java プロセス PID	いいえ		Java プロセスの PID。Pid または pod のいずれか少なくとも 1 つを指定します。
pod	文字列	Pod 名	いいえ		Pod 名。pid または pod のいずれか少なくとも 1 つを指定します。
duration	文字列	JNI メモリ割り当てプロファイリング期間	いいえ		JNI メモリ割り当てプロファイリング期間。JNI 診断を実行するには、0 以外の値を指定します。それ以外の場合、デフォルトでは JNI 診断は実行されません。

メモリ OOM 診断 (oomcheck) パラメーター

oomcheck (OOM 診断) ツールは、OOM (Out of Memory) エラーを分析および特定し、OOM イベントの根本原因を特定し、OOM エラーの解決とシステムの可用性およびパフォーマンスの向上に役立つ対応する推奨事項を提供するために使用されます。

パラメーター	タイプ	パラメーターの説明	必須	デフォルト	備考
uid	文字列	ユーザー UID	はい		ユーザー UID。
region	文字列	インスタンスリージョン	はい		インスタンスが存在するリージョン。
instance	文字列	インスタンス ID	はい		診断するインスタンスの ID を入力します。診断はこのインスタンス内部で開始されます。
pod	文字列	Pod 名	いいえ		Pod 名。
time	文字列	診断時間	いいえ		OOM 診断の時点を入力します。デフォルト値は最新の発生時刻です。

システム負荷診断 (loadtask) パラメーター

loadtask (システム負荷診断タスク) ツールは、1 分間の平均負荷 (load1 メトリック) のエラーの原因を分析し、詳細情報を提供します。

パラメーター	タイプ	パラメーターの説明	必須	デフォルト	備考
uid	文字列	ユーザー UID	はい		ユーザー UID。
region	文字列	インスタンスリージョン	はい		インスタンスが存在するリージョン。
instance	文字列	インスタンス ID	はい		診断するインスタンスの ID を入力します。診断はこのインスタンス内部で開始されます。

スケジューリングジッター診断 (delay) パラメーター

delay (スケジューリングジッター診断) ツールは、CPU が長期間タスク切り替えを実行しないことによって引き起こされるエラーを分析します。これにより、ユーザー空間プロセスがスケジューリングされなくなります (たとえば、メモリ回収中)。

パラメーター	タイプ	パラメーターの説明	必須	デフォルト	備考
uid	文字列	ユーザー UID	はい		ユーザー UID。
region	文字列	インスタンスリージョン	はい		インスタンスが存在するリージョン。
instance	文字列	インスタンス ID	はい		診断するインスタンスの ID を入力します。診断はこのインスタンス内部で開始されます。
duration	文字列	診断期間	いいえ	20	診断期間 (秒単位)。デフォルト値: 20。
threshold	文字列	診断しきい値	いいえ	20	レイテンシしきい値。このしきい値を超えるイベントが記録されます。デフォルト値: 20 ms。

I/O トラフィック分析診断 (iofsstat) パラメーター

iofsstat (I/O トラフィック分析) ツールは、システム内の I/O トラフィックの帰属と関連するエラーを分析します。結果には、各ディスクまたはパーティションの I/O トラフィック統計と、各プロセスの I/O トラフィック統計が含まれます。

パラメーター	タイプ	パラメーターの説明	必須	デフォルト	備考
uid	文字列	ユーザー UID	はい		ユーザー UID。
region	文字列	インスタンスリージョン	はい		インスタンスが存在するリージョン。
instance	文字列	インスタンス ID	はい		診断するインスタンスの ID を入力します。I/O トラフィック統計はこのインスタンス内部で収集されます。
timeout	文字列	診断期間	いいえ	15	診断期間。これは I/O トラフィック統計の収集期間でもあります。単位: 秒。60 秒を超えないようにしてください。
disk	文字列	対象ディスク	いいえ	""	vda や sda など、診断するディスクを入力します。デフォルトでは、すべてのディスクが診断されます。

ワンクリック I/O 診断 (iodiagnose) パラメーター

iodiagnose (ワンクリック I/O 診断) ツールは、高い I/O レイテンシ、I/O バースト、I/O 待機など、頻繁に発生するエラーに焦点を当てています。さまざまな I/O エラーのタイプを特定し、対応するサブツールを呼び出して I/O データを分析し、結論と推奨事項を提供します。

パラメーター	タイプ	パラメーターの説明	必須	デフォルト	備考
uid	文字列	ユーザー UID	はい		ユーザー UID。
region	文字列	インスタンスリージョン	はい		インスタンスが存在するリージョン。
instance	文字列	インスタンス ID	はい		診断するインスタンスの ID を入力します。I/O ハング診断はこのインスタンス内部で開始されます。
timeout	文字列	診断期間	いいえ	30	診断期間 (秒単位)。デフォルト値: 30。この値は 30 秒以上に設定してください。

ネットワークパケットロス診断 (packetdrop) パラメーター

packetdrop (ネットワークパケットロス診断) ツールは、さまざまな原因によりネットワーク伝送中にオペレーティングシステムのカーネルレベルで発生するパケットロスのエラーを分析します。

パラメーター	タイプ	パラメーターの説明	必須	デフォルト	備考
uid	文字列	ユーザー UID	はい		ユーザー UID。
region	文字列	インスタンスリージョン	はい		インスタンスが存在するリージョン。
instance	文字列	インスタンス ID	はい		診断するインスタンスの ID を入力します。診断はこのインスタンス内部で開始されます。

ネットワークジッター診断 (netjitter) パラメーター

netjitter (ネットワークジッター診断) ツールは、ネットワークパケット伝送中にさまざまな要因によって引き起こされるオペレーティングシステムのカーネルレベルでの不安定性やエラーを分析します。

パラメーター	タイプ	パラメーターの説明	必須	デフォルト	備考
uid	文字列	ユーザー UID	はい		ユーザー UID。
region	文字列	インスタンスリージョン	はい		インスタンスが存在するリージョン。
instance	文字列	インスタンス ID	はい		診断するインスタンスの ID を入力します。診断はこのインスタンス内部で開始されます。
duration	文字列	診断期間	いいえ	20	診断期間 (秒単位)。デフォルト値: 20。
threshold	文字列	ジッターしきい値	いいえ	10	ジッターを判定するためのしきい値 (ミリ秒単位)。デフォルト値: 10 ms。

クラッシュ診断 (vmcore) パラメーター

vmcore (クラッシュ診断) ツールは、オペレーティングシステムのエラーおよびクラッシュの原因を分析します。カーネルパニックによって生成されたコアダンプファイルを dmesg ログと組み合わせて分析し、クラッシュの原因を特定します。

パラメーター	タイプ	パラメーターの説明	必須	デフォルト	備考
uid	文字列	ユーザー UID	はい		ユーザー UID。
region	文字列	インスタンスリージョン	はい		インスタンスが存在するリージョン。
instance	文字列	インスタンス ID	はい		診断するインスタンスの ID を入力します。診断はこのインスタンス内部で開始されます。

ディスク分析診断 (diskanalysis) パラメーター

diskanalysis (ディスク分析診断) ツールは、システム内のディスク使用状況とエラーを分析します。

パラメーター	タイプ	パラメーターの説明	必須	デフォルト	備考
uid	文字列	ユーザー UID	はい		ユーザー UID。
region	文字列	インスタンスリージョン	はい		インスタンスが存在するリージョン。
instance	文字列	インスタンス ID	はい		診断するインスタンスの ID を入力します。診断はこのインスタンス内部で開始されます。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
code	string	状態コード。コード == Success は、権限付与が成功したことを示します。その他の状態コードは、権限付与が失敗したことを示します。詳細なエラー情報については、メッセージフィールドを確認してください。	Success
data	object	返される結果。
task_id	string	診断タスクの ID。この ID を使用して GetDiagnosisResult 操作を呼び出し、診断結果をクエリできます。	ihqhAcrt
message	string	エラーメッセージ。コード == Success の場合、このフィールドは空です。それ以外の場合、このフィールドにはリクエストのエラーメッセージが含まれます。	SysomOpenAPIAssumeRoleException: EntityNotExist.Role ロールが存在しません: acs:ram::xxxxx:role/aliyunserviceroleforsysom
request_id	string	リクエスト ID。	43A910E9-A739-525E-855D-A32C257F1826

例

成功レスポンス

JSONJSON

{
  "code": "Success",
  "data": {
    "task_id": "ihqhAcrt"
  },
  "message": "SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom",
  "request_id": "43A910E9-A739-525E-855D-A32C257F1826"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。