Published - Get Settings

Usługa:: DataAgent

Wersja interfejsu API:: v1

Zwraca opublikowane ustawienia dla określonego elementu DataAgent.

Note

Zarządzanie konfiguracją agenta danych jest obecnie dostępne w wersji zapoznawczej (dowiedz się więcej).

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu dla agenta DataAgent.

Wymagane zakresy delegowane

Item.Read.All lub Item.ReadWrite.All lub DataAgent.Read.All lub DataAgent.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity	Support
User	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataAgents/{dataAgentId}/settings

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
dataAgentId	path	True	string (uuid)	Identyfikator agenta danych.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.

Odpowiedzi

Nazwa Typ Opis

200 OK

Nazwa	Typ	Opis
200 OK	DataAgentSettingsResponse	Żądanie zostało ukończone pomyślnie.
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: ItemNotFound — żądany element nie został znaleziony.

DataAgentSettingsResponse

Żądanie zostało ukończone pomyślnie.

429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer

Other Status Codes

ErrorResponse

Typowe kody błędów:

ItemNotFound — żądany element nie został znaleziony.

Przykłady

Get published DataAgent settings example

Przykładowe żądanie

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataAgents/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/settings

Przykładowa odpowiedź

Kod stanu:: 200

{
  "aiInstructions": "Always respond in English. Be concise."
}

Definicje

Nazwa	Opis
DataAgentSettingsResponse	Ustawienia dataAgent.
ErrorRelatedResource	Obiekt szczegółowych informacji o zasobie związanym z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.

DataAgentSettingsResponse

Objekt

Ustawienia dataAgent.

Nazwa	Typ	Opis
aiInstructions	string	Niestandardowy monit systemu sztucznej inteligencji dla agenta DataAgent.

ErrorRelatedResource

Objekt

Obiekt szczegółowych informacji o zasobie związanym z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu powiązany z błędem.
resourceType	string	Typ zasobu powiązanego z błędem.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.