Documentation | Container As A Service › Containers

Container As A Service

container_as_a_service

Methods

Check Quota For Container Creation -> { baremetal_basic_count_limit, baremetal_basic_count_requested, baremetal_basic_count_usage, 126 more... }

post/v1/caas/{project_id}/{region_id}/check_limits

Check if regional quota is exceeded, if yes the number of additional quotas needed to create the specified cluster will be calculated

Get Caa S Flavors -> { count, results }

get/v1/caas/flavors/{project_id}/{region_id}

Get CaaS flavors

Get Global Quota -> { inference_cpu_millicore_count_limit, inference_cpu_millicore_count_usage, inference_gpu_a100_count_limit, 11 more... }

get/v2/global_quotas/{client_id}

Get global quota

Get A Quota By Region -> { baremetal_basic_count_limit, baremetal_basic_count_usage, baremetal_gpu_count_limit, 84 more... }

get/v2/regional_quotas/{client_id}/{region_id}

Get a quota by region

Container As A Service

Containers

container_as_a_service.containers

Methods

Create Container -> { tasks }

post/v1/caas/{project_id}/{region_id}/containers

Create container

Delete Container -> { tasks }

delete/v1/caas/{project_id}/{region_id}/containers/{container_name}

Delete container

Get Container Logs -> { logs }

get/v1/caas/{project_id}/{region_id}/containers/{container_name}/logs

Get container logs

List Containers -> OffsetPage<{ address, created_at, deploy_status, 17 more... }>

get/v1/caas/{project_id}/{region_id}/containers

List containers

Get Container -> { address, created_at, deploy_status, 17 more... }

get/v1/caas/{project_id}/{region_id}/containers/{container_name}

Get container

Parameters

project_id: number

Project id

region_id: number

Region id

container_name: string

Container name

Response fields

address: string

Container address

created_at: string

(format: date-time)

Container creation date

deploy_status: { ready, total }

Container deploy status

description: string

Container description

envs: unknown

Container environment variables

flavor: string

Container flavor

image: string

Container image

is_api_key_auth: boolean

Enable/Disable api key authentication

is_disabled: boolean

Set to true if container is disabled

listening_port: number

Container listening port

name: string

Container name

namespace: string

Container namespace

pull_secret: string

Image pull secret

scale: { max, min, cooldown_period, 1 more... }

Container autoscaling

source: string

Source of the container, can be 'cloud' or 'iate'

status: string

Container status

status_message: string

Container status message

timeout: number

Container timeout in seconds

commands: string

Optional

Container's commands

logging: { destination_region_id, enabled, retention_policy, 1 more... }

Optional

Logging configuration

Request example

curl https://api.gcore.com/cloud/v1/caas/$PROJECT_ID/$REGION_ID/containers/$CONTAINER_NAME \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "address": "some.example.com",
  "created_at": "2021-01-01T00:00:00Z",
  "deploy_status": {
    "ready": 1,
    "total": 2
  },
  "description": "My first container",
  "envs": {
    "ENVIRONMENT_VARIABLE": "value 2",
    "ENV_VAR": "value 1"
  },
  "flavor": "250mCPU-512MiB",
  "image": "nginx:latest",
  "is_api_key_auth": false,
  "is_disabled": false,
  "listening_port": 80,
  "name": "nginx",
  "namespace": "default",
  "pull_secret": "my-secret",
  "scale": {
    "max": 2,
    "min": 1,
    "cooldown_period": 1,
    "triggers": {
      "cpu": {
        "threshold": 1
      },
      "http": {
        "rate": 1,
        "window": 1
      },
      "memory": {
        "threshold": 1
      }
    }
  },
  "source": "cloud",
  "status": "RUNNING",
  "status_message": "Some container status",
  "timeout": 5,
  "commands": "python3 app.py -m test",
  "logging": {
    "destination_region_id": 1,
    "enabled": true,
    "retention_policy": {
      "period": 45
    },
    "topic_name": "some-topic"
  }
}