Ambil Log PolarDB Secara Aman Menggunakan DescribeDBLogFiles - PolarDB - Alibaba Cloud - PolarDB

Mengkueri log cluster PolarDB, seperti log failover primary/secondary.

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

polardb:DescribeDBLogFiles

list

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID cluster.	pc-*************
DBNodeId	string	No	ID node dalam cluster PolarDB.	pi-*************
PageNumber	integer	No	Nomor halaman. Nilainya harus berupa bilangan bulat yang lebih besar dari 0. Nilai default adalah 1.	1
PageSize	integer	No	Ukuran halaman. Nilai yang valid: 5 hingga 50. Nilai default adalah 10.	10
StartTime	string	No	Awal rentang waktu untuk dikueri. Waktu harus dalam UTC dan diformat sebagai `yyyy-MM-ddTHH:mm:ssZ`.	2023-08-20T16:00:00Z
EndTime	string	No	Akhir rentang waktu untuk dikueri. Waktu harus dalam UTC dan diformat sebagai `yyyy-MM-ddTHH:mm:ssZ`.	2023-09-20T16:00:00Z
LogType	string	Yes	Tipe log. Nilai yang valid: HaSwitchLogList: Daftar log failover. HaSwitchLogInfo: Detail log failover. SimulateSwitchLogs: Log simulasi failover. Valid values: HaSwitchLogInfo : HaSwitchLogInfo SimulateSwitchLogs : SimulateSwitchLogs HaSwitchLogList : HaSwitchLogList	HaSwitchLogList
DescribeSimulateSwitchMode	string	No	Mode untuk mengkueri catatan simulasi. Nilai yang valid: 0: Mengkueri catatan simulasi dari instance logis. Anda dapat menentukan ID simulasi. 1: Mengkueri catatan simulasi dari instance fisik berdasarkan `SimulateListId` yang ditentukan. 2: Mengkueri catatan dari simulasi terbaru yang sedang berlangsung.	0
SimulateListId	string	No	ID dari catatan simulasi instance logis.	"95"
SimulateStatusList	string	No	Memfilter hasil berdasarkan satu atau beberapa status simulasi. Tentukan beberapa status sebagai string yang dipisahkan koma. Nilai yang valid: 0: Menunggu penjadwalan 1: Berhasil 2: Berjalan 3: Gagal 4: Terganggu 5: Menunggu switchback 6: Dibatalkan	"0,1,2,3,4,5"
SimulateModeList	string	No	Memfilter hasil berdasarkan satu atau beberapa mode simulasi. Tentukan beberapa mode sebagai string yang dipisahkan koma. Nilai yang valid: 0: Kesalahan disuntikkan ke availability zone utama. 1: Kesalahan disuntikkan ke instance DB. 2: Kesalahan disuntikkan ke pusat data pemulihan bencana.	0,1,2

Elemen respons

Element	Type	Description	Example
	object
TotalRecords	integer	Jumlah total catatan.	1
ItemsNumbers	integer	Jumlah item log pada halaman saat ini.	1
PageNumber	integer	Nomor halaman. Harus berupa bilangan bulat positif yang tidak melebihi nilai maksimum tipe data Integer. Nilai default: 1.	1
DBInstanceName	string	ID cluster.	pc-****************
DBInstanceType	string	Tipe instance. Nilai yang valid: polardb_mysql_rw: instance baca-tulis. polardb_mysql_ro: instance baca-saja. polardb_mysql_standby: instance standby.	polardb_mysql_rw
HaStatus	integer	Menunjukkan apakah ada catatan failover. Nilai yang valid: 1: Tidak 0: Ya Valid values: 0 : 0 1 : 1	1
HaLogItems	array<object>	Daftar log failover.
	object	Log failover.
SwitchId	string	ID log failover.	e571f897-9b3c-4012-9470-88333832dec4
FromDBType	string	Tipe instance sebelum failover. Nilai yang valid: polardb_mysql_rw: instance baca-tulis. polardb_mysql_ro: instance baca-saja. polardb_mysql_standby: instance standby.	polardb_mysql_rw
SwitchCauseCode	string	Kode kesalahan untuk penyebab failover.	Platform.Ha.AuroraService.ManualOperations
SwitchCauseDetail	string	Detail tentang penyebab failover.	Platform.Ha.ManuallyTriggered
SwitchStartTime	string	Waktu saat failover dimulai. Waktu dalam format `yyyy-MM-ddTHH:mm:ssZ` dan ditampilkan dalam UTC.	2025-05-20T03:09:45Z
SwitchFinishTime	string	Waktu saat failover selesai. Waktu dalam format `yyyy-MM-ddTHH:mm:ssZ` dan ditampilkan dalam UTC.	2025-05-20T03:09:56Z
TotalSessions	integer	Jumlah total sesi selama failover.	10000
AffectedSessions	integer	Jumlah sesi yang terpengaruh selama failover.	100
SwitchType	integer	Tipe failover.	0
RequestId	string	ID permintaan.	24A1990B-4F6E-482B-B8CB-75C612******
PageSize	integer	Jumlah entri yang dikembalikan pada setiap halaman. Nilai yang valid: 5 hingga 50. Nilai default: 10.	10
SwitchListItems	array<object>	Daftar catatan simulasi kesalahan.
	array<object>	Catatan simulasi kesalahan.
SimulateListId	string	ID catatan simulasi kesalahan.	23
SimulateMode	string	Mode simulasi kesalahan.	0
SimulateStatus	string	Status simulasi kesalahan. Nilai yang valid: 0: Tertunda 1: Berhasil 2: Berjalan 3: Gagal 4: Dibatalkan 5: Menunggu rollback	2
StartTime	string	Waktu saat simulasi kesalahan dimulai. Waktu dalam format `yyyy-MM-ddTHH:mm:ssZ` dan ditampilkan dalam UTC.	2025-02-25T01:05:00Z
EndTime	string	Waktu saat simulasi kesalahan selesai. Waktu dalam format `yyyy-MM-ddTHH:mm:ssZ` dan ditampilkan dalam UTC.	2025-02-10T02:25:00Z
EventStartTime	string	Waktu saat peristiwa sistem dimulai. Waktu dalam format `yyyy-MM-ddTHH:mm:ssZ` dan ditampilkan dalam UTC.	2025-04-19T01:12:00Z
EventFinishTime	string	Waktu saat peristiwa sistem selesai. Waktu dalam format `yyyy-MM-ddTHH:mm:ssZ` dan ditampilkan dalam UTC.	2025-04-19T02:12:00Z
SimulateTaskId	string	ID task simulasi kesalahan.	23
DBNodeCrashList	array	ID node tempat simulasi kesalahan akan dilakukan. Catatan Untuk simulasi kesalahan tingkat node, tentukan ID node tunggal. Untuk simulasi kesalahan tingkat availability zone, Anda dapat mengabaikan parameter ini atau menentukan ID semua node di zona tersebut.
	string	ID node.	pi-bp19v6xsl0u2c1cqq,pi-bp1ap84xmpf4c1c1t
SwitchLogItems	array<object>	Daftar log simulasi kesalahan.
	array<object>	Log simulasi kesalahan.
SimulateListId	string		96
SimulateLogId	string		23
DBInstanceId	string		pc-*************
SrcDbType	string		PolarDBMySQL
DstDbType	string		PolarDBMySQL
SimulateStatus	string		1
EventStartTime	string		2025-04-19T01:12:00Z
EventFinishTime	string		2025-04-19T02:12:00Z
SwitchStepItems	array<object>
	object
StepName	string		init_task_info
StartTime	string		2025-04-19T02:12:00Z
SimulatePhase	string		PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
EndTime	string		2025-08-14T02:07:00Z
TimeCost	string		1000
IsSuccess	string		true
SwitchStepItems	array<object>	Daftar langkah failover.
	object
SimulatePhase	string		PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
StepName	string		init_task_info
StartTime	string		2025-07-16T02:12:00Z
EndTime	string		2025-07-23T02:30:00Z
TimeCost	string		1000
IsSuccess	string		true
DBNodeId	string		pi-*************
FaultInjectionType	string	Metode injeksi kesalahan. Nilai yang valid: CrashSQLInjection: Menyuntikkan kesalahan ke instance dengan menggunakan `Crash SQL`.	CrashSQLInjection
SwitchLogItems	array<object>	Daftar log simulasi kesalahan.
	array<object>	Log simulasi kesalahan.
SimulateListId	string	ID daftar simulasi.	231
Simulatecode	string	Kode status simulasi kesalahan.	0
DBInstanceId	string	ID cluster. Catatan Anda dapat memanggil operasi DescribeDBClusters untuk mengkueri detail cluster Anda, termasuk ID cluster.	pc-*************
SrcDbType	string	Tipe database sumber. Nilai yang valid: PolarDBMySQL: Peningkatan versi mayor PolarDB for MySQL. RDS: Migrasi dari RDS ke PolarDB for MySQL.	PolarDBMySQL
DstDbType	string	Tipe database tujuan. Nilai yang valid: PolarDBMySQL: Peningkatan versi mayor PolarDB for MySQL. RDS: Migrasi dari RDS ke PolarDB for MySQL.	PolarDBMySQL
SimulateStatus	string	Status simulasi kesalahan. Nilai yang valid: 0: Tertunda 1: Berhasil 2: Berjalan 3: Gagal 4: Dibatalkan 5: Menunggu rollback	1
EventStartTime	string	Waktu saat peristiwa sistem dimulai. Waktu dalam format `yyyy-MM-ddTHH:mm:ssZ` dan ditampilkan dalam UTC.	2025-04-19T01:12:00Z
EventFinishTime	string	Waktu saat peristiwa sistem selesai. Waktu dalam format `yyyy-MM-ddTHH:mm:ssZ` dan ditampilkan dalam UTC.	2025-04-19T02:12:00Z
SwitchStepItems	array<object>	Daftar langkah failover.
	object
StepName	string		init_task_info
StepMsg	string		This step exec success
StartTime	string		2024-10-21T02:12:00Z
EndTime	string		2025-03-27T02:27:00Z
TimeCost	string		1000
IsSuccess	string		true
SimulatePhase	string		PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION
DBNodeId	string		pi-*************

Contoh

Respons sukses

JSONformat

{
  "TotalRecords": 1,
  "ItemsNumbers": 1,
  "PageNumber": 1,
  "DBInstanceName": "pc-****************",
  "DBInstanceType": "polardb_mysql_rw",
  "HaStatus": 1,
  "HaLogItems": [
    {
      "SwitchId": "e571f897-9b3c-4012-9470-88333832dec4",
      "FromDBType": "polardb_mysql_rw",
      "SwitchCauseCode": "Platform.Ha.AuroraService.ManualOperations",
      "SwitchCauseDetail": "Platform.Ha.ManuallyTriggered",
      "SwitchStartTime": "2025-05-20T03:09:45Z",
      "SwitchFinishTime": "2025-05-20T03:09:56Z",
      "TotalSessions": 10000,
      "AffectedSessions": 100,
      "SwitchType": 0
    }
  ],
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "PageSize": 10,
  "SwitchListItems": [
    {
      "SimulateListId": "23",
      "SimulateMode": "0",
      "SimulateStatus": "2",
      "StartTime": "2025-02-25T01:05:00Z",
      "EndTime": "2025-02-10T02:25:00Z",
      "EventStartTime": "2025-04-19T01:12:00Z",
      "EventFinishTime": "2025-04-19T02:12:00Z",
      "SimulateTaskId": "23",
      "DBNodeCrashList": [
        "pi-bp19v6xsl0u2c1cqq,pi-bp1ap84xmpf4c1c1t"
      ],
      "SwitchLogItems": [
        {
          "SimulateListId": "96",
          "SimulateLogId": "23",
          "DBInstanceId": "pc-*************",
          "SrcDbType": "PolarDBMySQL",
          "DstDbType": "PolarDBMySQL",
          "SimulateStatus": "1",
          "EventStartTime": "2025-04-19T01:12:00Z",
          "EventFinishTime": "2025-04-19T02:12:00Z\n",
          "SwitchStepItems": [
            {
              "StepName": "init_task_info",
              "StartTime": "2025-04-19T02:12:00Z",
              "SimulatePhase": "PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION",
              "EndTime": "2025-08-14T02:07:00Z",
              "TimeCost": "1000",
              "IsSuccess": "true"
            }
          ]
        }
      ],
      "SwitchStepItems": [
        {
          "SimulatePhase": "PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION",
          "StepName": "init_task_info",
          "StartTime": "2025-07-16T02:12:00Z",
          "EndTime": "2025-07-23T02:30:00Z",
          "TimeCost": "1000",
          "IsSuccess": "true",
          "DBNodeId": "pi-*************"
        }
      ],
      "FaultInjectionType": "CrashSQLInjection"
    }
  ],
  "SwitchLogItems": [
    {
      "SimulateListId": "231",
      "Simulatecode": "0",
      "DBInstanceId": "pc-*************",
      "SrcDbType": "PolarDBMySQL",
      "DstDbType": "PolarDBMySQL",
      "SimulateStatus": "1",
      "EventStartTime": "2025-04-19T01:12:00Z",
      "EventFinishTime": "2025-04-19T02:12:00Z",
      "SwitchStepItems": [
        {
          "StepName": "init_task_info",
          "StepMsg": "This step exec success ",
          "StartTime": "2024-10-21T02:12:00Z",
          "EndTime": "2025-03-27T02:27:00Z",
          "TimeCost": "1000",
          "IsSuccess": "true",
          "SimulatePhase": "PolarDB.MySQL.FaultSimulate.Phase.FAULT_INJECTION",
          "DBNodeId": "pi-*************"
        }
      ]
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.