华为云用户手册

约束与限制 同一个环境中，一个API只能被一个Kafka日志推送策略绑定，但一个Kafka日志推送策略可以绑定多个API。 同一个APIG实例内最多可创建5个Kafka日志推送策略。如需调整配额，请提交工单，申请修改。 API绑定Kafka日志推送策略后，性能将损耗30%。性能数据请参考产品规格差异。 日志支持最大推送大小为4K，请求体/响应体支持最大推送大小为1K，超出部分会被截断。 策略和API本身相互独立，只有为API绑定策略后，策略才对API生效。为API绑定策略时需指定发布环境，策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效，不需要重新发布API。 API的下线操作不影响策略的绑定关系，再次发布后仍然会带有下线前绑定的策略。 如果策略与API有绑定关系，则策略无法执行删除操作。

为策略绑定API 单击策略名称，进入策略详情。 在API列表区域选择环境后，单击“绑定API”。 筛选API分组以及发布环境，勾选所需的API。 支持通过API名称或标签筛选API，标签为创建API时定义的标签。 单击“确定”，绑定完成。 如果单个API不需要绑定此策略，单击API所在行的“解绑”。 如果批量API不需要绑定此策略，则勾选待解绑的API，单击列表上方“解绑”。最多同时解绑1000个API。

更新SSL证书 进入证书列表页面，找到待更新证书，在“操作”列单击“编辑”，修改证书信息即可。 更新SSL证书不影响API的调用。 如果待更新证书已绑定独立 域名 ，那么所有访问这个域名的客户端都会看到更新后的证书。 如果更新的SSL证书已绑定独立域名且更新的内容新增CA证书，那么独立域名侧默认关闭“支持客户端认证”即关闭HTTPS双向认证；如果更新的SSL证书已绑定独立域名且更新的内容无CA证书，那么独立域名侧默认关闭“支持客户端认证”即未开启HTTPS双向认证。

转换证书为PEM格式 格式类型 转换方式（通过OpenSSL工具进行转换） CER/CRT 将“cert.crt”证书文件直接重命名为“cert.pem”。 PFX 提取私钥命令，以“cert.pfx”转换为“key.pem”为例。 openssl pkcs12 -in cert.pfx -nocerts -out key.pem 提取证书命令，以“cert.pfx”转换为“cert.pem”为例。 openssl pkcs12 -in cert.pfx -nokeys -out cert.pem P7B 证书转换，以“cert.p7b”转换为“cert.cer”为例。 openssl pkcs7 -print_certs -in cert.p7b -out cert.cer 将“cert.cer”证书文件直接重命名为“cert.pem”。 DER 提取私钥命令，以“privatekey.der”转换为“privatekey.pem”为例。 openssl rsa -inform DER -outform PEM -in privatekey.der -out privatekey.pem 提取证书命令，以“cert.cer”转换为“cert.pem”为例。 openssl x509 -inform der -in cert.cer -out cert.pem

ServiceComb错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 分类 状态码 错误码 错误信息 描述 处理措施 公共错误码 400 400001 Invalid parameter(s) 非法参数 根据错误提示中的规则，修改提示中的参数。 404 404001 ErrRecordNotExists 该资源不存在 输入正确的查找条件。 409 409001 ErrRecordAlreadyExists 该资源已存在 请勿创建相同的记录。 500 500003 Internal server error 内部错误 内部错误请联系运维支持。 微服务 400 400002 ErrUnhealthy 服务处于不健康状态 请稍后重试或联系技术支持工程师。 400010 Micro-service already exists 服务已存在 修改创建微服务body体中的serviceId或微服务描述信息。 400011 ErrUnavailableBackend 没有可提供的后台实例 请稍后重试或联系技术支持工程师。 400012 Micro-service does not exist 服务不存在 请输入有效的serviceId。 400013 Micro-service has deployed instance(s) 无法删除该微服务，该微服务已部署实例 请先将实例下线，再删除微服务；或强制删除微服务（url中添加query参数“force=true”）。 400014 Undefined schema id schemaId不存在 请输入有效的schemaId。 400015 Not allowed to modify schema schema不允许修改 该schema已注册，不支持修改。 400016 Schema does not exist schema不存在 请先注册schema再查询。 400017 Instance does not exist 实例不存在 请输入有效的instanceId。 400018 ErrTagNotExists 标签不存在 通常出现在查询接口，表明标签不存在，业务根据返回值做恰当后续处理。 400019 ErrRuleAlreadyExists 规则已经存在 重复创建规则，通常可以忽略该错误。 400020 ErrBlackAndWhiteRule 错误的黑白名单 根据错误提示修改参数。 400021 ErrModifyRuleNotAllow 不允许更改规则 必须修改版本号才允许更改微服务信息。 400022 ErrRuleNotExists 规则不存在 通常出现在查询接口，表明规则不存在，业务根据返回值做恰当后续处理。 400023 Consumer(s) depends on this micro-service 无法删除该微服务，该微服务被其他微服务依赖 可选择强制删除微服务（url中添加query参数“force=true”）。 400024 ErrPermissionDeny 权限不允许 使用合理的账号进行操作。 400025 ErrEndpointAlreadyExists 端口已存在 建议排查端口是否被其它实例占用。 400026 Micro-service version does not exist 微服务版本不存在 请输入正确的版本号或版本号范围。 400100 Not enough quota 配额不足 对应的资源（如微服务、实例、schema）配额不足，请删除部分资源再创建。 401 401204 No authorization header 认证不通过 若微服务引擎开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的微服务引擎Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取ServiceComb引擎专享版用户Token。 401201 Request unauthorized 认证不通过 输入的Authorization不合法. 403 403001 ErrForbidden 操作受限 使用合理的账号进行操作。 500 500011 Registry service is unavailable 后端错误 内部错误请联系运维支持。 500101 ErrUnavailableQuota 没有提供配额 请稍后重试或联系技术支持工程师。 500605 NA 配置中心Etcd连接失败 请稍后重试或联系技术支持工程师。 认证 401 401202 User name or password is wrong 账号名称或密码错误 输入正确的账号名称和密码。 父主题： 附录

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

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 gatewayId String 网关的ID。 pluginConfig Object 传递给插件的配置。 name String http2rpc插件名称。 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 参数类型。 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

请求示例 PUT https://{endpoint}/v2/{project_id}/enginemgr/gateways/{gateway_id}/http2Rpcs/{http2Rpc_id} { "pluginConfig" : { }, "name" : "string", "routeName" : "string", "routeDestinationName" : "string", "dubbo" : { "service" : "string", "version" : "string", "group" : "string", "methods" : [ { "serviceMethod" : "string", "headersAttach" : "string", "httpMethods" : [ "string" ], "httpPath" : "string", "params" : [ { "paramKey" : "string", "paramSource" : "string", "paramType" : "string" } ] } ] } }

响应示例 状态码： 200 创建成功 { "gatewayId" : "string", "pluginConfig" : { }, "name" : "string", "routeName" : "string", "routeDestinationName" : "string", "dubbo" : { "service" : "string", "version" : "string", "group" : "string", "methods" : [ { "serviceMethod" : "string", "headersAttach" : "string", "httpMethods" : [ "string" ], "httpPath" : "string", "params" : [ { "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 http2rpc插件名称。 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 参数类型。

请求示例 POST https://{endpoint}/v2/{project_id}/enginemgr/gateways/{gateway_id}/http2Rpcs { "gatewayId" : "string", "pluginConfig" : { }, "name" : "string", "routeName" : "string", "routeDestinationName" : "string", "dubbo" : { "service" : "string", "version" : "string", "group" : "string", "methods" : [ { "serviceMethod" : "string", "headersAttach" : "string", "httpMethods" : [ "string" ], "httpPath" : "string", "params" : [ { "paramKey" : "string", "paramSource" : "string", "paramType" : "string" } ] } ] } }

响应示例 状态码： 200 创建成功 { "gatewayId" : "string", "pluginConfig" : { }, "name" : "string", "routeName" : "string", "routeDestinationName" : "string", "dubbo" : { "service" : "string", "version" : "string", "group" : "string", "methods" : [ { "serviceMethod" : "string", "headersAttach" : "string", "httpMethods" : [ "string" ], "httpPath" : "string", "params" : [ { "paramKey" : "string", "paramSource" : "string", "paramType" : "string" } ] } ] } }

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 gatewayId String 网关的ID。 pluginConfig Object 传递给插件的配置。 name String http2rpc插件名称。 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 参数类型。 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM-Token。 Accept 否 String 该字段内容填为 "application/json"。 表3 请求Body参数 参数 是否必选 参数类型 描述 gatewayId 否 String 网关的ID。 pluginConfig 否 Object 传递给插件的配置。 name 否 String http2rpc插件名称。 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 参数类型。

响应示例 状态码： 200 查询成功 { "total" : 0, "data" : [ { "gatewayId" : "string", "pluginConfig" : { }, "name" : "string", "routeName" : "string", "routeDestinationName" : "string", "dubbo" : { "service" : "string", "version" : "string", "group" : "string", "methods" : [ { "serviceMethod" : "string", "headersAttach" : "string", "httpMethods" : [ "string" ], "httpPath" : "string", "params" : [ { "paramKey" : "string", "paramSource" : "string", "paramType" : "string" } ] } ] } } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Integer http2Rpc总数。 data Array of Http2Rpc objects Http2Rpc详细信息。 表4 Http2Rpc 参数 参数类型 描述 gatewayId String 网关的ID。 pluginConfig Object 传递给插件的配置。 name String http2rpc插件名称。 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 参数类型。 状态码： 400 表8 响应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 校验值。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。

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

请求示例 PUT https://{endpoint}/v2/{project_id}/enginemgr/gateways/{gateway_id}/plugins/{plugin_id} { "imagePullPolicy" : "UNSPECIFIED_POLICY", "imagePullSecret" : "string", "phase" : "UNSPECIFIED_PHASE", "pluginConfig" : { }, "pluginName" : "string", "priority" : 0, "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 查询成功 { "imagePullPolicy" : "UNSPECIFIED_POLICY", "imagePullSecret" : "string", "phase" : "UNSPECIFIED_PHASE", "pluginConfig" : { }, "pluginName" : "string", "priority" : 0, "sha256" : "string", "url" : "string", "verificationKey" : "string" }

响应参数 状态码： 200 表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 校验值。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg 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" : { } } ] } ]

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

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

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

请求参数 表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参数 参数 是否必选 参数类型 描述 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 所属环境。