Referensi API DescribeActiveOperationTask - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Mengkueri informasi detail tentang tugas instans Database Apsara for MongoDB.

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:DescribeActiveOperationTask

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Region	string	Yes	ID Wilayah Instans. Catatan Jika Anda mengatur parameter Region ke all, semua Tugas yang dibuat dalam akun Alibaba Cloud Anda akan dikueri. Dalam hal ini, Anda harus mengatur parameter taskType ke all.	cn-shanghai
TaskType	string	Yes	Tipe Tugas. Nilai valid: rds_apsaradb_ha: Alih bencana master-replika rds_apsaradb_transfer: migrasi Instans rds_apsaradb_upgrade: pembaruan versi minor.	rds_apsaradb_ha
IsHistory	integer	No	Apakah akan mengembalikan Tugas historis. Nilai default: 0. Nilai valid: 0: mengembalikan Tugas saat ini. 1: mengembalikan Tugas historis.	0
PageSize	integer	No	Jumlah entri per halaman. Tentukan nilai lebih besar dari 10. Nilai default: 30.	30
PageNumber	integer	No	Nomor halaman. Nilai harus berupa integer lebih besar dari 0. Nilai default: 1.	1
ProductId	string	No	ID Produk.	MongoDB

Elemen respons

Element	Type	Description	Example
	object
TotalRecordCount	integer	The total number of returned entries.	0
RequestId	string	The request ID.	6FD47DC4-0750-5524-A89E-E7D559Cxxxxx
PageSize	integer	The number of entries returned per page.	30
PageNumber	integer	The page number of the returned page.	1
Items	array<object>	The list of tasks.
	object
Status	integer	The state of the task. Valid values: 2: The task is waiting for users to specify a switchover time. 3: The task is waiting to be performed. 4: The task is being performed. If the task is in this state, the ModifyActiveOperationTask operation cannot be called to modify the scheduled switchover time. 5: The task is performed. 6: The task fails. 7: The task is canceled.	2
TaskParams	string	The task parameters.	""
PrepareInterval	string	The required preparation period between the task start time and the switchover time. The time is displayed in the HH:mm:ss format.	14:00:00
Deadline	string	The deadline before which the time to preform the task can be modified. The time in UTC is displayed in the yyyy-MM-ddTHH:mm:ssZ format.	2023-03-29T13:59:59Z
StartTime	string	The time when the task was preformed. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2023-03-20T02:40:00Z
TaskType	string	The type of the task. Valid values: rds_apsaradb_ha: master-replica switchover rds_apsaradb_transfer: instance migration rds_apsaradb_upgrade: minor version update all: all types	rds_apsaradb_ha
ModifiedTime	string	The time when the task was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2023-02-24T08:18:53Z
InsName	string	The instance ID.	dds-bp12721xxxx9b914
DbType	string	The database type of the instance.	mongodb
Region	string	The region of the instance.	cn-beijing
ResultInfo	string	The result information.	""
CreatedTime	string	The time when the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2024-11-06T13:11:08Z
Id	integer	The task ID.	50xx
SwitchTime	string	The time when the system performs the switchover operation. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2024-11-06T14:11:08Z

Contoh

Respons sukses

JSONformat

{
  "TotalRecordCount": 0,
  "RequestId": "6FD47DC4-0750-5524-A89E-E7D559Cxxxxx",
  "PageSize": 30,
  "PageNumber": 1,
  "Items": [
    {
      "Status": 2,
      "TaskParams": "\"\"",
      "PrepareInterval": "14:00:00",
      "Deadline": "2023-03-29T13:59:59Z",
      "StartTime": "2023-03-20T02:40:00Z",
      "TaskType": "rds_apsaradb_ha",
      "ModifiedTime": "2023-02-24T08:18:53Z",
      "InsName": "dds-bp12721xxxx9b914",
      "DbType": "mongodb",
      "Region": "cn-beijing",
      "ResultInfo": "\"\"",
      "CreatedTime": "2024-11-06T13:11:08Z",
      "Id": 0,
      "SwitchTime": "2024-11-06T14:11:08Z\n"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	RequiredParam.NotFound	Required input param is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.