DescribeApplicationNlbs-阿里云帮助中心

View the NLB configuration for the 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:DescribeApplicationNlbs

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	The application ID.	7171a6ca-d1cd-4928-8642-7d5cfe69****

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. A value of `success` indicates a successful request; otherwise, an error code is returned.	success
TraceId	string	The trace ID used to query the details of the request.	ac1a0b2215622246421415014e****
ErrorCode	string	The error code. This parameter is returned only if the request fails. For more information, see the Error codes section of this topic.
Code	string	The HTTP status code. Valid values: 2xx: The request is successful. 3xx: The request is redirected. 4xx: A client error occurred. 5xx: A server error occurred.	200
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Data	object	The data returned in the response.
Instances	object	A collection of instance details.
	object	The details of an instance.
DnsName	string	The DNS name.	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
Listeners	object	A collection of listener details.
	object	The details of a listener.
Protocol	string	The listener protocol.	TCPSSL
Port	integer	The listener port.	80
Status	string	The state of the NLB listener. Valid values: Creating: The listener is being created. Configuring: The listener is being configured. Bounded: The listener is running as expected. Unbinding: The listener is being deleted. Failed: The listener is unavailable.	Bounded
TargetPort	integer	The target port.	8080
CertIds	string	The server certificate ID.	123157******
CreatedBySae	boolean	Indicates whether SAE created the instance. Valid values: true: SAE created the instance. false: SAE reused an existing instance.	true

Examples

Success response

JSON format

{
  "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 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.