检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
路径:后端服务的路径。此处填写“/”。 发布API 在“API运行”页面,选择已创建的API,单击“发布最新版本”。 在“API运行”页面中,API的URL不显示调用方法以及协议,仅显示域名和路径部分。当发送gRPC请求时,填入域名部分即可。 选择API的发布环境,并填写发布说明。 单击“确定”,API发布成功后,发布按钮左上角的红色感叹号消失。
通过CSE微服务导入API API网关支持导入微服务引擎(Cloud Service Engine,简称CSE)的微服务。将微服务作为后端服务,在API网关中开放API,提供给API调用者使用。 如果当前实例不支持“导入CSE微服务”,请联系客服。 目前仅广州友好、贵阳一、上海一、广州、北京四区域支持导入CSE服务。
解除API与ACL策略的绑定 功能介绍 解除某条API与ACL策略的绑定关系 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/{acl_bindings_id}
如何调用API 构造请求 认证鉴权 返回结果
新增编排规则管理接口。 新增实例自定义入方向端口管理接口。 2024-01-19 新增查询实例支持的特性列表接口。 新增设置调试域名是否可以访问接口。 新增异步任务管理接口。 2023-09-12 增加修改变量接口。 增加校验API定义接口。 创建专享版实例接口分为创建专享版实例
String API归属的集成应用名称 暂不支持 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 暂不支持 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo
API的后端服务报“Backend unavailable”或“Backend timeout” 以下原因可能导致后端服务调用失败或者超时,请逐一排查。 原因 解决方案 后端服务地址错误。 在编辑API中修改后端服务地址。 如果是域名,请确认域名能正确解析到后端服务IP地址。 后端超时时间设置不合理。
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
导入导出API 导入导出API的限制与兼容性说明 通过API设计文件导入API 通过CSE微服务导入API 通过CCE工作负载导入API 导出APIG的API 父主题: 管理API
策略创建后,您还需要为策略绑定API,才能使策略对API生效。 为策略绑定API 单击策略名称,进入策略详情。 在API列表区域选择环境后,单击“绑定API”。 筛选API分组以及发布环境,勾选所需的API。 支持通过API名称或标签筛选API,标签为创建API时定义的标签。 单击“确定”,绑定完成。
操作步骤 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称,例如“API01”。 所属分组 API所属分组,此处默认“DEFAULT”。
参考调用APIG开放的API调用。 前提条件 同一个环境中,一个API只能被一个第三方认证策略绑定,但一个第三方认证策略可以绑定多个API。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。
配置API策略 配置API的传统策略 配置API的插件策略
策略创建后,您还需要为策略绑定API,才能使策略对API生效。 为策略绑定API 单击策略名称,进入策略详情。 在API列表区域选择环境后,单击“绑定API”。 筛选API分组以及发布环境,勾选所需的API。 支持通过API名称或标签筛选API,标签为创建API时定义的标签。 单击“确定”,绑定完成。
说明 id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 status Integer API的状态 type Integer API类型 version String
本次查询返回的列表长度 api_versions 字典数据类型 本次查询返回的API历史版本列表 表4 api_versions参数说明 参数 类型 说明 version_id String API历史版本的ID version_no String API的版本号 api_id String API编号
符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明 参数 类型 说明 id String API编号 name String API名称 group_id String API所属分组的编号
专享版-SSL证书管理 获取SSL证书列表 创建SSL证书 域名绑定SSL证书 域名解绑SSL证书 查看证书详情 删除SSL证书 修改SSL证书 SSL证书绑定域名 SSL证书解绑域名 获取SSL证书已绑定域名列表 父主题: 专享版API(V2)
Integer 满足条件的API历史版本总数 size Integer 本次查询返回的列表长度 api_versions 字典数据类型 本次查询返回的API历史版本列表 表4 api_versions参数说明 参数 类型 说明 version_id String API历史版本的ID version_no
安全 责任共担 身份认证与访问控制 数据保护技术 审计与日志 监控安全风险 认证证书