Lacak status tugas email melalui API GetMailTaskStatus-Quick BI-Alibaba Cloud - Quick BI

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

quickbi-public:GetMailTaskStatus

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
MailId	string	Yes	ID Email	d5a59a898b634d75be5584f8dc159c62
TaskId	integer	No	ID Tugas Catatan Jika ID tugas tidak diberikan, status tugas terbaru akan dikembalikan secara default; Jika ID tugas diberikan, status tugas yang ditentukan akan dikembalikan.	7218865303929605212

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
RequestId	string	ID Permintaan.	38C0FEC8-1510-415C-A9F1-9AE9422BDB65
Result	array<object>	Hasil kembalian.
	object	Hasil kembalian.
execTime	string	Waktu eksekusi, dalam format yyyy-MM-dd HH:mm:ss	2024-10-09 17:34:11
mailId	string	ID Email	c38f73f4c5xxxxxc808c41b3f4d23b7852
status	string	Status email. Nilai yang mungkin: Berhasil: SENT Gagal: FAILED Sedang Berlangsung: PROCESSING	SENT
taskId	integer	ID Tugas	1282xxx610816
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang mungkin: true: Permintaan berhasil. false: Permintaan gagal.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "38C0FEC8-1510-415C-A9F1-9AE9422BDB65",
  "Result": [
    {
      "execTime": "2024-10-09 17:34:11",
      "mailId": "c38f73f4c5xxxxxc808c41b3f4d23b7852",
      "status": "SENT",
      "taskId": 0
    }
  ],
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Mail.Forbidden.Access	Forbidden Access On This Operation.
400	Mail.Not.Found	Mail not found.
400	Mail.Subject.Error	The mail subject is invalid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.