检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看APIG的API调用日志 APIG提供了API的可视化分析和统计能力,支持查看API的调用日志。 前提条件 已调用API。 查看API的调用日志 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 日志分析”。 单击“配置访问日
配置API策略 配置API的传统策略 配置API的插件策略
id 是 String API的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 status
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances
进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,下线API。 在待下线的API所在行,单击“更多 > 下线”,弹出“下线API”对话框。 单击“API名称”,进入API详情页面。在右上角单击“下线”,弹出“下线API”对话框。 如果需要
paths参数说明 名称 是否必选 参数类型 说明 uri 是 Object API访问地址,参考表7 表7 uri参数说明 名称 是否必选 参数类型 说明 method 是 Object API访问方法,参考表8 表8 method参数说明 名称 是否必选 参数类型 说明 operationId
/v1/{project_id}/apigw/instances/{instance_id}/resources/outline/apis URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取
使用APP认证调用API 认证前准备 APP认证工作原理 Java Go Python C# JavaScript PHP C++ C Android curl
授权API 操作场景 API在创建后,通过指定授权给某些应用,让指定应用能够调用API。 仅在API发布到环境后,才支持被授权。 仅在API为APP认证时,才支持授权给应用。 前提条件 已创建API分组和分组内的API。 (可选)已创建环境。 已创建应用。 操作步骤 进入共享版控制台。
0/apigw/resources/outline/apis 请求消息 无 响应消息 表2 参数说明 名称 类型 说明 instance_num Integer API总个数 nums_off_release Integer 未发布到release环境的API个数 nums_on_release
API认证凭据问题汇总 Q:最多支持创建多少个应用(凭据)? 每个用户最多创建50个应用(凭据)。包括您自行创建的凭据和在云商店购买API生成的APP。 Q:APP认证的API,怎样实现不同的第三方之间无法知道对方调用情况? 创建多个应用(凭据),并绑定同一个API,分发给不同的第三方不一样的应用(凭据)。
发布或下线API 功能介绍 对API进行发布或下线。 发布操作是将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 下线操作是将API从某个已发布的环境上下线,下线后,API将无法再被调用。 调用方法 请参见如何调用API。
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw
success参数说明(批量下线) 名称 类型 说明 api_id String 下线成功的API ID api_name String 下线成功的API名称 表7 failure参数说明 名称 类型 说明 api_id String 发布或下线失败的API ID api_name String
错误码 当调用API时,可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。
配置API的自定义认证 配置API的前端自定义认证 配置API的后端自定义认证 父主题: 管理API
已购买API”,进入到已购买API分组信息页面。 图1 已购买API分组示例 单击待查看的API分组名称,进入此分组详情页面。 查看此分组下已购买的API列表和此分组的详细信息。 图2 已购买API的分组详情示例 在待调试API所在行,单击“调试API”,跳转到“调试API”页面。 左侧为API请求参
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改,其他属性不可修改。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}
导入导出API 导入导出API的限制与兼容性说明 通过API设计文件导入API 通过CSE微服务导入API 通过CCE工作负载导入API 导出APIG的API 父主题: 管理API
使用AppCode进行API请求的简易认证 在创建API时,选择“APP认证”并且开启“支持简易认证”。 如果您修改已有API为简易认证,需要在修改完成后,将API重新发布,使简易认证模式生效。 将支持简易认证的API绑定到已创建的凭据。 发送请求时,增加请求头部参数“X-Apig-AppCode”,省略请求签名相关信息。