RestoreTaskProps

Properties for defining a RestoreTask.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-dbs-restoretask

Initializer

using AlibabaCloud.SDK.ROS.CDK.Dbs;
new RestoreTaskProps {
    object BackupPlanId,
    object DestinationEndpointInstanceType,
    object RestoreTaskName,
    object BackupGatewayId = null,
    object BackupSetId = null,
    object DestinationEndpointDatabaseName = null,
    object DestinationEndpointInstanceId = null,
    object DestinationEndpointIp = null,
    object DestinationEndpointOracleSid = null,
    object DestinationEndpointPassword = null,
    object DestinationEndpointPort = null,
    object DestinationEndpointRegion = null,
    object DestinationEndpointUserName = null,
    object DuplicateConflict = null,
    object RestoreDir = null,
    object RestoreHome = null,
    object RestoreObjects = null,
    object RestoreTime = null,
    object StartTask = null
};

Properties

Name	Type	Description
BackupPlanId	object	Property backupPlanId: The ID of the backup plan.
DestinationEndpointInstanceType	object	Property destinationEndpointInstanceType: The location of the database.
RestoreTaskName	object	Property restoreTaskName: The name of the restoration task.
BackupGatewayId	object	Property backupGatewayId: The ID of the backup gateway.
BackupSetId	object	Property backupSetId: The ID of the full backup set used for restoration, which is mutually exclusive to RestoreTime.
DestinationEndpointDatabaseName	object	Property destinationEndpointDatabaseName: The name of the RDS database.
DestinationEndpointInstanceId	object	Property destinationEndpointInstanceId: The ID of the ApsaraDB RDS instance to query.
DestinationEndpointIp	object	Property destinationEndpointIp: The endpoint used to connect to the database.
DestinationEndpointOracleSid	object	Property destinationEndpointOracleSid: The SID of the Oracle instance.
DestinationEndpointPassword	object	Property destinationEndpointPassword: The password that is used to log on to the RDS instance.
DestinationEndpointPort	object	Property destinationEndpointPort: The port that is used to access the database of the primary MySQL server.
DestinationEndpointRegion	object	Property destinationEndpointRegion: The region of the database.
DestinationEndpointUserName	object	Property destinationEndpointUserName: The database account.
DuplicateConflict	object	Property duplicateConflict: The handling method for conflicts between objects with the same name.
RestoreDir	object	Property restoreDir: DestinationEndpointInstanceType this parameter is required when agent is specified and the backup schedule is MySQL.
RestoreHome	object	Property restoreHome: Database Program Directory.
RestoreObjects	object	Property restoreObjects: Restore an object.
RestoreTime	object	Property restoreTime: The time when the fault is restored.
StartTask	object	Property startTask: Start restore task after creating a recovery task.

---

BackupPlanId^Required

public object BackupPlanId { get; set; }

• Type: object

Property backupPlanId: The ID of the backup plan.

---

DestinationEndpointInstanceType^Required

public object DestinationEndpointInstanceType { get; set; }

• Type: object

Property destinationEndpointInstanceType: The location of the database.

Valid values:

• rds
• ecs
• express: a database connected over express connect, VPN Gateway, or smart gateway.
• agent: The database connected through the backup Gateway
• dds: apsaradb for MongoDB
• kvstore
• polardb
• drds
• dg: the database is directly connected through IP Address: Port.

---

RestoreTaskName^Required

public object RestoreTaskName { get; set; }

• Type: object

Property restoreTaskName: The name of the restoration task.

---

BackupGatewayId^Optional

public object BackupGatewayId { get; set; }

• Type: object

Property backupGatewayId: The ID of the backup gateway.

NoteDestinationEndpointInstanceType if you set this parameter to agent, this parameter is required.

---

BackupSetId^Optional

public object BackupSetId { get; set; }

• Type: object

Property backupSetId: The ID of the full backup set used for restoration, which is mutually exclusive to RestoreTime.

---

DestinationEndpointDatabaseName^Optional

public object DestinationEndpointDatabaseName { get; set; }

• Type: object

Property destinationEndpointDatabaseName: The name of the RDS database.

Note When the database type is PostgreSQL or MongoDB, this parameter is required.

---

DestinationEndpointInstanceId^Optional

public object DestinationEndpointInstanceId { get; set; }

• Type: object

Property destinationEndpointInstanceId: The ID of the ApsaraDB RDS instance to query.

NoteDestinationEndpointInstanceType if the value is RDS, ECS, DDS, or Express, this parameter is required.

---

DestinationEndpointIp^Optional

public object DestinationEndpointIp { get; set; }

• Type: object

Property destinationEndpointIp: The endpoint used to connect to the database.

NoteDestinationEndpointInstanceType is express, agent, or other. This parameter is required.

---

DestinationEndpointOracleSid^Optional

public object DestinationEndpointOracleSid { get; set; }

• Type: object

Property destinationEndpointOracleSid: The SID of the Oracle instance.

Note This parameter is required if the database type is Oracle.

---

DestinationEndpointPassword^Optional

public object DestinationEndpointPassword { get; set; }

• Type: object

Property destinationEndpointPassword: The password that is used to log on to the RDS instance.

Note You must specify this parameter when the database type is Redis, or the database location is agent and the database type is MSSQL.

---

DestinationEndpointPort^Optional

public object DestinationEndpointPort { get; set; }

• Type: object

Property destinationEndpointPort: The port that is used to access the database of the primary MySQL server.

NoteDestinationEndpointInstanceType is in the format of express, agent, other, or ECS. This parameter is required.

---

DestinationEndpointRegion^Optional

public object DestinationEndpointRegion { get; set; }

• Type: object

Property destinationEndpointRegion: The region of the database.

NoteDestinationEndpointInstanceType for RDS, ECS, DDS, Express, or Agent, this parameter is required.

---

DestinationEndpointUserName^Optional

public object DestinationEndpointUserName { get; set; }

• Type: object

Property destinationEndpointUserName: The database account.

Note You must specify this parameter when the database type is Redis, or the database location is agent and the database type is MSSQL.

---

DuplicateConflict^Optional

public object DuplicateConflict { get; set; }

• Type: object

Property duplicateConflict: The handling method for conflicts between objects with the same name.

Valid values: failure: The object with the same name fails (default). renamenew: renames an object with the same name.

---

RestoreDir^Optional

public object RestoreDir { get; set; }

• Type: object

Property restoreDir: DestinationEndpointInstanceType this parameter is required when agent is specified and the backup schedule is MySQL.

---

RestoreHome^Optional

public object RestoreHome { get; set; }

• Type: object

Property restoreHome: Database Program Directory.

---

RestoreObjects^Optional

public object RestoreObjects { get; set; }

• Type: object

Property restoreObjects: Restore an object.

Note For details, see the following RestoreObjects if the database is located in an agent, this parameter is required in other scenarios.

---

RestoreTime^Optional

public object RestoreTime { get; set; }

• Type: object

Property restoreTime: The time when the fault is restored.

Set the value to 1554560477000.

---

StartTask^Optional

public object StartTask { get; set; }

• Type: object

Property startTask: Start restore task after creating a recovery task.

---