Items - Execute Query (beta)

Hizmet:
GraphModel
API Sürümü:
v1

Belirtilen grafik modelinde bir sorgu yürütür.

Uyarı

GraphModel öğesi şu anda Önizleme aşamasındadır (daha fazla bilgi edinin). Bu API, Beta sürümünün bir parçasıdır ve yalnızca değerlendirme ve geliştirme amacıyla sağlanır. Geri bildirim temelinde değişebilir ve üretim kullanımı için önerilmez. Bu API'yi çağırırken, çağıranların sorgu parametresinin true değeri olarak belirtmesi beta gerekir (preview sorgu parametresi ile betadeğiştirilmiştir. Geriye dönük uyumluluk için hala preview desteklenir ve ile aynı betaşekilde davranır.

Bu API, sayfalandırmadestekler.

Permissions

Çağıranın bir görüntüleyici çalışma alanı rolü olmalıdır.

Gerekli Temsilci Kapsamları

Workspace.Read.All veya Workspace.ReadWrite.All

Desteklenen kimlikleri Microsoft Entra

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Kimlik Support
User Yes
Hizmet sorumlusu ve yönetilen kimlikler Yes

Arayüz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/executeQuery?beta={beta}

URI Parametreleri

Veri Akışı Adı İçinde Gerekli Tür Description
graphModelId
 path True

string (uuid)

GraphModel Kimliği.
workspaceId
 path True

string (uuid)

Çalışma alanı kimliği.
beta
 query True

boolean

Şu anda beta sürümünde olan bu API'ye erişmek için bu gerekli parametre olarak ayarlanmalıdır true .

İstek Gövdesi

Veri Akışı Adı Gerekli Tür Description
query True

string

Sorgu dizesi.

Yanıtlar

Veri Akışı Adı Tür Description
200 OK

file

Sorgu yürütme başarıyla tamamlandı. Sonuçlar JSON biçimindedir. Verilerin nasıl okunduğuna ilişkin MSFT GQL API'sine bakın.
429 Too Many Requests

ErrorResponse

Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir Retry-After üst bilgi döndürür.

Üst Bilgiler

Retry-After: integer
Other Status Codes

ErrorResponse

Yaygın hata kodları:

  • OperationNotSupportedForItem - İstenen öğe için işlem desteklenmiyor.

  • BozukPayload - Sağlanan yük bozuk.

Örnekler

Execute a graph query example

Örnek isteği

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/graphModels/5b218778-e7a5-4d73-8187-f10824047715/executeQuery?beta=True

{
  "query": "MATCH (node_station:`station`) RETURN TO_JSON_STRING(node_station) AS `station` LIMIT 10;"
}

Örnek yanıt

Durum kodu:
200 
{
  "status": {
    "code": "00000",
    "description": "note: successful completion",
    "diagnostics": {
      "OPERATION": "query",
      "OPERATION_CODE": "0",
      "CURRENT_SCHEMA": "/"
    }
  },
  "result": {
    "kind": "TABLE",
    "columns": [
      {
        "name": "station",
        "gqlType": "STRING",
        "jsonType": "string"
      }
    ],
    "data": [
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263937\",\"properties\":{\"stationFrom\":\"Holborn\",\"stationTo\":\"Chancery_Lane\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263938\",\"properties\":{\"stationFrom\":\"Chancery_Lane\",\"stationTo\":\"St_Paul's\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263939\",\"properties\":{\"stationFrom\":\"Hyde_Park_Corner\",\"stationTo\":\"Green_Park\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263940\",\"properties\":{\"stationFrom\":\"Holborn\",\"stationTo\":\"Russel_Square\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263941\",\"properties\":{\"stationFrom\":\"Euston\",\"stationTo\":\"Warren_Street\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263942\",\"properties\":{\"stationFrom\":\"Victoria\",\"stationTo\":\"Pimlico\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263943\",\"properties\":{\"stationFrom\":\"London_Bridge\",\"stationTo\":\"Monument\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263944\",\"properties\":{\"stationFrom\":\"Moorgate\",\"stationTo\":\"Old_Street\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263945\",\"properties\":{\"stationFrom\":\"South_Kensington\",\"stationTo\":\"Sloane_Square\"}}"
      },
      {
        "station": "{\"labels\":[\"station\"],\"oid\":\"1688849860263946\",\"properties\":{\"stationFrom\":\"Victoria\",\"stationTo\":\"St_James's_Park\"}}"
      }
    ]
  }
}

Tanımlar

Veri Akışı Adı Description
ErrorParameter

Bir hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametre.
ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse

Hata yanıtı.
ErrorResponseDetails

Hata yanıtı ayrıntıları.
ExecuteQueryRequest

Sorgu isteği yükünü yürüt.

ErrorParameter

Nesne

Bir hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametre.

Veri Akışı Adı Tür Description
message

string

Parametrenin anlamının insan tarafından okunabilen açıklaması.
name

string

Parametre tanımlayıcısı.
value

string

Parametre değeridir.

ErrorRelatedResource

Nesne

Hatayla ilgili kaynak ayrıntıları nesnesi.

Veri Akışı Adı Tür Description
resourceId

string

Hataya dahil olan kaynak kimliği.
resourceType

string

Hataya dahil olan kaynağın türü.

ErrorResponse

Nesne

Hata yanıtı.

Veri Akışı Adı Tür Description
errorCode

string

Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
isRetriable

boolean

True olduğunda istek yeniden denenebilir. Varsa gecikmeyi Retry-After belirlemek için yanıt üst bilgisini kullanın.
message

string

Hatanın okunabilir bir gösterimi.
moreDetails

ErrorResponseDetails[]

Ek hata ayrıntılarının listesi.
parameters

ErrorParameter[]

Hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametreler.
relatedResource

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları.
requestId

string (uuid)

Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Nesne

Hata yanıtı ayrıntıları.

Veri Akışı Adı Tür Description
errorCode

string

Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message

string

Hatanın okunabilir bir gösterimi.
parameters

ErrorParameter[]

Hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametreler.
relatedResource

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları.

ExecuteQueryRequest

Nesne

Sorgu isteği yükünü yürüt.

Veri Akışı Adı Tür Description
query

string

Sorgu dizesi.