Unbind an SSH key pair
Function
This API is used to unbind an SSH key pair from a specified VM and restore SSH password login.
URI
POST /v3/{project_id}/keypairs/disassociate
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
server |
Yes |
DisassociateEcsServerInfo object |
Information about the VM to which the key pair is to be bound. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
ID of the VM to which the SSH key pair is to be bound (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. |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
ID returned when a task is successfully delivered. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
{ "server" : { "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7", "authentication" : { "type" : "keypair", "key" : "-----BEGINRSAPRIVATEKEY-----\nM..." } } }
{ "server" : { "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7" } }
Example Responses
Status code: 202
OK.
{ "task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c" }
Status code: 400
Error occurred.
{ "error_code" : "KPS.XXX", "error_msg" : "XXX" }
Status Codes
Status Code |
Description |
---|---|
202 |
OK. |
400 |
Error occurred. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot