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

エージェントインストールタスクの実行ステータスを取得します。

今すぐお試しください

この 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:GetAgentTask

get

*すべてのリソース。

*

なし

リクエスト構文

GET /api/v1/am/agent/get_agent_task HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
task_id	string	任意	タスク ID。	42172120177e4b3abd6fabb3a6b5e2dd

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。エンドツーエンドの診断に使用できます。	2E75336A-0DB2-5263-B201-A6488EC97B50
code	string	状態コード。コード == Success は、権限付与が成功したことを示します。その他の状態コードは、権限付与が失敗したことを示します。権限付与が失敗した場合は、メッセージフィールドで詳細なエラー情報を確認してください。	Success
data	object	返されるデータ。
jobs	array<object>	サブタスクのリスト。
	object	サブタスクの詳細。
error	string	タスクが失敗した場合、このフィールドには失敗の原因が含まれます。	Deprecated (misused)
errorCode	string	サブタスク失敗のエラーコード。有効な値: Empty: タスクは正常に実行されています。 INSTANCE_NOT_SUPPORTED: インスタンスタイプはサポートされていません。 INSTANCE_NOT_EXISTS: インスタンスが存在しません。 INSTANCE_RELEASED: インスタンスはリリースされています。 INSTANCE_NOT_RUNNING: インスタンスは実行されていません。 INSTANCE_NOT_OWNED: インスタンスは現在のアカウントに属していません。 AGENT_ALREADY_INSTALLED: エージェントはすでにインストールされています。 AGENT_NOT_INSTALLED: エージェントはインストールされていません。 AGENT_SAME_VERSION: バージョンは同じです。 HAS_RUNNING_JOB: 実行中のタスクがすでに存在します。 RPM_LOCK_HELD: RPM ロックが保持されています。 DISK_SPACE_INSUFFICIENT: ディスク領域が不足しています。 NODE_LOAD_HIGH: ノードのロードが高くなっています。 COMMAND_FAILED: コマンドの実行に失敗しました。 CLIENT_NOT_RUNNING: クラウドアシスタントエージェントが実行されていません。 CLIENT_NOT_RESPONSE: クラウドアシスタントエージェントが応答していません。 DELIVERY_TIMEOUT: コマンドの配信がタイムアウトしました。 EXECUTION_TIMEOUT: コマンドの実行がタイムアウトしました。 TASK_CONCURRENCY_LIMIT: タスクの同時実行数の上限に達しました。	DISK_SPACE_INSUFFICIENT
errorMessage	string	サブタスクの失敗原因の詳細な説明。有効な値: インスタンスタイプはサポートされていません。インスタンスが存在しません。インスタンスはリリースされています。インスタンスは実行されていません。インスタンスは現在のアカウントに属していません。エージェントはすでにインストールされています。エージェントはインストールされていません。エージェントのバージョンは同じです。スペックアップは必須ではありません。実行中のタスクが存在します。後でもう一度お試しください。 RPM ロックが保持されています。後でもう一度お試しください。ディスク領域が不足しています。ノードのロードが高すぎます。後でもう一度お試しください。コマンドの実行に失敗しました。後でもう一度お試しください。クラウドアシスタントエージェントが実行されていません。クラウドアシスタントエージェントが応答していません。コマンドの配信がタイムアウトしました。コマンドの実行がタイムアウトしました。タスクの同時実行数の上限に達しました。	ディスク領域が不足しています
instance	string	インスタンス ID。	i-2zehme0rs1tc090fdl3n
params	any	サブタスクのパラメーター。	{ "エージェントバージョン": "3.5.0-beta", "opt": "install", "エージェントID": "74a86327-3170-412c-8fd67-da3389ec56a9", "install_type": "InstallAndUpgrade" }
region	string	リージョン ID。	cn-hangzhou
result	string	サブタスクの実行結果。	Deprecated (misused)
status	string	サブタスクのステータス。有効な値: Created: 作成済み。 Running: 実行中。 Success: タスクは成功しました。 Fail: タスクが失敗しました。	Running
status	string
task_id	string	タスク ID。	c41d8e3506224184a714682fea86d22d
message	string	エラーメッセージ。コード == Success の場合、このフィールドは空です。それ以外の場合、このフィールドにはリクエストのエラーメッセージが含まれます。	SysomOpenAPIException: SysomOpenAPI.InvalidParameter 有効ではないパラメーター、json 文字列または dict である必要があります

例

成功レスポンス

JSONJSON

{
  "RequestId": "2E75336A-0DB2-5263-B201-A6488EC97B50",
  "code": "Success",
  "data": {
    "jobs": [
      {
        "error": "Deprecated (misused)",
        "errorCode": "DISK_SPACE_INSUFFICIENT",
        "errorMessage": "ディスク領域が不足しています。",
        "instance": "i-2zehme0rs1tc090fdl3n",
        "params": "{\n    \"agent_version\": \"3.5.0-beta\",\n    \"opt\": \"install\",\n    \"agent_id\": \"74a86327-3170-412c-8fd67-da3389ec56a9\",\n    \"install_type\": \"InstallAndUpgrade\"\n}",
        "region": "cn-hangzhou",
        "result": "Deprecated (misused)",
        "status": "Running"
      }
    ],
    "status": "",
    "task_id": "c41d8e3506224184a714682fea86d22d"
  },
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter 無効なパラメーターです。JSON 文字列または dict である必要があります。"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	SysomOpenAPI.AgentNotExists	Agent not exists.
400	SysomOpenAPI.AgentTaskNotFound	Agent task not found.
400	SysomOpenAPI.AgentVersionNotExists	Agent version not exists.
400	SysomOpenAPI.InstanceNotExists	Instance not exists.
400	SysomOpenAPI.InvalidParameter	Invalid parameters passed when calling the interface.
400	SysomOpenAPI.MissingParameter	Missing parameters.
400	SysomOpenAPI.NoAgentInstalled	No SysOM Agent version available.
400	SysomOpenAPI.NotAuthorizedInstance	Instance not authorized.
400	SysomOpenAPI.NotOwnInstance	Not own current instance.
400	SysomOpenAPI.NotOwnTask	Diagnosis result does not belong to the current account.
400	SysomOpenAPI.NotSupportedAgentVersion	Unsupported sysom agent version.
400	SysomOpenAPI.ServerError	Server error, please correct the code according to the error message.

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

変更履歴

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