Query Cellular Module Firmware Upgrade Status (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/cellular_module_firmware/status/query

Query the cellular module firmware upgrade status of all tenant elements.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

aggregate Aggregate

The aggregate number of cellular module firmware that match the query parameters.

data AggregateData[]

The details of the aggregate data.

Array [

value number

Value of the aggregate data.

view object

View the aggregate date.

]

field string

Field

name string

The name of the query response.

operator string

Possible values: [max, count, min, avg, sum]

Operator

statistic string

QoS application aggregate statistics.

unit string

The unit.

dest_page int32

The destination page.

getDeleted boolean

The number of cellular module firmware for a time frame.

group_by string[]

Group the cellular module firmware for the query.

id string

Lists the cellular module firmware by ID.

last_query_ts int64

Return the ID of a specified query in the current session.

limit int32

The query limit.

next_query object

The limit.

query_params object
retrieved_fields string[]

Retrieve information from a field.

retrieved_fields_mask boolean

List the fields to query.

sort_params object
total_count int64

The total number of query parameters.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

deleted_count int64

The deleted number.

deleted_ids string[]

The deleted IDs.

description

Description of the query. Max size = 256.

id string

The ID.

next_query object

Details of the next query.

tenant_id string

The tenant ID.

total_count int64

Total number.

items CellularModuleFirmwareStatusQueryFilter[]
Array [
active_image_id string
The active image ID.
active_version string
The active version.
download_interval integer
The download interval.
download_percent integer
The download percent.
element_id string
The element ID.
failure_info string
Detials of the failure information.
id string
The ID.
previous_image_id string
The previous image ID.
rollback_version string
The rollback version.
scheduled_download string
The scheduled download.
scheduled_upgrade string
The scheduled upgrade.
upgrade_image_id string
The upgrade image ID.
upgrade_interval integer
The upgrade interval.
upgrade_state string
Possible values: [pending, init, discovery, download, download_init, download_complete, download_scheduled, download_abort, download_cancelled, download_cancel_pending, upgrade, upgrade_init, upgrade_complete, upgrade_scheduled, upgrade_abort, upgrade_cancelled, upgrade_cancel_pending, upgrade_failed, upgrading, verify, in-progress, install, complete, done, failed, download_discovery, download_failed, downloading, install_failed, installing, verifying, waiting_download_time, waiting_install_time, abort_upgrade_pending, abort_download_pending, invalid]
The upgrade state.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "active_image_id": "string",
      "active_version": "string",
      "download_interval": 0,
      "download_percent": 0,
      "element_id": "string",
      "failure_info": "string",
      "id": "string",
      "previous_image_id": "string",
      "rollback_version": "string",
      "scheduled_download": "string",
      "scheduled_upgrade": "string",
      "upgrade_image_id": "string",
      "upgrade_interval": 0,
      "upgrade_state": "pending"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "BAD_QUERY_REQUEST"
      }
    ]
  }
}

Loading...