1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. ecs
  6. Instance
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.ecs.Instance

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Represents an Elastic Compute Service (ECS) instance resource.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  ecsInstanceDemo:
    type: volcenginecc:ecs:Instance
    name: EcsInstanceDemo
    properties:
      password: '**********'
      instanceChargeType: PostPaid
      instanceName: EcsInstanceDemo
      spotStrategy: NoSpot
      hostname: EcsInstanceDemo
      description: EcsInstanceDemo Description
      projectName: default
      instanceType: ecs.g4i.large
      deletionProtection: false
      zoneId: cn-beijing-a
      deploymentSetId: dps-ydzccfzqjoaa98kxxxxx
      deploymentSetGroupNumber: 1
      image:
        image_id: image-aagd56zrw2jtdroxxxxx
      vpcId: vpc-rrco37ovjq4gv0x58zxxxxx
      eipAddress:
        charge_type: PayByTraffic
        bandwidth_mbps: 5
        isp: BGP
        release_with_instance: false
        bandwidth_package_id: ""
      primaryNetworkInterface:
        security_group_ids:
          - sg-1v9zvjkmx14w51j8e73xxxxx
        subnet_id: subnet-rrwqhg3qzxfkv0x57gxxxxx
        ipv_6_address_count: 1
      secondaryNetworkInterfaces:
        - security_group_ids:
            - sg-1v9zvjkmx14w51j8e73xxxxx
          subnet_id: subnet-rrwqhg3qzxfkv0x57gxxxxx
      placement:
        affinity: Default
        dedicated_host_cluster_id: ""
        tenancy: Default
        dedicated_host_id: ""
      systemVolume:
        size: 50
        delete_with_instance: true
        volume_type: ESSD_FlexPL

    Create Instance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             image: Optional[InstanceImageArgs] = None,
             zone_id: Optional[str] = None,
             system_volume: Optional[InstanceSystemVolumeArgs] = None,
             primary_network_interface: Optional[InstancePrimaryNetworkInterfaceArgs] = None,
             instance_type: Optional[str] = None,
             instance_name: Optional[str] = None,
             description: Optional[str] = None,
             password: Optional[str] = None,
             deployment_set_id: Optional[str] = None,
             affinity_group_size: Optional[int] = None,
             eip_address: Optional[InstanceEipAddressArgs] = None,
             enable_jumbo_frame: Optional[bool] = None,
             hostname: Optional[str] = None,
             hpc_cluster_id: Optional[str] = None,
             deletion_protection: Optional[bool] = None,
             include_data_volumes: Optional[bool] = None,
             install_run_command_agent: Optional[bool] = None,
             instance_charge_type: Optional[str] = None,
             credit_specification: Optional[str] = None,
             cpu_max_frequency: Optional[float] = None,
             key_pair: Optional[InstanceKeyPairArgs] = None,
             deployment_set_group_number: Optional[int] = None,
             period: Optional[int] = None,
             period_unit: Optional[str] = None,
             placement: Optional[InstancePlacementArgs] = None,
             auto_renew_period: Optional[int] = None,
             project_name: Optional[str] = None,
             renew_info: Optional[InstanceRenewInfoArgs] = None,
             role_names: Optional[Sequence[str]] = None,
             secondary_network_interfaces: Optional[Sequence[InstanceSecondaryNetworkInterfaceArgs]] = None,
             spot_price_limit: Optional[float] = None,
             spot_strategy: Optional[str] = None,
             status: Optional[str] = None,
             stopped_mode: Optional[str] = None,
             auto_renew: Optional[bool] = None,
             tags: Optional[Sequence[InstanceTagArgs]] = None,
             user_data: Optional[str] = None,
             auto_pay: Optional[bool] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: volcenginecc:ecs:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Instance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Instance resource accepts the following input properties:

    Image Volcengine.InstanceImage
    The image of the instance.
    InstanceName string
    Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length limit: 1–128 characters
    InstanceType string
    Instance specification. - Product selection: You can refer to Instance Specifications Introduction or call DescribeInstanceTypes to view performance data, and refer to Instance Selection Best Practices to learn how to choose specifications. - Inventory query: You can call DescribeAvailableResource to check available compute resources in the zone.
    PrimaryNetworkInterface Volcengine.InstancePrimaryNetworkInterface
    Primary network interface card of the instance.
    SystemVolume Volcengine.InstanceSystemVolume
    The system volume of the instance.
    ZoneId string
    The availability zone ID where the instance is located.
    AffinityGroupSize int
    Affinity group specification. Value: 2. Note: - Currently, only high performance computing NPU-type hpcpci3 instances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact your account manager.
    AutoPay bool
    Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is insufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only generates the order without charging. You can log in to the order management page to complete payment after the order is generated.
    AutoRenew bool
    Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No auto renewal Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    AutoRenewPeriod int
    Duration for each automatic renewal. - This parameter takes effect only when AutoRenew is set to True. Default value is 1. - When PeriodUnit is Month, valid values are 1, 2, 3, 6, 12.
    CpuMaxFrequency double
    Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. Note:

    • Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo frequencies and more information, see Instance Specifications Introduction. - This feature is in invitation-only testing. To use it, please contact your account manager.
    CreditSpecification string
    Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not supported yet). Note: - This parameter is only effective when InstanceTypeId is set to ecs.t2 series, i.e., burstable instances. - If not specified or left empty, burstable instances default to Standard mode.
    DeletionProtection bool
    Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion protection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code. To delete the instance, disable deletion protection first
    DeploymentSetGroupNumber int
    When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify the group number of the instance within the deployment set. Value range: 1–7.
    DeploymentSetId string
    The deployment set ID the instance needs to join. - You can call the DescribeDeploymentSets API to query existing deployment sets. - For more information about deployment sets, see Deployment Set.
    Description string
    The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters
    EipAddress Volcengine.InstanceEipAddress
    The EIP address of the instance.
    EnableJumboFrame bool
    Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces have an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500
    Hostname string
    Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use consecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows instances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or end with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15 characters.
    HpcClusterId string
    ID of the high performance computing cluster to which the instance belongs. Note: This parameter is only effective and required when creating high performance computing GPU instances.
    IncludeDataVolumes bool
    Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert. false (default): Do not convert.
    InstallRunCommandAgent bool
    Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false (default): Do not install during creation.
    InstanceChargeType string
    The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please ensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be returned.
    KeyPair Volcengine.InstanceKeyPair
    Instance key pair name
    Password string
    The password of the instance.
    Period int
    Resource purchase duration (N). - When PeriodUnit is Month (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60. - When PeriodUnit is Year, valid values are 1, 2, 3, 4, 5. Note: This parameter is valid and required only when InstanceChargeType is set to PrePaid.
    PeriodUnit string
    The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    Placement Volcengine.InstancePlacement
    The deployment information of the instance.
    ProjectName string
    Project name to which the instance belongs.
    RenewInfo Volcengine.InstanceRenewInfo
    Renewal information.
    RoleNames List<string>
    IAM role name bound to the instance
    SecondaryNetworkInterfaces List<Volcengine.InstanceSecondaryNetworkInterface>
    SpotPriceLimit double
    Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when SpotStrategy is set to SpotWithPriceLimit. - When SpotStrategy is set to SpotWithPriceLimit, you can set a custom price limit for the spot instance. If the market price exceeds your bid, the instance will be released. When SpotStrategy is set to SpotAsPriceGo, you accept the system's automatic bidding, following the current market price, and this parameter does not need to be filled in.
    SpotStrategy string
    Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. - SpotAsPriceGo: System bids automatically, following the current market price for spot instances.
    Status string
    Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting STARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting
    StoppedMode string
    StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode. After stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the same as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources (vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and continue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped mode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud server console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging. NotApplicable: Indicates that this instance does not support cost-saving stopped mode.
    Tags List<Volcengine.InstanceTag>
    UserData string
    Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances: Script content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8 KB and does not require Base64 encoding
    Image InstanceImageArgs
    The image of the instance.
    InstanceName string
    Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length limit: 1–128 characters
    InstanceType string
    Instance specification. - Product selection: You can refer to Instance Specifications Introduction or call DescribeInstanceTypes to view performance data, and refer to Instance Selection Best Practices to learn how to choose specifications. - Inventory query: You can call DescribeAvailableResource to check available compute resources in the zone.
    PrimaryNetworkInterface InstancePrimaryNetworkInterfaceArgs
    Primary network interface card of the instance.
    SystemVolume InstanceSystemVolumeArgs
    The system volume of the instance.
    ZoneId string
    The availability zone ID where the instance is located.
    AffinityGroupSize int
    Affinity group specification. Value: 2. Note: - Currently, only high performance computing NPU-type hpcpci3 instances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact your account manager.
    AutoPay bool
    Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is insufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only generates the order without charging. You can log in to the order management page to complete payment after the order is generated.
    AutoRenew bool
    Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No auto renewal Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    AutoRenewPeriod int
    Duration for each automatic renewal. - This parameter takes effect only when AutoRenew is set to True. Default value is 1. - When PeriodUnit is Month, valid values are 1, 2, 3, 6, 12.
    CpuMaxFrequency float64
    Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. Note:

    • Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo frequencies and more information, see Instance Specifications Introduction. - This feature is in invitation-only testing. To use it, please contact your account manager.
    CreditSpecification string
    Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not supported yet). Note: - This parameter is only effective when InstanceTypeId is set to ecs.t2 series, i.e., burstable instances. - If not specified or left empty, burstable instances default to Standard mode.
    DeletionProtection bool
    Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion protection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code. To delete the instance, disable deletion protection first
    DeploymentSetGroupNumber int
    When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify the group number of the instance within the deployment set. Value range: 1–7.
    DeploymentSetId string
    The deployment set ID the instance needs to join. - You can call the DescribeDeploymentSets API to query existing deployment sets. - For more information about deployment sets, see Deployment Set.
    Description string
    The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters
    EipAddress InstanceEipAddressArgs
    The EIP address of the instance.
    EnableJumboFrame bool
    Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces have an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500
    Hostname string
    Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use consecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows instances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or end with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15 characters.
    HpcClusterId string
    ID of the high performance computing cluster to which the instance belongs. Note: This parameter is only effective and required when creating high performance computing GPU instances.
    IncludeDataVolumes bool
    Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert. false (default): Do not convert.
    InstallRunCommandAgent bool
    Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false (default): Do not install during creation.
    InstanceChargeType string
    The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please ensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be returned.
    KeyPair InstanceKeyPairArgs
    Instance key pair name
    Password string
    The password of the instance.
    Period int
    Resource purchase duration (N). - When PeriodUnit is Month (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60. - When PeriodUnit is Year, valid values are 1, 2, 3, 4, 5. Note: This parameter is valid and required only when InstanceChargeType is set to PrePaid.
    PeriodUnit string
    The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    Placement InstancePlacementArgs
    The deployment information of the instance.
    ProjectName string
    Project name to which the instance belongs.
    RenewInfo InstanceRenewInfoArgs
    Renewal information.
    RoleNames []string
    IAM role name bound to the instance
    SecondaryNetworkInterfaces []InstanceSecondaryNetworkInterfaceArgs
    SpotPriceLimit float64
    Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when SpotStrategy is set to SpotWithPriceLimit. - When SpotStrategy is set to SpotWithPriceLimit, you can set a custom price limit for the spot instance. If the market price exceeds your bid, the instance will be released. When SpotStrategy is set to SpotAsPriceGo, you accept the system's automatic bidding, following the current market price, and this parameter does not need to be filled in.
    SpotStrategy string
    Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. - SpotAsPriceGo: System bids automatically, following the current market price for spot instances.
    Status string
    Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting STARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting
    StoppedMode string
    StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode. After stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the same as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources (vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and continue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped mode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud server console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging. NotApplicable: Indicates that this instance does not support cost-saving stopped mode.
    Tags []InstanceTagArgs
    UserData string
    Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances: Script content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8 KB and does not require Base64 encoding
    image InstanceImage
    The image of the instance.
    instanceName String
    Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length limit: 1–128 characters
    instanceType String
    Instance specification. - Product selection: You can refer to Instance Specifications Introduction or call DescribeInstanceTypes to view performance data, and refer to Instance Selection Best Practices to learn how to choose specifications. - Inventory query: You can call DescribeAvailableResource to check available compute resources in the zone.
    primaryNetworkInterface InstancePrimaryNetworkInterface
    Primary network interface card of the instance.
    systemVolume InstanceSystemVolume
    The system volume of the instance.
    zoneId String
    The availability zone ID where the instance is located.
    affinityGroupSize Integer
    Affinity group specification. Value: 2. Note: - Currently, only high performance computing NPU-type hpcpci3 instances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact your account manager.
    autoPay Boolean
    Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is insufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only generates the order without charging. You can log in to the order management page to complete payment after the order is generated.
    autoRenew Boolean
    Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No auto renewal Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    autoRenewPeriod Integer
    Duration for each automatic renewal. - This parameter takes effect only when AutoRenew is set to True. Default value is 1. - When PeriodUnit is Month, valid values are 1, 2, 3, 6, 12.
    cpuMaxFrequency Double
    Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. Note:

    • Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo frequencies and more information, see Instance Specifications Introduction. - This feature is in invitation-only testing. To use it, please contact your account manager.
    creditSpecification String
    Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not supported yet). Note: - This parameter is only effective when InstanceTypeId is set to ecs.t2 series, i.e., burstable instances. - If not specified or left empty, burstable instances default to Standard mode.
    deletionProtection Boolean
    Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion protection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code. To delete the instance, disable deletion protection first
    deploymentSetGroupNumber Integer
    When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify the group number of the instance within the deployment set. Value range: 1–7.
    deploymentSetId String
    The deployment set ID the instance needs to join. - You can call the DescribeDeploymentSets API to query existing deployment sets. - For more information about deployment sets, see Deployment Set.
    description String
    The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters
    eipAddress InstanceEipAddress
    The EIP address of the instance.
    enableJumboFrame Boolean
    Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces have an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500
    hostname String
    Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use consecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows instances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or end with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15 characters.
    hpcClusterId String
    ID of the high performance computing cluster to which the instance belongs. Note: This parameter is only effective and required when creating high performance computing GPU instances.
    includeDataVolumes Boolean
    Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert. false (default): Do not convert.
    installRunCommandAgent Boolean
    Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false (default): Do not install during creation.
    instanceChargeType String
    The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please ensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be returned.
    keyPair InstanceKeyPair
    Instance key pair name
    password String
    The password of the instance.
    period Integer
    Resource purchase duration (N). - When PeriodUnit is Month (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60. - When PeriodUnit is Year, valid values are 1, 2, 3, 4, 5. Note: This parameter is valid and required only when InstanceChargeType is set to PrePaid.
    periodUnit String
    The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    placement InstancePlacement
    The deployment information of the instance.
    projectName String
    Project name to which the instance belongs.
    renewInfo InstanceRenewInfo
    Renewal information.
    roleNames List<String>
    IAM role name bound to the instance
    secondaryNetworkInterfaces List<InstanceSecondaryNetworkInterface>
    spotPriceLimit Double
    Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when SpotStrategy is set to SpotWithPriceLimit. - When SpotStrategy is set to SpotWithPriceLimit, you can set a custom price limit for the spot instance. If the market price exceeds your bid, the instance will be released. When SpotStrategy is set to SpotAsPriceGo, you accept the system's automatic bidding, following the current market price, and this parameter does not need to be filled in.
    spotStrategy String
    Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. - SpotAsPriceGo: System bids automatically, following the current market price for spot instances.
    status String
    Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting STARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting
    stoppedMode String
    StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode. After stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the same as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources (vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and continue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped mode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud server console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging. NotApplicable: Indicates that this instance does not support cost-saving stopped mode.
    tags List<InstanceTag>
    userData String
    Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances: Script content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8 KB and does not require Base64 encoding
    image InstanceImage
    The image of the instance.
    instanceName string
    Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length limit: 1–128 characters
    instanceType string
    Instance specification. - Product selection: You can refer to Instance Specifications Introduction or call DescribeInstanceTypes to view performance data, and refer to Instance Selection Best Practices to learn how to choose specifications. - Inventory query: You can call DescribeAvailableResource to check available compute resources in the zone.
    primaryNetworkInterface InstancePrimaryNetworkInterface
    Primary network interface card of the instance.
    systemVolume InstanceSystemVolume
    The system volume of the instance.
    zoneId string
    The availability zone ID where the instance is located.
    affinityGroupSize number
    Affinity group specification. Value: 2. Note: - Currently, only high performance computing NPU-type hpcpci3 instances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact your account manager.
    autoPay boolean
    Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is insufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only generates the order without charging. You can log in to the order management page to complete payment after the order is generated.
    autoRenew boolean
    Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No auto renewal Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    autoRenewPeriod number
    Duration for each automatic renewal. - This parameter takes effect only when AutoRenew is set to True. Default value is 1. - When PeriodUnit is Month, valid values are 1, 2, 3, 6, 12.
    cpuMaxFrequency number
    Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. Note:

    • Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo frequencies and more information, see Instance Specifications Introduction. - This feature is in invitation-only testing. To use it, please contact your account manager.
    creditSpecification string
    Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not supported yet). Note: - This parameter is only effective when InstanceTypeId is set to ecs.t2 series, i.e., burstable instances. - If not specified or left empty, burstable instances default to Standard mode.
    deletionProtection boolean
    Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion protection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code. To delete the instance, disable deletion protection first
    deploymentSetGroupNumber number
    When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify the group number of the instance within the deployment set. Value range: 1–7.
    deploymentSetId string
    The deployment set ID the instance needs to join. - You can call the DescribeDeploymentSets API to query existing deployment sets. - For more information about deployment sets, see Deployment Set.
    description string
    The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters
    eipAddress InstanceEipAddress
    The EIP address of the instance.
    enableJumboFrame boolean
    Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces have an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500
    hostname string
    Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use consecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows instances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or end with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15 characters.
    hpcClusterId string
    ID of the high performance computing cluster to which the instance belongs. Note: This parameter is only effective and required when creating high performance computing GPU instances.
    includeDataVolumes boolean
    Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert. false (default): Do not convert.
    installRunCommandAgent boolean
    Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false (default): Do not install during creation.
    instanceChargeType string
    The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please ensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be returned.
    keyPair InstanceKeyPair
    Instance key pair name
    password string
    The password of the instance.
    period number
    Resource purchase duration (N). - When PeriodUnit is Month (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60. - When PeriodUnit is Year, valid values are 1, 2, 3, 4, 5. Note: This parameter is valid and required only when InstanceChargeType is set to PrePaid.
    periodUnit string
    The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    placement InstancePlacement
    The deployment information of the instance.
    projectName string
    Project name to which the instance belongs.
    renewInfo InstanceRenewInfo
    Renewal information.
    roleNames string[]
    IAM role name bound to the instance
    secondaryNetworkInterfaces InstanceSecondaryNetworkInterface[]
    spotPriceLimit number
    Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when SpotStrategy is set to SpotWithPriceLimit. - When SpotStrategy is set to SpotWithPriceLimit, you can set a custom price limit for the spot instance. If the market price exceeds your bid, the instance will be released. When SpotStrategy is set to SpotAsPriceGo, you accept the system's automatic bidding, following the current market price, and this parameter does not need to be filled in.
    spotStrategy string
    Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. - SpotAsPriceGo: System bids automatically, following the current market price for spot instances.
    status string
    Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting STARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting
    stoppedMode string
    StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode. After stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the same as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources (vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and continue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped mode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud server console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging. NotApplicable: Indicates that this instance does not support cost-saving stopped mode.
    tags InstanceTag[]
    userData string
    Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances: Script content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8 KB and does not require Base64 encoding
    image InstanceImageArgs
    The image of the instance.
    instance_name str
    Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length limit: 1–128 characters
    instance_type str
    Instance specification. - Product selection: You can refer to Instance Specifications Introduction or call DescribeInstanceTypes to view performance data, and refer to Instance Selection Best Practices to learn how to choose specifications. - Inventory query: You can call DescribeAvailableResource to check available compute resources in the zone.
    primary_network_interface InstancePrimaryNetworkInterfaceArgs
    Primary network interface card of the instance.
    system_volume InstanceSystemVolumeArgs
    The system volume of the instance.
    zone_id str
    The availability zone ID where the instance is located.
    affinity_group_size int
    Affinity group specification. Value: 2. Note: - Currently, only high performance computing NPU-type hpcpci3 instances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact your account manager.
    auto_pay bool
    Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is insufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only generates the order without charging. You can log in to the order management page to complete payment after the order is generated.
    auto_renew bool
    Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No auto renewal Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    auto_renew_period int
    Duration for each automatic renewal. - This parameter takes effect only when AutoRenew is set to True. Default value is 1. - When PeriodUnit is Month, valid values are 1, 2, 3, 6, 12.
    cpu_max_frequency float
    Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. Note:

    • Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo frequencies and more information, see Instance Specifications Introduction. - This feature is in invitation-only testing. To use it, please contact your account manager.
    credit_specification str
    Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not supported yet). Note: - This parameter is only effective when InstanceTypeId is set to ecs.t2 series, i.e., burstable instances. - If not specified or left empty, burstable instances default to Standard mode.
    deletion_protection bool
    Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion protection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code. To delete the instance, disable deletion protection first
    deployment_set_group_number int
    When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify the group number of the instance within the deployment set. Value range: 1–7.
    deployment_set_id str
    The deployment set ID the instance needs to join. - You can call the DescribeDeploymentSets API to query existing deployment sets. - For more information about deployment sets, see Deployment Set.
    description str
    The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters
    eip_address InstanceEipAddressArgs
    The EIP address of the instance.
    enable_jumbo_frame bool
    Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces have an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500
    hostname str
    Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use consecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows instances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or end with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15 characters.
    hpc_cluster_id str
    ID of the high performance computing cluster to which the instance belongs. Note: This parameter is only effective and required when creating high performance computing GPU instances.
    include_data_volumes bool
    Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert. false (default): Do not convert.
    install_run_command_agent bool
    Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false (default): Do not install during creation.
    instance_charge_type str
    The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please ensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be returned.
    key_pair InstanceKeyPairArgs
    Instance key pair name
    password str
    The password of the instance.
    period int
    Resource purchase duration (N). - When PeriodUnit is Month (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60. - When PeriodUnit is Year, valid values are 1, 2, 3, 4, 5. Note: This parameter is valid and required only when InstanceChargeType is set to PrePaid.
    period_unit str
    The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    placement InstancePlacementArgs
    The deployment information of the instance.
    project_name str
    Project name to which the instance belongs.
    renew_info InstanceRenewInfoArgs
    Renewal information.
    role_names Sequence[str]
    IAM role name bound to the instance
    secondary_network_interfaces Sequence[InstanceSecondaryNetworkInterfaceArgs]
    spot_price_limit float
    Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when SpotStrategy is set to SpotWithPriceLimit. - When SpotStrategy is set to SpotWithPriceLimit, you can set a custom price limit for the spot instance. If the market price exceeds your bid, the instance will be released. When SpotStrategy is set to SpotAsPriceGo, you accept the system's automatic bidding, following the current market price, and this parameter does not need to be filled in.
    spot_strategy str
    Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. - SpotAsPriceGo: System bids automatically, following the current market price for spot instances.
    status str
    Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting STARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting
    stopped_mode str
    StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode. After stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the same as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources (vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and continue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped mode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud server console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging. NotApplicable: Indicates that this instance does not support cost-saving stopped mode.
    tags Sequence[InstanceTagArgs]
    user_data str
    Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances: Script content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8 KB and does not require Base64 encoding
    image Property Map
    The image of the instance.
    instanceName String
    Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length limit: 1–128 characters
    instanceType String
    Instance specification. - Product selection: You can refer to Instance Specifications Introduction or call DescribeInstanceTypes to view performance data, and refer to Instance Selection Best Practices to learn how to choose specifications. - Inventory query: You can call DescribeAvailableResource to check available compute resources in the zone.
    primaryNetworkInterface Property Map
    Primary network interface card of the instance.
    systemVolume Property Map
    The system volume of the instance.
    zoneId String
    The availability zone ID where the instance is located.
    affinityGroupSize Number
    Affinity group specification. Value: 2. Note: - Currently, only high performance computing NPU-type hpcpci3 instances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact your account manager.
    autoPay Boolean
    Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is insufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only generates the order without charging. You can log in to the order management page to complete payment after the order is generated.
    autoRenew Boolean
    Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No auto renewal Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    autoRenewPeriod Number
    Duration for each automatic renewal. - This parameter takes effect only when AutoRenew is set to True. Default value is 1. - When PeriodUnit is Month, valid values are 1, 2, 3, 6, 12.
    cpuMaxFrequency Number
    Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. Note:

    • Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo frequencies and more information, see Instance Specifications Introduction. - This feature is in invitation-only testing. To use it, please contact your account manager.
    creditSpecification String
    Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not supported yet). Note: - This parameter is only effective when InstanceTypeId is set to ecs.t2 series, i.e., burstable instances. - If not specified or left empty, burstable instances default to Standard mode.
    deletionProtection Boolean
    Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion protection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code. To delete the instance, disable deletion protection first
    deploymentSetGroupNumber Number
    When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify the group number of the instance within the deployment set. Value range: 1–7.
    deploymentSetId String
    The deployment set ID the instance needs to join. - You can call the DescribeDeploymentSets API to query existing deployment sets. - For more information about deployment sets, see Deployment Set.
    description String
    The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters
    eipAddress Property Map
    The EIP address of the instance.
    enableJumboFrame Boolean
    Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces have an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500
    hostname String
    Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use consecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows instances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or end with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15 characters.
    hpcClusterId String
    ID of the high performance computing cluster to which the instance belongs. Note: This parameter is only effective and required when creating high performance computing GPU instances.
    includeDataVolumes Boolean
    Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert. false (default): Do not convert.
    installRunCommandAgent Boolean
    Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false (default): Do not install during creation.
    instanceChargeType String
    The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please ensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be returned.
    keyPair Property Map
    Instance key pair name
    password String
    The password of the instance.
    period Number
    Resource purchase duration (N). - When PeriodUnit is Month (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60. - When PeriodUnit is Year, valid values are 1, 2, 3, 4, 5. Note: This parameter is valid and required only when InstanceChargeType is set to PrePaid.
    periodUnit String
    The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    placement Property Map
    The deployment information of the instance.
    projectName String
    Project name to which the instance belongs.
    renewInfo Property Map
    Renewal information.
    roleNames List<String>
    IAM role name bound to the instance
    secondaryNetworkInterfaces List<Property Map>
    spotPriceLimit Number
    Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when SpotStrategy is set to SpotWithPriceLimit. - When SpotStrategy is set to SpotWithPriceLimit, you can set a custom price limit for the spot instance. If the market price exceeds your bid, the instance will be released. When SpotStrategy is set to SpotAsPriceGo, you accept the system's automatic bidding, following the current market price, and this parameter does not need to be filled in.
    spotStrategy String
    Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. - SpotAsPriceGo: System bids automatically, following the current market price for spot instances.
    status String
    Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting STARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting
    stoppedMode String
    StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode. After stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the same as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources (vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and continue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped mode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud server console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging. NotApplicable: Indicates that this instance does not support cost-saving stopped mode.
    tags List<Property Map>
    userData String
    Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances: Script content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8 KB and does not require Base64 encoding

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

    AffinityGroupId string
    Affinity group ID.
    CpuMemory Volcengine.InstanceCpuMemory
    The CPU options for the instance.
    CreatedAt string
    Instance creation time.
    ElasticScheduledInstanceType string
    Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance. Segmented: Elastic reservation instance - time segment type.
    ExpiredAt string
    The expiration time of the instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    The ECS instance ID.
    LocalVolumes List<Volcengine.InstanceLocalVolume>
    OperationSystem Volcengine.InstanceOperationSystem
    The operating system type of the instance.
    RdmaIpAddresses List<string>
    When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in a list.
    RdmaNetworkInterfaceDetails List<Volcengine.InstanceRdmaNetworkInterfaceDetail>
    UpdatedAt string
    The update time of the instance.
    VpcId string
    The private network ID to which the instance belongs. You can call the DescribeVpcs API to obtain VPC information for the target region.
    AffinityGroupId string
    Affinity group ID.
    CpuMemory InstanceCpuMemory
    The CPU options for the instance.
    CreatedAt string
    Instance creation time.
    ElasticScheduledInstanceType string
    Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance. Segmented: Elastic reservation instance - time segment type.
    ExpiredAt string
    The expiration time of the instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    The ECS instance ID.
    LocalVolumes []InstanceLocalVolume
    OperationSystem InstanceOperationSystem
    The operating system type of the instance.
    RdmaIpAddresses []string
    When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in a list.
    RdmaNetworkInterfaceDetails []InstanceRdmaNetworkInterfaceDetail
    UpdatedAt string
    The update time of the instance.
    VpcId string
    The private network ID to which the instance belongs. You can call the DescribeVpcs API to obtain VPC information for the target region.
    affinityGroupId String
    Affinity group ID.
    cpuMemory InstanceCpuMemory
    The CPU options for the instance.
    createdAt String
    Instance creation time.
    elasticScheduledInstanceType String
    Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance. Segmented: Elastic reservation instance - time segment type.
    expiredAt String
    The expiration time of the instance.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    The ECS instance ID.
    localVolumes List<InstanceLocalVolume>
    operationSystem InstanceOperationSystem
    The operating system type of the instance.
    rdmaIpAddresses List<String>
    When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in a list.
    rdmaNetworkInterfaceDetails List<InstanceRdmaNetworkInterfaceDetail>
    updatedAt String
    The update time of the instance.
    vpcId String
    The private network ID to which the instance belongs. You can call the DescribeVpcs API to obtain VPC information for the target region.
    affinityGroupId string
    Affinity group ID.
    cpuMemory InstanceCpuMemory
    The CPU options for the instance.
    createdAt string
    Instance creation time.
    elasticScheduledInstanceType string
    Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance. Segmented: Elastic reservation instance - time segment type.
    expiredAt string
    The expiration time of the instance.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    The ECS instance ID.
    localVolumes InstanceLocalVolume[]
    operationSystem InstanceOperationSystem
    The operating system type of the instance.
    rdmaIpAddresses string[]
    When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in a list.
    rdmaNetworkInterfaceDetails InstanceRdmaNetworkInterfaceDetail[]
    updatedAt string
    The update time of the instance.
    vpcId string
    The private network ID to which the instance belongs. You can call the DescribeVpcs API to obtain VPC information for the target region.
    affinity_group_id str
    Affinity group ID.
    cpu_memory InstanceCpuMemory
    The CPU options for the instance.
    created_at str
    Instance creation time.
    elastic_scheduled_instance_type str
    Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance. Segmented: Elastic reservation instance - time segment type.
    expired_at str
    The expiration time of the instance.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    The ECS instance ID.
    local_volumes Sequence[InstanceLocalVolume]
    operation_system InstanceOperationSystem
    The operating system type of the instance.
    rdma_ip_addresses Sequence[str]
    When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in a list.
    rdma_network_interface_details Sequence[InstanceRdmaNetworkInterfaceDetail]
    updated_at str
    The update time of the instance.
    vpc_id str
    The private network ID to which the instance belongs. You can call the DescribeVpcs API to obtain VPC information for the target region.
    affinityGroupId String
    Affinity group ID.
    cpuMemory Property Map
    The CPU options for the instance.
    createdAt String
    Instance creation time.
    elasticScheduledInstanceType String
    Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance. Segmented: Elastic reservation instance - time segment type.
    expiredAt String
    The expiration time of the instance.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    The ECS instance ID.
    localVolumes List<Property Map>
    operationSystem Property Map
    The operating system type of the instance.
    rdmaIpAddresses List<String>
    When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in a list.
    rdmaNetworkInterfaceDetails List<Property Map>
    updatedAt String
    The update time of the instance.
    vpcId String
    The private network ID to which the instance belongs. You can call the DescribeVpcs API to obtain VPC information for the target region.

    Look up Existing Instance Resource

    Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        affinity_group_id: Optional[str] = None,
        affinity_group_size: Optional[int] = None,
        auto_pay: Optional[bool] = None,
        auto_renew: Optional[bool] = None,
        auto_renew_period: Optional[int] = None,
        cpu_max_frequency: Optional[float] = None,
        cpu_memory: Optional[InstanceCpuMemoryArgs] = None,
        created_at: Optional[str] = None,
        credit_specification: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        deployment_set_group_number: Optional[int] = None,
        deployment_set_id: Optional[str] = None,
        description: Optional[str] = None,
        eip_address: Optional[InstanceEipAddressArgs] = None,
        elastic_scheduled_instance_type: Optional[str] = None,
        enable_jumbo_frame: Optional[bool] = None,
        expired_at: Optional[str] = None,
        hostname: Optional[str] = None,
        hpc_cluster_id: Optional[str] = None,
        image: Optional[InstanceImageArgs] = None,
        include_data_volumes: Optional[bool] = None,
        install_run_command_agent: Optional[bool] = None,
        instance_charge_type: Optional[str] = None,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_type: Optional[str] = None,
        key_pair: Optional[InstanceKeyPairArgs] = None,
        local_volumes: Optional[Sequence[InstanceLocalVolumeArgs]] = None,
        operation_system: Optional[InstanceOperationSystemArgs] = None,
        password: Optional[str] = None,
        period: Optional[int] = None,
        period_unit: Optional[str] = None,
        placement: Optional[InstancePlacementArgs] = None,
        primary_network_interface: Optional[InstancePrimaryNetworkInterfaceArgs] = None,
        project_name: Optional[str] = None,
        rdma_ip_addresses: Optional[Sequence[str]] = None,
        rdma_network_interface_details: Optional[Sequence[InstanceRdmaNetworkInterfaceDetailArgs]] = None,
        renew_info: Optional[InstanceRenewInfoArgs] = None,
        role_names: Optional[Sequence[str]] = None,
        secondary_network_interfaces: Optional[Sequence[InstanceSecondaryNetworkInterfaceArgs]] = None,
        spot_price_limit: Optional[float] = None,
        spot_strategy: Optional[str] = None,
        status: Optional[str] = None,
        stopped_mode: Optional[str] = None,
        system_volume: Optional[InstanceSystemVolumeArgs] = None,
        tags: Optional[Sequence[InstanceTagArgs]] = None,
        updated_at: Optional[str] = None,
        user_data: Optional[str] = None,
        vpc_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:ecs:Instance    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AffinityGroupId string
    Affinity group ID.
    AffinityGroupSize int
    Affinity group specification. Value: 2. Note: - Currently, only high performance computing NPU-type hpcpci3 instances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact your account manager.
    AutoPay bool
    Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is insufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only generates the order without charging. You can log in to the order management page to complete payment after the order is generated.
    AutoRenew bool
    Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No auto renewal Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    AutoRenewPeriod int
    Duration for each automatic renewal. - This parameter takes effect only when AutoRenew is set to True. Default value is 1. - When PeriodUnit is Month, valid values are 1, 2, 3, 6, 12.
    CpuMaxFrequency double
    Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. Note:

    • Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo frequencies and more information, see Instance Specifications Introduction. - This feature is in invitation-only testing. To use it, please contact your account manager.
    CpuMemory Volcengine.InstanceCpuMemory
    The CPU options for the instance.
    CreatedAt string
    Instance creation time.
    CreditSpecification string
    Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not supported yet). Note: - This parameter is only effective when InstanceTypeId is set to ecs.t2 series, i.e., burstable instances. - If not specified or left empty, burstable instances default to Standard mode.
    DeletionProtection bool
    Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion protection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code. To delete the instance, disable deletion protection first
    DeploymentSetGroupNumber int
    When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify the group number of the instance within the deployment set. Value range: 1–7.
    DeploymentSetId string
    The deployment set ID the instance needs to join. - You can call the DescribeDeploymentSets API to query existing deployment sets. - For more information about deployment sets, see Deployment Set.
    Description string
    The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters
    EipAddress Volcengine.InstanceEipAddress
    The EIP address of the instance.
    ElasticScheduledInstanceType string
    Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance. Segmented: Elastic reservation instance - time segment type.
    EnableJumboFrame bool
    Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces have an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500
    ExpiredAt string
    The expiration time of the instance.
    Hostname string
    Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use consecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows instances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or end with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15 characters.
    HpcClusterId string
    ID of the high performance computing cluster to which the instance belongs. Note: This parameter is only effective and required when creating high performance computing GPU instances.
    Image Volcengine.InstanceImage
    The image of the instance.
    IncludeDataVolumes bool
    Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert. false (default): Do not convert.
    InstallRunCommandAgent bool
    Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false (default): Do not install during creation.
    InstanceChargeType string
    The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please ensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be returned.
    InstanceId string
    The ECS instance ID.
    InstanceName string
    Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length limit: 1–128 characters
    InstanceType string
    Instance specification. - Product selection: You can refer to Instance Specifications Introduction or call DescribeInstanceTypes to view performance data, and refer to Instance Selection Best Practices to learn how to choose specifications. - Inventory query: You can call DescribeAvailableResource to check available compute resources in the zone.
    KeyPair Volcengine.InstanceKeyPair
    Instance key pair name
    LocalVolumes List<Volcengine.InstanceLocalVolume>
    OperationSystem Volcengine.InstanceOperationSystem
    The operating system type of the instance.
    Password string
    The password of the instance.
    Period int
    Resource purchase duration (N). - When PeriodUnit is Month (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60. - When PeriodUnit is Year, valid values are 1, 2, 3, 4, 5. Note: This parameter is valid and required only when InstanceChargeType is set to PrePaid.
    PeriodUnit string
    The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    Placement Volcengine.InstancePlacement
    The deployment information of the instance.
    PrimaryNetworkInterface Volcengine.InstancePrimaryNetworkInterface
    Primary network interface card of the instance.
    ProjectName string
    Project name to which the instance belongs.
    RdmaIpAddresses List<string>
    When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in a list.
    RdmaNetworkInterfaceDetails List<Volcengine.InstanceRdmaNetworkInterfaceDetail>
    RenewInfo Volcengine.InstanceRenewInfo
    Renewal information.
    RoleNames List<string>
    IAM role name bound to the instance
    SecondaryNetworkInterfaces List<Volcengine.InstanceSecondaryNetworkInterface>
    SpotPriceLimit double
    Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when SpotStrategy is set to SpotWithPriceLimit. - When SpotStrategy is set to SpotWithPriceLimit, you can set a custom price limit for the spot instance. If the market price exceeds your bid, the instance will be released. When SpotStrategy is set to SpotAsPriceGo, you accept the system's automatic bidding, following the current market price, and this parameter does not need to be filled in.
    SpotStrategy string
    Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. - SpotAsPriceGo: System bids automatically, following the current market price for spot instances.
    Status string
    Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting STARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting
    StoppedMode string
    StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode. After stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the same as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources (vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and continue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped mode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud server console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging. NotApplicable: Indicates that this instance does not support cost-saving stopped mode.
    SystemVolume Volcengine.InstanceSystemVolume
    The system volume of the instance.
    Tags List<Volcengine.InstanceTag>
    UpdatedAt string
    The update time of the instance.
    UserData string
    Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances: Script content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8 KB and does not require Base64 encoding
    VpcId string
    The private network ID to which the instance belongs. You can call the DescribeVpcs API to obtain VPC information for the target region.
    ZoneId string
    The availability zone ID where the instance is located.
    AffinityGroupId string
    Affinity group ID.
    AffinityGroupSize int
    Affinity group specification. Value: 2. Note: - Currently, only high performance computing NPU-type hpcpci3 instances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact your account manager.
    AutoPay bool
    Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is insufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only generates the order without charging. You can log in to the order management page to complete payment after the order is generated.
    AutoRenew bool
    Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No auto renewal Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    AutoRenewPeriod int
    Duration for each automatic renewal. - This parameter takes effect only when AutoRenew is set to True. Default value is 1. - When PeriodUnit is Month, valid values are 1, 2, 3, 6, 12.
    CpuMaxFrequency float64
    Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. Note:

    • Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo frequencies and more information, see Instance Specifications Introduction. - This feature is in invitation-only testing. To use it, please contact your account manager.
    CpuMemory InstanceCpuMemoryArgs
    The CPU options for the instance.
    CreatedAt string
    Instance creation time.
    CreditSpecification string
    Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not supported yet). Note: - This parameter is only effective when InstanceTypeId is set to ecs.t2 series, i.e., burstable instances. - If not specified or left empty, burstable instances default to Standard mode.
    DeletionProtection bool
    Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion protection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code. To delete the instance, disable deletion protection first
    DeploymentSetGroupNumber int
    When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify the group number of the instance within the deployment set. Value range: 1–7.
    DeploymentSetId string
    The deployment set ID the instance needs to join. - You can call the DescribeDeploymentSets API to query existing deployment sets. - For more information about deployment sets, see Deployment Set.
    Description string
    The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters
    EipAddress InstanceEipAddressArgs
    The EIP address of the instance.
    ElasticScheduledInstanceType string
    Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance. Segmented: Elastic reservation instance - time segment type.
    EnableJumboFrame bool
    Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces have an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500
    ExpiredAt string
    The expiration time of the instance.
    Hostname string
    Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use consecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows instances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or end with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15 characters.
    HpcClusterId string
    ID of the high performance computing cluster to which the instance belongs. Note: This parameter is only effective and required when creating high performance computing GPU instances.
    Image InstanceImageArgs
    The image of the instance.
    IncludeDataVolumes bool
    Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert. false (default): Do not convert.
    InstallRunCommandAgent bool
    Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false (default): Do not install during creation.
    InstanceChargeType string
    The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please ensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be returned.
    InstanceId string
    The ECS instance ID.
    InstanceName string
    Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length limit: 1–128 characters
    InstanceType string
    Instance specification. - Product selection: You can refer to Instance Specifications Introduction or call DescribeInstanceTypes to view performance data, and refer to Instance Selection Best Practices to learn how to choose specifications. - Inventory query: You can call DescribeAvailableResource to check available compute resources in the zone.
    KeyPair InstanceKeyPairArgs
    Instance key pair name
    LocalVolumes []InstanceLocalVolumeArgs
    OperationSystem InstanceOperationSystemArgs
    The operating system type of the instance.
    Password string
    The password of the instance.
    Period int
    Resource purchase duration (N). - When PeriodUnit is Month (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60. - When PeriodUnit is Year, valid values are 1, 2, 3, 4, 5. Note: This parameter is valid and required only when InstanceChargeType is set to PrePaid.
    PeriodUnit string
    The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    Placement InstancePlacementArgs
    The deployment information of the instance.
    PrimaryNetworkInterface InstancePrimaryNetworkInterfaceArgs
    Primary network interface card of the instance.
    ProjectName string
    Project name to which the instance belongs.
    RdmaIpAddresses []string
    When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in a list.
    RdmaNetworkInterfaceDetails []InstanceRdmaNetworkInterfaceDetailArgs
    RenewInfo InstanceRenewInfoArgs
    Renewal information.
    RoleNames []string
    IAM role name bound to the instance
    SecondaryNetworkInterfaces []InstanceSecondaryNetworkInterfaceArgs
    SpotPriceLimit float64
    Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when SpotStrategy is set to SpotWithPriceLimit. - When SpotStrategy is set to SpotWithPriceLimit, you can set a custom price limit for the spot instance. If the market price exceeds your bid, the instance will be released. When SpotStrategy is set to SpotAsPriceGo, you accept the system's automatic bidding, following the current market price, and this parameter does not need to be filled in.
    SpotStrategy string
    Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. - SpotAsPriceGo: System bids automatically, following the current market price for spot instances.
    Status string
    Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting STARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting
    StoppedMode string
    StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode. After stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the same as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources (vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and continue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped mode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud server console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging. NotApplicable: Indicates that this instance does not support cost-saving stopped mode.
    SystemVolume InstanceSystemVolumeArgs
    The system volume of the instance.
    Tags []InstanceTagArgs
    UpdatedAt string
    The update time of the instance.
    UserData string
    Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances: Script content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8 KB and does not require Base64 encoding
    VpcId string
    The private network ID to which the instance belongs. You can call the DescribeVpcs API to obtain VPC information for the target region.
    ZoneId string
    The availability zone ID where the instance is located.
    affinityGroupId String
    Affinity group ID.
    affinityGroupSize Integer
    Affinity group specification. Value: 2. Note: - Currently, only high performance computing NPU-type hpcpci3 instances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact your account manager.
    autoPay Boolean
    Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is insufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only generates the order without charging. You can log in to the order management page to complete payment after the order is generated.
    autoRenew Boolean
    Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No auto renewal Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    autoRenewPeriod Integer
    Duration for each automatic renewal. - This parameter takes effect only when AutoRenew is set to True. Default value is 1. - When PeriodUnit is Month, valid values are 1, 2, 3, 6, 12.
    cpuMaxFrequency Double
    Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. Note:

    • Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo frequencies and more information, see Instance Specifications Introduction. - This feature is in invitation-only testing. To use it, please contact your account manager.
    cpuMemory InstanceCpuMemory
    The CPU options for the instance.
    createdAt String
    Instance creation time.
    creditSpecification String
    Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not supported yet). Note: - This parameter is only effective when InstanceTypeId is set to ecs.t2 series, i.e., burstable instances. - If not specified or left empty, burstable instances default to Standard mode.
    deletionProtection Boolean
    Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion protection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code. To delete the instance, disable deletion protection first
    deploymentSetGroupNumber Integer
    When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify the group number of the instance within the deployment set. Value range: 1–7.
    deploymentSetId String
    The deployment set ID the instance needs to join. - You can call the DescribeDeploymentSets API to query existing deployment sets. - For more information about deployment sets, see Deployment Set.
    description String
    The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters
    eipAddress InstanceEipAddress
    The EIP address of the instance.
    elasticScheduledInstanceType String
    Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance. Segmented: Elastic reservation instance - time segment type.
    enableJumboFrame Boolean
    Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces have an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500
    expiredAt String
    The expiration time of the instance.
    hostname String
    Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use consecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows instances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or end with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15 characters.
    hpcClusterId String
    ID of the high performance computing cluster to which the instance belongs. Note: This parameter is only effective and required when creating high performance computing GPU instances.
    image InstanceImage
    The image of the instance.
    includeDataVolumes Boolean
    Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert. false (default): Do not convert.
    installRunCommandAgent Boolean
    Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false (default): Do not install during creation.
    instanceChargeType String
    The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please ensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be returned.
    instanceId String
    The ECS instance ID.
    instanceName String
    Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length limit: 1–128 characters
    instanceType String
    Instance specification. - Product selection: You can refer to Instance Specifications Introduction or call DescribeInstanceTypes to view performance data, and refer to Instance Selection Best Practices to learn how to choose specifications. - Inventory query: You can call DescribeAvailableResource to check available compute resources in the zone.
    keyPair InstanceKeyPair
    Instance key pair name
    localVolumes List<InstanceLocalVolume>
    operationSystem InstanceOperationSystem
    The operating system type of the instance.
    password String
    The password of the instance.
    period Integer
    Resource purchase duration (N). - When PeriodUnit is Month (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60. - When PeriodUnit is Year, valid values are 1, 2, 3, 4, 5. Note: This parameter is valid and required only when InstanceChargeType is set to PrePaid.
    periodUnit String
    The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    placement InstancePlacement
    The deployment information of the instance.
    primaryNetworkInterface InstancePrimaryNetworkInterface
    Primary network interface card of the instance.
    projectName String
    Project name to which the instance belongs.
    rdmaIpAddresses List<String>
    When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in a list.
    rdmaNetworkInterfaceDetails List<InstanceRdmaNetworkInterfaceDetail>
    renewInfo InstanceRenewInfo
    Renewal information.
    roleNames List<String>
    IAM role name bound to the instance
    secondaryNetworkInterfaces List<InstanceSecondaryNetworkInterface>
    spotPriceLimit Double
    Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when SpotStrategy is set to SpotWithPriceLimit. - When SpotStrategy is set to SpotWithPriceLimit, you can set a custom price limit for the spot instance. If the market price exceeds your bid, the instance will be released. When SpotStrategy is set to SpotAsPriceGo, you accept the system's automatic bidding, following the current market price, and this parameter does not need to be filled in.
    spotStrategy String
    Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. - SpotAsPriceGo: System bids automatically, following the current market price for spot instances.
    status String
    Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting STARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting
    stoppedMode String
    StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode. After stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the same as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources (vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and continue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped mode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud server console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging. NotApplicable: Indicates that this instance does not support cost-saving stopped mode.
    systemVolume InstanceSystemVolume
    The system volume of the instance.
    tags List<InstanceTag>
    updatedAt String
    The update time of the instance.
    userData String
    Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances: Script content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8 KB and does not require Base64 encoding
    vpcId String
    The private network ID to which the instance belongs. You can call the DescribeVpcs API to obtain VPC information for the target region.
    zoneId String
    The availability zone ID where the instance is located.
    affinityGroupId string
    Affinity group ID.
    affinityGroupSize number
    Affinity group specification. Value: 2. Note: - Currently, only high performance computing NPU-type hpcpci3 instances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact your account manager.
    autoPay boolean
    Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is insufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only generates the order without charging. You can log in to the order management page to complete payment after the order is generated.
    autoRenew boolean
    Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No auto renewal Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    autoRenewPeriod number
    Duration for each automatic renewal. - This parameter takes effect only when AutoRenew is set to True. Default value is 1. - When PeriodUnit is Month, valid values are 1, 2, 3, 6, 12.
    cpuMaxFrequency number
    Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. Note:

    • Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo frequencies and more information, see Instance Specifications Introduction. - This feature is in invitation-only testing. To use it, please contact your account manager.
    cpuMemory InstanceCpuMemory
    The CPU options for the instance.
    createdAt string
    Instance creation time.
    creditSpecification string
    Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not supported yet). Note: - This parameter is only effective when InstanceTypeId is set to ecs.t2 series, i.e., burstable instances. - If not specified or left empty, burstable instances default to Standard mode.
    deletionProtection boolean
    Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion protection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code. To delete the instance, disable deletion protection first
    deploymentSetGroupNumber number
    When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify the group number of the instance within the deployment set. Value range: 1–7.
    deploymentSetId string
    The deployment set ID the instance needs to join. - You can call the DescribeDeploymentSets API to query existing deployment sets. - For more information about deployment sets, see Deployment Set.
    description string
    The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters
    eipAddress InstanceEipAddress
    The EIP address of the instance.
    elasticScheduledInstanceType string
    Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance. Segmented: Elastic reservation instance - time segment type.
    enableJumboFrame boolean
    Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces have an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500
    expiredAt string
    The expiration time of the instance.
    hostname string
    Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use consecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows instances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or end with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15 characters.
    hpcClusterId string
    ID of the high performance computing cluster to which the instance belongs. Note: This parameter is only effective and required when creating high performance computing GPU instances.
    image InstanceImage
    The image of the instance.
    includeDataVolumes boolean
    Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert. false (default): Do not convert.
    installRunCommandAgent boolean
    Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false (default): Do not install during creation.
    instanceChargeType string
    The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please ensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be returned.
    instanceId string
    The ECS instance ID.
    instanceName string
    Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length limit: 1–128 characters
    instanceType string
    Instance specification. - Product selection: You can refer to Instance Specifications Introduction or call DescribeInstanceTypes to view performance data, and refer to Instance Selection Best Practices to learn how to choose specifications. - Inventory query: You can call DescribeAvailableResource to check available compute resources in the zone.
    keyPair InstanceKeyPair
    Instance key pair name
    localVolumes InstanceLocalVolume[]
    operationSystem InstanceOperationSystem
    The operating system type of the instance.
    password string
    The password of the instance.
    period number
    Resource purchase duration (N). - When PeriodUnit is Month (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60. - When PeriodUnit is Year, valid values are 1, 2, 3, 4, 5. Note: This parameter is valid and required only when InstanceChargeType is set to PrePaid.
    periodUnit string
    The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    placement InstancePlacement
    The deployment information of the instance.
    primaryNetworkInterface InstancePrimaryNetworkInterface
    Primary network interface card of the instance.
    projectName string
    Project name to which the instance belongs.
    rdmaIpAddresses string[]
    When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in a list.
    rdmaNetworkInterfaceDetails InstanceRdmaNetworkInterfaceDetail[]
    renewInfo InstanceRenewInfo
    Renewal information.
    roleNames string[]
    IAM role name bound to the instance
    secondaryNetworkInterfaces InstanceSecondaryNetworkInterface[]
    spotPriceLimit number
    Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when SpotStrategy is set to SpotWithPriceLimit. - When SpotStrategy is set to SpotWithPriceLimit, you can set a custom price limit for the spot instance. If the market price exceeds your bid, the instance will be released. When SpotStrategy is set to SpotAsPriceGo, you accept the system's automatic bidding, following the current market price, and this parameter does not need to be filled in.
    spotStrategy string
    Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. - SpotAsPriceGo: System bids automatically, following the current market price for spot instances.
    status string
    Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting STARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting
    stoppedMode string
    StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode. After stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the same as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources (vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and continue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped mode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud server console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging. NotApplicable: Indicates that this instance does not support cost-saving stopped mode.
    systemVolume InstanceSystemVolume
    The system volume of the instance.
    tags InstanceTag[]
    updatedAt string
    The update time of the instance.
    userData string
    Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances: Script content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8 KB and does not require Base64 encoding
    vpcId string
    The private network ID to which the instance belongs. You can call the DescribeVpcs API to obtain VPC information for the target region.
    zoneId string
    The availability zone ID where the instance is located.
    affinity_group_id str
    Affinity group ID.
    affinity_group_size int
    Affinity group specification. Value: 2. Note: - Currently, only high performance computing NPU-type hpcpci3 instances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact your account manager.
    auto_pay bool
    Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is insufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only generates the order without charging. You can log in to the order management page to complete payment after the order is generated.
    auto_renew bool
    Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No auto renewal Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    auto_renew_period int
    Duration for each automatic renewal. - This parameter takes effect only when AutoRenew is set to True. Default value is 1. - When PeriodUnit is Month, valid values are 1, 2, 3, 6, 12.
    cpu_max_frequency float
    Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. Note:

    • Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo frequencies and more information, see Instance Specifications Introduction. - This feature is in invitation-only testing. To use it, please contact your account manager.
    cpu_memory InstanceCpuMemoryArgs
    The CPU options for the instance.
    created_at str
    Instance creation time.
    credit_specification str
    Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not supported yet). Note: - This parameter is only effective when InstanceTypeId is set to ecs.t2 series, i.e., burstable instances. - If not specified or left empty, burstable instances default to Standard mode.
    deletion_protection bool
    Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion protection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code. To delete the instance, disable deletion protection first
    deployment_set_group_number int
    When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify the group number of the instance within the deployment set. Value range: 1–7.
    deployment_set_id str
    The deployment set ID the instance needs to join. - You can call the DescribeDeploymentSets API to query existing deployment sets. - For more information about deployment sets, see Deployment Set.
    description str
    The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters
    eip_address InstanceEipAddressArgs
    The EIP address of the instance.
    elastic_scheduled_instance_type str
    Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance. Segmented: Elastic reservation instance - time segment type.
    enable_jumbo_frame bool
    Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces have an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500
    expired_at str
    The expiration time of the instance.
    hostname str
    Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use consecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows instances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or end with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15 characters.
    hpc_cluster_id str
    ID of the high performance computing cluster to which the instance belongs. Note: This parameter is only effective and required when creating high performance computing GPU instances.
    image InstanceImageArgs
    The image of the instance.
    include_data_volumes bool
    Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert. false (default): Do not convert.
    install_run_command_agent bool
    Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false (default): Do not install during creation.
    instance_charge_type str
    The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please ensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be returned.
    instance_id str
    The ECS instance ID.
    instance_name str
    Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length limit: 1–128 characters
    instance_type str
    Instance specification. - Product selection: You can refer to Instance Specifications Introduction or call DescribeInstanceTypes to view performance data, and refer to Instance Selection Best Practices to learn how to choose specifications. - Inventory query: You can call DescribeAvailableResource to check available compute resources in the zone.
    key_pair InstanceKeyPairArgs
    Instance key pair name
    local_volumes Sequence[InstanceLocalVolumeArgs]
    operation_system InstanceOperationSystemArgs
    The operating system type of the instance.
    password str
    The password of the instance.
    period int
    Resource purchase duration (N). - When PeriodUnit is Month (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60. - When PeriodUnit is Year, valid values are 1, 2, 3, 4, 5. Note: This parameter is valid and required only when InstanceChargeType is set to PrePaid.
    period_unit str
    The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    placement InstancePlacementArgs
    The deployment information of the instance.
    primary_network_interface InstancePrimaryNetworkInterfaceArgs
    Primary network interface card of the instance.
    project_name str
    Project name to which the instance belongs.
    rdma_ip_addresses Sequence[str]
    When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in a list.
    rdma_network_interface_details Sequence[InstanceRdmaNetworkInterfaceDetailArgs]
    renew_info InstanceRenewInfoArgs
    Renewal information.
    role_names Sequence[str]
    IAM role name bound to the instance
    secondary_network_interfaces Sequence[InstanceSecondaryNetworkInterfaceArgs]
    spot_price_limit float
    Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when SpotStrategy is set to SpotWithPriceLimit. - When SpotStrategy is set to SpotWithPriceLimit, you can set a custom price limit for the spot instance. If the market price exceeds your bid, the instance will be released. When SpotStrategy is set to SpotAsPriceGo, you accept the system's automatic bidding, following the current market price, and this parameter does not need to be filled in.
    spot_strategy str
    Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. - SpotAsPriceGo: System bids automatically, following the current market price for spot instances.
    status str
    Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting STARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting
    stopped_mode str
    StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode. After stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the same as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources (vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and continue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped mode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud server console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging. NotApplicable: Indicates that this instance does not support cost-saving stopped mode.
    system_volume InstanceSystemVolumeArgs
    The system volume of the instance.
    tags Sequence[InstanceTagArgs]
    updated_at str
    The update time of the instance.
    user_data str
    Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances: Script content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8 KB and does not require Base64 encoding
    vpc_id str
    The private network ID to which the instance belongs. You can call the DescribeVpcs API to obtain VPC information for the target region.
    zone_id str
    The availability zone ID where the instance is located.
    affinityGroupId String
    Affinity group ID.
    affinityGroupSize Number
    Affinity group specification. Value: 2. Note: - Currently, only high performance computing NPU-type hpcpci3 instances (by invitation) support affinity groups. - This feature is in invitation testing. To try it, please contact your account manager.
    autoPay Boolean
    Auto payment option. Valid values: true: Auto payment. Ensure your account balance is sufficient; if the balance is insufficient, an exception order will be generated and the billing mode conversion will fail. false (default): Only generates the order without charging. You can log in to the order management page to complete payment after the order is generated.
    autoRenew Boolean
    Whether the instance will be automatically renewed upon expiration. Values: - true: Auto renewal - false (default): No auto renewal Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    autoRenewPeriod Number
    Duration for each automatic renewal. - This parameter takes effect only when AutoRenew is set to True. Default value is 1. - When PeriodUnit is Month, valid values are 1, 2, 3, 6, 12.
    cpuMaxFrequency Number
    Specify the maximum CPU frequency, in GHz. Value range: between the CPU's base frequency and turbo frequency. Note:

    • Currently, only g3al, c3al, r3al, g4i, c4i, r4i, g4ie, c4ie, r4ie instances support this parameter. For base/turbo frequencies and more information, see Instance Specifications Introduction. - This feature is in invitation-only testing. To use it, please contact your account manager.
    cpuMemory Property Map
    The CPU options for the instance.
    createdAt String
    Instance creation time.
    creditSpecification String
    Burstable instance operating mode. Values: - Standard: Standard mode. - Unlimited: Unlimited performance mode (not supported yet). Note: - This parameter is only effective when InstanceTypeId is set to ecs.t2 series, i.e., burstable instances. - If not specified or left empty, burstable instances default to Standard mode.
    deletionProtection Boolean
    Instance deletion protection attribute, specifies whether the instance can be deleted via the console or API. Values: - true: Enable instance deletion protection - false (default): Disable instance deletion protection When deletion protection is enabled, attempts to delete the instance via the console or API will return a deletion failure error code. To delete the instance, disable deletion protection first
    deploymentSetGroupNumber Number
    When the deployment set policy for an ECS instance is set to Availability Group, you can use this parameter to specify the group number of the instance within the deployment set. Value range: 1–7.
    deploymentSetId String
    The deployment set ID the instance needs to join. - You can call the DescribeDeploymentSets API to query existing deployment sets. - For more information about deployment sets, see Deployment Set.
    description String
    The description of the instance. Default is an empty string. - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, period '.', space, underscore '_', hyphen '-', equals '=', English comma ',', Chinese comma '，', and Chinese period '。' - Maximum length is 255 characters
    eipAddress Property Map
    The EIP address of the instance.
    elasticScheduledInstanceType String
    Elastic reservation instance type. Values: NoEsi: Non-elastic reservation instance. Esi: Elastic reservation instance. Segmented: Elastic reservation instance - time segment type.
    enableJumboFrame Boolean
    Whether jumbo frames are enabled for the instance. Values: - false: Jumbo frames are disabled. All network interfaces have an MTU of 1500. - true: Jumbo frames are enabled. All network interfaces have an MTU of 8500
    expiredAt String
    The expiration time of the instance.
    hostname String
    Instance hostname, which is the computer name inside the instance operating system. - Linux instances: - Letters, numbers, periods ('.'), and hyphens ('-') are allowed. - Cannot start or end with a hyphen or period, and cannot use consecutive hyphens and periods. - Linux system hostname length must be between 2 and 63 characters. - Windows instances: - Letters, numbers, and hyphens ('-') are allowed, but the hostname cannot be all numbers. - Cannot start or end with a hyphen, and cannot use consecutive hyphens. - Windows system hostname length must be between 2 and 15 characters.
    hpcClusterId String
    ID of the high performance computing cluster to which the instance belongs. Note: This parameter is only effective and required when creating high performance computing GPU instances.
    image Property Map
    The image of the instance.
    includeDataVolumes Boolean
    Whether to convert all pay-as-you-go data disks attached to the instance to subscription data disks. true: Convert. false (default): Do not convert.
    installRunCommandAgent Boolean
    Whether to install Cloud Assistant Agent when creating the instance. Values: true: Install during creation. false (default): Do not install during creation.
    instanceChargeType String
    The billing type for the instance and cloud disk. Values: - PostPaid: Pay-as-you-go - PrePaid: Subscription. Please ensure your account supports balance payment or credit payment, otherwise an InvalidInstanceChargeType error will be returned.
    instanceId String
    The ECS instance ID.
    instanceName String
    Instance name - Must start with a letter or Chinese character - Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods "." - Length limit: 1–128 characters
    instanceType String
    Instance specification. - Product selection: You can refer to Instance Specifications Introduction or call DescribeInstanceTypes to view performance data, and refer to Instance Selection Best Practices to learn how to choose specifications. - Inventory query: You can call DescribeAvailableResource to check available compute resources in the zone.
    keyPair Property Map
    Instance key pair name
    localVolumes List<Property Map>
    operationSystem Property Map
    The operating system type of the instance.
    password String
    The password of the instance.
    period Number
    Resource purchase duration (N). - When PeriodUnit is Month (default), valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, 60. - When PeriodUnit is Year, valid values are 1, 2, 3, 4, 5. Note: This parameter is valid and required only when InstanceChargeType is set to PrePaid.
    periodUnit String
    The unit for the duration of resource purchase. Values: - Month (default): Month - Year: Year Note: This parameter is effective only when InstanceChargeType is set to PrePaid.
    placement Property Map
    The deployment information of the instance.
    primaryNetworkInterface Property Map
    Primary network interface card of the instance.
    projectName String
    Project name to which the instance belongs.
    rdmaIpAddresses List<String>
    When querying high performance computing GPU instances, returns the RDMA IP addresses of each network interface card in a list.
    rdmaNetworkInterfaceDetails List<Property Map>
    renewInfo Property Map
    Renewal information.
    roleNames List<String>
    IAM role name bound to the instance
    secondaryNetworkInterfaces List<Property Map>
    spotPriceLimit Number
    Maximum hourly price for spot instances. - Supports up to three decimal places. - Only effective when SpotStrategy is set to SpotWithPriceLimit. - When SpotStrategy is set to SpotWithPriceLimit, you can set a custom price limit for the spot instance. If the market price exceeds your bid, the instance will be released. When SpotStrategy is set to SpotAsPriceGo, you accept the system's automatic bidding, following the current market price, and this parameter does not need to be filled in.
    spotStrategy String
    Spot strategy. Values: - NoSpot (default): Non-spot instance. - SpotWithPriceLimit: Spot instance with price limit. - SpotAsPriceGo: System bids automatically, following the current market price for spot instances.
    status String
    Instance status. Values: CREATING: Creating RUNNING: Running STOPPING: Stopping STOPPED: Stopped REBOOTING: Rebooting STARTING: Starting REBUILDING: Rebuilding RESIZING: Resizing ERROR: Error DELETING: Deleting
    stoppedMode String
    StoppedMode string Optional Example value: KeepCharging Stopped mode. Valid values: KeepCharging: Standard stopped mode. After stopping, the instance and its associated resources are retained and continue to be billed. Charges remain the same as before stopping. StopCharging: Cost-saving stopped mode. After stopping, the instance's computing resources (vCPU, GPU, and memory) are reclaimed and billing stops. Attached cloud disks, images, and public IPs are retained and continue to be billed. For conditions to enable cost-saving stopped mode, see the description of cost-saving stopped mode for pay-as-you-go billing. Default value: If you have enabled the default cost-saving stopped mode in the cloud server console and meet the conditions, the default value is StopCharging. Otherwise, the default value is KeepCharging. NotApplicable: Indicates that this instance does not support cost-saving stopped mode.
    systemVolume Property Map
    The system volume of the instance.
    tags List<Property Map>
    updatedAt String
    The update time of the instance.
    userData String
    Custom data for the instance. Default is empty. The final UserData passed will be Base64 encoded. - Linux instances: Script content must not exceed 16 KB and must be Base64 encoded. - Windows instances: Script content must not exceed 8 KB and does not require Base64 encoding
    vpcId String
    The private network ID to which the instance belongs. You can call the DescribeVpcs API to obtain VPC information for the target region.
    zoneId String
    The availability zone ID where the instance is located.

    Supporting Types

    InstanceCpuMemory, InstanceCpuMemoryArgs

    CoreCount int
    Number of instance cores.
    CpuNumber int
    Number of vCPUs for the instance.
    MemorySize int
    Instance memory size (MB).
    ThreadsPerCore int
    Threads per core for the instance.
    CoreCount int
    Number of instance cores.
    CpuNumber int
    Number of vCPUs for the instance.
    MemorySize int
    Instance memory size (MB).
    ThreadsPerCore int
    Threads per core for the instance.
    coreCount Integer
    Number of instance cores.
    cpuNumber Integer
    Number of vCPUs for the instance.
    memorySize Integer
    Instance memory size (MB).
    threadsPerCore Integer
    Threads per core for the instance.
    coreCount number
    Number of instance cores.
    cpuNumber number
    Number of vCPUs for the instance.
    memorySize number
    Instance memory size (MB).
    threadsPerCore number
    Threads per core for the instance.
    core_count int
    Number of instance cores.
    cpu_number int
    Number of vCPUs for the instance.
    memory_size int
    Instance memory size (MB).
    threads_per_core int
    Threads per core for the instance.
    coreCount Number
    Number of instance cores.
    cpuNumber Number
    Number of vCPUs for the instance.
    memorySize Number
    Instance memory size (MB).
    threadsPerCore Number
    Threads per core for the instance.

    InstanceEipAddress, InstanceEipAddressArgs

    AllocationId string
    Instance allocation ID
    BandwidthMbps int
    Maximum bandwidth for public IP. Default value is 1, unit: Mbps. - If ChargeType is PayByBandwidth: value range is 1–500. - If ChargeType is PayByTraffic: value range is 1–200.
    BandwidthPackageId string
    Shared bandwidth package ID, used to add a public IP to the shared bandwidth package. - You can call the DescribeBandwidthPackages API to query the shared bandwidth package ID. - To add a public IP to a shared bandwidth package, all of the following conditions must be met: - Both must have the same security protection type. - Both must be in the same region. - The public IP must use pay-as-you-go billing. - The shared bandwidth package must be IPv4 type.
    ChargeType string

    Public IP billing method. Values: - PayByBandwidth (default): Pay-as-you-go—billed by bandwidth cap. - PayByTraffic: Pay-as-you-go—billed by actual traffic. - PrePaid: Subscription.

    Note: When InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.

    IpAddress string
    Instance IP address.
    Isp string
    Line type for the public IP. Default is BGP. Values: - BGP: BGP (multi-line) - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single-line - ChinaTelecom: China Telecom static single-line - ChinaUnicom: China Unicom static single-line - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP
    ReleaseWithInstance bool
    Whether this resource is released when the instance is released.
    SecurityProtectionInstanceId int
    DDoS Native Protection (Enterprise Edition) ID.
    SecurityProtectionTypes List<string>
    Public IP security protection type.
    AllocationId string
    Instance allocation ID
    BandwidthMbps int
    Maximum bandwidth for public IP. Default value is 1, unit: Mbps. - If ChargeType is PayByBandwidth: value range is 1–500. - If ChargeType is PayByTraffic: value range is 1–200.
    BandwidthPackageId string
    Shared bandwidth package ID, used to add a public IP to the shared bandwidth package. - You can call the DescribeBandwidthPackages API to query the shared bandwidth package ID. - To add a public IP to a shared bandwidth package, all of the following conditions must be met: - Both must have the same security protection type. - Both must be in the same region. - The public IP must use pay-as-you-go billing. - The shared bandwidth package must be IPv4 type.
    ChargeType string

    Public IP billing method. Values: - PayByBandwidth (default): Pay-as-you-go—billed by bandwidth cap. - PayByTraffic: Pay-as-you-go—billed by actual traffic. - PrePaid: Subscription.

    Note: When InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.

    IpAddress string
    Instance IP address.
    Isp string
    Line type for the public IP. Default is BGP. Values: - BGP: BGP (multi-line) - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single-line - ChinaTelecom: China Telecom static single-line - ChinaUnicom: China Unicom static single-line - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP
    ReleaseWithInstance bool
    Whether this resource is released when the instance is released.
    SecurityProtectionInstanceId int
    DDoS Native Protection (Enterprise Edition) ID.
    SecurityProtectionTypes []string
    Public IP security protection type.
    allocationId String
    Instance allocation ID
    bandwidthMbps Integer
    Maximum bandwidth for public IP. Default value is 1, unit: Mbps. - If ChargeType is PayByBandwidth: value range is 1–500. - If ChargeType is PayByTraffic: value range is 1–200.
    bandwidthPackageId String
    Shared bandwidth package ID, used to add a public IP to the shared bandwidth package. - You can call the DescribeBandwidthPackages API to query the shared bandwidth package ID. - To add a public IP to a shared bandwidth package, all of the following conditions must be met: - Both must have the same security protection type. - Both must be in the same region. - The public IP must use pay-as-you-go billing. - The shared bandwidth package must be IPv4 type.
    chargeType String

    Public IP billing method. Values: - PayByBandwidth (default): Pay-as-you-go—billed by bandwidth cap. - PayByTraffic: Pay-as-you-go—billed by actual traffic. - PrePaid: Subscription.

    Note: When InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.

    ipAddress String
    Instance IP address.
    isp String
    Line type for the public IP. Default is BGP. Values: - BGP: BGP (multi-line) - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single-line - ChinaTelecom: China Telecom static single-line - ChinaUnicom: China Unicom static single-line - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP
    releaseWithInstance Boolean
    Whether this resource is released when the instance is released.
    securityProtectionInstanceId Integer
    DDoS Native Protection (Enterprise Edition) ID.
    securityProtectionTypes List<String>
    Public IP security protection type.
    allocationId string
    Instance allocation ID
    bandwidthMbps number
    Maximum bandwidth for public IP. Default value is 1, unit: Mbps. - If ChargeType is PayByBandwidth: value range is 1–500. - If ChargeType is PayByTraffic: value range is 1–200.
    bandwidthPackageId string
    Shared bandwidth package ID, used to add a public IP to the shared bandwidth package. - You can call the DescribeBandwidthPackages API to query the shared bandwidth package ID. - To add a public IP to a shared bandwidth package, all of the following conditions must be met: - Both must have the same security protection type. - Both must be in the same region. - The public IP must use pay-as-you-go billing. - The shared bandwidth package must be IPv4 type.
    chargeType string

    Public IP billing method. Values: - PayByBandwidth (default): Pay-as-you-go—billed by bandwidth cap. - PayByTraffic: Pay-as-you-go—billed by actual traffic. - PrePaid: Subscription.

    Note: When InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.

    ipAddress string
    Instance IP address.
    isp string
    Line type for the public IP. Default is BGP. Values: - BGP: BGP (multi-line) - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single-line - ChinaTelecom: China Telecom static single-line - ChinaUnicom: China Unicom static single-line - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP
    releaseWithInstance boolean
    Whether this resource is released when the instance is released.
    securityProtectionInstanceId number
    DDoS Native Protection (Enterprise Edition) ID.
    securityProtectionTypes string[]
    Public IP security protection type.
    allocation_id str
    Instance allocation ID
    bandwidth_mbps int
    Maximum bandwidth for public IP. Default value is 1, unit: Mbps. - If ChargeType is PayByBandwidth: value range is 1–500. - If ChargeType is PayByTraffic: value range is 1–200.
    bandwidth_package_id str
    Shared bandwidth package ID, used to add a public IP to the shared bandwidth package. - You can call the DescribeBandwidthPackages API to query the shared bandwidth package ID. - To add a public IP to a shared bandwidth package, all of the following conditions must be met: - Both must have the same security protection type. - Both must be in the same region. - The public IP must use pay-as-you-go billing. - The shared bandwidth package must be IPv4 type.
    charge_type str

    Public IP billing method. Values: - PayByBandwidth (default): Pay-as-you-go—billed by bandwidth cap. - PayByTraffic: Pay-as-you-go—billed by actual traffic. - PrePaid: Subscription.

    Note: When InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.

    ip_address str
    Instance IP address.
    isp str
    Line type for the public IP. Default is BGP. Values: - BGP: BGP (multi-line) - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single-line - ChinaTelecom: China Telecom static single-line - ChinaUnicom: China Unicom static single-line - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP
    release_with_instance bool
    Whether this resource is released when the instance is released.
    security_protection_instance_id int
    DDoS Native Protection (Enterprise Edition) ID.
    security_protection_types Sequence[str]
    Public IP security protection type.
    allocationId String
    Instance allocation ID
    bandwidthMbps Number
    Maximum bandwidth for public IP. Default value is 1, unit: Mbps. - If ChargeType is PayByBandwidth: value range is 1–500. - If ChargeType is PayByTraffic: value range is 1–200.
    bandwidthPackageId String
    Shared bandwidth package ID, used to add a public IP to the shared bandwidth package. - You can call the DescribeBandwidthPackages API to query the shared bandwidth package ID. - To add a public IP to a shared bandwidth package, all of the following conditions must be met: - Both must have the same security protection type. - Both must be in the same region. - The public IP must use pay-as-you-go billing. - The shared bandwidth package must be IPv4 type.
    chargeType String

    Public IP billing method. Values: - PayByBandwidth (default): Pay-as-you-go—billed by bandwidth cap. - PayByTraffic: Pay-as-you-go—billed by actual traffic. - PrePaid: Subscription.

    Note: When InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.

    ipAddress String
    Instance IP address.
    isp String
    Line type for the public IP. Default is BGP. Values: - BGP: BGP (multi-line) - If your account has applied for and enabled static single-line permissions, you can use the following values: - ChinaMobile: China Mobile static single-line - ChinaTelecom: China Telecom static single-line - ChinaUnicom: China Unicom static single-line - If your account has applied for and enabled BGP single-line permissions, you can use SingleLine_BGP. - If your account has applied for and enabled static BGP permissions, you can use Static_BGP
    releaseWithInstance Boolean
    Whether this resource is released when the instance is released.
    securityProtectionInstanceId Number
    DDoS Native Protection (Enterprise Edition) ID.
    securityProtectionTypes List<String>
    Public IP security protection type.

    InstanceImage, InstanceImageArgs

    ImageId string
    Instance image ID.
    ImageReleaseVersion string
    The image release version of the instance.
    KeepImageCredential bool
    Whether the instance retains image credentials
    SecurityEnhancementStrategy string
    Instance security enhancement policy. Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images
    ImageId string
    Instance image ID.
    ImageReleaseVersion string
    The image release version of the instance.
    KeepImageCredential bool
    Whether the instance retains image credentials
    SecurityEnhancementStrategy string
    Instance security enhancement policy. Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images
    imageId String
    Instance image ID.
    imageReleaseVersion String
    The image release version of the instance.
    keepImageCredential Boolean
    Whether the instance retains image credentials
    securityEnhancementStrategy String
    Instance security enhancement policy. Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images
    imageId string
    Instance image ID.
    imageReleaseVersion string
    The image release version of the instance.
    keepImageCredential boolean
    Whether the instance retains image credentials
    securityEnhancementStrategy string
    Instance security enhancement policy. Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images
    image_id str
    Instance image ID.
    image_release_version str
    The image release version of the instance.
    keep_image_credential bool
    Whether the instance retains image credentials
    security_enhancement_strategy str
    Instance security enhancement policy. Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images
    imageId String
    Instance image ID.
    imageReleaseVersion String
    The image release version of the instance.
    keepImageCredential Boolean
    Whether the instance retains image credentials
    securityEnhancementStrategy String
    Instance security enhancement policy. Active: Enable security hardening, applies only to public images. InActive: Disable security hardening, applies to all images

    InstanceKeyPair, InstanceKeyPairArgs

    KeyPairId string
    Instance public key
    KeyPairName string
    Instance key pair name
    KeyPairId string
    Instance public key
    KeyPairName string
    Instance key pair name
    keyPairId String
    Instance public key
    keyPairName String
    Instance key pair name
    keyPairId string
    Instance public key
    keyPairName string
    Instance key pair name
    key_pair_id str
    Instance public key
    key_pair_name str
    Instance key pair name
    keyPairId String
    Instance public key
    keyPairName String
    Instance key pair name

    InstanceLocalVolume, InstanceLocalVolumeArgs

    Count int
    The number of local disks attached to the instance.
    Size int
    Capacity of each local disk mounted to the instance (GiB).
    VolumeType string
    Local disk type. Values: LOCAL_SSD: SSD local disk. LOCAL_HDD: HDD local disk.
    Count int
    The number of local disks attached to the instance.
    Size int
    Capacity of each local disk mounted to the instance (GiB).
    VolumeType string
    Local disk type. Values: LOCAL_SSD: SSD local disk. LOCAL_HDD: HDD local disk.
    count Integer
    The number of local disks attached to the instance.
    size Integer
    Capacity of each local disk mounted to the instance (GiB).
    volumeType String
    Local disk type. Values: LOCAL_SSD: SSD local disk. LOCAL_HDD: HDD local disk.
    count number
    The number of local disks attached to the instance.
    size number
    Capacity of each local disk mounted to the instance (GiB).
    volumeType string
    Local disk type. Values: LOCAL_SSD: SSD local disk. LOCAL_HDD: HDD local disk.
    count int
    The number of local disks attached to the instance.
    size int
    Capacity of each local disk mounted to the instance (GiB).
    volume_type str
    Local disk type. Values: LOCAL_SSD: SSD local disk. LOCAL_HDD: HDD local disk.
    count Number
    The number of local disks attached to the instance.
    size Number
    Capacity of each local disk mounted to the instance (GiB).
    volumeType String
    Local disk type. Values: LOCAL_SSD: SSD local disk. LOCAL_HDD: HDD local disk.

    InstanceOperationSystem, InstanceOperationSystemArgs

    Name string
    Instance operating system name.
    Type string
    Operating system type of the instance. Linux: Linux system. Windows: Windows system.
    Name string
    Instance operating system name.
    Type string
    Operating system type of the instance. Linux: Linux system. Windows: Windows system.
    name String
    Instance operating system name.
    type String
    Operating system type of the instance. Linux: Linux system. Windows: Windows system.
    name string
    Instance operating system name.
    type string
    Operating system type of the instance. Linux: Linux system. Windows: Windows system.
    name str
    Instance operating system name.
    type str
    Operating system type of the instance. Linux: Linux system. Windows: Windows system.
    name String
    Instance operating system name.
    type String
    Operating system type of the instance. Linux: Linux system. Windows: Windows system.

    InstancePlacement, InstancePlacementArgs

    Affinity string
    For ECS instances in economy stop mode, some resources are released after stopping. This parameter indicates whether the ECS instance will remain deployed on the original host when restarted. Values: Host: When restarting an instance in economy stop mode, it will remain on the original host. Default: When restarting an instance in economy stop mode, it will preferentially migrate to a host that supports automatic deployment; if resources are insufficient, it will start on the original host.
    DedicatedHostClusterId string
    Instance dedicated host cluster ID.
    DedicatedHostId string
    Dedicated host ID for the instance.
    Tenancy string
    Whether to create the instance on a dedicated host. Values: Default: Create a regular cloud server instance. Host: Create a dedicated host instance. If you do not specify DedicatedHostId, the system automatically selects a dedicated host to place the instance.
    Affinity string
    For ECS instances in economy stop mode, some resources are released after stopping. This parameter indicates whether the ECS instance will remain deployed on the original host when restarted. Values: Host: When restarting an instance in economy stop mode, it will remain on the original host. Default: When restarting an instance in economy stop mode, it will preferentially migrate to a host that supports automatic deployment; if resources are insufficient, it will start on the original host.
    DedicatedHostClusterId string
    Instance dedicated host cluster ID.
    DedicatedHostId string
    Dedicated host ID for the instance.
    Tenancy string
    Whether to create the instance on a dedicated host. Values: Default: Create a regular cloud server instance. Host: Create a dedicated host instance. If you do not specify DedicatedHostId, the system automatically selects a dedicated host to place the instance.
    affinity String
    For ECS instances in economy stop mode, some resources are released after stopping. This parameter indicates whether the ECS instance will remain deployed on the original host when restarted. Values: Host: When restarting an instance in economy stop mode, it will remain on the original host. Default: When restarting an instance in economy stop mode, it will preferentially migrate to a host that supports automatic deployment; if resources are insufficient, it will start on the original host.
    dedicatedHostClusterId String
    Instance dedicated host cluster ID.
    dedicatedHostId String
    Dedicated host ID for the instance.
    tenancy String
    Whether to create the instance on a dedicated host. Values: Default: Create a regular cloud server instance. Host: Create a dedicated host instance. If you do not specify DedicatedHostId, the system automatically selects a dedicated host to place the instance.
    affinity string
    For ECS instances in economy stop mode, some resources are released after stopping. This parameter indicates whether the ECS instance will remain deployed on the original host when restarted. Values: Host: When restarting an instance in economy stop mode, it will remain on the original host. Default: When restarting an instance in economy stop mode, it will preferentially migrate to a host that supports automatic deployment; if resources are insufficient, it will start on the original host.
    dedicatedHostClusterId string
    Instance dedicated host cluster ID.
    dedicatedHostId string
    Dedicated host ID for the instance.
    tenancy string
    Whether to create the instance on a dedicated host. Values: Default: Create a regular cloud server instance. Host: Create a dedicated host instance. If you do not specify DedicatedHostId, the system automatically selects a dedicated host to place the instance.
    affinity str
    For ECS instances in economy stop mode, some resources are released after stopping. This parameter indicates whether the ECS instance will remain deployed on the original host when restarted. Values: Host: When restarting an instance in economy stop mode, it will remain on the original host. Default: When restarting an instance in economy stop mode, it will preferentially migrate to a host that supports automatic deployment; if resources are insufficient, it will start on the original host.
    dedicated_host_cluster_id str
    Instance dedicated host cluster ID.
    dedicated_host_id str
    Dedicated host ID for the instance.
    tenancy str
    Whether to create the instance on a dedicated host. Values: Default: Create a regular cloud server instance. Host: Create a dedicated host instance. If you do not specify DedicatedHostId, the system automatically selects a dedicated host to place the instance.
    affinity String
    For ECS instances in economy stop mode, some resources are released after stopping. This parameter indicates whether the ECS instance will remain deployed on the original host when restarted. Values: Host: When restarting an instance in economy stop mode, it will remain on the original host. Default: When restarting an instance in economy stop mode, it will preferentially migrate to a host that supports automatic deployment; if resources are insufficient, it will start on the original host.
    dedicatedHostClusterId String
    Instance dedicated host cluster ID.
    dedicatedHostId String
    Dedicated host ID for the instance.
    tenancy String
    Whether to create the instance on a dedicated host. Values: Default: Create a regular cloud server instance. Host: Create a dedicated host instance. If you do not specify DedicatedHostId, the system automatically selects a dedicated host to place the instance.

    InstancePrimaryNetworkInterface, InstancePrimaryNetworkInterfaceArgs

    Ipv6AddressCount int
    The number of IPv6 addresses for the instance.
    Ipv6Addresses List<string>
    IPv6 address of the instance.
    MacAddress string
    Instance MAC address.
    NetworkInterfaceId string
    The network interface ID of the instance.
    PrimaryIpAddress string
    Instance primary IP address
    PrivateIpAddresses List<string>
    Instance private IP address.
    SecurityGroupIds List<string>
    Instance security group ID
    SubnetId string
    Instance subnet ID.
    VpcId string
    VPC ID of the instance.
    Ipv6AddressCount int
    The number of IPv6 addresses for the instance.
    Ipv6Addresses []string
    IPv6 address of the instance.
    MacAddress string
    Instance MAC address.
    NetworkInterfaceId string
    The network interface ID of the instance.
    PrimaryIpAddress string
    Instance primary IP address
    PrivateIpAddresses []string
    Instance private IP address.
    SecurityGroupIds []string
    Instance security group ID
    SubnetId string
    Instance subnet ID.
    VpcId string
    VPC ID of the instance.
    ipv6AddressCount Integer
    The number of IPv6 addresses for the instance.
    ipv6Addresses List<String>
    IPv6 address of the instance.
    macAddress String
    Instance MAC address.
    networkInterfaceId String
    The network interface ID of the instance.
    primaryIpAddress String
    Instance primary IP address
    privateIpAddresses List<String>
    Instance private IP address.
    securityGroupIds List<String>
    Instance security group ID
    subnetId String
    Instance subnet ID.
    vpcId String
    VPC ID of the instance.
    ipv6AddressCount number
    The number of IPv6 addresses for the instance.
    ipv6Addresses string[]
    IPv6 address of the instance.
    macAddress string
    Instance MAC address.
    networkInterfaceId string
    The network interface ID of the instance.
    primaryIpAddress string
    Instance primary IP address
    privateIpAddresses string[]
    Instance private IP address.
    securityGroupIds string[]
    Instance security group ID
    subnetId string
    Instance subnet ID.
    vpcId string
    VPC ID of the instance.
    ipv6_address_count int
    The number of IPv6 addresses for the instance.
    ipv6_addresses Sequence[str]
    IPv6 address of the instance.
    mac_address str
    Instance MAC address.
    network_interface_id str
    The network interface ID of the instance.
    primary_ip_address str
    Instance primary IP address
    private_ip_addresses Sequence[str]
    Instance private IP address.
    security_group_ids Sequence[str]
    Instance security group ID
    subnet_id str
    Instance subnet ID.
    vpc_id str
    VPC ID of the instance.
    ipv6AddressCount Number
    The number of IPv6 addresses for the instance.
    ipv6Addresses List<String>
    IPv6 address of the instance.
    macAddress String
    Instance MAC address.
    networkInterfaceId String
    The network interface ID of the instance.
    primaryIpAddress String
    Instance primary IP address
    privateIpAddresses List<String>
    Instance private IP address.
    securityGroupIds List<String>
    Instance security group ID
    subnetId String
    Instance subnet ID.
    vpcId String
    VPC ID of the instance.

    InstanceRdmaNetworkInterfaceDetail, InstanceRdmaNetworkInterfaceDetailArgs

    Gateway string
    Gateway address.
    Ip string
    IP address
    Mask string
    Subnet mask.
    SwitchName string
    Switch name.
    SwitchPort string
    Switch port.
    Gateway string
    Gateway address.
    Ip string
    IP address
    Mask string
    Subnet mask.
    SwitchName string
    Switch name.
    SwitchPort string
    Switch port.
    gateway String
    Gateway address.
    ip String
    IP address
    mask String
    Subnet mask.
    switchName String
    Switch name.
    switchPort String
    Switch port.
    gateway string
    Gateway address.
    ip string
    IP address
    mask string
    Subnet mask.
    switchName string
    Switch name.
    switchPort string
    Switch port.
    gateway str
    Gateway address.
    ip str
    IP address
    mask str
    Subnet mask.
    switch_name str
    Switch name.
    switch_port str
    Switch port.
    gateway String
    Gateway address.
    ip String
    IP address
    mask String
    Subnet mask.
    switchName String
    Switch name.
    switchPort String
    Switch port.

    InstanceRenewInfo, InstanceRenewInfoArgs

    Period int
    Number of months for renewal. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36.
    PeriodUnit string
    Time unit for renewal duration, i.e., the unit for the Period parameter. Value: Month (default)
    Period int
    Number of months for renewal. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36.
    PeriodUnit string
    Time unit for renewal duration, i.e., the unit for the Period parameter. Value: Month (default)
    period Integer
    Number of months for renewal. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36.
    periodUnit String
    Time unit for renewal duration, i.e., the unit for the Period parameter. Value: Month (default)
    period number
    Number of months for renewal. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36.
    periodUnit string
    Time unit for renewal duration, i.e., the unit for the Period parameter. Value: Month (default)
    period int
    Number of months for renewal. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36.
    period_unit str
    Time unit for renewal duration, i.e., the unit for the Period parameter. Value: Month (default)
    period Number
    Number of months for renewal. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36.
    periodUnit String
    Time unit for renewal duration, i.e., the unit for the Period parameter. Value: Month (default)

    InstanceSecondaryNetworkInterface, InstanceSecondaryNetworkInterfaceArgs

    Ipv6AddressCount int
    The number of IPv6 addresses for the instance.
    Ipv6Addresses List<string>
    IPv6 address of the instance.
    MacAddress string
    Instance MAC address.
    NetworkInterfaceId string
    The network interface ID of the instance.
    PrimaryIpAddress string
    Instance primary IP address
    PrivateIpAddresses List<string>
    Instance private IP address.
    SecurityGroupIds List<string>
    Instance security group ID
    SubnetId string
    Instance subnet ID.
    VpcId string
    VPC ID of the instance.
    Ipv6AddressCount int
    The number of IPv6 addresses for the instance.
    Ipv6Addresses []string
    IPv6 address of the instance.
    MacAddress string
    Instance MAC address.
    NetworkInterfaceId string
    The network interface ID of the instance.
    PrimaryIpAddress string
    Instance primary IP address
    PrivateIpAddresses []string
    Instance private IP address.
    SecurityGroupIds []string
    Instance security group ID
    SubnetId string
    Instance subnet ID.
    VpcId string
    VPC ID of the instance.
    ipv6AddressCount Integer
    The number of IPv6 addresses for the instance.
    ipv6Addresses List<String>
    IPv6 address of the instance.
    macAddress String
    Instance MAC address.
    networkInterfaceId String
    The network interface ID of the instance.
    primaryIpAddress String
    Instance primary IP address
    privateIpAddresses List<String>
    Instance private IP address.
    securityGroupIds List<String>
    Instance security group ID
    subnetId String
    Instance subnet ID.
    vpcId String
    VPC ID of the instance.
    ipv6AddressCount number
    The number of IPv6 addresses for the instance.
    ipv6Addresses string[]
    IPv6 address of the instance.
    macAddress string
    Instance MAC address.
    networkInterfaceId string
    The network interface ID of the instance.
    primaryIpAddress string
    Instance primary IP address
    privateIpAddresses string[]
    Instance private IP address.
    securityGroupIds string[]
    Instance security group ID
    subnetId string
    Instance subnet ID.
    vpcId string
    VPC ID of the instance.
    ipv6_address_count int
    The number of IPv6 addresses for the instance.
    ipv6_addresses Sequence[str]
    IPv6 address of the instance.
    mac_address str
    Instance MAC address.
    network_interface_id str
    The network interface ID of the instance.
    primary_ip_address str
    Instance primary IP address
    private_ip_addresses Sequence[str]
    Instance private IP address.
    security_group_ids Sequence[str]
    Instance security group ID
    subnet_id str
    Instance subnet ID.
    vpc_id str
    VPC ID of the instance.
    ipv6AddressCount Number
    The number of IPv6 addresses for the instance.
    ipv6Addresses List<String>
    IPv6 address of the instance.
    macAddress String
    Instance MAC address.
    networkInterfaceId String
    The network interface ID of the instance.
    primaryIpAddress String
    Instance primary IP address
    privateIpAddresses List<String>
    Instance private IP address.
    securityGroupIds List<String>
    Instance security group ID
    subnetId String
    Instance subnet ID.
    vpcId String
    VPC ID of the instance.

    InstanceSystemVolume, InstanceSystemVolumeArgs

    DeleteWithInstance bool
    Whether the attached resources are deleted along with the instance.
    ExtraPerformanceIops int
    Additional performance IOPS for the instance
    ExtraPerformanceThroughputMb int
    The additional performance throughput of the instance, in MB.
    ExtraPerformanceTypeId string
    Type of additional performance. Values: Balance: Balanced additional performance IOPS: IOPS additional performance Throughput: Throughput additional performance
    Size int
    Instance size, in GiB
    SnapshotId string
    Instance snapshot ID
    VolumeId string
    Instance volume ID.
    VolumeType string
    Cloud disk type. Values: PTSSD: Performance SSD. ESSD_PL0: Ultra SSD disk, PL0 specification. ESSD_FlexPL: Ultra SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.
    DeleteWithInstance bool
    Whether the attached resources are deleted along with the instance.
    ExtraPerformanceIops int
    Additional performance IOPS for the instance
    ExtraPerformanceThroughputMb int
    The additional performance throughput of the instance, in MB.
    ExtraPerformanceTypeId string
    Type of additional performance. Values: Balance: Balanced additional performance IOPS: IOPS additional performance Throughput: Throughput additional performance
    Size int
    Instance size, in GiB
    SnapshotId string
    Instance snapshot ID
    VolumeId string
    Instance volume ID.
    VolumeType string
    Cloud disk type. Values: PTSSD: Performance SSD. ESSD_PL0: Ultra SSD disk, PL0 specification. ESSD_FlexPL: Ultra SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.
    deleteWithInstance Boolean
    Whether the attached resources are deleted along with the instance.
    extraPerformanceIops Integer
    Additional performance IOPS for the instance
    extraPerformanceThroughputMb Integer
    The additional performance throughput of the instance, in MB.
    extraPerformanceTypeId String
    Type of additional performance. Values: Balance: Balanced additional performance IOPS: IOPS additional performance Throughput: Throughput additional performance
    size Integer
    Instance size, in GiB
    snapshotId String
    Instance snapshot ID
    volumeId String
    Instance volume ID.
    volumeType String
    Cloud disk type. Values: PTSSD: Performance SSD. ESSD_PL0: Ultra SSD disk, PL0 specification. ESSD_FlexPL: Ultra SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.
    deleteWithInstance boolean
    Whether the attached resources are deleted along with the instance.
    extraPerformanceIops number
    Additional performance IOPS for the instance
    extraPerformanceThroughputMb number
    The additional performance throughput of the instance, in MB.
    extraPerformanceTypeId string
    Type of additional performance. Values: Balance: Balanced additional performance IOPS: IOPS additional performance Throughput: Throughput additional performance
    size number
    Instance size, in GiB
    snapshotId string
    Instance snapshot ID
    volumeId string
    Instance volume ID.
    volumeType string
    Cloud disk type. Values: PTSSD: Performance SSD. ESSD_PL0: Ultra SSD disk, PL0 specification. ESSD_FlexPL: Ultra SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.
    delete_with_instance bool
    Whether the attached resources are deleted along with the instance.
    extra_performance_iops int
    Additional performance IOPS for the instance
    extra_performance_throughput_mb int
    The additional performance throughput of the instance, in MB.
    extra_performance_type_id str
    Type of additional performance. Values: Balance: Balanced additional performance IOPS: IOPS additional performance Throughput: Throughput additional performance
    size int
    Instance size, in GiB
    snapshot_id str
    Instance snapshot ID
    volume_id str
    Instance volume ID.
    volume_type str
    Cloud disk type. Values: PTSSD: Performance SSD. ESSD_PL0: Ultra SSD disk, PL0 specification. ESSD_FlexPL: Ultra SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.
    deleteWithInstance Boolean
    Whether the attached resources are deleted along with the instance.
    extraPerformanceIops Number
    Additional performance IOPS for the instance
    extraPerformanceThroughputMb Number
    The additional performance throughput of the instance, in MB.
    extraPerformanceTypeId String
    Type of additional performance. Values: Balance: Balanced additional performance IOPS: IOPS additional performance Throughput: Throughput additional performance
    size Number
    Instance size, in GiB
    snapshotId String
    Instance snapshot ID
    volumeId String
    Instance volume ID.
    volumeType String
    Cloud disk type. Values: PTSSD: Performance SSD. ESSD_PL0: Ultra SSD disk, PL0 specification. ESSD_FlexPL: Ultra SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.

    InstanceTag, InstanceTagArgs

    Key string
    Instance key.
    Value string
    Instance value.
    Key string
    Instance key.
    Value string
    Instance value.
    key String
    Instance key.
    value String
    Instance value.
    key string
    Instance key.
    value string
    Instance value.
    key str
    Instance key.
    value str
    Instance value.
    key String
    Instance key.
    value String
    Instance value.

    Import

    $ pulumi import volcenginecc:ecs/instance:Instance example "instance_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.