控制API要求的輸入變數
建議變更
PDF
您可以透過HTTP要求中設定的參數和變數來控制API呼叫的處理方式。
HTTP方法
下表顯示了由REST API支援的HTTP方法SnapCenter 。
|
並非所有的HTTP方法都可在每個REST端點上使用。 |
| HTTP方法 | 說明 |
|---|---|
取得 |
擷取資源執行個體或集合上的物件屬性。 |
貼文 |
根據提供的輸入建立新的資源執行個體。 |
刪除 |
刪除現有的資源執行個體。 |
放入 |
修改現有的資源執行個體。 |
要求標頭
您應該在HTTP要求中包含多個標頭。
內容類型
如果要求本文包含JSON,則此標頭應設定為_application/json_。
接受
此標頭應設定為_application/json_。
授權
基本驗證應以使用者名稱和密碼編碼為基礎64字串。
申請本文
申請本文的內容會因特定通話而有所不同。HTTP要求本文包含下列其中一項：
-
具有輸入變數的Json物件
-
空白
篩選物件
發出使用Get的API呼叫時、您可以根據任何屬性來限制或篩選傳回的物件。例如、您可以指定要符合的確切值：
<field>=<query value>
除了完全相符的運算子、其他運算子也可傳回一系列值的一組物件。下表所示的靜態API支援篩選運算子。SnapCenter
| 營運者 | 說明 |
|---|---|
= |
等於 |
< |
小於 |
> |
大於 |
&l;= |
小於或等於 |
>= |
大於或等於 |
更新 |
或 |
！ |
不等於 |
* |
貪婪的萬用字元 |
您也可以使用* null 關鍵字或其否定！null *做為查詢的一部分、根據是否設定特定欄位來傳回物件集合。
|
|
任何未設定的欄位通常都會排除在相符查詢之外。 |
要求特定物件欄位
根據預設、使用Get發出API呼叫時、只會傳回唯一識別物件的屬性。這組最小欄位可做為每個物件的金鑰、而且會根據物件類型而有所不同。您可以使用選取其他物件內容 fields 以下列方式查詢參數：
一般或標準欄位
指定*功能變數=*以擷取最常用的物件欄位。這些欄位通常會保留在本機伺服器記憶體中、或只需少量處理即可存取。使用Get搭配URL路徑金鑰（UUID）之後、傳回的物件內容相同。
所有欄位
指定*功能變數=***以擷取所有物件欄位、包括需要額外伺服器處理才能存取的欄位。
自訂欄位選擇
使用* field=<field_name>*來指定所需的確切欄位。要求多個欄位時、必須使用不含空格的逗號分隔值。
|
最佳實務做法是、務必找出您想要的特定欄位。您只能在需要時擷取一組通用欄位或所有欄位。哪些欄位被分類為一般欄位、並使用_Fields =*傳回、由NetApp根據內部效能分析來決定。欄位的分類可能會在未來的版本中變更。 |
排序輸出集中的物件
資源集合中的記錄會以物件定義的預設順序傳回。您可以使用變更訂單 order_by 查詢參數的欄位名稱和排序方向如下：
order_by=<field name> asc|desc
例如、您可以依遞增順序、以遞減順序排序類型欄位、然後依ID排序：
order_by=type desc, id asc
-
如果您指定排序欄位但未提供方向、則會以遞增順序排序這些值。
-
包含多個參數時、您必須以逗號分隔欄位。
擷取集合中的物件時分頁
使用Get存取同一類型物件的集合時發出API呼叫SnapCenter 、根據兩個限制、嘗試傳回盡可能多的物件。您可以使用要求上的其他查詢參數來控制這些限制。針對特定Get要求所達成的第一個限制會終止要求、因此會限制傳回的記錄數目。
|
|
如果要求在重複所有物件之前結束、回應會包含擷取下一批記錄所需的連結。 |
限制物件數量
根據預設、SnapCenter 針對Get要求、最多可傳回10、000個物件。您可以使用_mast_Records_query參數來變更此限制。例如：
max_records=20
實際傳回的物件數目可能會低於有效的最大值、取決於相關的時間限制、以及系統中的物件總數。
限制擷取物件所用的時間
根據預設、SnapCenter 在允許的取得要求時間內、將盡可能多的物件傳回。預設的逾時時間為15秒。您可以使用_reture_timeout_查詢參數來變更此限制。例如：
return_timeout=5
實際傳回的物件數目可能會低於有效的最大值、這是根據物件數目的相關限制、以及系統中的物件總數而定。
縮小結果集
如有需要、您可以將這兩個參數與其他查詢參數結合、以縮小結果集範圍。例如、下列項目最多會傳回指定時間之後產生的10個EMS事件：
time⇒ 2018-04-04T15:41:29.140265Z&max_records=10
您可以針對物件發出多個分頁要求。每次後續的API呼叫都應根據最後結果集中的最新事件、使用新的時間值。
大小屬性
某些API呼叫所使用的輸入值以及某些查詢參數均為數值。您可以選擇使用下表所示的字尾、而不是提供以位元組為單位的整數。
| 後置 | 說明 |
|---|---|
KB |
KB千位元組（1024位元組）或Kibibibyte |
MB |
MB MB（KB x 1024位元組）或百萬位元組 |
GB |
GB GB GB（MB x 1024位元組）或GB |
TB |
TB TB TB（GB x 1024字節）或TB字節 |
PB |
PB PB PB（TB x 1024 bytes）或pibibbytes |