# Alibaba Cloud Simple Application Server API

> Alibaba Cloud Simple Application Server API on Apizie: 101 endpoints (Shares a custom image with other Alibaba Cloud accounts in the same region to quickly deploy identical…, Applies for a public network access endpoint, Applies a firewall template to configure firewall rules for multiple Simple Application Server instances at…, Attaches a key pair to a simple application server, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-swas-open/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-swas-open`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/swas-open
- Page: https://apizie.tech/api/cloud/aliyun-swas-open
- OpenAPI: https://apizie.tech/api/cloud/aliyun-swas-open/openapi.json

Alibaba Cloud OpenAPI for Simple Application Server (swas-open, version 2020-06-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Shares a custom image with other Alibaba Cloud accounts in the same region to quickly deploy identical…
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/add-custom-image-share-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query the latest Alibaba Cloud region list |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value on your client, but you must ensure… |
| ImageId | string | yes | The ID of the custom image |
| Account | string | yes | The account name (JSON-encoded) |

### Applies for a public network access endpoint
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/allocate-public-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the specified lightweight database instance. You can call the https://help.aliyun.com/document_detail/2361076.html… |
| DatabaseInstanceId | string | yes | The instance ID of the lightweight database |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… |

### Applies a firewall template to configure firewall rules for multiple Simple Application Server instances at…
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/apply-firewall-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query available regions |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value on your client and must ensure that the… |
| FirewallTemplateId | string | yes | The ID of the firewall template |
| InstanceIds | string | yes | The instance IDs of the Simple Application Server instances (JSON-encoded) |

### Attaches a key pair to a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/attach-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the specified lightweight database instance. You can call the https://help.aliyun.com/document_detail/189315.html… |
| ClientToken | string | no | Ensures the idempotence of the request. You can generate a parameter value from your client to ensure that the value is unique across… |
| InstanceIds | string | yes | The IDs of the simple application servers. You can specify up to 50 instance IDs (JSON-encoded) |
| KeyPairName | string | yes | The name of the key pair. The name must be 2 to 64 characters in length. It must start with a letter or a Chinese character and cannot… |

### Creates a Cloud Assistant command
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/create-command` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/189315.html to query available regions |
| Name | string | yes | The name of the command. All characters are supported. The name cannot exceed 128 characters in length |
| Description | string | no | The description of the command. All characters are supported. The description cannot exceed 512 characters in length |
| Type | string | yes | The language type of the command. Valid values: RunBatScript: bat commands for Windows instances RunPowerShellScript: PowerShell commands… |
| CommandContent | string | yes | The content of the command. Take note of the following items: If you set the EnableParameter parameter to true, you can use custom… |
| WorkingDir | string | no | The directory in which the created command is run on the ECS instance. Default value: Linux instances: the home directory of the root… |
| Timeout | integer | no | The timeout period for running the command on the instance, in seconds. If the task that runs the command times out, Cloud Assistant… |
| EnableParameter | string | no | Specifies whether the created command uses custom parameters. Default value: false |
| Tag | string | no | The list of tags. You can specify up to 20 tags (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group |

### Creates a custom image from a snapshot
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/create-custom-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query available regions |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| InstanceId | string | yes | The instance ID of the specified Simple Application Server |
| ImageName | string | yes | The name of the custom image. The name must be 2 to 128 characters in length and must start with a letter, a Chinese character, or a… |
| SystemSnapshotId | string | no | The ID of the system disk snapshot |
| Description | string | no | The description of the image |
| DataSnapshotId | string | no | The ID of the data disk snapshot |
| Tag | string | no | The list of tags. You can specify up to 20 tags (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group |

### Creates a firewall rule for a specified simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/create-firewall-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the specified simple application server |
| RegionId | string | yes | The region ID of the specified simple application server |
| RuleProtocol | string | yes | The transport layer protocol. Valid values: TCP: TCP UDP: UDP TCP+UDP: TCP and UDP ICMP: ICMP |
| Port | string | yes | The port range. TCP/UDP: Valid values: 1 to 65535. Use a forward slash (/) to separate the start port and the end port. For example,… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… |
| Remark | string | no | The remark for the firewall rule |

### Creates multiple firewall rules for a specified simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/create-firewall-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the specified simple application server |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query the regions where simple… |
| ClientToken | string | no | The client token |
| FirewallRules | string | no | The array of firewall rules (JSON-encoded) |
| Tag | string | no | The list of tags. The list can contain up to 20 tags (JSON-encoded) |

### Creates a firewall template
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/create-firewall-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Simple Application Server instance. You can call the https://help.aliyun.com/document_detail/189315.html operation to… |
| Name | string | yes | The name of the firewall template |
| Description | string | no | The description of the firewall template |
| FirewallRule | string | no | The firewall rules (JSON-encoded) |

### Adds firewall rules to a firewall template
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/create-firewall-template-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query the available regions for Simple… |
| FirewallTemplateId | string | yes | The ID of the firewall template |
| FirewallRule | string | yes | The firewall rules (JSON-encoded) |

### Creates a key pair for a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/create-instance-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the specified simple application server instance. You can call the https://help.aliyun.com/document_detail/189315.html… |
| ClientToken | string | no | Ensures the idempotence of the request. The value is generated by the client to ensure uniqueness across different requests. ClientToken… |
| InstanceId | string | yes | The instance ID of the simple application server |
| KeyPairName | string | yes | The name of the key pair |

### Creates one or more subscription Simple Application Server instances
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/create-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query available regions |
| ImageId | string | yes | The image ID. You can call the https://help.aliyun.com/document_detail/189313.html operation to query available image IDs in a specified… |
| PlanId | string | yes | The plan ID. You can call the https://help.aliyun.com/document_detail/189314.html operation to query all plans in a specified region |
| Period | integer | yes | The subscription period of the resource. Unit: months. Valid values: 1, 3, 6, 12, 24, and 36 |
| AutoRenew | string | no | Specifies whether to enable auto-renewal upon expiration. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is disabled.… |
| AutoRenewPeriod | integer | no | The auto-renewal period. This parameter is required only when AutoRenew is set to true. Unit: months. Valid values: 1, 3, 6, 12, 24, and 36 |
| DataDiskSize | integer | no | The size of the data cloud disk to be mounted. Unit: GB. Valid values: 0 to 16380. The value must be a multiple of 20. A value of 0… |
| Amount | integer | no | The number of Simple Application Server instances to create. Valid values: 1 to 20. Default value: 1 |
| ChargeType | string | no | The billing method. Set the value to PrePaid. Currently, only the subscription billing method is supported. Default value: PrePaid |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… |

### Creates a key pair for a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/create-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the specified simple application server instance. You can call the https://help.aliyun.com/document_detail/189315.html… |
| ClientToken | string | no | Ensures the idempotence of the request. You can generate the value on your client to ensure that the value is unique across different… |
| KeyPairName | string | yes | The name of the key pair. The name must be 2 to 64 characters in length, and can contain English letters and Chinese characters. It must… |

### Queries the pricing information of Simple Application Server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/create-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query available regions |
| OrderType | string | no | The order type. Valid values: Buy Default value: Buy |
| Commodity | string | yes | The order configuration information (JSON-encoded) |
| BusinessInfo | string | no | The additional parameter for business information (JSON-encoded) |
| FromApp | string | no | The request source. Valid values: OpenApi: The request is sent from OpenAPI. mongo_buy: The request is sent from the console |
| CouponNo | string | no | The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank` |

### Creates a snapshot for a specified disk
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/create-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Simple Application Server instance to which the specified disk belongs |
| DiskId | string | yes | The ID of the disk |
| SnapshotName | string | yes | The name of the snapshot. The name must be 2 to 50 characters in length and must start with a letter or a Chinese character. It cannot… |
| ClientToken | string | no | Ensures the idempotence of the request. You can generate the value from your client to ensure that the value is unique across different… |
| Tag | string | no | The list of tags. You can specify up to 20 tags (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group |

### Deletes a command
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/delete-command` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query the available regions for Simple… |
| CommandId | string | yes | The command ID. You can call the https://help.aliyun.com/document_detail/64843.html operation to query all available command IDs |

### Deletes a specified custom image
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/delete-custom-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query available regions |
| ClientToken | string | no | Ensures the idempotence of the request. Generate a parameter value on your client to ensure that the value is unique across different… |
| ImageId | string | yes | The ID of the custom image |

### Deletes custom images in batches. After a custom image is deleted, simple application servers created from…
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/delete-custom-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/189315.html to query available regions |
| ImageIds | string | yes | The instance IDs of the simple application servers. The value can be a JSON array that consists of multiple instance IDs. You can specify… |
| ClientToken | string | no | Ensures the idempotence of the request. Generate the value from your client and ensure that it is unique across different requests.… |

### Deletes a firewall rule of a specified simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/delete-firewall-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID of the specified simple application server |
| RegionId | string | yes | The region ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that… |
| RuleId | string | yes | The firewall rule ID |

### Deletes multiple firewall rules of a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/delete-firewall-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the simple application server |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| RuleIds | string | no | The IDs of the firewall rules that you want to delete (JSON-encoded) |

### Deletes firewall rules from a firewall template based on your requirements
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/delete-firewall-template-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| FirewallTemplateId | string | yes | The ID of the firewall template |
| FirewallTemplateRuleId | string | yes | The IDs of the firewall template rules (JSON-encoded) |

### Deletes firewall templates from a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/delete-firewall-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| FirewallTemplateId | string | yes | The IDs of the firewall templates (JSON-encoded) |

### Deletes the key pair of a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/delete-instance-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| InstanceId | string | yes | The ID of the simple application server |

### Deletes the SSH key pairs of simple application servers
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/delete-key-pairs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application servers. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| KeyPairNames | string | yes | The names of the SSH key pairs. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores… |

### Deletes a snapshot of a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/delete-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the snapshot |
| SnapshotId | string | yes | The snapshot ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |

### Deletes snapshots of a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/delete-snapshots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| SnapshotIds | string | yes | The snapshot IDs. The value can be a JSON array that consists of up to 100 snapshot IDs. Separate multiple snapshot IDs with commas (,) |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |

### Queries the Cloud Assistant information of one or more instances
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-cloud-assistant-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application servers. You can call https://help.aliyun.com/document_detail/189315.html to query the list of… |
| PageNumber | integer | no | The page number. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page |
| InstanceIds | string | yes | The instance IDs of the simple application server instances (JSON-encoded) |

### Queries whether the Cloud Assistant client is installed on simple application servers
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-cloud-assistant-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application servers |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Maximum value: 50. Default value: 10 |
| InstanceIds | string | no | The IDs of the simple application servers (JSON-encoded) |

### Queries the status of the CloudMonitor agent on simple application servers
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-cloud-monitor-agent-statuses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application servers. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| InstanceIds | string | yes | The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs.… |

### Queries the list and status of commands run by Cloud Assistant
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-command-invocations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/189315.html to query available regions |
| InstanceId | string | no | The instance ID of the simple application server |
| CommandId | string | no | The command ID. You can call https://help.aliyun.com/document_detail/64843.html to query all available command IDs |
| InvokeId | string | no | The command execution ID |
| CommandName | string | no | The command name. If the InstanceId parameter is also specified, this parameter does not take effect |
| InvocationStatus | string | no | The overall execution status of the command. The overall execution status depends on the common execution status across all instances in… |
| CommandType | string | no | The command type. Valid values: RunBatScript: Bat command for Windows instances. RunPowerShellScript: PowerShell command for Windows… |
| PageNumber | string | no | The page number. Minimum value: 1. Default value: 1 |
| PageSize | string | no | The number of entries per page for a paged query. Maximum value: 50. Default value: 10 |

### Queries commands that you manually created or public commands provided by Alibaba Cloud
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-commands` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| CommandId | string | no | The command ID |
| Name | string | no | The name of the command. Fuzzy match is not supported |
| Provider | string | yes | The provider of the public command. Valid values: AlibabaCloud: queries all public commands provided by Alibaba Cloud. User: queries all… |
| Type | string | no | The language type of the command. Valid values: RunBatScript: Bat command for Windows instances. RunPowerShellScript: PowerShell command… |
| PageNumber | string | no | The page number. Minimum value: 1. Default value: 1 |
| PageSize | string | no | The number of entries per page for a paged query. Maximum value: 50. Default value: 10 |
| Tag | string | no | The tags of the command (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |

### Queries the error logs of a lightweight database instance
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-database-error-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the lightweight database instance resides. You can call the https://help.aliyun.com/document_detail/189315.html… |
| DatabaseInstanceId | string | yes | The ID of the lightweight database instance |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of error logs to return per page |
| StartTime | string | yes | The start of the time range to query. The time must be in UTC and formatted as `yyyy-MM-ddTHH:mmZ` according to the… |
| EndTime | string | yes | The end of the time range to query. The time must be in UTC and formatted as `yyyy-MM-ddTHH:mmZ` according to the… |

### Retrieves monitoring metrics for a lightweight database instance
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-database-instance-metric-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the lightweight database instance. You can call the https://help.aliyun.com/document_detail/189315.html operation to get… |
| DatabaseInstanceId | string | yes | The ID of the lightweight database instance |
| MetricName | string | yes | The name of the metric. Valid values: `MySQL_MemCpuUsage`: The CPU utilization and memory usage of the instance, as a percentage of the… |
| StartTime | string | yes | The start of the time range to query. Specify the time in the https://help.aliyun.com/document_detail/25696.html standard in the… |
| EndTime | string | yes | The end of the time range to query. Specify the time in the https://help.aliyun.com/document_detail/25696.html standard in the… |

### View parameters for a lightweight database instance
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-database-instance-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the lightweight database instance is located. You can call https://help.aliyun.com/document_detail/189315.html… |
| DatabaseInstanceId | string | yes | The ID of the lightweight database instance |

### Queries the details of lightweight database instances
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-database-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the lightweight database instance |
| DatabaseInstanceIds | string | no | The IDs of the lightweight database instances. The value can be a JSON array that consists of multiple instance IDs. You can specify up to… |
| PageNumber | integer | no | The page number of the lightweight database instance list. Starting value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page for a paged query. Maximum value: 100. Default value: 10 |

### Retrieves slow log details for Simple Database Service
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-database-slow-log-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the lightweight database instance. You can call the https://help.aliyun.com/document_detail/189315.html operation to get… |
| DatabaseInstanceId | string | yes | The ID of the lightweight database instance |
| PageNumber | integer | no | The page number. Starting value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Valid values: 30 to 100. Default value: 30 |
| StartTime | string | yes | The beginning of the time range to query. The time is in UTC and must be formatted as `yyyy-MM-ddTHH:mm:ssZ` as specified by the… |
| EndTime | string | yes | The end of the time range to query. The end time must be later than the start time. The interval between the start time and the end time… |

### Queries the results of applying a firewall template to instances
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-firewall-template-apply-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call https://help.aliyun.com/document_detail/189315.html to query the list of… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. A client token is generated from your client to ensure uniqueness… |
| FirewallTemplateId | string | no | The firewall template ID |
| TaskId | string | no | The ID of the template application task (JSON-encoded) |
| PageNumber | integer | no | The page number of the firewall rule list |
| PageSize | integer | no | The number of entries per page for a paged query. Default value: 20 |

### Queries the result of applying a firewall template rule to simple application servers
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-firewall-template-rules-apply-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the simple application server |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you make sure… |
| FirewallTemplateId | string | yes | The ID of the firewall template |
| TaskId | string | yes | The ID of the execution to apply the template rule |

### Queries details about firewall templates
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-firewall-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| FirewallTemplateId | string | no | The IDs of the firewall templates (JSON-encoded) |
| Name | string | no | The name of the firewall template |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 20 |

### Queries information about the key pair of a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-instance-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| InstanceId | string | yes | The ID of the simple application server |

### Checks whether a password is set for a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-instance-passwords-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/2361076.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| InstanceId | string | yes | The ID of the simple application server |

### Queries the VNC connection address of a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-instance-vnc-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| InstanceId | string | yes | The ID of the simple application server |

### Queries the execution result of a single command
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-invocation-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the simple application server |
| InvokeId | string | yes | The command execution ID. You can call the https://help.aliyun.com/document_detail/439368.html operation to query the InvokeId |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/25609.html operation to query the most recent region list |

### Queries the details of a command
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-invocations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/189315.html to query the most recent region list |
| InstanceId | string | yes | The instance ID of the simple application server |
| PageNumber | integer | no | The page number. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page in a paged query. Settings for paging. Maximum value: 50. Default value: 10 |
| InvokeStatus | string | no | The execution status of the command. Valid values: Running: The command is running. Finished: The command execution is complete. Failed:… |

### Queries the monitoring information about vCPUs, memory, disk IOPS, and traffic of a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-monitor-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| InstanceId | string | yes | The ID of the simple application server |
| MetricName | string | yes | The name of the metric. Valid values: MEMORY_ACTUALUSEDSPACE: the memory usage. Unit: bytes. DISKUSAGE_USED: the disk usage. Unit: bytes.… |
| Period | string | yes | The interval at which the monitoring data is queried. Valid values: 60, 300, and 900. Unit: seconds. If MetricName is set to FLOW_USED,… |
| StartTime | string | yes | The beginning of the time range to query. The following formats are supported: UNIX timestamp: the number of milliseconds that have… |
| EndTime | string | yes | The end of the time range to query. The following formats are supported: UNIX timestamp: the number of milliseconds that have elapsed… |
| NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the… |
| Length | string | no | The number of entries per page. Valid values: 1 to 1440 |

### Retrieves the pricing information of Simple Application Server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the specified Simple Application Server instance. You can call the https://help.aliyun.com/document_detail/189315.html… |
| CommodityType | string | yes | The resource type. Valid values: Server |
| PlanId | string | no | The plan ID. You can call the https://help.aliyun.com/document_detail/189314.html operation to query all plan information in the specified… |
| DataDiskSize | integer | no | The capacity of the mounted data cloud disk. Unit: GB. Valid values: 0 to 16380. The value must be a multiple of 20 |
| Period | integer | no | The billing duration. Valid values: If the PriceUnit parameter is set to Month: 1 to 9. If the PriceUnit parameter is set to Year: 1 to 5.… |
| PriceUnit | string | no | The pricing unit. Valid values: Month: the pricing unit for monthly billing. Year: the pricing unit for yearly billing. Default value: Month |
| Amount | integer | no | The number of Simple Application Server instances to create. Valid values: 1 to 20. Default value: 1 |
| PayType | string | no | The billing method of the instance. Valid values: Prepaid: subscription. Example: Prepaid |
| PromotionOptions | string | no | The promotion option information (JSON-encoded) |
| OrderType | string | no | The order type. Valid values: Buy. Default value: Buy |
| AcceptLanguage | string | no | The language of the response. Valid values: zh-CN (default): Chinese. en-US: English |
| InstanceId | string | no | The ID of the Simple Application Server instance |

### Queries the status of the Security Center agent on a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/describe-security-agent-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| InstanceId | string | yes | The ID of the simple application server |

### Unbinds key pairs from simple application servers
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/detach-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application servers |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| InstanceIds | string | yes | The IDs of the simple application servers from which you want to unbind SSH key pairs. You can specify a maximum of 50 IDs of simple… |
| KeyPairName | string | yes | The name of the key pair. The name must be globally unique. The name must be 2 to 64 characters in length and can contain letters, digits,… |

### Disables a firewall policy for a specified simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/disable-firewall-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID of the specified simple application server |
| RegionId | string | yes | The region ID of the specified simple application server. You can call https://help.aliyun.com/document_detail/189315.html to query the… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. A client-generated parameter value that is unique among different… |
| RuleId | string | yes | The firewall rule ID. You can call the ListFirewallRules operation to obtain the firewall rule ID |
| Remark | string | no | The remarks of the firewall rule |

### Enables a firewall policy for a specified simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/enable-firewall-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID of the specified simple application server |
| RegionId | string | yes | The region ID of the specified simple application server. You can call https://help.aliyun.com/document_detail/189315.html to query the… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. A client token is generated from your client and must be unique… |
| RuleId | string | yes | The firewall rule ID |
| Remark | string | no | The remarks of the firewall rule |
| SourceCidrIp | string | no | The IP address or CIDR block |

### Imports an existing key pair
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/import-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Simple Application Server instance is located. Call https://help.aliyun.com/document_detail/189315.html to… |
| ClientToken | string | no | A client token used to ensure the idempotence of the request. Generate a unique value for this parameter from your client. ClientToken can… |
| KeyPairName | string | yes | The name of the key pair. The name must be 2 to 64 characters in length. It must start with a letter or a Chinese character. It cannot… |
| PublicKeyBody | string | yes | The content of the public key of the key pair |

### Installs the Cloud Assistant client on simple application servers at a time
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/install-cloud-assistant` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application servers. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| InstanceIds | string | yes | The IDs of the simple application servers (JSON-encoded) |

### Installs the CloudMonitor agent for a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/install-cloud-monitor-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| InstanceId | string | yes | The ID of the simple application server |
| Force | string | no | Specifies whether to forcibly install the CloudMonitor agent. Valid values: true (default value): forcibly installs the CloudMonitor… |

### Runs a Command Assistant command for one or more simple application servers
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/invoke-command` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query the most recent region list |
| CommandId | string | yes | The command ID. You can call the DescribeCommands operation to query all available command IDs |
| Parameters | string | no | The key-value pairs of custom parameters to specify when the custom parameter feature is enabled. You can specify up to 10 custom… |
| Username | string | no | The name of the user who runs the command in a simple application server. The username cannot exceed 255 characters in length. For Linux… |
| InstanceIds | string | yes | The IDs of the simple application servers. The value can be a JSON array that consists of up to 50 IDs of simple application servers.… |

### Calls the ListCustomImageShareAccounts operation to query information about cross-account shared images
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-custom-image-share-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/189315.html to query the available regions for simple application… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. A client token is generated from your client to ensure uniqueness… |
| ImageId | string | yes | The ID of the shared custom image |
| PageSize | integer | no | The number of entries per page for a paged query. Maximum value: 50. Default value: 10 |
| PageNumber | integer | no | The current page number |

### Queries information about one or more custom images that have been created in a specified region
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-custom-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application servers. You can call https://help.aliyun.com/document_detail/189315.html to query the list of… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. A client token is generated from your client and must be unique… |
| ImageIds | string | no | The image IDs of the simple application servers. The value can be a JSON array that consists of up to 100 instance IDs. Separate multiple… |
| PageSize | integer | no | The number of entries per page for a paged query. Maximum value: 100. Default value: 10 |
| PageNumber | integer | no | The page number of the snapshot list. Default value: 1 |
| ImageNames | string | no | The image names of the simple application servers. The value can be a JSON array that consists of up to 100 instance IDs. Separate… |
| SystemSnapshotId | string | no | The system cloud disk snapshot ID |
| DataSnapshotId | string | no | The data cloud disk snapshot ID |
| Tag | string | no | The tags of the custom images (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |
| Share | string | no | Specifies whether to query shared images. Valid values: False: The response does not include shared images. True: Only shared images are… |
| InstanceId | string | no | The instance ID of the simple application server from which the image was created |

### Queries the information about disks in a region
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-disks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the disks |
| InstanceId | string | no | The ID of the simple application server |
| DiskIds | string | no | The IDs of the disks. The value can be a JSON array that consists of up to 100 disk IDs. Separate multiple disk IDs with commas (,) |
| PageSize | integer | no | The number of entries per page. Maximum value: 100. Default value: 10 |
| PageNumber | integer | no | The page number. Default value: 1 |
| DiskType | string | no | The disk type. Valid values: system: system disk data: data disk By default, system disks and data disks are both queried |
| Tag | string | no | The tags that are added to the disks (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries the firewall rules of a specified simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-firewall-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID of the specified simple application server |
| RegionId | string | yes | The region ID of the simple application server |
| PageSize | integer | no | The paging Settings for the number of entries per page in a paged query. Maximum value: 100. Default value: 10 |
| PageNumber | integer | no | The page number of the firewall rule list. Starting value: 1. Default value: 1 |
| Tag | string | no | The tags of the firewall rules (JSON-encoded) |
| FirewallRuleId | string | no | The ID of the firewall rule |

### Queries the information about images in a region
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the images. You can call the https://help.aliyun.com/document_detail/189315.html operation to query the most recent… |
| ImageIds | string | no | The image IDs. The value can be a JSON array that consists of up to 50 image IDs. Format: `["xxx", "yyy", … "zzz"]`. Separate multiple… |
| ImageType | string | no | The type of the images. Valid values: system: OS images app: application images custom: custom images |

### This topic describes the list of plans to which a specified simple application server can be upgraded
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-instance-plans-modification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query the most recent region list |
| InstanceId | string | yes | The ID of the Simple Application Server instance |

### Queries the status of simple application servers
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-instance-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application servers. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| InstanceIds | string | no | The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs.… |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Queries the details of one or more instances in a specified region
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server |
| InstanceIds | string | no | The instance IDs of the simple application servers. The value can be a JSON array that consists of up to 100 instance IDs. Separate… |
| ChargeType | string | no | The billing method of the instance. Valid values: PrePaid: subscription. Currently, only the subscription billing method is supported.… |
| PublicIpAddresses | string | no | The public IP addresses of the simple application servers. The value can be a JSON array that consists of up to 100 public IP addresses.… |
| PageNumber | integer | no | The page number of the simple application server list. Default value: 1 |
| PageSize | integer | no | The number of entries per page in a paged query. Maximum value: 100. Default value: 10 |
| Status | string | no | The instance status. Valid values: Pending: The instance is being prepared. Starting: The instance is starting. Running: The instance is… |
| Tag | string | no | The tags of the instance (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the simple application server belongs |
| InstanceName | string | no | The name of the simple application server. You can use the asterisk (*) wildcard for fuzzy search |
| PlanType | string | no | The plan type. Valid values: NORMAL: general-purpose. CAPACITY: storage-optimized. PREVIOUS: previous generation. MULTI_IP:… |

### Queries the details about data transfer plans of simple application servers
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-instances-traffic-packages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application servers. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| InstanceIds | string | yes | The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs.… |

### The list of key pairs
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-key-pairs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/189315.html to query available regions |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a unique value for this parameter from your client to… |
| KeyPairName | string | no | The name of the key pair. The name must be 2 to 64 characters in length and can contain letters and Chinese characters. It must start with… |
| PageNumber | integer | no | The page number of the key pair list. Minimum value: 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page |

### Queries all plan information for simple application servers in a specified region
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/189315.html to query the available regions for simple application… |

### Queries all regions in which Simple Application Server is supported
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| AcceptLanguage | string | no | The language of the response. Valid values: zh-CN (default): Chinese en-US: English |

### Queries information about one or more snapshots that have been created
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-snapshots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server to which the snapshot belongs |
| InstanceId | string | no | The instance ID of the simple application server |
| DiskId | string | no | The ID of the disk |
| SnapshotIds | string | no | The snapshot IDs. The value can be a JSON array that consists of up to 100 snapshot IDs. Separate multiple IDs with commas (,) |
| PageSize | integer | no | The number of entries per page for a paged query. Maximum value: 100. Default value: 10 |
| PageNumber | integer | no | The page number of the snapshot list. Default value: 1 |
| SourceDiskType | string | no | The type of the source cloud disk for the snapshot. Valid values: System: system cloud disk. Data: data cloud disk |
| Tag | string | no | The tags of the snapshot (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries the tags that are added to simple resources, such as instances, snapshots, disks, images, commands,…
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ClientToken | string | no | The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must… |
| NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results |
| ResourceType | string | yes | The resource type. Valid values: instance snapshot customimage command firewallrule disk |
| ResourceId | string | no | The ID of the resource. You can specify up to 50 resource IDs (JSON-encoded) |
| Tag | string | no | The list of tags. You can specify up to 20 tags (JSON-encoded) |

### Performs a remote logon to a simple application server by using Workbench
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/login-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call https://help.aliyun.com/document_detail/189315.html to view the supported… |
| InstanceId | string | yes | The instance ID of the simple application server |
| Username | string | no | The username for the simple application server. No username is required for Linux servers. The default username for a Windows server is… |
| Password | string | no | The password for the simple application server. Linux servers: No password is required. Windows servers: Enter the configured password. If… |
| Port | integer | no | The port number for remote logon to the instance. Linux servers: The default port is 22. Windows servers: The default port is 3389. If you… |

### Modifies the description of a lightweight database instance
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/modify-database-instance-description` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the lightweight database instance. You can call the https://help.aliyun.com/document_detail/189315.html operation to… |
| DatabaseInstanceId | string | yes | The instance ID of the lightweight database instance |
| ClientToken | string | no | Ensures the idempotence of the request. You can generate the value from your client to ensure that the value is unique across different… |
| DatabaseInstanceDescription | string | yes | The description of the lightweight database instance |

### After you create a Simple Application Server database service instance, you can view and modify its parameters
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/modify-database-instance-parameter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the database instance. Call https://help.aliyun.com/document_detail/189315.html to view the supported Alibaba Cloud regions |
| DatabaseInstanceId | string | yes | The ID of the database instance |
| Parameters | string | yes | A JSON string that specifies the database parameters and their values. The value for each parameter must be a string. Format:… |
| ForceRestart | string | no | Specifies whether to restart the database for the parameter changes to take effect. Valid values: true: Forces a restart. Set this to true… |
| ClientToken | string | no | A client-generated token to ensure request idempotence. You must ensure that the token is unique for each request. It can contain only… |

### Modifies a firewall rule of a specified simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/modify-firewall-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID of the specified simple application server |
| RegionId | string | yes | The region ID of the specified simple application server. You can call https://help.aliyun.com/document_detail/189315.html to query the… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. A client token is a unique string generated by your client. The… |
| RuleId | string | yes | The firewall rule ID |
| RuleProtocol | string | yes | The transport-layer protocol. Valid values: TCP: TCP protocol. UDP: UDP protocol. TCP+UDP: TCP and UDP protocols |
| Port | string | yes | The port range. Valid values of port numbers: 1 to 65535. Separate the start port and end port with a forward slash (/). Example:… |
| SourceCidrIp | string | no | The IP address or CIDR block |
| Remark | string | no | The remarks of the firewall rule |

### Updates the firewall rules in an existing firewall template based on your business requirements and applies…
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/modify-firewall-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Simple Application Server instance. You can call the https://help.aliyun.com/document_detail/189315.html operation to… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, and you must make… |
| FirewallTemplateId | string | yes | The ID of the firewall template |
| Name | string | no | The name of the firewall template |
| Description | string | no | The description of the firewall template |
| FirewallTemplateRule | string | no | The firewall rules (JSON-encoded) |

### Shares or unshares a custom image to Elastic Compute Service (ECS)
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/modify-image-share-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the custom image. You can call the https://help.aliyun.com/document_detail/189315.html operation to query the most recent… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| ImageId | string | yes | The image ID |
| Operation | string | yes | Valid values: Share UnShare |

### Changes the VNC password of a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/modify-instance-vnc-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the simple application server |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| VncPassword | string | no | The VNC connection password |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |

### Restarts a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/reboot-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the simple application server |
| RegionId | string | yes | The region ID |
| ClientToken | string | no | Ensures the idempotence of the request. Generate a parameter value from your client to ensure that the value is unique across different… |

### Restarts simple application servers
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/reboot-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application servers. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| InstanceIds | string | yes | The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs.… |
| ForceReboot | string | no | Specifies whether to forcibly restart the servers. Valid values: true: forcibly restarts the servers. This operation is equivalent to the… |

### Releases the public endpoint of a lightweight database instance if you no longer need to access it from the…
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/release-public-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the lightweight database instance. You can call https://help.aliyun.com/document_detail/189315.html to query for… |
| DatabaseInstanceId | string | yes | The ID of the lightweight database instance |
| ClientToken | string | no | A client-generated token to ensure request idempotence. You must ensure that this token is unique for each request. For more information,… |

### Unshares a custom image that is shared across Alibaba Cloud accounts
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/remove-custom-image-share-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| ImageId | string | yes | The ID of the shared custom image |
| Account | string | yes | The IDs of the Alibaba Cloud accounts with which you want to unshare the image (JSON-encoded) |

### Renews a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/renew-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the simple application server |
| RegionId | string | yes | The region ID of the server |
| Period | integer | yes | The renewal period. Unit: month. Valid values: 1, 3, 6, 12, 24, and 36 |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |

### Resets the password of the administrator account for a database. You can call this operation to change the…
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/reset-database-account-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server database instance. You can call the https://help.aliyun.com/document_detail/189315.html… |
| DatabaseInstanceId | string | yes | The instance ID of the simple application server database |
| AccountPassword | string | yes | The password of the administrator account for the database |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, and you must ensure… |

### Rolls back a disk to a snapshot
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/reset-disk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server to which the snapshot belongs |
| DiskId | string | yes | The ID of the disk to be rolled back |
| ClientToken | string | no | Ensures the idempotence of the request. You can generate a parameter value on your client to ensure that the value is unique across… |
| SnapshotId | string | yes | The ID of the snapshot |

### Resets a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/reset-system` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the simple application server |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query the most recent region list |
| ImageId | string | no | The ID of the destination image. If you do not specify this parameter, the current image is reset |
| ClientToken | string | no | The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must… |
| LoginCredentials | string | no | The information about the logon credentials (JSON-encoded) |

### Call this operation to restart a lightweight database instance in the Running state
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/restart-database-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the lightweight database instance. Call https://help.aliyun.com/document_detail/189315.html to get the latest list of… |
| DatabaseInstanceId | string | yes | The ID of the lightweight database instance |
| ClientToken | string | no | A client-generated token to ensure request idempotency. The token must be unique for each request. The token can contain only ASCII… |

### Runs a command on a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/run-command` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| CommandContent | string | yes | The command content. Note the following items: Set `EnableParameter=true` to enable the custom parameter feature in the command content:… |
| WorkingDir | string | no | The custom execution path of the command. Default paths: Linux instances: The default execution path is the /root directory of the root… |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/189315.html to query the latest region list |
| Timeout | integer | no | The timeout period for the command to run on the server instance. Unit: seconds. When a command execution task times out, Command… |
| Type | string | yes | The language type of the command. Valid values: RunBatScript: Bat commands for Windows instances. RunPowerShellScript: PowerShell commands… |
| EnableParameter | string | no | Specifies whether the command contains custom parameters. Default value: false |
| Parameters | string | no | The key-value pairs of custom parameters to pass in when the command contains custom parameters. For example, if the command content is… |
| WorkingUser | string | no | The user that you want to use to run the command on the simple application server instance. We recommend that you use a regular user to… |
| WindowsPasswordName | string | no | The password name of the user that runs the command on a Windows instance. If you want to run a command as a non-default user (System) on… |
| InstanceId | string | yes | The instance ID of the simple application server |
| Name | string | yes | The name of the command execution |

### Starts a database instance
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/start-database-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the database instance. You can call the https://help.aliyun.com/document_detail/189315.html operation to obtain the… |
| DatabaseInstanceId | string | yes | The ID of the database instance |
| ClientToken | string | no | A client-generated token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must… |

### Starts a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/start-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the simple application server |
| RegionId | string | yes | The region ID of the server |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |

### Starts one or more simple application servers
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/start-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application servers. You can call https://help.aliyun.com/document_detail/189315.html to query the list of… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. A client token is a unique string generated by your client. It can… |
| InstanceIds | string | yes | The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 instance IDs. Separate multiple… |

### Starts a session to log on to a Simple Application Server instance
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/start-terminal-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Simple Application Server instance. You can call the https://help.aliyun.com/document_detail/189315.html operation to… |
| InstanceId | string | yes | The ID of the Simple Application Server instance |
| CommandLine | string | no | The command to run after the session is started. The command can be up to 512 characters in length |

### Stops a lightweight database instance
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/stop-database-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the lightweight database instance. You can call https://help.aliyun.com/document_detail/189315.html to view the supported… |
| DatabaseInstanceId | string | yes | The ID of the lightweight database instance |
| ClientToken | string | no | A client-generated token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must… |

### Stops a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/stop-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the specified simple application server |
| RegionId | string | yes | The region ID |
| ClientToken | string | no | Ensures the idempotence of the request. Generate a parameter value from your client to ensure that the value is unique across different… |

### Stops one or more simple application servers
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/stop-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server instance. You can call the https://help.aliyun.com/document_detail/189315.html operation to… |
| ClientToken | string | no | Ensures the idempotence of the request. You can generate the parameter value on your client and ensure that the value is unique across… |
| InstanceIds | string | yes | The instance IDs of the simple application servers. The value can be a JSON array that consists of up to 100 instance IDs. Separate… |
| ForceStop | string | no | Specifies whether to forcibly stop the instance. true: forcibly stops the instance. false (default): normally stops the instance |

### Adds tags to simple application servers, snapshots, custom images, commands, firewall rules, and disks to…
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ClientToken | string | no | The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must… |
| ResourceType | string | yes | The resource type. Valid values: instance snapshot customimage command firewallrule disk |
| ResourceId | string | yes | The resource IDs. You can specify up to 50 resource IDs (JSON-encoded) |
| Tag | string | yes | The list of tags. You can specify up to 20 tags (JSON-encoded) |

### Unbinds and deletes tags from specified lightweight resources, such as instances, snapshots, disks, images,…
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ClientToken | string | no | The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must… |
| ResourceType | string | yes | The resource type. Valid values: instance snapshot customimage command firewallrule disk |
| All | string | no | Specifies whether to remove all tags from the specified one or more resources. This parameter takes effect only if the TagKey.N parameter… |
| ResourceId | string | yes | The resource IDs. You can specify up to 50 resource IDs (JSON-encoded) |
| TagKey | string | no | The key of tag N. Valid values of N: 1 to 20 (JSON-encoded) |

### Modifys the parameter of a command
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/update-command-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/189315.html operation to query the most recent region list |
| CommandId | string | yes | The command ID. You can call the https://help.aliyun.com/document_detail/64843.html operation to query all available command IDs |
| Name | string | no | The name of the command. The name supports all character sets and can be up to 128 characters in length |
| Description | string | no | The description of the command. The description supports all character sets and can be up to 512 characters in length |
| WorkingDir | string | no | The working directory of the command. The directory can be up to 200 characters in length |
| Timeout | integer | no | The maximum timeout period for the command execution on the ECS instance. Unit: seconds. When a command that you created cannot be run,… |

### Modifies the remarks for the data disk that is attached to a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/update-disk-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| DiskId | string | yes | The disk ID. You can call the ListDisks operation to query the ID of data disk |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| Remark | string | yes | The remarks of the data disk |

### Modifies the information of an instance, including the instance name and password
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/update-instance-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the Simple Application Server |
| RegionId | string | yes | The region ID of the Simple Application Server |
| Password | string | no | The new password of the server. The password must be 8 to 30 characters in length and must contain at least three of the following… |
| InstanceName | string | no | The name of the server. The name must be 2 to 50 characters in length, and must start with a letter, digit, or Chinese character. It can… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |

### Modifies the remarks of a snapshot of a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/update-snapshot-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| SnapshotId | string | yes | The snapshot ID. You can call the ListSnapshots operation to query the snapshot ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| Remark | string | no | The remarks of the snapshot of the simple application server |

### Upgrades the plan configuration for a specified simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/upgrade-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the specified simple application server |
| RegionId | string | yes | The region ID of the specified simple application server |
| PlanId | string | yes | The ID of the plan to which you want to upgrade. You can call https://help.aliyun.com/document_detail/189314.html to query plan information |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |

### Imports a key pair for a simple application server
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/upload-instance-key-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the simple application server. You can call the https://help.aliyun.com/document_detail/189315.html operation to query… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| InstanceId | string | yes | The ID of the simple application server |
| KeyPairName | string | no | The name of the key pair |
| PublicKey | string | no | The public key |

### version
`POST https://apizie.tech/v1/cloud:aliyun-swas-open/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://swas.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-swas-open/add-custom-image-share-account" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Simple Application Server API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-swas-open/add-custom-image-share-account with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Simple Application Server API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Simple Application Server itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Simple Application Server API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-swas-open.

### What is the status of the Alibaba Cloud Simple Application Server API?
Needs your own provider key (bring your own key)