华为云用户手册

使用AppCode进行API请求的简易认证 在创建API时，选择“APP认证”并且开启“支持简易认证”。 如果您修改已有API为简易认证，需要在修改完成后，将API重新发布，使简易认证模式生效。 将支持简易认证的API绑定到已创建的凭据。 发送请求时，增加请求头部参数“X-Apig-AppCode”，省略请求签名相关信息。 以Curl方式为例，增加头部参数名称：X-Apig-AppCode，参数值填已生成的AppCode。 curl -X GET "https://api.exampledemo.com/testapi" -H "content-type: application/json" -H "host: api.exampledemo.com" -H "X-Apig-AppCode: xhrJVJKABSOxc7d***********FZL4gSHEXkCMQC"

约束与限制 同一个环境中一个API只能绑定一个签名密钥，一个签名密钥可以绑定多个API。 策略和API本身相互独立，只有为API绑定策略后，策略才对API生效。为API绑定策略时需指定发布环境，策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效，不需要重新发布API。 API的下线操作不影响策略的绑定关系，再次发布后仍然会带有下线前绑定的策略。 如果策略与API有绑定关系，则策略无法执行删除操作。

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

管理API概述 API创建完成后，您还可以进行以下相关操作管理API。 查看或编辑APIG的API信息：您可以通过查看API的基本信息来确认API的调用信息，通过编辑API的基本信息来更改服务信息。 配置API的自定义认证：您可以通过自定义认证来自定义认证系统。 配置API的参数编排规则：您可以通过不同算法规则，将请求参数映射为新的请求参数。 自定义API的错误响应信息：您可以通过网关响应功能，自定义响应状态码或网关响应内容。 克隆APIG的API：您可以通过克隆API功能，快速创建基本信息相同的API。 下线APIG的API：您可以通过下线API功能，将API从相关环境中下线，暂停对外提供的服务。该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户。 导入导出API：您可以通过API设计文件、 CS E微服务、CCE工作负载、导入API到APIG。 APIG的API设计文件扩展定义：导入API设计文件时，您可以参考apig支持的扩展定义，配置API设计文件。 父主题： 管理API

x-apigateway-access-controls.policy 含义：访问控制策略定义。 作用域：x-apigateway-access-controls 示例： x-apigateway-access-controls: customAccessControlName: acl-type: "DENY" entity-type: "IP" value: 127.0.0.1,192.168.0.1/16 表1 参数说明 参数 是否必选 类型 说明 acl-type 是 String 访问控制行为，支持PERMIT、DENY。 entity-type 是 String 访问控制对象，仅支持IP。 value 是 String 访问控制策略值，多个值以“,”间隔。 父主题： APIG的API设计文件扩展定义

x-apigateway-auth-opt 含义：APP简易认证方式参数。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger示例： securityDefinitions: apig-auth-app: type: apiKey name: Authorization in: header x-apigateway-auth-type: AppSigv1 apig-auth-app-header: type: apiKey name: Authorization in: header x-apigateway-auth-opt: appcode-auth-type: header x-apigateway-auth-type: AppSigv1 apig-auth-iam: type: apiKey name: unused in: header x-apigateway-auth-type: IAM OpenAPI示例： securitySchemes: apig-auth-app: in: header name: Authorization type: apiKey x-apigateway-auth-type: AppSigv1 apig-auth-app-header: in: header name: Authorization type: apiKey x-apigateway-auth-opt: appcode-auth-type: header x-apigateway-auth-type: AppSigv1 apig-auth-iam: in: header name: unused type: apiKey x-apigateway-auth-type: IAM 表1 参数说明 参数 是否必选 类型 说明 appcode-auth-type 否 String AppCode简易认证类型，默认为disable。 disable：不开启简易认证 header：开启简易认证且AppCode位置在HEADER。 父主题： APIG的API设计文件扩展定义

x-apigateway-ratelimits.policy 含义：流控策略定义。 作用域：x-apigateway-ratelimits 示例： x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit: 200 user-limit: 200 ip-limit: 200 interval: 1 unit: MINUTE shared: false special: - type: USER limit: 100 instance: xxxxxxx 表1 参数说明 参数 是否必选 类型 说明 api-limit 是 Number API访问次数限制。 user-limit 否 Number 用户访问次数限制。 app-limit 否 Number 应用访问次数限制。 ip-limit 否 Number 源IP访问次数限制。 interval 是 Number 流控策略时间周期。 unit 是 String 流控策略时间周期单位，支持SECOND、MINUTE、HOUR、DAY。 shared 否 Boolean 是否共享流控策略。 special 否 x-apigateway-ratelimits.policy.special 对象数组 特殊流控策略。 父主题： APIG的API设计文件扩展定义

x-apigateway-backend.functionEndpoints 含义：API网关定义的FUNCTION类型API后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "认证token" type: "string" in: "header" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "FUNCTION" functionEndpoints: version: "v1" function-urn: "" invocation-type: "synchronous" timeout: 30000 表1 参数说明 参数 是否必选 类型 说明 function-urn 是 String 函数URN地址。 version 是 String 函数版本。 invocation-type 是 String 函数调用类型，支持异步或同步。 timeout 否 Number 函数超时时间，单位毫秒，缺省值为5000，取值范围为1~60000。 父主题： APIG的API设计文件扩展定义

响应消息头 调用API时，API网关增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求，都会返回此参数 X-Apig-Latency 从API网关接收请求到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug时，返回此参数 X-Apig-Upstream-Latency 从API网关请求后端到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug，且后端服务类型不为Mock时，返回此参数 X-Apig-RateLimit-api API流量控制信息 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了API流量控制时，返回此参数 X-Apig-RateLimit-user 用户流量限制信息 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了用户流量限制时，返回此参数 X-Apig-RateLimit-app 应用流量限制信息 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了应用流量限制时，返回此参数 X-Apig-RateLimit-ip 源IP流量限制信息 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了源IP流量限制时，返回此参数 X-Apig-RateLimit-api-allenv API默认流控信息 示例：remain:199,limit:200,time:1 second 仅在请求消息头包含X-Apig-Mode: debug时，返回此参数 父主题： 调用已发布的API

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

约束与限制 同一个环境中，一个API只能被一个流量镜像策略绑定，但一个流量镜像策略可以绑定多个API。 镜像请求返回的响应会被忽略。 镜像请求的请求体大小受实例参数“request_body_size”控制，默认请求体大小为12MB，可通过“request_body_size”参数调整请求体大小，请求体大小调整越大性能损耗越大，请谨慎操作。 API的后端服务类型为Mock时，不支持绑定流量镜像策略。 策略和API本身相互独立，只有为API绑定策略后，策略才对API生效。为API绑定策略时需指定发布环境，策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效，不需要重新发布API。 API的下线操作不影响策略的绑定关系，再次发布后仍然会带有下线前绑定的策略。 如果策略与API有绑定关系，则策略无法执行删除操作。

x-apigateway-access-control 含义：引用访问控制策略。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-access-control: 'customAccessControlName' 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-access-control 否 String 访问控制策略。 父主题： APIG的API设计文件扩展定义

x-apigateway-backend.parameters 含义：API网关定义的API后端参数定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "认证token" type: "string" in: "header" required: true - name: "userId" description: "用户名" type: "string" in: "path" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "HTTP" parameters: - name: "userId" value: "userId" in: "query" origin: "REQUEST" description: "用户名" - name: "X-Invoke-User" value: "apigateway" in: "header" origin: "CONSTANT" description: "调用者" 表1 参数说明 参数 是否必选 类型 说明 name 是 String 参数名称，长度不能超过32个字节，由字母、数字、下划线、连线或点组成，且必须以字母开头。 header位置的参数名称不区分大小写。 value 是 String 参数值，当参数来源为REQUEST时，值为请求参数名称。 in 是 String 参数位置，支持header、query、path。 origin 是 String 参数映射来源，支持REQUEST、CONSTANT。 description 否 String 参数含义描述。 父主题： APIG的API设计文件扩展定义

注意事项 仅支持华为云 CCE Turbo 集群、VPC网络模型的CCE集群。 您需要确保当前实例与CCE集群所属同一个VPC中，或通过其他方式保证两者网络可达，否则导入后调用API会出现失败场景。 选择VPC网络模型的CCE集群时，您需要在实例详情界面的路由配置中添加CCE集群的容器网段，否则导入后调用API会出现失败场景。 导入后会生成相应的API以及微服务类型的负载通道，负载通道会监测工作负载下所有实例的地址变化，并更新到负载通道中。

x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义API网关支持的特有认证方式。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger： securityDefinitions: apig-auth-app: in: header name: Authorization type: apiKey x-apigateway-auth-type: AppSigv1 apig-auth-iam: in: header name: unused type: apiKey x-apigateway-auth-type: IAM OpenAPI示例： securitySchemes: apig-auth-app: in: header name: Authorization type: apiKey x-apigateway-auth-type: AppSigv1 apig-auth-iam: in: header name: unused type: apiKey x-apigateway-auth-type: IAM 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-auth-type 是 String API网关认证方式，支持AppSigv1、IAM。 type 是 String 认证类型，仅支持apiKey。 name 是 String 用于认证的参数名称。 in 是 String 仅支持header。 description 否 String 描述信息。 父主题： APIG的API设计文件扩展定义

APIG的API响应消息头说明 调用API时，API网关增加下表中的响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关调试信息。 响应消息头 描述 X-Request-Id 请求ID。所有合法请求，都会返回此参数。 X-Apig-Latency 从API网关接收请求到后端返回消息头的用时。仅在请求消息头包含X-Apig-Mode: debug时，返回此参数。 X-Apig-Upstream-Latency 从API网关请求后端到后端返回消息头的用时。仅在请求消息头包含X-Apig-Mode: debug，且后端服务类型不为Mock时，返回此参数。 X-Apig-RateLimit-api API流量控制信息。 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了API流量控制时，返回此参数。 X-Apig-RateLimit-user 用户流量限制信息。 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了用户流量限制时，返回此参数 X-Apig-RateLimit-app 凭据流量限制信息。 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了凭据流量限制时，返回此参数。 X-Apig-RateLimit-ip 源IP流量限制信息。 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了源IP流量限制时，返回此参数。 X-Apig-RateLimit-api-allenv API默认流控信息。 示例：remain:199,limit:200,time:1 second 仅在请求消息头包含X-Apig-Mode: debug时，返回此参数。 X-Apig-count 请求经过APIG的总次数。 经过APIG调用的合法请求都会返回此参数，当X-Apig-count请求头取值大于10时，会报错APIG.0612。 父主题： 调用API

脚本配置示例 { "breaker_condition":{ "breaker_type":"timeout", "breaker_mode":"counter", "unhealthy_threshold":30, "time_window":15, "open_breaker_time":15, "unhealthy_percentage":51, "min_call_threshold":20 }, "scope":"share", "downgrade_default":{ "type":"http", "passthrough_infos":null, "func_info":null, "mock_info":null, "http_info":{ "isVpc":false, "vpc_channel_id":"", "address":"10.10.10.10", "scheme":"HTTP", "method":"GET", "path":"/demo", "timeout":5000 }, "http_vpc_info":null }, "downgrade_parameters":[ { "name":"reqPath", "type":"path", "value":"path", "disabled":true, "focused":true, "id":"92002eqbpilg6g" }, { "name":"method", "type":"method", "value":"method", "disabled":true, "focused":true, "id":"tuvxetsdqvcos8" }], "downgrade_rules":[ { "rule_name":"rule-test1", "parameters":[ "reqPath", "method" ], "match_regex":"[\"reqPath\",\"==\",\"/test\"]", "downgrade_backend":{ "type":"mock", "passthrough_infos":null, "func_info":null, "mock_info":{ "status_code":200, "result_content":"{status: ok}", "headers":[] }, "http_info":null, "http_vpc_info":null }, "breaker_condition":{ "breaker_type":"timeout", "breaker_mode":"percentage", "unhealthy_threshold":30, "time_window":15, "open_breaker_time":15, "unhealthy_percentage":51, "min_call_threshold":20 } }]}

约束与限制 同一个环境中，一个API只能被一个断路器策略绑定，但一个断路器策略可以绑定多个API。 策略和API本身相互独立，只有为API绑定策略后，策略才对API生效。为API绑定策略时需指定发布环境，策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效，不需要重新发布API。 API的下线操作不影响策略的绑定关系，再次发布后仍然会带有下线前绑定的策略。 如果策略与API有绑定关系，则策略无法执行删除操作。

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

使用流程 在控制台创建签名密钥。 将新创建的签名密钥绑定API。 API网关将签名后的请求发送到后端服务，此时Authorization头中包含签名信息。后端服务通过不同的开发语言（例如Java、Go、Python、JavaScript、C#、PHP、C++、C、Android等）进行签名，比对签名结果和API网关传过来的Authorization头中签名是否一致来校验API的合法性。 图1 签名密钥流程

操作场景 签名密钥用于后端服务验证API网关的身份，在API网关请求后端服务时，保障后端服务的安全。 签名密钥是由一对Key和Secret组成，签名密钥需要绑定到API才能生效。当签名密钥绑定API后，API网关向后端服务发送此API的请求时，会增加相应的签名信息，此时需要后端服务依照同样方式进行签名，通过比对签名结果和API网关传过来的Authorization头中签名是否一致来校验API的合法性。 同一个环境中一个API只能绑定一个签名密钥，一个签名密钥可以绑定多个API。

非简单请求 对于非简单请求，您需要开启跨域访问，并且创建一个“Method”为“OPTIONS”的API。 跨域共享资源插件不需要创建一个“Method”为“OPTIONS”的API。 “Method”为“OPTIONS”的API和普通API的区别如下： 所属分组：选择已开启CORS的API所在的分组。 安全认证：可选择“无认证”。无论选择哪种认证方式，API网关都按照无认证处理。 请求协议：选择与已开启CORS的API相同的请求协议。 请求Path：填斜杠/即可，也可选择与已开启CORS的API相同或者匹配的请求Path。 Method：选择“OPTIONS”。 支持CORS：选择开启CORS。 假设后端服务类型为Mock，示例如下： 浏览器发送“Method”为“OPTIONS”的API请求： OPTIONS /HTTP/1.1User-Agent: curl/7.29.0Host: localhostAccept: */*Origin: http://www.cors.comAccess-Control-Request-Method: PUT Access-Control-Request-Headers: X-Sdk-Date Origin：此字段必选，表示请求消息所属源。 Access-Control-Request-Method：此字段必选，表示请求会使用哪些HTTP请求方法。 Access-Control-Request-Headers：此字段可选，表示请求会额外发送的头信息字段。 后端服务返回消息：无 API网关返回消息： HTTP/1.1 200 OKDate: Tue, 15 Jan 2019 02:38:48 GMTContent-Type: application/jsonContent-Length: 1036Server: api-gatewayX-Request-Id: c9b8926888c356d6a9581c5c10bb4d11Access-Control-Allow-Origin: *Access-Control-Allow-Headers: X-Stage,X-Sdk-Date,X-Sdk-Nonce,X-Proxy-Signed-Headers,X-Sdk-Content-Sha256,X-Forwarded-For,Authorization,Content-Type,Accept,Accept-Ranges,Cache-Control,RangeAccess-Control-Expose-Headers: X-Request-Id,X-Apig-Latency,X-Apig-Upstream-Latency,X-Apig-RateLimit-Api,X-Apig-RateLimit-User,X-Apig-RateLimit-App,X-Apig-RateLimit-Ip,X-Apig-RateLimit-Api-AllenvAccess-Control-Allow-Methods: GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCHAccess-Control-Max-Age: 172800 Access-Control-Allow-Origin：此字段必选，“*”表示API网关接受任意域的请求。 Access-Control-Allow-Headers：当请求消息中包含此字段时，此字段必选。表示允许跨域的所有请求头信息字段。 Access-Control-Expose-Headers：表示跨域访问允许查看的返回头信息字段。 Access-Control-Allow-Methods：此字段必选，表示API网关支持的所有HTTP请求方法。 Access-Control-Max-Age：此字段可选，表示本次预检的有效期，单位：秒。在有效期内，无需再次发出预检请求。 浏览器发送一个带Origin字段的请求头： PUT /simple HTTP/1.1Host: www.test.comOrigin: http://www.cors.comContent-Type: application/x-www-form-urlencoded; charset=utf-8Accept: application/jsonDate: Tue, 15 Jan 2019 01:25:52 GMT 后端服务返回消息： HTTP/1.1 200 OKDate: Tue, 15 Jan 2019 01:25:52 GMTContent-Type: application/jsonContent-Length: 16Server: api-gateway{"status":"200"} API网关返回消息： HTTP/1.1 200 OKDate: Tue, 15 Jan 2019 01:25:52 GMTContent-Type: application/jsonContent-Length: 16Server: api-gatewayX-Request-Id: 454d689fa69847610b3ca486458fb08bAccess-Control-Allow-Origin: *{"status":"200"}

什么是跨域访问 浏览器出于安全性考虑，会限制从页面脚本内发起的跨域访问（CORS）请求，此时页面只能访问同源的资源，而CORS允许浏览器向跨域服务器，发送XMLHttpRequest请求，从而实现跨域访问。 图1 跨域访问示意图 浏览器将CORS请求分为两类： 简单请求 简单跨域请求的场景需要满足以下两个条件： 请求方法是HEAD，GET，或者POST。 HTTP的头信息不超出以下范围： Accept Accept-Language Content-Language Last-Event-ID Content-Type：取值范围：application/x-www-form-urlencoded、multipart/form-data、text/plain 对于简单请求，浏览器自动在头信息之中，添加一个Origin字段，Origin字段用于说明本次请求来自哪个源（协议+ 域名 +端口）。服务器根据这个值，决定是否同意这次请求。服务器响应消息中包含“Access-Control-Allow-Origin”时，表示同意请求。 非简单请求 不满足简单请求两个条件的都为非简单请求。 对于非简单请求，在正式通信之前，浏览器会增加一次HTTP查询请求，称为预检请求。浏览器询问服务器，当前页面所在的源是否在服务器的许可名单之中，以及可以使用哪些HTTP请求方法和头信息字段。预检通过后，浏览器向服务器发送简单请求。

开启跨域访问 API网关默认不开启跨域访问，如果您需要开启，请参考以下说明完成跨域配置。 简单请求的跨域访问 如果是创建新的API，在定义API请求时，打开“支持跨域（CORS）”开关。详细的使用指导，可参考简单请求。 图2 支持跨域 非简单请求的跨域访问 非简单请求的跨域访问需要在API的分组中创建一个“Method”为“OPTIONS”的API，作为预检请求。 预检请求API的参数设置，请参考以下说明填写。详细的使用指导可参考非简单请求。 在API的基本信息中，安全认证选“无认证”。 图3 预检请求-使用无认证 定义API请求时，参数填写说明如下： 请求协议：选择与已开启CORS的API相同的请求协议 请求Path：填斜杠/ Method：选择“OPTIONS” 支持CORS：选择开启CORS 图4 预检请求-设置API请求 后端服务选择Mock。 图5 预检请求-后端服务类型Mock

简单请求 对于简单请求，您需要开启简单跨域访问。 场景一：已开启CORS，且后端服务响应消息中未指定跨域头时，API网关接受任意域的请求，并返回“Access-Control-Allow-Origin”跨域头，示例如下： 浏览器发送一个带Origin字段的请求消息： GET /simple HTTP/1.1Host: www.test.comOrigin: http://www.cors.comContent-Type: application/x-www-form-urlencoded; charset=utf-8Accept: application/jsonDate: Tue, 15 Jan 2019 01:25:52 GMT Origin：此字段必选，表示请求消息所属源，上例中请求来源于“http://www.cors.com”，API网关/后端服务根据这个值，决定是否同意本次请求。 后端服务返回响应消息： HTTP/1.1 200 OKDate: Tue, 15 Jan 2019 01:25:52 GMTContent-Type: application/jsonContent-Length: 16Server: api-gateway{"status":"200"} API网关响应消息： HTTP/1.1 200 OKDate: Tue, 15 Jan 2019 01:25:52 GMTContent-Type: application/jsonContent-Length: 16Server: api-gatewayX-Request-Id: 454d689fa69847610b3ca486458fb08bAccess-Control-Allow-Origin: *{"status":"200"} Access-Control-Allow-Origin：此字段必选，“*”表示API网关接受任意域的请求。 场景二：已开启CORS，且后端服务响应消息中指定跨域头时，后端服务响应的跨域头将覆盖API网关增加的跨域头，示例如下： 浏览器发送一个带Origin字段的请求消息： GET /simple HTTP/1.1Host: www.test.comOrigin: http://www.cors.comContent-Type: application/x-www-form-urlencoded; charset=utf-8Accept: application/jsonDate: Tue, 15 Jan 2019 01:25:52 GMT Origin：此字段必选，表示请求消息所属源，上例中请求来源于“http://www.cors.com”，API网关/后端服务根据这个值，决定是否同意本次请求。 后端服务返回响应消息： HTTP/1.1 200 OKDate: Tue, 15 Jan 2019 01:25:52 GMTContent-Type: application/jsonContent-Length: 16Server: api-gatewayAccess-Control-Allow-Origin: http://www.cors.com{"status":"200"} Access-Control-Allow-Origin：表示后端服务接受“http://www.cors.com”的请求。 API网关响应消息： HTTP/1.1 200 OKDate: Tue, 15 Jan 2019 01:25:52 GMTContent-Type: application/jsonContent-Length: 16Server: api-gatewayX-Request-Id: 454d689fa69847610b3ca486458fb08bAccess-Control-Allow-Origin: http://www.cors.com{"status":"200"} 后端服务响应消息中的跨域头覆盖API网关响应消息中的跨域头。

操作场景 使用APP认证的API，需要在API网关中创建一个应用，以生成应用ID和密钥对（AppKey、AppSecret）。将创建的应用绑定API后，才可以使用APP认证调用API。在API调用过程中，把密钥对替换SDK中的密钥对，API网关服务根据密钥对进行身份核对，完成鉴权。关于使用APP认证的方法，具体请参考《API网关开发指南》。 从云商店购买的API，系统自动创建一个应用，无需单独创建应用。 使用无认证/华为IAM认证的API，无需创建应用。 应用配额包括您自行创建的应用和在云商店购买API生成的应用。

API网关监控指标 表1 API网关共享版支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期（原始指标） avg_latency 平均延迟毫秒数 该指标用于统计测量api接口平均响应延时时间 ≥0 单位：毫秒 单个API 1分钟 input_throughput 流入流量 该指标用于统计测量api接口请求流量 ≥0 单位：Byte/KB/MB/GB 单个API 1分钟 max_latency 最大延迟毫秒数 该指标用于统计测量api接口最大响应延时时间 ≥0 单位：毫秒 单个API 1分钟 output_throughput 流出流量 该指标用于统计测量api接口返回流量 ≥0 单位：Byte/KB/MB/GB 单个API 1分钟 req_count 接口调用次数 该指标用于统计测量api接口调用次数 ≥0 单个API 1分钟 req_count_2xx 2xx调用次数 该指标用于统计测量api接口调用2xx的次数 ≥0 单个API 1分钟 req_count_4xx 4xx异常次数 该指标用于统计测量api接口返回4xx错误的次数 ≥0 单个API 1分钟 req_count_5xx 5xx异常次数 该指标用于统计测量api接口返回5xx错误的次数 ≥0 单个API 1分钟 req_count_error 异常次数 该指标用于统计测量api接口总的错误次数 ≥0 单个API 1分钟

错误码 当调用API时，可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 通过APIG接口管理API，发生错误时，产生的错误码请参考错误码。 使用APIG错误码时，请以错误码（如APIG.0101）为准，错误信息并非固定不变，有时会对错误信息进行优化修改。 表1 错误码 错误码 错误信息 HTTP状态码 语义 解决方案 APIG.0101 The API does not exist or has not been published in the environment. 404 API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和创建的API是否一致；检查API是否发布，如果发布到非生产环境，检查请求X-Stage头是否为发布的环境名；检查调用API使用的域名是否已经绑定到API所在的分组。 APIG.0101 The API does not exist. 404 API请求方法不存在 检查API请求方法是否与API定义的方法相同 APIG.0103 The backend does not exist. 500 无法找到后端 联系技术支持 APIG.0104 The plug-ins do not exist. 500 无法找到插件配置 联系技术支持 APIG.0105 The backend configurations do not exist. 500 无法找到后端配置 联系技术支持 APIG.0106 Orchestration error. 400 编排错误 检查API配置的前后端参数是否合理 APIG.0201 API request error. 400 请求格式不合法 使用合法的请求 APIG.0201 Request entity too large. 413 请求body过大（大于12M） 减小请求body大小 APIG.0201 Request URI too large. 414 请求URI过大（大于32K） 减小请求URI大小 APIG.0201 Request headers too large. 494 请求头过大（单个请求头大于32K或所有请求头总长度大于128K） 减小请求头大小 APIG.0201 Backend unavailable. 502 后端不可用 检查API配置的后端地址是否可用 APIG.0201 Backend timeout. 504 后端超时 增大超时时间或缩小后端的处理时间 APIG.0201 An unexpected error occurred 500 内部错误 联系技术支持 APIG.0202 Backend unavailable 502 后端不可用 检查API配置的后端请求协议是否与后端服务请求协议一致 APIG.0203 Backend timeout. 504 后端超时 增大超时时间或缩小后端的处理时间 APIG.0204 SSL protocol is not supported: TLSv1.1 400 SSL协议版本不支持 使用支持的SSL协议版本 APIG.0301 Incorrect IAM authentication information. 401 IAM认证信息错误 检查token是否正确，具体请参见IAM信息认证错误 APIG.0302 The IAM user is not authorized to access the API. 403 IAM用户不允许访问API 检查用户是否被黑白名单限制 APIG.0303 Incorrect app authentication information. 401 APP认证信息错误 APP签名认证时，做如下检查： 检查请求的方法、路径、查询参数、请求体和签名使用的方法、路径、查询参数、请求体是否一致 检查客户端机器时间是否正确 请参考使用APP认证调用API检查签名代码的问题。 APPCODE简易认证时，做如下检查：检查请求是否携带了X-Apig-AppCode头域 APIG.0304 The app is not authorized to access the API. 403 APP不允许访问API 检查APP是否授权访问API APIG.0305 Incorrect authentication information. 401 认证信息错误 检查认证信息是否正确 APIG.0306 API access denied. 403 不允许访问API 检查是否授权访问API APIG.0307 The token must be updated. 401 token需要更新 重新从IAM获取token APIG.0308 The throttling threshold has been reached. 429 超出流控值限制 等待流控刷新后访问。如果触发子域名的单日请求数上限，请绑定独立域名。 APIG.0310 The project is unavailable. 403 project不可使用 使用其他project访问 APIG.0311 Incorrect debugging authentication information. 401 调试认证信息错误 联系技术支持 APIG.0401 Unknown client IP address. 403 无法识别客户端IP地址 联系技术支持 APIG.0402 The IP address is not authorized to access the API. 403 IP地址不允许访问 检查IP地址是否被黑白名单限制 APIG.0404 Access to the backend IP address has been denied. 403 后端IP不允许访问 后端IP地址或后端域名对应的IP地址不允许访问 APIG.0501 The app quota has been used up. 405 APP已经超出配额 或云商店调用次数用完 扩大APP配额 或重新购买云商店调用次数 APIG.0502 The app has been frozen. 405 APP被冻结 余额不足 APIG.0601 Internal server error. 500 内部错误 联系技术支持 APIG.0602 Bad request. 400 非法请求 检查请求是否合法 APIG.0605 Domain name resolution failed. 500 域名解析失败 检查域名拼写，以及域名是否绑定了正确的后端地址 APIG.0606 Failed to load the API configurations. 500 未加载API配置 联系技术支持 APIG.0607 The following protocol is supported: {xxx} 400 协议不被允许，允许的协议是xxx。 注意：xxx以实际响应中的内容为准。 改用支持的协议（HTTP/HTTPS）访问 APIG.0608 Failed to obtain the admin token. 500 无法获取管理租户 联系技术支持 APIG.0609 The VPC backend does not exist. 500 找不到vpc后端 联系技术支持 APIG.0610 No backend available. 502 没有可连接的后端 检查所有后端是否可用，如调用信息与实际配置是否一致。 APIG.0611 The backend port does not exist. 500 后端端口未找到 联系技术支持 APIG.0612 An API cannot call itself. 500 API调用自身 修改API后端配置，递归调用层数不能超过10层。 APIG.0613 The IAM service is currently unavailable. 503 IAM服务暂时不可用 联系技术支持 APIG.0705 Backend signature calculation failed. 500 计算后端签名失败 联系技术支持 APIG.0802 The IAM user is forbidden in the currently selected region 403 该IAM用户在当前region中被禁用 联系技术支持 APIG.1009 AppKey or AppSecret is invalid 400 AppKey或AppSecret不合法 检查请求的AppKey或AppSecret是否正确 父主题： 调用已发布的API

云视频交付实施服务可以提供哪些服务？ 3D数字内容制作、虚拟视频制作、虚拟直播。 服务类型 服务内容 典型应用场景 3D数字内容制作 面向互娱、教育、企业、电商等场景，提供3D卡通数字人、美型数字人、写实数字人及相关配饰制作服务 面向制作行业、文旅、金融等行业客户，通过数字人视频介绍公司产品，传递公司价值 虚拟视频制作 提供视频镜头设计，结合数字人模型、虚拟背景、真实背景输出高质量视频 面向教育、培训等行业客户，使用数字人制作教育课件，降低教师重复繁琐的工作投入 虚拟直播 面向互娱、企业、电商等直播场景，提供数字人直播服务，用户可配置各种直播属性，即可生成主播视觉驱动的数字人直播流 面向娱乐、电商等行业客户，通过引入数字人和真人互动，提升直播带货效果，增加用户粘性 父主题： 关于服务咨询

场景三：删除和重命名字段（e_drop_fields函数和e_rename函数） 一般情况下，推荐您使用e_compose函数进行多个函数的组合操作。 示例如下所示： 原始日志 {"content":"123","age":23,"name":"twiss","IdNumber":1} 加工规则：首先判断content字段值是否为123，如果是，则删除age和name字段，再将IdNumber字段重命名为Id。 e_if(e_search("content==123"),e_compose(e_drop_fields("age|name"), e_rename("IdNumber", "Id"))) 加工结果 {"Id": 1,"content": 123} 父主题： 使用DSL加工函数清洗LTS日志数据