CreateHttpApiRoute - 建立HTTP API路由 - API Gateway

建立HttpApi的路由。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

apig:CreateHttpApiRoute

none

*HttpApi

acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId}

無

請求文法

POST /v1/http-apis/{httpApiId}/routes HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
httpApiId	string	否	路由所屬的 HTTP API ID。	api-cqoob7llhtgq***

請求參數

名稱	類型	必填	描述	樣本值
body	object	否	請求 Body。
environmentId	string	否	環境 ID。	env-cpqnr6tlhtgubcv***
name	string	否	路由名稱。	login
description	string	否	路由描述。	使用者登入路由。
domainIds	array	否	網域名稱 ID。
	string	否	網域名稱 ID。	d-cr62ts5lhtglnu***
match	HttpRouteMatch	否	路由 Match 規則。
backendConfig	object	否	路由的後端服務配置。
scene	string	否	後端服務情境。 SingleService：單服務。 MultiServiceByRatio：多服務按比例灰階。 Mock：Mock 服務。 Redirect：重新導向服務。枚舉值： SingleService : 單服務 MultiServiceByRatio : 多服務按比例灰階 Redirect : Redirect MultiServiceByTag : 多服務按標籤 Mock : Mock	SingleService
services	array<object>	否	後端服務列表。
	object	否	後端服務。
serviceId	string	否	服務 ID。	svc-crbgq0dlhtgr***
protocol	string	否	服務合約： HTTP。 HTTPS。枚舉值： HTTPS : HTTPS HTTP : HTTP	HTTP
port	integer	否	服務連接埠, 動態連接埠不傳入。	8080
weight	integer	否	流量比例的百分比值。	49
version	string	否	服務版本，僅在按標籤情境下有效。	v1
deployConfigs	array	否	API 部署配置。
	HttpApiDeployConfig	否	API 部署配置。
mcpRouteConfig	object	否	MCP 路由配置
protocol	string	否	服務合約: TCP。 HTTP。 DUBBO。	HTTP,HTTPS
exposedUriPath	string	否	暴露的 URI 路徑	/v1/chat/completions
mcpStatisticsEnable	boolean	否	是否啟用 MCP 可觀測，預設 false	false
policyConfigs	array	否	策略類型。
	HttpApiPolicyConfigs	否	策略類型。

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
requestId	string	請求 ID。	3ACFC7A7-45A9-58CF-B2D5-765B60254695
code	string	響應狀態代碼。	Ok
message	string	響應訊息，	success
data	object	響應資料。
routeId	string	路由 ID。	hr-cr82undlhtgrlej***

樣本

正常返回樣本

JSON格式

{
  "requestId": "3ACFC7A7-45A9-58CF-B2D5-765B60254695",
  "code": "Ok",
  "message": "success",
  "data": {
    "routeId": "hr-cr82undlhtgrlej***"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。