volcenginecc.rdsmssql.getInstance

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>

def get_instance(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]

func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

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

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

public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

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

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getInstance Result

The following output properties are available:

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.GetInstanceChargeInfo: Payment method.
ConnectionInfos List<Volcengine.GetInstanceConnectionInfo>: Connection information.
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.
Id string: Uniquely identifies the resource.
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.GetInstanceNodeDetailInfo>: Instance node information.
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.GetInstanceTag>: Tag list.
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 GetInstanceChargeInfo: Payment method.
ConnectionInfos []GetInstanceConnectionInfo: Connection information.
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.
Id string: Uniquely identifies the resource.
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 []GetInstanceNodeDetailInfo: Instance node information.
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 []GetInstanceTag: Tag list.
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 GetInstanceChargeInfo: Payment method.
connectionInfos List<GetInstanceConnectionInfo>: Connection information.
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.
id String: Uniquely identifies the resource.
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<GetInstanceNodeDetailInfo>: Instance node information.
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<GetInstanceTag>: Tag list.
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 GetInstanceChargeInfo: Payment method.
connectionInfos GetInstanceConnectionInfo[]: Connection information.
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.
id string: Uniquely identifies the resource.
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 GetInstanceNodeDetailInfo[]: Instance node information.
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 GetInstanceTag[]: Tag list.
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 GetInstanceChargeInfo: Payment method.
connection_infos Sequence[GetInstanceConnectionInfo]: Connection information.
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.
id str: Uniquely identifies the 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_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[GetInstanceNodeDetailInfo]: Instance node information.
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[GetInstanceTag]: Tag list.
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>: Connection information.
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.
id String: Uniquely identifies the resource.
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>: Instance node information.
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>: Tag list.
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

GetInstanceChargeInfo

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.

GetInstanceConnectionInfo

Addresses List<Volcengine.GetInstanceConnectionInfoAddress>: Address list.
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 []GetInstanceConnectionInfoAddress: Address list.
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<GetInstanceConnectionInfoAddress>: Address list.
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 GetInstanceConnectionInfoAddress[]: Address list.
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[GetInstanceConnectionInfoAddress]: Address list.
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>: Address list.
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.

GetInstanceConnectionInfoAddress

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.

GetInstanceNodeDetailInfo

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.

GetInstanceTag

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.

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.rdsmssql.getInstance

On this page

On this page

Using getInstance

getInstance Result

Supporting Types

GetInstanceChargeInfo

GetInstanceConnectionInfo

GetInstanceConnectionInfoAddress

GetInstanceNodeDetailInfo

GetInstanceTag

Package Details

On this page

On this page