GetSubscriptionAttributes - - Alibaba Cloud ドキュメントセンター

サブスクリプションのプロパティを取得します。

今すぐお試しください

この 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:GetSubscriptionAttributes

get

*Subscription

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TopicName	string	必須	サブスクリプションが属する Topic の名前。	MyTopic
SubscriptionName	string	必須	サブスクリプションの名前。	MySubscription

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	06273500-249F-5863-121D-74D51123****
Code	integer	応答コード。	200
Status	string	応答のステータス。	Success
Message	string	応答メッセージ。	operation success
Success	boolean	リクエストが成功したかどうかを示します。	true
Data	object	応答データ。
SubscriptionName	string	サブスクリプションの名前。	MySubscription
TopicOwner	string	サブスクリプションが属する Topic のオーナーの AccountId。	123456789098****
TopicName	string	サブスクリプションが属する Topic の名前。	MyTopic
Endpoint	string	サブスクリプションのエンドポイント。	http://example.com
FilterTag	string	メッセージのフィルタリングに使用されるタグ。一致するタグを持つメッセージのみがプッシュされます。	important
CreateTime	integer	サブスクリプションが作成された時間。値は、1970 年 1 月 1 日 00:00:00 から経過した秒数を表す UNIX タイムスタンプです。	1449554806
LastModifyTime	integer	サブスクリプションのプロパティが最後に変更された時間。値は、1970 年 1 月 1 日 00:00:00 から経過した秒数を表す UNIX タイムスタンプです。	1449554962
NotifyStrategy	string	メッセージがエンドポイントにプッシュできなかった場合に使用されるリトライポリシー。有効な値: BACKOFF_RETRY: バックオフ再試行。 EXPONENTIAL_DECAY_RETRY: 指数減衰再試行。	BACKOFF_RETRY
NotifyContentFormat	string	エンドポイントにプッシュされるメッセージコンテンツのフォーマット。有効な値: XML JSON SIMPLIFIED	XML
DlqPolicy	object	デッドレターキューポリシー。
Enabled	boolean	デッドレターメッセージの配信が有効になっているかどうかを示します。	true
DeadLetterTargetQueue	string	デッドレターメッセージが配信されるターゲットキュー。	deadLetterTargetQueue
TenantRateLimitPolicy	object
Enabled	boolean
MaxReceivesPerSecond	integer

例

成功レスポンス

JSONJSON

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": {
    "SubscriptionName": "MySubscription",
    "TopicOwner": "123456789098****",
    "TopicName": "MyTopic",
    "Endpoint": "http://example.com",
    "FilterTag": "important",
    "CreateTime": 1449554806,
    "LastModifyTime": 1449554962,
    "NotifyStrategy": "BACKOFF_RETRY",
    "NotifyContentFormat": "XML",
    "DlqPolicy": {
      "Enabled": true,
      "DeadLetterTargetQueue": "deadLetterTargetQueue"
    },
    "TenantRateLimitPolicy": {
      "Enabled": false,
      "MaxReceivesPerSecond": 0
    }
  }
}

エラーコード

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

変更履歴

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