华为云用户手册

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

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

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

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

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

响应示例 状态码： 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" : [ ] }

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

请求参数 表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 所属环境。

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

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" } ] }

响应参数 状态码： 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 详细定位信息。

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 查询指定类型治理策略列表响应结构体。 [ { "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" : { } } ] } ]

响应参数 状态码： 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参数 参数 是否必选 参数类型 描述 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 所属环境。

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

响应参数 状态码： 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 详细定位信息。

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

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 gatewayId String 网关的ID。 pluginConfig Object 传递给插件的配置。 name String routeName String 路由的名称。 routeDestinationName String 目标路由的名称。 dubbo Dubbo object dubbo 服务的信息。 表8 Dubbo 参数 参数类型 描述 service String 服务名。 version String 版本号。 group String 分组。 methods Array of DubboMethod objects dubbo方法列表。 表9 DubboMethod 参数 参数类型 描述 serviceMethod String 服务方法。 headersAttach String 附加请求头。 httpMethods Array of strings http 方法。 httpPath String http 路径。 params Array of DubboMethodParam objects dubbo 方法参数。 表10 DubboMethodParam 参数 参数类型 描述 paramKey String 参数键。 paramSource String 参数来源。 paramType String 参数类型。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM-Token Accept 否 String 该字段内容填为 "application/json" 表3 请求Body参数 参数 是否必选 参数类型 描述 gatewayId 否 String 网关的ID。 pluginConfig 否 Object 传递给插件的配置。 name 否 String routeName 否 String 路由的名称。 routeDestinationName 否 String 目标路由的名称。 dubbo 否 Dubbo object dubbo 服务的信息。 表4 Dubbo 参数 是否必选 参数类型 描述 service 否 String 服务名。 version 否 String 版本号。 group 否 String 分组。 methods 否 Array of DubboMethod objects dubbo方法列表。 表5 DubboMethod 参数 是否必选 参数类型 描述 serviceMethod 否 String 服务方法。 headersAttach 否 String 附加请求头。 httpMethods 否 Array of strings http 方法。 httpPath 否 String http 路径。 params 否 Array of DubboMethodParam objects dubbo 方法参数。 表6 DubboMethodParam 参数 是否必选 参数类型 描述 paramKey 否 String 参数键。 paramSource 否 String 参数来源。 paramType 否 String 参数类型。

响应参数 状态码： 204 删除成功。 状态码： 404 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

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

响应示例 状态码： 200 查询成功。 { "instance": { "instanceId": "4994929d6b8044b29462d4f7daa33c4f", "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": "1650545270", "modTimestamp": "1650545270", "version": "1.0.0" } }