List public cloud providers :: TigerGraph Savanna

Lists the cloud providers TigerGraph operates. Use an id from this list as the cloud_provider_id when you create a workgroup.

GET /controller/v4/v2/cloud-providers/public

Authorizations

x-api-key string header required

Authorization for TigerGraph Savanna. Send the key in the x-api-key request header.

Create an API key

Response

200 application/json

# Error boolean

Indicates whether the request returned an error.

# ErrorDetails object[]

Details about each error returned by the request.

Show child attributes Hide child attributes

FieldNamestring

Field associated with the error.

Reasonstring

Explanation of why the error occurred.

Typestring

Category of the error.

Available options: Internal-Error, Bad-Request, Not-Found, Forbidden, Unauthorized, API-Disabled, Quota-Exceed, Unknown

# Message string

Human-readable summary of the request result.

# RequestID string

Unique identifier for tracing the request.

# Result object[]

Payload returned by the request.

Show child attributes Hide child attributes

component_versionsstring

Versions of the components installed for the provider.

idstring

Unique identifier of the public cloud provider.

namestring

Name of the public cloud provider.

org_idstring

Unique identifier of the organization that owns the provider.

platformstring

Cloud platform that hosts the provider.

regionstring

Cloud region that hosts the provider.

statusstring

Current status of the public cloud provider.

versionstring

Version of the cloud provider deployment.

version_numberinteger

Internal version number of the cloud provider record.

List public cloud providers

curl --request GET \
  --url 'https://api.tgcloud.io/controller/v4/v2/cloud-providers/public' \
  --header 'x-api-key: <your-api-key>'

import requests

url = "https://api.tgcloud.io/controller/v4/v2/cloud-providers/public"
headers = {"x-api-key": "<your-api-key>"}
response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/public",
  {
    method: "GET",
    headers: { "x-api-key": "<your-api-key>" },
  }
)
console.log(await response.json())

<?php
$request = curl_init(
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/public"
);
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($request, CURLOPT_HTTPHEADER, [
  "x-api-key: <your-api-key>"
]);
curl_exec($request);

request, _ := http.NewRequest(
  "GET",
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/public",
  nil,
)
request.Header.Add("x-api-key", "<your-api-key>")
response, _ := http.DefaultClient.Do(request)

HttpRequest request = HttpRequest.newBuilder()
  .uri(URI.create(
    "https://api.tgcloud.io/controller/v4/v2/cloud-providers/public"
  ))
  .header("x-api-key", "<your-api-key>")
  .GET()
  .build();

uri = URI(
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/public"
)
request = Net::HTTP::Get.new(uri)
request["x-api-key"] = "<your-api-key>"
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) {
  |http| http.request(request)
}

{
  "Error": false,
  "ErrorDetails": [],
  "Message": "<string>",
  "RequestID": "<string>",
  "Result": [
    {
      "component_versions": "<string>",
      "id": "<string>",
      "name": "<string>",
      "org_id": "<string>",
      "platform": "<string>",
      "region": "<string>",
      "status": "<string>",
      "version": "<string>",
      "version_number": 0
    }
  ]
}