绑定密钥对

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

1. 接口描述

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

本接口 (AssociateInstancesKeyPairs) 用于将密钥绑定到实例上。

  • 将密钥的公钥写入到实例的SSH配置当中,用户就可以通过该密钥的私钥来登录实例。
  • 如果实例原来绑定过密钥,那么原来的密钥将失效。
  • 如果实例原来是通过密码登录,绑定密钥后无法使用密码登录。
  • 支持批量操作。每次请求批量实例的上限为100。如果批量实例存在不允许操作的实例,操作会以特定错误码返回。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AssociateInstancesKeyPairs
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
InstanceIds.N Array of String 一个或多个待操作的实例ID,每次请求批量实例的上限为100。
可以通过以下方式获取可用的实例ID:
  • 通过登录控制台查询实例ID。
  • 通过调用接口 DescribeInstances ,取返回信息中的InstanceId获取实例ID。
  • KeyIds.N Array of String 一个或多个待操作的密钥对ID,每次请求批量密钥对的上限为100。密钥对ID形如:skey-3glfot13
    可以通过以下方式获取可用的密钥ID:
  • 通过登录控制台查询密钥ID。
  • 通过调用接口 DescribeKeyPairs ,取返回信息中的KeyId获取密钥对ID。
  • ForceStop Boolean 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机,然后再绑定密钥。取值范围:
  • TRUE:表示在正常关机失败后进行强制关机。
  • FALSE:表示在正常关机失败后不进行强制关机。
    默认取值:FALSE。
  • 3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 绑定云主机密钥对

    输入示例

    https://cvm.tencentcloudapi.com/?Action=AssociateInstancesKeyPairs
    &InstanceIds.0=ins-1e4r6y8i
    &InstanceIds.1=ins-3e56fg78
    &KeyIds.0=skey-4e5ty7i8
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidKeyPairId.Malformed 无效密钥对ID。指定的密钥对ID格式错误,例如 ID 长度错误skey-1122
    InvalidKeyPairId.NotFound 无效密钥对ID。指定的密钥对ID不存在。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    MissingParameter 参数缺失。请求没有带必选参数。

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