华为云用户手册

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若ServiceComb引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的ServiceComb引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取ServiceComb引擎专享版用户Token。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 service MicroService object 微服务信息。 表4 MicroService 参数 参数类型 描述 serviceId String 微服务唯一标识。字符长度为1~64。正则表达式为^.*$。 environment String 用于区分微服务环境，取值为development、testing、acceptance、production。 appId String 应用App唯一标识。字符长度为1~160。 正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$。 serviceName String 微服务名称，同一个App要保证唯一。字符长度为1~128。 正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$。 version String 微服务版本号。字符长度为1~64。 正则表达式为^[0-9]$|^[0-9]+(.[0-9]+)$。 description String 微服务描述信息。字符长度不超过256。 level String 微服务层级：FRONT、MIDDLE、BACK。 registerBy String 微服务注册方式：SDK、PLATFORM、SIDECAR、UNKNOWN。 schemas Array of strings 微服务访问的契约内容。支持数字、字母，支持使用括号内字符做连接符(_-.)，长度1-160字节，数组长度最大100个契约。 status String 微服务状态，UP表示上线，DOWN表示下线，默认值UP。 枚举值： UP DOWN timestamp String 微服务注册时间。 modTimestamp String 最后修改UTC时间。 framework Framework object 开发框架信息。 paths Array of ServicePath objects 服务路由信息。 表5 Framework 参数 参数类型 描述 name String 微服务开发框架，默认值为UNKNOWN。 version String 微服务开发框架版本号。 表6 ServicePath 参数 参数类型 描述 Path String 路由地址。 Property Object 微服务扩展属性，可以自定义KEY和相应的Value。长度最小1字节。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

响应示例 状态码： 200 查询成功。 { "service": { "serviceId": "819706e21b7173306797d19922ce4231441c17c5", "appId": "default", "serviceName": "SERVICECENTER", "version": "2.4.8", "level": "BACK", "schemas": [ "servicecenter.grpc.api.ServiceCtrl", "servicecenter.grpc.api.ServiceInstanceCtrl" ], "status": "UP", "timestamp": "1616426688", "modTimestamp": "1616426688", "environment": "development" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若ServiceComb引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的ServiceComb引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取ServiceComb引擎专享版用户Token。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 token String 获取的用户Token，有效期为12小时。 状态码： 401 表3 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

响应示例 状态码： 200 用于获取用户Token的响应结构体。 { "token" : "****bGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50Ijoicm9vdCIsImV4cCI6MTY1MDU5MTcwMSwicm9sZXMiOlsiYWRtaW4iXX0.WKwNAjaYMM CS jNX0qCGCeyh13FJRzLousxoXlThdkMwkH- pXEmG51_SguH0LlHOZoIc8gNJq-ilQg4bxTo1s0pnQZIS3wma0qvE-MzaYnFguTuHM7rxD7eZdwnbUe3dhnw9xRqR1hcd-lTuBbLoL9fbED4U_63IoEDyBCJl9D_l0F86uGzpUysCvC-t6MrJHgi7miUaO7ZZQmSAUNhmbEoN8IIVp-QtP_cWNWtWaFO-eoQrmCT2FdlYiB9MCuELr9-5EGM_mFLPgs6E4fyIGiGHy7IwoGUKOCW5w6Jb0l-2JxeUe3eOl5Md5kzOIAE_EYUATxCbJ5GmgpSSJf*****" }

响应示例 状态码： 200 查询微服务引擎任务详情结构体。 { "id" : 12339, "engineId" : "ad76972c-a743-4770-859c-c98a680f4d98", "type" : "Create", "description" : "", "status" : "Finished", "scheduling" : 0, "createUser" : "test", "startTime" : 1636540095901, "endTime" : 1636540460230, "context" : "string", "tasks" : [ { "taskName" : "resourcePrepare", "taskNames" : [ "TenantTaskExecutor" ], "status" : "Finished", "startTime" : 1636540100216, "endTime" : 1636540110215, "taskExecutorBrief" : { "duration" : 6000, "description" : "资源准备" }, "tasks" : [ { "jobId" : 12339, "id" : 89117, "type" : "Create", "assigned" : "string", "taskName" : "TenantTaskExecutor", "engineName" : "test", "taskOrder" : 0, "status" : "Init", "startTime" : 1636540100216, "endTime" : 1636540110215, "createTime" : 1636540095910, "updateTime" : 1636540110230, "timeout" : -1, "log" : "string", "output" : "{}", "taskExecutorBrief" : { "duration" : 6000, "description" : "租户处理" } } ] } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 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"。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id Integer 任务ID。 engineId String 任务所属引擎ID。 type String 任务类型。 枚举值： Create Delete Upgrade Modify description String 任务描述。 status String 任务状态。 枚举值： Init Executing Error Timeout Finished scheduling Integer 任务是否正在执行，0表示不在执行，1表示执行中。 createUser String 任务创建者。 startTime Long 任务开始时间。 endTime Long 任务结束时间。 context String 任务执行上下文。 tasks Array of TaskSteps objects 任务包含的处理阶段。 表4 TaskSteps 参数 参数类型 描述 taskName String 处理阶段名称。 taskNames Array of strings 当前处理阶段包含的处理步骤名称列表。 status String 处理阶段状态。 枚举值： Init Executing Error Timeout Finished startTime Long 处理阶段开始时间。 endTime Long 处理阶段结束时间。 taskExecutorBrief TaskExecutorBrief object 处理阶段元数据。 tasks Array of Task objects 处理步骤。 表5 Task 参数 参数类型 描述 jobId Integer 子任务所属任务ID。 id Long 子任务ID，使用uuid。 type String 子任务的类型。 枚举值： Create Delete Upgrade Modify assigned String 子任务的执行者。 taskName String 子任务名称。 engineName String 子任务所属引擎名称。 taskOrder Integer 子任务执行的顺序,，从小到大。 status String 子任务状态。 枚举值： Init Executing Error Timeout Finished startTime Long 子任务开始时间。 endTime Long 子任务结束时间。 createTime Long 子任务创建时间。 updateTime Long 子任务更新时间。 timeout Integer 子任务是否超时。 log String 子任务详细信息，执行过程中产生的辅助信息。 output String 子任务输出信息。 缺省值：{} taskExecutorBrief TaskExecutorBrief object 任务元数据。 表6 TaskExecutorBrief 参数 参数类型 描述 duration Long 子任务持续时长。 description String 子任务描述。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 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"。

响应示例 状态码： 200 查询微服务引擎详情响应结构体。 { "id" : "891bf21a-4024-4f47-b38c-bd259ca8f10a", "name" : "test", "description" : "string", "authType" : "NONE", "flavor" : "cse.s1.medium2", "payment" : "0", "version" : "2.3.1", "latestVersion" : "2.3.4", "status" : "Creating", "beDefault" : true, "createUser" : "string", "createTime" : 1635576800332, "cceSpec" : { "id" : 7465, "engineId" : "891bf21a-4024-4f47-b38c-bd259ca8f10a", "specType" : "CCE", "cluster" : "", "clusterId" : "41115a6f-912f-11eb-9af9-0255ac100188", "clusterNodes" : { "clusterNodes" : [ { "id" : "c13aaf5c-2192-421c-8e03-522e2b9a06b5", "az" : "test", "ip" : "172.31.25.277", "label" : "test", "status" : "Active" } ] }, "flavor" : "string", "region" : "test", "version" : "", "extendParam" : "" }, "externalEntrypoint" : { "externalAddress" : "192.168.0.169", "publicAddress" : "", "serviceEndpoint" : { "serviceCenter" : { "masterEntrypoint" : "https://192.168.0.169:30110", "masterEntrypointIpv6" : "https://[2407:c080:11f0:11:b11d:675c:97ab:65f6]:30110", "slaveEntrypoint" : "", "slaveEntrypointIpv6" : "", "type" : "REGISTRY" } }, "publicServiceEndpoint" : { "serviceCenter" : { "masterEntrypoint" : "", "masterEntrypointIpv6" : "", "slaveEntrypoint" : "", "slaveEntrypointIpv6" : "", "type" : "REGISTRY" } } }, "reference" : { "vpc" : "vpc-test", "azList" : [ "string" ], "networkId" : "88550801-e892-4f8e-b21b-f7147f604f69", "subnetCidr" : "192.168.0.0/24", "subnetCidrV6" : "2407:c080:11f0:11::/64", "subnetGateway" : "192.168.0.2", "publicIpId" : "", "serviceLimit" : "200", "instanceLimit" : "200", "inputs" : { "nodeFlavor" : "s6.large.2", "is_arm_cluster" : "false" } }, "latestJobId" : 12339, "enterpriseProjectId" : "0", "enterpriseProjectName" : "default", "engineAdditionalActions" : [ "Noting" ], "specType" : "CSE2", "type" : "CSE", "projectId" : "string", "vmIds" : [ ] }

响应参数 状态码： 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", "vpcId" : "string", "publicIpId" : "string", "specType" : "string", "inputs" : { "nodeFlavor" : "string" } }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 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"。

响应示例 状态码： 200 查询微服务引擎列表响应结构体。 { "total" : 0, "data" : [ { "id" : "891bf21a-4024-4f47-b38c-bd259ca8f10a", "name" : "test", "enterpriseProjectId" : "0", "enterpriseProjectName" : "default", "type" : "CSE", "description" : "string", "flavor" : "cse.s1.medium2", "payment" : "0", "authType" : "NONE", "status" : "Available", "externalAddress" : "192.168.0.169", "serviceEndpoint" : { "kie" : { "masterEntrypoint" : "https://192.168.0.169:30110", "masterEntrypointIpv6" : "https://[2407:c080:11f0:11:b11d:675c:97ab:65f6]:30110", "slaveEntrypoint" : "string", "slaveEntrypointIpv6" : "string", "type" : "REGISTRY" } }, "publicAddress" : "", "publicServiceEndpoint" : { "kie" : { "masterEntrypoint" : "", "masterEntrypointIpv6" : "", "slaveEntrypoint" : "", "slaveEntrypointIpv6" : "", "type" : "REGISTRY" } }, "totalInstance" : 200, "usedInstance" : 0, "availableInstance" : 200, "version" : "2.3.1", "latestVersion" : "2.3.4", "createTime" : 1635576800332, "dueTo" : 4102415999000, "latestJobId" : 12339, "engineAdditionalActions" : [ "Retry" ], "specType" : "CSE2", "reference" : { "vpc" : "vpc-test", "azList" : [ "string" ], "networkId" : "88550801-e892-4f8e-b21b-f7147f604f69", "subnetCidr" : "192.168.0.0/24", "subnetCidrV6" : "2407:c080:11f0:11::/64", "subnetGateway" : "192.168.0.2", "publicIpId" : "", "serviceLimit" : 200, "instanceLimit" : 200, "inputs" : { "is_arm_cluster" : "true", "nodeFlavor" : "s6.large.2" } } } ] }

URI GET /v2/{project_id}/enginemgr/engines 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识。字符长度为1~64。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 分页的页码。 limit 是 String 每页显示的条目数量。 type 否 String 查询所有微服务引擎需要将该值设置为ALL。 查询ServiceComb引擎专享版需要将该值设置为CSE。 查询注册配置中心需要将该值设置为Nacos。 查询网关需要将该值设置为MicroGateway。

响应示例 状态码： 200 查询微服务引擎的规格列表响应结构体。 { "total" : 0, "data" : [ { "flavor" : "cse.s1.small2", "description" : "string", "spec" : [ { "availableCpuMemory" : "2-4", "linear" : false, "availablePrefix" : "s,c,t" } ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 微服务引擎的规格总个数。 data Array of FlavorBrief objects 微服务引擎的规格详情。 表5 FlavorBrief 参数 参数类型 描述 flavor String 微服务引擎的规格。 description String 微服务引擎的规格描述。 spec EngineSpec object 微服务引擎专享版相关参数。 表6 EngineSpec 参数 参数类型 描述 availableCpuMemory String CPU及内存规格。 linear String 是否为线性规格。 availablePrefix String 可用节点规格类型前缀。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

URI GET /v2/{project_id}/enginemgr/flavors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识。字符长度为1~64。 表2 Query参数 参数 是否必选 参数类型 描述 specType 否 String 微服务引擎的应用部署类型。 查询ServiceComb引擎专享版需要将该值设置为CSE2。 注册配置中心设置为Nacos2。 应用网关为MicroGateway。

响应示例 状态码： 200 导出的文件内容，文件名会根据environment标签的值命名，如：label=environment:development，则文件名为development+时间戳.json，如：label=environment:，则文件名为default+时间戳.json，如不包含或包含多个environment，会以custom+时间戳.json命名。 { "metadata" : { "version" : "1.0.0", "annotations" : { } }, "data" : [ { "id" : "46f9ae5f0d36c438d5d70392b42a2a1072879e8f7e373af4c021d1155bb5c4ac", "key" : "$random(6)-$date(yyyy-MM-dd-HH-mm-ss)", "labels" : { "key" : "value" }, "value" : "$random(20)", "value_type" : "text", "status" : "enabled" } ] }

状态码 状态码 描述 200 导出的文件内容，文件名会根据environment标签的值命名，如：label=environment:development，则文件名为development+时间戳.json，如：label=environment:，则文件名为default+时间戳.json，如不包含或包含多个environment，会以custom+时间戳.json命名。 400 错误的请求。 500 服务器内部错误。

请求参数 表3 请求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"。 x_engine_id 是 String 微服务引擎专享版ID。 表4 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 配置ID的集合。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 metadata metadata object 导出文件的描述信息。 data Array of CreateKieReq objects 导出的配置项列表。 表6 metadata 参数 参数类型 描述 version String 导出数据的版本号。 annotations Object 导出文件的其他信息。 表7 CreateKieReq 参数 参数类型 描述 id String 配置项的id。 key String 配置项的key。 缺省值：$random(6)-$date(yyyy-MM-dd-HH-mm-ss) labels Object 配置项的标签。 value String 配置项的值。 缺省值：$random(20) value_type String 配置项value的类型。 缺省值：text status String 配置项的状态。 缺省值：enabled 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

URI POST /v1/{project_id}/kie/download 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识。字符长度为1~64。 表2 Query参数 参数 是否必选 参数类型 描述 label 否 String 按label过滤项导出，格式为：{标签key}:{标签value}。 match 否 String 对label过滤项的匹配选项。如果值为exact，表示严格匹配，包括label个数和内容相等；不填表示包含匹配。 枚举值： exact

请求参数 表3 请求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" 表4 FormData参数 参数 是否必选 参数类型 描述 upload_file 是 File 导入文件内容的格式必须为键值对映射，例如:{"data":[{"key1":"value1","key2":"value2"}]}}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 success Array of GetKieConfigs objects 导入成功的配置项列表。 failure Array of failure objects 导入失败的配置项及其错误列表。 表6 GetKieConfigs 参数 参数类型 描述 id String 配置项的id。 key String 配置项的key。 labels Object 配置项的标签。 value String 配置项的值。 value_type String 配置项value的类型。 status String 配置项的状态。 create_time Integer 创建时间。 update_time Integer 更新时间。 create_revision Long 创建配置的版本号 update_revision Long 修改配置的版本号 表7 failure 参数 参数类型 描述 key String 导入失败配置的key。 labels Object 导入失败配置的label。 error_code String 导入失败的错误码。 error_message String 导入失败的原因。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

响应示例 状态码： 200 success { "success" : [ { "id" : "8a9e6a5d-8d65-48fb-a40c-5150c8479da8", "key" : "string", "labels" : { "key" : "value" }, "value" : "string", "value_type" : "text", "status" : "enabled", "create_time" : 1623139038, "update_time" : 1623139038, "create_revision" : 13, "update_revision" : 13 } ], "failure" : [ { "key" : "string", "labels" : { "key" : "value" }, "error_code" : "SVCSTG.004xxxxx", "error_message" : "Invalid parameters" } ] }

URI POST /v1/{project_id}/kie/file 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识。字符长度为1~64。 表2 Query参数 参数 是否必选 参数类型 描述 override 否 String 覆盖策略。 force： 强制覆盖。 abort：遇到第一个重复时终止导入后续的kv。 skip：跳过重复的key。 缺省值：force 枚举值： force abort skip label 否 String 指定label导入，格式为：{标签key}:{标签value}，如果不填则按body的label导入。

状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 200 - 操作成功。 204 NoContent 操作成功。 400 BadRequest 非法请求。 建议直接修改该请求为合法请求，不要再重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 409 Conflict 该资源已存在。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 父主题： 附录

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 imagePullPolicy String 拉取OCI镜像的行为。 枚举值： UNSPECIFIED_POLICY IfNotPresent Always imagePullSecret String 拉取OCI镜像的凭据。 phase String 确定插件将在过滤器链中的何处注入。 枚举值： UNSPECIFIED_PHASE AUTHN AUTHZ STATS pluginConfig Object 传递给插件的配置。 pluginName String 插件名。 priority Integer 插件的调用优先级。 sha256 String 用于校验插件和容器的校验和。 url String 插件或容器的下载地址。 verificationKey String 校验值。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。