Get service

Get service details

GET /api/v1/services/{serviceName}

cURL

cURL

curl --request GET \
  --url https://api.staging.qyl.dev/api/v1/services/{serviceName}

import requests

url = "https://api.staging.qyl.dev/api/v1/services/{serviceName}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.staging.qyl.dev/api/v1/services/{serviceName}', 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.staging.qyl.dev/api/v1/services/{serviceName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.staging.qyl.dev/api/v1/services/{serviceName}"

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

	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.staging.qyl.dev/api/v1/services/{serviceName}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.staging.qyl.dev/api/v1/services/{serviceName}")

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

request = Net::HTTP::Get.new(url)

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

200

{
  "name": "<string>",
  "instance_count": 123,
  "last_seen": "2023-11-07T05:31:56Z",
  "resource_attributes": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "instrumentation_libraries": [
    {
      "name": "<string>",
      "version": "2.1.0",
      "attributes": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "dropped_attributes_count": 1
    }
  ],
  "request_rate": 123,
  "error_rate": 0.5,
  "avg_latency_ms": 123,
  "p99_latency_ms": 123,
  "namespace_name": "<string>",
  "version": "2.1.0"
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "resource_type": "<string>",
  "resource_id": "<string>"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "error_code": "<string>"
}

Path Parameters

serviceName · string · required

Response

200

application/json

The request has succeeded.

Service details

name · string · required

Service name

instance_count · integer<int32> · required

Instance count

last_seen · string<date-time> · required

Last seen

resource_attributes · object[] · required

Resource attributes

Show child attributes

instrumentation_libraries · object[] · required

Instrumentation libraries

Show child attributes

request_rate · number<double> · required

Request rate (per second)

error_rate · number<double> · required

Error rate

Required range: 0 <= x <= 1

avg_latency_ms · number<double> · required

Average latency in milliseconds

p99_latency_ms · number<double> · required

P99 latency in milliseconds

namespace_name · string

Service namespace

version · string

Service version

Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

Example:

"2.1.0"