Get cluster analysis

Returns metadata and status for one cluster analysis execution.

GET /clusters/{clusterId}/analysis/{analysisId}

Get cluster analysis

cURL

curl --request GET \
  --url https://api.qovery.com/clusters/{clusterId}/analysis/{analysisId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.qovery.com/clusters/{clusterId}/analysis/{analysisId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.qovery.com/clusters/{clusterId}/analysis/{analysisId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.qovery.com/clusters/{clusterId}/analysis/{analysisId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qovery.com/clusters/{clusterId}/analysis/{analysisId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.qovery.com/clusters/{clusterId}/analysis/{analysisId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/clusters/{clusterId}/analysis/{analysisId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "triggered_by": "<string>",
  "error_message": "<string>"
}

Authorizations

bearerAuthApiKeyAuth

Authorization · string · header · required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

clusterId · string<uuid> · required

Cluster ID

analysisId · string<uuid> · required

Cluster analysis ID

Response

200

application/json

Cluster analysis

id · string<uuid> · required

cluster_id · string<uuid> · required

organization_id · string<uuid> · required

kind · enum<string> · required

Available options: COST_RECOMMENDATION, DEPRECATED_API_CHECK

status · enum<string> · required

Available options: PENDING, RUNNING, SUCCEEDED, FAILED, TERMINATED

output_format · enum<string> · required

Available options: TABLE, JSON, CSV

created_at · string<date-time> · required

updated_at · string<date-time> · required

triggered_by · string · required

error_message · string | null