检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
身份认证与访问控制 身份认证 服务认证:API网关代理提供AK/SK、Token等多种方式进行服务认证,只允许授权的访问。 签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对
API中心管理控制台的以下功能只允许API中心服务商使用,如果您想要使用以下功能,需要先申请入驻成为API中心服务商: API资产管理:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。
您可以登录API中心管理控制台,查看审核进展。 父主题: 服务商入驻
API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
IAM认证(AK/SK认证) 获取云服务平台的用户账号的AK/SK,以及认证签名所使用的SDK。 无认证 无需认证信息。 调用API 构造API请求,示例如下: POST https://{Address}/{Path}?
创建负载通道 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“负载通道”页签,进入到负载通道列表页面。 单击“创建负载通道”,配置基本信息。 表1 基本信息配置 信息项 描述 通道名称 自定义负载通道名称,用于识别不同的负载通道。
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 在API所在行,单击“操作”列的“更多 > 授权”。 单击“添加授权”。 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。
将分组内已发布的API上架至门户网站 任选以下三种方式之一操作,即可上架分组内已发布的API至API中心门户网站。 方式一:在分组所在行“操作”列,单击“更多>上架”,跳转至“创建API资产”页面。
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导出API”,设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。
图1 环境变量示意图 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击分组名称。 单击“分组信息”页签。 单击“环境变量”页签后面的,展开环境变量区域。 选择环境。如果未创建环境,可单击“创建环境”创建。
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击分组名称。 单击“分组信息”页签。 在“域名管理”区域,单击“绑定独立域名”,并在弹窗中配置域名信息。 表1 独立域名配置 信息项 描述 域名 填写要绑定的域名。
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。 单击“重置Secret”。 在弹窗中单击“确定”。 父主题: API凭据管理
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导入API”,具体操作请参考导入Swagger文件。 后续操作 将导入成功的API发布到环境中,以便API调用者调用。 父主题: API列表
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 在待下线的API所在行,单击“更多>下线”。 批量下线API:在API列表页,批量勾选API,单击正上方的“下线”。最多同时批量下线1000个API。 选择API需要下线的环境。
前端配置 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“创建API”。 配置参数。 根据下表参数信息,配置前端定义。 表1 前端定义 信息项 描述 API名称 API名称,根据规划自定义。
发布API 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 在待发布的API所在行,单击“操作”列的“发布”。 批量发布API:在API列表页,批量勾选API,单击正上方的“发布”。最多同时批量发布1000个API。
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击待调试的API名称,进入“API运行”页面。 单击“调试”。 配置API请求参数后,单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。
使用流程 图1 签名密钥流程图 在API中心管理控制台创建签名密钥。 将新创建的签名密钥绑定API。 API网关代理将签名后的请求发送到后端服务,此时Authorization头中包含签名信息。
图1 对外开放API流程 入驻API中心服务商 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 单击页面中间的“立即入驻”。 图2 入驻API中心服务商 也可以在API中心门户网站,单击页面右上角的“服务商入驻”,进入服务商入驻页面。 填写服务商信息。
可用性 API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换