Alert

List alerts

GET/api/v2/databases/{database}/schemas/{schema}/alerts
List alerts

パスパラメータ

パラメーター説明
database 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.
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 an alert

POST/api/v2/databases/{database}/schemas/{schema}/alerts
Create an alert

クエリパラメーター

パラメーター説明
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.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

応答

コード説明
200
Successful request.
202

Fetch an alert

GET/api/v2/databases/{database}/schemas/{schema}/alerts/{name}
Fetch an alert

パスパラメータ

パラメーター説明
name 
Identifier (i.e. name) for the resource.

応答

コード説明
200
successful
202

Delete an alert

DELETE/api/v2/databases/{database}/schemas/{schema}/alerts/{name}
Delete an alert

クエリパラメーター

パラメーター説明
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.

応答

コード説明
200
202

Create a new alert by cloning from the specified resource

POST/api/v2/databases/{database}/schemas/{schema}/alerts/{name}:clone
Create a new alert by cloning from the specified resource

クエリパラメーター

パラメーター説明
targetDatabase string
Database of the newly created resource. Defaults to the source's database
targetSchema string
Schema of the newly created resource. Defaults to the source's schema

応答

コード説明
200
202

Execute an alert

POST/api/v2/databases/{database}/schemas/{schema}/alerts/{name}:execute
Execute an alert

応答

コード説明
200
202
言語: 日本語