調用PutFunctionAsyncInvokeConfig介面建立或更新函數的非同步呼叫配置。
函數會根據非同步呼叫配置是否存在,在調用PutFunctionAsyncInvokeConfig介面時建立或更新相關配置資訊。
- 如果函數的非同步呼叫配置不存在,調用PutFunctionAsyncInvokeConfig介面則會建立相應配置。
- 如果函數的非同步呼叫配置已存在,調用PutFunctionAsyncInvokeConfig介面則會更新本次調用時新傳遞的內容,未指定的內容將保持不變。
配置中的StatefulAsyncInvocation即為非同步任務的配置項。非同步任務在普通的非同步呼叫基礎上增加了狀態管理的功能,更適用於各類任務情境。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
要求標頭
該介面無特殊要求標頭,關於公用要求標頭資訊,請參見公用參數。
請求文法
PUT /services/{serviceName[.qualifier]}/functions/{functionName}/async-invoke-config HTTP/1.1
請求參數
|
名稱 |
類型 |
位置 |
是否必選 |
樣本值 |
描述 |
| serviceName | String | Path | 是 | service_name | 非同步呼叫配置所屬的服務的名稱。 |
| functionName | String | Path | 是 | testHelloWorld | 非同步呼叫配置所屬的函數的名稱。 |
| qualifier | String | Path | 否 | alias | 非同步呼叫配置所屬的服務的別名或版本。 |
| Object | Body | 否 | 非同步呼叫配置。 |
||
| destinationConfig | DestinationConfig | Body | 否 | 非同步呼叫目標的配置結構體。 |
|
| maxAsyncEventAgeInSeconds | Long | Body | 否 | 300 | 訊息最大存活時間長度,取值範圍[1,604800],預設為86400,單位為秒。 |
| maxAsyncRetryAttempts | Long | Body | 否 | 3 | 非同步呼叫失敗後的最大重試次數,預設值為3。取值範圍[0,8]。 |
| statefulInvocation | Boolean | Body | 否 | true | 是否開啟非同步任務。
|
返回資料
名稱 |
類型 |
樣本值 |
描述 |
| createdTime | String | 2020-08-20T02:28:21Z | 服務的建立時間。 |
| destinationConfig | DestinationConfig | 非同步呼叫目標的配置結構體。 |
|
| functionName | String | testHelloWorld | 非同步呼叫配置所屬的函數的名稱。 |
| lastModifiedTime | String | 2020-09-10T02:45:02Z | 非同步呼叫配置的最後更改時間。 |
| maxAsyncEventAgeInSeconds | Long | 1 | 訊息最大存活時間長度,取值範圍[1,2592000]。單位:秒。 |
| maxAsyncRetryAttempts | Long | 1 | 非同步呼叫失敗後的最大重試次數,預設值為3。取值範圍[0,8]。 |
| qualifier | String | alias | 非同步呼叫配置所屬的服務的別名或版本。 |
| serviceName | String | service_name | 非同步呼叫配置所屬的服務的名稱。 |
| statefulInvocation | Boolean | true | 是否開啟非同步任務。
|
樣本
請求樣本
PUT /2016-08-15/services/service_name.alias/functions/testHelloWorld/async-invoke-config HTTP/1.1
公用要求標頭
{
"destinationConfig" : {
"onFailure" : {
"destination" : "acs:mns:cn-shanghai:1986***743:/queues/failure/messages"
},
"onSuccess" : {
"destination" : "acs:mns:cn-shanghai:1986***743:/queues/success/messages"
}
},
"maxAsyncEventAgeInSeconds" : 300,
"maxAsyncRetryAttempts" : 3,
"statefulInvocation" : true
}
正常返回樣本
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"createdTime" : "2020-08-20T02:28:21Z",
"destinationConfig" : {
"onFailure" : {
"destination" : "acs:mns:cn-shanghai:1986***743:/queues/failure/messages"
},
"onSuccess" : {
"destination" : "acs:mns:cn-shanghai:1986***743:/queues/success/messages"
}
},
"functionName" : "testHelloWorld",
"lastModifiedTime" : "2020-09-10T02:45:02Z",
"maxAsyncEventAgeInSeconds" : 1,
"maxAsyncRetryAttempts" : 1,
"qualifier" : "alias",
"serviceName" : "service_name",
"statefulInvocation" : true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。