使用DeployHttpApi发布HTTP API和路由-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

发布HTTP API。包括Rest API 和HTTP API里的路由。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:DeployHttpApi

none

*HttpApi

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

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
httpApiId	string	否	HTTP API ID。	api-cr68g1dlhtgm31fb***

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求 Body。
routeId	string	否	路由 ID。当发布 HTTP API 的路由时候，必须传入。	hr-cr82undlhtgrl***
restApiConfig	object	否	Rest API 部署配置。当发布 HTTP API 为 Rest API 必填。
revisionId	string	否	历史版本号，若指定该字段，发布信息以历史版本信息为准。	apr-xxx
description	string	否	发布描述。	用户服务API发布。
environment	object	否	发布环境配置。
environmentId `deprecated`	string	否	环境 ID。	env-cpqnr6tlhtgubc***
customDomainIds	array	否	用户域名列表。
	string	否	域名 ID。	d-cr62ts5lhtgln***
backendScene `deprecated`	string	否	API 发布场景。枚举值： SingleService : 单服务 MultiServiceByRatio : 按比例灰度 MultiServiceByContent : 按内容 Mock : Mock	SingleService
serviceConfigs `deprecated`	array<object>	否	已有服务配置，单服务场景下仅允许配置一个条目，按比例、按内容等场景下允许配置多个条目。
	object	否	已有服务配置。
serviceId	string	否	服务 ID。	svc-cr6pk4tlhtgm58e***
protocol	string	否	服务协议: HTTP。 HTTPS。枚举值： HTTPS : HTTPS HTTP : HTTP	HTTP
port	integer	否	服务端口, 动态端口不传入。	8080
weight	integer	否	权重，范围[1,100]，仅在按比例场景下有效。	49
version	string	否	服务版本。	v1
match	HttpApiBackendMatchConditions	否	API 发布相关的匹配条件配置。	{\"change_order_revision\":\"3.657.33_fc-hz-yunqi.1662568293908382_faas-eerouter\"}
operationIds `deprecated`	array	否	操作 ID
	string	否	参数	xxxxxx
gatewayId	string	否	网关 ID	gw-cvn2u46m1hkun04oll8g
operationDeployments	array<object>	否	Operation 级别的发布控制列表
	object	否	参数
operationId	string	否	Operation 的唯一标识	op-xxx
action	string	否	操作类型	Publish
httpApiConfig `deprecated`	object	否	Http API 部署配置
gatewayId	string	否	网关 ID	gw-csrhgfmm1hknf0hu6o3g
routeIds	array	否	路由 ID
	string	否	参数	xxxxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID。	0C2D1C68-0D93-5561-8EE6-FDB7BF067A30
code	string	响应状态码。	Ok
message	string	响应消息。	success
data	object
httpApiId	string

示例

正常返回示例

JSON格式

{
  "requestId": "0C2D1C68-0D93-5561-8EE6-FDB7BF067A30",
  "code": "Ok",
  "message": "success",
  "data": {
    "httpApiId": ""
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。