SHOW ENDPOINTS¶

Note

This operation is not currently covered by the Service Level set forth in Snowflake’s Support Policy and Service Level Agreement.

Lists the endpoints in a Snowpark Container Services service (or a job service). Use the command to list endpoints in a service or service running as a job.

See also:

CREATE SERVICE , ALTER SERVICE, DROP SERVICE , SHOW SERVICES

Syntax¶

SHOW ENDPOINTS IN SERVICE <name>
Copy

Parameters¶

name

Specifies the identifier for the service whose endpoints to list.

If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

For more information, see Identifier requirements.

Output¶

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

Column

Description

name

User-friendly endpoint name that represents the corresponding port.

port

The network port the service is listening on. NULL, when portRange is specified.

port_range

The network port range the service is listening on. NULL, when port is specified.

protocol

Supported network protocol (TCP, HTTP, or HTTPS). The default is HTTP. Public endpoints and service functions (see Using a service) require HTTP or HTTPS.

is_public

True, if the endpoint is public, accessible from internet.

ingress_url

Endpoint URL accessible from the internet.

Access control requirements¶

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

Privilege

Object

Notes

USAGE

Service

Note that operating on any object in a schema also requires the USAGE privilege on the parent database and 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 endpoints exposed by echo_service service:

SHOW ENDPOINTS IN SERVICE echo_service;
Copy
+--------------+------+------------+----------+-----------+------------------------------------------------------------------------------+
| name         | port | port_range | protocol | is_public | ingress_url                                                                  |
|--------------+------+------------+----------+-----------+------------------------------------------------------------------------------|
| echoendpoint | 8080 |            | HTTP     | true      | d7qoajz-orgname-acctname.pp-snowflakecomputing.app                           |
+--------------+------+------------+----------+-----------+------------------------------------------------------------------------------+
Language: English