检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
SDK API网关开放的API,安全认证方式可选IAM认证、APP认证、自定义认证或无认证。四者的区别以及如何选择,请参考调用API。 本章节主要提供APP认证的SDK下载以及文档。IAM认证请参考“使用IAM认证调用API”章节。
app_id 是 String 应用编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
apig:存量apig应用,不推荐使用 roma:roma集成应用 默认apig,暂不支持其他类型 roma_app_type String ROMA_APP的类型: subscription:订阅应用 integration:集成应用 暂不支持 状态码: 400 表5 响应Body
app_id 是 String 应用编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
父主题: 使用APP认证调用API
表2 参数说明 名称 是否必选 类型 说明 id 是 String App Code的编号 app_id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 编号 app_code String App Code值 app_id
请求消息样例: { "name": "app_001", "remark": "第一个APP", "app_key": "app_key_sample", "app_secret": "app_secret_sample" } 响应消息 表4 参数说明
删除APP 功能介绍 删除指定的APP。 APP删除后,将无法再调用任何API;其中,云商店自动创建的APP无法被删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。
表2 参数说明 名称 是否必选 类型 说明 id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 编号 name String 名称 status Integer 状态 app_key String APP的key app_secret
app_id 是 String 应用编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
APP授权 功能介绍 APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。 调用方法 请参见如何调用API。
使用身份认证 创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。 设置访问控制策略 从IP地址(或地址区间)以及账号等不同维度,设置白名单/黑名单。 将API绑定流控策略,通过流控策略保护API。
总数 size Integer 本次查询返回的列表长度 apps 字典数据类型 APP列表 表4 apps参数说明 参数 类型 说明 id String 编号 name String 名称 status Integer 状态 app_key String APP的key app_secret
删除App Code 功能介绍 删除App Code,App Code删除后,将无法再通过简易认证访问对应的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。
APP管理 对象模型 创建APP 修改APP 重置密钥 删除APP 校验APP 查看APP详情 查询APP列表 创建App Code 自动生成App Code 查看App Code详情 查询App Code列表 删除App Code 父主题: 共享版API(仅存量用户使用)
请求消息样例: { "name": "app_001", "remark": "第一个APP", "app_key": "app_key_sample", "app_secret": "app_secret_sample" } 响应消息 表4 参数说明
校验APP 功能介绍 校验APP是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。 URI HTTP/HTTPS请求方法以及URI如下表所示。
查看APP详情 功能介绍 查看指定APP的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。
校验APP 功能介绍 校验APP是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。 URI HTTP/HTTPS请求方法以及URI如下表所示。
删除APP 功能介绍 删除指定的APP。 APP删除后,将无法再调用任何API;其中,云商店自动创建的APP无法被删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。