华为云用户手册

  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取微服务引擎专享版用户Token。 表4 请求Body参数 参数 是否必选 参数类型 描述 serviceIds 是 Array of strings 服务ID列表,获取方法请参考查询所有微服务信息。
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 services Array of DelServicesRspInfo objects 需要删除的服务信息列表。 表6 DelServicesRspInfo 参数 参数类型 描述 serviceId String 微服务id。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • URI DELETE /v4/{project_id}/registry/microservices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 微服务引擎专业版,请填租户项目id,长度为1~64,获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版,请填固定值:default。 表2 Query参数 参数 是否必选 参数类型 描述 force 否 Boolean 是否强制删除。 true表示强制删除,false表示非强制删除。 选择强制删除会自动注销所有服务实例,并且删除相关的服务依赖关系。如果未传此参数,那么在服务拥有实例时,无法被删除。 缺省值:false。
  • 响应参数 状态码: 200 表11 响应Body参数 参数 参数类型 描述 serviceId String 微服务唯一标识。 状态码: 400 表12 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表13 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 请求示例 创建一个微服务的静态信息,其微服务名为test,微服务版本为1.0.0,rule的类型为白名单,实例的主机信息为instanceTest,访问地址为rest:127.0.0.1:8080。 POST https://{endpoint}/v4/{project_id}/registry/microservices { "service": { "appId": "default", "serviceName": "test", "version": "1.0.0", "description": "this is a test" }, "rules": [{ "ruleType": "WHITE", "attribute": "tag_123", "pattern": "aaa" }], "instances": [{ "hostName": "instanceTest", "endpoints": ["rest:127.0.0.1:8080"] }], "tags": { "test_tag1": "test_tag1", "test_tag2": "test_tag2", "test_tag3": "test_tag3" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取微服务引擎专享版用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 service 是 MicroService object 微服务信息。 rules 否 Array of Rule objects 黑白名单信息。 instances 否 Array of MicroServiceInstance objects 实例信息。 tags 否 Object 微服务扩展属性,可以自定义KEY和相应的Value。长度最小1字节。 表4 MicroService 参数 是否必选 参数类型 描述 serviceId 否 String 微服务唯一标识。字符长度为1~64。正则表达式为^.*$。 environment 否 String 用于区分微服务环境,取值为development、testing、acceptance、production。当配置为development、testing或acceptance时,可以通过批量上传schemas接口新增或者修改已存在的Schema;当配置为production时,则不可以新增或者修改Schema。默认值development。 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 微服务访问契约内容的外键ID,数组长度最大100个契约。 status 否 String 微服务状态,UP表示上线,DOWN表示下线,默认值UP。 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字节。 表7 Rule 参数 是否必选 参数类型 描述 ruleId 否 String 自定义ruleId。 ruleType 否 String rule类型:WHITE或者BLACK。 attribute 否 String 如果是tag_xxx开头,则按Tag过滤attribute属性,否则,则按"serviceId", "AppId", "ServiceName", "Version", "Description", "Level", "Status"过滤。 pattern 否 String 匹配规则,正则表达式,长度1到64。 description 否 String rule描述。 timestamp 否 String 只有获取rule时返回使用,创建rule的时间。 modTimestamp 否 String 更新时间。 表8 MicroServiceInstance 参数 是否必选 参数类型 描述 instanceId 否 String 实例id,唯一标识。创建实例,instanceId由service-center产生。 serviceId 否 String 微服务唯一标识。创建实例时,以url里面的为准,不用这里的serviceId。 version 否 String 微服务版本号。 hostName 是 String 主机信息。 endpoints 是 Array of strings 访问地址信息。 status 否 String 实例状态:UP、DOWN、STARTING、OUTOFSERVICE,默认值UP。 properties 否 Object 微服务扩展属性,可以自定义KEY和相应的Value。长度最小1字节。 healthCheck 否 HealthCheck object 健康检查信息。 dataCenterInfo 否 DataCenterInfo object 数据中心信息。 timestamp 否 String 实例创建时间戳,自动生成。 modTimestamp 否 String 更新时间。 表9 HealthCheck 参数 是否必选 参数类型 描述 mode 是 String 心跳模式: push或者pull。 port 否 Integer 端口。 interval 是 Integer 心跳间隔(秒),当值小于5秒时,按5秒注册。 times 是 Integer 最大尝试请求次数。 表10 DataCenterInfo 参数 是否必选 参数类型 描述 name 是 String 区 域名 称。 region 是 String 区域。 availableZone 是 String 可用区。
  • 响应示例 状态码: 200 查询成功。 { "services": [ { "serviceId": "8aed80ea052ac04a64dfc79c24f2170224d074f5", "appId": "default", "serviceName": "test", "version": "1.0.0", "description": "this is a test", "level": "BACK", "status": "UP", "timestamp": "1650543950", "modTimestamp": "1650543950" }, { "serviceId": "dcc6c1073eab3cadb47cea2e1a874b7883b02a63", "appId": "test", "serviceName": "test1", "version": "1.0.0", "level": "BACK", "status": "UP", "timestamp": "1650544223", "modTimestamp": "1650544223" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 services Array of MicroService objects 微服务列表。 表4 MicroService 参数 参数类型 描述 serviceId String 微服务唯一标识。字符长度为1~64。正则表达式为^.*$。 environment String 用于区分微服务环境,取值为development、testing、acceptance、production。当配置为development、testing或acceptance时,可以通过批量上传schemas接口新增或者修改已存在的Schema;当配置为production时,则不可以新增或者修改Schema。默认值development。 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。 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 详细定位信息。
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • URI DELETE /v4/{project_id}/registry/microservices/{service_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 微服务引擎专业版,请填租户项目id,长度为1~64,获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版,请填固定值:default。 service_id 是 String 微服务唯一标识。字符长度为1~64。正则表达式为^.*$,获取方法请参考查询所有微服务信息。 表2 Query参数 参数 是否必选 参数类型 描述 force 否 Boolean 是否强制删除。 true表示强制删除,false表示非强制删除。 选择强制删除会自动注销所有服务实例,并且删除相关的服务依赖关系。如果未传此参数,那么在服务拥有实例时,无法被删除。 缺省值:false
  • 响应示例 状态码: 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" } }
  • 响应参数 状态码: 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 详细定位信息。
  • URI GET /v4/{project_id}/registry/microservices/{service_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 微服务引擎专业版,请填租户项目id,长度为1~64,获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版,请填固定值:default。 service_id 是 String 微服务唯一标识。字符长度为1~64,正则表达式为^.*$,获取方法请参考查询所有微服务信息。
  • 响应示例 状态码: 200 用于获取用户Token的响应结构体。 { "token" : "****bGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50Ijoicm9vdCIsImV4cCI6MTY1MDU5MTcwMSwicm9sZXMiOlsiYWRtaW4iXX0.WKwNAjaYMM CS jNX0qCGCeyh13FJRzLousxoXlThdkMwkH- pXEmG51_SguH0LlHOZoIc8gNJq-ilQg4bxTo1s0pnQZIS3wma0qvE-MzaYnFguTuHM7rxD7eZdwnbUe3dhnw9xRqR1hcd-lTuBbLoL9fbED4U_63IoEDyBCJl9D_l0F86uGzpUysCvC-t6MrJHgi7miUaO7ZZQmSAUNhmbEoN8IIVp-QtP_cWNWtWaFO-eoQrmCT2FdlYiB9MCuELr9-5EGM_mFLPgs6E4fyIGiGHy7IwoGUKOCW5w6Jb0l-2JxeUe3eOl5Md5kzOIAE_EYUATxCbJ5GmgpSSJf*****" }
  • 响应参数 状态码: 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 详细定位信息。
  • 响应示例 { "id": 12339, "engineId": "ad76972c-a743-4770-859c-c98a680f4d98", "type": "Create", "description": "", "status": "Finished", "scheduling": 0, "createUser": "test", "startTime": 1636540095901, "endTime": 1636540460230, "context": "", "tasks": [{ "taskName": "resourcePrepare", "taskNames": ["TenantTaskExecutor"], "status": "Finished", "startTime": 1636540100216, "endTime": 1636540110215, "taskExecutorBrief": { "duration": 60000, "description": "资源准备" }, "tasks": [{ "jobId": 12339, "id": 89117, "type": "Create", "assigned": "", "taskName": "TenantTaskExecutor", "engineName": "test", "taskOrder": 0, "status": "Init", "startTime": 1636540100216, "endTime": 1636540110215, "createTime": 1636540095910, "updateTime": 1636540110230, "timeout": -1, "log": "", "output": "{}", "taskExecutorBrief": { "duration": 60000, "description": "租户处理" } }] }] }
  • 响应参数 状态码: 200 表3 响应Body体 参数 参数类型 描述 id Integer 任务ID。 engineId String 微服务引擎专享版ID。 type String 任务类型。 Create:创建引擎。 Delete:删除引擎。 Upgrade:升级引擎。 Configure:变更引擎配置。 description String 任务描述。 status String 任务当前执行状态。 Init:初始化。 Executing:执行中。 Error:执行失败。 Timeout:执行超时。 Finished:结束。 scheduling Integer 任务是否正在执行,0表示不在执行,1表示执行中。 createUser String 任务创建者。 startTime Integer 任务开始执行时间。 endTime Integer 任务结束时间。 context String 任务执行上下文。 tasks Array of TaskSteps objects 任务包含处理阶段。 表4 TaskSteps 参数 参数类型 描述 taskName String 处理阶段名称。 taskNames Array of String 当前处理阶段包含的处理步骤名称列表。 status String 任务处理阶段状态。 startTime Integer 任务处理阶段开始时间。 endTime Integer 任务处理阶段结束时间。 taskExecutorBrief Object 任务元数据。 tasks Array of Task objects 处理阶段包含的子任务。 表5 TaskExecutorBrief 参数 参数类型 描述 duration Integer 子任务持续时长。 description String 子任务描述。 表6 Task 参数 参数类型 描述 jobId Integer 子任务所属任务ID。 id Integer 子任务ID,使用uuid。 type String 子任务的类型。 assigned String 子任务的执行者。 taskName String 子任务名称。 engineName String 子任务所属引擎名称。 taskOrder Integer 子任务执行的顺序,从小到大。 status String 子任务状态。 startTime Integer 子任务开始时间。 endTime Integer 子任务结束时间。 createTime Integer 子任务创建时间。 updateTime Integer 子任务更新时间。 timeout Integer 子任务是否超时。 log String 子任务详细信息,执行过程中产生的辅助信息。 output String 子任务输出信息。 taskExecutorBrief Object 子任务元数据。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • URI GET /v2/{project_id}/enginemgr/engines/{engine_id}/jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识,字符长度为1~64位,获取方法请参考获取项目ID。 engine_id 是 String 微服务引擎专享版ID,获取方法请参考查询微服务引擎专享版列表。 job_id 是 String 微服务引擎专享版ID,获取方法请参考查询微服务引擎专享版详情。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 微服务引擎专享版ID。 name String 微服务引擎专享版名称。 jobId Integer 微服务引擎专享版执行任务ID。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 响应示例 { "id": "891bf21a-4024-4f47-b38c-bd259ca8f10a", "name": "test", "description": "", "authType": "RBAC", "flavor": "cse.s1.medium2", "payment": "0", "version": "2.3.1", "latestVersion": "2.3.3", "status": "Creating", "beDefault": true, "createUser": "test", "createTime": 1635576800332, "cceSpec": { "id": 7465, "engineId": "891bf21a-4024-4f47-b38c-bd259ca8f10a", "specType": "CCE", "cluster": null, "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": null, "region": "test", "version": "", "extendParam": "" }, "externalEntrypoint": { "externalAddress": "192.168.0.169", "publicAddress": "", "serviceEndpoint": { "kie": { "masterEntrypoint": "https://192.168.0.169:30110", "masterEntrypointIpv6": "https://[2407:c080:11f0:11:b11d:675c:97ab:65f6]:30110", "slaveEntrypoint": null, "slaveEntrypointIpv6": null, "type": "REGISTRY" }, "serviceCenter": { "masterEntrypoint": "https://192.168.0.169:30100", "masterEntrypointIpv6": "https://[2407:c080:11f0:11:b11d:675c:97ab:65f6]:30100", "slaveEntrypoint": null, "slaveEntrypointIpv6": null, "type": "REGISTRY" } }, "publicServiceEndpoint": { "kie": { "masterEntrypoint": "https://192.168.0.169:30110", "masterEntrypointIpv6": null, "slaveEntrypoint": null, "slaveEntrypointIpv6": null, "type": "REGISTRY" }, "serviceCenter": { "masterEntrypoint": "https://192.168.0.169:30100", "masterEntrypointIpv6": null, "slaveEntrypoint": null, "slaveEntrypointIpv6": null, "type": "REGISTRY" } } }, "reference": { "vpc": "vpc-test", "vpcId": "09902850-9454-4715-9764-018f0c3701hy", "azList": ["test"], "networkId": "88550801-e892-4f8e-b21b-f7147f604f69", "subnetCidr": "192.168.0.0/24", "subnetCidrV6": "2407:c080:11f0:11::/64", "subnetGateway": "192.168.0.2", "publicIpId": null, "serviceLimit": 200, "instanceLimit": 200, "inputs": { "is_arm_cluster": "false", "nodeFlavor": "s6.large.2" } }, "latestJobId": 12339, "enterpriseProjectId": "0", "enterpriseProjectName": "default", "engineAdditionalActions": ["Retry"], "specType": "CSE2", "type": "CSE", "projectId": "string", "vmIds": [""] }
  • 请求示例 创建一个名称为“test”微服务引擎专享版,其计费模式为按需计费,规格为cse.s1.small2,可用区为test,关闭安全认证,微服务引擎的部署类型为CSE2。 POST https://{endpoint}/v2/{project_id}/enginemgr/engines { "name": "test", "description": "test", "payment": "1", "flavor": "cse.s1.small2", "azList": ["test"], "authType": "NONE", "vpc": "vpc-demotest", "vpcId": "09902850-9454-4715-9764-018f0c37022", "networkId": "88550801-e892-4f8e-b21b-f7147f6229", "subnetCidr": "192.168.0.5/26", "specType": "CSE2, "inputs": { "nodeFlavor": "s6.large.2" } }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 id String 微服务引擎专享版专享版ID。 name String 微服务引擎专享版名称。 jobId Integer 微服务引擎专享版执行任务ID。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 响应示例 { "total": 1, "data": [{ "id": "891bf21a-4024-4f47-b38c-bd259ca8f10a", "name": "test", "enterpriseProjectId": "0", "enterpriseProjectName": "default", "type": "CSE_SHARE", "description": "", "flavor": "cse.s1.medium2", "payment": "0", "authType": "RBAC", "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": null, "slaveEntrypointIpv6": null, "type": "REGISTRY" }, "serviceCenter": { "masterEntrypoint": "https://192.168.0.169:30100", "masterEntrypointIpv6": "https://[2407:c080:11f0:11:b11d:675c:97ab:65f6]:30100", "slaveEntrypoint": null, "slaveEntrypointIpv6": null, "type": "REGISTRY" } }, "publicAddress": "", "publicServiceEndpoint": { "kie": { "masterEntrypoint": "", "masterEntrypointIpv6": "", "slaveEntrypoint": "", "slaveEntrypointIpv6": "", "type": "REGISTRY" }, "serviceCenter": { "masterEntrypoint": "", "masterEntrypointIpv6": "", "slaveEntrypoint": "", "slaveEntrypointIpv6": "", "type": "REGISTRY" } }, "totalInstance": 200, "usedInstance": 0, "availableInstance": 200, "version": "2.3.1", "latestVersion": "2.3.3", "createTime": 1635576800332, "dueTo": 4102415999000, "latestJobId": 12339, "engineAdditionalActions": ["Retry"], "specType": "CSE2", "reference": { "vpc": "vpc-test", "vpcId": "09902850-9454-4715-9764-018f0c3701hy", "azList": ["test"], "networkId": "88550801-e892-4f8e-b21b-f7147f604f69", "subnetCidr": "192.168.0.0/24", "subnetCidrV6": "2407:c080:11f0:11::/64", "subnetGateway": "192.168.0.2", "publicIpId": null, "serviceLimit": 200, "instanceLimit": 200, "inputs": { "is_arm_cluster": "false", "nodeFlavor": "s6.large.2" } } }] }
  • URI GET /v2/{project_id}/enginemgr/engines 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识,字符长度为1~64位,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量 limit 否 Integer 每页数据大小 type 否 String 查询的引擎类型:CSE、CSE_SHARE。
  • URI GET /v2/{project_id}/enginemgr/flavors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识,字符长度为1~64位,获取方法请参考获取项目ID。 表2 query参数 参数 是否必选 参数类型 描述 specType 否 String 查询1.x版本CSE引擎支持规格时,将specType设置为CSE。 查询2.x版本CSE引擎支持规格时,将specType设置为CSE2。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 当前微服务引擎专享版规格总个数。 data Array of Flavor objects 微服务引擎专享版规格详情。 表5 Flavor 参数 参数类型 描述 flavor String 微服务引擎专享版规格。 description String 微服务引擎专享版规格描述。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • URI POST /v1/{project_id}/kie/download 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识,字符长度为1~64位,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 label 否 String 按label过滤项导出,格式为:{标签key}:{标签value}。 match 否 String 对label过滤项的匹配选项。 如果值为exact表示严格匹配,包括label个数和内容相等。 不填表示包含匹配。
  • 响应示例 查询成功 { "metadata": { "version": "2.0.0" }, "data": [ { "id": "0bdfddb8-c4f9-4a88-8360-07a8a616a804", "key": "2", "labels": { "2": "2" }, "value": "2", "status": "enabled", "value_type": "text" }, { "id": "34befef9-7f3a-4394-85f9-142622a11b1d", "key": "1", "labels": { "1": "1" }, "value": "1", "status": "enabled", "value_type": "text" } ] }
  • 响应示例 查询成功 { "success": [ { "id": "7e2d346e-d907-4871-bf51-a17fc7e52ad4", "key": "2", "value": "2", "value_type": "text", "create_revision": 3, "update_revision": 3, "status": "enabled", "create_time": 1636374809, "update_time": 1636374809, "labels": { "2": "2", "environment": "production" } }, { "id": "907b3891-c691-4ae0-816f-e91eba705e28", "key": "1", "value": "1", "value_type": "text", "create_revision": 4, "update_revision": 4, "status": "enabled", "create_time": 1636374809, "update_time": 1636374809, "labels": { "1": "1", "environment": "production" } } ], "failure": [] }
  • 请求示例 导入配置文件,当存在相同配置时,会强制导入覆盖重复项,按body的label导入。 POST https://{endpoint}/v1/{project_id}/kie/file/override=force ----WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="upload_file"; filename="custom_1663124521493.json" Content-Type: application/json ----WebKitFormBoundary7MA4YWxkTrZu0gW
共100000条