检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。 如果策略与API有绑定关系,则策略无法执行删除操作。
API分组 创建API分组 域名管理 环境变量 父主题: API网关代理
转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。 转义说明可参考:RFC 2396(Uniform
下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。
0.5%。 在对API日志处理过程中,仅能对API日志进行增维操作,禁止对API日志中重要部分,如请求时间、请求者身份、请求IP地址、请求域名、请求URL地址、响应时间、响应状态码进行篡改。 父主题: API开放
为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介 简单介绍下API资产的行业,用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP,用于API在线调试。 分类 选择API资产所属行业,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开
为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介 简单介绍下API资产的行业,用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP,用于API在线调试。 分类 选择API资产所属行业,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介 简单介绍下API资产的行业,用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP,用于API在线调试。 分类 选择API资产所属行业,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开
安全 责任共担 身份认证与访问控制 服务韧性 认证证书
API列表 创建API 导入API 导出API 发布API 授权API 调试API 下线API 开启跨域访问 父主题: API网关代理
API策略 创建策略 流量控制策略说明 访问控制策略说明 签名密钥策略说明 负载通道 环境管理 父主题: API网关代理
华北-北京四 API网关代理 API中心服务商可使用API中心的网关代理模块,进行API注册、发布,并支持配置流控策略、访问控制、签名密钥等策略来限制对API的访问。 华北-北京四 API门户 API中心门户汇聚展示千行百业API,为应用开发者提供统一的API搜索查找入口,并通过智
只添加可选字段,不能添加必选字段。 不能更改字段的含义。 当资源URL发生变化的时候,支持重定向。 服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。
理的一些Swagger扩展字段。 全量定义:导出API前端定义和后端定义。 扩展定义:导出API前端定义、后端定义、API关联的流量控制、访问控制等策略及绑定关系。 导出格式 选择JSON或YAML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。
值范围。 API响应状态码,状态码及对应的说明。 API响应参数说明包括Header参数,需要明确字段内容和取值范围。 API正常响应Body内容,正常响应Body内容需要明确响应结构体内容及各个字段的取值范围。 API异常响应Body内容,异常响应Body中描述及说明。 API请求尽量少使用自定义消息头
人与人之间的私人消息,如短信、电话通信内容。 API涉及个人数据时,需要提供隐私声明 本条规则是MUST类型的基本规则,可保障API的安全合规。 如果API提供正常业务时涉及个人数据(包含收集、使用、转移、存储等),必须在API发布过程中提供产品隐私声明,描述收集的所有个人数据类型、目的、处理方式、时限等。
认证”时适用。 不能大于“API流量限制”的值。 与“时长”配合使用,表示“时长”时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。 说明: 如果希望单独为某个用户添加流量控制策略,可以通过对该策略增加特殊租户实现,具体参考添加特
生态圈。 适用范围 在华为云API中心发布、用于面向公众开放信息和服务的API。此类API可以充分发挥开发者的创造性,增加企业业务覆盖面和访问流量,是企业新的商业模式和收入来源。 读者对象 API构建者包括:架构师、开发、测试、运维、产品经理、CTO等。 父主题: 概述
单击“确定”,完成API发布。 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户后,选择待下线的API,单击“下线”即可。 查看发布历史 进入API中心服务页面。 在左侧导航栏选择“API网关代理