Skip to main content

Query Cellular Module Firmware Upgrade Status (v2.0)



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


Path Parameters

    tenant_id stringrequired

    ID of the tenant.


    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 (ref.doc.key:0:Aggregate.field)

    name string

    The name of the query response.

    operator string

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

    Operator (ref.doc.key:0:Aggregate.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.


Successful Operation

    count int32

    The actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.


    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.

  • ]