tencent cloud

边缘计算机器

产品公告
【2023年10月13日】边缘计算机器部分接口鉴权升级公告
【2022年06月01日】边缘计算机器网络带宽支持按天结算公告
新手指引
产品简介
产品概述
产品优势
应用场景
实例规格
购买指南
计费概述
购买方式
欠费说明
使用须知
快速入门
操作指南
登录 Linux 实例
登录 Windows 实例
管理边缘模块
管理实例
管理安全组
管理镜像
编辑标签
EIP直通
API 文档
History
API Category
Making API Requests
Region APIs
Module APIs
Instance APIs
Image APIs
VPC APIs
Subnet APIs
Route Table APIs
CLB APIs
ENI APIs
EIP APIs
HAVIP APIs
Other API
Key APIs
Security Group APIs
Data Types
Error Codes
常见问题
词汇表
ECM 政策
ECM 隐私协议
ECM 数据处理和安全协议
文档边缘计算机器API 文档Key APIsDisassociateInstancesKeyPairs

DisassociateInstancesKeyPairs

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 21:41:55

1. API Description

Domain name for API request: ecm.intl.tencentcloudapi.com.

This API is used to unbind a key pair from an instance.

A maximum of 20 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: DisassociateInstancesKeyPairs.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
InstanceIds.N Yes Array of String You can get available instance IDs in the following ways:
Log in to the console to query instance IDs.
Get the instance IDs from the InstanceId field in the information returned by the DescribeInstances API.
KeyIds.N Yes Array of String List of key pair IDs. Each request can contain up to 100 key pairs. The key pair ID takes the form of skey-11112222.

You can get available key IDs in the following ways:
Log in to the console to query key IDs.
Get the key pair IDs from the KeyId field in the information returned by the DescribeKeyPairs API.
ForceStop No Boolean Whether to force shut down the running instance. We recommend you manually shut down the running instance before unbinding the key. Valid values:
TRUE: yes.
FALSE: no.

Default value: FALSE.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Unbinding key pair

Input Example

POST / HTTP/1.1
Host: ecm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DisassociateInstancesKeyPairs
<Common request parameters>

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

Output Example

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

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
InvalidParameterValue The parameter value is incorrect.
InvalidParameterValue.InstanceIdNotSupported The instance does not support the current operation.
InvalidParameterValue.InvalidKeyPairId Invalid key ID.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
MissingParameter The parameter is missing.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈