Documents - Get

Hizmet:

Search Service

API Sürümü:

2026-04-01

Dizinden bir belge alır.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2026-04-01

İsteğe bağlı parametrelerle:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2026-04-01&$select={$select}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (uri)	Arama hizmetinin uç nokta URL'si.
indexName	path	True	string	Dizinin adı.
key	path	True	string	Alınacak belgenin anahtarı.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.
$select	query		string[]	Belge için alınacak alan adlarının listesi; Alınmayan herhangi bir alan, döndürülen belgede eksik olacaktır.

İstek Başlığı

Name	Gerekli	Tür	Description
Accept		Accept	Kabul Et başlığı.
x-ms-client-request-id		string (uuid)	İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Yanıtlar

Name	Tür	Description
200 OK	LookupDocument	İstek başarılı oldu.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

api-key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Kapsamlar

Name	Description
https://search.azure.com/.default

Örnekler

SearchIndexGetDocument

Örnek isteği

HTTP

GET https://exampleservice.search.windows.net/indexes('example-index')/docs('1')?api-version=2026-04-01&$select=id,description,name,category,ownerId

Örnek yanıt

Durum kodu:

200

{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

Tanımlar

Name	Description
Accept	Kabul Et başlığı.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).

Accept

Numaralandırma

Kabul Et başlığı.

Değer	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info		Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi

ErrorResponse

Nesne

Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.