API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (SWAS-OPEN/2020-06-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Instances
|
API |
Title |
Description |
| ListInstances | ListInstances | This topic describes how to query the details of one or more instances in a specified region. |
| ListInstancePlansModification | ListInstancePlansModification | This topic describes the list of plans to which a specified simple application server can be upgraded. |
Key Pairs
|
API |
Title |
Description |
| CreateKeyPair | CreateKeyPair | Creates a Simple Application Server key pair. |
| ImportKeyPair | ImportKeyPair | Imports an existing key pair. |
Firewall Template
|
API |
Title |
Description |
| CreateFirewallTemplate | CreateFirewallTemplate | Creates a firewall template. |
Command Assistant
|
API |
Title |
Description |
| CreateCommand | CreateCommand | Creates a Cloud Assistant command. |
| StartTerminalSession | StartTerminalSession | Starts a session to log on to a Simple Application Server instance. |
Other resources
|
API |
Title |
Description |
| ListPlans | ListPlans | This topic describes information about all Simple Application Server plans in a specified region. |
Others
|
API |
Title |
Description |
| AddCustomImageShareAccount | AddCustomImageShareAccount | Shares a custom image with other Alibaba Cloud accounts in the same region to quickly deploy the same environment configurations for multiple simple application servers at a time. This improves deployment efficiency. |
| ApplyFirewallTemplate | ApplyFirewallTemplate | Uses a firewall template to apply firewall rules to multiple simple application servers at a time. This improves your efficiency of setting firewall rules. |
| AttachKeyPair | AttachKeyPair | Binds a key pair to simple application servers. |
| CreateCustomImage | CreateCustomImage | Creates a custom image based on a snapshot of a simple application server. |
| CreateFirewallRule | CreateFirewallRule | Creates a firewall rule for a simple application server. |
| CreateFirewallRules | CreateFirewallRules | Creates multiple firewall rules for a simple application server at a time. |
| CreateFirewallTemplateRules | CreateFirewallTemplateRules | Adds firewall rules to a firewall template based on your business requirements. |
| CreateInstanceKeyPair | CreateInstanceKeyPair | Creates a key pair for a simple application server. |
| CreateInstances | CreateInstances | Creates subscription simple application servers. |
| CreateSnapshot | CreateSnapshot | Creates a snapshot for a disk. |
| DeleteCommand | DeleteCommand | Deletes a Command Assistant command. |
| DeleteCustomImage | DeleteCustomImage | Deletes a custom image. |
| DeleteCustomImages | DeleteCustomImages | Deletes custom images. If you no longer require a custom image, you can call this operation to delete the custom image. You can also call this operation to delete multiple custom images at the same time. After a custom image is deleted, you cannot use the custom image to reset the simple application servers that were created based on the custom image. |
| DeleteFirewallRule | DeleteFirewallRule | Deletes a firewall rule of a simple application server. |
| DeleteFirewallRules | DeleteFirewallRules | Deletes multiple firewall rules of a simple application server. |
| DeleteFirewallTemplateRules | DeleteFirewallTemplateRules | Deletes firewall rules from a firewall template based on your requirements. |
| DeleteFirewallTemplates | DeleteFirewallTemplates | Deletes firewall templates from a simple application server. |
| DeleteInstanceKeyPair | DeleteInstanceKeyPair | Deletes the key pair of a simple application server. |
| DeleteKeyPairs | DeleteKeyPairs | Deletes the SSH key pairs of simple application servers. |
| DeleteSnapshot | DeleteSnapshot | Deletes a snapshot of a simple application server. |
| DeleteSnapshots | DeleteSnapshots | Deletes snapshots of a simple application server. |
| DescribeCloudAssistantAttributes | DescribeCloudAssistantAttributes | Queries the Command Assistant information of simple application servers. |
| DescribeCloudAssistantStatus | DescribeCloudAssistantStatus | Queries whether the Cloud Assistant client is installed on simple application servers. |
| DescribeCloudMonitorAgentStatuses | DescribeCloudMonitorAgentStatuses | Queries the status of the CloudMonitor agent on simple application servers. |
| DescribeCommandInvocations | DescribeCommandInvocations | Queries the executions and execution status of a Cloud Assistant command. |
| DescribeCommands | DescribeCommands | Queries the commands that you created or the common commands that Alibaba Cloud provides. |
| DescribeFirewallTemplateApplyResults | DescribeFirewallTemplateApplyResults | Queries the result of applying a firewall template to simple application servers. |
| DescribeFirewallTemplateRulesApplyResult | DescribeFirewallTemplateRulesApplyResult | Queries the result of applying a firewall template rule to simple application servers. |
| DescribeFirewallTemplates | DescribeFirewallTemplates | Queries details about firewall templates. |
| DescribeInstanceKeyPair | DescribeInstanceKeyPair | Queries information about the key pair of a simple application server. |
| DescribeInstancePasswordsSetting | DescribeInstancePasswordsSetting | Checks whether a password is set for a simple application server. |
| DescribeInstanceVncUrl | DescribeInstanceVncUrl | Queries the VNC connection address of a simple application server. |
| DescribeInvocationResult | DescribeInvocationResult | Queries the execution result of a command. |
| DescribeInvocations | DescribeInvocations | Queries details about command execution. |
| DescribeMonitorData | DescribeMonitorData | Queries the monitoring information about vCPUs, memory, disk IOPS, and traffic of a simple application server. |
| DescribePrice | DescribePrice | Queries prices of simple application servers. |
| DescribeSecurityAgentStatus | DescribeSecurityAgentStatus | Queries the status of the Security Center agent on a simple application server. |
| DetachKeyPair | DetachKeyPair | Unbinds key pairs from simple application servers. |
| DisableFirewallRule | DisableFirewallRule | Disables a firewall rule of a simple application server. |
| EnableFirewallRule | EnableFirewallRule | Enables a firewall rule for a simple application server. |
| InstallCloudAssistant | InstallCloudAssistant | Installs the Cloud Assistant client on simple application servers at a time. |
| InstallCloudMonitorAgent | InstallCloudMonitorAgent | Installs the CloudMonitor agent for a simple application server. |
| InvokeCommand | InvokeCommand | Runs a Command Assistant command for one or more simple application servers. |
| ListCustomImageShareAccounts | ListCustomImageShareAccounts | Queries information about custom images that are shared across Alibaba Cloud accounts in a region. |
| ListCustomImages | ListCustomImages | Queries the information about custom images in a region. |
| ListDisks | ListDisks | Queries the information about disks in a region. |
| ListFirewallRules | ListFirewallRules | Queries the firewall rules of a simple application server. |
| ListImages | ListImages | Queries the information about images in a region. |
| ListInstanceStatus | ListInstanceStatus | Queries the status of simple application servers. |
| ListInstancesTrafficPackages | ListInstancesTrafficPackages | Queries the details about data transfer plans of simple application servers. |
| ListKeyPairs | ListKeyPairs | Queries the AccessKey pairs that are bound to simple application servers in a specific region. |
| ListRegions | ListRegions | Queries all regions in which Simple Application Server is supported. |
| ListSnapshots | ListSnapshots | Queries the information about snapshots that are created for a simple application server. |
| ListTagResources | ListTagResources | Queries the tags that are added to simple resources, such as instances, snapshots, disks, images, commands, and firewall rules. |
| LoginInstance | LoginInstance | Logs on to a simple application server on Workbench. |
| ModifyFirewallRule | ModifyFirewallRule | Modifies the firewall rule of a simple application server. |
| ModifyFirewallTemplate | ModifyFirewallTemplate | Modifies the firewall rule in a firewall template. You can apply the new firewall rule to simple application servers. |
| ModifyImageShareStatus | ModifyImageShareStatus | Shares or unshares a custom image to Elastic Compute Service (ECS). |
| ModifyInstanceVncPassword | ModifyInstanceVncPassword | Changes the VNC password of a simple application server. |
| RebootInstance | RebootInstance | Restarts a simple application server. |
| RebootInstances | RebootInstances | Restarts simple application servers. |
| RemoveCustomImageShareAccount | RemoveCustomImageShareAccount | Unshares a custom image that is shared across Alibaba Cloud accounts. |
| RenewInstance | RenewInstance | Renews a simple application server. |
| ResetDisk | ResetDisk | Rolls back a disk based on a snapshot. |
| ResetSystem | ResetSystem | Resets a simple application server. |
| RunCommand | RunCommand | Runs commands on a simple application server. |
| StartInstance | StartInstance | Starts a simple application server. |
| StartInstances | StartInstances | Starts simple application servers. |
| StopInstance | StopInstance | Stops a simple application server. |
| StopInstances | StopInstances | Stops simple application servers. |
| TagResources | TagResources | Adds tags to simple application servers, snapshots, custom images, commands, firewall rules, and disks to facilitate the viewing and management of the preceding resources. |
| UntagResources | UntagResources | Unbinds and deletes tags from specified lightweight resources, such as instances, snapshots, disks, images, commands, and firewall rules. |
| UpdateCommandAttribute | UpdateCommandAttribute | Modifys the parameter of a command. |
| UpdateDiskAttribute | UpdateDiskAttribute | Modifies the remarks for the data disk that is attached to a simple application server. |
| UpdateInstanceAttribute | UpdateInstanceAttribute | Modifies the information of a simple application server, including the server name and the password that you use to log on to the server. |
| UpdateSnapshotAttribute | UpdateSnapshotAttribute | Modifies the remarks of a snapshot of a simple application server. |
| UpgradeInstance | UpgradeInstance | Upgrades the plan for a simple application server. |
| UploadInstanceKeyPair | UploadInstanceKeyPair | Imports a key pair for a simple application server. |