检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用APP认证调用API 认证前准备 APP认证工作原理 Java Go Python C# JavaScript PHP C++ C Android curl
创建APP 功能介绍 APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps
APP授权 功能介绍 APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/in
APP管理 对象模型 创建APP 修改APP 重置密钥 删除APP 校验APP 查看APP详情 查询APP列表 创建App Code 自动生成App Code 查看App Code详情 查询App Code列表 删除App Code 父主题: 共享版API(仅存量用户使用)
APP管理(待下线) 对象模型 创建APP 修改APP 重置密钥 删除APP 校验APP 查看APP详情 查询APP列表 父主题: 专享版API(V1)(待下线)
id 是 String App Code的编号 app_id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 编号 app_code String App Code值 app_id String APP的ID create_time
API网关如何开放部署在华为云上的服务? 如果部署在华为云上的服务绑定了公网IP地址,在API网关中创建API时,使用公网IP地址:端口号作为后端服务地址。如果此服务已绑定域名,则优先使用域名作为后端服务地址。创建API的详细步骤请参见创建API。 如果部署在华为云上的服务无公网IP地
状态 1: 有效 app_type String APP的类型: apig:存量apig应用,不推荐使用 roma:roma集成应用 默认apig,暂不支持其他类型 roma_app_type String ROMA_APP的类型: subscription:订阅应用 integration:集成应用
APP授权管理 对象模型 查看APP未绑定的API列表 授权 查看APP已绑定的API列表 查看API已绑定的APP列表 解除授权 父主题: 共享版API(仅存量用户使用)
0/apigw/apps/{app_id}/app-codes URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 app_id 是 String APP的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 app_code 是 String APP的名称 支持英文,+_
查看APP未绑定的API列表 功能介绍 查询指定环境上某个APP未绑定的API列表,包括自有API和从云商店购买的API。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/unbinded-apis
访问控制主要用于禁止或仅允许某些账号/源访问IP的API调用。 此部分操作在API网关服务中完成,您可以参考访问控制章节。 在华为云商店中,入住卖家中心,将您的API开放售卖。 将API上架到华为云商店售卖。 此部分操作在华为云商店完成,您需要作为卖家入驻云商店,然后发布API商品。 专享版实例暂不支持将API上架到云商店公开售卖。
APP授权管理(待下线) 对象模型 查看APP未绑定的API列表 授权 查看APP已绑定的API列表 查看API已绑定的APP列表 解除授权 父主题: 专享版API(V1)(待下线)
专享版-APP授权管理 APP授权 解除授权 查看APP已绑定的API列表 查看APP未绑定的API列表 查看API已绑定的APP列表 父主题: 专享版API(V2)
OpenAPI接口 导出分组下所有API 批量导出API 导入API到新分组 导入API到已有分组 父主题: 共享版API(仅存量用户使用)
名称 类型 说明 -- 字典数据类型 API与APP的授权关系列表 表4 API与APP授权关系列表消息说明 名称 类型 说明 id String 授权关系编号 api_id String API编号 app_id String APP编号 auth_time Timestamp 授权时间
支持的监控指标 功能说明 本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 共享版:SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标
进入共享版控制台。 选择“调用API > 应用管理”,进入到应用管理信息页面。 单击待查看的应用名称,进入应用详情页面。 单击“AppCode”页签,进入AppCode的管理界面。 单击“添加AppCode”,生成AppCode。可自动生成,也可手动输入。 使用AppCode进行API请求的简易认证
对象模型 本节介绍APP与API之间的授权关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 APP授权关系对象模型 参数
对象模型 本节介绍APP与API之间的授权关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 APP授权关系对象模型 参数