status
Creates, updates, deletes, gets or lists a status
resource.
Overview
Name | status |
Type | Resource |
Id | snowflake.service.status |
Fields
The following fields are returned by SELECT
queries:
- fetch_service_status
successful
Name | Datatype | Description |
---|---|---|
system$get_service_status | string |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
fetch_service_status | select | database_name , schema_name , name , endpoint | timeout | Fetch 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.
Name | Datatype | Description |
---|---|---|
database_name | string | Identifier (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. |
endpoint | string | Organization and Account Name (default: orgid-acctid) |
name | string | Identifier (i.e. name) for the resource. |
schema_name | string | Identifier (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. |
timeout | integer | Number 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_service_status
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 }}';