API de Planos

Lista os planos do servidor que você pode implementar, com seus recursos e preços. Passar um uuid de plano como plan_uuid quando você cria ou redimensiona um servidor.

Pontos finais 2

Caminho base /api/v1/plans

PEGAR /api/v1/plans/

Listar todos os planos

Devolve cada plano ativo, mais barato primeiro. A lista não tem filtros e atualmente se encaixa em uma página.

Permissão requerida: plans:list

Exemplo de solicitação

cURL

Python

JavaScript

PHP

curl -X GET "https://admin.vps.org/api/v1/plans/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests

url = "https://admin.vps.org/api/v1/plans/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for plan in response.json()["results"]:
    print(plan["uuid"], plan["cpu"], plan["ram"], plan["ram_unit"], plan["monthly_price"])

const response = await fetch('https://admin.vps.org/api/v1/plans/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

$ch = curl_init('https://admin.vps.org/api/v1/plans/');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_API_TOKEN']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$plans = json_decode(curl_exec($ch), true);
curl_close($ch);

Exemplo de resposta

{
  "count": 12,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "ed0ac717-c26c-4d9b-a801-b170c4979028",
      "cpu": 1,
      "ram": 512,
      "ram_unit": "MB",
      "disk_space": 10,
      "disk_space_total": 10240,
      "transfer": 500,
      "transfer_unit": "GB",
      "includes_ipv4": false,
      "price": "2.50",
      "cpu_type_name": "Shared",
      "is_active": true,
      "hourly_price": "0.004",
      "monthly_price": "2.50",
      "is_gpu": false,
      "gpu_count": 0,
      "gpu_model": ""
    },
    {
      "uuid": "14186969-fbaf-43e1-9ab2-b1f1aeb66674",
      "cpu": 1,
      "ram": 2,
      "ram_unit": "GB",
      "disk_space": 25,
      "disk_space_total": 25600,
      "transfer": 1,
      "transfer_unit": "TB",
      "includes_ipv4": true,
      "price": "5.00",
      "cpu_type_name": "Shared",
      "is_active": true,
      "hourly_price": "0.007",
      "monthly_price": "5.00",
      "is_gpu": false,
      "gpu_count": 0,
      "gpu_model": ""
    }
  ]
}

Campos de resposta

Campo	Tipo	Descrição
`uuid`	string	Identificador de plano. Use-o como plan_uuid ou new_plan_uuid.
`cpu`	integer	Número de VCPUs
`ram`, `ram_unit`	integer, string	Montante da memória e sua unidade (MB ou GB)
`disk_space`	integer	Tamanho do disco em GB
`disk_space_total`	integer	Tamanho do disco em MB
`transfer`, `transfer_unit`	integer, string	Cota mensal de transferência de dados e sua unidade (GB ou TB)
`disk_space_unit`	string	Unidade de disco_espaço (GB)
`includes_ipv4`	boolean	Se o plano inclui um endereço IPv4 público. Os planos sem um são apenas IPv6; um endereço IPv4 pode ser adicionado por $2.00/mês.
`monthly_price`, `price`	string	Preço mensal em USD como uma cadeia decimal. o preço é o mesmo valor.
`hourly_price`	string	Preço por hora em USD como uma cadeia decimal
`cpu_type_name`	string	Tipo de CPU, por exemplo Compartilhado. Omitido para planos sem um tipo de CPU, como o plano GPU.
`is_active`	boolean	Sempre verdadeiro nesta lista, porque os planos inativos não são devolvidos
`is_gpu`, `gpu_count`, `gpu_model`	boolean, integer, string	Se o plano inclui GPUs dedicadas, quantos, e que modelo

A resposta não diz se um plano inclui um endereço IPv4. O plano 512 MB é apenas IPv6; os outros planos atual incluem IPv4. Compare com a página de preços antes de escolher um plano para um site que deve ser alcançável em relação ao IPv4.

Códigos de status de resposta

200	Lista de planos recuperados com sucesso
403	Token API faltante ou inválida, ou o token carece da permissão requerida

PEGAR /api/v1/plans/{uuid}/

Veja os detalhes do plano

Devolve um plano ativo com os campos acima. Um uuid inativo ou desconhecido devolve 404.

curl -X GET "https://admin.vps.org/api/v1/plans/ed0ac717-c26c-4d9b-a801-b170c4979028/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "uuid": "ed0ac717-c26c-4d9b-a801-b170c4979028",
  "cpu": 1,
  "ram": 512,
  "ram_unit": "MB",
  "disk_space": 10,
  "disk_space_total": 10240,
  "transfer": 500,
  "transfer_unit": "GB",
  "includes_ipv4": false,
  "price": "2.50",
  "cpu_type_name": "Shared",
  "is_active": true,
  "hourly_price": "0.004",
  "monthly_price": "2.50",
  "is_gpu": false,
  "gpu_count": 0,
  "gpu_model": ""
}