绑定SSH密钥对到Linux云主机
接口功能介绍
此接口提供用户绑定SSH密钥对到云主机功能。系统会接收用户输入的云主机id和SSH密钥对,将对应SSH密钥对绑定到对应云主机上。
接口约束
- 需要云主机处于工作状态
- 需要云主机的操作系统必须为linux
- 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
URI
POST /v4/ecs/keypair/attach
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
keyPairName | 是 | String | 密钥对名称。只能由数字、字母、-组成,不能以数字和-开头、以-结尾,且长度为2-63字符 | KeyPair-886 | |
ID | 是 | String | 云主机ID | b6e2966d-7b1c-385e-abe4-d940caa273b7 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为处理中或失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误信息 | ||
description | String | 失败时的错误描述 | ||
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
ID | String | 云主机ID | bab6830e-1cc6-42f1-6140-552c2ba21e3b |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"ID":"bab6830e-1cc6-42f1-6140-552c2ba21e3b",
"keyPairName":"keypair-886"
}
响应示例
{
"returnObj": {
"ID": "bab6830e-1cc6-42f1-6140-552c2ba21e3b"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Openapi.EcsWorkorder.AccessFailed | 查询云主机信息失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsFormat.FormatError | 查询云主机信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsCheck.UnknownError | 云主机检查失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Instance.NotFound | 云主机不存在,请确认云主机ID是否有效 |
Ecs.Instance.OsTypeNotAllow | 云主机操作系统类型不被允许,请确定云主机操作系统是否为linux |
Openapi.KeypairWorkorder.AccessFailed | 查询密钥对信息失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.KeypairFormat.FormatError | 查询密钥对信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Ecs.Keypair.NotExist | 密钥对不存在 ,请确认输入密钥对信息是否正确 |
Ecs.Instance.StatusNotValid | 云主机状态无效,请确认云主机状态是否符合操作条件,必须处于开机状态 |
Ecs.Keypair.ProjectNotSame | 密钥对与云主机不处于相同企业项目,请确定密钥对与云主机的企业项目信息 |
Openapi.KeypairWorkorder.BindError | 绑定密钥对失败,请重试。如果多次尝试失败,请提交工单 |