Endpoint
A compute endpoint of a Lakebase Postgres branch. An endpoint provides the compute that runs Postgres for the branch's data and the hostnames that clients connect to. Each branch has one read-write endpoint, created together with the branch, and can have additional read-only endpoints (read replicas).
Endpoint object
A compute endpoint of a Lakebase Postgres branch. An endpoint provides the compute that runs Postgres for the branch's data and the hostnames that clients connect to. Each branch has one read-write endpoint, created together with the branch, and can have additional read-only endpoints (read replicas).
- namestringIDImmutable
Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- uidstringOutput only
A system-generated ID that identifies the endpoint. Unlike
name, it is not derived from the user-chosen endpoint ID. The endpoint's connection hostnames are based on this ID.
- parentstringOutput only
The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- create_timestringOutput only
A timestamp indicating when the compute endpoint was created.
- update_timestringOutput only
A timestamp indicating when the compute endpoint was last updated.
- specobject
The desired configuration of the endpoint. Every field under
specexceptendpoint_typecan be changed after creation. Seestatusfor the configuration that is currently in effect.Read the resource's current values from
status, rather thanspec.spectracks field ownership for infrastructure-as-code tools and may omit unmanaged fields.Show child attributesHide child attributes
- endpoint_typestringImmutable
The endpoint type. A branch can only have one READ_WRITE endpoint.
ENDPOINT_TYPE_READ_WRITEENDPOINT_TYPE_READ_ONLY
- autoscaling_limit_min_cudouble
The minimum number of Compute Units. Minimum value is 0.5, and it must not exceed
autoscaling_limit_max_cu. When omitted at creation, the project's default endpoint settings apply.
- autoscaling_limit_max_cudouble
The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16. Set it equal to
autoscaling_limit_min_cufor a fixed-size compute. When omitted at creation, the project's default endpoint settings apply.
- disabledboolean
Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action. To accept connections again, set this field back to false.
- suspend_timeout_durationstring
Duration of inactivity after which the compute endpoint is automatically suspended. If specified, the value must be between 60s and 604800s (1 minute to 1 week). A suspended endpoint keeps its hostnames and configuration, and the next connection attempt restarts it. When neither this field nor
no_suspensionis set at creation, the project's default endpoint settings apply. Mutually exclusive withno_suspension.
- no_suspensionboolean
When set to true, explicitly disables automatic suspension (never suspend). The value must be true when provided. Mutually exclusive with
suspend_timeout_duration.
- settingsobject
Postgres server parameters for the compute endpoint. On update, an empty
pg_settingsmap leaves the current parameters unchanged.Show child attributesHide child attributes
- pg_settingsobject
Postgres server parameters to set on the compute endpoint, keyed by parameter name. Each value is given as a string.
- groupobject
Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults to non HA settings, with a single compute backing the endpoint (and no readable secondaries for Read/Write endpoints). Automatic suspension is not available for an endpoint with more than one compute, so set
no_suspensionto true when configuring one.Show child attributesHide child attributes
- minint32
The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1.
- maxint32
The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec.
- enable_readable_secondariesboolean
Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where
maxis greater than 1. When enabled, the endpoint also reports a read-only host instatus.hosts.
- statusobjectOutput only
The configuration and state of the endpoint that are currently in effect, as reported by the system, including the hostnames to connect to.
Show child attributesHide child attributes
- endpoint_typestringOutput only
The endpoint type. A branch can only have one READ_WRITE endpoint.
ENDPOINT_TYPE_READ_WRITEENDPOINT_TYPE_READ_ONLY
- hostsobjectOutput only
Contains host information for connecting to the endpoint.
Show child attributesHide child attributes
- hoststringOutput only
The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations.
- read_only_hoststringOutput only
An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled.
- read_write_pooled_hoststringOutput only
The read-write hostname of the compute endpoint, with pooling. This attribute is only defined for read-write endpoints.
- read_only_pooled_hoststringOutput only
The read-only hostname of the compute endpoint, with pooling. This attribute is always defined for read-only endpoints, and may be defined for read-write endpoints if configured with read replicas and allow read-only connections.
- last_active_timestringOutput only
A timestamp indicating when the compute endpoint was last active.
- autoscaling_limit_min_cudoubleOutput only
The minimum number of Compute Units.
- autoscaling_limit_max_cudoubleOutput only
The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16.
- current_statestringOutput only
The state the compute endpoint is in now.
INITACTIVEIDLEDEGRADED
- pending_statestringOutput only
The state the compute endpoint is transitioning to, if a transition is in progress.
INITACTIVEIDLEDEGRADED
- disabledbooleanOutput only
Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action.
- suspend_timeout_durationstringOutput only
Duration of inactivity after which the compute endpoint is automatically suspended. Absent when automatic suspension is disabled.
- settingsobjectOutput only
The Postgres server parameters currently set on the compute endpoint.
Show child attributesHide child attributes
- pg_settingsobject
Postgres server parameters to set on the compute endpoint, keyed by parameter name. Each value is given as a string.
- groupobjectOutput only
Details on the HA configuration of the endpoint.
Show child attributesHide child attributes
- minint32
The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1.
- maxint32
The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec.
- enable_readable_secondariesbooleanOutput only
Whether read-only connections to read-write endpoints are allowed. Only relevant if the endpoint has more than one compute (
maxgreater than 1).
- endpoint_idstringOutput only
The endpoint ID, which is the final segment of the endpoint's resource name.
- endpoint_idstringOutput only
The endpoint ID chosen when the endpoint was created. It is the final segment of
name.
Get an Endpoint GA
GET
Retrieves information about the specified compute endpoint, including its connection details and operational state.
API scopes: postgres
Parameters
- namestringRequiredpath
The full resource path of the endpoint to retrieve. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Response
Returns the Endpoint object.
List Endpoints GA
GET
Lists the compute endpoints in the branch, including its read-write endpoint and any read-only endpoints.
API scopes: postgres
Parameters
- parentstringRequiredpath
The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}
- page_tokenstringquery
Page token from a previous response. If not provided, returns the first page.
- page_sizeint32query
Upper bound for the number of endpoints returned. If set, the value must be at least 10.
Response
Returns a list of Endpoint objects.
Create an Endpoint GA
POST
Creates a compute endpoint in the branch. Each branch gets its read-write endpoint when the branch is
created, so use this method to add read-only endpoints (read replicas) or, with replace_existing,
to reconfigure the existing read-write endpoint.
API scopes: postgres
Parameters
- parentstringRequiredpath
The Branch where this Endpoint will be created. Format: projects/{project_id}/branches/{branch_id}
- endpoint_idstringRequiredquery
The ID to use for the endpoint. It becomes the final segment of the endpoint's resource name,
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}. The ID must be 3 to 63 characters long, start with a lowercase letter, end with a lowercase letter or digit, and contain only lowercase letters, digits, and hyphens.
- replace_existingbooleanInput onlyquery
If true, update the endpoint if it already exists instead of returning an error. The request's
spec.endpoint_typemust match the existing endpoint's type, and the otherspecfields are applied as an update. Use this to configure the read-write endpoint that was created together with the branch.
Request body
The endpoint to create. Only spec is read from this message; the system sets the other fields.
- namestringIDImmutable
Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- specobject
The desired configuration of the endpoint. Every field under
specexceptendpoint_typecan be changed after creation. Seestatusfor the configuration that is currently in effect.Read the resource's current values from
status, rather thanspec.spectracks field ownership for infrastructure-as-code tools and may omit unmanaged fields.Show child attributesHide child attributes
- endpoint_typestringRequiredImmutable
The endpoint type. A branch can only have one READ_WRITE endpoint.
ENDPOINT_TYPE_READ_WRITEENDPOINT_TYPE_READ_ONLY
- autoscaling_limit_min_cudouble
The minimum number of Compute Units. Minimum value is 0.5, and it must not exceed
autoscaling_limit_max_cu. When omitted at creation, the project's default endpoint settings apply.
- autoscaling_limit_max_cudouble
The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16. Set it equal to
autoscaling_limit_min_cufor a fixed-size compute. When omitted at creation, the project's default endpoint settings apply.
- disabledboolean
Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action. To accept connections again, set this field back to false.
- suspend_timeout_durationstring
Duration of inactivity after which the compute endpoint is automatically suspended. If specified, the value must be between 60s and 604800s (1 minute to 1 week). A suspended endpoint keeps its hostnames and configuration, and the next connection attempt restarts it. When neither this field nor
no_suspensionis set at creation, the project's default endpoint settings apply. Mutually exclusive withno_suspension.
- no_suspensionboolean
When set to true, explicitly disables automatic suspension (never suspend). The value must be true when provided. Mutually exclusive with
suspend_timeout_duration.
- settingsobject
Postgres server parameters for the compute endpoint. On update, an empty
pg_settingsmap leaves the current parameters unchanged.Show child attributesHide child attributes
- pg_settingsobject
Postgres server parameters to set on the compute endpoint, keyed by parameter name. Each value is given as a string.
- groupobject
Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults to non HA settings, with a single compute backing the endpoint (and no readable secondaries for Read/Write endpoints). Automatic suspension is not available for an endpoint with more than one compute, so set
no_suspensionto true when configuring one.Show child attributesHide child attributes
- minint32Required
The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1.
- maxint32Required
The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec.
- enable_readable_secondariesboolean
Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where
maxis greater than 1. When enabled, the endpoint also reports a read-only host instatus.hosts.
Response
- namestring
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the
nameshould be a resource name ending withoperations/{unique_id}.
- metadataobject
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata.
- doneboolean
If the value is
false, it means the operation is still in progress. Iftrue, the operation is completed, and eithererrororresponseis available.
- errorobject
The error result of the operation in case of failure or cancellation.
Show child attributesHide child attributes
- error_codestring
Error codes returned by Databricks APIs to indicate specific failure conditions.
Show 81 possible values
UNKNOWNINTERNAL_ERRORTEMPORARILY_UNAVAILABLEIO_ERRORBAD_REQUESTSERVICE_UNDER_MAINTENANCEWORKSPACE_TEMPORARILY_UNAVAILABLEDEADLINE_EXCEEDEDCANCELLEDRESOURCE_EXHAUSTEDABORTEDNOT_FOUNDALREADY_EXISTSUNAUTHENTICATEDUNAVAILABLEINVALID_PARAMETER_VALUEENDPOINT_NOT_FOUNDMALFORMED_REQUESTINVALID_STATEPERMISSION_DENIEDFEATURE_DISABLEDCUSTOMER_UNAUTHORIZEDREQUEST_LIMIT_EXCEEDEDRESOURCE_CONFLICTUNPARSEABLE_HTTP_ERRORNOT_IMPLEMENTEDDATA_LOSSINVALID_STATE_TRANSITIONCOULD_NOT_ACQUIRE_LOCKRESOURCE_ALREADY_EXISTSRESOURCE_DOES_NOT_EXISTQUOTA_EXCEEDEDMAX_BLOCK_SIZE_EXCEEDEDMAX_READ_SIZE_EXCEEDEDPARTIAL_DELETEMAX_LIST_SIZE_EXCEEDEDDRY_RUN_FAILEDRESOURCE_LIMIT_EXCEEDEDDIRECTORY_NOT_EMPTYDIRECTORY_PROTECTEDMAX_NOTEBOOK_SIZE_EXCEEDEDMAX_CHILD_NODE_SIZE_EXCEEDEDSEARCH_QUERY_TOO_LONGSEARCH_QUERY_TOO_SHORTMANAGED_RESOURCE_GROUP_DOES_NOT_EXISTPERMISSION_NOT_PROPAGATEDDEPLOYMENT_TIMEOUTGIT_CONFLICTGIT_UNKNOWN_REFGIT_SENSITIVE_TOKEN_DETECTEDGIT_URL_NOT_ON_ALLOW_LISTGIT_REMOTE_ERRORPROJECTS_OPERATION_TIMEOUTIPYNB_FILE_IN_REPOINSECURE_PARTNER_RESPONSEMALFORMED_PARTNER_RESPONSEMETASTORE_DOES_NOT_EXISTDAC_DOES_NOT_EXISTCATALOG_DOES_NOT_EXISTSCHEMA_DOES_NOT_EXISTTABLE_DOES_NOT_EXISTSHARE_DOES_NOT_EXISTRECIPIENT_DOES_NOT_EXISTSTORAGE_CREDENTIAL_DOES_NOT_EXISTEXTERNAL_LOCATION_DOES_NOT_EXISTPRINCIPAL_DOES_NOT_EXISTPROVIDER_DOES_NOT_EXISTMETASTORE_ALREADY_EXISTSDAC_ALREADY_EXISTSCATALOG_ALREADY_EXISTSSCHEMA_ALREADY_EXISTSTABLE_ALREADY_EXISTSSHARE_ALREADY_EXISTSRECIPIENT_ALREADY_EXISTSSTORAGE_CREDENTIAL_ALREADY_EXISTSEXTERNAL_LOCATION_ALREADY_EXISTSPROVIDER_ALREADY_EXISTSCATALOG_NOT_EMPTYSCHEMA_NOT_EMPTYMETASTORE_NOT_EMPTYPROVIDER_SHARE_NOT_ACCESSIBLE
- messagestring
- stack_tracestring
- detailsarray of object
- responseobject
The normal, successful response of the operation.
Update an Endpoint GA
PATCH
Updates the configuration of the specified compute endpoint. Only the spec fields named in
update_mask change, and spec.endpoint_type cannot be changed. The endpoint keeps its hostnames
across updates, so existing connection strings stay valid.
API scopes: postgres
Parameters
- namestringRequiredIDImmutablepath
Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- update_maskstringRequiredquery
The fields to update, as paths relative to the endpoint, for example
spec.autoscaling_limit_max_cu. Passspecto update every field that is set inspec. Only fields underspeccan be updated. To change the suspension setting, includespec.suspensionor the specific suspension field.
Request body
The Endpoint to update.
The endpoint's name field is used to identify the endpoint to update.
Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- specobject
The desired configuration of the endpoint. Every field under
specexceptendpoint_typecan be changed after creation. Seestatusfor the configuration that is currently in effect.Read the resource's current values from
status, rather thanspec.spectracks field ownership for infrastructure-as-code tools and may omit unmanaged fields.Show child attributesHide child attributes
- endpoint_typestringRequiredImmutable
The endpoint type. A branch can only have one READ_WRITE endpoint.
ENDPOINT_TYPE_READ_WRITEENDPOINT_TYPE_READ_ONLY
- autoscaling_limit_min_cudouble
The minimum number of Compute Units. Minimum value is 0.5, and it must not exceed
autoscaling_limit_max_cu. When omitted at creation, the project's default endpoint settings apply.
- autoscaling_limit_max_cudouble
The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16. Set it equal to
autoscaling_limit_min_cufor a fixed-size compute. When omitted at creation, the project's default endpoint settings apply.
- disabledboolean
Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action. To accept connections again, set this field back to false.
- suspend_timeout_durationstring
Duration of inactivity after which the compute endpoint is automatically suspended. If specified, the value must be between 60s and 604800s (1 minute to 1 week). A suspended endpoint keeps its hostnames and configuration, and the next connection attempt restarts it. When neither this field nor
no_suspensionis set at creation, the project's default endpoint settings apply. Mutually exclusive withno_suspension.
- no_suspensionboolean
When set to true, explicitly disables automatic suspension (never suspend). The value must be true when provided. Mutually exclusive with
suspend_timeout_duration.
- settingsobject
Postgres server parameters for the compute endpoint. On update, an empty
pg_settingsmap leaves the current parameters unchanged.Show child attributesHide child attributes
- pg_settingsobject
Postgres server parameters to set on the compute endpoint, keyed by parameter name. Each value is given as a string.
- groupobject
Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults to non HA settings, with a single compute backing the endpoint (and no readable secondaries for Read/Write endpoints). Automatic suspension is not available for an endpoint with more than one compute, so set
no_suspensionto true when configuring one.Show child attributesHide child attributes
- minint32Required
The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1.
- maxint32Required
The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec.
- enable_readable_secondariesboolean
Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where
maxis greater than 1. When enabled, the endpoint also reports a read-only host instatus.hosts.
Response
- namestring
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the
nameshould be a resource name ending withoperations/{unique_id}.
- metadataobject
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata.
- doneboolean
If the value is
false, it means the operation is still in progress. Iftrue, the operation is completed, and eithererrororresponseis available.
- errorobject
The error result of the operation in case of failure or cancellation.
Show child attributesHide child attributes
- error_codestring
Error codes returned by Databricks APIs to indicate specific failure conditions.
Show 81 possible values
UNKNOWNINTERNAL_ERRORTEMPORARILY_UNAVAILABLEIO_ERRORBAD_REQUESTSERVICE_UNDER_MAINTENANCEWORKSPACE_TEMPORARILY_UNAVAILABLEDEADLINE_EXCEEDEDCANCELLEDRESOURCE_EXHAUSTEDABORTEDNOT_FOUNDALREADY_EXISTSUNAUTHENTICATEDUNAVAILABLEINVALID_PARAMETER_VALUEENDPOINT_NOT_FOUNDMALFORMED_REQUESTINVALID_STATEPERMISSION_DENIEDFEATURE_DISABLEDCUSTOMER_UNAUTHORIZEDREQUEST_LIMIT_EXCEEDEDRESOURCE_CONFLICTUNPARSEABLE_HTTP_ERRORNOT_IMPLEMENTEDDATA_LOSSINVALID_STATE_TRANSITIONCOULD_NOT_ACQUIRE_LOCKRESOURCE_ALREADY_EXISTSRESOURCE_DOES_NOT_EXISTQUOTA_EXCEEDEDMAX_BLOCK_SIZE_EXCEEDEDMAX_READ_SIZE_EXCEEDEDPARTIAL_DELETEMAX_LIST_SIZE_EXCEEDEDDRY_RUN_FAILEDRESOURCE_LIMIT_EXCEEDEDDIRECTORY_NOT_EMPTYDIRECTORY_PROTECTEDMAX_NOTEBOOK_SIZE_EXCEEDEDMAX_CHILD_NODE_SIZE_EXCEEDEDSEARCH_QUERY_TOO_LONGSEARCH_QUERY_TOO_SHORTMANAGED_RESOURCE_GROUP_DOES_NOT_EXISTPERMISSION_NOT_PROPAGATEDDEPLOYMENT_TIMEOUTGIT_CONFLICTGIT_UNKNOWN_REFGIT_SENSITIVE_TOKEN_DETECTEDGIT_URL_NOT_ON_ALLOW_LISTGIT_REMOTE_ERRORPROJECTS_OPERATION_TIMEOUTIPYNB_FILE_IN_REPOINSECURE_PARTNER_RESPONSEMALFORMED_PARTNER_RESPONSEMETASTORE_DOES_NOT_EXISTDAC_DOES_NOT_EXISTCATALOG_DOES_NOT_EXISTSCHEMA_DOES_NOT_EXISTTABLE_DOES_NOT_EXISTSHARE_DOES_NOT_EXISTRECIPIENT_DOES_NOT_EXISTSTORAGE_CREDENTIAL_DOES_NOT_EXISTEXTERNAL_LOCATION_DOES_NOT_EXISTPRINCIPAL_DOES_NOT_EXISTPROVIDER_DOES_NOT_EXISTMETASTORE_ALREADY_EXISTSDAC_ALREADY_EXISTSCATALOG_ALREADY_EXISTSSCHEMA_ALREADY_EXISTSTABLE_ALREADY_EXISTSSHARE_ALREADY_EXISTSRECIPIENT_ALREADY_EXISTSSTORAGE_CREDENTIAL_ALREADY_EXISTSEXTERNAL_LOCATION_ALREADY_EXISTSPROVIDER_ALREADY_EXISTSCATALOG_NOT_EMPTYSCHEMA_NOT_EMPTYMETASTORE_NOT_EMPTYPROVIDER_SHARE_NOT_ACCESSIBLE
- messagestring
- stack_tracestring
- detailsarray of object
- responseobject
The normal, successful response of the operation.
Delete an Endpoint GA
DELETE
Deletes the specified compute endpoint. Deletion is permanent. Only read-only endpoints can be
deleted this way, because a branch's read-write endpoint is deleted together with the branch. To stop
the compute costs of a read-write endpoint without deleting the branch, set spec.disabled to true.
API scopes: postgres
Parameters
- namestringRequiredpath
The full resource path of the endpoint to delete. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Response
- namestring
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the
nameshould be a resource name ending withoperations/{unique_id}.
- metadataobject
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata.
- doneboolean
If the value is
false, it means the operation is still in progress. Iftrue, the operation is completed, and eithererrororresponseis available.
- errorobject
The error result of the operation in case of failure or cancellation.
Show child attributesHide child attributes
- error_codestring
Error codes returned by Databricks APIs to indicate specific failure conditions.
Show 81 possible values
UNKNOWNINTERNAL_ERRORTEMPORARILY_UNAVAILABLEIO_ERRORBAD_REQUESTSERVICE_UNDER_MAINTENANCEWORKSPACE_TEMPORARILY_UNAVAILABLEDEADLINE_EXCEEDEDCANCELLEDRESOURCE_EXHAUSTEDABORTEDNOT_FOUNDALREADY_EXISTSUNAUTHENTICATEDUNAVAILABLEINVALID_PARAMETER_VALUEENDPOINT_NOT_FOUNDMALFORMED_REQUESTINVALID_STATEPERMISSION_DENIEDFEATURE_DISABLEDCUSTOMER_UNAUTHORIZEDREQUEST_LIMIT_EXCEEDEDRESOURCE_CONFLICTUNPARSEABLE_HTTP_ERRORNOT_IMPLEMENTEDDATA_LOSSINVALID_STATE_TRANSITIONCOULD_NOT_ACQUIRE_LOCKRESOURCE_ALREADY_EXISTSRESOURCE_DOES_NOT_EXISTQUOTA_EXCEEDEDMAX_BLOCK_SIZE_EXCEEDEDMAX_READ_SIZE_EXCEEDEDPARTIAL_DELETEMAX_LIST_SIZE_EXCEEDEDDRY_RUN_FAILEDRESOURCE_LIMIT_EXCEEDEDDIRECTORY_NOT_EMPTYDIRECTORY_PROTECTEDMAX_NOTEBOOK_SIZE_EXCEEDEDMAX_CHILD_NODE_SIZE_EXCEEDEDSEARCH_QUERY_TOO_LONGSEARCH_QUERY_TOO_SHORTMANAGED_RESOURCE_GROUP_DOES_NOT_EXISTPERMISSION_NOT_PROPAGATEDDEPLOYMENT_TIMEOUTGIT_CONFLICTGIT_UNKNOWN_REFGIT_SENSITIVE_TOKEN_DETECTEDGIT_URL_NOT_ON_ALLOW_LISTGIT_REMOTE_ERRORPROJECTS_OPERATION_TIMEOUTIPYNB_FILE_IN_REPOINSECURE_PARTNER_RESPONSEMALFORMED_PARTNER_RESPONSEMETASTORE_DOES_NOT_EXISTDAC_DOES_NOT_EXISTCATALOG_DOES_NOT_EXISTSCHEMA_DOES_NOT_EXISTTABLE_DOES_NOT_EXISTSHARE_DOES_NOT_EXISTRECIPIENT_DOES_NOT_EXISTSTORAGE_CREDENTIAL_DOES_NOT_EXISTEXTERNAL_LOCATION_DOES_NOT_EXISTPRINCIPAL_DOES_NOT_EXISTPROVIDER_DOES_NOT_EXISTMETASTORE_ALREADY_EXISTSDAC_ALREADY_EXISTSCATALOG_ALREADY_EXISTSSCHEMA_ALREADY_EXISTSTABLE_ALREADY_EXISTSSHARE_ALREADY_EXISTSRECIPIENT_ALREADY_EXISTSSTORAGE_CREDENTIAL_ALREADY_EXISTSEXTERNAL_LOCATION_ALREADY_EXISTSPROVIDER_ALREADY_EXISTSCATALOG_NOT_EMPTYSCHEMA_NOT_EMPTYMETASTORE_NOT_EMPTYPROVIDER_SHARE_NOT_ACCESSIBLE
- messagestring
- stack_tracestring
- detailsarray of object
- responseobject
The normal, successful response of the operation.