mongodb-atlas-api-client
npm
Atlas Admin API v2
Preparing search index...
CloudBackup
Interface CloudBackup
interface
CloudBackup
{
createSnapshotRestoreJob
(
clustername
:
string
,
body
:
SnapshotRestoreJobRequest
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetSnapshotRestoreJob
>
;
getAllReplicaSetCloudBackups
(
clustername
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetAllReplicaSetCloudBackups
>
;
getReplicaSetCloudBackup
(
clustername
:
string
,
snapshotId
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetReplicaSetCloudBackup
>
;
getSnapshotRestoreJob
(
clustername
:
string
,
restoreJobId
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetSnapshotRestoreJob
>
;
}
Index
Methods
create
Snapshot
Restore
Job
get
All
Replica
Set
Cloud
Backups
get
Replica
Set
Cloud
Backup
get
Snapshot
Restore
Job
Methods
create
Snapshot
Restore
Job
createSnapshotRestoreJob
(
clustername
:
string
,
body
:
SnapshotRestoreJobRequest
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetSnapshotRestoreJob
>
Parameters
clustername
:
string
body
:
SnapshotRestoreJobRequest
Optional
options
:
AtlasClientOptions
Returns
Promise
<
AtlasError
|
GetSnapshotRestoreJob
>
get
All
Replica
Set
Cloud
Backups
getAllReplicaSetCloudBackups
(
clustername
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetAllReplicaSetCloudBackups
>
Parameters
clustername
:
string
Optional
options
:
AtlasClientOptions
Returns
Promise
<
AtlasError
|
GetAllReplicaSetCloudBackups
>
get
Replica
Set
Cloud
Backup
getReplicaSetCloudBackup
(
clustername
:
string
,
snapshotId
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetReplicaSetCloudBackup
>
Parameters
clustername
:
string
snapshotId
:
string
Optional
options
:
AtlasClientOptions
Returns
Promise
<
AtlasError
|
GetReplicaSetCloudBackup
>
get
Snapshot
Restore
Job
getSnapshotRestoreJob
(
clustername
:
string
,
restoreJobId
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
AtlasError
|
GetSnapshotRestoreJob
>
Parameters
clustername
:
string
restoreJobId
:
string
Optional
options
:
AtlasClientOptions
Returns
Promise
<
AtlasError
|
GetSnapshotRestoreJob
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
create
Snapshot
Restore
Job
get
All
Replica
Set
Cloud
Backups
get
Replica
Set
Cloud
Backup
get
Snapshot
Restore
Job
npm
Atlas Admin API v2
mongodb-atlas-api-client
Loading...