| --- |
| id: get-policy-for-object |
| title: "Get policy for metadata object" |
| description: "Get policy for metadata object" |
| sidebar_label: "Get policy for metadata object" |
| hide_title: true |
| hide_table_of_contents: true |
| api: eJztWutv2zgS/1cIfrldnOJX28Ouvrmp281uXkgcFLhcsGCkscWGIrUkldgw/L8fhhRlyVKevf1yaBDANkUO5/WbGQ61oZYtDY2vaaEET9b0JqKqAM0sV/IopTFdgj13jz4rfXb7DRJLI1owzXKwoHHphkqWA41pCpZxYWhEuaQx/asEvaYRTcEkmhdIkcb0SCaiTIH4yZASLhdK525Dwm5VaYnNgFTsRFTDXyXXkNJ4wYSBiJokg5zReEPtusBtb5USwKTbacFKYaup221Us5aDZYLdQeCtYDbrsDbPgOB8ohaOh8aiHRdWl31MGKu5XNL9PVNmmdfaHOc9tzsSa+6Oy4kKWn8pExEFWeZo1JPZfHo8/WNGI3o4nU+Pz77QiF4e/jY7mdKIzqcfj92js+Ork1Ma0c9Hx7PL2RwfnZ0fHdKInpx9mh3TiF6cHc/ozePSfS6FOMUHz0m4KIXoKPltYja5qd3l5dbt8bDn9rvByaZQ0oDB55PRCD/a+1yALbU0jT0q0QgzRiWcWUjJA7cZMQUkfMEh7VFCoqQFaZE8KwrBEweQ4b1MB0vN7rnlUg3ux//8ZnDTTZfpmlKhEdCWe5YTlUJjFpcWlqBpRD0I/dC7SUd7l5bZ0hBcHhQYVLHzt9HNNgqm6OGkTXFKbpnhSdARagTBHwSPqJJwtnDxZX9hYwlJSmNV3lhmuRW47aF74GMXRdOlHKnkXDKrNPJXaWZ92vShCqc5Kwo0OqrMEeoa+hk+mBAV+9+ph51/Xnt3j9qsgmS3AlLcsky5xRDetrnHSDdKvAgfW/TFPK988WkSU1JN7QvkshQCGfUw27aEeBFzzeC4Yy5I358PmjS+ZmAz0E1gckPC+m1Q3/OOi9NaaWuhNGHkS8AlIkOVOoFBF34agvc9L3BpQJOHTBG3CtKAOkfbGcaNz3m/eWtEp8zCgeXOc3rUynNoUSYPzIQtcRfBjD1RKUaq1zKOS0nu13bZbxBO/xYhWttjvqiDg7Mh8sBlBprb73CgmgJZaJX7h0wjCLpRfQ8DDYZ8nPrIDGqm64HNGBAiQwfnjZzxtAcf+omV31aRq5IIVw5eG74ghCtirC4TW2pwxB1N5K4tgSmLQmkL6a40Ml1xemftZGNas255GQKFwUixZwDMydwEQQPHCZPkFojLsuikCqXPuTyykBsajyPK/bfHy6wnaqvHSiqspfbkfU7POStQKL/7gVUH/hvZUXE6b3hnJaIzZ5pypMTEed+mocSJKKxYXgiHxTtYj2lM75koYUwj/D0Jvyd023Xfyq8e9eI9d3V+d1GKV4lfeavGZeQhA+1xfwcOjC4ElKLKZEz6oOM4DoZWC8Jkw8/7FdPWBJJEVfjPyH1OaDyevNtuXVnYV3RU2qCPz+jTIe0OXYRCa8eU09je03jjTbMr80bNaizU7es//diYNjI7nSMyuCGMWDB2l7WbSTpUQo2kW53JGpFnz6qV5lBT0SOIvu6iJhw7AmZ2KApQ60SLtrNu26Ed424jv9dZmDKp5DpXJUaoZjalk9Hkw8Hol4PR+/l4FE9+jSfvBu//9e7faDL3F9H3fdX/kUyxVgfU5C1LCYY9VChorfSAHGFhV4oUHTFhpYGU3K4Jk6SUsCogwTQSltyqdE18/iNKE+VyD/52sS3MumeCp1UZwrgoNUTElElGGKYm95TgIWFArkzJhFgTA/oe+WscK3BCiBYRYQJL0GVGuCRG5cipAUMMR88jFlZ2WAjG6xUk58vMokjanX28UAg8t5X+hyE5T1MBD0w7zP3vDjdt5f9+eXbqNU0KthbK6b/iiEvC6iOLL9kXpXY6rfoWREnHtCOwl7FyMIYtsfawvuh2AOvJwI+crnIueY7JYjwajfB0sap+jvFnW4rf5vPzHaeOZCMYjUejybZi49li7Eha0JIJXzunsODSBbtQRntRt1Et3wtK/KzMmTzQwFKMASSsRHhbltz1ZOhH8mcr+M2QkxOVgthLQl6l49HoXRCafmTphff+2SoBz1lDBHrCBMJkByUaAPu+C9hTZclnVcqUHBAsHtqHcmz/kFSBIVJZAituHBZta+KuFsRJ+6d82yH6d530f4Dh/xkMbtGpuiyTzCf+nfN3M38LL/2Lmoj57FuxVhHf/A0V5E/mZ3JdVww3pG4Nk+vjs+mnG1LKFPQOKTgX64c/w8hNRDQwzC7XvVzc0FpT11Tp5YAVLMmg4fkQpppBL4WY+AFSs7mHVxrRwWDgC25P4aRi7pUK7C57WoVBB06JqJWu/va109niDfrp0IhJGPK13WPq8UHyw2rV1+rymfzA8BTwwHErAI+6LOR+JIeHqDTVqBHEQn0aTgR3J0OeAhYheFBWuiJIPqxWHnim7nzlStcRMyGpSkqsUb3aOP6n/J6nJRNEq9KC+VFR/Aiib6ooJjXAL0qJHaR+ZNciX3qXnVXWrHH5jd2zgWByOdinE5P+xTcV2Nqa+ALh4OUQ0i0VcrCZqi7l3C2czWhMhyHQmOEmfN0Oq5aHH2pfQ233B8PtzXYYGjbDjWdki3I6zv1NX6kFjenGwQe28XC4yZSx23iD57rtcIO9oHNms23HzF9AguaJ7xZV4L+6OI48cJgQ2DWzeMMgF3xZanQFRPY90xy/mxq20I1PrnBzz4IfXl0cRQS4Q2NmbYFVG366aFHfE1IcQvdAKfrJ4pMQ1+r+yq6e85K0aAqVMOEIuia3foQwPiHuBPiQgQxbYEPHVtu2qP4y+nWEBIOGu0TPCt/HIIWGBV9hKvJ9LZCpz0yoZR8zW6RZwasmhYGk1Nyuna3PpqXNJl+5zX7/OndtO9D3PAHsnYJMgN5gj+cjXl7gTBpf3zRpXDp7OLPtUdoFXYbjHVfx071j4IKILoR68OHQ5ZJDDSlIy5nwQUDdgbxynulMHA+HsPKwO3BbHHgrDRKVD91k9OpEVf3EfbG8eVj103eSnIl2Df4Sz8OOTTxmWzfdZshSgo2FQXXgaOimltl5XFR7MnWXP2jYP0DfglbmmfkSlsri8aLqcSyUm1wFvR2LF7PLOZmeH9GICp5A1SCqmkBTV0WQyWBEowrTQXMPDw+hyFB6OazWmuHx0eHs9HJ2MBmMBpnNXVDFsOBNNh6MHK22IT9hegDThEyyuzHB0QXX2MPwdAJ2u0IM/iM9mIzNmWwI8mzIbDFUK3XXw0CyTgGbKpxe1+8KIEjixjsAVUQNo52r/fjRK/FGGzzevWfhY8413bioeaXFdovD/rUJd+3JTbvNtidMXfS8+qWKXjXcwbr1EkdVEVN3eRrC8CsZ++miKnl+Jk+8XdHLTkj5ct3kJbBZr8YY9GZ+nn7f4o1s7TnGdzH4gtclvpvL2lG/i9PeVyvewFu42cVXCTJgKd45Xm+qh9MEC6vGsueLfXTeum76MpvT7fa/y3zYNg== |
| 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 policy for metadata object"} |
| > |
| </Heading> |
| |
| <MethodEndpoint |
| method={"get"} |
| path={"/metalakes/{metalake}/objects/{metadataObjectType}/{metadataObjectFullName}/policies/{policy}"} |
| > |
| |
| </MethodEndpoint> |
| |
| |
| |
| Get policy 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":"policy","in":"path","description":"The name of the policy","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 policy","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 policy object associated with 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={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"} |
| > |
| policy |
| </strong><span |
| className={"openapi-schema__name"} |
| > |
| object |
| </span> |
| </span> |
| </summary><div |
| style={{"marginLeft":"1rem"}} |
| > |
| <div |
| style={{"marginTop":".5rem","marginBottom":".5rem"}} |
| > |
| |
| |
| A basic policy without content |
| |
| |
| </div><div> |
| <span |
| className={"badge badge--info"} |
| style={{"marginBottom":"1rem"}} |
| > |
| oneOf |
| </span><SchemaTabs> |
| <TabItem |
| label={"CustomPolicy"} |
| value={"0-item-properties"} |
| > |
| <div |
| style={{"marginTop":".5rem","marginBottom":".5rem"}} |
| className={"openapi-schema__summary"} |
| > |
| |
| |
| A policy with custom content |
| |
| |
| </div><SchemaItem |
| collapsible={false} |
| name={"name"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"The name of the policy"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"comment"} |
| required={false} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"A comment about the policy","nullable":true}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"policyType"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"The type of the policy"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"enabled"} |
| required={true} |
| schemaName={"boolean"} |
| qualifierMessage={undefined} |
| schema={{"type":"boolean","description":"Whether the policy is enabled"}} |
| > |
| |
| </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={false} |
| name={"inherited"} |
| required={false} |
| schemaName={"boolean"} |
| qualifierMessage={undefined} |
| schema={{"type":"boolean","description":"Whether the policy is inherited from the parent metadata object","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"} |
| > |
| content |
| </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"}} |
| > |
| |
| |
| Content for a custom policy type. |
| |
| |
| </div><SchemaItem |
| collapsible={false} |
| name={"supportedObjectTypes"} |
| required={true} |
| schemaName={"string[]"} |
| qualifierMessage={"**Possible values:** [`CATALOG`, `SCHEMA`, `TABLE`, `FILESET`, `TOPIC`, `MODEL`], `>= 1`"} |
| schema={{"type":"array","description":"The types of metadata objects this policy content can be applied to.","minItems":1,"items":{"type":"string","enum":["CATALOG","SCHEMA","TABLE","FILESET","TOPIC","MODEL"]}}} |
| > |
| |
| </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"}} |
| > |
| |
| |
| A map of string-to-string properties for the policy content. |
| |
| |
| </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={"customRules"} |
| required={false} |
| schemaName={"object"} |
| qualifierMessage={undefined} |
| schema={{"type":"object","description":"A map of custom rules where the key is the rule name and the value can be of any type.","example":{"rule1":"rule1","rule2":123}}} |
| > |
| |
| </SchemaItem> |
| </div> |
| </details> |
| </SchemaItem> |
| </TabItem> |
| </SchemaTabs> |
| </div> |
| </div> |
| </details> |
| </SchemaItem> |
| </ul> |
| </details> |
| </TabItem><TabItem |
| label={"Example (from schema)"} |
| value={"Example (from schema)"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 0\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem><TabItem |
| label={"PolicyResponse"} |
| value={"PolicyResponse"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 0,\n \"policy\": {\n \"name\": \"my_policy1\",\n \"comment\": \"This is a test policy\",\n \"policyType\": \"custom\",\n \"enabled\": false,\n \"content\": {\n \"customRules\": {\n \"rule1\": 123\n },\n \"supportedObjectTypes\": [\n \"SCHEMA\",\n \"TABLE\",\n \"MODEL\",\n \"TOPIC\",\n \"FILESET\",\n \"CATALOG\"\n ],\n \"properties\": {\n \"key1\": \"value1\"\n }\n },\n \"inherited\": null,\n \"audit\": {\n \"creator\": \"anonymous\",\n \"createTime\": \"2025-08-04T10:29:23.463Z\"\n }\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 policy 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={"NoSuchPolicyException"} |
| value={"NoSuchPolicyException"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1003,\n \"type\": \"NoSuchPolicyException\",\n \"message\": \"Failed to operate policy(s) [my_policy] operation [LOAD] under metalake [my_test_metalake], reason [NoSuchPolicyException]\",\n \"stack\": [\n \"org.apache.gravitino.exceptions.NoSuchPolicyException: Policy my_policy 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> |
| |
