创建微服务引擎 - CreateMicroserviceEngine
功能介绍
创建微服务引擎，支持创建ServiceComb引擎专享版、注册配置中心、应用网关。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
cse:engine:create
write
-
-
-
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”。 |
| Content-Type | 是 | String | 该字段内容填为 "application/json;charset=UTF-8"。 |
| Accept | 是 | String | 该字段内容填为 "application/json"。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 微服务引擎的名称。 名称以字母开头，字母、数字、（-）组成，且不能以（-）结尾，长度为3-24个字符。 |
| description | 否 | String | 微服务引擎的描述。 最大长度：255 |
| payment | 是 | String | 微服务引擎的计费方式。 取值范围：
最大长度：24 |
| flavor | 是 | String | 微服务引擎的规格。
取值范围：
说明： 以下规格当前只在西南-贵阳-汽车二局点支持。
|
| azList | 否 | Array of strings | 创建ServiceComb引擎专享版时必填，指定引擎部署的可用区列表。 数组长度：1 - 3 |
| authType | 否 | String | 创建ServiceComb引擎专享版时必填，指定引擎的认证类型。 取值范围：
|
| 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 说明： 当前CSE3只在西南-贵阳-汽车二局点支持。 |
| inputs | 否 | Map<String,String> | 引擎附加参数。 |
| enginestateInfo | 否 | enginestateInfo object | 引擎状态信息。 |
| 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。当specType为MicroGateway时必填。 |
| elbName | 否 | String | 微服务引擎使用的elb的名称。 |
| entrySubnetCidr | 否 | String | 网关入口网络子网划分。 最大长度：24 |
| entrySubnetSelect | 否 | String | 网关入口网络子网名称。 |
| entryVpcCidr | 否 | String | 网关vpc网络划分。 |
| entryVpcSelect | 否 | String | 网关vpc网络名称。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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 | 网关节点类型。 |
| currentflavor | 否 | String | 当前规格。 |
响应参数
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 微服务引擎ID。 |
| name | String | 微服务引擎名称。 |
| jobId | Integer | 微服务引擎执行的任务ID。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误信息。 |
| detail | String | 详细定位信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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",
"vpcId" : "string",
"publicIpId" : "string",
"specType" : "string",
"inputs" : {
"nodeFlavor" : "string"
}
} 响应示例
状态码： 200
创建微服务引擎响应结构体。
{
"id" : "891bf21a-4024-4f47-b38c-bd259ca8f10a",
"name" : "test",
"jobId" : 17655
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 创建微服务引擎响应结构体。 |
| 400 | 错误的请求。 |
| 500 | 服务器内部错误。 |
错误码
请参见CSE错误码。
