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

volcenginecc.ecs.getInstance

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

    Data Source schema for Volcengine::ECS::Instance

    Using getInstance

    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 getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
    def get_instance(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
    func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

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

    public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:ecs/getInstance:getInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

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

    getInstance Result

    The following output properties are available:

    AffinityGroupId string
    AffinityGroupSize int
    AutoPay bool
    AutoRenew bool
    AutoRenewPeriod int
    CpuMaxFrequency double
    CpuMemory Volcengine.GetInstanceCpuMemory
    CreatedAt string
    CreditSpecification string
    DeletionProtection bool
    DeploymentSetGroupNumber int
    DeploymentSetId string
    Description string
    EipAddress Volcengine.GetInstanceEipAddress
    ElasticScheduledInstanceType string
    EnableJumboFrame bool
    ExpiredAt string
    Hostname string
    HpcClusterId string
    Id string
    Image Volcengine.GetInstanceImage
    IncludeDataVolumes bool
    InstallRunCommandAgent bool
    InstanceChargeType string
    InstanceId string
    InstanceName string
    InstanceType string
    KeyPair Volcengine.GetInstanceKeyPair
    LocalVolumes List<Volcengine.GetInstanceLocalVolume>
    OperationSystem Volcengine.GetInstanceOperationSystem
    Password string
    Period int
    PeriodUnit string
    Placement Volcengine.GetInstancePlacement
    PrimaryNetworkInterface Volcengine.GetInstancePrimaryNetworkInterface
    ProjectName string
    RdmaIpAddresses List<string>
    RdmaNetworkInterfaceDetails List<Volcengine.GetInstanceRdmaNetworkInterfaceDetail>
    RenewInfo Volcengine.GetInstanceRenewInfo
    RoleNames List<string>
    SecondaryNetworkInterfaces List<Volcengine.GetInstanceSecondaryNetworkInterface>
    SpotPriceLimit double
    SpotStrategy string
    Status string
    StoppedMode string
    SystemVolume Volcengine.GetInstanceSystemVolume
    Tags List<Volcengine.GetInstanceTag>
    UpdatedAt string
    UserData string
    VpcId string
    ZoneId string
    AffinityGroupId string
    AffinityGroupSize int
    AutoPay bool
    AutoRenew bool
    AutoRenewPeriod int
    CpuMaxFrequency float64
    CpuMemory GetInstanceCpuMemory
    CreatedAt string
    CreditSpecification string
    DeletionProtection bool
    DeploymentSetGroupNumber int
    DeploymentSetId string
    Description string
    EipAddress GetInstanceEipAddress
    ElasticScheduledInstanceType string
    EnableJumboFrame bool
    ExpiredAt string
    Hostname string
    HpcClusterId string
    Id string
    Image GetInstanceImage
    IncludeDataVolumes bool
    InstallRunCommandAgent bool
    InstanceChargeType string
    InstanceId string
    InstanceName string
    InstanceType string
    KeyPair GetInstanceKeyPair
    LocalVolumes []GetInstanceLocalVolume
    OperationSystem GetInstanceOperationSystem
    Password string
    Period int
    PeriodUnit string
    Placement GetInstancePlacement
    PrimaryNetworkInterface GetInstancePrimaryNetworkInterface
    ProjectName string
    RdmaIpAddresses []string
    RdmaNetworkInterfaceDetails []GetInstanceRdmaNetworkInterfaceDetail
    RenewInfo GetInstanceRenewInfo
    RoleNames []string
    SecondaryNetworkInterfaces []GetInstanceSecondaryNetworkInterface
    SpotPriceLimit float64
    SpotStrategy string
    Status string
    StoppedMode string
    SystemVolume GetInstanceSystemVolume
    Tags []GetInstanceTag
    UpdatedAt string
    UserData string
    VpcId string
    ZoneId string
    affinityGroupId String
    affinityGroupSize Integer
    autoPay Boolean
    autoRenew Boolean
    autoRenewPeriod Integer
    cpuMaxFrequency Double
    cpuMemory GetInstanceCpuMemory
    createdAt String
    creditSpecification String
    deletionProtection Boolean
    deploymentSetGroupNumber Integer
    deploymentSetId String
    description String
    eipAddress GetInstanceEipAddress
    elasticScheduledInstanceType String
    enableJumboFrame Boolean
    expiredAt String
    hostname String
    hpcClusterId String
    id String
    image GetInstanceImage
    includeDataVolumes Boolean
    installRunCommandAgent Boolean
    instanceChargeType String
    instanceId String
    instanceName String
    instanceType String
    keyPair GetInstanceKeyPair
    localVolumes List<GetInstanceLocalVolume>
    operationSystem GetInstanceOperationSystem
    password String
    period Integer
    periodUnit String
    placement GetInstancePlacement
    primaryNetworkInterface GetInstancePrimaryNetworkInterface
    projectName String
    rdmaIpAddresses List<String>
    rdmaNetworkInterfaceDetails List<GetInstanceRdmaNetworkInterfaceDetail>
    renewInfo GetInstanceRenewInfo
    roleNames List<String>
    secondaryNetworkInterfaces List<GetInstanceSecondaryNetworkInterface>
    spotPriceLimit Double
    spotStrategy String
    status String
    stoppedMode String
    systemVolume GetInstanceSystemVolume
    tags List<GetInstanceTag>
    updatedAt String
    userData String
    vpcId String
    zoneId String
    affinityGroupId string
    affinityGroupSize number
    autoPay boolean
    autoRenew boolean
    autoRenewPeriod number
    cpuMaxFrequency number
    cpuMemory GetInstanceCpuMemory
    createdAt string
    creditSpecification string
    deletionProtection boolean
    deploymentSetGroupNumber number
    deploymentSetId string
    description string
    eipAddress GetInstanceEipAddress
    elasticScheduledInstanceType string
    enableJumboFrame boolean
    expiredAt string
    hostname string
    hpcClusterId string
    id string
    image GetInstanceImage
    includeDataVolumes boolean
    installRunCommandAgent boolean
    instanceChargeType string
    instanceId string
    instanceName string
    instanceType string
    keyPair GetInstanceKeyPair
    localVolumes GetInstanceLocalVolume[]
    operationSystem GetInstanceOperationSystem
    password string
    period number
    periodUnit string
    placement GetInstancePlacement
    primaryNetworkInterface GetInstancePrimaryNetworkInterface
    projectName string
    rdmaIpAddresses string[]
    rdmaNetworkInterfaceDetails GetInstanceRdmaNetworkInterfaceDetail[]
    renewInfo GetInstanceRenewInfo
    roleNames string[]
    secondaryNetworkInterfaces GetInstanceSecondaryNetworkInterface[]
    spotPriceLimit number
    spotStrategy string
    status string
    stoppedMode string
    systemVolume GetInstanceSystemVolume
    tags GetInstanceTag[]
    updatedAt string
    userData string
    vpcId string
    zoneId string
    affinity_group_id str
    affinity_group_size int
    auto_pay bool
    auto_renew bool
    auto_renew_period int
    cpu_max_frequency float
    cpu_memory GetInstanceCpuMemory
    created_at str
    credit_specification str
    deletion_protection bool
    deployment_set_group_number int
    deployment_set_id str
    description str
    eip_address GetInstanceEipAddress
    elastic_scheduled_instance_type str
    enable_jumbo_frame bool
    expired_at str
    hostname str
    hpc_cluster_id str
    id str
    image GetInstanceImage
    include_data_volumes bool
    install_run_command_agent bool
    instance_charge_type str
    instance_id str
    instance_name str
    instance_type str
    key_pair GetInstanceKeyPair
    local_volumes Sequence[GetInstanceLocalVolume]
    operation_system GetInstanceOperationSystem
    password str
    period int
    period_unit str
    placement GetInstancePlacement
    primary_network_interface GetInstancePrimaryNetworkInterface
    project_name str
    rdma_ip_addresses Sequence[str]
    rdma_network_interface_details Sequence[GetInstanceRdmaNetworkInterfaceDetail]
    renew_info GetInstanceRenewInfo
    role_names Sequence[str]
    secondary_network_interfaces Sequence[GetInstanceSecondaryNetworkInterface]
    spot_price_limit float
    spot_strategy str
    status str
    stopped_mode str
    system_volume GetInstanceSystemVolume
    tags Sequence[GetInstanceTag]
    updated_at str
    user_data str
    vpc_id str
    zone_id str
    affinityGroupId String
    affinityGroupSize Number
    autoPay Boolean
    autoRenew Boolean
    autoRenewPeriod Number
    cpuMaxFrequency Number
    cpuMemory Property Map
    createdAt String
    creditSpecification String
    deletionProtection Boolean
    deploymentSetGroupNumber Number
    deploymentSetId String
    description String
    eipAddress Property Map
    elasticScheduledInstanceType String
    enableJumboFrame Boolean
    expiredAt String
    hostname String
    hpcClusterId String
    id String
    image Property Map
    includeDataVolumes Boolean
    installRunCommandAgent Boolean
    instanceChargeType String
    instanceId String
    instanceName String
    instanceType String
    keyPair Property Map
    localVolumes List<Property Map>
    operationSystem Property Map
    password String
    period Number
    periodUnit String
    placement Property Map
    primaryNetworkInterface Property Map
    projectName String
    rdmaIpAddresses List<String>
    rdmaNetworkInterfaceDetails List<Property Map>
    renewInfo Property Map
    roleNames List<String>
    secondaryNetworkInterfaces List<Property Map>
    spotPriceLimit Number
    spotStrategy String
    status String
    stoppedMode String
    systemVolume Property Map
    tags List<Property Map>
    updatedAt String
    userData String
    vpcId String
    zoneId String

    Supporting Types

    GetInstanceCpuMemory

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

    GetInstanceEipAddress

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    GetInstanceImage

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

    GetInstanceKeyPair

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

    GetInstanceLocalVolume

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

    GetInstanceOperationSystem

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

    GetInstancePlacement

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

    GetInstancePrimaryNetworkInterface

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

    GetInstanceRdmaNetworkInterfaceDetail

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

    GetInstanceRenewInfo

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

    GetInstanceSecondaryNetworkInterface

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

    GetInstanceSystemVolume

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

    GetInstanceTag

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

    Package Details

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