Interface Container

interface Container {
    cpuLimit: number;
    createdAt?: Date;
    description?: string;
    domainName: string;
    environmentVariables: Record<string, string>;
    errorMessage?: string;
    healthCheck?: Container.v1beta1.ContainerHealthCheckSpec;
    httpOption: ContainerHttpOption;
    id: string;
    localStorageLimit: number;
    maxConcurrency: number;
    maxScale: number;
    memoryLimit: number;
    minScale: number;
    name: string;
    namespaceId: string;
    port: number;
    privacy: ContainerPrivacy;
    protocol: ContainerProtocol;
    readyAt?: Date;
    region: Region;
    registryImage: string;
    sandbox: ContainerSandbox;
    scalingOption?: Container.v1beta1.ContainerScalingOption;
    secretEnvironmentVariables: Container.v1beta1.SecretHashedValue[];
    status: ContainerStatus;
    timeout?: string;
    updatedAt?: Date;
}

Properties

cpuLimit createdAt? description? domainName environmentVariables errorMessage? healthCheck? httpOption id localStorageLimit maxConcurrency maxScale memoryLimit minScale name namespaceId port privacy protocol readyAt? region registryImage sandbox scalingOption? secretEnvironmentVariables status timeout? updatedAt?

Properties

cpuLimit

cpuLimit: number

CPU limit of the container in mvCPU.

OptionalcreatedAt

createdAt?: Date

Creation date of the container.

Optionaldescription

description?: string

Description of the container.

domainName

domainName: string

Domain name attributed to the contaioner.

environmentVariables

environmentVariables: Record<string, string>

Environment variables of the container.

OptionalerrorMessage

errorMessage?: string

Last error message of the container.

OptionalhealthCheck

healthCheck?: Container.v1beta1.ContainerHealthCheckSpec

Health check configuration of the container.

httpOption

httpOption: ContainerHttpOption

Possible values:

  • Redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
  • Enabled: Serve both HTTP and HTTPS traffic.

id

id: string

UUID of the container.

localStorageLimit

localStorageLimit: number

Local storage limit of the container (in MB).

maxConcurrency

maxConcurrency: number

Number of maximum concurrent executions of the container.

maxScale

maxScale: number

Maximum number of instances to scale the container to.

memoryLimit

memoryLimit: number

Memory limit of the container in MB.

minScale

minScale: number

Minimum number of instances to scale the container to.

name

name: string

Name of the container.

namespaceId

namespaceId: string

UUID of the namespace the container belongs to.

port

port: number

Port the container listens on.

privacy

privacy: ContainerPrivacy

Privacy setting of the container.

protocol

protocol: ContainerProtocol

Protocol the container uses.

OptionalreadyAt

readyAt?: Date

Last date when the container was successfully deployed and set to ready.

region

region: Region

Region in which the container will be deployed.

registryImage

registryImage: string

Name of the registry image (e.g. "rg.fr-par.scw.cloud/something/image:tag").

sandbox

sandbox: ContainerSandbox

Execution environment of the container.

OptionalscalingOption

scalingOption?: Container.v1beta1.ContainerScalingOption

Possible values:

  • Concurrent_requests_threshold: Scale depending on the number of concurrent requests being processed per container instance.
  • Cpu_usage_threshold: Scale depending on the CPU usage of a container instance.
  • Memory_usage_threshold: Scale depending on the memory usage of a container instance.

secretEnvironmentVariables

secretEnvironmentVariables: Container.v1beta1.SecretHashedValue[]

Secret environment variables of the container.

status

status: ContainerStatus

Status of the container.

Optionaltimeout

timeout?: string

Processing time limit for the container.

OptionalupdatedAt

updatedAt?: Date

Last update date of the container.

Settings

On This Page

Properties