Query the aggregation progress

Get the progress of an aggregation task

Query the processing progress of a processID

GET /v1/pqscale/tasks/:id

Path Parameters

Name	Type	Description
:id*	String	The processID you get after #request-an-aggregation-task

Headers

Name	Type	Description
Authorization*	String	Your API key

Query the processing progress of a processID

GET /v1/pqscale/tasks/:id

Path Parameters

Name	Type	Description
:id*	String	YHwwXtkAGEzW

Headers

Name	Type	Description
Authorization*	String	8T7YustkAMeE

Request examples

The request examples below are just for reference.

Remember to supply {{BASE_URL}} and{{Your_API_key}} in the corresponding fields.

cURL

curl '{{BASE_URL}}/v1/pqscale/tasks/251953243607818241' \
-H 'Authorization: {{Your_API_key}}'

NodeJS

var https = require('https');
var fs = require('fs');

var options = {
  'method': 'GET',
  'hostname': '{{BASE_URL}}',
  'path': '/v1/pqscale/tasks/253433858211471361',
  'headers': {
    'Authorization': '{{Your_API_key}}'
  }
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

req.end();

Go

package main

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

func main() {

  url := "{{BASE_URL}}/v1/pqscale/tasks/253433858211471361"
  method := "GET"

  client := &http.Client {
    CheckRedirect: func(req *http.Request, via []*http.Request) error {
      return http.ErrUseLastResponse
    },
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "{{Your_API_key}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Rust

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = reqwest::Client::builder()
        .build()?;

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "{{Your_API_key}}".parse()?);

    let request = client.request(reqwest::Method::GET, "{{BASE_URL}}/v1/pqscale/tasks/251962580963188737")
        .headers(headers);

    let response = request.send().await?;
    let body = response.text().await?;

    println!("{}", body);

    Ok(())
}

Python

import requests

url = "{{BASE_URL}}/v1/pqscale/tasks/251962580963188737"

payload = {}
headers = {
  'Authorization': '{{Your_API_key}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Response examples

200: OK Process progress successfully queried

Verifying

{
    "client_id": 228753395643609089,
    "process_id": 232018387302113281,
    "status": "wait for falcon signature verify",
    "batch_size": 128,
    "VCPUs": 48,
    "request_utc_time": "2023-03-17T07:04:22Z",
    "latest_status_update_iso_utc_time": "2023-03-17T07:04:22Z"
}

Processing

{
    "client_id": 228753395643609089,
    "process_id": 232018387302113281,
    "status": "aggregate signature processing",
    "batch_size": 128,
    "VCPUs": 48,
    "request_utc_time": "2023-03-17T07:04:22Z",
    "latest_status_update_iso_utc_time": "2023-03-17T07:04:22Z"
}

Completed

{
    "client_id": 228753395643609089,
    "process_id": 232018387302113281,
    "status": "aggregate signature completed",
    "batch_size": 128,
    "VCPUs": 48,
    "request_utc_time": "2023-03-14T02:12:38Z",
    "result_path": "https://s3.us-west-2.amazonaws.com/pqscale.storage.btq.com/aggsign/invalidated/2023/03/14/228753395643609089/230857807514066945-report.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAXDY3ZRYUJNHCC6YV%2F20230317%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230317T070738Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=6f70ae05c6dc4f1ac495955a5598fd7e3d79f758dad232a3701ee4f18c55651e",
    "latest_status_update_iso_utc_time": "2023-03-14T03:25:38Z"
}

401: Unauthorized Permission denied