DescribeApplicationSlbs - 获取应用SLB配置信息

获取应用SLB配置信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sae:DescribeApplicationSlbsget
  • 全部资源
    *

请求语法

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

请求参数

名称类型必填描述示例值
AppIdstring

目标应用 ID。

017f39b8-dfa4-4e16-a84b-1dcee4b1****

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

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

附加信息。取值说明如下:

  • 请求正常,返回 success
  • 请求异常,返回具体异常错误码。
success
TraceIdstring

调用链 ID,用于精确查询调用信息。

0a98a02315955564772843261e****
Dataobject

返回结果。

Intranetarray<object>

内网 SLB 配置。

Intranetobject

内网 SLB 配置详情。

HttpsCertIdstring

HTTPS 协议对应的阿里云证书 ID。

1513561019707729_16f37aae5f3_-375882821_-169099****
Protocolstring

支持的协议。

TCP
TargetPortinteger

容器端口。

8080
Portinteger

SLB 监听端口。

80
HttpsCaCertIdstring

HTTPS 协议对应的阿里云 CA 证书 ID。

1513561019707729_16f37aae5f3_-375882821_-169099****
StickySessionboolean

是否开启会话保持。

false
StickySessionTypestring

Cookie 处理方式。取值:

  • insert:植入 Cookie。客户端第一次访问时,负载均衡会在返回请求中植入 Cookie,下次客户端携带此 Cookie 访问,负载均衡服务会将请求定向转发给之前记录到的后端服务器上。

  • server:重写 Cookie。负载均衡发现用户自定义了 Cookie,将会对原来的 Cookie 进行重写,下次客户端携带新的 Cookie 访问,负载均衡服务会将请求定向转发给之前记录到的后端服务器。

说明 StickySession 值为 on 时,该参数必选且有效。
insert
CookieTimeoutinteger

Cookie 超时时间。单位:秒。取值范围:1~86400

说明 StickySessiononStickySessionTypeinsert 时,该参数必选且有效。
56
Cookiestring

服务器上配置的 Cookie。

长度为 1~200 个字符,只能包含 ASCII 英文字母和数字字符,不能包含半角逗号(,)、半角分号(;)或空格,不能以$开头。

说明 StickySessiononStickySessionTypeserver 时,该参数必选且有效。
wwe
InternetIpstring

公网 SLB 地址。

59.74.**.**
InternetSlbIdstring

公网 SLB ID。

lb-uf6xc7wybefehnv45****
Internetarray<object>

公网 SLB 配置。

Internetobject

公网 SLB 配置详情。

HttpsCertIdstring

HTTPS 协议对应的阿里云证书 ID。

1513561019707729_16f37aae5f3_-375882821_-169099****
Protocolstring

支持的协议。

TCP
TargetPortinteger

容器端口。

8080
Portinteger

SLB 监听端口。

80
HttpsCaCertIdstring

HTTPS 协议对应的阿里云 CA 证书 ID。

1513561019707729_16f37aae5f3_-375882821_-169099****
StickySessionboolean

是否开启会话保持。

false
StickySessionTypestring

Cookie 处理方式。取值:

  • insert:植入 Cookie。客户端第一次访问时,负载均衡会在返回请求中植入 Cookie,下次客户端携带此 Cookie 访问,负载均衡服务会将请求定向转发给之前记录到的后端服务器上。

  • server:重写 Cookie。负载均衡发现用户自定义了 Cookie,将会对原来的 Cookie 进行重写,下次客户端携带新的 Cookie 访问,负载均衡服务会将请求定向转发给之前记录到的后端服务器。

说明 StickySession 值为 on 时,该参数必选且有效。
insert
CookieTimeoutinteger

Cookie 超时时间。单位:秒。取值范围:1~86400

说明 StickySessiononStickySessionTypeinsert 时,该参数必选且有效。
56
Cookiestring

服务器上配置的 Cookie。

长度为 1~200 个字符,只能包含 ASCII 英文字母和数字字符,不能包含半角逗号(,)、半角分号(;)或空格,不能以$开头。

说明 StickySessiononStickySessionTypeserver 时,该参数必选且有效。
wwe
IntranetSlbIdstring

内网 SLB ID。

lb-uf6xc7wybefehnv45****
IntranetIpstring

内网 SLB 地址。

192.168.XX.XX
InternetSlbExpiredboolean

公网 SLB 是否已过期。

false
IntranetSlbExpiredboolean

私网 SLB 是否已过期。

false
InternetSlbChargeTypestring

公网负载均衡的计费方式。

PayBySpec
IntranetSlbChargeTypestring

内网负载均衡的计费方式。

PayBySpec
ErrorCodestring

错误码。取值说明如下:

  • 请求成功:不返回 ErrorCode 字段。
  • 请求失败:返回 ErrorCode 字段。具体信息,请参见本文的错误码列表。
Codestring

接口状态或 POP 错误码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
200
Successboolean

获取应用 SLB 配置信息是否成功。取值说明如下:

  • true:获取成功。

  • false:获取失败。

true

示例

正常返回示例

JSON格式

{
  "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"
      }
    ],
    "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"
      }
    ],
    "IntranetSlbId": "lb-uf6xc7wybefehnv45****",
    "IntranetIp": "192.168.XX.XX",
    "InternetSlbExpired": false,
    "IntranetSlbExpired": false,
    "InternetSlbChargeType": "PayBySpec",
    "IntranetSlbChargeType": "PayBySpec"
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-08-07OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-06-18OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-05-30OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情