更新时间:2024-12-12 GMT+08:00
分享

创建微服务引擎

功能介绍

创建微服务引擎,支持创建ServiceComb引擎专享版、注册配置中心、应用网关。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/enginemgr/engines

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户子项目的唯一标识。字符长度为1~64。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

X-Enterprise-Project-ID

String

如果不带则默认企业项目为"default",ID为"0"

缺省值:0

Content-Type

String

该字段内容填为 "application/json;charset=UTF-8"

Accept

String

该字段内容填为 "application/json"

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

微服务引擎的名称。

description

String

微服务引擎的描述。

最大长度:255

payment

String

微服务引擎的计费方式,0表示包周期,1表示按需,2表示免费。

枚举值:

  • 0,表示包周期,暂不支持。
  • 1,表示按需,支持。
  • 2,表示免费,暂不支持。

最大长度:24

flavor

String

微服务引擎的规格。

  • cse.s1.xxx对应ServiceComb引擎专享版的规格。
  • cse.nacos2.xxx对应注册配置中心的规格。
  • cse.microgateway.xxx对应应用网关的规格。

枚举值:

  • cse.s1.small2
  • cse.s1.medium2
  • cse.s1.large2
  • cse.s1.xlarge2
  • cse.nacos2.c1.large.10
  • cse.nacos2.c1.xlarge.20
  • cse.nacos2.c1.xlarge.40
  • cse.nacos2.c1.xlarge.60
  • cse.nacos2.c1.2xlarge.100
  • cse.microgateway.pro.small.1
  • cse.microgateway.pro.medium.1
  • cse.microgateway.pro.large.1

azList

Array of strings

创建ServiceComb引擎专享版时必填,指定引擎部署的可用区列表。

数组长度:1 - 3

authType

String

创建ServiceComb引擎专享版时必填,指定引擎的认证类型,RBAC为安全认证,NONE为无认证。

枚举值:

  • RBAC
  • NONE

vpc

String

vpc名称。

最大长度:64

vpcId

String

vpc标识。

最大长度:64

networkId

String

微服务引擎子网ID。

最大长度:64

subnetCidr

String

微服务引擎子网划分。

最大长度:24

publicIpId

String

微服务引擎公网地址ID,当前为null。

最大长度:64

auth_cred

EngineRbacPwd object

创建ServiceComb引擎专享版,选择RBAC认证时必传,包含引擎的认证信息。

specType

String

微服务引擎的应用部署类型。

缺省值:CSE2

枚举值:

  • CSE2
  • Nacos2
  • MicroGateway

inputs

Map<String,String>

引擎附加参数。

enginestateInfo

enginestateInfo object

引擎状态信息。

periodType

Integer

创建阶段类型。

flavorType

flavorType object

网关规格类型。

enterpriseProject

enterpriseProject object

企业项目信息。

vpcCidr

String

网关vpc划分。

resourceParams

resourceParams object

微服务引擎资源参数。

productId

String

产品ID。

capacityProductId

String

容量产品ID。

isFree

Boolean

微服务引擎是否免费。

subnetName

String

微服务引擎使用的子网名称。

tags

Array of strings

标签。

maintenanceConfig

maintenanceConfig object

网关的维护时间窗。

elbid

String

微服务引擎使用的elb的id。

表4 EngineRbacPwd

参数

是否必选

参数类型

描述

pwd

String

开启安全认证的微服务引擎专享版默认root账号的密码。

表5 enginestateInfo

参数

是否必选

参数类型

描述

cluster

Boolean

集群。

twinClusters

Boolean

双子集群。

singleEngine

Boolean

单引擎。

表6 flavorType

参数

是否必选

参数类型

描述

nodeFlavor

Array of strings

网关节点规格。

flavor

String

网关规格。

availablePrefix

String

可用区前缀。

availableCpuMemory

String

可用区CPU内存。

specType

String

引擎类型。

linear

Boolean

是否为线性。

licenseAmount

Integer

网关证书规模。

nodeLimit

String

网关节点数限制。

id

String

网关规格id。

microGatewayFlavor

String

网关规格。

disable

Boolean

网关是否禁用。

spec

String

网关节点类型。

cloudServiceType

String

云服务类型。

currentflavor

String

当前规格。

表7 enterpriseProject

参数

是否必选

参数类型

描述

id

String

企业项目id。

name

String

企业项目名称。

description

String

企业项目描述。

status

Integer

企业项目状态。

created_at

String

企业项目创建时间。

updated_at

String

企业项目升级时间。

label

String

企业项目标签。

表8 resourceParams

参数

是否必选

参数类型

描述

isAutoRenew

Integer

是否自动刷新。

表9 maintenanceConfig

参数

是否必选

参数类型

描述

time

String

维护时间。

zone

String

维护时间的时区。

响应参数

状态码: 200
表10 响应Body参数

参数

参数类型

描述

id

String

微服务引擎ID。

name

String

微服务引擎专名称。

jobId

Integer

微服务引擎执行的任务ID。

状态码: 400
表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

detail

String

详细定位信息。

状态码: 500
表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

detail

String

详细定位信息。

请求示例

POST https://{endpoint}/v2/{project_id}/enginemgr/engines

{
  "name" : "string",
  "description" : "string",
  "payment" : "string",
  "flavor" : "cse.s1.small2",
  "azList" : [ "string" ],
  "authType" : "NONE",
  "vpc" : "string",
  "networkId" : "string",
  "subnetCidr" : "string",
  "publicIpId" : "string",
  "specType" : "string",
  "inputs" : {
    "nodeFlavor" : "string"
  }
}

响应示例

状态码: 200

创建微服务引擎响应结构体。

{
  "id" : "891bf21a-4024-4f47-b38c-bd259ca8f10a",
  "name" : "test",
  "jobId" : 17655
}

状态码

状态码

描述

200

创建微服务引擎响应结构体。

400

错误的请求。

500

服务器内部错误。

错误码

请参见CSE错误码

相关文档