检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何获取API调用凭据? 如果是来源于华为云服务的API,您可通过token认证或AK/SK认证进行API的在线调测和调用。在线调测时,用户登录华为云账号后,API中心会为您自动获取Token或者自动生成临时AK/SK,帮助您直接进行在线调测;调用API时,可根据参数填写项的提示
在调用API前,您需要向API提供方获取API的调用信息。 获取API的请求信息 向API提供方获取API的“域名”、“请求方法”、“API URL”、“请求参数”和“Headers”。 获取API的调用凭据 根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体参考表1。
绑定华为IAM认证的API时,租户ID填写API调用者的账号ID。 绑定APP认证的API时,租户ID填写APP所属者的项目ID。 您可以单击控制台右上角的用户名,选择“我的凭证”,在我的凭证页面获取用户的项目ID和账号ID。 阈值 “时长”时间内,此租户访问单个API次数的最大值。
创建凭据并绑定API 使用APP认证的API,需要在API网关代理中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API,无需创建凭据。 创建凭据 进入API中心服务页面。
HTTP的头信息不超出以下范围: Accept Accept-Language Content-Language Last-Event-ID Content-Type:取值范围:application/x-www-form-urlencoded、multipart/form-data、text/plain
API响应报文使用分页,避免超长列表数据返回 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页,避免一次查询获取的资源数量过多。 不支持分页查询,则服务应该要设置一个显示条数的默认值,避免一次返回过多资源
单击“确定”,完成订阅。 订阅成功后,鼠标放在“联系咨询”上面,就会显示服务商的电话和邮箱。您可以通过已获取的联系方式联系服务商,获取API的调用方式。 单击“已订阅”,可以取消订阅API。 获取API的调用凭据。 需要付费购买的API(来源于华为云市场的API),可按照页面引导和提示,完
并且触达更广泛的业务范围。 准备工作 准备好API接口文档,推荐OpenAPI 2.0/3.0格式。 准备好API使用指南,说明API凭据获取方式、以及提供API使用时的补充说明信息。 API对应的后端服务已部署上线,并且推荐提供服务域名或IP地址,有助于伙伴/开发者便捷地在线调试API。
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
具体功能以API详情页面展示的为准。 华北-北京四 API凭证获取 对于技术开放型API,应用开发者可根据API使用指南中的指定方式或者联系API服务商获取API调用凭证。 对于商业售卖型API,应用开发者可根据页面引导前往云商店通过购买获得API调用凭证。 华北-北京四
不需要付费购买的API(技术开放型API),可根据API使用指南(如果有)或者联系API服务商获取API调用凭据。 华为云服务的OpenAPI,您可通过token认证或AK/SK认证进行API的在线调测和调用。在线调测时,用户登录华为云账号后,API中心会为您自动获取Token或者自动生成临时AK
sourceIp:API调用者的源地址。 stage:API调用的部署环境。 apiId:API的ID。 appId:API调用者的APP ID。 requestId:当次调用API所生成的请求ID。 serverAddr:网关服务器的地址 。 serverName:网关服务器的名称。
试用API。 支持区域: 华北-北京四 在线调测API 获取服务商联系方式 对于不需要付费购买的API,支持您在API中心门户网站的API详情页面通过订阅API,获取API服务商的联系方式。 支持区域: 华北-北京四 获取服务商联系方式 购买API 对于“API来源”为华为云市场的API,支持您在线购买。
息头。 X-Apig-Mode: debug表示响应消息头增加API网关代理调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode:
录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。 前提条件 已获取待导入API的Swagger文件。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上
服务商入驻成功后可以取消入驻吗? 服务商入驻成功后信息还可以修改吗? API网关代理 是否必须使用API中心的网关代理功能? 哪些API支持在线调测? 如何获取API调用凭据? API售卖与技术支持 如何对API进行商业售卖? 谁为API使用者提供技术支持?
API订阅管理 您可以在API中心门户网站中,通过订阅API,获取API资产服务商的联系方式。如果您想要查看您在API中心门户网站中已经订阅的所有API,或对已经订阅的API单个或批量取消订阅,可以参考本章指导操作。 查看已经订阅的所有API:参考查看订阅的所有API。 对已经订
API中心覆盖了API生产、API开放、API消费全场景,一站式体验。 本文档为您提供生产API、开放API、消费API的操作指导。您可以根据自身需求,选择一个或多个场景进行操作。 生产API:通过API工具库中提供的工具,完成API的设计、测试。 开放API: 上架API至AP
进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。 单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息,配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式 支持以下6种方式,上架API文件至API中心门户网站:
上,具体方法请参见增加CNAME类型记录集。 如果API分组中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书,请您提前获取SSL证书的内容和密钥,并创建SSL证书。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击分组名称。