Help Center/ Data Encryption Workshop/ API Reference/ APIs/ Key Pair Management APIs/ Key pair task management/ Binding an SSH Key Pair
Updated on 2025-10-16 GMT+08:00
View PDF
Share

Binding an SSH Key Pair

Function

Binds an SSH key pair to a specified VM. (The private key of the SSH key pair for the VM is required if you want to replace the key pair, but not required if you want to reset the key pair.)

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    kps:SSHKeyPair:bind

    Write

    SSHKeyPair *

    -
    • kps:domainKeypairs:bind
    • ecs:cloudServers:createServers
    • ecs:cloudServers:deleteServers
    • ecs:cloudServers:showServer
    • ecs:cloudServers:attach
    • ecs:cloudServers:listServerBlockDevices
    • ecs:cloudServers:showServerBlockDevice
    • ecs:cloudServers:detachVolume
    • ecs:cloudServers:listServerInterfaces
    • ecs:cloudServers:listServersDetails
    • ecs:cloudServerFlavors:get
    • ecs:cloudServerQuotas:get
    • evs:types:get
    • evs:volumes:use
    • ims:images:get
    • vpc:subnets:list

URI

POST /v3/{project_id}/keypairs/associate

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

keypair_name

Yes

String

SSH key pair name

server

Yes

EcsServerInfo object

Information about the VM that the key pair is to be bound to
Table 4 EcsServerInfo

Parameter

Mandatory

Type

Description

id

Yes

String

ID of the VM that the SSH key pair is to be bound to (in order to replace or reset the original key pair).

auth

No

Auth object

(Optional) Authentication type. This parameter is required for key pair replacement but not required for key pair reset.

disable_password

No

Boolean

  • true: SSH login is disabled on the VM.

- false: SSH login is enabled on the VM.

port

No

Long

SSH listening port.
Table 5 Auth

Parameter

Mandatory

Type

Description

type

No

String

The value can be password or keypair.

key

No

String

  • If type is set to password, key indicates the password.

  • If type is set to keypair, key indicates the private key.

Response Parameters

Status code: 202

Table 6 Response body parameters

Parameter

Type

Description

task_id

String

ID returned when a task is delivered

server_id

String

Specifies the ID of the bound VM.

status

String

Indicates the delivery status of a task. SUCCESS or FAILED.

error_code

String

Error code returned when a task fails to be delivered.

error_msg

String

Error information returned when a task fails to be delivered.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

  • {
  "keypair_name" : "newkeypair1",
  "server" : {
    "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7",
    "auth" : {
      "type" : "keypair",
      "key" : "-----BEGINRSAPRIVATEKEY-----M..."
    }
  }
}
  • {
  "keypair_name" : "newkeypair2",
  "server" : {
    "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7"
  }
}

Example Responses

Status code: 202

OK

{
  "task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c"
}

Status code: 400

Error response

{
  "error_code" : "KPS.XXX",
  "error_msg" : "XXX"
}

Status Codes

Status Code

Description

202

OK

400

Error response

Error Codes

See Error Codes.

Parent Topic: Key pair task management