API 网关：ImportHttpApi - 导入HTTP API

授权信息

请求语法

POST /v1/http-apis/import HTTP/1.1

请求参数

返回参数

示例

正常返回示例

JSON格式

{
  "code": "Ok",
  "data": {
    "dryRunInfo": {
      "errorMessages": [
        "OpenAPI 3.1.x 版本不支持。"
      ],
      "existHttpApiInfo": {
        "agentProtocols": [
          "DashScope"
        ],
        "aiProtocols": [
          "OpenAI/v1"
        ],
        "authConfig": {
          "authMode": "NoAuth",
          "authType": "Jwt"
        },
        "basePath": "/v1",
        "deployCntMap": {
          "key": {
            "cnt": 10,
            "deployedCnt": 3
          }
        },
        "deployConfigs": [
          {
            "autoDeploy": true,
            "backendScene": "SingleService",
            "builtinRouteNames": [
              "[\"chat\",\"completions\"]"
            ],
            "customDomainIds": [
              "d-xxx"
            ],
            "customDomainInfos": [
              {
                "domainId": "d-cshee6dlhtgk******",
                "name": "hello-server.com",
                "protocol": "HTTP"
              }
            ],
            "enableSystemModels": true,
            "envDomainIds": [
              "d-xxx"
            ],
            "envDomainInfos": [
              {
                "domainId": "d-env-xxx",
                "name": "api.example.com",
                "protocol": "HTTPS"
              }
            ],
            "environmentId": "env-xxx",
            "gatewayId": "gw-xx",
            "gatewayInfo": {
              "gatewayId": "gw-cq7og15lhtgi6qasrj60",
              "name": "apitest-gw",
              "vpcInfo": {
                "vpcId": "vpc-uf664nyle5kh***",
                "name": "商品中心预发环境专有网络"
              },
              "engineVersion": "2.0.7",
              "gatewayEdition": "MultiTenantServerless"
            },
            "gatewayType": "API",
            "mock": {
              "enable": false,
              "responseCode": 200,
              "responseContent": "Mock测试"
            },
            "policyConfigs": [
              {
                "type": "K8S",
                "enable": false,
                "semanticRouterConfig": {
                  "timeoutMillisecond": 2000
                },
                "aiFallbackConfig": {
                  "onlyRedirectUpstreamCode": true,
                  "serviceConfigs": [
                    {
                      "serviceId": "svc-bbb",
                      "name": "—",
                      "targetModelName": "qwen-max",
                      "passThroughModelName": false
                    }
                  ]
                },
                "aiSecurityGuardConfig": {
                  "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\"}]"
                      }
                    ]
                  },
                  "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": "-",
                  "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
                        }
                      }
                    }
                  ]
                }
              }
            ],
            "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"
                          }
                        ]
                      }
                    ]
                  }
                }
              ]
            },
            "serviceConfigs": [
              {
                "capabilityTier": "standard",
                "gatewayServiceId": "gw-svc-abc123",
                "intentCode": "INQUIRY",
                "match": {
                  "default": true,
                  "conditions": [
                    {
                      "type": "Query",
                      "key": "color",
                      "value": "gray",
                      "operator": "equal"
                    }
                  ]
                },
                "modelName": "qwen-max",
                "modelNamePattern": "qwen-*",
                "multiServiceRouteStrategy": "ByWeight",
                "name": "Qwen-Max-Service",
                "observabilityRouteConfig": {
                  "mode": "LeastBusy",
                  "queueSize": 100,
                  "rateLimit": 0.8
                },
                "port": 80,
                "protocol": "HTTP",
                "serviceId": "svc-xxx",
                "version": "V2",
                "weight": 100
              }
            ],
            "subDomains": [
              {
                "domainId": "d-csmn42um******",
                "name": "test",
                "networkType": "Intranet",
                "protocol": "HTTP"
              }
            ],
            "systemModelTiers": [
              "economy"
            ]
          }
        ],
        "description": "测试专用API",
        "enableAuth": true,
        "environments": [
          {
            "alias": "test",
            "backendScene": "SingleService",
            "backendType": "Service",
            "customDomains": [
              {
                "domainId": "d-xxx",
                "name": "www.example.com",
                "protocol": "HTTP"
              }
            ],
            "deployStatus": "Deployed",
            "environmentId": "env-xxx",
            "gatewayInfo": {
              "gatewayEdition": "MultiTenantServerless",
              "gatewayId": "gw-xxx",
              "name": "test"
            },
            "name": "test",
            "serviceConfigs": [
              {
                "gatewayServiceId": "gs-xxx",
                "match": {
                  "default": true,
                  "conditions": [
                    {
                      "type": "Query",
                      "key": "color",
                      "value": "gray",
                      "operator": "equal"
                    }
                  ]
                },
                "name": "demo-service",
                "port": "8080",
                "protocol": "HTTP",
                "serviceId": "svc-xxx",
                "version": "v1",
                "weight": 100
              }
            ],
            "subDomains": [
              {
                "domainId": "d-xxx",
                "name": "www.example.com",
                "networkType": "Internet",
                "protocol": "HTTP"
              }
            ]
          }
        ],
        "gatewayId": "gw-cpv4sqdl****",
        "httpApiId": "api-xxx",
        "ingressInfo": {
          "environmentInfo": {
            "environmentId": "env-xxx"
          },
          "ingressClass": "mse",
          "k8sClusterInfo": {
            "clusterId": "ca435c77cba1547cca9311957bcxxxxxx"
          },
          "overrideIngressIp": true,
          "sourceId": "src-xxx",
          "watchNamespace": "default"
        },
        "modelCategory": "Text",
        "name": "test",
        "protocols": [
          "HTTP"
        ],
        "resourceGroupId": "rg-xxx",
        "type": "Rest",
        "versionInfo": {
          "enable": true,
          "headerName": "my-version",
          "queryName": "myVersion",
          "scheme": "Query",
          "version": "v1"
        }
      },
      "failureComponents": [
        {
          "errorMessage": "数据结构定义有误。",
          "name": "orderDTO"
        }
      ],
      "failureOperations": [
        {
          "errorMessage": "缺少响应定义。",
          "method": "GET",
          "path": "/v1/orders"
        }
      ],
      "failureRoutes": [
        {
          "errorMessage": "conflict",
          "name": "admin-route"
        }
      ],
      "mcpToolsDefinition": "...",
      "successComponents": [
        {
          "action": "Create",
          "name": "userDTO"
        }
      ],
      "successOperations": [
        {
          "action": "Create",
          "method": "POST",
          "name": "CreateUser",
          "path": "/v1/users"
        }
      ],
      "successRoutes": [
        {
          "action": "Create",
          "name": "user-route"
        }
      ],
      "warningMessages": [
        "GET /v1/orders 参数定义不完整。"
      ]
    },
    "httpApiId": "api-xxx",
    "name": "import-test"
  },
  "message": "success",
  "requestId": "CE857A85-251D-5018-8103-A38957D71E20"
}

错误码

变更历史