Knowledge Sources - Get Status
知識ソースの状態を取得します。
GET https:///knowledgesources('{sourceName}')/status?api-version=2025-11-01-previewURI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
source
|
path | True |
string |
ナレッジソースの名前。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| Accept | True |
Acceptヘッダーです。 |
|
| x-ms-client-request-id |
string (uuid) |
要求の非透過的なグローバルに一意のクライアント生成文字列識別子。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は成功しました。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
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
要求のサンプル
GET https:///knowledgesources('ks-preview-test')/status?api-version=2025-11-01-preview
応答のサンプル
{
"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ヘッダーです。 |
|
Completed |
最後の同期の完了状態を表します。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。 |
|
Knowledge |
ナレッジ ソースの同期履歴に関する統計情報。 |
|
Knowledge |
ナレッジ ソースの状態と同期履歴を表します。 |
|
Knowledge |
ナレッジ ソースの現在の同期ステータス。 |
|
Synchronization |
複数のインデクサー実行にまたがる進行中の同期の現在の状態を表します。 |
Accept
Acceptヘッダーです。
| 値 | 説明 |
|---|---|
| application/json;odata.metadata=minimal |
CompletedSynchronizationState
最後の同期の完了状態を表します。
| 名前 | 型 | 説明 |
|---|---|---|
| endTime |
string (date-time) |
最後に完了した同期の終了時刻。 |
| itemsSkipped |
integer (int32) |
最後の同期でスキップされた項目の数。 |
| itemsUpdatesFailed |
integer (int32) |
前回の同期で失敗した項目の更新の数。 |
| itemsUpdatesProcessed |
integer (int32) |
前回の同期で正常に処理された項目更新の数。 |
| startTime |
string (date-time) |
最後に完了した同期の開始時刻。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
追加情報。 |
|
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
KnowledgeSourceStatistics
ナレッジ ソースの同期履歴に関する統計情報。
| 名前 | 型 | 説明 |
|---|---|---|
| averageItemsProcessedPerSynchronization |
integer (int32) |
同期ごとに処理される平均アイテム。 |
| averageSynchronizationDuration |
string |
HH:MM:SS形式の平均同期時間。 |
| totalSynchronization |
integer (int32) |
同期の総数。 |
KnowledgeSourceStatus
ナレッジ ソースの状態と同期履歴を表します。
| 名前 | 型 | 説明 |
|---|---|---|
| currentSynchronizationState |
複数のインデクサー実行にまたがる現在の同期状態。 |
|
| lastSynchronizationState |
最後に完了した同期の詳細。 最初の同期時に Null。 |
|
| statistics |
ナレッジ ソースの同期履歴に関する統計情報。 最初の同期時に Null。 |
|
| synchronizationInterval |
string |
同期間隔(例:毎日の「1d」)。 スケジュールが構成されていない場合は Null。 |
| synchronizationStatus |
現在の同期状況。 |
KnowledgeSourceSynchronizationStatus
ナレッジ ソースの現在の同期ステータス。
| 値 | 説明 |
|---|---|
| creating |
ナレッジソースがプロビジョニングされています。 |
| active |
ナレッジ ソースはアクティブで、同期実行が実行されています。 |
| deleting |
ナレッジ ソースが削除され、同期が一時停止されます。 |
SynchronizationState
複数のインデクサー実行にまたがる進行中の同期の現在の状態を表します。
| 名前 | 型 | 説明 |
|---|---|---|
| itemsSkipped |
integer (int32) |
現在の同期でスキップされた項目の数。 |
| itemsUpdatesFailed |
integer (int32) |
現在の同期で失敗したアイテム更新の数。 |
| itemsUpdatesProcessed |
integer (int32) |
現在の同期で正常に処理された項目更新の数。 |
| startTime |
string (date-time) |
現在の同期の開始時刻。 |