全部产品

实例相关接口

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

CreateInstance

新建HPC实例

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:CreateInstance
RegionId String 实例所属Region ID,默认cn-hangzhou
PackageId String 套餐类型,可选 G2 / G4

返回值

名称 类型 描述
InstanceId String 实例ID,访问HPC实例的唯一标识

错误码

错误代码 Http状态码 错误信息 语义
StockShortage 200 HPC stock shortage 库存不足
CreateOrderFailed 200 Create order failed 创建订单失败
CreateInstanceFailed 200 Create instance failed 创建实例失败
InvalidRegionId 200 Invalid regionId 无效的RegionId
InvalidPackageId 200 Invalid packageId 无效的PackageId
MissingParameterRegionId 400 Missing parameter regionId 缺少RegionId参数
MissingParameterPackageId 400 Missing parameter packageId 缺少PackageId参数
MissingParameterAliyunId 400 Invalid accessId or accessKey 无效的accessId或 accessKey
InternalError 500 Unknown error 未知错误

DeleleInstance

释放HPC实例(数据将会被删除)

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:DeleteInstance
RegionId String 实例所属Region ID,默认cn-hangzhou
InstanceId String 实例ID

返回值

只有公共返回参数

错误码

错误代码 Http状态码 错误信息 语义
ReleaseInstanceFailed 200 Release instance failed 释放实例失败
InvalidAccount 200 Invalid accessId or accessKey 无效的accessId或 accessKey
InvalidRegionId 200 Invalid RegionId 无效的RegionId
MissingParameterRegionId 400 Missing parameter regionId 缺少RegionId参数
MissingParameterInstanceId 400 Missing parameter instanceId 缺少InstanceId参数
MissingParameterAliyunId 400 Missing accessId or accessKey 缺少accessId或 accessKey
InvalidInstanceId.NotFound 404 No such instance or instance invalid 不存在该实例或者实例状态异常
InternalError 500 Unknown error 未知错误

RebootInstance

重启HPC实例

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:RebootInstance
RegionId String 实例所属Region ID,默认cn-hangzhou
InstanceId String 实例ID

返回值

只有公共返回参数

错误码

错误代码 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 其他错误

DescribeInstances

查询HPC实例信息

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:DescribeInstances
RegionId String 实例所属Region ID,默认cn-hangzhou
InstanceId String 实例ID作为过滤器,不指定此项则返回所有实例列表
InstanceType String 付费方式作为过滤器,取值PREPAY(包月实例)或者POSTPAY(按量实例)

返回值

返回实例列表,列表中每条记录包含如下字段:

名称 类型 描述
InstanceId String HPC实例ID
InstanceType String PREPAY(包月实例)或者POSTPAY(按量实例)
PackageId String G2或者G4
Status String 实例状态(running/stopped/stopping/starting/offline)
InnerIpAddress String HPC机器内网IP
JumpserverStatus String 跳板机状态(running/stopped/stopping/starting)
JumpserverPublicIpAddress String 跳板机公网IP
JumpserverInnerIpAddress String 跳板机内网IP

错误码

本文导读目录
本文导读目录
以上内容是否对您有帮助?