CreateIngress - Serverless应用引擎

调试

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

请求头

该接口使用公共请求头，无特殊请求头。更多信息，请参见公共请求和返回头。

请求语法

POST /pop/v1/sam/ingress/Ingress HTTP/1.1

请求参数


名称	类型	位置	是否必选	示例值	描述
NamespaceId	String	Query	是	cn-beijing:sae-test	应用所在命名空间ID，目前不支持跨命名空间的应用。
Description	String	Query	否	ingress-for-sae-test	Ingress描述信息。
SlbId	String	Query	是	lb-uf6hucc7inlqrtcq5****	Ingress所使用的SLB。
ListenerPort	Integer	Query	是	80	SLB监听端口，该端口不能被占用。
CertId	String	Query	否	188077086902**_176993d_181437_108724**	HTTPS监听所使用的SSL证书ID。更多信息，请参见证书概述。
DefaultRule	String	Query	否	{"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080}	默认转发规则。按照IP地址，通过指定端口转发流量到指定应用。参数说明如下： appId：应用ID。 containerPort：应用实例端口。说明所有未匹配或不满足Rules转发规则的请求都会转到该指定应用。
Rules	String	FormData	是	[{"appId":"395b60e4-0550-458d-9c54-a265d036**","containerPort":8080,"domain":"www.sae.site","path":"/path1"},{"appId":"666403ce-d25b-47cf-87fe-497565d2**","containerPort":8080,"domain":"sae.site","path":"/path2"}]	转发规则。按照域名和请求路径，通过指定端口转发流量到指定应用。参数说明如下： appId：应用ID。 containerPort：应用实例端口。 domain：域名。 path：请求路径。

返回数据


名称	类型	示例值	描述
RequestId	String	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****	请求ID。
Message	String	success	调用结果的附加信息。
TraceId	String	0a98a02315955564772843261e****	调用链ID，用于精确查询调用信息。
Data	Object		返回结果。
IngressId	Long	87	路由规则ID。
ErrorCode	String	success	错误码。
Code	String	200	接口状态或POP错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。
Success	Boolean	true	创建路由规则是否成功。取值说明如下： true：表示创建成功。 false：表示创建失败。

示例

请求示例

POST /pop/v1/sam/ingress/Ingress?NamespaceId=cn-beijing:sae-test&Description=ingress-for-sae-test&SlbId=lb-uf6hucc7inlqrtcq5****&ListenerPort=80&CertId=188077086902****_176993d****_181437****_108724****&DefaultRule={"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080} HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Rules=[{"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080,"domain":"www.sae.site","path":"/path1"},{"appId":"666403ce-d25b-47cf-87fe-497565d2****","containerPort":8080,"domain":"sae.site","path":"/path2"}]

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateIngressResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>0a98a02315955564772843261e****</TraceId>
    <Data>
        <IngressId>87</IngressId>
    </Data>
    <ErrorCode>success</ErrorCode>
    <Code>200</Code>
    <Success>true</Success>
</CreateIngressResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message" : "success",
  "TraceId" : "0a98a02315955564772843261e****",
  "Data" : {
    "IngressId" : 87
  },
  "ErrorCode" : "success",
  "Code" : "200",
  "Success" : true
}

错误码


HttpCode	错误码	错误信息	描述
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	不合法的参数：%s不能为空。
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	不合法的参数{%s}。
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	不合法的参数{%s}：%s。
400	Slb.NotFound	The SLB instance does not exist: slbId [%s]	SLB不存在: slbId[%s]
400	Exceed.IngressRule	The number of Ingress related rules must be less than or equal to 40.	Ingress配置对应规则不可超过40条。
400	SlbListenerPort.NotAvailable	The SLB listening port is unavailable: slbId [%s], port [%s]	SLB监听端口被占用: slbId[%s], port[%s]
404	InvalidResponse.Api	The response of API %s is empty.	API返回数据为空。

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