@alicloud/ecs20140526 7.9.1 → 7.9.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +226 -220
- package/dist/client.js +229 -220
- package/dist/client.js.map +1 -1
- package/dist/models/AttachDiskRequest.d.ts +25 -27
- package/dist/models/AttachDiskRequest.js.map +1 -1
- package/dist/models/CancelAutoSnapshotPolicyRequest.d.ts +6 -9
- package/dist/models/CancelAutoSnapshotPolicyRequest.js.map +1 -1
- package/dist/models/CancelImagePipelineExecutionRequest.d.ts +1 -1
- package/dist/models/CloneDisksRequest.d.ts +10 -10
- package/dist/models/CopySnapshotRequest.d.ts +17 -18
- package/dist/models/CopySnapshotRequest.js.map +1 -1
- package/dist/models/CreateAutoSnapshotPolicyRequest.d.ts +29 -35
- package/dist/models/CreateAutoSnapshotPolicyRequest.js.map +1 -1
- package/dist/models/CreateAutoSnapshotPolicyResponseBody.d.ts +1 -1
- package/dist/models/CreateDiskRequest.d.ts +30 -30
- package/dist/models/CreateDiskResponseBody.d.ts +2 -2
- package/dist/models/CreateSnapshotGroupRequest.d.ts +23 -25
- package/dist/models/CreateSnapshotGroupRequest.js.map +1 -1
- package/dist/models/CreateSnapshotRequest.d.ts +24 -29
- package/dist/models/CreateSnapshotRequest.js.map +1 -1
- package/dist/models/DeleteSnapshotGroupRequest.d.ts +2 -2
- package/dist/models/DeleteSnapshotGroupResponseBody.d.ts +1 -1
- package/dist/models/DeleteSnapshotRequest.d.ts +2 -2
- package/dist/models/DescribeDiskDefaultKmskeyIdRequest.d.ts +1 -1
- package/dist/models/DescribeDiskDefaultKmskeyIdResponseBody.d.ts +1 -1
- package/dist/models/DescribeDiskEncryptionByDefaultStatusRequest.d.ts +1 -1
- package/dist/models/DescribeDiskEncryptionByDefaultStatusResponseBody.d.ts +5 -3
- package/dist/models/DescribeDiskEncryptionByDefaultStatusResponseBody.js.map +1 -1
- package/dist/models/DescribeImagesRequest.d.ts +21 -20
- package/dist/models/DescribeImagesRequest.js +2 -0
- package/dist/models/DescribeImagesRequest.js.map +1 -1
- package/dist/models/DescribeImagesResponseBody.d.ts +1 -0
- package/dist/models/DescribeImagesResponseBody.js +2 -0
- package/dist/models/DescribeImagesResponseBody.js.map +1 -1
- package/dist/models/DescribeSendFileResultsRequest.d.ts +13 -13
- package/dist/models/DescribeSnapshotGroupsRequest.d.ts +11 -11
- package/dist/models/DescribeSnapshotGroupsResponseBody.d.ts +3 -3
- package/dist/models/DisableDiskEncryptionByDefaultRequest.d.ts +1 -1
- package/package.json +1 -1
- package/src/client.ts +230 -220
- package/src/models/AttachDiskRequest.ts +25 -27
- package/src/models/CancelAutoSnapshotPolicyRequest.ts +6 -9
- package/src/models/CancelImagePipelineExecutionRequest.ts +1 -1
- package/src/models/CloneDisksRequest.ts +10 -10
- package/src/models/CopySnapshotRequest.ts +17 -18
- package/src/models/CreateAutoSnapshotPolicyRequest.ts +29 -35
- package/src/models/CreateAutoSnapshotPolicyResponseBody.ts +1 -1
- package/src/models/CreateDiskRequest.ts +30 -30
- package/src/models/CreateDiskResponseBody.ts +2 -2
- package/src/models/CreateSnapshotGroupRequest.ts +23 -25
- package/src/models/CreateSnapshotRequest.ts +24 -29
- package/src/models/DeleteSnapshotGroupRequest.ts +2 -2
- package/src/models/DeleteSnapshotGroupResponseBody.ts +1 -1
- package/src/models/DeleteSnapshotRequest.ts +2 -2
- package/src/models/DescribeDiskDefaultKmskeyIdRequest.ts +1 -1
- package/src/models/DescribeDiskDefaultKmskeyIdResponseBody.ts +1 -1
- package/src/models/DescribeDiskEncryptionByDefaultStatusRequest.ts +1 -1
- package/src/models/DescribeDiskEncryptionByDefaultStatusResponseBody.ts +5 -3
- package/src/models/DescribeImagesRequest.ts +23 -20
- package/src/models/DescribeImagesResponseBody.ts +3 -0
- package/src/models/DescribeSendFileResultsRequest.ts +13 -13
- package/src/models/DescribeSnapshotGroupsRequest.ts +11 -11
- package/src/models/DescribeSnapshotGroupsResponseBody.ts +3 -3
- package/src/models/DisableDiskEncryptionByDefaultRequest.ts +1 -1
|
@@ -5,15 +5,15 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class AttachDiskRequest extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* Specifies whether to attach the disk as
|
|
8
|
+
* Specifies whether to attach the disk as a system disk. Valid values:
|
|
9
9
|
*
|
|
10
|
-
* - true:
|
|
10
|
+
* - true: The disk is attached as a system disk.
|
|
11
11
|
*
|
|
12
|
-
* - false:
|
|
12
|
+
* - false: The disk is not attached as a system disk.
|
|
13
13
|
*
|
|
14
14
|
* Default value: false.
|
|
15
15
|
*
|
|
16
|
-
* >
|
|
16
|
+
* > If you set `Bootable=true`, the destination ECS instance must have no system disk attached.
|
|
17
17
|
*
|
|
18
18
|
* @example
|
|
19
19
|
* false
|
|
@@ -23,19 +23,18 @@ export class AttachDiskRequest extends $dara.Model {
|
|
|
23
23
|
* @remarks
|
|
24
24
|
* Specifies whether to release the disk when the instance is released. Valid values:
|
|
25
25
|
*
|
|
26
|
-
* - true:
|
|
27
|
-
*
|
|
28
|
-
* - false: does not release the disk when the instance is released. The disk is retained as a pay-as-you-go data disk.
|
|
26
|
+
* - true: The disk is released together with the instance.
|
|
27
|
+
* - false: The disk is not released together with the instance. The disk is retained as a pay-as-you-go data disk.
|
|
29
28
|
*
|
|
30
29
|
* Default value: false.
|
|
31
30
|
*
|
|
32
|
-
* When you
|
|
31
|
+
* When you set this parameter, take note of the following items:
|
|
33
32
|
*
|
|
34
|
-
* - If
|
|
33
|
+
* - If you set `DeleteWithInstance` to `false` and the ECS instance is locked for security reasons, meaning that `OperationLocks` contains `"LockReason" : "security"`, this parameter is ignored when the instance is released, and the disk is released together with the instance.
|
|
35
34
|
*
|
|
36
|
-
* - If
|
|
35
|
+
* - If the disk to be attached is an `elastic ephemeral disk`, you must set `DeleteWithInstance` to `true`.
|
|
37
36
|
*
|
|
38
|
-
* -
|
|
37
|
+
* - Disks with the multi-attach feature enabled do not support this parameter.
|
|
39
38
|
*
|
|
40
39
|
* @example
|
|
41
40
|
* false
|
|
@@ -45,7 +44,7 @@ export class AttachDiskRequest extends $dara.Model {
|
|
|
45
44
|
* @remarks
|
|
46
45
|
* The device name of the disk.
|
|
47
46
|
*
|
|
48
|
-
* > This parameter will be
|
|
47
|
+
* > This parameter will be deprecated soon. To improve compatibility, use other parameters to identify the disk.
|
|
49
48
|
*
|
|
50
49
|
* @example
|
|
51
50
|
* testDeviceName
|
|
@@ -53,9 +52,9 @@ export class AttachDiskRequest extends $dara.Model {
|
|
|
53
52
|
device?: string;
|
|
54
53
|
/**
|
|
55
54
|
* @remarks
|
|
56
|
-
* The ID of the disk. The disk
|
|
55
|
+
* The ID of the disk to be attached. The disk (`DiskId`) and the instance (`InstanceId`) must be in the same zone.
|
|
57
56
|
*
|
|
58
|
-
* >
|
|
57
|
+
* > Both data disks and system disks can be attached. For related constraints, see the operation description section above.
|
|
59
58
|
*
|
|
60
59
|
* This parameter is required.
|
|
61
60
|
*
|
|
@@ -65,15 +64,15 @@ export class AttachDiskRequest extends $dara.Model {
|
|
|
65
64
|
diskId?: string;
|
|
66
65
|
/**
|
|
67
66
|
* @remarks
|
|
68
|
-
* Specifies whether to
|
|
69
|
-
*
|
|
70
|
-
* - true: force attaches the disk to the instance.
|
|
67
|
+
* Specifies whether to forcefully attach the disk. Valid values:
|
|
71
68
|
*
|
|
72
|
-
* -
|
|
69
|
+
* - true: Forcefully attaches the disk.
|
|
70
|
+
* - false: Does not forcefully attach the disk.
|
|
73
71
|
*
|
|
74
72
|
* Default value: false.
|
|
75
73
|
*
|
|
76
|
-
*
|
|
74
|
+
*
|
|
75
|
+
* > Currently, only regional ESSDs (cloud_regional_disk_auto) support setting this parameter to true.
|
|
77
76
|
*
|
|
78
77
|
* @example
|
|
79
78
|
* false
|
|
@@ -81,7 +80,7 @@ export class AttachDiskRequest extends $dara.Model {
|
|
|
81
80
|
force?: boolean;
|
|
82
81
|
/**
|
|
83
82
|
* @remarks
|
|
84
|
-
* The ID of the instance to which you want to attach the disk.
|
|
83
|
+
* The ID of the ECS instance to which you want to attach the disk.
|
|
85
84
|
*
|
|
86
85
|
* This parameter is required.
|
|
87
86
|
*
|
|
@@ -91,11 +90,11 @@ export class AttachDiskRequest extends $dara.Model {
|
|
|
91
90
|
instanceId?: string;
|
|
92
91
|
/**
|
|
93
92
|
* @remarks
|
|
94
|
-
* The name of the SSH key pair that
|
|
93
|
+
* The name of the SSH key pair that is bound to the Linux ECS instance when you attach a system disk.
|
|
95
94
|
*
|
|
96
|
-
* - Windows instances
|
|
95
|
+
* - Windows Server instances: SSH key pairs are not supported. Even if this parameter is specified, only the `Password` configuration takes effect.
|
|
97
96
|
*
|
|
98
|
-
* -
|
|
97
|
+
* - Linux instances: The password-based logon method is disabled by default.
|
|
99
98
|
*
|
|
100
99
|
* @example
|
|
101
100
|
* KeyPairTestName
|
|
@@ -105,15 +104,14 @@ export class AttachDiskRequest extends $dara.Model {
|
|
|
105
104
|
ownerId?: number;
|
|
106
105
|
/**
|
|
107
106
|
* @remarks
|
|
108
|
-
* The password that is set when you attach
|
|
107
|
+
* The password that is set for the instance when you attach a system disk. The password is effective only for the administrator and root usernames and is not effective for other usernames. The password must be 8 to 30 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported:
|
|
109
108
|
*
|
|
110
109
|
* ```
|
|
111
110
|
* ()`~!@#$%^&*-_+=|{}[]:;\\"<>,.?/
|
|
112
111
|
* ```
|
|
112
|
+
* For Windows instances, the password cannot start with a forward slash (/).
|
|
113
113
|
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
* > If `Password` is configured, we recommend that you send requests over HTTPS to prevent password leaks.
|
|
114
|
+
* > If you specify the `Password` parameter, send the request over HTTPS to prevent password leaks.
|
|
117
115
|
*
|
|
118
116
|
* @example
|
|
119
117
|
* EcsV587!
|
|
@@ -8,13 +8,10 @@ export class CancelAutoSnapshotPolicyRequest extends $dara.Model {
|
|
|
8
8
|
resourceOwnerId?: number;
|
|
9
9
|
/**
|
|
10
10
|
* @remarks
|
|
11
|
-
* The ID of the
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* - If only one auto snapshot policy is applied to a disk, that policy is canceled.
|
|
16
|
-
*
|
|
17
|
-
* - If a disk has more than one auto snapshot policy, the request fails and returns the `OperationDenied.TooManyAutoSnapshotPolicies` error code. In this case, you must specify `autoSnapshotPolicyId` to identify the policy to cancel.
|
|
11
|
+
* The ID of the automatic snapshot policy that you want to cancel.
|
|
12
|
+
* - Default value: empty. If you use the default value, note the following items:
|
|
13
|
+
* - If only one automatic snapshot policy is applied to the cloud disk, the automatic snapshot policy is canceled.
|
|
14
|
+
* - If more than one automatic snapshot policy is applied to the cloud disk, the `OperationDenied.TooManyAutoSnapshotPolicies` error code is returned and the request fails. Specify the `autoSnapshotPolicyId` parameter to specify the ID of the automatic snapshot policy that you want to cancel.
|
|
18
15
|
*
|
|
19
16
|
* @example
|
|
20
17
|
* sp-bp14yziiuvu3s6jn****
|
|
@@ -22,7 +19,7 @@ export class CancelAutoSnapshotPolicyRequest extends $dara.Model {
|
|
|
22
19
|
autoSnapshotPolicyId?: string;
|
|
23
20
|
/**
|
|
24
21
|
* @remarks
|
|
25
|
-
* The IDs of the
|
|
22
|
+
* The IDs of the cloud disks. To cancel the automatic snapshot policy for multiple cloud disks, specify the cloud disk IDs in a JSON array in the format of "d-xxxxxxxxx", "d-yyyyyyyyy", … "d-zzzzzzzzz". Separate multiple cloud disk IDs with commas (,).
|
|
26
23
|
*
|
|
27
24
|
* This parameter is required.
|
|
28
25
|
*
|
|
@@ -32,7 +29,7 @@ export class CancelAutoSnapshotPolicyRequest extends $dara.Model {
|
|
|
32
29
|
diskIds?: string;
|
|
33
30
|
/**
|
|
34
31
|
* @remarks
|
|
35
|
-
* The region ID of the
|
|
32
|
+
* The region ID of the automatic snapshot policy and cloud disks. You can call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to query the most recent region list.
|
|
36
33
|
*
|
|
37
34
|
* This parameter is required.
|
|
38
35
|
*
|
|
@@ -45,7 +45,7 @@ export class CancelImagePipelineExecutionRequestTemplateTag extends $dara.Model
|
|
|
45
45
|
export class CancelImagePipelineExecutionRequest extends $dara.Model {
|
|
46
46
|
/**
|
|
47
47
|
* @remarks
|
|
48
|
-
* The ID of the
|
|
48
|
+
* The ID of the image building task.
|
|
49
49
|
*
|
|
50
50
|
* This parameter is required.
|
|
51
51
|
*
|
|
@@ -121,14 +121,14 @@ export class CloneDisksRequest extends $dara.Model {
|
|
|
121
121
|
* @remarks
|
|
122
122
|
* The category of the new disk. Valid values:
|
|
123
123
|
*
|
|
124
|
-
* - cloud_essd:
|
|
124
|
+
* - cloud_essd: enterprise SSD.
|
|
125
125
|
* - cloud_auto: ESSD AutoPL disk.
|
|
126
126
|
* - cloud_essd_entry: ESSD Entry disk.
|
|
127
|
-
* - cloud_regional_disk_auto: regional
|
|
127
|
+
* - cloud_regional_disk_auto: regional ESSD.
|
|
128
128
|
*
|
|
129
129
|
* > Disk category restrictions for disk cloning:
|
|
130
|
-
* > - Non-regional disks can
|
|
131
|
-
* > - Regional disks can
|
|
130
|
+
* > - Non-regional disks can be cloned only to non-regional types.
|
|
131
|
+
* > - Regional disks can be cloned only to regional types.
|
|
132
132
|
*
|
|
133
133
|
* This parameter is required.
|
|
134
134
|
*
|
|
@@ -149,8 +149,8 @@ export class CloneDisksRequest extends $dara.Model {
|
|
|
149
149
|
/**
|
|
150
150
|
* @remarks
|
|
151
151
|
* Specifies whether to perform only a dry run, without performing the actual request. Valid values:
|
|
152
|
-
* - true: sends a check request without querying the filing status. The
|
|
153
|
-
* - false (default): sends a
|
|
152
|
+
* - true: sends a check request without querying the filing status. The check items include whether the AccessKey pair is valid, whether the Resource Access Management (RAM) user is granted the required authorization, and whether the required parameters are specified. If the check fails, the corresponding error message is returned. If the check succeeds, the DryRunOperation error code is returned.
|
|
153
|
+
* - false (default): sends a Normal request. After the check succeeds, a 2XX HTTP status code is returned and the filing status is directly queried.
|
|
154
154
|
*
|
|
155
155
|
* @example
|
|
156
156
|
* true
|
|
@@ -178,10 +178,10 @@ export class CloneDisksRequest extends $dara.Model {
|
|
|
178
178
|
kmsKeyId?: string;
|
|
179
179
|
/**
|
|
180
180
|
* @remarks
|
|
181
|
-
* Specifies whether to enable the multi-attach attribute for the new disk.
|
|
181
|
+
* Specifies whether to enable the multi-attach attribute for the new disk. Valid values:
|
|
182
182
|
*
|
|
183
183
|
* - Disabled: disables the multi-attach attribute.
|
|
184
|
-
* - Enabled: enables the multi-attach attribute.
|
|
184
|
+
* - Enabled: enables the multi-attach attribute. Currently, only enterprise SSDs support Settings to `Enabled`.
|
|
185
185
|
*
|
|
186
186
|
* This parameter is required.
|
|
187
187
|
*
|
|
@@ -192,7 +192,7 @@ export class CloneDisksRequest extends $dara.Model {
|
|
|
192
192
|
ownerId?: number;
|
|
193
193
|
/**
|
|
194
194
|
* @remarks
|
|
195
|
-
* The performance level
|
|
195
|
+
* The performance level of the standard SSD. Settings for this parameter depend on the disk category. Valid values:
|
|
196
196
|
*
|
|
197
197
|
* - PL0: a single disk can deliver up to 10,000 random read/write IOPS.
|
|
198
198
|
* - PL1: a single disk can deliver up to 50,000 random read/write IOPS.
|
|
@@ -244,7 +244,7 @@ export class CloneDisksRequest extends $dara.Model {
|
|
|
244
244
|
* @remarks
|
|
245
245
|
* The capacity of the new disk. Unit: GiB. You must specify a value for this parameter. Valid values:
|
|
246
246
|
*
|
|
247
|
-
* - cloud_essd:
|
|
247
|
+
* - cloud_essd: The valid values depend on the performance level.
|
|
248
248
|
* - PL0: 1 to 65,536.
|
|
249
249
|
* - PL1: 20 to 65,536.
|
|
250
250
|
* - PL2: 461 to 65,536.
|
|
@@ -55,7 +55,7 @@ export class CopySnapshotRequestArn extends $dara.Model {
|
|
|
55
55
|
export class CopySnapshotRequestTag extends $dara.Model {
|
|
56
56
|
/**
|
|
57
57
|
* @remarks
|
|
58
|
-
* The key of
|
|
58
|
+
* The tag key of the new snapshot. Once specified, the tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://.
|
|
59
59
|
*
|
|
60
60
|
* @example
|
|
61
61
|
* TestKey
|
|
@@ -63,7 +63,7 @@ export class CopySnapshotRequestTag extends $dara.Model {
|
|
|
63
63
|
key?: string;
|
|
64
64
|
/**
|
|
65
65
|
* @remarks
|
|
66
|
-
* The value of
|
|
66
|
+
* The tag value of the new snapshot. Once specified, the tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://.
|
|
67
67
|
*
|
|
68
68
|
* @example
|
|
69
69
|
* TestValue
|
|
@@ -95,12 +95,12 @@ export class CopySnapshotRequestTag extends $dara.Model {
|
|
|
95
95
|
export class CopySnapshotRequest extends $dara.Model {
|
|
96
96
|
/**
|
|
97
97
|
* @remarks
|
|
98
|
-
* > This parameter is
|
|
98
|
+
* > This parameter is in invitational preview and is not publicly available.
|
|
99
99
|
*/
|
|
100
100
|
arn?: CopySnapshotRequestArn[];
|
|
101
101
|
/**
|
|
102
102
|
* @remarks
|
|
103
|
-
*
|
|
103
|
+
* Ensures the idempotence of the request. The value is generated from your client and must be unique among different requests. The value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/25693.html).
|
|
104
104
|
*
|
|
105
105
|
* @example
|
|
106
106
|
* 123e4567-e89b-12d3-a456-426655440000
|
|
@@ -108,7 +108,7 @@ export class CopySnapshotRequest extends $dara.Model {
|
|
|
108
108
|
clientToken?: string;
|
|
109
109
|
/**
|
|
110
110
|
* @remarks
|
|
111
|
-
* The ID of the destination region to which to copy the
|
|
111
|
+
* The ID of the destination region to which to copy the snapshot.
|
|
112
112
|
*
|
|
113
113
|
* This parameter is required.
|
|
114
114
|
*
|
|
@@ -118,9 +118,9 @@ export class CopySnapshotRequest extends $dara.Model {
|
|
|
118
118
|
destinationRegionId?: string;
|
|
119
119
|
/**
|
|
120
120
|
* @remarks
|
|
121
|
-
* The description of the new snapshot. The description must be 2 to 256 characters in length and cannot start with http
|
|
121
|
+
* The description of the new snapshot. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
|
|
122
122
|
*
|
|
123
|
-
*
|
|
123
|
+
* Default value: null.
|
|
124
124
|
*
|
|
125
125
|
* This parameter is required.
|
|
126
126
|
*
|
|
@@ -130,9 +130,9 @@ export class CopySnapshotRequest extends $dara.Model {
|
|
|
130
130
|
destinationSnapshotDescription?: string;
|
|
131
131
|
/**
|
|
132
132
|
* @remarks
|
|
133
|
-
* The name of the new snapshot. The name must be 2 to 128 characters in length
|
|
133
|
+
* The name of the new snapshot. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. It cannot start with http:// or https://. The name can contain letters, digits, and Unicode characters that are categorized under the letter classification. It can also contain colons (:), underscores (_), periods (.), or hyphens (-).
|
|
134
134
|
*
|
|
135
|
-
*
|
|
135
|
+
* Default value: null.
|
|
136
136
|
*
|
|
137
137
|
* This parameter is required.
|
|
138
138
|
*
|
|
@@ -150,11 +150,10 @@ export class CopySnapshotRequest extends $dara.Model {
|
|
|
150
150
|
destinationStorageLocationArn?: string;
|
|
151
151
|
/**
|
|
152
152
|
* @remarks
|
|
153
|
-
* Specifies whether to encrypt the
|
|
153
|
+
* Specifies whether to encrypt the cloud disk. Valid values:
|
|
154
154
|
*
|
|
155
|
-
* - true
|
|
156
|
-
*
|
|
157
|
-
* - false
|
|
155
|
+
* - true: encrypts the cloud disk.
|
|
156
|
+
* - false: does not encrypt the cloud disk.
|
|
158
157
|
*
|
|
159
158
|
* Default value: false.
|
|
160
159
|
*
|
|
@@ -164,7 +163,7 @@ export class CopySnapshotRequest extends $dara.Model {
|
|
|
164
163
|
encrypted?: boolean;
|
|
165
164
|
/**
|
|
166
165
|
* @remarks
|
|
167
|
-
* The
|
|
166
|
+
* The customer master key (CMK) in the destination region.
|
|
168
167
|
*
|
|
169
168
|
* @example
|
|
170
169
|
* 0e478b7a-4262-4802-b8cb-00d3fb40****
|
|
@@ -173,7 +172,7 @@ export class CopySnapshotRequest extends $dara.Model {
|
|
|
173
172
|
ownerId?: number;
|
|
174
173
|
/**
|
|
175
174
|
* @remarks
|
|
176
|
-
* The region ID of the source snapshot. You can call
|
|
175
|
+
* The region ID of the source snapshot. You can call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to query the most recent region list.
|
|
177
176
|
*
|
|
178
177
|
* This parameter is required.
|
|
179
178
|
*
|
|
@@ -193,9 +192,9 @@ export class CopySnapshotRequest extends $dara.Model {
|
|
|
193
192
|
resourceOwnerId?: number;
|
|
194
193
|
/**
|
|
195
194
|
* @remarks
|
|
196
|
-
* The retention period of the new snapshot
|
|
195
|
+
* The retention period of the new snapshot, in days. The snapshot undergoes automatic release when the retention period expires. Valid values: 1 to 65536.
|
|
197
196
|
*
|
|
198
|
-
*
|
|
197
|
+
* Default value: null, which indicates that the snapshot does not undergo automatic release.
|
|
199
198
|
*
|
|
200
199
|
* @example
|
|
201
200
|
* 60
|
|
@@ -213,7 +212,7 @@ export class CopySnapshotRequest extends $dara.Model {
|
|
|
213
212
|
snapshotId?: string;
|
|
214
213
|
/**
|
|
215
214
|
* @remarks
|
|
216
|
-
* The tag
|
|
215
|
+
* The tag information of the new snapshot.
|
|
217
216
|
*/
|
|
218
217
|
tag?: CopySnapshotRequestTag[];
|
|
219
218
|
static names(): { [key: string]: string } {
|
|
@@ -60,11 +60,10 @@ export class CreateAutoSnapshotPolicyRequestCopyEncryptionConfiguration extends
|
|
|
60
60
|
arn?: CreateAutoSnapshotPolicyRequestCopyEncryptionConfigurationArn[];
|
|
61
61
|
/**
|
|
62
62
|
* @remarks
|
|
63
|
-
* Specifies whether to enable cross-region snapshot
|
|
63
|
+
* Specifies whether to enable encryption for cross-region snapshot backup. Valid values:
|
|
64
64
|
*
|
|
65
|
-
* - true
|
|
66
|
-
*
|
|
67
|
-
* - false
|
|
65
|
+
* - true: enables encryption.
|
|
66
|
+
* - false: disables encryption.
|
|
68
67
|
*
|
|
69
68
|
* Default value: false.
|
|
70
69
|
*
|
|
@@ -74,7 +73,7 @@ export class CreateAutoSnapshotPolicyRequestCopyEncryptionConfiguration extends
|
|
|
74
73
|
encrypted?: boolean;
|
|
75
74
|
/**
|
|
76
75
|
* @remarks
|
|
77
|
-
* The
|
|
76
|
+
* The KMS key ID used for encrypted cross-region snapshot backup.
|
|
78
77
|
*
|
|
79
78
|
* @example
|
|
80
79
|
* 0e478b7a-4262-4802-b8cb-00d3fb40826X
|
|
@@ -111,7 +110,7 @@ export class CreateAutoSnapshotPolicyRequestCopyEncryptionConfiguration extends
|
|
|
111
110
|
export class CreateAutoSnapshotPolicyRequestTag extends $dara.Model {
|
|
112
111
|
/**
|
|
113
112
|
* @remarks
|
|
114
|
-
* The key of
|
|
113
|
+
* The tag key of the automatic snapshot policy. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with aliyun or acs:. The tag key cannot contain http:// or https://.
|
|
115
114
|
*
|
|
116
115
|
* @example
|
|
117
116
|
* TestKey
|
|
@@ -119,7 +118,7 @@ export class CreateAutoSnapshotPolicyRequestTag extends $dara.Model {
|
|
|
119
118
|
key?: string;
|
|
120
119
|
/**
|
|
121
120
|
* @remarks
|
|
122
|
-
* The value of
|
|
121
|
+
* The tag value of the automatic snapshot policy. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with acs:. The tag value cannot contain http:// or https://.
|
|
123
122
|
*
|
|
124
123
|
* @example
|
|
125
124
|
* TestValue
|
|
@@ -151,11 +150,10 @@ export class CreateAutoSnapshotPolicyRequestTag extends $dara.Model {
|
|
|
151
150
|
export class CreateAutoSnapshotPolicyRequest extends $dara.Model {
|
|
152
151
|
/**
|
|
153
152
|
* @remarks
|
|
154
|
-
* The retention period of
|
|
155
|
-
*
|
|
156
|
-
* - -1: The snapshot copy is retained until it is deleted.
|
|
153
|
+
* The retention period of cross-region snapshot replicas. Unit: days. Valid values:
|
|
157
154
|
*
|
|
158
|
-
* - 1
|
|
155
|
+
* - -1: Snapshot replicas are permanently retained.
|
|
156
|
+
* - 1 to 65535: Snapshot replicas are retained for the specified number of days.
|
|
159
157
|
*
|
|
160
158
|
* Default value: -1.
|
|
161
159
|
*
|
|
@@ -165,16 +163,15 @@ export class CreateAutoSnapshotPolicyRequest extends $dara.Model {
|
|
|
165
163
|
copiedSnapshotsRetentionDays?: number;
|
|
166
164
|
/**
|
|
167
165
|
* @remarks
|
|
168
|
-
* The encryption
|
|
166
|
+
* The backup encryption parameter object for snapshot geo-redundancy.
|
|
169
167
|
*/
|
|
170
168
|
copyEncryptionConfiguration?: CreateAutoSnapshotPolicyRequestCopyEncryptionConfiguration;
|
|
171
169
|
/**
|
|
172
170
|
* @remarks
|
|
173
|
-
* Specifies whether to enable cross-region replication
|
|
174
|
-
*
|
|
175
|
-
* - true
|
|
171
|
+
* Specifies whether to enable automatic cross-region replication.
|
|
176
172
|
*
|
|
177
|
-
* -
|
|
173
|
+
* - true: enables automatic cross-region replication.
|
|
174
|
+
* - false: disables automatic cross-region replication.
|
|
178
175
|
*
|
|
179
176
|
* @example
|
|
180
177
|
* false
|
|
@@ -183,7 +180,7 @@ export class CreateAutoSnapshotPolicyRequest extends $dara.Model {
|
|
|
183
180
|
ownerId?: number;
|
|
184
181
|
/**
|
|
185
182
|
* @remarks
|
|
186
|
-
* The resource group
|
|
183
|
+
* The ID of the resource group.
|
|
187
184
|
*
|
|
188
185
|
* @example
|
|
189
186
|
* rg-aek2kkmhmhs****
|
|
@@ -201,12 +198,12 @@ export class CreateAutoSnapshotPolicyRequest extends $dara.Model {
|
|
|
201
198
|
storageLocationArn?: string;
|
|
202
199
|
/**
|
|
203
200
|
* @remarks
|
|
204
|
-
* The tags
|
|
201
|
+
* The tags of the automatic snapshot policy.
|
|
205
202
|
*/
|
|
206
203
|
tag?: CreateAutoSnapshotPolicyRequestTag[];
|
|
207
204
|
/**
|
|
208
205
|
* @remarks
|
|
209
|
-
* The destination region to which
|
|
206
|
+
* The destination region to which snapshots are replicated. You can specify only one destination region.
|
|
210
207
|
*
|
|
211
208
|
* @example
|
|
212
209
|
* ["cn-hangzhou"]
|
|
@@ -214,9 +211,9 @@ export class CreateAutoSnapshotPolicyRequest extends $dara.Model {
|
|
|
214
211
|
targetCopyRegions?: string;
|
|
215
212
|
/**
|
|
216
213
|
* @remarks
|
|
217
|
-
* The name of the automatic snapshot policy. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http
|
|
214
|
+
* The name of the automatic snapshot policy. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:// or https://. The name can contain digits, colons (:), underscores (_), and hyphens (-).
|
|
218
215
|
*
|
|
219
|
-
*
|
|
216
|
+
* Default value: null.
|
|
220
217
|
*
|
|
221
218
|
* @example
|
|
222
219
|
* TestName
|
|
@@ -224,7 +221,7 @@ export class CreateAutoSnapshotPolicyRequest extends $dara.Model {
|
|
|
224
221
|
autoSnapshotPolicyName?: string;
|
|
225
222
|
/**
|
|
226
223
|
* @remarks
|
|
227
|
-
* The
|
|
224
|
+
* The region to which the automatic snapshot policy belongs. You can call [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) to query the most recent region list.
|
|
228
225
|
*
|
|
229
226
|
* This parameter is required.
|
|
230
227
|
*
|
|
@@ -234,11 +231,10 @@ export class CreateAutoSnapshotPolicyRequest extends $dara.Model {
|
|
|
234
231
|
regionId?: string;
|
|
235
232
|
/**
|
|
236
233
|
* @remarks
|
|
237
|
-
* The days of the week on which
|
|
234
|
+
* The days of the week on which automatic snapshots are created. Unit: days. The cycle is weekly. Valid values: 1 to 7. For example, 1 indicates Monday. Format description:
|
|
238
235
|
*
|
|
239
|
-
* -
|
|
240
|
-
*
|
|
241
|
-
* - To schedule multiple automatic snapshots to be created in a week, you can specify multiple values. Separate the values with commas (,). You can specify a maximum of seven days. For example, a value of ["1","3","5"] specifies automatic snapshots to be created every Monday, Wednesday, and Friday.
|
|
236
|
+
* - The parameter value must be a JSON array. For example, ["1"\\] indicates that automatic snapshots are created every Monday.
|
|
237
|
+
* - To create multiple automatic snapshots within a week, specify multiple days separated by commas (,). You can specify a maximum of 7 days. For example, ["1","3","5"\\] indicates that automatic snapshots are created every Monday, Wednesday, and Friday.
|
|
242
238
|
*
|
|
243
239
|
* This parameter is required.
|
|
244
240
|
*
|
|
@@ -248,11 +244,10 @@ export class CreateAutoSnapshotPolicyRequest extends $dara.Model {
|
|
|
248
244
|
repeatWeekdays?: string;
|
|
249
245
|
/**
|
|
250
246
|
* @remarks
|
|
251
|
-
* The retention period of
|
|
252
|
-
*
|
|
253
|
-
* - -1: The automatic snapshot is retained until it is deleted.
|
|
247
|
+
* The retention period of automatic snapshots. Unit: days. Valid values:
|
|
254
248
|
*
|
|
255
|
-
* - 1
|
|
249
|
+
* - -1: Automatic snapshots are permanently retained.
|
|
250
|
+
* - 1 to 65535: Automatic snapshots are retained for the specified number of days.
|
|
256
251
|
*
|
|
257
252
|
* Default value: -1.
|
|
258
253
|
*
|
|
@@ -264,13 +259,12 @@ export class CreateAutoSnapshotPolicyRequest extends $dara.Model {
|
|
|
264
259
|
retentionDays?: number;
|
|
265
260
|
/**
|
|
266
261
|
* @remarks
|
|
267
|
-
* The points in time
|
|
268
|
-
*
|
|
269
|
-
* - Set this parameter to a JSON-formatted array. For example, a value of ["1"] specifies automatic snapshots to be created at 01:00:00.
|
|
262
|
+
* The points in time at which automatic snapshots are created. The time is displayed in UTC+8. Unit: hours. Valid values: 0 to 23, which represent the 24 points in time from 00:00 to 23:00. For example, 1 indicates 01:00. Format description:
|
|
270
263
|
*
|
|
271
|
-
* -
|
|
264
|
+
* - The parameter value must be a JSON array. For example, ["1"\\] indicates that automatic snapshots are created at 01:00.
|
|
265
|
+
* - To create multiple automatic snapshots within a day, specify multiple points in time separated by commas (,). You can specify a maximum of 24 points in time. For example, ["1","3","5"\\] indicates that automatic snapshots are created at 01:00, 03:00, and 05:00.
|
|
272
266
|
*
|
|
273
|
-
* > If
|
|
267
|
+
* > If a disk contains a large amount of data and the time required to create an automatic snapshot exceeds the interval between two consecutive points in time, the next point in time is skipped. For example, you set 09:00, 10:00, 11:00, and 12:00 as the points in time for automatic snapshot creation. The snapshot creation starts at 09:00 and is completed at 10:20, which takes 80 minutes. The system skips the 10:00 point in time and creates the next automatic snapshot at 11:00.
|
|
274
268
|
*
|
|
275
269
|
* This parameter is required.
|
|
276
270
|
*
|
|
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
|
|
|
5
5
|
export class CreateAutoSnapshotPolicyResponseBody extends $dara.Model {
|
|
6
6
|
/**
|
|
7
7
|
* @remarks
|
|
8
|
-
* The automatic snapshot policy
|
|
8
|
+
* The ID of the automatic snapshot policy.
|
|
9
9
|
*
|
|
10
10
|
* @example
|
|
11
11
|
* sp-bp12m37ccmxvbmi5****
|