Send a metrics report to this endpoint to be processed by the backend

POST 
/v1/:prefix/namespaces/:namespace/tables/:table/metrics

Send a metrics report to this endpoint to be processed by the backend

Request

Path Parameters

prefix stringrequired

The catalog name in Gravitino, as returned in defaults.prefix by GET /v1/config

namespace stringrequired

A namespace identifier as a single string. Multipart namespace parts must be separated by the namespace separator as indicated via the /config override namespace-separator, which defaults to the unit separator 0x1F byte (url encoded %1F). To be compatible with older clients, servers must use both the advertised separator and 0x1F as valid separators when decoding namespaces. The namespace-separator should be provided in a url encoded form.

Examples:

singlepart_namespace

Example: accounting

multipart_namespace

Example: accounting%1Ftax

table stringrequired
A table name
Example: sales

application/json

Body

required

The request containing the metrics report to be sent

anyOf

ScanReport

table-name stringrequired

snapshot-id int64required

filter

object

required

oneOf

TrueExpression

type ExpressionType (string)required

FalseExpression

type ExpressionType (string)required

AndOrExpression

type ExpressionType (string)required

Possible values: [and, or]

left objectrequired

A nested Expression

right objectrequired

A nested Expression

NotExpression

type ExpressionType (string)required

child objectrequired

A nested Expression

SetExpression

type ExpressionType (string)required

Possible values: [in, not-in]

term

object

required

oneOf

Reference

string

TransformTerm

type stringrequired

transform Transform (string)required

term Reference (string)required

values

object[]

required

Array [

oneOf

BooleanTypeValue

boolean

IntegerTypeValue

integer

LongTypeValue

integer

FloatTypeValue

number

DoubleTypeValue

number

DecimalTypeValue

Decimal type values are serialized as strings. Decimals with a positive scale serialize as numeric plain text, while decimals with a negative scale use scientific notation and the exponent will be equal to the negated scale. For instance, a decimal with a positive scale is '123.4500', with zero scale is '2', and with a negative scale is '2E+20'

string

StringTypeValue

string

UUIDTypeValue

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

DateTypeValue

Date type values follow the 'YYYY-MM-DD' ISO-8601 standard date format

string

TimeTypeValue

Time type values follow the 'HH:MM:SS.ssssss' ISO-8601 format with microsecond precision

string

TimestampTypeValue

Timestamp type values follow the 'YYYY-MM-DDTHH:MM:SS.ssssss' ISO-8601 format with microsecond precision

string

TimestampTzTypeValue

TimestampTz type values follow the 'YYYY-MM-DDTHH:MM:SS.ssssss+00:00' ISO-8601 format with microsecond precision, and a timezone offset (+00:00 for UTC)

string

TimestampNanoTypeValue

Timestamp_ns type values follow the 'YYYY-MM-DDTHH:MM:SS.sssssssss' ISO-8601 format with nanosecond precision

string

TimestampTzNanoTypeValue

Timestamp_ns type values follow the 'YYYY-MM-DDTHH:MM:SS.sssssssss+00:00' ISO-8601 format with nanosecond precision, and a timezone offset (+00:00 for UTC)

string

FixedTypeValue

Fixed length type values are stored and serialized as an uppercase hexadecimal string preserving the fixed length

string

BinaryTypeValue

Binary type values are stored and serialized as an uppercase hexadecimal string

string

]

LiteralExpression

type ExpressionType (string)required

Possible values: [lt, lt-eq, gt, gt-eq, eq, not-eq, starts-with, not-starts-with]

term

object

required

oneOf

Reference

string

TransformTerm

type stringrequired

transform Transform (string)required

term Reference (string)required

value

object

required

oneOf

BooleanTypeValue

boolean

IntegerTypeValue

integer

LongTypeValue

integer

FloatTypeValue

number

DoubleTypeValue

number

DecimalTypeValue

Decimal type values are serialized as strings. Decimals with a positive scale serialize as numeric plain text, while decimals with a negative scale use scientific notation and the exponent will be equal to the negated scale. For instance, a decimal with a positive scale is '123.4500', with zero scale is '2', and with a negative scale is '2E+20'

string

StringTypeValue

string

UUIDTypeValue

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

DateTypeValue

Date type values follow the 'YYYY-MM-DD' ISO-8601 standard date format

string

TimeTypeValue

Time type values follow the 'HH:MM:SS.ssssss' ISO-8601 format with microsecond precision

string

TimestampTypeValue

Timestamp type values follow the 'YYYY-MM-DDTHH:MM:SS.ssssss' ISO-8601 format with microsecond precision

string

TimestampTzTypeValue

TimestampTz type values follow the 'YYYY-MM-DDTHH:MM:SS.ssssss+00:00' ISO-8601 format with microsecond precision, and a timezone offset (+00:00 for UTC)

string

TimestampNanoTypeValue

Timestamp_ns type values follow the 'YYYY-MM-DDTHH:MM:SS.sssssssss' ISO-8601 format with nanosecond precision

string

TimestampTzNanoTypeValue

Timestamp_ns type values follow the 'YYYY-MM-DDTHH:MM:SS.sssssssss+00:00' ISO-8601 format with nanosecond precision, and a timezone offset (+00:00 for UTC)

string

FixedTypeValue

Fixed length type values are stored and serialized as an uppercase hexadecimal string preserving the fixed length

string

BinaryTypeValue

Binary type values are stored and serialized as an uppercase hexadecimal string

string

UnaryExpression

type ExpressionType (string)required

Possible values: [is-null, not-null, is-nan, not-nan]

term

object

required

oneOf

Reference

string

TransformTerm

type stringrequired

transform Transform (string)required

term Reference (string)required

schema-id integerrequired

projected-field-ids integer[]required

projected-field-names string[]required

metrics

object

required

property name*

MetricResult

anyOf

CounterResult

unit stringrequired

value int64required

TimerResult

time-unit stringrequired

count int64required

total-duration int64required

metadata

object

property name* string

CommitReport

table-name stringrequired

snapshot-id int64required

sequence-number int64required

operation stringrequired

metrics

object

required

property name*

MetricResult

anyOf

CounterResult

unit stringrequired

value int64required

TimerResult

time-unit stringrequired

count int64required

total-duration int64required

metadata

object

property name* string
report-type stringrequired

Responses

204

Success, no content

400

Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Malformed request",
    "type": "BadRequestException",
    "code": 400
  }
}

401

Unauthorized. The REST Catalog SHOULD respond with the 401 UnauthorizedResponse when the access token provided is expired, revoked, malformed, or invalid for other reasons. The client MAY request a new access token and retry the request.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Not authorized to make this request",
    "type": "NotAuthorizedException",
    "code": 401
  }
}

403

Forbidden. Authenticated user does not have the necessary permissions.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Not authorized to make this request",
    "type": "NotAuthorizedException",
    "code": 403
  }
}

404

Not Found - NoSuchTableException, table to load does not exist

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

TableToLoadDoesNotExist

The requested table does not exist

{
  "error": {
    "message": "The given table does not exist",
    "type": "NoSuchTableException",
    "code": 404
  }
}

419

This is an optional status response type that the REST Catalog can issue when the token has expired. The client MAY request a new access token and retry the request. 401 UnauthorizedResponse SHOULD be preferred over this response type on token expiry.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Credentials have timed out",
    "type": "AuthenticationTimeoutException",
    "code": 419
  }
}

503

The service is not ready to handle the request, request could have been partially processed. The service may additionally send a Retry-After header to indicate when to retry, a non idempotent request should only be retried by the client when the Retry-After header is present.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Slow down",
    "type": "SlowDownException",
    "code": 503
  }
}

5XX

A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Internal Server Error",
    "type": "InternalServerError",
    "code": 500
  }
}

Loading...