華為云計(jì)算 云知識(shí) 按標(biāo)簽查詢彈性公網(wǎng)IP列表ListPublicipsByTags
按標(biāo)簽查詢彈性公網(wǎng)IP列表ListPublicipsByTags

 

功能介紹

使用標(biāo)簽過濾實(shí)例。

調(diào)試

您可以在API Explorer中調(diào)試該接口,支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。

URI

POST /v2.0/{project_id}/publicips/resource_instances/action

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID,獲取項(xiàng)目ID請參見獲取項(xiàng)目ID

請求參數(shù)

表2 請求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

tags

Array of TagReq objects

包含標(biāo)簽,最多包含10個(gè)key。 每個(gè)key下面的value最多10個(gè),結(jié)構(gòu)體不能缺失,key不能為空或者空字符串。 Key不能重復(fù),同一個(gè)key中values不能重復(fù)。

limit

Integer

查詢記錄數(shù)(action為count時(shí)無此參數(shù))如果action為filter默認(rèn)為1000,limit最多為1000,不能為負(fù)數(shù),最小值為1

最小值:1

最大值:1000

offset

Integer

索引位置, 從offset指定的下一條數(shù)據(jù)開始查詢。 查詢第一頁數(shù)據(jù)時(shí),不需要傳入此參數(shù),查詢后續(xù)頁碼數(shù)據(jù)時(shí),將查詢前一頁數(shù)據(jù)時(shí)響應(yīng)體中的值帶入此參數(shù)(action為count時(shí)無此參數(shù))如果action為filter默認(rèn)為0,必須為數(shù)字,不能為負(fù)數(shù)

最小值:0

action

String

操作標(biāo)識(shí)(僅限于filter,count):filter(過濾),count(查詢總條數(shù)) 如果是filter就是分頁查詢,如果是count只需按照條件將總條數(shù)返回即可。

枚舉值:

  • filter

  • count

matches

Array of MatchReq objects

搜索字段,key為要匹配的字段,當(dāng)前僅支持resource_name。value為匹配的值。此字段為固定字典值。

表3 TagReq

參數(shù)

是否必選

參數(shù)類型

描述

key

String

鍵。最大長度127個(gè)unicode字符。 key不能為空。(搜索時(shí)不對(duì)此參數(shù)做校驗(yàn))

最大長度:127

values

Array of strings

值列表。每個(gè)值最大長度255個(gè)unicode字符,如果values為空列表,則表示any_value。value之間為或的關(guān)系。

最大長度:255

表4 MatchReq

參數(shù)

是否必選

參數(shù)類型

描述

key

String

鍵。當(dāng)前僅限定為resource_name

枚舉值:

  • resource_name

value

String

值。每個(gè)值最大長度255個(gè)unicode字符。

最大長度:255

響應(yīng)參數(shù)

狀態(tài)碼: 200

表5 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

resources

Array of ListResourceResp objects

resource對(duì)象列表

total_count

Integer

總記錄數(shù)

表6 ListResourceResp

參數(shù)

參數(shù)類型

描述

resource_detail

Object

資源詳情。 資源對(duì)象,用于擴(kuò)展。默認(rèn)為空

resource_id

String

資源ID

最小長度:0

最大長度:36

resource_name

String

資源名稱,沒有默認(rèn)為空字符串

最小長度:0

最大長度:256

tags

Array of ListResourceTagResp objects

標(biāo)簽列表,沒有標(biāo)簽?zāi)J(rèn)為空數(shù)組

表7 ListResourceTagResp

參數(shù)

參數(shù)類型

描述

key

String

鍵。最大長度127個(gè)unicode字符。 key不能為空。(搜索時(shí)不對(duì)此參數(shù)做校驗(yàn))

最小長度:0

最大長度:36

value

String

值列表。每個(gè)值最大長度255個(gè)unicode字符,如果values為空列表,則表示any_value。value之間為或的關(guān)系。

最小長度:0

最大長度:43

請求示例

  • action為filter時(shí)請求體。

    {
      "offset" : 0,
      "limit" : 100,
      "action" : "filter",
      "matches" : [ {
        "key" : "resource_name",
        "value" : "resource1"
      } ],
      "tags" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      } ]
    }
  • action為count時(shí)請求體。

    {
      "action" : "count",
      "tags" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      }, {
        "key" : "key2",
        "values" : [ "value1", "value2" ]
      } ],
      "matches" : [ {
        "key" : "resource_name",
        "value" : "resource1"
      } ]
    }

響應(yīng)示例

狀態(tài)碼: 200

GET操作正常返回

{
  "total_count" : 1000,
  "resources" : [ {
    "resource_detail" : null,
    "resource_id" : "cdfs_cefs_wesas_12_dsad",
    "resource_name" : "resouece1",
    "tags" : [ {
      "value" : "value1",
      "key" : "key1"
    }, {
      "value" : "value1",
      "key" : "key2"
    } ]
  } ]
}

狀態(tài)碼

狀態(tài)碼

描述

200

GET操作正常返回

錯(cuò)誤碼

請參見錯(cuò)誤碼。