Test existing catalog connection

POST 
/metalakes/:metalake/catalogs/:catalog/testConnection

Tests whether an existing catalog can connect to its source with its stored configuration, or with proposed changes applied for this test only and not saved. A failed test is reported as an error code in an HTTP 200 response, and testing with proposed changes requires the same access as updating the catalog.

Sign in with a bearer token or a local user's password; see Authentication.

Request

Path Parameters

metalake stringrequired

The name of the metalake

catalog stringrequired

The name of the catalog

application/json

Body

Optional catalog changes to apply only to this connection test

updates

object[]

required

Array [

oneOf

RenameCatalogRequest

@type stringrequired

Possible values: [rename]

newName stringrequired

The new name of the catalog

UpdateCatalogCommentRequest

@type stringrequired

Possible values: [updateComment]

newComment stringrequired

The new comment of the catalog

SetCatalogPropertyRequest

@type stringrequired

Possible values: [setProperty]

property stringrequired

The property to set

value stringrequired

The value to set

RemoveCatalogPropertyRequest

@type stringrequired

Possible values: [removeProperty]

property stringrequired

The property to remove

]

Responses

200

The result of the connection test. code is 0 when the test passed; a failed test, including a missing or disabled catalog, is reported with its error code, exception type and message.

application/vnd.gravitino.v1+json

Schema

Schema

code int32required

Application status code; 0 indicates success

type string

Internal exception type when the test fails

message string

Sanitized failure message

Example (from schema)

{
  "code": 0,
  "type": "string",
  "message": "string"
}

TestConnectionSuccess

{
  "code": 0
}

TestConnectionFailed

{
  "code": 1007,
  "type": "ConnectionFailedException",
  "message": "Failed to test Fileset catalog connection: location (access denied)"
}

InvalidProbeTarget

{
  "code": 1001,
  "type": "IllegalArgumentException",
  "message": "Fileset catalog has no catalog-level location to test"
}

TestConnectionNotSupported

{
  "code": 1006,
  "type": "UnsupportedOperationException",
  "message": "Model catalogs do not define an external catalog-level connection probe"
}

CatalogNotFound

{
  "code": 1003,
  "type": "NoSuchCatalogException",
  "message": "Catalog my_metalake.my_catalog does not exist"
}

CatalogDisabled

{
  "code": 1009,
  "type": "CatalogNotInUseException",
  "message": "Catalog my_metalake.my_catalog is not in use"
}

400

The request is malformed or fails validation, for example because of invalid JSON, a missing required field or an invalid parameter value. The body is normally an error model, although the server's middleware can return plain text instead.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

{
  "code": 1003,
  "type": "BadRequestException",
  "message": "Malformed request"
}

403

The caller cannot load the catalog, or supplied proposed changes without owning the metalake or the catalog.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

5xx

The server hit an internal error that the client usually cannot fix by changing the request.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...