Skip to main content

status

Creates, updates, deletes, gets or lists a status resource.

Overview

Namestatus
TypeResource
Idsnowflake.service.status

Fields

The following fields are returned by SELECT queries:

successful

NameDatatypeDescription
system$get_service_statusstring

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
fetch_service_statusselectdatabase_name, schema_name, name, endpointtimeoutFetch the status for a given service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
database_namestringIdentifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases.
endpointstringOrganization and Account Name (default: orgid-acctid)
namestringIdentifier (i.e. name) for the resource.
schema_namestringIdentifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database.
timeoutintegerNumber of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.

SELECT examples

Fetch the status for a given service.

SELECT
system$get_service_status
FROM snowflake.service.status
WHERE database_name = '{{ database_name }}' -- required
AND schema_name = '{{ schema_name }}' -- required
AND name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND timeout = '{{ timeout }}';