DescribeApplicationSlbs - Serverless App Engine - Alibaba Cloud Documentation Center

Queries the configurations of Server Load Balancer (SLB) instances for an application.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:DescribeApplicationSlbs

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application.	017f39b8-dfa4-4e16-a84b-1dcee4b1****

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. Valid values: success: The request was successful. An error code: The request failed.	success
TraceId	string	The trace ID of the request. You can use the ID to query the details of a request.	0a98a02315955564772843261e****
Data	object	The data returned.
Intranet	array<object>	The configurations of the internal-facing SLB instance.
	object	The details of the internal-facing SLB instance configuration.
HttpsCertId	string	The ID of the Alibaba Cloud certificate that is used for the HTTPS protocol.	1513561019707729_16f37aae5f3_-375882821_-169099****
Protocol	string	The supported protocol.	TCP
TargetPort	integer	The container port.	8080
Port	integer	The listening port of the SLB instance.	80
HttpsCaCertId	string	The ID of the Alibaba Cloud CA certificate that is used for the HTTPS protocol.	1513561019707729_16f37aae5f3_-375882821_-169099****
StickySession	boolean	Indicates whether session persistence is enabled.	false
StickySessionType	string	The method that is used to handle cookies. Valid values: insert: Inserts a cookie. The load balancer inserts a cookie into the first response from a client. The next request from the client contains this cookie, and the load balancer forwards the request to the same backend server. server: Rewrites a cookie. When the load balancer detects a custom cookie, it rewrites the cookie. The next request from the client contains the new cookie, and the load balancer forwards the request to the same backend server. Note This parameter is required and takes effect only when StickySession is set to true.	insert
CookieTimeout	integer	The timeout period of a cookie. Unit: seconds. Valid values: 1 to 86400. Note This parameter is required and takes effect only when StickySession is set to true and StickySessionType is set to insert.	56
Cookie	string	The cookie that is configured on the server. The cookie must be 1 to 200 characters in length and can contain only ASCII letters and digits. It cannot contain commas (,), semicolons (;), or spaces. It cannot start with a dollar sign ($). Note This parameter is required and takes effect only when StickySession is set to true and StickySessionType is set to server.	wwe
CreateTime	integer	The timestamp when the rule was created.	1741247308294
InternetIp	string	The public IP address of the SLB instance.	59.74..
InternetSlbId	string	The ID of the Internet-facing SLB instance.	lb-uf6xc7wybefehnv45****
Internet	array<object>	The configurations of the Internet-facing SLB instance.
	object	The details of the Internet-facing SLB instance configuration.
HttpsCertId	string	The ID of the Alibaba Cloud certificate that is used for the HTTPS protocol.	1513561019707729_16f37aae5f3_-375882821_-169099****
Protocol	string	The supported protocol.	TCP
TargetPort	integer	The container port.	8080
Port	integer	The listening port of the SLB instance.	80
HttpsCaCertId	string	The ID of the Alibaba Cloud CA certificate that is used for the HTTPS protocol.	1513561019707729_16f37aae5f3_-375882821_-169099****
StickySession	boolean	Indicates whether session persistence is enabled.	false
StickySessionType	string	The method that is used to handle cookies. Valid values: insert: Inserts a cookie. The load balancer inserts a cookie into the first response from a client. The next request from the client contains this cookie, and the load balancer forwards the request to the same backend server. server: Rewrites a cookie. When the load balancer detects a custom cookie, it rewrites the cookie. The next request from the client contains the new cookie, and the load balancer forwards the request to the same backend server. Note This parameter is required and takes effect only when StickySession is set to true.	insert
CookieTimeout	integer	The timeout period of a cookie. Unit: seconds. Valid values: 1 to 86400. Note This parameter is required and takes effect only when StickySession is set to true and StickySessionType is set to insert.	56
Cookie	string	The cookie that is configured on the server. The cookie must be 1 to 200 characters in length and can contain only ASCII letters and digits. It cannot contain commas (,), semicolons (;), or spaces. It cannot start with a dollar sign ($). Note This parameter is required and takes effect only when StickySession is set to true and StickySessionType is set to server.	wwe
CreateTime	integer	The timestamp when the rule was created.	1741247308294
IntranetSlbId	string	The ID of the internal-facing SLB instance.	lb-uf6xc7wybefehnv45****
IntranetIp	string	The private IP address of the SLB instance.	192.168.XX.XX
InternetSlbExpired	boolean	Indicates whether the Internet-facing SLB instance has expired.	false
IntranetSlbExpired	boolean	Indicates whether the private SLB instance has expired.	false
InternetSlbChargeType	string	The billing method of the Internet-facing SLB instance.	PayBySpec
IntranetSlbChargeType	string	The billing method of the internal-facing SLB instance.	PayBySpec
AppId	string
AppName	string
ClusterId	string
ErrorCode	string	The error code. If the request is successful, this parameter is not returned. If the request fails, this parameter is returned. For more information, see the Error codes section in this topic.	空
Code	string	The HTTP status code or a POP error code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: The request was invalid. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the SLB configurations of the application were queried. Valid values: true: The configurations were queried. false: The query failed.	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Intranet": [
      {
        "HttpsCertId": "1513561019707729_16f37aae5f3_-375882821_-169099****",
        "Protocol": "TCP",
        "TargetPort": 8080,
        "Port": 80,
        "HttpsCaCertId": "1513561019707729_16f37aae5f3_-375882821_-169099****",
        "StickySession": false,
        "StickySessionType": "insert",
        "CookieTimeout": 56,
        "Cookie": "wwe",
        "CreateTime": 1741247308294
      }
    ],
    "InternetIp": "59.74.**.**",
    "InternetSlbId": "lb-uf6xc7wybefehnv45****",
    "Internet": [
      {
        "HttpsCertId": "1513561019707729_16f37aae5f3_-375882821_-169099****",
        "Protocol": "TCP",
        "TargetPort": 8080,
        "Port": 80,
        "HttpsCaCertId": "1513561019707729_16f37aae5f3_-375882821_-169099****",
        "StickySession": false,
        "StickySessionType": "insert",
        "CookieTimeout": 56,
        "Cookie": "wwe",
        "CreateTime": 1741247308294
      }
    ],
    "IntranetSlbId": "lb-uf6xc7wybefehnv45****",
    "IntranetIp": "192.168.XX.XX",
    "InternetSlbExpired": false,
    "IntranetSlbExpired": false,
    "InternetSlbChargeType": "PayBySpec",
    "IntranetSlbChargeType": "PayBySpec",
    "AppId": "",
    "AppName": "",
    "ClusterId": ""
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidApplication.NotFound	The current application does not exist.
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.