Schemas
scaleway.containers.v1.Container
idContainer unique ID. (UUID format)
nameContainer name.
namespace_idUnique ID of the namespace the container belongs to. (UUID format)
descriptionContainer description.
statusContainer status.
error_messageContainer last error message.
created_atContainer creation date. (RFC 3339 format)
updated_atContainer last update date. (RFC 3339 format)
Environment variables of the container.
Secret environment variables of the container.
min_scaleMinimum number of instances to scale the container to.
max_scaleMaximum number of instances to scale the container to.
memory_limit_bytesMemory limit of the container in bytes. (in bytes)
mvcpu_limitCPU limit of the container in mvCPU.
local_storage_limit_bytesLocal storage limit of the container (in bytes). (in bytes)
timeoutProcessing time limit for the container. (in seconds)
privacyPrivacy policy of the container.
imageImage reference (e.g. "rg.fr-par.scw.cloud/my-registry-namespace/image:tag").
protocolProtocol the container uses.
portPort the container listens on.
https_connections_onlyIf true, it will allow only HTTPS connections to access your container to prevent it from being triggered by insecure connections (HTTP).
sandboxExecution environment of the container.
Parameter used to decide when to scale up or down.
Defines how to check if the container is running and healthy. If the liveness probe fails, the container will be restarted. It is performed periodically during the container's lifetime. The liveness probe is not executed until the startup probe (if defined) is successful.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
Defines how to check if the container has started successfully. If the startup probe fails, the container will be restarted. This check is useful for applications that might take a long time to start. It is only performed when the container is starting.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
tagsTags of the Serverless Container.
private_network_idID of the Private Network the container is connected to. When connected to a Private Network, the container can access other Scaleway resources in this Private Network. (UUID format)
commandContainer command. Command executed when the container starts. This overrides the default command defined in the container image. This is usually the main executable, or ENTRYPOINT script to run.
argsContainer arguments. Arguments passed to the command specified in the "command" field. These override the default arguments from the container image, and behave like command-line parameters.
public_endpointPublic URL of the container. This is the default endpoint generated by Scaleway to access the container from the Internet.
default_public_endpoint_enabledWhether default public endpoint is enabled or not.
regionRegion in which the container exists.
scaleway.containers.v1.Container.Privacy
scaleway.containers.v1.Container.Probe
failure_thresholdNumber of consecutive failures before considering the container as unhealthy. Unhealthy containers do not receive traffic from incoming requests.
intervalTime interval between checks. (in seconds)
timeoutDuration before the check times out. (in seconds)
Perform TCP check on the container. The check is successful if a TCP connection can be established with the container within the specified timeout.
Perform HTTP check on the container. The check is successful if an HTTP request to the specified path returns a successful status code (e.g. 2XX or 3XX) within the specified timeout.
scaleway.containers.v1.Container.Protocol
scaleway.containers.v1.Container.Sandbox
scaleway.containers.v1.Container.ScalingOption
concurrent_requests_thresholdScale depending on the number of concurrent requests being processed per container instance. The threshold value is the number of concurrent requests above which the container will be scaled up.
cpu_usage_thresholdScale depending on the CPU usage of a container instance. The threshold value is the percentage of CPU usage above which the container will be scaled up.
memory_usage_thresholdScale depending on the memory usage of a container instance. The threshold value is the percentage of memory usage above which the container will be scaled up.
scaleway.containers.v1.Container.Status
scaleway.containers.v1.CreateTriggerRequest.CronConfig
scheduleUNIX cron schedule to run job (e.g., "* * * * *").
timezoneTimezone for the cron schedule, in tz database format (e.g., "Europe/Paris").
bodyBody to send to the container when the trigger is invoked.
Additional headers to send to the container when the trigger is invoked.
scaleway.containers.v1.CreateTriggerRequest.DestinationConfig
http_pathThe HTTP path to send the request to (e.g., "/my-webhook-endpoint").
http_methodThe HTTP method to use when sending the request (e.g., get, post, put, patch, delete). Must be specified as lowercase.
scaleway.containers.v1.CreateTriggerRequest.DestinationConfig.HttpMethod
scaleway.containers.v1.CreateTriggerRequest.NATSConfig
server_urlsThe URLs of the NATS server (e.g., "nats://nats.mnq.fr-par.scaleway.com:4222").
subjectNATS subject to subscribe to (e.g., "my-subject").
credentials_file_contentThe content of the NATS credentials file. The credentials from this file will be used to authenticate with the NATS server and subscribe to the specified subject.
scaleway.containers.v1.CreateTriggerRequest.SQSConfig
regionThe region where the SQS queue is hosted (e.g., "fr-par", "nl-ams").
endpointEndpoint URL to use to access SQS (e.g., "https://sqs.mnq.fr-par.scaleway.comOpen in new context").
access_key_idThe access key for accessing the SQS queue.
secret_access_keyThe secret key for accessing the SQS queue.
queue_urlThe URL of the SQS queue to monitor for messages.
scaleway.containers.v1.Domain
idDomain unique ID. (UUID format)
container_idUnique ID of the container the domain is assigned to. (UUID format)
hostnameDomain assigned to the container.
statusDomain status.
error_messageDomain last error message.
created_atDomain creation date. (RFC 3339 format)
updated_atDomain last update date. (RFC 3339 format)
tagsA list of arbitrary tags associated with the domain.
scaleway.containers.v1.Domain.Status
scaleway.containers.v1.ListContainersRequest.OrderBy
scaleway.containers.v1.ListDomainsRequest.OrderBy
scaleway.containers.v1.ListNamespacesRequest.OrderBy
scaleway.containers.v1.ListTriggersRequest.OrderBy
scaleway.containers.v1.Namespace
idNamespace unique ID. (UUID format)
nameNamespace name.
organization_idUnique ID of the Organization the namespace belongs to. (UUID format)
project_idUnique ID of the Project the namespace belongs to. (UUID format)
descriptionNamespace description.
statusNamespace status.
error_messageNamespace last error message.
Namespace environment variables.
Namespace secret environment variables.
tagsA list of arbitrary tags associated with the namespace.
created_atNamespace creation date. (RFC 3339 format)
updated_atNamespace last update date. (RFC 3339 format)
regionRegion in which the namespace will be created.
scaleway.containers.v1.Namespace.Status
scaleway.containers.v1.Trigger
idTrigger unique ID. (UUID format)
nameName of the trigger.
descriptionDescription of the trigger.
tagsTags of the trigger.
statusTrigger status.
error_messageTrigger last error message.
container_idID of the container to trigger. (UUID format)
Configuration of the destination to trigger.
source_typeType of source that will trigger the container.
Configuration for a cron source.
Configuration for an SQS queue source.
Configuration for a NATS source.
created_atTrigger creation date. (RFC 3339 format)
updated_atTrigger last update date. (RFC 3339 format)
scaleway.containers.v1.Trigger.CronConfig
scheduleUNIX cron schedule to run job (e.g., "* * * * *").
timezoneTimezone for the cron schedule, in tz database format (e.g., "Europe/Paris").
bodyBody to send to the container when the trigger is invoked.
Additional headers to send to the container when the trigger is invoked.
scaleway.containers.v1.Trigger.DestinationConfig
http_pathThe HTTP path to send the request to (e.g., "/my-webhook-endpoint").
http_methodThe HTTP method to use when sending the request (e.g., get, post, put, patch, delete). Must be specified as lowercase.
scaleway.containers.v1.Trigger.DestinationConfig.HttpMethod
scaleway.containers.v1.Trigger.NATSConfig
server_urlsThe URLs of the NATS servers (e.g., "nats://nats.mnq.fr-par.scaleway.com:4222").
subjectNATS subject to subscribe to (e.g., "my-subject").
scaleway.containers.v1.Trigger.SQSConfig
regionThe region where the SQS queue is hosted (e.g., "fr-par", "nl-ams").
endpointEndpoint URL to use to access SQS (e.g., "https://sqs.mnq.fr-par.scaleway.comOpen in new context").
access_key_idThe access key for accessing the SQS queue.
queue_urlThe URL of the SQS queue to monitor for messages.
scaleway.containers.v1.Trigger.SourceType
scaleway.containers.v1.Trigger.Status
scaleway.containers.v1.UpdateContainerRequest.Probe
failure_thresholdinterval(in seconds)
timeout(in seconds)
scaleway.containers.v1.UpdateTriggerRequest.CronConfig
scheduleUNIX cron schedule to run job (e.g., "* * * * *").
timezoneTimezone for the cron schedule, in tz database format (e.g., "Europe/Paris").
bodyBody to send to the container when the trigger is invoked.
headersAdditional headers to send to the container when the trigger is invoked.
scaleway.containers.v1.UpdateTriggerRequest.DestinationConfig
http_pathThe HTTP path to send the request to (e.g., "/my-webhook-endpoint").
http_methodThe HTTP method to use when sending the request (e.g., get, post, put, patch, delete). Must be specified as lowercase.
scaleway.containers.v1.UpdateTriggerRequest.DestinationConfig.HttpMethod
scaleway.containers.v1.UpdateTriggerRequest.NATSConfig
server_urlsThe URLs of the NATS server (e.g., "nats://nats.mnq.fr-par.scaleway.com:4222").
subjectNATS subject to subscribe to (e.g., "my-subject").
credentials_file_contentThe content of the NATS credentials file. The credentials from this file will be used to authenticate with the NATS server and subscribe to the specified subject.
scaleway.containers.v1.UpdateTriggerRequest.SQSConfig
regionThe region where the SQS queue is hosted (e.g., "fr-par", "nl-ams").
endpointEndpoint URL to use to access SQS (e.g., "https://sqs.mnq.fr-par.scaleway.comOpen in new context").
access_key_idThe access key for accessing the SQS queue.
secret_access_keyThe secret key for accessing the SQS queue.
queue_urlThe URL of the SQS queue to monitor for messages.