DescribeIngress - Serverless App Engine - Alibaba Cloud Documentation Center

Queries the configurations of a routing rule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation does not have operation-specific request headers and uses only common request headers. For more information, see Common request and response headers.

Request syntax

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

Request parameters


Parameter	Type	Position	Required	Example	Description
IngressId	Long	Query	Yes	87	The ID of the routing rule whose configurations you want to query.

Response parameters


Parameter	Type	Example	Description
RequestId	String	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****	The request ID.
Message	String	success	The returned message. Valid values: success: If the call is successful, success is returned. An error code: If the call fails, an error code is returned.
TraceId	String	0a981dd515966966104121683d****	The trace ID that is used to query the details of the request.
Data	Object		The returned result.
SlbId	String	lb-uf62****6d13tq2u5	The ID of the Server Load Balancer (SLB) instance.
NamespaceId	String	cn-beijing:sae-test	The namespace ID.
Description	String	ingress-sae-test	The name of the routing rule.
ListenerPort	Integer	443	The listener port of the SLB instance.
SlbType	String	internet	The type of the SLB instance based on the IP address. Valid values: internet: an Internet-facing SLB instance intranet: an internal-facing SLB instance
CertId	String	13623****809_16cad216b32_845_-419427029	The ID of the certificate that is mounted to the Classic Load Balancer (CLB) instance.
Name	String	lb-uf6jt0nu4z6ior943**-80-f5**	The name of the routing rule.
DefaultRule	Object		The default rule.
ContainerPort	Integer	8080	The container port of the application that is specified in the default rule.
AppName	String	app1	The name of the application that is specified in the default rule.
AppId	String	395b60e4-0550-458d-9c54-a265d036****	The ID of the application that is specified in the default rule.
BackendProtocol	String	http	The backend protocol. Valid values: http: HTTP is suitable for applications that need to identify the transmitted data. https: HTTPS is suitable for applications that require encrypted data transmission. grpc: GRPC is suitable for load balancing scenarios in which you want to deploy services in multi-language frameworks such as the .NET framework. This parameter is returned only if the LoadBalanceType parameter is set to ALB and the ListenerProtocol parameter is set to HTTPS.
Rules	Array of Rule		The forwarding rules.
AppName	String	app1	The name of the application that is specified in the forwarding rule.
ContainerPort	Integer	8080	The container port of the application that is specified in the forwarding rule.
Domain	String	edas.site	The domain name of the application.
AppId	String	395b60e4-0550-458d-9c54-a265d036****	The ID of the application that is specified in the forwarding rule.
Path	String	/path1	The path of the URL.
BackendProtocol	String	http	The backend protocol. Valid values: http: HTTP is suitable for applications that need to identify the transmitted data. https: HTTPS is suitable for applications that require encrypted data transmission. grpc: GRPC is suitable for load balancing scenarios in which you want to deploy services in multi-language frameworks such as the .NET framework. This parameter is returned only if the LoadBalanceType parameter is set to ALB and the ListenerProtocol parameter is set to HTTPS.
RewritePath	String	/${1}	The path that is used to rewrite the original path.
Id	Long	87	The ID of the routing rule.
LoadBalanceType	String	clb	The type of the SLB instance based on the processing capabilities. Valid values: clb: a CLB (formerly SLB) instance alb: an Application Load Balancer (ALB) instance
ListenerProtocol	String	HTTP	The protocol that is used to forward requests. Valid values: HTTP: HTTP is suitable for applications that need to identify the transmitted data. HTTPS: HTTPS is suitable for applications that require encrypted data transmission. This parameter is optional in the CreateIngress and UpadateIngress operations. If you do not configure this parameter when you call the CreateIngress or UpadateIngress operation to create or update a gateway routing rule, this parameter is not returned for the corresponding response.
CertIds	String	87*35-cn-hangzhou,812*3-cn-hangzhou	The IDs of the certificates that are mounted to the ALB instance.
ErrorCode	String	Null	The error code. Valid values: If the call is successful, the ErrorCode parameter is not returned. If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section in this topic.
Code	String	200	The HTTP status code. Valid values: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 5xx: A server error occurred.
Success	Boolean	true	Indicates whether the configurations of the routing rule were queried. Valid values: true: The configurations were queried. false: The configurations failed to be queried.

Examples

Sample requests

GET /pop/v1/sam/ingress/Ingress?IngressId=87 HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

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

<DescribeIngressResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>0a981dd515966966104121683d****</TraceId>
    <Data>
        <SlbId>lb-uf62****6d13tq2u5</SlbId>
        <NamespaceId>cn-beijing:sae-test</NamespaceId>
        <Description>ingress-sae-test</Description>
        <ListenerPort>443</ListenerPort>
        <SlbType>internet</SlbType>
        <CertId>13623****809_16cad216b32_845_-419427029</CertId>
        <Name>lb-uf6jt0nu4z6ior943****-80-f5****</Name>
        <DefaultRule>
            <ContainerPort>8080</ContainerPort>
            <AppName>app1</AppName>
            <AppId>395b60e4-0550-458d-9c54-a265d036****</AppId>
            <BackendProtocol>http</BackendProtocol>
        </DefaultRule>
        <Rules>
            <AppName>app1</AppName>
            <ContainerPort>8080</ContainerPort>
            <Domain>edas.site</Domain>
            <AppId>395b60e4-0550-458d-9c54-a265d036****</AppId>
            <Path>/path1</Path>
            <BackendProtocol>http</BackendProtocol>
            <RewritePath>/${1}</RewritePath>
        </Rules>
        <Id>87</Id>
        <LoadBalanceType>clb</LoadBalanceType>
        <ListenerProtocol>HTTP</ListenerProtocol>
        <CertIds>87***35-cn-hangzhou,812***3-cn-hangzhou</CertIds>
    </Data>
    <ErrorCode>Null</ErrorCode>
    <Code>200</Code>
    <Success>true</Success>
</DescribeIngressResponse>

JSON format

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

{
  "RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message" : "success",
  "TraceId" : "0a981dd515966966104121683d****",
  "Data" : {
    "SlbId" : "lb-uf62****6d13tq2u5",
    "NamespaceId" : "cn-beijing:sae-test",
    "Description" : "ingress-sae-test",
    "ListenerPort" : 443,
    "SlbType" : "internet",
    "CertId" : "13623****809_16cad216b32_845_-419427029",
    "Name" : "lb-uf6jt0nu4z6ior943****-80-f5****",
    "DefaultRule" : {
      "ContainerPort" : 8080,
      "AppName" : "app1",
      "AppId" : "395b60e4-0550-458d-9c54-a265d036****",
      "BackendProtocol" : "http"
    },
    "Rules" : [ {
      "AppName" : "app1",
      "ContainerPort" : 8080,
      "Domain" : "edas.site",
      "AppId" : "395b60e4-0550-458d-9c54-a265d036****",
      "Path" : "/path1",
      "BackendProtocol" : "http",
      "RewritePath" : "/${1}"
    } ],
    "Id" : 87,
    "LoadBalanceType" : "clb",
    "ListenerProtocol" : "HTTP",
    "CertIds" : "87***35-cn-hangzhou,812***3-cn-hangzhou"
  },
  "ErrorCode" : "Null",
  "Code" : "200",
  "Success" : true
}

Error codes


HTTP status code	Error code	Error message	Description
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	The value of the %s parameter is invalid. This parameter cannot be left empty.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	The value of the {%s} parameter is invalid.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	The value %s of the {%s} parameter is invalid.

For a list of error codes, see Service error codes.