调用DescribeApplicationNlbs接口获取应用绑定的NLB配置-Serverless 应用引擎-阿里云-Serverless 应用引擎(SAE)-阿里云帮助中心

查看应用绑定的NLB配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sae:DescribeApplicationNlbs

get

*全部资源

*

无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
AppId	string	否	应用 ID。	7171a6ca-d1cd-4928-8642-7d5cfe69****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	附加信息。取值说明如下：请求正常，返回 success。请求异常，返回具体异常错误码。	success
TraceId	string	调用链 ID，用于精确查询调用信息。	ac1a0b2215622246421415014e****
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码目录。
Code	string	HTTP 状态码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	string	绑定是否成功。取值说明如下： true：启动成功。 false：启动失败。	true
Data	object	返回数据。
Instances	object	实例信息。
	object	实例信息
DnsName	string	DNS 域名。	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
Listeners	object	监听信息
	object	监听信息
Protocol	string	监听协议	TCPSSL
Port	integer	负载均衡监听端口	80
Status	string	NLB 监听状态 Creating：监听正在创建中。 Configuring：监听正在配置中。 Bounded：监听已正常运行。 Unbinding：监听正在删除中。 Failed：监听不可用。	Bounded
TargetPort	integer	实例开放端口	8080
CertIds	string	服务器证书	123157******
CreatedBySae	boolean	SAE 代购标识： true：实例由 SAE 代购创建 false：复用已有实例	true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidApplication.NotFound	The current application does not exist.	找不到当前应用。
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	不合法的参数：%s不能为空。
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	不合法的参数{%s}。
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	不合法的参数{%s}：%s。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。