尋找計量表服務
本節描述測試控制工具複合的尋找計量表 Web 服務。
FindMeters
此 Web 服務會查詢一或多個計量表的資料存放區。GetMeter 與 FindMeters 之間的差異，在於 GetMeter 最多只能傳回一個計量表，且該計量表必須完全符合您提供的 ID。如果 GetMeter 找不到該 ID，就會擲回錯誤。FindMeters 可傳回多個計量表 (使用正規表示式時)，且在 ID 不符合索引中的任何計量表時，不會擲回錯誤。
輸入 - FindMetersInput
組件：承載
元素：FindMetersRequest
|
參數 |
描述 |
|---|---|
|
id |
要搜尋的計量表 ID |
|
isRegex |
當此參數為 True 時，提供的 ID 可以是正規表示式值。提示：若要搜尋系統中的所有計量表，請使用 ".*" 作為 ID。 |
輸出 - FindMetersOutput
組件：承載
元素：FindMetersResult
可從搜尋傳回零或多個計量表物件
錯誤 - 請參閱 UtilityFault。與其他方法不同，如果找不到計量表，則 FindMeters 不會擲回例外。因此，它可用來在查詢某個「計量表」之前，先測試該計量表是否存在。
IsMeterDefined
此 Web 服務會查詢資料存放區中是否定義特定計量表。
輸入 - IsMeterDefinedInput
組件：承載
元素：IsMeterDefinedRequest
|
參數 |
描述 |
|---|---|
|
id |
要搜尋的計量表 ID |
輸出 - IsMeterDefinedOutput
組件：承載
元素：IsMeterDefinedResult
提供的 ID 是否為索引的一部分。
錯誤 - 請參閱 UtilityFault。找不到計量表 ID 時，就會擲回錯誤。
GetMeter
此 Web 服務會從記憶體內資料存放區傳回單一計量表的所有屬性。GetMeter 與 FindMeters 之間的差異，在於 GetMeter 最多只能傳回一個計量表，且該計量表必須完全符合您提供的 ID。如果 GetMeter 找不到該 ID，就會擲回錯誤。FindMeters 可傳回多個計量表 (使用正規表示式時)，且在 ID 不符合索引中的任何計量表時，不會擲回錯誤。
輸入 - GetMeterInput
組件：承載
元素：GetMeterRequest
|
參數 |
描述 |
|---|---|
|
id |
要搜尋的計量表 ID |
輸出 - GetMeterOutput
組件：承載
元素：GetMeterResult
ID 要求的計量表物件。
錯誤 - 請參閱 UtilityFault。找不到計量表 ID 時，就會擲回錯誤。