检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题: API网关代理
安全 责任共担 身份认证与访问控制 服务韧性 认证证书
图解API中心 优化如下章节: 产品优势 2023-03-31 第五次正式发布。 优化如下章节: 什么是API中心 应用场景 产品功能 与其他服务的关系 2023-03-22 第四次正式发布。 优化如下章节: 产品功能 2023-03-03 第三次正式发布。 优化如下章节: 产品功能
图解API中心
API数据分析页面通过图表的形式,直观地展示您在API网关代理中已经发布的所有API被调用的情况。 前提条件 已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 查看步骤 进入API中心服务页面。 在左侧导航栏选择“API数据分析”。 资源概览区域参数的含义如表1所示。 表1 资源概览参数说明 参数名称
数*100%就是调用成功率,该数值应大于等于99.99%。 服务API实际可用性与承诺的服务可用性需要100%吻合。当发现无法达到承诺的服务可用性时,API提供方从架构上考虑,通过增加可用区,增加多活部署等手段提升服务API的整体可用性。 API的TP99响应时长<3s 本条规则
可用性 API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。
境1中调用此API时,后端服务请求Path为“/Stage/test”。在环境2中创建了变量名“Path”,变量值“/Stage/AA”,则API在发布到环境2时,使用“/Stage/AA”代替“Path”,API调用者在环境2中调用此API时,后端服务请求Path为“/Stage/AA”。
已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理
负载通道 负载通道主要用于将服务通过API网关代理开放给外部访问,它的优势在于使用VPC的内部子网通信,网络时延更低,同时负载通道具有负载均衡功能,从而实现后端服务的负载均衡。 创建负载通道后,在创建API,且后端服务类型为HTTP/HTTPS时,后端服务地址可以直接使用已创建的负载通道。
重置完成后,原先的Secret将失效,绑定此凭据的API将无法调用,请更新SDK中的密钥对,并重新调用API。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。 单击“重置Secret”。
导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。 前提条件 已获取待导入API的Swagger文件。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导入API”,具体操作请参考导入Swagger文件。 后续操作
产品优势 API生产便捷高效 通过对接集成,API中心为开发者引入API生产工具:API Arts。 API设计、测试一站式高效协同,API数据自动同步。 API设计与文档实时同步,设计即文档。 API测试与设计同源,设计示例一键导入测试步骤。 API开放简单体验 一键上架:AP
API资产,将您开发好的API分享在API中心门户网站,供其他开发者调用。 注册API到网关代理:将您的API注册到API网关代理,使您的服务能力变现,同时降低企业研发投入,让您专注于企业核心业务,提升运营效率。 消费API:在API中心门户网站中搜索您需要的API,用于系统集成和项目开发使用。
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
API后,才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API,无需创建凭据。 创建凭据 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 单击“创建凭据”,填写凭据信息。 表1 凭据信息 信息项 描述 凭据名称
独立域名:您自定义的域名,API调用者通过访问独立域名来调用您开放的API。 独立域名不能重复。 前提条件 已有独立域名。可通过域名注册服务申请新的域名。 已备案独立域名,未备案的独立域名无法被访问。备案时长需几个工作日,建议您提前进行备案。 已将独立域名CNAME解析到分组的
约束与限制 API中心的使用限制如下: 创建API资产:每个用户最多可以创建50个API资产。 API网关代理:API网关代理使用限制如表1所示。 表1 API网关代理使用限制 限制项 限制值 API分组数量 每个用户最多可以创建50个API分组。 独立域名数量 每个分组最多可以绑定5个独立域名。
APP认证(app_basic认证) 向API提供方获取该API所授权凭据的Key和Secret。 IAM认证(AK/SK认证) 获取云服务平台的用户账号的AK/SK,以及认证签名所使用的SDK。 无认证 无需认证信息。 调用API 构造API请求,示例如下: POST htt