检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
域名管理 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。
API资产管理 通过创建API资产,将您开发好的API分享至API中心门户网站,其他开发者就可以在API中心门户网站搜索到您分享的API,用于自己的项目开发。 前提条件 已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 1个服务商最多可以创建50个API资产。 1
环境管理 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。 创建环境 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。 表1 环境信息 信息项
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题: API网关代理
选择左侧导航栏中的“API订阅管理” ,进入“API订阅管理”页面。 “API订阅管理”页面展示您在API中心门户网站订阅的所有API。您可以在右上角输入API资产名称或服务商名称,筛选想要查看的API。 取消订阅API 进入API中心服务页面。 选择左侧导航栏中的“API订阅管理” ,进入“API订阅管理”页面。
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则,可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划,从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口,需要正
如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。 创建凭据成功后,在凭据管理页面显示新建凭据和凭据ID。 单击凭据名称,进入详情页面,查看Key和Secret。 绑定API 在“凭据管理”页面,单击凭据名称,进入详情页面。
能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关代理,可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。API网关代理帮助您变现服务能力的同时,降低企业研发投入,让
API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。 在“AppCodes”区域,单击“添加AppCode”。 在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 信息项 描述 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。
服务商入驻 API中心管理控制台的以下功能只允许API中心服务商使用,如果您想要使用以下功能,需要先申请入驻成为API中心服务商: API资产管理:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代理:API网关代理包括API的
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。 单击“重置Secret”。 在弹窗中单击“确定”。 父主题: API凭据管理
错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
如果您需要在API中心门户网站搜索需要的API,用于系统集成和项目开发,请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索:输入您需要的API的一些关键信息,如API名称、描述等,系统会展示相关的搜索结果。 按不同维度搜索:
此功能。 等待审核。5个工作日内完成审核。您可以登录API中心管理控制台,查看审核进展。 审核通过后,您登录API中心管理控制台,就可以看到API资产管理等菜单了。 创建API资产 选择左侧导航栏中的“API资产管理 > API资产”。 单击页面右上角的“创建API资产”。 填写API资产信息。
服务商入驻审核多久通过? 提交服务商入驻申请后,运营人员将在5个工作日内完成审核。您可以登录API中心管理控制台,查看审核进展。 父主题: 服务商入驻
创建API分组 API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。您在创建API前,需要先创建API分组。 目前支持两种创建分组方式: 创建API分组 创建一个简单的分组,不包含API,用户可自行创建API。 导入Swagger文件 从本地导入已有的API文件,同步创建分组。
为什么要申请入驻服务商? API中心管理控制台的以下功能只允许API中心服务商使用,如果您想要使用以下功能,需要先申请入驻成为API中心服务商: API资产管理:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代理:API网关代
1和TLS1.2,推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。 如果API网关代理当前的配额限制无法满足您的需求,您可以向系统提交工单申请更多配额。
按服务商维度展示:展示所有API资产的服务商。可以在左侧勾选分类,按行业筛选API资产服务商。单击服务商,可以看到该服务商拥有的所有API资产。 查看系统精选API 勾选“仅看精选”,界面会展示系统为您精选的API资产。 查看API 搜索到符合您要求的API后,单击API资产,查看API资产的开发文档,可以查看API的详细信息。
API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。 转义说明可参考:RFC