Binds a key pair to simple application servers.
Operation description
You can bind only one key pair to a simple application server in the Simple Application Server console. If a simple application server has a key pair bound, the new key pair overwrites the original key pair.
Debugging
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 Resourcesis 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:AttachKeyPair | update |
|
| 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 |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence. | 123e4567-e89b-12d3-a456-426655440000 |
| InstanceIds | array | Yes | The IDs of simple application servers. You can specify a maximum of 50 IDs of simple application servers. | |
| string | Yes | The ID of the simple application server to which you want to bind the SSH key pair. You can specify a maximum of 50 IDs of simple application servers. | ["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"] | |
| KeyPairName | string | Yes | The name of the key pair that you want to bind to the simple application server. The name must be 2 to 64 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://. | test_gin |
Response parameters
Examples
Sample success responses
JSONformat
{
"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 |
|---|---|---|
| 404 | InvalidInstanceId.NotFound | The specified Instance Id does not exist. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-28 | The Error code has changed | View Change Details |