Call the LoginInstance API to log on to an instance on Workbench - Simple Application Server - Alibaba Cloud - Simple Application Server

Operation description

After you create a simple application server, you can perform a remote logon to the simple application server to set up environments and deploy applications.

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:LoginInstance

none

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application server. You can call ListRegions to view the supported Alibaba Cloud regions.	cn-hangzhou
InstanceId	string	Yes	The instance ID of the simple application server.	9ae7106e68eb4402b0dcbd48a9de****
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 `administrator`.	administrator
Password	string	No	The password for the simple application server. Linux servers: No password is required. Windows servers: Enter the configured password. If you did not set a password after purchasing the simple application server, see Reset the password.	Test****
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. Note If you want to connect to the server by using a custom port, you must first change the default remote port of the server. For more information, see Settings for custom remote connection ports.	3389

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	C2DE174B-7196-5778-A00D-6EA2601B****
RedirectUrl	string	The URL of the remote logon desktop.	https://ecs-workbench.alibabacloud.com/view/instance/single/gbktfz****

Examples

Success response

JSON format

{
  "RequestId": "C2DE174B-7196-5778-A00D-6EA2601B****",
  "RedirectUrl": "https://ecs-workbench.alibabacloud.com/view/instance/single/gbktfz****"
}

Error codes

HTTP status code	Error code	Error message	Description
500	INSTANCE_LOGIN_FAILURE	Instance login failure.	Instance login failed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.