Domain name for API request: cvm.tencentcloudapi.com.
This API is used to query key pairs.
A maximum of 10 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeKeyPairs. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| KeyIds.N | No | Array of String | Key pair ID(s) in the format of skey-11112222. This API supports using multiple IDs as filters at the same time. For more information on the format of this parameter, see the id.N section in API Introduction. You cannot specify KeyIds and Filters at the same time. You can log in to the console to query the key pair IDs. |
| Filters.N | No | Array of Filter | Filters.project-id - Integer - Optional - Filter results by project ID. To view the list of project IDs, you can go to Project Management, or call DescribeProject and look for projectId in the response. key-name - String - Optional - Filter results by key pair name. KeyIds and Filters at the same time. |
| Offset | No | Integer | Offset; default value: 0. For more information on Offset, see the corresponding sections in API Introduction. Number of results returned; default value: 20; maximum: 100. For more information on Limit, see the corresponding section in API Introduction. |
| Limit | No | Integer | Number of results returned; default value: 20; maximum: 100. For more information on Limit, see the corresponding section in API Introduction. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of key pairs meeting the filtering conditions. |
| KeyPairSet | Array of KeyPair | Detailed information on key pairs. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
GET https://cvm.tencentcloudapi.com/?Action=DescribeKeyPairs
&Filters.0.Name=key-name
&Filters.0.Values.0=Tencent
&Offset=0
&Limit=20
&<Common request parameters>{
"Response": {
"TotalCount": 1,
"KeyPairSet": [
{
"KeyId": "skey-mv9yzyjj",
"KeyName": "Tencent",
"Description": "",
"PublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDP0Yw2T4itUKOJQIK69c1Asy1UO88cxEbujR5Jbr0e/Ey1v4ZKAUzDnsBnFlf4hKPA1YvMB8RBYj4GcLtM7PrKnBNNram8rgl73X/klOO8oqKv+J/XUA7KHH1Y6wcn1RTRTMdDHbGhW1q/UpfeylNTbf+wEIWhEfaL5FKQm4hqCw== skey_112168",
"AssociatedInstanceIds": [],
"CreateTime": "2016-12-02T00:22:40Z"
}
],
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalServerError | Internal error. |
| InvalidFilter | Invalid filter. |
| InvalidFilterValue.LimitExceeded | Filter |
| InvalidKeyPair.LimitExceeded | The number of key pairs exceeds the limit. |
| InvalidKeyPairId.Malformed | Invalid key pair ID. The specified key pair ID has an invalid format. For example, skey-1122 has an invalid ID length. |
| InvalidParameter | A parameter error occurred. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValueLimit | The number of parameter values exceeds the limit. |
| InvalidParameterValueOffset | Invalid parameter value: invalid Offset. |
Was this page helpful?