Updating SSH Key Pair Description

This API is used to update the SSH key pair description.

For details, see Calling APIs.

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

Write

SSHKeyPair *

-

kps:domainKeypairs:update

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
kps:SSHKeyPair:update	Write	SSHKeyPair *	-	kps:domainKeypairs:update	-

PUT /v3/{project_id}/keypairs/{keypair_name}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A
keypair_name	Yes	String	Definition Key pair name Constraints Key pair name. The value can contain at most 255 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. Range N/A Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
keypair	Yes	UpdateKeypairDescriptionReq object	Definition Message body for updating the SSH key pair description Constraints N/A Range N/A Default Value N/A

**Table 4** UpdateKeypairDescriptionReq
Parameter	Mandatory	Type	Description
description	Yes	String	Definition Description Constraints N/A Range N/A Default Value N/A

Status code: 200

None

{
  "keypair" : {
    "description" : "description"
  }
}

None

Status Code	Description
200	OK

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.