1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. escloud
  6. getInstance
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    Data Source schema for Volcengine::ESCloud::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:escloud/getInstance:getInstance
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getInstance Result

    The following output properties are available:

    CerebroEnabled bool
    Whether to enable cerebro. true: enable cerebro; false: do not enable cerebro.
    CerebroPrivateDomain string
    Cerebro private network access address. Note: Cerebro and Kibana share the domain name. For legacy instances, the access address may start with http(s)://kibana-***
    CerebroPublicDomain string
    Cerebro public access address. Note: Cerebro and Kibana share the same domain name. For legacy instances, the access address may start with http(s)://kibana-***
    ChargeEnabled bool
    Whether billing is enabled for the instance. Value description: true: Billing enabled false: Billing not enabled
    ClusterId string
    ID of the cluster to which the instance belongs.
    CreateTime string
    Instance creation time.
    EnableEsPrivateDomainPublic bool
    Whether the instance has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses
    EnableEsPrivateNetwork bool
    Whether private network access is enabled for the instance. true: Default, private network access enabled; false: private network access not enabled.
    EnableEsPublicNetwork bool
    Whether the instance has enabled public access. true: Public access enabled. false: Public access not enabled
    EnableKibanaPrivateDomainPublic bool
    Whether Kibana has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses
    EnableKibanaPrivateNetwork bool
    Whether Kibana private network access is enabled. true: Default value, private network access enabled false: Kibana private network access not enabled
    EnableKibanaPublicNetwork bool
    Whether Kibana has enabled public access. true: Public access enabled false: Public access not enabled
    EsEip string
    EIP bound to the instance.
    EsEipId string
    ID of the EIP bound to the instance
    EsPrivateEndpoint string
    Instance private network access address.
    EsPrivateIpAllowList string
    Instance private network address access allowlist. Same as ESPrivateIpWhitelist
    EsPrivateIpWhitelist string
    Instance private network address access allowlist
    EsPubBandwidth int
    ES public network bandwidth, unit: Mbps.
    EsPublicEndpoint string
    Instance public access address
    EsPublicIpAllowList string
    Instance public IP address access allowlist. Same as ESPublicIpWhitelist
    EsPublicIpWhitelist string
    Allowlist for instance public network address access.
    ExpireDate string
    Expiration time for subscription instance payment
    Id string
    Uniquely identifies the resource.
    InstanceConfiguration Volcengine.GetInstanceInstanceConfiguration
    Instance configuration details
    InstanceId string
    Instance ID
    KibanaConfig Volcengine.GetInstanceKibanaConfig
    Kibana parameter configuration
    KibanaEip string
    EIP bound to Kibana
    KibanaEipId string
    ID of the EIP bound to Kibana.
    KibanaPrivateDomain string
    Kibana private network access address. Note: For historical instances, the access address may start with http(s)://kibana-***.
    KibanaPrivateIpAllowList string
    Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPrivateIpWhitelist.
    KibanaPrivateIpWhitelist string
    Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist.
    KibanaPubBandwidth int
    Kibana public network bandwidth, unit: Mbps
    KibanaPublicDomain string
    Kibana public access address. Note: For legacy instances, the access address may start with http(s)://kibana-***
    KibanaPublicIpAllowList string
    Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPublicIpWhitelist
    KibanaPublicIpWhitelist string
    Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist
    MainZoneId string
    Primary availability zone
    MaintenanceDays List<string>
    Instance maintenance date.
    MaintenanceTime string
    Instance maintenance window.
    Status string
    Current instance status
    SubInstanceEnable string
    Sub-instance activation status
    SubInstances List<Volcengine.GetInstanceSubInstance>
    Enterprise SQL analytics instance configuration information
    SupportColdNode bool
    Whether cold nodes are supported
    TotalNodes int
    Total number of nodes in the instance
    TransferInfo Volcengine.GetInstanceTransferInfo
    Data migration task information
    UserId string
    Instance owner's user ID
    CerebroEnabled bool
    Whether to enable cerebro. true: enable cerebro; false: do not enable cerebro.
    CerebroPrivateDomain string
    Cerebro private network access address. Note: Cerebro and Kibana share the domain name. For legacy instances, the access address may start with http(s)://kibana-***
    CerebroPublicDomain string
    Cerebro public access address. Note: Cerebro and Kibana share the same domain name. For legacy instances, the access address may start with http(s)://kibana-***
    ChargeEnabled bool
    Whether billing is enabled for the instance. Value description: true: Billing enabled false: Billing not enabled
    ClusterId string
    ID of the cluster to which the instance belongs.
    CreateTime string
    Instance creation time.
    EnableEsPrivateDomainPublic bool
    Whether the instance has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses
    EnableEsPrivateNetwork bool
    Whether private network access is enabled for the instance. true: Default, private network access enabled; false: private network access not enabled.
    EnableEsPublicNetwork bool
    Whether the instance has enabled public access. true: Public access enabled. false: Public access not enabled
    EnableKibanaPrivateDomainPublic bool
    Whether Kibana has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses
    EnableKibanaPrivateNetwork bool
    Whether Kibana private network access is enabled. true: Default value, private network access enabled false: Kibana private network access not enabled
    EnableKibanaPublicNetwork bool
    Whether Kibana has enabled public access. true: Public access enabled false: Public access not enabled
    EsEip string
    EIP bound to the instance.
    EsEipId string
    ID of the EIP bound to the instance
    EsPrivateEndpoint string
    Instance private network access address.
    EsPrivateIpAllowList string
    Instance private network address access allowlist. Same as ESPrivateIpWhitelist
    EsPrivateIpWhitelist string
    Instance private network address access allowlist
    EsPubBandwidth int
    ES public network bandwidth, unit: Mbps.
    EsPublicEndpoint string
    Instance public access address
    EsPublicIpAllowList string
    Instance public IP address access allowlist. Same as ESPublicIpWhitelist
    EsPublicIpWhitelist string
    Allowlist for instance public network address access.
    ExpireDate string
    Expiration time for subscription instance payment
    Id string
    Uniquely identifies the resource.
    InstanceConfiguration GetInstanceInstanceConfiguration
    Instance configuration details
    InstanceId string
    Instance ID
    KibanaConfig GetInstanceKibanaConfig
    Kibana parameter configuration
    KibanaEip string
    EIP bound to Kibana
    KibanaEipId string
    ID of the EIP bound to Kibana.
    KibanaPrivateDomain string
    Kibana private network access address. Note: For historical instances, the access address may start with http(s)://kibana-***.
    KibanaPrivateIpAllowList string
    Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPrivateIpWhitelist.
    KibanaPrivateIpWhitelist string
    Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist.
    KibanaPubBandwidth int
    Kibana public network bandwidth, unit: Mbps
    KibanaPublicDomain string
    Kibana public access address. Note: For legacy instances, the access address may start with http(s)://kibana-***
    KibanaPublicIpAllowList string
    Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPublicIpWhitelist
    KibanaPublicIpWhitelist string
    Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist
    MainZoneId string
    Primary availability zone
    MaintenanceDays []string
    Instance maintenance date.
    MaintenanceTime string
    Instance maintenance window.
    Status string
    Current instance status
    SubInstanceEnable string
    Sub-instance activation status
    SubInstances []GetInstanceSubInstance
    Enterprise SQL analytics instance configuration information
    SupportColdNode bool
    Whether cold nodes are supported
    TotalNodes int
    Total number of nodes in the instance
    TransferInfo GetInstanceTransferInfo
    Data migration task information
    UserId string
    Instance owner's user ID
    cerebroEnabled Boolean
    Whether to enable cerebro. true: enable cerebro; false: do not enable cerebro.
    cerebroPrivateDomain String
    Cerebro private network access address. Note: Cerebro and Kibana share the domain name. For legacy instances, the access address may start with http(s)://kibana-***
    cerebroPublicDomain String
    Cerebro public access address. Note: Cerebro and Kibana share the same domain name. For legacy instances, the access address may start with http(s)://kibana-***
    chargeEnabled Boolean
    Whether billing is enabled for the instance. Value description: true: Billing enabled false: Billing not enabled
    clusterId String
    ID of the cluster to which the instance belongs.
    createTime String
    Instance creation time.
    enableEsPrivateDomainPublic Boolean
    Whether the instance has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses
    enableEsPrivateNetwork Boolean
    Whether private network access is enabled for the instance. true: Default, private network access enabled; false: private network access not enabled.
    enableEsPublicNetwork Boolean
    Whether the instance has enabled public access. true: Public access enabled. false: Public access not enabled
    enableKibanaPrivateDomainPublic Boolean
    Whether Kibana has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses
    enableKibanaPrivateNetwork Boolean
    Whether Kibana private network access is enabled. true: Default value, private network access enabled false: Kibana private network access not enabled
    enableKibanaPublicNetwork Boolean
    Whether Kibana has enabled public access. true: Public access enabled false: Public access not enabled
    esEip String
    EIP bound to the instance.
    esEipId String
    ID of the EIP bound to the instance
    esPrivateEndpoint String
    Instance private network access address.
    esPrivateIpAllowList String
    Instance private network address access allowlist. Same as ESPrivateIpWhitelist
    esPrivateIpWhitelist String
    Instance private network address access allowlist
    esPubBandwidth Integer
    ES public network bandwidth, unit: Mbps.
    esPublicEndpoint String
    Instance public access address
    esPublicIpAllowList String
    Instance public IP address access allowlist. Same as ESPublicIpWhitelist
    esPublicIpWhitelist String
    Allowlist for instance public network address access.
    expireDate String
    Expiration time for subscription instance payment
    id String
    Uniquely identifies the resource.
    instanceConfiguration GetInstanceInstanceConfiguration
    Instance configuration details
    instanceId String
    Instance ID
    kibanaConfig GetInstanceKibanaConfig
    Kibana parameter configuration
    kibanaEip String
    EIP bound to Kibana
    kibanaEipId String
    ID of the EIP bound to Kibana.
    kibanaPrivateDomain String
    Kibana private network access address. Note: For historical instances, the access address may start with http(s)://kibana-***.
    kibanaPrivateIpAllowList String
    Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPrivateIpWhitelist.
    kibanaPrivateIpWhitelist String
    Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist.
    kibanaPubBandwidth Integer
    Kibana public network bandwidth, unit: Mbps
    kibanaPublicDomain String
    Kibana public access address. Note: For legacy instances, the access address may start with http(s)://kibana-***
    kibanaPublicIpAllowList String
    Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPublicIpWhitelist
    kibanaPublicIpWhitelist String
    Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist
    mainZoneId String
    Primary availability zone
    maintenanceDays List<String>
    Instance maintenance date.
    maintenanceTime String
    Instance maintenance window.
    status String
    Current instance status
    subInstanceEnable String
    Sub-instance activation status
    subInstances List<GetInstanceSubInstance>
    Enterprise SQL analytics instance configuration information
    supportColdNode Boolean
    Whether cold nodes are supported
    totalNodes Integer
    Total number of nodes in the instance
    transferInfo GetInstanceTransferInfo
    Data migration task information
    userId String
    Instance owner's user ID
    cerebroEnabled boolean
    Whether to enable cerebro. true: enable cerebro; false: do not enable cerebro.
    cerebroPrivateDomain string
    Cerebro private network access address. Note: Cerebro and Kibana share the domain name. For legacy instances, the access address may start with http(s)://kibana-***
    cerebroPublicDomain string
    Cerebro public access address. Note: Cerebro and Kibana share the same domain name. For legacy instances, the access address may start with http(s)://kibana-***
    chargeEnabled boolean
    Whether billing is enabled for the instance. Value description: true: Billing enabled false: Billing not enabled
    clusterId string
    ID of the cluster to which the instance belongs.
    createTime string
    Instance creation time.
    enableEsPrivateDomainPublic boolean
    Whether the instance has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses
    enableEsPrivateNetwork boolean
    Whether private network access is enabled for the instance. true: Default, private network access enabled; false: private network access not enabled.
    enableEsPublicNetwork boolean
    Whether the instance has enabled public access. true: Public access enabled. false: Public access not enabled
    enableKibanaPrivateDomainPublic boolean
    Whether Kibana has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses
    enableKibanaPrivateNetwork boolean
    Whether Kibana private network access is enabled. true: Default value, private network access enabled false: Kibana private network access not enabled
    enableKibanaPublicNetwork boolean
    Whether Kibana has enabled public access. true: Public access enabled false: Public access not enabled
    esEip string
    EIP bound to the instance.
    esEipId string
    ID of the EIP bound to the instance
    esPrivateEndpoint string
    Instance private network access address.
    esPrivateIpAllowList string
    Instance private network address access allowlist. Same as ESPrivateIpWhitelist
    esPrivateIpWhitelist string
    Instance private network address access allowlist
    esPubBandwidth number
    ES public network bandwidth, unit: Mbps.
    esPublicEndpoint string
    Instance public access address
    esPublicIpAllowList string
    Instance public IP address access allowlist. Same as ESPublicIpWhitelist
    esPublicIpWhitelist string
    Allowlist for instance public network address access.
    expireDate string
    Expiration time for subscription instance payment
    id string
    Uniquely identifies the resource.
    instanceConfiguration GetInstanceInstanceConfiguration
    Instance configuration details
    instanceId string
    Instance ID
    kibanaConfig GetInstanceKibanaConfig
    Kibana parameter configuration
    kibanaEip string
    EIP bound to Kibana
    kibanaEipId string
    ID of the EIP bound to Kibana.
    kibanaPrivateDomain string
    Kibana private network access address. Note: For historical instances, the access address may start with http(s)://kibana-***.
    kibanaPrivateIpAllowList string
    Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPrivateIpWhitelist.
    kibanaPrivateIpWhitelist string
    Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist.
    kibanaPubBandwidth number
    Kibana public network bandwidth, unit: Mbps
    kibanaPublicDomain string
    Kibana public access address. Note: For legacy instances, the access address may start with http(s)://kibana-***
    kibanaPublicIpAllowList string
    Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPublicIpWhitelist
    kibanaPublicIpWhitelist string
    Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist
    mainZoneId string
    Primary availability zone
    maintenanceDays string[]
    Instance maintenance date.
    maintenanceTime string
    Instance maintenance window.
    status string
    Current instance status
    subInstanceEnable string
    Sub-instance activation status
    subInstances GetInstanceSubInstance[]
    Enterprise SQL analytics instance configuration information
    supportColdNode boolean
    Whether cold nodes are supported
    totalNodes number
    Total number of nodes in the instance
    transferInfo GetInstanceTransferInfo
    Data migration task information
    userId string
    Instance owner's user ID
    cerebro_enabled bool
    Whether to enable cerebro. true: enable cerebro; false: do not enable cerebro.
    cerebro_private_domain str
    Cerebro private network access address. Note: Cerebro and Kibana share the domain name. For legacy instances, the access address may start with http(s)://kibana-***
    cerebro_public_domain str
    Cerebro public access address. Note: Cerebro and Kibana share the same domain name. For legacy instances, the access address may start with http(s)://kibana-***
    charge_enabled bool
    Whether billing is enabled for the instance. Value description: true: Billing enabled false: Billing not enabled
    cluster_id str
    ID of the cluster to which the instance belongs.
    create_time str
    Instance creation time.
    enable_es_private_domain_public bool
    Whether the instance has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses
    enable_es_private_network bool
    Whether private network access is enabled for the instance. true: Default, private network access enabled; false: private network access not enabled.
    enable_es_public_network bool
    Whether the instance has enabled public access. true: Public access enabled. false: Public access not enabled
    enable_kibana_private_domain_public bool
    Whether Kibana has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses
    enable_kibana_private_network bool
    Whether Kibana private network access is enabled. true: Default value, private network access enabled false: Kibana private network access not enabled
    enable_kibana_public_network bool
    Whether Kibana has enabled public access. true: Public access enabled false: Public access not enabled
    es_eip str
    EIP bound to the instance.
    es_eip_id str
    ID of the EIP bound to the instance
    es_private_endpoint str
    Instance private network access address.
    es_private_ip_allow_list str
    Instance private network address access allowlist. Same as ESPrivateIpWhitelist
    es_private_ip_whitelist str
    Instance private network address access allowlist
    es_pub_bandwidth int
    ES public network bandwidth, unit: Mbps.
    es_public_endpoint str
    Instance public access address
    es_public_ip_allow_list str
    Instance public IP address access allowlist. Same as ESPublicIpWhitelist
    es_public_ip_whitelist str
    Allowlist for instance public network address access.
    expire_date str
    Expiration time for subscription instance payment
    id str
    Uniquely identifies the resource.
    instance_configuration GetInstanceInstanceConfiguration
    Instance configuration details
    instance_id str
    Instance ID
    kibana_config GetInstanceKibanaConfig
    Kibana parameter configuration
    kibana_eip str
    EIP bound to Kibana
    kibana_eip_id str
    ID of the EIP bound to Kibana.
    kibana_private_domain str
    Kibana private network access address. Note: For historical instances, the access address may start with http(s)://kibana-***.
    kibana_private_ip_allow_list str
    Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPrivateIpWhitelist.
    kibana_private_ip_whitelist str
    Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist.
    kibana_pub_bandwidth int
    Kibana public network bandwidth, unit: Mbps
    kibana_public_domain str
    Kibana public access address. Note: For legacy instances, the access address may start with http(s)://kibana-***
    kibana_public_ip_allow_list str
    Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPublicIpWhitelist
    kibana_public_ip_whitelist str
    Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist
    main_zone_id str
    Primary availability zone
    maintenance_days Sequence[str]
    Instance maintenance date.
    maintenance_time str
    Instance maintenance window.
    status str
    Current instance status
    sub_instance_enable str
    Sub-instance activation status
    sub_instances Sequence[GetInstanceSubInstance]
    Enterprise SQL analytics instance configuration information
    support_cold_node bool
    Whether cold nodes are supported
    total_nodes int
    Total number of nodes in the instance
    transfer_info GetInstanceTransferInfo
    Data migration task information
    user_id str
    Instance owner's user ID
    cerebroEnabled Boolean
    Whether to enable cerebro. true: enable cerebro; false: do not enable cerebro.
    cerebroPrivateDomain String
    Cerebro private network access address. Note: Cerebro and Kibana share the domain name. For legacy instances, the access address may start with http(s)://kibana-***
    cerebroPublicDomain String
    Cerebro public access address. Note: Cerebro and Kibana share the same domain name. For legacy instances, the access address may start with http(s)://kibana-***
    chargeEnabled Boolean
    Whether billing is enabled for the instance. Value description: true: Billing enabled false: Billing not enabled
    clusterId String
    ID of the cluster to which the instance belongs.
    createTime String
    Instance creation time.
    enableEsPrivateDomainPublic Boolean
    Whether the instance has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses
    enableEsPrivateNetwork Boolean
    Whether private network access is enabled for the instance. true: Default, private network access enabled; false: private network access not enabled.
    enableEsPublicNetwork Boolean
    Whether the instance has enabled public access. true: Public access enabled. false: Public access not enabled
    enableKibanaPrivateDomainPublic Boolean
    Whether Kibana has enabled public resolution for private network addresses. true: Public resolution enabled for private network addresses false: Public resolution not enabled for private network addresses
    enableKibanaPrivateNetwork Boolean
    Whether Kibana private network access is enabled. true: Default value, private network access enabled false: Kibana private network access not enabled
    enableKibanaPublicNetwork Boolean
    Whether Kibana has enabled public access. true: Public access enabled false: Public access not enabled
    esEip String
    EIP bound to the instance.
    esEipId String
    ID of the EIP bound to the instance
    esPrivateEndpoint String
    Instance private network access address.
    esPrivateIpAllowList String
    Instance private network address access allowlist. Same as ESPrivateIpWhitelist
    esPrivateIpWhitelist String
    Instance private network address access allowlist
    esPubBandwidth Number
    ES public network bandwidth, unit: Mbps.
    esPublicEndpoint String
    Instance public access address
    esPublicIpAllowList String
    Instance public IP address access allowlist. Same as ESPublicIpWhitelist
    esPublicIpWhitelist String
    Allowlist for instance public network address access.
    expireDate String
    Expiration time for subscription instance payment
    id String
    Uniquely identifies the resource.
    instanceConfiguration Property Map
    Instance configuration details
    instanceId String
    Instance ID
    kibanaConfig Property Map
    Kibana parameter configuration
    kibanaEip String
    EIP bound to Kibana
    kibanaEipId String
    ID of the EIP bound to Kibana.
    kibanaPrivateDomain String
    Kibana private network access address. Note: For historical instances, the access address may start with http(s)://kibana-***.
    kibanaPrivateIpAllowList String
    Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPrivateIpWhitelist.
    kibanaPrivateIpWhitelist String
    Kibana private network allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist.
    kibanaPubBandwidth Number
    Kibana public network bandwidth, unit: Mbps
    kibanaPublicDomain String
    Kibana public access address. Note: For legacy instances, the access address may start with http(s)://kibana-***
    kibanaPublicIpAllowList String
    Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Same as KibanaPublicIpWhitelist
    kibanaPublicIpWhitelist String
    Kibana public allowlist. Only IP addresses added to the allowlist can access the visualization tool. Note: Cerebro and Kibana share the same allowlist
    mainZoneId String
    Primary availability zone
    maintenanceDays List<String>
    Instance maintenance date.
    maintenanceTime String
    Instance maintenance window.
    status String
    Current instance status
    subInstanceEnable String
    Sub-instance activation status
    subInstances List<Property Map>
    Enterprise SQL analytics instance configuration information
    supportColdNode Boolean
    Whether cold nodes are supported
    totalNodes Number
    Total number of nodes in the instance
    transferInfo Property Map
    Data migration task information
    userId String
    Instance owner's user ID

    Supporting Types

    GetInstanceInstanceConfiguration

    AdminPassword string
    Administrator password.
    AdminUserName string
    Administrator username.
    AutoRenew bool
    Whether the subscription instance is set to auto-renewal. true: Auto-renewal; the system will automatically renew the instance before each expiration. false: Auto-renewal is not enabled; manual renewal is required before the instance expires. For more information, see Instance renewal.
    ChargeType string
    Instance billing type. PostPaid: Pay-as-you-go. PrePaid: Subscription
    ColdNodeNumber int
    Number of cold nodes.
    ColdNodeResourceSpec Volcengine.GetInstanceInstanceConfigurationColdNodeResourceSpec
    Node specification details for cold nodes
    ColdNodeStorageSpec Volcengine.GetInstanceInstanceConfigurationColdNodeStorageSpec
    Details of cold node storage specification configuration
    ConfigurationCode string
    Billing configuration code, obtainable via the DescribeNodeAvailableSpecs API.
    CoordinatorNodeNumber int
    Coordinator node count
    CoordinatorNodeResourceSpec Volcengine.GetInstanceInstanceConfigurationCoordinatorNodeResourceSpec
    Node specification configuration details for coordinator node.
    CoordinatorNodeStorageSpec Volcengine.GetInstanceInstanceConfigurationCoordinatorNodeStorageSpec
    Storage specification configuration details for coordinator node.
    DeletionProtection bool
    Enable instance deletion protection. Values: true: Enable instance deletion protection. false: Disable instance deletion protection. Note: After enabling deletion protection, you cannot delete the instance via console or API
    EnableHttps bool
    Enable HTTPS access protocol. true: Enable HTTPS access. false: Disable HTTPS, use HTTP access. Note: If you choose HTTP access, you can access without security authentication and transmit data in plain HTTP. Ensure the security of your access environment and do not expose the API to the public network. After the instance is created, you can modify the transmission protocol as needed. For related documentation, see Switch Instance Transmission Protocol
    EnablePureMaster bool
    Whether the master node is dedicated. true: Master node is dedicated. false: Master node is combined with data node, that is, uses Hot node.
    HotNodeNumber int
    Number of data nodes
    HotNodeResourceSpec Volcengine.GetInstanceInstanceConfigurationHotNodeResourceSpec
    Node specification configuration details for data node.
    HotNodeStorageSpec Volcengine.GetInstanceInstanceConfigurationHotNodeStorageSpec
    Data node storage specification configuration details
    InstanceName string
    Set a custom instance name. Only Chinese characters, letters, numbers, hyphens (-), and underscores (_) are allowed. The name cannot start or end with a number or hyphen (-). Length must be between 1 and 128 characters.
    KibanaNodeNumber int
    Number of Kibana nodes
    KibanaNodeResourceSpec Volcengine.GetInstanceInstanceConfigurationKibanaNodeResourceSpec
    Kibana node specification configuration details
    MasterNodeNumber int
    Number of master nodes.
    MasterNodeResourceSpec Volcengine.GetInstanceInstanceConfigurationMasterNodeResourceSpec
    Master node specification configuration details
    MasterNodeStorageSpec Volcengine.GetInstanceInstanceConfigurationMasterNodeStorageSpec
    Storage specification details for master node
    NetworkSpecs List<Volcengine.GetInstanceInstanceConfigurationNetworkSpec>
    Instance public network specification configuration
    NodeSpecsAssigns List<Volcengine.GetInstanceInstanceConfigurationNodeSpecsAssign>
    Configuration of node counts and specifications in the instance
    Period int
    Subscription instance purchase duration, in months.
    ProjectName string
    Set the project for your cloud search instance as needed to facilitate grouping and management of cloud resources. Projects provide a resource management method that helps maintain resource independence and data security. You can also view resource consumption bills by project, making it easier to calculate cloud resource usage costs. For more information, see Project Overview
    RegionId string
    Instance region
    Subnet Volcengine.GetInstanceInstanceConfigurationSubnet
    Set subnet information for the instance. Note: The subnet must be in the primary zone.
    Tags List<Volcengine.GetInstanceInstanceConfigurationTag>
    Tag information
    Version string
    API version. Value: 2023-01-01.
    Vpc Volcengine.GetInstanceInstanceConfigurationVpc
    Set VPC information for the instance
    WarmNodeNumber int
    Warm node count.
    WarmNodeResourceSpec Volcengine.GetInstanceInstanceConfigurationWarmNodeResourceSpec
    Warm node specification configuration details.
    WarmNodeStorageSpec Volcengine.GetInstanceInstanceConfigurationWarmNodeStorageSpec
    Storage specification details for warm nodes
    ZoneId string
    Zone where the instance is located. Note: For multi-zone deployment, enter multiple ZoneIds separated by commas, e.g., cn-beijing-a,cn-beijing-c. The leftmost ZoneId is the primary zone, others are backup zones.
    ZoneNumber int
    Number of instance availability zones.
    AdminPassword string
    Administrator password.
    AdminUserName string
    Administrator username.
    AutoRenew bool
    Whether the subscription instance is set to auto-renewal. true: Auto-renewal; the system will automatically renew the instance before each expiration. false: Auto-renewal is not enabled; manual renewal is required before the instance expires. For more information, see Instance renewal.
    ChargeType string
    Instance billing type. PostPaid: Pay-as-you-go. PrePaid: Subscription
    ColdNodeNumber int
    Number of cold nodes.
    ColdNodeResourceSpec GetInstanceInstanceConfigurationColdNodeResourceSpec
    Node specification details for cold nodes
    ColdNodeStorageSpec GetInstanceInstanceConfigurationColdNodeStorageSpec
    Details of cold node storage specification configuration
    ConfigurationCode string
    Billing configuration code, obtainable via the DescribeNodeAvailableSpecs API.
    CoordinatorNodeNumber int
    Coordinator node count
    CoordinatorNodeResourceSpec GetInstanceInstanceConfigurationCoordinatorNodeResourceSpec
    Node specification configuration details for coordinator node.
    CoordinatorNodeStorageSpec GetInstanceInstanceConfigurationCoordinatorNodeStorageSpec
    Storage specification configuration details for coordinator node.
    DeletionProtection bool
    Enable instance deletion protection. Values: true: Enable instance deletion protection. false: Disable instance deletion protection. Note: After enabling deletion protection, you cannot delete the instance via console or API
    EnableHttps bool
    Enable HTTPS access protocol. true: Enable HTTPS access. false: Disable HTTPS, use HTTP access. Note: If you choose HTTP access, you can access without security authentication and transmit data in plain HTTP. Ensure the security of your access environment and do not expose the API to the public network. After the instance is created, you can modify the transmission protocol as needed. For related documentation, see Switch Instance Transmission Protocol
    EnablePureMaster bool
    Whether the master node is dedicated. true: Master node is dedicated. false: Master node is combined with data node, that is, uses Hot node.
    HotNodeNumber int
    Number of data nodes
    HotNodeResourceSpec GetInstanceInstanceConfigurationHotNodeResourceSpec
    Node specification configuration details for data node.
    HotNodeStorageSpec GetInstanceInstanceConfigurationHotNodeStorageSpec
    Data node storage specification configuration details
    InstanceName string
    Set a custom instance name. Only Chinese characters, letters, numbers, hyphens (-), and underscores (_) are allowed. The name cannot start or end with a number or hyphen (-). Length must be between 1 and 128 characters.
    KibanaNodeNumber int
    Number of Kibana nodes
    KibanaNodeResourceSpec GetInstanceInstanceConfigurationKibanaNodeResourceSpec
    Kibana node specification configuration details
    MasterNodeNumber int
    Number of master nodes.
    MasterNodeResourceSpec GetInstanceInstanceConfigurationMasterNodeResourceSpec
    Master node specification configuration details
    MasterNodeStorageSpec GetInstanceInstanceConfigurationMasterNodeStorageSpec
    Storage specification details for master node
    NetworkSpecs []GetInstanceInstanceConfigurationNetworkSpec
    Instance public network specification configuration
    NodeSpecsAssigns []GetInstanceInstanceConfigurationNodeSpecsAssign
    Configuration of node counts and specifications in the instance
    Period int
    Subscription instance purchase duration, in months.
    ProjectName string
    Set the project for your cloud search instance as needed to facilitate grouping and management of cloud resources. Projects provide a resource management method that helps maintain resource independence and data security. You can also view resource consumption bills by project, making it easier to calculate cloud resource usage costs. For more information, see Project Overview
    RegionId string
    Instance region
    Subnet GetInstanceInstanceConfigurationSubnet
    Set subnet information for the instance. Note: The subnet must be in the primary zone.
    Tags []GetInstanceInstanceConfigurationTag
    Tag information
    Version string
    API version. Value: 2023-01-01.
    Vpc GetInstanceInstanceConfigurationVpc
    Set VPC information for the instance
    WarmNodeNumber int
    Warm node count.
    WarmNodeResourceSpec GetInstanceInstanceConfigurationWarmNodeResourceSpec
    Warm node specification configuration details.
    WarmNodeStorageSpec GetInstanceInstanceConfigurationWarmNodeStorageSpec
    Storage specification details for warm nodes
    ZoneId string
    Zone where the instance is located. Note: For multi-zone deployment, enter multiple ZoneIds separated by commas, e.g., cn-beijing-a,cn-beijing-c. The leftmost ZoneId is the primary zone, others are backup zones.
    ZoneNumber int
    Number of instance availability zones.
    adminPassword String
    Administrator password.
    adminUserName String
    Administrator username.
    autoRenew Boolean
    Whether the subscription instance is set to auto-renewal. true: Auto-renewal; the system will automatically renew the instance before each expiration. false: Auto-renewal is not enabled; manual renewal is required before the instance expires. For more information, see Instance renewal.
    chargeType String
    Instance billing type. PostPaid: Pay-as-you-go. PrePaid: Subscription
    coldNodeNumber Integer
    Number of cold nodes.
    coldNodeResourceSpec GetInstanceInstanceConfigurationColdNodeResourceSpec
    Node specification details for cold nodes
    coldNodeStorageSpec GetInstanceInstanceConfigurationColdNodeStorageSpec
    Details of cold node storage specification configuration
    configurationCode String
    Billing configuration code, obtainable via the DescribeNodeAvailableSpecs API.
    coordinatorNodeNumber Integer
    Coordinator node count
    coordinatorNodeResourceSpec GetInstanceInstanceConfigurationCoordinatorNodeResourceSpec
    Node specification configuration details for coordinator node.
    coordinatorNodeStorageSpec GetInstanceInstanceConfigurationCoordinatorNodeStorageSpec
    Storage specification configuration details for coordinator node.
    deletionProtection Boolean
    Enable instance deletion protection. Values: true: Enable instance deletion protection. false: Disable instance deletion protection. Note: After enabling deletion protection, you cannot delete the instance via console or API
    enableHttps Boolean
    Enable HTTPS access protocol. true: Enable HTTPS access. false: Disable HTTPS, use HTTP access. Note: If you choose HTTP access, you can access without security authentication and transmit data in plain HTTP. Ensure the security of your access environment and do not expose the API to the public network. After the instance is created, you can modify the transmission protocol as needed. For related documentation, see Switch Instance Transmission Protocol
    enablePureMaster Boolean
    Whether the master node is dedicated. true: Master node is dedicated. false: Master node is combined with data node, that is, uses Hot node.
    hotNodeNumber Integer
    Number of data nodes
    hotNodeResourceSpec GetInstanceInstanceConfigurationHotNodeResourceSpec
    Node specification configuration details for data node.
    hotNodeStorageSpec GetInstanceInstanceConfigurationHotNodeStorageSpec
    Data node storage specification configuration details
    instanceName String
    Set a custom instance name. Only Chinese characters, letters, numbers, hyphens (-), and underscores (_) are allowed. The name cannot start or end with a number or hyphen (-). Length must be between 1 and 128 characters.
    kibanaNodeNumber Integer
    Number of Kibana nodes
    kibanaNodeResourceSpec GetInstanceInstanceConfigurationKibanaNodeResourceSpec
    Kibana node specification configuration details
    masterNodeNumber Integer
    Number of master nodes.
    masterNodeResourceSpec GetInstanceInstanceConfigurationMasterNodeResourceSpec
    Master node specification configuration details
    masterNodeStorageSpec GetInstanceInstanceConfigurationMasterNodeStorageSpec
    Storage specification details for master node
    networkSpecs List<GetInstanceInstanceConfigurationNetworkSpec>
    Instance public network specification configuration
    nodeSpecsAssigns List<GetInstanceInstanceConfigurationNodeSpecsAssign>
    Configuration of node counts and specifications in the instance
    period Integer
    Subscription instance purchase duration, in months.
    projectName String
    Set the project for your cloud search instance as needed to facilitate grouping and management of cloud resources. Projects provide a resource management method that helps maintain resource independence and data security. You can also view resource consumption bills by project, making it easier to calculate cloud resource usage costs. For more information, see Project Overview
    regionId String
    Instance region
    subnet GetInstanceInstanceConfigurationSubnet
    Set subnet information for the instance. Note: The subnet must be in the primary zone.
    tags List<GetInstanceInstanceConfigurationTag>
    Tag information
    version String
    API version. Value: 2023-01-01.
    vpc GetInstanceInstanceConfigurationVpc
    Set VPC information for the instance
    warmNodeNumber Integer
    Warm node count.
    warmNodeResourceSpec GetInstanceInstanceConfigurationWarmNodeResourceSpec
    Warm node specification configuration details.
    warmNodeStorageSpec GetInstanceInstanceConfigurationWarmNodeStorageSpec
    Storage specification details for warm nodes
    zoneId String
    Zone where the instance is located. Note: For multi-zone deployment, enter multiple ZoneIds separated by commas, e.g., cn-beijing-a,cn-beijing-c. The leftmost ZoneId is the primary zone, others are backup zones.
    zoneNumber Integer
    Number of instance availability zones.
    adminPassword string
    Administrator password.
    adminUserName string
    Administrator username.
    autoRenew boolean
    Whether the subscription instance is set to auto-renewal. true: Auto-renewal; the system will automatically renew the instance before each expiration. false: Auto-renewal is not enabled; manual renewal is required before the instance expires. For more information, see Instance renewal.
    chargeType string
    Instance billing type. PostPaid: Pay-as-you-go. PrePaid: Subscription
    coldNodeNumber number
    Number of cold nodes.
    coldNodeResourceSpec GetInstanceInstanceConfigurationColdNodeResourceSpec
    Node specification details for cold nodes
    coldNodeStorageSpec GetInstanceInstanceConfigurationColdNodeStorageSpec
    Details of cold node storage specification configuration
    configurationCode string
    Billing configuration code, obtainable via the DescribeNodeAvailableSpecs API.
    coordinatorNodeNumber number
    Coordinator node count
    coordinatorNodeResourceSpec GetInstanceInstanceConfigurationCoordinatorNodeResourceSpec
    Node specification configuration details for coordinator node.
    coordinatorNodeStorageSpec GetInstanceInstanceConfigurationCoordinatorNodeStorageSpec
    Storage specification configuration details for coordinator node.
    deletionProtection boolean
    Enable instance deletion protection. Values: true: Enable instance deletion protection. false: Disable instance deletion protection. Note: After enabling deletion protection, you cannot delete the instance via console or API
    enableHttps boolean
    Enable HTTPS access protocol. true: Enable HTTPS access. false: Disable HTTPS, use HTTP access. Note: If you choose HTTP access, you can access without security authentication and transmit data in plain HTTP. Ensure the security of your access environment and do not expose the API to the public network. After the instance is created, you can modify the transmission protocol as needed. For related documentation, see Switch Instance Transmission Protocol
    enablePureMaster boolean
    Whether the master node is dedicated. true: Master node is dedicated. false: Master node is combined with data node, that is, uses Hot node.
    hotNodeNumber number
    Number of data nodes
    hotNodeResourceSpec GetInstanceInstanceConfigurationHotNodeResourceSpec
    Node specification configuration details for data node.
    hotNodeStorageSpec GetInstanceInstanceConfigurationHotNodeStorageSpec
    Data node storage specification configuration details
    instanceName string
    Set a custom instance name. Only Chinese characters, letters, numbers, hyphens (-), and underscores (_) are allowed. The name cannot start or end with a number or hyphen (-). Length must be between 1 and 128 characters.
    kibanaNodeNumber number
    Number of Kibana nodes
    kibanaNodeResourceSpec GetInstanceInstanceConfigurationKibanaNodeResourceSpec
    Kibana node specification configuration details
    masterNodeNumber number
    Number of master nodes.
    masterNodeResourceSpec GetInstanceInstanceConfigurationMasterNodeResourceSpec
    Master node specification configuration details
    masterNodeStorageSpec GetInstanceInstanceConfigurationMasterNodeStorageSpec
    Storage specification details for master node
    networkSpecs GetInstanceInstanceConfigurationNetworkSpec[]
    Instance public network specification configuration
    nodeSpecsAssigns GetInstanceInstanceConfigurationNodeSpecsAssign[]
    Configuration of node counts and specifications in the instance
    period number
    Subscription instance purchase duration, in months.
    projectName string
    Set the project for your cloud search instance as needed to facilitate grouping and management of cloud resources. Projects provide a resource management method that helps maintain resource independence and data security. You can also view resource consumption bills by project, making it easier to calculate cloud resource usage costs. For more information, see Project Overview
    regionId string
    Instance region
    subnet GetInstanceInstanceConfigurationSubnet
    Set subnet information for the instance. Note: The subnet must be in the primary zone.
    tags GetInstanceInstanceConfigurationTag[]
    Tag information
    version string
    API version. Value: 2023-01-01.
    vpc GetInstanceInstanceConfigurationVpc
    Set VPC information for the instance
    warmNodeNumber number
    Warm node count.
    warmNodeResourceSpec GetInstanceInstanceConfigurationWarmNodeResourceSpec
    Warm node specification configuration details.
    warmNodeStorageSpec GetInstanceInstanceConfigurationWarmNodeStorageSpec
    Storage specification details for warm nodes
    zoneId string
    Zone where the instance is located. Note: For multi-zone deployment, enter multiple ZoneIds separated by commas, e.g., cn-beijing-a,cn-beijing-c. The leftmost ZoneId is the primary zone, others are backup zones.
    zoneNumber number
    Number of instance availability zones.
    admin_password str
    Administrator password.
    admin_user_name str
    Administrator username.
    auto_renew bool
    Whether the subscription instance is set to auto-renewal. true: Auto-renewal; the system will automatically renew the instance before each expiration. false: Auto-renewal is not enabled; manual renewal is required before the instance expires. For more information, see Instance renewal.
    charge_type str
    Instance billing type. PostPaid: Pay-as-you-go. PrePaid: Subscription
    cold_node_number int
    Number of cold nodes.
    cold_node_resource_spec GetInstanceInstanceConfigurationColdNodeResourceSpec
    Node specification details for cold nodes
    cold_node_storage_spec GetInstanceInstanceConfigurationColdNodeStorageSpec
    Details of cold node storage specification configuration
    configuration_code str
    Billing configuration code, obtainable via the DescribeNodeAvailableSpecs API.
    coordinator_node_number int
    Coordinator node count
    coordinator_node_resource_spec GetInstanceInstanceConfigurationCoordinatorNodeResourceSpec
    Node specification configuration details for coordinator node.
    coordinator_node_storage_spec GetInstanceInstanceConfigurationCoordinatorNodeStorageSpec
    Storage specification configuration details for coordinator node.
    deletion_protection bool
    Enable instance deletion protection. Values: true: Enable instance deletion protection. false: Disable instance deletion protection. Note: After enabling deletion protection, you cannot delete the instance via console or API
    enable_https bool
    Enable HTTPS access protocol. true: Enable HTTPS access. false: Disable HTTPS, use HTTP access. Note: If you choose HTTP access, you can access without security authentication and transmit data in plain HTTP. Ensure the security of your access environment and do not expose the API to the public network. After the instance is created, you can modify the transmission protocol as needed. For related documentation, see Switch Instance Transmission Protocol
    enable_pure_master bool
    Whether the master node is dedicated. true: Master node is dedicated. false: Master node is combined with data node, that is, uses Hot node.
    hot_node_number int
    Number of data nodes
    hot_node_resource_spec GetInstanceInstanceConfigurationHotNodeResourceSpec
    Node specification configuration details for data node.
    hot_node_storage_spec GetInstanceInstanceConfigurationHotNodeStorageSpec
    Data node storage specification configuration details
    instance_name str
    Set a custom instance name. Only Chinese characters, letters, numbers, hyphens (-), and underscores (_) are allowed. The name cannot start or end with a number or hyphen (-). Length must be between 1 and 128 characters.
    kibana_node_number int
    Number of Kibana nodes
    kibana_node_resource_spec GetInstanceInstanceConfigurationKibanaNodeResourceSpec
    Kibana node specification configuration details
    master_node_number int
    Number of master nodes.
    master_node_resource_spec GetInstanceInstanceConfigurationMasterNodeResourceSpec
    Master node specification configuration details
    master_node_storage_spec GetInstanceInstanceConfigurationMasterNodeStorageSpec
    Storage specification details for master node
    network_specs Sequence[GetInstanceInstanceConfigurationNetworkSpec]
    Instance public network specification configuration
    node_specs_assigns Sequence[GetInstanceInstanceConfigurationNodeSpecsAssign]
    Configuration of node counts and specifications in the instance
    period int
    Subscription instance purchase duration, in months.
    project_name str
    Set the project for your cloud search instance as needed to facilitate grouping and management of cloud resources. Projects provide a resource management method that helps maintain resource independence and data security. You can also view resource consumption bills by project, making it easier to calculate cloud resource usage costs. For more information, see Project Overview
    region_id str
    Instance region
    subnet GetInstanceInstanceConfigurationSubnet
    Set subnet information for the instance. Note: The subnet must be in the primary zone.
    tags Sequence[GetInstanceInstanceConfigurationTag]
    Tag information
    version str
    API version. Value: 2023-01-01.
    vpc GetInstanceInstanceConfigurationVpc
    Set VPC information for the instance
    warm_node_number int
    Warm node count.
    warm_node_resource_spec GetInstanceInstanceConfigurationWarmNodeResourceSpec
    Warm node specification configuration details.
    warm_node_storage_spec GetInstanceInstanceConfigurationWarmNodeStorageSpec
    Storage specification details for warm nodes
    zone_id str
    Zone where the instance is located. Note: For multi-zone deployment, enter multiple ZoneIds separated by commas, e.g., cn-beijing-a,cn-beijing-c. The leftmost ZoneId is the primary zone, others are backup zones.
    zone_number int
    Number of instance availability zones.
    adminPassword String
    Administrator password.
    adminUserName String
    Administrator username.
    autoRenew Boolean
    Whether the subscription instance is set to auto-renewal. true: Auto-renewal; the system will automatically renew the instance before each expiration. false: Auto-renewal is not enabled; manual renewal is required before the instance expires. For more information, see Instance renewal.
    chargeType String
    Instance billing type. PostPaid: Pay-as-you-go. PrePaid: Subscription
    coldNodeNumber Number
    Number of cold nodes.
    coldNodeResourceSpec Property Map
    Node specification details for cold nodes
    coldNodeStorageSpec Property Map
    Details of cold node storage specification configuration
    configurationCode String
    Billing configuration code, obtainable via the DescribeNodeAvailableSpecs API.
    coordinatorNodeNumber Number
    Coordinator node count
    coordinatorNodeResourceSpec Property Map
    Node specification configuration details for coordinator node.
    coordinatorNodeStorageSpec Property Map
    Storage specification configuration details for coordinator node.
    deletionProtection Boolean
    Enable instance deletion protection. Values: true: Enable instance deletion protection. false: Disable instance deletion protection. Note: After enabling deletion protection, you cannot delete the instance via console or API
    enableHttps Boolean
    Enable HTTPS access protocol. true: Enable HTTPS access. false: Disable HTTPS, use HTTP access. Note: If you choose HTTP access, you can access without security authentication and transmit data in plain HTTP. Ensure the security of your access environment and do not expose the API to the public network. After the instance is created, you can modify the transmission protocol as needed. For related documentation, see Switch Instance Transmission Protocol
    enablePureMaster Boolean
    Whether the master node is dedicated. true: Master node is dedicated. false: Master node is combined with data node, that is, uses Hot node.
    hotNodeNumber Number
    Number of data nodes
    hotNodeResourceSpec Property Map
    Node specification configuration details for data node.
    hotNodeStorageSpec Property Map
    Data node storage specification configuration details
    instanceName String
    Set a custom instance name. Only Chinese characters, letters, numbers, hyphens (-), and underscores (_) are allowed. The name cannot start or end with a number or hyphen (-). Length must be between 1 and 128 characters.
    kibanaNodeNumber Number
    Number of Kibana nodes
    kibanaNodeResourceSpec Property Map
    Kibana node specification configuration details
    masterNodeNumber Number
    Number of master nodes.
    masterNodeResourceSpec Property Map
    Master node specification configuration details
    masterNodeStorageSpec Property Map
    Storage specification details for master node
    networkSpecs List<Property Map>
    Instance public network specification configuration
    nodeSpecsAssigns List<Property Map>
    Configuration of node counts and specifications in the instance
    period Number
    Subscription instance purchase duration, in months.
    projectName String
    Set the project for your cloud search instance as needed to facilitate grouping and management of cloud resources. Projects provide a resource management method that helps maintain resource independence and data security. You can also view resource consumption bills by project, making it easier to calculate cloud resource usage costs. For more information, see Project Overview
    regionId String
    Instance region
    subnet Property Map
    Set subnet information for the instance. Note: The subnet must be in the primary zone.
    tags List<Property Map>
    Tag information
    version String
    API version. Value: 2023-01-01.
    vpc Property Map
    Set VPC information for the instance
    warmNodeNumber Number
    Warm node count.
    warmNodeResourceSpec Property Map
    Warm node specification configuration details.
    warmNodeStorageSpec Property Map
    Storage specification details for warm nodes
    zoneId String
    Zone where the instance is located. Note: For multi-zone deployment, enter multiple ZoneIds separated by commas, e.g., cn-beijing-a,cn-beijing-c. The leftmost ZoneId is the primary zone, others are backup zones.
    zoneNumber Number
    Number of instance availability zones.

    GetInstanceInstanceConfigurationColdNodeResourceSpec

    Cpu int
    CPU resources for node specification, measured in cores.
    Description string
    Description of node specifications
    DisplayName string
    Display name of node specification.
    Memory int
    Memory capacity for node specification, measured in GiB
    Name string
    Node specification. For details on node specification types and details.
    Cpu int
    CPU resources for node specification, measured in cores.
    Description string
    Description of node specifications
    DisplayName string
    Display name of node specification.
    Memory int
    Memory capacity for node specification, measured in GiB
    Name string
    Node specification. For details on node specification types and details.
    cpu Integer
    CPU resources for node specification, measured in cores.
    description String
    Description of node specifications
    displayName String
    Display name of node specification.
    memory Integer
    Memory capacity for node specification, measured in GiB
    name String
    Node specification. For details on node specification types and details.
    cpu number
    CPU resources for node specification, measured in cores.
    description string
    Description of node specifications
    displayName string
    Display name of node specification.
    memory number
    Memory capacity for node specification, measured in GiB
    name string
    Node specification. For details on node specification types and details.
    cpu int
    CPU resources for node specification, measured in cores.
    description str
    Description of node specifications
    display_name str
    Display name of node specification.
    memory int
    Memory capacity for node specification, measured in GiB
    name str
    Node specification. For details on node specification types and details.
    cpu Number
    CPU resources for node specification, measured in cores.
    description String
    Description of node specifications
    displayName String
    Display name of node specification.
    memory Number
    Memory capacity for node specification, measured in GiB
    name String
    Node specification. For details on node specification types and details.

    GetInstanceInstanceConfigurationColdNodeStorageSpec

    Description string
    Description of storage specification
    DisplayName string
    Display name of storage specification
    MaxSize int
    Maximum storage specification, measured in GiB
    MinSize int
    Minimum storage specification, measured in GiB
    Name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    Size int
    Current storage specification value, in GiB.
    Description string
    Description of storage specification
    DisplayName string
    Display name of storage specification
    MaxSize int
    Maximum storage specification, measured in GiB
    MinSize int
    Minimum storage specification, measured in GiB
    Name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    Size int
    Current storage specification value, in GiB.
    description String
    Description of storage specification
    displayName String
    Display name of storage specification
    maxSize Integer
    Maximum storage specification, measured in GiB
    minSize Integer
    Minimum storage specification, measured in GiB
    name String
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size Integer
    Current storage specification value, in GiB.
    description string
    Description of storage specification
    displayName string
    Display name of storage specification
    maxSize number
    Maximum storage specification, measured in GiB
    minSize number
    Minimum storage specification, measured in GiB
    name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size number
    Current storage specification value, in GiB.
    description str
    Description of storage specification
    display_name str
    Display name of storage specification
    max_size int
    Maximum storage specification, measured in GiB
    min_size int
    Minimum storage specification, measured in GiB
    name str
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size int
    Current storage specification value, in GiB.
    description String
    Description of storage specification
    displayName String
    Display name of storage specification
    maxSize Number
    Maximum storage specification, measured in GiB
    minSize Number
    Minimum storage specification, measured in GiB
    name String
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size Number
    Current storage specification value, in GiB.

    GetInstanceInstanceConfigurationCoordinatorNodeResourceSpec

    Cpu int
    CPU resources of node specification, unit: cores.
    Description string
    Description of node specifications
    DisplayName string
    Display name of node specification.
    Memory int
    Memory capacity of node specification, unit: GiB.
    Name string
    Node specification. For details on node specification types and details.
    Cpu int
    CPU resources of node specification, unit: cores.
    Description string
    Description of node specifications
    DisplayName string
    Display name of node specification.
    Memory int
    Memory capacity of node specification, unit: GiB.
    Name string
    Node specification. For details on node specification types and details.
    cpu Integer
    CPU resources of node specification, unit: cores.
    description String
    Description of node specifications
    displayName String
    Display name of node specification.
    memory Integer
    Memory capacity of node specification, unit: GiB.
    name String
    Node specification. For details on node specification types and details.
    cpu number
    CPU resources of node specification, unit: cores.
    description string
    Description of node specifications
    displayName string
    Display name of node specification.
    memory number
    Memory capacity of node specification, unit: GiB.
    name string
    Node specification. For details on node specification types and details.
    cpu int
    CPU resources of node specification, unit: cores.
    description str
    Description of node specifications
    display_name str
    Display name of node specification.
    memory int
    Memory capacity of node specification, unit: GiB.
    name str
    Node specification. For details on node specification types and details.
    cpu Number
    CPU resources of node specification, unit: cores.
    description String
    Description of node specifications
    displayName String
    Display name of node specification.
    memory Number
    Memory capacity of node specification, unit: GiB.
    name String
    Node specification. For details on node specification types and details.

    GetInstanceInstanceConfigurationCoordinatorNodeStorageSpec

    Description string
    Description of storage specification.
    DisplayName string
    Display name of storage specification
    MaxSize int
    Maximum storage specification, in GiB
    MinSize int
    Minimum value for storage specification, unit: GiB.
    Name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    Size int
    Current storage specification value, in GiB.
    Description string
    Description of storage specification.
    DisplayName string
    Display name of storage specification
    MaxSize int
    Maximum storage specification, in GiB
    MinSize int
    Minimum value for storage specification, unit: GiB.
    Name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    Size int
    Current storage specification value, in GiB.
    description String
    Description of storage specification.
    displayName String
    Display name of storage specification
    maxSize Integer
    Maximum storage specification, in GiB
    minSize Integer
    Minimum value for storage specification, unit: GiB.
    name String
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size Integer
    Current storage specification value, in GiB.
    description string
    Description of storage specification.
    displayName string
    Display name of storage specification
    maxSize number
    Maximum storage specification, in GiB
    minSize number
    Minimum value for storage specification, unit: GiB.
    name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size number
    Current storage specification value, in GiB.
    description str
    Description of storage specification.
    display_name str
    Display name of storage specification
    max_size int
    Maximum storage specification, in GiB
    min_size int
    Minimum value for storage specification, unit: GiB.
    name str
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size int
    Current storage specification value, in GiB.
    description String
    Description of storage specification.
    displayName String
    Display name of storage specification
    maxSize Number
    Maximum storage specification, in GiB
    minSize Number
    Minimum value for storage specification, unit: GiB.
    name String
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size Number
    Current storage specification value, in GiB.

    GetInstanceInstanceConfigurationHotNodeResourceSpec

    Cpu int
    CPU resources of node specification, measured in cores
    Description string
    Description of node specification.
    DisplayName string
    Display name of node specification.
    Memory int
    Memory capacity for node specification, measured in GiB.
    Name string
    Node specification. For details on node specification types and details, see Product Specifications.
    Cpu int
    CPU resources of node specification, measured in cores
    Description string
    Description of node specification.
    DisplayName string
    Display name of node specification.
    Memory int
    Memory capacity for node specification, measured in GiB.
    Name string
    Node specification. For details on node specification types and details, see Product Specifications.
    cpu Integer
    CPU resources of node specification, measured in cores
    description String
    Description of node specification.
    displayName String
    Display name of node specification.
    memory Integer
    Memory capacity for node specification, measured in GiB.
    name String
    Node specification. For details on node specification types and details, see Product Specifications.
    cpu number
    CPU resources of node specification, measured in cores
    description string
    Description of node specification.
    displayName string
    Display name of node specification.
    memory number
    Memory capacity for node specification, measured in GiB.
    name string
    Node specification. For details on node specification types and details, see Product Specifications.
    cpu int
    CPU resources of node specification, measured in cores
    description str
    Description of node specification.
    display_name str
    Display name of node specification.
    memory int
    Memory capacity for node specification, measured in GiB.
    name str
    Node specification. For details on node specification types and details, see Product Specifications.
    cpu Number
    CPU resources of node specification, measured in cores
    description String
    Description of node specification.
    displayName String
    Display name of node specification.
    memory Number
    Memory capacity for node specification, measured in GiB.
    name String
    Node specification. For details on node specification types and details, see Product Specifications.

    GetInstanceInstanceConfigurationHotNodeStorageSpec

    Description string
    Description of storage specification
    DisplayName string
    Display name of storage specification.
    MaxSize int
    Maximum storage specification, in GiB
    MinSize int
    Minimum storage specification, measured in GiB.
    Name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    Size int
    Configured available disk space size
    Description string
    Description of storage specification
    DisplayName string
    Display name of storage specification.
    MaxSize int
    Maximum storage specification, in GiB
    MinSize int
    Minimum storage specification, measured in GiB.
    Name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    Size int
    Configured available disk space size
    description String
    Description of storage specification
    displayName String
    Display name of storage specification.
    maxSize Integer
    Maximum storage specification, in GiB
    minSize Integer
    Minimum storage specification, measured in GiB.
    name String
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size Integer
    Configured available disk space size
    description string
    Description of storage specification
    displayName string
    Display name of storage specification.
    maxSize number
    Maximum storage specification, in GiB
    minSize number
    Minimum storage specification, measured in GiB.
    name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size number
    Configured available disk space size
    description str
    Description of storage specification
    display_name str
    Display name of storage specification.
    max_size int
    Maximum storage specification, in GiB
    min_size int
    Minimum storage specification, measured in GiB.
    name str
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size int
    Configured available disk space size
    description String
    Description of storage specification
    displayName String
    Display name of storage specification.
    maxSize Number
    Maximum storage specification, in GiB
    minSize Number
    Minimum storage specification, measured in GiB.
    name String
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size Number
    Configured available disk space size

    GetInstanceInstanceConfigurationKibanaNodeResourceSpec

    Cpu int
    CPU resources for node specification, measured in cores.
    Description string
    Description of node specifications
    DisplayName string
    Display name of node specification.
    Memory int
    Memory capacity for node specification, measured in GiB
    Name string
    Node specification. For information about node specification types and details, please refer to the documentation.
    Cpu int
    CPU resources for node specification, measured in cores.
    Description string
    Description of node specifications
    DisplayName string
    Display name of node specification.
    Memory int
    Memory capacity for node specification, measured in GiB
    Name string
    Node specification. For information about node specification types and details, please refer to the documentation.
    cpu Integer
    CPU resources for node specification, measured in cores.
    description String
    Description of node specifications
    displayName String
    Display name of node specification.
    memory Integer
    Memory capacity for node specification, measured in GiB
    name String
    Node specification. For information about node specification types and details, please refer to the documentation.
    cpu number
    CPU resources for node specification, measured in cores.
    description string
    Description of node specifications
    displayName string
    Display name of node specification.
    memory number
    Memory capacity for node specification, measured in GiB
    name string
    Node specification. For information about node specification types and details, please refer to the documentation.
    cpu int
    CPU resources for node specification, measured in cores.
    description str
    Description of node specifications
    display_name str
    Display name of node specification.
    memory int
    Memory capacity for node specification, measured in GiB
    name str
    Node specification. For information about node specification types and details, please refer to the documentation.
    cpu Number
    CPU resources for node specification, measured in cores.
    description String
    Description of node specifications
    displayName String
    Display name of node specification.
    memory Number
    Memory capacity for node specification, measured in GiB
    name String
    Node specification. For information about node specification types and details, please refer to the documentation.

    GetInstanceInstanceConfigurationMasterNodeResourceSpec

    Cpu int
    CPU resources of node specification, unit: cores.
    Description string
    Description of node specifications
    DisplayName string
    Display name of node specification
    Memory int
    Memory capacity of node specification, unit: GiB.
    Name string
    Node specification. For information about node specification types and details, please refer to the documentation.
    Cpu int
    CPU resources of node specification, unit: cores.
    Description string
    Description of node specifications
    DisplayName string
    Display name of node specification
    Memory int
    Memory capacity of node specification, unit: GiB.
    Name string
    Node specification. For information about node specification types and details, please refer to the documentation.
    cpu Integer
    CPU resources of node specification, unit: cores.
    description String
    Description of node specifications
    displayName String
    Display name of node specification
    memory Integer
    Memory capacity of node specification, unit: GiB.
    name String
    Node specification. For information about node specification types and details, please refer to the documentation.
    cpu number
    CPU resources of node specification, unit: cores.
    description string
    Description of node specifications
    displayName string
    Display name of node specification
    memory number
    Memory capacity of node specification, unit: GiB.
    name string
    Node specification. For information about node specification types and details, please refer to the documentation.
    cpu int
    CPU resources of node specification, unit: cores.
    description str
    Description of node specifications
    display_name str
    Display name of node specification
    memory int
    Memory capacity of node specification, unit: GiB.
    name str
    Node specification. For information about node specification types and details, please refer to the documentation.
    cpu Number
    CPU resources of node specification, unit: cores.
    description String
    Description of node specifications
    displayName String
    Display name of node specification
    memory Number
    Memory capacity of node specification, unit: GiB.
    name String
    Node specification. For information about node specification types and details, please refer to the documentation.

    GetInstanceInstanceConfigurationMasterNodeStorageSpec

    Description string
    Description of storage specification.
    DisplayName string
    Display name of storage specification.
    MaxSize int
    Maximum storage specification, measured in GiB
    MinSize int
    Minimum value for storage specification, unit: GiB.
    Name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    Size int
    Current storage specification value, in GiB.
    Description string
    Description of storage specification.
    DisplayName string
    Display name of storage specification.
    MaxSize int
    Maximum storage specification, measured in GiB
    MinSize int
    Minimum value for storage specification, unit: GiB.
    Name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    Size int
    Current storage specification value, in GiB.
    description String
    Description of storage specification.
    displayName String
    Display name of storage specification.
    maxSize Integer
    Maximum storage specification, measured in GiB
    minSize Integer
    Minimum value for storage specification, unit: GiB.
    name String
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size Integer
    Current storage specification value, in GiB.
    description string
    Description of storage specification.
    displayName string
    Display name of storage specification.
    maxSize number
    Maximum storage specification, measured in GiB
    minSize number
    Minimum value for storage specification, unit: GiB.
    name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size number
    Current storage specification value, in GiB.
    description str
    Description of storage specification.
    display_name str
    Display name of storage specification.
    max_size int
    Maximum storage specification, measured in GiB
    min_size int
    Minimum value for storage specification, unit: GiB.
    name str
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size int
    Current storage specification value, in GiB.
    description String
    Description of storage specification.
    displayName String
    Display name of storage specification.
    maxSize Number
    Maximum storage specification, measured in GiB
    minSize Number
    Minimum value for storage specification, unit: GiB.
    name String
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size Number
    Current storage specification value, in GiB.

    GetInstanceInstanceConfigurationNetworkSpec

    Bandwidth int
    Public IP bandwidth limit. Default is '1', unit: Mbps.
    IsOpen bool
    Enable/Disable
    SpecName string
    Instance public resource specification name
    Type string
    Public network application types: Elasticsearch—for ES instance usage. Kibana—for Dashboard usage
    Bandwidth int
    Public IP bandwidth limit. Default is '1', unit: Mbps.
    IsOpen bool
    Enable/Disable
    SpecName string
    Instance public resource specification name
    Type string
    Public network application types: Elasticsearch—for ES instance usage. Kibana—for Dashboard usage
    bandwidth Integer
    Public IP bandwidth limit. Default is '1', unit: Mbps.
    isOpen Boolean
    Enable/Disable
    specName String
    Instance public resource specification name
    type String
    Public network application types: Elasticsearch—for ES instance usage. Kibana—for Dashboard usage
    bandwidth number
    Public IP bandwidth limit. Default is '1', unit: Mbps.
    isOpen boolean
    Enable/Disable
    specName string
    Instance public resource specification name
    type string
    Public network application types: Elasticsearch—for ES instance usage. Kibana—for Dashboard usage
    bandwidth int
    Public IP bandwidth limit. Default is '1', unit: Mbps.
    is_open bool
    Enable/Disable
    spec_name str
    Instance public resource specification name
    type str
    Public network application types: Elasticsearch—for ES instance usage. Kibana—for Dashboard usage
    bandwidth Number
    Public IP bandwidth limit. Default is '1', unit: Mbps.
    isOpen Boolean
    Enable/Disable
    specName String
    Instance public resource specification name
    type String
    Public network application types: Elasticsearch—for ES instance usage. Kibana—for Dashboard usage

    GetInstanceInstanceConfigurationNodeSpecsAssign

    ExtraPerformance Volcengine.GetInstanceInstanceConfigurationNodeSpecsAssignExtraPerformance
    Disk extra performance package configuration.
    Number int
    Node count. When configuring the number of data nodes, note the following based on deployment mode: Single availability zone deployment: For production environments, configure at least 3 data nodes. Configuring 2 nodes poses a split-brain risk. If dedicated master nodes are enabled, 2 data nodes will not result in split-brain. Dual availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 4 data nodes—2 per availability zone. Triple availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 6 data nodes—2 per availability zone. You can set the number of data nodes from 1 to 100. If you need more, apply to increase the quota to 200. Master node configuration: If dedicated master nodes are not enabled, master node configuration matches data nodes; otherwise, master node configuration is independent. Dedicated master node configuration: If you need to enable dedicated master nodes, the default number is 3. Kibana node configuration: The number is fixed at 1. Coordinator node configuration: If enabled, configure at least 2 coordinator nodes for production environments. The configurable range is 2–50. Warm data nodes: If enabled, configure at least 3 warm data nodes for production environments, up to 100. Cold data nodes: If enabled, configure at least 2 cold data nodes for production environments, up to 100.
    ResourceSpecName string
    Compute resource specification name. You can call the DescribeNodeAvailableSpecs API to get the list of available node specifications. For details, see V2 instance specifications.
    StorageSize int
    Storage capacity, measured in GiB. Default value is 100 GiB, adjustment step is 10 GiB. Note: StorageSize for Kibana nodes is set to 0, i.e., "StorageSize": 0. StorageSize for dedicated master and coordinator nodes defaults to 20
    StorageSpecName string
    Storage specification name. Currently supported specifications: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0. es.volume.essd.flexpl-standard: Standard Edition - High Performance Cloud Disk - flexpl. Note: StorageSpecName for Kibana nodes is set to empty, i.e., "StorageSpecName": ""
    Type string
    Node type. Please understand the function of each node type first, then determine whether to create based on your business needs. For details, see node types. Master: Master node. Hot: Data node. Cold: Cold data node. Warm: Warm data node. Kibana: Kibana node. Coordinator: Coordinator node
    ExtraPerformance GetInstanceInstanceConfigurationNodeSpecsAssignExtraPerformance
    Disk extra performance package configuration.
    Number int
    Node count. When configuring the number of data nodes, note the following based on deployment mode: Single availability zone deployment: For production environments, configure at least 3 data nodes. Configuring 2 nodes poses a split-brain risk. If dedicated master nodes are enabled, 2 data nodes will not result in split-brain. Dual availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 4 data nodes—2 per availability zone. Triple availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 6 data nodes—2 per availability zone. You can set the number of data nodes from 1 to 100. If you need more, apply to increase the quota to 200. Master node configuration: If dedicated master nodes are not enabled, master node configuration matches data nodes; otherwise, master node configuration is independent. Dedicated master node configuration: If you need to enable dedicated master nodes, the default number is 3. Kibana node configuration: The number is fixed at 1. Coordinator node configuration: If enabled, configure at least 2 coordinator nodes for production environments. The configurable range is 2–50. Warm data nodes: If enabled, configure at least 3 warm data nodes for production environments, up to 100. Cold data nodes: If enabled, configure at least 2 cold data nodes for production environments, up to 100.
    ResourceSpecName string
    Compute resource specification name. You can call the DescribeNodeAvailableSpecs API to get the list of available node specifications. For details, see V2 instance specifications.
    StorageSize int
    Storage capacity, measured in GiB. Default value is 100 GiB, adjustment step is 10 GiB. Note: StorageSize for Kibana nodes is set to 0, i.e., "StorageSize": 0. StorageSize for dedicated master and coordinator nodes defaults to 20
    StorageSpecName string
    Storage specification name. Currently supported specifications: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0. es.volume.essd.flexpl-standard: Standard Edition - High Performance Cloud Disk - flexpl. Note: StorageSpecName for Kibana nodes is set to empty, i.e., "StorageSpecName": ""
    Type string
    Node type. Please understand the function of each node type first, then determine whether to create based on your business needs. For details, see node types. Master: Master node. Hot: Data node. Cold: Cold data node. Warm: Warm data node. Kibana: Kibana node. Coordinator: Coordinator node
    extraPerformance GetInstanceInstanceConfigurationNodeSpecsAssignExtraPerformance
    Disk extra performance package configuration.
    number Integer
    Node count. When configuring the number of data nodes, note the following based on deployment mode: Single availability zone deployment: For production environments, configure at least 3 data nodes. Configuring 2 nodes poses a split-brain risk. If dedicated master nodes are enabled, 2 data nodes will not result in split-brain. Dual availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 4 data nodes—2 per availability zone. Triple availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 6 data nodes—2 per availability zone. You can set the number of data nodes from 1 to 100. If you need more, apply to increase the quota to 200. Master node configuration: If dedicated master nodes are not enabled, master node configuration matches data nodes; otherwise, master node configuration is independent. Dedicated master node configuration: If you need to enable dedicated master nodes, the default number is 3. Kibana node configuration: The number is fixed at 1. Coordinator node configuration: If enabled, configure at least 2 coordinator nodes for production environments. The configurable range is 2–50. Warm data nodes: If enabled, configure at least 3 warm data nodes for production environments, up to 100. Cold data nodes: If enabled, configure at least 2 cold data nodes for production environments, up to 100.
    resourceSpecName String
    Compute resource specification name. You can call the DescribeNodeAvailableSpecs API to get the list of available node specifications. For details, see V2 instance specifications.
    storageSize Integer
    Storage capacity, measured in GiB. Default value is 100 GiB, adjustment step is 10 GiB. Note: StorageSize for Kibana nodes is set to 0, i.e., "StorageSize": 0. StorageSize for dedicated master and coordinator nodes defaults to 20
    storageSpecName String
    Storage specification name. Currently supported specifications: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0. es.volume.essd.flexpl-standard: Standard Edition - High Performance Cloud Disk - flexpl. Note: StorageSpecName for Kibana nodes is set to empty, i.e., "StorageSpecName": ""
    type String
    Node type. Please understand the function of each node type first, then determine whether to create based on your business needs. For details, see node types. Master: Master node. Hot: Data node. Cold: Cold data node. Warm: Warm data node. Kibana: Kibana node. Coordinator: Coordinator node
    extraPerformance GetInstanceInstanceConfigurationNodeSpecsAssignExtraPerformance
    Disk extra performance package configuration.
    number number
    Node count. When configuring the number of data nodes, note the following based on deployment mode: Single availability zone deployment: For production environments, configure at least 3 data nodes. Configuring 2 nodes poses a split-brain risk. If dedicated master nodes are enabled, 2 data nodes will not result in split-brain. Dual availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 4 data nodes—2 per availability zone. Triple availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 6 data nodes—2 per availability zone. You can set the number of data nodes from 1 to 100. If you need more, apply to increase the quota to 200. Master node configuration: If dedicated master nodes are not enabled, master node configuration matches data nodes; otherwise, master node configuration is independent. Dedicated master node configuration: If you need to enable dedicated master nodes, the default number is 3. Kibana node configuration: The number is fixed at 1. Coordinator node configuration: If enabled, configure at least 2 coordinator nodes for production environments. The configurable range is 2–50. Warm data nodes: If enabled, configure at least 3 warm data nodes for production environments, up to 100. Cold data nodes: If enabled, configure at least 2 cold data nodes for production environments, up to 100.
    resourceSpecName string
    Compute resource specification name. You can call the DescribeNodeAvailableSpecs API to get the list of available node specifications. For details, see V2 instance specifications.
    storageSize number
    Storage capacity, measured in GiB. Default value is 100 GiB, adjustment step is 10 GiB. Note: StorageSize for Kibana nodes is set to 0, i.e., "StorageSize": 0. StorageSize for dedicated master and coordinator nodes defaults to 20
    storageSpecName string
    Storage specification name. Currently supported specifications: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0. es.volume.essd.flexpl-standard: Standard Edition - High Performance Cloud Disk - flexpl. Note: StorageSpecName for Kibana nodes is set to empty, i.e., "StorageSpecName": ""
    type string
    Node type. Please understand the function of each node type first, then determine whether to create based on your business needs. For details, see node types. Master: Master node. Hot: Data node. Cold: Cold data node. Warm: Warm data node. Kibana: Kibana node. Coordinator: Coordinator node
    extra_performance GetInstanceInstanceConfigurationNodeSpecsAssignExtraPerformance
    Disk extra performance package configuration.
    number int
    Node count. When configuring the number of data nodes, note the following based on deployment mode: Single availability zone deployment: For production environments, configure at least 3 data nodes. Configuring 2 nodes poses a split-brain risk. If dedicated master nodes are enabled, 2 data nodes will not result in split-brain. Dual availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 4 data nodes—2 per availability zone. Triple availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 6 data nodes—2 per availability zone. You can set the number of data nodes from 1 to 100. If you need more, apply to increase the quota to 200. Master node configuration: If dedicated master nodes are not enabled, master node configuration matches data nodes; otherwise, master node configuration is independent. Dedicated master node configuration: If you need to enable dedicated master nodes, the default number is 3. Kibana node configuration: The number is fixed at 1. Coordinator node configuration: If enabled, configure at least 2 coordinator nodes for production environments. The configurable range is 2–50. Warm data nodes: If enabled, configure at least 3 warm data nodes for production environments, up to 100. Cold data nodes: If enabled, configure at least 2 cold data nodes for production environments, up to 100.
    resource_spec_name str
    Compute resource specification name. You can call the DescribeNodeAvailableSpecs API to get the list of available node specifications. For details, see V2 instance specifications.
    storage_size int
    Storage capacity, measured in GiB. Default value is 100 GiB, adjustment step is 10 GiB. Note: StorageSize for Kibana nodes is set to 0, i.e., "StorageSize": 0. StorageSize for dedicated master and coordinator nodes defaults to 20
    storage_spec_name str
    Storage specification name. Currently supported specifications: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0. es.volume.essd.flexpl-standard: Standard Edition - High Performance Cloud Disk - flexpl. Note: StorageSpecName for Kibana nodes is set to empty, i.e., "StorageSpecName": ""
    type str
    Node type. Please understand the function of each node type first, then determine whether to create based on your business needs. For details, see node types. Master: Master node. Hot: Data node. Cold: Cold data node. Warm: Warm data node. Kibana: Kibana node. Coordinator: Coordinator node
    extraPerformance Property Map
    Disk extra performance package configuration.
    number Number
    Node count. When configuring the number of data nodes, note the following based on deployment mode: Single availability zone deployment: For production environments, configure at least 3 data nodes. Configuring 2 nodes poses a split-brain risk. If dedicated master nodes are enabled, 2 data nodes will not result in split-brain. Dual availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 4 data nodes—2 per availability zone. Triple availability zone deployment, dedicated master nodes enabled by default: For production environments, configure at least 6 data nodes—2 per availability zone. You can set the number of data nodes from 1 to 100. If you need more, apply to increase the quota to 200. Master node configuration: If dedicated master nodes are not enabled, master node configuration matches data nodes; otherwise, master node configuration is independent. Dedicated master node configuration: If you need to enable dedicated master nodes, the default number is 3. Kibana node configuration: The number is fixed at 1. Coordinator node configuration: If enabled, configure at least 2 coordinator nodes for production environments. The configurable range is 2–50. Warm data nodes: If enabled, configure at least 3 warm data nodes for production environments, up to 100. Cold data nodes: If enabled, configure at least 2 cold data nodes for production environments, up to 100.
    resourceSpecName String
    Compute resource specification name. You can call the DescribeNodeAvailableSpecs API to get the list of available node specifications. For details, see V2 instance specifications.
    storageSize Number
    Storage capacity, measured in GiB. Default value is 100 GiB, adjustment step is 10 GiB. Note: StorageSize for Kibana nodes is set to 0, i.e., "StorageSize": 0. StorageSize for dedicated master and coordinator nodes defaults to 20
    storageSpecName String
    Storage specification name. Currently supported specifications: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0. es.volume.essd.flexpl-standard: Standard Edition - High Performance Cloud Disk - flexpl. Note: StorageSpecName for Kibana nodes is set to empty, i.e., "StorageSpecName": ""
    type String
    Node type. Please understand the function of each node type first, then determine whether to create based on your business needs. For details, see node types. Master: Master node. Hot: Data node. Cold: Cold data node. Warm: Warm data node. Kibana: Kibana node. Coordinator: Coordinator node

    GetInstanceInstanceConfigurationNodeSpecsAssignExtraPerformance

    Throughput int
    When your data node uses the FlexPL storage type and the storage specification is 500 GiB or above, you can purchase a bandwidth package to increase disk bandwidth. Unit: MiB; adjustment step: 10 MiB. Supported storage specifications and corresponding maximum throughput for additional performance packages are as follows: es.volume.essd.flexpl-standard: 650.
    Throughput int
    When your data node uses the FlexPL storage type and the storage specification is 500 GiB or above, you can purchase a bandwidth package to increase disk bandwidth. Unit: MiB; adjustment step: 10 MiB. Supported storage specifications and corresponding maximum throughput for additional performance packages are as follows: es.volume.essd.flexpl-standard: 650.
    throughput Integer
    When your data node uses the FlexPL storage type and the storage specification is 500 GiB or above, you can purchase a bandwidth package to increase disk bandwidth. Unit: MiB; adjustment step: 10 MiB. Supported storage specifications and corresponding maximum throughput for additional performance packages are as follows: es.volume.essd.flexpl-standard: 650.
    throughput number
    When your data node uses the FlexPL storage type and the storage specification is 500 GiB or above, you can purchase a bandwidth package to increase disk bandwidth. Unit: MiB; adjustment step: 10 MiB. Supported storage specifications and corresponding maximum throughput for additional performance packages are as follows: es.volume.essd.flexpl-standard: 650.
    throughput int
    When your data node uses the FlexPL storage type and the storage specification is 500 GiB or above, you can purchase a bandwidth package to increase disk bandwidth. Unit: MiB; adjustment step: 10 MiB. Supported storage specifications and corresponding maximum throughput for additional performance packages are as follows: es.volume.essd.flexpl-standard: 650.
    throughput Number
    When your data node uses the FlexPL storage type and the storage specification is 500 GiB or above, you can purchase a bandwidth package to increase disk bandwidth. Unit: MiB; adjustment step: 10 MiB. Supported storage specifications and corresponding maximum throughput for additional performance packages are as follows: es.volume.essd.flexpl-standard: 650.

    GetInstanceInstanceConfigurationSubnet

    SubnetId string
    Subnet ID。
    SubnetName string
    Subnet name
    SubnetId string
    Subnet ID。
    SubnetName string
    Subnet name
    subnetId String
    Subnet ID。
    subnetName String
    Subnet name
    subnetId string
    Subnet ID。
    subnetName string
    Subnet name
    subnet_id str
    Subnet ID。
    subnet_name str
    Subnet name
    subnetId String
    Subnet ID。
    subnetName String
    Subnet name

    GetInstanceInstanceConfigurationTag

    Key string
    Tag key for user labels. Length limit: 1–128 characters. Case-sensitive. Cannot start or end with a space. Letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), minus (-), and @ are allowed. Duplicate tag keys are not allowed for the same resource
    Value string
    Tag value for user tag. Length limit: 0–256 characters. Case-sensitive, cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscore (_), period (.), colon (:), slash (/), equals (=), plus (+), minus (-), and @
    Key string
    Tag key for user labels. Length limit: 1–128 characters. Case-sensitive. Cannot start or end with a space. Letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), minus (-), and @ are allowed. Duplicate tag keys are not allowed for the same resource
    Value string
    Tag value for user tag. Length limit: 0–256 characters. Case-sensitive, cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscore (_), period (.), colon (:), slash (/), equals (=), plus (+), minus (-), and @
    key String
    Tag key for user labels. Length limit: 1–128 characters. Case-sensitive. Cannot start or end with a space. Letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), minus (-), and @ are allowed. Duplicate tag keys are not allowed for the same resource
    value String
    Tag value for user tag. Length limit: 0–256 characters. Case-sensitive, cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscore (_), period (.), colon (:), slash (/), equals (=), plus (+), minus (-), and @
    key string
    Tag key for user labels. Length limit: 1–128 characters. Case-sensitive. Cannot start or end with a space. Letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), minus (-), and @ are allowed. Duplicate tag keys are not allowed for the same resource
    value string
    Tag value for user tag. Length limit: 0–256 characters. Case-sensitive, cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscore (_), period (.), colon (:), slash (/), equals (=), plus (+), minus (-), and @
    key str
    Tag key for user labels. Length limit: 1–128 characters. Case-sensitive. Cannot start or end with a space. Letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), minus (-), and @ are allowed. Duplicate tag keys are not allowed for the same resource
    value str
    Tag value for user tag. Length limit: 0–256 characters. Case-sensitive, cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscore (_), period (.), colon (:), slash (/), equals (=), plus (+), minus (-), and @
    key String
    Tag key for user labels. Length limit: 1–128 characters. Case-sensitive. Cannot start or end with a space. Letters, numbers, spaces (), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), minus (-), and @ are allowed. Duplicate tag keys are not allowed for the same resource
    value String
    Tag value for user tag. Length limit: 0–256 characters. Case-sensitive, cannot start or end with a space. Allowed characters: letters, numbers, spaces ( ), underscore (_), period (.), colon (:), slash (/), equals (=), plus (+), minus (-), and @

    GetInstanceInstanceConfigurationVpc

    VpcId string
    VPC ID。
    VpcName string
    VPC name
    VpcId string
    VPC ID。
    VpcName string
    VPC name
    vpcId String
    VPC ID。
    vpcName String
    VPC name
    vpcId string
    VPC ID。
    vpcName string
    VPC name
    vpc_id str
    VPC ID。
    vpc_name str
    VPC name
    vpcId String
    VPC ID。
    vpcName String
    VPC name

    GetInstanceInstanceConfigurationWarmNodeResourceSpec

    Cpu int
    CPU resources for node specification, measured in cores.
    Description string
    Description of node specification
    DisplayName string
    Display name of node specification.
    Memory int
    Memory capacity for node specification, measured in GiB
    Name string
    Node specification. For details on node specification types and details.
    Cpu int
    CPU resources for node specification, measured in cores.
    Description string
    Description of node specification
    DisplayName string
    Display name of node specification.
    Memory int
    Memory capacity for node specification, measured in GiB
    Name string
    Node specification. For details on node specification types and details.
    cpu Integer
    CPU resources for node specification, measured in cores.
    description String
    Description of node specification
    displayName String
    Display name of node specification.
    memory Integer
    Memory capacity for node specification, measured in GiB
    name String
    Node specification. For details on node specification types and details.
    cpu number
    CPU resources for node specification, measured in cores.
    description string
    Description of node specification
    displayName string
    Display name of node specification.
    memory number
    Memory capacity for node specification, measured in GiB
    name string
    Node specification. For details on node specification types and details.
    cpu int
    CPU resources for node specification, measured in cores.
    description str
    Description of node specification
    display_name str
    Display name of node specification.
    memory int
    Memory capacity for node specification, measured in GiB
    name str
    Node specification. For details on node specification types and details.
    cpu Number
    CPU resources for node specification, measured in cores.
    description String
    Description of node specification
    displayName String
    Display name of node specification.
    memory Number
    Memory capacity for node specification, measured in GiB
    name String
    Node specification. For details on node specification types and details.

    GetInstanceInstanceConfigurationWarmNodeStorageSpec

    Description string
    Description of storage specification.
    DisplayName string
    Display name of storage specification.
    MaxSize int
    Maximum storage specification, measured in GiB
    MinSize int
    Minimum value for storage specification, unit: GiB.
    Name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    Size int
    Current storage specification value, in GiB.
    Description string
    Description of storage specification.
    DisplayName string
    Display name of storage specification.
    MaxSize int
    Maximum storage specification, measured in GiB
    MinSize int
    Minimum value for storage specification, unit: GiB.
    Name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    Size int
    Current storage specification value, in GiB.
    description String
    Description of storage specification.
    displayName String
    Display name of storage specification.
    maxSize Integer
    Maximum storage specification, measured in GiB
    minSize Integer
    Minimum value for storage specification, unit: GiB.
    name String
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size Integer
    Current storage specification value, in GiB.
    description string
    Description of storage specification.
    displayName string
    Display name of storage specification.
    maxSize number
    Maximum storage specification, measured in GiB
    minSize number
    Minimum value for storage specification, unit: GiB.
    name string
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size number
    Current storage specification value, in GiB.
    description str
    Description of storage specification.
    display_name str
    Display name of storage specification.
    max_size int
    Maximum storage specification, measured in GiB
    min_size int
    Minimum value for storage specification, unit: GiB.
    name str
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size int
    Current storage specification value, in GiB.
    description String
    Description of storage specification.
    displayName String
    Display name of storage specification.
    maxSize Number
    Maximum storage specification, measured in GiB
    minSize Number
    Minimum value for storage specification, unit: GiB.
    name String
    Storage specification. Current specification: es.volume.essd.pl0: Standard Edition - High Performance Cloud Disk - pl0
    size Number
    Current storage specification value, in GiB.

    GetInstanceKibanaConfig

    RequestTimeout int
    API request timeout duration. Default is 30000 milliseconds. If the backend response exceeds 30 seconds, a 503 Request timed out error will occur. To receive responses normally and reduce 503 errors, you can increase the request timeout duration
    SessionKeepAlive bool
    Whether to proactively extend session validity. true: Default value, session validity is extended with each page request. false: Session validity is not proactively extended. With this setting, session timeout can occur; when login duration reaches the session validity period, you will be automatically logged out.
    SessionTtl int
    Session validity duration. Default is 3600000 milliseconds (1 hour). If you set Session activity retention to No, you will be automatically logged out when the login duration reaches the session validity duration
    RequestTimeout int
    API request timeout duration. Default is 30000 milliseconds. If the backend response exceeds 30 seconds, a 503 Request timed out error will occur. To receive responses normally and reduce 503 errors, you can increase the request timeout duration
    SessionKeepAlive bool
    Whether to proactively extend session validity. true: Default value, session validity is extended with each page request. false: Session validity is not proactively extended. With this setting, session timeout can occur; when login duration reaches the session validity period, you will be automatically logged out.
    SessionTtl int
    Session validity duration. Default is 3600000 milliseconds (1 hour). If you set Session activity retention to No, you will be automatically logged out when the login duration reaches the session validity duration
    requestTimeout Integer
    API request timeout duration. Default is 30000 milliseconds. If the backend response exceeds 30 seconds, a 503 Request timed out error will occur. To receive responses normally and reduce 503 errors, you can increase the request timeout duration
    sessionKeepAlive Boolean
    Whether to proactively extend session validity. true: Default value, session validity is extended with each page request. false: Session validity is not proactively extended. With this setting, session timeout can occur; when login duration reaches the session validity period, you will be automatically logged out.
    sessionTtl Integer
    Session validity duration. Default is 3600000 milliseconds (1 hour). If you set Session activity retention to No, you will be automatically logged out when the login duration reaches the session validity duration
    requestTimeout number
    API request timeout duration. Default is 30000 milliseconds. If the backend response exceeds 30 seconds, a 503 Request timed out error will occur. To receive responses normally and reduce 503 errors, you can increase the request timeout duration
    sessionKeepAlive boolean
    Whether to proactively extend session validity. true: Default value, session validity is extended with each page request. false: Session validity is not proactively extended. With this setting, session timeout can occur; when login duration reaches the session validity period, you will be automatically logged out.
    sessionTtl number
    Session validity duration. Default is 3600000 milliseconds (1 hour). If you set Session activity retention to No, you will be automatically logged out when the login duration reaches the session validity duration
    request_timeout int
    API request timeout duration. Default is 30000 milliseconds. If the backend response exceeds 30 seconds, a 503 Request timed out error will occur. To receive responses normally and reduce 503 errors, you can increase the request timeout duration
    session_keep_alive bool
    Whether to proactively extend session validity. true: Default value, session validity is extended with each page request. false: Session validity is not proactively extended. With this setting, session timeout can occur; when login duration reaches the session validity period, you will be automatically logged out.
    session_ttl int
    Session validity duration. Default is 3600000 milliseconds (1 hour). If you set Session activity retention to No, you will be automatically logged out when the login duration reaches the session validity duration
    requestTimeout Number
    API request timeout duration. Default is 30000 milliseconds. If the backend response exceeds 30 seconds, a 503 Request timed out error will occur. To receive responses normally and reduce 503 errors, you can increase the request timeout duration
    sessionKeepAlive Boolean
    Whether to proactively extend session validity. true: Default value, session validity is extended with each page request. false: Session validity is not proactively extended. With this setting, session timeout can occur; when login duration reaches the session validity period, you will be automatically logged out.
    sessionTtl Number
    Session validity duration. Default is 3600000 milliseconds (1 hour). If you set Session activity retention to No, you will be automatically logged out when the login duration reaches the session validity duration

    GetInstanceSubInstance

    SubInstanceId string
    Enterprise-level SQL analysis instance ID.
    SubInstanceStatus string
    Instance status
    SubInstanceType string
    Instance type
    SubInstanceId string
    Enterprise-level SQL analysis instance ID.
    SubInstanceStatus string
    Instance status
    SubInstanceType string
    Instance type
    subInstanceId String
    Enterprise-level SQL analysis instance ID.
    subInstanceStatus String
    Instance status
    subInstanceType String
    Instance type
    subInstanceId string
    Enterprise-level SQL analysis instance ID.
    subInstanceStatus string
    Instance status
    subInstanceType string
    Instance type
    sub_instance_id str
    Enterprise-level SQL analysis instance ID.
    sub_instance_status str
    Instance status
    sub_instance_type str
    Instance type
    subInstanceId String
    Enterprise-level SQL analysis instance ID.
    subInstanceStatus String
    Instance status
    subInstanceType String
    Instance type

    GetInstanceTransferInfo

    ForbidStop bool
    ForbidStop
    ReduceSpecConfig Volcengine.GetInstanceTransferInfoReduceSpecConfig
    Resource information
    TransferProgress double
    Data migration task progress, percentage
    TransferStatus string
    Data migration task status
    TransferTaskId string
    Data migration task ID
    ForbidStop bool
    ForbidStop
    ReduceSpecConfig GetInstanceTransferInfoReduceSpecConfig
    Resource information
    TransferProgress float64
    Data migration task progress, percentage
    TransferStatus string
    Data migration task status
    TransferTaskId string
    Data migration task ID
    forbidStop Boolean
    ForbidStop
    reduceSpecConfig GetInstanceTransferInfoReduceSpecConfig
    Resource information
    transferProgress Double
    Data migration task progress, percentage
    transferStatus String
    Data migration task status
    transferTaskId String
    Data migration task ID
    forbidStop boolean
    ForbidStop
    reduceSpecConfig GetInstanceTransferInfoReduceSpecConfig
    Resource information
    transferProgress number
    Data migration task progress, percentage
    transferStatus string
    Data migration task status
    transferTaskId string
    Data migration task ID
    forbid_stop bool
    ForbidStop
    reduce_spec_config GetInstanceTransferInfoReduceSpecConfig
    Resource information
    transfer_progress float
    Data migration task progress, percentage
    transfer_status str
    Data migration task status
    transfer_task_id str
    Data migration task ID
    forbidStop Boolean
    ForbidStop
    reduceSpecConfig Property Map
    Resource information
    transferProgress Number
    Data migration task progress, percentage
    transferStatus String
    Data migration task status
    transferTaskId String
    Data migration task ID

    GetInstanceTransferInfoReduceSpecConfig

    ColdNodeNum int
    Number of cold nodes.
    DataNodeNum int
    Number of data nodes
    EnablePureMaster bool
    Whether the master node is independent. true: Master node is independent. false: Master node overlaps with data node, declared as Hot
    MasterNodeNum int
    Number of master nodes.
    WarmNodeNum int
    Number of warm nodes
    ColdNodeNum int
    Number of cold nodes.
    DataNodeNum int
    Number of data nodes
    EnablePureMaster bool
    Whether the master node is independent. true: Master node is independent. false: Master node overlaps with data node, declared as Hot
    MasterNodeNum int
    Number of master nodes.
    WarmNodeNum int
    Number of warm nodes
    coldNodeNum Integer
    Number of cold nodes.
    dataNodeNum Integer
    Number of data nodes
    enablePureMaster Boolean
    Whether the master node is independent. true: Master node is independent. false: Master node overlaps with data node, declared as Hot
    masterNodeNum Integer
    Number of master nodes.
    warmNodeNum Integer
    Number of warm nodes
    coldNodeNum number
    Number of cold nodes.
    dataNodeNum number
    Number of data nodes
    enablePureMaster boolean
    Whether the master node is independent. true: Master node is independent. false: Master node overlaps with data node, declared as Hot
    masterNodeNum number
    Number of master nodes.
    warmNodeNum number
    Number of warm nodes
    cold_node_num int
    Number of cold nodes.
    data_node_num int
    Number of data nodes
    enable_pure_master bool
    Whether the master node is independent. true: Master node is independent. false: Master node overlaps with data node, declared as Hot
    master_node_num int
    Number of master nodes.
    warm_node_num int
    Number of warm nodes
    coldNodeNum Number
    Number of cold nodes.
    dataNodeNum Number
    Number of data nodes
    enablePureMaster Boolean
    Whether the master node is independent. true: Master node is independent. false: Master node overlaps with data node, declared as Hot
    masterNodeNum Number
    Number of master nodes.
    warmNodeNum Number
    Number of warm nodes

    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
      Try Pulumi Cloud free. Your team will thank you.