检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
您需要先申请入驻成为API中心服务商,才可以使用API网关代理功能,具体操作指导参见服务商入驻。 父主题: API网关代理
是 PATCH 用于部分更新资源的场景,如果使用PUT操作所需输入的整体资源信息内容大小与PATCH操作无太大差异,优先使用PUT操作,不推荐使用PATCH操作。 是 OPTIONS 获取当前资源支持哪些方法的信息。 是 例如:使用正确的HTTP动词。
REST REST(Representational State Transfer,表征状态转移)网络上的所有事物都可被抽象为资源,每一个资源都有唯一的资源标识(resource identifier),对资源的操作不会改变这些标识,所有的操作都是无状态的,使用标准方法操作资源。
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 在API所在行,单击“操作”列的“更多 > 授权”。 单击“添加授权”。 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导入API”,具体操作请参考导入Swagger文件。 后续操作 将导入成功的API发布到环境中,以便API调用者调用。 父主题: API列表
操作步骤 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 单击页面中间的“立即入驻”。 图1 入驻API中心服务商 也可以在API中心门户网站,单击页面右上角的“服务商入驻”,进入服务商入驻页面。 填写服务商信息。
良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表,列表包括虚拟机名称,所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。
操作指导 相关操作指导,请参考华为云帮助中心API Hub。 父主题: 附录-API治理规范指导
后续操作 创建完API后,您还可以执行如表11的操作。 表11 后续操作 操作 说明 修改API参数信息 在API列表页,单击API所在行“操作”列的“编辑”,修改API参数信息。 创建策略并绑定API 通过对API添加策略,限制对API的访问,从而保护后端服务。
后续操作 API调试成功后,您可以将API发布到环境,以便API调用者调用。或者出于API的安全性考虑,为API添加策略。 父主题: API列表
查看已发布API被调用情况 如果您想要查看已发布的API被调用的情况,如API被请求调用的次数,调用失败的次数等,可以参考API数据分析章节指导操作。 父主题: API列表
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。 单击“重置Secret”。 在弹窗中单击“确定”。 父主题: API凭据管理
如果您想要查看当前订阅的所有API,或者对已经订阅的API单个或批量取消订阅,可以参考API订阅管理章节操作。 购买API API中心支持您在线购买来自华为云市场的API,购买流程如下。 访问API中心门户网站。 选择来自华为云市场的API。
操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”,进入API Arts工具界面。
后续操作 创建完环境和环境变量后,您可以将API发布到环境,以便API调用者调用。 父主题: API策略
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导出API”,设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。
错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
图1 环境变量示意图 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击分组名称。 单击“分组信息”页签。 单击“环境变量”页签后面的,展开环境变量区域。 选择环境。如果未创建环境,可单击“创建环境”创建。
后续操作 创建API,将部署在负载中的后端服务开放API,从而实现后端服务的负载均衡。 父主题: API策略
常用操作 什么是ECS 创建容器应用基本流程 快速创建一个kubernetes集群 3分钟创建一个游戏类容器应用 3分钟创建一个游戏类容器应用 3分钟创建一个游戏类容器应用 网络安全 什么是ECS 创建容器应用基本流程 快速创建一个kubernetes集群 3分钟创建一个游戏类容器应用