This operation updates the configuration for Cloud Metrics Reporting.
Request
Syntax
POST <webservice>/CommServ/MetricsReporting HTTP/1.1 Host: <host name> Accept: {application/xml | application/json} Authtoken: <authentication token> Content-type: application/xml <update_cloud_metrics_reporting_template.xml>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
Name |
Description |
Host |
The host name of the Web Server or Web Console used in the API request. |
Accept |
The format of the response. Valid values are: application/xml or application/json. |
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Content-type |
The media type contained in the request body. |
Request Body
Download the XML file required for this request: update_cloud_metrics_reporting_template.xml. The following table displays the parameters for the request body.
Parameter |
Description |
Element |
---|---|---|
commcellDiagUsage |
The option to enable or disable the collection of data for Cloud Metrics Reporting. Valid values are True or False. |
config |
id |
The ID for the type of data to collect. Add a serviceList block for each type of data and use the enable parameter to enable or disable the collection of that data. For example: <serviceList> Valid values are:
|
service |
enabled |
The option to enable or disable the collection of the type of data in the id parameter. Valid values are True or False. |
serviceList |
dataCollectionTime |
The time to collect data from the CommServe database. Valid values are UNIX-style timestamps (seconds since January 1, 1970). For example, if 3:30 p.m. is set as the data collection time, 55800 is the value in the dataCollectionTime parameter. |
config |
clientGroupId |
The system-generated ID assigned to the client computer group. If data is collected for all client computer groups, -1 is the value in the clientGroupId parameter. |
clientGroupList |
clientGroupName |
The client computer group name. If data is collected for all client computer groups, the clientGroupName parameter is not returned. |
clientGroupList |
_type_ |
Valid value is CLIENT_GROUP_ENTITY. |
clientGroupList |
uploadNow |
The option to immediately send current data collection results to the Metrics Reporting Server. Valid values are 0 or 1. |
config |
uploadFrequency |
The number of days between the time that data collection results are uploaded to the Metrics Reporting Server. Valid values are 1 to 7. |
config |
Response
Response Parameters
Parameter |
Description |
Element |
errorCode |
The possible codes. Valid values are:
|
CVGui_GenericResp |
errorMessage |
The description of the error code. Not all error codes have a description. |
CVGui_GenericResp |
Examples
Sample Request
This request disables the collection of the Health Check data.
POST <webservice>/CommServ/MetricsReporting HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<EVGui_SetCommServeSurveyConfigurationReq>
<config>
<commcellDiagUsage>true</commcellDiagUsage>
<cloud>
<serviceList>
<service>
<id>1</id>
</service>
<enabled>false</enabled>
</serviceList>
</cloud>
</config>
</EVGui_SetCommServeSurveyConfigurationReq>
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<CVGui_GenericResp errorCode="0" errorMessage="Success"/>