API overview
Updated at:
API standards and multilingual preset SDKs
The OpenAPI of this product (appstream-center/2021-09-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Cloud browser
|
API |
Title |
Description |
| CreateBrowserInstanceGroup | Create a cloud browser group | Creates a cloud browser group that is billed by monthly active users (MAU). |
| ModifyBrowserInstanceGroup | Modify a cloud browser | Modifies the attributes of a Wuying Cloud Browser. |
Agent management
|
API |
Title |
Description |
| Agent runtime management | Agent runtime management | |
| ListDesktopAgentRuntime | Query agent runtime list | Queries the list of desktop agent runtimes. |
| Agent model management | Agent model management | |
| GetRuntimeModelConfig | Query model configuration of an agent runtime | Queries the model configuration details of a cloud computer. |
| ConfigRuntimeModelTemplate | Configure model groups for agent runtime resources | Configures model groups for Agent runtime resources. |
| RemoveRuntimeModelTemplate | Remove a model group from an agent runtime resource | Removes a model group from an Agent runtime resource. |
| ListModelTemplateResourceGroup | Query resource groups associated with a model group | Queries the list of resource groups associated with a model group. |
| ConfigResourceGroupModelTemplate | Configure model group for a resource group | Configures the model group for a resource group. |
| RemoveResourceGroupModelTemplate | Remove model groups from a resource group | Removes model groups from a resource group. |
| Agent channel management | Agent channel management | |
| GetRuntimeChannel | Query third-party channel configurations of an agent runtime | Queries the third-party channel configurations of an Agent runtime. |
| ConfigRuntimeChannel | Configure a third-party channel for agent runtime | Configures a third-party channel for Agent runtime. |
| RemoveRuntimeChannel | Remove third-party channel configuration from agent runtime | Removes a third-party channel configuration from the Agent runtime. |
| Model group management | Model group management | |
| CreateModelTemplate | Create a model group | Creates a model template. |
| UpdateModelTemplate | Update a model group | Updates a model template. |
| DeleteModelTemplate | Delete a model group | Deletes a model template. |
| ListModelTemplates | Query model group list | Queries a list of model templates. |
| CreateModelProviderTemplate | Create a model provider template | Creates a model provider template for model creation. |
| UpdateModelProviderTemplate | Update model provider template | Updates a model provider template. |
| DeleteModelProviderTemplate | Delete a model provider template | Deletes a model provider template. |
| GetModelProviderTemplate | Query model provider template details | Queries the details of a model provider template. |
| ListModelProviderTemplates | Query model provider templates | Queries the list of model provider templates. |
| BatchCreateLlmTemplates | Batch create model templates | Creates LLM templates in batches. |
| DeleteLlmTemplate | Delete a model template | Deletes an LLM template. |
| ListLlmTemplates | Query model template list | Queries the list of LLM templates. |
Region
|
API |
Title |
Description |
| ListRegions | Query supported regions | Queries the regions supported by WUYING Cloud Application. |
| ListZones | Query available zones | Queries the list of available zone IDs for a specified region, product type, and operating system type. |
Resource
|
API |
Title |
Description |
| ListNodes | Query resource node list | Queries the list of resource nodes. |
| ModifyNodePoolAmount | Modify node specifications in a resource node pool | Upgrades the number of nodes in a subscription delivery group. |
| ListNodeInstanceType | Query resource specifications | Queries the resource specifications available for selection when creating a delivery group. |
| GetResourcePrice | Query resource price | Queries the price information of a resource. |
| GetResourceRenewPrice | Query resource renewal price | Queries the renewal price of WUYING Cloud Application resources. |
Image
|
API |
Title |
Description |
| ListImage | Query image information | Queries image information. |
| CreateImageByInstance | Create a custom image from an instance | Creates a custom image from a deployed WUYING instance. You can use the custom image to quickly create more WUYING instances with the same configurations, without having to repeatedly configure the instance environment each time. |
| StartTaskForDistributeImage | Initiate image cross-region copy task | Initiates a task to copy an image to other regions. |
| DeleteImage | Delete a custom image | Deletes a custom WUYING image. |
Delivery group
|
API |
Title |
Description |
| CreateAppInstanceGroup | Create a delivery group | Creates a delivery group. |
| GetAppInstanceGroup | Query the details of a specified delivery group | Queries the details of a specified delivery group. |
| ListAppInstanceGroup | Query details of multiple delivery groups | Queries the details of multiple delivery groups. This operation queries all delivery groups that meet the specified conditions instead of a specific delivery group. |
| PageListAppInstanceGroupUser | Query allocated users of a delivery group with paging | Queries the allocated users added to a delivery group by paging. |
| RenewAppInstanceGroup | Renew a delivery group | Renews a delivery group. |
| UpdateAppInstanceGroupImage | Update delivery group image | Updates the image of a delivery group. |
| ModifyAppInstanceGroupAttribute | Modify General Policy of a delivery group | Modifies the General Policy of a delivery group, including the number of concurrent sessions and the session retention duration after disconnection. |
| ModifyNodePoolAttribute | Modify delivery group elastic mode | Modifies the elastic mode of a delivery group, including fixed quantity (no elastic scaling), scheduled scaling, and automatic scaling. |
| AuthorizeInstanceGroup | Add or remove assigned users for a delivery group | Adds or removes assigned users for a delivery group. Only users added as assigned users can access cloud applications. |
| AuthorizeUsersForApp | Add or remove authorized users for a specified application in a delivery group | Adds or removes authorized users for a specified application deployed in a delivery group. Only authorized users can access the application. |
| LogOffAllSessionsInAppInstanceGroup | Log off all sessions in a delivery group | Logs off all sessions in a pay-as-you-go delivery group that has scheduled auto scaling enabled. |
| DeleteAppInstanceGroup | Delete a pay-as-you-go delivery group | Deletes a pay-as-you-go delivery group of the resource-based type. |
| ModifyAppPolicy | Modify delivery group display policy | Modifies the display policy of a delivery group, including settings such as frame rate, resolution, and protocol type. |
| ListAuthorizedUsers | Query authorized users | Queries the list of authorized users for a specified delivery group or delivery group set by using paging. Supports exact or fuzzy filtering by username. |
| ListAuthorizedUserGroups | Query user groups authorized by a delivery group | Queries the list of user groups authorized by a specified delivery group. |
| ListAuthorizedAppInstanceGroupByUser | Query authorized delivery groups for a user | Queries the delivery groups for which a specified user has obtained access permissions through delivery group-level authorization by paging, with support for fuzzy filtering by delivery group ID, delivery group name, application ID, or application name. |
| ListAuthorizedAppsByUser | Query authorized applications for a user | Queries the applications for which a specified user has obtained access permissions through per-application authorization by paging. You can filter results by delivery group ID, delivery group name, application ID, or application name using fuzzy match. |
| ListAppsByAppInstanceGroupId | Query deployed applications in a delivery group | Queries the deployed applications in the image used by a specified delivery group with paging and returns the number of users with per-application authorization for each application. |
| ListPublishedAppInstanceGroup | Query published delivery groups | Queries published delivery groups and their application information for a specified product type under the current Alibaba Cloud account by using paging. Supports filtering by delivery group, application, and user authorization status. |
| ListPublishedApps | Query applications in published delivery groups | Queries deployed applications in published delivery groups under the current Alibaba Cloud account for a specified product type by paging, and returns each application along with its delivery group and the number of authorized users by application. Supports filtering by delivery group, application, and user authorization status. |
Application instance
|
API |
Title |
Description |
| ListAppInstances | Query instance details in a delivery group | Queries the details of session instances in a delivery group, including instance IDs, instance statuses, creation time, update time, session statuses, and public IP addresses of primary network interface controllers (NICs). |
| DeleteAppInstances | Delete a specified application instance | Deletes a specified application instance. |
| ListPersistentAppInstances | Query persistent session application instances | Queries the list of persistent session application instances in a delivery group. |
Connection
|
API |
Title |
Description |
| GetConnectionTicket | Retrieve cloud application connection credential | Retrieves the connection credential for a cloud application. |
| Unbind | Unbind a user from a session | Unbinds a user from a session. |
| ListBindInfo | Query binding information | Queries the bindng information between users and resources. |
Debugging
|
API |
Title |
Description |
| CreateImageFromAppInstanceGroup | Create a new image from a debug delivery group | Creates a new image from a debug delivery group. |
| GetDebugAppInstance | Retrieve debug application instance information | Retrieves the information about a debug application instance. |
OTA upgrade
|
API |
Title |
Description |
| ListOtaTask | Query over-the-air update history | Queries the history of over-the-air updates. |
| GetOtaTaskByTaskId | Query OTA upgrade task details | Queries the details of an over-the-air update task, including the available version and release notes. |
| ApproveOtaTask | Set OTA upgrade execution time | Sets the execution time for an OTA upgrade. |
Administrator account
|
API |
Title |
Description |
| ListTenantConfig | Query administrator account configuration information | Queries the configuration information of an administrator account, such as whether resource expiration reminders are enabled. |
| ModifyTenantConfig | Modify administrator account configuration | Modifies the administrator account configuration, such as whether to enable resource expiration reminders. |
Resource tag
|
API |
Title |
Description |
| ListTagCloudResources | Query tags of cloud resources | Queries the tags of one or more specified cloud resources. |
| TagCloudResources | Create and attach tags to cloud resources | Creates and attaches tags to cloud resources. For resources that already have the specified tags, updates the tag values. |
| UntagCloudResources | Unbind tags from cloud resources | Unbinds tags from cloud resources in a unified manner. |
| ListTagResources | Query tags bound to resources | Queries tags bound to one or more delivery groups, or filters delivery groups that have specific tags bound by tag key-value pairs. |
| TagResources | Create and bind tags to resources | Creates and binds tags to specified China Office (Chinese: Wuying) delivery groups in compliance with Alibaba Cloud tag specifications. If a tag key already exists on a resource, the tag value is updated to the value specified in the current request. Currently, only delivery group (`APPINSTANCEGROUP`) resource types are supported. |
WUYING workspace
|
API |
Title |
Description |
| DescribeWuyingServerEipInfo | Query wuying workspace EIP information | Queries the Elastic IP Address (EIP) information of a Wuying workspace. |
| CreateWuyingServer | Create workstations | Creates one or more workstations. |
| ListWuyingServer | Query workstations | Queries a list of workstations. |
| StartWuyingServer | Start a workstation | Starts a workstation. |
| StopWuyingServer | Stop a workstation | Stops a workstation. |
| RestartWuyingServer | Restart a workstation | Restarts a workstation. |
| ModifyWuyingServerAttribute | Modify workstation properties | Modifies the properties of a workstation. |
| UpdateWuyingServerImage | Update a workstation image | Updates a workstation image. |
| RenewWuyingServer | Renew a workstation | Renews a workstation. |
| DeleteWuyingServer | Delete a cloud graphics workstation | Deletes a cloud graphics workstation. |
| DescribeWuyingServer | Query WUYING workspace details | Queries the details of a development host. |
Other
|
API |
Title |
Description |
| AssignWuyingServerPrivateAddresses | Assign secondary private IP addresses for a wuying workspace | Assigns secondary private IP addresses to a development host. |
| DeliverToUserSls | Deliver operation logs to user SLS | Configures SLS log delivery. |
| GetBrowserInstanceGroup | Query cloud browser group details | Queries the configuration, status, and authorization statistics of a specified cloud browser group. |
| GetFileUploadInfo | Get file upload address | Retrieves file upload information. |
| ListBrowserInstanceGroup | Query cloud browser groups | Queries cloud browser groups and their current status by paging. |
| ListModelProviderEndpoints | Query model provider endpoints | Queries the list of model provider endpoints. |
| UnassignWuyingServerPrivateAddresses | Unbind secondary private IP addresses from a WUYING workspace | Unbinds secondary private IP addresses from a development host. |
| UntagResources | Unbind tags from resources | Unbinds tags from specified Wuying delivery groups in compliance with Alibaba Cloud tagging standards. You can unbind specific tags by tag key or unbind all custom tags from a resource at once by setting `All=true` without specifying tag keys. Currently, only the delivery group (`APPINSTANCEGROUP`) resource type is supported. |
Is this page helpful?