文档首页/ 全球加速 GA/ API参考/ API/ 监听器/ 查询监听器列表
更新时间:2024-11-11 GMT+08:00
分享

查询监听器列表

功能介绍

查询监听器列表。

调用方法

请参见如何调用API

URI

GET /v1/listeners

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

分页查询每页的资源个数。如果不设置,则默认为500。

marker

String

分页查询的起始的资源ID,表示上一页最后一条查询资源记录的ID。不指定时表示查询第一页。

必须与limit一起使用。

page_reverse

Boolean

分页的顺序,true表示从后往前分页,false表示从前往后分页,默认为false。

id

String

资源ID。

name

String

资源名称,取值范围:0~64个字符之间,只能由数字、字母、中划线和中文组成。

status

String

配置状态,可选范围:

  • ACTIVE:运行中

  • PENDING:待定

  • ERROR:错误

  • DELETING:正在删除

accelerator_id

String

全球加速器ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

listeners

Array of ListenerDetail objects

监听器列表。

page_info

PageInfo object

分页查询页的信息。

request_id

String

请求ID。

表4 ListenerDetail

参数

参数类型

描述

id

String

监听器ID。

name

String

监听器名称,取值范围:1~64个字符之间,只能由数字、字母、中划线和中文组成。

description

String

监听器的描述信息,取值范围:0~255个字符之间,禁止输入字符:<>。

protocol

String

监听的网络传输协议类型。

status

String

配置状态,取值:

  • ACTIVE:运行中

  • PENDING:待定

  • ERROR:错误

  • DELETING:正在删除

port_ranges

Array of PortRange objects

监听端口范围列表。

client_affinity

String

客户端亲和性,取值:

  • SOURCE_IP:按源IP保持会话。

  • NONE:关闭。

accelerator_id

String

全球加速实例ID。

created_at

String

创建时间。

updated_at

String

更新时间。

domain_id

String

租户ID。

frozen_info

FrozenInfo object

云服务或资源实例冻结信息。

tags

Array of ResourceTag objects

标签列表。

表5 PortRange

参数

参数类型

描述

from_port

Integer

起始端口。

to_port

Integer

结束端口。

表6 FrozenInfo

参数

参数类型

描述

status

Integer

云服务或资源实例状态,取值:

  • 0:解冻/正常(云服务恢复正常)。

  • 1:冻结(资源和数据会保留,但租户无法再正常使用云服务)。

  • 2:删除/终止(资源和数据将清除)。

effect

Integer

在冻结/解冻操作下,取值:

  • 1(默认值):冻结可释放。

  • 2:冻结不可释放。

  • 3:冻结后不可续费。

scene

Array of strings

更新云服务状态的业务场景列表,取值:

  • ARREAR(默认值):欠费场景。为正常的运营业务场景,包括包周期资源到期、按需资源扣费失败。

  • POLICE:公安冻结场景。

  • ILLEGAL:违规冻结场景。

  • VERIFY:客户未实名认证冻结场景。

  • PARTNER:合作伙伴冻结(合作伙伴冻结子客户资源)。

表7 ResourceTag

参数

参数类型

描述

key

String

标签键,规则:

  • 1.key不能为空,长度1~128个字符(中文也可以输入128个字符)。

  • 2.可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符_ . : = + - @。

  • 3._sys_开头属于系统标签,租户不能输入。

value

String

标签值,规则:

  • 1.长度0~255个字符(中文也可以输入255个字符)。

  • 2.可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符_ . : / = + - @。

  • 3.资源标签值可以为空(empty or null)。

表8 PageInfo

参数

参数类型

描述

next_marker

String

下一页的marker,为空时表示最后一页。

current_count

Integer

当前列表中资源数量。

请求示例

查询监听器列表

GET https://{ga_endpoint}/v1/listeners

响应示例

状态码: 200

操作成功

{
  "listeners" : [ {
    "id" : "1b11747a-b139-492f-9692-2df0b1c87193",
    "name" : "listenerName",
    "description" : "listener description",
    "protocol" : "TCP",
    "status" : "ACTIVE",
    "port_ranges" : [ {
      "from_port" : 4000,
      "to_port" : 4200
    } ],
    "client_affinity" : "SOURCE_IP",
    "accelerator_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8",
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "frozen_info" : {
      "status" : 2,
      "effect" : 1,
      "scene" : [ "ARREAR", "POLICE" ]
    },
    "tags" : [ {
      "key" : "tagKey",
      "value" : "tagValue"
    } ]
  } ],
  "page_info" : {
    "next_marker" : "1b11747a-b139-492f-9692-2df0b1c87193",
    "current_count" : 1
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

状态码

状态码

描述

200

操作成功

错误码

请参见错误码

相关文档