제품 동향
공용 이미지 업데이트 동향
운영 체제 공식 지원 종료 계획
제품 공지
Domain name for API request: cvm.intl.tencentcloudapi.com.
This API is used to query key pairs.
A maximum of 10 requests can be initiated per second for this API.
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 Params. The value used for this API: DescribeKeyPairs. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| 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 | Filtersproject-id - Integer - Optional - Filter by project ID. To view the list of project IDs, you can go to Project Management, or call the DescribeProject API and look for projectId in the response.key-name - String - Optional - Filter by key pair name.KeyIds and Filters at the same time. |
| Offset | No | Integer | Offset. The default value is 0. For more information on Offset, see the relevant 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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the list of key pairs.
POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKeyPairs
<Common request parameters>
{
"Filters": [
{
"Name": "key-name",
"Values": [
"MyKeyPair"
]
}
],
"Offset": 0,
"Limit": 1
}{
"Response": {
"KeyPairSet": [
{
"AssociatedInstanceIds": [],
"CreatedTime": "2025-10-16T08:12:48Z",
"Description": "",
"KeyId": "skey-1q8j7b93",
"KeyName": "MyKeyPair",
"ProjectId": 0,
"PublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC8gSdflU6iZDlLp3uRgfIQ7d9gl4SzF2yO9BJ1VyzhgWkbYsUS8u7qbwxC6UeAc8364FhT4MjVjXi/+6hYpDnnMiK6lqKBxotLupUtkVmYt+osdPP+y3OcCzTqHWCsY3s7AvyvD41+nuH6LrpXZ4LlHJynPc66eqd5gpnCyg2O1sxW+pd2Zigk0QGWiCuVtm4ICEp3DNHG/9wlVzd++xODf398JU3ebxBsXfe46mFSkyBVbsJLuNueZd4eGDS3q0WhimnvpgZoYOGsNPl4GBLCGOHWZrl/9hE+az6P8W7QwpVe5gvy5MG3usk6zpc0f/diZrdXX7 skey-1q8j7b93",
"Tags": [
{
"Key": "MyKeyPairTagKey",
"Value": "MyKeyPairTagValue"
}
]
}
],
"RequestId": "eebd54d0-a305-4716-9a84-6017ac14e8c8",
"TotalCount": 120
}
}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 | The value of Filter exceeds the limit. |
| 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. |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| InvalidParameterValueLimit | The number of parameter values exceeds the limit. |
| InvalidParameterValueOffset | Invalid parameter value: invalid Offset. |
| UnauthorizedOperation.InvalidToken | Check if the token is valid. |
| UnsupportedOperation | Unsupported operation. |
피드백