Get cloud provider details :: TigerGraph Savanna

Returns a single Bring Your Own Cloud (BYOC) provider, including its status, the AWS resources Savanna created in your account, and its component versions.

GET /controller/v4/v2/cloud-providers/{cloudProviderID}

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

Path parameters

# cloudProviderID string path required

Cloud Provider ID

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

api_tokensstring[]

API tokens associated with the cloud provider.

availability_zonesstring[]

Availability zones configured for the cloud provider.

cluster_enabled_log_typesstring[]

Kubernetes control-plane log types enabled for the provider.

Available options: api, audit, authenticator, controllerManager, scheduler

component_versionsstring

Versions of the components installed for the provider.

created_atstring

Time the cloud provider was created.

created_bystring

User who created the cloud provider.

eks_idstring

Identifier of the Amazon EKS cluster.

endpoint_service_namestring

Name of the private endpoint service.

idstring

Unique identifier of the cloud provider.

last_errorstring

Most recent error reported while provisioning or updating the provider.

namestring

Name of the cloud provider.

node_group_configobject

Configuration of the Kubernetes node groups.

Show child attributes Hide child attributes

ng_16object

Configuration of the 16-unit node group.

Show child attributes Hide child attributes

max_sizeinteger

Maximum number of nodes in the group.

min_sizeinteger

Minimum number of nodes in the group.

overprovisioning_factorinteger

Additional capacity factor reserved above the requested workload.

ng_32object

Configuration of the 32-unit node group.

Show child attributes Hide child attributes

max_sizeinteger

Maximum number of nodes in the group.

min_sizeinteger

Minimum number of nodes in the group.

overprovisioning_factorinteger

Additional capacity factor reserved above the requested workload.

ng_48object

Configuration of the 48-unit node group.

Show child attributes Hide child attributes

max_sizeinteger

Maximum number of nodes in the group.

min_sizeinteger

Minimum number of nodes in the group.

overprovisioning_factorinteger

Additional capacity factor reserved above the requested workload.

ng_64object

Configuration of the 64-unit node group.

Show child attributes Hide child attributes

max_sizeinteger

Maximum number of nodes in the group.

min_sizeinteger

Minimum number of nodes in the group.

overprovisioning_factorinteger

Additional capacity factor reserved above the requested workload.

ng_systemobject

Configuration of the system node group.

Show child attributes Hide child attributes

max_sizeinteger

Maximum number of nodes in the group.

min_sizeinteger

Minimum number of nodes in the group.

overprovisioning_factorinteger

Additional capacity factor reserved above the requested workload.

prefetch_image_liststring[]

Container images to prefetch onto the nodes.

optionsobject

Additional cloud-provider configuration options.

Show child attributes Hide child attributes

account_idstring

Cloud account identifier associated with the provider.

secure_connectionboolean

Whether the provider uses a private, secure connection.

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.

role_arnstring

Amazon Resource Name of the IAM role TigerGraph assumes.

role_external_idstring

External identifier used when TigerGraph assumes the IAM role.

security_group_idstring

Identifier of the network security group.

short_idstring

Short identifier of the cloud provider.

statusstring

Current status of the cloud provider.

subnet_idstring[]

Identifiers of the subnets used by the provider.

typestring

Access type of the cloud provider.

updated_atstring

Time the cloud provider was last updated.

versionstring

Version of the cloud provider deployment.

version_numberinteger

Internal version number of the cloud provider record.

vpc_idstring

Identifier of the virtual private cloud.

vpc_owned_by_tgboolean

Whether TigerGraph owns and manages the virtual private cloud.

work_dirstring

Working directory used while provisioning the provider.

Get cloud provider details

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

import requests

url = "https://api.tgcloud.io/controller/v4/v2/cloud-providers/{cloudProviderID}"
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/{cloudProviderID}",
  {
    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/{cloudProviderID}"
);
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/{cloudProviderID}",
  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/{cloudProviderID}"
  ))
  .header("x-api-key", "<your-api-key>")
  .GET()
  .build();

uri = URI(
  "https://api.tgcloud.io/controller/v4/v2/cloud-providers/{cloudProviderID}"
)
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": {
    "api_tokens": [
      "<string>"
    ],
    "availability_zones": [
      "<string>"
    ],
    "cluster_enabled_log_types": [
      "api"
    ],
    "component_versions": "<string>",
    "created_at": "<string>",
    "created_by": "<string>",
    "eks_id": "<string>",
    "endpoint_service_name": "<string>",
    "id": "<string>",
    "last_error": "<string>",
    "name": "<string>",
    "node_group_config": {
      "ng_16": {
        "max_size": 0,
        "min_size": 0,
        "overprovisioning_factor": 0
      },
      "ng_32": {
        "max_size": 0,
        "min_size": 0,
        "overprovisioning_factor": 0
      },
      "ng_48": {
        "max_size": 0,
        "min_size": 0,
        "overprovisioning_factor": 0
      },
      "ng_64": {
        "max_size": 0,
        "min_size": 0,
        "overprovisioning_factor": 0
      },
      "ng_system": {
        "max_size": 0,
        "min_size": 0,
        "overprovisioning_factor": 0
      },
      "prefetch_image_list": [
        "<string>"
      ]
    },
    "options": {
      "account_id": "<string>",
      "secure_connection": false
    },
    "org_id": "<string>",
    "platform": "<string>",
    "region": "<string>",
    "role_arn": "<string>",
    "role_external_id": "<string>",
    "security_group_id": "<string>",
    "short_id": "<string>",
    "status": "<string>",
    "subnet_id": [
      "<string>"
    ],
    "type": "<string>",
    "updated_at": "<string>",
    "version": "<string>",
    "version_number": 0,
    "vpc_id": "<string>",
    "vpc_owned_by_tg": false,
    "work_dir": "<string>"
  }
}