更新时间:2024-09-27 GMT+08:00

购买Flexus L实例

功能介绍

订购一个或多个Flexus L实例。

本接口为异步接口,当前订购接口请求下发后会返回order_id和instances_ids,此时仅表示订单创建完成,Flexus L实例并没有创建完成。

请使用本接口返回的order_id调用查询订单状态,通过响应消息中status参数的值确认Flexus L实例的创建状态,status为5时表示Flexus L实例创建成功。

API网关地址

https://hcss.ap-southeast-3.myhuaweicloud.com

URL

POST /v1/light-instances

请求消息

表1 header参数

参数

是否必选

参数类型

描述

Client-Request-Id

String

用户指定的,对于此请求的唯一ID,用于定位某个请求,推荐使用UUID。

字符长度为36~128。

X-Auth-Token

String

用户Token。

本接口的鉴权方式为token鉴权,通过调用获取IAM账号的 token接口获取。

X-Auth-Token的值为获取IAM账号的 token接口响应消息头中X-Subject-Token的值。

表2 body参数

参数名

是否必选

参数类型

描述

instance_name

String

实例名称。可以使用大小写英文、数字、下划线、中划线。首字符需为英文,区分大小写。

字符长度为1~128。

description

String

实例描述。

字符长度为0~1024。

plan_spec

String

规格编码。

不同镜像支持的规格编码不同,具体信息请参考附录

image_ref

ImageRef

镜像信息。详情请参见表3

region

String

区域。

目前仅支持“ap-southeast-1”(香港)、“ap-southeast-3” (新加坡)“ap-southeast-2”(曼谷)、“tr-west-1”(伊斯坦布尔)、“sa-brazil-1”(圣保罗一)、“me-east-1”(利雅得)区域。

charging_mode

String

计费模式。默认为prePaid,表示预付费,即包年包月。

period_type

String

订购周期类型。

  • month:月。
  • year:年。

period_num

String

订购周期数。

  • periodType=month(周期类型为月)时,取值为[1,9]。
  • periodType=year(周期类型为年)时,取值为[1,3]。

purchase_quantity

int

购买数量。默认为1。

取值范围:[1,200]。

is_auto_renew

boolean

是否自动续订。默认false。

  • true:自动续订。
  • false:不自动续订。

is_auto_pay

boolean

下单订购后,是否自动从客户的账户中支付。默认false。

  • true:是,即自动支付。
  • false:否,即需要客户手动支付。

ExtraResources

Array of ExtraResources

附加资源信息。详情请参见表4

tags

Array of Tags

用户自定义标签。详情请参见表5

表3 ImageRef参数

参数名

是否必选

参数类型

描述

image_name

String

Flexus L实例支持的应用镜像、系统镜像的名称。

使用应用镜像、系统镜像创建Flexus L实例时,涉及此参数;使用私有镜像创建Flexus L实例,不涉该参数。

目前支持的镜像名称请参考应用镜像系统镜像

image_version

String

Flexus L实例支持的应用镜像、系统镜像的版本。

使用应用镜像、系统镜像创建Flexus L实例时,涉及此参数;使用私有镜像创建Flexus L实例,不涉该参数。

目前支持的镜像版本请参考应用镜像系统镜像

image_id

String

私有镜像ID。

仅使用私有镜像创建Flexus L实例时,由用户提供该私有镜像的image_id。如果使用系统镜像或者应用镜像创建Flexus L实例,则不涉及该参数。

表4 ExtraResources参数

参数名

是否必选

参数类型

描述

type

String

附加资源类型。

目前支持"evs","cbr","hss"。

  • “evs”为数据盘。
  • “cbr”为云备份。
  • “hss”为主机安全。

size

Int

附加“evs”、“cbr”资源的容量大小,容量单位为GiB, 输入大小范围为[10,2048]。

"hss"附加资源类型不涉及此参数。

表5 Tags参数

参数名

是否必选

参数类型

描述

key

String

键。字符长度为1~32。

value

String

值。字符长度为0~2048。

响应消息

表6 Tags参数

参数名

参数类型

描述

order_id

String

订单号。

instance_ids

Array of strings

实例ID列表。

请使用本接口返回的order_id调用查询订单状态,通过响应消息中status参数的值确认Flexus L实例的创建状态,status为5时表示Flexus L实例创建成功。

请求示例

创建2台实例名为“test-0620-01”、规格编码为hf.large.1.30m.linux、镜像为宝塔6.8.35版本、区域为新加坡、购买时长为1个月、自动支付、自动续费,并且加购20GB数据盘、20GB云备份、HSS的订单。

{
  "instance_name": "test-0620-01",
  "description": "test",
  "plan_spec": "hf.large.1.30m.linux",
  "image_ref": {
    "image_name": "BT",
    "image_version": "6.8.35"
  },
  "region": "ap-southeast-3",
  "charging_mode": "prePaid",
  "period_type": "month",
  "period_num": 1,
  "purchase_quantity": 2,
  "is_auto_renew": true,
  "is_auto_pay": true
  ,"extra_resources": [
    {
      "type": "evs",
      "size": 20
    },
    {
      "type": "cbr",
      "size": 20
    },
    {
      "type": "hss"
    }
  ]
}

响应示例

{
    "order_id": "CS24022811305H1EW",
    "instance_ids": [
        "65dea8d23005da564c78d9d2"
    ]
 }

返回值

表7 返回值

状态码

描述

202

请求接受,异步处理。

400

用户请求非法。

401

用户身份认证失败。

403

用户无权限调用此API。

429

请求数量过多。

500

服务器内部错误。

错误码

表8 错误码

HTTP状态码

错误码

错误描述

400

HCSS.14000001

参数非法。

400

HCSS.14000002

cors服务请求异常。

400

HCSS.14000003

cbc服务请求异常。

400

HCSS.14000004

ecs服务请求异常。

400

HCSS.14000005

evs服务请求异常。

400

HCSS.14000006

eip服务请求异常。

400

HCSS.14000007

elb服务请求异常。

400

HCSS.14000008

ims服务请求异常。

400

HCSS.14000009

市场镜像服务请求异常。

400

HCSS.14000010

规格容量不足。

400

HCSS.14000011

额度不足。

429

HCSS.14290001

请求过多,请稍后再试。

500

HCSS.15000001

服务器异常。

附录

本节介绍本接口支持的各类镜像对应的规格编码。

接口支持的应用镜像及其对应的规格编码,对应的具体规格见表12表13
表9 应用镜像规格编码

镜像名称

镜像版本

支持的规格编码

BT

6.8.35

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

CRM

8.0

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Ghost

5.67

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

GitLab

16.9.3

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Joomla

5.0.3

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

KodBox

1.49

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Matomo

5.0.3

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Moodle

4.3.4

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Nextcloud

28.0.3

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Nodejs

21

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Odoo

17.0

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Portainer

2.19.4

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

PrestaShop

8.1.5

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Redmine

5.1

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

SRS

6.0.101

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Superset

3.1.1

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

WordPress

6.4

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

本接口支持的系统镜像版本及其对应的规格编码如下表,对应的具体规格见表12表13

表10 系统镜像规格编码

镜像名称

镜像版本

支持的规格编码

Ubuntu

22.04/20.04/18.04/16.04

hf.large.05.30m.linux

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Huawei Cloud EulerOS

2.0

hf.large.025.30m.linux(仅香港、新加坡区域支持)

hf.large.05.30m.linux

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

CentOS

8.2/8.1/8.0/7.9/7.8/7.7/7.6/7.5/ 7.4/7.3/7.2

说明:

伊斯坦布尔和利雅得区域不支持8.2/8.1/8.0/7.3/7.2版本。

hf.large.025.30m.linux(仅香港、新加坡区域的7.6镜像版本支持)

hf.large.05.30m.linux

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Debian

11.1/9.0

hf.large.025.30m.linux(仅香港、新加坡区域的11.1镜像版本支持)

hf.large.05.30m.linux

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

本接口支持的私有镜像对应的规格编码如下表,对应的具体规格见表12表13

表11 私有镜像规格编码

操作系统

规格编码

Linux操作系统

hf.large.025.30m.linux

hf.large.05.30m.linux

hf.large.1.30m.linux

hf.large.2.30m.linux

hf.large.4.30m.linux

hf.xlarge.2.30m.linux

hf.xlarge.4.30m.linux

Windows操作系统

hf.large.1.30m.byol

hf.large.2.30m.byol

hf.large.4.30m.byol

hf.xlarge.2.30m.byol

hf.xlarge.4.30m.byol

规格编码对应的具体规格如下表所示。

表12 Linux系统规格编码的规格

规格编码

vCPU

内存(GiB)

系统盘(GiB)

峰值带宽(Mbps)

流量包(GB)

hf.large.025.30m.linux

2

0.5

20

30

1024

hf.large.05.30m.linux

2

1

40

30

2048

hf.large.1.30m.linux

2

2

60

30

3072

hf.large.2.30m.linux

2

4

80

30

4096

hf.large.4.30m.linux

2

8

160

30

5120

hf.xlarge.2.30m.linux

4

8

240

30

6144

hf.xlarge.4.30m.linux

4

16

320

30

7168

表13 Windows系统规格编码的规格

规格编码

vCPU

内存(GiB)

系统盘(GiB)

峰值带宽(Mbps)

流量包(GB)

hf.large.1.30m.byol

2

2

60

30

3072

hf.large.2.30m.byol

2

4

80

30

4096

hf.large.4.30m.byol

2

8

160

30

5120

hf.xlarge.2.30m.byol

4

8

240

30

6144

hf.xlarge.4.30m.byol

4

16

320

30

7168