检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。 管理控制台
下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。
创建凭据并绑定API 使用APP认证的API,需要在API网关代理中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API,无需创建凭据。 创建凭据 进入API中心服务页面。
选择API需要发布到的环境,并填写发布说明。 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。 如果在选择环境时,没有自己需要的环境,单击“创建环境”链接,创建一个自己需要的环境。 单击“确定”,完成API发布。 已发布的API因为其他原因需要暂停对外提供服务
授权”。 单击“添加授权”。 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。 如果已授权的凭据需要解除授权,在“授权历史”弹窗中,选择需解除授权的凭据,单击“操作”列“解除授权”。 父主题: API列表
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
选择左侧导航栏中的“API订阅管理” ,进入“API订阅管理”页面。 “API订阅管理”页面展示您在API中心门户网站订阅的所有API。您可以在右上角输入API资产名称或服务商名称,筛选想要查看的API。 取消订阅API 进入API中心服务页面。 选择左侧导航栏中的“API订阅管理” ,进入“API订阅管理”页面。
Arts界面单击项目名称,进入目标项目详情页面。 在左侧选择“API发布”,然后单击“申请发布”,跳转至API中心“创建API资产”页面。(如果您不是API中心服务商,需要先参考服务商入驻章节,入驻成为API中心服务商,然后才能创建API资产。) 图1 申请发布 填写API资产信息。详细指导参考填写API资产信息。
所有API。您在创建API前,需要先创建API分组。 目前支持两种创建分组方式: 创建API分组 创建一个简单的分组,不包含API,用户可自行创建API。 导入Swagger文件 从本地导入已有的API文件,同步创建分组。 对外开放API时,您需要为API分组绑定自己的独立域名。
API策略”。 在“策略管理”页面,单击“创建策略”。 单击需要创建的策略类型。 传统策略 不同的策略类型,策略内容的配置不同: 流量控制策略说明 访问控制策略说明 签名密钥策略说明 单击“确定”。 策略创建后,您还需要为API绑定策略,才能使策略对API生效。 为API绑定策略
环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量。例如创建API时定义了变量名为“Path”,在环境1中创建了变量名“Path”,变量值“/Stage/test”,则AP
仅支持华为云账号修改服务商信息,不允许该账号下的IAM用户修改服务商信息。 商用 变更服务商信息 3 API中心支持网关白名单 如果需要使用API网关代理功能,需要在申请入驻中心服务商时告知运营人员。 商用 服务商入驻 2023年5月 序号 功能名称 功能描述 阶段 相关文档 1 支持取消服务商入驻
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则,可保障API的可维护性。 在采集API调用日志过程中,需要保证API日志的实时性和完整性,以提升API分析的精准度。 API日志在传递过程中,必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
API下线前必须提前通知订阅服务的用户 本条规则是MUST类型的基本规则,可保障API租户的业务连续性。 对于需要下线的API,需要梳理订阅该API的用户,并通过公告等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动,并在公告服务下线时间后1个月内对API调用进行监控,当没有API
可用性 API需要配置并发请求及流量控制 本条规则是Should类型的扩展规则,可提升API的可用性。 在API发布之前,需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分:并发请求控制,吞吐量控制和传输流量控制。 并发请求控制:指API最大允许的客户端连接数量。
该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。 单击“确定”,将独立域名与API分组绑定。 如果不再需要此域名时,在域名所在行,单击“解绑域名”。 (可选)如果API分组中的API支持HTTPS请求协议,则需要为独立域名绑定SSL证书。否则跳过此步骤。 在域名所在行单击“添加SSL证书”。 根据下表参数信息,配置SSL证书。
步骤6:发布API 在左侧导航栏选择“API网关代理 > API列表”。 在需要发布的API所在行,单击“操作”列的“发布”。 选择已创建的API发布环境,并填写发布说明。 图5 发布API 单击“确定”,完成发布。 后续操作 如果您需要调用注册到API网关代理的API,请参考《用户指南》调用API章节。
Collection开发的API,上架至API中心门户网站。 Markdown压缩包:支持导入Markdown编辑的API文件,且该文件需要压缩为zip包导入。 URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API
Collection开发的API,上架至API中心门户网站。 Markdown压缩包:支持导入Markdown编辑的API文件,且该文件需要压缩为zip包导入。 URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API
选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有已发布的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围 基础定义:只导出API前端定义。其中API前端定义除了Swagger规范定义项