接口功能介绍
此接口提供用户绑定SSH密钥对到云主机功能。系统会接收用户输入的云主机id和SSH密钥对，将对应SSH密钥对绑定到对应云主机上。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
如果实例已经绑定了SSH密钥对，新的SSH密钥对自动替换原来的SSH密钥对
接口约束
1.云主机必须存在
2.需要云主机处于运行中（running）状态
3.需要云主机的操作系统必须为linux
4.密钥对名称必须存在
5.密钥对与云主机必须处于相同企业项目
URI
POST /v4/ecs/keypair/attach-instance
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| keyPairName | 是 | String | 密钥对名称。满足以下规则：只能由数字、字母、-组成，不能以数字和-开头、以-结尾，且长度为2-63字符。 | KeyPair-886 | |
| instanceID | 是 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
b6e2966d-7b1c-385e-abe4-d940caa273b7 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中或失败) | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误信息，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceID | String | 云主机ID | 39341024-9c57-4be4-a580-ae809d44bafd |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：在华东1资源池绑定一个名称为"keypair-886"的密钥对到一台云主机
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID":"bab6830e-1cc6-42f1-6140-552c2ba21e3b",
"keyPairName":"keypair-886"
}
响应示例
{
"returnObj": {
"instanceID": "bab6830e-1cc6-42f1-6140-552c2ba21e3b"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
