This product(
appstream-center/2021-09-01) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Regions
| API | Title | Description |
|---|---|---|
| ListRegions | ListRegions | Queries the regions that are supported by App Streaming. |
Resources
| API | Title | Description |
|---|---|---|
| ListNodes | ListNodes | Queries resource nodes. |
| ModifyNodePoolAmount | ModifyNodePoolAmount | Changes the number of nodes in a subscription delivery group. |
| ListNodeInstanceType | ListNodeInstanceType | Queries the resource types that are available for purchase when you create a delivery group. |
| GetResourcePrice | GetResourcePrice | Queries resource prices. |
| GetResourceRenewPrice | GetResourceRenewPrice | Queries the renewal prices of App Streaming resources. |
Images
| API | Title | Description |
|---|---|---|
| ListImage | ListImage | Queries the image information about an ECS instance. |
| CreateImageByInstance | CreateImageByInstance | Create a custom image from a deployed instance. This allows you to quickly create more instances with the same configurations and avoid repeatedly configuring the instance environment each time you create the instance. |
| StartTaskForDistributeImage | StartTaskForDistributeImage | Initiates a task to replicate an image to another region. |
| DeleteImage | DeleteImage | Delete a custom RDS image |
Delivery Groups
| API | Title | Description |
|---|---|---|
| CreateAppInstanceGroup | CreateAppInstanceGroup | Creates a delivery group. |
| GetAppInstanceGroup | GetAppInstanceGroup | Queries the details of a delivery group. |
| ListAppInstanceGroup | ListAppInstanceGroup | Queries the details of multiple delivery groups that meet the query conditions. |
| PageListAppInstanceGroupUser | PageListAppInstanceGroupUser | Queries the assigned users that are added to a delivery group by page. |
| RenewAppInstanceGroup | RenewAppInstanceGroup | Renews a delivery group. |
| UpdateAppInstanceGroupImage | UpdateAppInstanceGroupImage | Updates the image of a delivery group. |
| ModifyAppInstanceGroupAttribute | ModifyAppInstanceGroupAttribute | Modifies the general policies of a delivery group, including the number of concurrent sessions and the retention period of disconnected sessions. |
| ModifyNodePoolAttribute | ModifyNodePoolAttribute | Changes the scaling policy of a delivery group. The following scaling policies are supported: fixed resource number, scheduled scaling, and auto scaling. |
| AuthorizeInstanceGroup | AuthorizeInstanceGroup | Adds assigned users to or removes assigned users from a delivery group. Only users added to the assigned user list can access App Streaming. |
| LogOffAllSessionsInAppInstanceGroup | LogOffAllSessionsInAppInstanceGroup | Closes all sessions in a pay-as-you-go delivery group for which a scheduled scaling policy is used. |
| DeleteAppInstanceGroup | DeleteAppInstanceGroup | Deletes a delivery group that uses the By Resource - Pay-as-you-go billing method. |
| ModifyAppPolicy | ModifyAppPolicy | Modify the delivery group display policy, including settings such as frame rate, resolution, and protocol type. |
| ListAuthorizedUserGroups | ListAuthorizedUserGroups | Queries the user groups authorized by a delivery group. |
App Instances
| API | Title | Description |
|---|---|---|
| ListAppInstances | ListAppInstances | Queries the details of application instances in a delivery group, including the IDs, status, creation time, update time, session status, and public IP addresses associated with the primary NICs of the instances. |
| DeleteAppInstances | DeleteAppInstances | Deletes an application instance. |
| ListPersistentAppInstances | ListPersistentAppInstances | Queries app instances of the persistent session type in a delivery group. |
Connections
| API | Title | Description |
|---|---|---|
| GetConnectionTicket | GetConnectionTicket | Queries the credential that is used to connect to App Streaming. |
| Unbind | Unbind | Unbinds a user and a session. |
| ListBindInfo | ListBindInfo | Queries the bindings between users and resources. |
Debugging
| API | Title | Description |
|---|---|---|
| CreateImageFromAppInstanceGroup | CreateImageFromAppInstanceGroup | Creates a new image by debugging the delivery group. |
| GetDebugAppInstance | GetDebugAppInstance | Queries information that is used to debug an application instance. |
OTA
| API | Title | Description |
|---|---|---|
| ListOtaTask | ListOtaTask | Queries the information about over-the-air (OTA) update tasks. |
| GetOtaTaskByTaskId | GetOtaTaskByTaskId | Queries the details of an over-the-air (OTA) update task, including the available versions and version description. |
| ApproveOtaTask | ApproveOtaTask | Sets the execution time of an over-the-air (OTA) update task. |
Tenant Account
| API | Title | Description |
|---|---|---|
| ListTenantConfig | ListTenantConfig | Queries the configurations of the administrator account, such as whether the resource expiration reminder feature is enabled. |
| ModifyTenantConfig | ModifyTenantConfig | Modifies the configurations of the administrator account, such as whether to enable the resource expiration reminder feature. |
Resource Tags
| API | Title | Description |
|---|---|---|
| ListTagCloudResources | ListTagCloudResources | Queries the tags added to one or more cloud resources. |
| TagCloudResources | TagCloudResources | Creates and adds tags to cloud resources and updates the values of existing cloud resource tags. |
| UntagCloudResources | UntagCloudResources | Removes tags from cloud resources. |
Workstations
| API | Title | Description |
|---|---|---|
| DescribeWuyingServerEipInfo | DescribeWuyingServerEipInfo | Queries the Elastic IP Addresses (EIPs) of workstations. |
| CreateWuyingServer | CreateWuyingServer | Create one or more workstations. |
| ListWuyingServer | ListWuyingServer | Queries the list of workstations. |
| StartWuyingServer | StartWuyingServer | Start the workstation. |
| StopWuyingServer | StopWuyingServer | Stops the workstation. |
| RestartWuyingServer | RestartWuyingServer | Restarts the workstation. |
| ModifyWuyingServerAttribute | ModifyWuyingServerAttribute | Modify workstation properties. |
| UpdateWuyingServerImage | UpdateWuyingServerImage | Updates the workstation image. |
| RenewWuyingServer | RenewWuyingServer | Renew one workstation. |
| DeleteWuyingServer | DeleteWuyingServer |
Other
| API | Title | Description |
|---|---|---|
| ModifyBrowserInstanceGroup | ModifyBrowserInstanceGroup | Modifies the properties of the cloud browser. |