华为云用户手册

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-Schema-Summary String 契约的摘要。 表5 响应Body参数 参数 参数类型 描述 serviceId String 查询实体为服务时，返回服务ID。 schemaId String 查询实体为契约时，返回契约ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Integer http2Rpc 总数。 data Array of Http2Rpc objects Http2Rpc 详细信息。 表4 Http2Rpc 参数 参数类型 描述 gatewayId String 网关的ID。 pluginConfig Object 传递给插件的配置。 name String routeName String 路由的名称。 routeDestinationName String 目标路由的名称。 dubbo Dubbo object dubbo 服务的信息。 表5 Dubbo 参数 参数类型 描述 service String 服务名。 version String 版本号。 group String 分组。 methods Array of DubboMethod objects dubbo方法列表。 表6 DubboMethod 参数 参数类型 描述 serviceMethod String 服务方法。 headersAttach String 附加请求头。 httpMethods Array of strings http 方法。 httpPath String http 路径。 params Array of DubboMethodParam objects dubbo 方法参数。 表7 DubboMethodParam 参数 参数类型 描述 paramKey String 参数键。 paramSource String 参数来源。 paramType 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 所属环境。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 治理策略名称。 selector 否 GovSelector object 治理策略下发范围。 spec 否 Object 治理策略定义内容。 表4 GovSelector 参数 是否必选 参数类型 描述 environment 否 String 所属环境。 app 否 String 所属应用。 service 否 String 可选，治理下发到微服务级别。

请求示例 POST https://{endpoint}/v3/{project_id}/govern/governance/{kind} { "name" : "string", "selector" : { "environment" : "string", "app" : "string", "service" : "string" }, "spec" : { } }

请求示例 注册一个微服务实例，其主机信息为localhost，健康检查的心跳模式为push，心跳间隔为30s，所在region为r1，名字为dc，可用区为az1。 POST https://{endpoint}/v4/{project_id}/registry/microservices/{service_id}/instances { "instance" : { "endpoints" : [ "grpc://127.0.1.312:9980", "rest://127.0.0.111:8081" ], "hostName" : "localhost", "status" : "UP", "properties" : { "_TAGS" : "A, B", "attr1" : "a", "nodeIP" : "127.0.0.1" }, "dataCenterInfo" : { "name" : "dc", "region" : "r1", "availableZone" : "az1" }, "healthCheck" : { "mode" : "push", "interval" : 30, "times" : 3 } } }

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 instanceId String 实例ID。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

请求参数 表2 请求Header参数 参数 是必选 参数类型 描述 Authorization 否 String 若ServiceComb引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的ServiceComb引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取ServiceComb引擎专享版用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 instance 是 MicroServiceInstance object 微服务实例信息。 表4 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 更新时间。 表5 HealthCheck 参数 是否必选 参数类型 描述 mode 是 String 心跳模式push/pull。 port 否 Integer 端口。 interval 是 Integer 心跳间隔（秒），当值小于5秒时，按5秒注册。 times 是 Integer 最大尝试请求次数。 表6 DataCenterInfo 参数 是否必选 参数类型 描述 name 是 String 区域名字。 region 是 String 区域。 availableZone 是 String 可用区。

URI POST /v1/{project_id}/nacos/v1/console/namespaces 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识。字符长度为1~64。 表2 Query参数 参数 是否必选 参数类型 描述 custom_namespace_id 是 String 命名空间ID，仅支持大小写字母、数字、短划线（-）和下划线（_），不超过128个字符。 namespace_name 是 String 命名空间名，支持非@、#、$、%、^、&、*，不超过128个字符。 namespace_desc 否 String 命名空间描述，不超过256个字符。

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

响应参数 状态码： 200 删除成功。 状态码： 404 表3 响应Body参数 参数 参数类型 描述 error_code String 错误代码。 error_message String 错误信息。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误代码。 error_message String 错误信息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误代码。 error_message String 错误信息。

响应参数 状态码： 200 表3 响应Body体 参数 参数类型 描述 quotas EngineQuota 资源配额详情。 表4 EngineQuota 参数 参数类型 描述 resources Array of TenantQuotaUsed↵objects 配额详情列表。 表5 TenantQuotaUsed 参数 参数类型 描述 type String 资源类型 used Integer 已使用配额数量 quota Integer 总配额数量

调用说明 CSE提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用。 微服务、契约、微服务实例、依赖关系接口只在华北-北京一、华北-北京四、华北-乌兰察布一、华东-上海一、华东-上海二、华南-广州、西南-贵阳一、中国-香港、亚太-新加坡、拉美-墨西哥城二、中东-利雅德局点支持。 调用ServiceComb引擎专享版的ServiceComb API的方法如下： 登录CSE控制台。 在左侧导航栏选择“ServiceComb引擎专享版”。 单击待调用接口的ServiceComb引擎。 调用认证、微服务、契约、微服务实例、依赖关系接口时，在“服务发现 & 配置”区域，查看或单击复制“服务注册发现地址”。 调用配置管理接口时，在“服务发现 & 配置”区域，查看或单击复制“配置中心地址”。 参考如何调用API调用该接口，在请求URI中，替换{Endpoint}为已获取到的服务注册发现地址。 父主题： ServiceComb API

响应示例 状态码： 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参数 参数 是否必选 参数类型 描述 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 所属环境。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 治理策略名称。 selector 否 GovSelector object 治理策略下发范围。 spec 否 Object 治理策略定义内容。 表4 GovSelector 参数 是否必选 参数类型 描述 environment 否 String 所属环境。 app 否 String 所属应用。 service 否 String 可选，治理下发到微服务级别。

请求示例 PUT https://{endpoint}/v3/{project_id}/govern/governance/{kind}/{policy_id} { "name" : "string", "selector" : { "environment" : "string", "app" : "string", "service" : "string" }, "spec" : { } }

响应示例 状态码： 200 查询成功。 { "total": 1, "data":[{ "id": "8a9e6a5d-8d65-48fb-a40c-5150c8479da8", "key": "string", "labels": { "key1": "value1", "key2": "value2" }, "value": "string", "value_type": "text", "status": "enabled", "create_time": 1623139038, "update_time": 1623139038, "create_revision": 13, "update_revision": 13 }] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若ServiceComb引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的ServiceComb引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取ServiceComb引擎专享版用户Token。 表3 Query参数 参数 是否必选 参数类型 描述 label 否 String 按label过滤项导出，格式为：{标签key}:{标签value}。 match 否 String 对label过滤项的匹配选项，如果值为exact，表示严格匹配，包括label个数和内容相等；不填表示包含匹配。 revision 否 Integer 配置的版本号。 用于判断本地缓存配置和配置管理中心的配置差异。 首次传值0。 若传入的revision值与当前配置的revision一致，则返回304状态码，无body体返回；若不一致，则返回当前配置和revision信息。 下次请求若需要传入revision，则该值为当前返回body体中的update_revision 。

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

响应示例 状态码： 200 查询成功。 { "instances": [ { "instanceId": "4098483294bb42d8b3c27eee0c166c1c", "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": "1650545431", "modTimestamp": "1650545442", "version": "1.0.0" } ] }

URI GET /v4/{project_id}/registry/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 请填固定值：default。 表2 Query参数 参数 是否必选 参数类型 描述 appId 是 String 应用app唯一标识。字符长度为1~160。 正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$。 serviceName 是 String 微服务名称。字符长度为1~128。 正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$。 tags 否 String Tag标签过滤，多个时逗号分隔。 正则表达式为^[a-zA-Z][a-zA-Z0-9_-.]{0,63}$。 env 否 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" : { } } ] } ]

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

URI GET /v3/{project_id}/govern/governance/display 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识。字符长度为1~64。 表2 Query参数 参数 是否必选 参数类型 描述 environment 是 String 所属环境，填写all时表示查询所有环境。 app 否 String 所属应用。

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

响应示例 查询成功 { "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": [] }

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