全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网

跳板机相关接口

更新时间:2017-06-07 13:26:11

cn-hangzhou HPC产品一期特有接口

StartJumpserver

启动跳板机

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:StartJumpserver
RegionId String 实例所属Region ID,默认cn-hangzhou
InstanceId String HPC实例ID
Force Integer 设置为1,则无视资源当前状态,强制执行操作

返回值

只有公共返回参数

错误码

错误代码 Http状态码 错误信息 语义
InvalidInstanceId.NotFound 404 No such instance or instance invalid 该实例不存在
IncorrectInstanceStatus 403 Resource in an invalid status 资源状态不正确
MissingParameter 400 Missing parameter 缺少参数
InternalError 500 Unknown error 其他错误

StopJumpserver

停止跳板机

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:StopJumpserver
RegionId String 实例所属Region ID,默认cn-hangzhou
InstanceId String HPC实例ID
Force Integer 设置为1,则无视资源当前状态,强制执行操作

返回值

只有公共返回参数

错误码

错误代码 Http状态码 错误信息 语义
InvalidInstanceId.NotFound 404 No such instance or instance invalid 该实例不存在
IncorrectInstanceStatus 403 Resource in an invalid status 资源状态不正确
MissingParameter 400 Missing parameter 缺少参数
InternalError 500 Unknown error 其他错误

RebootJumpserver

重启跳板机

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:RebootJumpserver
RegionId String 实例所属Region ID,默认cn-hangzhou
InstanceId String HPC实例ID
Force Integer 设置为1,则无视资源当前状态,强制执行操作

返回值

只有公共返回参数

错误码

错误代码 Http状态码 错误信息 语义
InvalidInstanceId.NotFound 404 No such instance or instance invalid 该实例不存在
IncorrectInstanceStatus 403 Resource in an invalid status 资源状态不正确
MissingParameter 400 Missing parameter 缺少参数
InternalError 500 Unknown error 其他错误

ModifyJumpserverPassword

修改跳板机密码(需要重启跳板机后生效)

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:ModifyJumpserverPassword
RegionId String 实例所属Region ID,默认cn-hangzhou
InstanceId String HPC实例ID
NewPassword String 重置为用户指定的密码。8-30个字符,必须同时包含三项(大、小写字母,数字和特殊符号)。
支持以下特殊字符:( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ‘ < > , . ? /
如果传入 Password 参数,请务必使用 HTTPS 协议调用 API 以避免可能发生的密码泄露。

返回值

只有公共返回参数

错误码

错误代码 Http状态码 错误信息 语义
InvalidInstanceId.NotFound 404 No such instance or instance invalid 该实例不存在
InvalidPassword 403 Breaked the password generation rule 违反密码生成规则
MissingParameter 400 Missing parameter 缺少参数
InternalError 500 Unknown error 其他错误
本文导读目录