SHOW SERVICE CONTAINERS IN SERVICE¶

Lists the containers in all instances of a service.

If Snowflake encounters issues executing one or more of your service containers, this command provides visibility into the status of individual containers. Similarly, during a rolling upgrade, it shows the version of your service code running in each container.

See also:

Snowpark Container Services overview, CREATE SERVICE, SHOW SERVICES, SHOW SERVICE INSTANCES IN SERVICE

Syntax¶

SHOW SERVICE CONTAINERS IN SERVICE <name>
Copy

Parameters¶

name

Specifies the identifier for the service whose containers to list.

Quoted names for special characters or case-sensitive names are not supported.

Output¶

The command output provides properties and metadata of the service containers in the following columns:

Column

Description

database_name

Database in which the service is created.

schema_name

Schema in which the service is created.

service_name

Name of the service.

instance_id

ID of the service instance (this is the index of the service instance starting from 0).

container_name

Name of the container.

status

Service container status. Currently supported status values include the following:

  • PENDING: The container is currently being deployed.

  • READY: The container started and the readiness probe returned HTTP 200 OK status.

  • DONE: The container exited with a 0 exit code.

  • FAILED: The container exited with a non-zero exit code (exit code 0 indicates success).

  • UNKNOWN: Snowflake could not retrieve the container status. Contact support.

message

Additional clarification about status. For example, when status is FAILED, Snowflake might provide additional information.

image_name

Image name used to create the service.

image_digest

The unique and immutable identifier representing the image content.

restart_count

Number of times Snowflake restarted the service.

start_time

Date and time when the container started.

last_exit_code

Indicates the exit code when the container last exited. For service containers, Snowflake restarts the container if it exits prematurely. The exit code is represented as an integer value:

  • NULL: The container is currently running and has never exited.

  • 0: The container’s last exit was successful.

  • Non-zero value: The container encountered a failure.

last_restart_time

Provides the timestamp of the most recent restart of the container by Snowflake. A NULL value indicates the container never restarted.

Access control requirements¶

A role used to execute this operation must have the following privileges at a minimum:

Privilege

Object

Notes

Any one of these privileges: OWNERSHIP or MONITOR

Service

The USAGE privilege on the parent database and schema are required to perform operations on any object in a schema.

For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.

Usage notes¶

  • To post-process the output of this command, you can use the RESULT_SCAN function, which treats the output as a table that can be queried.

Examples¶

The following example lists containers of the echo_service service in the current database and schema for the session:

SHOW SERVICE CONTAINERS IN SERVICE echo_service;
Copy

Sample output:

+---------------+-------------+--------------+-------------+----------------+--------+---------+---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+---------------+----------------------+----------------+-------------------+
| database_name | schema_name | service_name | instance_id | container_name | status | message | image_name                                                                                                                | image_digest                                                            | restart_count | start_time           | last_exit_code | last_restart_time |
|---------------+-------------+--------------+-------------+----------------+--------+---------+---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+---------------+----------------------+----------------+-------------------|
| TUTORIAL_DB   | DATA_SCHEMA | ECHO_SERVICE | 0           | echo           | READY  | Running | orgname-acctname.registry.snowflakecomputing.com/tutorial_db/data_schema/tutorial_repository/my_echo_service_image:latest | sha256:d04a2d7b7d9bd607df994926e3cc672edcb541474e4888a01703e8bb0dd3f173 |             0 | 2024-12-13T07:30:25Z |           NULL | NULL              |
+---------------+-------------+--------------+-------------+----------------+--------+---------+---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+---------------+----------------------+----------------+-------------------+
Language: English