Get secrets
GET/metalakes/:metalake/objects/:metadataObjectType/:metadataObjectFullName/secrets
Returns the plaintext values of a metadata object's secret properties, which get and list responses mask as ******: properties declared hidden and undeclared properties whose names look sensitive. Callers without the USE_SECRETS privilege get an empty map, and cloud access-key pairs are left out unless the caller also has INCLUDE_CREDENTIAL_SECRETS.
Sign in with a bearer token or a local user's password; see Authentication.
Request
Path Parameters
The name of the metalake
Possible values: [METALAKE, CATALOG, SCHEMA, TABLE, VIEW, FILESET, TOPIC, MODEL]
The type of the metadata object. Secrets can be read for objects of type METALAKE, CATALOG, SCHEMA, TABLE, VIEW, FILESET, TOPIC and MODEL.
The full name of the metadata object
Responses
- 200
- 400
- 404
- 5xx
The plaintext values of the object's secret properties, keyed by property name. The map is empty when the caller lacks USE_SECRETS.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- SecretsResponse
Schema
Possible values: [0]
Status code of the response
secrets
object
Map of secret property key to plaintext value
{
"code": 0,
"secrets": {}
}
{
"code": 0,
"secrets": {
"jdbc-password": "plaintext-password"
}
}
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
- Example (from schema)
- Example
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
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.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1003,
"type": "BadRequestException",
"message": "Malformed request"
}
The metalake or the metadata object does not exist.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- NoSuchMetalakeException
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
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.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"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",
"..."
]
}
The server hit an internal error that the client usually cannot fix by changing the request.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- Example
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
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.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1002,
"type": "RuntimeException",
"message": "Internal Server Error",
"stack": [
"java.lang.RuntimeException: Internal Server Error"
]
}