Knowledge Sources - Get Status

サービス:: Search Service

API バージョン:: 2025-11-01-preview

知識ソースの状態を取得します。

GET {endpoint}/knowledgesources('{sourceName}')/status?api-version=2025-11-01-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	検索サービスのエンドポイント URL。
sourceName	path	True	string	ナレッジソースの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Accept		Accept	Acceptヘッダーです。
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

応答

名前	型	説明
200 OK	KnowledgeSourceStatus	要求は成功しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

api-key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://search.azure.com/.default

例

SearchServiceGetKnowledgeSourceStatus

要求のサンプル

HTTP

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')/status?api-version=2025-11-01-preview

応答のサンプル

状態コード:: 200

{
  "synchronizationStatus": "active",
  "synchronizationInterval": "1d",
  "currentSynchronizationState": {
    "startTime": "2024-11-26T03:37:18.853Z",
    "itemsUpdatesProcessed": 10,
    "itemsUpdatesFailed": 2,
    "itemsSkipped": 1
  },
  "lastSynchronizationState": {
    "startTime": "2024-11-25T03:37:18.853Z",
    "endTime": "2024-11-25T03:38:19.012Z",
    "itemsUpdatesProcessed": 8,
    "itemsUpdatesFailed": 1,
    "itemsSkipped": 0
  },
  "statistics": {
    "totalSynchronization": 5,
    "averageSynchronizationDuration": "PT30M",
    "averageItemsProcessedPerSynchronization": 100
  }
}

定義

名前	説明
Accept	Acceptヘッダーです。
CompletedSynchronizationState	最後の同期の完了状態を表します。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
KnowledgeSourceStatistics	ナレッジソースの同期履歴に関する統計情報。
KnowledgeSourceStatus	ナレッジソースの状態と同期履歴を表します。
KnowledgeSourceSynchronizationStatus	ナレッジソースの現在の同期ステータス。
SynchronizationState	複数のインデクサー実行にまたがる進行中の同期の現在の状態を表します。

Accept

列挙

Acceptヘッダーです。

値	説明
application/json;odata.metadata=minimal

CompletedSynchronizationState

Object

最後の同期の完了状態を表します。

名前	型	説明
endTime	string (date-time)	最後に完了した同期の終了時刻。
itemsSkipped	integer (int32)	最後の同期でスキップされた項目の数。
itemsUpdatesFailed	integer (int32)	前回の同期で失敗した項目の更新の数。
itemsUpdatesProcessed	integer (int32)	前回の同期で正常に処理された項目更新の数。
startTime	string (date-time)	最後に完了した同期の開始時刻。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info		追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

KnowledgeSourceStatistics

Object

ナレッジソースの同期履歴に関する統計情報。

名前	型	説明
averageItemsProcessedPerSynchronization	integer (int32)	同期ごとに処理される平均アイテム。
averageSynchronizationDuration	string	HH:MM:SS形式の平均同期時間。
totalSynchronization	integer (int32)	同期の総数。

KnowledgeSourceStatus

Object

ナレッジソースの状態と同期履歴を表します。

名前	型	説明
currentSynchronizationState	SynchronizationState	複数のインデクサー実行にまたがる現在の同期状態。
lastSynchronizationState	CompletedSynchronizationState	最後に完了した同期の詳細。最初の同期時に Null。
statistics	KnowledgeSourceStatistics	ナレッジソースの同期履歴に関する統計情報。最初の同期時に Null。
synchronizationInterval	string	同期間隔(例:毎日の「1d」)。スケジュールが構成されていない場合は Null。
synchronizationStatus	KnowledgeSourceSynchronizationStatus	現在の同期状況。

KnowledgeSourceSynchronizationStatus

列挙

ナレッジソースの現在の同期ステータス。

値	説明
creating	ナレッジソースがプロビジョニングされています。
active	ナレッジソースはアクティブで、同期実行が実行されています。
deleting	ナレッジソースが削除され、同期が一時停止されます。

SynchronizationState

Object

複数のインデクサー実行にまたがる進行中の同期の現在の状態を表します。

名前	型	説明
itemsSkipped	integer (int32)	現在の同期でスキップされた項目の数。
itemsUpdatesFailed	integer (int32)	現在の同期で失敗したアイテム更新の数。
itemsUpdatesProcessed	integer (int32)	現在の同期で正常に処理された項目更新の数。
startTime	string (date-time)	現在の同期の開始時刻。