Skip to content
API Enriched

GET Upgrade Status.

GET
/api/maurice/namespaces/{namespace}/sites/{name}/upgrade_status
curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/maurice/namespaces/example/sites/example/upgrade_status \
  --header 'Authorization: <Authorization>'

API to GET upgrade status of a site.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Fetch upgrade status for the given namespace.

name
required
string

Name Fetch upgrade status for the name of site.

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
GetUpgradeStatusResponse

Response to GET the upgrade status.

object
upgrade_status
object
sw_upgrade_progress
object
failure_reason

Reason for failure.

string
<= 1024 characters
image_download
object
results

Results of each node in OS Setup.

Array<object>
Install Result

InstallResult shows the result each application/process.

object
message

Message of this stage.

string
<= 1024 characters
name
x-displayName: "Name" Name of this application/process

Human-readable name for the resource

string
>= 6 characters <= 1024 characters
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
type
x-displayName: "Type" Type of upgrade

Type or category classification

string
<= 1024 characters
start_timestamp

Start timestamp of Image download.

string format: date-time
<= 1024 characters
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
node_level_upgrade
object
results
x-displayName: "Results" Results for each stage in site level upgrades

Configuration parameter for results

Array<object>
object
name

Name of node.

string
>= 6 characters <= 1024 characters
progress
object
completed

Number of apps that have been upgraded within a level.

integer format: int32
total

Total number of apps to upgrade.

integer format: int32
results
x-displayName: "Results" Results for each node in node level upgrades

Configuration parameter for results

Array<object>
SiteLevelStageUpgradeResults

SiteLevelStageUpgradeResults shows the upgrade status of each stage and applications within the stage.

object
applications
x-displayName: "Applications" Status of application objects in each application

Configuration parameter for applications

Array<object>
StageApplication

StageApplication shows the upgrade status of each application in either site/node level upgrades.

object
name

Name of stage.

string
>= 6 characters <= 1024 characters
objects
x-displayName: "objects" Status of application objects in each application

Configuration parameter for objects

Array<object>
ApplicationObj

ApplicationObj shows the upgrade status of each object in a application in either site/node level upgrades.

object
conditions
x-displayName: "Conditions" name of object

Configuration parameter for conditions

Array<object>
Condition

Condition of object in each phase of installation.

object
message

Message of action.

string
<= 1024 characters
result

Result of action, i.e. Success etc.

string
<= 1024 characters
type
x-displayName: "Type" Type of action to was applied with object, i.e. load, apply, running, status

Type or category classification

string
<= 1024 characters
debug
x-displayName: "Name" debug? TODO: What is this, reference maurice deployment status object

Configuration parameter for debug

string
<= 1024 characters
deploy_strategy
x-displayName: "Deploy Strategy" Deployment strategy of object

Configuration parameter for deploy strategy

string
<= 1024 characters
kind
x-displayName: "Kind" Kubernetes object kind

Resource type or kind

string
>= 12 characters <= 1024 characters
name
x-displayName: "Name" name of object

Human-readable name for the resource

string
>= 6 characters <= 1024 characters
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
name

Name of stage.

string
>= 6 characters <= 1024 characters
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
start_timestamp

Start timestamp of Image download.

string format: date-time
<= 1024 characters
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
os_setup
object
results

Results of each node in OS Setup.

Array<object>
OSNodeResult

OSNodeResult shows the result of OS upgrade for each node.

object
name

Name of node.

string
>= 6 characters <= 1024 characters
results

Result of each component in each node.

Array<object>
Install Result

InstallResult shows the result each application/process.

object
message

Message of this stage.

string
<= 1024 characters
name
x-displayName: "Name" Name of this application/process

Human-readable name for the resource

string
>= 6 characters <= 1024 characters
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
type
x-displayName: "Type" Type of upgrade

Type or category classification

string
<= 1024 characters
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
start_timestamp

Start timestamp of OS setup.

string format: date-time
<= 1024 characters
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
retries

Number of retries that has been issued.

integer format: int32
site

Site for this upgrade status, assigned after status is assigned to site.

string
<= 1024 characters
site_level_upgrade
object
progress
object
completed

Number of apps that have been upgraded within a level.

integer format: int32
total

Total number of apps to upgrade.

integer format: int32
results
x-displayName: "Results" Results for each stage in site level upgrades

Configuration parameter for results

Array<object>
SiteLevelStageUpgradeResults

SiteLevelStageUpgradeResults shows the upgrade status of each stage and applications within the stage.

object
applications
x-displayName: "Applications" Status of application objects in each application

Configuration parameter for applications

Array<object>
StageApplication

StageApplication shows the upgrade status of each application in either site/node level upgrades.

object
name

Name of stage.

string
>= 6 characters <= 1024 characters
objects
x-displayName: "objects" Status of application objects in each application

Configuration parameter for objects

Array<object>
ApplicationObj

ApplicationObj shows the upgrade status of each object in a application in either site/node level upgrades.

object
conditions
x-displayName: "Conditions" name of object

Configuration parameter for conditions

Array<object>
Condition

Condition of object in each phase of installation.

object
message

Message of action.

string
<= 1024 characters
result

Result of action, i.e. Success etc.

string
<= 1024 characters
type
x-displayName: "Type" Type of action to was applied with object, i.e. load, apply, running, status

Type or category classification

string
<= 1024 characters
debug
x-displayName: "Name" debug? TODO: What is this, reference maurice deployment status object

Configuration parameter for debug

string
<= 1024 characters
deploy_strategy
x-displayName: "Deploy Strategy" Deployment strategy of object

Configuration parameter for deploy strategy

string
<= 1024 characters
kind
x-displayName: "Kind" Kubernetes object kind

Resource type or kind

string
>= 12 characters <= 1024 characters
name
x-displayName: "Name" name of object

Human-readable name for the resource

string
>= 6 characters <= 1024 characters
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
name

Name of stage.

string
>= 6 characters <= 1024 characters
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
start_timestamp

Start timestamp of Image download.

string format: date-time
<= 1024 characters
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
validation
object
results

String of messages from validation stage.

Array<string>
start_timestamp

Start timestamp of Image download.

string format: date-time
<= 1024 characters
status
string
default: UNKNOWN
Allowed values: UNKNOWN SCHEDULED IN_PROGRESS COMPLETED FAILED SKIPPED
version

Version that software is upgrading to.

string
>= 1 characters <= 1024 characters
Example
{
  "upgrade_status": {
    "sw_upgrade_progress": {
      "image_download": {
        "results": [
          {
            "status": "UNKNOWN"
          }
        ],
        "status": "UNKNOWN"
      },
      "node_level_upgrade": {
        "results": [
          {
            "results": [
              {
                "applications": [
                  {
                    "status": "UNKNOWN"
                  }
                ],
                "status": "UNKNOWN"
              }
            ],
            "status": "UNKNOWN"
          }
        ],
        "status": "UNKNOWN"
      },
      "os_setup": {
        "results": [
          {
            "results": [
              {
                "status": "UNKNOWN"
              }
            ],
            "status": "UNKNOWN"
          }
        ],
        "status": "UNKNOWN"
      },
      "site_level_upgrade": {
        "results": [
          {
            "applications": [
              {
                "status": "UNKNOWN"
              }
            ],
            "status": "UNKNOWN"
          }
        ],
        "status": "UNKNOWN"
      },
      "status": "UNKNOWN",
      "validation": {
        "status": "UNKNOWN"
      }
    }
  }
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example