作成されたキューの属性を取得します。
操作説明
サービスパフォーマンスの最適化のため、Simple メッセージキュー (旧 MNS) は以下のフィールドの戻り値をオフラインにします (デフォルト値は 0 になります):
- ActiveMessages
- InactiveMessages
- DelayMessages
代替ソリューションとして以下を使用してください:
CloudMonitor OpenAPI を使用してキューの監視メトリクスを取得します。詳細については、「CloudMonitor OpenAPI ドキュメント」を参照してください。
- 「CloudMonitor コンソール監視メトリクスドキュメント」。非推奨フィールドと監視メトリクスのマッピング:
ActiveMessages → 監視メトリクス NumberOfMessagesVisible
InactiveMessages → 監視メトリクス NumberOfMessagesInvisible
DelayMessages → 監視メトリクス NumberOfMessagesDelayed
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
mns:GetQueueAttributes |
get |
*Queue。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| 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 |
キューの属性が最後に変更済みの時間。値は、1970-01-01 00:00:00 からの経過秒数を表す UNIX タイムスタンプです。 |
1250700999 |
| DelaySeconds |
integer |
キューに送信されるすべてのメッセージの遅延期間。キューに送信されたメッセージは、このパラメーターで指定された遅延期間が経過した後にのみ消費できます。単位: 秒。 |
30 |
| MaximumMessageSize |
integer |
キューに送信されるメッセージ本文の長さの最大値。単位: バイト。 |
65536 |
| MessageRetentionPeriod |
integer |
メッセージがキューに保持される持続時間の最大値。メッセージがキューに送信されてからこのパラメーターで指定された期間が経過すると、メッセージは消費済みかどうかに関係なく削除されます。単位: 秒。 |
65536 |
| VisibilityTimeout |
integer |
メッセージがキューから消費され、アクティブな状態から Inactive 状態に変化した後、Inactive 状態にとどまる持続時間。 有効な値: 1 ~ 43200。単位: 秒。 デフォルト値: 30。 |
60 |
| PollingWaitSeconds |
integer |
キューにメッセージがない場合の、キューに対する ReceiveMessage リクエストの待機時間の最大値。単位: 秒。 |
0 |
| ActiveMessages |
integer |
キュー内のアクティブな状態にあるメッセージのおよその総数。 警告 このフィールドは非推奨となり、デフォルト値は 0 になります。代わりに CloudMonitor API を使用してこのメトリックを取得してください。 |
0 |
| InactiveMessages |
integer |
キュー内の非アクティブな状態にあるメッセージのおよその総数。 警告 このフィールドは非推奨となり、デフォルト値は 0 になります。代わりに CloudMonitor API を使用してこのメトリックを取得してください。 |
0 |
| DelayMessages |
integer |
キュー内の Delayed 状態にあるメッセージのおよその総数。 警告 このフィールドは非推奨となり、デフォルト値は 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 |
| TenantRateLimitPolicy |
object |
レート制限ポリシー。 |
|
| Enabled |
boolean |
レート制限が有効かどうかを示します。有効値:
|
true |
| MaxReceivesPerSecond |
integer |
1 秒あたりの最大受信数。 |
1000 |
| 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": {
"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",
"EnableSSE": false,
"SseType": "",
"SseAlgorithm": "",
"KmsKeyId": "",
"EncryptionEnabled": false
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。