解绑密钥对

最近更新时间:2024-03-12 01:29:15

我的收藏

1. 接口描述

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

用于解除实例的密钥绑定关系。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DisassociateInstancesKeyPairs。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,本接口不需要传递此参数。
InstanceIds.N Array of String 可以通过以下方式获取可用的实例ID:
通过登录控制台查询实例ID。
通过调用接口 DescribeInstances ,取返回信息中的 InstanceId 获取实例ID。
示例值:["ein-8cnm1234"]
KeyIds.N Array of String 密钥对ID列表,每次请求批量密钥对的上限为100。密钥对ID形如:skey-11112222。

可以通过以下方式获取可用的密钥ID:
通过登录控制台查询密钥ID。
通过调用接口 DescribeKeyPairs ,取返回信息中的 KeyId 获取密钥对ID。
示例值:["skey-dklg1234"]
ForceStop Boolean 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机,然后再解绑密钥。取值范围:
TRUE:表示在正常关机失败后进行强制关机。
FALSE:表示在正常关机失败后不进行强制关机。

默认取值:FALSE。
示例值:false

3. 输出参数

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

4. 示例

示例1 解绑密钥对

输入示例

POST / HTTP/1.1
Host: ecm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DisassociateInstancesKeyPairs
<公共请求参数>

{
    "InstanceIds": [
        "ein-ss23fw23"
    ],
    "KeyIds": [
        "skey-3cvmq2vn"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "d40cdb72-7bc0-4b48-b3aa-25e8401f6999"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InstanceIdNotSupported 实例不支持当前操作。
InvalidParameterValue.InvalidKeyPairId 密钥ID无效。
InvalidParameterValue.LimitExceeded 参数值超出限制。
MissingParameter 缺少参数错误。