Associate tags with metadata object

POST 
/metalakes/:metalake/objects/:metadataObjectType/:metadataObjectFullName/tags

Associate and disassociate tags with metadata object, please be aware that supported metadata objects are CATALOG, SCHEMA, TABLE, FILESET, TOPIC, COLUMN

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

application/json

Body

tagsToAdd string[]nullable

The tags to add

tagsToRemove string[]nullable

The tags to remove

Responses

200

Returns the list of tag names associated with the specified metadata object

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

names string[]

Example (from schema)

{
  "code": 0,
  "names": [
    "string"
  ]
}

NameListResponse

{
  "code": 0,
  "names": [
    "my_tag1",
    "my_tag2"
  ]
}

409

Conflict - The target tag already 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"
  ]
}

TagAlreadyAssociatedException

{
  "code": 1004,
  "type": "TagAlreadyAssociatedException",
  "message": "Failed to operate tag(s) [my_tag] operation [ASSOCIATE] under metalake [my_test_metalake], reason [TagAlreadyAssociatedException]",
  "stack": [
    "org.apache.gravitino.exceptions.TagAlreadyAssociatedException: Tag my_tag already associated",
    "..."
  ]
}

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