すべてのプロダクト
Search

このプロダクト

    :Subscribe

    ドキュメントセンター

    :Subscribe

    最終更新日:Nov 24, 2025

    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 プッシュ。

    • queue: キュープッシュ。

    • mpush: モバイルプッシュ。

    • alisms: Alibaba Cloud ショートメッセージプッシュ。

    • email: E メールプッシュ。

    queue
    Endpoint

    string

    必須

    このサブスクリプションでメッセージを受信するエンドポイント。エンドポイントのフォーマットは、エンドポイントのタイプによって異なります:

    • HTTP: http(s)://{your_url}

    • キュー: {QueueName}

    • モバイルプッシュ: {AppKey}

    • Alibaba Cloud ショートメッセージ: {phoneNumber}

    • E メール: {emailAddress}

    http://*****.com/uri1/xxx
    NotifyStrategy

    string

    任意

    エラー発生時にエンドポイントにメッセージをプッシュするためのリトライポリシー。有効な値:

    • BACKOFF_RETRY: バックオフリトライ。

    • EXPONENTIAL_DECAY_RETRY: 指数減衰再試行。

    BACKOFF_RETRY
    NotifyContentFormat

    string

    任意

    エンドポイントにプッシュされるメッセージのフォーマット。 有効な値:

    • XML

    • JSON

    • SIMPLIFIED

    XML
    MessageTag

    string

    任意

    このサブスクリプションでのメッセージフィルタリング用のタグ。同じタグを持つメッセージのみがプッシュされます。 値は最大 16 文字の文字列です。

    デフォルトでは、メッセージはフィルターされません。

    important
    DlqPolicy

    object

    任意

    デッドレターキューポリシー。

    Enabled

    boolean

    任意

    デッドレターメッセージの配信を有効にするかどうかを指定します。

    true
    DeadLetterTargetQueue

    string

    任意

    デッドレターメッセージ配信のターゲットキュー。

    deadLetterTargetQueue
    TenantRateLimitPolicy

    object

    任意

    Enabled

    boolean

    任意

    MaxReceivesPerSecond

    integer

    任意

    StsRoleArn

    string

    任意

    DmAttributes

    object

    任意

    AccountName

    string

    任意

    Subject

    string

    任意

    DysmsAttributes

    object

    任意

    TemplateCode

    string

    任意

    SignName

    string

    任意

    KafkaAttributes

    object

    任意

    BusinessMode

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

    エラーコード

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

    変更履歴

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