Bind a Key Pair to Secure Server Access via AttachKeyPair - Simple Application Server - Alibaba Cloud - Simple Application Server

Operation description

You can attach only one key pair to a simple application server in the console. If the selected simple application server is already attached to another key pair, the new key pair overwrites the existing one.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the specified lightweight database instance. You can call the ListRegions operation to query the list of supported Alibaba Cloud regions.	cn-hangzhou
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 different requests. ClientToken supports only ASCII characters and can be up to 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
InstanceIds	array	Yes	The IDs of the simple application servers. You can specify up to 50 instance IDs.
	string	No	The ID of the instance to which you want to attach the SSH key pair. You can specify up to 50 instance IDs.	2ad1ae67295445f598017499dc****
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 start with http:// or https://. It can contain digits, colons (:), underscores (_), and hyphens (-).	test

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	30637AD6-D977-4833-A54C-CC89483E****
TotalCount	integer	The total number of instances to which the key pair is attached.	2
FailCount	integer	The total number of instances to which the key pair failed to be attached.	2
Results	array<object>	The result list.
	object	The set of results for successful or failed key pair attachments.
Code	string	The result code.	200
Message	string	The result message.	success
Success	string	Indicates whether the key pair is successfully attached. Valid values: true: The key pair is successfully attached. false: The key pair failed to be attached.	true
InstanceId	string	The instance ID.	aa6e71ddb35c46679bc4753d6219d604

Examples

Success response

JSON format

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "TotalCount": 2,
  "FailCount": 2,
  "Results": [
    {
      "Code": "200",
      "Message": "success",
      "Success": "true",
      "InstanceId": "aa6e71ddb35c46679bc4753d6219d604"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidInstanceId.NotFound	The specified Instance Id does not exist.	The specified instance ID does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.