调用GetListenerAttribute查询监听属性-负载均衡-阿里云

查询负载均衡实例的监听器详情。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

gwlb:GetListenerAttribute

get

*LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadbalancerId}

*Listener

acs:gwlb:{#regionId}:{#accountId}:listener/{#ListenerId}

无

请求参数

名称	类型	必填	描述	示例值
ListenerId	string	是	监听 ID。	lsn-brx2y3hqdinciz****

返回参数

名称	类型	描述	示例值
	object	请求的返回值。
ListenerDescription	string	自定义监听描述。长度限制为 2~256 个字符，支持中文和英文字母，可包含数字、半角逗号（,）、半角句号（.）、半角分号（;）、正斜线（/）、at（@）、下划线（_）和短划线（-）。	listener_description
ListenerId	string	监听 ID。	lsn-3kbj3587mqhm3p****
ListenerStatus	string	当前监听的状态。取值： Provisioning：创建中。 Running：运行中。 Configuring：配置中。 Deleting：删除中。	Provisioning
LoadBalancerId	string	网关型负载均衡实例 ID。	gwlb-te609d6696632f76****
RegionId	string	网关型负载均衡实例所在的地域 ID。	cn-hangzhou
RequestId	string	请求 ID。	75CC3312-7757-5EE1-90D8-49CEA66608AE
ServerGroupId	string	服务器组 ID。	sgp-sp8d2r6y7t0xtl****
TcpIdleTimeout	integer	TCP 连接空闲超时时间。	350
Tags	array<object>	标签列表。
	object	标签。
Key	string	标签键。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	testKey
Value	string	标签值。最多支持 256 个字符，不能包含`http://`或`https://`。	testValue

示例

正常返回示例

JSON格式

{
  "ListenerDescription": "listener_description",
  "ListenerId": "lsn-3kbj3587mqhm3p****",
  "ListenerStatus": "Provisioning",
  "LoadBalancerId": "gwlb-te609d6696632f76****",
  "RegionId": "cn-hangzhou",
  "RequestId": "75CC3312-7757-5EE1-90D8-49CEA66608AE",
  "ServerGroupId": "sgp-sp8d2r6y7t0xtl****",
  "TcpIdleTimeout": 350,
  "Tags": [
    {
      "Key": "testKey",
      "Value": "testValue"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
404	ResourceNotFound.Listener	The specified resource of %s is not found.	指定的监听资源不存在

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

变更历史

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