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: 78410016550).
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. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Instances
|
API |
Title |
Description |
| CreateInstances | CreateInstances | Creates subscription simple application servers. |
| StartInstance | StartInstance | Starts a simple application server. |
| StartInstances | StartInstances | Starts simple application servers. |
| ListInstanceStatus | ListInstanceStatus | Queries the status of simple application servers. |
| StopInstance | StopInstance | Stops a simple application server. |
| StopInstances | StopInstances | Stops simple application servers. |
| 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. |
| ListInstances | ListInstances | Queries the details of one or more instances in a specified region. |
| LoginInstance | LoginInstance | Logs on to a simple application server on Workbench. |
| DescribeInstanceVncUrl | DescribeInstanceVncUrl | Queries the VNC connection address of a simple application server. |
| ModifyInstanceVncPassword | ModifyInstanceVncPassword | Changes the VNC password of a simple application server. |
| ListInstancePlansModification | ListInstancePlansModification | Queries the available upgrade plans for a specified Simple Application Server. |
| ListInstancesTrafficPackages | ListInstancesTrafficPackages | Queries the details about data transfer plans of simple application servers. |
| DescribeInstancePasswordsSetting | DescribeInstancePasswordsSetting | Checks whether a password is set for a simple application server. |
| InstallCloudMonitorAgent | InstallCloudMonitorAgent | Installs the CloudMonitor agent for a simple application server. |
| DescribeCloudMonitorAgentStatuses | DescribeCloudMonitorAgentStatuses | Queries the status of the CloudMonitor agent on simple application servers. |
| DescribeMonitorData | DescribeMonitorData | Queries the monitoring information about vCPUs, memory, disk IOPS, and traffic of a simple application server. |
| DescribeSecurityAgentStatus | DescribeSecurityAgentStatus | Queries the status of the Security Center agent on a simple application server. |
| RebootInstance | RebootInstance | Restarts a simple application server. |
| RebootInstances | RebootInstances | Restarts simple application servers. |
| UpgradeInstance | UpgradeInstance | Upgrades the plan for a simple application server. |
| RenewInstance | RenewInstance | Renews a simple application server. |
| ResetSystem | ResetSystem | Resets a simple application server. |
Key Pairs
|
API |
Title |
Description |
| CreateInstanceKeyPair | CreateInstanceKeyPair | Creates a key pair for a simple application server. |
| CreateKeyPair | CreateKeyPair | Creates a key pair. |
| UploadInstanceKeyPair | UploadInstanceKeyPair | Imports a key pair for a simple application server. |
| ImportKeyPair | ImportKeyPair | Imports an existing key pair to the Simple Application Server console. |
| DescribeInstanceKeyPair | DescribeInstanceKeyPair | Queries information about the key pair of a simple application server. |
| ListKeyPairs | ListKeyPairs | Queries the AccessKey pairs that are bound to simple application servers in a specific region. |
| AttachKeyPair | AttachKeyPair | Binds a key pair to simple application servers. |
| DetachKeyPair | DetachKeyPair | Unbinds key pairs from simple application servers. |
| DeleteInstanceKeyPair | DeleteInstanceKeyPair | Deletes the key pair of a simple application server. |
| DeleteKeyPairs | DeleteKeyPairs | Deletes the SSH key pairs of simple application servers. |
Firewall Template
|
API |
Title |
Description |
| CreateFirewallTemplate | CreateFirewallTemplate | Creates a firewall template. |
| DescribeFirewallTemplates | DescribeFirewallTemplates | Queries details about firewall templates. |
| CreateFirewallTemplateRules | CreateFirewallTemplateRules | Adds firewall rules to a firewall template based on your business requirements. |
| 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. |
| ModifyFirewallTemplate | ModifyFirewallTemplate | Modifies the firewall rule in a firewall template. You can apply the new firewall rule to simple application servers. |
| 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. |
| DeleteFirewallTemplateRules | DeleteFirewallTemplateRules | Deletes firewall rules from a firewall template based on your requirements. |
| DeleteFirewallTemplates | DeleteFirewallTemplates | Deletes firewall templates from a simple application server. |
Firewalls
|
API |
Title |
Description |
| DeleteFirewallRules | DeleteFirewallRules | Deletes multiple firewall rules 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. |
| ListFirewallRules | ListFirewallRules | Queries the firewall rules of a simple application server. |
| ModifyFirewallRule | ModifyFirewallRule | Modifies the firewall rule of a simple application server. |
| EnableFirewallRule | EnableFirewallRule | Enables a firewall rule for a simple application server. |
| DisableFirewallRule | DisableFirewallRule | Disables a firewall rule of a simple application server. |
| DeleteFirewallRule | DeleteFirewallRule | Deletes a firewall rule of a simple application server. |
Snapshots
|
API |
Title |
Description |
| CreateSnapshot | CreateSnapshot | Creates a snapshot for a disk. |
| ListSnapshots | ListSnapshots | Queries the information about snapshots that are created for a simple application server. |
| UpdateSnapshotAttribute | UpdateSnapshotAttribute | Modifies the remarks of a snapshot of a simple application server. |
| DeleteSnapshot | DeleteSnapshot | Deletes a snapshot of a simple application server. |
| DeleteSnapshots | DeleteSnapshots | Deletes snapshots of a simple application server. |
Disks
|
API |
Title |
Description |
| UpdateDiskAttribute | UpdateDiskAttribute | Modifies the remarks for the data disk that is attached to a simple application server. |
| ListDisks | ListDisks | Queries the information about disks in a region. |
| ResetDisk | ResetDisk | Rolls back a disk based on a snapshot. |
Custom Images
|
API |
Title |
Description |
| CreateCustomImage | CreateCustomImage | Creates a custom image based on a snapshot of a simple application server. |
| ListCustomImages | ListCustomImages | Queries the information about custom images in a region. |
| ModifyImageShareStatus | ModifyImageShareStatus | Shares or unshares a custom image to Elastic Compute Service (ECS). |
| 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. |
| ListCustomImageShareAccounts | ListCustomImageShareAccounts | Queries information about custom images that are shared across Alibaba Cloud accounts in a region. |
| RemoveCustomImageShareAccount | RemoveCustomImageShareAccount | Unshares a custom image that is shared across Alibaba Cloud accounts. |
| 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. |
Command Assistant
|
API |
Title |
Description |
| DescribeCloudAssistantAttributes | DescribeCloudAssistantAttributes | Queries the Command Assistant information of simple application servers. |
| UpdateCommandAttribute | UpdateCommandAttribute | Modifys the parameter of a command. |
| InvokeCommand | InvokeCommand | Runs a Command Assistant command for one or more simple application servers. |
| DescribeCommands | DescribeCommands | Queries the commands that you created or the common commands that Alibaba Cloud provides. |
| DescribeCommandInvocations | DescribeCommandInvocations | Queries the executions and execution status of a Cloud Assistant command. |
| DeleteCommand | DeleteCommand | Deletes a Command Assistant command. |
| CreateCommand | CreateCommand | Creates a Cloud Assistant command. |
| StartTerminalSession | StartTerminalSession | Creates a session for a simple application server. |
| InstallCloudAssistant | InstallCloudAssistant | Installs the Cloud Assistant client on simple application servers at a time. |
| DescribeCloudAssistantStatus | DescribeCloudAssistantStatus | Queries whether the Cloud Assistant client is installed on simple application servers. |
| DescribeInvocationResult | DescribeInvocationResult | Queries the execution result of a command. |
| RunCommand | RunCommand | Runs commands on a simple application server. |
| DescribeInvocations | DescribeInvocations | Queries details about command execution. |
Simple Application Database Service
|
API |
Title |
Description |
| ModifyDatabaseInstanceParameter | ModifyDatabaseInstanceParameter | After you create a Simple Database Service instance, you can view the parameters of the instance or modify the parameters of the instance based on your business requirements. |
| StopDatabaseInstance | StopDatabaseInstance | Stops a Simple Database Service instance. |
| StartDatabaseInstance | StartDatabaseInstance | Starts a Simple Database Service instance. |
| ModifyDatabaseInstanceDescription | ModifyDatabaseInstanceDescription | Modifies the description of a Simple Database Service instance. |
| DescribeDatabaseSlowLogRecords | DescribeDatabaseSlowLogRecords | Queries the slow query log details of a Simple Database Service instance. |
| DescribeDatabaseErrorLogs | DescribeDatabaseErrorLogs | Queries error logs of databases in a Simple Database Service instance. |
| DescribeDatabaseInstanceMetricData | DescribeDatabaseInstanceMetricData | Queries the monitoring information about a Simple Database Service instance. |
| DescribeDatabaseInstanceParameters | DescribeDatabaseInstanceParameters | Queries the parameters of a Simple Database Service instance. |
| DescribeDatabaseInstances | DescribeDatabaseInstances | Queries the information about Simple Database Service instances. |
| AllocatePublicConnection | AllocatePublicConnection | Applies for a public endpoint for a Simple Database Service instance. |
| RestartDatabaseInstance | RestartDatabaseInstance | You can call this operation to restart a Simple Database Service instance that is in the Running state. |
| ResetDatabaseAccountPassword | ResetDatabaseAccountPassword | If the password of your Simple Database Service instance is not strong, you can call this operation to change the password of the administrator account of the instance. To ensure security of the instance, we recommend that you regularly change the password of the instance. |
| ReleasePublicConnection | ReleasePublicConnection | If you no longer need to use a public endpoint to access a Simple Database Service instance, you can release the public endpoint. |
Tag
|
API |
Title |
Description |
| 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. |
| ListTagResources | ListTagResources | Queries the tags that are added to simple resources, such as instances, snapshots, disks, images, commands, and firewall rules. |
| UntagResources | UntagResources | Unbinds and deletes tags from specified lightweight resources, such as instances, snapshots, disks, images, commands, and firewall rules. |
Other resources
|
API |
Title |
Description |
| ListRegions | ListRegions | Queries all regions in which Simple Application Server is supported. |
| ListImages | ListImages | Queries the information about images in a region. |
| ListPlans | ListPlans | This topic describes information about all Simple Application Server plans in a specified region. |