| --- |
| id: get-object-tag |
| title: "Get tag for metadata object" |
| description: "Get tag for metadata object" |
| sidebar_label: "Get tag for metadata object" |
| hide_title: true |
| hide_table_of_contents: true |
| api: eJztWVtv27gS/isEX84ujmI7bgNs9eambje7uRSJgwInx1jQ4thiQ5FakkpsGPrviyElWbKcpE3PeWtRIBYvw7l+MxxuqWMrS+M7/EvnEdU5GOaEVmecxnQF7mrxFRI3Yysa0ZwZloEDgzu2VLEMaEw5OCakpREVisb07wLMhkaUg02MyJEWjemZSmTBgYTFwIlQS20yfxRhC1044lIgzp9j4O9CGOA0XjJpIaI2SSFjNN5St8nxzIXWEpjyxyxZIV21tCyjhq8MHJPsHmrGcubSHl+zFAiuJ3rpGWht2nHhTHGICeuMUCu6fyZnjlVaw3UvnY7E2qfjdqL9/u9gIqKgigwNeTGdTc4nf05pRE8ns8n51Sca0ZvT36cXExrR2eT9uZ+6Or+9uKQR/Xh2Pr2ZznDq6vPZKY3oxdWH6TmN6PXV+ZTOn5buYyHlJU68JOGykLKn5NeJ2eYm+Mq3m3bft146aY6Lba6VBYvz49EI/3QPuQZXGGX9AVJY5w9jq0oyS5i1OhHMASePwqXE5pCIpQC+rwQilmRbhVJJhCWePaJdCuZRWCDmiZNUMEGilQPlkEOW51IkPrSGD4oPVoY9CCeUHjwc//urRb63fbkbW+QGQcCJIHWiObRWCeVgBYZGNIRvGHoz7mn/xjFXWILbawPU2tw562heRt6OB9jokpv0zHdHK8lZwYVD7OoyHrykHycvO0mJ2syySpvP75+QamkPxFQhJVtICI5W1ny+LCku68DjUhvCyKfaiqhHXZgEBn1jGWBOm28Tu7BgyGOqid8FvLaRp+2V4Mdn4rAeG/tz5uDICW+LA/AmMuhQJo/M1kfiKZJZd6E5BsX3Mo5bSRb29tlvEeb/FyE6xyM0USccGjzYEHnomud5w59qtRSrwgAngT/idP0rYzl66I6cd4qdszVZcIuOxrlAmkx+PnT8DkqpUCkYgYY4nFrb7H1JAbGoPhQhqtlOlkZnfiZnBoOhj/B74dBSFtYWe9/XNVKUEYU1y3IZJGhPxVv6wGQBO5AaNVhS56vNX46tjmkrnuksRcYtyTakmuva6B42xzQOpHH2Hjbj+ntM22HcBBttAJZ2g4aOR+M3R8fjo9Fvs9Gb+O1xPD4ZnLw7+Q/t6r4qXfy/iL49lGfOFEdIB0sYWTBOEAfBOgLGaDMgZ44kupCcLIAkrLDAyWJDmCKFgnUOCdqo3rLQfEOC4xNtQobx3xZdrF71wKTgFf4wIQsDEbFFkhKGdvezBHPJgNzagkm5IRbMA/LXyj64gFSZKSJMulQXq5QIRazOkFMLlliB9iUO1m6YSyaaHSQTq9ShSCH3BaHQy/xR5l+WZIJzCY/MeDD83+XArvL/uLm6DJomOdtI7fVfcSQUYU1mCzl+WRiv0yqbE608057AXgrLwFq2QtBxoVb0ntzLZU8m4UwokWEqPR6NRhHN2Lr6PMbPrhS/z2afd5x6kk10eQLjsmLjRRQ+Uw6MYjIUrxyWQnnEqbNoELWMGvm+IY+mRcbUkQHGESZIvbOMqHUsuW+RYMYwvGEIB9lBYGuByRQ5udAcZAtLdio9Ho3e1ELT94xfB++frhMInLVEoBdMYpjsQonWAfu2H7CX2pGPulCcHBFMId3CD68YhGuwRGlHYO3ruYCtu4UVyuKK/TLS9Sh20fZnJPyMhG+JBL/pUt8USTpjq53b95NrJ1IO7GgHysdwxXeahHaCLxh+sb+Su5CR56RpM5C786vJhzkpFAezCw2/EKz7qx6ZR8QAw3Ry1z98ThvV3FFtVgOWsySFlqtDvdQO+ttjMmMrEljbC0oa0cFg4G/BldAXFUPfqav+tucVVsvttYaa6OtsXyO9I16hlh6NmNRDBLl4Uj0BCU/W6z4STqp0fWQFByxhFxKwWGR1gkdyCyCMc4MaQZ9v6slECqwEcCtWGlhqalMRJCfrdQgw6+EG71+ZNg0yJoTrpMC6L6hN4H8uHgQvmCRGFw7sz7LhJ1i+qmwYNwF+XSi8Hx6O7Ebkm+Cy08qaTVx+ZQ9sIJlaDfbpxOTw5nkVbF1NfALnCwYMj349kIFLddXR9Y1cl9KYDmuUscNt/bMcVq2rMNRtZpb7g3UPsBxiH3m4dWxVonSe39AlLoykMd36oIEyHg63qbaujLe5Nq4cbhfMwmfm0rJn3E+gwIiE4Io65G+vz6MQLkxKvG067DGFizM6AMbzAzMCf9smWKGPSr4m83O1991en0UEhI/B1LkcCzL86zGiuWBTHEKnQCkOk8WZGs2ae/quWguSdGhKnTDpCWLPQJsnCOMM8Ze7xxRUfYTvFFTHdqj+Nno3QoK1hvtEr/LQJyC5gaVYYwJCIM5zUDzkI9RyQMoOaZYLDJg5mjopjHAbb+urSeHS8Rfh0j++zNC7UVaRAPZDQCVA59i/fc+sSHAlje/mbRo33h7ebHuUdlDLcLznKmF5cAzcENGl1I8BBH0GOTXAQTnBZAh9fQ/q1numN3E8HMI6BNuRP+IoWGmQ6GzoF6NXJzqvnGpPrGAeVn2GhqI30a5pV+BV17OJN2jnl7sUWUqwizCo7hIt3TQye4+LGk9Ge4oEDfsnmAUYbV9Yr2ClHV4eqp7PUvvFFdTtWLye3szI5PMZjagUCVRNlqqXMvG1AxkPRjSqYrrW3OPjY11aaLMaVnvt8PzsdHp5Mz0aD0aD1GUeShEWgslGg3eD454hP2BSANsOmWTXBcXRpTDYngh06tjtCzH4rwrBZF3GVEuQ54Gyw02j0V1vAml66bcViN4170wYIXHr/ajC0Xq09ywUP/mc4t/kIhpXb3IBae7o1mPlrZFlicPhoQ3DjgtfNe3ey/akaAqc73uGOyj8PWw6b35V6UspBnKNvN/J1S/XVW3zK3nmPe4gO3VuV5s2LzWbzW6EnVfz8/wL3SvZ2nOHH2LwGx7YfpjLxj1/iNP+e9wrGPNvNPhylALj+Ghwt61mJgnWTq09L9fz6LZNdfRpOqNl+Q8xXMj5 |
| sidebar_class_name: "get api-method" |
| info_path: docs/api/rest/gravitino-rest-api |
| custom_edit_url: null |
| --- |
| |
| import ApiTabs from "@theme/ApiTabs"; |
| import DiscriminatorTabs from "@theme/DiscriminatorTabs"; |
| import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; |
| import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; |
| import MimeTabs from "@theme/MimeTabs"; |
| import ParamsItem from "@theme/ParamsItem"; |
| import ResponseSamples from "@theme/ResponseSamples"; |
| import SchemaItem from "@theme/SchemaItem"; |
| import SchemaTabs from "@theme/SchemaTabs"; |
| import Heading from "@theme/Heading"; |
| import OperationTabs from "@theme/OperationTabs"; |
| import TabItem from "@theme/TabItem"; |
| |
| <Heading |
| as={"h1"} |
| className={"openapi__heading"} |
| children={"Get tag for metadata object"} |
| > |
| </Heading> |
| |
| <MethodEndpoint |
| method={"get"} |
| path={"/metalakes/{metalake}/objects/{metadataObjectType}/{metadataObjectFullName}/tags/{tag}"} |
| > |
| |
| </MethodEndpoint> |
| |
| |
| |
| Get tag for metadata object |
| |
| <Heading |
| id={"request"} |
| as={"h2"} |
| className={"openapi-tabs__heading"} |
| children={"Request"} |
| > |
| </Heading> |
| |
| <details |
| style={{"marginBottom":"1rem"}} |
| className={"openapi-markdown__details"} |
| data-collapsed={false} |
| open={true} |
| > |
| <summary |
| style={{}} |
| > |
| <h3 |
| className={"openapi-markdown__details-summary-header-params"} |
| > |
| Path Parameters |
| </h3> |
| </summary><div> |
| <ul> |
| <ParamsItem |
| className={"paramsItem"} |
| param={{"name":"metalake","in":"path","description":"The name of the metalake","required":true,"schema":{"type":"string"}}} |
| > |
| |
| </ParamsItem><ParamsItem |
| className={"paramsItem"} |
| param={{"name":"metadataObjectType","in":"path","description":"The type of the metadata object","required":true,"schema":{"type":"string","enum":["METALAKE","CATALOG","SCHEMA","TABLE","COLUMN","FILESET","TOPIC","MODEL","ROLE"]}}} |
| > |
| |
| </ParamsItem><ParamsItem |
| className={"paramsItem"} |
| param={{"name":"metadataObjectFullName","in":"path","description":"The full name of the metadata object","required":true,"schema":{"type":"string"}}} |
| > |
| |
| </ParamsItem><ParamsItem |
| className={"paramsItem"} |
| param={{"name":"tag","in":"path","description":"The name of the tag","required":true,"schema":{"type":"string"}}} |
| > |
| |
| </ParamsItem> |
| </ul> |
| </div> |
| </details><details |
| style={{"marginBottom":"1rem"}} |
| className={"openapi-markdown__details"} |
| data-collapsed={false} |
| open={true} |
| > |
| <summary |
| style={{}} |
| > |
| <h3 |
| className={"openapi-markdown__details-summary-header-params"} |
| > |
| Query Parameters |
| </h3> |
| </summary><div> |
| <ul> |
| <ParamsItem |
| className={"paramsItem"} |
| param={{"name":"details","in":"query","description":"Include detailed information about the tag","required":false,"schema":{"type":"boolean","default":false}}} |
| > |
| |
| </ParamsItem> |
| </ul> |
| </div> |
| </details><div> |
| <div> |
| <ApiTabs |
| label={undefined} |
| id={undefined} |
| > |
| <TabItem |
| label={"200"} |
| value={"200"} |
| > |
| <div> |
| |
| |
| Returns the list of tag objects associated with specified metadata object if \{details\} is true, otherwise returns the list of tag name |
| |
| |
| </div><div> |
| <MimeTabs |
| className={"openapi-tabs__mime"} |
| schemaType={"response"} |
| > |
| <TabItem |
| label={"application/vnd.gravitino.v1+json"} |
| value={"application/vnd.gravitino.v1+json"} |
| > |
| <SchemaTabs |
| className={"openapi-tabs__schema"} |
| > |
| <TabItem |
| label={"Schema"} |
| value={"Schema"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details response"} |
| data-collapsed={false} |
| open={true} |
| > |
| <summary |
| style={{}} |
| className={"openapi-markdown__details-summary-response"} |
| > |
| <strong> |
| Schema |
| </strong> |
| </summary><div |
| style={{"textAlign":"left","marginLeft":"1rem"}} |
| > |
| |
| </div><ul |
| style={{"marginLeft":"1rem"}} |
| > |
| <SchemaItem |
| collapsible={false} |
| name={"code"} |
| required={false} |
| schemaName={"int32"} |
| qualifierMessage={"**Possible values:** [`0`]"} |
| schema={{"type":"integer","format":"int32","description":"Status code of the response","enum":[0]}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={true} |
| className={"schemaItem"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details"} |
| > |
| <summary |
| style={{}} |
| > |
| <span |
| className={"openapi-schema__container"} |
| > |
| <strong |
| className={"openapi-schema__property"} |
| > |
| tag |
| </strong><span |
| className={"openapi-schema__name"} |
| > |
| object |
| </span> |
| </span> |
| </summary><div |
| style={{"marginLeft":"1rem"}} |
| > |
| <div |
| style={{"marginTop":".5rem","marginBottom":".5rem"}} |
| > |
| |
| |
| A tag |
| |
| |
| </div><SchemaItem |
| collapsible={false} |
| name={"name"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"The name of the tag"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"comment"} |
| required={false} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"A comment about the tag","nullable":true}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={true} |
| className={"schemaItem"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details"} |
| > |
| <summary |
| style={{}} |
| > |
| <span |
| className={"openapi-schema__container"} |
| > |
| <strong |
| className={"openapi-schema__property"} |
| > |
| audit |
| </strong><span |
| className={"openapi-schema__name"} |
| > |
| object |
| </span><span |
| className={"openapi-schema__divider"} |
| > |
| |
| </span><span |
| className={"openapi-schema__required"} |
| > |
| required |
| </span> |
| </span> |
| </summary><div |
| style={{"marginLeft":"1rem"}} |
| > |
| <div |
| style={{"marginTop":".5rem","marginBottom":".5rem"}} |
| > |
| |
| |
| Audit information for a Gravitino resource. |
| |
| |
| </div><SchemaItem |
| collapsible={false} |
| name={"creator"} |
| required={false} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"The user who created the resource"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"createTime"} |
| required={false} |
| schemaName={"date-time"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","format":"date-time","description":"The time the resource was created"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"lastModifier"} |
| required={false} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"The user who last modified the resource"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"lastModifiedTime"} |
| required={false} |
| schemaName={"date-time"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","format":"date-time","description":"The time the resource was last modified"}} |
| > |
| |
| </SchemaItem> |
| </div> |
| </details> |
| </SchemaItem><SchemaItem |
| collapsible={true} |
| className={"schemaItem"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details"} |
| > |
| <summary |
| style={{}} |
| > |
| <span |
| className={"openapi-schema__container"} |
| > |
| <strong |
| className={"openapi-schema__property"} |
| > |
| properties |
| </strong><span |
| className={"openapi-schema__name"} |
| > |
| object |
| </span> |
| </span> |
| </summary><div |
| style={{"marginLeft":"1rem"}} |
| > |
| <div |
| style={{"marginTop":".5rem","marginBottom":".5rem"}} |
| > |
| |
| |
| Configured string to string map of properties for the tag |
| |
| |
| </div><SchemaItem |
| name={"property name*"} |
| required={false} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string"}} |
| collapsible={false} |
| discriminator={false} |
| > |
| |
| </SchemaItem> |
| </div> |
| </details> |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"inherited"} |
| required={false} |
| schemaName={"boolean"} |
| qualifierMessage={undefined} |
| schema={{"type":"boolean","description":"Whether the tag is inherited from the parent metadata object","nullable":true}} |
| > |
| |
| </SchemaItem> |
| </div> |
| </details> |
| </SchemaItem> |
| </ul> |
| </details> |
| </TabItem><TabItem |
| label={"Example (from schema)"} |
| value={"Example (from schema)"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 0,\n \"tag\": {\n \"name\": \"string\",\n \"comment\": \"string\",\n \"audit\": {\n \"creator\": \"string\",\n \"createTime\": \"2024-07-29T15:51:28.071Z\",\n \"lastModifier\": \"string\",\n \"lastModifiedTime\": \"2024-07-29T15:51:28.071Z\"\n },\n \"properties\": {},\n \"inherited\": true\n }\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem><TabItem |
| label={"TagResponse"} |
| value={"TagResponse"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 0,\n \"tag\": {\n \"name\": \"my_tag1\",\n \"comment\": \"This is my tag1\",\n \"properties\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"audit\": {\n \"creator\": \"gravitino\",\n \"createTime\": \"2023-12-08T03:41:25.595Z\"\n },\n \"inherited\": false\n }\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem> |
| </SchemaTabs> |
| </TabItem> |
| </MimeTabs> |
| </div> |
| </TabItem><TabItem |
| label={"400"} |
| value={"400"} |
| > |
| <div> |
| |
| |
| 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. |
| |
| |
| </div><div> |
| <MimeTabs |
| className={"openapi-tabs__mime"} |
| schemaType={"response"} |
| > |
| <TabItem |
| label={"application/vnd.gravitino.v1+json"} |
| value={"application/vnd.gravitino.v1+json"} |
| > |
| <SchemaTabs |
| className={"openapi-tabs__schema"} |
| > |
| <TabItem |
| label={"Schema"} |
| value={"Schema"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details response"} |
| data-collapsed={false} |
| open={true} |
| > |
| <summary |
| style={{}} |
| className={"openapi-markdown__details-summary-response"} |
| > |
| <strong> |
| Schema |
| </strong> |
| </summary><div |
| style={{"textAlign":"left","marginLeft":"1rem"}} |
| > |
| |
| </div><ul |
| style={{"marginLeft":"1rem"}} |
| > |
| <SchemaItem |
| collapsible={false} |
| name={"code"} |
| required={true} |
| schemaName={"integer"} |
| qualifierMessage={"**Possible values:** `>= 1000` and `<= 1100`"} |
| schema={{"type":"integer","minimum":1000,"maximum":1100,"description":"HTTP response code","example":1002}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"type"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"Internal type definition of the error"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"message"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"A human-readable message"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"stack"} |
| required={false} |
| schemaName={"string[]"} |
| qualifierMessage={undefined} |
| schema={{"type":"array","items":{"type":"string"}}} |
| > |
| |
| </SchemaItem> |
| </ul> |
| </details> |
| </TabItem><TabItem |
| label={"Example (from schema)"} |
| value={"Example (from schema)"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1002,\n \"type\": \"string\",\n \"message\": \"string\",\n \"stack\": [\n \"string\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem><TabItem |
| label={"Example"} |
| value={"Example"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1003,\n \"type\": \"BadRequestException\",\n \"message\": \"Malformed request\"\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem> |
| </SchemaTabs> |
| </TabItem> |
| </MimeTabs> |
| </div> |
| </TabItem><TabItem |
| label={"404"} |
| value={"404"} |
| > |
| <div> |
| |
| |
| Not Found - The specified metalake does not exist or the specified tag is not associated with the specified metadata object |
| |
| |
| </div><div> |
| <MimeTabs |
| className={"openapi-tabs__mime"} |
| schemaType={"response"} |
| > |
| <TabItem |
| label={"application/vnd.gravitino.v1+json"} |
| value={"application/vnd.gravitino.v1+json"} |
| > |
| <SchemaTabs |
| className={"openapi-tabs__schema"} |
| > |
| <TabItem |
| label={"Schema"} |
| value={"Schema"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details response"} |
| data-collapsed={false} |
| open={true} |
| > |
| <summary |
| style={{}} |
| className={"openapi-markdown__details-summary-response"} |
| > |
| <strong> |
| Schema |
| </strong> |
| </summary><div |
| style={{"textAlign":"left","marginLeft":"1rem"}} |
| > |
| |
| </div><ul |
| style={{"marginLeft":"1rem"}} |
| > |
| <SchemaItem |
| collapsible={false} |
| name={"code"} |
| required={true} |
| schemaName={"integer"} |
| qualifierMessage={"**Possible values:** `>= 1000` and `<= 1100`"} |
| schema={{"type":"integer","minimum":1000,"maximum":1100,"description":"HTTP response code","example":1002}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"type"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"Internal type definition of the error"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"message"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"A human-readable message"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"stack"} |
| required={false} |
| schemaName={"string[]"} |
| qualifierMessage={undefined} |
| schema={{"type":"array","items":{"type":"string"}}} |
| > |
| |
| </SchemaItem> |
| </ul> |
| </details> |
| </TabItem><TabItem |
| label={"Example (from schema)"} |
| value={"Example (from schema)"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1002,\n \"type\": \"string\",\n \"message\": \"string\",\n \"stack\": [\n \"string\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem><TabItem |
| label={"NoSuchTagException"} |
| value={"NoSuchTagException"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1003,\n \"type\": \"NoSuchTagException\",\n \"message\": \"Failed to operate tag(s) [my_tag] operation [LOAD] under metalake [my_test_metalake], reason [NoSuchTagException]\",\n \"stack\": [\n \"org.apache.gravitino.exceptions.NoSuchTagException: Tag my_tag does not exist\",\n \"...\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem><TabItem |
| label={"NoSuchMetalakeException"} |
| value={"NoSuchMetalakeException"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1003,\n \"type\": \"NoSuchMetalakeException\",\n \"message\": \"Failed to operate metalake(s) [test] operation [LOAD], reason [NoSuchMetalakeException]\",\n \"stack\": [\n \"org.apache.gravitino.exceptions.NoSuchMetalakeException: Metalake test does not exist\",\n \"...\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem> |
| </SchemaTabs> |
| </TabItem> |
| </MimeTabs> |
| </div> |
| </TabItem><TabItem |
| label={"5xx"} |
| value={"5xx"} |
| > |
| <div> |
| |
| |
| 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. |
| |
| |
| </div><div> |
| <MimeTabs |
| className={"openapi-tabs__mime"} |
| schemaType={"response"} |
| > |
| <TabItem |
| label={"application/vnd.gravitino.v1+json"} |
| value={"application/vnd.gravitino.v1+json"} |
| > |
| <SchemaTabs |
| className={"openapi-tabs__schema"} |
| > |
| <TabItem |
| label={"Schema"} |
| value={"Schema"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details response"} |
| data-collapsed={false} |
| open={true} |
| > |
| <summary |
| style={{}} |
| className={"openapi-markdown__details-summary-response"} |
| > |
| <strong> |
| Schema |
| </strong> |
| </summary><div |
| style={{"textAlign":"left","marginLeft":"1rem"}} |
| > |
| |
| </div><ul |
| style={{"marginLeft":"1rem"}} |
| > |
| <SchemaItem |
| collapsible={false} |
| name={"code"} |
| required={true} |
| schemaName={"integer"} |
| qualifierMessage={"**Possible values:** `>= 1000` and `<= 1100`"} |
| schema={{"type":"integer","minimum":1000,"maximum":1100,"description":"HTTP response code","example":1002}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"type"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"Internal type definition of the error"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"message"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"A human-readable message"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"stack"} |
| required={false} |
| schemaName={"string[]"} |
| qualifierMessage={undefined} |
| schema={{"type":"array","items":{"type":"string"}}} |
| > |
| |
| </SchemaItem> |
| </ul> |
| </details> |
| </TabItem><TabItem |
| label={"Example (from schema)"} |
| value={"Example (from schema)"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1002,\n \"type\": \"string\",\n \"message\": \"string\",\n \"stack\": [\n \"string\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem><TabItem |
| label={"Example"} |
| value={"Example"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1002,\n \"type\": \"RuntimeException\",\n \"message\": \"Internal Server Error\",\n \"stack\": [\n \"java.lang.RuntimeException: Internal Server Error\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem> |
| </SchemaTabs> |
| </TabItem> |
| </MimeTabs> |
| </div> |
| </TabItem> |
| </ApiTabs> |
| </div> |
| </div> |
| |
