ListTraces - ApsaraMQ for RocketMQ

Mengambil jejak pesan untuk topik tertentu.

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

rocketmq:ListTraces

get

*Topic

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}

None

Sintaks permintaan

GET /instances/{instanceId}/topics/{topicName}/traces HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID instans.	rmq-cn-tl32upjeb08
topicName	string	Yes	Nama topik.	topic_hpms_product_price_change

Parameter permintaan

Parameter	Type	Required	Description	Example
startTime	string	Yes	Waktu mulai.	2023-05-10 10:42:11
endTime	string	Yes	Waktu akhir.	2023-05-19 10:10:09
pageNumber	integer	Yes	Nomor halaman hasil yang akan dikembalikan.	1
pageSize	integer	Yes	Jumlah entri yang dikembalikan per halaman.	10
queryType	string	Yes	Tipe kueri. Valid values: MESSAGE_ID : MESSAGE_ID MESSAGE_KEY : MESSAGE_KEY TOPIC : TOPIC	MESSAGE_ID
messageId	string	No	ID pesan. Parameter ini wajib jika `queryType` diatur ke `MESSAGE_ID`.	0100163E0EC1F1965C04C7906700000000
messageKey	string	No	Kunci pesan. Parameter ini wajib jika `queryType` diatur ke `MESSAGE_KEY`.	order_ceating
liteTopicName	string	No	Nama topik ringan.	abc

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
requestId	string	ID permintaan	EDFF77E1-1ED1-5389-B6A8-651D9433BBE5
success	boolean	Menunjukkan apakah permintaan berhasil.	true
code	string	Kode kesalahan.	Topic.NotFound
message	string	Pesan kesalahan.	Parameter instanceId is mandatory for this action .
data	object	Data yang dikembalikan.
pageNumber	integer	Nomor halaman yang dikembalikan.	1
pageSize	integer	Jumlah entri yang dikembalikan per halaman.	10
totalCount	integer	Total jumlah entri yang dikembalikan.	1
list	array<object>	Data terpaginasi.
	object	Data terpaginasi.
regionId	string	ID wilayah.	cn-hangzhou
instanceId	string	ID instans.	rmq-cn-7e22ody****
topicName	string	Nama topik.	topic_test
messageId	string	ID pesan.	7F00000100207A4F0F294A938F7807AE
bornTime	string	Waktu saat pesan dibuat.	2023-03-22 12:17:08
messageTag	string	Tag pesan.	xx
messageKeys	array	Kunci bisnis.
	string	Satu kunci bisnis.	xx
httpStatusCode	integer	Kode status HTTP.	200
dynamicCode	string	Kode kesalahan dinamis.	InstanceId
dynamicMessage	string	Pesan kesalahan dinamis.	InstanceId

Contoh

Respons sukses

JSONformat

{
  "requestId": "EDFF77E1-1ED1-5389-B6A8-651D9433BBE5",
  "success": true,
  "code": "Topic.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageId": "7F00000100207A4F0F294A938F7807AE",
        "bornTime": "2023-03-22 12:17:08",
        "messageTag": "xx",
        "messageKeys": [
          "xx"
        ]
      }
    ]
  },
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "InstanceId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.