Stop Instances via API on Simple Application Server - Simple Application Server - Alibaba Cloud - Simple Application Server

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

swas-open:StopInstances

update

*Instance

acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application server instance. You can call the ListRegions operation to query the supported Alibaba Cloud regions.	cn-hangzhou
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 different requests. The ClientToken parameter supports only ASCII characters and can be up to 64 characters in length. For more information, see Ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
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 multiple instance IDs with commas (,).	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]
ForceStop	boolean	No	Specifies whether to forcibly stop the instance. true: forcibly stops the instance. false (default): normally stops the instance.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C2DE174B-7196-5778-A00D-6EA2601B****

Examples

Success response

JSON format

{
  "RequestId": "C2DE174B-7196-5778-A00D-6EA2601B****"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.