further document the api

This commit is contained in:
Minecon724 2024-07-29 11:10:41 +02:00
parent cd2f68df65
commit 3dd96447e9
Signed by: Minecon724
GPG key ID: 3CCC4D267742C8E8

View file

@ -1,67 +1,69 @@
lines starting with with N are not included in code
{
"id": "int",
"bundle_id": "int",
"bw_nvlink": "float",
"compute_cap": "int",
"cpu_arch": "str",
"cpu_cores": "int",
"cpu_cores_effective": "float",
"cpu_name": "str",
"cpu_ram": "int",
"id": "int", // the instance id
N"bundle_id": "int",
N"bw_nvlink": "float",
"compute_cap": "int", // not sure, but related to gpu series
"cpu_arch": "str", // cpu architecture
"cpu_cores": "int", // total cpu cores
"cpu_cores_effective": "float", // available cpu cores on instance
"cpu_name": "str", // the cpu name
"cpu_ram": "int", // memory available on instance in MB
"credit_discount_max": "float",
"cuda_max_good": "float",
"direct_port_count": "int",
"disk_bw": "float",
"disk_name": "str",
"disk_space": "float",
"dlperf": "float",
"dlperf_per_dphtotal": "float",
"dph_base": "float",
"dph_total": "float",
"driver_version": "str",
"duration": "float",
"end_date": "float",
"external": "NoneType",
"flops_per_dphtotal": "float",
"geolocation": "str",
"gpu_display_active": "bool",
"gpu_frac": "float",
"gpu_lanes": "int",
"gpu_mem_bw": "float",
"gpu_name": "str",
"gpu_ram": "int",
"has_avx": "int",
"host_id": "int",
"hosting_type": "int",
"inet_down": "float",
"inet_down_cost": "float",
"inet_up": "float",
"inet_up_cost": "float",
"is_bid": "bool",
"logo": "str",
"machine_id": "int",
"min_bid": "float",
"mobo_name": "str",
"num_gpus": "int",
"os_version": "str",
"pci_gen": "float",
"pcie_bw": "float",
"public_ipaddr": "str",
"rentable": "bool",
"score": "float",
"start_date": "float",
"static_ip": "bool",
"storage_cost": "float",
"storage_total_cost": "float",
"cuda_max_good": "float", // "max cuda" on website
"direct_port_count": "int", // how many open ports
"disk_bw": "float", // disk bandwidth (?) in MB/s
"disk_name": "str", // disk "name" which doesn't always make sense
"disk_space": "float", // available disk space on host
"dlperf": "float", // Deep Learning Performance as on site
N"dlperf_per_dphtotal": "float", // dlperf divided by dph_total
"dph_base": "float", // dollars per hour excluding storage costs
N"dph_total": "float", // dollars per hour including storage costs (storage is set in request)
"driver_version": "str", // self explanatory
N"duration": "float", // the length of time the instance can be rented, in seconds, the site assumes all months have 30 days
"end_date": "float", // when instance will expire as unix timestamp, basically the above
N"external": "bool?", // null if not rented, otherwise not sure but seems always false
N"flops_per_dphtotal": "float", // total_flops divided by dph_total
"geolocation": "str", // formatted as City, CC
N"gpu_display_active": "bool",
"gpu_frac": "float", // percentage of system ram available to instance
"gpu_lanes": "int", // pcie gpu lanes
"gpu_mem_bw": "float", // vram bandwidth in GB/s
"gpu_name": "str", // the gpu name
"gpu_ram": "int", // vram in MB
N"has_avx": "int", // if the cpu has avx which is almost always
"host_id": "int", // host's id
"hosting_type": "int", // 0 normal, 1 datacenter
"inet_down": "float", // download speed in Mbps
"inet_down_cost": "float", // cost of 1 GB of download (on site it shows TB as 1024)
"inet_up": "float", // upload speed in Mbps
"inet_up_cost": "float", // cost of 1 GB of upload (on site it shows TB as 1024)
"is_bid": "bool", // if you're bidding this instance, always false in marketplace (or not?)
N"logo": "str", // the logo, displayed on the website on the left side, it's constant now but I remember it being different for some machines
"machine_id": "int", // self explanatory
"min_bid": "float", // the minimum bid you can make, as dph. website shows more I don't know why
"mobo_name": "str", // motherboard name, like disk name doesn't always make sense
"num_gpus": "int", // self explanatory
N"os_version": "str", // ubuntu version running on the machine
"pci_gen": "float", // pcie version
"pcie_bw": "float", // pcie bandwidth in GB/s
"public_ipaddr": "str", // public ip address of the machine
"rentable": "bool", // is the machine available for rental
N"score": "float",
"start_date": "float", // unix seconds, since when the instance is available for rental (or is rented if rented by you), at least I think because it's recent and unavailable machines don't have that
"static_ip": "bool", // self explanatory but not sure if matters
"storage_cost": "float", // storage cost 1 GB / 30 days (720 hours)
N"storage_total_cost": "float", // cost of storage per hour (size provided in query)
"total_flops": "float",
"verification": "str",
"vram_costperhour": "float",
"webpage": "NoneType",
"reliability2": "float",
"search": "dict",
"instance": "dict",
"time_remaining": "str",
"time_remaining_isbid": "str",
"internet_up_cost_per_tb": "float",
"internet_down_cost_per_tb": "float"
"verification": "str", // verified / unverified / deverified
N"vram_costperhour": "float",
N"webpage": "NoneType",
"reliability2": "float", // reliability of the machine
N"search": "dict", // the cost of the machine with specific parameters, mostly repeating what was already provided and the rest can be calculated
N"instance": "dict",
N"time_remaining": "str",
N"time_remaining_isbid": "str",
N"internet_up_cost_per_tb": "float", // cost of 1 TiB of upload (because inet_down_cost is for 1 GB)
N"internet_down_cost_per_tb": "float" // cost of 1 TiB of download (because inet_down_cost is for 1 GB)
}