检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
哪些API支持在线调测? API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
等待系统解析API文件。API资产所在行“状态”列如果显示“已上架”,说明解析完成。此时,API资产已成功上架至API中心门户网站。 父主题: 开放API
API对应的后端服务已部署上线,并且推荐提供服务域名或IP地址,有助于伙伴/开发者便捷地在线调试API。 已注册华为账号并开通华为云,并已完成企业实名认证。 操作流程 对外开放API的操作流程如图1所示。 图1 对外开放API流程 入驻API中心服务商 进入API中心服务页面。
IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。 动作 包括“允许”和“禁止”。 和“类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址 输入需要允许或者禁止访问API的IP地址,或IP地址范围。
后端服务地址:后端服务的地址。 路径:后端服务的路径。 后端超时 后端服务请求的超时时间。此处默认“5000”ms。 在“返回结果基础定义”页面,定义返回结果。 表5 定义返回结果 信息项 描述 成功响应示例 成功调用API时,返回的响应信息示例。
等待系统解析API文件。API资产所在行“状态”列如果显示“已上架”,说明解析完成。此时,API资产已成功分享至API中心门户网站。 如果您在华为云云商店上架了API资产,则API资产会周期性地自动上架至API中心门户网站,并展示在API资产列表页。
在线调测时,用户登录华为云账号后,API中心会为您自动获取Token或者自动生成临时AK/SK,帮助您直接进行在线调测;调用API时,可根据参数填写项的提示链接和指导文档,获取用户Token和AK/SK。
访问控制:API网关代理支持通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。 父主题: 安全
支持区域: 华北-北京四 流量控制策略说明 访问控制策略 访问控制通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API,保护后端服务。
分发算法包含如下几种: 加权轮询 加权最小连接 源地址哈希 URI哈希 配置通道内服务器。 创建服务器分组,填写分组名称、权重和描述。 添加后端服务器地址,填写后端服务地址,设置是否启用备用节点。 配置健康检查。
{Address}:请求地址,需替换为获取API的请求信息中获取的域名地址。 API网关代理使用分组分配的子域名或分组绑定的域名调用API,无需另外配置。 {Path}:请求路径,需替换为获取API的请求信息中获取的URL。
JSON JSON(JavaScript Object Notation) 是一个轻量级的数据交换格式,它易于人类读写及其解析生成。 HTTP HTTP(Hyper Text Transfer Protocol)是超文本传输协议。
常见问题 绑定域名失败常见原因:未将独立域名CNAME解析到分组的子域名上或域名重复。 添加SSL证书失败常见原因:生成证书的域名和实际添加证书所用的域名不一致。
哪些API支持在线调测? 如何获取API调用凭据? API售卖与技术支持 如何对API进行商业售卖? 谁为API使用者提供技术支持?
在对API日志处理过程中,仅能对API日志进行增维操作,禁止对API日志中重要部分,如请求时间、请求者身份、请求IP地址、请求域名、请求URL地址、响应时间、响应状态码进行篡改。 父主题: API开放
(可选)在线调测API。 对于不需要付费购买的API(技术开放型API),可以通过以下步骤在线调测API,快速试用API。 单击API资产,查看API资产的开发文档。 在需要调试的接口详情页面,单击“在线调试”。 部分API未提供调试功能,具体以详情页面展示的信息为准。
检查IP地址是否被黑白名单限制。 503 APIC.0404 Access to the backend IP address has been denied. 使用可用的IP地址访问后端服务。
在线调测API 对于不需要付费购买的API(技术开放型API),可以通过以下步骤在线调测API,快速试用API。 单击API资产,查看API资产的开发文档。 在需要调试的接口详情页面,单击“在线调试”。 部分API未提供调试功能,具体以详情页面展示的信息为准。
华北-北京四 在线调测 应用开发者可在API门户的API详情页进行API在线调测,快速试用API。 说明: API是否支持调测,取决于伙伴服务商上架API资产时是否提供了相关试用调测环境。部分API暂未提供调测能力。具体功能以API详情页面展示的为准。
访问控制 访问控制策略是API网关代理提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止或允许某个IP地址或账户访问API。 凭据 凭据定义了一个API调用者的身份。