功能介紹
使用標簽過濾保護實例
接口約束
無
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
POST /v1/{project_id}/protected-instances/resource_instances/action
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
項目ID。 |
請求參數(shù)
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用戶Token。通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值) |
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
tags |
否 |
包含標簽,最多包含10個key,每個key下面的value最多10個,每個key對應(yīng)的value可以為空數(shù)組但結(jié)構(gòu)體不能缺失。Key不能重復(fù),同一個key中values不能重復(fù)。結(jié)果返回包含所有標簽的資源列表,key之間是與的關(guān)系,key-value結(jié)構(gòu)中value是或的關(guān)系。無tag過濾條件時返回全量數(shù)據(jù)。 |
|
tags_any |
否 |
包含任意標簽,最多包含10個key,每個key下面的value最多10個, 每個key對應(yīng)的value可以為空數(shù)組但結(jié)構(gòu)體不能缺失。Key不能重復(fù),同一個key中values不能重復(fù)。結(jié)果返回包含標簽的資源列表,key之間是或的關(guān)系,key-value結(jié)構(gòu)中value是或的關(guān)系。無過濾條件時返回全量數(shù)據(jù)。 |
|
not_tags |
否 |
不包含標簽,最多包含10個key,每個key下面的value最多10個, 每個key對應(yīng)的value可以為空數(shù)組但結(jié)構(gòu)體不能缺失。Key不能重復(fù),同一個key中values不能重復(fù)。結(jié)果返回不包含標簽的資源列表,key之間是與的關(guān)系,key-value結(jié)構(gòu)中value是或的關(guān)系。無過濾條件時返回全量數(shù)據(jù)。 |
|
not_tags_any |
否 |
不包含任意標簽,最多包含10個key,每個key下面的value最多10個, 每個key對應(yīng)的value可以為空數(shù)組但結(jié)構(gòu)體不能缺失。Key不能重復(fù),同一個key中values不能重復(fù)。結(jié)果返回不包含標簽的資源列表,key之間是或的關(guān)系,key-value結(jié)構(gòu)中value是或的關(guān)系。無過濾條件時返回全量數(shù)據(jù)。 |
|
limit |
否 |
String |
查詢記錄數(shù)(action為count時無此參數(shù))如果action為filter默認為1000,limit最多為1000,不能為負數(shù),最小值為1。 |
offset |
否 |
String |
索引位置,偏移量(action為count時無此參數(shù))從第一條數(shù)據(jù)偏移offset條數(shù)據(jù)后開始查詢,如果action為filter默認為0(偏移0條數(shù)據(jù),表示從第一條數(shù)據(jù)開始查詢),必須為數(shù)字,不能為負數(shù)。 |
action |
是 |
String |
操作標識(僅限于filter,count):filter(過濾),count(查詢總條數(shù))。如果是filter就按照過濾條件查詢,如果是count,只需要返回總條數(shù),禁止返回其他字段。 枚舉值:
|
matches |
否 |
搜索字段,key為要匹配的字段,如resource_name等。value為匹配的值。key為固定字典值,不能包含重復(fù)的key或不支持的key。根據(jù)key的值確認是否需要模糊匹配,如resource_name默認為模糊搜索(不區(qū)分大小寫),如果value為空字符串精確匹配。目前只有resource_name,后續(xù)再擴展。 |
響應(yīng)參數(shù)
狀態(tài)碼: 200
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
resources |
返回的保護實例列表。 |
|
total_count |
Integer |
總記錄數(shù)。該值不受過濾條件的影響。 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
resource_id |
String |
保護實例ID。 |
resource_detail |
保護實例詳情。 |
|
tags |
標簽列表,沒有標簽?zāi)J為空數(shù)組。 |
|
resource_name |
String |
保護實例名稱,沒有名稱時默認為空字符串。 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
id |
String |
保護實例的ID。 |
name |
String |
保護實例的名稱。 |
description |
String |
保護實例的描述。 |
status |
String |
保護實例的狀態(tài)。 |
source_server |
String |
生產(chǎn)站點 云服務(wù)器 ID。 |
target_server |
String |
容災(zāi)站點云服務(wù)器ID。 |
server_group_id |
String |
保護組的ID。 |
created_at |
String |
創(chuàng)建時間。默認格式為:"yyyy-MM-dd HH:mm:ss.SSS",例:"2019-04-01 12:00:00.000"。 |
updated_at |
String |
更新時間。默認格式為:"yyyy-MM-dd HH:mm:ss.SSS",例:"2019-04-01 12:00:00.000"。 |
metadata |
保護實例元數(shù)據(jù)信息。 |
|
attachment |
掛載的復(fù)制對列表。 |
|
tags |
標簽列表。 |
|
progress |
Integer |
保護實例的同步進度。單位:百分比(%)。 |
priority_station |
String |
標識保護實例所在保護組的當前生產(chǎn)站點可用區(qū)。source:表示當前生產(chǎn)站點可用區(qū)為保護組source_availability_zone的值。target:表示當前生產(chǎn)站點可用區(qū)為保護組的target_availability_zone的值。 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
__system__frozen |
String |
保護實例元數(shù)據(jù)中資源凍結(jié)的字段。 true:表示資源被凍結(jié)。 空:表示資源沒有被凍結(jié)。 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
replication |
String |
復(fù)制對ID。 |
device |
String |
掛載點。 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
key |
String |
鍵。同一資源的key值不能重復(fù)。最大長度為36個UNICODE字符。key不能為空,不允許為空字符串。不能包含以下字符:非打印字符ASCII(0-31)特殊字符“*”,“<”,“>”,“\”,“=”,“,”,“|”,“/”鍵。不能為空。對于同一資源鍵值唯一。 |
value |
String |
值。最大長度為43個UNICODE字符。value不能為空,可以為空字符串。不能包含以下字符:非打印字符ASCII(0-31)特殊字符“*”,“<”,“>”,“\”,“=”,“,”,“|”,“/”。長度不超過43個字符。 |
狀態(tài)碼: 400
狀態(tài)碼: 401
狀態(tài)碼: 403
狀態(tài)碼: 404
狀態(tài)碼: 500
請求示例
POST https://{Endpoint}/v1/{project_id}/protected-instances/resource_instances/action { "offset" : "100", "limit" : "100", "action" : "filter", "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }
響應(yīng)示例
狀態(tài)碼: 200
OK
{ "resources" : [ { "resource_id" : "d5a00c87-6b82-414a-a09e-59c37fff44d0", "resource_name" : "Protected-Instance-c801", "resource_detail" : { "id" : "d5a00c87-6b82-414a-a09e-59c37fff44d0", "name" : "Protected-Instance-c801", "description" : null, "server_group_id" : "525fbd01-d4d1-44fc-b341-6d734bcce245", "status" : "protected", "progress" : 100, "source_server" : "73aff1d7-48d2-494e-a9f1-a7d3ffad31ff", "target_server" : "0f6bc56b-a3bb-4707-a4fb-ccd4db5fac59", "created_at" : "2019-05-28 08:17:50.066", "updated_at" : "2019-05-30 01:40:00.74", "priority_station" : "source", "attachment" : [ { "replication" : "42e2016e-b96e-4f75-aa57-1377a9cb45e4", "device" : "/dev/vda" } ], "tags" : [ { "key" : "GH1111113fffffKdddddd", "value" : "aaappppppppddddddd" } ], "metadata" : { } }, "tags" : [ { "key" : "GH1111113fffffKdddddd", "value" : "aaappppppppddddddd" } ] } ], "total_count" : 1 }
狀態(tài)碼
狀態(tài)碼 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
錯誤碼
請參見錯誤碼