Query audit logs_Lingma_AI Coding Assistant - AI Coding Assistant Lingma

Gunakan API ini untuk menanyakan log audit.

Edisi yang didukung

Enterprise Dedicated Edition

Titik akhir layanan dan informasi otorisasi

Dapatkan titik akhir layanan untuk menggantikan <domain> dalam sintaks permintaan API dengan titik akhir Anda.
Peroleh token akses.
Peroleh organizationId. Buka konsol Lingma dan lihat ID organisasi pada halaman Basic Information di bawah Enterprise settings > > Organization.

Produk	Sumber daya	Izin yang diperlukan
Pengaturan Organisasi	Log Audit	Hanya-Baca

Sintaks permintaan

GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/auditLogs

Header permintaan

Parameter	Tipe	Diperlukan	Deskripsi	Contoh
`x-yunxiao-token`	string	Ya	Token akses.	pt-0fh3**0fbG_35af**0484

Parameter permintaan

Parameter	Tipe	Posisi	Diperlukan	Deskripsi	Contoh
`organizationId`	string	path	Ya	ID organisasi untuk menyaring log di tingkat organisasi.	99d1****71d4
`userIds`	string	query	Tidak	Daftar ID pengguna yang dipisahkan koma yang tindakannya ingin disaring dalam log audit.	99d1****71d4
`apps`	string	query	Tidak	Daftar identitas aplikasi yang dipisahkan koma seperti `lingma` untuk menyaring log untuk aplikasi tersebut.	Nama Aplikasi Contoh
`actionTimeStart`	string	query	Ya	Timestamp awal (dalam format RFC3339) dari rentang pencarian log (inklusif).	2023-09-30T00:00:00.00Z
`actionTimeEnd`	string	query	Tidak	Timestamp akhir (dalam format RFC3339) dari rentang pencarian log (eksklusif). Jika tidak diberikan, default ke waktu saat ini.	2023-08-31T03:59:16.201Z
`perPage`	integer	query	Tidak	Jumlah entri log audit yang akan dikembalikan per halaman. Nilai default: 100.	20
`nextToken`	string	query	Tidak	Token paginasi. Gunakan token ini untuk menanyakan set hasil berikutnya setelah panggilan pertama.

Contoh permintaan

curl -X 'GET' \
  'https://{domain}/oapi/v1/platform/organizations/{organizationId}/auditLogs?userIds={userIds}&apps={apps}&actionTimeStart={actionTimeStart}&actionTimeEnd={actionTimeEnd}&perPage={perPage}&nextToken={nextToken}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Parameter respons

Parameter	Tipe	Deskripsi	Contoh
-	array
-	object
`action`	string	Tindakan yang dilakukan oleh pengguna, seperti logon, membuat pengguna, dan menghapus pengguna.	logon
`actionTime`	string	Waktu ketika tindakan terjadi.	2023-08-31T03:59:16.201Z
`app`	object	Informasi aplikasi.
`identity`	string	Identitas aplikasi.	base
`name`	string	Nama aplikasi.	Nama Aplikasi Contoh
`appId`	string	ID aplikasi unik.	99d1****6124
`detail`	string	Detail tindakan.	xxx logon
`id`	string	ID log audit unik.	99d1****6124
`ip`	string	Alamat IP tempat tindakan dilakukan.	192...1
`organization`	object	Informasi organisasi.
`id`	string	ID organisasi.	99d1****6124
`name`	string	Nama organisasi.	Nama Contoh
`organizationId`	string	ID organisasi.	99d1****6124
`scope`	string	Rentang tindakan.	org
`targetId`	string	ID objek tempat operasi dilakukan.	99d1****6124
`targetType`	string	Tipe objek tempat operasi dilakukan.	user
`user`	object	Informasi operator.
`id`	string	ID pengguna.	99d1****6124
`name`	string	Nama pengguna dari pengguna.	Nama Contoh
`nickName`	string	Nama panggilan atau alias pengguna.	Nama Panggilan Contoh
`userId`	string	ID pengguna.	99d1****6124

Contoh respons sukses

[
    {
        "action": "logon",
        "actionTime": "2023-08-31T03:59:16.201Z",
        "app": {
            "identity": "base",
            "name": "Nama Aplikasi Contoh"
        },
        "appId": "99d1****6124",
        "detail": "xxx logon",
        "id": "99d1****6124",
        "ip": "192.*.*.1",
        "organization": {
            "id": "99d1****6124",
            "name": "Nama Contoh"
        },
        "organizationId": "99d1****6124",
        "scope": "org",
        "targetId": "99d1****6124",
        "targetType": "user",
        "user": {
            "id": "99d1****6124",
            "name": "Nama Contoh",
            "nickName": "Nama Panggilan Contoh"
        },
        "userId": "99d1****6124"
    }
]

Header respons

Parameter	Deskripsi	Contoh
`x-next-token`	Token untuk halaman berikutnya.

Kode kesalahan

Untuk informasi lebih lanjut, lihat Kode kesalahan.