Aliases

All operations require authentication.

12 operationsv1/dbaas/logs

OpenAPI

Agent setup

List aliasesProduction

GET

/1.0/dbaas/logs/{serviceName}/output/opensearch/alias

Returns the aliases of the Logs Data Platform service.

Path parameters

serviceName

required

string

Service name

Query parameters

iamTags

object

Filter resources on IAM tags

Response

200string[]successful operation

404objectError 404 response

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/alias \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1[2  "00000000-0000-0000-0000-000000000000"3]

Get an aliasProduction

GET

/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}

Returns the alias.

Path parameters

aliasId

required

stringuuid

Alias ID

serviceName

required

string

Service name

Response

200AliasWithIAMsuccessful operation

aliasId

read-only

stringuuid

Alias ID

createdAt

read-only

stringdate-time

Input creation

description

read-only

string

Alias description

iam

read-only

ResourceMetadata

IAM resource metadata

isEditable

read-only

boolean

Indicates if you are allowed to edit entry

name

read-only

string

Alias name

nbIndex

read-only

integer

Number of indices linked

nbStream

read-only

integer

Number of streams linked

updatedAt

read-only

stringdate-time

Input last update

404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "aliasId": "00000000-0000-0000-0000-000000000000",3  "createdAt": "2024-01-01T12:00:00Z",4  "description": "string",5  "iam": {6    "displayName": "string",7    "id": "00000000-0000-0000-0000-000000000000",8    "state": "EXPIRED",9    "tags": {10      "key": "string"11    },12    "urn": "string"13  },14  "isEditable": true,15  "name": "string",16  "nbIndex": 0,17  "nbStream": 0,18  "updatedAt": "2024-01-01T12:00:00Z"19}

List indexes on an aliasProduction

GET

/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/index

Returns the indexes attached to the alias.

Path parameters

aliasId

required

stringuuid

Alias ID

serviceName

required

string

Service name

Response

200string[]successful operation

404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/index \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1[2  "00000000-0000-0000-0000-000000000000"3]

List data streams on an aliasProduction

GET

/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/stream

Returns the data streams attached to the alias.

Path parameters

aliasId

required

stringuuid

Alias ID

serviceName

required

string

Service name

Response

200string[]successful operation

404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/stream \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1[2  "00000000-0000-0000-0000-000000000000"3]

List alias URLsProduction

GET

/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/url

Returns the alias URLs of the Logs Data Platform service.

Path parameters

aliasId

required

stringuuid

Alias ID

serviceName

required

string

Service name

Response

200Url[]successful operation

address

read-only

string

Web URI

type

read-only

UrlTypeEnum

Service type

ValuesCONSOLEELASTICSEARCH_APIGRAYLOG_APIGRAYLOG_WEBUIHTTP_GELFHTTP_TLS_GELFKIBANA_WEBUIOPENSEARCH_APIOSD_WEBUIPROMETHEUS_APISERVICE_DOMAINTCP_BEATSTCP_CAP_N_PROTOTCP_GELFTCP_LTSV_LINETCP_LTSV_NULTCP_RFC5424TCP_TLS_BEATSTCP_TLS_CAP_N_PROTOTCP_TLS_GELFTCP_TLS_LTSV_LINETCP_TLS_LTSV_NULTCP_TLS_RFC5424UDP_CAP_N_PROTOUDP_GELFUDP_LTSV_LINEUDP_LTSV_NULUDP_RFC5424WEB_SOCKET

404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/url \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1[2  {3    "address": "string",4    "type": "CONSOLE"5  }6]

Create an aliasProduction

POST

/1.0/dbaas/logs/{serviceName}/output/opensearch/alias

Creates an alias on the Logs Data Platform service.

Path parameters

serviceName

required

string

Service name

Request body (required)

description

required

string

Description

suffix

required

string

Suffix

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

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/alias \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "aliasId": "00000000-0000-0000-0000-000000000000",3  "createdAt": "2024-01-01T12:00:00Z",4  "dashboardId": "00000000-0000-0000-0000-000000000000",5  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",6  "indexId": "00000000-0000-0000-0000-000000000000",7  "inputId": "00000000-0000-0000-0000-000000000000",8  "operationId": "00000000-0000-0000-0000-000000000000",9  "osdId": "00000000-0000-0000-0000-000000000000",10  "roleId": "00000000-0000-0000-0000-000000000000",11  "serviceName": "string",12  "state": "FAILURE",13  "streamId": "00000000-0000-0000-0000-000000000000",14  "subscriptionId": "00000000-0000-0000-0000-000000000000",15  "tenantId": "00000000-0000-0000-0000-000000000000",16  "tokenId": "00000000-0000-0000-0000-000000000000",17  "updatedAt": "2024-01-01T12:00:00Z"18}

Attach an index to an aliasProduction

POST

/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/index

Attaches an index to the alias.

Path parameters

aliasId

required

stringuuid

Alias ID

serviceName

required

string

Service name

Request body (required)

indexId

required

stringuuid

Index 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

409objectError 409 response

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

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/index \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "aliasId": "00000000-0000-0000-0000-000000000000",3  "createdAt": "2024-01-01T12:00:00Z",4  "dashboardId": "00000000-0000-0000-0000-000000000000",5  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",6  "indexId": "00000000-0000-0000-0000-000000000000",7  "inputId": "00000000-0000-0000-0000-000000000000",8  "operationId": "00000000-0000-0000-0000-000000000000",9  "osdId": "00000000-0000-0000-0000-000000000000",10  "roleId": "00000000-0000-0000-0000-000000000000",11  "serviceName": "string",12  "state": "FAILURE",13  "streamId": "00000000-0000-0000-0000-000000000000",14  "subscriptionId": "00000000-0000-0000-0000-000000000000",15  "tenantId": "00000000-0000-0000-0000-000000000000",16  "tokenId": "00000000-0000-0000-0000-000000000000",17  "updatedAt": "2024-01-01T12:00:00Z"18}

Attach a data stream to an aliasProduction

POST

/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/stream

Attaches a data stream to the alias.

Path parameters

aliasId

required

stringuuid

Alias ID

serviceName

required

string

Service name

Request body (required)

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 aliasId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/stream \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "aliasId": "00000000-0000-0000-0000-000000000000",3  "createdAt": "2024-01-01T12:00:00Z",4  "dashboardId": "00000000-0000-0000-0000-000000000000",5  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",6  "indexId": "00000000-0000-0000-0000-000000000000",7  "inputId": "00000000-0000-0000-0000-000000000000",8  "operationId": "00000000-0000-0000-0000-000000000000",9  "osdId": "00000000-0000-0000-0000-000000000000",10  "roleId": "00000000-0000-0000-0000-000000000000",11  "serviceName": "string",12  "state": "FAILURE",13  "streamId": "00000000-0000-0000-0000-000000000000",14  "subscriptionId": "00000000-0000-0000-0000-000000000000",15  "tenantId": "00000000-0000-0000-0000-000000000000",16  "tokenId": "00000000-0000-0000-0000-000000000000",17  "updatedAt": "2024-01-01T12:00:00Z"18}

Delete an aliasProduction

DELETE

/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}

Deletes the alias.

Path parameters

aliasId

required

stringuuid

Alias ID

serviceName

required

string

Service name

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 aliasId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "aliasId": "00000000-0000-0000-0000-000000000000",3  "createdAt": "2024-01-01T12:00:00Z",4  "dashboardId": "00000000-0000-0000-0000-000000000000",5  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",6  "indexId": "00000000-0000-0000-0000-000000000000",7  "inputId": "00000000-0000-0000-0000-000000000000",8  "operationId": "00000000-0000-0000-0000-000000000000",9  "osdId": "00000000-0000-0000-0000-000000000000",10  "roleId": "00000000-0000-0000-0000-000000000000",11  "serviceName": "string",12  "state": "FAILURE",13  "streamId": "00000000-0000-0000-0000-000000000000",14  "subscriptionId": "00000000-0000-0000-0000-000000000000",15  "tenantId": "00000000-0000-0000-0000-000000000000",16  "tokenId": "00000000-0000-0000-0000-000000000000",17  "updatedAt": "2024-01-01T12:00:00Z"18}

Detach an index from an aliasProduction

DELETE

/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/index/{indexId}

Detaches an index from the alias.

Path parameters

aliasId

required

stringuuid

Alias ID

indexId

required

stringuuid

Index ID

serviceName

required

string

Service name

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 aliasId = 00000000-0000-0000-0000-000000000000, indexId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/index/{indexId} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "aliasId": "00000000-0000-0000-0000-000000000000",3  "createdAt": "2024-01-01T12:00:00Z",4  "dashboardId": "00000000-0000-0000-0000-000000000000",5  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",6  "indexId": "00000000-0000-0000-0000-000000000000",7  "inputId": "00000000-0000-0000-0000-000000000000",8  "operationId": "00000000-0000-0000-0000-000000000000",9  "osdId": "00000000-0000-0000-0000-000000000000",10  "roleId": "00000000-0000-0000-0000-000000000000",11  "serviceName": "string",12  "state": "FAILURE",13  "streamId": "00000000-0000-0000-0000-000000000000",14  "subscriptionId": "00000000-0000-0000-0000-000000000000",15  "tenantId": "00000000-0000-0000-0000-000000000000",16  "tokenId": "00000000-0000-0000-0000-000000000000",17  "updatedAt": "2024-01-01T12:00:00Z"18}

Detach a data stream from an aliasProduction

DELETE

/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}/stream/{streamId}

Detaches a data stream from the alias.

Path parameters

aliasId

required

stringuuid

Alias 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 aliasId = 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/opensearch/alias/{aliasId}/stream/{streamId} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "aliasId": "00000000-0000-0000-0000-000000000000",3  "createdAt": "2024-01-01T12:00:00Z",4  "dashboardId": "00000000-0000-0000-0000-000000000000",5  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",6  "indexId": "00000000-0000-0000-0000-000000000000",7  "inputId": "00000000-0000-0000-0000-000000000000",8  "operationId": "00000000-0000-0000-0000-000000000000",9  "osdId": "00000000-0000-0000-0000-000000000000",10  "roleId": "00000000-0000-0000-0000-000000000000",11  "serviceName": "string",12  "state": "FAILURE",13  "streamId": "00000000-0000-0000-0000-000000000000",14  "subscriptionId": "00000000-0000-0000-0000-000000000000",15  "tenantId": "00000000-0000-0000-0000-000000000000",16  "tokenId": "00000000-0000-0000-0000-000000000000",17  "updatedAt": "2024-01-01T12:00:00Z"18}

Update an aliasProduction

PUT

/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId}

Updates the alias.

Path parameters

aliasId

required

stringuuid

Alias ID

serviceName

required

string

Service name

Request body (required)

description

required

string

Description

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 aliasId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/alias/{aliasId} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "aliasId": "00000000-0000-0000-0000-000000000000",3  "createdAt": "2024-01-01T12:00:00Z",4  "dashboardId": "00000000-0000-0000-0000-000000000000",5  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",6  "indexId": "00000000-0000-0000-0000-000000000000",7  "inputId": "00000000-0000-0000-0000-000000000000",8  "operationId": "00000000-0000-0000-0000-000000000000",9  "osdId": "00000000-0000-0000-0000-000000000000",10  "roleId": "00000000-0000-0000-0000-000000000000",11  "serviceName": "string",12  "state": "FAILURE",13  "streamId": "00000000-0000-0000-0000-000000000000",14  "subscriptionId": "00000000-0000-0000-0000-000000000000",15  "tenantId": "00000000-0000-0000-0000-000000000000",16  "tokenId": "00000000-0000-0000-0000-000000000000",17  "updatedAt": "2024-01-01T12:00:00Z"18}