bytepluscc.rdsmssql.getInstance

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

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: bytepluscc: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: 需要修改的实例高级特性。该接口当前属于加白接口，如需使用，您可以联系技术支持。示例值：{"Key":"Value"}
AllowListIds List<string>: 允许访问的白名单ID列表。
BackupUse double: 实例已用备份空间。单位：GiB。
ChargeInfo Byteplus.GetInstanceChargeInfo: 付费方式。
ConnectionInfos List<Byteplus.GetInstanceConnectionInfo>: 连接信息。
CreatedTime string: 创建时间。
DbEngineVersion string: 兼容版本。取值如下：SQLServer2019Std：表示 SQL Server 2019 标准版。SQLServer2019Ent：表示 SQL Server 2019 企业版。SQLServer2019Web：表示 SQL Server 2019 Web 版。SQLServer2022Std：表示 SQL Server 2022 标准版。SQLServer2022Ent：表示 SQL Server 2022 企业版。SQLServer2022Web：表示 SQL Server 2022 Web 版。
Id string: Uniquely identifies the resource.
InnerVersion string: 内核版本号。
InstanceCategory string: 实例分类。取值：Primary：主实例。ReadOnly：只读实例。
InstanceId string: 实例ID。
InstanceName string: 实例名称。实例名称的命名规则如下：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制在 1~128 之间。
InstanceStatus string: 实例状态，取值：Running：运行中。Creating：创建中。CreateFailed：创建失败。Deleting：删除中。Restarting：重启中。Updating：变更中。MasterChanging：主节点切换中。Error：错误。
InstanceType string: 实例类型。取值如下：HA（高可用）、Basic（基础版）、Cluster（集群版）。不同引擎版本支持的类型不同：2019 Std 支持 HA/Basic；2019 Ent 支持 Cluster/Basic；2019 Web 支持 Basic。
MaintenanceTime string: 实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC时间）。默认取值为 UTC18:00Z-21:59Z（即北京时间 02:00-05:59）。说明：为保护云数据库的稳定性，系统会不定期对实例进行维护。可维护时间段建议设置在业务低峰期，避免对业务造成影响。在可维护时间段内，实例可能会出现 1~2 次的连接闪断，需确保应用程序具有自动重连机制。可维护时间段最小时间间隔 1 小时，最大时间间隔 24 小时，不允许跨天选择可维护时间段。
MasterNodeId string: 主节点ID。手动切换主备节点时，该参数为必填项。
Memory int: 内存大小，单位为 GiB。
NodeDetailInfos List<Byteplus.GetInstanceNodeDetailInfo>: 实例节点信息。
NodeSpec string: 实例规格代码。
Port string: 端口
PrimaryInstanceId string: 主实例ID。如果为空说明它是主实例。
ProjectName string: 所属项目。
ReadOnlyNumber int: 只读实例数量。
ServerCollation string: 实例字符集排序规则，默认 ChinesePRCCIAS。目前已支持大多数原生字符集具体取值如下：Latin1GeneralCIAS，Latin1GeneralCSAS，SQLLatin1GeneralCP1CIAS，SQLLatin1GeneralCP1CSAS，ChinesePRCCIAS，ChinesePRCCSAS，ChinesePRCBIN，JapaneseCIAS，JapaneseCSAS，ChineseTaiwanStrokeCIAS，ChineseTaiwanStrokeCSAS，ThaiCIAS，ChinesePRCCIAI，ChinesePRCBIN2，CyrillicGeneralCI_AS。
SlowQueryEnable bool: 表示是否开启慢日志，取值如下：true：表示开启慢日志。false：表示不开启慢日志。
SlowQueryTime string: 慢日志的阈值，取值范围为 [1~10]，单位：秒（s）。
StorageSpace int: 存储空间大小，单位为 GiB。取值范围：20GiB ~ 4000GiB，步长为 10GiB。
StorageType string: 实例存储类型。
StorageUse double: 实例已用储空间。单位：GiB。
SubnetId string: 子网 ID。当主备节点不在同一个可用区时，主备节点的子网也需设置为对应可用区私有网络下的子网，多个可用区需使用英文分号（;）隔开。
SuperAccountPassword string: 高权限账号的密码。密码规则如下：长度为 8~32 个字符。由大写字母、小写字母、数字、特殊字符中的至少三种组成。特殊字符为 !@#$%^&*()_+-=。
Tags List<Byteplus.GetInstanceTag>: 标签列表。
TimeZone string: 时区。
UpdatedTime string: 更新时间。
Vcpu int: CPU 大小。例如：1 表示 1核。
VpcId string: VPC ID
ZoneId string: 节点所在可用区。当主备节点不在同一个可用区时，您可以使用英文分号（;）隔开，默认第一个为主节点可用区，第二个为备节点可用区。

AdvancedFeatures string: 需要修改的实例高级特性。该接口当前属于加白接口，如需使用，您可以联系技术支持。示例值：{"Key":"Value"}
AllowListIds []string: 允许访问的白名单ID列表。
BackupUse float64: 实例已用备份空间。单位：GiB。
ChargeInfo GetInstanceChargeInfo: 付费方式。
ConnectionInfos []GetInstanceConnectionInfo: 连接信息。
CreatedTime string: 创建时间。
DbEngineVersion string: 兼容版本。取值如下：SQLServer2019Std：表示 SQL Server 2019 标准版。SQLServer2019Ent：表示 SQL Server 2019 企业版。SQLServer2019Web：表示 SQL Server 2019 Web 版。SQLServer2022Std：表示 SQL Server 2022 标准版。SQLServer2022Ent：表示 SQL Server 2022 企业版。SQLServer2022Web：表示 SQL Server 2022 Web 版。
Id string: Uniquely identifies the resource.
InnerVersion string: 内核版本号。
InstanceCategory string: 实例分类。取值：Primary：主实例。ReadOnly：只读实例。
InstanceId string: 实例ID。
InstanceName string: 实例名称。实例名称的命名规则如下：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制在 1~128 之间。
InstanceStatus string: 实例状态，取值：Running：运行中。Creating：创建中。CreateFailed：创建失败。Deleting：删除中。Restarting：重启中。Updating：变更中。MasterChanging：主节点切换中。Error：错误。
InstanceType string: 实例类型。取值如下：HA（高可用）、Basic（基础版）、Cluster（集群版）。不同引擎版本支持的类型不同：2019 Std 支持 HA/Basic；2019 Ent 支持 Cluster/Basic；2019 Web 支持 Basic。
MaintenanceTime string: 实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC时间）。默认取值为 UTC18:00Z-21:59Z（即北京时间 02:00-05:59）。说明：为保护云数据库的稳定性，系统会不定期对实例进行维护。可维护时间段建议设置在业务低峰期，避免对业务造成影响。在可维护时间段内，实例可能会出现 1~2 次的连接闪断，需确保应用程序具有自动重连机制。可维护时间段最小时间间隔 1 小时，最大时间间隔 24 小时，不允许跨天选择可维护时间段。
MasterNodeId string: 主节点ID。手动切换主备节点时，该参数为必填项。
Memory int: 内存大小，单位为 GiB。
NodeDetailInfos []GetInstanceNodeDetailInfo: 实例节点信息。
NodeSpec string: 实例规格代码。
Port string: 端口
PrimaryInstanceId string: 主实例ID。如果为空说明它是主实例。
ProjectName string: 所属项目。
ReadOnlyNumber int: 只读实例数量。
ServerCollation string: 实例字符集排序规则，默认 ChinesePRCCIAS。目前已支持大多数原生字符集具体取值如下：Latin1GeneralCIAS，Latin1GeneralCSAS，SQLLatin1GeneralCP1CIAS，SQLLatin1GeneralCP1CSAS，ChinesePRCCIAS，ChinesePRCCSAS，ChinesePRCBIN，JapaneseCIAS，JapaneseCSAS，ChineseTaiwanStrokeCIAS，ChineseTaiwanStrokeCSAS，ThaiCIAS，ChinesePRCCIAI，ChinesePRCBIN2，CyrillicGeneralCI_AS。
SlowQueryEnable bool: 表示是否开启慢日志，取值如下：true：表示开启慢日志。false：表示不开启慢日志。
SlowQueryTime string: 慢日志的阈值，取值范围为 [1~10]，单位：秒（s）。
StorageSpace int: 存储空间大小，单位为 GiB。取值范围：20GiB ~ 4000GiB，步长为 10GiB。
StorageType string: 实例存储类型。
StorageUse float64: 实例已用储空间。单位：GiB。
SubnetId string: 子网 ID。当主备节点不在同一个可用区时，主备节点的子网也需设置为对应可用区私有网络下的子网，多个可用区需使用英文分号（;）隔开。
SuperAccountPassword string: 高权限账号的密码。密码规则如下：长度为 8~32 个字符。由大写字母、小写字母、数字、特殊字符中的至少三种组成。特殊字符为 !@#$%^&*()_+-=。
Tags []GetInstanceTag: 标签列表。
TimeZone string: 时区。
UpdatedTime string: 更新时间。
Vcpu int: CPU 大小。例如：1 表示 1核。
VpcId string: VPC ID
ZoneId string: 节点所在可用区。当主备节点不在同一个可用区时，您可以使用英文分号（;）隔开，默认第一个为主节点可用区，第二个为备节点可用区。

advancedFeatures String: 需要修改的实例高级特性。该接口当前属于加白接口，如需使用，您可以联系技术支持。示例值：{"Key":"Value"}
allowListIds List<String>: 允许访问的白名单ID列表。
backupUse Double: 实例已用备份空间。单位：GiB。
chargeInfo GetInstanceChargeInfo: 付费方式。
connectionInfos List<GetInstanceConnectionInfo>: 连接信息。
createdTime String: 创建时间。
dbEngineVersion String: 兼容版本。取值如下：SQLServer2019Std：表示 SQL Server 2019 标准版。SQLServer2019Ent：表示 SQL Server 2019 企业版。SQLServer2019Web：表示 SQL Server 2019 Web 版。SQLServer2022Std：表示 SQL Server 2022 标准版。SQLServer2022Ent：表示 SQL Server 2022 企业版。SQLServer2022Web：表示 SQL Server 2022 Web 版。
id String: Uniquely identifies the resource.
innerVersion String: 内核版本号。
instanceCategory String: 实例分类。取值：Primary：主实例。ReadOnly：只读实例。
instanceId String: 实例ID。
instanceName String: 实例名称。实例名称的命名规则如下：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制在 1~128 之间。
instanceStatus String: 实例状态，取值：Running：运行中。Creating：创建中。CreateFailed：创建失败。Deleting：删除中。Restarting：重启中。Updating：变更中。MasterChanging：主节点切换中。Error：错误。
instanceType String: 实例类型。取值如下：HA（高可用）、Basic（基础版）、Cluster（集群版）。不同引擎版本支持的类型不同：2019 Std 支持 HA/Basic；2019 Ent 支持 Cluster/Basic；2019 Web 支持 Basic。
maintenanceTime String: 实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC时间）。默认取值为 UTC18:00Z-21:59Z（即北京时间 02:00-05:59）。说明：为保护云数据库的稳定性，系统会不定期对实例进行维护。可维护时间段建议设置在业务低峰期，避免对业务造成影响。在可维护时间段内，实例可能会出现 1~2 次的连接闪断，需确保应用程序具有自动重连机制。可维护时间段最小时间间隔 1 小时，最大时间间隔 24 小时，不允许跨天选择可维护时间段。
masterNodeId String: 主节点ID。手动切换主备节点时，该参数为必填项。
memory Integer: 内存大小，单位为 GiB。
nodeDetailInfos List<GetInstanceNodeDetailInfo>: 实例节点信息。
nodeSpec String: 实例规格代码。
port String: 端口
primaryInstanceId String: 主实例ID。如果为空说明它是主实例。
projectName String: 所属项目。
readOnlyNumber Integer: 只读实例数量。
serverCollation String: 实例字符集排序规则，默认 ChinesePRCCIAS。目前已支持大多数原生字符集具体取值如下：Latin1GeneralCIAS，Latin1GeneralCSAS，SQLLatin1GeneralCP1CIAS，SQLLatin1GeneralCP1CSAS，ChinesePRCCIAS，ChinesePRCCSAS，ChinesePRCBIN，JapaneseCIAS，JapaneseCSAS，ChineseTaiwanStrokeCIAS，ChineseTaiwanStrokeCSAS，ThaiCIAS，ChinesePRCCIAI，ChinesePRCBIN2，CyrillicGeneralCI_AS。
slowQueryEnable Boolean: 表示是否开启慢日志，取值如下：true：表示开启慢日志。false：表示不开启慢日志。
slowQueryTime String: 慢日志的阈值，取值范围为 [1~10]，单位：秒（s）。
storageSpace Integer: 存储空间大小，单位为 GiB。取值范围：20GiB ~ 4000GiB，步长为 10GiB。
storageType String: 实例存储类型。
storageUse Double: 实例已用储空间。单位：GiB。
subnetId String: 子网 ID。当主备节点不在同一个可用区时，主备节点的子网也需设置为对应可用区私有网络下的子网，多个可用区需使用英文分号（;）隔开。
superAccountPassword String: 高权限账号的密码。密码规则如下：长度为 8~32 个字符。由大写字母、小写字母、数字、特殊字符中的至少三种组成。特殊字符为 !@#$%^&*()_+-=。
tags List<GetInstanceTag>: 标签列表。
timeZone String: 时区。
updatedTime String: 更新时间。
vcpu Integer: CPU 大小。例如：1 表示 1核。
vpcId String: VPC ID
zoneId String: 节点所在可用区。当主备节点不在同一个可用区时，您可以使用英文分号（;）隔开，默认第一个为主节点可用区，第二个为备节点可用区。

advancedFeatures string: 需要修改的实例高级特性。该接口当前属于加白接口，如需使用，您可以联系技术支持。示例值：{"Key":"Value"}
allowListIds string[]: 允许访问的白名单ID列表。
backupUse number: 实例已用备份空间。单位：GiB。
chargeInfo GetInstanceChargeInfo: 付费方式。
connectionInfos GetInstanceConnectionInfo[]: 连接信息。
createdTime string: 创建时间。
dbEngineVersion string: 兼容版本。取值如下：SQLServer2019Std：表示 SQL Server 2019 标准版。SQLServer2019Ent：表示 SQL Server 2019 企业版。SQLServer2019Web：表示 SQL Server 2019 Web 版。SQLServer2022Std：表示 SQL Server 2022 标准版。SQLServer2022Ent：表示 SQL Server 2022 企业版。SQLServer2022Web：表示 SQL Server 2022 Web 版。
id string: Uniquely identifies the resource.
innerVersion string: 内核版本号。
instanceCategory string: 实例分类。取值：Primary：主实例。ReadOnly：只读实例。
instanceId string: 实例ID。
instanceName string: 实例名称。实例名称的命名规则如下：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制在 1~128 之间。
instanceStatus string: 实例状态，取值：Running：运行中。Creating：创建中。CreateFailed：创建失败。Deleting：删除中。Restarting：重启中。Updating：变更中。MasterChanging：主节点切换中。Error：错误。
instanceType string: 实例类型。取值如下：HA（高可用）、Basic（基础版）、Cluster（集群版）。不同引擎版本支持的类型不同：2019 Std 支持 HA/Basic；2019 Ent 支持 Cluster/Basic；2019 Web 支持 Basic。
maintenanceTime string: 实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC时间）。默认取值为 UTC18:00Z-21:59Z（即北京时间 02:00-05:59）。说明：为保护云数据库的稳定性，系统会不定期对实例进行维护。可维护时间段建议设置在业务低峰期，避免对业务造成影响。在可维护时间段内，实例可能会出现 1~2 次的连接闪断，需确保应用程序具有自动重连机制。可维护时间段最小时间间隔 1 小时，最大时间间隔 24 小时，不允许跨天选择可维护时间段。
masterNodeId string: 主节点ID。手动切换主备节点时，该参数为必填项。
memory number: 内存大小，单位为 GiB。
nodeDetailInfos GetInstanceNodeDetailInfo[]: 实例节点信息。
nodeSpec string: 实例规格代码。
port string: 端口
primaryInstanceId string: 主实例ID。如果为空说明它是主实例。
projectName string: 所属项目。
readOnlyNumber number: 只读实例数量。
serverCollation string: 实例字符集排序规则，默认 ChinesePRCCIAS。目前已支持大多数原生字符集具体取值如下：Latin1GeneralCIAS，Latin1GeneralCSAS，SQLLatin1GeneralCP1CIAS，SQLLatin1GeneralCP1CSAS，ChinesePRCCIAS，ChinesePRCCSAS，ChinesePRCBIN，JapaneseCIAS，JapaneseCSAS，ChineseTaiwanStrokeCIAS，ChineseTaiwanStrokeCSAS，ThaiCIAS，ChinesePRCCIAI，ChinesePRCBIN2，CyrillicGeneralCI_AS。
slowQueryEnable boolean: 表示是否开启慢日志，取值如下：true：表示开启慢日志。false：表示不开启慢日志。
slowQueryTime string: 慢日志的阈值，取值范围为 [1~10]，单位：秒（s）。
storageSpace number: 存储空间大小，单位为 GiB。取值范围：20GiB ~ 4000GiB，步长为 10GiB。
storageType string: 实例存储类型。
storageUse number: 实例已用储空间。单位：GiB。
subnetId string: 子网 ID。当主备节点不在同一个可用区时，主备节点的子网也需设置为对应可用区私有网络下的子网，多个可用区需使用英文分号（;）隔开。
superAccountPassword string: 高权限账号的密码。密码规则如下：长度为 8~32 个字符。由大写字母、小写字母、数字、特殊字符中的至少三种组成。特殊字符为 !@#$%^&*()_+-=。
tags GetInstanceTag[]: 标签列表。
timeZone string: 时区。
updatedTime string: 更新时间。
vcpu number: CPU 大小。例如：1 表示 1核。
vpcId string: VPC ID
zoneId string: 节点所在可用区。当主备节点不在同一个可用区时，您可以使用英文分号（;）隔开，默认第一个为主节点可用区，第二个为备节点可用区。

advanced_features str: 需要修改的实例高级特性。该接口当前属于加白接口，如需使用，您可以联系技术支持。示例值：{"Key":"Value"}
allow_list_ids Sequence[str]: 允许访问的白名单ID列表。
backup_use float: 实例已用备份空间。单位：GiB。
charge_info GetInstanceChargeInfo: 付费方式。
connection_infos Sequence[GetInstanceConnectionInfo]: 连接信息。
created_time str: 创建时间。
db_engine_version str: 兼容版本。取值如下：SQLServer2019Std：表示 SQL Server 2019 标准版。SQLServer2019Ent：表示 SQL Server 2019 企业版。SQLServer2019Web：表示 SQL Server 2019 Web 版。SQLServer2022Std：表示 SQL Server 2022 标准版。SQLServer2022Ent：表示 SQL Server 2022 企业版。SQLServer2022Web：表示 SQL Server 2022 Web 版。
id str: Uniquely identifies the resource.
inner_version str: 内核版本号。
instance_category str: 实例分类。取值：Primary：主实例。ReadOnly：只读实例。
instance_id str: 实例ID。
instance_name str: 实例名称。实例名称的命名规则如下：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制在 1~128 之间。
instance_status str: 实例状态，取值：Running：运行中。Creating：创建中。CreateFailed：创建失败。Deleting：删除中。Restarting：重启中。Updating：变更中。MasterChanging：主节点切换中。Error：错误。
instance_type str: 实例类型。取值如下：HA（高可用）、Basic（基础版）、Cluster（集群版）。不同引擎版本支持的类型不同：2019 Std 支持 HA/Basic；2019 Ent 支持 Cluster/Basic；2019 Web 支持 Basic。
maintenance_time str: 实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC时间）。默认取值为 UTC18:00Z-21:59Z（即北京时间 02:00-05:59）。说明：为保护云数据库的稳定性，系统会不定期对实例进行维护。可维护时间段建议设置在业务低峰期，避免对业务造成影响。在可维护时间段内，实例可能会出现 1~2 次的连接闪断，需确保应用程序具有自动重连机制。可维护时间段最小时间间隔 1 小时，最大时间间隔 24 小时，不允许跨天选择可维护时间段。
master_node_id str: 主节点ID。手动切换主备节点时，该参数为必填项。
memory int: 内存大小，单位为 GiB。
node_detail_infos Sequence[GetInstanceNodeDetailInfo]: 实例节点信息。
node_spec str: 实例规格代码。
port str: 端口
primary_instance_id str: 主实例ID。如果为空说明它是主实例。
project_name str: 所属项目。
read_only_number int: 只读实例数量。
server_collation str: 实例字符集排序规则，默认 ChinesePRCCIAS。目前已支持大多数原生字符集具体取值如下：Latin1GeneralCIAS，Latin1GeneralCSAS，SQLLatin1GeneralCP1CIAS，SQLLatin1GeneralCP1CSAS，ChinesePRCCIAS，ChinesePRCCSAS，ChinesePRCBIN，JapaneseCIAS，JapaneseCSAS，ChineseTaiwanStrokeCIAS，ChineseTaiwanStrokeCSAS，ThaiCIAS，ChinesePRCCIAI，ChinesePRCBIN2，CyrillicGeneralCI_AS。
slow_query_enable bool: 表示是否开启慢日志，取值如下：true：表示开启慢日志。false：表示不开启慢日志。
slow_query_time str: 慢日志的阈值，取值范围为 [1~10]，单位：秒（s）。
storage_space int: 存储空间大小，单位为 GiB。取值范围：20GiB ~ 4000GiB，步长为 10GiB。
storage_type str: 实例存储类型。
storage_use float: 实例已用储空间。单位：GiB。
subnet_id str: 子网 ID。当主备节点不在同一个可用区时，主备节点的子网也需设置为对应可用区私有网络下的子网，多个可用区需使用英文分号（;）隔开。
super_account_password str: 高权限账号的密码。密码规则如下：长度为 8~32 个字符。由大写字母、小写字母、数字、特殊字符中的至少三种组成。特殊字符为 !@#$%^&*()_+-=。
tags Sequence[GetInstanceTag]: 标签列表。
time_zone str: 时区。
updated_time str: 更新时间。
vcpu int: CPU 大小。例如：1 表示 1核。
vpc_id str: VPC ID
zone_id str: 节点所在可用区。当主备节点不在同一个可用区时，您可以使用英文分号（;）隔开，默认第一个为主节点可用区，第二个为备节点可用区。

advancedFeatures String: 需要修改的实例高级特性。该接口当前属于加白接口，如需使用，您可以联系技术支持。示例值：{"Key":"Value"}
allowListIds List<String>: 允许访问的白名单ID列表。
backupUse Number: 实例已用备份空间。单位：GiB。
chargeInfo Property Map: 付费方式。
connectionInfos List<Property Map>: 连接信息。
createdTime String: 创建时间。
dbEngineVersion String: 兼容版本。取值如下：SQLServer2019Std：表示 SQL Server 2019 标准版。SQLServer2019Ent：表示 SQL Server 2019 企业版。SQLServer2019Web：表示 SQL Server 2019 Web 版。SQLServer2022Std：表示 SQL Server 2022 标准版。SQLServer2022Ent：表示 SQL Server 2022 企业版。SQLServer2022Web：表示 SQL Server 2022 Web 版。
id String: Uniquely identifies the resource.
innerVersion String: 内核版本号。
instanceCategory String: 实例分类。取值：Primary：主实例。ReadOnly：只读实例。
instanceId String: 实例ID。
instanceName String: 实例名称。实例名称的命名规则如下：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制在 1~128 之间。
instanceStatus String: 实例状态，取值：Running：运行中。Creating：创建中。CreateFailed：创建失败。Deleting：删除中。Restarting：重启中。Updating：变更中。MasterChanging：主节点切换中。Error：错误。
instanceType String: 实例类型。取值如下：HA（高可用）、Basic（基础版）、Cluster（集群版）。不同引擎版本支持的类型不同：2019 Std 支持 HA/Basic；2019 Ent 支持 Cluster/Basic；2019 Web 支持 Basic。
maintenanceTime String: 实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC时间）。默认取值为 UTC18:00Z-21:59Z（即北京时间 02:00-05:59）。说明：为保护云数据库的稳定性，系统会不定期对实例进行维护。可维护时间段建议设置在业务低峰期，避免对业务造成影响。在可维护时间段内，实例可能会出现 1~2 次的连接闪断，需确保应用程序具有自动重连机制。可维护时间段最小时间间隔 1 小时，最大时间间隔 24 小时，不允许跨天选择可维护时间段。
masterNodeId String: 主节点ID。手动切换主备节点时，该参数为必填项。
memory Number: 内存大小，单位为 GiB。
nodeDetailInfos List<Property Map>: 实例节点信息。
nodeSpec String: 实例规格代码。
port String: 端口
primaryInstanceId String: 主实例ID。如果为空说明它是主实例。
projectName String: 所属项目。
readOnlyNumber Number: 只读实例数量。
serverCollation String: 实例字符集排序规则，默认 ChinesePRCCIAS。目前已支持大多数原生字符集具体取值如下：Latin1GeneralCIAS，Latin1GeneralCSAS，SQLLatin1GeneralCP1CIAS，SQLLatin1GeneralCP1CSAS，ChinesePRCCIAS，ChinesePRCCSAS，ChinesePRCBIN，JapaneseCIAS，JapaneseCSAS，ChineseTaiwanStrokeCIAS，ChineseTaiwanStrokeCSAS，ThaiCIAS，ChinesePRCCIAI，ChinesePRCBIN2，CyrillicGeneralCI_AS。
slowQueryEnable Boolean: 表示是否开启慢日志，取值如下：true：表示开启慢日志。false：表示不开启慢日志。
slowQueryTime String: 慢日志的阈值，取值范围为 [1~10]，单位：秒（s）。
storageSpace Number: 存储空间大小，单位为 GiB。取值范围：20GiB ~ 4000GiB，步长为 10GiB。
storageType String: 实例存储类型。
storageUse Number: 实例已用储空间。单位：GiB。
subnetId String: 子网 ID。当主备节点不在同一个可用区时，主备节点的子网也需设置为对应可用区私有网络下的子网，多个可用区需使用英文分号（;）隔开。
superAccountPassword String: 高权限账号的密码。密码规则如下：长度为 8~32 个字符。由大写字母、小写字母、数字、特殊字符中的至少三种组成。特殊字符为 !@#$%^&*()_+-=。
tags List<Property Map>: 标签列表。
timeZone String: 时区。
updatedTime String: 更新时间。
vcpu Number: CPU 大小。例如：1 表示 1核。
vpcId String: VPC ID
zoneId String: 节点所在可用区。当主备节点不在同一个可用区时，您可以使用英文分号（;）隔开，默认第一个为主节点可用区，第二个为备节点可用区。

Supporting Types

GetInstanceChargeInfo

AutoRenew bool: 预付费场景下是否自动续费。true：自动续费（默认）。false：不自动续费。
ChargeEndTime string: 计费到期时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
ChargeStartTime string: 计费开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
ChargeStatus string: 付费状态。取值：Normal：表示实例正常。Overdue：表示实例欠费。Unpaid：表示实例等待支付。
ChargeType string: 付费类型。取值：PostPaid：表示按量付费。PrePaid：表示包年包月。
OverdueReclaimTime string: 欠费关停时预计释放时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
OverdueTime string: 欠费关停时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
Period int: 预付费场景下的购买时长。默认值：1。
PeriodUnit string: 预付费场景下的购买周期。Month：表示包月(默认值)。Year：表示包年。

AutoRenew bool: 预付费场景下是否自动续费。true：自动续费（默认）。false：不自动续费。
ChargeEndTime string: 计费到期时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
ChargeStartTime string: 计费开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
ChargeStatus string: 付费状态。取值：Normal：表示实例正常。Overdue：表示实例欠费。Unpaid：表示实例等待支付。
ChargeType string: 付费类型。取值：PostPaid：表示按量付费。PrePaid：表示包年包月。
OverdueReclaimTime string: 欠费关停时预计释放时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
OverdueTime string: 欠费关停时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
Period int: 预付费场景下的购买时长。默认值：1。
PeriodUnit string: 预付费场景下的购买周期。Month：表示包月(默认值)。Year：表示包年。

autoRenew Boolean: 预付费场景下是否自动续费。true：自动续费（默认）。false：不自动续费。
chargeEndTime String: 计费到期时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
chargeStartTime String: 计费开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
chargeStatus String: 付费状态。取值：Normal：表示实例正常。Overdue：表示实例欠费。Unpaid：表示实例等待支付。
chargeType String: 付费类型。取值：PostPaid：表示按量付费。PrePaid：表示包年包月。
overdueReclaimTime String: 欠费关停时预计释放时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
overdueTime String: 欠费关停时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
period Integer: 预付费场景下的购买时长。默认值：1。
periodUnit String: 预付费场景下的购买周期。Month：表示包月(默认值)。Year：表示包年。

autoRenew boolean: 预付费场景下是否自动续费。true：自动续费（默认）。false：不自动续费。
chargeEndTime string: 计费到期时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
chargeStartTime string: 计费开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
chargeStatus string: 付费状态。取值：Normal：表示实例正常。Overdue：表示实例欠费。Unpaid：表示实例等待支付。
chargeType string: 付费类型。取值：PostPaid：表示按量付费。PrePaid：表示包年包月。
overdueReclaimTime string: 欠费关停时预计释放时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
overdueTime string: 欠费关停时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
period number: 预付费场景下的购买时长。默认值：1。
periodUnit string: 预付费场景下的购买周期。Month：表示包月(默认值)。Year：表示包年。

auto_renew bool: 预付费场景下是否自动续费。true：自动续费（默认）。false：不自动续费。
charge_end_time str: 计费到期时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
charge_start_time str: 计费开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
charge_status str: 付费状态。取值：Normal：表示实例正常。Overdue：表示实例欠费。Unpaid：表示实例等待支付。
charge_type str: 付费类型。取值：PostPaid：表示按量付费。PrePaid：表示包年包月。
overdue_reclaim_time str: 欠费关停时预计释放时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
overdue_time str: 欠费关停时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
period int: 预付费场景下的购买时长。默认值：1。
period_unit str: 预付费场景下的购买周期。Month：表示包月(默认值)。Year：表示包年。

autoRenew Boolean: 预付费场景下是否自动续费。true：自动续费（默认）。false：不自动续费。
chargeEndTime String: 计费到期时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
chargeStartTime String: 计费开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
chargeStatus String: 付费状态。取值：Normal：表示实例正常。Overdue：表示实例欠费。Unpaid：表示实例等待支付。
chargeType String: 付费类型。取值：PostPaid：表示按量付费。PrePaid：表示包年包月。
overdueReclaimTime String: 欠费关停时预计释放时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
overdueTime String: 欠费关停时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
period Number: 预付费场景下的购买时长。默认值：1。
periodUnit String: 预付费场景下的购买周期。Month：表示包月(默认值)。Year：表示包年。

GetInstanceConnectionInfo

Addresses List<Byteplus.GetInstanceConnectionInfoAddress>: 地址列表。
Description string: 描述信息。
EndpointId string: 终端 ID。
EndpointName string: 终端名称。
EndpointType string: 终端类型。取值如下：Primary：表示主节点终端。ROCluster：表示只读集群终端。RO：表示只读节点终端。

Addresses []GetInstanceConnectionInfoAddress: 地址列表。
Description string: 描述信息。
EndpointId string: 终端 ID。
EndpointName string: 终端名称。
EndpointType string: 终端类型。取值如下：Primary：表示主节点终端。ROCluster：表示只读集群终端。RO：表示只读节点终端。

addresses List<GetInstanceConnectionInfoAddress>: 地址列表。
description String: 描述信息。
endpointId String: 终端 ID。
endpointName String: 终端名称。
endpointType String: 终端类型。取值如下：Primary：表示主节点终端。ROCluster：表示只读集群终端。RO：表示只读节点终端。

addresses GetInstanceConnectionInfoAddress[]: 地址列表。
description string: 描述信息。
endpointId string: 终端 ID。
endpointName string: 终端名称。
endpointType string: 终端类型。取值如下：Primary：表示主节点终端。ROCluster：表示只读集群终端。RO：表示只读节点终端。

addresses Sequence[GetInstanceConnectionInfoAddress]: 地址列表。
description str: 描述信息。
endpoint_id str: 终端 ID。
endpoint_name str: 终端名称。
endpoint_type str: 终端类型。取值如下：Primary：表示主节点终端。ROCluster：表示只读集群终端。RO：表示只读节点终端。

addresses List<Property Map>: 地址列表。
description String: 描述信息。
endpointId String: 终端 ID。
endpointName String: 终端名称。
endpointType String: 终端类型。取值如下：Primary：表示主节点终端。ROCluster：表示只读集群终端。RO：表示只读节点终端。

GetInstanceConnectionInfoAddress

DnsVisibility bool: 表示是否开启私网到公网解析，取值如下：true：表示开启私网到公网解析。false：表示不开启私网到公网解析。
Domain string: 域名。
EipId string: EIP的ID，仅对公网地址有效。
IpAddress string: IP地址。
NetworkType string: 网络地址类型。取值：Private：私网类型。Public：公网类型。
Port string: 端口。
SubnetId string: 子网 ID，仅对私网地址有效。

DnsVisibility bool: 表示是否开启私网到公网解析，取值如下：true：表示开启私网到公网解析。false：表示不开启私网到公网解析。
Domain string: 域名。
EipId string: EIP的ID，仅对公网地址有效。
IpAddress string: IP地址。
NetworkType string: 网络地址类型。取值：Private：私网类型。Public：公网类型。
Port string: 端口。
SubnetId string: 子网 ID，仅对私网地址有效。

dnsVisibility Boolean: 表示是否开启私网到公网解析，取值如下：true：表示开启私网到公网解析。false：表示不开启私网到公网解析。
domain String: 域名。
eipId String: EIP的ID，仅对公网地址有效。
ipAddress String: IP地址。
networkType String: 网络地址类型。取值：Private：私网类型。Public：公网类型。
port String: 端口。
subnetId String: 子网 ID，仅对私网地址有效。

dnsVisibility boolean: 表示是否开启私网到公网解析，取值如下：true：表示开启私网到公网解析。false：表示不开启私网到公网解析。
domain string: 域名。
eipId string: EIP的ID，仅对公网地址有效。
ipAddress string: IP地址。
networkType string: 网络地址类型。取值：Private：私网类型。Public：公网类型。
port string: 端口。
subnetId string: 子网 ID，仅对私网地址有效。

dns_visibility bool: 表示是否开启私网到公网解析，取值如下：true：表示开启私网到公网解析。false：表示不开启私网到公网解析。
domain str: 域名。
eip_id str: EIP的ID，仅对公网地址有效。
ip_address str: IP地址。
network_type str: 网络地址类型。取值：Private：私网类型。Public：公网类型。
port str: 端口。
subnet_id str: 子网 ID，仅对私网地址有效。

dnsVisibility Boolean: 表示是否开启私网到公网解析，取值如下：true：表示开启私网到公网解析。false：表示不开启私网到公网解析。
domain String: 域名。
eipId String: EIP的ID，仅对公网地址有效。
ipAddress String: IP地址。
networkType String: 网络地址类型。取值：Private：私网类型。Public：公网类型。
port String: 端口。
subnetId String: 子网 ID，仅对私网地址有效。

GetInstanceNodeDetailInfo

CreateTime string: 节点的创建时间。
HostName string: 节点主机名。
InstanceId string: 实例ID。
Memory int: 内存大小，单位为 GiB。
NodeId string: 节点ID。
NodeIp string: 节点IP。
NodeSpec string: 节点规格。
NodeStatus string: 节点状态，取值为：Running：运行中。Creating：创建中。Deleting：删除中。Restarting：重启中。Updating：变更中。MasterChanging：主备切换中。Error：错误。
NodeType string: 节点类型。取值：Primary：表示主节点终端。ReadOnly：表示只读节点终端。Secondary：表示备节点终端。
RegionId string: 区域ID。
UpdateTime string: 更新时间。
Vcpu int: vCPU 数量。
ZoneId string: 可用区ID。

CreateTime string: 节点的创建时间。
HostName string: 节点主机名。
InstanceId string: 实例ID。
Memory int: 内存大小，单位为 GiB。
NodeId string: 节点ID。
NodeIp string: 节点IP。
NodeSpec string: 节点规格。
NodeStatus string: 节点状态，取值为：Running：运行中。Creating：创建中。Deleting：删除中。Restarting：重启中。Updating：变更中。MasterChanging：主备切换中。Error：错误。
NodeType string: 节点类型。取值：Primary：表示主节点终端。ReadOnly：表示只读节点终端。Secondary：表示备节点终端。
RegionId string: 区域ID。
UpdateTime string: 更新时间。
Vcpu int: vCPU 数量。
ZoneId string: 可用区ID。

createTime String: 节点的创建时间。
hostName String: 节点主机名。
instanceId String: 实例ID。
memory Integer: 内存大小，单位为 GiB。
nodeId String: 节点ID。
nodeIp String: 节点IP。
nodeSpec String: 节点规格。
nodeStatus String: 节点状态，取值为：Running：运行中。Creating：创建中。Deleting：删除中。Restarting：重启中。Updating：变更中。MasterChanging：主备切换中。Error：错误。
nodeType String: 节点类型。取值：Primary：表示主节点终端。ReadOnly：表示只读节点终端。Secondary：表示备节点终端。
regionId String: 区域ID。
updateTime String: 更新时间。
vcpu Integer: vCPU 数量。
zoneId String: 可用区ID。

createTime string: 节点的创建时间。
hostName string: 节点主机名。
instanceId string: 实例ID。
memory number: 内存大小，单位为 GiB。
nodeId string: 节点ID。
nodeIp string: 节点IP。
nodeSpec string: 节点规格。
nodeStatus string: 节点状态，取值为：Running：运行中。Creating：创建中。Deleting：删除中。Restarting：重启中。Updating：变更中。MasterChanging：主备切换中。Error：错误。
nodeType string: 节点类型。取值：Primary：表示主节点终端。ReadOnly：表示只读节点终端。Secondary：表示备节点终端。
regionId string: 区域ID。
updateTime string: 更新时间。
vcpu number: vCPU 数量。
zoneId string: 可用区ID。

create_time str: 节点的创建时间。
host_name str: 节点主机名。
instance_id str: 实例ID。
memory int: 内存大小，单位为 GiB。
node_id str: 节点ID。
node_ip str: 节点IP。
node_spec str: 节点规格。
node_status str: 节点状态，取值为：Running：运行中。Creating：创建中。Deleting：删除中。Restarting：重启中。Updating：变更中。MasterChanging：主备切换中。Error：错误。
node_type str: 节点类型。取值：Primary：表示主节点终端。ReadOnly：表示只读节点终端。Secondary：表示备节点终端。
region_id str: 区域ID。
update_time str: 更新时间。
vcpu int: vCPU 数量。
zone_id str: 可用区ID。

createTime String: 节点的创建时间。
hostName String: 节点主机名。
instanceId String: 实例ID。
memory Number: 内存大小，单位为 GiB。
nodeId String: 节点ID。
nodeIp String: 节点IP。
nodeSpec String: 节点规格。
nodeStatus String: 节点状态，取值为：Running：运行中。Creating：创建中。Deleting：删除中。Restarting：重启中。Updating：变更中。MasterChanging：主备切换中。Error：错误。
nodeType String: 节点类型。取值：Primary：表示主节点终端。ReadOnly：表示只读节点终端。Secondary：表示备节点终端。
regionId String: 区域ID。
updateTime String: 更新时间。
vcpu Number: vCPU 数量。
zoneId String: 可用区ID。

GetInstanceTag

Key string: 用户标签的标签键。
Value string: 用户标签的标签值。

Key string: 用户标签的标签键。
Value string: 用户标签的标签值。

key String: 用户标签的标签键。
value String: 用户标签的标签值。

key string: 用户标签的标签键。
value string: 用户标签的标签值。

key str: 用户标签的标签键。
value str: 用户标签的标签值。

key String: 用户标签的标签键。
value String: 用户标签的标签值。

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.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