华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为 "application/json;charset=UTF-8"。 X-Auth-Token 是 String 用户Token。 x-engine-id 是 String 微服务引擎专享版的实例ID。 X-Enterprise-Project-ID 是 String 企业项目ID。 x-environment 否 String 所属环境。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 name String 治理策略名称。 selector GovSelector object 治理策略下发范围。 spec Object 治理策略定义内容。 表4 GovSelector 参数 参数类型 描述 environment String 所属环境。 app String 所属应用。 service String 可选，治理下发到微服务级别。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

响应参数 状态码： 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 校验值。

请求参数 表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 查询成功。 { "instances": [ { "instanceId": "8540bb8b693c4ad1a7fb6a756c415244", "serviceId": "8aed80ea052ac04a64dfc79c24f2170224d074f5", "endpoints": [ "rest:127.0.0.1:8080" ], "hostName": "hostNameTest", "status": "UP", "properties": { "engineID": "30c263e5-2eac-4da1-9c72-5abb9ac94550", "engineName": "cse-fkln1-HA" }, "healthCheck": { "mode": "push", "interval": 30, "times": 3 }, "timestamp": "1650545035", "modTimestamp": "1650545035", "version": "1.0.0" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instances Array of MicroServiceInstance objects 实例列表。 表5 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 更新时间。 表6 HealthCheck 参数 参数类型 描述 mode String 心跳模式push/pull。 port Integer 端口。 interval Integer 心跳间隔（秒），当值小于5秒时，按5秒注册。 times Integer 最大尝试请求次数。 表7 DataCenterInfo 参数 参数类型 描述 name String 区 域名 字。 region String 区域。 availableZone String 可用区。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

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

URI GET /v4/{project_id}/registry/microservices/{service_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 请填固定值：default。 service_id 是 String 微服务唯一标识。字符长度为1~64，正则表达式为^.*$。获取方法请参考查询所有微服务信息。 表2 Query参数 参数 是否必选 参数类型 描述 tags 否 String Tag标签过滤，多个时逗号分隔。 正则表达式为^[a-zA-Z][a-zA-Z0-9_-.]{0,63}$。

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-Schema-Summary String 微服务契约的摘要。 表4 响应Body参数 参数 参数类型 描述 schema String 契约内容。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

响应示例 状态码： 200 查询成功，如果summary存在，则header里面的X-Schema-Summary的value为该schema对应的摘要。 { "schema" : "---\nswagger: \"2.0\"\ninfo:\n version: \"1.0.0\"\n title: \"swagger definition for com.service.provider.controller.ProviderImpl\"\n x-java-interface: \"cse.gen.springmvc.provider.provider.ProviderImplIntf\"\nbasePath: \"/provider\"\nconsumes:\n- \"application/json\"\nproduces:\n- \"application/json\"\npaths:\n /helloworld:\n get:\n operationId: \"helloworld\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"name\"\n in: \"query\"\n required: true\n type: \"string\"\n responses:\n 200:\n description: \"response of 200\"\n schema:\n type: \"string\"\n" }

URI GET /v4/{project_id}/registry/microservices/{service_id}/schemas/{schema_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 请填固定值：default。 service_id 是 String 微服务唯一标识。字符长度为1~64，正则表达式为^.*$。获取方法请参考查询所有微服务信息。 schema_id 是 String 契约的id。获取方法请参考查询微服务的所有契约。

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 升级的ServiceComb引擎专享版ID。 name String 升级的ServiceComb引擎专享版名称。 jobId Integer ServiceComb引擎专享版执行的任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Enterprise-Project-ID 否 String 企业项目id。 如果不配置此参数，则默认企业项目为“default”，ID为0。 表3 请求Body参数 参数 是否必选 参数类型 描述 version 是 String 升级到的ServiceComb引擎专享版的版本号。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为 "application/json;charset=UTF-8"。 X-Auth-Token 是 String 用户Token。 x-engine-id 是 String 微服务引擎专享版的实例ID。 X-Enterprise-Project-ID 是 String 企业项目ID。 x-environment 否 String 所属环境。

响应参数 状态码： 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。

URI PUT /v1/{project_id}/nacos/v1/console/namespaces 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识。字符长度为1~64。 表2 Query参数 参数 是否必选 参数类型 描述 namespace 是 String 命名空间ID。 namespace_show_name 是 String 命名空间名，支持非@、#、$、%、^、&、*，不超过128个字符。 namespace_desc 是 String 命名空间描述，不超过256个字符。

响应示例 状态码： 200 查询成功，则返回serviceId或者schemaId。 { "providers": [ { "serviceId": "8aed80ea052ac04a64dfc79c24f2170224d074f5", "appId": "default", "serviceName": "test", "version": "1.0.0", "description": "this is a test", "level": "BACK", "status": "UP", "properties": { "test": "test" }, "timestamp": "1650543950", "modTimestamp": "1650544411" } ] }

URI GET /v4/{project_id}/registry/microservices/{consumer_id}/providers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 请填固定值：default。 consumer_id 是 String 消费者的服务id。 表2 Query参数 参数 是否必选 参数类型 描述 noSelf 否 Integer 是否取消返回自依赖的关系，0表示不返回自依赖关系，1表示返回自依赖关系。 sameDomain 否 Integer 是否取消返回共享服务的关系，0表示不返回共享服务，1表示返回。

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 providers MicroService object 微服务信息。 表5 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 服务路由信息。 properties Object 扩展属性。可以自定义KEY和相应的Value。 表6 Framework 参数 参数类型 描述 name String 微服务开发框架，默认值为UNKNOWN。 version String 微服务开发框架版本号。 表7 ServicePath 参数 参数类型 描述 Path String 路由地址。 Property Object 微服务扩展属性，可以自定义KEY和相应的Value。长度最小1字节。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

响应示例 状态码： 200 查询指定类型治理策略列表响应结构体。 [ { "matchGroup" : { "name" : "", "status" : "enabled", "selector" : { "environment" : "string", "app" : "string", "service" : "string" }, "spec" : { "alias" : "string", "matches" : [ { "name" : "string", "apiPath" : { }, "headers" : { }, "method" : [ "string" ], "serviceName" : "string" } ] } }, "policies" : [ { "id" : "string", "name" : "string", "kind" : "string", "status" : "string", "selector" : { "environment" : "string", "app" : "string", "service" : "string" }, "spec" : { } } ] } ]

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为 "application/json;charset=UTF-8"。 X-Auth-Token 是 String 用户Token。 x-engine-id 是 String 微服务引擎专享版的实例ID。 X-Enterprise-Project-ID 是 String 企业项目ID。 x-environment 否 String 所属环境。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of GovPolicyDetail objects 查询治理策略列表响应结构体。 表4 GovPolicyDetail 参数 参数类型 描述 matchGroup CreateBussinessScene object 流量定义。 policies Array of policies objects 治理策略定义。 表5 CreateBussinessScene 参数 参数类型 描述 name String 流量名称。 status String 启用状态，支持enabled和disabled。 缺省值：enabled selector GovSelector object 治理策略下发范围。 spec spec object 流量特征描述。 表6 spec 参数 参数类型 描述 alias String 特征名称。 matches Array of matches objects 匹配条件定义。 表7 matches 参数 参数类型 描述 name String 条件名称。 apiPath Object 匹配的PATH。 headers Object 匹配的Headers。 method Array of strings 匹配的Method列表。 serviceName String 匹配的微服务名称。 表8 policies 参数 参数类型 描述 id String 治理策略ID。 name String 治理策略名称。 kind String 治理类型，支持填写retry、rate-limiting、loadbalance、circuit-breaker、instance-isolation、fault-injection和bulkhead。 status String 启用状态，支持enabled和disabled。 selector GovSelector object 治理策略下发范围。 spec Object 治理策略定义内容。 表9 GovSelector 参数 参数类型 描述 environment String 所属环境。 app String 所属应用。 service String 可选，治理下发到微服务级别。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若ServiceComb引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的ServiceComb引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取ServiceComb引擎专享版用户Token。 X-consumerId 否 String 微服务消费者的微服务唯一标识。 表3 请求Body参数 参数 是否必选 参数类型 描述 properties 否 Object 微服务扩展属性，可以自定义KEY和相应的Value。长度最小1字节。

URI PUT /v4/{project_id}/registry/microservices/{service_id}/instances/{instance_id}/properties 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 请填固定值：default。 service_id 是 String 微服务唯一标识。字符长度为1~64，正则表达式为^.*$。获取方法请参考查询所有微服务信息。 instance_id 是 String 微服务实例唯一标识。字符长度不超过64位， 正则表达式为^[A-Za-z0-9_.-]*$。获取方法请参考根据service_id查询微服务实例。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail 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 校验值。