.jpg)
.jpg)
.jpg)
.jpg)
功能介绍
查询监听器列表。
调用方法
请参见如何调用API。
URI
GET /v1/listeners
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
分页查询每页的资源个数。如果不设置，则默认为500。 最小值：1 最大值：2000 缺省值：500 |
|
marker |
否 |
String |
分页查询的起始的资源ID，表示上一页最后一条查询资源记录的ID。不指定时表示查询第一页。 必须与limit一起使用。 最小长度：1 最大长度：36 |
|
page_reverse |
否 |
Boolean |
分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。 缺省值：false |
|
id |
否 |
String |
资源ID。 最小长度：0 最大长度：36 |
|
name |
否 |
String |
资源名称，取值范围：0~64个字符之间，只能由数字、字母、中划线和中文组成。 最小长度：0 最大长度：64 |
|
status |
否 |
String |
配置状态，可选范围:
最小长度：1 最大长度：10 枚举值：
|
|
accelerator_id |
否 |
String |
全球加速 器ID。 最小长度：0 最大长度：36 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
listeners |
监听器列表。 |
|
|
page_info |
分页查询页的信息。 |
|
|
request_id |
String |
请求ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
监听器ID。 |
|
name |
String |
监听器名称，取值范围：1~64个字符之间，只能由数字、字母、中划线和中文组成。 最小长度：1 最大长度：64 |
|
description |
String |
监听器的描述信息，取值范围：0~255个字符之间，禁止输入字符：<>。 最小长度：0 最大长度：255 |
|
protocol |
String |
监听的网络传输协议类型。 枚举值：
|
|
status |
String |
配置状态，取值：
枚举值：
|
|
port_ranges |
监听端口范围列表。 数组长度：1 - 10 |
|
|
client_affinity |
String |
客户端亲和性，取值：
枚举值：
|
|
accelerator_id |
String |
全球加速实例ID。 |
|
created_at |
String |
创建时间。 |
|
updated_at |
String |
更新时间。 |
|
domain_id |
String |
租户ID。 |
|
frozen_info |
云服务或资源实例冻结信息。 |
|
|
tags |
标签列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
from_port |
Integer |
起始端口。 最小值：1 最大值：65535 |
|
to_port |
Integer |
结束端口。 最小值：1 最大值：65535 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
Integer |
云服务或资源实例状态，取值：
最小值：0 最大值：2 |
|
effect |
Integer |
在冻结/解冻操作下，取值：
最小值：1 最大值：3 缺省值：1 |
|
scene |
Array of strings |
更新云服务状态的业务场景列表，取值：
最大长度：16 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
标签键，规则：
最小长度：1 最大长度：128 |
|
value |
String |
标签值，规则：
最小长度：0 最大长度：255 |
请求示例
查询监听器列表
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 |
操作成功 |
错误码
请参见错误码。
