Get Migration Job Stats

Get Migration Job Stats

Fetch the Stats for the migration job associated with given migration job logicalId on this gateway acting as the Blue Gateway

Request
URI
GET
https://{api_host}/api/sdwan/v2/gateways/{gatewayLogicalId}/migrations/{migrationLogicalId}/stats
COPY
Path Parameters
string
gatewayLogicalId
Required

The logicalId GUID of the Gateway

string
migrationLogicalId
Required

The logicalId GUID of the migration job on a Gateway


Responses
200

Request successfully processed

Returns EnterpriseMigrationJobStats of type(s) application/json
{
    "_href": "string",
    "migrationJobLogicalId": "string",
    "migrationStatus": "string",
    "blueGatewayStats": {
        "connectedVceCount": "number",
        "tunnelCount": "number",
        "tunnelCountV6": "number",
        "establishedNsdTunnelCount": "number",
        "flowCount": "number"
    },
    "greenGatewayStats": {
        "connectedVceCount": "number",
        "tunnelCount": "number",
        "tunnelCountV6": "number",
        "establishedNsdTunnelCount": "number",
        "flowCount": "number"
    },
    "impactedEdges": [
        {
            "edgeIdentifier": "number",
            "enterpriseIdentifier": "number",
            "edgeLogicalId": "string",
            "edgeName": "string",
            "edgeLastContact": "string",
            "edgeState": "string",
            "blueGatewayTunnelStatus": "string",
            "greenGatewayTunnelStatus": "string"
        }
    ]
}
string
_href
Optional

_href

string
migrationJobLogicalId
Required

migrationJobLogicalId

string
migrationStatus
Required

migrationStatus

Possible values are : GATEWAY_MIGRATION_STAGE_1, GATEWAY_MIGRATION_FINALIZED, GATEWAY_MIGRATION_ABORTED, GATEWAY_MIGRATION_FAILED, GATEWAY_MIGRATION_COMPLETED,
blueGatewayStats
Required

blueGatewayStats

greenGatewayStats
Required

greenGatewayStats

impactedEdges
Optional

No field or null value means that the migration job has not been started yet. Impacted Edges have not got calculated


401

Unauthorized

Returns UnAuthorized of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


404

Resource not found

Returns ResourceNotFoundError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


429

Rate Limit Exceeded

Returns RateLimitExceededError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


500

Internal server error

Returns InternalServerError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation