GetTrace - ApsaraMQ for RocketMQ

Mengambil jejak pesan tertentu dalam topik yang ditentukan.

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

get

*Topic

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

None

Sintaks permintaan

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID instans yang akan dikueri.	rmq-cn-zvp2vtypu05
topicName	string	Yes	Nama topik yang akan dikueri.	linkedcare-image
messageId	string	Yes	ID pesan.	012A5AB0BBEC8A000104C6342B00001ECF

Parameter permintaan

Parameter	Type	Required	Description	Example
startTime	string	No	Waktu mulai.	2023-05-10 10:42:11
endTime	string	No	Waktu akhir.	2024-09-09 09:00:00

Elemen respons

Element	Type	Description	Example
	object	Respons.
requestId	string	ID permintaan. Setiap permintaan memiliki ID unik. Anda dapat menggunakan ID ini untuk memecahkan masalah.	7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49
success	boolean	Menunjukkan apakah permintaan berhasil.	true
data	object	Data yang dikembalikan.
regionId	string	ID wilayah.	cn-hangzhou
instanceId	string	ID instans.	rmq-cn-7e22ody****
topicName	string	Nama topik.	topic_test
messageInfo	object	Informasi pesan.
regionId	string	ID wilayah.	cn-beijing
instanceId	string	ID instans.	rmq-cn-u0t2ygjq505
topicName	string	Nama topik.	Topic_normal_inspector
messageId	string	ID pesan.	0A79275A00207A4F0F2916C92F9A0B94
bornTime	string	Waktu saat pesan dihasilkan.	2023-03-22 12:17:08
storeTime	string	Waktu saat pesan disimpan.	2023-03-22 12:17:08
body	string	Isi pesan.	{}
bornHost	string	Sumber pesan.	x.x.x.x
storeHost	string	Lokasi tempat pesan disimpan.	x.x.x.x
messageType	string	Tipe pesan.	NORMAL
messageTag	string	Daftar tag.	xx
messageGroup	string	Kunci sharding sebelumnya. Parameter ini khusus untuk pesan terurut.	xx
messageKeys	array	ID bisnis.
	string	ID bisnis.	xx
userProperties	object	Properti yang ditentukan pengguna.
	string	Properti yang ditentukan pengguna.	xx
transactionId	string	ID transaksi.	xx
liteTopicName	string	Nama topik ringan.	abc
producerInfo	object	Informasi jejak produsen.
records	array<object>	Daftar catatan produksi.
	object	Daftar catatan produksi.
userName	string	Nama produsen.	xxx
clientHost	string	Hostname.	xx.xx.xx.xx
produceTime	string	Waktu saat pesan dikirim.	2023-03-22 12:17:08
produceDuration	integer	Waktu yang diperlukan untuk mengirim pesan.	100
produceStatus	string	Status pengiriman.	SUCCESS
arriveTime	string	Waktu kedatangan.	2023-03-22 12:17:08
messageSource	string	Sumber pesan.	CONSOLE
dlqOriginTopic	string	Topik antrian pesan gagal.	test_topic
dlqOriginMessageId	string	ID pesan dalam antrian pesan gagal.	0A79275A00207A4F0F2916C92F9A0B94
recallTime	string	Waktu saat permintaan pencabutan dimulai. Bidang ini tidak kosong ketika messageSource bernilai recall.	空 \| 2023-03-22 12:17:08
brokerInfo	object	Informasi jejak broker.
presetDelayTime	string	Waktu pengiriman yang telah ditetapkan.	2023-03-22 12:17:08
delayStatus	string	Status pesan terjadwal.	SUCCESS
operations	array<object>	Daftar operasi.
	object	Daftar operasi.
operateType	string	Tipe operasi.	ADD
operateTime	string	Waktu operasi.	2023-03-22 12:17:08
recallResult	string	Hasil operasi pencabutan. Bidang ini tidak kosong jika terdapat catatan pencabutan.	空 \| RECALL_OK \| RECALL_FAIL
consumerInfos	array<object>	Informasi jejak konsumen.
	array<object>	Informasi jejak konsumen.
consumerGroupId	string	ID kelompok konsumen.	GID_inspector_group
records	array<object>	Daftar catatan konsumsi.
	array<object>	Daftar catatan konsumsi.
userName	string	Nama konsumen.	test
clientHost	string	Hostname.	xx.xx.xx.xx
fifoEnable	boolean	Menunjukkan apakah pesan dikonsumsi secara berurutan.	true
consumeStatus	string	Status konsumsi.	SUCCESS
operations	array<object>	Daftar operasi.
	object	Daftar operasi.
operateType	string	Tipe operasi.	ADD
operateTime	string	Waktu operasi.	2023-03-22 12:17:08
invisibleTime	integer	Durasi ketidakterlihatan, dalam milidetik.	100
deadMessage	boolean	Menunjukkan apakah pesan merupakan pesan antrian gagal.	true
popCk	string	Checkpoint POP.	123
consumeStatus	string	Status konsumsi.	SUCCESS
deadMessage	boolean	Menunjukkan apakah pesan merupakan pesan antrian gagal.	true
deadLetterInfo	object	Informasi tentang pesan antrian gagal.
topicName	string	Nama topik.	Register_Sync
messageId	string	ID pesan.	7F000001001F7A4F0F29463F0376047D
toDlqTime	string	Waktu saat pesan tiba di antrian pesan gagal.	2023-03-22 12:17:08
code	string	Kode kesalahan.	InvalidConsumerGroupId
message	string	Pesan kesalahan.	The instance cannot be found.
httpStatusCode	integer	Kode status HTTP.	200
dynamicCode	string	Kode kesalahan dinamis.	InstanceId
dynamicMessage	string	Pesan kesalahan dinamis.	instanceId

Contoh

Respons sukses

JSONformat

{
  "requestId": "7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "messageInfo": {
      "regionId": "cn-beijing",
      "instanceId": "rmq-cn-u0t2ygjq505",
      "topicName": "Topic_normal_inspector",
      "messageId": "0A79275A00207A4F0F2916C92F9A0B94",
      "bornTime": "2023-03-22 12:17:08",
      "storeTime": "2023-03-22 12:17:08",
      "body": "{}",
      "bornHost": "x.x.x.x",
      "storeHost": "x.x.x.x",
      "messageType": "NORMAL",
      "messageTag": "xx",
      "messageGroup": "xx",
      "messageKeys": [
        "xx"
      ],
      "userProperties": {
        "key": "xx"
      },
      "transactionId": "xx",
      "liteTopicName": "abc"
    },
    "producerInfo": {
      "records": [
        {
          "userName": "xxx",
          "clientHost": "xx.xx.xx.xx",
          "produceTime": "2023-03-22 12:17:08",
          "produceDuration": 100,
          "produceStatus": "SUCCESS",
          "arriveTime": "2023-03-22 12:17:08",
          "messageSource": "CONSOLE",
          "dlqOriginTopic": "test_topic",
          "dlqOriginMessageId": "0A79275A00207A4F0F2916C92F9A0B94",
          "recallTime": "空 | 2023-03-22 12:17:08"
        }
      ]
    },
    "brokerInfo": {
      "presetDelayTime": "2023-03-22 12:17:08",
      "delayStatus": "SUCCESS",
      "operations": [
        {
          "operateType": "ADD",
          "operateTime": "2023-03-22 12:17:08"
        }
      ],
      "recallResult": "空 | RECALL_OK | RECALL_FAIL"
    },
    "consumerInfos": [
      {
        "consumerGroupId": "GID_inspector_group",
        "records": [
          {
            "userName": "test",
            "clientHost": "xx.xx.xx.xx",
            "fifoEnable": true,
            "consumeStatus": "SUCCESS",
            "operations": [
              {
                "operateType": "ADD",
                "operateTime": "2023-03-22 12:17:08",
                "invisibleTime": 100,
                "deadMessage": true
              }
            ],
            "popCk": "123"
          }
        ],
        "consumeStatus": "SUCCESS",
        "deadMessage": true,
        "deadLetterInfo": {
          "topicName": "Register_Sync",
          "messageId": "7F000001001F7A4F0F29463F0376047D",
          "toDlqTime": "2023-03-22 12:17:08"
        }
      }
    ]
  },
  "code": "InvalidConsumerGroupId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.