Get credentials

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

Get credentials

Request

Path Parameters

metalake stringrequired

The name of the metalake

metadataObjectType stringrequired

Possible values: [METALAKE, CATALOG, SCHEMA, TABLE, COLUMN, FILESET, TOPIC, MODEL, ROLE]

The type of the metadata object

metadataObjectFullName stringrequired

The full name of the metadata object

Responses

200

Returns the list of credential objects associated with specified metadata object.

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

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/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[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

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

404

Not Found - The specified metalake 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[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "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

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/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[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

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

Loading...