绑定密钥对

最近更新时间:2024-03-12 01:19:20

我的收藏

1. 接口描述

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

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

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

    参数名称 类型 描述
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 绑定云服务器密钥对

    绑定云服务器密钥对

    输入示例

    GET 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 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    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.InstanceIdMalformed 实例ID不合要求,请提供规范的实例ID,类似ins-xxxxxxxx,字母x代表小写字符或数字。
    InvalidParameterValue.KeyPairNotSupported 指定的密钥不支持当前操作。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    MissingParameter 缺少参数错误。
    MutexOperation.TaskRunning 同样的任务正在运行。
    OperationDenied.InstanceOperationInProgress 实例正在执行其他操作,请稍后再试。
    UnauthorizedOperation.MFAExpired 您无法进行当前操作,请确认多因子认证(MFA)是否失效。
    UnauthorizedOperation.MFANotFound 没有权限进行此操作,请确认是否存在多因子认证(MFA)。
    UnsupportedOperation.InstanceOsWindows 请求不支持操作系统为Xserver windows2012cndatacenterx86_64的实例ins-xxxxxx
    UnsupportedOperation.InstanceStateEnterServiceLiveMigrate 不支持状态为 ENTER_SERVICE_LIVE_MIGRATE.的实例 ins-xxxxxx
    UnsupportedOperation.InstanceStateExitRescueMode 请求不支持正在退出救援模式的实例
    UnsupportedOperation.InstanceStateFreezing 操作不支持已冻结的实例。
    UnsupportedOperation.InstanceStateIsolating 请求不支持正在隔离状态的实例。
    UnsupportedOperation.InstanceStatePending 请求不支持创建未完成的实例
    UnsupportedOperation.InstanceStateRebooting 请求不支持正在重启的实例
    UnsupportedOperation.InstanceStateRescueMode 请求不支持救援模式的实例
    UnsupportedOperation.InstanceStateRunning 请求不支持开机状态的实例
    UnsupportedOperation.InstanceStateShutdown 请求不支持隔离状态的实例
    UnsupportedOperation.InstanceStateStarting 实例开机中,不允许该操作。
    UnsupportedOperation.InstanceStateStopping 请求不支持正在关机的实例
    UnsupportedOperation.InstanceStateTerminating 请求不支持正在销毁的实例
    UnsupportedOperation.StoppedModeStopCharging 不支持关机不收费特性