{"componentChunkName":"component---src-templates-acg-portal-new-template-tsx","path":"/gmu9lv4tn","result":{"data":{"markdownRemark":{"html":"

概述

\n

基础 API 是基础服务下的传统 HTTP 路由，通过配置匹配规则（路径、方法、Header、Query）与后端绑定，将请求转发到目标后端，并支持超时、URL 重写、重试、请求/响应体积等高级策略。本文介绍如何创建基础 API。

\n

前提条件

\n\n

操作步骤

\n
    \n
  1. 登录 API 网关专享版控制台，在左侧导航选择目标实例。
    2. \n
  2. 进入 API 管理，单击 创建，进入创建基础 API 页面。
    3. \n
  3. 按以下模块完成配置。
    4. \n
\n

基本信息

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
配置项说明
API 名称（必填）API 在实例内的标识。
所属服务（必选）选择已创建的基础服务。
\n

匹配规则

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
配置项说明
请求路径（必填）请求匹配的路径，配合匹配方式使用。
匹配方式（必选）精确匹配 / 前缀匹配 / 正则匹配。
请求方法（必选）GET、POST、PUT、DELETE 等 HTTP 方法，支持多选。
Header 匹配（可选）按请求头的键值与匹配方式（精确/前缀/正则）追加匹配条件。
Query 匹配（可选）按请求参数的键值与匹配方式追加匹配条件。
优先级（可选）范围 0-9999，0 为最高优先级，默认为 0。当优先级相同时，按默认路由规则匹配。
\n

默认 API 规则（优先级相同时）：

\n
    \n
  1. API 匹配规则优先级：精确匹配 > 前缀匹配 > 正则匹配；
    2. \n
  2. 路径段数匹配多的优先级高，例如 /a/b 优先级大于 /a；
    3. \n
  3. Header 匹配数量多的优先级高，Header 优先级大于 Query；
    4. \n
  4. Query 匹配数量多的优先级高。
    5. \n
\n

高级配置

\n

超时

\n

启用后，允许请求等待后端响应的最大时间。

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
配置项说明
超时时间单位秒（支持毫秒精度），后端超过该时间未响应时网关返回超时错误。
\n

URL 重写

\n

启用后，转发到后端前重写请求的路径或 Host。

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
配置项说明
重写路径转发到后端时使用的新路径。
重写 Host转发到后端时使用的新 Host。
\n

重试

\n

启用后，支持配置对失败的请求进行重试的场景。

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
配置项说明
重试条件触发重试的错误场景（如连接失败、后端不可用等），与状态码至少填写一项。
状态码后端返回指定状态码（如 502、503）时触发重试。
请求重试次数范围 1-10 次。
单次重试超时单次重试等待响应的最大时间，单位秒。
\n

后端配置

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
配置项说明
后端（必选）从已创建的后端中选择。
匹配类型/内容多后端时配置各后端的流量匹配规则，目前支持为不同后端设置流量权重比例
\n
    \n
  1. 单击 确定 完成创建。
    2. \n
\n

后续操作

\n","fields":{"slug":"gmu9lv4tn","title":"创建基础API","date":"2026-09-20","extractedHeadings":[]},"headings":[{"value":"概述","depth":2},{"value":"前提条件","depth":2},{"value":"操作步骤","depth":2},{"value":"基本信息","depth":3},{"value":"匹配规则","depth":3},{"value":"高级配置","depth":3},{"value":"超时","depth":4},{"value":"URL 重写","depth":4},{"value":"重试","depth":4},{"value":"后端配置","depth":3},{"value":"后续操作","depth":2}]}},"pageContext":{"isCreatedByStatefulCreatePages":false,"slug":"gmu9lv4tn","prev":{"id":"Imu9lv4nz","name":"基础API概述","path":"Imu9lv4nz","filePath":"API网关专享版/操作指南/API管理/基础API/基础API概述.md","seo":null,"parentIds":["Omspw9n4x","nmspw9npq","xmspw9nsg","0mu9lv4nd"],"parents":[{"id":"Omspw9n4x","documentId":"cbb7cda2-d4b2-4774-9c2f-c637554847d6","name":"API网关专享版","repoName":"APIGW","filePath":"API网关专享版","disabled":false,"path":"Omspw9n4x","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"nmspw9npq","documentId":"5488af8a-8e35-4ad7-a345-adda73980fdd","name":"操作指南","repoName":"APIGW","filePath":"API网关专享版/操作指南","disabled":false,"path":"nmspw9npq","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"xmspw9nsg","documentId":"ded40ec3-0e3b-4ab3-af7b-ff4fb019d53e","name":"API管理","repoName":"APIGW","filePath":"API网关专享版/操作指南/API管理","disabled":false,"path":"xmspw9nsg","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"0mu9lv4nd","documentId":"959827a2-2fa4-4bf6-8acb-ed959e2c9fe0","name":"基础API","repoName":"APIGW","filePath":"API网关专享版/操作指南/API管理/基础API","disabled":false,"path":"0mu9lv4nd","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null}]},"next":{"id":"Omu9lv4wb","name":"发布与管理基础API","path":"Omu9lv4wb","filePath":"API网关专享版/操作指南/API管理/基础API/发布与管理基础API.md","seo":null,"parentIds":["Omspw9n4x","nmspw9npq","xmspw9nsg","0mu9lv4nd"],"parents":[{"id":"Omspw9n4x","documentId":"cbb7cda2-d4b2-4774-9c2f-c637554847d6","name":"API网关专享版","repoName":"APIGW","filePath":"API网关专享版","disabled":false,"path":"Omspw9n4x","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"nmspw9npq","documentId":"5488af8a-8e35-4ad7-a345-adda73980fdd","name":"操作指南","repoName":"APIGW","filePath":"API网关专享版/操作指南","disabled":false,"path":"nmspw9npq","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"xmspw9nsg","documentId":"ded40ec3-0e3b-4ab3-af7b-ff4fb019d53e","name":"API管理","repoName":"APIGW","filePath":"API网关专享版/操作指南/API管理","disabled":false,"path":"xmspw9nsg","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"0mu9lv4nd","documentId":"959827a2-2fa4-4bf6-8acb-ed959e2c9fe0","name":"基础API","repoName":"APIGW","filePath":"API网关专享版/操作指南/API管理/基础API","disabled":false,"path":"0mu9lv4nd","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null}]},"parents":[{"id":"Omspw9n4x","documentId":"cbb7cda2-d4b2-4774-9c2f-c637554847d6","name":"API网关专享版","repoName":"APIGW","filePath":"API网关专享版","disabled":false,"path":"Omspw9n4x","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"nmspw9npq","documentId":"5488af8a-8e35-4ad7-a345-adda73980fdd","name":"操作指南","repoName":"APIGW","filePath":"API网关专享版/操作指南","disabled":false,"path":"nmspw9npq","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"xmspw9nsg","documentId":"ded40ec3-0e3b-4ab3-af7b-ff4fb019d53e","name":"API管理","repoName":"APIGW","filePath":"API网关专享版/操作指南/API管理","disabled":false,"path":"xmspw9nsg","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"0mu9lv4nd","documentId":"959827a2-2fa4-4bf6-8acb-ed959e2c9fe0","name":"基础API","repoName":"APIGW","filePath":"API网关专享版/操作指南/API管理/基础API","disabled":false,"path":"0mu9lv4nd","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null}],"specificSeo":null}}}