1. Registry
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. ecs
  6. getScheduledInstance
Viewing docs for volcenginecc v0.0.60
published on Thursday, Sep 3, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.60
published on Thursday, Sep 3, 2026 by Volcengine

    Data Source schema for Volcengine::ECS::ScheduledInstance

    Using getScheduledInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getScheduledInstance(args: GetScheduledInstanceArgs, opts?: InvokeOptions): Promise<GetScheduledInstanceResult>
    function getScheduledInstanceOutput(args: GetScheduledInstanceOutputArgs, opts?: InvokeOutputOptions): Output<GetScheduledInstanceResult>
    def get_scheduled_instance(id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetScheduledInstanceResult
    def get_scheduled_instance_output(id: pulumi.Input[Optional[str]] = None,
                               opts: Optional[InvokeOutputOptions] = None) -> Output[GetScheduledInstanceResult]
    func LookupScheduledInstance(ctx *Context, args *LookupScheduledInstanceArgs, opts ...InvokeOption) (*LookupScheduledInstanceResult, error)
    func LookupScheduledInstanceOutput(ctx *Context, args *LookupScheduledInstanceOutputArgs, opts ...InvokeOption) LookupScheduledInstanceResultOutput

    > Note: This function is named LookupScheduledInstance in the Go SDK.

    public static class GetScheduledInstance 
    {
        public static Task<GetScheduledInstanceResult> InvokeAsync(GetScheduledInstanceArgs args, InvokeOptions? opts = null)
        public static Output<GetScheduledInstanceResult> Invoke(GetScheduledInstanceInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetScheduledInstanceResult> Invoke(GetScheduledInstanceInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetScheduledInstanceResult> getScheduledInstance(GetScheduledInstanceArgs args, InvokeOptions options)
    public static Output<GetScheduledInstanceResult> getScheduledInstance(GetScheduledInstanceArgs args, InvokeOptions options)
    public static Output<GetScheduledInstanceResult> getScheduledInstance(GetScheduledInstanceArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: volcenginecc:ecs/getScheduledInstance:getScheduledInstance
      arguments:
        # arguments dictionary
    data "volcenginecc_ecs_get_scheduled_instance" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Id string
    id string
    id String
    id string
    id str
    id String

    getScheduledInstance Result

    The following output properties are available:

    AutoReleaseAt string
    CpuMaxFrequency double
    CreatedAt string
    DeletionProtection bool
    DeliveryCount int
    DeliveryType string
    Description string
    EipAddress Volcengine.GetScheduledInstanceEipAddress
    ElasticScheduledInstanceType string
    EndDeliveryAt string
    HostName string
    HpcClusterId string
    HttpTokens string
    Id string
    ImageId string
    InstallRunCommandAgent bool
    InstanceConfig Volcengine.GetScheduledInstanceInstanceConfig
    InstanceCount int
    InstanceName string
    InstanceTypeId string
    InvalidAt string
    KeepImageCredential bool
    KeyPairName string
    MinCount int
    NetworkInterfaces List<Volcengine.GetScheduledInstanceNetworkInterface>
    Password string
    ProjectName string
    ReleaseCount int
    ScheduledInstanceDescription string
    ScheduledInstanceId string
    ScheduledInstanceName string
    SecurityEnhancementStrategy string
    StartDeliveryAt string
    Status string
    SuffixIndex int
    Tags List<Volcengine.GetScheduledInstanceTag>
    UniqueSuffix bool
    UpdatedAt string
    UserData string
    Volumes List<Volcengine.GetScheduledInstanceVolume>
    ZoneId string
    AutoReleaseAt string
    CpuMaxFrequency float64
    CreatedAt string
    DeletionProtection bool
    DeliveryCount int
    DeliveryType string
    Description string
    EipAddress GetScheduledInstanceEipAddress
    ElasticScheduledInstanceType string
    EndDeliveryAt string
    HostName string
    HpcClusterId string
    HttpTokens string
    Id string
    ImageId string
    InstallRunCommandAgent bool
    InstanceConfig GetScheduledInstanceInstanceConfig
    InstanceCount int
    InstanceName string
    InstanceTypeId string
    InvalidAt string
    KeepImageCredential bool
    KeyPairName string
    MinCount int
    NetworkInterfaces []GetScheduledInstanceNetworkInterface
    Password string
    ProjectName string
    ReleaseCount int
    ScheduledInstanceDescription string
    ScheduledInstanceId string
    ScheduledInstanceName string
    SecurityEnhancementStrategy string
    StartDeliveryAt string
    Status string
    SuffixIndex int
    Tags []GetScheduledInstanceTag
    UniqueSuffix bool
    UpdatedAt string
    UserData string
    Volumes []GetScheduledInstanceVolume
    ZoneId string
    auto_release_at string
    cpu_max_frequency number
    created_at string
    deletion_protection bool
    delivery_count number
    delivery_type string
    description string
    eip_address object
    elastic_scheduled_instance_type string
    end_delivery_at string
    host_name string
    hpc_cluster_id string
    http_tokens string
    id string
    image_id string
    install_run_command_agent bool
    instance_config object
    instance_count number
    instance_name string
    instance_type_id string
    invalid_at string
    keep_image_credential bool
    key_pair_name string
    min_count number
    network_interfaces list(object)
    password string
    project_name string
    release_count number
    scheduled_instance_description string
    scheduled_instance_id string
    scheduled_instance_name string
    security_enhancement_strategy string
    start_delivery_at string
    status string
    suffix_index number
    tags list(object)
    unique_suffix bool
    updated_at string
    user_data string
    volumes list(object)
    zone_id string
    autoReleaseAt String
    cpuMaxFrequency Double
    createdAt String
    deletionProtection Boolean
    deliveryCount Integer
    deliveryType String
    description String
    eipAddress GetScheduledInstanceEipAddress
    elasticScheduledInstanceType String
    endDeliveryAt String
    hostName String
    hpcClusterId String
    httpTokens String
    id String
    imageId String
    installRunCommandAgent Boolean
    instanceConfig GetScheduledInstanceInstanceConfig
    instanceCount Integer
    instanceName String
    instanceTypeId String
    invalidAt String
    keepImageCredential Boolean
    keyPairName String
    minCount Integer
    networkInterfaces List<GetScheduledInstanceNetworkInterface>
    password String
    projectName String
    releaseCount Integer
    scheduledInstanceDescription String
    scheduledInstanceId String
    scheduledInstanceName String
    securityEnhancementStrategy String
    startDeliveryAt String
    status String
    suffixIndex Integer
    tags List<GetScheduledInstanceTag>
    uniqueSuffix Boolean
    updatedAt String
    userData String
    volumes List<GetScheduledInstanceVolume>
    zoneId String
    autoReleaseAt string
    cpuMaxFrequency number
    createdAt string
    deletionProtection boolean
    deliveryCount number
    deliveryType string
    description string
    eipAddress GetScheduledInstanceEipAddress
    elasticScheduledInstanceType string
    endDeliveryAt string
    hostName string
    hpcClusterId string
    httpTokens string
    id string
    imageId string
    installRunCommandAgent boolean
    instanceConfig GetScheduledInstanceInstanceConfig
    instanceCount number
    instanceName string
    instanceTypeId string
    invalidAt string
    keepImageCredential boolean
    keyPairName string
    minCount number
    networkInterfaces GetScheduledInstanceNetworkInterface[]
    password string
    projectName string
    releaseCount number
    scheduledInstanceDescription string
    scheduledInstanceId string
    scheduledInstanceName string
    securityEnhancementStrategy string
    startDeliveryAt string
    status string
    suffixIndex number
    tags GetScheduledInstanceTag[]
    uniqueSuffix boolean
    updatedAt string
    userData string
    volumes GetScheduledInstanceVolume[]
    zoneId string
    auto_release_at str
    cpu_max_frequency float
    created_at str
    deletion_protection bool
    delivery_count int
    delivery_type str
    description str
    eip_address GetScheduledInstanceEipAddress
    elastic_scheduled_instance_type str
    end_delivery_at str
    host_name str
    hpc_cluster_id str
    http_tokens str
    id str
    image_id str
    install_run_command_agent bool
    instance_config GetScheduledInstanceInstanceConfig
    instance_count int
    instance_name str
    instance_type_id str
    invalid_at str
    keep_image_credential bool
    key_pair_name str
    min_count int
    network_interfaces Sequence[GetScheduledInstanceNetworkInterface]
    password str
    project_name str
    release_count int
    scheduled_instance_description str
    scheduled_instance_id str
    scheduled_instance_name str
    security_enhancement_strategy str
    start_delivery_at str
    status str
    suffix_index int
    tags Sequence[GetScheduledInstanceTag]
    unique_suffix bool
    updated_at str
    user_data str
    volumes Sequence[GetScheduledInstanceVolume]
    zone_id str
    autoReleaseAt String
    cpuMaxFrequency Number
    createdAt String
    deletionProtection Boolean
    deliveryCount Number
    deliveryType String
    description String
    eipAddress Property Map
    elasticScheduledInstanceType String
    endDeliveryAt String
    hostName String
    hpcClusterId String
    httpTokens String
    id String
    imageId String
    installRunCommandAgent Boolean
    instanceConfig Property Map
    instanceCount Number
    instanceName String
    instanceTypeId String
    invalidAt String
    keepImageCredential Boolean
    keyPairName String
    minCount Number
    networkInterfaces List<Property Map>
    password String
    projectName String
    releaseCount Number
    scheduledInstanceDescription String
    scheduledInstanceId String
    scheduledInstanceName String
    securityEnhancementStrategy String
    startDeliveryAt String
    status String
    suffixIndex Number
    tags List<Property Map>
    uniqueSuffix Boolean
    updatedAt String
    userData String
    volumes List<Property Map>
    zoneId String

    Supporting Types

    GetScheduledInstanceEipAddress

    BandwidthMbps int
    The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When ChargeType is set to PayByBandwidth: valid range is 1–500. - When ChargeType is set to PayByTraffic: valid range is 1–200.
    BandwidthPackageId string
    ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
    ChargeType string
    Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription. Note: When the instance billing type InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.
    Isp string
    Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - 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 the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
    SecurityProtectionInstanceId int
    DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    SecurityProtectionTypes List<string>

    Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.

    Note: - If EipAddress.SecurityProtectionTypes.N is set to AntiDDoS_Enhanced, EipAddress.ChargeType cannot be PrePaid, and EipAddress.ISP must be set to BGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.

      - If not specified, the default protection type public IP will be applied.
    
    BandwidthMbps int
    The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When ChargeType is set to PayByBandwidth: valid range is 1–500. - When ChargeType is set to PayByTraffic: valid range is 1–200.
    BandwidthPackageId string
    ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
    ChargeType string
    Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription. Note: When the instance billing type InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.
    Isp string
    Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - 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 the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
    SecurityProtectionInstanceId int
    DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    SecurityProtectionTypes []string

    Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.

    Note: - If EipAddress.SecurityProtectionTypes.N is set to AntiDDoS_Enhanced, EipAddress.ChargeType cannot be PrePaid, and EipAddress.ISP must be set to BGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.

      - If not specified, the default protection type public IP will be applied.
    
    bandwidth_mbps number
    The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When ChargeType is set to PayByBandwidth: valid range is 1–500. - When ChargeType is set to PayByTraffic: valid range is 1–200.
    bandwidth_package_id string
    ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
    charge_type string
    Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription. Note: When the instance billing type InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.
    isp string
    Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - 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 the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
    security_protection_instance_id number
    DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    security_protection_types list(string)

    Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.

    Note: - If EipAddress.SecurityProtectionTypes.N is set to AntiDDoS_Enhanced, EipAddress.ChargeType cannot be PrePaid, and EipAddress.ISP must be set to BGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.

      - If not specified, the default protection type public IP will be applied.
    
    bandwidthMbps Integer
    The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When ChargeType is set to PayByBandwidth: valid range is 1–500. - When ChargeType is set to PayByTraffic: valid range is 1–200.
    bandwidthPackageId String
    ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
    chargeType String
    Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription. Note: When the instance billing type InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.
    isp String
    Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - 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 the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
    securityProtectionInstanceId Integer
    DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    securityProtectionTypes List<String>

    Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.

    Note: - If EipAddress.SecurityProtectionTypes.N is set to AntiDDoS_Enhanced, EipAddress.ChargeType cannot be PrePaid, and EipAddress.ISP must be set to BGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.

      - If not specified, the default protection type public IP will be applied.
    
    bandwidthMbps number
    The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When ChargeType is set to PayByBandwidth: valid range is 1–500. - When ChargeType is set to PayByTraffic: valid range is 1–200.
    bandwidthPackageId string
    ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
    chargeType string
    Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription. Note: When the instance billing type InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.
    isp string
    Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - 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 the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
    securityProtectionInstanceId number
    DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    securityProtectionTypes string[]

    Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.

    Note: - If EipAddress.SecurityProtectionTypes.N is set to AntiDDoS_Enhanced, EipAddress.ChargeType cannot be PrePaid, and EipAddress.ISP must be set to BGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.

      - If not specified, the default protection type public IP will be applied.
    
    bandwidth_mbps int
    The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When ChargeType is set to PayByBandwidth: valid range is 1–500. - When ChargeType is set to PayByTraffic: valid range is 1–200.
    bandwidth_package_id str
    ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
    charge_type str
    Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription. Note: When the instance billing type InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.
    isp str
    Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - 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 the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
    security_protection_instance_id int
    DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    security_protection_types Sequence[str]

    Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.

    Note: - If EipAddress.SecurityProtectionTypes.N is set to AntiDDoS_Enhanced, EipAddress.ChargeType cannot be PrePaid, and EipAddress.ISP must be set to BGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.

      - If not specified, the default protection type public IP will be applied.
    
    bandwidthMbps Number
    The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When ChargeType is set to PayByBandwidth: valid range is 1–500. - When ChargeType is set to PayByTraffic: valid range is 1–200.
    bandwidthPackageId String
    ID of the shared bandwidth package, indicating that the public IP will be added to the shared bandwidth package. - You can call the [DescribeBandwidthPackages] API to query the ID of the shared bandwidth package. - The following conditions must be met to add a public IP to a shared bandwidth package: - Both must have the same security protection type. - Both must be in the same region. - The billing method for the public IP must be pay-as-you-go. - The shared bandwidth package must be of IPv4 type.
    chargeType String
    Public IP billing method. Options: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap. - PayByTraffic: Pay-as-you-go by actual traffic. - PrePaid: Subscription. Note: When the instance billing type InstanceChargeType is set to PostPaid, this parameter cannot be set to PrePaid.
    isp String
    Public IP line type. Defaults to BGP. Options: - BGP: BGP (multi-line). - If your account has applied for and enabled static single-line permissions, you can use: - 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 the public IP is released with the instance - true: The public IP is released with the instance - false (default): The public IP is not released with the instance
    securityProtectionInstanceId Number
    DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    securityProtectionTypes List<String>

    Security protection type for public IP. - Parameter - N: Indicates the sequence number of the security protection type. Currently, only 1 is supported. - Values: - AntiDDoS_Enhanced: Apply for a public IP with enhanced protection, which can be added to a DDoS native protection (Enterprise Edition) instance.

    Note: - If EipAddress.SecurityProtectionTypes.N is set to AntiDDoS_Enhanced, EipAddress.ChargeType cannot be PrePaid, and EipAddress.ISP must be set to BGP. - Enhanced protection public IP is in invitation-only testing. To try it, contact your account manager.

      - If not specified, the default protection type public IP will be applied.
    

    GetScheduledInstanceInstanceConfig

    Description string
    Description of the instance.
    EipAddress Volcengine.GetScheduledInstanceInstanceConfigEipAddress
    Public IP information bound to the instance.
    HostName string
    Instance hostname.
    HpcClusterId string
    High performance computing cluster ID.
    ImageId string
    Image ID
    InstanceName string
    Instance name.
    InstanceTypeId string
    Instance type.
    KeyPairName string
    Key pair name.
    NetworkInterfaces List<Volcengine.GetScheduledInstanceInstanceConfigNetworkInterface>
    Network interface information attached to the instance.
    ProjectName string
    Project to which the instance belongs.
    Tags List<Volcengine.GetScheduledInstanceInstanceConfigTag>
    Tag information for the instance.
    Volumes List<Volcengine.GetScheduledInstanceInstanceConfigVolume>
    Information about the cloud disks attached to the instance.
    ZoneId string
    Availability zone ID where the elastic reservation order is located.
    Description string
    Description of the instance.
    EipAddress GetScheduledInstanceInstanceConfigEipAddress
    Public IP information bound to the instance.
    HostName string
    Instance hostname.
    HpcClusterId string
    High performance computing cluster ID.
    ImageId string
    Image ID
    InstanceName string
    Instance name.
    InstanceTypeId string
    Instance type.
    KeyPairName string
    Key pair name.
    NetworkInterfaces []GetScheduledInstanceInstanceConfigNetworkInterface
    Network interface information attached to the instance.
    ProjectName string
    Project to which the instance belongs.
    Tags []GetScheduledInstanceInstanceConfigTag
    Tag information for the instance.
    Volumes []GetScheduledInstanceInstanceConfigVolume
    Information about the cloud disks attached to the instance.
    ZoneId string
    Availability zone ID where the elastic reservation order is located.
    description string
    Description of the instance.
    eip_address object
    Public IP information bound to the instance.
    host_name string
    Instance hostname.
    hpc_cluster_id string
    High performance computing cluster ID.
    image_id string
    Image ID
    instance_name string
    Instance name.
    instance_type_id string
    Instance type.
    key_pair_name string
    Key pair name.
    network_interfaces list(object)
    Network interface information attached to the instance.
    project_name string
    Project to which the instance belongs.
    tags list(object)
    Tag information for the instance.
    volumes list(object)
    Information about the cloud disks attached to the instance.
    zone_id string
    Availability zone ID where the elastic reservation order is located.
    description String
    Description of the instance.
    eipAddress GetScheduledInstanceInstanceConfigEipAddress
    Public IP information bound to the instance.
    hostName String
    Instance hostname.
    hpcClusterId String
    High performance computing cluster ID.
    imageId String
    Image ID
    instanceName String
    Instance name.
    instanceTypeId String
    Instance type.
    keyPairName String
    Key pair name.
    networkInterfaces List<GetScheduledInstanceInstanceConfigNetworkInterface>
    Network interface information attached to the instance.
    projectName String
    Project to which the instance belongs.
    tags List<GetScheduledInstanceInstanceConfigTag>
    Tag information for the instance.
    volumes List<GetScheduledInstanceInstanceConfigVolume>
    Information about the cloud disks attached to the instance.
    zoneId String
    Availability zone ID where the elastic reservation order is located.
    description string
    Description of the instance.
    eipAddress GetScheduledInstanceInstanceConfigEipAddress
    Public IP information bound to the instance.
    hostName string
    Instance hostname.
    hpcClusterId string
    High performance computing cluster ID.
    imageId string
    Image ID
    instanceName string
    Instance name.
    instanceTypeId string
    Instance type.
    keyPairName string
    Key pair name.
    networkInterfaces GetScheduledInstanceInstanceConfigNetworkInterface[]
    Network interface information attached to the instance.
    projectName string
    Project to which the instance belongs.
    tags GetScheduledInstanceInstanceConfigTag[]
    Tag information for the instance.
    volumes GetScheduledInstanceInstanceConfigVolume[]
    Information about the cloud disks attached to the instance.
    zoneId string
    Availability zone ID where the elastic reservation order is located.
    description str
    Description of the instance.
    eip_address GetScheduledInstanceInstanceConfigEipAddress
    Public IP information bound to the instance.
    host_name str
    Instance hostname.
    hpc_cluster_id str
    High performance computing cluster ID.
    image_id str
    Image ID
    instance_name str
    Instance name.
    instance_type_id str
    Instance type.
    key_pair_name str
    Key pair name.
    network_interfaces Sequence[GetScheduledInstanceInstanceConfigNetworkInterface]
    Network interface information attached to the instance.
    project_name str
    Project to which the instance belongs.
    tags Sequence[GetScheduledInstanceInstanceConfigTag]
    Tag information for the instance.
    volumes Sequence[GetScheduledInstanceInstanceConfigVolume]
    Information about the cloud disks attached to the instance.
    zone_id str
    Availability zone ID where the elastic reservation order is located.
    description String
    Description of the instance.
    eipAddress Property Map
    Public IP information bound to the instance.
    hostName String
    Instance hostname.
    hpcClusterId String
    High performance computing cluster ID.
    imageId String
    Image ID
    instanceName String
    Instance name.
    instanceTypeId String
    Instance type.
    keyPairName String
    Key pair name.
    networkInterfaces List<Property Map>
    Network interface information attached to the instance.
    projectName String
    Project to which the instance belongs.
    tags List<Property Map>
    Tag information for the instance.
    volumes List<Property Map>
    Information about the cloud disks attached to the instance.
    zoneId String
    Availability zone ID where the elastic reservation order is located.

    GetScheduledInstanceInstanceConfigEipAddress

    BandwidthMbps int
    Maximum bandwidth for the public IP, in Mbps - Default: 1 - Value range: - If ChargeType is PayByBandwidth: 1–500 - If ChargeType is PayByTraffic: 1–200
    BandwidthPackageId string
    Shared bandwidth package ID.
    ChargeType string
    Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
    Isp string
    Line type. Values: - BGP (default): 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 the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
    SecurityProtectionInstanceId string
    ID of the bound security protection package. This parameter is returned only when SecurityProtectionTypes is not empty.
    SecurityProtectionTypes List<string>
    Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
    BandwidthMbps int
    Maximum bandwidth for the public IP, in Mbps - Default: 1 - Value range: - If ChargeType is PayByBandwidth: 1–500 - If ChargeType is PayByTraffic: 1–200
    BandwidthPackageId string
    Shared bandwidth package ID.
    ChargeType string
    Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
    Isp string
    Line type. Values: - BGP (default): 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 the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
    SecurityProtectionInstanceId string
    ID of the bound security protection package. This parameter is returned only when SecurityProtectionTypes is not empty.
    SecurityProtectionTypes []string
    Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
    bandwidth_mbps number
    Maximum bandwidth for the public IP, in Mbps - Default: 1 - Value range: - If ChargeType is PayByBandwidth: 1–500 - If ChargeType is PayByTraffic: 1–200
    bandwidth_package_id string
    Shared bandwidth package ID.
    charge_type string
    Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
    isp string
    Line type. Values: - BGP (default): 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 the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
    security_protection_instance_id string
    ID of the bound security protection package. This parameter is returned only when SecurityProtectionTypes is not empty.
    security_protection_types list(string)
    Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
    bandwidthMbps Integer
    Maximum bandwidth for the public IP, in Mbps - Default: 1 - Value range: - If ChargeType is PayByBandwidth: 1–500 - If ChargeType is PayByTraffic: 1–200
    bandwidthPackageId String
    Shared bandwidth package ID.
    chargeType String
    Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
    isp String
    Line type. Values: - BGP (default): 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 the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
    securityProtectionInstanceId String
    ID of the bound security protection package. This parameter is returned only when SecurityProtectionTypes is not empty.
    securityProtectionTypes List<String>
    Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
    bandwidthMbps number
    Maximum bandwidth for the public IP, in Mbps - Default: 1 - Value range: - If ChargeType is PayByBandwidth: 1–500 - If ChargeType is PayByTraffic: 1–200
    bandwidthPackageId string
    Shared bandwidth package ID.
    chargeType string
    Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
    isp string
    Line type. Values: - BGP (default): 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 the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
    securityProtectionInstanceId string
    ID of the bound security protection package. This parameter is returned only when SecurityProtectionTypes is not empty.
    securityProtectionTypes string[]
    Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
    bandwidth_mbps int
    Maximum bandwidth for the public IP, in Mbps - Default: 1 - Value range: - If ChargeType is PayByBandwidth: 1–500 - If ChargeType is PayByTraffic: 1–200
    bandwidth_package_id str
    Shared bandwidth package ID.
    charge_type str
    Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
    isp str
    Line type. Values: - BGP (default): 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 the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
    security_protection_instance_id str
    ID of the bound security protection package. This parameter is returned only when SecurityProtectionTypes is not empty.
    security_protection_types Sequence[str]
    Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.
    bandwidthMbps Number
    Maximum bandwidth for the public IP, in Mbps - Default: 1 - Value range: - If ChargeType is PayByBandwidth: 1–500 - If ChargeType is PayByTraffic: 1–200
    bandwidthPackageId String
    Shared bandwidth package ID.
    chargeType String
    Billing method for public IP. Values: - PayByBandwidth (default): Pay-as-you-go by bandwidth cap - PayByTraffic: Pay-as-you-go by actual traffic - PrePaid: Subscription
    isp String
    Line type. Values: - BGP (default): 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 the public IP is released with the instance. Only applies to pay-as-you-go public IPs. Options: - true: Public IP is released with the instance. When the instance is automatically reclaimed by the system (24 hours after unsubscribe, expiration, etc.) or deleted via [DeleteInstance] or [DeleteInstances] API, the public IP is released together with the instance. - false: Public IP is not released with the instance.
    securityProtectionInstanceId String
    ID of the bound security protection package. This parameter is returned only when SecurityProtectionTypes is not empty.
    securityProtectionTypes List<String>
    Security protection type for public IP. - AntiDDoS_Enhanced: Public IP with enhanced protection (can be added to DDoS Native Protection (Enterprise Edition) instance). - Null: Public IP with basic protection.

    GetScheduledInstanceInstanceConfigNetworkInterface

    SecurityGroupIds List<string>
    Security group ID associated with the network interface.
    SubnetId string
    Private network subnet ID of the instance.
    SecurityGroupIds []string
    Security group ID associated with the network interface.
    SubnetId string
    Private network subnet ID of the instance.
    security_group_ids list(string)
    Security group ID associated with the network interface.
    subnet_id string
    Private network subnet ID of the instance.
    securityGroupIds List<String>
    Security group ID associated with the network interface.
    subnetId String
    Private network subnet ID of the instance.
    securityGroupIds string[]
    Security group ID associated with the network interface.
    subnetId string
    Private network subnet ID of the instance.
    security_group_ids Sequence[str]
    Security group ID associated with the network interface.
    subnet_id str
    Private network subnet ID of the instance.
    securityGroupIds List<String>
    Security group ID associated with the network interface.
    subnetId String
    Private network subnet ID of the instance.

    GetScheduledInstanceInstanceConfigTag

    Key string
    Resource tag key.
    Value string
    Resource tag value
    Key string
    Resource tag key.
    Value string
    Resource tag value
    key string
    Resource tag key.
    value string
    Resource tag value
    key String
    Resource tag key.
    value String
    Resource tag value
    key string
    Resource tag key.
    value string
    Resource tag value
    key str
    Resource tag key.
    value str
    Resource tag value
    key String
    Resource tag key.
    value String
    Resource tag value

    GetScheduledInstanceInstanceConfigVolume

    Kind string
    Disk type. Values: - system: System disk - data: Data disk
    Size int
    Cloud disk capacity, in GiB.
    VolumeType string
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
    Kind string
    Disk type. Values: - system: System disk - data: Data disk
    Size int
    Cloud disk capacity, in GiB.
    VolumeType string
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
    kind string
    Disk type. Values: - system: System disk - data: Data disk
    size number
    Cloud disk capacity, in GiB.
    volume_type string
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
    kind String
    Disk type. Values: - system: System disk - data: Data disk
    size Integer
    Cloud disk capacity, in GiB.
    volumeType String
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
    kind string
    Disk type. Values: - system: System disk - data: Data disk
    size number
    Cloud disk capacity, in GiB.
    volumeType string
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
    kind str
    Disk type. Values: - system: System disk - data: Data disk
    size int
    Cloud disk capacity, in GiB.
    volume_type str
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
    kind String
    Disk type. Values: - system: System disk - data: Data disk
    size Number
    Cloud disk capacity, in GiB.
    volumeType String
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL

    GetScheduledInstanceNetworkInterface

    PrimaryIpAddress string
    Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
    PrivateIpAddresses List<string>
    Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
    SecurityGroupIds List<string>
    Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
    SubnetId string
    Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
    VpcId string
    Private network
    PrimaryIpAddress string
    Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
    PrivateIpAddresses []string
    Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
    SecurityGroupIds []string
    Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
    SubnetId string
    Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
    VpcId string
    Private network
    primary_ip_address string
    Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
    private_ip_addresses list(string)
    Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
    security_group_ids list(string)
    Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
    subnet_id string
    Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
    vpc_id string
    Private network
    primaryIpAddress String
    Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
    privateIpAddresses List<String>
    Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
    securityGroupIds List<String>
    Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
    subnetId String
    Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
    vpcId String
    Private network
    primaryIpAddress string
    Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
    privateIpAddresses string[]
    Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
    securityGroupIds string[]
    Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
    subnetId string
    Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
    vpcId string
    Private network
    primary_ip_address str
    Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
    private_ip_addresses Sequence[str]
    Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
    security_group_ids Sequence[str]
    Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
    subnet_id str
    Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
    vpc_id str
    Private network
    primaryIpAddress String
    Specify the primary IP address of the NIC. Currently, only one primary IP address can be specified for either the primary or auxiliary NIC. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple NICs with &.
    privateIpAddresses List<String>
    Specify the secondary IP address of the primary network interface. Currently, only the primary network interface supports specifying secondary IPs. - The first N: Indicates the sequence number of the primary network interface. Only one primary network interface can be bound. - The second N: Indicates the sequence number of the secondary IP on the primary network interface. The maximum number of assignable secondary IP addresses is the number of private IPs per single network interface for this [instance type] minus one primary private IP. - Separate multiple secondary IPs with &.
    securityGroupIds List<String>
    Security group ID associated with the network interface. - The first N: Indicates the sequence number of the network interface, N = 1 is the primary network interface; N ≥ 2 is a secondary network interface. - The second N: Indicates the sequence number of the security group associated with the network interface, value range: 1–5. - Use & to separate multiple security group IDs.
    subnetId String
    Private network subnet ID of the instance. When creating an instance, you can bind auxiliary NICs at the same time. - Parameter - N: indicates the NIC index, N = 1 means primary NIC; N ≥ 2 means auxiliary NIC. - Separate multiple private network subnet IDs with &.
    vpcId String
    Private network

    GetScheduledInstanceTag

    Key string
    Resource tag key.
    Value string
    Resource tag value
    Key string
    Resource tag key.
    Value string
    Resource tag value
    key string
    Resource tag key.
    value string
    Resource tag value
    key String
    Resource tag key.
    value String
    Resource tag value
    key string
    Resource tag key.
    value string
    Resource tag value
    key str
    Resource tag key.
    value str
    Resource tag value
    key String
    Resource tag key.
    value String
    Resource tag value

    GetScheduledInstanceVolume

    DeleteWithInstance bool
    Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
    ExtraPerformanceIops int

    Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when ExtraPerformanceTypeId is Balance or IOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000

    Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.

    ExtraPerformanceThroughputMb int
    Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when ExtraPerformanceTypeId is Throughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &.
    ExtraPerformanceTypeId string

    Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].

    Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.

    Size int

    Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048

    Note: Default: max{40, image size of ImageId}

    - Data disk:
      - ESSD_PL0: 10–32768
      - ESSD_FlexPL: 10–32768
    

    Note: If this parameter is not specified, the snapshot size corresponding to Volumes.N.SnapshotId is used as the data disk capacity. If Volumes.N.SnapshotId is not specified, an error LimitExceeded.DataVolumeSize is returned

    SnapshotId string
    Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
    VolumeType string
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
    DeleteWithInstance bool
    Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
    ExtraPerformanceIops int

    Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when ExtraPerformanceTypeId is Balance or IOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000

    Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.

    ExtraPerformanceThroughputMb int
    Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when ExtraPerformanceTypeId is Throughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &.
    ExtraPerformanceTypeId string

    Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].

    Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.

    Size int

    Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048

    Note: Default: max{40, image size of ImageId}

    - Data disk:
      - ESSD_PL0: 10–32768
      - ESSD_FlexPL: 10–32768
    

    Note: If this parameter is not specified, the snapshot size corresponding to Volumes.N.SnapshotId is used as the data disk capacity. If Volumes.N.SnapshotId is not specified, an error LimitExceeded.DataVolumeSize is returned

    SnapshotId string
    Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
    VolumeType string
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
    delete_with_instance bool
    Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
    extra_performance_iops number

    Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when ExtraPerformanceTypeId is Balance or IOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000

    Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.

    extra_performance_throughput_mb number
    Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when ExtraPerformanceTypeId is Throughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &.
    extra_performance_type_id string

    Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].

    Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.

    size number

    Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048

    Note: Default: max{40, image size of ImageId}

    - Data disk:
      - ESSD_PL0: 10–32768
      - ESSD_FlexPL: 10–32768
    

    Note: If this parameter is not specified, the snapshot size corresponding to Volumes.N.SnapshotId is used as the data disk capacity. If Volumes.N.SnapshotId is not specified, an error LimitExceeded.DataVolumeSize is returned

    snapshot_id string
    Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
    volume_type string
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
    deleteWithInstance Boolean
    Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
    extraPerformanceIops Integer

    Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when ExtraPerformanceTypeId is Balance or IOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000

    Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.

    extraPerformanceThroughputMb Integer
    Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when ExtraPerformanceTypeId is Throughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &.
    extraPerformanceTypeId String

    Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].

    Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.

    size Integer

    Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048

    Note: Default: max{40, image size of ImageId}

    - Data disk:
      - ESSD_PL0: 10–32768
      - ESSD_FlexPL: 10–32768
    

    Note: If this parameter is not specified, the snapshot size corresponding to Volumes.N.SnapshotId is used as the data disk capacity. If Volumes.N.SnapshotId is not specified, an error LimitExceeded.DataVolumeSize is returned

    snapshotId String
    Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
    volumeType String
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
    deleteWithInstance boolean
    Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
    extraPerformanceIops number

    Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when ExtraPerformanceTypeId is Balance or IOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000

    Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.

    extraPerformanceThroughputMb number
    Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when ExtraPerformanceTypeId is Throughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &.
    extraPerformanceTypeId string

    Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].

    Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.

    size number

    Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048

    Note: Default: max{40, image size of ImageId}

    - Data disk:
      - ESSD_PL0: 10–32768
      - ESSD_FlexPL: 10–32768
    

    Note: If this parameter is not specified, the snapshot size corresponding to Volumes.N.SnapshotId is used as the data disk capacity. If Volumes.N.SnapshotId is not specified, an error LimitExceeded.DataVolumeSize is returned

    snapshotId string
    Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
    volumeType string
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
    delete_with_instance bool
    Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
    extra_performance_iops int

    Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when ExtraPerformanceTypeId is Balance or IOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000

    Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.

    extra_performance_throughput_mb int
    Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when ExtraPerformanceTypeId is Throughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &.
    extra_performance_type_id str

    Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].

    Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.

    size int

    Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048

    Note: Default: max{40, image size of ImageId}

    - Data disk:
      - ESSD_PL0: 10–32768
      - ESSD_FlexPL: 10–32768
    

    Note: If this parameter is not specified, the snapshot size corresponding to Volumes.N.SnapshotId is used as the data disk capacity. If Volumes.N.SnapshotId is not specified, an error LimitExceeded.DataVolumeSize is returned

    snapshot_id str
    Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
    volume_type str
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.
    deleteWithInstance Boolean
    Whether the cloud disk is released with the instance. Values: - true (default): The cloud disk is released with the instance. - false: The cloud disk is not released with the instance. Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, which is released with the instance by default and cannot be retained; N ≥ 2 indicates a data disk, which can be optionally released with the instance. - Separate multiple cloud disks with &.
    extraPerformanceIops Number

    Extra IOPS performance size for the cloud disk, supported only by ESSD FlexPL data disks, measured in operations/second. This parameter must be set when ExtraPerformanceTypeId is Balance or IOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000

    Note: - Parameter - N: Indicates the sequence number of the cloud disk, value range: 1–16. N = 1 indicates the system disk, so when N is 1, this parameter is ignored. N ≥ 2 indicates a data disk, and this parameter can be set normally. - Use & to separate multiple cloud disks.

    extraPerformanceThroughputMb Number
    Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when ExtraPerformanceTypeId is Throughput. Value range: 1–650. Note: - Parameter - N: indicates the disk index, value range: 1–16. N = 1 means system disk; if N is 1, this parameter will be ignored. N ≥ 2 means data disk; you can set this parameter normally. - Separate multiple disks with &.
    extraPerformanceTypeId String

    Type of extra cloud disk performance, supported only by ESSD FlexPL data disks. Values: - Balance: Balanced extra performance - IOPS: IOPS extra performance - Throughput: Throughput extra performance For more information about extra performance, see [Cloud Disk Extra Performance].

    Note: - Parameter - N: Indicates the sequence number of the cloud disk. Value range: 1–16. N = 1 indicates the system disk. If N is set to 1, this parameter will be ignored. N ≥ 2 indicates a data disk. This parameter can be set normally. - Use & to separate multiple cloud disks.

    size Number

    Cloud disk capacity, in GiB. N ranges from 1 to 16, where N = 1 is the system disk, and N ≥ 2 are data disks. Separate multiple cloud disks with &. Cloud disk capacity ranges: - System disk: - ESSD_PL0: 20–2048 - ESSD_FlexPL: 20–2048

    Note: Default: max{40, image size of ImageId}

    - Data disk:
      - ESSD_PL0: 10–32768
      - ESSD_FlexPL: 10–32768
    

    Note: If this parameter is not specified, the snapshot size corresponding to Volumes.N.SnapshotId is used as the data disk capacity. If Volumes.N.SnapshotId is not specified, an error LimitExceeded.DataVolumeSize is returned

    snapshotId String
    Create a disk from a snapshot; only data disks are supported. You can call the [DescribeSnapshots] API to query the snapshot ID. - Parameter - N: Indicates the disk sequence number, value range: 1–16. N = 1 indicates the system disk; when N is 1, this parameter will be ignored. N ≥ 2 indicates a data disk; you can specify the target data disk snapshot ID. - Use & to separate multiple disks. Note: - Only ultra-fast SSDs support creating disks from snapshots; performance SSDs do not support snapshot-related features. - Only snapshots in the 'Available' state support creating new disks. Snapshots in 'Creating', 'Rolling back', 'Deleting', or 'Error' states do not support creating new disks.
    volumeType String
    Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL Note: - Parameter - N: Indicates the disk number, range: 1–16. N = 1 indicates the system disk; N ≥ 2 indicates a data disk. - Use & to separate multiple disks.

    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.60
    published on Thursday, Sep 3, 2026 by Volcengine

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial