网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

导入API到新分组

更新时间:2022-08-30 GMT+08:00
分享

功能介绍

通过导入的swagger文件创建新分组和新API。swagger文件支持json以及yaml格式。

URI

HTTP/HTTPS请求方法以及URI如下表所示。

表1

请求方法

URI

POST

/v1/{project_id}/apigw/instances/{instance_id}/openapi[?extend_mode]

URI中的参数说明如下表所示。

表2 参数说明

参数

参数位置

是否必选

类型

说明

project_id

path

String

项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。

instance_id

path

String

实例ID,可从API网关控制台的专享版实例信息中获取。

extend_mode

query

String

扩展信息导入模式,取值可选merge和override。

当扩展信息定义冲突时,merge保留原有扩展信息,override会覆盖原有扩展信息。

请求消息

表3 参数说明

名称

是否必选

参数类型

说明

swagger

String

固定值2.0

info

Object

参考表4

paths

Object

参考表 paths参数说明

responses

Object

公用响应定义,可以被引用在{method}的操作中,参考表9

securityDefinitions

Object

定义鉴权方式,参考表13

x-apigateway-access-controls

Object

访问控制信息,参考表 x-apigateway-access-controls参数说明

x-apigateway-ratelimits

Object

流量空时信息,参考表 x-apigateway-ratelimits参数说明

表4 info参数说明

名称

是否必选

参数类型

说明

title

String

API分组名称

version

String

版本号,用户输入自定义版本号或者使用默认的当前时间

description

String

分组描述信息

表5 paths参数说明

名称

是否必选

参数类型

说明

uri

Object

API访问地址,参考表6

表6 uri参数说明

名称

是否必选

参数类型

说明

method

Object

API访问方法,参考表7

表7 method参数说明

名称

是否必选

参数类型

说明

operationId

String

API的名称

description

String

API的描述信息

schemes

Object

API的请求协议对象数组定义,支持http、https

tags

Object

API标签对象数组定义

parameters

Object

请求参数对象数组定义,参考表 前端parameters参数说明

responses

Object

响应定义,参考表9

security

Object

API的认证类型对象数组定义,参考表 security参数说明

x-apigateway-access-control

Object

API绑定的访问控制对象数组定义

x-apigateway-backend

Object

API的后端信息,参考表 x-apigateway-backend参数说明

x-apigateway-backend-policies

Object

API的策略后端信息,参考表 x-apigateway-backend-policies参数说明

x-apigateway-cors

Boolean

是否支持跨域

x-apigateway-match-mode

String

API的匹配方式

x-apigateway-ratelimit

String

API绑定的流量控制名称

x-apigateway-request-type

String

API的类型

表8 前端parameters参数说明

名称

是否必选

参数类型

说明

maximum

Float

参数为数值类型时,最大参数值

minimum

Float

参数为数值类型时,最小参数值

maxLength

Integer

参数为字符串类型时,参数的最大长度

minLength

Integer

参数为字符串类型时,参数的最小长度

pattern

String

参数值为正则匹配表达式

type

String

参数类型

default

String

参数默认值

description

String

参数描述信息

name

String

参数名称

in

String

参数位置,支持path、header、query、formData、body

required

Boolean

参数是否必需,参数位置为path时必需

表9 responses参数说明

名称

是否必选

参数类型

说明

default

Object

缺省响应,描述未定义的响应码

status_code

Object

响应状态码,值为响应对象,参考表11

x-apigateway-result-failure-sample

String

失败返回示例,描述API的异常返回信息

x-apigateway-result-normal-sample

String

正常响应示例,描述API的正常返回信息

表10 security参数说明

名称

是否必选

参数类型

说明

apig-auth-type

Object

API的认证类型对象数组定义,为空数组

apig-auth-type支持:

  • APP认证: apig-auth-app
  • IAM认证:apig-auth-iam
  • NONE:不填写
表11 status code参数说明

名称

是否必选

参数类型

说明

description

String

响应描述信息

schema

Object

响应正文定义,参考表12

表12 schema参数说明

名称

是否必选

参数类型

说明

description

String

BODY体描述

type

String

BODY体类型:FORM/STREAM(表单/字节流)

表13 securityDefinitions参数说明

名称

是否必选

参数类型

说明

name

Object

自定义鉴权方式名称,参考表14

表14 name参数说明

名称

是否必选

参数类型

说明

type

String

鉴权类型,支持apiKey

name

String

apiKey参数名称

in

String

apiKey参数位置

x-apigateway-auth-type

String

扩展鉴权类型,基于apiKey鉴权方式的扩展,网关自定义的鉴权方式,支持AppSigv1、IAM、IAM_NONE

表15 x-apigateway-backend参数说明

名称

是否必选

参数类型

说明

type

String

API后端类型,支持HTTP、HTTP-VPC、FUNCTION、MOCK

parameters

Object

后端参数对象数组定义,参考表 后端parameters参数说明

backend_define

Object

API后端定义

backend_define支持:

表16 x-apigateway-backend-policies参数说明

名称

是否必选

参数类型

说明

type

String

API后端类型,支持HTTP、HTTP-VPC、FUNCTION、MOCK

name

String

后端策略名称

parameters

Object

后端参数对象数组定义,参考表 后端parameters参数说明

backend_define

Object

API后端定义

backend_define支持:

conditions

Object

策略条件对象数组定义,参考表 conditions参数说明

effectMode

String

关联的策略组合模式,支持ANY、ALL

表17 后端parameters参数说明

名称

是否必选

参数类型

说明

name

String

参数名称,由字母、数字、下划线、连线、点组成,以字母开头,最长32字节

header位置的参数名称不区分大小写

value

String

参数值,当参数来源为REQUEST时,值为请求参数名称

in

String

参数位置,支持header、query、path

origin

String

参数映射来源,支持REQUEST、CONSTANT

description

String

参数含义描述

表18 后端httpEndpoints参数说明

名称

是否必选

参数类型

说明

address

String

后端服务地址,格式为:<域名或IP>:[port]

scheme

String

后端请求协议定义,支持http、https

method

String

后端请求方法,支持GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH、ANY

path

String

后端请求路径,支持路径变量

timeout

Integer

后端请求超时时间,单位毫秒,缺省值为5000,取值范围为1 ~ 60000

description

String

API后端描述

表19 后端httpVpcEndpoints参数说明

名称

是否必选

参数类型

说明

name

Array

VPC通道名称

scheme

String

后端请求协议定义,支持http、https

method

String

后端请求方法,支持GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH、ANY

path

String

后端请求路径,支持路径变量

timeout

Integer

后端请求超时时间,单位毫秒,缺省值为5000,取值范围为1 ~ 60000

host

String

VPC通道代理主机

description

String

API后端描述

表20 后端functionEndpoints参数说明

名称

是否必选

参数类型

说明

function-urn

String

函数URN地址

version

String

函数版本

invocation-type

String

函数调用类型,支持async、sync

timeout

Integer

函数超时时间,单位毫秒,缺省值为5000,取值范围为1 ~ 60000

description

String

API后端描述

表21 后端mockEndpoints参数说明

名称

是否必选

参数类型

说明

result-content

String

MOCK返回结果

description

String

API后端描述

表22 conditions参数说明

名称

是否必选

参数类型

说明

type

String

策略条件类型,支持equal、enum、pattern

value

String

策略条件值

origin

String

策略条件输入来源,支持source、request

parameter

String

策略条件输入来源为request时,请求入参的名称

表23 x-apigateway-access-controls参数说明

名称

是否必选

参数类型

说明

acl_name

Object

指定名称的访问控制策略,参考表 acl_name参数说明

表24 acl_name参数说明

名称

是否必选

参数类型

说明

acl-type

String

访问控制行为,支持PERMIT、DENY

entity-type

String

访问控制对象,支持IP、DOMAIN

value

String

访问控制策略值,多个值以“,”间隔

表25 x-apigateway-ratelimits参数说明

名称

是否必选

参数类型

说明

throttle_name

Object

指定名称的流控策略,参考表 throttle_name参数说明

表26 throttle_name参数说明

名称

是否必选

参数类型

说明

api-limit

Integer

API访问次数限制

user-limit

Integer

用户访问次数限制

app-limit

Integer

应用访问次数限制

ip-limit

Integer

源IP访问次数限制

interval

Integer

流控策略时间周期

unit

String

流控策略时间周期单位,支持SECOND、MINUTE、HOUR、DAY

shared

Boolean

是否共享流控策略

special

Object

特殊流控策略对象数组定义,参考表 special参数说明

表27 special参数说明

名称

是否必选

参数类型

说明

type

String

特殊流控策略类型,支持APP、USER

limit

Integer

访问次数

instance

String

特殊APP或USER的对象标识

请求消息样例:

{
	"swagger": "2.0",
	"info": {
		"description": "api group test",
		"title": "APIGroup_test",
		"version": "2019-09-12-17:38:10"
	},

	"paths": {
		"/test/{path}": {
			"get": {
				"security": [
					{
						"apig-auth-app": []
					}
				],
				"description": "api test",
				"schemes": [
					"https"
				],
				"operationId": "API_test",
				"parameters": [
					{
						"type": "string",
						"description": "header parameter",
						"name": "header",
						"in": "header",
						"required": true
					},
					{
						"type": "string",
						"description": "path parameter",
						"name": "path",
						"in": "path",
						"required": true
					},
					{
						"type": "number",
						"default": "123",
						"description": "query parameter",
						"name": "query",
						"in": "query"
					}
				],
				"responses": {
					"default": {
						"$ref": "#/responses/default"
					},
					"x-apigateway-result-failure-sample": "",
					"x-apigateway-result-normal-sample": "success"
				},
				"x-apigateway-backend": {
					"httpEndpoints": {
						"address": "1.1.1.1:443",
						"description": "",
						"method": "GET",
						"path": "/test/{path}",
						"scheme": "https",
						"timeout": 5000
					},
					"parameters": [
						{
							"description": "",
							"in": "HEADER",
							"name": "header",
							"origin": "REQUEST",
							"value": "header"
						},
						{
							"description": "",
							"in": "PATH",
							"name": "path",
							"origin": "REQUEST",
							"value": "path"
						},
						{
							"description": "",
							"in": "QUERY",
							"name": "query",
							"origin": "REQUEST",
							"value": "query"
						}
					],
					"type": "HTTP"
				},
				"x-apigateway-backend-policies": [
					{
						"conditions": [
							{
								"origin": "param",
								"parameter": "path",
								"type": "exact",
								"value": "path"
							},
							{
								"origin": "source",
								"parameter": "",
								"type": "",
								"value": "1.0.0.0/8"
							}
						],
						"effectMode": "ANY",
						"httpVpcEndpoints": {
							"method": "POST",
							"name": "VPC_n9ct",
							"path": "/",
							"scheme": "HTTPS",
							"timeout": 5000
						},
						"name": "policy_test",
						"type": "HTTP-VPC"
					}
				],
				"x-apigateway-cors": false,
				"x-apigateway-match-mode": "NORMAL",
				"x-apigateway-request-type": "public"
			}
		}
	},
	"responses": {
		"default": {
			"description": "response example"
		}
	},
	"securityDefinitions": {
		"apig-auth-app": {
			"type": "apiKey",
			"name": "Authorization",
			"in": "header",
			"x-apigateway-auth-type": "AppSigv1"
		},
		"apig-auth-iam": {
			"type": "apiKey",
			"name": "unused",
			"in": "header",
			"x-apigateway-auth-type": "IAM"
		}
	}
}

响应消息

表28 参数说明

名称

类型

说明

group_id

String

分组ID

success

Array

导入成功信息,见表29

failure

Array

导入失败信息,见表30

swagger

Object

  
表29 success参数说明

名称

类型

说明

id

String

导入成功的API ID

action

String

导入行为:

  • update:表示更新API
  • create:表示新建API

method

String

API请求方法

path

String

API请求路径

表30 failure参数说明

名称

类型

说明

error_code

String

导入失败的错误码

error_msg

String

导入失败的错误信息

method

String

API请求方法

path

String

API请求路径

表31 swagger参数说明

名称

类型

说明

id

String

swagger文件唯一id

result

String

swagger文件的API导入结果,取值范围:

  • Success
  • Failure

响应消息样例:

{
  "group_id": "27aa2317e3514c5bb5aab5587a5e50ea",
  "success": [
    {
      "id": "aea39194d8db46408be0174b0bd15931",
      "action": "create",
      "method": "GET",
      "path": "/test01"
    }
  ],
  "failure": [
    {
      "error_code": "APIG.2011",
      "error_msg": "Parameter value does not match the rules,parameterName:backend_type",
      "method": "GET",
      "path": "/test02"
    }
  ],
	"swagger": {
		"id": "f38dee667a324c16b8a5d7029df015af",
		"result": "Success"
	}
}

状态码

表32 返回消息说明

状态码

说明

200

OK

400

Bad Request

403

Forbidden

500

Server Internal Error

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容