LoginInstance - Simple Application Server - Alibaba Cloud Documentation Center

Logs on to a simple application server on Workbench.

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
swas-open:LoginInstance	none	*Instance `acs:swas-open:{#regionId}:{#accountId}:Instance/{#InstanceId}`	none	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 parameters

Parameter	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

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-06-24	The request parameters of the API has changed	View Change Details