tencent cloud

Tencent Cloud Lighthouse

Release Notes and Announcements
Image Release Notes
Announcements
Product Introduction
Overview
Basic Concepts
Strengths
Scenarios
Use Limits
Region and Network Connectivity
Product Comparison
User Guide
Billing
Billing Overview
Instance Package
Pricing Details
Purchase Methods
Configuration Adjustment (for Upgrade Only)
Overdue Payments
Refund
Getting Started
One-Click Application Creation Using Lighthouse
Quick Instance Creation
User Guide
Instances
Cloud Disks
Images
Firewall
Private Network Interconnection
Data Backup and Restoration Using Snapshots
Cloud Access Management
OPS and Monitoring
File Transfer
Use Cases
Website Building
Development Environment Building
Cloud Storage System Building
E-commerce Platform Building
Personal Live Streaming Room Building
FTP Service Building
SSL Certificate Installation
Troubleshooting
Windows Instance: RDP Connection to the Remote Computer Fails
Windows Instance: Offline Password Resetting Fails or Invalid
Linux/Windows Instance: Online Password Resetting Fails or Invalid
API Documentation
History
Introduction
API Category
Making API Requests
Image APIs
Firewall APIs
Key APIs
Instance APIs
Snapshot APIs
CCN APIs
Other APIs
Cloud Disk APIs
Scene APIs
Package APIs
Quota APIs
Region APIs
Data Types
Error Codes
FAQs
Agreements
Privacy Policy
Data Processing And Security Agreement
Contact Us
DokumentasiTencent Cloud LighthouseAPI DocumentationKey APIsDescribeKeyPairs

DescribeKeyPairs

PDF
Mode fokus
Ukuran font
Terakhir diperbarui: 2025-10-30 21:47:16

1. API Description

Domain name for API request: lighthouse.intl.tencentcloudapi.com.

This API is used to query key pairs.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: 2020-03-24.
Region No String Common Params. This parameter is not required for this API.
KeyIds.N No Array of String Key pair ID list.
Offset No Integer Offset. Default value: 0.
Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.
Filters.N No Array of Filter Filter list.
  • key-id
    • Filter by key pair ID.
    Type: String
    Required: no
  • key-name
    • Filter by the key pair name. Fuzzy match is supported.
    Type: String
    Required: no
    Each request can contain up to 10 Filters and up to 5 Filter.Values for each filter. KeyIds and Filters cannot be specified at the same time.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible key pairs.
    KeyPairSet Array of KeyPair List of key pair details.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying key pair list

    Input Example

    POST / HTTP/1.1
Host: lighthouse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKeyPairs
<Common request parameters>

{
    "KeyIds": [
        "lhkp-omd12oc1"
    ]
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "KeyPairSet": [
            {
                "KeyId": "lhkp-omd12oc1",
                "KeyName": "test",
                "PublicKey": "",
                "AssociatedInstanceIds": [],
                "CreatedTime": "2020-04-28T23:01:47Z",
                "PrivateKey": "null"
            }
        ],
        "RequestId": "9abb999a-53d6-4534-9b49-00e53b5c0fea"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    InvalidParameter.InvalidFilter Invalid parameter: the Filter parameter is invalid.
    InvalidParameter.ParameterConflict Invalid parameter: the parameters conflict.
    InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
    InvalidParameterValue.KeyPairIdMalformed Invalid parametric value: the key pair ID format is invalid.
    InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
    InvalidParameterValue.Negative Invalid parametric value: it cannot be negative.
    InvalidParameterValue.OutOfRange Invalid parametric value: it is not within the valid range.
    UnauthorizedOperation.NoPermission No permission.
    Topik sebelumnya: DeleteKeyPairsTopik selanjutnya: DisassociateInstancesKeyPairs

    Bantuan dan Dukungan

    Apakah halaman ini membantu?

    masukan