@alicloud/ecs20140526 7.0.15 → 7.0.17

package/dist/client.d.ts

@@ -2171,10 +2171,11 @@ export default class Client extends OpenApi {
      */
     deleteImage(request: $_model.DeleteImageRequest): Promise<$_model.DeleteImageResponse>;
     /**
-     * Deletes an image component.
+     * Deletes an image component. You can specify RegionId and ImageComponentId in the request.
      *
      * @remarks
-     * Only custom image components can be deleted.
+     *   Only custom image components can be deleted.
+     * *   When you delete a component, make sure that the component is not used in the template. Otherwise, the component fails to be deleted.
      *
      * @param request - DeleteImageComponentRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2182,17 +2183,18 @@ export default class Client extends OpenApi {
      */
     deleteImageComponentWithOptions(request: $_model.DeleteImageComponentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteImageComponentResponse>;
     /**
-     * Deletes an image component.
+     * Deletes an image component. You can specify RegionId and ImageComponentId in the request.
      *
      * @remarks
-     * Only custom image components can be deleted.
+     *   Only custom image components can be deleted.
+     * *   When you delete a component, make sure that the component is not used in the template. Otherwise, the component fails to be deleted.
      *
      * @param request - DeleteImageComponentRequest
      * @returns DeleteImageComponentResponse
      */
     deleteImageComponent(request: $_model.DeleteImageComponentRequest): Promise<$_model.DeleteImageComponentResponse>;
     /**
-     * Deletes an image template. You can specify RegionId and ImagePipelineId in the request.
+     * Deletes an image template.
      *
      * @remarks
      * If an ongoing image building task is associated with an image template, you cannot delete the image template. You can delete the image template only if the image building task reaches the SUCCESS, FAILED, TEST_FAILED, PARTITION_SUCCESS, or CANCELLED state. You can call the DescribeImagePipelineExecutions operation to query the details of an image building task.
@@ -2203,7 +2205,7 @@ export default class Client extends OpenApi {
      */
     deleteImagePipelineWithOptions(request: $_model.DeleteImagePipelineRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteImagePipelineResponse>;
     /**
-     * Deletes an image template. You can specify RegionId and ImagePipelineId in the request.
+     * Deletes an image template.
      *
      * @remarks
      * If an ongoing image building task is associated with an image template, you cannot delete the image template. You can delete the image template only if the image building task reaches the SUCCESS, FAILED, TEST_FAILED, PARTITION_SUCCESS, or CANCELLED state. You can call the DescribeImagePipelineExecutions operation to query the details of an image building task.
@@ -3098,7 +3100,7 @@ export default class Client extends OpenApi {
      */
     describeDedicatedHostTypes(request: $_model.DescribeDedicatedHostTypesRequest): Promise<$_model.DescribeDedicatedHostTypesResponse>;
     /**
-     * Queries the information about dedicated hosts, including the physical performance specifications, machine codes, and status of the dedicated hosts, and Elastic Compute Service (ECS) instances that are created on the dedicated hosts.
+     * Queries the details of one or more Dedicated Hosts (DDHs). You can call this operation to obtain information about a DDH, including the physical performance specifications, machine code, service status, and the list of created ECS instances. You can specify relevant parameters, such as DDH IDs, DDH cluster IDs, hostname, and status, to query the required DDH details. This helps you efficiently manage and optimize cloud computing resources.
      *
      * @remarks
      * ## [](#)Usage notes
@@ -3112,7 +3114,7 @@ export default class Client extends OpenApi {
      */
     describeDedicatedHostsWithOptions(request: $_model.DescribeDedicatedHostsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDedicatedHostsResponse>;
     /**
-     * Queries the information about dedicated hosts, including the physical performance specifications, machine codes, and status of the dedicated hosts, and Elastic Compute Service (ECS) instances that are created on the dedicated hosts.
+     * Queries the details of one or more Dedicated Hosts (DDHs). You can call this operation to obtain information about a DDH, including the physical performance specifications, machine code, service status, and the list of created ECS instances. You can specify relevant parameters, such as DDH IDs, DDH cluster IDs, hostname, and status, to query the required DDH details. This helps you efficiently manage and optimize cloud computing resources.
      *
      * @remarks
      * ## [](#)Usage notes
@@ -3721,7 +3723,8 @@ export default class Client extends OpenApi {
      *
      * @remarks
      *   You can query system events that were completed within the last 30 days. No limits apply to the time range for querying uncompleted system events.
-     * *   You can also specify InstanceEventCycleStatus to query the system events that are in the Scheduled, Executing, or Inquiring state.
+     * *   If you do not specify the EventCycleStatus or InstanceEventCycleStatus parameter, only system events in the Avoidated, Executed, Canceled, or Failed state are included in the query results by default.
+     * *   You can also specify the InstanceEventCycleStatus parameter in the request to query the system events that are in the Scheduled, Executing, or Inquiring state.
      *
      * @param request - DescribeInstanceHistoryEventsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3733,7 +3736,8 @@ export default class Client extends OpenApi {
      *
      * @remarks
      *   You can query system events that were completed within the last 30 days. No limits apply to the time range for querying uncompleted system events.
-     * *   You can also specify InstanceEventCycleStatus to query the system events that are in the Scheduled, Executing, or Inquiring state.
+     * *   If you do not specify the EventCycleStatus or InstanceEventCycleStatus parameter, only system events in the Avoidated, Executed, Canceled, or Failed state are included in the query results by default.
+     * *   You can also specify the InstanceEventCycleStatus parameter in the request to query the system events that are in the Scheduled, Executing, or Inquiring state.
      *
      * @param request - DescribeInstanceHistoryEventsRequest
      * @returns DescribeInstanceHistoryEventsResponse
@@ -6068,20 +6072,15 @@ export default class Client extends OpenApi {
      */
     joinResourceGroup(request: $_model.JoinResourceGroupRequest): Promise<$_model.JoinResourceGroupResponse>;
     /**
-     * Adds an Elastic Compute Service (ECS) instance or an elastic network interface (ENI) to a security group. When you call this operation, you can specify parameters, such as SecurityGroupId, InstanceId, and NetworkInterfaceId, in the request.
+     * Adds an Elastic Compute Service (ECS) instance or an elastic network interface (ENI) to a specified security group.
      *
      * @remarks
-     * ## [](#)Usage notes
-     * >  This operation is not recommended. We recommend that you call the [ModifyInstanceAttribute](https://help.aliyun.com/document_detail/25503.html) operation to add an instance to or remove an instance from a security group, and call the [ModifyNetworkInterfaceAttribute](https://help.aliyun.com/document_detail/58513.html) operation to add an ENI to or remove an ENI from a security group.
-     * Take note of the following items:
-     * *   Before you add an instance to a security group, the instance must be in the **Stopped** (Stopped) or **Running** (Running) state.
-     * *   An instance can be added to up to five security groups by default.
-     * *   You can [submit a ticket](https://workorder-intl.console.aliyun.com/#/ticket/createIndex) to change the maximum number of security groups to which an instance can be added to 4 or 10.
-     * *   A basic security group can contain up to 2,000 instances. An advanced security group can contain up to 65,536 instances.
-     * *   The security group and the instance must reside in the same region.
-     * *   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.
+     * > This operation is not recommended. We recommend that you call the [ModifyInstanceAttribute](https://help.aliyun.com/document_detail/25503.html) operation to add an instance to or remove an instance from a security group, and call the [ModifyNetworkInterfaceAttribute](https://help.aliyun.com/document_detail/58513.html) operation to add an ENI to or remove an ENI from a security group.
      * *   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.
-     * For more information, see [Limits](https://help.aliyun.com/document_detail/25412.html).
+     * *   The security group and the ECS instance to be added to the security group must reside in the same region.
+     * *   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.
+     * *   Before you add an instance to a security group, the instance must be in the **Stopped** or **Running** state.
+     * *   An instance can be added to up to five security groups by default. For more information, see [Security group limits](~~25412#SecurityGroupQuota1~~).
      *
      * @param request - JoinSecurityGroupRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -6089,20 +6088,15 @@ export default class Client extends OpenApi {
      */
     joinSecurityGroupWithOptions(request: $_model.JoinSecurityGroupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.JoinSecurityGroupResponse>;
     /**
-     * Adds an Elastic Compute Service (ECS) instance or an elastic network interface (ENI) to a security group. When you call this operation, you can specify parameters, such as SecurityGroupId, InstanceId, and NetworkInterfaceId, in the request.
+     * Adds an Elastic Compute Service (ECS) instance or an elastic network interface (ENI) to a specified security group.
      *
      * @remarks
-     * ## [](#)Usage notes
-     * >  This operation is not recommended. We recommend that you call the [ModifyInstanceAttribute](https://help.aliyun.com/document_detail/25503.html) operation to add an instance to or remove an instance from a security group, and call the [ModifyNetworkInterfaceAttribute](https://help.aliyun.com/document_detail/58513.html) operation to add an ENI to or remove an ENI from a security group.
-     * Take note of the following items:
-     * *   Before you add an instance to a security group, the instance must be in the **Stopped** (Stopped) or **Running** (Running) state.
-     * *   An instance can be added to up to five security groups by default.
-     * *   You can [submit a ticket](https://workorder-intl.console.aliyun.com/#/ticket/createIndex) to change the maximum number of security groups to which an instance can be added to 4 or 10.
-     * *   A basic security group can contain up to 2,000 instances. An advanced security group can contain up to 65,536 instances.
-     * *   The security group and the instance must reside in the same region.
-     * *   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.
+     * > This operation is not recommended. We recommend that you call the [ModifyInstanceAttribute](https://help.aliyun.com/document_detail/25503.html) operation to add an instance to or remove an instance from a security group, and call the [ModifyNetworkInterfaceAttribute](https://help.aliyun.com/document_detail/58513.html) operation to add an ENI to or remove an ENI from a security group.
      * *   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.
-     * For more information, see [Limits](https://help.aliyun.com/document_detail/25412.html).
+     * *   The security group and the ECS instance to be added to the security group must reside in the same region.
+     * *   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.
+     * *   Before you add an instance to a security group, the instance must be in the **Stopped** or **Running** state.
+     * *   An instance can be added to up to five security groups by default. For more information, see [Security group limits](~~25412#SecurityGroupQuota1~~).
      *
      * @param request - JoinSecurityGroupRequest
      * @returns JoinSecurityGroupResponse
@@ -6474,7 +6468,7 @@ export default class Client extends OpenApi {
      */
     modifyDiskAttribute(request: $_model.ModifyDiskAttributeRequest): Promise<$_model.ModifyDiskAttributeResponse>;
     /**
-     * Changes the billing method of data disks that are attached to a subscription Elastic Compute Service (ECS) instance.
+     * Converts the billing method of a data disk attached to a subscription ECS instance between pay-as-you-go and subscription.
      *
      * @remarks
      * For information about how to change the billing method of cloud disks, see [Change the billing methods of a disk](https://help.aliyun.com/document_detail/145018.html).
@@ -6491,7 +6485,7 @@ export default class Client extends OpenApi {
      */
     modifyDiskChargeTypeWithOptions(request: $_model.ModifyDiskChargeTypeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDiskChargeTypeResponse>;
     /**
-     * Changes the billing method of data disks that are attached to a subscription Elastic Compute Service (ECS) instance.
+     * Converts the billing method of a data disk attached to a subscription ECS instance between pay-as-you-go and subscription.
      *
      * @remarks
      * For information about how to change the billing method of cloud disks, see [Change the billing methods of a disk](https://help.aliyun.com/document_detail/145018.html).