DeployHttpApi - 发布API

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apig:DeployHttpApinone
*HttpApi
acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId}

请求语法

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

请求参数

名称类型必填描述示例值
httpApiIdstring

HTTP API ID。

api-cr68g1dlhtgm31fb***
bodyobject

请求 Body。

routeIdstring

路由 ID。当发布 HTTP API 的路由时候,必须传入。

hr-cr82undlhtgrl***
restApiConfigobject

Rest API 部署配置。当发布 HTTP API 为 Rest API 必填。

revisionIdstring

历史版本号,若指定该字段,发布信息以历史版本信息为准。

apr-xxx
descriptionstring

发布描述。

用户服务API发布。
environmentobject

发布环境配置。

environmentIdstring

环境 ID。

env-cpqnr6tlhtgubc***
customDomainIdsarray

用户域名列表。

string

域名 ID。

d-cr62ts5lhtgln***
backendScenestring

API 发布场景。

枚举值:
  • SingleService单服务
  • MultiServiceByRatio按比例灰度
  • MultiServiceByContent按内容
  • MockMock
SingleService
serviceConfigsarray<object>

已有服务配置,单服务场景下仅允许配置一个条目,按比例、按内容等场景下允许配置多个条目。

object

已有服务配置。

serviceIdstring

服务 ID。

svc-cr6pk4tlhtgm58e***
protocolstring

服务协议:

  • HTTP。
  • HTTPS。
HTTP
portinteger

服务端口, 动态端口不传入。

8080
weightinteger

权重,范围[1,100],仅在按比例场景下有效。

49
versionstring

服务版本。

v1
matchHttpApiBackendMatchConditions

API 发布相关的匹配条件配置。

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID。

0C2D1C68-0D93-5561-8EE6-FDB7BF067A30
codestring

响应状态码。

Ok
messagestring

响应消息。

success

示例

正常返回示例

JSON格式

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

错误码

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