華為云計算 云知識 按標簽查詢專屬主機列表ListDedicatedHostsByTags
按標簽查詢專屬主機列表ListDedicatedHostsByTags

 

功能介紹

  • 使用標簽過濾 專屬主機 列表,并返回專屬主機使用的所有標簽。
  • 標簽管理服務(TMS)使用該接口過濾專屬主機列表。

調試

您可以在API Explorer中調試該接口。

URI

POST /v1.0/{project_id}/dedicated-host-tags/resource_instances/action

參數說明請參見表1。

表1 參數說明

參數

參數類型

是否必選

描述

project_id

String

項目ID。

請求消息

表2 請求參數

參數

參數類型

是否必選

描述

tags

Array of objects

查詢包含所有指定標簽的專屬主機。更多信息,請參見表3。

  • 最多包含10個key,每個key下面的value最多10個。
  • 結構體不能缺失。
  • key不能為空或者空字符串。
  • key不能重復。
  • 同一個key中value不能重復。

not_tags

Array of objects

查詢不包含所有指定標簽的專屬主機。更多信息,請參見表3。

  • 最多包含10個key,每個key下面的value最多10個。
  • 結構體不能缺失。
  • key不能為空或者空字符串。
  • Key不能重復。
  • 同一個key中value不能重復。

limit

Integer

查詢返回的專屬主機數量限制,最多為1000,不能為負數。

  • 如果action的值為count,此參數無效。
  • 如果action的值為filter,limit默認為1000。

offset

Integer

索引位置,從offset指定的下一條數據開始查詢。必須為數字,不能為負數。

查詢第一頁數據時,不需要傳入此參數。查詢后續(xù)頁碼數據時,將查詢前一頁數據時響應體中的值帶入此參數。

  • 如果action的值為count,此參數無效。
  • 如果action的值為filter,offset默認為0。

action

String

操作標識,包括filter和count兩種。

  • filter:表示按標簽過濾專屬主機,返回符合條件的專屬主機列表。此時,為分頁查詢。
  • count:表示按標簽搜索專屬主機,返回符合條件的專屬主機個數。

tags_any

Array of objects

包含任意標簽。更多信息,請參見表3。

  • 最多包含10個key,每個key下面的value最多10個,每個key對應的value可以為空數組但結構體不能缺失。
  • key不能重復,同一個key中value不能重復。
  • 結果返回包含標簽的資源列表,key之間是“或”的關系,key-value結構中value是“或”的關系。
  • 無過濾條件時返回全量數據。

not_tags_any

Array of objects

不包含任意標簽。更多信息,請參見表3。

  • 最多包含10個key,每個key下面的value最多10個,每個key對應的value可以為空數組但結構體不能缺失。
  • key不能重復,同一個key中value不能重復。
  • 結果返回不包含標簽的資源列表,key之間是“或”的關系,key-value結構中value是或的關系。
  • 無過濾條件時返回全量數據。

matches

Array of objects

搜索字段,用于按條件搜索專屬主機。

當前僅支持按resource_name進行搜索。更多信息,請參見表4。

表3 tag字段數據結構說明

參數

參數類型

是否必選

描述

key

String

鍵。

  • 最大長度127個unicode字符。
  • key不能為空。

values

Array of strings

值列表。

  • 最多10個value。
  • value不允許重復。
  • 每個值最大長度255個unicode字符。
  • 如果value缺失則表示any_value。
  • value之間為“或”的關系。
表4 match字段數據結構說明

參數

參數類型

是否必選

描述

key

String

鍵,表示要匹配的字段。

  • key不能重復,value為匹配的值。
  • 此字段為固定字典值。
  • 不允許為空字符串。
說明:

當前key的參數值僅支持resource_name,此時value的參數值為專屬主機名稱。

value

String

值。

  • 每個值最大長度為255個unicode字符。
  • 不可以為空 。

響應消息

表5 響應參數

參數

參數類型

描述

resources

Array of objects

返回的專屬主機列表,詳情參見表6。

total_count

Integer

總記錄數。

表6 resource字段數據結構說明

參數

參數類型

描述

resource_id

String

專屬主機ID。

resouce_detail

String

專屬主機詳情。

該字段用于后續(xù)擴展,默認為空。

tags

Array of objects

標簽列表。

詳見表表7。

resource_name

String

資源名稱。

表7 tag字段數據結構說明

參數

參數類型

描述

key

String

鍵。

  • 最大長度36個unicode字符。
  • key不能為空。
  • 不能包含以下ASCII非打印字符:“=”,“*”,“<”,“>”,“\”,“|”,“/”,“,”。

value

String

值。

  • 每個值最大長度43個unicode字符。
  • 可以為空字符串。
  • 不能包含以下ASCII非打印字符: “=”,“*”,“<”,“>”,“\”,“|”,“/”,“,”。

請求示例

按標簽查詢專屬主機列表,按標簽過濾專屬主機,從第一條數據開始查詢,搜索名稱為resource1的專屬主機,標簽鍵為key1值為value1。
POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/resource_instances/action 
{ 
    "offset": "0",
    "limit": "100",
    "action": "filter",
    "matches": [
        {
            "key": "resource_name",
            "value": "resource1"
        }
    ],
    "tags": [
        {
            "key": "key1",
            "values": ["value1"]
        }
    ]
}

響應示例

action為filter時的響應體:

{
    "resources": [
        {
            "resource_detail": null,
            "resource_id": "cdfs_cefs_wesas_12_dsad",
            "resource_name": "resource1",
            "tags": [
                {
                    "key": "key1",
                    "value": "value1"
                }
            ]
        }
    ],
    "total_count": 1
}

action為count時的響應體:

{
    "total_count": 100
}

返回值

請參見狀態(tài)碼