文档首页 > > API参考> API V2(推荐)> 生命周期管理>

创建实例(按需)

创建实例(按需)

分享
更新时间:2021/02/08 GMT+08:00

功能介绍

创建实例,该接口创建的实例为按需计费的方式。

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

实例名称。

由英文字符开头,只能由英文字母、数字、中划线、下划线组成,长度为4~64的字符。

description

String

实例的描述信息。

长度不超过1024的字符串。

说明:

\与"在json报文中属于特殊字符,如果参数值中需要显示\或者"字符,请在字符前增加转义字符\,比如\或者"。

engine

String

消息引擎:rabbitmq。

engine_version

String

消息引擎的版本。

  • RabbitMQ版本有:3.7.17

storage_space

Integer

消息存储空间,单位GB。

  • 单机RabbitMQ实例的存储空间的取值范围100GB~90000GB。

  • 集群RabbitMQ实例的存储空间的取值范围为100GB节点数~90000GB、200GB节点数~90000GB、300GB*节点数~90000GB。

access_user

String

认证用户名,只能由英文字母、数字、中划线组成,长度为4~64的字符。

password

String

实例的认证密码。

复杂度要求:

  • 输入长度为8到32位的字符串。

  • 必须包含如下四种字符中的两种组合:

    • 小写字母

    • 大写字母

    • 数字

    • 特殊字符包括(`~!@#$%^&*()-_=+|[{}]:'",<.>/?)

vpc_id

String

租户VPC ID。

security_group_id

String

租户安全组ID。

subnet_id

String

子网ID。

available_zones

Array of strings

创建节点到指定且有资源的可用区ID。该参数不能为空数组或者数组的值为空,详情请参考查询可用区信息查询得到。

product_id

String

产品标识。

获取方法,请参考查询产品规格列表

maintain_begin

String

维护时间窗开始时间,格式为HH:mm。

  • 维护时间窗开始和结束时间必须为指定的时间段,可参考查询维护时间窗时间段获取。

  • 开始时间必须为22:00、02:00、06:00、10:00、14:00和18:00。

  • 该参数不能单独为空,若该值为空,则结束时间也为空。系统分配一个默认开始时间02:00。

maintain_end

String

维护时间窗结束时间,格式为HH:mm。

  • 维护时间窗开始和结束时间必须为指定的时间段,可参考查询维护时间窗时间段获取。

  • 结束时间在开始时间基础上加四个小时,即当开始时间为22:00时,结束时间为02:00。

  • 该参数不能单独为空,若该值为空,则开始时间也为空,系统分配一个默认结束时间06:00。

enable_publicip

Boolean

RabbitMQ实例是否开启公网访问功能。

  • true:开启

  • false:不开启

publicip_id

String

RabbitMQ实例绑定的弹性IP地址的ID。 如果开启了公网访问功能(即enable_publicip为true),该字段为必选。

ssl_enable

Boolean

是否打开SSL加密访问。

  • true:打开SSL加密访问。

  • false:不打开SSL加密访问。

storage_spec_code

String

存储IO规格。如何选择磁盘类型请参考磁盘类型及性能介绍。 取值范围:

  • dms.physical.storage.normal:

  • dms.physical.storage.high

  • dms.physical.storage.ultra

enterprise_project_id

String

企业项目ID。若为企业项目帐号,该参数必填。

tags

Array<Object>

标签列表。

表3 tags

参数

是否必选

参数类型

描述

key

String

键。最大长度36个unicode字符。

key不能为空,不能为空字符串。

不能包含下列字符:非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value

String

值。每个值最大长度43个unicode字符。

value不能为空,可以空字符串。

不能包含下列字符:非打印字符ASCII(0-31), “=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

instance_id

String

实例ID。

请求示例

POST https://{endpoint}/v2/{project_id}/instances

{
  "name" : "rabbitmq-demo",
  "description" : "",
  "engine" : "RabbitMQ",
  "engine_version" : "3.7.17",
  "storage_space" : 100,
  "access_user" : "******",
  "password" : "******",
  "vpc_id" : "1e93f86e-13af-46c8-97d6-d40fa62b76c2",
  "security_group_id" : "0aaa0033-bf7f-4c41-a6c2-18cd04cad2c8",
  "subnet_id" : "b5fa806c-35e7-4299-b659-b39398dd4718",
  "available_zones" : [ "d573142f24894ef3bd3664de068b44b0" ],
  "product_id" : "00300-30109-0--0",
  "maintain_begin" : "22:00",
  "maintain_end" : "02:00",
  "ssl_enable" : false,
  "enable_publicip" : false,
  "publicip_id" : "",
  "storage_spec_code" : "dms.physical.storage.ultra",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ]
}

响应示例

状态码: 200

创建实例成功。

{
  "instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"
}

状态码

状态码

描述

200

创建实例成功。

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问
{{site}}{{lan}}
{{site}}{{language}}