documents/batch XML API - Amazon CloudSearch
請求documents/batch 回應 (XML)

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

documents/batch XML API

XML documents/batch 請求

documents/batch 請求的內文是以 XML 指定您要執行的文件操作。例如：

<batch>
	<add  id="tt0484562">
		<field name="title">The Seeker: The Dark Is Rising</field>
		<field name="director">Cunningham, David L.</field>
		<field name="genre">Adventure</field>
		<field name="genre">Drama</field>
		<field name="genre">Fantasy</field>
		<field name="genre">Thriller</field>
		<field name="actor">McShane, Ian</field>
		<field name="actor">Eccleston, Christopher</field>
		<field name="actor">Conroy, Frances</field>
		<field name="actor">Ludwig, Alexander</field>
		<field name="actor">Crewson, Wendy</field>
		<field name="actor">Warner, Amelia</field>
		<field name="actor">Cosmo, James</field>
		<field name="actor">Hickey, John Benjamin</field>
		<field name="actor">Piddock, Jim</field>
		<field name="actor">Lockhart, Emma</field>
	</add>
	<delete id="tt0301199" />
</batch>

documents/batch 請求元素 (XML)

Element 描述 必要
批次 您要提交至搜尋網域的一組新增或刪除操作。批次必須包含至少一個 add 或 delete 元素。 是
add 指定您要新增至搜尋網域的文件。id 屬性是必要項目，且 add 元素必須包含至少一個欄位。

屬性：

  • id字母數字字串。A-Z (大寫或小寫) 和 0-9 以外的任何字元均屬無效。長度上限為 128 個字元。

 否
field 指定欲新增的文件內某一欄位。name 屬性和欄位值是必要項目。欄位名稱必須以字母開頭，並可包含以下字元：a-z (小寫)、0-9 和 _ (底線)。名稱 score 是保留項目，不得做為欄位名稱使用。欄位值可以是文字或 CDATA。

若要為某欄位指定多個值，請附上多個同名的 field 元素。例如：

<field name="genre">Adventure</field>
<field name="genre">Drama</field>
<field name="genre">Fantasy</field>
<field name="genre">Thriller</field>

約束:

  • name以字母開頭的英數字串。可包含 a-z (小寫)、0-9、_ (底線)、- (連字號) 和 . (句號)。

條件：add 元素必須指定至少一個欄位。

 有條件
刪除 指定您要從搜尋網域移除的文件。id 屬性是必要項目。delete 元素需為空白。如需有關永久刪除文件的資訊，請參閱在 Amazon CloudSearch ch 中刪除文件。

約束:

  • id字母數字字串。A-Z (大寫或小寫) 和 0-9 以外的任何字元均屬無效。

 否

documents/batch 回應 (XML)

回應內文會列出已執行的新增和刪除數目，以及任何產生的錯誤或警告。

文件服務 API 回應的 RelaxNG 結構描述如下：

 start = response

response = element response {
    attribute status { "success" | "error" },
    attribute adds { xsd:integer },
    attribute deletes { xsd:integer },
    element errors {
        element error {
            text
        }+
    }? &
    element warnings {
        element warning {
            text
        }+
    }?
}

documents/batch 回應元素 (XML)

Element 描述
result

包含各元素以列出剖析及驗證請求時產生的錯誤和警告。

屬性：

  • status - 結果狀態，可能是 success 或 error。

  • adds新增文件的數目。狀態若是 error 則其值一律為零。

  • deletes已刪除文件的數目。狀態若是 error 則其值一律為零。

限制：狀態為 error 時，results 元素將包含一份錯誤清單。如果狀態是 success，results 元素可能包含一份警告清單但無任何錯誤。
錯誤 包含 error 元素的集合以識別剖析及驗證請求時發生的錯誤。
error 提供有關剖析或驗證錯誤的資訊。其值提供該項錯誤的描述。
warnings 包含 warning 元素的集合以識別剖析及驗證請求時產生的警告。
warning 提供有關剖析或驗證警告的資訊。其值提供該項錯誤的描述。