查询密钥对列表

最近更新时间:2018-12-06 21:42:29

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口 (DescribeKeyPairs) 用于查询密钥对信息。

  • 密钥对是通过一种算法生成的一对密钥,在生成的密钥对中,一个向外界公开,称为公钥;另一个用户自己保留,称为私钥。密钥对的公钥内容可以通过这个接口查询,但私钥内容系统不保留。

默认接口请求频率限制:10次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeKeyPairs
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
KeyIds.N Array of String 密钥对ID,密钥对ID形如:skey-11112222(此接口支持同时传入多个ID进行过滤。此参数的具体格式可参考 API 简介id.N 一节)。参数不支持同时指定 KeyIdsFilters。密钥对ID可以通过登录控制台查询。
Filters.N Array of Filter 过滤条件。
  • project-id - Integer - 是否必填:否 -(过滤条件)按照项目ID过滤。可以通过项目列表查询项目ID,或者调用接口 DescribeProject,取返回信息中的projectId获取项目ID。
  • key-name - String - 是否必填:否 -(过滤条件)按照密钥对名称过滤。
  • 参数不支持同时指定 KeyIdsFilters
    Offset Integer 偏移量,默认为0。关于 Offset 的更进一步介绍请参考 API 简介中的相关小节。返回数量,默认为20,最大值为100。关于 Limit 的更进一步介绍请参考 API 简介中的相关小节。
    Limit Integer 返回数量,默认为20,最大值为100。关于 Limit 的更进一步介绍请参考 API 简介中的相关小节。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的密钥对数量。
    KeyPairSet Array of KeyPair 密钥对详细信息列表。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 示例

    输入示例

    https://cvm.tencentcloudapi.com/?Action=DescribeKeyPairs
    &Filters.0.Name=key-name
    &Filters.0.Values.0=Tencent
    &Offset=0
    &Limit=20
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "KeyPairSet": [
          {
            "AssociatedInstanceIds": [],
            "CreateTime": "2016-12-02T00:22:40Z",
            "Description": "",
            "KeyId": "skey-mv9yzyjj",
            "KeyName": "Tencent",
            "PublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDP0Yw2T4itUKOJQIK69c1Asy1UO88cxEbujR5Jbr0e/Ey1v4ZKAUzDnsBnFlf4hKPA1YvMB8RBYj4GcLtM7PrKnBNNram8rgl73X/klOO8oqKv+J/XUA7KHH1Y6wcn1RTRTMdDHbGhW1q/UpfeylNTbf+wEIWhEfaL5FKQm4hqCw== skey_112168"
          }
        ],
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7",
        "TotalCount": 1
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidFilter 无效的过滤器。
    InvalidFilterValue.LimitExceeded Filter参数值数量超过限制。
    InvalidKeyPair.LimitExceeded 密钥对数量超过限制。
    InvalidKeyPairId.Malformed 无效密钥对ID。指定的密钥对ID格式错误,例如 ID 长度错误skey-1122
    InvalidParameter 无效参数。参数不合要求或者参数不被支持等。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    InvalidParameterValueLimit 参数值数量超过限制。
    InvalidParameterValueOffset 无效参数值。指定的 Offset 无效。

    如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >