Update tag

PUT 
http://localhost:8090/api/metalakes/:metalake/tags/:tag

Alters the specified tag information in the specified metalake

Request

Path Parameters

metalake stringrequired

The name of the metalake

tag stringrequired

The name of the tag

application/json

Body

updates

object[]

required

Array [

oneOf

RenameTagRequest

@type stringrequired

Possible values: [rename]

newName stringrequired

The new name of the tag

UpdateTagCommentRequest

@type stringrequired

Possible values: [updateComment]

newComment stringrequired

The new comment of the tag

SetTagPropertyRequest

@type stringrequired

Possible values: [setProperty]

property stringrequired

The property to set

value stringrequired

The value to set

RemoveTagPropertyRequest

@type stringrequired

Possible values: [removeProperty]

property stringrequired

The property to remove

]

Responses

200

Returns the updated tag object

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-07-29T15:51:28.071Z",
      "lastModifier": "string",
      "lastModifiedTime": "2024-07-29T15:51:28.071Z"
    },
    "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
  }
}

404

Not Found - The specified tag does not exist in the specified metalake

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

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT 'http://localhost:8090/api/metalakes/:metalake/tags/:tag' \
-H 'Content-Type: application/json' \
-H 'Accept: application/vnd.gravitino.v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "updates": [
    {
      "@type": "rename",
      "newName": "my_tag_new"
    },
    {
      "@type": "updateComment",
      "newComment": "This is my new tag comment"
    },
    {
      "@type": "setProperty",
      "property": "key1",
      "value": "value1"
    },
    {
      "@type": "removeProperty",
      "property": "key2"
    }
  ]
}'

Request Collapse all

Base URL

http://localhost:8090/api

Auth

Security Scheme

OAuth2WithJWTBasicAuth

Bearer Token

Parameters

metalake — pathrequired

tag — pathrequired

Body

{
  "updates": [
    {
      "@type": "rename",
      "newName": "my_tag_new"
    },
    {
      "@type": "updateComment",
      "newComment": "This is my new tag comment"
    },
    {
      "@type": "setProperty",
      "property": "key1",
      "value": "value1"
    },
    {
      "@type": "removeProperty",
      "property": "key2"
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!