1. Interface Description
Interface request domain name: cvm.api3.convergecloud.com.
This API (DescribeKeyPairs) is used to query key pair information.
- A key pair is a pair of keys generated through an algorithm, including two keys: one is made public, known as the public key, the other is retained by the user, known as the private key. For a key pair, content of the public key can be queried through this API, but content of the private key is not retained by the system.
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: DescribeKeyPairs |
| 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 | No | No | Array of String | Key pair ID. The key pair ID is in the format of skey-11112222 (This API supports filtering by passing multiple IDs at the same time. For the specific format of this parameter, see the section id.N in the API Introduction). This parameter does not support specifying KeyIds and Filters at the same time.You can query the key pair ID by logging in to the Console. Example: skey-11112222 |
| Filters | No | No | Array of Filter | Filter conditions support: key-name, tag-key, and tag-value. Parameters KeyIds and Filters cannot be specified at the same time.Example:View |
| Offset | No | No | Int64 | Offset, 0 by default. For further introduction to the Offset, see relevant sections in the API Introduction.Example: 0 |
| Limit | No | No | Int64 | Number of returns, 20 by default, and the maximum value is 100. For further introduction to the Limit, see relevant sections in the API Introduction.Example: 20 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalCount | Int64 | Number of eligible key pairs. Example: 1 |
| KeyPairSet | Array of KeyPair | List of detailed information of key pairs. Example:View |
| 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 |
|---|---|
| InvalidFilter | Invalid filter. |
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or not supported, etc. |
| InvalidParameterValueLimit | The parameter value is out of range |
| InvalidParameterValueOffset | Invalid parameter value. The specified offset is invalid. |
| InvalidFilterValue.LimitExceeded | The number of Filter parameter values exceeds the limit. |
| 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. |
| InvalidParameter | Invalid parameter. The parameter does not meet the requirements, is not supported, or the like. |