Kueri pekerjaan sinkronisasi melalui API ListSynchronizationJobs dengan NextToken - EIAM - Alibaba Cloud - Identity as a Service

Mengkueri daftar detail pekerjaan sinkronisasi.

Deskripsi operasi

Dua metode berikut didukung untuk melihat data yang dikembalikan:

Metode 1: Saat mengkueri halaman pertama, tetapkan hanya MaxResults untuk membatasi jumlah entri yang dikembalikan. Nilai NextToken dalam tanggapan berfungsi sebagai kredensial untuk mengkueri halaman berikutnya. Saat mengkueri halaman berikutnya, tetapkan parameter NextToken ke nilai NextToken yang diperoleh dari tanggapan sebelumnya, dan tetapkan MaxResults untuk membatasi jumlah entri yang dikembalikan. Jika tidak ada halaman lagi, NextToken tidak lagi dikembalikan. Nilai maksimum MaxResults adalah 100.
Metode 2: Tetapkan jumlah entri yang dikembalikan per halaman dengan menggunakan PageSize, dan tetapkan nomor halaman dengan menggunakan PageNumber.

Anda hanya dapat menggunakan salah satu dari dua metode sebelumnya. Ketika Tingkat Tinggi entri dikembalikan, gunakan Metode 1. Jika parameter MaxResults atau NextToken ditetapkan, parameter permintaan PageSize dan PageNumber menjadi tidak valid.

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

eiam:ListSynchronizationJobs

list

*SynchronizationJob

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans.	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	integer	No	Nomor halaman, dimulai dari 1.	1
PageSize	integer	No	Ukuran halaman. Nilai maksimum: 100.	10
NextToken	string	No	Token untuk mengkueri halaman berikutnya. Parameter ini tidak dikembalikan ketika tidak ada halaman lagi.	NTxxxxxexample
MaxResults	integer	No	Jumlah baris per halaman untuk kueri berpaginasi. Nilai maksimum: 100.	20
TargetType	string	No	Tipe target sinkronisasi. Nilai valid: identity_provider: penyedia identitas application: aplikasi.	identity_provider
TargetIds	array	No	Daftar ID target sinkronisasi. [idp_111XXXX,idp_222XXXX].	target_001
	string	No	ID target sinkronisasi.	idp_my664lwkhpicbyzirog3xxxxx
StartTime	integer	No	pengatur waktu mulai sinkronisasi dalam format stempel waktu UNIX, dalam milidetik.	1649830226000
EndTime	integer	No	pengatur waktu selesai sinkronisasi dalam format stempel waktu UNIX, dalam milidetik.	1649830226000
Direction	string	No	Arah pekerjaan sinkronisasi. Nilai valid: ingress: arah masuk egress: arah keluar.	ingress
Status	string	No	Status pekerjaan sinkronisasi. Nilai valid: pending: status awal running: berjalan failed: gagal partial_success: sebagian berhasil success: berhasil.	running
Filters	array<object>	No	Parameter filter.
	object	No	Parameter filter.
Key	string	No	Nama parameter dinamis.	qps
Values	array	No	Nilai parameter dinamis.
	string	No	Nilai parameter dinamis.	[]

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	Jumlah total entri.	100
NextToken	string	Nilai token kueri yang dikembalikan oleh permintaan ini.	NTxxxexample
SynchronizationJobs	array<object>	Daftar pekerjaan sinkronisasi.
	array<object>	Detail pekerjaan sinkronisasi.
SynchronizationJobId	string	ID pekerjaan sinkronisasi.	sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx
TargetType	string	Tipe target sinkronisasi. Nilai valid: identity_provider: penyedia identitas application: aplikasi.	identity_provider
TargetId	string	ID target sinkronisasi.	idp_my664lwkhpicbyzirog3xxxxx
Direction	string	Arah pekerjaan sinkronisasi. Nilai valid: ingress: arah masuk egress: arah keluar.	ingress
StartTime	integer	pengatur waktu mulai sinkronisasi dalam format stempel waktu UNIX, dalam milidetik.	1649830226000
EndTime	integer	pengatur waktu selesai sinkronisasi dalam format stempel waktu UNIX, dalam milidetik.	1649830226000
TriggerType	string	Tipe pemicu sinkronisasi. Nilai valid: auto: dipicu secara otomatis manual: dipicu secara manual.	auto
Status	string	Status pekerjaan sinkronisasi. Nilai valid: pending: status awal running: berjalan failed: gagal partial_success: sebagian berhasil success: berhasil.	success
Result	object	Hasil pekerjaan sinkronisasi.
UserStatistics	object	Statistik hasil sinkronisasi pengguna.
Created	object	Statistik hasil pembuatan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Updated	object	Statistik hasil pembaruan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Binded	object	Statistik hasil pengikatan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Deleted	object	Statistik hasil penghapusan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Same	object	Statistik entri yang identik.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Pushed	object	Statistik hasil dorongan (push).
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Exported	object	Statistik hasil ekspor.
Total	integer	Jumlah total.	5
Success	integer	Jumlah operasi yang berhasil.	2
Failed	integer	Jumlah operasi yang gagal.	2
Skipped	integer	Jumlah operasi yang dilewati.	1
OrganizationalUnitStatistics	object	Statistik hasil sinkronisasi organisasi.
Created	object	Statistik hasil pembuatan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Updated	object	Statistik hasil pembaruan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Binded	object	Statistik hasil pengikatan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Deleted	object	Statistik hasil penghapusan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Same	object	Statistik entri yang identik.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Pushed	object	Statistik hasil dorongan (push).
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
GroupStatistics	object	Statistik hasil sinkronisasi grup.
Created	object	Statistik hasil pembuatan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Updated	object	Statistik hasil pembaruan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Binded	object	Statistik hasil pengikatan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Deleted	object	Statistik hasil penghapusan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Same	object	Statistik entri yang identik.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Pushed	object	Statistik hasil dorongan (push).
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
GroupMemberStatistics	object	Statistik hasil sinkronisasi anggota grup.
Created	object	Statistik hasil pembuatan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Updated	object	Statistik hasil pembaruan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Binded	object	Statistik hasil pengikatan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Deleted	object	Statistik hasil penghapusan.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Same	object	Statistik entri yang identik.
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
Pushed	object	Statistik hasil dorongan (push).
Total	integer	Jumlah total.	3
Success	integer	Jumlah operasi yang berhasil.	1
Failed	integer	Jumlah operasi yang gagal.	1
Skipped	integer	Jumlah operasi yang dilewati.	1
ErrorMessage	string	Pesan kesalahan untuk hasil sinkronisasi.	The specified parameter Username is required!
ErrorCode	string	Kode kesalahan untuk hasil sinkronisasi.	MissingParameter.Username
Description	string	Deskripsi pekerjaan sinkronisasi.	Description

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "SynchronizationJobs": [
    {
      "SynchronizationJobId": "sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx\n",
      "TargetType": "identity_provider",
      "TargetId": "idp_my664lwkhpicbyzirog3xxxxx\n",
      "Direction": "ingress",
      "StartTime": 1649830226000,
      "EndTime": 1649830226000,
      "TriggerType": "auto",
      "Status": "success",
      "Result": {
        "UserStatistics": {
          "Created": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Updated": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Binded": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Deleted": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Same": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Pushed": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Exported": {
            "Total": 5,
            "Success": 2,
            "Failed": 2,
            "Skipped": 1
          }
        },
        "OrganizationalUnitStatistics": {
          "Created": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Updated": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Binded": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Deleted": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Same": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Pushed": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          }
        },
        "GroupStatistics": {
          "Created": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Updated": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Binded": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Deleted": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Same": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Pushed": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          }
        },
        "GroupMemberStatistics": {
          "Created": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Updated": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Binded": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Deleted": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Same": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          },
          "Pushed": {
            "Total": 3,
            "Success": 1,
            "Failed": 1,
            "Skipped": 1
          }
        },
        "ErrorMessage": "The specified parameter Username is required!",
        "ErrorCode": "MissingParameter.Username"
      },
      "Description": " Description"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.