Items - Execute Query (beta)

Υπηρεσία:

GraphModel

Έκδοση API:

v1

Εκτελεί ένα ερώτημα στο καθορισμένο μοντέλο γραφήματος.

Σημείωμα

Το στοιχείο GraphModel είναι αυτήν τη στιγμή σε έκδοση προεπισκόπησης (μάθετε περισσότερα). Αυτό το API αποτελεί μέρος μιας έκδοσης Beta και παρέχεται μόνο για σκοπούς αξιολόγησης και ανάπτυξης. Μπορεί να αλλάξει με βάση τα σχόλια και δεν συνιστάται για χρήση στην παραγωγή. Κατά την κλήση αυτού του API, οι καλούντες πρέπει να καθορίσουν true ως τιμή για την παράμετρο beta ερωτήματος (preview η παράμετρος ερωτήματος έχει αντικατασταθεί από betaτο . Για συμβατότητα με προηγούμενες εκδόσεις, preview εξακολουθεί να υποστηρίζεται και συμπεριφέρεται όμοια με betaτο ).

Αυτό το API υποστηρίζει σελιδοποίησης .

Δικαιώματα

Ο καλών πρέπει να έχει ρόλο θεατή.

Απαιτούμενες εμβέλειες με ανάθεση

Workspace.Read.All ή Workspace.ReadWrite.All

υποστηριζόμενες ταυτότητες Microsoft Entra

Αυτό το API υποστηρίζει τις ταυτότητες Microsoft που παρατίθενται σε αυτή την ενότητα.

Ταυτότητα	Υποστήριξη
User	Ναι
Υπηρεσίας και διαχειριζόμενες ταυτότητες	Ναι

Διασύνδεση

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

Παράμετροι URI

Όνομα	Σε	Απαιτείται	Τύπος	Περιγραφή
graphModelId	path	True	string (uuid)	Το αναγνωριστικό GraphModel.
workspaceId	path	True	string (uuid)	Το αναγνωριστικό χώρου εργασίας.
beta	query	True	boolean	Αυτή η απαιτούμενη παράμετρος πρέπει να οριστεί για true πρόσβαση σε αυτό το API, το οποίο βρίσκεται αυτήν τη στιγμή σε beta.

Κυρίως τμήμα αίτησης

Όνομα	Απαιτείται	Τύπος	Περιγραφή
query	True	string	Η συμβολοσειρά ερωτήματος.

Αποκρίσεις

Όνομα	Τύπος	Περιγραφή
200 OK	file	Η εκτέλεση του ερωτήματος ολοκληρώθηκε με επιτυχία. Τα αποτελέσματα είναι σε μορφή JSON. Ανατρέξτε στο MSFT GQL API σχετικά με τον τρόπο ανάγνωσης των δεδομένων.
429 Too Many Requests	ErrorResponse	Έγινε υπέρβαση του ορίου επιτοκίου υπηρεσίας. Ο διακομιστής επιστρέφει μια Retry-After κεφαλίδα που υποδεικνύει, σε δευτερόλεπτα, πόσο πρέπει να περιμένει ο υπολογιστής-πελάτης πριν από την αποστολή πρόσθετων αιτήσεων. Κεφαλίδες Retry-After: integer
Other Status Codes	ErrorResponse	Συνήθεις κωδικοί σφαλμάτων: OperationNotSupportedForItem - Η λειτουργία δεν υποστηρίζεται για το στοιχείο που ζητήθηκε. CorruptedPayload - Το παρεχόμενο ωφέλιμο φορτίο είναι διεφθαρμένο.

Παραδείγματα

Execute a graph query example

Δείγμα αίτησης

HTTP

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;"
}

Δείγμα απόκρισης

Κωδικός κατάστασης:

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\"}}"
      }
    ]
  }
}

Ορισμοί

Όνομα	Περιγραφή
ErrorRelatedResource	Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.
ErrorResponse	Η απόκριση σφάλματος.
ErrorResponseDetails	Οι λεπτομέρειες της απόκρισης σφάλματος.
ExecuteQueryRequest	Εκτελέστε το ωφέλιμο φορτίο αίτησης ερωτήματος.

ErrorRelatedResource

Αντικείμενο

Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.

Όνομα	Τύπος	Περιγραφή
resourceId	string	Το αναγνωριστικό πόρου που εμπλέκεται στο σφάλμα.
resourceType	string	Ο τύπος του πόρου που εμπλέκεται στο σφάλμα.

ErrorResponse

Αντικείμενο

Η απόκριση σφάλματος.

Όνομα	Τύπος	Περιγραφή
errorCode	string	Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
isRetriable	boolean	Όταν είναι true, η αίτηση μπορεί να επαναληφθεί. Χρησιμοποιήστε την Retry-After κεφαλίδα απόκρισης για να προσδιορίσετε την καθυστέρηση, εάν υπάρχει.
message	string	Μια αναγνώσιμη αναπαράσταση του σφάλματος.
moreDetails	ErrorResponseDetails[]	Λίστα πρόσθετων λεπτομερειών σφάλματος.
relatedResource	ErrorRelatedResource	Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.
requestId	string (uuid)	Το αναγνωριστικό της αίτησης που σχετίζεται με το σφάλμα.

ErrorResponseDetails

Αντικείμενο

Οι λεπτομέρειες της απόκρισης σφάλματος.

Όνομα	Τύπος	Περιγραφή
errorCode	string	Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
message	string	Μια αναγνώσιμη αναπαράσταση του σφάλματος.
relatedResource	ErrorRelatedResource	Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.

ExecuteQueryRequest

Αντικείμενο

Εκτελέστε το ωφέλιμο φορτίο αίτησης ερωτήματος.

Όνομα	Τύπος	Περιγραφή
query	string	Η συμβολοσειρά ερωτήματος.