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

Operation description

After you create a simple application server, you can log on to the simple application server to build environments and applications on the 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: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 the ListRegions operation to query the most recent region list.	cn-hangzhou
InstanceId	string	Yes	The ID of the simple application server.	9ae7106e68eb4402b0dcbd48a9de****
Username	string	No	The username of the simple application server. For a Linux server, you do not need to enter a username. For a Windows server, the default username `administrator` is used.	administrator
Password	string	No	The password that corresponds to the username. For a Linux server, you do not need to enter a password. For a Windows server, enter the password that you set. If you have not set a password for the simple application server, set a password. For more information, see Reset the password.	Test****
Port	integer	No	The port number that is used to log on to the simple application server by using Workbench. Linux servers: The default value is 22. Windows servers: The default value is 3389. Note If you want to connect to a server by using a custom port, you must modify the default remote connection port. For more information, see Configure a custom remote connection port.	3389

Response elements

Element	Type	Description	Example
	object	Schema of response.
RequestId	string	The request ID.	C2DE174B-7196-5778-A00D-6EA2601B****
RedirectUrl	string	The URL that you use to log on to the server.	https://ecs-workbench.aliyun.com/view/instance/single/gbktfz****

Examples

Success response

JSON format

{
  "RequestId": "C2DE174B-7196-5778-A00D-6EA2601B****",
  "RedirectUrl": "https://ecs-workbench.aliyun.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.