GetRuntimeChannel - App Streaming - Alibaba Cloud Documentation Center

Queries the third-party channel configurations of an Agent runtime.

Operation description

You can query the third-party channel configuration status of Agent runtimes such as JVS Computer, OpenClaw, and Hermes Agent in the Wuying Agent Management Center.

Make sure that you are familiar with the operations and usage of the Wuying Agent Management Center before you call this operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

appstreaming:GetRuntimeChannel

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RuntimeType	string	Yes	The type of the Agent runtime. Valid values: CloudDesktop : cloud computer.	CloudDesktop
RuntimeId	string	Yes	The Agent runtime ID. The ID mappings are as follows: JVS Computer: the JVS Computer ID, in the format of jvs-xxxx. OpenClaw: the cloud computer ID, in the format of ecd-xxxx. Hermes Agent: the Hermes Agent ID, in the format of jvs-xxxx.	jvs-xxxx
AgentProvider	string	Yes	The Agent provider. JVS Computer: set to OpenClaw. OpenClaw: set to OpenClaw. Hermes Agent: set to HermesAgent. Valid values: OpenClaw : OpenClaw HermesAgent : Hermes Agent	OpenClaw
AgentPlatform	string	No	The Agent platform. Valid values: ENTERPRISE : OpenClaw ENTERPRISE_JVS : JVS Computer、Hermes Agent	ENTERPRISE
IncludeRiskInfo	boolean	No	Specifies whether to include risk information. Valid values: true : yes. false : no.	true

Response elements

Element	Type	Description	Example
	object	The request result.
Data	array<object>	The returned object.
	object	The returned data object.
Code	string	The channel code. Valid values: dingtalk-connector : DingTalk. wechat : WeChat. feishu : Lark. qqbot : QQ wecom : WeCom.	dingtalk-connector
Status	string	The configuration status. Valid values: Unconfigured : Unconfigured. Configured : Configured.	Configured
Config	string	The channel configuration JSON string. Currently, only the simple configuration mode is supported. You must pass AppKey and AppSecret.	{ "appKey": "abc", "appSecret": "efg" }
ConfigMode	string	The configuration mode. Valid values: Custom : Custom configuration mode. Simple : Simple configuration mode.	Simple
AvatarUrl	string	The channel avatar URL.	https://test.com/test.jpg
RiskType	string	The risk type. This parameter is returned only when includeRiskInfo=true. Valid values: UserAdded : A channel added by the user but not configured by the administrator. UserRemoved : A channel configured by the administrator but removed by the user. Normal : Consistent with the administrator configuration (no risk).	Normal
QrCodeStatus	string	The QR code configuration status. This parameter is returned only when the status is not in a desired state.	https://q.qq.com/qqbot/openclaw/entity-picker.html?session_id=c0882266-77c0-4094-af93-442*****2a58
QrCodeNotifyUrl	string	The QR code configuration notification page URL. This parameter is returned only for the ENTERPRISE or ENTERPRISE_JVS platform.	https://eds.console.alibabacloud.com/public/scan-pair?taskId=e7eb5d86-1b94-4d58-****-3b78b01df99e&code=dingtalk-connector&region=cn-shanghai
ChannelType	string	The channel type. Valid values: Custom : Custom channel. System : System-supported channel.	System
TotalCount	integer	The total number of entries returned.	6
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

{
  "Data": [
    {
      "Code": "dingtalk-connector",
      "Status": "Configured",
      "Config": "{\n    \"appKey\": \"abc\",\n    \"appSecret\": \"efg\"\n}",
      "ConfigMode": "Simple",
      "AvatarUrl": "https://test.com/test.jpg",
      "RiskType": "Normal",
      "QrCodeStatus": "https://q.qq.com/qqbot/openclaw/entity-picker.html?session_id=c0882266-77c0-4094-af93-442*****2a58",
      "QrCodeNotifyUrl": "https://eds.console.alibabacloud.com/public/scan-pair?taskId=e7eb5d86-1b94-4d58-****-3b78b01df99e&code=dingtalk-connector&region=cn-shanghai",
      "ChannelType": "System"
    }
  ],
  "TotalCount": 6,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.