检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
表1 配置分组信息 参数 配置说明 分组名称 API分组名称,用于将API接口进行分组管理。 描述 对分组的介绍。 单击“确定”,创建API分组。系统会同时为其分配一个子域名,您可以用于调试API。 创建成功后,可以单击操作列的“编辑”对分组名称及描述进行修改。也可单击操作列的“更多”删除或者导出API分组。
单击页面右上角的“导出API”,设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有已发布的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围
API需要配置并发请求及流量控制 本条规则是Should类型的扩展规则,可提升API的可用性。 在API发布之前,需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分:并发请求控制,吞吐量控制和传输流量控制。 并发请求控制:指API最大允许的客户端连接数量。 吞吐量(TPS)
度限制对API的调用次数,保护后端服务。同时支持通过添加特殊应用或特殊租户对某一凭据或用户设置专有的流量控制策略。 支持区域: 华北-北京四 流量控制策略说明 访问控制策略 访问控制通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。 支持区域:
分组。 扩展覆盖 勾选后,当导入API的扩展定义项名称(流控,访问控制,插件等)与已有的策略(流控,访问控制,插件等)名称相同时,会覆盖已有的策略(流控,访问控制,插件等)。 是否覆盖 勾选后,当导入API的名称与已有API的名称相同时,导入的API会覆盖已有的API。 仅在“导
服务商时告知运营人员。 商用 服务商入驻 2023年5月 序号 功能名称 功能描述 阶段 相关文档 1 支持取消服务商入驻 支持您取消入驻API中心服务商。 公测 取消入驻服务商 2023年3月 序号 功能名称 功能描述 阶段 相关文档 1 优化服务商入驻 已经入驻华为云云商店的
根据获取API的请求信息中获取的请求参数进行设置。 {Header}:请求头参数,格式为“参数名: 参数取值”,例如Content-Type: application/json。需根据获取API的请求信息中获取的Headers进行设置。 {Body}:请求消息体,JSON格式。需
在左侧导航栏选择“API网关代理 > API分组”。 单击分组名称。 单击“分组信息”页签。 单击“环境变量”页签后面的,展开环境变量区域。 选择环境。如果未创建环境,可单击“创建环境”创建。 单击“添加环境变量”,填写变量信息。 在实际发送API请求中,环境变量名称与变量值会明文传递,请勿携带隐私信息。
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 单击“创建凭据”,填写凭据信息。 表1 凭据信息 信息项 描述 凭据名称 凭据的名称。 描述 凭据的介绍。 (可选)单击“自定义配置”后面的,展开自定义配置区域,可以自定义配置AppKey和AppSecret。AppKey是身份标识,需要保证全局唯一。
选择左侧导航栏中的“API订阅管理” ,进入“API订阅管理”页面。 “API订阅管理”页面展示您在API中心门户网站订阅的所有API。您可以在右上角输入API资产名称或服务商名称,筛选想要查看的API。 取消订阅API 进入API中心服务页面。 选择左侧导航栏中的“API订阅管理” ,进入“API订阅管理”页面。
服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则,可提升API的可维护性。
在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。 表1 环境信息 信息项 描述 环境名称 API环境名称。 描述 环境描述信息。 单击“确定”,创建环境。 创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful
访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索:输入您需要的API的一些关键信息,如API名称、描述等,系统会展示相关的搜索结果。 按不同维度搜索: 按API维度展示:展示所有API资产。可以在左侧勾选“分类”、“可见范围”或“AP
来的Authorization头中签名是否一致,来校验API网关代理的合法性。 配置参数说明 表1 配置参数说明 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“HMAC”、“Basic Auth”、“Public Key”和“Aes”。
新调用API。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。 单击“重置Secret”。 在弹窗中单击“确定”。 父主题: API凭据管理
全的加密算法,推荐您使用ECDSA和DSA加密算法。 表2 SSL证书配置 参数 配置说明 证书名称 填写SSL证书的名称,根据规划自定义。建议您按照一定的命名规则填写SSL证书名称,方便您快速识别和查找。 证书内容 填写pem编码格式的SSL证书内容。 以文本方式打开待添加证书里的PEM格式证书文件(后缀名为“
API网关代理 是否必须使用API中心的网关代理功能? 哪些API支持在线调测? 如何获取API调用凭据?
API售卖与技术支持 如何对API进行商业售卖? 谁为API使用者提供技术支持?
前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击待调试的API名称,进入“API运行”页面。 单击“调试”。 配置API请求参数后,单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。
每个凭据最多可创建5个AppCode。 生成APPCode 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。 在“AppCodes”区域,单击“添加AppCode”。 在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode