すべてのプロダクト
Search
ドキュメントセンター

Function Compute:PutFunctionAsyncInvokeConfig

最終更新日:Sep 11, 2024

関数の非同期呼び出し設定を作成または更新します。

PutFunctionAsyncInvokeConfig操作を呼び出すときに非同期呼び出し設定が存在するかどうかに基づいて、システムは関数の設定を作成または更新します。

  • 関数が非同期呼び出し設定で構成されていない場合、PutFunctionAsyncInvokeConfig操作を呼び出すことができると、非同期呼び出し設定が作成されます。

  • 関数がすでに非同期呼び出し設定で設定されている場合、PutFunctionAsyncInvokeConfig操作を呼び出すことができるときに、渡された設定に基づいて非同期呼び出し設定が更新されます。 指定されていないアイテムは変更されません。

StatefulAsyncInvocationは、非同期タスク機能が有効かどうかを示します。 非同期タスク機能を使用すると、非同期呼び出しの状態を管理でき、タスクシナリオに適しています。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 利便性を考慮して、この操作は OpenAPI Explorer で呼び出すことが推奨されます。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作には、操作固有のリクエストヘッダーがなく、共通のリクエストヘッダーのみが使用されます。 詳細は、共通パラメータを参照してください。

リクエスト構文

PUT /services/{serviceName[.qualifier]}/functions/{functionName}/async-invoke-config HTTP/1.1

リクエストパラメーター

パラメーター

データ型

位置

必須

説明

serviceName

String

パス

あり

service_name

非同期呼び出し設定が構成されている関数を含むサービスの名前。

functionName

String

パス

あり

testHelloWorld

非同期呼び出し設定が設定されている関数の名前。

修飾子

String

パス

なし

alias

非同期呼び出し設定が設定されている関数を含むサービスのエイリアスまたはバージョン。

オブジェクト

本文

なし

非同期呼び出し設定。

destinationConfig

DestinationConfig

本文

なし

非同期呼び出しの宛先の構成構造体。

maxAsyncEventAgeInSeconds

Long

本文

なし

300

メッセージの最大有効期間。 有効な値: [1,604800] 。 デフォルト値: 86400 単位は秒です。

maxAsyncRetryAttempts

Long

本文

なし

3

非同期呼び出しが失敗した後に許可される再試行の最大数。 デフォルト値: 3。 有効な値: 0〜8。

statefulInvocation

Boolean

本文

なし

true

非同期タスク機能を有効にするかどうかを指定します。 有効な値:

  • true

  • false

レスポンスパラメーター

パラメーター

データ型

説明

createdTime

String

202008-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。

修飾子

String

alias

非同期呼び出し設定が設定されている関数を含むサービスのエイリアスまたはバージョン。

serviceName

String

service_name

非同期呼び出し設定が構成されている関数を含むサービスの名前。

statefulInvocation

Boolean

true

非同期タスク機能が有効かどうかを示します。 有効な値:

  • true

  • false

リクエストの例

PUT /2016-08-15/services/service_name.alias/functions/testHelloWorld/async-invoke-config HTTP/1.1
Common request headers

{
  "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
}

エラーコード

エラーコードの一覧については、「サービスエラーコード」をご参照ください。