Tenant Cloud Compute Cloud Virtual Machine Key APIs ModifyKeyPairAttribute

ModifyKeyPairAttribute

Last Updated At: 2026-08-02 00:05:21

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (ModifyKeyPairAttribute) is used to modify attributes of a key pair.

  • Modify the name and description information of the key pair specified by the key pair ID.
  • The key pair name should not be the same as the name of an existing key pair.
  • The key pair ID is the unique flag of the key pair and should not be modified.

Default interface request rate limit: 10 times per second.

Interface update time: 2018-04-04 09:23:06.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: ModifyKeyPairAttribute
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
KeyId Yes No String Key pair ID. The key pair ID is in the format of skey-11112222.

You can obtain the key ID in the following ways:
  • By querying the key ID by logging in to the Console.
  • By calling the KeyId in the returned information from the API DescribeKeyPairs.
    Example: skey-mv9yzyjj
    		•
    KeyName No No String Modified key pair name, can contain digits, letters, and underscores, with no more than 25 characters.
    Example: alice_use
    Description No No String Description information of modified key pair. It can be named as required, but should not exceed 60 characters.
    Example: KeyPair

    3. Output Parameters

    Parameter name Type Description
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameterValue Invalid parameter value. The format of the parameter value is incorrect or not supported, etc.
    InvalidKeyPairId.Malformed Invalid key pair ID. The format of the specified key pair ID is incorrect, for example, an ID length error skey-1122.
    InternalServerError Internal operation error.
    InvalidParameter Invalid parameter. The parameter does not meet the requirements, is not supported, or the like.
    InvalidKeyPairId.NotFound Invalid key pair ID. The specified key pair ID does not exist.
    MissingParameter Parameters are missing. The request did not include mandatory parameters.
    InvalidKeyPairName.Duplicate The key pair names are duplicate.