SQL Uç Noktası API’leri

Önemli

Bu özellik, Özel Önizleme sürümündedir. Denemek için Azure Databricks tarafındaki ilgili kişinize ulaşın.

Önemli

Databricks REST API’lerine erişmek için kimlik doğrulaması yapmanız gerekir.

Gereksinimler

  • Veri SQL oluşturmak için Veri Bilimive Mühendislik çalışma alanında etkinleştirilen küme oluşturma iznine & gerekir.
  • Bir uç SQL yönetmek için, uç nokta için Databricks SQL yönetebilirsiniz.

Tek tek uç SQL yapılandırmak için SQL Uç Noktalar API'sini kullanın. Tüm uç noktaları SQL için Genel Uç Noktalar API'SQL kullanın.

SQL Uç Noktaları API’si

Uç noktaları oluşturmak, düzenlemek, listele ve almak için bu API SQL kullanın.

Bu bölümdeki konular:

Oluştur

Uç Nokta HTTP Yöntemi
2.0/sql/endpoints/ POST

Bir uç SQL oluşturun.

Alan Adı Tür Açıklama
name STRING Uç noktanın SQL. Benzersiz olmalıdır. Bu alan gereklidir.
cluster_size String Uç noktasına ayrılan kümelerin boyutu: "2X-Small" , , , , , , , "X-Small" "Small" "Medium" "Large" "X-Large" "2X-Large" "3X-Large" "4X-Large" . Kümeden örnek boyutuna eşleme için bkz. Küme boyutu. Bu alan gereklidir.
min_num_clusters INT32 Bir uç noktanın çalışma SQL küme sayısı. Varsayılan değer 1'dir.
max_num_clusters INT32 Bir uç noktanın çalışma SQL küme sayısı. Bu alan gereklidir. Çok kümeli yük dengeleme etkinleştirilmemişse,bu ile 1 sınırlıdır.
auto_stop_mins INT32 Bir uç noktanın boşta kalma süresi SQL ve durur. Bu alan isteğe bağlıdır. Varsayılan değer 0'dır ve bu da otomatik durdurmanın devre dışı olduğu anlamına gelir.
etiketler EndpointTags Uç noktayı tanımlayan anahtar-değer çiftleri. Azure Databricks uç nokta kaynaklarını bu etiketlerle etiketler. Bu alan isteğe bağlıdır.
enable_photon BOOLEAN Sorguların sorgu yürütmeyi hızlandıran yerel bir vektörleştirilmiş altyapıda yürütülip yürütülmeyecekleri. Bu alan isteğe bağlıdır. Varsayılan değer: true.

Örnek istek

{
  "name": "My SQL Endpoint",
  "cluster_size": "Medium",
  "min_num_clusters": 1,
  "max_num_clusters": 10,
  "tags": {
    "custom_tags": [
      {
        "key": "mykey",
        "value": "myvalue"
      }
    ]
  },
  "enable_photon": "true"
}

Örnek yanıt

{
  "id": "0123456789abcdef"
}

Sil

Uç Nokta HTTP Yöntemi
2.0/sql/endpoints/{id} DELETE

Bir uç SQL silin.

Düzenle

Uç Nokta HTTP Yöntemi
2.0/sql/endpoints/{id}/edit POST

Bir uç SQL değiştirme. Tüm alanlar isteğe bağlıdır. Eksik alanlar varsayılan olarak geçerli değerlere sahiptir.

Alan Adı Tür Açıklama
kimlik STRING Uç noktanın SQL.
name STRING Uç noktanın SQL.
cluster_size String Uç noktasına ayrılan kümelerin boyutu: "2X-Small" , , , , , , , "X-Small" "Small" "Medium" "Large" "X-Large" "2X-Large" "3X-Large" "4X-Large" . Kümeden örnek boyutuna eşleme için bkz. Küme boyutu.
min_num_clusters INT32 Bir uç noktanın çalışma SQL küme sayısı.
max_num_clusters INT32 Bir uç noktanın çalışma SQL küme sayısı. Bu alan gereklidir. Çok kümeli yük dengeleme etkinleştirilmemişse ile 1 sınırlıdır.
auto_stop_mins INT32 Bir uç noktanın boşta kalma süresi SQL ve durur.
etiketler EndpointTags Uç noktayı tanımlayan anahtar-değer çiftleri.
enable_photon BOOLEAN Sorguların sorgu yürütmeyi hızlandıran yerel bir vektörleştirilmiş altyapıda yürütülip yürütülmeyecekleri.

Örnek istek

{
  "name": "My Edited SQL endpoint",
  "cluster_size": "Large",
  "auto_stop_mins": 60
}

Al

Uç Nokta HTTP Yöntemi
2.0/sql/endpoints/{id} GET

Bir uç noktanın SQL alın.

Alan Adı Tür Açıklama
kimlik STRING SQL uç nokta kimliği.
name STRING Uç noktanın SQL.
cluster_size String Uç noktasına ayrılan kümelerin boyutu: "2X-Small" , , , , , , , "X-Small" "Small" "Medium" "Large" "X-Large" "2X-Large" "3X-Large" "4X-Large" . Kümeden örnek boyutuna eşleme için bkz. Küme boyutu.
auto_stop_mins INT32 Boştaki bir uç SQL tüm kümeleri sonlandırana ve durdurana kadar geçen süre.
num_clusters INT32 Uç noktasına ayrılan küme sayısı.
min_num_clusters INT32 Bir uç noktanın çalışma SQL küme sayısı.
max_num_clusters INT32 Bir uç noktanın çalışma SQL küme sayısı.
num_active_sessions INT32 Uç noktada çalışan etkin JDBC ve ODBC SQL sayısı.
state EndpointState Uç noktanın SQL.
creator_name STRING Uç noktayı oluşturan kullanıcının e-posta adresi.
creator_id STRING Azure Databricks noktasını oluşturan kullanıcının kimliğini girin.
jdbc_url STRING JDBC kullanarak SQL uç noktasına SQL URL.
odbc_params ODBCParams ODBC kullanarak SQL uç noktasına göndermek için gereken ana bilgisayar, SQL ve bağlantı noktası bilgileri.
etiketler EndpointTags Uç noktayı tanımlayan anahtar-değer çiftleri.
Sağlık EndpointHealth Uç noktanın durumu.
enable_photon BOOLEAN Sorguların sorgu yürütmeyi hızlandıran yerel bir vektörleştirilmiş altyapıda yürütülip yürütülmeyecekleri.

Örnek yanıt

{
  "id": "7f2629a529869126",
  "name": "MyEndpoint",
  "size": "SMALL",
  "min_num_clusters": 1,
  "max_num_clusters": 1,
  "auto_stop_mins": 0,
  "auto_resume": true,
  "num_clusters": 0,
  "num_active_sessions": 0,
  "state": "STOPPED",
  "creator_name": "user@example.com",
  "jdbc_url": "jdbc:spark://hostname.staging.cloud.databricks.com:443/default;transportMode=http;ssl=1;AuthMech=3;httpPath=/sql/1.0/endpoints/7f2629a529869126;",
  "odbc_params": {
    "hostname": "hostname.cloud.databricks.com",
    "path": "/sql/1.0/endpoints/7f2629a529869126",
    "protocol": "https",
    "port": 443
  },
  "tags": {
    "custom_tags": [
      {
        "key": "mykey",
        "value": "myvalue"
      }
    ]
  },
  "enable_photon": true,
  "cluster_size": "Small"
}

Liste

Uç Nokta HTTP Yöntemi
2.0/sql/endpoints/ GET

Çalışma alanında SQL uç noktaları listele.

Örnek yanıt

{
  "endpoints": [
    { "id": "123456790abcdef", "name": "My SQL endpoint", "cluster_size": "Medium", },
    { "id": "098765321fedcba", "name": "Another SQL endpoint", "cluster_size": "Large", }
  ]
}

Başlangıç

Uç Nokta HTTP Yöntemi
2.0/sql/endpoints/{id}/start POST

Bir uç SQL başlatma.

Durdur

Uç Nokta HTTP Yöntemi
2.0/sql/endpoints/{id}/stop POST

Bir uç SQL durdurun.

Genel SQL Uç Noktaları API'si

Tüm uç noktalar için güvenlik ilkesi ve veri erişimini yapılandırmak üzere bu API SQL kullanın.

Bu bölümdeki konular:

Al

Uç Nokta HTTP Yöntemi
/2.0/sql/config/endpoints GET

Tüm uç noktalar için yapılandırmayı SQL.

Alan Adı Tür Açıklama
security_policy EndpointSecurityPolicy Veri kümelerine erişimi denetleme ilkesi.
data_access_config EndpointConfPair dizisi Dış Hive meta veri deposu için özellikler içeren anahtar-değer çiftleri dizisi.

Örnek yanıt

{
  "security_policy": "DATA_ACCESS_CONTROL",
  "data_access_config": [
    {
      "key": "spark.sql.hive.metastore.jars",
      "value": "/databricks/hive_metastore_jars/*"
    }
  ],
}

Düzenle

Tüm uç noktalar için SQL düzenleyin.

Önemli

  • Tüm alanlar zorunludur.
  • Bu yöntemin iptali, çalışan tüm uç SQL yeniden başlatılır.
Uç Nokta HTTP Yöntemi
/2.0/sql/config/endpoints PUT
Alan Adı Tür Açıklama
security_policy EndpointSecurityPolicy Veri kümelerine erişimi denetleme ilkesi.
data_access_config EndpointConfPair dizisi Dış Hive meta veri deposu için özellikler içeren anahtar-değer çiftleri dizisi.

Örnek istek

{
  "data_access_config": [
    {
      "key": "spark.sql.hive.metastore.jars",
      "value": "/databricks/hive_metastore_jars/*"
    }
  ],
}

Veri yapıları

Bu bölümdeki konular:

EndpointConfPair

Alan Adı Tür Açıklama
anahtar STRING Yapılandırma anahtarı adı.
değer STRING Yapılandırma anahtarı değeri.

EndpointHealth

Alan Adı Tür Açıklama
durum EndpointStatus durumu Uç nokta durumu.
message STRING Sistem durumu hakkında açıklayıcı bir ileti. Geçerli sağlık durumuna katkıda bulunan hatalar hakkında bilgi içerir.

EndpointSecurityPolicy

Seçenek Açıklama
DATA_ACCESS_CONTROL Veri kümelerine erişimi denetlemek için veri erişim denetimi kullanın.

EndpointState

SQL uç noktasının durumu. İzin verilen durum geçişleri şunlardır:

  • STARTING -> STARTING, RUNNING, STOPPING, DELETING
  • RUNNING -> STOPPING, DELETING
  • STOPPING -> STOPPED, STARTING
  • STOPPED -> STARTING, DELETING
  • DELETING -> DELETED
Durum Açıklama
STARTING Uç nokta başlangıç sürecinde.
RUNNING Başlangıç işlemi yapılır ve uç nokta kullanıma hazırdır.
STOPPING Uç nokta durdurulma sürecinde.
STOPPED Uç nokta durdurulur. Başlat 'ı çağırarak veya bir JDBC ya da ODBC isteği göndererek başlayın.
DELETING Uç nokta, yok etme sürecinde.
DELETED Uç nokta silindi ve kurtarılamıyor.

EndpointStatus durumu

Durum Açıklama
HEALTHY Uç nokta normal şekilde çalışıyor ve bilinen bir sorun yok.
DEGRADED Uç nokta işlevsel olabilir, ancak bazı bilinen sorunlar vardır. Performans etkilenebilir.
FAILED Uç nokta ciddi bir şekilde etkilenir ve sorgulara bir işlem yapamaz.

EndpointTags

Alan Adı Tür Açıklama
custom_tags Endpointtagpair dizisi Anahtar-değer çiftleri dizisini içeren nesne.

EndpointTagPair

Alan Adı Tür Açıklama
anahtar STRING Etiket anahtarı adı.
değer STRING Etiket anahtarı değeri.

Odbcparams

Alan Adı Tür Açıklama
konak STRING ODBC sunucusu konak adı.
path STRING ODBC sunucu yolu.
protokol STRING ODBC sunucu protokolü.
port INT32 ODBC sunucu bağlantı noktası