tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeKeyPairs

Last updated: 2023-12-04 16:31:54

    1. API Description

    Domain name for API request: lighthouse.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.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
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy