すべてのプロダクト
Search

このプロダクト

    Simple Application Server:DescribeCloudAssistantAttributes

    ドキュメントセンター

    Simple Application Server:DescribeCloudAssistantAttributes

    最終更新日:Jan 16, 2026

    シンプルアプリケーションサーバーのコマンドアシスタント情報を照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    swas-open:DescribeCloudAssistantAttributes

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    指定されたシンプルアプリケーションサーバーのリージョン ID。 ListRegions 操作を呼び出して、最新のリージョンリストを照会できます。

    cn-hangzhou
    PageNumber

    integer

    任意

    ページ番号。

    ページは 1 から始まります。

    デフォルト値：1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。

    10
    InstanceIds

    array

    必須

    シンプルアプリケーションサーバーの ID。

    string

    任意

    シンプルアプリケーションサーバーの ID。

    ["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ

    RequestId

    string

    リクエスト ID。

    30637AD6-D977-4833-A54C-CC89483E****
    CloudAssistant

    array<object>

    コマンドアシスタント情報。

    object

    InstanceId

    string

    シンプルアプリケーションサーバーの ID。

    85dbe3e7cc7b49e1a3df4af3bfa4ebbf
    CloudAssistantStatus

    string

    コマンドアシスタントが実行中かどうかを示します。 有効な値は次のとおりです：

    true：過去 2 分以内にハートビートが検出されたことを示します。

    false：過去 2 分以内にハートビートが検出されなかったことを示します。

    true
    LastInvokedTime

    string

    コマンドが最後に実行された時間。

    2021-03-15T08:00:00Z

    CloudAssistantVersion

    string

    コマンドアシスタントエージェントのバージョン番号。 コマンドアシスタントエージェントがインストールされていないか、実行されていない場合は、Null が返されます。

    2.2.0.106

    ActiveTaskCount

    integer

    コマンドアシスタントのアクティブなタスクの数。

    0
    InvocationCount

    integer

    コマンドアシスタントで完了したタスクの数。

    4
    LastHeartbeatTime

    string

    コマンドアシスタントの最後のハートビートが検出された時間。 値は平均して 1 分ごとに更新されます。 間隔は 55、60、または 65 秒です。

    2021-03-15T09:00:00Z

    OSType

    string

    シンプルアプリケーションサーバーの OS タイプ。 有効な値は次のとおりです：

    • Windows

    • Linux

    • FreeBSD

    Linux
    SupportSessionManager

    boolean

    コマンドアシスタントがセッション管理をサポートしているかどうかを示します。サポートしていない場合、コマンドアシスタントエージェントのバージョンが古いため、最新バージョンへの更新を推奨します。

    セッション管理機能を使用するには、ご利用のコマンドアシスタントエージェントのバージョンが、次のいずれかの要件を満たしている必要があります：

    ご利用の Simple Application Server が Linux を実行している場合、サーバー上のコマンドアシスタントエージェントのバージョンは 2.2.3.189 以降である必要があります。ご利用の Simple Application Server が Windows を実行している場合、サーバー上のコマンドアシスタントエージェントのバージョンは 2.1.3.189 以降である必要があります。

    true
    TotalCount

    integer

    エントリの総数。

    4
    PageSize

    integer

    1 ページあたりのエントリ数。

    10
    PageNumber

    integer

    ページ番号。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "CloudAssistant": [
    {
      "InstanceId": "85dbe3e7cc7b49e1a3df4af3bfa4ebbf",
      "CloudAssistantStatus": "true",
      "LastInvokedTime": "2021-03-15T08:00:00Z\n",
      "CloudAssistantVersion": "2.2.0.106\n",
      "ActiveTaskCount": 0,
      "InvocationCount": 4,
      "LastHeartbeatTime": "2021-03-15T09:00:00Z\n",
      "OSType": "Linux",
      "SupportSessionManager": true
    }
  ],
  "TotalCount": 4,
  "PageSize": 10,
  "PageNumber": 1
}

    エラーコード

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

    変更履歴

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