检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
小于0.5%。 在对API日志处理过程中,仅能对API日志进行增维操作,禁止对API日志中重要部分,如请求时间、请求者身份、请求IP地址、请求域名、请求URL地址、响应时间、响应状态码进行篡改。 父主题: API开放
签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。 访问控制:API网关代理支持通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。
请求Header或者Query中携带请求签名、请求时间和应用身份进行身份认证,该认证方法对请求中URI、HTTP方法、AppId、SignKey、请求时间等采用HMAC-SHA256进行计算,在API请求过程中不会直接传递SignKey,同时对请求时间进行有效校验,避免重复请求攻击。 动态Token
API异常响应Body内容,异常响应Body中描述及说明。 API请求尽量少使用自定义消息头 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 标准消息头及其取值格式按照参考标准,并尽量最小化添加自定义消息头。 所有消息头命名格式一致,自定义消息头命名规范:用连词符“-”分隔单词,采用大驼峰方式如X-APIG-TOKEN。
本条规则是Should类型的扩展规则,可方便管理API的生命周期。 API接口的变更,要具体到参数级别,必须将API修订的记录按照时间和版本顺序排列进行条目化,具体示例如表1所示。 表1 API修订记录 时间 版本 变更内容 2021-07-15 V1.0 XXX服务API初始发布 2021-09-20 V1
unavailable. 检查API配置的后端地址是否可用。 504 APIC.0203 Backend timeout. 增大超时时间或缩小后端的处理时间。 401 APIC.0301 Incorrect IAM authentication information. 检查token是否正确。
通过集群提供服务,集群中每个微服务都有多个实例,当一个或部分实例异常时,其他实例可以持续提供服务。 数据容灾 数据存储在RDS服务中,RDS实现了AZ容灾方案,数据持续会同步到容灾站点,当生产站点的RDS异常后,容灾站点可以接管业务,保障云服务持续运行。 父主题: 安全
用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验,避免出现因请求消息体格式错误导致的执行异常。 API响应内容格式需要与响应设置媒体类型和编码格式一致。在API响应中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验,避免出现因请求消息体格式错误导致的执行异常。
可用性:对API调用成功率、响应时长、并发及流量控制、吞吐量等提出规范要求或建议,保障API的高可用性。 易用性:对API参考文档描述、入参和出参、消息头定义等提出规范要求或建议,提升API调用者使用体验。 可维护性:对于API兼容性、日志实时性和完整性、版本管理等提出规范要求或建议,提升API可维护性。
表1 配置AppCode 信息项 描述 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。 AppCode 仅手动输入方式需要填写AppCode的值。 使用AppCode进行API请求的简易认证 在创建API时,
API网关代理中,已发布的所有API被调用失败的总次数。数据10分钟刷新一次。 在“API监控”区域,展开API右侧的下拉框,选择您想要查看调用情况的API。 选择要查看的时间范围。支持查看近1个小时、近6个小时、近24个小时或近7天的调用情况。 查看API监控指标。包括“请求次数”、“调用延时”、“数据流量”和“出错统计”。
的Authorization头中签名是否一致,来校验API网关代理的合法性。 配置参数说明 表1 配置参数说明 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“HMAC”、“Basic Auth”、“Public Key”和“Aes”。
当“导入方式”为“URL”时,需要填写API资产的URL地址。 根据表2参数信息配置资产基本信息。 表2 资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。 说明: 同一个华为云账号下的API资产名称不能重复。 图标 为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介
每个API建议带上版本号,保证API的版本显性化,容易被API调用者所识别。版本号建议放置在URI中,用于显性标识所请求的API版本。 服务所提供的API版本定义统一规范成“vX”,这里X是一个正整数如:v1,v2等,要在API版本文档中明确在接口中说明清楚哪个版本号是目前服务主推的版本,哪些版本是
快速创建一个kubernetes集群 3分钟创建一个游戏类容器应用 快速购买 什么是ECS 创建容器应用基本流程 快速创建一个kubernetes集群 自定义购买 什么是ECS 创建容器应用基本流程 快速创建一个kubernetes集群 04 使用 弹性云服务器(Elastic Cloud Se
预检请求API的参数设置,请参考以下说明填写。详细的使用指导可参考非简单请求。 在“前端定义”中,参数填写说明如下: 请求方法:选择“OPTIONS”。 请求协议:选择与已开启CORS的API相同的请求协议。 路径:填斜杠/。 图2 预检请求-定义API请求。 在“安全配置”中,安全认证选“无认证”,勾选“开启支持跨域CORS”。
当“导入方式”为“URL”时,需要填写API资产的URL地址。 根据表2参数信息,配置资产基本信息。 表2 资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。 说明: 同一个华为云账号下的API资产名称不能重复。 图标 为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介
当“导入方式”为“URL”时,需要填写API资产的URL地址。 根据表2参数信息,配置资产基本信息。 表2 资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。 说明: 同一个华为云账号下的API资产名称不能重复。 图标 为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介