Get credentials

GET 
/metalakes/:metalake/objects/:metadataObjectType/:metadataObjectFullName/credentials

Returns the storage credentials vended for a catalog or fileset, each with its type, expiry time and credential properties. Write credentials are returned when the caller owns the object or a parent object or holds WRITE_FILESET on it, and read credentials otherwise.

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

Request

Path Parameters

metalake stringrequired

The name of the metalake

metadataObjectType stringrequired

Possible values: [CATALOG, FILESET]

The type of the metadata object. Credentials can be vended for catalogs and filesets only; any other type is rejected with an unsupported-operation error. The server matches the value case-insensitively.

metadataObjectFullName stringrequired

The full name of the metadata object

Responses

200

The storage credentials vended for the catalog or fileset, each with its type, expiry time and credential properties.

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

credentials

object[]

A list of credential objects

Array [

credentialType stringrequired

The type of the credential, for example, s3-token, s3-secret-key, oss-token, oss-secret-key, gcs-token, adls-token, azure-account-key, etc.

expireTimeInMs integerrequired

The expiration time of the credential in milliseconds since the epoch, 0 means not expire.

credentialInfo

object

required

The specific information of the credential.

property name* string

]

Example (from schema)

{
  "code": 0,
  "credentials": [
    {
      "credentialType": "string",
      "expireTimeInMs": 0,
      "credentialInfo": {}
    }
  ]
}

CredentialResponse

{
  "code": 0,
  "credentials": [
    {
      "credentialType": "s3-token",
      "expireTimeInMs": 1735891948411,
      "credentialInfo": {
        "s3-access-key-id": "value1",
        "s3-secret-access-key": "value2",
        "s3-session-token": "value3"
      }
    },
    {
      "credentialType": "s3-secret-key",
      "expireTimeInMs": 0,
      "credentialInfo": {
        "s3-access-key-id": "value1",
        "s3-secret-access-key": "value2"
      }
    }
  ]
}

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"
}

404

The metalake, or the catalog or fileset, does not exist.

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"
}

NoSuchMetalakeException

{
  "code": 1003,
  "type": "NoSuchMetalakeException",
  "message": "Failed to operate metalake(s) [test] operation [LOAD], reason [NoSuchMetalakeException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchMetalakeException: Metalake test does not exist",
    "..."
  ]
}

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...