published on Thursday, Sep 3, 2026 by Volcengine
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 dictionarydata "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:
- Auto
Release stringAt - Cpu
Max doubleFrequency - Created
At string - Deletion
Protection bool - Delivery
Count int - Delivery
Type string - Description string
- Eip
Address Volcengine.Get Scheduled Instance Eip Address - Elastic
Scheduled stringInstance Type - End
Delivery stringAt - Host
Name string - Hpc
Cluster stringId - Http
Tokens string - Id string
- Image
Id string - Install
Run boolCommand Agent - Instance
Config Volcengine.Get Scheduled Instance Instance Config - Instance
Count int - Instance
Name string - Instance
Type stringId - Invalid
At string - Keep
Image boolCredential - Key
Pair stringName - Min
Count int - Network
Interfaces List<Volcengine.Get Scheduled Instance Network Interface> - Password string
- Project
Name string - Release
Count int - Scheduled
Instance stringDescription - Scheduled
Instance stringId - Scheduled
Instance stringName - Security
Enhancement stringStrategy - Start
Delivery stringAt - Status string
- Suffix
Index int -
List<Volcengine.
Get Scheduled Instance Tag> - Unique
Suffix bool - Updated
At string - User
Data string - Volumes
List<Volcengine.
Get Scheduled Instance Volume> - Zone
Id string
- Auto
Release stringAt - Cpu
Max float64Frequency - Created
At string - Deletion
Protection bool - Delivery
Count int - Delivery
Type string - Description string
- Eip
Address GetScheduled Instance Eip Address - Elastic
Scheduled stringInstance Type - End
Delivery stringAt - Host
Name string - Hpc
Cluster stringId - Http
Tokens string - Id string
- Image
Id string - Install
Run boolCommand Agent - Instance
Config GetScheduled Instance Instance Config - Instance
Count int - Instance
Name string - Instance
Type stringId - Invalid
At string - Keep
Image boolCredential - Key
Pair stringName - Min
Count int - Network
Interfaces []GetScheduled Instance Network Interface - Password string
- Project
Name string - Release
Count int - Scheduled
Instance stringDescription - Scheduled
Instance stringId - Scheduled
Instance stringName - Security
Enhancement stringStrategy - Start
Delivery stringAt - Status string
- Suffix
Index int -
[]Get
Scheduled Instance Tag - Unique
Suffix bool - Updated
At string - User
Data string - Volumes
[]Get
Scheduled Instance Volume - Zone
Id string
- auto_
release_ stringat - cpu_
max_ numberfrequency - created_
at string - deletion_
protection bool - delivery_
count number - delivery_
type string - description string
- eip_
address object - elastic_
scheduled_ stringinstance_ type - end_
delivery_ stringat - host_
name string - hpc_
cluster_ stringid - http_
tokens string - id string
- image_
id string - install_
run_ boolcommand_ agent - instance_
config object - instance_
count number - instance_
name string - instance_
type_ stringid - invalid_
at string - keep_
image_ boolcredential - key_
pair_ stringname - min_
count number - network_
interfaces list(object) - password string
- project_
name string - release_
count number - scheduled_
instance_ stringdescription - scheduled_
instance_ stringid - scheduled_
instance_ stringname - security_
enhancement_ stringstrategy - start_
delivery_ stringat - status string
- suffix_
index number - list(object)
- unique_
suffix bool - updated_
at string - user_
data string - volumes list(object)
- zone_
id string
- auto
Release StringAt - cpu
Max DoubleFrequency - created
At String - deletion
Protection Boolean - delivery
Count Integer - delivery
Type String - description String
- eip
Address GetScheduled Instance Eip Address - elastic
Scheduled StringInstance Type - end
Delivery StringAt - host
Name String - hpc
Cluster StringId - http
Tokens String - id String
- image
Id String - install
Run BooleanCommand Agent - instance
Config GetScheduled Instance Instance Config - instance
Count Integer - instance
Name String - instance
Type StringId - invalid
At String - keep
Image BooleanCredential - key
Pair StringName - min
Count Integer - network
Interfaces List<GetScheduled Instance Network Interface> - password String
- project
Name String - release
Count Integer - scheduled
Instance StringDescription - scheduled
Instance StringId - scheduled
Instance StringName - security
Enhancement StringStrategy - start
Delivery StringAt - status String
- suffix
Index Integer -
List<Get
Scheduled Instance Tag> - unique
Suffix Boolean - updated
At String - user
Data String - volumes
List<Get
Scheduled Instance Volume> - zone
Id String
- auto
Release stringAt - cpu
Max numberFrequency - created
At string - deletion
Protection boolean - delivery
Count number - delivery
Type string - description string
- eip
Address GetScheduled Instance Eip Address - elastic
Scheduled stringInstance Type - end
Delivery stringAt - host
Name string - hpc
Cluster stringId - http
Tokens string - id string
- image
Id string - install
Run booleanCommand Agent - instance
Config GetScheduled Instance Instance Config - instance
Count number - instance
Name string - instance
Type stringId - invalid
At string - keep
Image booleanCredential - key
Pair stringName - min
Count number - network
Interfaces GetScheduled Instance Network Interface[] - password string
- project
Name string - release
Count number - scheduled
Instance stringDescription - scheduled
Instance stringId - scheduled
Instance stringName - security
Enhancement stringStrategy - start
Delivery stringAt - status string
- suffix
Index number -
Get
Scheduled Instance Tag[] - unique
Suffix boolean - updated
At string - user
Data string - volumes
Get
Scheduled Instance Volume[] - zone
Id string
- auto_
release_ strat - cpu_
max_ floatfrequency - created_
at str - deletion_
protection bool - delivery_
count int - delivery_
type str - description str
- eip_
address GetScheduled Instance Eip Address - elastic_
scheduled_ strinstance_ type - end_
delivery_ strat - host_
name str - hpc_
cluster_ strid - http_
tokens str - id str
- image_
id str - install_
run_ boolcommand_ agent - instance_
config GetScheduled Instance Instance Config - instance_
count int - instance_
name str - instance_
type_ strid - invalid_
at str - keep_
image_ boolcredential - key_
pair_ strname - min_
count int - network_
interfaces Sequence[GetScheduled Instance Network Interface] - password str
- project_
name str - release_
count int - scheduled_
instance_ strdescription - scheduled_
instance_ strid - scheduled_
instance_ strname - security_
enhancement_ strstrategy - start_
delivery_ strat - status str
- suffix_
index int -
Sequence[Get
Scheduled Instance Tag] - unique_
suffix bool - updated_
at str - user_
data str - volumes
Sequence[Get
Scheduled Instance Volume] - zone_
id str
- auto
Release StringAt - cpu
Max NumberFrequency - created
At String - deletion
Protection Boolean - delivery
Count Number - delivery
Type String - description String
- eip
Address Property Map - elastic
Scheduled StringInstance Type - end
Delivery StringAt - host
Name String - hpc
Cluster StringId - http
Tokens String - id String
- image
Id String - install
Run BooleanCommand Agent - instance
Config Property Map - instance
Count Number - instance
Name String - instance
Type StringId - invalid
At String - keep
Image BooleanCredential - key
Pair StringName - min
Count Number - network
Interfaces List<Property Map> - password String
- project
Name String - release
Count Number - scheduled
Instance StringDescription - scheduled
Instance StringId - scheduled
Instance StringName - security
Enhancement StringStrategy - start
Delivery StringAt - status String
- suffix
Index Number - List<Property Map>
- unique
Suffix Boolean - updated
At String - user
Data String - volumes List<Property Map>
- zone
Id String
Supporting Types
GetScheduledInstanceEipAddress
- Bandwidth
Mbps int - The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - Bandwidth
Package stringId - 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
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - 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 boolInstance - 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 intInstance Id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - Security
Protection List<string>Types 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.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - 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
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - Bandwidth
Package stringId - 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
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - 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 boolInstance - 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 intInstance Id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - Security
Protection []stringTypes 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.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - 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
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - bandwidth_
package_ stringid - 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
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - 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_ boolinstance - 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_ numberinstance_ id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - security_
protection_ list(string)types 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.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - 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 Integer - The maximum bandwidth for the public IP address. Default value: 1. Unit: Mbps. - When
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - bandwidth
Package StringId - 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
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - 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 BooleanInstance - 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 IntegerInstance Id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - security
Protection List<String>Types 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.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - 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
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - bandwidth
Package stringId - 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
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - 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 booleanInstance - 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 numberInstance Id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - security
Protection string[]Types 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.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - 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
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - bandwidth_
package_ strid - 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
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - 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_ boolinstance - 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_ intinstance_ id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - security_
protection_ Sequence[str]types 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.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - 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
ChargeTypeis set toPayByBandwidth: valid range is 1–500. - WhenChargeTypeis set toPayByTraffic: valid range is 1–200. - bandwidth
Package StringId - 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
InstanceChargeTypeis set toPostPaid, this parameter cannot be set toPrePaid. - 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 BooleanInstance - 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 NumberInstance Id - DDoS Native Protection (Enterprise Edition) ID. - You can call the [DescInstanceList] API to query the DDoS Native Protection (Enterprise Edition) ID. - When
SecurityProtectionTypesis set toAntiDDoS_Enhanced, this parameter is required. - security
Protection List<String>Types 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.Nis set toAntiDDoS_Enhanced,EipAddress.ChargeTypecannot bePrePaid, andEipAddress.ISPmust be set toBGP. - 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.
- Eip
Address Volcengine.Get Scheduled Instance Instance Config Eip Address - Public IP information bound to the instance.
- Host
Name string - Instance hostname.
- Hpc
Cluster stringId - High performance computing cluster ID.
- Image
Id string - Image ID
- Instance
Name string - Instance name.
- Instance
Type stringId - Instance type.
- Key
Pair stringName - Key pair name.
- Network
Interfaces List<Volcengine.Get Scheduled Instance Instance Config Network Interface> - Network interface information attached to the instance.
- Project
Name string - Project to which the instance belongs.
-
List<Volcengine.
Get Scheduled Instance Instance Config Tag> - Tag information for the instance.
- Volumes
List<Volcengine.
Get Scheduled Instance Instance Config Volume> - 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.
- Eip
Address GetScheduled Instance Instance Config Eip Address - Public IP information bound to the instance.
- Host
Name string - Instance hostname.
- Hpc
Cluster stringId - High performance computing cluster ID.
- Image
Id string - Image ID
- Instance
Name string - Instance name.
- Instance
Type stringId - Instance type.
- Key
Pair stringName - Key pair name.
- Network
Interfaces []GetScheduled Instance Instance Config Network Interface - Network interface information attached to the instance.
- Project
Name string - Project to which the instance belongs.
-
[]Get
Scheduled Instance Instance Config Tag - Tag information for the instance.
- Volumes
[]Get
Scheduled Instance Instance Config Volume - 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.
- eip_
address object - Public IP information bound to the instance.
- host_
name string - Instance hostname.
- hpc_
cluster_ stringid - High performance computing cluster ID.
- image_
id string - Image ID
- instance_
name string - Instance name.
- instance_
type_ stringid - Instance type.
- key_
pair_ stringname - Key pair name.
- network_
interfaces list(object) - Network interface information attached to the instance.
- project_
name string - Project to which the instance belongs.
- 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.
- eip
Address GetScheduled Instance Instance Config Eip Address - Public IP information bound to the instance.
- host
Name String - Instance hostname.
- hpc
Cluster StringId - High performance computing cluster ID.
- image
Id String - Image ID
- instance
Name String - Instance name.
- instance
Type StringId - Instance type.
- key
Pair StringName - Key pair name.
- network
Interfaces List<GetScheduled Instance Instance Config Network Interface> - Network interface information attached to the instance.
- project
Name String - Project to which the instance belongs.
-
List<Get
Scheduled Instance Instance Config Tag> - Tag information for the instance.
- volumes
List<Get
Scheduled Instance Instance Config Volume> - 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.
- eip
Address GetScheduled Instance Instance Config Eip Address - Public IP information bound to the instance.
- host
Name string - Instance hostname.
- hpc
Cluster stringId - High performance computing cluster ID.
- image
Id string - Image ID
- instance
Name string - Instance name.
- instance
Type stringId - Instance type.
- key
Pair stringName - Key pair name.
- network
Interfaces GetScheduled Instance Instance Config Network Interface[] - Network interface information attached to the instance.
- project
Name string - Project to which the instance belongs.
-
Get
Scheduled Instance Instance Config Tag[] - Tag information for the instance.
- volumes
Get
Scheduled Instance Instance Config Volume[] - Information about the cloud disks attached to the instance.
- zone
Id string - Availability zone ID where the elastic reservation order is located.
- description str
- Description of the instance.
- eip_
address GetScheduled Instance Instance Config Eip Address - Public IP information bound to the instance.
- host_
name str - Instance hostname.
- hpc_
cluster_ strid - High performance computing cluster ID.
- image_
id str - Image ID
- instance_
name str - Instance name.
- instance_
type_ strid - Instance type.
- key_
pair_ strname - Key pair name.
- network_
interfaces Sequence[GetScheduled Instance Instance Config Network Interface] - Network interface information attached to the instance.
- project_
name str - Project to which the instance belongs.
-
Sequence[Get
Scheduled Instance Instance Config Tag] - Tag information for the instance.
- volumes
Sequence[Get
Scheduled Instance Instance Config Volume] - 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.
- eip
Address Property Map - Public IP information bound to the instance.
- host
Name String - Instance hostname.
- hpc
Cluster StringId - High performance computing cluster ID.
- image
Id String - Image ID
- instance
Name String - Instance name.
- instance
Type StringId - Instance type.
- key
Pair StringName - Key pair name.
- network
Interfaces List<Property Map> - Network interface information attached to the instance.
- project
Name String - Project to which the instance belongs.
- List<Property Map>
- Tag information for the instance.
- volumes List<Property Map>
- Information about the cloud disks attached to the instance.
- zone
Id String - Availability zone ID where the elastic reservation order is located.
GetScheduledInstanceInstanceConfigEipAddress
- Bandwidth
Mbps int - Maximum bandwidth for the public IP, in Mbps
- Default: 1
- Value range:
- If
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - Bandwidth
Package stringId - 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 boolInstance - 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 stringInstance Id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - Security
Protection List<string>Types - 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
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - Bandwidth
Package stringId - 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 boolInstance - 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 stringInstance Id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - Security
Protection []stringTypes - 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
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - bandwidth_
package_ stringid - 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_ boolinstance - 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_ stringinstance_ id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - security_
protection_ list(string)types - 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 Integer - Maximum bandwidth for the public IP, in Mbps
- Default: 1
- Value range:
- If
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - bandwidth
Package StringId - 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 BooleanInstance - 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 StringInstance Id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - security
Protection List<String>Types - 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
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - bandwidth
Package stringId - 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 booleanInstance - 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 stringInstance Id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - security
Protection string[]Types - 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
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - bandwidth_
package_ strid - 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_ boolinstance - 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_ strinstance_ id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - security_
protection_ Sequence[str]types - 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
ChargeTypeisPayByBandwidth: 1–500 - IfChargeTypeisPayByTraffic: 1–200 - bandwidth
Package StringId - 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 BooleanInstance - 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 StringInstance Id - ID of the bound security protection package. This parameter is returned only when
SecurityProtectionTypesis not empty. - security
Protection List<String>Types - 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
- Security
Group List<string>Ids - Security group ID associated with the network interface.
- Subnet
Id string - Private network subnet ID of the instance.
- Security
Group []stringIds - Security group ID associated with the network interface.
- Subnet
Id string - Private network subnet ID of the instance.
- security_
group_ list(string)ids - Security group ID associated with the network interface.
- subnet_
id string - Private network subnet ID of the instance.
- security
Group List<String>Ids - Security group ID associated with the network interface.
- subnet
Id String - Private network subnet ID of the instance.
- security
Group string[]Ids - Security group ID associated with the network interface.
- subnet
Id string - Private network subnet ID of the instance.
- security_
group_ Sequence[str]ids - Security group ID associated with the network interface.
- subnet_
id str - Private network subnet ID of the instance.
- security
Group List<String>Ids - Security group ID associated with the network interface.
- subnet
Id String - Private network subnet ID of the instance.
GetScheduledInstanceInstanceConfigTag
GetScheduledInstanceInstanceConfigVolume
- Kind string
- Disk type. Values: - system: System disk - data: Data disk
- Size int
- 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 int
- 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 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.
- 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 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 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.
- volume
Type String - Cloud disk type. Values: - ESSD_PL0: Ultra-fast SSD PL0 - ESSD_FlexPL: Ultra-fast SSD FlexPL
GetScheduledInstanceNetworkInterface
- Primary
Ip stringAddress - 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 List<string>Addresses - 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 List<string>Ids - 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
- Primary
Ip stringAddress - 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 []stringAddresses - 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 []stringIds - 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
- primary_
ip_ stringaddress - 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_ list(string)addresses - 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_ list(string)ids - 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
- primary
Ip StringAddress - 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 List<String>Addresses - 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 List<String>Ids - 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
- primary
Ip stringAddress - 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 string[]Addresses - 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 string[]Ids - 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
- primary_
ip_ straddress - 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_ Sequence[str]addresses - 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_ Sequence[str]ids - 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
- primary
Ip StringAddress - 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 List<String>Addresses - 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 List<String>Ids - 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
GetScheduledInstanceTag
GetScheduledInstanceVolume
- Delete
With boolInstance - 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 intIops 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
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - 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 intThroughput Mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. 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 stringType Id 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–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis 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.
- Delete
With boolInstance - 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 intIops 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
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - 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 intThroughput Mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. 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 stringType Id 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–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis 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.
- delete_
with_ boolinstance - 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_ numberiops 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
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - 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_ numberthroughput_ mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. 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_ stringtype_ id 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–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis 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.
- delete
With BooleanInstance - 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 IntegerIops 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
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - 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 IntegerThroughput Mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. 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 StringType Id 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–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis 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.
- delete
With booleanInstance - 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 numberIops 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
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - 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 numberThroughput Mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. 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 stringType Id 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–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis 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.
- delete_
with_ boolinstance - 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_ intiops 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
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - 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_ intthroughput_ mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. 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_ strtype_ id 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–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis 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.
- delete
With BooleanInstance - 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 NumberIops 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
ExtraPerformanceTypeIdisBalanceorIOPS. The value ranges for each type are as follows: - IOPS type: 1–50000 - Balance type: 1–50000Note: - 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 NumberThroughput Mb - Extra disk throughput performance in MB/s. Supported only by ESSD FlexPL data disks. Set this parameter when
ExtraPerformanceTypeIdisThroughput. 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 StringType Id 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–32768Note: If this parameter is not specified, the snapshot size corresponding to
Volumes.N.SnapshotIdis used as the data disk capacity. IfVolumes.N.SnapshotIdis 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.
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
published on Thursday, Sep 3, 2026 by Volcengine