OnsTraceGetResult - ApsaraMQ for RocketMQ

Mengambil hasil dari task kueri jejak pesan menggunakan ID task tersebut.

Deskripsi operasi

Penting Alibaba Cloud OpenAPI adalah API management. Gunakan API ini untuk mengelola dan mengkueri sumber daya layanan Alibaba Cloud. Integrasikan API ini hanya untuk keperluan manajemen. Jangan gunakan API ini pada tautan data inti untuk mengirim dan menerima pesan karena hal ini dapat menimbulkan ancaman terhadap tautan data Anda.

Setelah membuat task kueri jejak pesan dengan memanggil operasi OnsTraceQueryByMsgId atau OnsTraceQueryByMsgKey, Anda akan menerima ID task. Anda kemudian dapat memanggil operasi ini untuk mengambil detail jejak pesan tersebut. ID task tersebut adalah QueryId yang dikembalikan oleh operasi pembuatan.
Task kueri jejak pesan bersifat time-consuming. Jika Anda memanggil operasi ini segera setelah membuat task, kueri tersebut mungkin mengembalikan hasil kosong. Dalam hal ini, tunggu beberapa saat lalu coba panggil kembali.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
QueryId	string	Yes	ID task yang hasil kueri jejak pesannya ingin diambil.	272967562652883649157096685****
InstanceId	string	No	ID instans yang berisi pesan yang ingin Anda kueri.	MQ_INST_111111111111_DOxxxxxx
Topic	string	No	Topik pesan yang ingin Anda kueri.	test

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan. Ini merupakan parameter umum. Setiap permintaan memiliki ID unik yang dapat Anda gunakan untuk pemecahan masalah.	84EE24D2-851F-40D6-B99E-4D6AB909****
TraceData	object	Detail hasil task kueri.
Status	string	Hasil task kueri. Nilai yang valid: finish: Kueri telah selesai. working: Kueri sedang berlangsung. removed: Task telah dihapus.	finish
MsgKey	string	Kunci pesan yang sesuai dengan task kueri.	ORDERID_100
UpdateTime	integer	Waktu pembaruan terakhir dari task kueri.	1570966877000
CreateTime	integer	Waktu pembuatan task kueri.	1570966857000
Topic	string	Topik dari task kueri.	test
UserId	string	ID pengguna yang memulai kueri.	27296756265288****
InstanceId	string	ID instans.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	ID pesan yang sesuai dengan task kueri.	1E05791C117818B4AAC23B1BB0CE****
TraceList	object
TraceMapDo	array<object>	Daftar jejak pesan yang cocok untuk task kueri.
	array<object>
Status	string	Status pengiriman. Nilai yang valid: SEND_SUCCESS: Pesan berhasil dikirim. SEND_FAILED: Pesan gagal dikirim. SEND_ROLLBACK: Pesan transaksional di-rollback. SEND_UNKNOWN: Pesan transaksional belum dikomit. SEND_DELAY: Pesan terjadwal atau tertunda sedang menunggu untuk dikirim.	SEND_SUCCESS
MsgKey	string	Kunci pesan.	ORDERID_100
PubTime	integer	Waktu pesan dikirim.	1570850870478
SubList	object
SubMapDo	array<object>	Daftar jejak konsumsi untuk pesan tersebut.
	array<object>
ClientList	object
SubClientInfoDo	array<object>	Daftar catatan konsumsi untuk client yang termasuk dalam group ID tersebut.
	object
Status	string	Status konsumsi. Nilai yang valid: CONSUME_FAILED: Pesan gagal dikonsumsi. CONSUME_SUCCESS: Pesan berhasil dikonsumsi. CONSUME_NOT_RETURN: Hasil konsumsi tidak dikembalikan. SEND_UNKNOWN: Pesan transaksional belum dikomit. SEND_DELAY: Pesan terjadwal atau tertunda sedang menunggu untuk dikirim.	CONSUME_SUCCESS
SubTime	integer	Stempel waktu UNIX saat konsumsi dimulai.	1570851590511
ReconsumeTimes	integer	Jumlah upaya pengiriman untuk konsumsi ini.	1
SubGroupName	string	Group ID tempat client tersebut berada.	GID_test
ClientHost	string	Alamat client konsumen.	30.5..
CostTime	integer	Waktu yang dibutuhkan untuk konsumsi ini, dalam milidetik.	43
FailCount	integer	Jumlah kegagalan konsumsi untuk group ID tersebut.	0
SubGroupName	string	Group ID konsumen.	GID_test
SuccessCount	integer	Jumlah konsumsi sukses untuk group ID tersebut.	1
Topic	string	Topik pesan.	test
CostTime	integer	Waktu yang dibutuhkan untuk mengirim pesan, dalam milidetik.	24
Tag	string	Tag pesan.	TagA
MsgId	string	ID pesan.	0BC1F01800002A9F000000531246****
PubGroupName	string	Group ID yang dikonfigurasi pada client produsen.	GID_test
BornHost	string	Alamat client produsen.	30.5..
QueryId	string	ID task kueri.	272967562652883649157096685****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "84EE24D2-851F-40D6-B99E-4D6AB909****",
  "TraceData": {
    "Status": "finish",
    "MsgKey": "ORDERID_100",
    "UpdateTime": 1570966877000,
    "CreateTime": 1570966857000,
    "Topic": "test",
    "UserId": "27296756265288****",
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "MsgId": "1E05791C117818B4AAC23B1BB0CE****",
    "TraceList": {
      "TraceMapDo": [
        {
          "Status": "SEND_SUCCESS",
          "MsgKey": "ORDERID_100",
          "PubTime": 1570850870478,
          "SubList": {
            "SubMapDo": [
              {
                "ClientList": {
                  "SubClientInfoDo": [
                    {
                      "Status": "CONSUME_SUCCESS",
                      "SubTime": 1570851590511,
                      "ReconsumeTimes": 1,
                      "SubGroupName": "GID_test",
                      "ClientHost": "30.5.**.**",
                      "CostTime": 43
                    }
                  ]
                },
                "FailCount": 0,
                "SubGroupName": "GID_test",
                "SuccessCount": 1
              }
            ]
          },
          "Topic": "test",
          "CostTime": 24,
          "Tag": "TagA",
          "MsgId": "0BC1F01800002A9F000000531246****",
          "PubGroupName": "GID_test",
          "BornHost": "30.5.**.**"
        }
      ]
    },
    "QueryId": "272967562652883649157096685****"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.