published on Thursday, Apr 23, 2026 by Volcengine
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:
- Db
Engine stringVersion - 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 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.
- Node
Spec string - Instance specification code.
- Storage
Space int - Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
- Subnet
Id 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.
- Super
Account stringPassword - 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 string - Time zone.
- Vpc
Id string - VPC ID
- Zone
Id 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 string - Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
- Allow
List List<string>Ids - Allowlist ID list permitted for access.
- Charge
Info Volcengine.Instance Charge Info - Payment method.
- Instance
Name 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.
- Maintenance
Time 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.
- Master
Node stringId - Primary node ID. This parameter is required when manually switching master and standby nodes.
- Project
Name string - Project.
- Server
Collation 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.
-
List<Volcengine.
Instance Tag>
- Db
Engine stringVersion - 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 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.
- Node
Spec string - Instance specification code.
- Storage
Space int - Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
- Subnet
Id 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.
- Super
Account stringPassword - 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 string - Time zone.
- Vpc
Id string - VPC ID
- Zone
Id 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 string - Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
- Allow
List []stringIds - Allowlist ID list permitted for access.
- Charge
Info InstanceCharge Info Args - Payment method.
- Instance
Name 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.
- Maintenance
Time 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.
- Master
Node stringId - Primary node ID. This parameter is required when manually switching master and standby nodes.
- Project
Name string - Project.
- Server
Collation 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.
-
[]Instance
Tag Args
- db
Engine StringVersion - 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 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.
- node
Spec String - Instance specification code.
- storage
Space Integer - Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
- subnet
Id 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.
- super
Account StringPassword - 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 String - Time zone.
- vpc
Id String - VPC ID
- zone
Id 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 String - Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
- allow
List List<String>Ids - Allowlist ID list permitted for access.
- charge
Info InstanceCharge Info - Payment method.
- instance
Name 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.
- maintenance
Time 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.
- master
Node StringId - Primary node ID. This parameter is required when manually switching master and standby nodes.
- project
Name String - Project.
- server
Collation 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.
-
List<Instance
Tag>
- db
Engine stringVersion - 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 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.
- node
Spec string - Instance specification code.
- storage
Space number - Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
- subnet
Id 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.
- super
Account stringPassword - 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 string - Time zone.
- vpc
Id string - VPC ID
- zone
Id 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 string - Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
- allow
List string[]Ids - Allowlist ID list permitted for access.
- charge
Info InstanceCharge Info - Payment method.
- instance
Name 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.
- maintenance
Time 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.
- master
Node stringId - Primary node ID. This parameter is required when manually switching master and standby nodes.
- project
Name string - Project.
- server
Collation 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.
-
Instance
Tag[]
- db_
engine_ strversion - 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_ strpassword - 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_ Sequence[str]ids - Allowlist ID list permitted for access.
- charge_
info InstanceCharge Info Args - 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_ strid - 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.
-
Sequence[Instance
Tag Args]
- db
Engine StringVersion - 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 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.
- node
Spec String - Instance specification code.
- storage
Space Number - Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
- subnet
Id 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.
- super
Account StringPassword - 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 String - Time zone.
- vpc
Id String - VPC ID
- zone
Id 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 String - Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
- allow
List List<String>Ids - Allowlist ID list permitted for access.
- charge
Info Property Map - Payment method.
- instance
Name 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.
- maintenance
Time 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.
- master
Node StringId - Primary node ID. This parameter is required when manually switching master and standby nodes.
- project
Name String - Project.
- server
Collation 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.
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- Backup
Use double - Used backup space for the instance, in GiB.
- Connection
Infos List<Volcengine.Instance Connection Info> - Created
Time string - Creation time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Inner
Version string - Kernel version number.
- Instance
Category string - Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
- Instance
Id string - Instance ID.
- Instance
Status 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.
- Node
Detail List<Volcengine.Infos Instance Node Detail Info> - Port string
- Port.
- Primary
Instance stringId - Primary instance ID. If this field is empty, this instance is the primary instance.
- Read
Only intNumber - Number of read-only instances.
- Slow
Query boolEnable - Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
- Slow
Query stringTime - Slow log threshold. Range: [1~10], unit: seconds (s).
- Storage
Type string - Instance storage type.
- Storage
Use double - Used storage space for the instance. Unit: GiB.
- Updated
Time string - Update time.
- Vcpu int
- CPU size. For example: 1 means 1 core.
- Backup
Use float64 - Used backup space for the instance, in GiB.
- Connection
Infos []InstanceConnection Info - Created
Time string - Creation time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Inner
Version string - Kernel version number.
- Instance
Category string - Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
- Instance
Id string - Instance ID.
- Instance
Status 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.
- Node
Detail []InstanceInfos Node Detail Info - Port string
- Port.
- Primary
Instance stringId - Primary instance ID. If this field is empty, this instance is the primary instance.
- Read
Only intNumber - Number of read-only instances.
- Slow
Query boolEnable - Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
- Slow
Query stringTime - Slow log threshold. Range: [1~10], unit: seconds (s).
- Storage
Type string - Instance storage type.
- Storage
Use float64 - Used storage space for the instance. Unit: GiB.
- Updated
Time string - Update time.
- Vcpu int
- CPU size. For example: 1 means 1 core.
- backup
Use Double - Used backup space for the instance, in GiB.
- connection
Infos List<InstanceConnection Info> - created
Time String - Creation time.
- id String
- The provider-assigned unique ID for this managed resource.
- inner
Version String - Kernel version number.
- instance
Category String - Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
- instance
Id String - Instance ID.
- instance
Status 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.
- node
Detail List<InstanceInfos Node Detail Info> - port String
- Port.
- primary
Instance StringId - Primary instance ID. If this field is empty, this instance is the primary instance.
- read
Only IntegerNumber - Number of read-only instances.
- slow
Query BooleanEnable - Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
- slow
Query StringTime - Slow log threshold. Range: [1~10], unit: seconds (s).
- storage
Type String - Instance storage type.
- storage
Use Double - Used storage space for the instance. Unit: GiB.
- updated
Time String - Update time.
- vcpu Integer
- CPU size. For example: 1 means 1 core.
- backup
Use number - Used backup space for the instance, in GiB.
- connection
Infos InstanceConnection Info[] - created
Time string - Creation time.
- id string
- The provider-assigned unique ID for this managed resource.
- inner
Version string - Kernel version number.
- instance
Category string - Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
- instance
Id string - Instance ID.
- instance
Status 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.
- node
Detail InstanceInfos Node Detail Info[] - port string
- Port.
- primary
Instance stringId - Primary instance ID. If this field is empty, this instance is the primary instance.
- read
Only numberNumber - Number of read-only instances.
- slow
Query booleanEnable - Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
- slow
Query stringTime - Slow log threshold. Range: [1~10], unit: seconds (s).
- storage
Type string - Instance storage type.
- storage
Use number - Used storage space for the instance. Unit: GiB.
- updated
Time 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[InstanceConnection Info] - 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_ Sequence[Instanceinfos Node Detail Info] - port str
- Port.
- primary_
instance_ strid - Primary instance ID. If this field is empty, this instance is the primary instance.
- read_
only_ intnumber - Number of read-only instances.
- slow_
query_ boolenable - Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
- slow_
query_ strtime - 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.
- backup
Use Number - Used backup space for the instance, in GiB.
- connection
Infos List<Property Map> - created
Time String - Creation time.
- id String
- The provider-assigned unique ID for this managed resource.
- inner
Version String - Kernel version number.
- instance
Category String - Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
- instance
Id String - Instance ID.
- instance
Status 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.
- node
Detail List<Property Map>Infos - port String
- Port.
- primary
Instance StringId - Primary instance ID. If this field is empty, this instance is the primary instance.
- read
Only NumberNumber - Number of read-only instances.
- slow
Query BooleanEnable - Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
- slow
Query StringTime - Slow log threshold. Range: [1~10], unit: seconds (s).
- storage
Type String - Instance storage type.
- storage
Use Number - Used storage space for the instance. Unit: GiB.
- updated
Time 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) -> Instancefunc 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.
- Advanced
Features string - Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
- Allow
List List<string>Ids - Allowlist ID list permitted for access.
- Backup
Use double - Used backup space for the instance, in GiB.
- Charge
Info Volcengine.Instance Charge Info - Payment method.
- Connection
Infos List<Volcengine.Instance Connection Info> - Created
Time string - Creation time.
- Db
Engine stringVersion - 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 string - Kernel version number.
- Instance
Category string - Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
- Instance
Id string - Instance ID.
- Instance
Name 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.
- Instance
Status string - Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
- Instance
Type 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.
- Maintenance
Time 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.
- Master
Node stringId - Primary node ID. This parameter is required when manually switching master and standby nodes.
- Memory int
- Memory size, in GiB.
- Node
Detail List<Volcengine.Infos Instance Node Detail Info> - Node
Spec string - Instance specification code.
- Port string
- Port.
- Primary
Instance stringId - Primary instance ID. If this field is empty, this instance is the primary instance.
- Project
Name string - Project.
- Read
Only intNumber - Number of read-only instances.
- Server
Collation 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.
- Slow
Query boolEnable - Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
- Slow
Query stringTime - 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 string - Instance storage type.
- Storage
Use double - Used storage space for the instance. Unit: GiB.
- Subnet
Id 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.
- Super
Account stringPassword - 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: !@#$%^&*()_+-=.
-
List<Volcengine.
Instance Tag> - Time
Zone string - Time zone.
- Updated
Time string - Update time.
- Vcpu int
- CPU size. For example: 1 means 1 core.
- Vpc
Id string - VPC ID
- Zone
Id 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 string - Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
- Allow
List []stringIds - Allowlist ID list permitted for access.
- Backup
Use float64 - Used backup space for the instance, in GiB.
- Charge
Info InstanceCharge Info Args - Payment method.
- Connection
Infos []InstanceConnection Info Args - Created
Time string - Creation time.
- Db
Engine stringVersion - 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 string - Kernel version number.
- Instance
Category string - Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
- Instance
Id string - Instance ID.
- Instance
Name 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.
- Instance
Status string - Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
- Instance
Type 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.
- Maintenance
Time 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.
- Master
Node stringId - Primary node ID. This parameter is required when manually switching master and standby nodes.
- Memory int
- Memory size, in GiB.
- Node
Detail []InstanceInfos Node Detail Info Args - Node
Spec string - Instance specification code.
- Port string
- Port.
- Primary
Instance stringId - Primary instance ID. If this field is empty, this instance is the primary instance.
- Project
Name string - Project.
- Read
Only intNumber - Number of read-only instances.
- Server
Collation 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.
- Slow
Query boolEnable - Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
- Slow
Query stringTime - 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 string - Instance storage type.
- Storage
Use float64 - Used storage space for the instance. Unit: GiB.
- Subnet
Id 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.
- Super
Account stringPassword - 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: !@#$%^&*()_+-=.
-
[]Instance
Tag Args - Time
Zone string - Time zone.
- Updated
Time string - Update time.
- Vcpu int
- CPU size. For example: 1 means 1 core.
- Vpc
Id string - VPC ID
- Zone
Id 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 String - Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
- allow
List List<String>Ids - Allowlist ID list permitted for access.
- backup
Use Double - Used backup space for the instance, in GiB.
- charge
Info InstanceCharge Info - Payment method.
- connection
Infos List<InstanceConnection Info> - created
Time String - Creation time.
- db
Engine StringVersion - 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 String - Kernel version number.
- instance
Category String - Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
- instance
Id String - Instance ID.
- instance
Name 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.
- instance
Status String - Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
- instance
Type 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.
- maintenance
Time 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.
- master
Node StringId - Primary node ID. This parameter is required when manually switching master and standby nodes.
- memory Integer
- Memory size, in GiB.
- node
Detail List<InstanceInfos Node Detail Info> - node
Spec String - Instance specification code.
- port String
- Port.
- primary
Instance StringId - Primary instance ID. If this field is empty, this instance is the primary instance.
- project
Name String - Project.
- read
Only IntegerNumber - Number of read-only instances.
- server
Collation 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.
- slow
Query BooleanEnable - Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
- slow
Query StringTime - Slow log threshold. Range: [1~10], unit: seconds (s).
- storage
Space Integer - Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
- storage
Type String - Instance storage type.
- storage
Use Double - Used storage space for the instance. Unit: GiB.
- subnet
Id 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.
- super
Account StringPassword - 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: !@#$%^&*()_+-=.
-
List<Instance
Tag> - time
Zone String - Time zone.
- updated
Time String - Update time.
- vcpu Integer
- CPU size. For example: 1 means 1 core.
- vpc
Id String - VPC ID
- zone
Id 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 string - Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
- allow
List string[]Ids - Allowlist ID list permitted for access.
- backup
Use number - Used backup space for the instance, in GiB.
- charge
Info InstanceCharge Info - Payment method.
- connection
Infos InstanceConnection Info[] - created
Time string - Creation time.
- db
Engine stringVersion - 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 string - Kernel version number.
- instance
Category string - Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
- instance
Id string - Instance ID.
- instance
Name 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.
- instance
Status string - Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
- instance
Type 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.
- maintenance
Time 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.
- master
Node stringId - Primary node ID. This parameter is required when manually switching master and standby nodes.
- memory number
- Memory size, in GiB.
- node
Detail InstanceInfos Node Detail Info[] - node
Spec string - Instance specification code.
- port string
- Port.
- primary
Instance stringId - Primary instance ID. If this field is empty, this instance is the primary instance.
- project
Name string - Project.
- read
Only numberNumber - Number of read-only instances.
- server
Collation 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.
- slow
Query booleanEnable - Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
- slow
Query stringTime - Slow log threshold. Range: [1~10], unit: seconds (s).
- storage
Space number - Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
- storage
Type string - Instance storage type.
- storage
Use number - Used storage space for the instance. Unit: GiB.
- subnet
Id 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.
- super
Account stringPassword - 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: !@#$%^&*()_+-=.
-
Instance
Tag[] - time
Zone string - Time zone.
- updated
Time string - Update time.
- vcpu number
- CPU size. For example: 1 means 1 core.
- vpc
Id string - VPC ID
- zone
Id 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_ Sequence[str]ids - Allowlist ID list permitted for access.
- backup_
use float - Used backup space for the instance, in GiB.
- charge_
info InstanceCharge Info Args - Payment method.
- connection_
infos Sequence[InstanceConnection Info Args] - created_
time str - Creation time.
- db_
engine_ strversion - 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_ strid - Primary node ID. This parameter is required when manually switching master and standby nodes.
- memory int
- Memory size, in GiB.
- node_
detail_ Sequence[Instanceinfos Node Detail Info Args] - node_
spec str - Instance specification code.
- port str
- Port.
- primary_
instance_ strid - Primary instance ID. If this field is empty, this instance is the primary instance.
- project_
name str - Project.
- read_
only_ intnumber - 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_ boolenable - Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
- slow_
query_ strtime - 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_ strpassword - 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: !@#$%^&*()_+-=.
-
Sequence[Instance
Tag Args] - 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.
- advanced
Features String - Advanced instance features to modify. This API currently requires allowlisting. To use it, contact technical support. Example value: {"Key":"Value"}
- allow
List List<String>Ids - Allowlist ID list permitted for access.
- backup
Use Number - Used backup space for the instance, in GiB.
- charge
Info Property Map - Payment method.
- connection
Infos List<Property Map> - created
Time String - Creation time.
- db
Engine StringVersion - 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 String - Kernel version number.
- instance
Category String - Instance category. Values: Primary: primary instance. ReadOnly: read-only instance.
- instance
Id String - Instance ID.
- instance
Name 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.
- instance
Status String - Instance status. Values: Running: running. Creating: creating. CreateFailed: creation failed. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: primary node switching. Error: error.
- instance
Type 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.
- maintenance
Time 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.
- master
Node StringId - Primary node ID. This parameter is required when manually switching master and standby nodes.
- memory Number
- Memory size, in GiB.
- node
Detail List<Property Map>Infos - node
Spec String - Instance specification code.
- port String
- Port.
- primary
Instance StringId - Primary instance ID. If this field is empty, this instance is the primary instance.
- project
Name String - Project.
- read
Only NumberNumber - Number of read-only instances.
- server
Collation 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.
- slow
Query BooleanEnable - Indicates whether slow logs are enabled. Available values: true: slow logs enabled. false: slow logs disabled.
- slow
Query StringTime - Slow log threshold. Range: [1~10], unit: seconds (s).
- storage
Space Number - Storage size, in GiB. Range: 20 GiB ~ 4000 GiB, increment: 10 GiB.
- storage
Type String - Instance storage type.
- storage
Use Number - Used storage space for the instance. Unit: GiB.
- subnet
Id 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.
- super
Account StringPassword - 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: !@#$%^&*()_+-=.
- List<Property Map>
- time
Zone String - Time zone.
- updated
Time String - Update time.
- vcpu Number
- CPU size. For example: 1 means 1 core.
- vpc
Id String - VPC ID
- zone
Id 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
- Auto
Renew bool - Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
- Charge
End stringTime - Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
- Charge
Start stringTime - Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
- Charge
Status string - Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
- Charge
Type string - Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
- Overdue
Reclaim stringTime - Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
- Overdue
Time 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.
- Period
Unit 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 stringTime - Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
- Charge
Start stringTime - Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
- Charge
Status string - Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
- Charge
Type string - Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
- Overdue
Reclaim stringTime - Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
- Overdue
Time 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.
- Period
Unit string - Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
- auto
Renew Boolean - Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
- charge
End StringTime - Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
- charge
Start StringTime - Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
- charge
Status String - Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
- charge
Type String - Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
- overdue
Reclaim StringTime - Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
- overdue
Time 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.
- period
Unit String - Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
- auto
Renew boolean - Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
- charge
End stringTime - Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
- charge
Start stringTime - Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
- charge
Status string - Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
- charge
Type string - Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
- overdue
Reclaim stringTime - Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
- overdue
Time 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.
- period
Unit 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_ strtime - Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
- charge_
start_ strtime - 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_ strtime - 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.
- auto
Renew Boolean - Auto-renewal for prepaid scenarios. true: auto-renew (default). false: do not auto-renew.
- charge
End StringTime - Billing expiration time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
- charge
Start StringTime - Billing start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC time).
- charge
Status String - Payment status. Possible values: Normal: instance is normal. Overdue: instance is overdue. Unpaid: instance is awaiting payment.
- charge
Type String - Billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription.
- overdue
Reclaim StringTime - Estimated release time when service is suspended due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
- overdue
Time 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.
- period
Unit String - Purchase cycle for prepaid scenarios. Month: monthly subscription (default). Year: annual subscription.
InstanceConnectionInfo, InstanceConnectionInfoArgs
- Addresses
List<Volcengine.
Instance Connection Info Address> - Description string
- Description.
- Endpoint
Id string - Terminal ID.
- Endpoint
Name string - Terminal name.
- Endpoint
Type string - Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
- Addresses
[]Instance
Connection Info Address - Description string
- Description.
- Endpoint
Id string - Terminal ID.
- Endpoint
Name string - Terminal name.
- Endpoint
Type string - Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
- addresses
List<Instance
Connection Info Address> - description String
- Description.
- endpoint
Id String - Terminal ID.
- endpoint
Name String - Terminal name.
- endpoint
Type String - Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
- addresses
Instance
Connection Info Address[] - description string
- Description.
- endpoint
Id string - Terminal ID.
- endpoint
Name string - Terminal name.
- endpoint
Type string - Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
- addresses
Sequence[Instance
Connection Info Address] - 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.
- endpoint
Id String - Terminal ID.
- endpoint
Name String - Terminal name.
- endpoint
Type String - Terminal type. Possible values: Primary: primary node terminal. ROCluster: read-only cluster terminal. RO: read-only node terminal.
InstanceConnectionInfoAddress, InstanceConnectionInfoAddressArgs
- Dns
Visibility bool - Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
- Domain string
- Domain name.
- Eip
Id string - EIP ID, valid only for public addresses.
- Ip
Address string - IP address.
- Network
Type string - Network address type. Possible values: Private: private network type. Public: public network type.
- Port string
- Port.
- Subnet
Id 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 string
- Domain name.
- Eip
Id string - EIP ID, valid only for public addresses.
- Ip
Address string - IP address.
- Network
Type string - Network address type. Possible values: Private: private network type. Public: public network type.
- Port string
- Port.
- Subnet
Id string - Subnet ID, valid only for private network addresses.
- dns
Visibility Boolean - Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
- domain String
- Domain name.
- eip
Id String - EIP ID, valid only for public addresses.
- ip
Address String - IP address.
- network
Type String - Network address type. Possible values: Private: private network type. Public: public network type.
- port String
- Port.
- subnet
Id String - Subnet ID, valid only for private network addresses.
- dns
Visibility boolean - Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
- domain string
- Domain name.
- eip
Id string - EIP ID, valid only for public addresses.
- ip
Address string - IP address.
- network
Type string - Network address type. Possible values: Private: private network type. Public: public network type.
- port string
- Port.
- subnet
Id 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.
- dns
Visibility Boolean - Indicates whether private network to public network resolution is enabled. Available values: true: enabled. false: disabled.
- domain String
- Domain name.
- eip
Id String - EIP ID, valid only for public addresses.
- ip
Address String - IP address.
- network
Type String - Network address type. Possible values: Private: private network type. Public: public network type.
- port String
- Port.
- subnet
Id String - Subnet ID, valid only for private network addresses.
InstanceNodeDetailInfo, InstanceNodeDetailInfoArgs
- Create
Time string - Node creation time.
- Host
Name string - Node hostname.
- Instance
Id string - Instance ID.
- Memory int
- Memory size, in GiB.
- Node
Id string - Node ID.
- Node
Ip string - Node IP.
- Node
Spec string - Node specification.
- Node
Status string - Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
- Node
Type string - Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
- Region
Id string - Region ID.
- Update
Time string - Update time.
- Vcpu int
- vCPU count.
- Zone
Id string - Availability zone ID.
- Create
Time string - Node creation time.
- Host
Name string - Node hostname.
- Instance
Id string - Instance ID.
- Memory int
- Memory size, in GiB.
- Node
Id string - Node ID.
- Node
Ip string - Node IP.
- Node
Spec string - Node specification.
- Node
Status string - Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
- Node
Type string - Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
- Region
Id string - Region ID.
- Update
Time string - Update time.
- Vcpu int
- vCPU count.
- Zone
Id string - Availability zone ID.
- create
Time String - Node creation time.
- host
Name String - Node hostname.
- instance
Id String - Instance ID.
- memory Integer
- Memory size, in GiB.
- node
Id String - Node ID.
- node
Ip String - Node IP.
- node
Spec String - Node specification.
- node
Status String - Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
- node
Type String - Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
- region
Id String - Region ID.
- update
Time String - Update time.
- vcpu Integer
- vCPU count.
- zone
Id String - Availability zone ID.
- create
Time string - Node creation time.
- host
Name string - Node hostname.
- instance
Id string - Instance ID.
- memory number
- Memory size, in GiB.
- node
Id string - Node ID.
- node
Ip string - Node IP.
- node
Spec string - Node specification.
- node
Status string - Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
- node
Type string - Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
- region
Id string - Region ID.
- update
Time string - Update time.
- vcpu number
- vCPU count.
- zone
Id 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.
- create
Time String - Node creation time.
- host
Name String - Node hostname.
- instance
Id String - Instance ID.
- memory Number
- Memory size, in GiB.
- node
Id String - Node ID.
- node
Ip String - Node IP.
- node
Spec String - Node specification.
- node
Status String - Node status. Possible values: Running: running. Creating: creating. Deleting: deleting. Restarting: restarting. Updating: updating. MasterChanging: master/standby switching. Error: error.
- node
Type String - Node type. Possible values: Primary: primary node terminal. ReadOnly: read-only node terminal. Secondary: standby node terminal.
- region
Id String - Region ID.
- update
Time String - Update time.
- vcpu Number
- vCPU count.
- zone
Id String - Availability zone ID.
InstanceTag, InstanceTagArgs
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
volcengineccTerraform Provider.
published on Thursday, Apr 23, 2026 by Volcengine
