您在調用ROS API時,如果發生請求逾時或伺服器內部錯誤,用戶端可能會嘗試重發請求。您可以在請求中設定ClientToken參數避免多次重試帶來重複操作的問題。
什麼是等冪性
在數學計算或者電腦科學中,等冪性(Idempotence)是指相同操作或資源在一次或多次請求中具有同樣效果的作用。等冪性在分布式系統設計中具有十分重要的地位。
保證等冪性
通常情況下,用戶端只需要在HTTP狀態代碼返回500 Internal Server Error或503 Service Unavailable錯誤,或者無法擷取響應結果時重試。使用ROS API,您可以從用戶端產生一個參數值不超過64個ASCII字元的字串,並將值賦予ClientToken,保證重試請求的等冪性。
ClientToken詳解
ClientToken參數的詳細資料如下:
- ClientToken是一個由用戶端產生的唯一的、區分大小寫、不超過64個ASCII字元的字串。例如:
ClientToken=123e4567-e89b-12d3-a456-42665544****。 - 如果您提供了一個已經使用過的ClientToken,但其他請求參數有變化,則ROS會返回
InvalidIdempotenceParameter的錯誤碼。說明 參數SignatureNonce、Timestamp和Signature在重試時是需要變化的。具體原因是ROS使用SignatureNonce防止重放攻擊,使用Timestamp標記每次請求時間。所以再次請求必須提供不同的SignatureNonce和Timestamp參數值,同時也會導致Signature值的變化。 - 添加了ClientToken參數後:
- HTTP狀態代碼返回
200 OK時,重試後用戶端可以得到與上次相同的結果,但對您的服務端狀態沒有影響。 - HTTP狀態代碼返回請求錯誤(例如
400 Bad Request)時,如果錯誤資訊沒有表明try it later類似的資訊,重試不會成功。您需要根據錯誤資訊排查問題後再重試請求。
- HTTP狀態代碼返回
等冪請求樣本
以調用CreateStack建立資源棧為例,如果您使用同一個ClientToken值,其他請求參數相同時,則服務端只會返回同一個StackId。如果您不使用ClientToken,在報錯重試時,可能會建立多個資源棧。
請求樣本
http(s)://ros.aliyuncs.com/?Action=CreateStack
&RegionId=cn-hangzhou
&StackName=MyStack
&TemplateBody={"ROSTemplateFormatVersion": "2015-09-01"}
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&<公用請求參數>返回樣本
{
"StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
"RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F"
}