1. Interface Description
Interface request domain name: cvm.api3.convergecloud.com.
This API is used to delete key pairs managed on the cloud platform.
Multiple key pairs can be deleted at the same time.
Key pairs referenced by instances or images cannot be deleted. Therefore, it is necessary to independently determine whether each key pair is successfully deleted.
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: DeleteKeyPairs |
| 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 |
| KeyIds | Yes | No | Array of String | One or more key pair IDs to be operated. A maximum of 100 batch instances per request are allowed. You can obtain an available key pair ID in the following ways: KeyId in the returned information from the API DescribeKeyPairs.Example: ["skey-mv9yzyjj"] |
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. |
| InvalidKeyPair.LimitExceeded | The number of key pairs exceeds the limit. |
| InternalServerError | Internal operation error. |
| InvalidParameterValue.LimitExceeded | The parameter value is out of range |
| MissingParameter | Parameters are missing. The request did not include mandatory parameters. |
| InvalidParameterValue.KeyPairNotSupported | The key is not supported. |