Paging API ListQueue untuk pengambilan antrean massal - Simple Message Queue - Alibaba Cloud - Simple Message Queue (formerly MNS)

Mendaftar semua antrian di bawah akun Alibaba Cloud tertentu dengan dukungan paginasi.

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:ListQueue

list

*Semua resource.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
PageNum	integer	No	Nomor halaman hasil yang akan dikembalikan. Nilai valid: 1 hingga 100000000. Jika Anda menetapkan parameter ini ke nilai kurang dari 1, sistem akan menggunakan 1 secara default. Jika Anda menetapkan parameter ini ke nilai lebih dari 100000000, sistem akan menggunakan 100000000 secara default.	1
PageSize	integer	No	Jumlah entri yang akan dikembalikan pada setiap halaman. Nilai valid: 10 hingga 50. Jika Anda menetapkan parameter ini ke nilai kurang dari 10, sistem akan menggunakan 10 secara default. Jika Anda menetapkan parameter ini ke nilai lebih dari 50, sistem akan menggunakan 50 secara default.	20
QueueName	string	No	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
QueueType	string	No	Tipe antrian. Nilai valid: normal: antrian standar fifo: antrian FIFO	normal

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.
PageNum	integer	Nomor halaman hasil yang dikembalikan.	1
PageSize	integer	Jumlah maksimum entri yang dikembalikan per halaman.	50
Size	integer	Jumlah entri yang dikembalikan pada halaman saat ini.	20
Pages	integer	Jumlah total halaman.	3
Total	integer	Jumlah total entri.	130
PageData	array<object>	Hasil yang dikembalikan pada halaman saat ini.
	array<object>	Entri data.
QueueName	string	The queue name.	demo-queue
CreateTime	integer	The time when the queue was created. This value is a UNIX timestamp that represents the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1250700999
LastModifyTime	integer	The time when the queue properties were last modified. This value is a UNIX timestamp that represents the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1250700999
DelaySeconds	integer	The delay period for all messages that are sent to the queue. A message can be consumed only after the specified delay period. Unit: seconds.	30
MaximumMessageSize	integer	The maximum size of a message body that can be sent to the queue. Unit: bytes.	65536
MessageRetentionPeriod	integer	The maximum time to live for a message in the queue. After the specified period, the message is deleted, regardless of whether it has been consumed. Unit: seconds.	65536
VisibilityTimeout	integer	The period during which a message remains in the Inactive state after it is retrieved from the queue. Valid values: 1 to 43,200. Unit: seconds. Default value: 30.	60
PollingWaitSeconds	integer	The maximum polling wait time for a ReceiveMessage request if the queue is empty. Unit: seconds.	0
ActiveMessages	integer	The total number of active messages in the queue. This is an approximate value. This parameter will default to 0 and is deprecated. Use the CloudMonitor API to obtain this metric.	0
InactiveMessages	integer	The total number of inactive messages in the queue. This is an approximate value. This parameter will default to 0 and is deprecated. Use the CloudMonitor API to obtain this metric.	0
DelayMessages	integer	The total number of delayed messages in the queue. This is an approximate value. This parameter will default to 0 and is deprecated. Use the CloudMonitor API to obtain this metric.	0
LoggingEnabled	boolean	Indicates whether the Log Management feature is enabled. True: Enabled. False: Disabled.	True
Tags	array<object>	A list of resource tags.
	object	The tag value.
TagKey	string	The key of the tag.	tag1
TagValue	string	The value of the tag.	test
DlqPolicy	object	The dead-letter queue policy.
Enabled	boolean	Indicates whether messages can be delivered to a dead-letter queue.	true
DeadLetterTargetQueue	string	The target queue to which dead-letter messages are delivered.	deadLetterTargetQueue
MaxReceiveCount	string	The maximum number of times a message can be delivered.	3
QueueType	string	The type of the queue. Valid values: normal: standard queue fifo: FIFO queue	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": {
    "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
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.