检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API开放 安全性 可用性 可维护性 生命周期管理 父主题: 规范要求
API分组 创建API分组 域名管理 环境变量 父主题: API网关代理
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题: API网关代理
服务商 服务商入驻 变更服务商信息 取消入驻服务商
安全 责任共担 身份认证与访问控制 服务韧性 认证证书
修订记录 发布日期 修订记录 2023-09-27 第八次正式发布。 新增如下章节: 附录-API治理规范指导 2023-07-14 第七次正式发布。 优化如下章节: 约束与限制 2023-05-22 第六次正式发布。 新增如下章节: 图解API中心 优化如下章节: 产品优势 2023
图解API中心
简易认证指APP认证方式下调用API时,在HTTPS请求头部消息增加一个参数X-Apig-AppCode,而不需要对请求内容签名,API网关代理也仅校验AppCode,不校验请求签名,从而实现快速响应。 注意仅支持HTTPS方式调用,不支持HTTP方式。
在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验,避免出现因请求消息体格式错误导致的执行异常。 API响应内容格式需要与响应设置媒体类型和编码格式一致。
只允许华为云企业账号申请成为API中心服务商。 前提条件 已完成华为云账号企业用户实名认证。 仅允许华为云账号入驻API中心服务商,不允许该账号下的IAM用户入驻API中心服务商。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。
通知需要在服务下线前至少6个月启动,并在公告服务下线时间后1个月内对API调用进行监控,当没有API调用流量之后,才启动正式下线。待该API到了正式下线后,API中心不再展示下线的API。 父主题: API开放
为简易认证绑定AppCode 简易认证指调用API时,在HTTPS请求头部消息增加一个参数“X-Apig-AppCode”(参数值填凭据详情中“AppCode”的值),而不需要对请求内容签名,API网关代理也仅校验AppCode,不校验请求签名,从而实现快速响应。
RESTful风格的服务接口需定义:操作名、URL、请求和响应消息体和响应状态码。 本文后续章节将分别描述接口各部分的定义规范。 父主题: 概述
勾选“我已阅读并同意《华为云API中心服务商合作协议》和《华为云隐私政策声明》”,单击“立即提交”。 根据您是否需要使用API网关代理功能,选择对应的操作。 是:联系API中心运营人员,并告知其您需要使用API网关代理功能。 否:直接执行7。
只允许华为云企业账号申请成为API中心服务商。 父主题: 服务商入驻
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 在API所在行,单击“操作”列的“更多 > 授权”。 单击“添加授权”。 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。
导入Swagger文件 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击右上角的“创建API分组”,选择下拉框中的“导入Swagger文件”。 在弹窗中选择本地路径下的API文件,然后单击“打开”导入文件。 填写导入信息。
在线调测时,用户登录华为云账号后,API中心会为您自动获取Token或者自动生成临时AK/SK,帮助您直接进行在线调测;调用API时,可根据参数填写项的提示链接和指导文档,获取用户Token和AK/SK。
创建环境 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。 表1 环境信息 信息项 描述 环境名称 API环境名称。 描述 环境描述信息。 单击“确定”,创建环境。
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导出API”,设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。