Gunakan GetQueueAttributes untuk mengambil properti antrean - Simple Message Queue (dahulu MNS) - Alibaba Cloud - Simple Message Queue (formerly MNS)

Mengambil atribut antrian yang telah dibuat.

Deskripsi operasi

Peringatan

Untuk optimalisasi kinerja layanan, Simple Message Queue (sebelumnya MNS) akan menghentikan pengembalian nilai dari bidang berikut (nilai default akan menjadi 0):
- ActiveMessages
- InactiveMessages
- DelayMessages

Gunakan alternatif berikut untuk mendapatkan solusi pengganti:

Gunakan CloudMonitor OpenAPI untuk mengambil data deret waktu pemantauan Antrian Pesan. Untuk informasi lebih lanjut, lihat dokumentasi CloudMonitor OpenAPI
dokumentasi data deret waktu pemantauan CloudMonitor. Pemetaan antara bidang yang tidak digunakan lagi dan data deret waktu pemantauan:
- ActiveMessages → data deret waktu pemantauan NumberOfMessagesVisible
- InactiveMessages → data deret waktu pemantauan NumberOfMessagesInvisible
- DelayMessages → data deret waktu pemantauan NumberOfMessagesDelayed

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

mns:GetQueueAttributes

get

*Antrian.

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
QueueName	string	Yes	Nama antrian.	demo-queue
Tag	array<object>	No	Daftar tag Sumber daya.
	object	No	Nilai tag yang sesuai dengan kunci tag.
Key	string	No	Kunci tag.	tag1
Value	string	No	Nilai tag.	test

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	06273500-249F-5863-121D-74D51123****
Code	integer	Kode tanggapan.	200
Status	string	Status tanggapan.	Success
Message	string	Paket tanggapan.	operation success
Success	boolean	Apakah permintaan berhasil.	true
Data	object	Data tanggapan.
QueueName	string	Nama antrian.	demo-queue
CreateTime	integer	Waktu pembuatan antrian.	1250700999
LastModifyTime	integer	Waktu terakhir modifikasi atribut antrian. Nilainya adalah Stempel waktu UNIX yang menunjukkan jumlah detik yang telah berlalu sejak 1970-01-01 00:00:00.	1250700999
DelaySeconds	integer	Periode penundaan untuk semua Paket yang dikirim ke antrian. Paket yang dikirim ke antrian hanya dapat dikonsumsi setelah periode penundaan yang ditentukan oleh parameter ini berlalu. Unit: detik.	30
MaximumMessageSize	integer	Panjang maksimum body Paket yang dikirim ke antrian. Unit: byte.	65536
MessageRetentionPeriod	integer	Durasi maksimum penyimpanan Paket di antrian. Setelah periode yang ditentukan oleh parameter ini berlalu sejak Paket dikirim ke antrian, Paket akan dihapus terlepas dari apakah Paket tersebut telah dikonsumsi atau belum. Unit: detik.	65536
VisibilityTimeout	integer	Durasi Paket tetap dalam status Inactive setelah dikonsumsi dari antrian dan berubah dari status Active menjadi Inactive. Nilai valid: 1 hingga 43200. Unit: detik. Nilai default: 30.	60
PollingWaitSeconds	integer	Waktu tunggu maksimum untuk permintaan ReceiveMessage pada antrian ketika antrian tidak memiliki Paket. Unit: detik.	0
ActiveMessages	integer	Jumlah total perkiraan Paket dalam status Active di antrian. Peringatan Bidang ini akan dihentikan penggunaannya dan defaultnya adalah 0. Gunakan API CloudMonitor untuk mengambil data deret waktu ini sebagai gantinya.	0
InactiveMessages	integer	Jumlah total perkiraan Paket dalam status Inactive di antrian. Peringatan Bidang ini akan dihentikan penggunaannya dan defaultnya adalah 0. Gunakan API CloudMonitor untuk mengambil data deret waktu ini sebagai gantinya.	0
DelayMessages	integer	Jumlah total perkiraan Paket dalam status Delayed di antrian. Peringatan Bidang ini akan dihentikan penggunaannya dan defaultnya adalah 0. Gunakan API CloudMonitor untuk mengambil data deret waktu ini sebagai gantinya.	0
LoggingEnabled	boolean	Apakah fitur manajemen log diaktifkan. True: Diaktifkan. False: Dinonaktifkan.	True
Tags	array<object>	Daftar tag Sumber daya.
	object	Nilai tag yang sesuai dengan kunci tag.
TagKey	string	The key of the tag.	tag1
TagValue	string	The value of the tag.	test
DlqPolicy	object	Kebijakan dead-letter Antrian.
Enabled	boolean	Indicates whether dead-letter message delivery is enabled.	true
DeadLetterTargetQueue	string	The target queue for dead-letter message delivery.	deadLetterTargetQueue
MaxReceiveCount	string	The maximum number of times a message can be delivered.	3
TenantRateLimitPolicy	object	Kebijakan Pembatasan laju.
Enabled	boolean	Indicates whether rate limiting is enabled. Valid values: true false	true
MaxReceivesPerSecond	integer	The maximum number of receives per second.	1000
QueueType	string	Tipe antrian. Nilai valid: normal: antrian standar fifo: antrian FIFO	normal
EnableSSE	boolean
SseType	string
SseAlgorithm	string
KmsKeyId	string
EncryptionEnabled	boolean

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.