Get tag for metadata object

GET 
/metalakes/:metalake/objects/:metadataObjectType/:metadataObjectFullName/tags/:tag

Get tag for metadata object

Request

Path Parameters

metalake stringrequired

The name of the metalake

metadataObjectType stringrequired

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

The type of the metadata object

metadataObjectFullName stringrequired

The full name of the metadata object

tag stringrequired

The name of the tag

Query Parameters

details boolean

Include detailed information about the tag

Responses

200

Returns the list of tag objects associated with specified metadata object if {details} is true, otherwise returns the list of tag name

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

tag

object

A tag

name stringrequired

The name of the tag

comment stringnullable

A comment about the tag

audit

object

required

Audit information for a Gravitino resource.

creator string

The user who created the resource

createTime date-time

The time the resource was created

lastModifier string

The user who last modified the resource

lastModifiedTime date-time

The time the resource was last modified

properties

object

Configured string to string map of properties for the tag

property name* string

inherited booleannullable

Whether the tag is inherited from the parent metadata object

Example (from schema)

{
  "code": 0,
  "tag": {
    "name": "string",
    "comment": "string",
    "audit": {
      "creator": "string",
      "createTime": "2024-11-14T07:54:08.707Z",
      "lastModifier": "string",
      "lastModifiedTime": "2024-11-14T07:54:08.707Z"
    },
    "properties": {},
    "inherited": true
  }
}

TagResponse

{
  "code": 0,
  "tag": {
    "name": "my_tag1",
    "comment": "This is my tag1",
    "properties": {
      "key1": "value1",
      "key2": "value2"
    },
    "audit": {
      "creator": "gravitino",
      "createTime": "2023-12-08T03:41:25.595Z"
    },
    "inherited": false
  }
}

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 metadata object does not exist or the specified tag is not associated with the specified metadata object

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

NoSuchTagException

{
  "code": 1003,
  "type": "NoSuchTagException",
  "message": "Failed to operate tag(s) [my_tag] operation [LOAD] under metalake [my_test_metalake], reason [NoSuchTagException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchTagException: Tag my_tag 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...