Nebula Block
  • Overview
  • Getting Started
    • Quickstart
    • Account Setup
    • Billing Information
    • Deploy Products
  • Core Services
    • Inference Models
      • Text Generation
      • Text Generation (Vision)
      • Image Generation
      • Embedding Generation
      • Model List
    • GPU Instances
      • Quickstart
    • Object Storage
      • Get Started
      • Tutorials
        • Linux/Mac
        • Windows
      • SDK
        • Golang
        • Python
        • Java
    • SSH Keys
      • Quickstart
  • API Reference
    • Platform API
      • Authentication
      • Instances
        • List Products
        • Create GPU Instance
        • List User Instances
        • List Deleted User Instances
        • User Instance Detail
        • Delete GPU Instance
        • Start GPU Instance
        • Stop GPU Instance
        • Reboot GPU Instance
      • SSH Keys
        • List SSH Keys
        • Rename SSH Key
        • Delete SSH Key
      • API Keys
        • List API Keys
        • Delete API Key
      • Billing
        • List Invoices
        • Download Invoice
        • Get Payment History
    • Inference API (OpenAI Compatible)
      • List Models
      • Generate Text
      • Generate Text (Vision)
      • Generate Images
      • Generate Embeddings
  • Team
  • Tier
  • Referral
  • Glossary
  • Contact Us
Powered by GitBook
On this page
  • HTTP Request
  • Path parameters
  • Response Attributes
  • Example
  1. API Reference
  2. Platform API
  3. Instances

User Instance Detail

User Instances Details.

Return instance detail information, like cpu, gpu, ram, total running time and etc.

HTTP Request

GET {API_URL}/computing/instance/{id}

Path parameters

Parameters
Requirements
Type
Description

id

Required

string

The unique identifier of the instance. {id} comes from <List User Instances API>

Response Attributes

data array

An array containing information about products organized by GPU model and region:

  • id string: The unique identifier for the product.

  • region string: The region where the GPU product is available.

  • product_type string: The type of instance,like GPU and CPU.

  • host_name string: The user defined name of the instance.

  • cpu_cores number: The number of CPU cores in the product.

  • ram number: The amount of RAM in gigabytes for the product.

  • gpu string: The GPU model name for the GPU product.

  • gpu_type string: The GPU serial name for the GPU product.

  • gpu_count: The number of GPUs included in the GPU product.

  • disk_size number: The root disk size of the GPU instance in gigabytes.

  • ephemeral number: The ephemeral disk size of the GPU instance in gigabytes.

  • public_ipv4 string: The Public IPv4 address associated with the instance.

  • lan_ipv4 string: The LAN IPv4 address associated with the instance.

  • login_method string: The login method of the instance.

  • os string: The operation system of the instance.

  • exposed_ports string: The exposed ports of the container instance.

  • user_name string: The user name of the container instance.

  • password string: The password of the container instance.

  • status string: The status of the instance.

  • start_time string: The time that instance started.

  • running_time string: The total running time of the instance.

  • total_cost string: The total cost of the instance.

message string

A description of the status of the request.

status string

Indicates the result of the request. success signifies success, while failed indicates an error.

Example

Request

curl -X GET '{API_URL}/computing/instances' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \

Response

{
    "data": [
        {
            "id": "102cade84ea-e703-4400-b77d-8ed545d198ee",
            "region": "CANADA",
            "product_type": "Virtual Machine",
            "host_name": "demo",
            "cpu_cores": "28",
            "ram": "58",
            "gpu_type": "RTX-A6000",
            "gpu_count": 1,
            "disk_size": 100,
            "public_ipv4": "38.80.81.128",
            "login_method": "",
            "os": "Ubuntu Server 20.04 LTS (Focal Fossa)",
            "exposed_ports": "",
            "vm_name": "demo",
            "vm_password": "qZ3!Xukz=I-Xv_ya",
            "status": "Running",
            "start_time": "EST 2024-11-04 10:11:50",
            "running_time": "0.0000 hours",
            "total_cost": "$0.0000"
        }
    ],
    "message": "Get instance detail successfully",
    "status": "success"
}
PreviousList Deleted User InstancesNextDelete GPU Instance

Last updated 6 months ago