指定された Alibaba Cloud アカウント配下のすべてのキューをページネーション付きで一覧表示します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
mns:ListQueue |
list |
*All resources.
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PageNum |
integer |
任意 |
返される結果のページ番号。 有効な値: 1 ～ 100000000。 このパラメーターに 1 未満の値を設定した場合、システムはデフォルトで 1 を使用します。このパラメーターに 100000000 より大きい値を設定した場合、システムはデフォルトで 100000000 を使用します。 |
1 |
| PageSize |
integer |
任意 |
各ページで返されるエントリ数。 有効な値: 10 ～ 50。 このパラメーターに 10 未満の値を設定した場合、システムはデフォルトで 10 を使用します。このパラメーターに 50 より大きい値を設定した場合、システムはデフォルトで 50 を使用します。 |
20 |
| QueueName |
string |
任意 |
キューの名前。 |
demo-queue |
| Tag |
array<object> |
任意 |
リソースタグのリスト。 |
|
|
object |
任意 |
タグキーに対応するタグ値。 |
||
| Key |
string |
任意 |
タグのキー。 |
tag1 |
| Value |
string |
任意 |
タグの値。 |
test |
| QueueType |
string |
任意 |
キューのタイプ。有効な値:
|
normal |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエストの ID。 |
06273500-249F-5863-121D-74D51123**** |
| Code |
integer |
応答コード。 |
200 |
| Status |
string |
応答のステータス。 |
Success |
| Message |
string |
応答メッセージ。 |
operation success |
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
true |
| Data |
object |
応答データ。 |
|
| PageNum |
integer |
返された結果のページ番号。 |
1 |
| PageSize |
integer |
ページごとに返されるエントリの最大値。 |
50 |
| Size |
integer |
現在のページで返されたエントリ数。 |
20 |
| Pages |
integer |
ページの総数。 |
3 |
| Total |
integer |
エントリの総数。 |
130 |
| PageData |
array<object> |
現在のページで返された結果。 |
|
|
array<object> |
データ入力。 |
||
| QueueName |
string |
キュー名。 |
demo-queue |
| CreateTime |
integer |
キューが作成された時刻。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過した秒数を表す UNIX タイムスタンプです。 |
1250700999 |
| LastModifyTime |
integer |
キューのプロパティが最後に変更された時刻。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過した秒数を表す UNIX タイムスタンプです。 |
1250700999 |
| DelaySeconds |
integer |
キューに送信されるすべてのメッセージの遅延期間。メッセージは、指定された遅延期間が経過した後にのみ消費できます。単位: 秒。 |
30 |
| MaximumMessageSize |
integer |
キューに送信できるメッセージ本文の最大サイズ。単位: バイト。 |
65536 |
| MessageRetentionPeriod |
integer |
キュー内のメッセージの最大生存期間。指定された期間が経過すると、メッセージが消費されたかどうかに関係なく、メッセージは削除されます。単位: 秒。 |
65536 |
| VisibilityTimeout |
integer |
メッセージがキューから取得された後、非アクティブ状態のままである期間。 有効な値: 1～43,200。単位: 秒。 デフォルト値: 30。 |
60 |
| PollingWaitSeconds |
integer |
キューが空の場合の ReceiveMessage リクエストの最大ポーリング待機時間。単位: 秒。 |
0 |
| ActiveMessages |
integer |
キュー内のアクティブなメッセージの総数。これは概算値です。 このパラメーターはデフォルトで 0 になり、非推奨です。このメトリックを取得するには、CloudMonitor API を使用します。 |
0 |
| InactiveMessages |
integer |
キュー内の非アクティブなメッセージの総数。これは概算値です。 このパラメーターはデフォルトで 0 になり、非推奨です。このメトリックを取得するには、CloudMonitor API を使用します。 |
0 |
| DelayMessages |
integer |
キュー内の遅延メッセージの総数。これは概算値です。 このパラメーターはデフォルトで 0 になり、非推奨です。このメトリックを取得するには、CloudMonitor API を使用します。 |
0 |
| LoggingEnabled |
boolean |
ログ管理機能が有効かどうかを示します。
|
True |
| Tags |
array<object> |
リソースタグのリスト。 |
|
|
object |
タグの値。 |
||
| TagKey |
string |
タグのキー。 |
tag1 |
| TagValue |
string |
タグの値。 |
test |
| DlqPolicy |
object |
デッドレターキューポリシー。 |
|
| Enabled |
boolean |
メッセージをデッドレターキューに配信できるかどうかを示します。 |
true |
| DeadLetterTargetQueue |
string |
デッドレターメッセージが配信されるターゲットキュー。 |
deadLetterTargetQueue |
| MaxReceiveCount |
string |
メッセージを配信できる最大回数。 |
3 |
| QueueType |
string |
キューのタイプ。有効な値:
|
normal |
| EnableSSE |
boolean |
||
| SseType |
string |
||
| SseAlgorithm |
string |
||
| KmsKeyId |
string |
||
| EncryptionEnabled |
boolean |
例
成功レスポンス
JSONJSON
{
"RequestId": "06273500-249F-5863-121D-74D51123****",
"Code": 200,
"Status": "Success",
"Message": "operation success",
"Success": true,
"Data": {
"PageNum": 1,
"PageSize": 50,
"Size": 20,
"Pages": 3,
"Total": 130,
"PageData": [
{
"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"
},
"QueueType": "normal",
"EnableSSE": false,
"SseType": "",
"SseAlgorithm": "",
"KmsKeyId": "",
"EncryptionEnabled": false
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。