| Read Operations | Description |
|---|---|
|
Returns the info item values for all services resolved in the service filter, given a service filter and a list of desired service info item keys. |
Given a service filter and a list of desired info item keys, this operation returns the info item values for all services resolved in the service filter.
The following table lists and describes all of the child elements of the request node (<GetServiceInfoItemsReq>).
| Element Name | Required | Description |
|---|---|---|
|
ServiceFilter |
Yes |
A filter consisting of one or more of the following: site name (<SiteName>), service name (<ServiceName>), and service type (<ServiceType>). Each item in the filter may contain multiple semicolon-delimited values. |
|
InfoItems |
Yes |
A list of info items to return for all services resolved by ServiceFilter. |
|
<?xml version="1.0"?> <CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730" > <GetServiceInfoItemsReq> <ServiceFilter> <SiteName>CYGDEMO;CYG64</SiteName> <ServiceName></ServiceName> <ServiceType>CVS;ARS</ServiceType> </ServiceFilter> <InfoItems> <InfoItem key="SRVNET_MSGS_IN"></InfoItem> <InfoItem key="SRVNET_MSGS_OUT"></InfoItem> <InfoItem key="SRVNET_IPPORT"></InfoItem> <InfoItem key="SRVNET_CLIENTS_REGED"></InfoItem> </InfoItems> </GetServiceInfoItemsReq> </CygNetEnterpriseOperations> |
The following example represents a successful response.
|
<?xml version="1.0" encoding="UTF-8"?> <CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730"> <GetServiceInfoItemsResp> <InfoItems> <InfoItemResult service="CYG64.ARS"> <InfoItem key="SRVNET_MSGS_IN">15768856</InfoItem> <InfoItem key="SRVNET_MSGS_OUT">15657639</InfoItem> <InfoItem key="SRVNET_IPPORT">5410</InfoItem> <InfoItem key="SRVNET_CLIENTS_REGED">287</InfoItem> </InfoItemResult> <InfoItemResult service="CYG64.HSS"> <InfoItem key="SRVNET_MSGS_IN">6183263</InfoItem> <InfoItem key="SRVNET_MSGS_OUT">6183262</InfoItem> <InfoItem key="SRVNET_IPPORT">6013</InfoItem> <InfoItem key="SRVNET_CLIENTS_REGED">21</InfoItem> </InfoItemResult> <InfoItemResult service="CYG64.OPCIS"> <InfoItem key="SRVNET_MSGS_IN">6183378</InfoItem> <InfoItem key="SRVNET_MSGS_OUT">6183377</InfoItem> <InfoItem key="SRVNET_IPPORT">6017</InfoItem> <InfoItem key="SRVNET_CLIENTS_REGED">21</InfoItem> </InfoItemResult> <InfoItemResult service="CYG64.SVCMON"> <InfoItem key="SRVNET_MSGS_IN">5464424</InfoItem> <InfoItem key="SRVNET_MSGS_OUT">5464423</InfoItem> <InfoItem key="SRVNET_IPPORT">6033</InfoItem> <InfoItem key="SRVNET_CLIENTS_REGED">20</InfoItem> </InfoItemResult> <InfoItemResult service="CYGDEMO.ARS"> <InfoItem key="SRVNET_MSGS_IN">22674124</InfoItem> <InfoItem key="SRVNET_MSGS_OUT">22477131</InfoItem> <InfoItem key="SRVNET_IPPORT">5410</InfoItem> <InfoItem key="SRVNET_CLIENTS_REGED">41</InfoItem> </InfoItemResult> <InfoItemResult service="CYGDEMO.SVCMON"> <InfoItem key="SRVNET_MSGS_IN">1885175</InfoItem> <InfoItem key="SRVNET_MSGS_OUT">1885174</InfoItem> <InfoItem key="SRVNET_IPPORT">6033</InfoItem> <InfoItem key="SRVNET_CLIENTS_REGED">22</InfoItem> </InfoItemResult> </InfoItems> <OperationResults success="true" resp_timestamp="2011-12-10T19:05:52.972Z" exec_duration="PT3.939S" /> </GetServiceInfoItemsResp> </CygNetEnterpriseOperations> |
The following example represents an unsuccessful response.
|
<?xml version="1.0" encoding="UTF-8"?> <CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730"> <GetServiceInfoItemsResp> <InfoItems /> <OperationResults success="false" resp_timestamp="2011-07-30T22:12:10.712Z" exec_duration="PT0.002S"> <OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS0</OperationResult> <OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult> </OperationResults> </GetServiceInfoItemsResp> </CygNetEnterpriseOperations> |
|
|
|
