All Products
Search
Document Center

Serverless App Engine:DescribeApplicationNlbs

Last Updated:Dec 17, 2025

Queries the Network Load Balancer (NLB) instances bound to an application and their listeners.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
sae:DescribeApplicationNlbsget
*All Resources
*
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringNo

The ID of the application.

7171a6ca-d1cd-4928-8642-7d5cfe69****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

The message returned. Valid values:If the request was successful, success is returned. If the request failed, an error code is returned.

success
TraceIdstring

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

ac1a0b2215622246421415014e****
ErrorCodestring

The status code. Value values:

  • If the request was successful, ErrorCode is not returned.
  • If the request failed, ErrorCode is returned. For more information, see Error codes section in this topic.
Codestring

The HTTP status code. Valid values:

  • 2xx: The request was successful.
  • 3xx: The request was redirected.
  • 4xx: The request failed.
  • 5xx: A server error occurred.
200
Successstring

Indicates whether the NLB instance was successfully associated with the application. Valid values:

  • true: The application was associated.
  • false: The application failed to be associated.
true
Dataobject

The returned data.

Instancesobject

The details of the instance.

object

The information about the instance.

DnsNamestring

The domain name.

nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
Listenersobject

The listeners.

object

The information about listeners.

Protocolstring

The listener protocol.

TCPSSL
Portinteger

The listener port of the NLB instance.

80
Statusstring

The status of the NLB listener.

  • Creating: The listener is being created.
  • Configuring: The listener is being configured.
  • Bounded: The listener runs as expected.
  • Unbinding: The listener is being deleted.
  • Failed: The listener is unavailable.
Bounded
TargetPortinteger

The open ports of the NLB instance.

8080
CertIdsstring

The server certificates.

123157******
CreatedBySaeboolean

Indicates whether the instance is created by SAE.

  • true: The instance is created by SAE.
  • false: The existing instance is reused.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "ac1a0b2215622246421415014e****",
  "ErrorCode": "",
  "Code": 200,
  "Success": true,
  "Data": {
    "Instances": {
      "key": {
        "DnsName": "nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com",
        "Listeners": {
          "key": {
            "Protocol": "TCPSSL",
            "Port": 80,
            "Status": "Bounded",
            "TargetPort": 8080,
            "CertIds": "123157******"
          }
        },
        "CreatedBySae": true
      }
    }
  }
}

Error codes

HTTP status codeError codeError message
400InvalidApplication.NotFoundThe current application does not exist.
400InvalidParameter.NotEmptyYou must specify the parameter %s.
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.
400InvalidParameter.WithMessageThe parameter is invalid {%s}: %s

For a list of error codes, visit the Service error codes.