API overview-Simple Application Server(SAS)-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (SWAS-OPEN/2020-06-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.

Instances

API	Title	Description
CreateInstances	CreateInstances	Creates subscription simple application servers.
StartInstance	StartInstance	Starts a simple application server.
StartInstances	Start instances in batches	Starts one or more 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	List instances	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	This topic describes the list of plans to which a specified simple application server can be upgraded.
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	Upgrade an instance	Upgrades the plan configuration for a specified 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 Simple Application Server key pair.
UploadInstanceKeyPair	UploadInstanceKeyPair	Imports a key pair for a simple application server.
ImportKeyPair	ImportKeyPair	Imports an existing key pair.
DescribeInstanceKeyPair	DescribeInstanceKeyPair	Queries information about the key pair of a simple application server.
ListKeyPairs	Query key pairs	The list of key pairs.
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 templates

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	Query firewall template application results	Queries the results of applying a firewall template to instances.
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	Retrieve firewall rules of an instance	Queries the firewall rules of a specified simple application server.
ModifyFirewallRule	Modify instance firewall rule	Modifies a firewall rule of a specified simple application server.
EnableFirewallRule	Enable an instance firewall rule	Enables a firewall policy for a specified simple application server.
DisableFirewallRule	Disable an instance firewall rule	Disables a firewall policy for a specified simple application server.
DeleteFirewallRule	Delete an instance firewall rule	Deletes a firewall rule of a specified simple application server.

Snapshots

API	Title	Description
CreateSnapshot	CreateSnapshot	Creates a snapshot for a disk.
ListSnapshots	Query snapshots	Queries information about one or more snapshots that have been created.
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	Query one or more custom images	Queries information about one or more custom images that have been created in a specified 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	Query cross-account shared image information	Calls the ListCustomImageShareAccounts operation to query information about cross-account shared images.
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	Query Cloud assistant information of one or more instances	Queries the Cloud Assistant information of one or more instances.
UpdateCommandAttribute	UpdateCommandAttribute	Modifys the parameter of a command.
InvokeCommand	InvokeCommand	Runs a Command Assistant command for one or more simple application servers.
DescribeCommands	Query commands	Queries commands that you manually created or public commands provided by Alibaba Cloud.
DescribeCommandInvocations	Query command execution list and status	Queries the list and status of commands run by Cloud Assistant.
DeleteCommand	DeleteCommand	Deletes a Command Assistant command.
CreateCommand	CreateCommand	Creates a Cloud Assistant command.
StartTerminalSession	StartTerminalSession	Starts a session to log on to a Simple Application Server instance.
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	Query the execution result of a single command	Queries the execution result of a single command.
RunCommand	Run a command	Runs a command on a simple application server.
DescribeInvocations	Query command details	Queries the details of a command.

Simple database service

API	Title	Description
ModifyDatabaseInstanceParameter	ModifyDatabaseInstanceParameter	After you create a Simple Application Server database service instance, you can view and modify its parameters.
StopDatabaseInstance	StopDatabaseInstance	Stops a lightweight database instance.
StartDatabaseInstance	StartDatabaseInstance	Starts a database instance.
ModifyDatabaseInstanceDescription	ModifyDatabaseInstanceDescription	Modifies the description of a lightweight database instance.
DescribeDatabaseSlowLogRecords	DescribeDatabaseSlowLogRecords	Retrieves slow log details for Simple Database Service.
DescribeDatabaseErrorLogs	DescribeDatabaseErrorLogs	Queries the error logs of a lightweight database instance.
DescribeDatabaseInstanceMetricData	DescribeDatabaseInstanceMetricData	Retrieves monitoring metrics for a lightweight database instance.
DescribeDatabaseInstanceParameters	DescribeDatabaseInstanceParameters	View parameters for a lightweight database instance.
DescribeDatabaseInstances	DescribeDatabaseInstances	This topic describes lightweight database instances.
AllocatePublicConnection	AllocatePublicConnection	Allocates a public connection.
RestartDatabaseInstance	RestartDatabaseInstance	Call this operation to restart a lightweight database instance in the Running state.
ResetDatabaseAccountPassword	ResetDatabaseAccountPassword	Use this operation to reset the password for the administrator account of a database. For enhanced security, change your password regularly.
ReleasePublicConnection	ReleasePublicConnection	Releases the public endpoint of a lightweight database instance if you no longer need to access it from the internet.

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	Query plan information	Queries all plan information for simple application servers in a specified region.
DescribePrice	Query pricing	Queries the pricing information of Simple Application Server.
CreateOrder	Create an order	Queries the pricing information of Simple Application Server.

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.