检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
将签名信息置于请求消息头的Authorization。 客户端须注意本地时间与时钟服务器的同步，避免请求消息头X-Sdk-Date的值出现较大误差。 API网关除了校验时间格式外，还会校验该时间值与网关收到请求的时间差，如果时间差大于15分钟，API网关将拒绝请求。 父主题： 使用APP认证调用API
字符。 使用AppCode进行API请求的简易认证 在创建API时，选择“APP认证”并且开启“支持简易认证”。 如果您修改已有API为简易认证，需要在修改完成后，将API重新发布，使简易认证模式生效。 将支持简易认证的API绑定到已创建的凭据。 发送请求时，增加请求头部参数“X
还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择JSON、YAML或YML。 自定义版本 为导出的API自定义版本号，如果没有指定版本号，默认使用当前时间。 OpenAPI版本 选择导出Swagger 2.0或OpenAPI 3.0定义的API。 单击“导
x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义API网关支持的特有认证方式。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger： securityDefinitions:
PI网关的一些Swagger扩展字段。 全量定义：包括API前端请求定义、后端服务定义和响应定义。 扩展定义：包括API前端请求定义、后端服务定义和响应定义，还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择JSON或YAML。 自定义版本 为导出的API自定
AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 通过AK/SK获取的Token有效期最短为15分钟。 AK/SK既可以使用永久访问密钥中的AK/SK，也可以使用临时访问密钥中的AK/SK，但使用临时访问密钥的AK/SK时需要额外携带“X-Security
Language，缩写IDL），同时底层的消息交换格式也是使用protobuf。 当用户使用gRPC服务时，可以通过API网关创建API，实现gRPC服务的路由转发。 约束与限制 由于GRPCS协议的约束，gRPC类型的API不支持导入、导出、调试。 父主题： 使用APIG专享版实现gRPC服务的路由转发
为了方便管理API的生命周期，API网关定义了API受限使用范围，这个受限使用的范围，称为环境，例如API的测试环境，开发环境等。 环境定义了API生命周期管理过程中的不同状态，API可以被发布到不同的自定义环境中。 调用不同环境的API，一般通过在API调用的请求头增加指定的头部参数，
单击“下一步”，进入配置API的后端信息。 配置API的后端信息 支持定义多个策略后端，即满足一定条件后转发给指定的API后端服务，用以满足不同的调用场景。例如为了区分普通调用与特殊调用，可以定义一个“策略后端”，通过调用方的源IP地址，为特殊调用方分配专用的后端服务。 除了定义一个默认的API后端
可以配置单账号名或多账号名，多账号名以英文格式下的逗号“,”隔开，账号名支持除英文格式下“,”以外的任意ASCII字符，账号名长度限制在1~64个字符，不支持纯数字。多账号名字符的总长度不超过1024。 账号ID：仅适用IAM认证类型的API，限制调用API的账号ID。仅支持配置账号ID，对
配置API的后端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权，可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型： 前端自定义认证：指APIG使用自定义的认证函数，对收到的API请求进行安全认证。 后端自定义认证：指API的后端服务使用自定义的认证函数，
method参数说明 名称 是否必选 参数类型 说明 operationId 否 String API的名称 description 否 String API的描述信息 schemes 否 Object API的请求协议对象数组定义，支持http、https tags 否 Object API标签对象数组定义
导入API到新分组 功能介绍 通过导入的swagger文件创建新分组和新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1.0/apigw/openapi URI中的参数说明如下表所示。 表2
IP地址/域名可以是公网IP（支持云服务器的弹性IP地址、用户自己服务器的公网IP地址、ELB地址）/公网域名，前提需要开启实例的公网出口。可以是内网的IP，不可以是内网域名。 2022年10月30日后创建的实例支持APIG与后端服务tls握手阶段向后端服务传SNI。 路径 后端服务的路径，即服务的uri，可以
开启后，API网关将认证API后端服务。双向认证所需的证书配置说明，请参考配置参数。 路径 仅在协议不为“TCP”时，需要设置。 健康检查时的目标路径。 请求类型 GET HEAD 检查端口 健康检查的目标端口。 缺省时，检查端口为负载通道的端口号。 正常阈值 判定负载通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。
前端自定义认证响应的context映射的指定键值对的字符串值 $context.authorizer.backend.property 后端自定义认证响应的context映射的指定键值对的字符串值 $context.error.message 当前网关错误响应的错误信息 $context
API名称，根据规划自定义。建议您按照一定的命名规则填写API名称，方便您快速识别和查找。 支持中文、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、中文或数字开头，长度为3~255个字符。 API路径 API的请求路径。请求路径可以包含请求
配置API的前端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权，可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型： 前端自定义认证：指APIG使用自定义的认证函数，对收到的API请求进行安全认证。 后端自定义认证：指API的后端服务使用自定义的认证函数，
Python 再次单击“Next”，弹出以下对话框。单击“...”，在弹出的对话框中选择解压后的SDK路径，单击“Finish”。 图3 选择解压后的SDK路径 完成工程创建后，目录结构如下。 图4 新建工程python的目录结构 “main.py”为示例代码，请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。
当“镜像协议”为HTTP/HTTPS时设置。 镜像请求的路径，支持* % - _ .等特殊字符，总长度不超过512，且满足URI规范。如果不指定镜像请求路径，那么默认使用绑定的API的请求路径。 拼接模式 当指定镜像请求的路径后，可以设置请求路径的拼接模式。 replace模式：表示使用指定的“镜像请求路径”作为镜像请求的路径。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
