Status200
Ресурс

Metric Type

List of all the metrics ingested with OpenTelemetry

Модель Metric Type

Свойства

  • Имя
    _id
    Тип
    Object ID
    Описание

    ID of this object

  • Имя
    createdAt
    Тип
    Date
    Описание

    Date and Time when the object was created.

  • Имя
    updatedAt
    Тип
    Date
    Описание

    Date and Time when the object was updated.

  • Имя
    project
    Тип
    Project
    Описание

    Relation to Project Resource in which this object belongs

  • Имя
    services
    Тип
    Service
    Описание

    List of services this metric is related to

  • Имя
    projectId
    Тип
    Object IDОбязательно
    Описание

    ID of your Project in which this object belongs

  • Имя
    name
    Тип
    TextОбязательно
    Описание

    Any friendly name of this object

  • Имя
    description
    Тип
    Very Long Text
    Описание

    Metric description

  • Имя
    unit
    Тип
    Very Long Text
    Описание

    Metric description

  • Имя
    createdByUser
    Тип
    User
    Описание

    Relation to User who created this object (if this object was created by a User)

  • Имя
    createdByUserId
    Тип
    Object ID
    Описание

    User ID who created this object (if this object was created by a User)

GETorPOST/api/metric-type/get-list

Список

Этот метод возвращает постраничный список ваших объектов «Metric Type». По умолчанию на странице до десяти записей.

Необязательные query-параметры

  • limit
    число
    Сколько объектов вернуть. По умолчанию 10, максимум 100
  • skip
    число
    Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

Запрос списка

POST
/api/metric-type/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "name": true,
    "projectId": true,
    "_id": true,
    "createdAt": true,
    "createdByUser": true
  },
  "query": {
    "name": "Example name"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377429c0-28fe-11f1-b591-3fdcef396aba",
      "name": "Example name",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "createdByUser": "Example created by user"
    },
    {
      "_id": "377429c1-28fe-11f1-b591-3fdcef396aba",
      "name": "Example name",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "createdByUser": "Example created by user"
    },
    {
      "_id": "377429c2-28fe-11f1-b591-3fdcef396aba",
      "name": "Example name",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "createdByUser": "Example created by user"
    }
  ]
}
GETorPOST/api/metric-type/:id/get-item

Получить по ID

Возвращает объект «Metric Type» по идентификатору.

  • id
    строка
    ID объекта

Необязательное тело запроса

  • select
    По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST
/api/metric-type/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "name": true,
    "projectId": true,
    "_id": true,
    "createdAt": true,
    "createdByUser": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example name",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "createdByUser": "Example created by user"
}
POST/api/metric-type/count

Количество

Возвращает количество ваших объектов «Metric Type».

Необязательное тело запроса

Запрос количества

POST
/api/metric-type/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "name": "Example name"
  }
}

Ответ

{
  "count": 107
}
POST/api/metric-type

Создать Metric Type

Создаёт новый объект.

Запрос создания

POST
/api/metric-type
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "name": "Example name",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "createdByUser": "Example created by user",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000",
    "description": "Example description"
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example name",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "createdByUser": "Example created by user"
}
PUT/api/metric-type/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/metric-type/:id/update-item
GET/api/metric-type/:id/update-item

Запрос обновления

PUT
/api/metric-type/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "name": "Example name",
    "description": "Example description",
    "services": []
  }
}

Ответ

{}
DELETE/api/metric-type/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/metric-type/:id/delete-item
GET/api/metric-type/:id/delete-item

Запрос удаления

DELETE
/api/metric-type/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения Metric Type

  • Project Owner
  • Project Admin
  • Project Member
  • Read Telemetry Service Metrics
  • Read All Project Resources

Права на создание

Нужны для создания Metric Type

  • Project Owner
  • Project Admin
  • Project Member
  • Create Telemetry Service Metrics

Права на обновление

Нужны для обновления Metric Type

  • Project Owner
  • Project Admin
  • Project Member
  • Edit Telemetry Service Metrics

Права на удаление

Нужны для удаления Metric Type

  • Project Owner
  • Project Admin
  • Delete Telemetry Service Metrics