创建微服务引擎
功能介绍
创建微服务引擎,支持创建ServiceComb引擎专享版、注册配置中心、应用网关(公测)。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/enginemgr/engines
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户子项目的唯一标识。字符长度为1~64。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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" |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
微服务引擎的名称 |
description |
否 |
String |
微服务引擎的描述 最大长度:255 |
payment |
是 |
String |
微服务引擎的计费方式,0表示包周期,1表示按需,2表示免费 最大长度:24 |
flavor |
是 |
String |
微服务引擎的规格,cse.s1.xxx对应ServiceComb引擎专享版的规格,cse.nacos2.xxx对应注册配置中心的规格,cse.microgateway.xxx对应应用网关(公测)的规格 枚举值:
|
azList |
否 |
Array of strings |
创建ServiceComb引擎专享版时必填,指定引擎部署的可用区列表 数组长度:1 - 3 |
authType |
否 |
String |
创建ServiceComb引擎专享版时必填,指定引擎的认证类型,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 枚举值:
|
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 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
cluster |
否 |
Boolean |
集群 |
twinClusters |
否 |
Boolean |
双子集群 |
singleEngine |
否 |
Boolean |
单引擎 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
当前规格 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
微服务引擎ID。 |
name |
String |
微服务引擎专名称。 |
jobId |
Integer |
微服务引擎执行的任务ID。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误信息。 |
detail |
String |
详细定位信息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
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 |
服务器内部错误。 |
错误码
请参见错误码。