Loading...

REST API - GET DR Group Job Statistics

This operation returns the Disaster Recovery (DR) group job statistics.

Request

Syntax

GET <webservice>/DRGroups/JobStats?jobId={jobId}&drGroupId={drGroupId}&replicationId={replicationId}&clientId={clientId} HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>

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 Parameters

Name

Description

Required

jobId

The system-generated ID assigned to the job. To find the value for jobID, send a request without any request parameters, for example, /DRGroups/JobStats.

No

drGroupId

The DR group ID for the DR group. If the DR Group ID is not known, use the use the GET DR Group Properties to retrieve it from the vAppId parameter.

No

replicationId

The system-generated Id for the replication set. If the replication ID is not known, use the GET DR Group Properties to retrieve it.

No

clientId

The system-generated Id assigned to the client. If the client ID is not known, use the GET DR Group Properties to retrieve it.

No

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.

Response

Response Parameters

Parameter

Description

Element

jobId

The ID for the job.

job

replicationId

The system generated Id for the replication set.

job

phase

The phase of the failover job.

phase

status

The status of the failover job phase.

phase

_type_

The type of entity.

Valid value is 55.

startTime

time

Time that the failover job began.

startTime

_type_

The type of entity.

Valid value is 55.

endTime

time

The time that the failover job ended.

endTime

clientId

The system-generated ID assigned to the client.

client

clientName

The name of the client.

client

vAppId

The ID of the vApp.

vapp

Examples

Sample Request

GET <webservice>/DRGroups/JobStats?jobId=2416&drGroupId=38&replicationId=22&clientId=385 HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

JSON

{
  "job": [{
    "jobId": 2416,
    "replicationId": 22,
    "phase": [{
      "phase": 15,
      "status": 0,
      "startTime": {
        "_type_": 55,
        "time": 1502403488
      },
      "endTime": {
        "_type_": 55,
        "time": 1502403488
      }
    }, {
      "phase": 24,
      "status": 0,
      "startTime": {
        "_type_": 55,
        "time": 1502403489
      },
      "endTime": {
        "_type_": 55,
        "time": 1502403509
      }
    }, {
      "phase": 8,
      "status": 0,
      "startTime": {
        "_type_": 55,
        "time": 1502403513
      },
      "endTime": {
        "_type_": 55,
        "time": 1502404130
      }
    }, {
      "phase": 7,
      "status": 1,
      "startTime": {
        "_type_": 55,
        "time": 1502405399
      },
      "endTime": {
        "_type_": 55,
        "time": 1502405709
      }
    }],
    "client": {
      "clientId": 0,
      "clientName": "johndoeVm9"
    },
    "vapp": {
      "vAppId": 1
    }
  }]
}

 

XML

<Api_VirtualAppJobDetailsResp>
    <job jobId="2416" replicationId="22">
     <phase phase="15" status="0">
      <startTime _type_="55" time="1502403488" />
      <endTime _type_="55" time="1502403488" />
     </phase>
     <phase phase="24" status="0">
      <startTime _type_="55" time="1502403489" />
      <endTime _type_="55" time="1502403509" />
     </phase>
     <phase phase="8" status="0">
      <startTime _type_="55" time="1502403513" />
      <endTime _type_="55" time="1502404130" />
     </phase>
     <phase phase="7" status="1">
      <startTime _type_="55" time="1502405399" />
      <endTime _type_="55" time="1502405709" />
     </phase>
     <client clientId="0" clientName="johndoeVm9" />
     <vapp vAppId="1" />
    </job>
</Api_VirtualAppJobDetailsResp>

Last modified: 1/10/2018 5:21:54 PM