检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
专享版-APP授权管理 APP授权 解除授权 查看APP已绑定的API列表 查看APP未绑定的API列表 查看API已绑定的APP列表 父主题: 专享版API(V2)
专享版-配置管理 查询某个实例的租户配置列表 查询租户实例配置列表 父主题: 专享版API(V2)
专享版-域名管理 绑定域名 绑定域名证书 修改域名 解绑域名 设置调试域名是否可以访问 删除域名证书 查看域名证书 父主题: 专享版API(V2)
API管理(待下线) 对象模型 创建API 修改API 删除API 发布API 下线API 批量发布或下线API 查看API详情 查询API列表 查询API历史版本列表 根据版本编号下线API 查看版本详情 查询API运行时定义 调试API 父主题: 专享版API(V1)(待下线)
概要查询(待下线) 查询API分组概况 查询API概况 查询APP概况 父主题: 专享版API(V1)(待下线)
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
请求消息 表2 参数说明 参数 是否必选 类型 说明 name 是 String APP的名称 支持汉字,英文,数字,“_”,且只能以英文和汉字开头,3 ~ 64个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String APP描述。 字符长度不能大于255
校验APP 功能介绍 校验APP是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍VPC通道的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 VPC通道对象模型 参数 类型 说明 操作类型 是否必选
查看版本详情 功能介绍 查询某个指定的版本详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/versions/{version_id} URI中的参数说明如下表所示。
大小写 不支持取值为"X-Stage",不区分大小写 mode为MARKET或CONSUMER时,不支持取值为"X-Auth-Token"和"Authorization",不区分大小写 说明: 头域名称在使用前会被规范化,如:"x-MY-hEaDer"会被规范化为"X-My-Header"
自定义认证 创建自定义认证 删除自定义认证 父主题: 共享版操作指导(仅存量用户使用)
删除分组 操作场景 API分组在创建后,如需对创建的数据进行删除,可以删除此分组。 如果API分组下存在API,API分组无法被删除。 前提条件 已创建分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”,进入到API分组信息页面。 通过以下任意一种方式,进入“删除分组”对话框。
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 app_id 是 String 应用编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述
试环境上,而v1.2的版本目前开发团队正处于开发过程中,可以发布到开发环境进行自测等。 为此,API网关提供多环境管理功能,使租户能够最大化的模拟实际场景,低成本的接入API网关。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/
异步导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw
当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN 最大长度:64 alias_urn 否 String 函数别名URN 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN timeout 是 Integer API网关请求后端服
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
如果您需要收集、记录或者查询API网关服务的操作日志,用于支撑安全分析、审计、问题定位等常见应用场景时,那么需要先开通云审计服务。 云审计服务包含以下功能: 记录审计日志 审计日志查询 审计日志转储 事件文件加密 关键操作通知 查看关键操作列表 通过云审计服务,您可以记录与API网关相关的操作事件,便于日后的查询、审计和回溯。