1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rdsmssql
  6. Instance
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

    Cloud Database SQL Server Edition is a stable, reliable, and scalable online database service built on the world-class commercial database product Microsoft SQL Server. Creating an instance is the first step to using Cloud Database SQL Server Edition

    Example Usage

    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    resources:
      rDSMsSQLInstanceDemo:
        type: volcenginecc:rdsmssql:Instance
        name: RDSMsSQLInstanceDemo
        properties:
          nodeSpec: rds.mssql.3il.x8.medium.s1
          zoneId: cn-beijing-a
          subnetId: subnet-1a0zgr5e7hslc8nvepxxxxx
          dbEngineVersion: SQLServer_2019_Std
          instanceType: Basic
          storageSpace: 20
          vpcId: vpc-3nqt4kq87xn2893xxxxx
          instanceName: RDSMsSQLInstanceDemo
          superAccountPassword: '********'
          serverCollation: Chinese_PRC_CI_AS
          timeZone: China Standard Time
          chargeInfo:
            charge_type: PostPaid
          projectName: default
          maintenanceTime: 18:00Z-21:59Z
          allowListIds:
            - acl-03f197e136c843b29e47de74e9xxxxx
          tags:
            - key: env
              value: test
    

    Create Instance Resource

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

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
    def Instance(resource_name: str,
                 args: InstanceArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Instance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 subnet_id: Optional[str] = None,
                 super_account_password: Optional[str] = None,
                 zone_id: Optional[str] = None,
                 db_engine_version: Optional[str] = None,
                 vpc_id: Optional[str] = None,
                 instance_type: Optional[str] = None,
                 time_zone: Optional[str] = None,
                 node_spec: Optional[str] = None,
                 storage_space: Optional[int] = None,
                 server_collation: Optional[str] = None,
                 project_name: Optional[str] = None,
                 allow_list_ids: Optional[Sequence[str]] = None,
                 advanced_features: Optional[str] = None,
                 master_node_id: Optional[str] = None,
                 tags: Optional[Sequence[InstanceTagArgs]] = None,
                 maintenance_time: Optional[str] = None,
                 instance_name: Optional[str] = None,
                 charge_info: Optional[InstanceChargeInfoArgs] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
    public Instance(String name, InstanceArgs args, CustomResourceOptions options)
    
    type: volcenginecc:rdsmssql:Instance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Instance Resource Properties

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

    Inputs

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

    The Instance resource accepts the following input properties:

    DbEngineVersion string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    InstanceType string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    NodeSpec string
    Instance specification code.
    StorageSpace int
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    SubnetId string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    SuperAccountPassword string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    TimeZone string
    Time zone.
    VpcId string
    VPC ID
    ZoneId string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    AdvancedFeatures string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    AllowListIds List<string>
    Allowlist ID list permitted for access.
    ChargeInfo Volcengine.InstanceChargeInfo
    Payment method.
    InstanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    MaintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    MasterNodeId string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    ProjectName string
    Project.
    ServerCollation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    Tags List<Volcengine.InstanceTag>
    DbEngineVersion string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    InstanceType string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    NodeSpec string
    Instance specification code.
    StorageSpace int
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    SubnetId string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    SuperAccountPassword string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    TimeZone string
    Time zone.
    VpcId string
    VPC ID
    ZoneId string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    AdvancedFeatures string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    AllowListIds []string
    Allowlist ID list permitted for access.
    ChargeInfo InstanceChargeInfoArgs
    Payment method.
    InstanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    MaintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    MasterNodeId string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    ProjectName string
    Project.
    ServerCollation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    Tags []InstanceTagArgs
    dbEngineVersion String
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    instanceType String
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    nodeSpec String
    Instance specification code.
    storageSpace Integer
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    subnetId String
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    superAccountPassword String
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    timeZone String
    Time zone.
    vpcId String
    VPC ID
    zoneId String
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advancedFeatures String
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allowListIds List<String>
    Allowlist ID list permitted for access.
    chargeInfo InstanceChargeInfo
    Payment method.
    instanceName String
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    maintenanceTime String
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    masterNodeId String
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    projectName String
    Project.
    serverCollation String
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    tags List<InstanceTag>
    dbEngineVersion string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    instanceType string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    nodeSpec string
    Instance specification code.
    storageSpace number
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    subnetId string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    superAccountPassword string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    timeZone string
    Time zone.
    vpcId string
    VPC ID
    zoneId string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advancedFeatures string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allowListIds string[]
    Allowlist ID list permitted for access.
    chargeInfo InstanceChargeInfo
    Payment method.
    instanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    maintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    masterNodeId string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    projectName string
    Project.
    serverCollation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    tags InstanceTag[]
    db_engine_version str
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    instance_type str
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    node_spec str
    Instance specification code.
    storage_space int
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    subnet_id str
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    super_account_password str
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    time_zone str
    Time zone.
    vpc_id str
    VPC ID
    zone_id str
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advanced_features str
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allow_list_ids Sequence[str]
    Allowlist ID list permitted for access.
    charge_info InstanceChargeInfoArgs
    Payment method.
    instance_name str
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    maintenance_time str
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    master_node_id str
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    project_name str
    Project.
    server_collation str
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    tags Sequence[InstanceTagArgs]
    dbEngineVersion String
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    instanceType String
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    nodeSpec String
    Instance specification code.
    storageSpace Number
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    subnetId String
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    superAccountPassword String
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    timeZone String
    Time zone.
    vpcId String
    VPC ID
    zoneId String
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advancedFeatures String
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allowListIds List<String>
    Allowlist ID list permitted for access.
    chargeInfo Property Map
    Payment method.
    instanceName String
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    maintenanceTime String
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    masterNodeId String
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    projectName String
    Project.
    serverCollation String
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    tags List<Property Map>

    Outputs

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

    BackupUse double
    Used backup space for the instance, in GiB.
    ConnectionInfos List<Volcengine.InstanceConnectionInfo>
    CreatedTime string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    InnerVersion string
    Kernel version number.
    InstanceCategory string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    InstanceId string
    Instance ID.
    InstanceStatus string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    Memory int
    Memory size, in GiB.
    NodeDetailInfos List<Volcengine.InstanceNodeDetailInfo>
    Port string
    Port.
    PrimaryInstanceId string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    ReadOnlyNumber int
    Number of read-only instances.
    SlowQueryEnable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    SlowQueryTime string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    StorageType string
    Instance storage type.
    StorageUse double
    Used storage space for the instance. Unit: GiB.
    UpdatedTime string
    Update time.
    Vcpu int
    CPU size. For example: 1 means 1 core.
    BackupUse float64
    Used backup space for the instance, in GiB.
    ConnectionInfos []InstanceConnectionInfo
    CreatedTime string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    InnerVersion string
    Kernel version number.
    InstanceCategory string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    InstanceId string
    Instance ID.
    InstanceStatus string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    Memory int
    Memory size, in GiB.
    NodeDetailInfos []InstanceNodeDetailInfo
    Port string
    Port.
    PrimaryInstanceId string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    ReadOnlyNumber int
    Number of read-only instances.
    SlowQueryEnable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    SlowQueryTime string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    StorageType string
    Instance storage type.
    StorageUse float64
    Used storage space for the instance. Unit: GiB.
    UpdatedTime string
    Update time.
    Vcpu int
    CPU size. For example: 1 means 1 core.
    backupUse Double
    Used backup space for the instance, in GiB.
    connectionInfos List<InstanceConnectionInfo>
    createdTime String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    innerVersion String
    Kernel version number.
    instanceCategory String
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instanceId String
    Instance ID.
    instanceStatus String
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    memory Integer
    Memory size, in GiB.
    nodeDetailInfos List<InstanceNodeDetailInfo>
    port String
    Port.
    primaryInstanceId String
    Primary instance ID. If this field is empty, this instance is the primary instance.
    readOnlyNumber Integer
    Number of read-only instances.
    slowQueryEnable Boolean
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slowQueryTime String
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storageType String
    Instance storage type.
    storageUse Double
    Used storage space for the instance. Unit: GiB.
    updatedTime String
    Update time.
    vcpu Integer
    CPU size. For example: 1 means 1 core.
    backupUse number
    Used backup space for the instance, in GiB.
    connectionInfos InstanceConnectionInfo[]
    createdTime string
    Creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    innerVersion string
    Kernel version number.
    instanceCategory string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instanceId string
    Instance ID.
    instanceStatus string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    memory number
    Memory size, in GiB.
    nodeDetailInfos InstanceNodeDetailInfo[]
    port string
    Port.
    primaryInstanceId string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    readOnlyNumber number
    Number of read-only instances.
    slowQueryEnable boolean
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slowQueryTime string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storageType string
    Instance storage type.
    storageUse number
    Used storage space for the instance. Unit: GiB.
    updatedTime string
    Update time.
    vcpu number
    CPU size. For example: 1 means 1 core.
    backup_use float
    Used backup space for the instance, in GiB.
    connection_infos Sequence[InstanceConnectionInfo]
    created_time str
    Creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    inner_version str
    Kernel version number.
    instance_category str
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instance_id str
    Instance ID.
    instance_status str
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    memory int
    Memory size, in GiB.
    node_detail_infos Sequence[InstanceNodeDetailInfo]
    port str
    Port.
    primary_instance_id str
    Primary instance ID. If this field is empty, this instance is the primary instance.
    read_only_number int
    Number of read-only instances.
    slow_query_enable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slow_query_time str
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storage_type str
    Instance storage type.
    storage_use float
    Used storage space for the instance. Unit: GiB.
    updated_time str
    Update time.
    vcpu int
    CPU size. For example: 1 means 1 core.
    backupUse Number
    Used backup space for the instance, in GiB.
    connectionInfos List<Property Map>
    createdTime String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    innerVersion String
    Kernel version number.
    instanceCategory String
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instanceId String
    Instance ID.
    instanceStatus String
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    memory Number
    Memory size, in GiB.
    nodeDetailInfos List<Property Map>
    port String
    Port.
    primaryInstanceId String
    Primary instance ID. If this field is empty, this instance is the primary instance.
    readOnlyNumber Number
    Number of read-only instances.
    slowQueryEnable Boolean
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slowQueryTime String
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storageType String
    Instance storage type.
    storageUse Number
    Used storage space for the instance. Unit: GiB.
    updatedTime String
    Update time.
    vcpu Number
    CPU size. For example: 1 means 1 core.

    Look up Existing Instance Resource

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

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            advanced_features: Optional[str] = None,
            allow_list_ids: Optional[Sequence[str]] = None,
            backup_use: Optional[float] = None,
            charge_info: Optional[InstanceChargeInfoArgs] = None,
            connection_infos: Optional[Sequence[InstanceConnectionInfoArgs]] = None,
            created_time: Optional[str] = None,
            db_engine_version: Optional[str] = None,
            inner_version: Optional[str] = None,
            instance_category: Optional[str] = None,
            instance_id: Optional[str] = None,
            instance_name: Optional[str] = None,
            instance_status: Optional[str] = None,
            instance_type: Optional[str] = None,
            maintenance_time: Optional[str] = None,
            master_node_id: Optional[str] = None,
            memory: Optional[int] = None,
            node_detail_infos: Optional[Sequence[InstanceNodeDetailInfoArgs]] = None,
            node_spec: Optional[str] = None,
            port: Optional[str] = None,
            primary_instance_id: Optional[str] = None,
            project_name: Optional[str] = None,
            read_only_number: Optional[int] = None,
            server_collation: Optional[str] = None,
            slow_query_enable: Optional[bool] = None,
            slow_query_time: Optional[str] = None,
            storage_space: Optional[int] = None,
            storage_type: Optional[str] = None,
            storage_use: Optional[float] = None,
            subnet_id: Optional[str] = None,
            super_account_password: Optional[str] = None,
            tags: Optional[Sequence[InstanceTagArgs]] = None,
            time_zone: Optional[str] = None,
            updated_time: Optional[str] = None,
            vcpu: Optional[int] = None,
            vpc_id: Optional[str] = None,
            zone_id: Optional[str] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:rdsmssql:Instance    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdvancedFeatures string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    AllowListIds List<string>
    Allowlist ID list permitted for access.
    BackupUse double
    Used backup space for the instance, in GiB.
    ChargeInfo Volcengine.InstanceChargeInfo
    Payment method.
    ConnectionInfos List<Volcengine.InstanceConnectionInfo>
    CreatedTime string
    Creation time.
    DbEngineVersion string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    InnerVersion string
    Kernel version number.
    InstanceCategory string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    InstanceStatus string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    InstanceType string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    MaintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    MasterNodeId string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    Memory int
    Memory size, in GiB.
    NodeDetailInfos List<Volcengine.InstanceNodeDetailInfo>
    NodeSpec string
    Instance specification code.
    Port string
    Port.
    PrimaryInstanceId string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    ProjectName string
    Project.
    ReadOnlyNumber int
    Number of read-only instances.
    ServerCollation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    SlowQueryEnable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    SlowQueryTime string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    StorageSpace int
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    StorageType string
    Instance storage type.
    StorageUse double
    Used storage space for the instance. Unit: GiB.
    SubnetId string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    SuperAccountPassword string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    Tags List<Volcengine.InstanceTag>
    TimeZone string
    Time zone.
    UpdatedTime string
    Update time.
    Vcpu int
    CPU size. For example: 1 means 1 core.
    VpcId string
    VPC ID
    ZoneId string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    AdvancedFeatures string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    AllowListIds []string
    Allowlist ID list permitted for access.
    BackupUse float64
    Used backup space for the instance, in GiB.
    ChargeInfo InstanceChargeInfoArgs
    Payment method.
    ConnectionInfos []InstanceConnectionInfoArgs
    CreatedTime string
    Creation time.
    DbEngineVersion string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    InnerVersion string
    Kernel version number.
    InstanceCategory string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    InstanceStatus string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    InstanceType string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    MaintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    MasterNodeId string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    Memory int
    Memory size, in GiB.
    NodeDetailInfos []InstanceNodeDetailInfoArgs
    NodeSpec string
    Instance specification code.
    Port string
    Port.
    PrimaryInstanceId string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    ProjectName string
    Project.
    ReadOnlyNumber int
    Number of read-only instances.
    ServerCollation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    SlowQueryEnable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    SlowQueryTime string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    StorageSpace int
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    StorageType string
    Instance storage type.
    StorageUse float64
    Used storage space for the instance. Unit: GiB.
    SubnetId string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    SuperAccountPassword string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    Tags []InstanceTagArgs
    TimeZone string
    Time zone.
    UpdatedTime string
    Update time.
    Vcpu int
    CPU size. For example: 1 means 1 core.
    VpcId string
    VPC ID
    ZoneId string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advancedFeatures String
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allowListIds List<String>
    Allowlist ID list permitted for access.
    backupUse Double
    Used backup space for the instance, in GiB.
    chargeInfo InstanceChargeInfo
    Payment method.
    connectionInfos List<InstanceConnectionInfo>
    createdTime String
    Creation time.
    dbEngineVersion String
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    innerVersion String
    Kernel version number.
    instanceCategory String
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instanceId String
    Instance ID.
    instanceName String
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    instanceStatus String
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    instanceType String
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    maintenanceTime String
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    masterNodeId String
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    memory Integer
    Memory size, in GiB.
    nodeDetailInfos List<InstanceNodeDetailInfo>
    nodeSpec String
    Instance specification code.
    port String
    Port.
    primaryInstanceId String
    Primary instance ID. If this field is empty, this instance is the primary instance.
    projectName String
    Project.
    readOnlyNumber Integer
    Number of read-only instances.
    serverCollation String
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    slowQueryEnable Boolean
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slowQueryTime String
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storageSpace Integer
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    storageType String
    Instance storage type.
    storageUse Double
    Used storage space for the instance. Unit: GiB.
    subnetId String
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    superAccountPassword String
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    tags List<InstanceTag>
    timeZone String
    Time zone.
    updatedTime String
    Update time.
    vcpu Integer
    CPU size. For example: 1 means 1 core.
    vpcId String
    VPC ID
    zoneId String
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advancedFeatures string
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allowListIds string[]
    Allowlist ID list permitted for access.
    backupUse number
    Used backup space for the instance, in GiB.
    chargeInfo InstanceChargeInfo
    Payment method.
    connectionInfos InstanceConnectionInfo[]
    createdTime string
    Creation time.
    dbEngineVersion string
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    innerVersion string
    Kernel version number.
    instanceCategory string
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instanceId string
    Instance ID.
    instanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    instanceStatus string
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    instanceType string
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    maintenanceTime string
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    masterNodeId string
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    memory number
    Memory size, in GiB.
    nodeDetailInfos InstanceNodeDetailInfo[]
    nodeSpec string
    Instance specification code.
    port string
    Port.
    primaryInstanceId string
    Primary instance ID. If this field is empty, this instance is the primary instance.
    projectName string
    Project.
    readOnlyNumber number
    Number of read-only instances.
    serverCollation string
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    slowQueryEnable boolean
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slowQueryTime string
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storageSpace number
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    storageType string
    Instance storage type.
    storageUse number
    Used storage space for the instance. Unit: GiB.
    subnetId string
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    superAccountPassword string
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    tags InstanceTag[]
    timeZone string
    Time zone.
    updatedTime string
    Update time.
    vcpu number
    CPU size. For example: 1 means 1 core.
    vpcId string
    VPC ID
    zoneId string
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advanced_features str
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allow_list_ids Sequence[str]
    Allowlist ID list permitted for access.
    backup_use float
    Used backup space for the instance, in GiB.
    charge_info InstanceChargeInfoArgs
    Payment method.
    connection_infos Sequence[InstanceConnectionInfoArgs]
    created_time str
    Creation time.
    db_engine_version str
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    inner_version str
    Kernel version number.
    instance_category str
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instance_id str
    Instance ID.
    instance_name str
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    instance_status str
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    instance_type str
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    maintenance_time str
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    master_node_id str
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    memory int
    Memory size, in GiB.
    node_detail_infos Sequence[InstanceNodeDetailInfoArgs]
    node_spec str
    Instance specification code.
    port str
    Port.
    primary_instance_id str
    Primary instance ID. If this field is empty, this instance is the primary instance.
    project_name str
    Project.
    read_only_number int
    Number of read-only instances.
    server_collation str
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    slow_query_enable bool
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slow_query_time str
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storage_space int
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    storage_type str
    Instance storage type.
    storage_use float
    Used storage space for the instance. Unit: GiB.
    subnet_id str
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    super_account_password str
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    tags Sequence[InstanceTagArgs]
    time_zone str
    Time zone.
    updated_time str
    Update time.
    vcpu int
    CPU size. For example: 1 means 1 core.
    vpc_id str
    VPC ID
    zone_id str
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.
    advancedFeatures String
    Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
    allowListIds List<String>
    Allowlist ID list permitted for access.
    backupUse Number
    Used backup space for the instance, in GiB.
    chargeInfo Property Map
    Payment method.
    connectionInfos List<Property Map>
    createdTime String
    Creation time.
    dbEngineVersion String
    Compatible version. Values: SQLServer2019Std: SQL Server 2019 Standard Edition. SQLServer2019Ent: SQL Server 2019 Enterprise Edition. SQLServer2019Web: SQL Server 2019 Web Edition. SQLServer2022Std: SQL Server 2022 Standard Edition. SQLServer2022Ent: SQL Server 2022 Enterprise Edition. SQLServer2022Web: SQL Server 2022 Web Edition.
    innerVersion String
    Kernel version number.
    instanceCategory String
    Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
    instanceId String
    Instance ID.
    instanceName String
    Instance name. Naming rules: Cannot start with a digit or hyphen. Can only contain Chinese characters, letters, digits, underscores, and hyphens. Length must be between 1 and 128 characters.
    instanceStatus String
    Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
    instanceType String
    Instance type. Available values: HA (High Availability), Basic, Cluster. Supported types vary by engine version: 2019 Std supports HA/Basic; 2019 Ent supports Cluster/Basic; 2019 Web supports Basic.
    maintenanceTime String
    Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time). Default: UTC18:00Z-21:59Z (Beijing time 02:00-05:59). Note: To ensure cloud database stability, the system performs maintenance on instances periodically. It is recommended to set the maintenance window during off-peak hours to avoid business impact. During the maintenance window, the instance may experience 1–2 brief disconnections. Ensure your application supports automatic reconnection. The minimum maintenance window is 1 hour, the maximum is 24 hours, and cross-day maintenance windows are not allowed.
    masterNodeId String
    Primary node ID. This parameter is required when manually switching master and standby nodes.
    memory Number
    Memory size, in GiB.
    nodeDetailInfos List<Property Map>
    nodeSpec String
    Instance specification code.
    port String
    Port.
    primaryInstanceId String
    Primary instance ID. If this field is empty, this instance is the primary instance.
    projectName String
    Project.
    readOnlyNumber Number
    Number of read-only instances.
    serverCollation String
    Instance collation. Default: ChinesePRCCIAS. Most native collations are supported. Available values: Latin1GeneralCIAS, Latin1GeneralCSAS, SQLLatin1GeneralCP1CIAS, SQLLatin1GeneralCP1CSAS, ChinesePRCCIAS, ChinesePRCCSAS, ChinesePRCBIN, JapaneseCIAS, JapaneseCSAS, ChineseTaiwanStrokeCIAS, ChineseTaiwanStrokeCSAS, ThaiCIAS, ChinesePRCCIAI, ChinesePRCBIN2, CyrillicGeneralCI_AS.
    slowQueryEnable Boolean
    Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
    slowQueryTime String
    Slow log threshold. Range: [1~10], unit: seconds (s).
    storageSpace Number
    Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
    storageType String
    Instance storage type.
    storageUse Number
    Used storage space for the instance. Unit: GiB.
    subnetId String
    Subnet ID. If the primary and standby nodes are in different availability zones, their subnets must be set to the corresponding private network subnets for each zone. Use a semicolon (;) to separate multiple zones.
    superAccountPassword String
    Password for the high-privilege account. Password rules: 8–32 characters; must include at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Allowed special characters: !@#$%^&*()_+-=.
    tags List<Property Map>
    timeZone String
    Time zone.
    updatedTime String
    Update time.
    vcpu Number
    CPU size. For example: 1 means 1 core.
    vpcId String
    VPC ID
    zoneId String
    Availability zone of the node. If the primary and standby nodes are in different availability zones, use a semicolon (;) to separate them. The first is the primary node's zone by default, the second is the standby node's zone.

    Supporting Types

    InstanceChargeInfo, InstanceChargeInfoArgs

    AutoRenew bool
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    ChargeEndTime string
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    ChargeStartTime string
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    ChargeStatus string
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    ChargeType string
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    OverdueReclaimTime string
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    OverdueTime string
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    Period int
    Purchase duration for prepaid scenarios. Default: 1 month.
    PeriodUnit string
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
    AutoRenew bool
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    ChargeEndTime string
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    ChargeStartTime string
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    ChargeStatus string
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    ChargeType string
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    OverdueReclaimTime string
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    OverdueTime string
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    Period int
    Purchase duration for prepaid scenarios. Default: 1 month.
    PeriodUnit string
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
    autoRenew Boolean
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    chargeEndTime String
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    chargeStartTime String
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    chargeStatus String
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    chargeType String
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    overdueReclaimTime String
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    overdueTime String
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    period Integer
    Purchase duration for prepaid scenarios. Default: 1 month.
    periodUnit String
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
    autoRenew boolean
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    chargeEndTime string
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    chargeStartTime string
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    chargeStatus string
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    chargeType string
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    overdueReclaimTime string
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    overdueTime string
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    period number
    Purchase duration for prepaid scenarios. Default: 1 month.
    periodUnit string
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
    auto_renew bool
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    charge_end_time str
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    charge_start_time str
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    charge_status str
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    charge_type str
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    overdue_reclaim_time str
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    overdue_time str
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    period int
    Purchase duration for prepaid scenarios. Default: 1 month.
    period_unit str
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
    autoRenew Boolean
    Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
    chargeEndTime String
    Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    chargeStartTime String
    Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    chargeStatus String
    Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
    chargeType String
    Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
    overdueReclaimTime String
    Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
    overdueTime String
    Shutdown time due to overdue payment, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
    period Number
    Purchase duration for prepaid scenarios. Default: 1 month.
    periodUnit String
    Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.

    InstanceConnectionInfo, InstanceConnectionInfoArgs

    Addresses List<Volcengine.InstanceConnectionInfoAddress>
    Description string
    Description.
    EndpointId string
    Terminal ID.
    EndpointName string
    Terminal name.
    EndpointType string
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
    Addresses []InstanceConnectionInfoAddress
    Description string
    Description.
    EndpointId string
    Terminal ID.
    EndpointName string
    Terminal name.
    EndpointType string
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
    addresses List<InstanceConnectionInfoAddress>
    description String
    Description.
    endpointId String
    Terminal ID.
    endpointName String
    Terminal name.
    endpointType String
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
    addresses InstanceConnectionInfoAddress[]
    description string
    Description.
    endpointId string
    Terminal ID.
    endpointName string
    Terminal name.
    endpointType string
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
    addresses Sequence[InstanceConnectionInfoAddress]
    description str
    Description.
    endpoint_id str
    Terminal ID.
    endpoint_name str
    Terminal name.
    endpoint_type str
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
    addresses List<Property Map>
    description String
    Description.
    endpointId String
    Terminal ID.
    endpointName String
    Terminal name.
    endpointType String
    Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.

    InstanceConnectionInfoAddress, InstanceConnectionInfoAddressArgs

    DnsVisibility bool
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    Domain string
    Domain name.
    EipId string
    EIP ID, valid only for public addresses.
    IpAddress string
    IP address.
    NetworkType string
    Network address type. Possible values: Private: private network type. Public: public network type.
    Port string
    Port.
    SubnetId string
    Subnet ID, valid only for private network addresses.
    DnsVisibility bool
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    Domain string
    Domain name.
    EipId string
    EIP ID, valid only for public addresses.
    IpAddress string
    IP address.
    NetworkType string
    Network address type. Possible values: Private: private network type. Public: public network type.
    Port string
    Port.
    SubnetId string
    Subnet ID, valid only for private network addresses.
    dnsVisibility Boolean
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    domain String
    Domain name.
    eipId String
    EIP ID, valid only for public addresses.
    ipAddress String
    IP address.
    networkType String
    Network address type. Possible values: Private: private network type. Public: public network type.
    port String
    Port.
    subnetId String
    Subnet ID, valid only for private network addresses.
    dnsVisibility boolean
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    domain string
    Domain name.
    eipId string
    EIP ID, valid only for public addresses.
    ipAddress string
    IP address.
    networkType string
    Network address type. Possible values: Private: private network type. Public: public network type.
    port string
    Port.
    subnetId string
    Subnet ID, valid only for private network addresses.
    dns_visibility bool
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    domain str
    Domain name.
    eip_id str
    EIP ID, valid only for public addresses.
    ip_address str
    IP address.
    network_type str
    Network address type. Possible values: Private: private network type. Public: public network type.
    port str
    Port.
    subnet_id str
    Subnet ID, valid only for private network addresses.
    dnsVisibility Boolean
    Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
    domain String
    Domain name.
    eipId String
    EIP ID, valid only for public addresses.
    ipAddress String
    IP address.
    networkType String
    Network address type. Possible values: Private: private network type. Public: public network type.
    port String
    Port.
    subnetId String
    Subnet ID, valid only for private network addresses.

    InstanceNodeDetailInfo, InstanceNodeDetailInfoArgs

    CreateTime string
    Node creation time.
    HostName string
    Node hostname.
    InstanceId string
    Instance ID.
    Memory int
    Memory size, in GiB.
    NodeId string
    Node ID.
    NodeIp string
    Node IP.
    NodeSpec string
    Node specification.
    NodeStatus string
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    NodeType string
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    RegionId string
    Region ID.
    UpdateTime string
    Update time.
    Vcpu int
    vCPU count.
    ZoneId string
    Availability zone ID.
    CreateTime string
    Node creation time.
    HostName string
    Node hostname.
    InstanceId string
    Instance ID.
    Memory int
    Memory size, in GiB.
    NodeId string
    Node ID.
    NodeIp string
    Node IP.
    NodeSpec string
    Node specification.
    NodeStatus string
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    NodeType string
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    RegionId string
    Region ID.
    UpdateTime string
    Update time.
    Vcpu int
    vCPU count.
    ZoneId string
    Availability zone ID.
    createTime String
    Node creation time.
    hostName String
    Node hostname.
    instanceId String
    Instance ID.
    memory Integer
    Memory size, in GiB.
    nodeId String
    Node ID.
    nodeIp String
    Node IP.
    nodeSpec String
    Node specification.
    nodeStatus String
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    nodeType String
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    regionId String
    Region ID.
    updateTime String
    Update time.
    vcpu Integer
    vCPU count.
    zoneId String
    Availability zone ID.
    createTime string
    Node creation time.
    hostName string
    Node hostname.
    instanceId string
    Instance ID.
    memory number
    Memory size, in GiB.
    nodeId string
    Node ID.
    nodeIp string
    Node IP.
    nodeSpec string
    Node specification.
    nodeStatus string
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    nodeType string
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    regionId string
    Region ID.
    updateTime string
    Update time.
    vcpu number
    vCPU count.
    zoneId string
    Availability zone ID.
    create_time str
    Node creation time.
    host_name str
    Node hostname.
    instance_id str
    Instance ID.
    memory int
    Memory size, in GiB.
    node_id str
    Node ID.
    node_ip str
    Node IP.
    node_spec str
    Node specification.
    node_status str
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    node_type str
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    region_id str
    Region ID.
    update_time str
    Update time.
    vcpu int
    vCPU count.
    zone_id str
    Availability zone ID.
    createTime String
    Node creation time.
    hostName String
    Node hostname.
    instanceId String
    Instance ID.
    memory Number
    Memory size, in GiB.
    nodeId String
    Node ID.
    nodeIp String
    Node IP.
    nodeSpec String
    Node specification.
    nodeStatus String
    Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
    nodeType String
    Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
    regionId String
    Region ID.
    updateTime String
    Update time.
    vcpu Number
    vCPU count.
    zoneId String
    Availability zone ID.

    InstanceTag, InstanceTagArgs

    Key string
    Tag key for user tags.
    Value string
    User tag value.
    Key string
    Tag key for user tags.
    Value string
    User tag value.
    key String
    Tag key for user tags.
    value String
    User tag value.
    key string
    Tag key for user tags.
    value string
    User tag value.
    key str
    Tag key for user tags.
    value str
    User tag value.
    key String
    Tag key for user tags.
    value String
    User tag value.

    Import

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

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

    Package Details

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