DownloadProps
Properties for defining a Download
.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-dbs-download
Initializer
using AlibabaCloud.SDK.ROS.CDK.Dbs;
new DownloadProps {
object FormatType,
object InstanceName,
object BakSetId = null,
object BakSetSize = null,
object BakSetType = null,
object DeleteBackupSetInOss = null,
object DownloadAddressDuration = null,
object DownloadPointInTime = null,
object TargetBucket = null,
object TargetOssRegion = null,
object TargetPath = null,
object TargetType = null
};
Properties
Name | Type | Description |
---|---|---|
FormatType |
object |
Property formatType: The format to which the downloaded backup set is converted. |
InstanceName |
object |
Property instanceName: The ID of the instance. |
BakSetId |
object |
Property bakSetId: The ID of the backup set. |
BakSetSize |
object |
Property bakSetSize: The size of the full backup set. |
BakSetType |
object |
Property bakSetType: The type of the download task. |
DeleteBackupSetInOss |
object |
Property deleteBackupSetInOss: Whether to delete the backup set in OSS when deleting the stack. |
DownloadAddressDuration |
object |
Property downloadAddressDuration: When the download target is a URL, set the link validity period. |
DownloadPointInTime |
object |
Property downloadPointInTime: The point in time at which the backup set is downloaded. |
TargetBucket |
object |
Property targetBucket: The name of the OSS bucket that is used to store the backup set. |
TargetOssRegion |
object |
Property targetOssRegion: The region in which the OSS bucket resides. |
TargetPath |
object |
Property targetPath: The destination path to which the backup set is downloaded. |
TargetType |
object |
Property targetType: The type of the destination to which the backup set is downloaded. |
FormatType
Required
public object FormatType { get; set; }
- Type: object
Property formatType: The format to which the downloaded backup set is converted.
Valid values: CSV|SQL|Parquet
InstanceName
Required
public object InstanceName { get; set; }
- Type: object
Property instanceName: The ID of the instance.
BakSetId
Optional
public object BakSetId { get; set; }
- Type: object
Property bakSetId: The ID of the backup set.
You can call the DescribeBackups operation to query the ID of the backup set. This parameter is required if the BakSetType parameter is set to full.
BakSetSize
Optional
public object BakSetSize { get; set; }
- Type: object
Property bakSetSize: The size of the full backup set.
Unit: bytes. You can call the DescribeBackups operation to query the size of the full backup set.
BakSetType
Optional
public object BakSetType { get; set; }
- Type: object
Property bakSetType: The type of the download task.
Valid values: full: downloads a full backup set pitr: downloads a backup set at a specific point in time.
DeleteBackupSetInOss
Optional
public object DeleteBackupSetInOss { get; set; }
- Type: object
Property deleteBackupSetInOss: Whether to delete the backup set in OSS when deleting the stack.
Valid values: true|false, default is true.
DownloadAddressDuration
Optional
public object DownloadAddressDuration { get; set; }
- Type: object
Property downloadAddressDuration: When the download target is a URL, set the link validity period.
The default URL validity period is 7200 seconds. The effective duration range can be set from 300 seconds to 86400 seconds
DownloadPointInTime
Optional
public object DownloadPointInTime { get; set; }
- Type: object
Property downloadPointInTime: The point in time at which the backup set is downloaded.
Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. This parameter is required if the BakSetType parameter is set to pitr.
TargetBucket
Optional
public object TargetBucket { get; set; }
- Type: object
Property targetBucket: The name of the OSS bucket that is used to store the backup set.
This parameter is required if the TargetType parameter is set to OSS. Make sure that your account is granted the AliyunDBSDefaultRole permission. For more information, see Use RAM for resource authorization. You can also grant permissions based on the operation instructions in the Resource Access Management (RAM) console.
TargetOssRegion
Optional
public object TargetOssRegion { get; set; }
- Type: object
Property targetOssRegion: The region in which the OSS bucket resides.
This parameter is required if the TargetType parameter is set to OSS.
TargetPath
Optional
public object TargetPath { get; set; }
- Type: object
Property targetPath: The destination path to which the backup set is downloaded.
This parameter is required if the TargetType parameter is set to OSS.
TargetType
Optional
public object TargetType { get; set; }
- Type: object
Property targetType: The type of the destination to which the backup set is downloaded.
Valid values: OSS|URL