@alicloud/ecs20140526 4.0.0 → 4.1.0
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 +1424 -574
- package/dist/client.js +7203 -5925
- package/dist/client.js.map +1 -1
- package/package.json +5 -5
- package/src/client.ts +2262 -811
package/dist/client.d.ts
CHANGED
|
@@ -1509,6 +1509,7 @@ export declare class CreateAutoProvisioningGroupRequest extends $tea.Model {
|
|
|
1509
1509
|
spotInstancePoolsToUseCount?: number;
|
|
1510
1510
|
spotTargetCapacity?: string;
|
|
1511
1511
|
systemDiskConfig?: CreateAutoProvisioningGroupRequestSystemDiskConfig[];
|
|
1512
|
+
tag?: CreateAutoProvisioningGroupRequestTag[];
|
|
1512
1513
|
terminateInstances?: boolean;
|
|
1513
1514
|
terminateInstancesWithExpiration?: boolean;
|
|
1514
1515
|
totalTargetCapacity?: string;
|
|
@@ -1556,6 +1557,7 @@ export declare class CreateAutoProvisioningGroupResponse extends $tea.Model {
|
|
|
1556
1557
|
}
|
|
1557
1558
|
export declare class CreateAutoSnapshotPolicyRequest extends $tea.Model {
|
|
1558
1559
|
copiedSnapshotsRetentionDays?: number;
|
|
1560
|
+
copyEncryptionConfiguration?: CreateAutoSnapshotPolicyRequestCopyEncryptionConfiguration;
|
|
1559
1561
|
enableCrossRegionCopy?: boolean;
|
|
1560
1562
|
ownerId?: number;
|
|
1561
1563
|
resourceGroupId?: string;
|
|
@@ -5631,6 +5633,7 @@ export declare class DescribeAutoProvisioningGroupsRequest extends $tea.Model {
|
|
|
5631
5633
|
resourceGroupId?: string;
|
|
5632
5634
|
resourceOwnerAccount?: string;
|
|
5633
5635
|
resourceOwnerId?: number;
|
|
5636
|
+
tag?: DescribeAutoProvisioningGroupsRequestTag[];
|
|
5634
5637
|
static names(): {
|
|
5635
5638
|
[key: string]: string;
|
|
5636
5639
|
};
|
|
@@ -6049,6 +6052,54 @@ export declare class DescribeClassicLinkInstancesResponse extends $tea.Model {
|
|
|
6049
6052
|
[key: string]: any;
|
|
6050
6053
|
});
|
|
6051
6054
|
}
|
|
6055
|
+
export declare class DescribeCloudAssistantSettingsRequest extends $tea.Model {
|
|
6056
|
+
ownerAccount?: string;
|
|
6057
|
+
ownerId?: number;
|
|
6058
|
+
regionId?: string;
|
|
6059
|
+
resourceOwnerAccount?: string;
|
|
6060
|
+
resourceOwnerId?: number;
|
|
6061
|
+
settingType?: string[];
|
|
6062
|
+
static names(): {
|
|
6063
|
+
[key: string]: string;
|
|
6064
|
+
};
|
|
6065
|
+
static types(): {
|
|
6066
|
+
[key: string]: any;
|
|
6067
|
+
};
|
|
6068
|
+
constructor(map?: {
|
|
6069
|
+
[key: string]: any;
|
|
6070
|
+
});
|
|
6071
|
+
}
|
|
6072
|
+
export declare class DescribeCloudAssistantSettingsResponseBody extends $tea.Model {
|
|
6073
|
+
agentUpgradeConfig?: DescribeCloudAssistantSettingsResponseBodyAgentUpgradeConfig;
|
|
6074
|
+
ossDeliveryConfigs?: DescribeCloudAssistantSettingsResponseBodyOssDeliveryConfigs;
|
|
6075
|
+
requestId?: string;
|
|
6076
|
+
slsDeliveryConfigs?: DescribeCloudAssistantSettingsResponseBodySlsDeliveryConfigs;
|
|
6077
|
+
static names(): {
|
|
6078
|
+
[key: string]: string;
|
|
6079
|
+
};
|
|
6080
|
+
static types(): {
|
|
6081
|
+
[key: string]: any;
|
|
6082
|
+
};
|
|
6083
|
+
constructor(map?: {
|
|
6084
|
+
[key: string]: any;
|
|
6085
|
+
});
|
|
6086
|
+
}
|
|
6087
|
+
export declare class DescribeCloudAssistantSettingsResponse extends $tea.Model {
|
|
6088
|
+
headers?: {
|
|
6089
|
+
[key: string]: string;
|
|
6090
|
+
};
|
|
6091
|
+
statusCode?: number;
|
|
6092
|
+
body?: DescribeCloudAssistantSettingsResponseBody;
|
|
6093
|
+
static names(): {
|
|
6094
|
+
[key: string]: string;
|
|
6095
|
+
};
|
|
6096
|
+
static types(): {
|
|
6097
|
+
[key: string]: any;
|
|
6098
|
+
};
|
|
6099
|
+
constructor(map?: {
|
|
6100
|
+
[key: string]: any;
|
|
6101
|
+
});
|
|
6102
|
+
}
|
|
6052
6103
|
export declare class DescribeCloudAssistantStatusRequest extends $tea.Model {
|
|
6053
6104
|
instanceId?: string[];
|
|
6054
6105
|
maxResults?: number;
|
|
@@ -11156,6 +11207,56 @@ export declare class DescribeTasksResponse extends $tea.Model {
|
|
|
11156
11207
|
[key: string]: any;
|
|
11157
11208
|
});
|
|
11158
11209
|
}
|
|
11210
|
+
export declare class DescribeTerminalSessionsRequest extends $tea.Model {
|
|
11211
|
+
instanceId?: string;
|
|
11212
|
+
maxResults?: number;
|
|
11213
|
+
nextToken?: string;
|
|
11214
|
+
ownerAccount?: string;
|
|
11215
|
+
ownerId?: number;
|
|
11216
|
+
regionId?: string;
|
|
11217
|
+
resourceOwnerAccount?: string;
|
|
11218
|
+
resourceOwnerId?: number;
|
|
11219
|
+
sessionId?: string;
|
|
11220
|
+
static names(): {
|
|
11221
|
+
[key: string]: string;
|
|
11222
|
+
};
|
|
11223
|
+
static types(): {
|
|
11224
|
+
[key: string]: any;
|
|
11225
|
+
};
|
|
11226
|
+
constructor(map?: {
|
|
11227
|
+
[key: string]: any;
|
|
11228
|
+
});
|
|
11229
|
+
}
|
|
11230
|
+
export declare class DescribeTerminalSessionsResponseBody extends $tea.Model {
|
|
11231
|
+
nextToken?: string;
|
|
11232
|
+
requestId?: string;
|
|
11233
|
+
sessions?: DescribeTerminalSessionsResponseBodySessions;
|
|
11234
|
+
static names(): {
|
|
11235
|
+
[key: string]: string;
|
|
11236
|
+
};
|
|
11237
|
+
static types(): {
|
|
11238
|
+
[key: string]: any;
|
|
11239
|
+
};
|
|
11240
|
+
constructor(map?: {
|
|
11241
|
+
[key: string]: any;
|
|
11242
|
+
});
|
|
11243
|
+
}
|
|
11244
|
+
export declare class DescribeTerminalSessionsResponse extends $tea.Model {
|
|
11245
|
+
headers?: {
|
|
11246
|
+
[key: string]: string;
|
|
11247
|
+
};
|
|
11248
|
+
statusCode?: number;
|
|
11249
|
+
body?: DescribeTerminalSessionsResponseBody;
|
|
11250
|
+
static names(): {
|
|
11251
|
+
[key: string]: string;
|
|
11252
|
+
};
|
|
11253
|
+
static types(): {
|
|
11254
|
+
[key: string]: any;
|
|
11255
|
+
};
|
|
11256
|
+
constructor(map?: {
|
|
11257
|
+
[key: string]: any;
|
|
11258
|
+
});
|
|
11259
|
+
}
|
|
11159
11260
|
export declare class DescribeUserBusinessBehaviorRequest extends $tea.Model {
|
|
11160
11261
|
ownerAccount?: string;
|
|
11161
11262
|
ownerId?: number;
|
|
@@ -12245,6 +12346,7 @@ export declare class ImportImageRequest extends $tea.Model {
|
|
|
12245
12346
|
resourceOwnerAccount?: string;
|
|
12246
12347
|
resourceOwnerId?: number;
|
|
12247
12348
|
roleName?: string;
|
|
12349
|
+
storageLocationArn?: string;
|
|
12248
12350
|
tag?: ImportImageRequestTag[];
|
|
12249
12351
|
static names(): {
|
|
12250
12352
|
[key: string]: string;
|
|
@@ -12828,6 +12930,7 @@ export declare class ModifyAutoSnapshotPolicyResponse extends $tea.Model {
|
|
|
12828
12930
|
}
|
|
12829
12931
|
export declare class ModifyAutoSnapshotPolicyExRequest extends $tea.Model {
|
|
12830
12932
|
copiedSnapshotsRetentionDays?: number;
|
|
12933
|
+
copyEncryptionConfiguration?: ModifyAutoSnapshotPolicyExRequestCopyEncryptionConfiguration;
|
|
12831
12934
|
enableCrossRegionCopy?: boolean;
|
|
12832
12935
|
ownerId?: number;
|
|
12833
12936
|
resourceOwnerAccount?: string;
|
|
@@ -12974,6 +13077,74 @@ export declare class ModifyCapacityReservationResponse extends $tea.Model {
|
|
|
12974
13077
|
[key: string]: any;
|
|
12975
13078
|
});
|
|
12976
13079
|
}
|
|
13080
|
+
export declare class ModifyCloudAssistantSettingsRequest extends $tea.Model {
|
|
13081
|
+
agentUpgradeConfig?: ModifyCloudAssistantSettingsRequestAgentUpgradeConfig;
|
|
13082
|
+
ossDeliveryConfig?: ModifyCloudAssistantSettingsRequestOssDeliveryConfig;
|
|
13083
|
+
ownerAccount?: string;
|
|
13084
|
+
ownerId?: number;
|
|
13085
|
+
regionId?: string;
|
|
13086
|
+
resourceOwnerAccount?: string;
|
|
13087
|
+
resourceOwnerId?: number;
|
|
13088
|
+
settingType?: string;
|
|
13089
|
+
slsDeliveryConfig?: ModifyCloudAssistantSettingsRequestSlsDeliveryConfig;
|
|
13090
|
+
static names(): {
|
|
13091
|
+
[key: string]: string;
|
|
13092
|
+
};
|
|
13093
|
+
static types(): {
|
|
13094
|
+
[key: string]: any;
|
|
13095
|
+
};
|
|
13096
|
+
constructor(map?: {
|
|
13097
|
+
[key: string]: any;
|
|
13098
|
+
});
|
|
13099
|
+
}
|
|
13100
|
+
export declare class ModifyCloudAssistantSettingsShrinkRequest extends $tea.Model {
|
|
13101
|
+
agentUpgradeConfigShrink?: string;
|
|
13102
|
+
ossDeliveryConfigShrink?: string;
|
|
13103
|
+
ownerAccount?: string;
|
|
13104
|
+
ownerId?: number;
|
|
13105
|
+
regionId?: string;
|
|
13106
|
+
resourceOwnerAccount?: string;
|
|
13107
|
+
resourceOwnerId?: number;
|
|
13108
|
+
settingType?: string;
|
|
13109
|
+
slsDeliveryConfigShrink?: string;
|
|
13110
|
+
static names(): {
|
|
13111
|
+
[key: string]: string;
|
|
13112
|
+
};
|
|
13113
|
+
static types(): {
|
|
13114
|
+
[key: string]: any;
|
|
13115
|
+
};
|
|
13116
|
+
constructor(map?: {
|
|
13117
|
+
[key: string]: any;
|
|
13118
|
+
});
|
|
13119
|
+
}
|
|
13120
|
+
export declare class ModifyCloudAssistantSettingsResponseBody extends $tea.Model {
|
|
13121
|
+
requestId?: string;
|
|
13122
|
+
static names(): {
|
|
13123
|
+
[key: string]: string;
|
|
13124
|
+
};
|
|
13125
|
+
static types(): {
|
|
13126
|
+
[key: string]: any;
|
|
13127
|
+
};
|
|
13128
|
+
constructor(map?: {
|
|
13129
|
+
[key: string]: any;
|
|
13130
|
+
});
|
|
13131
|
+
}
|
|
13132
|
+
export declare class ModifyCloudAssistantSettingsResponse extends $tea.Model {
|
|
13133
|
+
headers?: {
|
|
13134
|
+
[key: string]: string;
|
|
13135
|
+
};
|
|
13136
|
+
statusCode?: number;
|
|
13137
|
+
body?: ModifyCloudAssistantSettingsResponseBody;
|
|
13138
|
+
static names(): {
|
|
13139
|
+
[key: string]: string;
|
|
13140
|
+
};
|
|
13141
|
+
static types(): {
|
|
13142
|
+
[key: string]: any;
|
|
13143
|
+
};
|
|
13144
|
+
constructor(map?: {
|
|
13145
|
+
[key: string]: any;
|
|
13146
|
+
});
|
|
13147
|
+
}
|
|
12977
13148
|
export declare class ModifyCommandRequest extends $tea.Model {
|
|
12978
13149
|
commandContent?: string;
|
|
12979
13150
|
commandId?: string;
|
|
@@ -17622,6 +17793,7 @@ export declare class StartTerminalSessionRequest extends $tea.Model {
|
|
|
17622
17793
|
resourceOwnerAccount?: string;
|
|
17623
17794
|
resourceOwnerId?: number;
|
|
17624
17795
|
targetServer?: string;
|
|
17796
|
+
username?: string;
|
|
17625
17797
|
static names(): {
|
|
17626
17798
|
[key: string]: string;
|
|
17627
17799
|
};
|
|
@@ -18621,6 +18793,19 @@ export declare class CreateAutoProvisioningGroupRequestSystemDiskConfig extends
|
|
|
18621
18793
|
[key: string]: any;
|
|
18622
18794
|
});
|
|
18623
18795
|
}
|
|
18796
|
+
export declare class CreateAutoProvisioningGroupRequestTag extends $tea.Model {
|
|
18797
|
+
key?: string;
|
|
18798
|
+
value?: string;
|
|
18799
|
+
static names(): {
|
|
18800
|
+
[key: string]: string;
|
|
18801
|
+
};
|
|
18802
|
+
static types(): {
|
|
18803
|
+
[key: string]: any;
|
|
18804
|
+
};
|
|
18805
|
+
constructor(map?: {
|
|
18806
|
+
[key: string]: any;
|
|
18807
|
+
});
|
|
18808
|
+
}
|
|
18624
18809
|
export declare class CreateAutoProvisioningGroupResponseBodyLaunchResultsLaunchResultInstanceIds extends $tea.Model {
|
|
18625
18810
|
instanceId?: string[];
|
|
18626
18811
|
static names(): {
|
|
@@ -18663,6 +18848,34 @@ export declare class CreateAutoProvisioningGroupResponseBodyLaunchResults extend
|
|
|
18663
18848
|
[key: string]: any;
|
|
18664
18849
|
});
|
|
18665
18850
|
}
|
|
18851
|
+
export declare class CreateAutoSnapshotPolicyRequestCopyEncryptionConfigurationArn extends $tea.Model {
|
|
18852
|
+
assumeRoleFor?: number;
|
|
18853
|
+
roleType?: string;
|
|
18854
|
+
rolearn?: string;
|
|
18855
|
+
static names(): {
|
|
18856
|
+
[key: string]: string;
|
|
18857
|
+
};
|
|
18858
|
+
static types(): {
|
|
18859
|
+
[key: string]: any;
|
|
18860
|
+
};
|
|
18861
|
+
constructor(map?: {
|
|
18862
|
+
[key: string]: any;
|
|
18863
|
+
});
|
|
18864
|
+
}
|
|
18865
|
+
export declare class CreateAutoSnapshotPolicyRequestCopyEncryptionConfiguration extends $tea.Model {
|
|
18866
|
+
arn?: CreateAutoSnapshotPolicyRequestCopyEncryptionConfigurationArn[];
|
|
18867
|
+
encrypted?: boolean;
|
|
18868
|
+
KMSKeyId?: string;
|
|
18869
|
+
static names(): {
|
|
18870
|
+
[key: string]: string;
|
|
18871
|
+
};
|
|
18872
|
+
static types(): {
|
|
18873
|
+
[key: string]: any;
|
|
18874
|
+
};
|
|
18875
|
+
constructor(map?: {
|
|
18876
|
+
[key: string]: any;
|
|
18877
|
+
});
|
|
18878
|
+
}
|
|
18666
18879
|
export declare class CreateAutoSnapshotPolicyRequestTag extends $tea.Model {
|
|
18667
18880
|
key?: string;
|
|
18668
18881
|
value?: string;
|
|
@@ -19769,6 +19982,19 @@ export declare class DescribeAutoProvisioningGroupInstancesResponseBodyInstances
|
|
|
19769
19982
|
[key: string]: any;
|
|
19770
19983
|
});
|
|
19771
19984
|
}
|
|
19985
|
+
export declare class DescribeAutoProvisioningGroupsRequestTag extends $tea.Model {
|
|
19986
|
+
key?: string;
|
|
19987
|
+
value?: string;
|
|
19988
|
+
static names(): {
|
|
19989
|
+
[key: string]: string;
|
|
19990
|
+
};
|
|
19991
|
+
static types(): {
|
|
19992
|
+
[key: string]: any;
|
|
19993
|
+
};
|
|
19994
|
+
constructor(map?: {
|
|
19995
|
+
[key: string]: any;
|
|
19996
|
+
});
|
|
19997
|
+
}
|
|
19772
19998
|
export declare class DescribeAutoProvisioningGroupsResponseBodyAutoProvisioningGroupsAutoProvisioningGroupLaunchTemplateConfigsLaunchTemplateConfig extends $tea.Model {
|
|
19773
19999
|
instanceType?: string;
|
|
19774
20000
|
maxPrice?: number;
|
|
@@ -19823,6 +20049,31 @@ export declare class DescribeAutoProvisioningGroupsResponseBodyAutoProvisioningG
|
|
|
19823
20049
|
[key: string]: any;
|
|
19824
20050
|
});
|
|
19825
20051
|
}
|
|
20052
|
+
export declare class DescribeAutoProvisioningGroupsResponseBodyAutoProvisioningGroupsAutoProvisioningGroupTagsTag extends $tea.Model {
|
|
20053
|
+
tagKey?: string;
|
|
20054
|
+
tagValue?: string;
|
|
20055
|
+
static names(): {
|
|
20056
|
+
[key: string]: string;
|
|
20057
|
+
};
|
|
20058
|
+
static types(): {
|
|
20059
|
+
[key: string]: any;
|
|
20060
|
+
};
|
|
20061
|
+
constructor(map?: {
|
|
20062
|
+
[key: string]: any;
|
|
20063
|
+
});
|
|
20064
|
+
}
|
|
20065
|
+
export declare class DescribeAutoProvisioningGroupsResponseBodyAutoProvisioningGroupsAutoProvisioningGroupTags extends $tea.Model {
|
|
20066
|
+
tag?: DescribeAutoProvisioningGroupsResponseBodyAutoProvisioningGroupsAutoProvisioningGroupTagsTag[];
|
|
20067
|
+
static names(): {
|
|
20068
|
+
[key: string]: string;
|
|
20069
|
+
};
|
|
20070
|
+
static types(): {
|
|
20071
|
+
[key: string]: any;
|
|
20072
|
+
};
|
|
20073
|
+
constructor(map?: {
|
|
20074
|
+
[key: string]: any;
|
|
20075
|
+
});
|
|
20076
|
+
}
|
|
19826
20077
|
export declare class DescribeAutoProvisioningGroupsResponseBodyAutoProvisioningGroupsAutoProvisioningGroupTargetCapacitySpecification extends $tea.Model {
|
|
19827
20078
|
defaultTargetCapacityType?: string;
|
|
19828
20079
|
payAsYouGoTargetCapacity?: number;
|
|
@@ -19854,6 +20105,7 @@ export declare class DescribeAutoProvisioningGroupsResponseBodyAutoProvisioningG
|
|
|
19854
20105
|
spotOptions?: DescribeAutoProvisioningGroupsResponseBodyAutoProvisioningGroupsAutoProvisioningGroupSpotOptions;
|
|
19855
20106
|
state?: string;
|
|
19856
20107
|
status?: string;
|
|
20108
|
+
tags?: DescribeAutoProvisioningGroupsResponseBodyAutoProvisioningGroupsAutoProvisioningGroupTags;
|
|
19857
20109
|
targetCapacitySpecification?: DescribeAutoProvisioningGroupsResponseBodyAutoProvisioningGroupsAutoProvisioningGroupTargetCapacitySpecification;
|
|
19858
20110
|
terminateInstances?: boolean;
|
|
19859
20111
|
terminateInstancesWithExpiration?: boolean;
|
|
@@ -19894,6 +20146,19 @@ export declare class DescribeAutoSnapshotPolicyExRequestTag extends $tea.Model {
|
|
|
19894
20146
|
[key: string]: any;
|
|
19895
20147
|
});
|
|
19896
20148
|
}
|
|
20149
|
+
export declare class DescribeAutoSnapshotPolicyExResponseBodyAutoSnapshotPoliciesAutoSnapshotPolicyCopyEncryptionConfiguration extends $tea.Model {
|
|
20150
|
+
encrypted?: boolean;
|
|
20151
|
+
KMSKeyId?: string;
|
|
20152
|
+
static names(): {
|
|
20153
|
+
[key: string]: string;
|
|
20154
|
+
};
|
|
20155
|
+
static types(): {
|
|
20156
|
+
[key: string]: any;
|
|
20157
|
+
};
|
|
20158
|
+
constructor(map?: {
|
|
20159
|
+
[key: string]: any;
|
|
20160
|
+
});
|
|
20161
|
+
}
|
|
19897
20162
|
export declare class DescribeAutoSnapshotPolicyExResponseBodyAutoSnapshotPoliciesAutoSnapshotPolicyTagsTag extends $tea.Model {
|
|
19898
20163
|
tagKey?: string;
|
|
19899
20164
|
tagValue?: string;
|
|
@@ -19923,6 +20188,7 @@ export declare class DescribeAutoSnapshotPolicyExResponseBodyAutoSnapshotPolicie
|
|
|
19923
20188
|
autoSnapshotPolicyId?: string;
|
|
19924
20189
|
autoSnapshotPolicyName?: string;
|
|
19925
20190
|
copiedSnapshotsRetentionDays?: number;
|
|
20191
|
+
copyEncryptionConfiguration?: DescribeAutoSnapshotPolicyExResponseBodyAutoSnapshotPoliciesAutoSnapshotPolicyCopyEncryptionConfiguration;
|
|
19926
20192
|
creationTime?: string;
|
|
19927
20193
|
diskNums?: number;
|
|
19928
20194
|
enableCrossRegionCopy?: boolean;
|
|
@@ -20338,6 +20604,89 @@ export declare class DescribeClassicLinkInstancesResponseBodyLinks extends $tea.
|
|
|
20338
20604
|
[key: string]: any;
|
|
20339
20605
|
});
|
|
20340
20606
|
}
|
|
20607
|
+
export declare class DescribeCloudAssistantSettingsResponseBodyAgentUpgradeConfigAllowedUpgradeWindows extends $tea.Model {
|
|
20608
|
+
allowedUpgradeWindow?: string[];
|
|
20609
|
+
static names(): {
|
|
20610
|
+
[key: string]: string;
|
|
20611
|
+
};
|
|
20612
|
+
static types(): {
|
|
20613
|
+
[key: string]: any;
|
|
20614
|
+
};
|
|
20615
|
+
constructor(map?: {
|
|
20616
|
+
[key: string]: any;
|
|
20617
|
+
});
|
|
20618
|
+
}
|
|
20619
|
+
export declare class DescribeCloudAssistantSettingsResponseBodyAgentUpgradeConfig extends $tea.Model {
|
|
20620
|
+
allowedUpgradeWindows?: DescribeCloudAssistantSettingsResponseBodyAgentUpgradeConfigAllowedUpgradeWindows;
|
|
20621
|
+
enabled?: boolean;
|
|
20622
|
+
timeZone?: string;
|
|
20623
|
+
static names(): {
|
|
20624
|
+
[key: string]: string;
|
|
20625
|
+
};
|
|
20626
|
+
static types(): {
|
|
20627
|
+
[key: string]: any;
|
|
20628
|
+
};
|
|
20629
|
+
constructor(map?: {
|
|
20630
|
+
[key: string]: any;
|
|
20631
|
+
});
|
|
20632
|
+
}
|
|
20633
|
+
export declare class DescribeCloudAssistantSettingsResponseBodyOssDeliveryConfigsOssDeliveryConfig extends $tea.Model {
|
|
20634
|
+
bucketName?: string;
|
|
20635
|
+
deliveryType?: string;
|
|
20636
|
+
enabled?: boolean;
|
|
20637
|
+
encryptionAlgorithm?: string;
|
|
20638
|
+
encryptionKeyId?: string;
|
|
20639
|
+
encryptionType?: string;
|
|
20640
|
+
prefix?: string;
|
|
20641
|
+
static names(): {
|
|
20642
|
+
[key: string]: string;
|
|
20643
|
+
};
|
|
20644
|
+
static types(): {
|
|
20645
|
+
[key: string]: any;
|
|
20646
|
+
};
|
|
20647
|
+
constructor(map?: {
|
|
20648
|
+
[key: string]: any;
|
|
20649
|
+
});
|
|
20650
|
+
}
|
|
20651
|
+
export declare class DescribeCloudAssistantSettingsResponseBodyOssDeliveryConfigs extends $tea.Model {
|
|
20652
|
+
ossDeliveryConfig?: DescribeCloudAssistantSettingsResponseBodyOssDeliveryConfigsOssDeliveryConfig[];
|
|
20653
|
+
static names(): {
|
|
20654
|
+
[key: string]: string;
|
|
20655
|
+
};
|
|
20656
|
+
static types(): {
|
|
20657
|
+
[key: string]: any;
|
|
20658
|
+
};
|
|
20659
|
+
constructor(map?: {
|
|
20660
|
+
[key: string]: any;
|
|
20661
|
+
});
|
|
20662
|
+
}
|
|
20663
|
+
export declare class DescribeCloudAssistantSettingsResponseBodySlsDeliveryConfigsSlsDeliveryConfig extends $tea.Model {
|
|
20664
|
+
deliveryType?: string;
|
|
20665
|
+
enabled?: boolean;
|
|
20666
|
+
logstoreName?: string;
|
|
20667
|
+
projectName?: string;
|
|
20668
|
+
static names(): {
|
|
20669
|
+
[key: string]: string;
|
|
20670
|
+
};
|
|
20671
|
+
static types(): {
|
|
20672
|
+
[key: string]: any;
|
|
20673
|
+
};
|
|
20674
|
+
constructor(map?: {
|
|
20675
|
+
[key: string]: any;
|
|
20676
|
+
});
|
|
20677
|
+
}
|
|
20678
|
+
export declare class DescribeCloudAssistantSettingsResponseBodySlsDeliveryConfigs extends $tea.Model {
|
|
20679
|
+
slsDeliveryConfig?: DescribeCloudAssistantSettingsResponseBodySlsDeliveryConfigsSlsDeliveryConfig[];
|
|
20680
|
+
static names(): {
|
|
20681
|
+
[key: string]: string;
|
|
20682
|
+
};
|
|
20683
|
+
static types(): {
|
|
20684
|
+
[key: string]: any;
|
|
20685
|
+
};
|
|
20686
|
+
constructor(map?: {
|
|
20687
|
+
[key: string]: any;
|
|
20688
|
+
});
|
|
20689
|
+
}
|
|
20341
20690
|
export declare class DescribeCloudAssistantStatusResponseBodyInstanceCloudAssistantStatusSetInstanceCloudAssistantStatus extends $tea.Model {
|
|
20342
20691
|
activeTaskCount?: number;
|
|
20343
20692
|
cloudAssistantStatus?: string;
|
|
@@ -27268,6 +27617,66 @@ export declare class DescribeTasksResponseBodyTaskSet extends $tea.Model {
|
|
|
27268
27617
|
[key: string]: any;
|
|
27269
27618
|
});
|
|
27270
27619
|
}
|
|
27620
|
+
export declare class DescribeTerminalSessionsResponseBodySessionsSessionConnectionsConnection extends $tea.Model {
|
|
27621
|
+
closedReason?: string;
|
|
27622
|
+
endTime?: string;
|
|
27623
|
+
instanceId?: string;
|
|
27624
|
+
startTime?: string;
|
|
27625
|
+
status?: string;
|
|
27626
|
+
static names(): {
|
|
27627
|
+
[key: string]: string;
|
|
27628
|
+
};
|
|
27629
|
+
static types(): {
|
|
27630
|
+
[key: string]: any;
|
|
27631
|
+
};
|
|
27632
|
+
constructor(map?: {
|
|
27633
|
+
[key: string]: any;
|
|
27634
|
+
});
|
|
27635
|
+
}
|
|
27636
|
+
export declare class DescribeTerminalSessionsResponseBodySessionsSessionConnections extends $tea.Model {
|
|
27637
|
+
connection?: DescribeTerminalSessionsResponseBodySessionsSessionConnectionsConnection[];
|
|
27638
|
+
static names(): {
|
|
27639
|
+
[key: string]: string;
|
|
27640
|
+
};
|
|
27641
|
+
static types(): {
|
|
27642
|
+
[key: string]: any;
|
|
27643
|
+
};
|
|
27644
|
+
constructor(map?: {
|
|
27645
|
+
[key: string]: any;
|
|
27646
|
+
});
|
|
27647
|
+
}
|
|
27648
|
+
export declare class DescribeTerminalSessionsResponseBodySessionsSession extends $tea.Model {
|
|
27649
|
+
clientIP?: string;
|
|
27650
|
+
connections?: DescribeTerminalSessionsResponseBodySessionsSessionConnections;
|
|
27651
|
+
creationTime?: string;
|
|
27652
|
+
identityType?: string;
|
|
27653
|
+
portNumber?: number;
|
|
27654
|
+
principalId?: string;
|
|
27655
|
+
sessionId?: string;
|
|
27656
|
+
targetServer?: string;
|
|
27657
|
+
username?: string;
|
|
27658
|
+
static names(): {
|
|
27659
|
+
[key: string]: string;
|
|
27660
|
+
};
|
|
27661
|
+
static types(): {
|
|
27662
|
+
[key: string]: any;
|
|
27663
|
+
};
|
|
27664
|
+
constructor(map?: {
|
|
27665
|
+
[key: string]: any;
|
|
27666
|
+
});
|
|
27667
|
+
}
|
|
27668
|
+
export declare class DescribeTerminalSessionsResponseBodySessions extends $tea.Model {
|
|
27669
|
+
session?: DescribeTerminalSessionsResponseBodySessionsSession[];
|
|
27670
|
+
static names(): {
|
|
27671
|
+
[key: string]: string;
|
|
27672
|
+
};
|
|
27673
|
+
static types(): {
|
|
27674
|
+
[key: string]: any;
|
|
27675
|
+
};
|
|
27676
|
+
constructor(map?: {
|
|
27677
|
+
[key: string]: any;
|
|
27678
|
+
});
|
|
27679
|
+
}
|
|
27271
27680
|
export declare class DescribeVRoutersResponseBodyVRoutersVRouterRouteTableIds extends $tea.Model {
|
|
27272
27681
|
routeTableId?: string[];
|
|
27273
27682
|
static names(): {
|
|
@@ -28027,6 +28436,34 @@ export declare class ModifyAutoProvisioningGroupRequestLaunchTemplateConfig exte
|
|
|
28027
28436
|
[key: string]: any;
|
|
28028
28437
|
});
|
|
28029
28438
|
}
|
|
28439
|
+
export declare class ModifyAutoSnapshotPolicyExRequestCopyEncryptionConfigurationArn extends $tea.Model {
|
|
28440
|
+
assumeRoleFor?: number;
|
|
28441
|
+
roleType?: string;
|
|
28442
|
+
rolearn?: string;
|
|
28443
|
+
static names(): {
|
|
28444
|
+
[key: string]: string;
|
|
28445
|
+
};
|
|
28446
|
+
static types(): {
|
|
28447
|
+
[key: string]: any;
|
|
28448
|
+
};
|
|
28449
|
+
constructor(map?: {
|
|
28450
|
+
[key: string]: any;
|
|
28451
|
+
});
|
|
28452
|
+
}
|
|
28453
|
+
export declare class ModifyAutoSnapshotPolicyExRequestCopyEncryptionConfiguration extends $tea.Model {
|
|
28454
|
+
arn?: ModifyAutoSnapshotPolicyExRequestCopyEncryptionConfigurationArn[];
|
|
28455
|
+
encrypted?: boolean;
|
|
28456
|
+
KMSKeyId?: string;
|
|
28457
|
+
static names(): {
|
|
28458
|
+
[key: string]: string;
|
|
28459
|
+
};
|
|
28460
|
+
static types(): {
|
|
28461
|
+
[key: string]: any;
|
|
28462
|
+
};
|
|
28463
|
+
constructor(map?: {
|
|
28464
|
+
[key: string]: any;
|
|
28465
|
+
});
|
|
28466
|
+
}
|
|
28030
28467
|
export declare class ModifyCapacityReservationRequestPrivatePoolOptions extends $tea.Model {
|
|
28031
28468
|
id?: string;
|
|
28032
28469
|
name?: string;
|
|
@@ -28040,6 +28477,51 @@ export declare class ModifyCapacityReservationRequestPrivatePoolOptions extends
|
|
|
28040
28477
|
[key: string]: any;
|
|
28041
28478
|
});
|
|
28042
28479
|
}
|
|
28480
|
+
export declare class ModifyCloudAssistantSettingsRequestAgentUpgradeConfig extends $tea.Model {
|
|
28481
|
+
allowedUpgradeWindow?: string[];
|
|
28482
|
+
enabled?: boolean;
|
|
28483
|
+
timeZone?: string;
|
|
28484
|
+
static names(): {
|
|
28485
|
+
[key: string]: string;
|
|
28486
|
+
};
|
|
28487
|
+
static types(): {
|
|
28488
|
+
[key: string]: any;
|
|
28489
|
+
};
|
|
28490
|
+
constructor(map?: {
|
|
28491
|
+
[key: string]: any;
|
|
28492
|
+
});
|
|
28493
|
+
}
|
|
28494
|
+
export declare class ModifyCloudAssistantSettingsRequestOssDeliveryConfig extends $tea.Model {
|
|
28495
|
+
bucketName?: string;
|
|
28496
|
+
enabled?: boolean;
|
|
28497
|
+
encryptionAlgorithm?: string;
|
|
28498
|
+
encryptionKeyId?: string;
|
|
28499
|
+
encryptionType?: string;
|
|
28500
|
+
prefix?: string;
|
|
28501
|
+
static names(): {
|
|
28502
|
+
[key: string]: string;
|
|
28503
|
+
};
|
|
28504
|
+
static types(): {
|
|
28505
|
+
[key: string]: any;
|
|
28506
|
+
};
|
|
28507
|
+
constructor(map?: {
|
|
28508
|
+
[key: string]: any;
|
|
28509
|
+
});
|
|
28510
|
+
}
|
|
28511
|
+
export declare class ModifyCloudAssistantSettingsRequestSlsDeliveryConfig extends $tea.Model {
|
|
28512
|
+
enabled?: boolean;
|
|
28513
|
+
logstoreName?: string;
|
|
28514
|
+
projectName?: string;
|
|
28515
|
+
static names(): {
|
|
28516
|
+
[key: string]: string;
|
|
28517
|
+
};
|
|
28518
|
+
static types(): {
|
|
28519
|
+
[key: string]: any;
|
|
28520
|
+
};
|
|
28521
|
+
constructor(map?: {
|
|
28522
|
+
[key: string]: any;
|
|
28523
|
+
});
|
|
28524
|
+
}
|
|
28043
28525
|
export declare class ModifyDedicatedHostAttributeRequestNetworkAttributes extends $tea.Model {
|
|
28044
28526
|
slbUdpTimeout?: number;
|
|
28045
28527
|
udpTimeout?: number;
|
|
@@ -29550,13 +30032,14 @@ export default class Client extends OpenApi {
|
|
|
29550
30032
|
*/
|
|
29551
30033
|
connectRouterInterface(request: ConnectRouterInterfaceRequest): Promise<ConnectRouterInterfaceResponse>;
|
|
29552
30034
|
/**
|
|
29553
|
-
*
|
|
29554
|
-
*
|
|
29555
|
-
*
|
|
29556
|
-
* *
|
|
30035
|
+
* ## [](#)Usage notes
|
|
30036
|
+
* After a public IP address is converted into an EIP, the EIP is billed separately. Make sure that you fully understand the billing methods of EIPs. For more information, see [Billing overview](~~122035~~).
|
|
30037
|
+
* When you call this operation, make sure that the ECS instance meets the following requirements:
|
|
30038
|
+
* * The instance is in the **Stopped** (`Stopped`) or **Running** (`Running`) state.
|
|
30039
|
+
* * The instance has no EIPs associated.
|
|
29557
30040
|
* * The instance has no configuration change tasks that have not taken effect.
|
|
29558
30041
|
* * The public bandwidth of the instance is not 0 Mbit/s.
|
|
29559
|
-
* * The instance uses the pay-by-
|
|
30042
|
+
* * If the instance is a subscription instance, the billing method for network usage of the instance must be `pay-by-traffic`. The public IP address of a subscription instance that uses the `pay-by-bandwidth` billing method for network usage cannot be converted into an EIP. This requirement does not apply to pay-as-you-go instances. For more information, see [Change the billing method for network usage](~~178883~~).
|
|
29560
30043
|
* * If the instance is a subscription instance that resides in a VPC, the instance does not expire within 24 hours.
|
|
29561
30044
|
*
|
|
29562
30045
|
* @param request ConvertNatPublicIpToEipRequest
|
|
@@ -29565,13 +30048,14 @@ export default class Client extends OpenApi {
|
|
|
29565
30048
|
*/
|
|
29566
30049
|
convertNatPublicIpToEipWithOptions(request: ConvertNatPublicIpToEipRequest, runtime: $Util.RuntimeOptions): Promise<ConvertNatPublicIpToEipResponse>;
|
|
29567
30050
|
/**
|
|
29568
|
-
*
|
|
29569
|
-
*
|
|
29570
|
-
*
|
|
29571
|
-
* *
|
|
30051
|
+
* ## [](#)Usage notes
|
|
30052
|
+
* After a public IP address is converted into an EIP, the EIP is billed separately. Make sure that you fully understand the billing methods of EIPs. For more information, see [Billing overview](~~122035~~).
|
|
30053
|
+
* When you call this operation, make sure that the ECS instance meets the following requirements:
|
|
30054
|
+
* * The instance is in the **Stopped** (`Stopped`) or **Running** (`Running`) state.
|
|
30055
|
+
* * The instance has no EIPs associated.
|
|
29572
30056
|
* * The instance has no configuration change tasks that have not taken effect.
|
|
29573
30057
|
* * The public bandwidth of the instance is not 0 Mbit/s.
|
|
29574
|
-
* * The instance uses the pay-by-
|
|
30058
|
+
* * If the instance is a subscription instance, the billing method for network usage of the instance must be `pay-by-traffic`. The public IP address of a subscription instance that uses the `pay-by-bandwidth` billing method for network usage cannot be converted into an EIP. This requirement does not apply to pay-as-you-go instances. For more information, see [Change the billing method for network usage](~~178883~~).
|
|
29575
30059
|
* * If the instance is a subscription instance that resides in a VPC, the instance does not expire within 24 hours.
|
|
29576
30060
|
*
|
|
29577
30061
|
* @param request ConvertNatPublicIpToEipRequest
|
|
@@ -29666,10 +30150,10 @@ export default class Client extends OpenApi {
|
|
|
29666
30150
|
*/
|
|
29667
30151
|
createActivation(request: CreateActivationRequest): Promise<CreateActivationResponse>;
|
|
29668
30152
|
/**
|
|
29669
|
-
* ## Usage notes
|
|
29670
|
-
* * Auto Provisioning is a service that allows quick deployment of an instance cluster that consists of preemptible and pay-as-you-go instances. Auto Provisioning supports push-button deployment of instance clusters across different billing methods, instance families, and zones. For more information, see [Use auto provisioning group-related API operations to create multiple ECS instances at the same time](~~200772~~).
|
|
30153
|
+
* ## [](#)Usage notes
|
|
30154
|
+
* * Auto Provisioning is a service that allows quick deployment of an instance cluster that consists of preemptible instances and pay-as-you-go instances. Auto Provisioning supports push-button deployment of instance clusters across different billing methods, instance families, and zones. For more information, see [Use auto provisioning group-related API operations to create multiple ECS instances at the same time](~~200772~~).
|
|
29671
30155
|
* * Auto Provisioning uses auto provisioning groups to schedule and maintain computing resources. You can use auto provisioning groups to obtain a steady supply of computing resources. This helps reduce the impact on compute capacity when preemptible instances are reclaimed.
|
|
29672
|
-
* * Auto Provisioning is provided free
|
|
30156
|
+
* * Auto Provisioning is provided free of charge. However, you are charged for instance resources that are created in auto provisioning groups. For more information, see [Overview of preemptible instances](~~52088~~) and [Pay-as-you-go](~~40653~~).
|
|
29673
30157
|
* * When you specify both a launch template (`LaunchTemplateId`) and extended configurations (`LaunchConfiguration.*` parameters), LaunchTemplateId takes precedence.
|
|
29674
30158
|
*
|
|
29675
30159
|
* @param request CreateAutoProvisioningGroupRequest
|
|
@@ -29678,10 +30162,10 @@ export default class Client extends OpenApi {
|
|
|
29678
30162
|
*/
|
|
29679
30163
|
createAutoProvisioningGroupWithOptions(request: CreateAutoProvisioningGroupRequest, runtime: $Util.RuntimeOptions): Promise<CreateAutoProvisioningGroupResponse>;
|
|
29680
30164
|
/**
|
|
29681
|
-
* ## Usage notes
|
|
29682
|
-
* * Auto Provisioning is a service that allows quick deployment of an instance cluster that consists of preemptible and pay-as-you-go instances. Auto Provisioning supports push-button deployment of instance clusters across different billing methods, instance families, and zones. For more information, see [Use auto provisioning group-related API operations to create multiple ECS instances at the same time](~~200772~~).
|
|
30165
|
+
* ## [](#)Usage notes
|
|
30166
|
+
* * Auto Provisioning is a service that allows quick deployment of an instance cluster that consists of preemptible instances and pay-as-you-go instances. Auto Provisioning supports push-button deployment of instance clusters across different billing methods, instance families, and zones. For more information, see [Use auto provisioning group-related API operations to create multiple ECS instances at the same time](~~200772~~).
|
|
29683
30167
|
* * Auto Provisioning uses auto provisioning groups to schedule and maintain computing resources. You can use auto provisioning groups to obtain a steady supply of computing resources. This helps reduce the impact on compute capacity when preemptible instances are reclaimed.
|
|
29684
|
-
* * Auto Provisioning is provided free
|
|
30168
|
+
* * Auto Provisioning is provided free of charge. However, you are charged for instance resources that are created in auto provisioning groups. For more information, see [Overview of preemptible instances](~~52088~~) and [Pay-as-you-go](~~40653~~).
|
|
29685
30169
|
* * When you specify both a launch template (`LaunchTemplateId`) and extended configurations (`LaunchConfiguration.*` parameters), LaunchTemplateId takes precedence.
|
|
29686
30170
|
*
|
|
29687
30171
|
* @param request CreateAutoProvisioningGroupRequest
|
|
@@ -29689,11 +30173,12 @@ export default class Client extends OpenApi {
|
|
|
29689
30173
|
*/
|
|
29690
30174
|
createAutoProvisioningGroup(request: CreateAutoProvisioningGroupRequest): Promise<CreateAutoProvisioningGroupResponse>;
|
|
29691
30175
|
/**
|
|
29692
|
-
*
|
|
30176
|
+
* ## [](#)Usage notes
|
|
30177
|
+
* When you call this operation to create an automatic snapshot policy, you can specify the days of the week on which to create automatic snapshots, the retention period of the automatic snapshots, and whether to enable cross-region replication for the snapshots in the policy to meet your diverse data backup requirements. After the automatic snapshot policy is created, call the [ApplyAutoSnapshotPolicy](~~25531~~) operation to apply the policy to disks. If you want to modify the automatic snapshot policy, call the [ModifyAutoSnapshotPolicyEx](~~25529~~) operation.
|
|
29693
30178
|
* Take note of the following items:
|
|
29694
|
-
* * You can create
|
|
29695
|
-
* * If an automatic snapshot is being created when the time scheduled for creating another automatic snapshot is due, the new snapshot task is skipped. This may occur when a disk contains a large volume of data. For example, you have scheduled snapshots to be created at 09:00:00, 10:00:00, 11:00:00, and 12:00:00 for a disk. The system starts to create a snapshot for the disk at 09:00:00. The process takes 80 minutes to complete because the disk contains a large volume of data and ends at 10:20:00.
|
|
29696
|
-
* * For information about how to copy a snapshot from one region to another, see the "Background information" section in [Copy a snapshot](~~159441~~).
|
|
30179
|
+
* * You can create up to 100 automatic snapshot policies per region for a single Alibaba Cloud account.
|
|
30180
|
+
* * If an automatic snapshot is being created when the time scheduled for creating another automatic snapshot is due, the new snapshot task is skipped. This may occur when a disk contains a large volume of data. For example, you have scheduled snapshots to be created at 09:00:00, 10:00:00, 11:00:00, and 12:00:00 for a disk. The system starts to create a snapshot for the disk at 09:00:00. The process takes 80 minutes to complete because the disk contains a large volume of data and ends at 10:20:00. In this case, the system does not create a snapshot at 10:00, but creates a snapshot at 11:00.
|
|
30181
|
+
* * For information about how to copy a snapshot from one region to another region, see the "Background information" section in [Copy a snapshot](~~159441~~).
|
|
29697
30182
|
*
|
|
29698
30183
|
* @param request CreateAutoSnapshotPolicyRequest
|
|
29699
30184
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -29701,11 +30186,12 @@ export default class Client extends OpenApi {
|
|
|
29701
30186
|
*/
|
|
29702
30187
|
createAutoSnapshotPolicyWithOptions(request: CreateAutoSnapshotPolicyRequest, runtime: $Util.RuntimeOptions): Promise<CreateAutoSnapshotPolicyResponse>;
|
|
29703
30188
|
/**
|
|
29704
|
-
*
|
|
30189
|
+
* ## [](#)Usage notes
|
|
30190
|
+
* When you call this operation to create an automatic snapshot policy, you can specify the days of the week on which to create automatic snapshots, the retention period of the automatic snapshots, and whether to enable cross-region replication for the snapshots in the policy to meet your diverse data backup requirements. After the automatic snapshot policy is created, call the [ApplyAutoSnapshotPolicy](~~25531~~) operation to apply the policy to disks. If you want to modify the automatic snapshot policy, call the [ModifyAutoSnapshotPolicyEx](~~25529~~) operation.
|
|
29705
30191
|
* Take note of the following items:
|
|
29706
|
-
* * You can create
|
|
29707
|
-
* * If an automatic snapshot is being created when the time scheduled for creating another automatic snapshot is due, the new snapshot task is skipped. This may occur when a disk contains a large volume of data. For example, you have scheduled snapshots to be created at 09:00:00, 10:00:00, 11:00:00, and 12:00:00 for a disk. The system starts to create a snapshot for the disk at 09:00:00. The process takes 80 minutes to complete because the disk contains a large volume of data and ends at 10:20:00.
|
|
29708
|
-
* * For information about how to copy a snapshot from one region to another, see the "Background information" section in [Copy a snapshot](~~159441~~).
|
|
30192
|
+
* * You can create up to 100 automatic snapshot policies per region for a single Alibaba Cloud account.
|
|
30193
|
+
* * If an automatic snapshot is being created when the time scheduled for creating another automatic snapshot is due, the new snapshot task is skipped. This may occur when a disk contains a large volume of data. For example, you have scheduled snapshots to be created at 09:00:00, 10:00:00, 11:00:00, and 12:00:00 for a disk. The system starts to create a snapshot for the disk at 09:00:00. The process takes 80 minutes to complete because the disk contains a large volume of data and ends at 10:20:00. In this case, the system does not create a snapshot at 10:00, but creates a snapshot at 11:00.
|
|
30194
|
+
* * For information about how to copy a snapshot from one region to another region, see the "Background information" section in [Copy a snapshot](~~159441~~).
|
|
29709
30195
|
*
|
|
29710
30196
|
* @param request CreateAutoSnapshotPolicyRequest
|
|
29711
30197
|
* @return CreateAutoSnapshotPolicyResponse
|
|
@@ -29976,42 +30462,44 @@ export default class Client extends OpenApi {
|
|
|
29976
30462
|
*/
|
|
29977
30463
|
createImagePipeline(request: CreateImagePipelineRequest): Promise<CreateImagePipelineResponse>;
|
|
29978
30464
|
/**
|
|
29979
|
-
*
|
|
29980
|
-
*
|
|
29981
|
-
*
|
|
29982
|
-
*
|
|
29983
|
-
* *
|
|
29984
|
-
*
|
|
29985
|
-
*
|
|
29986
|
-
* *
|
|
29987
|
-
* *
|
|
29988
|
-
*
|
|
29989
|
-
*
|
|
29990
|
-
*
|
|
29991
|
-
* *
|
|
29992
|
-
* *
|
|
29993
|
-
*
|
|
29994
|
-
*
|
|
29995
|
-
* *
|
|
29996
|
-
* *
|
|
29997
|
-
*
|
|
29998
|
-
*
|
|
29999
|
-
* *
|
|
30000
|
-
* *
|
|
30001
|
-
* *
|
|
30002
|
-
* *
|
|
30003
|
-
* *
|
|
30004
|
-
*
|
|
30005
|
-
*
|
|
30006
|
-
* *
|
|
30007
|
-
* *
|
|
30008
|
-
*
|
|
30009
|
-
*
|
|
30010
|
-
* *
|
|
30011
|
-
* *
|
|
30012
|
-
* *
|
|
30013
|
-
*
|
|
30014
|
-
*
|
|
30465
|
+
* ## [](#)Usage notes
|
|
30466
|
+
* > You can call the [DescribeAvailableResource](~~66186~~) operation to query available resources in a specific region or zone. If you want to batch create instances that automatically enter the Running state after they are created, we recommend that you call the [RunInstances](~~63440~~) operation.
|
|
30467
|
+
* Take note of the following items:
|
|
30468
|
+
* * **Billing**:
|
|
30469
|
+
* * You must familiarize yourself with ECS billing methods before you create an instance because you may be charged for the resources used by the instance. For more information, see [Billing overview](~~25398~~).
|
|
30470
|
+
* * If you create a subscription instance (`PrePaid`), available coupons in your account are used by default.
|
|
30471
|
+
* * **Instance type**:
|
|
30472
|
+
* * You can use the `IoOptimized` parameter to specify whether to create an I/O optimized instance.
|
|
30473
|
+
* * Instance type selection: See [Instance families](~~25378~~) or call the [DescribeInstanceTypes](~~25620~~) operation to query the performance data of instance types, or see [Best practices for instance type selection](~~58291~~) to learn about how to select instance types.
|
|
30474
|
+
* * Query of available resources: Call the [DescribeAvailableResource](~~66186~~) operation to query resources available in a specific region or zone.
|
|
30475
|
+
* > If the `QuotaExceed.ElasticQuota` error is returned when you call this operation, it indicates that the maximum number of instances of the specified instance type in the region has been reached, or the maximum number of vCPUs for all instance types in a zone has been reached. You can go to the [ECS console](https://ecs.console.aliyun.com/?spm=a2c8b.12215451.favorites.decs.5e3a336aMGTtzy#/privileges/quota) or [Quota Center](https://quotas.console.aliyun.com/products/ecs/quotas) to request a quota increase.
|
|
30476
|
+
* * **Image**:
|
|
30477
|
+
* * The image determines the system disk configurations of the new instance. The system disk of the new instance is a clone of the specified image.
|
|
30478
|
+
* * If you want to create instances with 512 MiB of memory, you cannot use Windows Server images except for Windows Server Semi-Annual Channel images.
|
|
30479
|
+
* * If you want to create instances with 4 GiB or more of memory, you cannot use 32-bit OS image.
|
|
30480
|
+
* * **Network type**:
|
|
30481
|
+
* * Each instance that resides in a virtual private cloud (VPC) must be connected to only a single vSwitch.
|
|
30482
|
+
* * If `VSwitchId` is specified, the security group specified by `SecurityGroupId` and the vSwitch specified by `VSwitchId` must belong to the same VPC.
|
|
30483
|
+
* * The value of `PrivateIpAddress` varies based on the value of `VSwitchId`. `PrivateIpAddress` cannot be separately specified. If `VSwitchId` and `PrivateIpAddress` are specified, the IP address specified by `PrivateIpAddress` must be an idle IP address in the CIDR block of the specified vSwitch.
|
|
30484
|
+
* * **Public bandwidth**:
|
|
30485
|
+
* * Starting November 27, 2020, the maximum bandwidth value that is available for you to create ECS instances or change ECS instance configurations is subject to the throttling policy of your account. To increase the bandwidth limit, submit a ticket. The throttling policy imposes the following constraints: In a single region, the total maximum bandwidth value of all instances that use the pay-by-traffic billing method for network usage cannot exceed 5 Gbit/s and the total maximum bandwidth value of all instances that use the pay-by-bandwidth billing method for network usage cannot exceed 50 Gbit/s.
|
|
30486
|
+
* * If you call the `CreateInstance` operation to create an instance, no public IP addresses are assigned to the instance. You can call the [AllocatePublicIpAddress](~~25544~~) operation to assign a public IP address to an instance.
|
|
30487
|
+
* * Network usage fees vary based on the settings of `InternetChargeType` and `InternetMaxBandwidthOut`.
|
|
30488
|
+
* * The value of `InternetMaxBandwidthIn` does not affect billing because inbound data traffic is free of charge.
|
|
30489
|
+
* * If `InternetChargeType` is set to PayByBandwidth, `InternetMaxBandwidthOut` specifies the fixed bandwidth. A fixed bandwidth is a specified amount of public bandwidth allocated to an instance that uses the pay-by-bandwidth billing method for network usage.
|
|
30490
|
+
* * If `InternetChargeType` is set to PayByTraffic, `InternetMaxBandwidthOut` specifies the peak bandwidth. A peak bandwidth is the maximum amount of public bandwidth that an instance can consume when the instance uses the pay-by-traffic billing method for network usage. Network usage costs are calculated based on the volume of network traffic.
|
|
30491
|
+
* * **Security group**:
|
|
30492
|
+
* * If no security groups are available in the region where you want to create an instance, you must call the [CreateSecurityGroup](~~25553~~) operation to create a security group in that region first.
|
|
30493
|
+
* * The maximum number of instances that a security group can contain varies based on the security group type. For more information, see the "Security group limits" section in the [Limits](~~25412~~) topic.
|
|
30494
|
+
* * Instances in the same security group can communicate with each other over the internal network. By default, instances in different security groups cannot communicate with each other. You can allow communication between instances by allowing mutual access between the security groups to which the instances belong. For more information, see [AuthorizeSecurityGroup](~~25554~~) and [AuthorizeSecurityGroupEgress](~~25560~~).
|
|
30495
|
+
* * **Storage**:
|
|
30496
|
+
* * The instance is assigned a system disk whose capacity varies based on the size of the specified image. The size of the system disk must be at least `20 GiB` and greater than or equal to the image size. For information about system disk categories, see the description of `SystemDisk.Category`.
|
|
30497
|
+
* * The system disk of an I/O optimized instance can only be an enhanced SSD (ESSD) (`cloud_essd`), a standard SSD (`cloud_ssd`), or an ultra disk (`cloud_efficiency`).
|
|
30498
|
+
* * The maximum size of a data disk varies based on the disk category. For more information, see the description of `DataDisk.N.Size`.
|
|
30499
|
+
* * Up to 16 data disks can be added to an instance. Mount points /dev/xvd\\[b-z] are automatically assigned to data disks in ascending alphanumeric order.
|
|
30500
|
+
* > If the `QuotaExceed.DiskCapacity` error is returned when you call this operation, it indicates that the maximum capacity of the disks of the selected disk category in the specified zone has been reached. You can go to the [Quota Center](https://quotas.console.aliyun.com/products/disk/quotas) to query and request a quota increase.
|
|
30501
|
+
* * **User data**: If the instance type supports user data, you can use the UserData parameter to pass in user data.[](~~49121~~) User data is encoded in Base64. We recommend that you do not pass in confidential information (such as passwords or private keys) in plaintext as user data. This is because the system does not encrypt `UserData` values when API requests are transmitted. If you must pass in confidential information, we recommend that you encrypt and encode the information in Base64 before you pass in the information. Then decode and decrypt the information in the same way within the instance.
|
|
30502
|
+
* * **Others**: When you call API operations by using Alibaba Cloud CLI or SDKs, you must delete periods (.) from some request parameters before you use the parameters. For example, use `SystemDiskCategory` instead of `SystemDisk.Category` as a request parameter.
|
|
30015
30503
|
*
|
|
30016
30504
|
* @param request CreateInstanceRequest
|
|
30017
30505
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -30019,42 +30507,44 @@ export default class Client extends OpenApi {
|
|
|
30019
30507
|
*/
|
|
30020
30508
|
createInstanceWithOptions(request: CreateInstanceRequest, runtime: $Util.RuntimeOptions): Promise<CreateInstanceResponse>;
|
|
30021
30509
|
/**
|
|
30022
|
-
*
|
|
30023
|
-
*
|
|
30024
|
-
*
|
|
30025
|
-
*
|
|
30026
|
-
* *
|
|
30027
|
-
*
|
|
30028
|
-
*
|
|
30029
|
-
* *
|
|
30030
|
-
* *
|
|
30031
|
-
*
|
|
30032
|
-
*
|
|
30033
|
-
*
|
|
30034
|
-
* *
|
|
30035
|
-
* *
|
|
30036
|
-
*
|
|
30037
|
-
*
|
|
30038
|
-
* *
|
|
30039
|
-
* *
|
|
30040
|
-
*
|
|
30041
|
-
*
|
|
30042
|
-
* *
|
|
30043
|
-
* *
|
|
30044
|
-
* *
|
|
30045
|
-
* *
|
|
30046
|
-
* *
|
|
30047
|
-
*
|
|
30048
|
-
*
|
|
30049
|
-
* *
|
|
30050
|
-
* *
|
|
30051
|
-
*
|
|
30052
|
-
*
|
|
30053
|
-
* *
|
|
30054
|
-
* *
|
|
30055
|
-
* *
|
|
30056
|
-
*
|
|
30057
|
-
*
|
|
30510
|
+
* ## [](#)Usage notes
|
|
30511
|
+
* > You can call the [DescribeAvailableResource](~~66186~~) operation to query available resources in a specific region or zone. If you want to batch create instances that automatically enter the Running state after they are created, we recommend that you call the [RunInstances](~~63440~~) operation.
|
|
30512
|
+
* Take note of the following items:
|
|
30513
|
+
* * **Billing**:
|
|
30514
|
+
* * You must familiarize yourself with ECS billing methods before you create an instance because you may be charged for the resources used by the instance. For more information, see [Billing overview](~~25398~~).
|
|
30515
|
+
* * If you create a subscription instance (`PrePaid`), available coupons in your account are used by default.
|
|
30516
|
+
* * **Instance type**:
|
|
30517
|
+
* * You can use the `IoOptimized` parameter to specify whether to create an I/O optimized instance.
|
|
30518
|
+
* * Instance type selection: See [Instance families](~~25378~~) or call the [DescribeInstanceTypes](~~25620~~) operation to query the performance data of instance types, or see [Best practices for instance type selection](~~58291~~) to learn about how to select instance types.
|
|
30519
|
+
* * Query of available resources: Call the [DescribeAvailableResource](~~66186~~) operation to query resources available in a specific region or zone.
|
|
30520
|
+
* > If the `QuotaExceed.ElasticQuota` error is returned when you call this operation, it indicates that the maximum number of instances of the specified instance type in the region has been reached, or the maximum number of vCPUs for all instance types in a zone has been reached. You can go to the [ECS console](https://ecs.console.aliyun.com/?spm=a2c8b.12215451.favorites.decs.5e3a336aMGTtzy#/privileges/quota) or [Quota Center](https://quotas.console.aliyun.com/products/ecs/quotas) to request a quota increase.
|
|
30521
|
+
* * **Image**:
|
|
30522
|
+
* * The image determines the system disk configurations of the new instance. The system disk of the new instance is a clone of the specified image.
|
|
30523
|
+
* * If you want to create instances with 512 MiB of memory, you cannot use Windows Server images except for Windows Server Semi-Annual Channel images.
|
|
30524
|
+
* * If you want to create instances with 4 GiB or more of memory, you cannot use 32-bit OS image.
|
|
30525
|
+
* * **Network type**:
|
|
30526
|
+
* * Each instance that resides in a virtual private cloud (VPC) must be connected to only a single vSwitch.
|
|
30527
|
+
* * If `VSwitchId` is specified, the security group specified by `SecurityGroupId` and the vSwitch specified by `VSwitchId` must belong to the same VPC.
|
|
30528
|
+
* * The value of `PrivateIpAddress` varies based on the value of `VSwitchId`. `PrivateIpAddress` cannot be separately specified. If `VSwitchId` and `PrivateIpAddress` are specified, the IP address specified by `PrivateIpAddress` must be an idle IP address in the CIDR block of the specified vSwitch.
|
|
30529
|
+
* * **Public bandwidth**:
|
|
30530
|
+
* * Starting November 27, 2020, the maximum bandwidth value that is available for you to create ECS instances or change ECS instance configurations is subject to the throttling policy of your account. To increase the bandwidth limit, submit a ticket. The throttling policy imposes the following constraints: In a single region, the total maximum bandwidth value of all instances that use the pay-by-traffic billing method for network usage cannot exceed 5 Gbit/s and the total maximum bandwidth value of all instances that use the pay-by-bandwidth billing method for network usage cannot exceed 50 Gbit/s.
|
|
30531
|
+
* * If you call the `CreateInstance` operation to create an instance, no public IP addresses are assigned to the instance. You can call the [AllocatePublicIpAddress](~~25544~~) operation to assign a public IP address to an instance.
|
|
30532
|
+
* * Network usage fees vary based on the settings of `InternetChargeType` and `InternetMaxBandwidthOut`.
|
|
30533
|
+
* * The value of `InternetMaxBandwidthIn` does not affect billing because inbound data traffic is free of charge.
|
|
30534
|
+
* * If `InternetChargeType` is set to PayByBandwidth, `InternetMaxBandwidthOut` specifies the fixed bandwidth. A fixed bandwidth is a specified amount of public bandwidth allocated to an instance that uses the pay-by-bandwidth billing method for network usage.
|
|
30535
|
+
* * If `InternetChargeType` is set to PayByTraffic, `InternetMaxBandwidthOut` specifies the peak bandwidth. A peak bandwidth is the maximum amount of public bandwidth that an instance can consume when the instance uses the pay-by-traffic billing method for network usage. Network usage costs are calculated based on the volume of network traffic.
|
|
30536
|
+
* * **Security group**:
|
|
30537
|
+
* * If no security groups are available in the region where you want to create an instance, you must call the [CreateSecurityGroup](~~25553~~) operation to create a security group in that region first.
|
|
30538
|
+
* * The maximum number of instances that a security group can contain varies based on the security group type. For more information, see the "Security group limits" section in the [Limits](~~25412~~) topic.
|
|
30539
|
+
* * Instances in the same security group can communicate with each other over the internal network. By default, instances in different security groups cannot communicate with each other. You can allow communication between instances by allowing mutual access between the security groups to which the instances belong. For more information, see [AuthorizeSecurityGroup](~~25554~~) and [AuthorizeSecurityGroupEgress](~~25560~~).
|
|
30540
|
+
* * **Storage**:
|
|
30541
|
+
* * The instance is assigned a system disk whose capacity varies based on the size of the specified image. The size of the system disk must be at least `20 GiB` and greater than or equal to the image size. For information about system disk categories, see the description of `SystemDisk.Category`.
|
|
30542
|
+
* * The system disk of an I/O optimized instance can only be an enhanced SSD (ESSD) (`cloud_essd`), a standard SSD (`cloud_ssd`), or an ultra disk (`cloud_efficiency`).
|
|
30543
|
+
* * The maximum size of a data disk varies based on the disk category. For more information, see the description of `DataDisk.N.Size`.
|
|
30544
|
+
* * Up to 16 data disks can be added to an instance. Mount points /dev/xvd\\[b-z] are automatically assigned to data disks in ascending alphanumeric order.
|
|
30545
|
+
* > If the `QuotaExceed.DiskCapacity` error is returned when you call this operation, it indicates that the maximum capacity of the disks of the selected disk category in the specified zone has been reached. You can go to the [Quota Center](https://quotas.console.aliyun.com/products/disk/quotas) to query and request a quota increase.
|
|
30546
|
+
* * **User data**: If the instance type supports user data, you can use the UserData parameter to pass in user data.[](~~49121~~) User data is encoded in Base64. We recommend that you do not pass in confidential information (such as passwords or private keys) in plaintext as user data. This is because the system does not encrypt `UserData` values when API requests are transmitted. If you must pass in confidential information, we recommend that you encrypt and encode the information in Base64 before you pass in the information. Then decode and decrypt the information in the same way within the instance.
|
|
30547
|
+
* * **Others**: When you call API operations by using Alibaba Cloud CLI or SDKs, you must delete periods (.) from some request parameters before you use the parameters. For example, use `SystemDiskCategory` instead of `SystemDisk.Category` as a request parameter.
|
|
30058
30548
|
*
|
|
30059
30549
|
* @param request CreateInstanceRequest
|
|
30060
30550
|
* @return CreateInstanceResponse
|
|
@@ -30137,16 +30627,15 @@ export default class Client extends OpenApi {
|
|
|
30137
30627
|
*/
|
|
30138
30628
|
createNatGateway(request: CreateNatGatewayRequest): Promise<CreateNatGatewayResponse>;
|
|
30139
30629
|
/**
|
|
30140
|
-
* ## Usage notes
|
|
30630
|
+
* ## [](#)Usage notes
|
|
30141
30631
|
* Take note of the following items:
|
|
30142
|
-
* *
|
|
30632
|
+
* * This operation is a synchronous operation. After an ENI is created, it immediately enters the Available (`Available`) state and can be attached to an Elastic Compute Service (ECS) instance.
|
|
30143
30633
|
* * If NetworkInterfaceId is empty in the response, no ENI is created. Call the operation again to create an ENI.
|
|
30144
30634
|
* * An ENI can be attached only to a single instance that resides in a virtual private cloud (VPC).
|
|
30145
30635
|
* * When an ENI is detached from an instance and attached to another instance, the attributes of the ENI remain unchanged and network traffic is redirected to the new instance.
|
|
30146
|
-
* *
|
|
30147
|
-
* * If you want to assign IPv6 addresses when you create an ENI, make sure that IPv6 has been enabled for the vSwitch with which to associate the ENI. For more information, see [What is an IPv6 gateway?](~~98896~~)
|
|
30636
|
+
* * If you want to assign IPv6 addresses when you create an ENI, make sure that IPv6 is enabled for the vSwitch with which you want to associate the ENI. For more information, see [What is an IPv6 gateway?](~~98896~~)
|
|
30148
30637
|
* * A quota is imposed on the number of ENIs that can be created per Alibaba Cloud region per account. You can view the quota in the ECS console. For more information, see [View and increase resource quotas](~~184115~~).
|
|
30149
|
-
* **For information about examples on how to call this operation, see
|
|
30638
|
+
* **For information about examples on how to call this operation, see** [Create an ENI](~~471552~~).
|
|
30150
30639
|
*
|
|
30151
30640
|
* @param request CreateNetworkInterfaceRequest
|
|
30152
30641
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -30154,16 +30643,15 @@ export default class Client extends OpenApi {
|
|
|
30154
30643
|
*/
|
|
30155
30644
|
createNetworkInterfaceWithOptions(request: CreateNetworkInterfaceRequest, runtime: $Util.RuntimeOptions): Promise<CreateNetworkInterfaceResponse>;
|
|
30156
30645
|
/**
|
|
30157
|
-
* ## Usage notes
|
|
30646
|
+
* ## [](#)Usage notes
|
|
30158
30647
|
* Take note of the following items:
|
|
30159
|
-
* *
|
|
30648
|
+
* * This operation is a synchronous operation. After an ENI is created, it immediately enters the Available (`Available`) state and can be attached to an Elastic Compute Service (ECS) instance.
|
|
30160
30649
|
* * If NetworkInterfaceId is empty in the response, no ENI is created. Call the operation again to create an ENI.
|
|
30161
30650
|
* * An ENI can be attached only to a single instance that resides in a virtual private cloud (VPC).
|
|
30162
30651
|
* * When an ENI is detached from an instance and attached to another instance, the attributes of the ENI remain unchanged and network traffic is redirected to the new instance.
|
|
30163
|
-
* *
|
|
30164
|
-
* * If you want to assign IPv6 addresses when you create an ENI, make sure that IPv6 has been enabled for the vSwitch with which to associate the ENI. For more information, see [What is an IPv6 gateway?](~~98896~~)
|
|
30652
|
+
* * If you want to assign IPv6 addresses when you create an ENI, make sure that IPv6 is enabled for the vSwitch with which you want to associate the ENI. For more information, see [What is an IPv6 gateway?](~~98896~~)
|
|
30165
30653
|
* * A quota is imposed on the number of ENIs that can be created per Alibaba Cloud region per account. You can view the quota in the ECS console. For more information, see [View and increase resource quotas](~~184115~~).
|
|
30166
|
-
* **For information about examples on how to call this operation, see
|
|
30654
|
+
* **For information about examples on how to call this operation, see** [Create an ENI](~~471552~~).
|
|
30167
30655
|
*
|
|
30168
30656
|
* @param request CreateNetworkInterfaceRequest
|
|
30169
30657
|
* @return CreateNetworkInterfaceResponse
|
|
@@ -30187,7 +30675,13 @@ export default class Client extends OpenApi {
|
|
|
30187
30675
|
*/
|
|
30188
30676
|
createPhysicalConnection(request: CreatePhysicalConnectionRequest): Promise<CreatePhysicalConnectionResponse>;
|
|
30189
30677
|
/**
|
|
30190
|
-
*
|
|
30678
|
+
* * A prefix list is a collection of network prefixes (CIDR blocks) and can be referenced to configure network rules for other resources. For more information, see [Overview](~~206223~~).
|
|
30679
|
+
* * When you create a prefix list, take note of the following items:
|
|
30680
|
+
* * You must specify an IP address family (IPv4 or IPv6) for the prefix list, and cannot change the IP address family after the prefix list is created. You cannot combine IPv4 and IPv6 CIDR blocks in a single prefix list.
|
|
30681
|
+
* * You must specify the maximum number of entries that the prefix list can contain. You cannot modify the maximum number of entries after the prefix list is created.
|
|
30682
|
+
* * You can specify entries for the prefix list. Each entry consists of a CIDR block and the description for the CIDR block. The total number of entries cannot exceed the maximum number of entries that you specified.
|
|
30683
|
+
* * For more information about the limits on prefix lists and other resources, see [Limits](~~25412~~).
|
|
30684
|
+
* * You can create Resource Access Management (RAM) users and grant them minimum permissions. This eliminates the need to share the AccessKey pair of your Alibaba Cloud account with other users and reduces security risks for your enterprises. For information about how to grant permissions on prefix lists to RAM users, see [Grant a RAM user permissions on prefix lists](~~206175~~)
|
|
30191
30685
|
*
|
|
30192
30686
|
* @param request CreatePrefixListRequest
|
|
30193
30687
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -30195,7 +30689,13 @@ export default class Client extends OpenApi {
|
|
|
30195
30689
|
*/
|
|
30196
30690
|
createPrefixListWithOptions(request: CreatePrefixListRequest, runtime: $Util.RuntimeOptions): Promise<CreatePrefixListResponse>;
|
|
30197
30691
|
/**
|
|
30198
|
-
*
|
|
30692
|
+
* * A prefix list is a collection of network prefixes (CIDR blocks) and can be referenced to configure network rules for other resources. For more information, see [Overview](~~206223~~).
|
|
30693
|
+
* * When you create a prefix list, take note of the following items:
|
|
30694
|
+
* * You must specify an IP address family (IPv4 or IPv6) for the prefix list, and cannot change the IP address family after the prefix list is created. You cannot combine IPv4 and IPv6 CIDR blocks in a single prefix list.
|
|
30695
|
+
* * You must specify the maximum number of entries that the prefix list can contain. You cannot modify the maximum number of entries after the prefix list is created.
|
|
30696
|
+
* * You can specify entries for the prefix list. Each entry consists of a CIDR block and the description for the CIDR block. The total number of entries cannot exceed the maximum number of entries that you specified.
|
|
30697
|
+
* * For more information about the limits on prefix lists and other resources, see [Limits](~~25412~~).
|
|
30698
|
+
* * You can create Resource Access Management (RAM) users and grant them minimum permissions. This eliminates the need to share the AccessKey pair of your Alibaba Cloud account with other users and reduces security risks for your enterprises. For information about how to grant permissions on prefix lists to RAM users, see [Grant a RAM user permissions on prefix lists](~~206175~~)
|
|
30199
30699
|
*
|
|
30200
30700
|
* @param request CreatePrefixListRequest
|
|
30201
30701
|
* @return CreatePrefixListResponse
|
|
@@ -30278,7 +30778,20 @@ export default class Client extends OpenApi {
|
|
|
30278
30778
|
*/
|
|
30279
30779
|
createSimulatedSystemEvents(request: CreateSimulatedSystemEventsRequest): Promise<CreateSimulatedSystemEventsResponse>;
|
|
30280
30780
|
/**
|
|
30281
|
-
*
|
|
30781
|
+
* ## [](#)Usage notes
|
|
30782
|
+
* The local snapshot feature is replaced by the instant access feature. Take note of the following items:
|
|
30783
|
+
* * If you have used the local snapshot feature before December 14, 2020, you can use the Category parameter.
|
|
30784
|
+
* * If you have not used the local snapshot feature before December 14, 2020, new snapshots of your enhanced SSDs (ESSDs) at performance levels 0, 1, 2, and 3 (PL0, PL1, PL2, and PL3 ESSDs) and ESSD AutoPL disks are instantly available after creation without the need for additional configurations, regardless of whether the snapshots are manually or automatically created. The InstantAccess, InstantAccessRetentionDays, and DisableInstantAccess parameters in this operation that are related to the instant access feature no longer take effect. Available is added to the response parameters of the DescribeSnapshots and DescribeSnapshotGroup operations to indicate whether the snapshot is available.
|
|
30785
|
+
* In the following scenarios, you cannot create snapshots for a disk:
|
|
30786
|
+
* * The number of manual snapshots of the disk has reached 256.
|
|
30787
|
+
* * A snapshot is being created for the disk.
|
|
30788
|
+
* * The Elastic Compute Service (ECS) instance to which the disk is attached has never been started.
|
|
30789
|
+
* * The ECS instance to which the disk is attached is not in the **Stopped** (`Stopped`) or **Running** (`Running`) state.
|
|
30790
|
+
* * If the response contains `{"OperationLocks": {"LockReason" : "security"}}` when you query the information of the instance, the instance is locked for security reasons and all operations are prohibited on it.
|
|
30791
|
+
* When you create a snapshot, take note of the following items:
|
|
30792
|
+
* * If a snapshot is being created, you cannot use this snapshot to create a custom image by calling the [CreateImage](~~25535~~) operation.
|
|
30793
|
+
* * When a snapshot is being created for a disk that is attached to an ECS instance, do not change the instance state.
|
|
30794
|
+
* * You can create snapshots for a disk that is in the **Expired** (`Expired`) state. If the release time scheduled for a disk arrives while a snapshot is being created for the disk, the snapshot is in the **Creating** (`Creating` state and is deleted when the disk is released.
|
|
30282
30795
|
*
|
|
30283
30796
|
* @param request CreateSnapshotRequest
|
|
30284
30797
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -30286,23 +30799,37 @@ export default class Client extends OpenApi {
|
|
|
30286
30799
|
*/
|
|
30287
30800
|
createSnapshotWithOptions(request: CreateSnapshotRequest, runtime: $Util.RuntimeOptions): Promise<CreateSnapshotResponse>;
|
|
30288
30801
|
/**
|
|
30289
|
-
*
|
|
30802
|
+
* ## [](#)Usage notes
|
|
30803
|
+
* The local snapshot feature is replaced by the instant access feature. Take note of the following items:
|
|
30804
|
+
* * If you have used the local snapshot feature before December 14, 2020, you can use the Category parameter.
|
|
30805
|
+
* * If you have not used the local snapshot feature before December 14, 2020, new snapshots of your enhanced SSDs (ESSDs) at performance levels 0, 1, 2, and 3 (PL0, PL1, PL2, and PL3 ESSDs) and ESSD AutoPL disks are instantly available after creation without the need for additional configurations, regardless of whether the snapshots are manually or automatically created. The InstantAccess, InstantAccessRetentionDays, and DisableInstantAccess parameters in this operation that are related to the instant access feature no longer take effect. Available is added to the response parameters of the DescribeSnapshots and DescribeSnapshotGroup operations to indicate whether the snapshot is available.
|
|
30806
|
+
* In the following scenarios, you cannot create snapshots for a disk:
|
|
30807
|
+
* * The number of manual snapshots of the disk has reached 256.
|
|
30808
|
+
* * A snapshot is being created for the disk.
|
|
30809
|
+
* * The Elastic Compute Service (ECS) instance to which the disk is attached has never been started.
|
|
30810
|
+
* * The ECS instance to which the disk is attached is not in the **Stopped** (`Stopped`) or **Running** (`Running`) state.
|
|
30811
|
+
* * If the response contains `{"OperationLocks": {"LockReason" : "security"}}` when you query the information of the instance, the instance is locked for security reasons and all operations are prohibited on it.
|
|
30812
|
+
* When you create a snapshot, take note of the following items:
|
|
30813
|
+
* * If a snapshot is being created, you cannot use this snapshot to create a custom image by calling the [CreateImage](~~25535~~) operation.
|
|
30814
|
+
* * When a snapshot is being created for a disk that is attached to an ECS instance, do not change the instance state.
|
|
30815
|
+
* * You can create snapshots for a disk that is in the **Expired** (`Expired`) state. If the release time scheduled for a disk arrives while a snapshot is being created for the disk, the snapshot is in the **Creating** (`Creating` state and is deleted when the disk is released.
|
|
30290
30816
|
*
|
|
30291
30817
|
* @param request CreateSnapshotRequest
|
|
30292
30818
|
* @return CreateSnapshotResponse
|
|
30293
30819
|
*/
|
|
30294
30820
|
createSnapshot(request: CreateSnapshotRequest): Promise<CreateSnapshotResponse>;
|
|
30295
30821
|
/**
|
|
30296
|
-
*
|
|
30297
|
-
*
|
|
30298
|
-
*
|
|
30299
|
-
*
|
|
30300
|
-
*
|
|
30301
|
-
* * If
|
|
30302
|
-
*
|
|
30303
|
-
* *
|
|
30304
|
-
* *
|
|
30305
|
-
* *
|
|
30822
|
+
* ## [](#)Usage notes
|
|
30823
|
+
* You can specify `InstanceId` to create a snapshot-consistent group for disks on a specific (ECS instance. You can also specify `DiskId.N` to create a snapshot-consistent group for multiple disks on multiple ECS instances within the same zone.
|
|
30824
|
+
* > You cannot specify both `DiskId.N` and `ExcludeDiskId.N` in the same request. If `InstanceId` is specified, you can use `DiskId.N` to specify only disks on the ECS instance specified by InstanceId and cannot use DiskId.N to specify disks across ECS instances.
|
|
30825
|
+
* Take note of the following items:
|
|
30826
|
+
* * The disks for which you want to create a snapshot must be in the **In Use** (`In_use`) or **Unattached** (`Available`) state.
|
|
30827
|
+
* * If a disk is in the **In Use** (`In_use`) state, make sure that the ECS instance to which the disk is attached is in the **Running** (`Running`) or **Stopped** (`Stopped`) state.
|
|
30828
|
+
* * If a disk is in the **Unattached** (`Available`) state, make sure that the disk has been attached to ECS instances. Snapshots cannot be created for disks that have never been attached to an ECS instance.
|
|
30829
|
+
* * Snapshot-consistent groups can be used to create snapshots only for enhanced SSDs (ESSDs).
|
|
30830
|
+
* * A snapshot-consistent group can contain snapshots of up to 16 disks, including system disks and data disks, and cannot exceed 32 TiB in size.
|
|
30831
|
+
* * Snapshots that you created are stored indefinitely until you delete the snapshots. We recommend that you delete unnecessary snapshots on a regular basis to prevent excess snapshot storage fees.
|
|
30832
|
+
* * Snapshot-consistent groups cannot be created for disks for which multi-attach feature is enabled. If disks for which the multi-attach feature is enabled are attached to an ECS instance, specify the `ExcludeDiskId.N` parameter to exclude the disks.
|
|
30306
30833
|
* For more information about the snapshot-consistent group feature, see [Create a snapshot-consistent group](~~199625~~).
|
|
30307
30834
|
*
|
|
30308
30835
|
* @param request CreateSnapshotGroupRequest
|
|
@@ -30311,16 +30838,17 @@ export default class Client extends OpenApi {
|
|
|
30311
30838
|
*/
|
|
30312
30839
|
createSnapshotGroupWithOptions(request: CreateSnapshotGroupRequest, runtime: $Util.RuntimeOptions): Promise<CreateSnapshotGroupResponse>;
|
|
30313
30840
|
/**
|
|
30314
|
-
*
|
|
30315
|
-
*
|
|
30316
|
-
*
|
|
30317
|
-
*
|
|
30318
|
-
*
|
|
30319
|
-
* * If
|
|
30320
|
-
*
|
|
30321
|
-
* *
|
|
30322
|
-
* *
|
|
30323
|
-
* *
|
|
30841
|
+
* ## [](#)Usage notes
|
|
30842
|
+
* You can specify `InstanceId` to create a snapshot-consistent group for disks on a specific (ECS instance. You can also specify `DiskId.N` to create a snapshot-consistent group for multiple disks on multiple ECS instances within the same zone.
|
|
30843
|
+
* > You cannot specify both `DiskId.N` and `ExcludeDiskId.N` in the same request. If `InstanceId` is specified, you can use `DiskId.N` to specify only disks on the ECS instance specified by InstanceId and cannot use DiskId.N to specify disks across ECS instances.
|
|
30844
|
+
* Take note of the following items:
|
|
30845
|
+
* * The disks for which you want to create a snapshot must be in the **In Use** (`In_use`) or **Unattached** (`Available`) state.
|
|
30846
|
+
* * If a disk is in the **In Use** (`In_use`) state, make sure that the ECS instance to which the disk is attached is in the **Running** (`Running`) or **Stopped** (`Stopped`) state.
|
|
30847
|
+
* * If a disk is in the **Unattached** (`Available`) state, make sure that the disk has been attached to ECS instances. Snapshots cannot be created for disks that have never been attached to an ECS instance.
|
|
30848
|
+
* * Snapshot-consistent groups can be used to create snapshots only for enhanced SSDs (ESSDs).
|
|
30849
|
+
* * A snapshot-consistent group can contain snapshots of up to 16 disks, including system disks and data disks, and cannot exceed 32 TiB in size.
|
|
30850
|
+
* * Snapshots that you created are stored indefinitely until you delete the snapshots. We recommend that you delete unnecessary snapshots on a regular basis to prevent excess snapshot storage fees.
|
|
30851
|
+
* * Snapshot-consistent groups cannot be created for disks for which multi-attach feature is enabled. If disks for which the multi-attach feature is enabled are attached to an ECS instance, specify the `ExcludeDiskId.N` parameter to exclude the disks.
|
|
30324
30852
|
* For more information about the snapshot-consistent group feature, see [Create a snapshot-consistent group](~~199625~~).
|
|
30325
30853
|
*
|
|
30326
30854
|
* @param request CreateSnapshotGroupRequest
|
|
@@ -30572,14 +31100,15 @@ export default class Client extends OpenApi {
|
|
|
30572
31100
|
*/
|
|
30573
31101
|
deleteImagePipeline(request: DeleteImagePipelineRequest): Promise<DeleteImagePipelineResponse>;
|
|
30574
31102
|
/**
|
|
30575
|
-
*
|
|
30576
|
-
* *
|
|
30577
|
-
*
|
|
30578
|
-
* *
|
|
30579
|
-
* *
|
|
30580
|
-
* *
|
|
31103
|
+
* ## [](#)Usage notes
|
|
31104
|
+
* * After an ECS instance is released, all the physical resources used by the instance are recycled. Relevant data is erased and cannot be restored.
|
|
31105
|
+
* * When you release an ECS instance, take note of the following items for the disks attached to the instance:
|
|
31106
|
+
* * The disks for which `DeleteWithInstance` is set to false are retained as pay-as-you-go disks after the instance is released.
|
|
31107
|
+
* * The disks for which `DeleteWithInstance` is set to true are released along with the instance.
|
|
31108
|
+
* * For disks for which `DeleteAutoSnapshot` is set to false, the automatic snapshots of the disks are retained after the instance is released.
|
|
31109
|
+
* * For disks for which `DeleteAutoSnapshot` is set to true, the automatic snapshots of the disks are released along with the instance.
|
|
30581
31110
|
* * Manual snapshots of the disks are retained.
|
|
30582
|
-
* * If the response contains `
|
|
31111
|
+
* * If `OperationLocks` in the response contains `"LockReason" : "security"` when you query the information of the instance, the instance is locked for security reasons. In this case, even if `DeleteWithInstance` is set to `false` for the disks that are attached to the instance, the system ignores the DeleteWithInstance value and releases the disks along with the instance. For more information, see [API behavior when an instance is locked for security reasons](~~25695~~).
|
|
30583
31112
|
*
|
|
30584
31113
|
* @param request DeleteInstanceRequest
|
|
30585
31114
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -30587,14 +31116,15 @@ export default class Client extends OpenApi {
|
|
|
30587
31116
|
*/
|
|
30588
31117
|
deleteInstanceWithOptions(request: DeleteInstanceRequest, runtime: $Util.RuntimeOptions): Promise<DeleteInstanceResponse>;
|
|
30589
31118
|
/**
|
|
30590
|
-
*
|
|
30591
|
-
* *
|
|
30592
|
-
*
|
|
30593
|
-
* *
|
|
30594
|
-
* *
|
|
30595
|
-
* *
|
|
31119
|
+
* ## [](#)Usage notes
|
|
31120
|
+
* * After an ECS instance is released, all the physical resources used by the instance are recycled. Relevant data is erased and cannot be restored.
|
|
31121
|
+
* * When you release an ECS instance, take note of the following items for the disks attached to the instance:
|
|
31122
|
+
* * The disks for which `DeleteWithInstance` is set to false are retained as pay-as-you-go disks after the instance is released.
|
|
31123
|
+
* * The disks for which `DeleteWithInstance` is set to true are released along with the instance.
|
|
31124
|
+
* * For disks for which `DeleteAutoSnapshot` is set to false, the automatic snapshots of the disks are retained after the instance is released.
|
|
31125
|
+
* * For disks for which `DeleteAutoSnapshot` is set to true, the automatic snapshots of the disks are released along with the instance.
|
|
30596
31126
|
* * Manual snapshots of the disks are retained.
|
|
30597
|
-
* * If the response contains `
|
|
31127
|
+
* * If `OperationLocks` in the response contains `"LockReason" : "security"` when you query the information of the instance, the instance is locked for security reasons. In this case, even if `DeleteWithInstance` is set to `false` for the disks that are attached to the instance, the system ignores the DeleteWithInstance value and releases the disks along with the instance. For more information, see [API behavior when an instance is locked for security reasons](~~25695~~).
|
|
30598
31128
|
*
|
|
30599
31129
|
* @param request DeleteInstanceRequest
|
|
30600
31130
|
* @return DeleteInstanceResponse
|
|
@@ -30668,15 +31198,17 @@ export default class Client extends OpenApi {
|
|
|
30668
31198
|
*/
|
|
30669
31199
|
deleteNatGateway(request: DeleteNatGatewayRequest): Promise<DeleteNatGatewayResponse>;
|
|
30670
31200
|
/**
|
|
30671
|
-
*
|
|
30672
|
-
* * The ENI must be in the Available state.
|
|
30673
|
-
* * If the ENI is attached to an Elastic Compute Service (ECS) instance, you must
|
|
31201
|
+
* Take note of the following items:
|
|
31202
|
+
* * The ENI to be deleted must be in the Available state.
|
|
31203
|
+
* * If the ENI to be deleted is attached to an Elastic Compute Service (ECS) instance, you must detach the ENI from the instance before you can delete the ENI. To detach the ENI, you can call the [DetachNetworkInterface](~~58514~~) operation.
|
|
30674
31204
|
* * After an ENI is deleted, the following situations occur:
|
|
30675
|
-
* * All
|
|
30676
|
-
* * The ENI is automatically removed from
|
|
30677
|
-
* *
|
|
30678
|
-
*
|
|
30679
|
-
*
|
|
31205
|
+
* * All private IP addresses (including primary and secondary private IP addresses) of the ENI are automatically released.
|
|
31206
|
+
* * The ENI is automatically removed from all security groups.
|
|
31207
|
+
* * The DeleteNetworkInterface operation is an asynchronous operation. After this operation is called to delete an ENI, you can check the status or events of the ENI to determine whether the ENI is deleted. The following figure shows the transitions between the states of the ENI.
|
|
31208
|
+
* * If the ENI is in the Deleting state, the ENI deletion request is sent and the ENI is being deleted.
|
|
31209
|
+
* * If the ENI is not found, the ENI is deleted.
|
|
31210
|
+
* * If the ENI is stuck in the Deleting state, the ENI fails to be deleted. You can re-initiate the request to delete the ENI.
|
|
31211
|
+
* **For information about examples on how to call the DeleteNetworkInterface operation, see **[Delete an ENI](~~471553~~).
|
|
30680
31212
|
*
|
|
30681
31213
|
* @param request DeleteNetworkInterfaceRequest
|
|
30682
31214
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -30684,15 +31216,17 @@ export default class Client extends OpenApi {
|
|
|
30684
31216
|
*/
|
|
30685
31217
|
deleteNetworkInterfaceWithOptions(request: DeleteNetworkInterfaceRequest, runtime: $Util.RuntimeOptions): Promise<DeleteNetworkInterfaceResponse>;
|
|
30686
31218
|
/**
|
|
30687
|
-
*
|
|
30688
|
-
* * The ENI must be in the Available state.
|
|
30689
|
-
* * If the ENI is attached to an Elastic Compute Service (ECS) instance, you must
|
|
31219
|
+
* Take note of the following items:
|
|
31220
|
+
* * The ENI to be deleted must be in the Available state.
|
|
31221
|
+
* * If the ENI to be deleted is attached to an Elastic Compute Service (ECS) instance, you must detach the ENI from the instance before you can delete the ENI. To detach the ENI, you can call the [DetachNetworkInterface](~~58514~~) operation.
|
|
30690
31222
|
* * After an ENI is deleted, the following situations occur:
|
|
30691
|
-
* * All
|
|
30692
|
-
* * The ENI is automatically removed from
|
|
30693
|
-
* *
|
|
30694
|
-
*
|
|
30695
|
-
*
|
|
31223
|
+
* * All private IP addresses (including primary and secondary private IP addresses) of the ENI are automatically released.
|
|
31224
|
+
* * The ENI is automatically removed from all security groups.
|
|
31225
|
+
* * The DeleteNetworkInterface operation is an asynchronous operation. After this operation is called to delete an ENI, you can check the status or events of the ENI to determine whether the ENI is deleted. The following figure shows the transitions between the states of the ENI.
|
|
31226
|
+
* * If the ENI is in the Deleting state, the ENI deletion request is sent and the ENI is being deleted.
|
|
31227
|
+
* * If the ENI is not found, the ENI is deleted.
|
|
31228
|
+
* * If the ENI is stuck in the Deleting state, the ENI fails to be deleted. You can re-initiate the request to delete the ENI.
|
|
31229
|
+
* **For information about examples on how to call the DeleteNetworkInterface operation, see **[Delete an ENI](~~471553~~).
|
|
30696
31230
|
*
|
|
30697
31231
|
* @param request DeleteNetworkInterfaceRequest
|
|
30698
31232
|
* @return DeleteNetworkInterfaceResponse
|
|
@@ -30729,7 +31263,7 @@ export default class Client extends OpenApi {
|
|
|
30729
31263
|
*/
|
|
30730
31264
|
deletePhysicalConnection(request: DeletePhysicalConnectionRequest): Promise<DeletePhysicalConnectionResponse>;
|
|
30731
31265
|
/**
|
|
30732
|
-
*
|
|
31266
|
+
* If a prefix list is associated with resources, you cannot delete the prefix list. You must disassociate the prefix list from the resources before you delete the prefix list. You can call the [DescribePrefixListAssociations](~~204724~~) operation to query resources that are associated with a specific prefix list.
|
|
30733
31267
|
*
|
|
30734
31268
|
* @param request DeletePrefixListRequest
|
|
30735
31269
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -30737,7 +31271,7 @@ export default class Client extends OpenApi {
|
|
|
30737
31271
|
*/
|
|
30738
31272
|
deletePrefixListWithOptions(request: DeletePrefixListRequest, runtime: $Util.RuntimeOptions): Promise<DeletePrefixListResponse>;
|
|
30739
31273
|
/**
|
|
30740
|
-
*
|
|
31274
|
+
* If a prefix list is associated with resources, you cannot delete the prefix list. You must disassociate the prefix list from the resources before you delete the prefix list. You can call the [DescribePrefixListAssociations](~~204724~~) operation to query resources that are associated with a specific prefix list.
|
|
30741
31275
|
*
|
|
30742
31276
|
* @param request DeletePrefixListRequest
|
|
30743
31277
|
* @return DeletePrefixListResponse
|
|
@@ -30774,8 +31308,10 @@ export default class Client extends OpenApi {
|
|
|
30774
31308
|
*/
|
|
30775
31309
|
deleteRouterInterface(request: DeleteRouterInterfaceRequest): Promise<DeleteRouterInterfaceResponse>;
|
|
30776
31310
|
/**
|
|
30777
|
-
*
|
|
30778
|
-
*
|
|
31311
|
+
* ## [](#)Usage notes
|
|
31312
|
+
* Take note of the following items:
|
|
31313
|
+
* * Before you delete a security group, make sure that the security group does not contain instances and is not referenced by other security groups. Otherwise, the DeleteSecurityGroup request fails. You can call the [DescribeSecurityGroupReferences](~~57320~~) operation to query the reference details of the security group.
|
|
31314
|
+
* * If the InvalidOperation.DeletionProtection error code is returned when you call the DeleteSecurityGroup operation to delete a security group or if a deletion protection-related message appears when you delete a security group in the Elastic Compute Service (ECS) console, the deletion protection feature is enabled for the security group. When you create a Container Service for Kubernetes (ACK) cluster, the deletion protection feature is enabled for an associated security group to prevent accidental deletion. You cannot manually disable the deletion protection feature for the security group. The deletion protection feature can be automatically disabled only after the ACK cluster is deleted. For more information, see [Disable deletion protection for a security group](~~353191~~).
|
|
30779
31315
|
*
|
|
30780
31316
|
* @param request DeleteSecurityGroupRequest
|
|
30781
31317
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -30783,8 +31319,10 @@ export default class Client extends OpenApi {
|
|
|
30783
31319
|
*/
|
|
30784
31320
|
deleteSecurityGroupWithOptions(request: DeleteSecurityGroupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteSecurityGroupResponse>;
|
|
30785
31321
|
/**
|
|
30786
|
-
*
|
|
30787
|
-
*
|
|
31322
|
+
* ## [](#)Usage notes
|
|
31323
|
+
* Take note of the following items:
|
|
31324
|
+
* * Before you delete a security group, make sure that the security group does not contain instances and is not referenced by other security groups. Otherwise, the DeleteSecurityGroup request fails. You can call the [DescribeSecurityGroupReferences](~~57320~~) operation to query the reference details of the security group.
|
|
31325
|
+
* * If the InvalidOperation.DeletionProtection error code is returned when you call the DeleteSecurityGroup operation to delete a security group or if a deletion protection-related message appears when you delete a security group in the Elastic Compute Service (ECS) console, the deletion protection feature is enabled for the security group. When you create a Container Service for Kubernetes (ACK) cluster, the deletion protection feature is enabled for an associated security group to prevent accidental deletion. You cannot manually disable the deletion protection feature for the security group. The deletion protection feature can be automatically disabled only after the ACK cluster is deleted. For more information, see [Disable deletion protection for a security group](~~353191~~).
|
|
30788
31326
|
*
|
|
30789
31327
|
* @param request DeleteSecurityGroupRequest
|
|
30790
31328
|
* @return DeleteSecurityGroupResponse
|
|
@@ -30892,7 +31430,7 @@ export default class Client extends OpenApi {
|
|
|
30892
31430
|
describeAccessPoints(request: DescribeAccessPointsRequest): Promise<DescribeAccessPointsResponse>;
|
|
30893
31431
|
/**
|
|
30894
31432
|
* After you [create](https://account.alibabacloud.com/register/intl_register.htm) an Alibaba Cloud account, you can create a specific number of ECS instances in different regions within the account. For more information, see [Limits](~~25412~~).
|
|
30895
|
-
* You can apply for a quota increase in the [Quota Center console](https://
|
|
31433
|
+
* You can apply for a quota increase in the [Quota Center console](https://quotas.console.aliyun.com/products).
|
|
30896
31434
|
*
|
|
30897
31435
|
* @param request DescribeAccountAttributesRequest
|
|
30898
31436
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -30901,7 +31439,7 @@ export default class Client extends OpenApi {
|
|
|
30901
31439
|
describeAccountAttributesWithOptions(request: DescribeAccountAttributesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAccountAttributesResponse>;
|
|
30902
31440
|
/**
|
|
30903
31441
|
* After you [create](https://account.alibabacloud.com/register/intl_register.htm) an Alibaba Cloud account, you can create a specific number of ECS instances in different regions within the account. For more information, see [Limits](~~25412~~).
|
|
30904
|
-
* You can apply for a quota increase in the [Quota Center console](https://
|
|
31442
|
+
* You can apply for a quota increase in the [Quota Center console](https://quotas.console.aliyun.com/products).
|
|
30905
31443
|
*
|
|
30906
31444
|
* @param request DescribeAccountAttributesRequest
|
|
30907
31445
|
* @return DescribeAccountAttributesResponse
|
|
@@ -31005,6 +31543,8 @@ export default class Client extends OpenApi {
|
|
|
31005
31543
|
* @return DescribeClassicLinkInstancesResponse
|
|
31006
31544
|
*/
|
|
31007
31545
|
describeClassicLinkInstances(request: DescribeClassicLinkInstancesRequest): Promise<DescribeClassicLinkInstancesResponse>;
|
|
31546
|
+
describeCloudAssistantSettingsWithOptions(request: DescribeCloudAssistantSettingsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeCloudAssistantSettingsResponse>;
|
|
31547
|
+
describeCloudAssistantSettings(request: DescribeCloudAssistantSettingsRequest): Promise<DescribeCloudAssistantSettingsResponse>;
|
|
31008
31548
|
/**
|
|
31009
31549
|
* - Before you run commands on or send files to instances, especially new instances, we recommend that you query the status of Cloud Assistant on the instances by calling this operation and checking the return value of CloudAssistantStatus. Run commands on or send files to the instances only when the return value is true.
|
|
31010
31550
|
* - You can use one of the following methods to check the responses:
|
|
@@ -31149,13 +31689,14 @@ export default class Client extends OpenApi {
|
|
|
31149
31689
|
describeDiagnosticReportsWithOptions(request: DescribeDiagnosticReportsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDiagnosticReportsResponse>;
|
|
31150
31690
|
describeDiagnosticReports(request: DescribeDiagnosticReportsRequest): Promise<DescribeDiagnosticReportsResponse>;
|
|
31151
31691
|
/**
|
|
31152
|
-
*
|
|
31153
|
-
*
|
|
31154
|
-
*
|
|
31692
|
+
* ## [](#)Usage notes
|
|
31693
|
+
* You can query the following monitoring data of a disk: the read IOPS, write IOPS, read bandwidth (byte/s), write bandwidth (byte/s), read latency (microseconds), and write latency (microseconds).
|
|
31694
|
+
* Take note of the following items:
|
|
31695
|
+
* * You can query the monitoring data only of the disks that are in the In Use (`In_Use`) state. For more information, see [Disk states](~~25689~~).
|
|
31155
31696
|
* **
|
|
31156
|
-
* **Note**Some information may be missing from the monitoring data of a disk because the disk is not in the In Use (`In_Use`) state and the system cannot obtain the relevant information.
|
|
31157
|
-
* *
|
|
31158
|
-
* * You can query the monitoring data in
|
|
31697
|
+
* **Note** Some information may be missing from the monitoring data of a disk because the disk is not in the In Use (`In_Use`) state and the system cannot obtain the relevant information.
|
|
31698
|
+
* * Up to 400 monitoring data entries can be returned at a time. Make sure that the `TotalCount` value does not exceed 400. The value is calculated by using the following formula: `TotalCount = (EndTime - StartTime)/Period`. If the TotalCount value is greater than 400, the `InvalidParameter.TooManyDataQueried` error is returned.
|
|
31699
|
+
* * You can query the monitoring data in the last 30 days. If the value of `StartTime` is more than 30 days earlier than the current time, an error is returned.
|
|
31159
31700
|
*
|
|
31160
31701
|
* @param request DescribeDiskMonitorDataRequest
|
|
31161
31702
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -31163,27 +31704,29 @@ export default class Client extends OpenApi {
|
|
|
31163
31704
|
*/
|
|
31164
31705
|
describeDiskMonitorDataWithOptions(request: DescribeDiskMonitorDataRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDiskMonitorDataResponse>;
|
|
31165
31706
|
/**
|
|
31166
|
-
*
|
|
31167
|
-
*
|
|
31168
|
-
*
|
|
31707
|
+
* ## [](#)Usage notes
|
|
31708
|
+
* You can query the following monitoring data of a disk: the read IOPS, write IOPS, read bandwidth (byte/s), write bandwidth (byte/s), read latency (microseconds), and write latency (microseconds).
|
|
31709
|
+
* Take note of the following items:
|
|
31710
|
+
* * You can query the monitoring data only of the disks that are in the In Use (`In_Use`) state. For more information, see [Disk states](~~25689~~).
|
|
31169
31711
|
* **
|
|
31170
|
-
* **Note**Some information may be missing from the monitoring data of a disk because the disk is not in the In Use (`In_Use`) state and the system cannot obtain the relevant information.
|
|
31171
|
-
* *
|
|
31172
|
-
* * You can query the monitoring data in
|
|
31712
|
+
* **Note** Some information may be missing from the monitoring data of a disk because the disk is not in the In Use (`In_Use`) state and the system cannot obtain the relevant information.
|
|
31713
|
+
* * Up to 400 monitoring data entries can be returned at a time. Make sure that the `TotalCount` value does not exceed 400. The value is calculated by using the following formula: `TotalCount = (EndTime - StartTime)/Period`. If the TotalCount value is greater than 400, the `InvalidParameter.TooManyDataQueried` error is returned.
|
|
31714
|
+
* * You can query the monitoring data in the last 30 days. If the value of `StartTime` is more than 30 days earlier than the current time, an error is returned.
|
|
31173
31715
|
*
|
|
31174
31716
|
* @param request DescribeDiskMonitorDataRequest
|
|
31175
31717
|
* @return DescribeDiskMonitorDataResponse
|
|
31176
31718
|
*/
|
|
31177
31719
|
describeDiskMonitorData(request: DescribeDiskMonitorDataRequest): Promise<DescribeDiskMonitorDataResponse>;
|
|
31178
31720
|
/**
|
|
31179
|
-
*
|
|
31180
|
-
* *
|
|
31721
|
+
* ### [](#)Usage notes
|
|
31722
|
+
* * You can specify multiple request parameters such as `RegionId`, `ZoneId`, `DiskIds`, and `InstanceId` as filters. The specified parameters are evaluated by using the "AND" operator. If you specify more than one filter, the records that match all filters are returned.
|
|
31723
|
+
* * The value of `DiskIds` is a JSON array. If you do not specify DiskIds, the parameter is not used as a filter condition. If you set `DiskIds` to an empty JSON array, the parameter is regarded as a valid filter, and an empty result is returned.
|
|
31181
31724
|
* * You can use one of the following methods to check the responses:
|
|
31182
|
-
* * Method 1: Use `NextToken` to
|
|
31183
|
-
* * Method 2: Use `PageSize` to specify the number of entries to return on each page and then use `PageNumber` to specify the page
|
|
31184
|
-
* You can use only one of the preceding methods. If
|
|
31185
|
-
* *
|
|
31186
|
-
* When you call an API operation by using Alibaba Cloud CLI, you must specify
|
|
31725
|
+
* * Method 1: Use `NextToken` to specify the pagination token. Set the value to the `NextToken` value that is obtained from the previous query. Then, use `MaxResults` to specify the maximum number of entries to return on each page.
|
|
31726
|
+
* * Method 2: Use `PageSize` to specify the number of entries to return on each page, and then use `PageNumber` to specify the number of the page to return.
|
|
31727
|
+
* You can use only one of the preceding methods. If a large number of entries are to be returned, we recommend that you use Method 1. If `NextToken` is specified, `PageSize` and `PageNumber` do not take effect and `TotalCount` in the response is invalid.
|
|
31728
|
+
* * You can attach a disk for which the multi-attach feature is enabled to multiple instances. You can query the attachment information of the disk based on the `Attachment` values in the response.
|
|
31729
|
+
* When you call an API operation by using Alibaba Cloud CLI, you must specify request parameter values of different data types in the required formats. For more information, see [Parameter format overview](~~110340~~).
|
|
31187
31730
|
*
|
|
31188
31731
|
* @param request DescribeDisksRequest
|
|
31189
31732
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -31191,14 +31734,15 @@ export default class Client extends OpenApi {
|
|
|
31191
31734
|
*/
|
|
31192
31735
|
describeDisksWithOptions(request: DescribeDisksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDisksResponse>;
|
|
31193
31736
|
/**
|
|
31194
|
-
*
|
|
31195
|
-
* *
|
|
31737
|
+
* ### [](#)Usage notes
|
|
31738
|
+
* * You can specify multiple request parameters such as `RegionId`, `ZoneId`, `DiskIds`, and `InstanceId` as filters. The specified parameters are evaluated by using the "AND" operator. If you specify more than one filter, the records that match all filters are returned.
|
|
31739
|
+
* * The value of `DiskIds` is a JSON array. If you do not specify DiskIds, the parameter is not used as a filter condition. If you set `DiskIds` to an empty JSON array, the parameter is regarded as a valid filter, and an empty result is returned.
|
|
31196
31740
|
* * You can use one of the following methods to check the responses:
|
|
31197
|
-
* * Method 1: Use `NextToken` to
|
|
31198
|
-
* * Method 2: Use `PageSize` to specify the number of entries to return on each page and then use `PageNumber` to specify the page
|
|
31199
|
-
* You can use only one of the preceding methods. If
|
|
31200
|
-
* *
|
|
31201
|
-
* When you call an API operation by using Alibaba Cloud CLI, you must specify
|
|
31741
|
+
* * Method 1: Use `NextToken` to specify the pagination token. Set the value to the `NextToken` value that is obtained from the previous query. Then, use `MaxResults` to specify the maximum number of entries to return on each page.
|
|
31742
|
+
* * Method 2: Use `PageSize` to specify the number of entries to return on each page, and then use `PageNumber` to specify the number of the page to return.
|
|
31743
|
+
* You can use only one of the preceding methods. If a large number of entries are to be returned, we recommend that you use Method 1. If `NextToken` is specified, `PageSize` and `PageNumber` do not take effect and `TotalCount` in the response is invalid.
|
|
31744
|
+
* * You can attach a disk for which the multi-attach feature is enabled to multiple instances. You can query the attachment information of the disk based on the `Attachment` values in the response.
|
|
31745
|
+
* When you call an API operation by using Alibaba Cloud CLI, you must specify request parameter values of different data types in the required formats. For more information, see [Parameter format overview](~~110340~~).
|
|
31202
31746
|
*
|
|
31203
31747
|
* @param request DescribeDisksRequest
|
|
31204
31748
|
* @return DescribeDisksResponse
|
|
@@ -31269,9 +31813,10 @@ export default class Client extends OpenApi {
|
|
|
31269
31813
|
describeElasticityAssurancesWithOptions(request: DescribeElasticityAssurancesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeElasticityAssurancesResponse>;
|
|
31270
31814
|
describeElasticityAssurances(request: DescribeElasticityAssurancesRequest): Promise<DescribeElasticityAssurancesResponse>;
|
|
31271
31815
|
/**
|
|
31272
|
-
*
|
|
31273
|
-
*
|
|
31274
|
-
* *
|
|
31816
|
+
* ## [](#)Usage notes
|
|
31817
|
+
* The monitoring data of a secondary ENI includes the amount of traffic sent and received over the internal network, the number of packets sent and received by the secondary ENI, and the number of sent and received packets that are dropped by the secondary ENI. Specific information may be missing from the returned monitoring data. This may be because the system cannot obtain the relevant information. For example, if the instance to which the secondary ENI is attached is in the Stopped state or if the secondary ENI is not attached to an instance and is in the Available state, the monitoring data of the secondary ENI cannot be obtained. Take note of the following items:
|
|
31818
|
+
* * Up to 400 monitoring data entries can be returned at a time. Make sure that the `TotalCount` value does not exceed 400. The value is calculated by using the following formula: `TotalCount = (EndTime - StartTime)/Period`. If the TotalCount value is greater than 400, the `InvalidParameter.TooManyDataQueried` error is returned.
|
|
31819
|
+
* * You can query the monitoring data in the last 30 days. If the value of `StartTime` is more than 30 days earlier than the current time, an error is returned.
|
|
31275
31820
|
*
|
|
31276
31821
|
* @param request DescribeEniMonitorDataRequest
|
|
31277
31822
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -31279,9 +31824,10 @@ export default class Client extends OpenApi {
|
|
|
31279
31824
|
*/
|
|
31280
31825
|
describeEniMonitorDataWithOptions(request: DescribeEniMonitorDataRequest, runtime: $Util.RuntimeOptions): Promise<DescribeEniMonitorDataResponse>;
|
|
31281
31826
|
/**
|
|
31282
|
-
*
|
|
31283
|
-
*
|
|
31284
|
-
* *
|
|
31827
|
+
* ## [](#)Usage notes
|
|
31828
|
+
* The monitoring data of a secondary ENI includes the amount of traffic sent and received over the internal network, the number of packets sent and received by the secondary ENI, and the number of sent and received packets that are dropped by the secondary ENI. Specific information may be missing from the returned monitoring data. This may be because the system cannot obtain the relevant information. For example, if the instance to which the secondary ENI is attached is in the Stopped state or if the secondary ENI is not attached to an instance and is in the Available state, the monitoring data of the secondary ENI cannot be obtained. Take note of the following items:
|
|
31829
|
+
* * Up to 400 monitoring data entries can be returned at a time. Make sure that the `TotalCount` value does not exceed 400. The value is calculated by using the following formula: `TotalCount = (EndTime - StartTime)/Period`. If the TotalCount value is greater than 400, the `InvalidParameter.TooManyDataQueried` error is returned.
|
|
31830
|
+
* * You can query the monitoring data in the last 30 days. If the value of `StartTime` is more than 30 days earlier than the current time, an error is returned.
|
|
31285
31831
|
*
|
|
31286
31832
|
* @param request DescribeEniMonitorDataRequest
|
|
31287
31833
|
* @return DescribeEniMonitorDataResponse
|
|
@@ -31394,9 +31940,11 @@ export default class Client extends OpenApi {
|
|
|
31394
31940
|
describeImageSupportInstanceTypesWithOptions(request: DescribeImageSupportInstanceTypesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeImageSupportInstanceTypesResponse>;
|
|
31395
31941
|
describeImageSupportInstanceTypes(request: DescribeImageSupportInstanceTypesRequest): Promise<DescribeImageSupportInstanceTypesResponse>;
|
|
31396
31942
|
/**
|
|
31943
|
+
* ## [](#)Usage notes
|
|
31397
31944
|
* * You can query your custom images, public images provided by Alibaba Cloud, Alibaba Cloud Marketplace images, and shared images from other Alibaba Cloud accounts.
|
|
31398
|
-
* * This
|
|
31399
|
-
* * When you call an API operation by using Alibaba Cloud CLI, you must specify
|
|
31945
|
+
* * This is a paginated query. The response contains the total number of available images and the images on the returned page. By default,10 entries are displayed on each page.
|
|
31946
|
+
* * When you call an API operation by using Alibaba Cloud CLI, you must specify request parameter values of different data types in the required formats. For more information, see [Parameter formats](~~110340~~).
|
|
31947
|
+
* * If you set ImageOwnerAlias to system or others when you call the DescribeImages operation to query public images that are provided by Alibaba Cloud or shared images, Resource Access Management (RAM) policies are ignored in the request. For more information, see [RAM authorization](~~25497~~).
|
|
31400
31948
|
*
|
|
31401
31949
|
* @param request DescribeImagesRequest
|
|
31402
31950
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -31404,9 +31952,11 @@ export default class Client extends OpenApi {
|
|
|
31404
31952
|
*/
|
|
31405
31953
|
describeImagesWithOptions(request: DescribeImagesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeImagesResponse>;
|
|
31406
31954
|
/**
|
|
31955
|
+
* ## [](#)Usage notes
|
|
31407
31956
|
* * You can query your custom images, public images provided by Alibaba Cloud, Alibaba Cloud Marketplace images, and shared images from other Alibaba Cloud accounts.
|
|
31408
|
-
* * This
|
|
31409
|
-
* * When you call an API operation by using Alibaba Cloud CLI, you must specify
|
|
31957
|
+
* * This is a paginated query. The response contains the total number of available images and the images on the returned page. By default,10 entries are displayed on each page.
|
|
31958
|
+
* * When you call an API operation by using Alibaba Cloud CLI, you must specify request parameter values of different data types in the required formats. For more information, see [Parameter formats](~~110340~~).
|
|
31959
|
+
* * If you set ImageOwnerAlias to system or others when you call the DescribeImages operation to query public images that are provided by Alibaba Cloud or shared images, Resource Access Management (RAM) policies are ignored in the request. For more information, see [RAM authorization](~~25497~~).
|
|
31410
31960
|
*
|
|
31411
31961
|
* @param request DescribeImagesRequest
|
|
31412
31962
|
* @return DescribeImagesResponse
|
|
@@ -31504,10 +32054,12 @@ export default class Client extends OpenApi {
|
|
|
31504
32054
|
*/
|
|
31505
32055
|
describeInstanceModificationPrice(request: DescribeInstanceModificationPriceRequest): Promise<DescribeInstanceModificationPriceResponse>;
|
|
31506
32056
|
/**
|
|
32057
|
+
* ## [](#)Usage notes
|
|
31507
32058
|
* Take note of the following items:
|
|
31508
|
-
* * Up to 400 monitoring data entries can be returned at a time.
|
|
31509
|
-
* * You can query the monitoring data
|
|
31510
|
-
* * In some scenarios, such as when the instance is in the Stopped state, the system cannot obtain the relevant information and
|
|
32059
|
+
* * Up to 400 monitoring data entries can be returned at a time. Make sure that the `TotalCount` value does not exceed 400. The value is calculated by using the following formula: `TotalCount = (EndTime - StartTime)/Period`. If the TotalCount value is greater than 400, the `InvalidParameter.TooManyDataQueried` error is returned.
|
|
32060
|
+
* * You can query the monitoring data in the last 30 days. If the value of `StartTime` is more than 30 days earlier than the current time, an error is returned.
|
|
32061
|
+
* * In some scenarios, such as when the instance is in the Stopped state, the system cannot obtain the relevant information and specific information may be missing from the returned monitoring data.
|
|
32062
|
+
* * You cannot call this operation to obtain the CPU basic monitoring information of an ECS bare metal instance. To obtain the CPU monitoring information of an ECS bare metal instance, install the CloudMonitor agent on the instance. For more information, see [InstallCloudMonitor](~~183482~~).
|
|
31511
32063
|
*
|
|
31512
32064
|
* @param request DescribeInstanceMonitorDataRequest
|
|
31513
32065
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -31515,10 +32067,12 @@ export default class Client extends OpenApi {
|
|
|
31515
32067
|
*/
|
|
31516
32068
|
describeInstanceMonitorDataWithOptions(request: DescribeInstanceMonitorDataRequest, runtime: $Util.RuntimeOptions): Promise<DescribeInstanceMonitorDataResponse>;
|
|
31517
32069
|
/**
|
|
32070
|
+
* ## [](#)Usage notes
|
|
31518
32071
|
* Take note of the following items:
|
|
31519
|
-
* * Up to 400 monitoring data entries can be returned at a time.
|
|
31520
|
-
* * You can query the monitoring data
|
|
31521
|
-
* * In some scenarios, such as when the instance is in the Stopped state, the system cannot obtain the relevant information and
|
|
32072
|
+
* * Up to 400 monitoring data entries can be returned at a time. Make sure that the `TotalCount` value does not exceed 400. The value is calculated by using the following formula: `TotalCount = (EndTime - StartTime)/Period`. If the TotalCount value is greater than 400, the `InvalidParameter.TooManyDataQueried` error is returned.
|
|
32073
|
+
* * You can query the monitoring data in the last 30 days. If the value of `StartTime` is more than 30 days earlier than the current time, an error is returned.
|
|
32074
|
+
* * In some scenarios, such as when the instance is in the Stopped state, the system cannot obtain the relevant information and specific information may be missing from the returned monitoring data.
|
|
32075
|
+
* * You cannot call this operation to obtain the CPU basic monitoring information of an ECS bare metal instance. To obtain the CPU monitoring information of an ECS bare metal instance, install the CloudMonitor agent on the instance. For more information, see [InstallCloudMonitor](~~183482~~).
|
|
31522
32076
|
*
|
|
31523
32077
|
* @param request DescribeInstanceMonitorDataRequest
|
|
31524
32078
|
* @return DescribeInstanceMonitorDataResponse
|
|
@@ -31601,26 +32155,17 @@ export default class Client extends OpenApi {
|
|
|
31601
32155
|
*/
|
|
31602
32156
|
describeInstanceTypes(request: DescribeInstanceTypesRequest): Promise<DescribeInstanceTypesResponse>;
|
|
31603
32157
|
/**
|
|
31604
|
-
* ##
|
|
31605
|
-
*
|
|
31606
|
-
* * The
|
|
31607
|
-
* *
|
|
31608
|
-
* *
|
|
31609
|
-
*
|
|
31610
|
-
* * `
|
|
31611
|
-
* * `
|
|
31612
|
-
*
|
|
31613
|
-
*
|
|
31614
|
-
*
|
|
31615
|
-
* ```
|
|
31616
|
-
* https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true
|
|
31617
|
-
*
|
|
31618
|
-
* ```
|
|
31619
|
-
* Or:
|
|
31620
|
-
* ```
|
|
31621
|
-
* https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true&password=****
|
|
31622
|
-
*
|
|
31623
|
-
* ```
|
|
32158
|
+
* ## [](#)Usage notes
|
|
32159
|
+
* Take note of the following items:
|
|
32160
|
+
* * The **keepalive** time of a connection to a VNC management terminal is 300 seconds. If you do not interact with the VNC management terminal for 300 seconds, the VNC management terminal is automatically disconnected.
|
|
32161
|
+
* * If the connection is interrupted, you must recall this operation to obtain a new logon address that is specified by `VncUrl` and use the new logon address to construct a URL that can be used to reconnect to the VNC management terminal. You can reconnect to a VNC management terminal for a maximum of 30 times per minute.
|
|
32162
|
+
* * You need to add the `vncUrl=\\*\\*\\*\\*`, `instanceId=\\*\\*\\*\\*`, and `isWindows=true/false` parameters to the end of the link `https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?` and use an ampersand (`&`) between the parameters.
|
|
32163
|
+
* * `vncUrl`: the value of `VncUrl` that is returned after a successful call of this operation.
|
|
32164
|
+
* * `instanceId`: the ID of your instance.
|
|
32165
|
+
* * `isWindows`: specifies whether the operating system of your instance is Windows. A value of `true` indicates that the operating system is Windows. A value of `false` indicates that the operating system is not Windows.
|
|
32166
|
+
* > You can connect to an instance without a VNC logon password. Therefore, you do not need to configure the `password` parameter.
|
|
32167
|
+
* Sample URL:
|
|
32168
|
+
* https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true
|
|
31624
32169
|
*
|
|
31625
32170
|
* @param request DescribeInstanceVncUrlRequest
|
|
31626
32171
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -31628,26 +32173,17 @@ export default class Client extends OpenApi {
|
|
|
31628
32173
|
*/
|
|
31629
32174
|
describeInstanceVncUrlWithOptions(request: DescribeInstanceVncUrlRequest, runtime: $Util.RuntimeOptions): Promise<DescribeInstanceVncUrlResponse>;
|
|
31630
32175
|
/**
|
|
31631
|
-
* ##
|
|
31632
|
-
*
|
|
31633
|
-
* * The
|
|
31634
|
-
* *
|
|
31635
|
-
* *
|
|
31636
|
-
*
|
|
31637
|
-
* * `
|
|
31638
|
-
* * `
|
|
31639
|
-
*
|
|
31640
|
-
*
|
|
31641
|
-
*
|
|
31642
|
-
* ```
|
|
31643
|
-
* https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true
|
|
31644
|
-
*
|
|
31645
|
-
* ```
|
|
31646
|
-
* Or:
|
|
31647
|
-
* ```
|
|
31648
|
-
* https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true&password=****
|
|
31649
|
-
*
|
|
31650
|
-
* ```
|
|
32176
|
+
* ## [](#)Usage notes
|
|
32177
|
+
* Take note of the following items:
|
|
32178
|
+
* * The **keepalive** time of a connection to a VNC management terminal is 300 seconds. If you do not interact with the VNC management terminal for 300 seconds, the VNC management terminal is automatically disconnected.
|
|
32179
|
+
* * If the connection is interrupted, you must recall this operation to obtain a new logon address that is specified by `VncUrl` and use the new logon address to construct a URL that can be used to reconnect to the VNC management terminal. You can reconnect to a VNC management terminal for a maximum of 30 times per minute.
|
|
32180
|
+
* * You need to add the `vncUrl=\\*\\*\\*\\*`, `instanceId=\\*\\*\\*\\*`, and `isWindows=true/false` parameters to the end of the link `https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?` and use an ampersand (`&`) between the parameters.
|
|
32181
|
+
* * `vncUrl`: the value of `VncUrl` that is returned after a successful call of this operation.
|
|
32182
|
+
* * `instanceId`: the ID of your instance.
|
|
32183
|
+
* * `isWindows`: specifies whether the operating system of your instance is Windows. A value of `true` indicates that the operating system is Windows. A value of `false` indicates that the operating system is not Windows.
|
|
32184
|
+
* > You can connect to an instance without a VNC logon password. Therefore, you do not need to configure the `password` parameter.
|
|
32185
|
+
* Sample URL:
|
|
32186
|
+
* https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true
|
|
31651
32187
|
*
|
|
31652
32188
|
* @param request DescribeInstanceVncUrlRequest
|
|
31653
32189
|
* @return DescribeInstanceVncUrlResponse
|
|
@@ -31829,7 +32365,9 @@ export default class Client extends OpenApi {
|
|
|
31829
32365
|
describeNetworkInterfacePermissionsWithOptions(request: DescribeNetworkInterfacePermissionsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeNetworkInterfacePermissionsResponse>;
|
|
31830
32366
|
describeNetworkInterfacePermissions(request: DescribeNetworkInterfacePermissionsRequest): Promise<DescribeNetworkInterfacePermissionsResponse>;
|
|
31831
32367
|
/**
|
|
31832
|
-
*
|
|
32368
|
+
* ## [](#)Usage notes
|
|
32369
|
+
* The `DescribeNetworkInterfaces` operation supports paged queries. During a paged query, when you call the DescribeNetworkInterfaces operation to retrieve the first page of results, set `MaxResults` to specify the maximum number of entries to return in the call. The return value of `NextToken` is a pagination token that can be used in the next call to retrieve a new page of results. When you call the DescribeNetworkInterfaces operation to retrieve a new page of results, set `NextToken` to the `NextToken` value returned in the previous call and set `MaxResults` to specify the maximum number of entries to return in this call.
|
|
32370
|
+
* > If you specify `MaxResults` or `NextToken`, the system uses the preceding paged query method to return results. Otherwise, the system returns results based on the combination of `PageNumber` and `PageSize`.
|
|
31833
32371
|
*
|
|
31834
32372
|
* @param request DescribeNetworkInterfacesRequest
|
|
31835
32373
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -31837,7 +32375,9 @@ export default class Client extends OpenApi {
|
|
|
31837
32375
|
*/
|
|
31838
32376
|
describeNetworkInterfacesWithOptions(request: DescribeNetworkInterfacesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeNetworkInterfacesResponse>;
|
|
31839
32377
|
/**
|
|
31840
|
-
*
|
|
32378
|
+
* ## [](#)Usage notes
|
|
32379
|
+
* The `DescribeNetworkInterfaces` operation supports paged queries. During a paged query, when you call the DescribeNetworkInterfaces operation to retrieve the first page of results, set `MaxResults` to specify the maximum number of entries to return in the call. The return value of `NextToken` is a pagination token that can be used in the next call to retrieve a new page of results. When you call the DescribeNetworkInterfaces operation to retrieve a new page of results, set `NextToken` to the `NextToken` value returned in the previous call and set `MaxResults` to specify the maximum number of entries to return in this call.
|
|
32380
|
+
* > If you specify `MaxResults` or `NextToken`, the system uses the preceding paged query method to return results. Otherwise, the system returns results based on the combination of `PageNumber` and `PageSize`.
|
|
31841
32381
|
*
|
|
31842
32382
|
* @param request DescribeNetworkInterfacesRequest
|
|
31843
32383
|
* @return DescribeNetworkInterfacesResponse
|
|
@@ -32044,10 +32584,11 @@ export default class Client extends OpenApi {
|
|
|
32044
32584
|
*/
|
|
32045
32585
|
describeSecurityGroupReferences(request: DescribeSecurityGroupReferencesRequest): Promise<DescribeSecurityGroupReferencesResponse>;
|
|
32046
32586
|
/**
|
|
32587
|
+
* ## [](#)Usage notes
|
|
32047
32588
|
* Take note of the following items:
|
|
32048
|
-
* * The basic information about security groups includes their IDs and descriptions. The response returns security groups
|
|
32049
|
-
* * We recommend that you use
|
|
32050
|
-
* * When you use Alibaba Cloud CLI to call an API operation, you must specify
|
|
32589
|
+
* * The basic information about security groups includes their IDs and descriptions. The response returns security groups in descending order of the IDs of the security groups.
|
|
32590
|
+
* * We recommend that you use `MaxResults` and `NextToken` for a paged query. We recommend that you use `MaxResults` to specify the maximum number of entries to return for each request. The return value of `NextToken` is a pagination token, which can be used in the next request to retrieve a new page of results. When you call the DescribeSecurityGroups operation to retrieve a new page of results, set `NextToken` to the `NextToken` value that is returned in the previous call and set `MaxResults` to specify the maximum number of entries to return in this call. If the return value of `NextToken` is empty, the current page of results is the last page and no more results are to be returned.
|
|
32591
|
+
* * When you use Alibaba Cloud CLI to call an API operation, you must specify request parameter values of different data types in required formats. For more information, see [Parameter format overview](~~110340~~).
|
|
32051
32592
|
*
|
|
32052
32593
|
* @param request DescribeSecurityGroupsRequest
|
|
32053
32594
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -32055,10 +32596,11 @@ export default class Client extends OpenApi {
|
|
|
32055
32596
|
*/
|
|
32056
32597
|
describeSecurityGroupsWithOptions(request: DescribeSecurityGroupsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeSecurityGroupsResponse>;
|
|
32057
32598
|
/**
|
|
32599
|
+
* ## [](#)Usage notes
|
|
32058
32600
|
* Take note of the following items:
|
|
32059
|
-
* * The basic information about security groups includes their IDs and descriptions. The response returns security groups
|
|
32060
|
-
* * We recommend that you use
|
|
32061
|
-
* * When you use Alibaba Cloud CLI to call an API operation, you must specify
|
|
32601
|
+
* * The basic information about security groups includes their IDs and descriptions. The response returns security groups in descending order of the IDs of the security groups.
|
|
32602
|
+
* * We recommend that you use `MaxResults` and `NextToken` for a paged query. We recommend that you use `MaxResults` to specify the maximum number of entries to return for each request. The return value of `NextToken` is a pagination token, which can be used in the next request to retrieve a new page of results. When you call the DescribeSecurityGroups operation to retrieve a new page of results, set `NextToken` to the `NextToken` value that is returned in the previous call and set `MaxResults` to specify the maximum number of entries to return in this call. If the return value of `NextToken` is empty, the current page of results is the last page and no more results are to be returned.
|
|
32603
|
+
* * When you use Alibaba Cloud CLI to call an API operation, you must specify request parameter values of different data types in required formats. For more information, see [Parameter format overview](~~110340~~).
|
|
32062
32604
|
*
|
|
32063
32605
|
* @param request DescribeSecurityGroupsRequest
|
|
32064
32606
|
* @return DescribeSecurityGroupsResponse
|
|
@@ -32107,9 +32649,10 @@ export default class Client extends OpenApi {
|
|
|
32107
32649
|
*/
|
|
32108
32650
|
describeSnapshotGroups(request: DescribeSnapshotGroupsRequest): Promise<DescribeSnapshotGroupsResponse>;
|
|
32109
32651
|
/**
|
|
32110
|
-
*
|
|
32111
|
-
*
|
|
32112
|
-
* *
|
|
32652
|
+
* ## [](#)Usage notes
|
|
32653
|
+
* Take note of the following items:
|
|
32654
|
+
* * You can specify multiple request parameters, such as `RegionId`, `DiskIds`, and `InstanceId`, to query snapshot chains. Specified parameters have logical AND relations.
|
|
32655
|
+
* * Only the specified parameters are used as filter conditions. If the `DiskIds` and `SnapshotLinkIds` parameters are set to empty JSON arrays, the values are considered as valid filter conditions. In this case, an empty result is returned.
|
|
32113
32656
|
*
|
|
32114
32657
|
* @param request DescribeSnapshotLinksRequest
|
|
32115
32658
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -32117,18 +32660,20 @@ export default class Client extends OpenApi {
|
|
|
32117
32660
|
*/
|
|
32118
32661
|
describeSnapshotLinksWithOptions(request: DescribeSnapshotLinksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeSnapshotLinksResponse>;
|
|
32119
32662
|
/**
|
|
32120
|
-
*
|
|
32121
|
-
*
|
|
32122
|
-
* *
|
|
32663
|
+
* ## [](#)Usage notes
|
|
32664
|
+
* Take note of the following items:
|
|
32665
|
+
* * You can specify multiple request parameters, such as `RegionId`, `DiskIds`, and `InstanceId`, to query snapshot chains. Specified parameters have logical AND relations.
|
|
32666
|
+
* * Only the specified parameters are used as filter conditions. If the `DiskIds` and `SnapshotLinkIds` parameters are set to empty JSON arrays, the values are considered as valid filter conditions. In this case, an empty result is returned.
|
|
32123
32667
|
*
|
|
32124
32668
|
* @param request DescribeSnapshotLinksRequest
|
|
32125
32669
|
* @return DescribeSnapshotLinksResponse
|
|
32126
32670
|
*/
|
|
32127
32671
|
describeSnapshotLinks(request: DescribeSnapshotLinksRequest): Promise<DescribeSnapshotLinksResponse>;
|
|
32128
32672
|
/**
|
|
32673
|
+
* ## [](#)Usage notes
|
|
32129
32674
|
* Take note of the following items:
|
|
32130
|
-
* * Up to 400
|
|
32131
|
-
* *
|
|
32675
|
+
* * Up to 400 monitoring data entries can be returned at a time. Make sure that the `TotalCount` value does not exceed 400. The value is calculated by using the following formula: `TotalCount = (EndTime - StartTime)/Period`. If the TotalCount value is greater than 400, the `InvalidParameter.TooManyDataQueried` error is returned.
|
|
32676
|
+
* * You can query the monitoring data of snapshot sizes in the last 30 days. If the value of `StartTime` is more than 30 days earlier than the current time, an error is returned.
|
|
32132
32677
|
*
|
|
32133
32678
|
* @param request DescribeSnapshotMonitorDataRequest
|
|
32134
32679
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -32136,9 +32681,10 @@ export default class Client extends OpenApi {
|
|
|
32136
32681
|
*/
|
|
32137
32682
|
describeSnapshotMonitorDataWithOptions(request: DescribeSnapshotMonitorDataRequest, runtime: $Util.RuntimeOptions): Promise<DescribeSnapshotMonitorDataResponse>;
|
|
32138
32683
|
/**
|
|
32684
|
+
* ## [](#)Usage notes
|
|
32139
32685
|
* Take note of the following items:
|
|
32140
|
-
* * Up to 400
|
|
32141
|
-
* *
|
|
32686
|
+
* * Up to 400 monitoring data entries can be returned at a time. Make sure that the `TotalCount` value does not exceed 400. The value is calculated by using the following formula: `TotalCount = (EndTime - StartTime)/Period`. If the TotalCount value is greater than 400, the `InvalidParameter.TooManyDataQueried` error is returned.
|
|
32687
|
+
* * You can query the monitoring data of snapshot sizes in the last 30 days. If the value of `StartTime` is more than 30 days earlier than the current time, an error is returned.
|
|
32142
32688
|
*
|
|
32143
32689
|
* @param request DescribeSnapshotMonitorDataRequest
|
|
32144
32690
|
* @return DescribeSnapshotMonitorDataResponse
|
|
@@ -32164,7 +32710,8 @@ export default class Client extends OpenApi {
|
|
|
32164
32710
|
*/
|
|
32165
32711
|
describeSnapshots(request: DescribeSnapshotsRequest): Promise<DescribeSnapshotsResponse>;
|
|
32166
32712
|
/**
|
|
32167
|
-
*
|
|
32713
|
+
* ## [](#)Usage notes
|
|
32714
|
+
* If you want to view the snapshot usage of each disk in the current region, we recommend that you call the [DescribeSnapshotLinks](~~55837~~) operation to query snapshot chain information.
|
|
32168
32715
|
*
|
|
32169
32716
|
* @param request DescribeSnapshotsUsageRequest
|
|
32170
32717
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -32172,7 +32719,8 @@ export default class Client extends OpenApi {
|
|
|
32172
32719
|
*/
|
|
32173
32720
|
describeSnapshotsUsageWithOptions(request: DescribeSnapshotsUsageRequest, runtime: $Util.RuntimeOptions): Promise<DescribeSnapshotsUsageResponse>;
|
|
32174
32721
|
/**
|
|
32175
|
-
*
|
|
32722
|
+
* ## [](#)Usage notes
|
|
32723
|
+
* If you want to view the snapshot usage of each disk in the current region, we recommend that you call the [DescribeSnapshotLinks](~~55837~~) operation to query snapshot chain information.
|
|
32176
32724
|
*
|
|
32177
32725
|
* @param request DescribeSnapshotsUsageRequest
|
|
32178
32726
|
* @return DescribeSnapshotsUsageResponse
|
|
@@ -32251,6 +32799,21 @@ export default class Client extends OpenApi {
|
|
|
32251
32799
|
* @return DescribeTasksResponse
|
|
32252
32800
|
*/
|
|
32253
32801
|
describeTasks(request: DescribeTasksRequest): Promise<DescribeTasksResponse>;
|
|
32802
|
+
/**
|
|
32803
|
+
* You can query the session records of Session Manager that were generated in the last four weeks.
|
|
32804
|
+
*
|
|
32805
|
+
* @param request DescribeTerminalSessionsRequest
|
|
32806
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
32807
|
+
* @return DescribeTerminalSessionsResponse
|
|
32808
|
+
*/
|
|
32809
|
+
describeTerminalSessionsWithOptions(request: DescribeTerminalSessionsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeTerminalSessionsResponse>;
|
|
32810
|
+
/**
|
|
32811
|
+
* You can query the session records of Session Manager that were generated in the last four weeks.
|
|
32812
|
+
*
|
|
32813
|
+
* @param request DescribeTerminalSessionsRequest
|
|
32814
|
+
* @return DescribeTerminalSessionsResponse
|
|
32815
|
+
*/
|
|
32816
|
+
describeTerminalSessions(request: DescribeTerminalSessionsRequest): Promise<DescribeTerminalSessionsResponse>;
|
|
32254
32817
|
/**
|
|
32255
32818
|
* @deprecated
|
|
32256
32819
|
*
|
|
@@ -32424,7 +32987,15 @@ export default class Client extends OpenApi {
|
|
|
32424
32987
|
*/
|
|
32425
32988
|
detachKeyPair(request: DetachKeyPairRequest): Promise<DetachKeyPairResponse>;
|
|
32426
32989
|
/**
|
|
32427
|
-
*
|
|
32990
|
+
* Take note of the following items:
|
|
32991
|
+
* * You cannot detach the primary ENI of an instance.
|
|
32992
|
+
* * Make sure that the ENI to be detached is in the Detaching (Unbinding) or InUse (Bound) state.
|
|
32993
|
+
* * Make sure that the instance from which you want to detach an ENI is in the Running (Running) or Stopped (Stopped) state.
|
|
32994
|
+
* * The DetachNetworkInterface operation is an asynchronous operation. After this operation is called to detach an ENI, you can check the status or events of the ENI to determine whether the ENI is detached. The following figure shows the transitions between the states of the ENI.
|
|
32995
|
+
* * If the ENI is in the Detaching state, the ENI detachment request is sent and the ENI is being detached from the associated instance.
|
|
32996
|
+
* * If the ENI is in the Available state, the ENI is detached from the associated instance.
|
|
32997
|
+
* * If the ENI is stuck in the Detaching state, the ENI may fail to be detached from the associated instance due to specific reasons. For example, the ENI may fail to be detached because the operating system of the instance did not respond to the ENI detachment request. If this issue occurs, you can re-initiate the request to detach the ENI. If the issue persists, restart the instance.
|
|
32998
|
+
* For information about examples on how to call the DetachNetworkInterface operation, see [Detach an ENI from an ECS instance](~~471551~~).
|
|
32428
32999
|
*
|
|
32429
33000
|
* @param request DetachNetworkInterfaceRequest
|
|
32430
33001
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -32432,7 +33003,15 @@ export default class Client extends OpenApi {
|
|
|
32432
33003
|
*/
|
|
32433
33004
|
detachNetworkInterfaceWithOptions(request: DetachNetworkInterfaceRequest, runtime: $Util.RuntimeOptions): Promise<DetachNetworkInterfaceResponse>;
|
|
32434
33005
|
/**
|
|
32435
|
-
*
|
|
33006
|
+
* Take note of the following items:
|
|
33007
|
+
* * You cannot detach the primary ENI of an instance.
|
|
33008
|
+
* * Make sure that the ENI to be detached is in the Detaching (Unbinding) or InUse (Bound) state.
|
|
33009
|
+
* * Make sure that the instance from which you want to detach an ENI is in the Running (Running) or Stopped (Stopped) state.
|
|
33010
|
+
* * The DetachNetworkInterface operation is an asynchronous operation. After this operation is called to detach an ENI, you can check the status or events of the ENI to determine whether the ENI is detached. The following figure shows the transitions between the states of the ENI.
|
|
33011
|
+
* * If the ENI is in the Detaching state, the ENI detachment request is sent and the ENI is being detached from the associated instance.
|
|
33012
|
+
* * If the ENI is in the Available state, the ENI is detached from the associated instance.
|
|
33013
|
+
* * If the ENI is stuck in the Detaching state, the ENI may fail to be detached from the associated instance due to specific reasons. For example, the ENI may fail to be detached because the operating system of the instance did not respond to the ENI detachment request. If this issue occurs, you can re-initiate the request to detach the ENI. If the issue persists, restart the instance.
|
|
33014
|
+
* For information about examples on how to call the DetachNetworkInterface operation, see [Detach an ENI from an ECS instance](~~471551~~).
|
|
32436
33015
|
*
|
|
32437
33016
|
* @param request DetachNetworkInterfaceRequest
|
|
32438
33017
|
* @return DetachNetworkInterfaceResponse
|
|
@@ -32516,51 +33095,48 @@ export default class Client extends OpenApi {
|
|
|
32516
33095
|
*/
|
|
32517
33096
|
enablePhysicalConnection(request: EnablePhysicalConnectionRequest): Promise<EnablePhysicalConnectionResponse>;
|
|
32518
33097
|
/**
|
|
32519
|
-
*
|
|
32520
|
-
*
|
|
32521
|
-
* *
|
|
33098
|
+
* ## [](#)Usage notes
|
|
33099
|
+
* Before you export images, take note of the following items:
|
|
33100
|
+
* * Make sure that you are familiar with the prerequisites and precautions. For more information, see [Export a custom image](~~58181~~).
|
|
33101
|
+
* * The `ImageFormat` parameter is available only for the following regions: India (Mumbai), Japan (Tokyo), Australia (Sydney), Indonesia (Jakarta), Germany (Frankfurt), UAE (Dubai), US (Virginia), UK (London), Singapore, Malaysia (Kuala Lumpur), and US (Silicon Valley). By default, custom images are exported in the RAW format in regions where ImageFormat is unsupported.
|
|
32522
33102
|
* * Use Resource Access Management (RAM) to grant Elastic Compute Service (ECS) the permissions to write data to OSS. To complete the authorization, perform the following operations:
|
|
32523
|
-
*
|
|
32524
|
-
*
|
|
32525
|
-
*
|
|
32526
|
-
*
|
|
32527
|
-
*
|
|
32528
|
-
*
|
|
32529
|
-
*
|
|
32530
|
-
*
|
|
32531
|
-
*
|
|
32532
|
-
*
|
|
32533
|
-
*
|
|
33103
|
+
* * Create a role named `AliyunECSImageExportDefaultRole`, and attach the following policy to the role:
|
|
33104
|
+
* {
|
|
33105
|
+
* "Statement": [
|
|
33106
|
+
* {
|
|
33107
|
+
* "Action": "sts:AssumeRole",
|
|
33108
|
+
* "Effect": "Allow",
|
|
33109
|
+
* "Principal": {
|
|
33110
|
+
* "Service": [
|
|
33111
|
+
* "ecs.aliyuncs.com"
|
|
33112
|
+
* ]
|
|
33113
|
+
* }
|
|
33114
|
+
* }
|
|
33115
|
+
* ],
|
|
33116
|
+
* "Version": "1"
|
|
32534
33117
|
* }
|
|
32535
|
-
*
|
|
32536
|
-
*
|
|
32537
|
-
*
|
|
32538
|
-
*
|
|
32539
|
-
*
|
|
32540
|
-
*
|
|
32541
|
-
*
|
|
32542
|
-
*
|
|
32543
|
-
*
|
|
32544
|
-
*
|
|
32545
|
-
*
|
|
32546
|
-
*
|
|
32547
|
-
*
|
|
32548
|
-
*
|
|
32549
|
-
*
|
|
32550
|
-
*
|
|
32551
|
-
*
|
|
32552
|
-
*
|
|
32553
|
-
*
|
|
32554
|
-
*
|
|
32555
|
-
*
|
|
32556
|
-
*
|
|
32557
|
-
* "Effect": "Allow"
|
|
32558
|
-
* }
|
|
32559
|
-
* ]
|
|
32560
|
-
* }
|
|
32561
|
-
* ```
|
|
32562
|
-
* After you export a custom image, the following situation occurs:
|
|
32563
|
-
* The custom image is stored in the specified OSS bucket. You can download the custom image. For more information, see [Download objects](~~31912~~).
|
|
33118
|
+
* * Attach the `AliyunECSImageExportRolePolicy` system policy to the `AliyunECSImageExportDefaultRole` role. This policy is the default policy that grants ECS the permissions to export images. For more information, go to the [Cloud Resource Access Authorization](https://ram.console.aliyun.com/?spm=5176.2020520101.0.0.64c64df5dfpmdY#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunECSImageImportDefaultRole%22,%20%22TemplateId%22:%20%22ECSImportRole%22%7D,%20%22request2%22:%20%7B%22RoleName%22:%20%22AliyunECSImageExportDefaultRole%22,%20%22TemplateId%22:%20%22ECSExportRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fecs.console.aliyun.com%2F%22,%20%22Service%22:%20%22ECS%22%7D) page. You can also create a custom policy that contains the following content and attach the policy to the role:
|
|
33119
|
+
* {
|
|
33120
|
+
* "Version": "1",
|
|
33121
|
+
* "Statement": [
|
|
33122
|
+
* {
|
|
33123
|
+
* "Action": [
|
|
33124
|
+
* "oss:GetObject",
|
|
33125
|
+
* "oss:PutObject",
|
|
33126
|
+
* "oss:DeleteObject",
|
|
33127
|
+
* "oss:GetBucketLocation",
|
|
33128
|
+
* "oss:GetBucketInfo",
|
|
33129
|
+
* "oss:AbortMultipartUpload",
|
|
33130
|
+
* "oss:ListMultipartUploads",
|
|
33131
|
+
* "oss:ListParts"
|
|
33132
|
+
* ],
|
|
33133
|
+
* "Resource": "*",
|
|
33134
|
+
* "Effect": "Allow"
|
|
33135
|
+
* }
|
|
33136
|
+
* ]
|
|
33137
|
+
* }
|
|
33138
|
+
* After you export the images, take note of the following items:
|
|
33139
|
+
* Each exported custom image is stored in the specified OSS bucket. You can download the custom image. For more information, see [Download objects](~~31912~~).
|
|
32564
33140
|
*
|
|
32565
33141
|
* @param request ExportImageRequest
|
|
32566
33142
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -32568,51 +33144,48 @@ export default class Client extends OpenApi {
|
|
|
32568
33144
|
*/
|
|
32569
33145
|
exportImageWithOptions(request: ExportImageRequest, runtime: $Util.RuntimeOptions): Promise<ExportImageResponse>;
|
|
32570
33146
|
/**
|
|
32571
|
-
*
|
|
32572
|
-
*
|
|
32573
|
-
* *
|
|
33147
|
+
* ## [](#)Usage notes
|
|
33148
|
+
* Before you export images, take note of the following items:
|
|
33149
|
+
* * Make sure that you are familiar with the prerequisites and precautions. For more information, see [Export a custom image](~~58181~~).
|
|
33150
|
+
* * The `ImageFormat` parameter is available only for the following regions: India (Mumbai), Japan (Tokyo), Australia (Sydney), Indonesia (Jakarta), Germany (Frankfurt), UAE (Dubai), US (Virginia), UK (London), Singapore, Malaysia (Kuala Lumpur), and US (Silicon Valley). By default, custom images are exported in the RAW format in regions where ImageFormat is unsupported.
|
|
32574
33151
|
* * Use Resource Access Management (RAM) to grant Elastic Compute Service (ECS) the permissions to write data to OSS. To complete the authorization, perform the following operations:
|
|
32575
|
-
*
|
|
32576
|
-
*
|
|
32577
|
-
*
|
|
32578
|
-
*
|
|
32579
|
-
*
|
|
32580
|
-
*
|
|
32581
|
-
*
|
|
32582
|
-
*
|
|
32583
|
-
*
|
|
32584
|
-
*
|
|
32585
|
-
*
|
|
33152
|
+
* * Create a role named `AliyunECSImageExportDefaultRole`, and attach the following policy to the role:
|
|
33153
|
+
* {
|
|
33154
|
+
* "Statement": [
|
|
33155
|
+
* {
|
|
33156
|
+
* "Action": "sts:AssumeRole",
|
|
33157
|
+
* "Effect": "Allow",
|
|
33158
|
+
* "Principal": {
|
|
33159
|
+
* "Service": [
|
|
33160
|
+
* "ecs.aliyuncs.com"
|
|
33161
|
+
* ]
|
|
33162
|
+
* }
|
|
33163
|
+
* }
|
|
33164
|
+
* ],
|
|
33165
|
+
* "Version": "1"
|
|
32586
33166
|
* }
|
|
32587
|
-
*
|
|
32588
|
-
*
|
|
32589
|
-
*
|
|
32590
|
-
*
|
|
32591
|
-
*
|
|
32592
|
-
*
|
|
32593
|
-
*
|
|
32594
|
-
*
|
|
32595
|
-
*
|
|
32596
|
-
*
|
|
32597
|
-
*
|
|
32598
|
-
*
|
|
32599
|
-
*
|
|
32600
|
-
*
|
|
32601
|
-
*
|
|
32602
|
-
*
|
|
32603
|
-
*
|
|
32604
|
-
*
|
|
32605
|
-
*
|
|
32606
|
-
*
|
|
32607
|
-
*
|
|
32608
|
-
*
|
|
32609
|
-
* "Effect": "Allow"
|
|
32610
|
-
* }
|
|
32611
|
-
* ]
|
|
32612
|
-
* }
|
|
32613
|
-
* ```
|
|
32614
|
-
* After you export a custom image, the following situation occurs:
|
|
32615
|
-
* The custom image is stored in the specified OSS bucket. You can download the custom image. For more information, see [Download objects](~~31912~~).
|
|
33167
|
+
* * Attach the `AliyunECSImageExportRolePolicy` system policy to the `AliyunECSImageExportDefaultRole` role. This policy is the default policy that grants ECS the permissions to export images. For more information, go to the [Cloud Resource Access Authorization](https://ram.console.aliyun.com/?spm=5176.2020520101.0.0.64c64df5dfpmdY#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunECSImageImportDefaultRole%22,%20%22TemplateId%22:%20%22ECSImportRole%22%7D,%20%22request2%22:%20%7B%22RoleName%22:%20%22AliyunECSImageExportDefaultRole%22,%20%22TemplateId%22:%20%22ECSExportRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fecs.console.aliyun.com%2F%22,%20%22Service%22:%20%22ECS%22%7D) page. You can also create a custom policy that contains the following content and attach the policy to the role:
|
|
33168
|
+
* {
|
|
33169
|
+
* "Version": "1",
|
|
33170
|
+
* "Statement": [
|
|
33171
|
+
* {
|
|
33172
|
+
* "Action": [
|
|
33173
|
+
* "oss:GetObject",
|
|
33174
|
+
* "oss:PutObject",
|
|
33175
|
+
* "oss:DeleteObject",
|
|
33176
|
+
* "oss:GetBucketLocation",
|
|
33177
|
+
* "oss:GetBucketInfo",
|
|
33178
|
+
* "oss:AbortMultipartUpload",
|
|
33179
|
+
* "oss:ListMultipartUploads",
|
|
33180
|
+
* "oss:ListParts"
|
|
33181
|
+
* ],
|
|
33182
|
+
* "Resource": "*",
|
|
33183
|
+
* "Effect": "Allow"
|
|
33184
|
+
* }
|
|
33185
|
+
* ]
|
|
33186
|
+
* }
|
|
33187
|
+
* After you export the images, take note of the following items:
|
|
33188
|
+
* Each exported custom image is stored in the specified OSS bucket. You can download the custom image. For more information, see [Download objects](~~31912~~).
|
|
32616
33189
|
*
|
|
32617
33190
|
* @param request ExportImageRequest
|
|
32618
33191
|
* @return ExportImageResponse
|
|
@@ -32633,7 +33206,24 @@ export default class Client extends OpenApi {
|
|
|
32633
33206
|
* @return ExportSnapshotResponse
|
|
32634
33207
|
*/
|
|
32635
33208
|
exportSnapshot(request: ExportSnapshotRequest): Promise<ExportSnapshotResponse>;
|
|
33209
|
+
/**
|
|
33210
|
+
* * ECS is a virtualized cloud-based service and cannot be connected to display devices. Alibaba Cloud caches system command outputs for the last start, restart, or shutdown of ECS instances. You can call the GetInstanceConsoleOutput operation to query the command outputs.
|
|
33211
|
+
* * For instances of the retired instance types, you cannot obtain command outputs. For more information, see [Retired instance types](~~55263~~).
|
|
33212
|
+
* * You cannot obtain the command outputs of Windows instances.
|
|
33213
|
+
*
|
|
33214
|
+
* @param request GetInstanceConsoleOutputRequest
|
|
33215
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
33216
|
+
* @return GetInstanceConsoleOutputResponse
|
|
33217
|
+
*/
|
|
32636
33218
|
getInstanceConsoleOutputWithOptions(request: GetInstanceConsoleOutputRequest, runtime: $Util.RuntimeOptions): Promise<GetInstanceConsoleOutputResponse>;
|
|
33219
|
+
/**
|
|
33220
|
+
* * ECS is a virtualized cloud-based service and cannot be connected to display devices. Alibaba Cloud caches system command outputs for the last start, restart, or shutdown of ECS instances. You can call the GetInstanceConsoleOutput operation to query the command outputs.
|
|
33221
|
+
* * For instances of the retired instance types, you cannot obtain command outputs. For more information, see [Retired instance types](~~55263~~).
|
|
33222
|
+
* * You cannot obtain the command outputs of Windows instances.
|
|
33223
|
+
*
|
|
33224
|
+
* @param request GetInstanceConsoleOutputRequest
|
|
33225
|
+
* @return GetInstanceConsoleOutputResponse
|
|
33226
|
+
*/
|
|
32637
33227
|
getInstanceConsoleOutput(request: GetInstanceConsoleOutputRequest): Promise<GetInstanceConsoleOutputResponse>;
|
|
32638
33228
|
/**
|
|
32639
33229
|
* After ECS returns a Base64-encoded instance screenshot in the JPG format, you must decode the screenshot. We recommend that you call this operation for troubleshooting and diagnosis. When you call this operation, take note of the following items:
|
|
@@ -32657,11 +33247,12 @@ export default class Client extends OpenApi {
|
|
|
32657
33247
|
*/
|
|
32658
33248
|
getInstanceScreenshot(request: GetInstanceScreenshotRequest): Promise<GetInstanceScreenshotResponse>;
|
|
32659
33249
|
/**
|
|
32660
|
-
*
|
|
32661
|
-
*
|
|
32662
|
-
* *
|
|
32663
|
-
* *
|
|
32664
|
-
*
|
|
33250
|
+
* ### [](#)Usage notes
|
|
33251
|
+
* Take note of the following items:
|
|
33252
|
+
* * Before you import an image, you must upload the image to an Object Storage Service (OSS) bucket. For more information, see [Upload objects](~~31886~~).
|
|
33253
|
+
* * In some scenarios, you may want to create a custom image based on the operating system data of a source server, import the image to Alibaba Cloud, and then create an ECS instance from the image. The source server can be a physical server, a virtual machine, or a cloud host. If the virtio driver is not installed on the source server, the created ECS instance may be unable to start. To prevent this issue, verify that the virtio driver is installed on the source server before you import the image to Alibaba Cloud. For more information, see [Install the virtio driver](~~62423~~).
|
|
33254
|
+
* * Before you import images for the first time, you must use Resource Access Management (RAM) to authorize ECS to access your OSS buckets. If ECS is not authorized to access your OSS buckets, the `NoSetRoletoECSServiceAcount` error code is returned when you call the ImportImage operation. You can complete the authorization with one click on the [Cloud Resource Access Authorization](https://ram.console.aliyun.com/?spm=5176.2020520101image.0.0.2ffa4df57kSoHX#/role/authorize?request=%7B%22Requests%22%3A%20%7B%22request1%22%3A%20%7B%22RoleName%22%3A%20%22AliyunECSImageImportDefaultRole%22%2C%20%22TemplateId%22%3A%20%22ECSImportRole%22%7D%2C%20%22request2%22%3A%20%7B%22RoleName%22%3A%20%22AliyunECSImageExportDefaultRole%22%2C%20%22TemplateId%22%3A%20%22ECSExportRole%22%7D%7D%2C%20%22ReturnUrl%22%3A%20%22https%3A//ecs.console.aliyun.com/%22%2C%20%22Service%22%3A%20%22ECS%22%7D) page of the RAM console. You can also complete the authorization by using a RAM role and RAM policies. The following examples show the policies and permissions required for some steps in the authorization procedure. For more information, see [Control access to resources by using RAM users](~~25481~~).
|
|
33255
|
+
* 1. Create a RAM role named `AliyunECSImageImportDefaultRole`. You must use this exact role name. Otherwise, the image cannot be imported. Configure the following trust policy for the role:
|
|
32665
33256
|
* {
|
|
32666
33257
|
* "Statement": [
|
|
32667
33258
|
* {
|
|
@@ -32676,7 +33267,7 @@ export default class Client extends OpenApi {
|
|
|
32676
33267
|
* ],
|
|
32677
33268
|
* "Version": "1"
|
|
32678
33269
|
* }
|
|
32679
|
-
* 2. Attach the `AliyunECSImageImportRolePolicy` system policy to the role. You can also create a custom policy that contains the following content and attach the policy to the role:
|
|
33270
|
+
* 2. Attach the `AliyunECSImageImportRolePolicy` system policy to the RAM role. You can also create a custom policy that contains the following content and attach the policy to the role:
|
|
32680
33271
|
* ```
|
|
32681
33272
|
* {
|
|
32682
33273
|
* "Version": "1",
|
|
@@ -32694,19 +33285,20 @@ export default class Client extends OpenApi {
|
|
|
32694
33285
|
* }
|
|
32695
33286
|
* ```
|
|
32696
33287
|
* * You cannot delete an image that is being imported. However, you can call the [CancelTask](~~25624~~) operation to cancel the image import task.
|
|
32697
|
-
* * You can import an image only to the same region as the OSS bucket to which the image
|
|
32698
|
-
* * The valid values of N in
|
|
33288
|
+
* * You can import an image only to the same region as the OSS bucket to which the image file is uploaded.
|
|
33289
|
+
* * The valid values of N in `DiskDeviceMapping.N` range from 1 to 17. When N is set to 1, the disk is a system disk. When N is set to a value from 2 to 17, the disk is a data disk. When N is set to a value greater than 17, parameters prefixed with DiskDeviceMapping.N are ignored.
|
|
32699
33290
|
* * When you set `Architecture` to `arm64` or when you set `Platform` to `CentOS Stream`, `Anolis`, `AlmaLinux`, `UOS`, `Kylin`, or `Rocky Linux`, take note of the following items:
|
|
32700
|
-
* * To ensure that the password can be set
|
|
32701
|
-
* * The operating system
|
|
32702
|
-
* *
|
|
33291
|
+
* * To ensure that the password can be set or the key pair can be modified for an imported image, make sure that the image meets the following requirements before you import it:
|
|
33292
|
+
* * The kernel of the operating system supports the `CONFIG_FW_CFG_SYSFS` feature. By default, Linux community kernel 4.6 and later and CentOS kernel 3.10.0-826.el7 and later support the CONFIG_FW_CFG_SYSFS feature. You can run the `grep -nr CONFIG_FW_CFG_SYSFS /boot/config-$(uname -r)` command on the source server of the image. If the command output contains `CONFIG_FW_CFG_SYSFS=y`, the kernel of the image supports the `CONFIG_FW_CFG_SYSFS` feature.
|
|
33293
|
+
* * Alibaba Cloud cloud-init of the latest version is installed on the operating system. If the version of cloud-init is 19.1, the minor version must be 19.1.3 or later. If the version of cloud-init is 0.7.6a in some early versions of operating systems, the minor version must be 0.7.6a15 or later. For more information, see [Install cloud-init](~~57803~~).
|
|
32703
33294
|
* * The operating system supports the SHA-512 encryption algorithm.
|
|
32704
33295
|
* * If you want an imported image to support the resizing of disks and file systems, make sure that the image meets the following requirements before you import it:
|
|
32705
33296
|
* * The kernel version of the operating system is later than 3.6.
|
|
32706
|
-
* * The image supports the growpart command. To support this command, you must install the `cloud-utils-growpart` package.
|
|
32707
|
-
* * The image supports the resize2fs command. To support this command, you must install the `e2fsprogs` package. By default, the package is installed on the operating system. If the package is not installed,
|
|
32708
|
-
* *
|
|
32709
|
-
* * If the image that you want to import uses the
|
|
33297
|
+
* * The image supports the growpart command. To support this command, you must install the `cloud-utils-growpart` package. The methods of installing the package vary based on operating systems. For more information, see [Extend the partitions and file systems of disks on a Linux instance](~~25451~~).
|
|
33298
|
+
* * The image supports the resize2fs command. To support this command, you must install the `e2fsprogs` package. By default, the package is installed on the operating system. If the package is not installed, install it.
|
|
33299
|
+
* * Alibaba Cloud cloud-init of the latest version is installed on the operating system. If the version of cloud-init is 19.1, the minor version must be 19.1.3 or later. If the version of cloud-init is 0.7.6a in some early versions of operating systems, the minor version must be 0.7.6a15 or later. For more information, see [Install cloud-init](~~57803~~).
|
|
33300
|
+
* * If the image that you want to import uses the Arm64 architecture, configure the real-time clock (RTC) to use the Coordinated Universal Time (UTC) time standard. For more information, see [Linux time and time zones](~~405080~~).
|
|
33301
|
+
* * When you import images, we recommend that you specify DetectionStrategy. This way, you can optimize the images based on the image check results. For more information, see [Overview](~~439819~~).
|
|
32710
33302
|
*
|
|
32711
33303
|
* @param request ImportImageRequest
|
|
32712
33304
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -32714,11 +33306,12 @@ export default class Client extends OpenApi {
|
|
|
32714
33306
|
*/
|
|
32715
33307
|
importImageWithOptions(request: ImportImageRequest, runtime: $Util.RuntimeOptions): Promise<ImportImageResponse>;
|
|
32716
33308
|
/**
|
|
32717
|
-
*
|
|
32718
|
-
*
|
|
32719
|
-
* *
|
|
32720
|
-
* *
|
|
32721
|
-
*
|
|
33309
|
+
* ### [](#)Usage notes
|
|
33310
|
+
* Take note of the following items:
|
|
33311
|
+
* * Before you import an image, you must upload the image to an Object Storage Service (OSS) bucket. For more information, see [Upload objects](~~31886~~).
|
|
33312
|
+
* * In some scenarios, you may want to create a custom image based on the operating system data of a source server, import the image to Alibaba Cloud, and then create an ECS instance from the image. The source server can be a physical server, a virtual machine, or a cloud host. If the virtio driver is not installed on the source server, the created ECS instance may be unable to start. To prevent this issue, verify that the virtio driver is installed on the source server before you import the image to Alibaba Cloud. For more information, see [Install the virtio driver](~~62423~~).
|
|
33313
|
+
* * Before you import images for the first time, you must use Resource Access Management (RAM) to authorize ECS to access your OSS buckets. If ECS is not authorized to access your OSS buckets, the `NoSetRoletoECSServiceAcount` error code is returned when you call the ImportImage operation. You can complete the authorization with one click on the [Cloud Resource Access Authorization](https://ram.console.aliyun.com/?spm=5176.2020520101image.0.0.2ffa4df57kSoHX#/role/authorize?request=%7B%22Requests%22%3A%20%7B%22request1%22%3A%20%7B%22RoleName%22%3A%20%22AliyunECSImageImportDefaultRole%22%2C%20%22TemplateId%22%3A%20%22ECSImportRole%22%7D%2C%20%22request2%22%3A%20%7B%22RoleName%22%3A%20%22AliyunECSImageExportDefaultRole%22%2C%20%22TemplateId%22%3A%20%22ECSExportRole%22%7D%7D%2C%20%22ReturnUrl%22%3A%20%22https%3A//ecs.console.aliyun.com/%22%2C%20%22Service%22%3A%20%22ECS%22%7D) page of the RAM console. You can also complete the authorization by using a RAM role and RAM policies. The following examples show the policies and permissions required for some steps in the authorization procedure. For more information, see [Control access to resources by using RAM users](~~25481~~).
|
|
33314
|
+
* 1. Create a RAM role named `AliyunECSImageImportDefaultRole`. You must use this exact role name. Otherwise, the image cannot be imported. Configure the following trust policy for the role:
|
|
32722
33315
|
* {
|
|
32723
33316
|
* "Statement": [
|
|
32724
33317
|
* {
|
|
@@ -32733,7 +33326,7 @@ export default class Client extends OpenApi {
|
|
|
32733
33326
|
* ],
|
|
32734
33327
|
* "Version": "1"
|
|
32735
33328
|
* }
|
|
32736
|
-
* 2. Attach the `AliyunECSImageImportRolePolicy` system policy to the role. You can also create a custom policy that contains the following content and attach the policy to the role:
|
|
33329
|
+
* 2. Attach the `AliyunECSImageImportRolePolicy` system policy to the RAM role. You can also create a custom policy that contains the following content and attach the policy to the role:
|
|
32737
33330
|
* ```
|
|
32738
33331
|
* {
|
|
32739
33332
|
* "Version": "1",
|
|
@@ -32751,19 +33344,20 @@ export default class Client extends OpenApi {
|
|
|
32751
33344
|
* }
|
|
32752
33345
|
* ```
|
|
32753
33346
|
* * You cannot delete an image that is being imported. However, you can call the [CancelTask](~~25624~~) operation to cancel the image import task.
|
|
32754
|
-
* * You can import an image only to the same region as the OSS bucket to which the image
|
|
32755
|
-
* * The valid values of N in
|
|
33347
|
+
* * You can import an image only to the same region as the OSS bucket to which the image file is uploaded.
|
|
33348
|
+
* * The valid values of N in `DiskDeviceMapping.N` range from 1 to 17. When N is set to 1, the disk is a system disk. When N is set to a value from 2 to 17, the disk is a data disk. When N is set to a value greater than 17, parameters prefixed with DiskDeviceMapping.N are ignored.
|
|
32756
33349
|
* * When you set `Architecture` to `arm64` or when you set `Platform` to `CentOS Stream`, `Anolis`, `AlmaLinux`, `UOS`, `Kylin`, or `Rocky Linux`, take note of the following items:
|
|
32757
|
-
* * To ensure that the password can be set
|
|
32758
|
-
* * The operating system
|
|
32759
|
-
* *
|
|
33350
|
+
* * To ensure that the password can be set or the key pair can be modified for an imported image, make sure that the image meets the following requirements before you import it:
|
|
33351
|
+
* * The kernel of the operating system supports the `CONFIG_FW_CFG_SYSFS` feature. By default, Linux community kernel 4.6 and later and CentOS kernel 3.10.0-826.el7 and later support the CONFIG_FW_CFG_SYSFS feature. You can run the `grep -nr CONFIG_FW_CFG_SYSFS /boot/config-$(uname -r)` command on the source server of the image. If the command output contains `CONFIG_FW_CFG_SYSFS=y`, the kernel of the image supports the `CONFIG_FW_CFG_SYSFS` feature.
|
|
33352
|
+
* * Alibaba Cloud cloud-init of the latest version is installed on the operating system. If the version of cloud-init is 19.1, the minor version must be 19.1.3 or later. If the version of cloud-init is 0.7.6a in some early versions of operating systems, the minor version must be 0.7.6a15 or later. For more information, see [Install cloud-init](~~57803~~).
|
|
32760
33353
|
* * The operating system supports the SHA-512 encryption algorithm.
|
|
32761
33354
|
* * If you want an imported image to support the resizing of disks and file systems, make sure that the image meets the following requirements before you import it:
|
|
32762
33355
|
* * The kernel version of the operating system is later than 3.6.
|
|
32763
|
-
* * The image supports the growpart command. To support this command, you must install the `cloud-utils-growpart` package.
|
|
32764
|
-
* * The image supports the resize2fs command. To support this command, you must install the `e2fsprogs` package. By default, the package is installed on the operating system. If the package is not installed,
|
|
32765
|
-
* *
|
|
32766
|
-
* * If the image that you want to import uses the
|
|
33356
|
+
* * The image supports the growpart command. To support this command, you must install the `cloud-utils-growpart` package. The methods of installing the package vary based on operating systems. For more information, see [Extend the partitions and file systems of disks on a Linux instance](~~25451~~).
|
|
33357
|
+
* * The image supports the resize2fs command. To support this command, you must install the `e2fsprogs` package. By default, the package is installed on the operating system. If the package is not installed, install it.
|
|
33358
|
+
* * Alibaba Cloud cloud-init of the latest version is installed on the operating system. If the version of cloud-init is 19.1, the minor version must be 19.1.3 or later. If the version of cloud-init is 0.7.6a in some early versions of operating systems, the minor version must be 0.7.6a15 or later. For more information, see [Install cloud-init](~~57803~~).
|
|
33359
|
+
* * If the image that you want to import uses the Arm64 architecture, configure the real-time clock (RTC) to use the Coordinated Universal Time (UTC) time standard. For more information, see [Linux time and time zones](~~405080~~).
|
|
33360
|
+
* * When you import images, we recommend that you specify DetectionStrategy. This way, you can optimize the images based on the image check results. For more information, see [Overview](~~439819~~).
|
|
32767
33361
|
*
|
|
32768
33362
|
* @param request ImportImageRequest
|
|
32769
33363
|
* @return ImportImageResponse
|
|
@@ -32828,21 +33422,21 @@ export default class Client extends OpenApi {
|
|
|
32828
33422
|
*/
|
|
32829
33423
|
installCloudAssistant(request: InstallCloudAssistantRequest): Promise<InstallCloudAssistantResponse>;
|
|
32830
33424
|
/**
|
|
32831
|
-
* ## Usage notes
|
|
32832
|
-
* * ECS instances on which you want to run the Cloud Assistant command must meet the following requirements. If multiple ECS instances are specified and one of the instances does not meet the requirements for running the command, the call fails. You must specify instances that meet the requirements and call the InvokeCommand operation again.
|
|
32833
|
-
* * The instances are in the Running (`Running`) state. You can call the [DescribeInstances](~~25506~~) operation to query
|
|
33425
|
+
* ## [](#)Usage notes
|
|
33426
|
+
* * The Elastic Compute Service (ECS) instances on which you want to run the Cloud Assistant command must meet the following requirements. If multiple ECS instances are specified and one of the instances does not meet the requirements for running the command, the call fails. You must specify instances that meet the requirements and call the InvokeCommand operation again.
|
|
33427
|
+
* * The instances are in the Running (`Running`) state. You can call the [DescribeInstances](~~25506~~) operation to query the status of instances.
|
|
32834
33428
|
* * Cloud Assistant Agent is installed on the instances. For more information, see [Install Cloud Assistant Agent](~~64921~~).
|
|
32835
33429
|
* * Before you run PowerShell commands on the instances, make sure that the instances have the PowerShell module configured.
|
|
32836
|
-
* *
|
|
32837
|
-
* *
|
|
32838
|
-
* * The schedule is specified by the Frequency parameter. The results of each execution of
|
|
32839
|
-
* * If you
|
|
32840
|
-
*
|
|
33430
|
+
* * You can configure the command to run only once on the instances.
|
|
33431
|
+
* * You can configure the command to run multiple times on the instances based on a schedule.
|
|
33432
|
+
* * The schedule is specified by the Frequency parameter. The results of each execution of the command do not affect the next execution of the command.
|
|
33433
|
+
* * If you use a cron expression to specify a schedule, you can specify a time zone based on your business requirements. If you do not specify a time zone, the schedule is determined by the system time of the instance. Make sure that the time or time zone of the instance meets your business requirements. For more information, see [Configure the NTP service for ECS instances that run CentOS 6](~~92803~~) or [Configure the NTP service for Windows instances](~~51890~~).
|
|
33434
|
+
* To ensure that scheduled tasks can run as expected, make sure that the version of Cloud Assistant Agent is not earlier than the following ones. You can configure a command to run at a fixed interval based on a rate expression, run only once at a specified time, or run at designated times based on a cron expression. If the ClientNeedUpgrade error code is returned, you must upgrade Cloud Assistant Agent to the latest version. For more information, see [Upgrade or disable upgrades for Cloud Assistant Agent](~~134383~~).
|
|
32841
33435
|
* * Linux: 2.2.3.282
|
|
32842
33436
|
* * Windows: 2.1.3.282
|
|
32843
33437
|
* * Commands may fail to run due to instance status exceptions, network exceptions, or exceptions on Cloud Assistant Agent. If a command fails to run, no execution information is generated. For more information, see [Check execution results and troubleshoot common issues](~~87029~~).
|
|
32844
|
-
* * If you
|
|
32845
|
-
* * Before you run
|
|
33438
|
+
* * If you enabled the custom parameter feature when you created the command, you must specify custom parameters (`Parameters`) to run the command.
|
|
33439
|
+
* * Before you run the command on instances, especially new instances, we recommend that you call the [DescribeCloudAssistantStatus](~~87346~~) operation to query the status of Cloud Assistant Agent on the instances. Run the command when the return value of CloudAssistantStatus is true.
|
|
32846
33440
|
*
|
|
32847
33441
|
* @param tmpReq InvokeCommandRequest
|
|
32848
33442
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -32850,21 +33444,21 @@ export default class Client extends OpenApi {
|
|
|
32850
33444
|
*/
|
|
32851
33445
|
invokeCommandWithOptions(tmpReq: InvokeCommandRequest, runtime: $Util.RuntimeOptions): Promise<InvokeCommandResponse>;
|
|
32852
33446
|
/**
|
|
32853
|
-
* ## Usage notes
|
|
32854
|
-
* * ECS instances on which you want to run the Cloud Assistant command must meet the following requirements. If multiple ECS instances are specified and one of the instances does not meet the requirements for running the command, the call fails. You must specify instances that meet the requirements and call the InvokeCommand operation again.
|
|
32855
|
-
* * The instances are in the Running (`Running`) state. You can call the [DescribeInstances](~~25506~~) operation to query
|
|
33447
|
+
* ## [](#)Usage notes
|
|
33448
|
+
* * The Elastic Compute Service (ECS) instances on which you want to run the Cloud Assistant command must meet the following requirements. If multiple ECS instances are specified and one of the instances does not meet the requirements for running the command, the call fails. You must specify instances that meet the requirements and call the InvokeCommand operation again.
|
|
33449
|
+
* * The instances are in the Running (`Running`) state. You can call the [DescribeInstances](~~25506~~) operation to query the status of instances.
|
|
32856
33450
|
* * Cloud Assistant Agent is installed on the instances. For more information, see [Install Cloud Assistant Agent](~~64921~~).
|
|
32857
33451
|
* * Before you run PowerShell commands on the instances, make sure that the instances have the PowerShell module configured.
|
|
32858
|
-
* *
|
|
32859
|
-
* *
|
|
32860
|
-
* * The schedule is specified by the Frequency parameter. The results of each execution of
|
|
32861
|
-
* * If you
|
|
32862
|
-
*
|
|
33452
|
+
* * You can configure the command to run only once on the instances.
|
|
33453
|
+
* * You can configure the command to run multiple times on the instances based on a schedule.
|
|
33454
|
+
* * The schedule is specified by the Frequency parameter. The results of each execution of the command do not affect the next execution of the command.
|
|
33455
|
+
* * If you use a cron expression to specify a schedule, you can specify a time zone based on your business requirements. If you do not specify a time zone, the schedule is determined by the system time of the instance. Make sure that the time or time zone of the instance meets your business requirements. For more information, see [Configure the NTP service for ECS instances that run CentOS 6](~~92803~~) or [Configure the NTP service for Windows instances](~~51890~~).
|
|
33456
|
+
* To ensure that scheduled tasks can run as expected, make sure that the version of Cloud Assistant Agent is not earlier than the following ones. You can configure a command to run at a fixed interval based on a rate expression, run only once at a specified time, or run at designated times based on a cron expression. If the ClientNeedUpgrade error code is returned, you must upgrade Cloud Assistant Agent to the latest version. For more information, see [Upgrade or disable upgrades for Cloud Assistant Agent](~~134383~~).
|
|
32863
33457
|
* * Linux: 2.2.3.282
|
|
32864
33458
|
* * Windows: 2.1.3.282
|
|
32865
33459
|
* * Commands may fail to run due to instance status exceptions, network exceptions, or exceptions on Cloud Assistant Agent. If a command fails to run, no execution information is generated. For more information, see [Check execution results and troubleshoot common issues](~~87029~~).
|
|
32866
|
-
* * If you
|
|
32867
|
-
* * Before you run
|
|
33460
|
+
* * If you enabled the custom parameter feature when you created the command, you must specify custom parameters (`Parameters`) to run the command.
|
|
33461
|
+
* * Before you run the command on instances, especially new instances, we recommend that you call the [DescribeCloudAssistantStatus](~~87346~~) operation to query the status of Cloud Assistant Agent on the instances. Run the command when the return value of CloudAssistantStatus is true.
|
|
32868
33462
|
*
|
|
32869
33463
|
* @param request InvokeCommandRequest
|
|
32870
33464
|
* @return InvokeCommandResponse
|
|
@@ -32886,16 +33480,16 @@ export default class Client extends OpenApi {
|
|
|
32886
33480
|
*/
|
|
32887
33481
|
joinResourceGroup(request: JoinResourceGroupRequest): Promise<JoinResourceGroupResponse>;
|
|
32888
33482
|
/**
|
|
32889
|
-
* ## Usage notes
|
|
32890
|
-
* >
|
|
33483
|
+
* ## [](#)Usage notes
|
|
33484
|
+
* > This operation is not recommended. We recommend that you call the [ModifyInstanceAttribute](~~25503~~) operation to add an instance to or remove an instance from a security group, and call the [ModifyNetworkInterfaceAttribute](~~58513~~) operation to add an ENI to or remove an ENI from a security group.
|
|
32891
33485
|
* Take note of the following items:
|
|
32892
|
-
* * Before you add an instance to a security group, the instance must be in the **Stopped** or **Running** state.
|
|
32893
|
-
* * An instance can be added to up to five security groups.
|
|
32894
|
-
* *
|
|
33486
|
+
* * Before you add an instance to a security group, the instance must be in the **Stopped** (Stopped) or **Running** (Running) state.
|
|
33487
|
+
* * An instance can be added to up to five security groups by default.
|
|
33488
|
+
* * To add an instance to more security groups, [submit a ticket](https://workorder-intl.console.aliyun.com/#/ticket/createIndex). An instance can be added to up to 16 security groups.
|
|
32895
33489
|
* * A basic security group can contain up to 2,000 instances. An advanced security group can contain up to 65,536 instances.
|
|
32896
33490
|
* * The security group and the instance must reside in the same region.
|
|
32897
|
-
* * The security group and the instance must be of the same network type. If the network type is virtual private cloud (VPC), the security group and the instance must
|
|
32898
|
-
* * An instance and an ENI cannot be added to a security group at the same time. You cannot
|
|
33491
|
+
* * The security group and the instance must be of the same network type. If the network type is virtual private cloud (VPC), the security group and the instance must reside in the same VPC.
|
|
33492
|
+
* * An instance and an ENI cannot be added to a security group at the same time. You cannot specify `InstanceId` and `NetworkInterfaceId` at the same time in a request.
|
|
32899
33493
|
*
|
|
32900
33494
|
* @param request JoinSecurityGroupRequest
|
|
32901
33495
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -32903,16 +33497,16 @@ export default class Client extends OpenApi {
|
|
|
32903
33497
|
*/
|
|
32904
33498
|
joinSecurityGroupWithOptions(request: JoinSecurityGroupRequest, runtime: $Util.RuntimeOptions): Promise<JoinSecurityGroupResponse>;
|
|
32905
33499
|
/**
|
|
32906
|
-
* ## Usage notes
|
|
32907
|
-
* >
|
|
33500
|
+
* ## [](#)Usage notes
|
|
33501
|
+
* > This operation is not recommended. We recommend that you call the [ModifyInstanceAttribute](~~25503~~) operation to add an instance to or remove an instance from a security group, and call the [ModifyNetworkInterfaceAttribute](~~58513~~) operation to add an ENI to or remove an ENI from a security group.
|
|
32908
33502
|
* Take note of the following items:
|
|
32909
|
-
* * Before you add an instance to a security group, the instance must be in the **Stopped** or **Running** state.
|
|
32910
|
-
* * An instance can be added to up to five security groups.
|
|
32911
|
-
* *
|
|
33503
|
+
* * Before you add an instance to a security group, the instance must be in the **Stopped** (Stopped) or **Running** (Running) state.
|
|
33504
|
+
* * An instance can be added to up to five security groups by default.
|
|
33505
|
+
* * To add an instance to more security groups, [submit a ticket](https://workorder-intl.console.aliyun.com/#/ticket/createIndex). An instance can be added to up to 16 security groups.
|
|
32912
33506
|
* * A basic security group can contain up to 2,000 instances. An advanced security group can contain up to 65,536 instances.
|
|
32913
33507
|
* * The security group and the instance must reside in the same region.
|
|
32914
|
-
* * The security group and the instance must be of the same network type. If the network type is virtual private cloud (VPC), the security group and the instance must
|
|
32915
|
-
* * An instance and an ENI cannot be added to a security group at the same time. You cannot
|
|
33508
|
+
* * The security group and the instance must be of the same network type. If the network type is virtual private cloud (VPC), the security group and the instance must reside in the same VPC.
|
|
33509
|
+
* * An instance and an ENI cannot be added to a security group at the same time. You cannot specify `InstanceId` and `NetworkInterfaceId` at the same time in a request.
|
|
32916
33510
|
*
|
|
32917
33511
|
* @param request JoinSecurityGroupRequest
|
|
32918
33512
|
* @return JoinSecurityGroupResponse
|
|
@@ -33048,6 +33642,8 @@ export default class Client extends OpenApi {
|
|
|
33048
33642
|
modifyBandwidthPackageSpec(request: ModifyBandwidthPackageSpecRequest): Promise<ModifyBandwidthPackageSpecResponse>;
|
|
33049
33643
|
modifyCapacityReservationWithOptions(request: ModifyCapacityReservationRequest, runtime: $Util.RuntimeOptions): Promise<ModifyCapacityReservationResponse>;
|
|
33050
33644
|
modifyCapacityReservation(request: ModifyCapacityReservationRequest): Promise<ModifyCapacityReservationResponse>;
|
|
33645
|
+
modifyCloudAssistantSettingsWithOptions(tmpReq: ModifyCloudAssistantSettingsRequest, runtime: $Util.RuntimeOptions): Promise<ModifyCloudAssistantSettingsResponse>;
|
|
33646
|
+
modifyCloudAssistantSettings(request: ModifyCloudAssistantSettingsRequest): Promise<ModifyCloudAssistantSettingsResponse>;
|
|
33051
33647
|
/**
|
|
33052
33648
|
* You can modify a command when it is run. After the command is modified, the new command content applies to subsequent executions.
|
|
33053
33649
|
* You cannot modify the command type. For example, you cannot change a shell command (RunShellScript) to a batch command (RunBatScript).
|
|
@@ -33191,7 +33787,44 @@ export default class Client extends OpenApi {
|
|
|
33191
33787
|
* @return ModifyDiskChargeTypeResponse
|
|
33192
33788
|
*/
|
|
33193
33789
|
modifyDiskChargeType(request: ModifyDiskChargeTypeRequest): Promise<ModifyDiskChargeTypeResponse>;
|
|
33790
|
+
/**
|
|
33791
|
+
* ### [](#)Usage notes
|
|
33792
|
+
* > The Dedicated Block Storage Cluster feature is available in the following regions: China (Hangzhou), China (Shanghai), China (Beijing), China (Zhangjiakou), China (Ulanqab), China (Shenzhen), China (Heyuan), Indonesia (Jakarta), Germany (Frankfurt), and China South 1 Finance.
|
|
33793
|
+
* Before you call the ModifyDiskDeployment operation, make sure that you fully understand the billing methods and prices of disks and dedicated block storage clusters. In addition, make sure that the dedicated block storage clusters are unexpired and your account has no overdue payments. For more information, see [Dedicated block storage cluster](~~208883~~) and [Block storage devices](~~179022~~).
|
|
33794
|
+
* Take note of the following items:
|
|
33795
|
+
* * The disks and a dedicated block storage cluster to which you want to migrate the disk must be in the same zone.
|
|
33796
|
+
* * You can migrate only pay-as-you-go disks. If you want to migrate subscription disks, change the disks to pay-as-you-go disks first. For more information, see [Change the billing method of a disk](~~145018~~).
|
|
33797
|
+
* * The specifications of disks that you want to migrate to a destination block storage cluster must the same as the disk specifications that the destination dedicated block storage cluster supports. During migration, you can change the specifications of the disks to ensure specification consistency.
|
|
33798
|
+
* * The disk must be in the **In Use** (In_Use) or **Available** (Available) state.
|
|
33799
|
+
* * If the disk is attached to an Elastic Compute Service (ECS) instance, the instance must be in the **Running** (Running) or **Stopped** (Stopped) state. The ECS instance cannot be in the Expired state.
|
|
33800
|
+
* * The performance level of an enhanced SSD (ESSD) is limited by the ESSD disk size. If you cannot upgrade the performance level of an ESSD, you can resize the ESSD. For more information, see [ResizeDisk](~~25522~~) and [ESSDs](~~122389~~).
|
|
33801
|
+
* * An account can perform up to five disk migration tasks in the same region at the same time.
|
|
33802
|
+
* * When a disk is being migrated, you cannot cancel the migration task, create snapshots for the disk, change the disk configurations, resize the disk, mount the disk, unmount the disk, or re-initialize the disk.
|
|
33803
|
+
* > After you migrate a disk to a destination cluster by calling the ModifyDiskDeployment operation, the billing method, disk specifications, and capabilities of the destination cluster take effect immediately on the disk. Alibaba Cloud charges the disk based on the disk category and performance level. For more information, see [Dedicated block storage cluster](~~208883~~) and [Block storage devices](~~179022~~).
|
|
33804
|
+
*
|
|
33805
|
+
* @param request ModifyDiskDeploymentRequest
|
|
33806
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
33807
|
+
* @return ModifyDiskDeploymentResponse
|
|
33808
|
+
*/
|
|
33194
33809
|
modifyDiskDeploymentWithOptions(request: ModifyDiskDeploymentRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDiskDeploymentResponse>;
|
|
33810
|
+
/**
|
|
33811
|
+
* ### [](#)Usage notes
|
|
33812
|
+
* > The Dedicated Block Storage Cluster feature is available in the following regions: China (Hangzhou), China (Shanghai), China (Beijing), China (Zhangjiakou), China (Ulanqab), China (Shenzhen), China (Heyuan), Indonesia (Jakarta), Germany (Frankfurt), and China South 1 Finance.
|
|
33813
|
+
* Before you call the ModifyDiskDeployment operation, make sure that you fully understand the billing methods and prices of disks and dedicated block storage clusters. In addition, make sure that the dedicated block storage clusters are unexpired and your account has no overdue payments. For more information, see [Dedicated block storage cluster](~~208883~~) and [Block storage devices](~~179022~~).
|
|
33814
|
+
* Take note of the following items:
|
|
33815
|
+
* * The disks and a dedicated block storage cluster to which you want to migrate the disk must be in the same zone.
|
|
33816
|
+
* * You can migrate only pay-as-you-go disks. If you want to migrate subscription disks, change the disks to pay-as-you-go disks first. For more information, see [Change the billing method of a disk](~~145018~~).
|
|
33817
|
+
* * The specifications of disks that you want to migrate to a destination block storage cluster must the same as the disk specifications that the destination dedicated block storage cluster supports. During migration, you can change the specifications of the disks to ensure specification consistency.
|
|
33818
|
+
* * The disk must be in the **In Use** (In_Use) or **Available** (Available) state.
|
|
33819
|
+
* * If the disk is attached to an Elastic Compute Service (ECS) instance, the instance must be in the **Running** (Running) or **Stopped** (Stopped) state. The ECS instance cannot be in the Expired state.
|
|
33820
|
+
* * The performance level of an enhanced SSD (ESSD) is limited by the ESSD disk size. If you cannot upgrade the performance level of an ESSD, you can resize the ESSD. For more information, see [ResizeDisk](~~25522~~) and [ESSDs](~~122389~~).
|
|
33821
|
+
* * An account can perform up to five disk migration tasks in the same region at the same time.
|
|
33822
|
+
* * When a disk is being migrated, you cannot cancel the migration task, create snapshots for the disk, change the disk configurations, resize the disk, mount the disk, unmount the disk, or re-initialize the disk.
|
|
33823
|
+
* > After you migrate a disk to a destination cluster by calling the ModifyDiskDeployment operation, the billing method, disk specifications, and capabilities of the destination cluster take effect immediately on the disk. Alibaba Cloud charges the disk based on the disk category and performance level. For more information, see [Dedicated block storage cluster](~~208883~~) and [Block storage devices](~~179022~~).
|
|
33824
|
+
*
|
|
33825
|
+
* @param request ModifyDiskDeploymentRequest
|
|
33826
|
+
* @return ModifyDiskDeploymentResponse
|
|
33827
|
+
*/
|
|
33195
33828
|
modifyDiskDeployment(request: ModifyDiskDeploymentRequest): Promise<ModifyDiskDeploymentResponse>;
|
|
33196
33829
|
/**
|
|
33197
33830
|
* ## Usage notes
|
|
@@ -33293,17 +33926,18 @@ export default class Client extends OpenApi {
|
|
|
33293
33926
|
*/
|
|
33294
33927
|
modifyImageShareGroupPermission(request: ModifyImageShareGroupPermissionRequest): Promise<ModifyImageShareGroupPermissionResponse>;
|
|
33295
33928
|
/**
|
|
33296
|
-
*
|
|
33297
|
-
*
|
|
33298
|
-
* * You can share
|
|
33299
|
-
* * You can share a custom image
|
|
33300
|
-
* *
|
|
33929
|
+
* ## [](#)Usage notes
|
|
33930
|
+
* Take note of the following items:
|
|
33931
|
+
* * You can share only your own custom images to other Alibaba Cloud accounts.
|
|
33932
|
+
* * You can share a custom image to up to 10 Alibaba Cloud accounts at a time. You can specify up to 10 Alibaba Cloud account IDs by using AddAccount.N or RemoveAccount.N. If you specify more than 10 account IDs, the system processes only the first 10 account IDs. The excess account IDs are ignored.
|
|
33933
|
+
* * You can share a custom image to up to 50 Alibaba Cloud accounts.
|
|
33934
|
+
* * If an Elastic Compute Service (ECS) instance was created ([RunInstances](~~63440~~)) from a shared image, you cannot re-initialize the instance ([ReInitDisk](~~25519~~)) after the image owner unshares or deletes the image ([DeleteImage](~~25537~~)).
|
|
33301
33935
|
* When you publish or unpublish a community image, take note of the following items:
|
|
33302
|
-
* * Alibaba Cloud provides only the platform on which community images can be published and managed. The owner of a community image is responsible for the quality and updates of the image. Make sure that you
|
|
33936
|
+
* * Alibaba Cloud provides only the platform on which community images can be published and managed. The owner of a community image is responsible for the quality and updates of the image. Make sure that you acknowledge and agree to the Community Image Agreement. Otherwise, you cannot publish community images. For more information, see [Publish a community image](~~208370~~).
|
|
33303
33937
|
* * You cannot publish encrypted images as community images.
|
|
33304
|
-
* *
|
|
33938
|
+
* * Community images are publicly available. A community image is available to all Alibaba Cloud accounts in the region where the image resides.
|
|
33305
33939
|
* * You cannot share, export, or copy community images.
|
|
33306
|
-
* * After a community image
|
|
33940
|
+
* * After you unpublish a community image, the image is no longer available to other Alibaba Cloud accounts. If an image is shared to other Alibaba Cloud accounts before it is unpublished, the image remains available to the accounts.
|
|
33307
33941
|
*
|
|
33308
33942
|
* @param request ModifyImageSharePermissionRequest
|
|
33309
33943
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -33311,17 +33945,18 @@ export default class Client extends OpenApi {
|
|
|
33311
33945
|
*/
|
|
33312
33946
|
modifyImageSharePermissionWithOptions(request: ModifyImageSharePermissionRequest, runtime: $Util.RuntimeOptions): Promise<ModifyImageSharePermissionResponse>;
|
|
33313
33947
|
/**
|
|
33314
|
-
*
|
|
33315
|
-
*
|
|
33316
|
-
* * You can share
|
|
33317
|
-
* * You can share a custom image
|
|
33318
|
-
* *
|
|
33948
|
+
* ## [](#)Usage notes
|
|
33949
|
+
* Take note of the following items:
|
|
33950
|
+
* * You can share only your own custom images to other Alibaba Cloud accounts.
|
|
33951
|
+
* * You can share a custom image to up to 10 Alibaba Cloud accounts at a time. You can specify up to 10 Alibaba Cloud account IDs by using AddAccount.N or RemoveAccount.N. If you specify more than 10 account IDs, the system processes only the first 10 account IDs. The excess account IDs are ignored.
|
|
33952
|
+
* * You can share a custom image to up to 50 Alibaba Cloud accounts.
|
|
33953
|
+
* * If an Elastic Compute Service (ECS) instance was created ([RunInstances](~~63440~~)) from a shared image, you cannot re-initialize the instance ([ReInitDisk](~~25519~~)) after the image owner unshares or deletes the image ([DeleteImage](~~25537~~)).
|
|
33319
33954
|
* When you publish or unpublish a community image, take note of the following items:
|
|
33320
|
-
* * Alibaba Cloud provides only the platform on which community images can be published and managed. The owner of a community image is responsible for the quality and updates of the image. Make sure that you
|
|
33955
|
+
* * Alibaba Cloud provides only the platform on which community images can be published and managed. The owner of a community image is responsible for the quality and updates of the image. Make sure that you acknowledge and agree to the Community Image Agreement. Otherwise, you cannot publish community images. For more information, see [Publish a community image](~~208370~~).
|
|
33321
33956
|
* * You cannot publish encrypted images as community images.
|
|
33322
|
-
* *
|
|
33957
|
+
* * Community images are publicly available. A community image is available to all Alibaba Cloud accounts in the region where the image resides.
|
|
33323
33958
|
* * You cannot share, export, or copy community images.
|
|
33324
|
-
* * After a community image
|
|
33959
|
+
* * After you unpublish a community image, the image is no longer available to other Alibaba Cloud accounts. If an image is shared to other Alibaba Cloud accounts before it is unpublished, the image remains available to the accounts.
|
|
33325
33960
|
*
|
|
33326
33961
|
* @param request ModifyImageSharePermissionRequest
|
|
33327
33962
|
* @return ModifyImageSharePermissionResponse
|
|
@@ -33553,16 +34188,17 @@ export default class Client extends OpenApi {
|
|
|
33553
34188
|
*/
|
|
33554
34189
|
modifyInstanceNetworkSpec(request: ModifyInstanceNetworkSpecRequest): Promise<ModifyInstanceNetworkSpecResponse>;
|
|
33555
34190
|
/**
|
|
34191
|
+
* ## [](#)Usage notes
|
|
33556
34192
|
* For information about how to use ECS SDK for Python to change resource configurations, see [Query available resources for configuration changes](~~109517~~).
|
|
33557
34193
|
* Take note of the following items:
|
|
33558
34194
|
* * Make sure that you have no overdue payments in your account.
|
|
33559
|
-
* * You can
|
|
33560
|
-
* * Before you change the instance type of a pay-as-you-go instance,
|
|
34195
|
+
* * You can adjust the public bandwidth of an instance only when the instance is in the **Running** (`Running`) or **Stopped** (`Stopped`) state.
|
|
34196
|
+
* * Before you change the instance type of a pay-as-you-go instance, call the [DescribeResourcesModification](~~66187~~) operation to query compatible instance types.
|
|
33561
34197
|
* * You can change the instance type of an instance only when the instance is in the **Stopped** (`Stopped`) state.
|
|
33562
34198
|
* * The instance type and the public bandwidth of an instance cannot be changed together.
|
|
33563
|
-
* *
|
|
33564
|
-
* *
|
|
33565
|
-
* *
|
|
34199
|
+
* * Starting November 27, 2020, the maximum bandwidth value that is available for you to create ECS instances or change ECS instance configurations is subject to the throttling policy of your account. To increase the maximum bandwidth value, submit a ticket. The following throttling policies apply:
|
|
34200
|
+
* * In each region, the sum of actual maximum bandwidths of all ECS instances that use the pay-by-traffic billing method for network usage cannot exceed 5 Gbit/s.
|
|
34201
|
+
* * In each region, the sum of actual maximum bandwidths of all ECS instances that use the pay-by-bandwidth billing method for network usage cannot exceed 50 Gbit/s.
|
|
33566
34202
|
*
|
|
33567
34203
|
* @param request ModifyInstanceSpecRequest
|
|
33568
34204
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -33570,16 +34206,17 @@ export default class Client extends OpenApi {
|
|
|
33570
34206
|
*/
|
|
33571
34207
|
modifyInstanceSpecWithOptions(request: ModifyInstanceSpecRequest, runtime: $Util.RuntimeOptions): Promise<ModifyInstanceSpecResponse>;
|
|
33572
34208
|
/**
|
|
34209
|
+
* ## [](#)Usage notes
|
|
33573
34210
|
* For information about how to use ECS SDK for Python to change resource configurations, see [Query available resources for configuration changes](~~109517~~).
|
|
33574
34211
|
* Take note of the following items:
|
|
33575
34212
|
* * Make sure that you have no overdue payments in your account.
|
|
33576
|
-
* * You can
|
|
33577
|
-
* * Before you change the instance type of a pay-as-you-go instance,
|
|
34213
|
+
* * You can adjust the public bandwidth of an instance only when the instance is in the **Running** (`Running`) or **Stopped** (`Stopped`) state.
|
|
34214
|
+
* * Before you change the instance type of a pay-as-you-go instance, call the [DescribeResourcesModification](~~66187~~) operation to query compatible instance types.
|
|
33578
34215
|
* * You can change the instance type of an instance only when the instance is in the **Stopped** (`Stopped`) state.
|
|
33579
34216
|
* * The instance type and the public bandwidth of an instance cannot be changed together.
|
|
33580
|
-
* *
|
|
33581
|
-
* *
|
|
33582
|
-
* *
|
|
34217
|
+
* * Starting November 27, 2020, the maximum bandwidth value that is available for you to create ECS instances or change ECS instance configurations is subject to the throttling policy of your account. To increase the maximum bandwidth value, submit a ticket. The following throttling policies apply:
|
|
34218
|
+
* * In each region, the sum of actual maximum bandwidths of all ECS instances that use the pay-by-traffic billing method for network usage cannot exceed 5 Gbit/s.
|
|
34219
|
+
* * In each region, the sum of actual maximum bandwidths of all ECS instances that use the pay-by-bandwidth billing method for network usage cannot exceed 50 Gbit/s.
|
|
33583
34220
|
*
|
|
33584
34221
|
* @param request ModifyInstanceSpecRequest
|
|
33585
34222
|
* @return ModifyInstanceSpecResponse
|
|
@@ -33607,17 +34244,18 @@ export default class Client extends OpenApi {
|
|
|
33607
34244
|
*/
|
|
33608
34245
|
modifyInstanceVncPasswd(request: ModifyInstanceVncPasswdRequest): Promise<ModifyInstanceVncPasswdResponse>;
|
|
33609
34246
|
/**
|
|
33610
|
-
*
|
|
34247
|
+
* ## [](#)Usage notes
|
|
34248
|
+
* The instance that you want to manage must be in the **Stopped** (`Stopped`) state.
|
|
33611
34249
|
* * When you call this operation to change the private IP address or vSwitch of an instance, take note of the following items:
|
|
33612
34250
|
* * If the instance is a new instance, you must restart the instance before you call this operation.
|
|
33613
|
-
* * After the private IP address or vSwitch of the instance is changed, you must restart the instance before you
|
|
34251
|
+
* * After the private IP address or vSwitch of the instance is changed, you must restart the instance before you can recall this operation.
|
|
33614
34252
|
* * When you call this operation to change the VPC of an instance, take note of the following items:
|
|
33615
34253
|
* * **Instance:**
|
|
33616
34254
|
* * The instance cannot be associated with Server Load Balancer (SLB) instances.
|
|
33617
|
-
* * The instance cannot be in the Locked, To Be Released, Expired, Expired and Being Recycled, or Overdue and Being Recycled state. For more information, see [
|
|
34255
|
+
* * The instance cannot be in the Locked, To Be Released, Expired, Expired and Being Recycled, or Overdue and Being Recycled state. For more information, see [Instance lifecycle](~~25380~~).
|
|
33618
34256
|
* * The instance cannot be used in other Alibaba Cloud services. For example, the instance cannot be in the process of being migrated or having its VPC changed, or the databases deployed on the instance cannot be managed by Data Transmission Service (DTS).
|
|
33619
34257
|
* * **Network:**
|
|
33620
|
-
* * The cut-through mode or the multi-EIP-to-ENI mode cannot be enabled for the instance.
|
|
34258
|
+
* * The cut-through mode or the multi-elastic IP address (EIP)-to-elastic network interface (ENI) mode cannot be enabled for the instance.
|
|
33621
34259
|
* * The instance cannot be associated with a high-availability virtual IP address (HAVIP).
|
|
33622
34260
|
* * The vSwitch of the instance cannot be associated with a custom route table.
|
|
33623
34261
|
* * Global Accelerator (GA) cannot be activated for the instance.
|
|
@@ -33626,14 +34264,13 @@ export default class Client extends OpenApi {
|
|
|
33626
34264
|
* * The primary ENI of the instance cannot be associated with multiple IP addresses.
|
|
33627
34265
|
* * The new vSwitch that you specify must belong to the new VPC.
|
|
33628
34266
|
* * The original and new vSwitches must reside in the same zone.
|
|
33629
|
-
* * If you assign a private IP address to the primary ENI of the instance, the private IP address must an idle IP address within the CIDR block of the new vSwitch. If you do not assign a private IP address to the primary ENI of the instance, a private IP address is randomly assigned to the ENI.
|
|
33630
|
-
* * If advanced features are enabled for the new VPC, take note of the instance families that do not support advanced VPC features. For more information, see [Instance families that do not support advanced VPC features](~~163466~~).
|
|
34267
|
+
* * If you assign a private IP address to the primary ENI of the instance, the private IP address must be an idle IP address within the CIDR block of the new vSwitch. If you do not assign a private IP address to the primary ENI of the instance, a private IP address is randomly assigned to the ENI. Make sure that sufficient IP addresses are available in the CIDR block of the new vSwitch.
|
|
33631
34268
|
* * The Alibaba Cloud account that owns the new VPC cannot share the VPC with other accounts.
|
|
33632
34269
|
* * **Security group (SecurityGroupId.N):**
|
|
33633
34270
|
* * All security groups must be of the same type.
|
|
33634
|
-
* * The valid values of N
|
|
34271
|
+
* * The valid values of N vary based on the maximum number of security groups to which an instance can belong. For more information, see the "Security group limits" section in [Limits](~~25412~~).
|
|
33635
34272
|
* * The security groups that you specify must belong to the new VPC.
|
|
33636
|
-
* * You can switch the instance to
|
|
34273
|
+
* * You can switch the instance to security groups of a different type. To ensure network connectivity, we recommend that you understand the differences in rule configurations of the two security group types before you switch an instance to security groups of a different type. For more information, see [Overview](~~25387~~).
|
|
33637
34274
|
*
|
|
33638
34275
|
* @param request ModifyInstanceVpcAttributeRequest
|
|
33639
34276
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -33641,17 +34278,18 @@ export default class Client extends OpenApi {
|
|
|
33641
34278
|
*/
|
|
33642
34279
|
modifyInstanceVpcAttributeWithOptions(request: ModifyInstanceVpcAttributeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyInstanceVpcAttributeResponse>;
|
|
33643
34280
|
/**
|
|
33644
|
-
*
|
|
34281
|
+
* ## [](#)Usage notes
|
|
34282
|
+
* The instance that you want to manage must be in the **Stopped** (`Stopped`) state.
|
|
33645
34283
|
* * When you call this operation to change the private IP address or vSwitch of an instance, take note of the following items:
|
|
33646
34284
|
* * If the instance is a new instance, you must restart the instance before you call this operation.
|
|
33647
|
-
* * After the private IP address or vSwitch of the instance is changed, you must restart the instance before you
|
|
34285
|
+
* * After the private IP address or vSwitch of the instance is changed, you must restart the instance before you can recall this operation.
|
|
33648
34286
|
* * When you call this operation to change the VPC of an instance, take note of the following items:
|
|
33649
34287
|
* * **Instance:**
|
|
33650
34288
|
* * The instance cannot be associated with Server Load Balancer (SLB) instances.
|
|
33651
|
-
* * The instance cannot be in the Locked, To Be Released, Expired, Expired and Being Recycled, or Overdue and Being Recycled state. For more information, see [
|
|
34289
|
+
* * The instance cannot be in the Locked, To Be Released, Expired, Expired and Being Recycled, or Overdue and Being Recycled state. For more information, see [Instance lifecycle](~~25380~~).
|
|
33652
34290
|
* * The instance cannot be used in other Alibaba Cloud services. For example, the instance cannot be in the process of being migrated or having its VPC changed, or the databases deployed on the instance cannot be managed by Data Transmission Service (DTS).
|
|
33653
34291
|
* * **Network:**
|
|
33654
|
-
* * The cut-through mode or the multi-EIP-to-ENI mode cannot be enabled for the instance.
|
|
34292
|
+
* * The cut-through mode or the multi-elastic IP address (EIP)-to-elastic network interface (ENI) mode cannot be enabled for the instance.
|
|
33655
34293
|
* * The instance cannot be associated with a high-availability virtual IP address (HAVIP).
|
|
33656
34294
|
* * The vSwitch of the instance cannot be associated with a custom route table.
|
|
33657
34295
|
* * Global Accelerator (GA) cannot be activated for the instance.
|
|
@@ -33660,20 +34298,54 @@ export default class Client extends OpenApi {
|
|
|
33660
34298
|
* * The primary ENI of the instance cannot be associated with multiple IP addresses.
|
|
33661
34299
|
* * The new vSwitch that you specify must belong to the new VPC.
|
|
33662
34300
|
* * The original and new vSwitches must reside in the same zone.
|
|
33663
|
-
* * If you assign a private IP address to the primary ENI of the instance, the private IP address must an idle IP address within the CIDR block of the new vSwitch. If you do not assign a private IP address to the primary ENI of the instance, a private IP address is randomly assigned to the ENI.
|
|
33664
|
-
* * If advanced features are enabled for the new VPC, take note of the instance families that do not support advanced VPC features. For more information, see [Instance families that do not support advanced VPC features](~~163466~~).
|
|
34301
|
+
* * If you assign a private IP address to the primary ENI of the instance, the private IP address must be an idle IP address within the CIDR block of the new vSwitch. If you do not assign a private IP address to the primary ENI of the instance, a private IP address is randomly assigned to the ENI. Make sure that sufficient IP addresses are available in the CIDR block of the new vSwitch.
|
|
33665
34302
|
* * The Alibaba Cloud account that owns the new VPC cannot share the VPC with other accounts.
|
|
33666
34303
|
* * **Security group (SecurityGroupId.N):**
|
|
33667
34304
|
* * All security groups must be of the same type.
|
|
33668
|
-
* * The valid values of N
|
|
34305
|
+
* * The valid values of N vary based on the maximum number of security groups to which an instance can belong. For more information, see the "Security group limits" section in [Limits](~~25412~~).
|
|
33669
34306
|
* * The security groups that you specify must belong to the new VPC.
|
|
33670
|
-
* * You can switch the instance to
|
|
34307
|
+
* * You can switch the instance to security groups of a different type. To ensure network connectivity, we recommend that you understand the differences in rule configurations of the two security group types before you switch an instance to security groups of a different type. For more information, see [Overview](~~25387~~).
|
|
33671
34308
|
*
|
|
33672
34309
|
* @param request ModifyInstanceVpcAttributeRequest
|
|
33673
34310
|
* @return ModifyInstanceVpcAttributeResponse
|
|
33674
34311
|
*/
|
|
33675
34312
|
modifyInstanceVpcAttribute(request: ModifyInstanceVpcAttributeRequest): Promise<ModifyInstanceVpcAttributeResponse>;
|
|
34313
|
+
/**
|
|
34314
|
+
* * You can modify the execution information of a command that is run in one of the following modes:
|
|
34315
|
+
* * Period: The command is run on a schedule.
|
|
34316
|
+
* * NextRebootOnly: The command is run the next time the instance starts.
|
|
34317
|
+
* * EveryReboot: The command is run every time the instance starts.
|
|
34318
|
+
* * You can modify the execution information of a command that is in one of the following status (For more information, see the [InvocationStatus](~~64840~~) response parameter of `DescribeInvocations`.):
|
|
34319
|
+
* * Pending: The command is being verified or sent. When the execution status on at least one instance is Pending, the overall execution status is Pending.
|
|
34320
|
+
* * Running: The command is being run on the instance. When the execution status on at least one instance is Running, the overall execution status is Running.
|
|
34321
|
+
* * Scheduled: The command that is set to run on a schedule is sent and waiting to be run. When the execution status on at least one instance is Scheduled, the overall execution status is Scheduled.
|
|
34322
|
+
* * Stopping: The command that is running is being stopped. When the execution status on at least one instance is Stopping, the overall execution status is Stopping.
|
|
34323
|
+
* * The Cloud Assistant Agent version that is installed on the instance must be later than one of the following versions to support the ModifyInvocationAttribute operation. If the `ClientNeedUpgrade` error code is returned, update Cloud Assistant Agent to the latest version.
|
|
34324
|
+
* * Linux: 2.2.3.541
|
|
34325
|
+
* * Windows: 2.1.3.541
|
|
34326
|
+
*
|
|
34327
|
+
* @param tmpReq ModifyInvocationAttributeRequest
|
|
34328
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
34329
|
+
* @return ModifyInvocationAttributeResponse
|
|
34330
|
+
*/
|
|
33676
34331
|
modifyInvocationAttributeWithOptions(tmpReq: ModifyInvocationAttributeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyInvocationAttributeResponse>;
|
|
34332
|
+
/**
|
|
34333
|
+
* * You can modify the execution information of a command that is run in one of the following modes:
|
|
34334
|
+
* * Period: The command is run on a schedule.
|
|
34335
|
+
* * NextRebootOnly: The command is run the next time the instance starts.
|
|
34336
|
+
* * EveryReboot: The command is run every time the instance starts.
|
|
34337
|
+
* * You can modify the execution information of a command that is in one of the following status (For more information, see the [InvocationStatus](~~64840~~) response parameter of `DescribeInvocations`.):
|
|
34338
|
+
* * Pending: The command is being verified or sent. When the execution status on at least one instance is Pending, the overall execution status is Pending.
|
|
34339
|
+
* * Running: The command is being run on the instance. When the execution status on at least one instance is Running, the overall execution status is Running.
|
|
34340
|
+
* * Scheduled: The command that is set to run on a schedule is sent and waiting to be run. When the execution status on at least one instance is Scheduled, the overall execution status is Scheduled.
|
|
34341
|
+
* * Stopping: The command that is running is being stopped. When the execution status on at least one instance is Stopping, the overall execution status is Stopping.
|
|
34342
|
+
* * The Cloud Assistant Agent version that is installed on the instance must be later than one of the following versions to support the ModifyInvocationAttribute operation. If the `ClientNeedUpgrade` error code is returned, update Cloud Assistant Agent to the latest version.
|
|
34343
|
+
* * Linux: 2.2.3.541
|
|
34344
|
+
* * Windows: 2.1.3.541
|
|
34345
|
+
*
|
|
34346
|
+
* @param request ModifyInvocationAttributeRequest
|
|
34347
|
+
* @return ModifyInvocationAttributeResponse
|
|
34348
|
+
*/
|
|
33677
34349
|
modifyInvocationAttribute(request: ModifyInvocationAttributeRequest): Promise<ModifyInvocationAttributeResponse>;
|
|
33678
34350
|
/**
|
|
33679
34351
|
* ## Debugging
|
|
@@ -33727,13 +34399,12 @@ export default class Client extends OpenApi {
|
|
|
33727
34399
|
*/
|
|
33728
34400
|
modifyPhysicalConnectionAttribute(request: ModifyPhysicalConnectionAttributeRequest): Promise<ModifyPhysicalConnectionAttributeResponse>;
|
|
33729
34401
|
/**
|
|
33730
|
-
*
|
|
33731
|
-
* * The specified CIDR block must be valid. For example, 10.0.0.0/8 is a valid CIDR block while 10.0.0.1/8 is not. For more information, see the [What is CIDR?](https://www.alibabacloud.com/help/doc-detail/40637.htm#section-jua-0tj-q5m) section in Network FAQ.
|
|
34402
|
+
* * The specified CIDR block must be valid. For example, 10.0.0.0/8 is a valid CIDR block while 10.0.0.1/8 is not. For more information, see the [What is CIDR?](~~40637~~#section-jua-0tj-q5m) section in the "Network FAQ" topic.
|
|
33732
34403
|
* * When you add or delete an entry, you cannot specify duplicate CIDR blocks. Examples:
|
|
33733
|
-
* * For IPv4 CIDR blocks, you cannot specify the 10.0.0.0/8 CIDR block in two entries. You cannot specify the 10.0.0.1/32 CIDR block in one entry and the 10.0.0.1 CIDR block in another entry.
|
|
33734
|
-
* * For IPv6 CIDR blocks, you cannot specify the 2001:fd01:0:0:0:0:0:0/32 CIDR block in one entry and the 2001:fd01::/32 CIDR block in another entry.
|
|
33735
|
-
* * The CIDR block in an entry to be added cannot the same as that in an entry to be deleted. For example, when you add an entry in which the 10.0.0.0/8 CIDR block is specified,
|
|
33736
|
-
* * If you want to modify the description of an entry, you must specify the CIDR block (`AddEntry.N.Cidr`) and new description (`AddEntry.N.Description`)
|
|
34404
|
+
* * For IPv4 CIDR blocks, you cannot specify the 10.0.0.0/8 CIDR block in two entries. You cannot specify the 10.0.0.1/32 CIDR block in one entry and the 10.0.0.1 CIDR block in another entry. The two CIDR blocks are the same.
|
|
34405
|
+
* * For IPv6 CIDR blocks, you cannot specify the 2001:fd01:0:0:0:0:0:0/32 CIDR block in one entry and the 2001:fd01::/32 CIDR block in another entry. The two CIDR blocks are the same.
|
|
34406
|
+
* * The CIDR block in an entry to be added cannot the same as that in an entry to be deleted. For example, when you add an entry in which the 10.0.0.0/8 CIDR block is specified, make sure the 10.0.0.0/8 CIDR block is not specified in an entry to be deleted.
|
|
34407
|
+
* * If you want to modify the description of an entry, you must specify the CIDR block (`AddEntry.N.Cidr`) and new description (`AddEntry.N.Description`) for the entry.
|
|
33737
34408
|
*
|
|
33738
34409
|
* @param request ModifyPrefixListRequest
|
|
33739
34410
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -33741,31 +34412,29 @@ export default class Client extends OpenApi {
|
|
|
33741
34412
|
*/
|
|
33742
34413
|
modifyPrefixListWithOptions(request: ModifyPrefixListRequest, runtime: $Util.RuntimeOptions): Promise<ModifyPrefixListResponse>;
|
|
33743
34414
|
/**
|
|
33744
|
-
*
|
|
33745
|
-
* * The specified CIDR block must be valid. For example, 10.0.0.0/8 is a valid CIDR block while 10.0.0.1/8 is not. For more information, see the [What is CIDR?](https://www.alibabacloud.com/help/doc-detail/40637.htm#section-jua-0tj-q5m) section in Network FAQ.
|
|
34415
|
+
* * The specified CIDR block must be valid. For example, 10.0.0.0/8 is a valid CIDR block while 10.0.0.1/8 is not. For more information, see the [What is CIDR?](~~40637~~#section-jua-0tj-q5m) section in the "Network FAQ" topic.
|
|
33746
34416
|
* * When you add or delete an entry, you cannot specify duplicate CIDR blocks. Examples:
|
|
33747
|
-
* * For IPv4 CIDR blocks, you cannot specify the 10.0.0.0/8 CIDR block in two entries. You cannot specify the 10.0.0.1/32 CIDR block in one entry and the 10.0.0.1 CIDR block in another entry.
|
|
33748
|
-
* * For IPv6 CIDR blocks, you cannot specify the 2001:fd01:0:0:0:0:0:0/32 CIDR block in one entry and the 2001:fd01::/32 CIDR block in another entry.
|
|
33749
|
-
* * The CIDR block in an entry to be added cannot the same as that in an entry to be deleted. For example, when you add an entry in which the 10.0.0.0/8 CIDR block is specified,
|
|
33750
|
-
* * If you want to modify the description of an entry, you must specify the CIDR block (`AddEntry.N.Cidr`) and new description (`AddEntry.N.Description`)
|
|
34417
|
+
* * For IPv4 CIDR blocks, you cannot specify the 10.0.0.0/8 CIDR block in two entries. You cannot specify the 10.0.0.1/32 CIDR block in one entry and the 10.0.0.1 CIDR block in another entry. The two CIDR blocks are the same.
|
|
34418
|
+
* * For IPv6 CIDR blocks, you cannot specify the 2001:fd01:0:0:0:0:0:0/32 CIDR block in one entry and the 2001:fd01::/32 CIDR block in another entry. The two CIDR blocks are the same.
|
|
34419
|
+
* * The CIDR block in an entry to be added cannot the same as that in an entry to be deleted. For example, when you add an entry in which the 10.0.0.0/8 CIDR block is specified, make sure the 10.0.0.0/8 CIDR block is not specified in an entry to be deleted.
|
|
34420
|
+
* * If you want to modify the description of an entry, you must specify the CIDR block (`AddEntry.N.Cidr`) and new description (`AddEntry.N.Description`) for the entry.
|
|
33751
34421
|
*
|
|
33752
34422
|
* @param request ModifyPrefixListRequest
|
|
33753
34423
|
* @return ModifyPrefixListResponse
|
|
33754
34424
|
*/
|
|
33755
34425
|
modifyPrefixList(request: ModifyPrefixListRequest): Promise<ModifyPrefixListResponse>;
|
|
33756
34426
|
/**
|
|
33757
|
-
*
|
|
33758
|
-
* Before you
|
|
33759
|
-
*
|
|
33760
|
-
*
|
|
34427
|
+
* ## [](#)Usage notes
|
|
34428
|
+
* Before you call this operation, we recommend that you familiarize yourself with the billing methods, pricing schedule, and refund rules of [ECS](https://www.alibabacloud.com/product/ecs#pricing). For information about the refund rules, see [Rules for unsubscribing from resources](~~476339~~).
|
|
34429
|
+
* Before you change the instance type of a subscription instance, call the [DescribeResourcesModification](~~66187~~) operation to query the instance types to which you can change the instance. You can use ECS SDK for Python. For more information, see [Query available resources for configuration changes](~~109517~~).
|
|
34430
|
+
* Take note of the following items:
|
|
34431
|
+
* * To change the instance type of an expired instance, you must first renew the instance.
|
|
33761
34432
|
* * When you downgrade the instance type of an instance, take note of the following items:
|
|
33762
|
-
* * The instance must be in the `Stopped` state
|
|
33763
|
-
* *
|
|
33764
|
-
*
|
|
33765
|
-
* * The price difference is refunded to the payment account you used. Vouchers that have been redeemed during purchase are not refundable.
|
|
33766
|
-
* * This operation is asynchronous. It takes 5 to 10 seconds for the instance type to change. You must restart the instance by calling the RebootInstance operation or by using the ECS console for the instance type change to take effect. If you restart only the operating system of the instance, the instance type change does not take effect.
|
|
34433
|
+
* * The instance must be in the **Stopped** (`Stopped`) state.
|
|
34434
|
+
* * The price difference is refunded to the payment account you used. Vouchers that have been redeemed are not refundable.
|
|
34435
|
+
* * The operation is asynchronous. Wait 5 to 10 seconds for the instance type change to complete. Then, restart the instance by calling the RebootInstance operation or by using the ECS console for the instance type change to take effect. If you restart only the operating system of the instance, the instance type change does not take effect.
|
|
33767
34436
|
* * If the instance is in the **Stopped** state, you only need to start the instance. You do not need to restart the instance after it enters the Running state.
|
|
33768
|
-
* * If `RebootWhenFinished` is set to true for the instance, you do not need to
|
|
34437
|
+
* * If `RebootWhenFinished` is set to true for the instance, you do not need to restart the instance.
|
|
33769
34438
|
*
|
|
33770
34439
|
* @param request ModifyPrepayInstanceSpecRequest
|
|
33771
34440
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -33773,18 +34442,17 @@ export default class Client extends OpenApi {
|
|
|
33773
34442
|
*/
|
|
33774
34443
|
modifyPrepayInstanceSpecWithOptions(request: ModifyPrepayInstanceSpecRequest, runtime: $Util.RuntimeOptions): Promise<ModifyPrepayInstanceSpecResponse>;
|
|
33775
34444
|
/**
|
|
33776
|
-
*
|
|
33777
|
-
* Before you
|
|
33778
|
-
*
|
|
33779
|
-
*
|
|
34445
|
+
* ## [](#)Usage notes
|
|
34446
|
+
* Before you call this operation, we recommend that you familiarize yourself with the billing methods, pricing schedule, and refund rules of [ECS](https://www.alibabacloud.com/product/ecs#pricing). For information about the refund rules, see [Rules for unsubscribing from resources](~~476339~~).
|
|
34447
|
+
* Before you change the instance type of a subscription instance, call the [DescribeResourcesModification](~~66187~~) operation to query the instance types to which you can change the instance. You can use ECS SDK for Python. For more information, see [Query available resources for configuration changes](~~109517~~).
|
|
34448
|
+
* Take note of the following items:
|
|
34449
|
+
* * To change the instance type of an expired instance, you must first renew the instance.
|
|
33780
34450
|
* * When you downgrade the instance type of an instance, take note of the following items:
|
|
33781
|
-
* * The instance must be in the `Stopped` state
|
|
33782
|
-
* *
|
|
33783
|
-
*
|
|
33784
|
-
* * The price difference is refunded to the payment account you used. Vouchers that have been redeemed during purchase are not refundable.
|
|
33785
|
-
* * This operation is asynchronous. It takes 5 to 10 seconds for the instance type to change. You must restart the instance by calling the RebootInstance operation or by using the ECS console for the instance type change to take effect. If you restart only the operating system of the instance, the instance type change does not take effect.
|
|
34451
|
+
* * The instance must be in the **Stopped** (`Stopped`) state.
|
|
34452
|
+
* * The price difference is refunded to the payment account you used. Vouchers that have been redeemed are not refundable.
|
|
34453
|
+
* * The operation is asynchronous. Wait 5 to 10 seconds for the instance type change to complete. Then, restart the instance by calling the RebootInstance operation or by using the ECS console for the instance type change to take effect. If you restart only the operating system of the instance, the instance type change does not take effect.
|
|
33786
34454
|
* * If the instance is in the **Stopped** state, you only need to start the instance. You do not need to restart the instance after it enters the Running state.
|
|
33787
|
-
* * If `RebootWhenFinished` is set to true for the instance, you do not need to
|
|
34455
|
+
* * If `RebootWhenFinished` is set to true for the instance, you do not need to restart the instance.
|
|
33788
34456
|
*
|
|
33789
34457
|
* @param request ModifyPrepayInstanceSpecRequest
|
|
33790
34458
|
* @return ModifyPrepayInstanceSpecResponse
|
|
@@ -34275,7 +34943,7 @@ export default class Client extends OpenApi {
|
|
|
34275
34943
|
removeTagsWithOptions(request: RemoveTagsRequest, runtime: $Util.RuntimeOptions): Promise<RemoveTagsResponse>;
|
|
34276
34944
|
removeTags(request: RemoveTagsRequest): Promise<RemoveTagsResponse>;
|
|
34277
34945
|
/**
|
|
34278
|
-
*
|
|
34946
|
+
* Valid vouchers can be applied when you renew the subscription plan dedicated hosts. In order to use vouchers, make sure that your account supports the credit card payment method.
|
|
34279
34947
|
*
|
|
34280
34948
|
* @param request RenewDedicatedHostsRequest
|
|
34281
34949
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -34283,7 +34951,7 @@ export default class Client extends OpenApi {
|
|
|
34283
34951
|
*/
|
|
34284
34952
|
renewDedicatedHostsWithOptions(request: RenewDedicatedHostsRequest, runtime: $Util.RuntimeOptions): Promise<RenewDedicatedHostsResponse>;
|
|
34285
34953
|
/**
|
|
34286
|
-
*
|
|
34954
|
+
* Valid vouchers can be applied when you renew the subscription plan dedicated hosts. In order to use vouchers, make sure that your account supports the credit card payment method.
|
|
34287
34955
|
*
|
|
34288
34956
|
* @param request RenewDedicatedHostsRequest
|
|
34289
34957
|
* @return RenewDedicatedHostsResponse
|
|
@@ -34544,23 +35212,23 @@ export default class Client extends OpenApi {
|
|
|
34544
35212
|
*/
|
|
34545
35213
|
revokeSecurityGroupEgress(request: RevokeSecurityGroupEgressRequest): Promise<RevokeSecurityGroupEgressResponse>;
|
|
34546
35214
|
/**
|
|
34547
|
-
* ## Usage notes
|
|
35215
|
+
* ## [](#)Usage notes
|
|
34548
35216
|
* Unlike the [CreateCommand](~~64844~~) and [InvokeCommand](~~64841~~) operations, RunCommand can be used to create and run a command in a single request.
|
|
34549
35217
|
* Take note of the following items:
|
|
34550
35218
|
* * The instances on which you want to run a command must be in the Running (`Running`) state. You can call the [DescribeInstances](~~25506~~) operation to query the status of instances.
|
|
34551
|
-
* * [Cloud Assistant Agent](~~64921~~)
|
|
35219
|
+
* * [Cloud Assistant Agent](~~64921~~) must be installed on the instances.
|
|
34552
35220
|
* * Before you run a PowerShell command on a Windows instance, make sure that the PowerShell module is installed on the instance.
|
|
34553
|
-
* * When you use a cron expression to specify a schedule, you can specify a time zone based on your business requirements. If you do not specify a time zone, the schedule is determined by the system time of the instance. Make sure that the time or time zone of the
|
|
35221
|
+
* * When you use a cron expression to specify a schedule, you can specify a time zone based on your business requirements. If you do not specify a time zone, the schedule is determined by the system time of the instance. Make sure that the time or time zone of the instances meets your business requirements. For information about time zones, see [Configure the NTP service for a CentOS 6 instance](~~92803~~) or [Configure the NTP service for a Windows instance](~~51890~~).
|
|
34554
35222
|
* * You can set `Timeout` to specify the timeout period for executions of the command on ECS instances. If an execution times out, Cloud Assistant Agent forcefully terminates the command process.
|
|
34555
|
-
* * When the one-time execution of
|
|
34556
|
-
* * For a scheduled task, the timeout period takes effect on each execution of the command.
|
|
34557
|
-
*
|
|
34558
|
-
*
|
|
34559
|
-
*
|
|
35223
|
+
* * When the one-time execution of the command times out, the execution state ([InvokeRecordStatus](~~64845~~)) of the command becomes Failed.
|
|
35224
|
+
* * For a scheduled task, the timeout period takes effect on each execution of the command. When a command execution times out, the subsequent executions of the command are not affected. When a scheduled execution of the command times out, the execution state ([InvokeRecordStatus](~~64845~~)) of the command becomes Failed.
|
|
35225
|
+
* To ensure that scheduled tasks can run as expected, make sure that the version of Cloud Assistant Agent is not earlier than the following ones. A scheduled task can run a command at a specified interval, only once at a specified time, or at designated times based on a cron expression in a specified year or time zone. If the `ClientNeedUpgrade` error code is returned, you must update Cloud Assistant Agent to the latest version. For more information, see [Upgrade or disable upgrades for Cloud Assistant Agent](~~134383~~).
|
|
35226
|
+
* - Linux: 2.2.3.282
|
|
35227
|
+
* - Windows: 2.1.3.282
|
|
34560
35228
|
* * Command executions may fail due to instance status exceptions, network exceptions, or exceptions on Cloud Assistant Agent. If a command execution fails, no execution information is generated. For more information, see [Check execution results and troubleshoot common issues](~~87029~~).
|
|
34561
|
-
* *
|
|
34562
|
-
* * You can retain up to 500 to 10,000 Cloud Assistant commands in each region based on your
|
|
34563
|
-
* * Before you run a command on instances, especially new instances, we recommend that you call the [DescribeCloudAssistantStatus](~~87346~~) operation to query the status of Cloud Assistant Agent on the instances
|
|
35229
|
+
* * If you set the `EnableParameter` parameter to true, the custom parameter feature is enabled. When you configure the `CommandContent` parameter, you can define custom parameters in the `{{parameter}}` format. Then, when the command is run, the key-value pairs of the custom parameters are passed in.
|
|
35230
|
+
* * You can retain up to 500 to 10,000 Cloud Assistant commands in each region based on your usage. You can perform operations that are described in the [View and increase resource quotas](~~184115~~) topic or call the [DescribeAccountAttribute](~~73772~~) operation to query resource quotas.
|
|
35231
|
+
* * Before you run a command on instances, especially new instances, we recommend that you call the [DescribeCloudAssistantStatus](~~87346~~) operation to query the status of Cloud Assistant Agent on the instances and run the command when the value of CloudAssistantStatus in the response is true for the instances.
|
|
34564
35232
|
*
|
|
34565
35233
|
* @param tmpReq RunCommandRequest
|
|
34566
35234
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -34568,50 +35236,141 @@ export default class Client extends OpenApi {
|
|
|
34568
35236
|
*/
|
|
34569
35237
|
runCommandWithOptions(tmpReq: RunCommandRequest, runtime: $Util.RuntimeOptions): Promise<RunCommandResponse>;
|
|
34570
35238
|
/**
|
|
34571
|
-
* ## Usage notes
|
|
35239
|
+
* ## [](#)Usage notes
|
|
34572
35240
|
* Unlike the [CreateCommand](~~64844~~) and [InvokeCommand](~~64841~~) operations, RunCommand can be used to create and run a command in a single request.
|
|
34573
35241
|
* Take note of the following items:
|
|
34574
35242
|
* * The instances on which you want to run a command must be in the Running (`Running`) state. You can call the [DescribeInstances](~~25506~~) operation to query the status of instances.
|
|
34575
|
-
* * [Cloud Assistant Agent](~~64921~~)
|
|
35243
|
+
* * [Cloud Assistant Agent](~~64921~~) must be installed on the instances.
|
|
34576
35244
|
* * Before you run a PowerShell command on a Windows instance, make sure that the PowerShell module is installed on the instance.
|
|
34577
|
-
* * When you use a cron expression to specify a schedule, you can specify a time zone based on your business requirements. If you do not specify a time zone, the schedule is determined by the system time of the instance. Make sure that the time or time zone of the
|
|
35245
|
+
* * When you use a cron expression to specify a schedule, you can specify a time zone based on your business requirements. If you do not specify a time zone, the schedule is determined by the system time of the instance. Make sure that the time or time zone of the instances meets your business requirements. For information about time zones, see [Configure the NTP service for a CentOS 6 instance](~~92803~~) or [Configure the NTP service for a Windows instance](~~51890~~).
|
|
34578
35246
|
* * You can set `Timeout` to specify the timeout period for executions of the command on ECS instances. If an execution times out, Cloud Assistant Agent forcefully terminates the command process.
|
|
34579
|
-
* * When the one-time execution of
|
|
34580
|
-
* * For a scheduled task, the timeout period takes effect on each execution of the command.
|
|
34581
|
-
*
|
|
34582
|
-
*
|
|
34583
|
-
*
|
|
35247
|
+
* * When the one-time execution of the command times out, the execution state ([InvokeRecordStatus](~~64845~~)) of the command becomes Failed.
|
|
35248
|
+
* * For a scheduled task, the timeout period takes effect on each execution of the command. When a command execution times out, the subsequent executions of the command are not affected. When a scheduled execution of the command times out, the execution state ([InvokeRecordStatus](~~64845~~)) of the command becomes Failed.
|
|
35249
|
+
* To ensure that scheduled tasks can run as expected, make sure that the version of Cloud Assistant Agent is not earlier than the following ones. A scheduled task can run a command at a specified interval, only once at a specified time, or at designated times based on a cron expression in a specified year or time zone. If the `ClientNeedUpgrade` error code is returned, you must update Cloud Assistant Agent to the latest version. For more information, see [Upgrade or disable upgrades for Cloud Assistant Agent](~~134383~~).
|
|
35250
|
+
* - Linux: 2.2.3.282
|
|
35251
|
+
* - Windows: 2.1.3.282
|
|
34584
35252
|
* * Command executions may fail due to instance status exceptions, network exceptions, or exceptions on Cloud Assistant Agent. If a command execution fails, no execution information is generated. For more information, see [Check execution results and troubleshoot common issues](~~87029~~).
|
|
34585
|
-
* *
|
|
34586
|
-
* * You can retain up to 500 to 10,000 Cloud Assistant commands in each region based on your
|
|
34587
|
-
* * Before you run a command on instances, especially new instances, we recommend that you call the [DescribeCloudAssistantStatus](~~87346~~) operation to query the status of Cloud Assistant Agent on the instances
|
|
35253
|
+
* * If you set the `EnableParameter` parameter to true, the custom parameter feature is enabled. When you configure the `CommandContent` parameter, you can define custom parameters in the `{{parameter}}` format. Then, when the command is run, the key-value pairs of the custom parameters are passed in.
|
|
35254
|
+
* * You can retain up to 500 to 10,000 Cloud Assistant commands in each region based on your usage. You can perform operations that are described in the [View and increase resource quotas](~~184115~~) topic or call the [DescribeAccountAttribute](~~73772~~) operation to query resource quotas.
|
|
35255
|
+
* * Before you run a command on instances, especially new instances, we recommend that you call the [DescribeCloudAssistantStatus](~~87346~~) operation to query the status of Cloud Assistant Agent on the instances and run the command when the value of CloudAssistantStatus in the response is true for the instances.
|
|
34588
35256
|
*
|
|
34589
35257
|
* @param request RunCommandRequest
|
|
34590
35258
|
* @return RunCommandResponse
|
|
34591
35259
|
*/
|
|
34592
35260
|
runCommand(request: RunCommandRequest): Promise<RunCommandResponse>;
|
|
34593
35261
|
/**
|
|
34594
|
-
*
|
|
34595
|
-
*
|
|
34596
|
-
* *
|
|
34597
|
-
* *
|
|
34598
|
-
* *
|
|
34599
|
-
* *
|
|
34600
|
-
* *
|
|
34601
|
-
*
|
|
34602
|
-
* *
|
|
34603
|
-
* *
|
|
34604
|
-
* *
|
|
34605
|
-
* *
|
|
34606
|
-
* *
|
|
34607
|
-
* *
|
|
34608
|
-
* *
|
|
34609
|
-
*
|
|
34610
|
-
* *
|
|
34611
|
-
* *
|
|
34612
|
-
* *
|
|
34613
|
-
* *
|
|
34614
|
-
* *
|
|
35262
|
+
* ## [](#)Usage notes
|
|
35263
|
+
* * **Preparations**:
|
|
35264
|
+
* * Cost estimation: Learn about the billing methods of ECS resources. For more information, see [Billing overview](~~25398~~).
|
|
35265
|
+
* * Instance type selection: Call the [DescribeInstanceTypes](~~25620~~) operation to query the performance data of instance types, or see [Best practices for selecting instance types](~~58291~~) to learn about how to select instance types.
|
|
35266
|
+
* * Query of available resources: Call the [DescribeAvailableResource](~~66186~~) operation to query resources available in a specific region or zone.
|
|
35267
|
+
* * Network planning: Make sure that you have security groups available for use. For more information, see [CreateSecurityGroup](~~25553~~). Before you create an instance of the Virtual Private Cloud (VPC) type, [create a VPC](~~65430~~) in the region where you want to create the instance.
|
|
35268
|
+
* * **Comparison with CreateInstance**:
|
|
35269
|
+
* RunInstances has the following advantages over CreateInstance:
|
|
35270
|
+
* * You can call the RunInstances operation to create up to 100 instances at a time, instead of repeatedly calling the CreateInstance operation.
|
|
35271
|
+
* * After an instance is created, the instance enters the `Starting` state and then transitions to the `Running` state. You do not need to call the [StartInstance](~~25500~~) operation to start the instance.
|
|
35272
|
+
* * When you create an instance, you can specify `InternetMaxBandwidthOut` to assign a public IP address to the instance, without the need to call the [AllocatePublicIpAddress](~~25544~~) operation.
|
|
35273
|
+
* * You can use `AutoReleaseTime` to set the time when to automatically release the instances, without the need to call the [ModifyInstanceAutoReleaseTime](~~47576~~) operation.
|
|
35274
|
+
* * You can specify `LaunchTemplateId` and `LaunchTemplateVersion` to use a launch template. This way, you do not need to configure a large number of parameters every time you create instances.
|
|
35275
|
+
* * You can specify `UniqueSuffix` to batch configure sequential names or hostnames for multiple instances for easy management and retrieval.
|
|
35276
|
+
* * When you call the RunInstances operation to create instances, you can configure the enclave-based confidential computing mode and the trusted system mode for the instances.
|
|
35277
|
+
* * You can set `NetworkOptions.EnableJumboFrame` to true to enable the Jumbo Frames feature when you create instances. For more information, see [MTUs](~~200512~~).
|
|
35278
|
+
* * **Considerations**:
|
|
35279
|
+
* * You can create up to 100 instances at a time.
|
|
35280
|
+
* * You can use `AutoReleaseTime` to set the time when to automatically release the instances.
|
|
35281
|
+
* * After you create instances and obtain their IDs, you can call the [DescribeInstances](~~25506~~) operation to check the status of the instances.
|
|
35282
|
+
* * By default, instances automatically start after they are created. Instances are ready for use when they are in the Running (`Running`) state.
|
|
35283
|
+
* * Starting November 27, 2020, the maximum bandwidth value that is available for you to create ECS instances or change ECS instance configurations is subject to the throttling policy of your account. To increase the maximum bandwidth value, submit a ticket. The throttling policy imposes the following constraints: In a single region, the total maximum bandwidth value of all instances that use the pay-by-traffic billing method for network usage cannot exceed 5 Gbit/s and the total maximum bandwidth value of all instances that use the pay-by-bandwidth billing method for network usage cannot exceed 50 Gbit/s.
|
|
35284
|
+
* * Different from the [CreateInstance](~~25499~~) operation, the `RunInstances` operation allows the system to assign public IP addresses to new instances if you set `InternetMaxBandwidthOut` to a value greater than 0.
|
|
35285
|
+
* * When you call the RunInstances operation to create an instance, you can use one of the following methods to attach a primary elastic network interface (ENI) to the instance. Take note that you can use only one of the methods to configure the primary ENI in each call. Otherwise, the call fails and an error message is returned.
|
|
35286
|
+
* * Specify parameters such as `SecurityGroupId`, `VSwitchId`, `PrivateIpAddress`, `NetworkInterfaceQueueNumber`, and `Ipv6AddressCount` to configure the primary ENI.
|
|
35287
|
+
* * Specify parameters that start with `NetworkInterface.N.` to configure the primary and secondary ENIs. If `NetworkInterface.N.InstanceType` is set to `Primary`, the primary ENI is attached to the instance. If `NetworkInterface.N.InstanceType` is set to `Secondary` or left empty, the secondary ENI is attached to the instance.
|
|
35288
|
+
* * If a parameter is invalid or available resources are insufficient, an error is returned after you call the RunInstances operation. For more information, see the "Error codes" section of this topic.
|
|
35289
|
+
* * If the maximum number of instances of the specified instance type that can be created in the specified region or the maximum number of vCPUs for all instance types in a zone is exceeded, the `QuotaExceed.ElasticQuota` error is returned when you call the operation. You can go to the [ECS console](https://ecs.console.aliyun.com/?spm=a2c8b.12215451.favorites.decs.5e3a336aMGTtzy#/privileges/quota) or the [Quota Center](https://quotas.console.aliyun.com/products/ecs/quotas) to request a quota increase.
|
|
35290
|
+
* * If the capacity of disks that belong to the specified disk category exceeds the quota limit for the specified zone, the `QuotaExceed.DiskCapacity` error is returned when you call the operation. You can go to the [Quota Center](https://quotas.console.aliyun.com/products/disk/quotas) to view and increase the disk capacity quota.
|
|
35291
|
+
* * **Best practices**:
|
|
35292
|
+
* * We recommend that you use auto provisioning groups in the following scenarios: Resources are insufficient to create more than 100 instances at a time, you want to quickly create instances regardless of resource configurations such as instance types or zones, or you want to create instances to consume a specific total number of vCPUs regardless of the number of instances. You can call the [CreateAutoProvisioningGroup](~~122738~~) operation to create an auto provisioning group to deploy an instance cluster across different zones, different billing methods, and instance families. For more information, see [Use auto provisioning group-related API operations to batch create ECS instances](~~200772~~).
|
|
35293
|
+
* * You can call the `RunInstances` operation to batch create instances. To better manage and search for the instances, we recommend that you add tags to the instances by specifying `Tag.N.Key` and `Tag.N.Value`. You can also append incremental suffixes (`UniqueSuffix`) to the hostname (`HostName`) and to the instance name (`InstanceName`).
|
|
35294
|
+
* * A launch template contains parameters required to create an instance so that you do not have to specify these parameters every time you create instances. You can call the [CreateLaunchTemplate](~~74686~~) operation to create a launch template. Then, in your request to call the `RunInstances` operation, you can specify `LaunchTemplateId` and `LaunchTemplateVersion` to use the launch template.
|
|
35295
|
+
* ### [](#-1)Example 1: Create a subscription instance
|
|
35296
|
+
* Use the aliyun\\_3\\_x64\\_20G_alibase\\_20221102.vhd image to create a one-month subscription instance of the ecs.g7.large instance type in the China (Hangzhou) region, and enable auto-renewal to renew the instance for one month on expiration. The instance uses a 40 GiB enhanced SSD (ESSD) as the system disk and a 100 GiB ESSD as a data disk and is automatically assigned private and public IP addresses. The outbound public bandwidth of the instance is 10 Mbit/s. The instance name is ECS-test and the logon password of the instance is ECS@test1234.
|
|
35297
|
+
* http(s)://ecs.aliyuncs.com/?Action=RunInstances
|
|
35298
|
+
* &RegionId=cn-hangzhou
|
|
35299
|
+
* &ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
|
|
35300
|
+
* &InstanceType=ecs.g7.large
|
|
35301
|
+
* &SecurityGroupId=sg-bp150uqocpf9jj70****
|
|
35302
|
+
* &VSwitchId=vsw-bp1qo7s91cbch5i4l****
|
|
35303
|
+
* &InstanceChargeType=PrePaid
|
|
35304
|
+
* &SystemDisk.Size=40
|
|
35305
|
+
* &DataDisk.1.Size=100
|
|
35306
|
+
* &DataDisk.1.Category=cloud_essd
|
|
35307
|
+
* &SystemDisk.Category=cloud_essd
|
|
35308
|
+
* &Amount=1
|
|
35309
|
+
* &Period=1
|
|
35310
|
+
* &PeriodUnit=Month
|
|
35311
|
+
* &AutoRenew=true
|
|
35312
|
+
* &AutoRenewPeriod=1
|
|
35313
|
+
* &HostName=ECS-test
|
|
35314
|
+
* &Password=ECS@test1234
|
|
35315
|
+
* &InternetMaxBandwidthOut=10
|
|
35316
|
+
* &<Common request parameters>
|
|
35317
|
+
* ### [](#-2)Example 2: Create a pay-as-you-go instance
|
|
35318
|
+
* Use the aliyun\\_3\\_x64\\_20G_alibase\\_20221102.vhd image to create a pay-as-you-go instance of the ecs.g7.large instance type in the China (Hangzhou) region. The instance uses a 40 GiB ESSD as the system disk and a 100 GiB ESSD as a data disk and is automatically assigned private and public IP addresses. The outbound public bandwidth of the instance is 10 Mbit/s. The instance name is ECS-test and the logon password of the instance is ECS@test1234.
|
|
35319
|
+
* http(s)://ecs.aliyuncs.com/?Action=RunInstances
|
|
35320
|
+
* &RegionId=cn-hangzhou
|
|
35321
|
+
* &ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
|
|
35322
|
+
* &InstanceType=ecs.g7.large
|
|
35323
|
+
* &SecurityGroupId=sg-bp150uqocpf9jj70****
|
|
35324
|
+
* &VSwitchId=vsw-bp1qo7s91cbch5i4l****
|
|
35325
|
+
* &InstanceChargeType=PostPaid
|
|
35326
|
+
* &SystemDisk.Size=40
|
|
35327
|
+
* &DataDisk.1.Size=100
|
|
35328
|
+
* &DataDisk.1.Category=cloud_essd
|
|
35329
|
+
* &SystemDisk.Category=cloud_essd
|
|
35330
|
+
* &HostName=ECS-test
|
|
35331
|
+
* &Password=ECS@test1234
|
|
35332
|
+
* &InternetMaxBandwidthOut=10
|
|
35333
|
+
* &<Common request parameters>
|
|
35334
|
+
* ### [](#-3)Example 3: Create a preemptible instance
|
|
35335
|
+
* Use the aliyun\\_3\\_x64\\_20G_alibase\\_20221102.vhd image to create a preemptible instance of the ecs.g7.large instance type that has a 1-hour protection period in the China (Hangzhou) region. The market price of the instance type at the time of purchase is automatically used as the bidding price. The instance uses a 40 GiB ESSD as the system disk and a 100 GiB ESSD as a data disk and is automatically assigned private and public IP addresses. The outbound public bandwidth of the instance is 10 Mbit/s. The instance name is ECS-test and the logon password of the instance is ECS@test1234.
|
|
35336
|
+
* http(s)://ecs.aliyuncs.com/?Action=RunInstances
|
|
35337
|
+
* &RegionId=cn-hangzhou
|
|
35338
|
+
* &ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
|
|
35339
|
+
* &InstanceType=ecs.g7.large
|
|
35340
|
+
* &SecurityGroupId=sg-bp150uqocpf9jj70****
|
|
35341
|
+
* &VSwitchId=vsw-bp1qo7s91cbch5i4l****
|
|
35342
|
+
* &InstanceChargeType=PostPaid
|
|
35343
|
+
* &SystemDisk.Size=40
|
|
35344
|
+
* &DataDisk.1.Size=100
|
|
35345
|
+
* &DataDisk.1.Category=cloud_essd
|
|
35346
|
+
* &SystemDisk.Category=cloud_essd
|
|
35347
|
+
* &HostName=ECS-test
|
|
35348
|
+
* &Password=ECS@test1234
|
|
35349
|
+
* &InternetMaxBandwidthOut=10
|
|
35350
|
+
* &SpotStrategy=SpotAsPriceGo
|
|
35351
|
+
* &SpotDuration=1
|
|
35352
|
+
* &<Common request parameters>
|
|
35353
|
+
* ### [](#-4)Example 4: Create a subscription instance on a dedicated host
|
|
35354
|
+
* Use the aliyun\\_3\\_x64\\_20G_alibase\\_20221102.vhd image to create a one-month subscription instance of the ecs.g7.large instance type on the dh-bp12w10wll9xcjq2\\*\\*\\*\\* dedicated host in the China (Hangzhou) region. The instance uses a 40 GiB ESSD as the system disk and a 100 GiB ESSD as a data disk and is automatically assigned private and public IP addresses. The outbound public bandwidth of the instance is 10 Mbit/s. The instance name is ECS-test and the logon password of the instance is ECS@test1234.
|
|
35355
|
+
* http(s)://ecs.aliyuncs.com/?Action=RunInstances
|
|
35356
|
+
* &RegionId=cn-hangzhou
|
|
35357
|
+
* &ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
|
|
35358
|
+
* &InstanceType=ecs.g7.large
|
|
35359
|
+
* &SecurityGroupId=sg-bp150uqocpf9jj70****
|
|
35360
|
+
* &VSwitchId=vsw-bp1qo7s91cbch5i4l****
|
|
35361
|
+
* &InstanceChargeType=PrePaid
|
|
35362
|
+
* &Amount=1
|
|
35363
|
+
* &Period=1
|
|
35364
|
+
* &PeriodUnit=Month
|
|
35365
|
+
* &SystemDisk.Size=40
|
|
35366
|
+
* &DataDisk.1.Size=100
|
|
35367
|
+
* &DataDisk.1.Category=cloud_essd
|
|
35368
|
+
* &SystemDisk.Category=cloud_essd
|
|
35369
|
+
* &HostName=ECS-test
|
|
35370
|
+
* &Password=ECS@test1234
|
|
35371
|
+
* &InternetMaxBandwidthOut=10
|
|
35372
|
+
* &DedicatedHostId=dh-bp12w10wll9xcjq2****
|
|
35373
|
+
* &<Common request parameters>
|
|
34615
35374
|
*
|
|
34616
35375
|
* @param request RunInstancesRequest
|
|
34617
35376
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -34619,27 +35378,118 @@ export default class Client extends OpenApi {
|
|
|
34619
35378
|
*/
|
|
34620
35379
|
runInstancesWithOptions(request: RunInstancesRequest, runtime: $Util.RuntimeOptions): Promise<RunInstancesResponse>;
|
|
34621
35380
|
/**
|
|
34622
|
-
*
|
|
34623
|
-
*
|
|
34624
|
-
* *
|
|
34625
|
-
* *
|
|
34626
|
-
* *
|
|
34627
|
-
* *
|
|
34628
|
-
* *
|
|
34629
|
-
*
|
|
34630
|
-
* *
|
|
34631
|
-
* *
|
|
34632
|
-
* *
|
|
34633
|
-
* *
|
|
34634
|
-
* *
|
|
34635
|
-
* *
|
|
34636
|
-
* *
|
|
34637
|
-
*
|
|
34638
|
-
* *
|
|
34639
|
-
* *
|
|
34640
|
-
* *
|
|
34641
|
-
* *
|
|
34642
|
-
* *
|
|
35381
|
+
* ## [](#)Usage notes
|
|
35382
|
+
* * **Preparations**:
|
|
35383
|
+
* * Cost estimation: Learn about the billing methods of ECS resources. For more information, see [Billing overview](~~25398~~).
|
|
35384
|
+
* * Instance type selection: Call the [DescribeInstanceTypes](~~25620~~) operation to query the performance data of instance types, or see [Best practices for selecting instance types](~~58291~~) to learn about how to select instance types.
|
|
35385
|
+
* * Query of available resources: Call the [DescribeAvailableResource](~~66186~~) operation to query resources available in a specific region or zone.
|
|
35386
|
+
* * Network planning: Make sure that you have security groups available for use. For more information, see [CreateSecurityGroup](~~25553~~). Before you create an instance of the Virtual Private Cloud (VPC) type, [create a VPC](~~65430~~) in the region where you want to create the instance.
|
|
35387
|
+
* * **Comparison with CreateInstance**:
|
|
35388
|
+
* RunInstances has the following advantages over CreateInstance:
|
|
35389
|
+
* * You can call the RunInstances operation to create up to 100 instances at a time, instead of repeatedly calling the CreateInstance operation.
|
|
35390
|
+
* * After an instance is created, the instance enters the `Starting` state and then transitions to the `Running` state. You do not need to call the [StartInstance](~~25500~~) operation to start the instance.
|
|
35391
|
+
* * When you create an instance, you can specify `InternetMaxBandwidthOut` to assign a public IP address to the instance, without the need to call the [AllocatePublicIpAddress](~~25544~~) operation.
|
|
35392
|
+
* * You can use `AutoReleaseTime` to set the time when to automatically release the instances, without the need to call the [ModifyInstanceAutoReleaseTime](~~47576~~) operation.
|
|
35393
|
+
* * You can specify `LaunchTemplateId` and `LaunchTemplateVersion` to use a launch template. This way, you do not need to configure a large number of parameters every time you create instances.
|
|
35394
|
+
* * You can specify `UniqueSuffix` to batch configure sequential names or hostnames for multiple instances for easy management and retrieval.
|
|
35395
|
+
* * When you call the RunInstances operation to create instances, you can configure the enclave-based confidential computing mode and the trusted system mode for the instances.
|
|
35396
|
+
* * You can set `NetworkOptions.EnableJumboFrame` to true to enable the Jumbo Frames feature when you create instances. For more information, see [MTUs](~~200512~~).
|
|
35397
|
+
* * **Considerations**:
|
|
35398
|
+
* * You can create up to 100 instances at a time.
|
|
35399
|
+
* * You can use `AutoReleaseTime` to set the time when to automatically release the instances.
|
|
35400
|
+
* * After you create instances and obtain their IDs, you can call the [DescribeInstances](~~25506~~) operation to check the status of the instances.
|
|
35401
|
+
* * By default, instances automatically start after they are created. Instances are ready for use when they are in the Running (`Running`) state.
|
|
35402
|
+
* * Starting November 27, 2020, the maximum bandwidth value that is available for you to create ECS instances or change ECS instance configurations is subject to the throttling policy of your account. To increase the maximum bandwidth value, submit a ticket. The throttling policy imposes the following constraints: In a single region, the total maximum bandwidth value of all instances that use the pay-by-traffic billing method for network usage cannot exceed 5 Gbit/s and the total maximum bandwidth value of all instances that use the pay-by-bandwidth billing method for network usage cannot exceed 50 Gbit/s.
|
|
35403
|
+
* * Different from the [CreateInstance](~~25499~~) operation, the `RunInstances` operation allows the system to assign public IP addresses to new instances if you set `InternetMaxBandwidthOut` to a value greater than 0.
|
|
35404
|
+
* * When you call the RunInstances operation to create an instance, you can use one of the following methods to attach a primary elastic network interface (ENI) to the instance. Take note that you can use only one of the methods to configure the primary ENI in each call. Otherwise, the call fails and an error message is returned.
|
|
35405
|
+
* * Specify parameters such as `SecurityGroupId`, `VSwitchId`, `PrivateIpAddress`, `NetworkInterfaceQueueNumber`, and `Ipv6AddressCount` to configure the primary ENI.
|
|
35406
|
+
* * Specify parameters that start with `NetworkInterface.N.` to configure the primary and secondary ENIs. If `NetworkInterface.N.InstanceType` is set to `Primary`, the primary ENI is attached to the instance. If `NetworkInterface.N.InstanceType` is set to `Secondary` or left empty, the secondary ENI is attached to the instance.
|
|
35407
|
+
* * If a parameter is invalid or available resources are insufficient, an error is returned after you call the RunInstances operation. For more information, see the "Error codes" section of this topic.
|
|
35408
|
+
* * If the maximum number of instances of the specified instance type that can be created in the specified region or the maximum number of vCPUs for all instance types in a zone is exceeded, the `QuotaExceed.ElasticQuota` error is returned when you call the operation. You can go to the [ECS console](https://ecs.console.aliyun.com/?spm=a2c8b.12215451.favorites.decs.5e3a336aMGTtzy#/privileges/quota) or the [Quota Center](https://quotas.console.aliyun.com/products/ecs/quotas) to request a quota increase.
|
|
35409
|
+
* * If the capacity of disks that belong to the specified disk category exceeds the quota limit for the specified zone, the `QuotaExceed.DiskCapacity` error is returned when you call the operation. You can go to the [Quota Center](https://quotas.console.aliyun.com/products/disk/quotas) to view and increase the disk capacity quota.
|
|
35410
|
+
* * **Best practices**:
|
|
35411
|
+
* * We recommend that you use auto provisioning groups in the following scenarios: Resources are insufficient to create more than 100 instances at a time, you want to quickly create instances regardless of resource configurations such as instance types or zones, or you want to create instances to consume a specific total number of vCPUs regardless of the number of instances. You can call the [CreateAutoProvisioningGroup](~~122738~~) operation to create an auto provisioning group to deploy an instance cluster across different zones, different billing methods, and instance families. For more information, see [Use auto provisioning group-related API operations to batch create ECS instances](~~200772~~).
|
|
35412
|
+
* * You can call the `RunInstances` operation to batch create instances. To better manage and search for the instances, we recommend that you add tags to the instances by specifying `Tag.N.Key` and `Tag.N.Value`. You can also append incremental suffixes (`UniqueSuffix`) to the hostname (`HostName`) and to the instance name (`InstanceName`).
|
|
35413
|
+
* * A launch template contains parameters required to create an instance so that you do not have to specify these parameters every time you create instances. You can call the [CreateLaunchTemplate](~~74686~~) operation to create a launch template. Then, in your request to call the `RunInstances` operation, you can specify `LaunchTemplateId` and `LaunchTemplateVersion` to use the launch template.
|
|
35414
|
+
* ### [](#-1)Example 1: Create a subscription instance
|
|
35415
|
+
* Use the aliyun\\_3\\_x64\\_20G_alibase\\_20221102.vhd image to create a one-month subscription instance of the ecs.g7.large instance type in the China (Hangzhou) region, and enable auto-renewal to renew the instance for one month on expiration. The instance uses a 40 GiB enhanced SSD (ESSD) as the system disk and a 100 GiB ESSD as a data disk and is automatically assigned private and public IP addresses. The outbound public bandwidth of the instance is 10 Mbit/s. The instance name is ECS-test and the logon password of the instance is ECS@test1234.
|
|
35416
|
+
* http(s)://ecs.aliyuncs.com/?Action=RunInstances
|
|
35417
|
+
* &RegionId=cn-hangzhou
|
|
35418
|
+
* &ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
|
|
35419
|
+
* &InstanceType=ecs.g7.large
|
|
35420
|
+
* &SecurityGroupId=sg-bp150uqocpf9jj70****
|
|
35421
|
+
* &VSwitchId=vsw-bp1qo7s91cbch5i4l****
|
|
35422
|
+
* &InstanceChargeType=PrePaid
|
|
35423
|
+
* &SystemDisk.Size=40
|
|
35424
|
+
* &DataDisk.1.Size=100
|
|
35425
|
+
* &DataDisk.1.Category=cloud_essd
|
|
35426
|
+
* &SystemDisk.Category=cloud_essd
|
|
35427
|
+
* &Amount=1
|
|
35428
|
+
* &Period=1
|
|
35429
|
+
* &PeriodUnit=Month
|
|
35430
|
+
* &AutoRenew=true
|
|
35431
|
+
* &AutoRenewPeriod=1
|
|
35432
|
+
* &HostName=ECS-test
|
|
35433
|
+
* &Password=ECS@test1234
|
|
35434
|
+
* &InternetMaxBandwidthOut=10
|
|
35435
|
+
* &<Common request parameters>
|
|
35436
|
+
* ### [](#-2)Example 2: Create a pay-as-you-go instance
|
|
35437
|
+
* Use the aliyun\\_3\\_x64\\_20G_alibase\\_20221102.vhd image to create a pay-as-you-go instance of the ecs.g7.large instance type in the China (Hangzhou) region. The instance uses a 40 GiB ESSD as the system disk and a 100 GiB ESSD as a data disk and is automatically assigned private and public IP addresses. The outbound public bandwidth of the instance is 10 Mbit/s. The instance name is ECS-test and the logon password of the instance is ECS@test1234.
|
|
35438
|
+
* http(s)://ecs.aliyuncs.com/?Action=RunInstances
|
|
35439
|
+
* &RegionId=cn-hangzhou
|
|
35440
|
+
* &ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
|
|
35441
|
+
* &InstanceType=ecs.g7.large
|
|
35442
|
+
* &SecurityGroupId=sg-bp150uqocpf9jj70****
|
|
35443
|
+
* &VSwitchId=vsw-bp1qo7s91cbch5i4l****
|
|
35444
|
+
* &InstanceChargeType=PostPaid
|
|
35445
|
+
* &SystemDisk.Size=40
|
|
35446
|
+
* &DataDisk.1.Size=100
|
|
35447
|
+
* &DataDisk.1.Category=cloud_essd
|
|
35448
|
+
* &SystemDisk.Category=cloud_essd
|
|
35449
|
+
* &HostName=ECS-test
|
|
35450
|
+
* &Password=ECS@test1234
|
|
35451
|
+
* &InternetMaxBandwidthOut=10
|
|
35452
|
+
* &<Common request parameters>
|
|
35453
|
+
* ### [](#-3)Example 3: Create a preemptible instance
|
|
35454
|
+
* Use the aliyun\\_3\\_x64\\_20G_alibase\\_20221102.vhd image to create a preemptible instance of the ecs.g7.large instance type that has a 1-hour protection period in the China (Hangzhou) region. The market price of the instance type at the time of purchase is automatically used as the bidding price. The instance uses a 40 GiB ESSD as the system disk and a 100 GiB ESSD as a data disk and is automatically assigned private and public IP addresses. The outbound public bandwidth of the instance is 10 Mbit/s. The instance name is ECS-test and the logon password of the instance is ECS@test1234.
|
|
35455
|
+
* http(s)://ecs.aliyuncs.com/?Action=RunInstances
|
|
35456
|
+
* &RegionId=cn-hangzhou
|
|
35457
|
+
* &ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
|
|
35458
|
+
* &InstanceType=ecs.g7.large
|
|
35459
|
+
* &SecurityGroupId=sg-bp150uqocpf9jj70****
|
|
35460
|
+
* &VSwitchId=vsw-bp1qo7s91cbch5i4l****
|
|
35461
|
+
* &InstanceChargeType=PostPaid
|
|
35462
|
+
* &SystemDisk.Size=40
|
|
35463
|
+
* &DataDisk.1.Size=100
|
|
35464
|
+
* &DataDisk.1.Category=cloud_essd
|
|
35465
|
+
* &SystemDisk.Category=cloud_essd
|
|
35466
|
+
* &HostName=ECS-test
|
|
35467
|
+
* &Password=ECS@test1234
|
|
35468
|
+
* &InternetMaxBandwidthOut=10
|
|
35469
|
+
* &SpotStrategy=SpotAsPriceGo
|
|
35470
|
+
* &SpotDuration=1
|
|
35471
|
+
* &<Common request parameters>
|
|
35472
|
+
* ### [](#-4)Example 4: Create a subscription instance on a dedicated host
|
|
35473
|
+
* Use the aliyun\\_3\\_x64\\_20G_alibase\\_20221102.vhd image to create a one-month subscription instance of the ecs.g7.large instance type on the dh-bp12w10wll9xcjq2\\*\\*\\*\\* dedicated host in the China (Hangzhou) region. The instance uses a 40 GiB ESSD as the system disk and a 100 GiB ESSD as a data disk and is automatically assigned private and public IP addresses. The outbound public bandwidth of the instance is 10 Mbit/s. The instance name is ECS-test and the logon password of the instance is ECS@test1234.
|
|
35474
|
+
* http(s)://ecs.aliyuncs.com/?Action=RunInstances
|
|
35475
|
+
* &RegionId=cn-hangzhou
|
|
35476
|
+
* &ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
|
|
35477
|
+
* &InstanceType=ecs.g7.large
|
|
35478
|
+
* &SecurityGroupId=sg-bp150uqocpf9jj70****
|
|
35479
|
+
* &VSwitchId=vsw-bp1qo7s91cbch5i4l****
|
|
35480
|
+
* &InstanceChargeType=PrePaid
|
|
35481
|
+
* &Amount=1
|
|
35482
|
+
* &Period=1
|
|
35483
|
+
* &PeriodUnit=Month
|
|
35484
|
+
* &SystemDisk.Size=40
|
|
35485
|
+
* &DataDisk.1.Size=100
|
|
35486
|
+
* &DataDisk.1.Category=cloud_essd
|
|
35487
|
+
* &SystemDisk.Category=cloud_essd
|
|
35488
|
+
* &HostName=ECS-test
|
|
35489
|
+
* &Password=ECS@test1234
|
|
35490
|
+
* &InternetMaxBandwidthOut=10
|
|
35491
|
+
* &DedicatedHostId=dh-bp12w10wll9xcjq2****
|
|
35492
|
+
* &<Common request parameters>
|
|
34643
35493
|
*
|
|
34644
35494
|
* @param request RunInstancesRequest
|
|
34645
35495
|
* @return RunInstancesResponse
|
|
@@ -34745,16 +35595,16 @@ export default class Client extends OpenApi {
|
|
|
34745
35595
|
*/
|
|
34746
35596
|
startInstances(request: StartInstancesRequest): Promise<StartInstancesResponse>;
|
|
34747
35597
|
/**
|
|
34748
|
-
*
|
|
35598
|
+
* ## [](#)Usage notes
|
|
34749
35599
|
* When you use custom code to connect to an ECS instance that serves as a client, you can call this operation to obtain the WebSocket URL that is used to connect to the instance. Take note of the following items:
|
|
34750
|
-
* * The ECS instance must be in the Running
|
|
35600
|
+
* * The ECS instance must be in the Running state.
|
|
34751
35601
|
* * Cloud Assistant Agent must be installed on the ECS instance. You can call the [DescribeCloudAssistantStatus](~~87346~~) operation to check whether Cloud Assistant Agent is installed on the ECS instance and query the version number of the installed Cloud Assistant Agent.
|
|
34752
35602
|
* * If Cloud Assistant Agent is not installed on the ECS instance, call the [InstallCloudAssistant](~~85916~~) operation to install Cloud Assistant Agent.
|
|
34753
|
-
* *
|
|
34754
|
-
* *
|
|
34755
|
-
* *
|
|
35603
|
+
* * The Cloud Assistant Agent versions that are later than the following ones support the session management feature. If you need to upgrade the Cloud Assistant Agent version, follow the instructions in [Upgrade or disable upgrades for Cloud Assistant Agent](~~134383~~).
|
|
35604
|
+
* * Linux operating system: 2.2.3.256
|
|
35605
|
+
* * Windows operating system: 2.1.3.256
|
|
34756
35606
|
* * Each WebSocket URL returned by the StartTerminalSession operation remains valid for 10 minutes.
|
|
34757
|
-
* * Up to 1,000 sessions can be created and available
|
|
35607
|
+
* * Up to 1,000 sessions can be created and available in a region. Each ECS instance can have up to 20 sessions in the connected state.
|
|
34758
35608
|
*
|
|
34759
35609
|
* @param request StartTerminalSessionRequest
|
|
34760
35610
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -34762,16 +35612,16 @@ export default class Client extends OpenApi {
|
|
|
34762
35612
|
*/
|
|
34763
35613
|
startTerminalSessionWithOptions(request: StartTerminalSessionRequest, runtime: $Util.RuntimeOptions): Promise<StartTerminalSessionResponse>;
|
|
34764
35614
|
/**
|
|
34765
|
-
*
|
|
35615
|
+
* ## [](#)Usage notes
|
|
34766
35616
|
* When you use custom code to connect to an ECS instance that serves as a client, you can call this operation to obtain the WebSocket URL that is used to connect to the instance. Take note of the following items:
|
|
34767
|
-
* * The ECS instance must be in the Running
|
|
35617
|
+
* * The ECS instance must be in the Running state.
|
|
34768
35618
|
* * Cloud Assistant Agent must be installed on the ECS instance. You can call the [DescribeCloudAssistantStatus](~~87346~~) operation to check whether Cloud Assistant Agent is installed on the ECS instance and query the version number of the installed Cloud Assistant Agent.
|
|
34769
35619
|
* * If Cloud Assistant Agent is not installed on the ECS instance, call the [InstallCloudAssistant](~~85916~~) operation to install Cloud Assistant Agent.
|
|
34770
|
-
* *
|
|
34771
|
-
* *
|
|
34772
|
-
* *
|
|
35620
|
+
* * The Cloud Assistant Agent versions that are later than the following ones support the session management feature. If you need to upgrade the Cloud Assistant Agent version, follow the instructions in [Upgrade or disable upgrades for Cloud Assistant Agent](~~134383~~).
|
|
35621
|
+
* * Linux operating system: 2.2.3.256
|
|
35622
|
+
* * Windows operating system: 2.1.3.256
|
|
34773
35623
|
* * Each WebSocket URL returned by the StartTerminalSession operation remains valid for 10 minutes.
|
|
34774
|
-
* * Up to 1,000 sessions can be created and available
|
|
35624
|
+
* * Up to 1,000 sessions can be created and available in a region. Each ECS instance can have up to 20 sessions in the connected state.
|
|
34775
35625
|
*
|
|
34776
35626
|
* @param request StartTerminalSessionRequest
|
|
34777
35627
|
* @return StartTerminalSessionResponse
|