API によるハイブリッドサーバーへの CloudMonitor エージェントデプロイ - Security Center - Alibaba Cloud - Security Center

操作説明

説明

インストールの前に、サーバー上の Security Center クライアントがオンラインであること、およびサーバーがネットワーク経由で 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-sas:InstallCloudMonitor

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ArgusVersion	string	必須	インストールする CloudMonitor エージェントのバージョン。最新の CloudMonitor エージェントバージョンはプラグイン概要から取得できます。	3.5.6
AgentAccessKey	string	任意	CloudMonitor エージェントのインストールに必要な AccessKey。 DescribeMonitoringAgentAccessKey 操作を呼び出してこのパラメーターを取得できます。説明このパラメーターは、Alibaba Cloud 以外のサーバーに CloudMonitor エージェントをインストールする場合にのみ必須です。	usY*****R_U
AgentSecretKey	string	任意	CloudMonitor エージェントのインストールに必要な AccessSecret。 DescribeMonitoringAgentAccessKey 操作を呼び出してこのパラメーターを取得できます。説明このパラメーターは、Alibaba Cloud 以外のサーバーに CloudMonitor エージェントをインストールする場合にのみ必須です。	UCxF2R1sIO90XlU9****
InstanceIdList	array	任意	CloudMonitor エージェントをインストールするサーバーのインスタンス ID のリスト。複数の ID はコンマ (,) で区切ります。
	string	任意	CloudMonitor エージェントをインストールするサーバーのインスタンス ID のリスト。複数の ID はコンマ (,) で区切ります。説明操作を成功させるには、InstanceIdList と UuidList のパラメーターのうち少なくとも 1 つを指定する必要があります。両方のパラメーターを指定した場合、CloudMonitor エージェントは 2 つのパラメーターで指定されたサーバーの UNION にインストールされます。	[VMware-564d4e22ce6d9207-c97c8af3a448**,VMware-564d4a9574e0b8ab-843ba10d8b0c,VMware-564dbb7fddaf27ce-629271166745**]
UuidList	array	任意	CloudMonitor エージェントをインストールするサーバーの UUID のリスト。複数の UUID はコンマ (,) で区切ります。
	string	任意	CloudMonitor エージェントをインストールするサーバーの UUID のリスト。複数の UUID はコンマ (,) で区切ります。説明操作を成功させるには、InstanceIdList と UuidList のパラメーターのうち少なくとも 1 つを指定する必要があります。両方のパラメーターを指定した場合、CloudMonitor エージェントは 2 つのパラメーターで指定されたサーバーの UNION にインストールされます。	[inet-c669e5d9-0adf-4d71-a9ce-65ed2730**,inet-2e87cce8-763d-4dcd-b39f-d592e1b0,inet-7c676676-06fa-442e-90fb-b802e5d6**]

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。Alibaba Cloud はリクエストごとに一意の ID を生成します。この ID を使用して問題をトラブルシューティングできます。	F92AFB96-FACC-57E7-928E-678D04B94CAE
Success	boolean	操作が成功したかどうかを示します。有効な値: true: 操作が成功しました。 false: 操作が失敗しました。	false
Code	string	操作が失敗した場合に返されるエラーコード。	IllegalParam
Message	string	エラーコードの詳細情報。	There was an error with your request.
HttpStatusCode	integer	HTTP 状態コード。	400

例

成功レスポンス

JSONJSON

{
  "RequestId": "F92AFB96-FACC-57E7-928E-678D04B94CAE",
  "Success": false,
  "Code": "IllegalParam",
  "Message": "There was an error with your request.",
  "HttpStatusCode": 400
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ConsoleError	The error message is %s %s.
400	IllegalParam	Illegal param
400	MachineNotExist	The machine does not exist.
400	AgentNotOnline	The agent not online.
400	InvalidParam	There was an error with your request.
500	ServerError	ServerError
403	NoPermission	caller has no permission

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

変更履歴

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