检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
group_id String API所属分组的编号 group_name String API所属分组的名称 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String API的发布记录编号 signature_name
更新SSL证书不影响API的调用。 如果待更新证书已绑定独立域名,那么所有访问这个域名的客户端都会看到更新后的证书。 如果更新的SSL证书已绑定独立域名且更新的内容新增CA证书,那么独立域名侧默认关闭“支持客户端认证”即关闭HTTPS双向认证;如果更新的SSL证书已绑定独立域名且更新的内容无CA
PS、是否开启gzip等多种因素影响。下表是API网关处于30%CPU水位下的QPS参考值,参考场景为无认证和单机流控模式。 安全水位指能够在突发流量增长至双倍的情况下,API网关系统依然维持高吞吐量和低延迟性能。 表1 QPS性能参考 实例规格 基础版 专业版 企业版 铂金版 铂金版x2
如果需要批量发布API,则勾选待发布的API,单击“发布”。最多同时发布1000个API。 选择API需要发布到的环境,并填写发布说明。 图1 发布API 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。 如果在选择的环境时没有自己需要的环境,可以创建一个自己需要的环境。 单击“发布”,完成API发布。
签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样
String 签名算法。默认值为空,仅aes类型签名密钥支持选择签名算法,其他类型签名密钥不支持签名算法。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 name String 签名密钥的名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头。 说明:
功能介绍 解除API与签名密钥的绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/sign-bindings/{id} URI中的参数说明如下表所示。 表2 参数说明
Key”类型。 签名算法 选择aes的签名算法,包含以下两种: aes-128-cfb aes-256-cfb Key 根据选择的密钥类型,填写不同的密钥信息。 HMAC:填写APP认证所使用密钥对的Key。 Basic Auth:填写basic认证所使用的用户名。 aes:填写aes认证所使用的密钥key。
Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
解除绑定 功能介绍 解除API与签名密钥的绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instances/{instance_i
删除插件 功能介绍 删除插件。 必须先解除API和插件的绑定关系,否则删除报错 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id} 表1 路径参数
自定义VPC通道名称,用于识别不同的VPC通道。 端口 VPC通道中主机的端口号,即用户的后端业务端口号。 取值为1 ~ 65535。 成员类型 选择负载通道中的服务器成员类型。成员类型在负载通道创建后将不能修改。 实例:通过选择弹性云服务器的方式添加负载通道成员。 IP地址:通过填写IP地址的方式添加负载通道成员。
前端自定义认证响应的context映射的指定键值对的字符串值 $context.authorizer.backend.property 后端自定义认证响应的context映射的指定键值对的字符串值 $context.error.message 当前网关错误响应的错误信息 $context
对构造好的规范请求进行哈希处理,算法与对RequestPayload哈希处理的算法相同。经过哈希处理的规范请求必须以小写十六进制字符串形式表示。 算法伪代码:Lowercase(HexEncode(Hash.SHA256(CanonicalRequest))) 经过哈希处理的规范请求示例:
String 签名算法。默认值为空,仅aes类型签名密钥支持选择签名算法,其他类型签名密钥不支持签名算法。 update_time String 更新时间 create_time String 创建时间 id String 签名密钥的编号 bind_num Integer 绑定的API数量
ken接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 certs Array of CertBase objects
请求参数匹配编排规则的生效优先级与列表顺序保持一致,列表中靠前的配置匹配优先级较高; 如果编排规则列表中包含none_value类型的规则,则none_value类型的规则优先级最高,至多绑定一个none_value类型的规则; 如果编排规则列表中包含default类型的规则,则def
本节介绍签名密钥与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 签名密钥与API绑定关系对象模型 参数 类型
本节介绍签名密钥与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 签名密钥与API绑定关系对象模型 参数 类型
自定义负载通道名称,用于识别不同的负载通道。 端口 负载通道中主机的端口号,即用户的后端业务端口号。 取值范围为1 ~ 65535。 分发算法 通过分发算法确定请求被发送到哪台主机。 分发算法包含如下几种: 加权轮询 加权最小连接 源地址哈希 URI哈希 通道类型 选择服务器类型,API的请求将被分发