华为云用户手册

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" : "SV CS TG.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 详细定位信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM -Token。 Accept 否 String 该字段内容填为 "application/json"。 表3 请求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 校验值。

响应示例 状态码： 200 创建成功 { "imagePullPolicy" : "UNSPECIFIED_POLICY", "imagePullSecret" : "string", "phase" : "UNSPECIFIED_PHASE", "pluginConfig" : { }, "pluginName" : "string", "priority" : 0, "sha256" : "string", "url" : "string", "verificationKey" : "string" }

请求示例 POST https://{endpoint}/v2/{project_id}/enginemgr/gateways/{gateway_id}/plugins { "imagePullPolicy" : "UNSPECIFIED_POLICY", "imagePullSecret" : "string", "phase" : "UNSPECIFIED_PHASE", "pluginConfig" : { }, "pluginName" : "string", "priority" : 0, "sha256" : "string", "url" : "string", "verificationKey" : "string" }

响应示例 状态码： 200 查询成功 { "total" : 0, "data" : [ { "imagePullPolicy" : "UNSPECIFIED_POLICY", "imagePullSecret" : "string", "phase" : "UNSPECIFIED_PHASE", "pluginConfig" : { }, "pluginName" : "string", "priority" : 0, "sha256" : "string", "url" : "string", "verificationKey" : "string" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Integer 插件总数。 data Array of WasmPlugin objects 插件列表。 表4 WasmPlugin 参数 参数类型 描述 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 详细定位信息。

操作步骤 注册微服务my-provider。 调用创建微服务静态信息接口，请求示例如下。 curl -k -H "x-domain-name:default" -XPOST "https://{cse_endpoint}/v4/default/registry/microservices" -d '{ "service": { "serviceName": "my-provider", "appId": "default", "version": "1.0.0", "description": "test", "level": "MIDDLE", "status": "UP" } }' 返回结果： {"serviceId":"918282e8562dc5fdc9a8dcd4d1baabb492190aa4"} 得到的serviceId，后续示例中以{providerServiceId}代替。 注册微服务my-provider的实例。 调用注册微服务实例接口。实例有效期1小时，到期自动下线。假设provider实例监听的地址为127.0.0.1:8080，请求示例如下。 curl -k -H "x-domain-name:default" -XPOST "https://{cse_endpoint}/v4/default/registry/microservices/{providerServiceId}/instances" -d '{ "instance": { "hostName": "test", "endpoints": [ "rest:127.0.0.1:8080" ], "status": "UP", "healthCheck": { "mode": "push", "interval": 900, "times": 3 } } }' 返回结果： {"instanceId":"2be605a095ed11eabcbe0255ac100fa3"} 注册微服务my-consumer。 调用创建微服务静态信息接口，请求示例如下。 curl -k -H "x-domain-name:default" -XPOST "https://{cse_endpoint}/v4/default/registry/microservices" -d '{ "service": { "serviceName": "my-consumer", "appId": "default", "version": "1.0.0", "description": "test", "level": "MIDDLE", "status": "UP" } }' 返回结果： {"serviceId":"9db248934c31fc754d6e922b48ede4a5c004d3c1"} 得到的serviceId，后续示例中以{consumerServiceId}代替。 my-consumer发现my-provider的实例。 调用按条件查询微服务实例接口，consumer带着自身的serviceId去服务中心查询provider的实例信息，请求示例如下。 curl -k -H "x-domain-name:default" -H "X-ConsumerId:{consumerServiceId}" -XGET "https://{cse_endpoint}/v4/default/registry/instances?appId=default&serviceName=my-provider&version=0.0.0%2B" 返回结果： { "instances": [ { "instanceId": "2be605a095ed11eabcbe0255ac100fa3", "serviceId": "918282e8562dc5fdc9a8dcd4d1baabb492190aa4", "endpoints": [ "rest:127.0.0.1:8080" ], "hostName": "test", "status": "UP", "healthCheck": { "mode": "push", "interval": 150, "times": 3 }, "timestamp": "1589465646", "modTimestamp": "1589465646", "version": "1.0.0" } ] } 在实际业务中，consumer可从实例查询结果中的"endpoint"字段获取provider实例的地址，发起业务调用。 您还可以进入微服务引擎控制台的“微服务目录”，查看服务注册信息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 token String rbac token。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

请求参数 表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"。 X-Namespace-ID 否 String Nacos命名空间。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 Result String 删除结果。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

请求参数 表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"。 X-ENVIRONMENT 否 String 环境名称。 表3 Body参数 参数 是否必选 参数类型 描述 dimensionInfo 否 String 配置范围信息。 flush 否 String 是否刷新。 keys 否 Array of String 删除的键值。

响应示例 状态码： 200 success { "total": 100, "data": [ { "id": 12339, "engineId": "ad76972c-a743-4770-859c-c98a680f4d98", "type": "Create", "description": "", "status": "Finished", "scheduling": 0, "createUser": "test", "startTime": 1636540095901, "endTime": 1636540460230, "context": "string", "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": "租户处理" } } ] } ] }

请求参数 表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"

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

URI GET /v2/{project_id}/enginemgr/engines/{engine_id}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识。字符长度为1~64。 engine_id 是 String 微服务引擎ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 String 分页的页码。 limit 否 String 每页显示的条目数量。 from-time 否 String 查询日期范围的起始时间。 to-time 否 String 查询日期范围的结束时间。

请求参数 表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参数 参数 是否必选 参数类型 描述 description 否 String 微服务引擎的描述。 最大长度：255 alias 否 String 微服务引擎的别名（展示的名称）。 最大长度：64 maintenanceConfig 否 MaintenanceConfig object 应用网关的维护时间窗。 表4 MaintenanceConfig 参数 是否必选 参数类型 描述 time 否 String 应用网关的维护时间窗范围。 zone 否 String 时区。

响应参数 状态码： 200 无 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

请求参数 表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"。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 list Array of KeyObject key列表。 appIds Array of String 应用Id列表。 page Integer 分页页码。 number Integer 当前页的数量。 total Integer 查询总数。 表5 KeyObject 参数 参数类型 描述 key String key值。 serviceId String 服务Id。 serviceName String 服务名称。 appId String 应用Id。 version String 版本。 environment String 环境名称。 custom Map object 自定义信息。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

响应示例 状态码： 200 success { "list": [ { "key": "string", "serviceId": "string", "appId": "string", "version": "string", "environment": "string", "custom": { "key": 1.0 } } ], "appIds": ["string", "string"], "page": 0, "number": 0, "total": 0 }

URI GET /v3/{project_id}/csemonitor/metric/list 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识。字符长度为1~64。 表2 Query参数 参数 是否必选 参数类型 描述 page 否 String 分页页码。 number 否 String 分页大小。 sortType 否 String 排序类型。 枚举值： increase decrease sortKey 否 String 指定排序字段。 枚举值： name qps latency total appIds 否 String 查询的应用列表，以逗号分隔。 nameFilter 否 String 过滤的名称。

响应示例 状态码： 200 success [ [ { "time": 1733973104652, "appId": "weathermap", "version": "0.0.2", "qps": 0.0, "latency": 0.0, "failureRate": 0.0, "total": 0, "breakerRateAgg": 0.0, "circuitBreakerOpen": false, "failure": 0, "shortCircuited": 0, "semaphoreRejected": 0, "threadPoolRejected": 0, "countTimeout": 0, "l995": 0, "l99": 0, "l90": 0, "l75": 0, "l50": 0, "l25": 0, "l5": 0, "serviceId": "da21c8749d7ca08047b7d8da63f79e296127c21b", "instanceCount": 10, "environment": "", "diagnosis": { "instanceCache": null }, "name": "weather" } ] ]

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 success Array of MetricInfo objects 查询结果。 表5 MetricInfo 参数 参数类型 描述 time Long 时间戳。 appId String 服务appId。 version String 服务版本号。 qps Double 每秒请求量，单位：个。 latency Double 时延，单位：毫秒。 rate Double 成功率，百分比（0-100）。 failureRate Double 失败率，百分比（0-100）。 total Long 请求总量。 breakerRateAgg Float 平均熔断率。 circuitBreakerOpen Boolean 当前熔断状态。 failure Long 失败总个数。 shortCircuited Long 总短路个数。 semaphoreRejected Long 总信号量拒绝个数。 threadPoolRejected Long 总线程池拒绝个数。 countTimeout Long 总超时个数。 l995 double 所有请求时延从小到大排序，前99.5%的时延。 l99 double 所有请求时延从小到大排序，前99%的时延。 l90 double 所有请求时延从小到大排序，前90%的时延。 l75 double 所有请求时延从小到大排序，前75%的时延。 l50 double 所有请求时延从小到大排序，前50%的时延。 l25 double 所有请求时延从小到大排序，前25%的时延。 l5 double 所有请求时延从小到大排序，前5%的时延。 name String 名称。 serviceId String 服务Id。 instanceCount Long 服务实例数量。 environment String 环境名称。 diagnosis Array of Diagnosisobject 服务诊断结果。 instanceId String 实例Id。 thread Integer 线程数量。 cpu Double cpu使用率，百分比。 memory Map object 内存使用率，百分比。 functionCount Long 函数方法数量。 customs Map object 用户自定义变量。 providersCache Array of ProviderCache object 服务端实例集合。 functionType String 方法类型。 表6 ProviderCache 参数 参数类型 描述 appId String 应用Id。 microserviceName String 服务名称。 detail String 细节信息。 pulledInstances Array of ProviderInstance object 服务提供者实例信息。 status String 状态信息。 表7 ProviderInstance 参数 参数类型 描述 instanceId String 实例Id。 endpoints Array of String 实例接入点信息列表。 hostName String 实例 域名 。 timestamp String 时间戳。 表8 Diagnosis 参数 参数类型 描述 instanceCache Array of InstanceCache object 服务实例缓存结果。 表9 InstanceCache 参数 参数类型 描述 status String 检查状态。 枚举值： NORMAL ABNORMAL UNKNOWN timestamp Long 时间戳。 producers Array of Producer object 服务提供者列表。 checkTime Long 检测时间，如果有异常时，显示最新的异常时间，否则为最新的检测时间。 latestStatus String 检查状态。 枚举值： NORMAL ABNORMAL UNKNOWN 表10 Producer 参数 参数类型 描述 status String 检查状态。 枚举值： NORMAL ABNORMAL UNKNOWN appId String 应用ID。 microserviceName String 微服务名称。 detail String 详细信息。 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

URI GET /v3/{project_id}/csemonitor/metric 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识。字符长度为1~64。 表2 Query参数 参数 是否必选 参数类型 描述 service 是 String 服务名称列表，以“,”分隔。 instance 否 String 实例名称。 function 否 String 方法名称。 flag 否 String 批量查询标记。