检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用Swagger文件导入API时是否有模板? 模板在开发中。 您可以先配置好1~2个API,再导出作为模板。 父主题: 导入导出API
异步导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/insta
Swagger对象 OpenAPI对象 (以3.0.0为例) API网关对象 导入时行为 导出时行为 info.title info.title API分组名称 导入到新的分组:新的分组名称 导入到已有分组:未使用 支持汉字、英文、数字、下划线,且只能以英文或汉字开头,3 ~ 64字符
String 分组ID success Array 导入成功信息 failure Array 导入失败信息 表29 success参数说明 名称 类型 说明 id String 导入成功的API ID action String 导入行为: update:表示更新API create:表示新建API
success Array 导入成功信息,见表29 failure Array 导入失败信息,见表30 swagger Object 表29 success参数说明 名称 类型 说明 id String 导入成功的API ID action String 导入行为: update:表示更新API
下面描述单向认证流程,双向认证具体操作请参考双向认证。 创建SSL证书 SSL证书是进行数据传输加密和身份证明的证书。 绑定域名 将API所属的分组与已备案且解析的独立域名绑定。 绑定证书 将独立域名和已创建的SSL证书绑定。 调用API 验证API是否调用成功。 父主题: 配置
ssl_infos Array of SslInfo objects SSL证书列表。 表5 SslInfo 参数 参数类型 描述 ssl_id String SSL证书编号。 ssl_name String SSL证书名称。 algorithm_type String 证书算法类型:
OpenAPI版本 选择导出Swagger 2.0或OpenAPI 3.0定义的API。 单击“导出”,右侧显示导出结果,并自动下载文件。 父主题: 导入导出API
实施步骤 单向认证 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 创建SSL证书。 在左侧导航栏选择“API管理 > API策略”。 在“SSL证书管理”页签中,单击“创建SSL证书”。 表1 配置单向认证的证书信息 参数 配置说明 证书名称 填写证书名称,建议您按
查看域名证书 功能介绍 查看域名下绑定的证书详情。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/ap
导入导出API 导入导出API的限制与兼容性说明 通过API设计文件导入API 通过CSE微服务导入API 通过CCE工作负载导入API 导出APIG的API 父主题: 管理API
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
的请求协议必须选择“HTTPS”或“HTTP&HTTPS”。 API已发布。 API所属API分组已绑定独立域名和SSL证书。 API的相关操作及绑定域名和SSL证书,请参见《API网关用户指南》。 开启重定向 登录API网关控制台,在左侧导航栏选择“API管理 > API分组”。
object 导入微服务的API分组信息 service_type 是 String 微服务中心类型。 CSE:CSE微服务注册中心 CCE: CCE云容器引擎(工作负载) CCE_SERVICE: CCE云容器引擎(Service) NACOS: Nacos注册中心,nacos_info必填。
String 分组ID success Array 导入成功信息 failure Array 导入失败信息 表29 success参数说明 名称 类型 说明 id String 导入成功的API ID action String 导入行为: update:表示更新API create:表示新建API
String 分组ID success Array 导入成功信息 failure Array 导入失败信息 表29 success参数说明 名称 类型 说明 id String 导入成功的API ID action String 导入行为: update:表示更新API create:表示新建API
的调试域名)访问API,该调试域名每天最多可以访问1000次。 如果在API网关控制台“API管理 > API策略 > SSL证书管理”界面的“创建SSL证书”窗口中设置了“CA”参数,那么在调用API时,请注意以下限制。 使用HTTP/1.0协议调用API时,不允许请求头中存在
创建API分组 每个API都归属到某一个API分组下,在创建API前应提前创建API分组。 添加API的SSL证书 如果API分组中的API支持HTTPS请求协议,需要为独立域名添加SSL证书。反之,跳过此步骤。 配置API的调用域名 在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。
request 401 unauthorized 403 forbidden 500 server internal error 父主题: API导入导出(待下线)
API导入导出(待下线) 导出分组下所有API 批量导出API 导入API到新分组 导入API到已有分组 父主题: 专享版API(V1)(待下线)