DescribeCloudAssistantStatus - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

インスタンスにクラウドアシスタントエージェントがインストールされているかどうかを照会します。クラウドアシスタントエージェントがインストールされている場合、実行されたクラウドアシスタントコマンドの総数、実行中のクラウドアシスタントコマンドの数、およびクラウドアシスタントコマンドが最後に実行された時刻を照会します。

操作説明

注意事項

インスタンス、特に新しいインスタンスでコマンドを実行したり、ファイルを送信したりする前に、この操作を呼び出してインスタンスのクラウドアシスタントのステータスを照会し、戻り値の CloudAssistantStatus を確認することを推奨します。戻り値が true の場合にのみ、インスタンスでコマンドを実行するか、ファイルを送信してください。
ページングクエリ中に DescribeCloudAssistantStatus 操作を呼び出して結果の最初のページを取得する場合、MaxResults を設定して、呼び出しで返されるエントリの最大数を指定します。戻り値の NextToken は、次の呼び出しで結果の新しいページを取得するために使用できるページネーショントークンです。DescribeCloudAssistantStatus 操作を呼び出して結果の新しいページを取得する場合、NextToken を前の呼び出しで返された NextToken の値に設定し、MaxResults を設定してこの呼び出しで返されるエントリの最大数を指定します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeCloudAssistantStatus

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
RegionId	string	必須	インスタンスのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
OSType	string	任意	インスタンスのオペレーティングシステムタイプ。有効な値： Windows Linux FreeBSD	Windows
PageNumber	integer	任意	説明このパラメーターは将来削除される予定です。ページングクエリには NextToken と MaxResults を使用することを推奨します。	1
PageSize	integer	任意	説明このパラメーターは将来削除される予定です。ページングクエリには NextToken と MaxResults を使用することを推奨します。	10
MaxResults	integer	任意	1ページあたりの最大エントリ数。InstanceId を指定した場合、このパラメーターは無効になります。有効な値：1～50。デフォルト値：10。	10
NextToken	string	任意	次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。前のクエリから取得したトークンを NextToken の値として指定する必要があります。	AAAAAdDWBF2
InstanceId	array	任意	インスタンス ID。	i-bp1iudwa5b1tqa****
	string	任意	インスタンス N の ID。インスタンスは Elastic Compute Service (ECS) インスタンスまたはホストインスタンスです。1 回のリクエストで最大 100 個のインスタンス ID を指定できます。	i-bp1iudwa5b1tqa****

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	1ページあたりのエントリ数。	1
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	ページ番号。	1
TotalCount	integer	インスタンスの総数。	1
NextToken	string	ページネーショントークン。次のリクエストで結果の新しいページを取得するために使用できます。	AAAAAdDWBF2
InstanceCloudAssistantStatusSet	object
InstanceCloudAssistantStatus	array<object>	インスタンスへのクラウドアシスタントのインストール状況に関する詳細。
	object
CloudAssistantStatus	string	インスタンスでクラウドアシスタントが実行中かどうかを示します。有効な値： true：過去 2 分以内にハートビートが検出されました。 false：過去 2 分以内にハートビートが検出されませんでした。	true
LastInvokedTime	string	コマンドが最後に実行された時刻。	2021-03-15T08:00:00Z
CloudAssistantVersion	string	クラウドアシスタントエージェントのバージョン番号。クラウドアシスタントエージェントがインストールされていないか、インスタンスで実行されていない場合、このパラメーターは空になります。	2.2.0.106
ActiveTaskCount	integer	クラウドアシスタントがインスタンスで実行していたタスクの数。	0
InvocationCount	integer	クラウドアシスタントがインスタンスで完了したタスクの数。	2
InstanceId	string	インスタンスの ID。	i-bp1iudwa5b1tqa****
LastHeartbeatTime	string	クラウドアシスタントの最後のハートビート時間。値は平均して 1 分ごとに更新されます。間隔は 55、60、または 65 秒です。	2021-03-15T09:00:00Z
OSType	string	インスタンスのオペレーティングシステムタイプ。有効な値： Windows Linux FreeBSD	Linux
SupportSessionManager	boolean	インスタンスでクラウドアシスタントがセッションマネージャーをサポートしているかどうかを示します。セッションマネージャーがサポートされていない場合、クラウドアシスタントエージェントのバージョンは古くなっています。クラウドアシスタントエージェントを最新バージョンに更新してください。セッションマネージャーをサポートするには、クラウドアシスタントエージェントのバージョンが次のバージョンより前であってはなりません： Linux：2.2.3.189 Windows：2.1.3.189	true

例

成功レスポンス

JSONJSON

{
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 1,
  "NextToken": "AAAAAdDWBF2",
  "InstanceCloudAssistantStatusSet": {
    "InstanceCloudAssistantStatus": [
      {
        "CloudAssistantStatus": "true",
        "LastInvokedTime": "2021-03-15T08:00:00Z",
        "CloudAssistantVersion": "2.2.0.106",
        "ActiveTaskCount": 0,
        "InvocationCount": 2,
        "InstanceId": "i-bp1iudwa5b1tqa****",
        "LastHeartbeatTime": "2021-03-15T09:00:00Z",
        "OSType": "Linux",
        "SupportSessionManager": true
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	RegionId.ApiNotSupported	The api is not supported in this region.
400	MissingParam.InstanceId	The parameter instanceId is missing or empty.
400	InvalidParam.PageSize	The specified parameter is invalid.
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.
500	InternalError.Dispatch	An error occurred when you dispatched the request.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.
403	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.
403	Operation.Forbidden	The operation is not permitted.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidInstance.NotFound	The specified instance does not exist.

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

変更履歴

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