すべてのプロダクト
Search

このプロダクト

    :GetQueueAttributes

    ドキュメントセンター

    :GetQueueAttributes

    最終更新日:Jan 29, 2026

    作成されたキューのプロパティを取得します。

    操作説明

    警告

    サービスのパフォーマンスを最適化するため、Message Service (MNS) は以下のフィールドの戻り値を間もなく非公開とし、これらのフィールドはデフォルト値 0 を返すようになります。
    - ActiveMessages
    - InactiveMessages
    - DelayMessages











    代替メトリックを取得するには、以下の方法をご利用ください。

    • CloudMonitor OpenAPI を使用してキューのメトリックを取得します。詳細については、「CloudMonitor OpenAPI ドキュメント」をご参照ください。

    • 「CloudMonitor メトリックドキュメント」をご参照ください。以下に、廃止予定のフィールドと新しいメトリックの対応関係を示します。

      • ActiveMessages → CloudMonitor メトリック NumberOfMessagesVisible

      • InactiveMessages → CloudMonitor メトリック NumberOfMessagesInvisible

      • DelayMessages → CloudMonitor メトリック NumberOfMessagesDelayed

    今すぐお試しください

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

    get

    *Queue

    acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    QueueName

    string

    必須

    キューの名前。

    demo-queue
    Tag

    array<object>

    任意

    リソースタグのリスト。

    object

    任意

    タグのキーと値のペア。

    Key

    string

    任意

    タグのキー。

    tag1
    Value

    string

    任意

    タグの値。

    test

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    06273500-249F-5863-121D-74D51123****
    Code

    integer

    応答コード。

    200
    Status

    string

    応答のステータス。

    Success
    Message

    string

    応答メッセージ。

    operation success
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    Data

    object

    応答データ。

    QueueName

    string

    キューの名前。

    demo-queue
    CreateTime

    integer

    キューの作成時刻。

    1250700999
    LastModifyTime

    integer

    キューのプロパティが最後に変更された時刻。値は UNIX タイムスタンプ（秒単位）です。

    1250700999
    DelaySeconds

    integer

    キューに送信されたすべてのメッセージに適用される遅延期間。指定された遅延期間が経過した後でのみ、メッセージを消費できます。単位：秒。

    30
    MaximumMessageSize

    integer

    キューに送信可能なメッセージ本文の最大サイズ。単位：バイト。

    65536
    MessageRetentionPeriod

    integer

    キュー内のメッセージの最大存続時間 (TTL)。指定された期間が経過すると、メッセージが消費されたかどうかに関係なく削除されます。単位：秒。

    65536
    VisibilityTimeout

    integer

    キューから取得されたメッセージが Inactive 状態で維持される期間。有効値：1 ～ 43200。単位：秒。デフォルト値：30。

    60
    PollingWaitSeconds

    integer

    キューが空の場合に ReceiveMessage リクエストがメッセージを待機できる最大時間。単位：秒。

    0
    ActiveMessages

    integer

    キュー内にある Active 状態のメッセージの総数。これは近似値です。

    警告

    このフィールドは非公開となり、デフォルト値 0 を返します。このフィールドは使用しないでください。代わりに CloudMonitor API を使用してメトリックを取得してください。

    0
    InactiveMessages

    integer

    キュー内にある Inactive 状態のメッセージの総数。これは近似値です。

    警告

    このフィールドは非公開となり、デフォルト値 0 を返します。このフィールドは使用しないでください。代わりに CloudMonitor API を使用してメトリックを取得してください。

    0
    DelayMessages

    integer

    キュー内にある Delayed 状態のメッセージの総数。これは近似値です。

    警告

    このフィールドは非公開となり、デフォルト値 0 を返します。このフィールドは使用しないでください。代わりに CloudMonitor API を使用してメトリックを取得してください。

    0
    LoggingEnabled

    boolean

    ログ管理が有効かどうかを示します。

    • True：有効

    • False：無効

    True
    Tags

    array<object>

    リソースタグのリスト。

    object

    タグのキーと値のペア。

    TagKey

    string

    タグのキー。

    tag1
    TagValue

    string

    タグの値。

    test
    DlqPolicy

    object

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

    Enabled

    boolean

    デッドレターメッセージの配信が有効かどうかを示します。

    true
    DeadLetterTargetQueue

    string

    デッドレターメッセージの配信先となるキュー。

    deadLetterTargetQueue
    MaxReceiveCount

    string

    メッセージを配信できる最大回数。

    3
    TenantRateLimitPolicy

    object

    レート制限ポリシー。

    Enabled

    boolean

    レート制限が有効かどうかを示します。有効値：

    • true

    • false

    true
    MaxReceivesPerSecond

    integer

    1 秒あたりの最大受信数。

    1000
    QueueType

    string

    キューのタイプ。有効値：

    • normal：スタンダードキュー

    • fifo：FIFO キュー

    normal

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": {
    "QueueName": "demo-queue",
    "CreateTime": 1250700999,
    "LastModifyTime": 1250700999,
    "DelaySeconds": 30,
    "MaximumMessageSize": 65536,
    "MessageRetentionPeriod": 65536,
    "VisibilityTimeout": 60,
    "PollingWaitSeconds": 0,
    "ActiveMessages": 0,
    "InactiveMessages": 0,
    "DelayMessages": 0,
    "LoggingEnabled": true,
    "Tags": [
      {
        "TagKey": "tag1",
        "TagValue": "test"
      }
    ],
    "DlqPolicy": {
      "Enabled": true,
      "DeadLetterTargetQueue": "deadLetterTargetQueue",
      "MaxReceiveCount": "3"
    },
    "TenantRateLimitPolicy": {
      "Enabled": true,
      "MaxReceivesPerSecond": 1000
    },
    "QueueType": "normal"
  }
}

    エラーコード

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

    変更履歴

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