导入HTTP API，支持将OpenAPI 2.0和 OpenAPI 3.0.x版本的定义文件导入为REST类型的API。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
apig:ImportHttpApi |
none |
*全部资源
|
无 | 无 |
请求语法
POST /v1/http-apis/import HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求体参数。 |
{"dryRun":false,"strategy":"ExistFirst"} |
| specContentBase64 |
string |
否 |
Bse64 编码的 API 定义，支持 OAS2.0 和 OAS3.0 规范，支持 YAML 格式和 JSON 格式。优先级高于 specFileUrl 参数。 若文件大小超过 10MB 请使用 specFileUrl 参数传递。 |
b3BlbmFwaTogMy4wLjAKaW5mbzoKICAgIHRpdGxlOiBkZW1vCiAgICBkZXNjcmlwdGlvbjogdGhpc2lzZGVtbwogICAgdmVyc2lvbjogIiIKcGF0aHM6CiAgICAvdXNlci97dXNlcklkfToKICAgICAgICBnZXQ6CiAgICAgICAgICAgIHN1bW1hcnk6IOiOt+WPlueUqOaIt+S/oeaBrwogICAgICAgICAgICBkZXNjcmlwdGlvbjog6I635Y+W55So5oi35L+h5oGvCiAgICAgICAgICAgIG9wZXJhdGlvbklkOiBHZXRVc2VySW5mbwogICAgICAgICAgICByZXNwb25zZXM6CiAgICAgICAgICAgICAgICAiMjAwIjoKICAgICAgICAgICAgICAgICAgICBkZXNjcmlwdGlvbjog5oiQ5YqfCiAgICAgICAgICAgICAgICAgICAgY29udGVudDoKICAgICAgICAgICAgICAgICAgICAgICAgYXBwbGljYXRpb24vanNvbjtjaGFyc2V0PXV0Zi04OgogICAgICAgICAgICAgICAgICAgICAgICAgICAgc2NoZW1hOiBudWxsCnNlcnZlcnM6CiAgICAtIHVybDogaHR0cDovL2FwaS5leGFtcGxlLmNvbS92MQo= |
| specFileUrl |
string |
否 |
API 定义文件的下载地址，需要公网可以下载或使用相同 region 的 OSS 内网下载地址。文件地址要求拥有下载权限，对于 OSS 非公开读的文件链接，请参考文档使用预签名 URL 下载文件，填写带有下载权限的地址。目前仅支持 OSS 上存储的 API 定义文件。 |
https://bucket.oss-cn-hangzhou.aliyuncs.com/**/*.yaml |
| name |
string |
否 |
导入的 API 名称，若不填则从 API 定义文件中提取。若 API 名称与版本化配置已存在，则本次导入会根据 strategy 字段对已有 API 定义做更新。 |
import-test |
| description |
string |
否 |
导入的 API 描述字段，若未填写则从 API 定义中提取。限制长度 255 字节。 |
测试专用API |
| versionConfig | HttpApiVersionConfig |
否 |
API 版本化配置，若开启版本化配置，则版本号 API 名称与已存在 API 相同时，本次导入将视为更新动作。若未开启版本化配置，则 API 名称与已存在 API 相同时，本次导入将视为更新动作。 |
|
| dryRun |
boolean |
否 |
导入预检，若开启则仅进行检测，不进行导入动作。 |
false |
| strategy |
string |
否 |
当导入的 API 名称与版本管理与已存在 API 相同时，需要指定更新策略。
枚举值：
|
ExistFirst |
| withGatewayExtension |
boolean |
否 |
是否导入网关扩展信息 |
false |
| targetHttpApiId |
string |
否 |
若指定该字段，则本次导入将更新指定 API 而非导入或根据 API 名称与版本管理配置搜索已存在 API。目标 API 必须是 REST 类型。 |
api-xxxx |
| resourceGroupId |
string |
否 |
|
rg-aek23nsa353vmra |
| specOssConfig |
object |
否 |
OSS 信息。 |
|
| regionId |
string |
否 |
地域 ID。 |
cn-shanghai |
| bucketName |
string |
否 |
bucket 名称。 |
gms-service-prod |
| objectKey |
string |
否 |
文件完整路径。 |
/test/swagger.json |
| deployConfigs |
array |
否 |
API 部署配置。 |
|
| HttpApiDeployConfig |
否 |
参数 |
||
| mcpRouteId |
string |
否 |
MCP 路由 ID。 |
mcp-route-xxxxxxxx |
| gatewayId |
string |
否 |
网关 ID。 |
gw-xxx |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
响应。 |
||
| requestId |
string |
请求 ID。 |
CE857A85-251D-5018-8103-A38957D71E20 |
| code |
string |
响应状态码。 |
Ok |
| message |
string |
响应消息。 |
success |
| data |
object |
API 信息。 |
|
| name |
string |
API 名称。 |
import-test |
| httpApiId |
string |
HTTP API 唯一 ID。 |
api-xxx |
| dryRunInfo |
object |
预检结果。 |
|
| successOperations |
array<object> |
预检成功的接口列表。 |
|
|
object |
接口信息。 |
||
| action |
string |
预检后将执行的动作。
枚举值：
|
Create |
| name |
string |
接口名称。 |
CreateUser |
| path |
string |
接口路径。 |
/v1/users |
| method |
string |
接口方法。 |
POST |
| failureOperations |
array<object> |
预检失败的接口列表。 |
|
|
object |
接口信息。 |
||
| path |
string |
接口路径。 |
/v1/orders |
| method |
string |
接口方法。 |
GET |
| errorMessage |
string |
错误信息 |
缺少响应定义。 |
| successComponents |
array<object> |
预检成功的数据结构列表。 |
|
|
object |
数据结构信息。 |
||
| action |
string |
预检后将执行的动作。
枚举值：
|
Create |
| name |
string |
数据结构名称。 |
userDTO |
| failureComponents |
array<object> |
预检失败的数据结构列表。 |
|
|
object |
数据结构信息。 |
||
| name |
string |
数据结构名称。 |
orderDTO |
| errorMessage |
string |
错误信息。 |
数据结构定义有误。 |
| successRoutes |
array<object> |
成功导入的路由列表 |
|
|
object |
路由列表 |
||
| action |
string |
操作类型 |
Create |
| name |
string |
名称 |
user-route |
| failureRoutes |
array<object> |
失败的路由列表 |
|
|
object |
路由列表 |
||
| name |
string |
参数名称。 |
admin-route |
| errorMessage |
string |
错误信息 |
conflict |
| errorMessages |
array |
错误信息，若错误信息非空，则无法成功导入 API。 |
|
|
string |
单个错误信息。 |
OpenAPI 3.1.x 版本不支持。 |
|
| warningMessages |
array |
告警信息，告警信息非空，则部分接口/数据接口可能导入不成功。 |
|
|
string |
单个告警信息。 |
GET /v1/orders 参数定义不完整。 |
|
| existHttpApiInfo | HttpApiApiInfo |
已存在的 API 信息。若该字段非空，则导入动作将更新该 API。 |
|
| mcpToolsDefinition |
string |
MCP 工具定义信息 |
... |
示例
正常返回示例
JSON格式
{
"requestId": "CE857A85-251D-5018-8103-A38957D71E20",
"code": "Ok",
"message": "success",
"data": {
"name": "import-test",
"httpApiId": "api-xxx",
"dryRunInfo": {
"successOperations": [
{
"action": "Create",
"name": "CreateUser",
"path": "/v1/users",
"method": "POST"
}
],
"failureOperations": [
{
"path": "/v1/orders",
"method": "GET",
"errorMessage": "缺少响应定义。"
}
],
"successComponents": [
{
"action": "Create",
"name": "userDTO"
}
],
"failureComponents": [
{
"name": "orderDTO",
"errorMessage": "数据结构定义有误。"
}
],
"successRoutes": [
{
"action": "Create",
"name": "user-route"
}
],
"failureRoutes": [
{
"name": "admin-route",
"errorMessage": "conflict"
}
],
"errorMessages": [
"OpenAPI 3.1.x 版本不支持。"
],
"warningMessages": [
"GET /v1/orders 参数定义不完整。"
],
"existHttpApiInfo": {
"httpApiId": "api-xxx",
"name": "test",
"basePath": "/v1",
"description": "测试专用API",
"versionInfo": {
"enable": true,
"scheme": "Query",
"headerName": "my-version",
"queryName": "myVersion",
"version": "v1"
},
"ingressInfo": {
"sourceId": "src-xxx",
"ingressClass": "mse",
"watchNamespace": "default",
"environmentInfo": {
"environmentId": "env-xxx"
},
"k8sClusterInfo": {
"clusterId": "ca435c77cba1547cca9311957bcxxxxxx"
},
"overrideIngressIp": true
},
"type": "Rest",
"resourceGroupId": "rg-xxx",
"enableAuth": true,
"authConfig": {
"authType": "Jwt",
"authMode": "NoAuth"
},
"gatewayId": "gw-cpv4sqdl****",
"modelCategory": "Text",
"protocols": [
"HTTP"
],
"environments": [
{
"environmentId": "env-xxx",
"backendScene": "SingleService",
"backendType": "Service",
"serviceConfigs": [
{
"gatewayServiceId": "gs-xxx",
"name": "demo-service",
"protocol": "HTTP",
"port": "8080",
"weight": 100,
"version": "v1",
"match": {
"default": true,
"conditions": [
{
"type": "Query",
"key": "color",
"value": "gray",
"operator": "equal"
}
]
},
"serviceId": "svc-xxx"
}
],
"customDomains": [
{
"domainId": "d-xxx",
"name": "www.example.com",
"protocol": "HTTP"
}
],
"name": "test",
"alias": "test",
"gatewayInfo": {
"gatewayId": "gw-xxx",
"name": "test",
"gatewayEdition": "MultiTenantServerless"
},
"deployStatus": "Deployed",
"subDomains": [
{
"domainId": "d-xxx",
"name": "www.example.com",
"protocol": "HTTP",
"networkType": "Internet"
}
]
}
],
"aiProtocols": [
"OpenAI/v1"
],
"deployConfigs": [
{
"environmentId": "env-xxx",
"backendScene": "SingleService",
"enableSystemModels": true,
"systemModelTiers": [
"economy"
],
"autoDeploy": true,
"gatewayId": "gw-xx",
"dfpConfig": {
"serviceId": "svc-cr8k0udlhtgt80sh7png"
},
"restApiRouteMode": "ordinary",
"routeBackend": {
"scene": "Single",
"enableSystemModels": true,
"services": [
{
"serviceId": "service-cq2bmmdlhtgj***",
"modelName": "qwen-plus",
"name": "item-service",
"protocol": "HTTP",
"port": 0,
"weight": 49,
"version": "v1",
"sourceType": "MSE_NACOS",
"groupName": "DEFAULT_GROUP",
"namespace": "public",
"httpDubboTranscoder": {
"dubboServiceName": "com.example.DemoService",
"dubboServiceVersion": "1.0.0",
"dubboServiceGroup": "DEV",
"methodMapList": [
{
"dubboMethodName": "sayName",
"httpMethod": "ALL_GET",
"methodPath": "/mytestzbk/sayhello",
"passThroughAllHeaders": "PASS_NOT",
"passThroughList": [
"[\"x-request-id\", \"x-tenant\"]"
],
"paramMapsList": [
{
"extractKeySpec": "ALL_QUERY_PARAMETER",
"extractKey": "name",
"mappingType": "java.lang.String"
}
]
}
]
}
}
]
},
"gatewayInfo": {
"gatewayId": "gw-cq7og15lhtgi6qasrj60",
"name": "apitest-gw",
"vpcInfo": {
"vpcId": "vpc-uf664nyle5kh***",
"name": "商品中心预发环境专有网络"
},
"engineVersion": "2.0.7",
"gatewayEdition": "MultiTenantServerless"
},
"mock": {
"enable": false,
"responseCode": 200,
"responseContent": "Mock测试"
},
"gatewayType": "API",
"customDomainIds": [
"d-xxx"
],
"envDomainIds": [
"d-xxx"
],
"serviceConfigs": [
{
"serviceId": "svc-xxx",
"weight": 100,
"modelNamePattern": "qwen-*",
"modelName": "qwen-max",
"capabilityTier": "standard",
"intentCode": "INQUIRY",
"match": {
"default": true,
"conditions": [
{
"type": "Query",
"key": "color",
"value": "gray",
"operator": "equal"
}
]
},
"port": 80,
"protocol": "HTTP",
"gatewayServiceId": "gw-svc-abc123",
"name": "Qwen-Max-Service",
"version": "V2",
"multiServiceRouteStrategy": "ByWeight",
"observabilityRouteConfig": {
"mode": "LeastBusy",
"rateLimit": 0.8,
"queueSize": 100
}
}
],
"policyConfigs": [
{
"type": "K8S",
"enable": false,
"semanticRouterConfig": {
"timeoutMillisecond": 2000
},
"aiFallbackConfig": {
"onlyRedirectUpstreamCode": true,
"serviceConfigs": [
{
"serviceId": "svc-bbb",
"name": "—",
"targetModelName": "qwen-max",
"passThroughModelName": false
}
]
},
"aiSecurityGuardConfig": {
"defaultGenerated": true,
"longTermEnabled": true,
"serviceAddress": "https://green-cip-vpc.cn-shanghai.aliyuncs.com",
"checkRequest": true,
"checkResponse": true,
"checkRequestImage": false,
"checkResponseImage": false,
"requestCheckService": "query_security_check",
"responseCheckService": "response_security_check",
"requestImageCheckService": "img_query_guard",
"responseImageCheckService": "img_response_guard",
"riskAlertLevel": "high",
"bufferLimit": 1000,
"pluginStatus": {
"serviceHealthy": true,
"pluginId": "pi-xxx",
"errorLogs": [
{
"key": "[{\"timestamp\":\"2026-06-29T10:00:00Z\",\"message\":\"redis connection timeout\"}]"
}
]
},
"consumerConfigBindings": [
{
"matchType": "exact",
"name": "example-consumer",
"templateId": "apig_0123456789abcdef"
}
],
"consumerRiskLevel": [
{
"name": "consumer-a",
"matchType": "exact",
"type": "ContentModeration",
"level": "high"
}
],
"consumerRequestCheckService": [
{
"name": "consumer-a",
"requestCheckService": "query_security_check",
"requestImageCheckService": "img_query_guard",
"matchType": "exact",
"modalityType": "Text"
}
],
"consumerResponseCheckService": [
{
"name": "consumer-a\n",
"responseCheckService": "query_security_check",
"responseImageCheckService": "img_query_guard\n",
"matchType": "exact",
"modalityType": "Text"
}
],
"riskConfig": [
{
"type": "ContentModeration",
"level": "high",
"consumerRules": {
"pattern": "consumer-a",
"matchType": "Exact"
}
}
]
},
"aiTokenRateLimitConfig": {
"redisConfig": {
"host": "r-xxx.redis.rds.aliyuncs.com",
"port": 6379,
"username": "user",
"password": "pass",
"timeout": 5000,
"databaseNumber": 0
},
"pluginStatus": {
"serviceHealthy": true,
"pluginId": "pi-xxx",
"errorLogs": [
{
"key": "[{\"timestamp\":\"2026-06-29T10:00:00Z\",\"message\":\"redis connection timeout\"}]"
}
]
},
"rules": [
{
"limitType": "Consumer",
"matchKey": "X-API-Key",
"matchType": "Exact",
"matchValue": "consumer-a",
"limitMode": "TokenPerMinute",
"limitValue": 1000
}
],
"globalRules": [
{
"limitType": "Consumer",
"matchKey": "X-API-Key",
"matchType": "Exact",
"matchValue": "consumer-a",
"limitMode": "TokenPerMinute",
"limitValue": 1000
}
],
"enableGlobalRules": true
},
"policyReference": {
"policyId": "pol-9f2exxx",
"policyAttachmentId": "pa-3c8ayyy"
},
"aiCacheConfig": {
"cacheTTL": 3600,
"redisConfig": {
"host": "r-xxx.redis.rds.aliyuncs.com",
"port": 6379,
"username": "user",
"password": "pass",
"timeout": 5000,
"databaseNumber": 0
},
"vectorConfig": {
"type": "dashvector",
"serviceHost": "vdb-xxx.dashvector.aliyuncs.com",
"apiKey": "sk-xxx",
"timeout": 5000,
"collectionId": "col-xxx",
"threshold": 0.95
},
"embeddingConfig": {
"type": "dashscope",
"serviceId": "svc-xxx",
"timeout": 5000,
"modelName": "text-embedding-v2"
},
"cacheKeyStrategy": "default",
"cacheMode": "exact",
"pluginStatus": {
"serviceHealthy": true,
"pluginId": "pi-xxx",
"errorLogs": [
{
"key": "[{\"timestamp\":\"2026-06-29T10:00:00Z\",\"message\":\"redis connection timeout\"}]"
}
]
}
},
"aiNetworkSearchConfig": {
"needReference": true,
"referenceFormat": "参考来源:\\n%s",
"referenceLocation": "head",
"defaultLang": "zh-CN",
"defaultEnable": true,
"searchFrom": [
{
"type": "aliyunQuark",
"apiKey": "sk-xxx",
"count": 5,
"start": 0,
"timeoutMillisecond": 5000,
"optionArgs": {
"key": "{\"market\":\"zh-CN\"}"
},
"endpoint": "https://cloud-iqs.aliyuncs.com",
"contentMode": "summary",
"industry": "互联网",
"timeRange": "7d"
}
],
"searchEngineConfig": {
"type": "aliyunQuark",
"apiKey": "sk-xxx",
"count": 5,
"start": 0,
"timeoutMillisecond": 5000,
"optionArgs": {
"key": "{\"market\":\"zh-CN\"}"
},
"endpoint": "https://cloud-iqs.aliyuncs.com",
"contentMode": "summary",
"industry": "互联网",
"timeRange": "7d"
},
"searchRewrite": {
"enable": true,
"serviceId": "svc-xxx",
"modelName": "qwen-max",
"timeoutMillisecond": 5000,
"maxCount": 3
}
},
"aiToolSelectionConfig": {
"enableConditions": {
"toolCountThreshold": 10
},
"toolReranking": {
"modelService": {
"serviceId": "svc-xxx\n",
"modelName": "gte-rerank-v2",
"timeoutMillisecond": 5000
},
"filteringMethod": "topN",
"topKPercent": 50,
"topNCount": 5,
"scoreThreshold": 0.5,
"fallbackStrategy": "skip"
},
"queryRewriting": {
"enabled": true,
"modelService": {
"serviceId": "svc-xxx",
"modelName": "gte-rerank-v2",
"timeoutMillisecond": 5000
},
"promptConfig": {
"type": "builtIn",
"customPrompt": "请将以下用户问题改写为..."
},
"maxOutputTokens": 50,
"triggerConditions": {
"messageCountThreshold": 1
},
"contextSelection": {
"type": "allMessages",
"value": 5
},
"fallbackStrategy": "skip"
}
},
"aiStatisticsConfig": {
"logRequestContent": true,
"logResponseContent": true,
"pathFieldConfigs": [
{
"path": "/v1/chat/completions",
"fieldPaths": {
"key": {
"fieldKey": "question",
"jsonPath": "messages.#.content",
"rule": "append",
"name": "问题内容",
"description": "用户输入的问题内容",
"source": "request_body",
"category": "conversation",
"io": "request",
"sensitive": false,
"recordEnabled": true
}
}
}
]
}
}
],
"customDomainInfos": [
{
"domainId": "d-cshee6dlhtgk******",
"name": "hello-server.com",
"protocol": "HTTP"
}
],
"envDomainInfos": [
{
"domainId": "d-env-xxx",
"name": "api.example.com",
"protocol": "HTTPS"
}
],
"subDomains": [
{
"domainId": "d-csmn42um******",
"name": "test",
"protocol": "HTTP",
"networkType": "Intranet"
}
],
"builtinRouteNames": [
"[\"chat\",\"completions\"]"
]
}
],
"deployCntMap": {
"key": {
"deployedCnt": 3,
"cnt": 10
}
},
"agentProtocols": [
"DashScope"
]
},
"mcpToolsDefinition": "..."
}
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。