トピックをサブスクライブする - Simple Message Queue (旧称：MNS) - Alibaba Cloud - Simple Message Queue (formerly MNS)

Subscribe 操作を呼び出して、Topic のサブスクリプションを作成します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mns:Subscribe

update

*Subscription。

acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions/{#SubscriptionName}

mns:PushType

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TopicName	string	必須	Topic の名前。	topic****1
SubscriptionName	string	必須	サブスクリプションの名前。	testSubscription
PushType	string	必須	サブスクリプションのプッシュタイプ有効な値: `http`: HTTP/HTTPS プッシュ。指定された HTTP または HTTPS コールバック URL にメッセージをプッシュします。 `queue`: キュープッシュ。指定された SMQ キューにメッセージをプッシュします。 `dm`: メールプッシュ。DirectMail を通じて通知を送信します。`DmAttributes` および `StsRoleArn` パラメーターもセットする必要があります。 `dysms`: SMS プッシュ。Alibaba Cloud Short Message サービスを通じて通知を送信します。`DysmsAttributes` パラメーターもセットする必要があります。 `fc`: Function Compute プッシュ。Alibaba Cloud Function Compute (FC) にメッセージをプッシュします。 `eventbus`: EventBridge プッシュ。EventBridge イベントバスにメッセージをプッシュします。注意: 以下の値は非推奨であり、レガシサブスクリプションとの互換性のためにのみ使用されます: `mpush`: Mobile Push。 `alisms`: レガシ SMS。 `email`: レガシメール。代わりに `dm` を使用してください。 `kafka`: Kafka プッシュタイプは非推奨です。	queue
Endpoint	string	必須	メッセージを受信するためのエンドポイントアドレスフォーマットは `PushType` の値によって異なります: `PushType=http`: HTTP/HTTPS コールバック URL。例: `http://example.com/callback` または `https://example.com/callback`。 `PushType=queue`: 送信先キューの Amazon リソースネーム (ARN)。フォーマット: `acs:mns:{RegionId}:{Alibaba Cloud アカウント ID}:queues/{QueueName}`。 `PushType=dm`: メールプッシュエンドポイント。固定フォーマット: `smq-ep:dm:{Alibaba Cloud アカウント ID}:__dynamic`。`{Alibaba Cloud アカウント ID}` をお使いの Alibaba Cloud アカウント ID に置き換えてください。 `PushType=dysms`: SMS プッシュエンドポイント。フォーマット: `smq-ep:dysms:{Alibaba Cloud アカウント ID}:{PhoneNumber}`。 `PushType=kafka`: Kafka プッシュエンドポイント。Kafka プッシュタイプは非推奨です。 `PushType=fc`: Function Compute エンドポイント。フォーマット: `acs:fc:{RegionId}:{Alibaba Cloud アカウント ID}:services/{サービス名}/functions/{関数名}`。 `PushType=eventbus`: EventBridge エンドポイント。フォーマット: `acs:eventbridge:{RegionId}:{Alibaba Cloud アカウント ID}:eventbus/{イベントバス名}`。	http://*****.com/uri1/xxx
NotifyStrategy	string	任意	エンドポイントへのメッセージプッシュ時にエラーが発生した場合のリトライ戦略。有効な値: BACKOFF_RETRY: バックオフ再試行。 EXPONENTIAL_DECAY_RETRY: 指数関数的減衰リトライ。	BACKOFF_RETRY
NotifyContentFormat	string	任意	プッシュされるメッセージ本文のフォーマット有効な値: `XML`: メッセージ本文は XML フォーマットでプッシュされます。これはデフォルト値です。 `JSON`: メッセージ本文は JSON フォーマットでプッシュされます。 `SIMPLIFIED`: SMQ メタデータのラッピングなしで、生のメッセージ本文のみがプッシュされます。	XML
MessageTag	string	任意	このサブスクリプションでメッセージフィルタリングに使用されるフィルタータグ。一致するタグを持つメッセージのみがプッシュされます。値は最大 16 文字の文字列です。デフォルトでは、メッセージフィルタリングは適用されません。	important
DlqPolicy	object	任意	デッドレターキューポリシー。
Enabled	boolean	任意	デッドレターメッセージ配信を有効にするかどうかを指定します。	true
DeadLetterTargetQueue	string	任意	デッドレターメッセージ配信の送信先キュー。	deadLetterTargetQueue
TenantRateLimitPolicy	object	任意	スロットリングポリシー。
Enabled	boolean	任意	スロットリングポリシーを有効にするかどうかを指定します。有効な値: true および false。
MaxReceivesPerSecond	integer	任意	1 秒あたりのプッシュまたは消費の最大値。	50
StsRoleArn	string	任意	サービスが引き受ける RAM ロールの Amazon リソースネーム (ARN)。フォーマットは acs:ram::{Alibaba Cloud アカウント ID}:role/{RoleName} です。{Alibaba Cloud アカウント ID} を API オペレーションを呼び出す Alibaba Cloud アカウント ID に置き換えてください。	acs:ram::1234567890:role/AliyunMNSNotificationRole
DmAttributes	object	任意	メールプッシュ属性。PushType が dm にセットされている場合、このパラメーターは必須です。値は JSON フォーマットで、以下のフィールドを含みます: AccountName: DirectMail で設定された送信元アドレス (例: notify@example.com)。 Subject: メールの主題。
AccountName	string	任意	送信元アドレス。	notify@example.com
Subject	string	任意	メールの主題。	notify
DysmsAttributes	object	任意	SMS プッシュ属性。PushType が alisms にセットされている場合、このパラメーターは必須です。値は JSON フォーマットで、以下のフィールドを含みます: TemplateCode: SMS テンプレートコード。Short Message サービスコンソールから取得できます。 SignName: SMS 署名名。
TemplateCode	string	任意	SMS テンプレートコード。	123456
SignName	string	任意	SMS 署名名。	阿里云短信测试专用
KafkaAttributes	object	任意	Kafka プッシュタイプは非推奨です。
BusinessMode	string	任意	Kafka プッシュタイプは非推奨です。	Default empty string

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	06273500-249F-5863-121D-74D51123****
Code	integer	応答コード。	200
Status	string	応答ステータス。	Success
Message	string	応答メッセージ。	operation success
Success	boolean	リクエストが成功したかどうかを示します。	true
Data	string	応答データ。	{'Code': 200, 'Success': True}

例

成功レスポンス

JSONJSON

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": "{'Code': 200, 'Success': True}"
}

エラーコード

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

変更履歴

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

今すぐお試しください

RAM 認証

リクエストパラメーター

サブスクリプションのプッシュタイプ

メッセージを受信するためのエンドポイントアドレス

プッシュされるメッセージ本文のフォーマット

レスポンスフィールド

例

エラーコード

変更履歴