Sign in
Projects

Summarize deployments in a project

Changed on

Summarizes deployment attempts for one comparable resource pipeline. Success rate uses conclusive outcomes only: active and deleted attempts are successful; failed and degraded attempts are failures; in-progress and superseded attempts are excluded. Median build duration includes completed, non-superseded attempts with recorded build work, including failed builds.

With resource_type=function, pass function_kind to summarize one kind of function only. It is rejected with resource_type=frontend.

get/projects/{id}/deployments/summary

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/deployments/summary
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

Query parameters

searchstring

Restrict the summary to resource names containing this value.

resource_type'function' | 'frontend' required

Restrict the summary to one comparable deployment pipeline.

function_kind'standard' | 'durable'

A function kind to filter a list by. Unlike FunctionKind it has no default: omitting the filter includes both kinds.

Restrict results to functions of one kind. Omit to include both standard and durable functions.

created_afterstring date-time

Restrict results to attempts created at or after this timestamp.

Response

Successful response

deployment_countinteger required

All deployment attempts matching the filters.

successful_countinteger required

Attempts that reached active or deleted.

failed_countinteger required

Attempts that reached failed or degraded.

canceled_countinteger required

Superseded attempts, excluded from success rate and duration.

success_ratenumber double nullable required

Successful attempts divided by successful plus failed attempts.

median_build_duration_secondsnumber double nullable required

Median build duration across eligible completed attempts.

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

    • ○

      added the new optional query request parameter function_kind

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter id

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status