Skip to content
Console(the OVHcloud Console, opens in a new tab)

Rules

All operations require authentication.

4 operationsv1/dbaas/logs
OpenAPI
Agent setup

List stream rulesProduction

GET
/1.0/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule

Returns the stream rules of the Logs Data Platform service.

Path parameters

serviceName
required
string

Service name

streamId
required
stringuuid

Stream ID

Response

200string[]successful operation
404objectError 404 response

Example uses serviceName = string, streamId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "00000000-0000-0000-0000-000000000000"]

Get a stream ruleProduction

GET
/1.0/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule/{ruleId}

Returns the stream rule.

Path parameters

ruleId
required
stringuuid

Rule ID

serviceName
required
string

Service name

streamId
required
stringuuid

Stream ID

Response

200StreamRulesuccessful operation
field
read-only
string

Field name

isInverted
read-only
boolean

Invert condition

operator
read-only
StreamRuleOperatorEnum

Field operator

ValuesFIELD_PRESENCEGREATER_THANMATCH_EXACTLYSMALLER_THAN
ruleId
read-only
stringuuid

Stream rule ID

value
read-only
string

Field value

404objectError 404 response

Example uses ruleId = 00000000-0000-0000-0000-000000000000, serviceName = string, streamId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule/{ruleId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "field": "string",  "isInverted": true,  "operator": "FIELD_PRESENCE",  "ruleId": "00000000-0000-0000-0000-000000000000",  "value": "string"}

Create a stream ruleProduction

POST
/1.0/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule

Creates a stream rule on the Logs Data Platform service.

Path parameters

serviceName
required
string

Service name

streamId
required
stringuuid

Stream ID

Request body (required)

field
required
string

Field name

isInverted
boolean

Invert condition

operator
required
StreamRuleOperatorEnum

Field operator

ValuesFIELD_PRESENCEGREATER_THANMATCH_EXACTLYSMALLER_THAN
value
required
string

Field value

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response
409objectError 409 response

Example uses serviceName = string, streamId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Delete a stream ruleProduction

DELETE
/1.0/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule/{ruleId}

Deletes the stream rule.

Path parameters

ruleId
required
stringuuid

Rule ID

serviceName
required
string

Service name

streamId
required
stringuuid

Stream ID

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response

Example uses ruleId = 00000000-0000-0000-0000-000000000000, serviceName = string, streamId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule/{ruleId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}