All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeHistoryTasks

    Document Center

    ApsaraDB for MongoDB:DescribeHistoryTasks

    Last Updated:Jun 10, 2026

    Memuat daftar tugas di pusat tugas.

    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

    dds:DescribeHistoryTasks

    list

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#InstanceId}

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    ID region dari event yang tertunda. Anda dapat memanggil operasi DescribeRegions untuk memuat daftar region terbaru.

    cn-beijing
    PageSize

    integer

    No

    Jumlah entri per halaman. Nilai yang valid: 10 hingga 100. Nilai default: 10.

    10
    PageNumber

    integer

    No

    Nomor halaman yang akan dikembalikan. Nilai harus berupa bilangan bulat positif. Nilai default: 1.

    1
    InstanceType

    string

    No

    Jenis instance dari instance. Tetapkan nilainya menjadi Instance.

    Instance
    Status

    string

    No

    Status tugas. Nilai yang valid:

    • Scheduled: Tugas sedang menunggu untuk dieksekusi.

    • Running: Tugas sedang berjalan.

    • Succeed: Tugas berhasil.

    • Failed: Tugas gagal.

    • Cancelling: Tugas sedang dihentikan.

    • Canceled: Tugas telah dihentikan.

    • Waiting: Tugas sedang menunggu waktu yang dijadwalkan.

    Pisahkan beberapa status dengan koma (,). Parameter ini kosong secara default, yang menunjukkan bahwa tugas dalam semua status akan dimuat.

    Succeed,Running,Waiting
    InstanceId

    string

    No

    ID instance. Pisahkan beberapa ID instance dengan koma (,). Anda dapat menentukan hingga 30 ID instance. Parameter ini kosong secara default, yang menunjukkan bahwa tugas dari semua instance akan dimuat.

    dds-8vb38f0e7933xxxx
    TaskId

    string

    No

    ID tugas. Pisahkan beberapa ID tugas dengan koma (,). Anda dapat menentukan hingga 30 ID tugas. Parameter ini kosong secara default, yang menunjukkan bahwa semua tugas akan dimuat.

    t-0mq1yyhm3ffl2bxxxx
    TaskType

    string

    No

    Jenis tugas. Parameter ini kosong secara default, yang menunjukkan bahwa semua jenis tugas akan dimuat. Nilai yang valid:

    • CreateIns: Membuat instance.

    • DeleteIns: Menghapus instance.

    • ChangeVariable: Memodifikasi pengaturan parameter untuk instance.

    • ModifyInsConfig: Mengubah konfigurasi instance.

    • RestartIns: Memulai ulang instance.

    • HaSwitch: Melakukan switchover primer/sekunder pada instance.

    • CloneIns: Mengkloning instance.

    • KernelVersionUpgrade: Memperbarui versi minor instance.

    • ProxyVersionUpgrade: Meng-upgrade versi agen instance.

    • ModifyAccount: Mengubah akun instance.

    • ModifyInsSpec: Mengubah spesifikasi instance atau melakukan migrasi data pada instance.

    • CreateReadIns: Membuat instance read-only.

    • StartIns: Memulai instance.

    • StopIns: Menghentikan instance.

    • ModifyNetwork: Memodifikasi jenis jaringan untuk instance.

    • LockIns: Mengunci instance.

    • UnlockIns: Membuka kunci instance.

    • DiskOnlineExpansion: Memperluas disk instance secara online.

    • StorageOnlineExpansion: Memperluas kapasitas penyimpanan instance secara online.

    • AddInsNode: Menambahkan node ke instance.

    • DeleteInsNode: Menghapus node dari instance.

    • ManualBackupIns: Mencadangkan instance secara manual.

    • ModifyInsStorageType: Memodifikasi jenis penyimpanan untuk instance.

    DeleteInsNode
    FromStartTime

    string

    Yes

    Waktu mulai tugas O&M yang akan dilakukan. Tentukan waktu dalam standar ISO 8601 dengan format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Anda dapat memuat data dalam 30 hari terakhir.

    2023-03-15T03:41:26Z
    ToStartTime

    string

    Yes

    Waktu akhir tugas O&M yang akan dilakukan. Tentukan waktu dalam standar ISO 8601 dengan format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Anda dapat memuat data dalam 30 hari terakhir.

    2023-03-16T07:21:31Z
    FromExecTime

    integer

    No

    Durasi eksekusi minimum tugas. Parameter ini digunakan untuk memfilter tugas yang durasi eksekusinya lebih lama dari durasi eksekusi minimum. Unit: detik. Nilai default adalah 0, yang menunjukkan bahwa tidak ada batasan yang diterapkan untuk query.

    0
    ToExecTime

    integer

    No

    Durasi eksekusi maksimum tugas. Parameter ini digunakan untuk memfilter tugas yang durasi eksekusinya lebih pendek atau sama dengan durasi eksekusi maksimum. Unit: detik. Nilai default adalah 0, yang menunjukkan bahwa tidak ada batasan yang diterapkan untuk query.

    0
    ResourceGroupId

    string

    No

    ID grup sumber daya.

    rg-aek2inrfrnw3xby

    Elemen respons

    Element

    Type

    Description

    Example

    object

    PageNumber

    integer

    Nomor halaman yang dikembalikan.

    1
    RequestId

    string

    ID permintaan.

    3C4A2494-XXXX-XXXX-93CF-548DB3375193
    PageSize

    integer

    Jumlah maksimum entri yang dikembalikan per halaman.

    10
    TotalCount

    integer

    Jumlah total tugas yang memenuhi kondisi tersebut tanpa memperhitungkan paginasi.

    5
    Items

    array<object>

    Objek tugas.

    object

    Status

    string

    Status tugas. Nilai yang valid:

    • Scheduled: Tugas sedang menunggu untuk dieksekusi.

    • Running: Tugas sedang berjalan.

    • Succeed: Tugas berhasil.

    • Failed: Tugas gagal.

    • Cancelling: Tugas sedang dihentikan.

    • Canceled: Tugas telah dihentikan.

    • Waiting: Tugas sedang menunggu waktu yang dijadwalkan.

    Succeed
    TaskId

    string

    ID tugas.

    t-0mq1yyhm3ffl2bxxxx
    CurrentStepName

    string

    Nama langkah saat ini. Jika parameter ini dikosongkan, tugas belum dimulai.

    exec_task
    StartTime

    string

    Waktu mulai tugas O&M yang dilakukan. Waktu mengikuti standar ISO 8601 dengan format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

    2023-02-11T02:33Z
    EndTime

    string

    Waktu akhir tugas O&M yang dilakukan. Waktu mengikuti standar ISO 8601 dengan format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

    2023-03-16T02:59Z
    TaskType

    string

    Jenis tugas.

    • CreateIns: Membuat instance.

    • DeleteIns: Menghapus instance.

    • ChangeVariable: Memodifikasi pengaturan parameter untuk instance.

    • ModifyInsConfig: Mengubah konfigurasi instance.

    • RestartIns: Memulai ulang instance.

    • HaSwitch: Melakukan switchover primer/sekunder pada instance.

    • CloneIns: Mengkloning instance.

    • KernelVersionUpgrade: Memperbarui versi minor instance.

    • ProxyVersionUpgrade: Meng-upgrade versi agen instance.

    • ModifyAccount: Mengubah akun instance.

    • ModifyInsSpec: Mengubah spesifikasi instance atau melakukan migrasi data pada instance.

    • CreateReadIns: Membuat instance read-only.

    • StartIns: Memulai instance.

    • StopIns: Menghentikan instance.

    • ModifyNetwork: Memodifikasi jenis jaringan untuk instance.

    • LockIns: Mengunci instance.

    • UnlockIns: Membuka kunci instance.

    • DiskOnlineExpansion: Memperluas disk instance secara online.

    • StorageOnlineExpansion: Memperluas kapasitas penyimpanan instance secara online.

    • AddInsNode: Menambahkan node ke instance.

    • DeleteInsNode: Menghapus node dari instance.

    • ManualBackupIns: Mencadangkan instance secara manual.

    • ModifyInsStorageType: Memodifikasi jenis penyimpanan untuk instance.

    CreateIns
    RemainTime

    integer

    Estimasi sisa waktu eksekusi. Unit: detik. Nilai 0 menunjukkan bahwa tugas telah selesai.

    1000

    Progress

    number

    Kemajuan tugas saat ini. Nilai yang valid berkisar dari 0 hingga 100.

    100.0
    RegionId

    string

    ID region instance.

    cn-hangzhou
    InstanceType

    string

    Jenis instance dari instance. Nilainya ditetapkan menjadi Instance.

    Instance
    InstanceId

    string

    ID instance

    dds-t4n18194768fxxxx
    InstanceName

    string

    Nama instance.

    test-dds
    DbType

    string

    Jenis database. Nilainya ditetapkan menjadi mongodb.

    mongodb
    Product

    string

    Produk. Nilainya ditetapkan menjadi dds.

    dds
    TaskDetail

    string

    Detail tugas. Detail tugas bervariasi berdasarkan nilai parameter taskType.

    {\"callerUid\":\"test\"}
    ReasonCode

    string

    Alasan mengapa tugas saat ini dimulai.

    小版本升级
    ActionInfo

    string

    Sekumpulan tindakan yang diizinkan untuk dilakukan pada tugas. Sistem mencocokkan nama langkah saat ini dan status tugas dengan tindakan yang tersedia yang ditentukan oleh ActionInfo. Jika tidak ada tindakan yang cocok ditemukan, status tugas saat ini tidak mendukung tindakan apa pun. Contoh:

       "steps": [
    {
      "step_name": "exec_task", // Nama langkah, yang cocok dengan nilai CurrentStepName.
      "action_info": {    // Tindakan yang didukung untuk langkah ini.
        "Waiting": [      // Status, yang cocok dengan nilai Status.
          "modifySwitchTime" // Tindakan. Beberapa tindakan didukung.
        ]
      }
    },
    {
      "step_name": "init_task", // Nama langkah.
      "action_info": {    // Tindakan yang didukung untuk langkah ini.
        "Running": [      // Status.
          "cancel",       // Tindakan.
          "pause"
        ]
      }
    }
  ]
}

    Sistem dapat mendukung tindakan berikut:

    • retry: melakukan upaya lain.

    • cancel: melakukan pembatalan.

    • modifySwitchTime: mengubah waktu pengalihan atau pemulihan.

    `{\"steps\":[{\"action_info\":{\"Waiting\":[\"modifySwitchTime\"]},\"step_name\":\"exec_task\"}]}`
    Uid

    string

    ID pengguna pemilik sumber daya.

    141345906006****
    CallerSource

    string

    Sumber permintaan. Nilai yang valid: System dan User.

    System
    CallerUid

    string

    ID pengguna yang membuat permintaan. Jika CallerSource diatur ke User, CallerUid menunjukkan ID unik (UID) pengguna.

    141345906006****

    Contoh

    Respons sukses

    JSONformat

    {
  "PageNumber": 1,
  "RequestId": "3C4A2494-XXXX-XXXX-93CF-548DB3375193",
  "PageSize": 10,
  "TotalCount": 5,
  "Items": [
    {
      "Status": "Succeed",
      "TaskId": "t-0mq1yyhm3ffl2bxxxx",
      "CurrentStepName": "exec_task",
      "StartTime": "2023-02-11T02:33Z",
      "EndTime": "2023-03-16T02:59Z",
      "TaskType": "CreateIns",
      "RemainTime": 1000,
      "Progress": 100,
      "RegionId": "cn-hangzhou",
      "InstanceType": "Instance",
      "InstanceId": "dds-t4n18194768fxxxx",
      "InstanceName": "test-dds",
      "DbType": "mongodb",
      "Product": "dds",
      "TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
      "ReasonCode": "小版本升级",
      "ActionInfo": "`{\\\"steps\\\":[{\\\"action_info\\\":{\\\"Waiting\\\":[\\\"modifySwitchTime\\\"]},\\\"step_name\\\":\\\"exec_task\\\"}]}`",
      "Uid": "141345906006****",
      "CallerSource": "System",
      "CallerUid": "141345906006****"
    }
  ]
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 Param.Invalid Param invalid
    400 Param.Invalid.TimeEndBeforeStart Param invalid. End time before start time

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.