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

指定されたインスタンスにエージェントをインストールします。

操作説明

エージェントをインストールするこの操作の呼び出しは非同期です。この操作を呼び出すと、task_id が返されます。この ID を使用して GetAgentTask 操作を呼び出し、タスク実行のステータスを照会できます。

今すぐお試しください

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

none

*すべてのリソース。

*

なし

リクエスト構文

POST /api/v1/am/agent/install_agent HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	リクエストボディ。
agent_id	string	必須	インストールするコンポーネントの ID。	74a86327-3170-412c-8e67-da3389ec56a9
agent_version	string	必須	インストールするコンポーネントのバージョン。	3.4.0-1
install_type	string	必須	インストールタイプ。有効な値: InstallAndUpgrade: コンポーネントが存在しない場合はインストールし、存在する場合は更新します。 OnlyInstallNotHasAgent: コンポーネントが存在しない場合はインストールし、存在する場合は操作しません。 OnlyUpgradeHasAgent: コンポーネントが存在しない場合は操作せず、存在する場合は更新します。 OnlyInstallWithoutStart: サービスを開始せずにコンポーネントのみをインストールします。	InstallAndUpgrade
instances	array<object>	必須	コンポーネントをインストールするインスタンスのリスト。
	object	必須	インスタンス情報。
instance	string	必須	インスタンスの ID。	i-wz9b9vucz1iubsz8sjqo
region	string	必須	リージョンの ID。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエストの ID。エンドツーエンドの診断に使用できます。	1D8887FC-4BDB-5A1C-AB19-135C29A9E481
code	string	状態コード。 code == Success の場合、権限付与が成功したことを示します。その他の状態コードは、権限付与が失敗したことを示します。詳細なエラー情報については、メッセージフィールドを確認してください。	Success
data	object	応答データ。
task_id	string	タスクの ID。このタスク ID を使用して GetAgentTask 操作を呼び出し、タスク実行のステータスを照会できます。	26b3cd97389c43dcad6bc4901c36fcec
message	string	エラーメッセージ。コード == Success の場合、このフィールドは空です。それ以外の場合、このフィールドにはリクエストのエラーメッセージが含まれます。	""

例

成功レスポンス

JSONJSON

{
  "RequestId": "1D8887FC-4BDB-5A1C-AB19-135C29A9E481",
  "code": "Success",
  "data": {
    "task_id": "26b3cd97389c43dcad6bc4901c36fcec"
  },
  "message": "\"\""
}

エラーコード

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.
400	SysomOpenAPI.ServiceRoleNotExists	Service role does not exist, please init the sysom service first.
400	SysomOpenAPI.RegionNotSupport	Region not supported.

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

変更履歴

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