功能介紹
查詢監(jiān)聽器列表。
調(diào)用方法
請(qǐng)參見如何調(diào)用API。
URI
GET /v1/listeners
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
分頁查詢每頁的資源個(gè)數(shù)。如果不設(shè)置，則默認(rèn)為500。 最小值：1 最大值：2000 缺省值：500 |
|
marker |
否 |
String |
分頁查詢的起始的資源ID，表示上一頁最后一條查詢資源記錄的ID。不指定時(shí)表示查詢第一頁。 必須與limit一起使用。 最小長(zhǎng)度：1 最大長(zhǎng)度：36 |
|
page_reverse |
否 |
Boolean |
分頁的順序，true表示從后往前分頁，false表示從前往后分頁，默認(rèn)為false。 缺省值：false |
|
id |
否 |
String |
資源ID。 最小長(zhǎng)度：0 最大長(zhǎng)度：36 |
|
name |
否 |
String |
資源名稱，取值范圍：0~64個(gè)字符之間，只能由數(shù)字、字母、中劃線和中文組成。 最小長(zhǎng)度：0 最大長(zhǎng)度：64 |
|
status |
否 |
String |
配置狀態(tài)，可選范圍:
最小長(zhǎng)度：1 最大長(zhǎng)度：10 枚舉值：
|
|
accelerator_id |
否 |
String |
全球加速 器ID。 最小長(zhǎng)度：0 最大長(zhǎng)度：36 |
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值）。 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
listeners |
監(jiān)聽器列表。 |
|
|
page_info |
分頁查詢頁的信息。 |
|
|
request_id |
String |
請(qǐng)求ID。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
監(jiān)聽器ID。 |
|
name |
String |
監(jiān)聽器名稱，取值范圍：1~64個(gè)字符之間，只能由數(shù)字、字母、中劃線和中文組成。 最小長(zhǎng)度：1 最大長(zhǎng)度：64 |
|
description |
String |
監(jiān)聽器的描述信息，取值范圍：0~255個(gè)字符之間，禁止輸入字符：<>。 最小長(zhǎng)度：0 最大長(zhǎng)度：255 |
|
protocol |
String |
監(jiān)聽的網(wǎng)絡(luò)傳輸協(xié)議類型。 枚舉值：
|
|
status |
String |
配置狀態(tài)，取值：
枚舉值：
|
|
port_ranges |
監(jiān)聽端口范圍列表。 數(shù)組長(zhǎng)度：1 - 10 |
|
|
client_affinity |
String |
客戶端親和性，取值：
枚舉值：
|
|
accelerator_id |
String |
全球加速實(shí)例ID。 |
|
created_at |
String |
創(chuàng)建時(shí)間。 |
|
updated_at |
String |
更新時(shí)間。 |
|
domain_id |
String |
租戶ID。 |
|
frozen_info |
云服務(wù)或資源實(shí)例凍結(jié)信息。 |
|
|
tags |
標(biāo)簽列表。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
from_port |
Integer |
起始端口。 最小值：1 最大值：65535 |
|
to_port |
Integer |
結(jié)束端口。 最小值：1 最大值：65535 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
status |
Integer |
云服務(wù)或資源實(shí)例狀態(tài)，取值：
最小值：0 最大值：2 |
|
effect |
Integer |
在凍結(jié)/解凍操作下，取值：
最小值：1 最大值：3 缺省值：1 |
|
scene |
Array of strings |
更新云服務(wù)狀態(tài)的業(yè)務(wù)場(chǎng)景列表，取值：
最大長(zhǎng)度：16 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
key |
String |
標(biāo)簽鍵，規(guī)則：
最小長(zhǎng)度：1 最大長(zhǎng)度：128 |
|
value |
String |
標(biāo)簽值，規(guī)則：
最小長(zhǎng)度：0 最大長(zhǎng)度：255 |
請(qǐng)求示例
查詢監(jiān)聽器列表
GET https://{ga_endpoint}/v1/listeners
響應(yīng)示例
狀態(tài)碼： 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"
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
操作成功 |
錯(cuò)誤碼
請(qǐng)參見錯(cuò)誤碼。
