Service
List services¶
GET/api/v2/databases/{database}/schemas/{schema}/services
Lists the services under the database and schema.
詳細情報をご参照ください
引数、オプション、権限要件、使用ガイドラインに関する詳細情報を表示するには、 SQL コマンドページに移動してください。
パスパラメータ¶
| パラメーター | 説明 |
|---|---|
| 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. |
クエリパラメーター¶
| パラメーター | 説明 |
|---|---|
| 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. |
応答¶
| コード | 説明 |
|---|---|
| 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.
詳細情報をご参照ください
引数、オプション、権限要件、使用ガイドラインに関する詳細情報を表示するには、 SQL コマンドページに移動してください。
クエリパラメーター¶
| パラメーター | 説明 |
|---|---|
| createMode string | Query parameter allowing support for different modes of resource creation. Possible values include:
|
応答¶
| コード | 説明 |
|---|---|
| 200 | Successful request. |
| 202 |
Execute a job service¶
Fetch a service¶
Create a (or alter an existing) service¶
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.
詳細情報をご参照ください
引数、オプション、権限要件、使用ガイドラインに関する詳細情報を表示するには、 SQL コマンドページに移動してください。
クエリパラメーター¶
| パラメーター | 説明 |
|---|---|
| ifExists boolean | Query parameter that specifies how to handle the request for a resource that does not exist:
|
応答¶
| コード | 説明 |
|---|---|
| 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.
クエリパラメーター¶
| パラメーター | 説明 |
|---|---|
| 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. |
応答¶
| コード | 説明 |
|---|---|
| 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.
詳細情報をご参照ください
引数、オプション、権限要件、使用ガイドラインに関する詳細情報を表示するには、 SQL コマンドページに移動してください。
クエリパラメーター¶
| パラメーター | 説明 |
|---|---|
| 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. |
応答¶
| コード | 説明 |
|---|---|
| 200 | successful |
| 202 |