Service

List services¶

GET/api/v2/databases/{database}/schemas/{schema}/services
Lists the services under the database and schema.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Path Parameters¶

ParameterDescription
database 
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.
schema 
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.

Query Parameters¶

ParameterDescription
like string
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWith string
Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
showLimit integer
Query parameter to limit the maximum number of rows returned by a command.
fromName string
Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.

Response¶

CodeDescription
200
successful
202
Successfully accepted the request, but it is not completed yet.

Create a service¶

POST/api/v2/databases/{database}/schemas/{schema}/services
Create a service, with standard create modifiers as query parameters. See the Service component definition for what is required to be provided in the request body.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
createMode string
Query parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

Response¶

CodeDescription
200
Successful request.
202

Execute a job service¶

POST/api/v2/databases/{database}/schemas/{schema}/services:execute-job
Create and execute a job service. See the JobService component definition for what is required to be provided in the request body.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
202

Fetch a service¶

GET/api/v2/databases/{database}/schemas/{schema}/services/{name}
Fetch a service.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Path Parameters¶

ParameterDescription
name 
Identifier (i.e. name) for the resource.

Response¶

CodeDescription
200
successful
202

Create a (or alter an existing) service¶

PUT/api/v2/databases/{database}/schemas/{schema}/services/{name}
Create a (or alter an existing) service. Even if the operation is just an alter, the full property set must be provided.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
Successful request
202

Delete a service¶

DELETE/api/v2/databases/{database}/schemas/{schema}/services/{name}
Delete a service with the given name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
ifExists boolean
Query parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

Response¶

CodeDescription
200
202

Fetch the logs for a given service¶

GET/api/v2/databases/{database}/schemas/{schema}/services/{name}/logs
Fetch the logs for a given service.

Query Parameters¶

ParameterDescription
instanceId integer
ID of the service instance, starting with 0.
containerName string
Container name as specified in the service specification file.
numLines integer
Number of trailing log lines to retrieve.

Response¶

CodeDescription
200
successful
202

Fetch the status for a given service (Deprecated)¶

GET/api/v2/databases/{database}/schemas/{schema}/services/{name}/status
Fetch the status for a given service. Deprecated
  • use listServiceContainers instead.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
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.

Response¶

CodeDescription
200
successful
202

List all the containers of the service¶

GET/api/v2/databases/{database}/schemas/{schema}/services/{name}/containers
List all the containers of the service

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
successful
202

List all the instances of the service¶

GET/api/v2/databases/{database}/schemas/{schema}/services/{name}/instances
List all the instances of the service

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
successful
202

List all the service roles of the service¶

GET/api/v2/databases/{database}/schemas/{schema}/services/{name}/roles
List all the service roles of the service

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
successful
202

List all the grants of the service role¶

GET/api/v2/databases/{database}/schemas/{schema}/services/{service}/roles/{name}/grants-of
List all the grants of the service role

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
successful
202

List all the grants given to the service role¶

GET/api/v2/databases/{database}/schemas/{schema}/services/{service}/roles/{name}/grants
List all the grants given to the service role

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
successful
202

Resume a service¶

POST/api/v2/databases/{database}/schemas/{schema}/services/{name}:resume
Resume a service.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
202

Suspend a service¶

POST/api/v2/databases/{database}/schemas/{schema}/services/{name}:suspend
Suspend a service.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
202

List the endpoints in a service¶

GET/api/v2/databases/{database}/schemas/{schema}/services/{name}/endpoints
Lists the endpoints in a Snowpark Container Services service (or a job service).

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
successful
202
Language: English