All Products
Search
Document Center

Serverless App Engine:DescribeApplicationSlbs

Last Updated:Sep 26, 2023

Queries the information about the SLB instances that are associated with an application.

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 uses only common request headers and does not have operation-specific request headers. For more information, see Common request and response headers.

Request syntax

GET /pop/v1/sam/app/slb HTTP/1.1

Request parameters

Parameter

Type

Position

Required

Example

Description

AppId String Query Yes 017f39b8-dfa4-4e16-a84b-1dcee4b1****

The ID of the application whose associated SLB instances 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:

  • If the call is successful, success is returned.
  • If the call fails, an error code is returned.
TraceId String 0a98a02315955564772843261e****

The trace ID that is used to query the details of the request.

Data Object

The returned result.

Intranet Array of Intranet

The configurations of the internal-facing SLB instance.

HttpsCertId String 1513561019707729_16f37aae5f3_-375882821_-169099****

The ID of the SSL certificate issued by Alibaba Cloud.

Protocol String TCP

The supported protocol.

TargetPort Integer 8080

The container port.

Port Integer 80

The listener port of the SLB instance.

InternetIp String 59.74.**.**

The IP address of the Internet-facing SLB instance.

InternetSlbId String lb-uf6xc7wybefehnv45****

The ID of the Internet-facing SLB instance.

Internet Array of Internet

The configurations of Internet-facing SLB instance.

HttpsCertId String 1513561019707729_16f37aae5f3_-375882821_-169099****

The ID of the SSL certificate issued by Alibaba Cloud.

Protocol String TCP

The supported protocol.

TargetPort Integer 8080

The container port.

Port Integer 80

The listener port of the SLB instance.

IntranetSlbId String lb-uf6xc7wybefehnv45****

The ID of the internal-facing SLB instance.

IntranetIp String 192.168.0.0

The IP address of the internal-facing SLB instance.

InternetSlbExpired Boolean false

Indicates whether the Internet-facing SLB instance expires.

IntranetSlbExpired Boolean false

Indicates whether the internal-facing SLB instance expires.

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 information about the SLB instances that are associated with an application was obtained. Valid values:

  • true: The information was obtained.
  • false: The information failed to be obtained.

Examples

Sample requests

GET /pop/v1/sam/app/slb?AppId=017f39b8-dfa4-4e16-a84b-1dcee4b1**** 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

<DescribeApplicationSlbsResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>0a98a02315955564772843261e****</TraceId>
    <Data>
        <Intranet>
            <HttpsCertId>1513561019707729_16f37aae5f3_-375882821_-169099****</HttpsCertId>
            <Protocol>TCP</Protocol>
            <TargetPort>8080</TargetPort>
            <Port>80</Port>
        </Intranet>
        <InternetIp>59.74.**.**</InternetIp>
        <InternetSlbId>lb-uf6xc7wybefehnv45****</InternetSlbId>
        <Internet>
            <HttpsCertId>1513561019707729_16f37aae5f3_-375882821_-169099****</HttpsCertId>
            <Protocol>TCP</Protocol>
            <TargetPort>8080</TargetPort>
            <Port>80</Port>
        </Internet>
        <IntranetSlbId>lb-uf6xc7wybefehnv45****</IntranetSlbId>
        <IntranetIp>192.168.0.0</IntranetIp>
        <InternetSlbExpired>false</InternetSlbExpired>
        <IntranetSlbExpired>false</IntranetSlbExpired>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeApplicationSlbsResponse>

JSON format

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

{
  "RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message" : "success",
  "TraceId" : "0a98a02315955564772843261e****",
  "Data" : {
    "Intranet" : [ {
      "HttpsCertId" : "1513561019707729_16f37aae5f3_-375882821_-169099****",
      "Protocol" : "TCP",
      "TargetPort" : 8080,
      "Port" : 80
    } ],
    "InternetIp" : "59.74.**.**",
    "InternetSlbId" : "lb-uf6xc7wybefehnv45****",
    "Internet" : [ {
      "HttpsCertId" : "1513561019707729_16f37aae5f3_-375882821_-169099****",
      "Protocol" : "TCP",
      "TargetPort" : 8080,
      "Port" : 80
    } ],
    "IntranetSlbId" : "lb-uf6xc7wybefehnv45****",
    "IntranetIp" : "192.168.0.0",
    "InternetSlbExpired" : false,
    "IntranetSlbExpired" : false
  },
  "Code" : "200",
  "Success" : true
}

Error codes

HttpCode

Error code

Error message

Description

400 InvalidApplication.NotFound The current application does not exist. The specified application is not found.
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.