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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

appstreaming:ListDesktopAgentRuntime

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AgentProvider	string	必須	エージェントプロバイダー名。	OpenClaw
ModelTemplateId	string	任意	エージェントプラットフォーム。列挙値: ENTERPRISE : Enterprise Edition。 ENTERPRISE_JVS : Enterprise Edition JVS Computer および Enterprise Edition Hermes Agent。	ENTERPRISE
DesktopIds	array	任意	エージェントプラットフォームのリスト。AgentPlatform も指定されている場合、AgentPlatform が優先され、このリストは無視されます。	ENTERPRISE
	string	必須	エージェントプラットフォーム。	ecd-xxxx。
AgentTemplateIds	array	任意	エージェントプロバイダーのリスト。AgentProvider も指定されている場合、AgentProvider が優先され、このリストは無視されます。	OpenClaw
	string	任意	エージェントプロバイダー名。
ResourceIds	array	任意	モデルグループ ID。	mt-xxxx
	string	任意	リソースの ID。	ecd-xxxx。
DesktopStatuses	array	任意	エージェントランタイム ID のリスト。	jvs-xxxxx
	string	必須	エージェントランタイム ID。ID のマッピングは以下のとおりです: JVS Computer: JVS Computer ID、フォーマットは jvs-xxxx です。 OpenClaw: クラウドデスクトップ ID、フォーマットは ecd-xxxx です。 Hermes Agent: Hermes Agent ID、フォーマットは jvs-xxxx です。列挙値: Stopped : 停止。 Starting : 起動中。 Rebuilding : 再構築中。 Running : 実行中。 Stopping : 停止中。 Expired : 期限切れ。 Deleted : 削除済み。 Pending : 保留中。	ecd-xxxx
AuthUsers	array	任意	エージェントテンプレート ID のリスト。すべての有効なテンプレートが割り当てられている場合にのみ一致します。	at-xxxxx
	string	必須	エージェントテンプレート ID。	user-001
AgentInstanceVersions	array	任意	リソース ID のリスト (基盤となる実際のリソース ID)。	ecd-xxxxx
	string	必須	リソース ID。	ecd-xxxx
AgentInstanceStatuses	array	任意	クラウドデスクトップステータスのリスト。	Running
	string	必須	クラウドデスクトップステータス。列挙値: Undeployed : 未デプロイ。 Deploying : デプロイ中。 Stopped : 停止済み。 Starting : 起動中。 Running : 実行中。 Stopping : 停止中。 Deleted : 削除済み。 Deployed : デプロイ済み。 Unavailable : 利用不可。 Rebuilding : 再構築中。 Expired : 期限切れ。 Pending : 保留中。	Running
DeploymentSource	string	任意	許可されるユーザーのリスト。列挙値: User : ユーザーによる Deployment。 Admin : 管理者による Deployment。	user001
ModelConfigure	boolean	任意	エージェントインスタンスバージョンのリスト。列挙値: true : はい。 false : no.	OpenClaw 2026.4.15
ChannelConfigure	boolean	任意	エージェントインスタンスステータスのリスト。列挙値: true : はい。 false : no.	Running
ResourceGroupId	string	任意	Deployment ソース。列挙値: User : ユーザーによる Deployment。 Admin : 管理者による Deployment。	Admin
DesktopNames	array	任意	モデルが構成されているかどうかを指定します。列挙値: true : はい。 false : no.	true
	string	必須	エージェントランタイムの名前。	Agent-001
BizType	integer	任意	サードパーティチャンネルが構成されているかどうかを指定します。列挙値: 1 : 企業。 true : はい。 false : no.	true
AgentPlatform	string	任意	リソースグループ ID。列挙値: ENTERPRISE : 企業。 ENTERPRISE_JVS : Enterprise JVS Computer または Enterprise Hermes Agent。	rg-xxxx
HasAuthUser	boolean	任意	エージェントランタイム名のリスト。列挙値: true : はい。 false : false。	Desktop001
IncludeRiskInfo	boolean	任意	ビジネスタイプ。列挙値: true : はい。 false : no. 1 : Enterprise Edition。	1
HasRisk	boolean	任意	権限付与用の許可されるユーザーが存在するかどうかを示します。列挙値: true : はい。 false : false。	true
ManagementStatus	string	任意	リスク情報をクエリして返すかどうかを指定します。デフォルト値: false。true にセットすると、応答に RiskInfo フィールドが含まれ、HasRisk フィルターが効果を発揮します。フォーマット。列挙値: true : はい。 false : no.	true
AgentImOnlineStatus	string	任意	リスクが存在するかどうかを指定します。このパラメーターは、リスクの有無に基づいてクラウドデスクトップをフィルター処理するために使用され、IncludeRiskInfo が true に設定されている場合にのみ有効です。このパラメーターを true に設定すると、リスクのあるレコードのみが返されます。このパラメーターを false に設定すると、リスクのないレコードのみが返されます。このパラメーターを指定しない場合、フィルター処理は適用されません。列挙値: true : はい。 false : no.	true
OfficeSiteId	string	任意	管理ステータスフィルター (Hibernated など)。	Hibernated
BizRegionId	string	任意	エージェント IM オンラインステータスフィルター。	Online
PageSize	integer	任意	オフィスネットワーク ID。	cn-hangzhou+dir-xxxx
PageNumber	integer	任意	ビジネスリージョン ID。	cn-hangzhou
		任意	1 ページあたりのエントリ数。	20
		任意	ページ番号。1 から開始します。値 0 と 1 は同じ結果を返します。	1

レスポンスフィールド

フィールド	型	説明	例
	object	クエリ結果。
PageSize	integer	1 ページあたりのエントリ数。	20
PageNumber	integer	ページ番号。	1
Data	array<object>	返された結果オブジェクトのリスト。
	array<object>	返された結果オブジェクト。
DesktopId	string	エージェントランタイムの ID。	ecd-xxxx
ResourceId	string	リソース ID。クラウドデスクトップの ID です。	ecd-xxxx
RegionId	string	リージョン ID。	cn-hangzhou
RegionLocation	string	リージョン位置 (中国本土または中国以外)。列挙値: Mainland : 中国本土。 Overseas : 中国以外 (中国香港を含む)。	Mainland
DesktopName	string	エージェントランタイム名。	Agent-001
DesktopStatus	string	クラウドデスクトップステータス。列挙値: Stopped : 停止済み。 Starting : 起動中。 Rebuilding : 再構築中。 Running : 実行中。 Stopping : 停止中。 Expired : 期限切れ。 Deleted : 削除済み。 Pending : 保留中。	Running
OsType	string	オペレーティングシステムのタイプ。列挙値: Linux : Linux。 Windows : Windows。	Windows
AuthUsers	array	許可されるユーザーのリスト。
	string	許可されるユーザー。	user-001
HasAuthUser	boolean	権限付与された許可されるユーザーが存在するかどうかを示します。列挙値: true : はい。 false : no.	true
AgentInstanceInfoList	array<object>	エージェントインスタンス情報のフォーマットのリスト。
	object	エージェントインスタンス情報のフォーマットオブジェクト。
AgentPlatform	string
AgentProvider	string
AgentInstanceVersion	string	エージェントインスタンスのバージョン。	2026.3.13
AgentInstanceStatus	string	エージェントインスタンスステータス。列挙値: Undeployed : 未デプロイ。 Deploying : デプロイ中。 Stopped : 停止。 Starting : 起動中。 Running : 実行中。 Stopping : 停止中。 Deleted : 削除済み。 Deployed : デプロイ済み。 Unavailable : 利用不可。	Running。
ModelConfigure	boolean	エージェントインスタンスにモデルが設定されているかどうかを示します。列挙値: true : はい。 false : no.	true。
ChannelConfigure	boolean	エージェントインスタンスにサードパーティチャンネルが設定されているかどうかを示します。列挙値: true : はい。 false : no.	true。
ChannelConfiguredList	array	エージェントインスタンスに設定されているサードパーティチャンネルのリスト。
	string	エージェントインスタンスに設定されているサードパーティチャンネル。列挙値: dingtalk-connector : DingTalk。 wechat : WeChat。 feishu : Feishu。 qqbot : QQ wecom : WeCom。	dingtalk-connector。
DeploymentSource	string	Deployment のソース。列挙値: User : ユーザーによる Deployment。 Admin : 管理者による Deployment。	Admin。
ModelTemplateId	string	設定されているモデルグループの ID。	mt-xxxx。
ModelConfigure	boolean	エージェントランタイムにモデルが設定されているかどうかを示します。列挙値: true : はい。 false : false。	true
ModelTemplateId	string	アクティブなモデルテンプレートの ID。このパラメーターは、modelConfigure が true に設定されている場合にのみ返されます。	mt-xxxx
ModelTemplateName	string	アクティブなモデルテンプレート名。このパラメーターは、modelConfigure が true に設定されている場合にのみ返されます。	モデルテンプレート-001
ChannelConfigure	boolean	エージェントランタイムにサードパーティチャンネルが設定されているかどうかを示します。列挙値: true : はい。 false : no.	true
ChannelConfiguredList	array	エージェントランタイムに設定されたサードパーティチャンネルのリスト。
	string	エージェントランタイムに設定されたサードパーティチャンネル。列挙値: dingtalk-connector : DingTalk。 wechat : WeChat。 feishu : Lark。 qqbot : QQ wecom : WeCom。	dingtalk-connector
QrCodeConfiguringList	array	QR コード設定中のチャンネルコードのリスト。
	string	QR コード設定中のチャンネルコード。	wechat
AgentImInfo	object	エージェント IM 情報。
AgentImStatus	string	エージェント IM のステータス。列挙値: Enabled : 有効。 Disabled : 無効。	Enabled。
CloudSpaceStatus	string	CloudSpace のステータス。列挙値: Enabled : 有効。 Disabled : 無効。	Enabled。
AgentImOnlineStatus	string
RiskInfo	object	リスク情報。このパラメーターは、リクエストパラメーター IncludeRiskInfo が true に設定されている場合にのみ返されます。それ以外の場合は null が返されます。
ModelModified	boolean	モデル構成が変更済みかどうか (管理者分散の構成と不一致であるかどうか) を示します。列挙値: true : はい。 false : no.	true。
ChannelModified	boolean	サードパーティチャンネル構成が変更済みかどうか (管理者分散の構成と不一致であるかどうか) を示します。列挙値: true : はい。 false : no.	true。
AgentUninstalled	boolean	エージェントがアンインストールされているかどうかを示します。列挙値: true : はい。 false : no.	true。
ResourceGroup	object	リソースグループ情報。
ResourceGroupId	string	リソースグループの ID。	rg-xxxx。
ResourceGroupName	string	リソースグループの名前。	リソースグループ-001
ManagementStatuses	array	managementStatus 複合値から解析された管理ステータスのリスト。
	string
TotalCount	integer	返されるエントリの総数。	30
RequestId	string	リクエストの ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

例

成功レスポンス

JSONJSON

{
  "PageSize": 20,
  "PageNumber": 1,
  "Data": [
    {
      "DesktopId": "ecd-xxxx。",
      "ResourceId": "ecd-xxxx。",
      "RegionId": "cn-hangzhou。",
      "RegionLocation": "Mainland。",
      "DesktopName": "Agent-001",
      "DesktopStatus": "Running。",
      "OsType": "Windows。",
      "AuthUsers": [
        "user-001"
      ],
      "HasAuthUser": true,
      "AgentInstanceInfoList": [
        {
          "AgentPlatform": "",
          "AgentProvider": "",
          "AgentInstanceVersion": "2026.3.13",
          "AgentInstanceStatus": "Running。",
          "ModelConfigure": true,
          "ChannelConfigure": true,
          "ChannelConfiguredList": [
            "dingtalk-connector。"
          ],
          "DeploymentSource": "Admin。",
          "ModelTemplateId": "mt-xxxx。"
        }
      ],
      "ModelConfigure": true,
      "ModelTemplateId": "mt-xxxx。",
      "ModelTemplateName": "モデルテンプレート-001",
      "ChannelConfigure": true,
      "ChannelConfiguredList": [
        "dingtalk-connector。"
      ],
      "QrCodeConfiguringList": [
        "wechat。"
      ],
      "AgentImInfo": {
        "AgentImStatus": "Enabled。",
        "CloudSpaceStatus": "Enabled。",
        "AgentImOnlineStatus": ""
      },
      "RiskInfo": {
        "ModelModified": true,
        "ChannelModified": true,
        "AgentUninstalled": true
      },
      "ResourceGroup": {
        "ResourceGroupId": "rg-xxxx。",
        "ResourceGroupName": "リソースグループ-001"
      },
      "ManagementStatuses": [
        ""
      ]
    }
  ],
  "TotalCount": 30,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

エラーコード

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

変更履歴

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