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

:SetMessageCallback

最終更新日:Aug 06, 2025

この操作を呼び出して、イベント通知のコールバックメソッド、Webhook アドレス、およびイベントタイプを設定できます。

操作説明

HTTP および MNS コールバックがサポートされています。詳細については、「イベント通知」をご参照ください。

QPS 制限

この操作における単一ユーザーの 1 秒あたりのクエリ数(QPS)制限は 15 です。この制限を超えると、API 呼び出しがスロットルされ、ビジネスに影響を与える可能性があります。妥当な頻度でこの操作を呼び出すことをお勧めします。詳細については、「QPS 制限」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vod:SetMessageCallback

create

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

タイプ

必須 / 任意

説明

CallbackType

string

任意

コールバックメソッド。有効な値:

  • HTTP

  • Simple Message Queue (旧称:MNS)

HTTP

CallbackURL

string

任意

Webhook アドレス。 CallbackType を HTTP に設定した場合、このパラメーターは必須です。 Webhook アドレスは最大 256 バイトです。複数の Webhook アドレスを指定することはできません。

http://developer.aliyundoc.com

EventTypeList

string

任意

コールバックイベントのタイプ。このパラメーターを空のままにすると、すべてのイベント通知が無効になります。このパラメーターを ALL に設定すると、すべてのイベント通知が有効になります。通知を有効にするイベントタイプを指定することもできます。複数のイベントタイプはコンマ(,)で区切ります。有効な値については、「イベントタイプ」をご参照ください。

FileUploadComplete

AuthSwitch

string

任意

HTTP コールバックの認証スイッチ。このパラメーターは、CallbackType が HTTP に設定されている場合にのみ有効です。有効な値:

  • on: 有効

  • off: 無効

on

AuthKey

string

任意

認証キー。最大 32 文字で、大文字、小文字、数字を含める必要があります。 CallbackType が HTTP に設定されている場合、このパラメーターを設定できます。

Dsf346dvet

MnsEndpoint

string

任意

MNS キューのパブリックエンドポイント。 CallbackTypeSimple Message Queue (旧称:MNS) に設定した場合、このパラメーターは必須です。メッセージサービスコンソール にログインし、右上隅にある [エンドポイントの取得] をクリックして、エンドポイントを取得できます。詳細については、「エンドポイント」をご参照ください。

http://****.mns.cn-shanghai.aliyuncs.com/

MnsQueueName

string

任意

MNS キューの名前。メッセージサービスコンソール にログインし、[キューリスト] でキュー名を確認できます。 CallbackType を Simple Message Queue (旧称:MNS) に設定した場合、このパラメーターは必須です。

quene_name

AppId

string

任意

アプリケーションの ID。このパラメーターを設定しない場合、デフォルトアプリケーションの ID( app-1000000 )が使用されます。

app-1000000

レスポンスパラメーター

パラメーター

タイプ

説明

object

返された結果。

RequestId

string

リクエストの ID。

25818875-5F78-4AF6-D7393642CA58****

成功レスポンス

JSONJSON

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。