Skip to content

Latest commit

 

History

History
227 lines (145 loc) · 7.93 KB

EnvironmentDeploymentHistoryAPI.md

File metadata and controls

227 lines (145 loc) · 7.93 KB

\EnvironmentDeploymentHistoryAPI

All URIs are relative to https://api.qovery.com

Method HTTP request Description
GenerateDeploymentBuildUsageReport Post /environment/{environmentId}/deploymentBuildUsageReport Generate a Grafana snapshot report showing build runner pod usage for a specific deployment
ListEnvironmentDeploymentHistory Get /environment/{environmentId}/deploymentHistory List environment deployments
ListEnvironmentDeploymentHistoryV2 Get /environment/{environmentId}/deploymentHistoryV2 List environment deployments

GenerateDeploymentBuildUsageReport

DeploymentBuildUsageReportResponse GenerateDeploymentBuildUsageReport(ctx, environmentId).DeploymentBuildUsageReportRequest(deploymentBuildUsageReportRequest).Execute()

Generate a Grafana snapshot report showing build runner pod usage for a specific deployment

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	environmentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment ID
	deploymentBuildUsageReportRequest := *openapiclient.NewDeploymentBuildUsageReportRequest("ExecutionId_example", int32(86400)) // DeploymentBuildUsageReportRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnvironmentDeploymentHistoryAPI.GenerateDeploymentBuildUsageReport(context.Background(), environmentId).DeploymentBuildUsageReportRequest(deploymentBuildUsageReportRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentDeploymentHistoryAPI.GenerateDeploymentBuildUsageReport``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GenerateDeploymentBuildUsageReport`: DeploymentBuildUsageReportResponse
	fmt.Fprintf(os.Stdout, "Response from `EnvironmentDeploymentHistoryAPI.GenerateDeploymentBuildUsageReport`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentId string Environment ID

Other Parameters

Other parameters are passed through a pointer to a apiGenerateDeploymentBuildUsageReportRequest struct via the builder pattern

Name Type Description Notes

deploymentBuildUsageReportRequest | DeploymentBuildUsageReportRequest | |

Return type

DeploymentBuildUsageReportResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListEnvironmentDeploymentHistory

DeploymentHistoryEnvironmentPaginatedResponseList ListEnvironmentDeploymentHistory(ctx, environmentId).StartId(startId).Execute()

List environment deployments

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	environmentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment ID
	startId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Starting point after which to return results (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnvironmentDeploymentHistoryAPI.ListEnvironmentDeploymentHistory(context.Background(), environmentId).StartId(startId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentDeploymentHistoryAPI.ListEnvironmentDeploymentHistory``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListEnvironmentDeploymentHistory`: DeploymentHistoryEnvironmentPaginatedResponseList
	fmt.Fprintf(os.Stdout, "Response from `EnvironmentDeploymentHistoryAPI.ListEnvironmentDeploymentHistory`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentId string Environment ID

Other Parameters

Other parameters are passed through a pointer to a apiListEnvironmentDeploymentHistoryRequest struct via the builder pattern

Name Type Description Notes

startId | string | Starting point after which to return results |

Return type

DeploymentHistoryEnvironmentPaginatedResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListEnvironmentDeploymentHistoryV2

DeploymentHistoryEnvironmentPaginatedResponseListV2 ListEnvironmentDeploymentHistoryV2(ctx, environmentId).PageSize(pageSize).Execute()

List environment deployments

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	environmentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	pageSize := float32(8.14) // float32 | The number of deployments to return in the current page (optional) (default to 20)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnvironmentDeploymentHistoryAPI.ListEnvironmentDeploymentHistoryV2(context.Background(), environmentId).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentDeploymentHistoryAPI.ListEnvironmentDeploymentHistoryV2``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListEnvironmentDeploymentHistoryV2`: DeploymentHistoryEnvironmentPaginatedResponseListV2
	fmt.Fprintf(os.Stdout, "Response from `EnvironmentDeploymentHistoryAPI.ListEnvironmentDeploymentHistoryV2`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentId string

Other Parameters

Other parameters are passed through a pointer to a apiListEnvironmentDeploymentHistoryV2Request struct via the builder pattern

Name Type Description Notes

pageSize | float32 | The number of deployments to return in the current page | [default to 20]

Return type

DeploymentHistoryEnvironmentPaginatedResponseListV2

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]