volcenginecc.vedbm.getInstance

volcenginecc v0.0.11, Dec 4 25

volcenginecc v0.0.11 published on Thursday, Dec 4, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc v0.0.11 published on Thursday, Dec 4, 2025 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:vedbm/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:

ChargeDetail Volcengine.GetInstanceChargeDetail: 计费详细信息。
CreatedTime string: 实例的创建时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
DbEngineVersion string: 实例兼容版本。取值范围：MySQL80：表示兼容社区 MySQL 8.0 版本。MySQL57：表示兼容社区 MySQL 5.7 版本。
DbMinorVersion string: 根据兼容版本，选择 veDB MySQL 小版本。当 DBEngineVersion 取值为 MySQL57 时，该参数取值默认为 2.0。当 DBEngineVersion 取值为 MySQL80 时，该参数取值范围如下：3.0（默认）：veDB MySQL 稳定版，100% 兼容 MySQL 8.0。3.1：原生支持 HTAP 应用场景，加速复杂查询。3.2：原生支持 HTAP 应用场景，加速复杂查询。
DbRevisionVersion string: 实例的内核版本。
DeletionProtection string: 实例是否开启了删除保护功能。取值范围：enabled：开启。disabled：关闭。
Endpoints List<Volcengine.GetInstanceEndpoint>: 连接终端的详细信息。
Id string: Uniquely identifies the resource.
InstanceId string: 实例 ID。
InstanceName string: 实例名称。命名规则：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需在 1~128 个字符内。
InstanceStatus string: 实例状态。
LowerCaseTableNames string: 表名是否区分大小写。取值范围：0：表名称大小写敏感，后端根据实际表名存储。1：表名称不区分大小写，后端存储时将表名称统一为小写字母。
MaintenanceWindow Volcengine.GetInstanceMaintenanceWindow: 实例的可维护时间窗口信息。
NodeNumber int: 实例节点数量。取值范围为 2~16 个。
NodeSpec string: 实例的节点规格代码。
Nodes List<Volcengine.GetInstanceNode>: 实例节点的详细信息。
Number int: 创建的实例数量，取值范围 1~50，默认值为 1。
Port int: 为实例默认创建的连接终端指定私网端口号。默认取值为 3306，取值范围为 1000~65534。
PrePaidStorageInGb int: 预付费的存储总容量大小，单位 GiB。
ProjectName string: 实例所属的项目名称。
SpecFamily string: 实例规格类型，取值：General：通用型。Exclusive：独享型。
StorageChargeType string: 存储计费类型，不传入该参数时，存储计费类型默认与计算计费类型取值一致。取值：PostPaid：按量计费（后付费）。PrePaid：包年包月（预付费）。
StorageUsedGiB double: 已使用存储空间大小，单位 GiB。
SubnetId string: 子网 ID。子网必须属于所选的可用区。
SuperAccountName string: 高权限用户的账号名称。账号名称需满足以下要求：名称唯一，且长度在 2~32 个字符内。由字母、数字、中划线（-）、下划线（_）组成。以字母开头，以字母或数字结尾。名称内不能包含禁用关键词。
SuperAccountPassword string: 高权限账号的密码。账号密码需满足以下要求：只能包含大小写字母、数字和特殊字符（如 ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/）。长度需在 8~32 个字符内。至少包含大写字母、小写字母、数字或特殊字符中的 3 种。
Tags List<Volcengine.GetInstanceTag>: 实例绑定的标签键和标签值数组对象。
TemplateId string: 参数模板 ID。
TimeZone string: 实例的时区。国内所有地域默认时区为 UTC +08:00。
VpcId string: 私有网络（VPC） ID。
ZoneIds string: 可用区 ID。

ChargeDetail GetInstanceChargeDetail: 计费详细信息。
CreatedTime string: 实例的创建时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
DbEngineVersion string: 实例兼容版本。取值范围：MySQL80：表示兼容社区 MySQL 8.0 版本。MySQL57：表示兼容社区 MySQL 5.7 版本。
DbMinorVersion string: 根据兼容版本，选择 veDB MySQL 小版本。当 DBEngineVersion 取值为 MySQL57 时，该参数取值默认为 2.0。当 DBEngineVersion 取值为 MySQL80 时，该参数取值范围如下：3.0（默认）：veDB MySQL 稳定版，100% 兼容 MySQL 8.0。3.1：原生支持 HTAP 应用场景，加速复杂查询。3.2：原生支持 HTAP 应用场景，加速复杂查询。
DbRevisionVersion string: 实例的内核版本。
DeletionProtection string: 实例是否开启了删除保护功能。取值范围：enabled：开启。disabled：关闭。
Endpoints []GetInstanceEndpoint: 连接终端的详细信息。
Id string: Uniquely identifies the resource.
InstanceId string: 实例 ID。
InstanceName string: 实例名称。命名规则：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需在 1~128 个字符内。
InstanceStatus string: 实例状态。
LowerCaseTableNames string: 表名是否区分大小写。取值范围：0：表名称大小写敏感，后端根据实际表名存储。1：表名称不区分大小写，后端存储时将表名称统一为小写字母。
MaintenanceWindow GetInstanceMaintenanceWindow: 实例的可维护时间窗口信息。
NodeNumber int: 实例节点数量。取值范围为 2~16 个。
NodeSpec string: 实例的节点规格代码。
Nodes []GetInstanceNode: 实例节点的详细信息。
Number int: 创建的实例数量，取值范围 1~50，默认值为 1。
Port int: 为实例默认创建的连接终端指定私网端口号。默认取值为 3306，取值范围为 1000~65534。
PrePaidStorageInGb int: 预付费的存储总容量大小，单位 GiB。
ProjectName string: 实例所属的项目名称。
SpecFamily string: 实例规格类型，取值：General：通用型。Exclusive：独享型。
StorageChargeType string: 存储计费类型，不传入该参数时，存储计费类型默认与计算计费类型取值一致。取值：PostPaid：按量计费（后付费）。PrePaid：包年包月（预付费）。
StorageUsedGiB float64: 已使用存储空间大小，单位 GiB。
SubnetId string: 子网 ID。子网必须属于所选的可用区。
SuperAccountName string: 高权限用户的账号名称。账号名称需满足以下要求：名称唯一，且长度在 2~32 个字符内。由字母、数字、中划线（-）、下划线（_）组成。以字母开头，以字母或数字结尾。名称内不能包含禁用关键词。
SuperAccountPassword string: 高权限账号的密码。账号密码需满足以下要求：只能包含大小写字母、数字和特殊字符（如 ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/）。长度需在 8~32 个字符内。至少包含大写字母、小写字母、数字或特殊字符中的 3 种。
Tags []GetInstanceTag: 实例绑定的标签键和标签值数组对象。
TemplateId string: 参数模板 ID。
TimeZone string: 实例的时区。国内所有地域默认时区为 UTC +08:00。
VpcId string: 私有网络（VPC） ID。
ZoneIds string: 可用区 ID。

chargeDetail GetInstanceChargeDetail: 计费详细信息。
createdTime String: 实例的创建时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
dbEngineVersion String: 实例兼容版本。取值范围：MySQL80：表示兼容社区 MySQL 8.0 版本。MySQL57：表示兼容社区 MySQL 5.7 版本。
dbMinorVersion String: 根据兼容版本，选择 veDB MySQL 小版本。当 DBEngineVersion 取值为 MySQL57 时，该参数取值默认为 2.0。当 DBEngineVersion 取值为 MySQL80 时，该参数取值范围如下：3.0（默认）：veDB MySQL 稳定版，100% 兼容 MySQL 8.0。3.1：原生支持 HTAP 应用场景，加速复杂查询。3.2：原生支持 HTAP 应用场景，加速复杂查询。
dbRevisionVersion String: 实例的内核版本。
deletionProtection String: 实例是否开启了删除保护功能。取值范围：enabled：开启。disabled：关闭。
endpoints List<GetInstanceEndpoint>: 连接终端的详细信息。
id String: Uniquely identifies the resource.
instanceId String: 实例 ID。
instanceName String: 实例名称。命名规则：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需在 1~128 个字符内。
instanceStatus String: 实例状态。
lowerCaseTableNames String: 表名是否区分大小写。取值范围：0：表名称大小写敏感，后端根据实际表名存储。1：表名称不区分大小写，后端存储时将表名称统一为小写字母。
maintenanceWindow GetInstanceMaintenanceWindow: 实例的可维护时间窗口信息。
nodeNumber Integer: 实例节点数量。取值范围为 2~16 个。
nodeSpec String: 实例的节点规格代码。
nodes List<GetInstanceNode>: 实例节点的详细信息。
number Integer: 创建的实例数量，取值范围 1~50，默认值为 1。
port Integer: 为实例默认创建的连接终端指定私网端口号。默认取值为 3306，取值范围为 1000~65534。
prePaidStorageInGb Integer: 预付费的存储总容量大小，单位 GiB。
projectName String: 实例所属的项目名称。
specFamily String: 实例规格类型，取值：General：通用型。Exclusive：独享型。
storageChargeType String: 存储计费类型，不传入该参数时，存储计费类型默认与计算计费类型取值一致。取值：PostPaid：按量计费（后付费）。PrePaid：包年包月（预付费）。
storageUsedGiB Double: 已使用存储空间大小，单位 GiB。
subnetId String: 子网 ID。子网必须属于所选的可用区。
superAccountName String: 高权限用户的账号名称。账号名称需满足以下要求：名称唯一，且长度在 2~32 个字符内。由字母、数字、中划线（-）、下划线（_）组成。以字母开头，以字母或数字结尾。名称内不能包含禁用关键词。
superAccountPassword String: 高权限账号的密码。账号密码需满足以下要求：只能包含大小写字母、数字和特殊字符（如 ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/）。长度需在 8~32 个字符内。至少包含大写字母、小写字母、数字或特殊字符中的 3 种。
tags List<GetInstanceTag>: 实例绑定的标签键和标签值数组对象。
templateId String: 参数模板 ID。
timeZone String: 实例的时区。国内所有地域默认时区为 UTC +08:00。
vpcId String: 私有网络（VPC） ID。
zoneIds String: 可用区 ID。

chargeDetail GetInstanceChargeDetail: 计费详细信息。
createdTime string: 实例的创建时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
dbEngineVersion string: 实例兼容版本。取值范围：MySQL80：表示兼容社区 MySQL 8.0 版本。MySQL57：表示兼容社区 MySQL 5.7 版本。
dbMinorVersion string: 根据兼容版本，选择 veDB MySQL 小版本。当 DBEngineVersion 取值为 MySQL57 时，该参数取值默认为 2.0。当 DBEngineVersion 取值为 MySQL80 时，该参数取值范围如下：3.0（默认）：veDB MySQL 稳定版，100% 兼容 MySQL 8.0。3.1：原生支持 HTAP 应用场景，加速复杂查询。3.2：原生支持 HTAP 应用场景，加速复杂查询。
dbRevisionVersion string: 实例的内核版本。
deletionProtection string: 实例是否开启了删除保护功能。取值范围：enabled：开启。disabled：关闭。
endpoints GetInstanceEndpoint[]: 连接终端的详细信息。
id string: Uniquely identifies the resource.
instanceId string: 实例 ID。
instanceName string: 实例名称。命名规则：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需在 1~128 个字符内。
instanceStatus string: 实例状态。
lowerCaseTableNames string: 表名是否区分大小写。取值范围：0：表名称大小写敏感，后端根据实际表名存储。1：表名称不区分大小写，后端存储时将表名称统一为小写字母。
maintenanceWindow GetInstanceMaintenanceWindow: 实例的可维护时间窗口信息。
nodeNumber number: 实例节点数量。取值范围为 2~16 个。
nodeSpec string: 实例的节点规格代码。
nodes GetInstanceNode[]: 实例节点的详细信息。
number number: 创建的实例数量，取值范围 1~50，默认值为 1。
port number: 为实例默认创建的连接终端指定私网端口号。默认取值为 3306，取值范围为 1000~65534。
prePaidStorageInGb number: 预付费的存储总容量大小，单位 GiB。
projectName string: 实例所属的项目名称。
specFamily string: 实例规格类型，取值：General：通用型。Exclusive：独享型。
storageChargeType string: 存储计费类型，不传入该参数时，存储计费类型默认与计算计费类型取值一致。取值：PostPaid：按量计费（后付费）。PrePaid：包年包月（预付费）。
storageUsedGiB number: 已使用存储空间大小，单位 GiB。
subnetId string: 子网 ID。子网必须属于所选的可用区。
superAccountName string: 高权限用户的账号名称。账号名称需满足以下要求：名称唯一，且长度在 2~32 个字符内。由字母、数字、中划线（-）、下划线（_）组成。以字母开头，以字母或数字结尾。名称内不能包含禁用关键词。
superAccountPassword string: 高权限账号的密码。账号密码需满足以下要求：只能包含大小写字母、数字和特殊字符（如 ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/）。长度需在 8~32 个字符内。至少包含大写字母、小写字母、数字或特殊字符中的 3 种。
tags GetInstanceTag[]: 实例绑定的标签键和标签值数组对象。
templateId string: 参数模板 ID。
timeZone string: 实例的时区。国内所有地域默认时区为 UTC +08:00。
vpcId string: 私有网络（VPC） ID。
zoneIds string: 可用区 ID。

charge_detail GetInstanceChargeDetail: 计费详细信息。
created_time str: 实例的创建时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
db_engine_version str: 实例兼容版本。取值范围：MySQL80：表示兼容社区 MySQL 8.0 版本。MySQL57：表示兼容社区 MySQL 5.7 版本。
db_minor_version str: 根据兼容版本，选择 veDB MySQL 小版本。当 DBEngineVersion 取值为 MySQL57 时，该参数取值默认为 2.0。当 DBEngineVersion 取值为 MySQL80 时，该参数取值范围如下：3.0（默认）：veDB MySQL 稳定版，100% 兼容 MySQL 8.0。3.1：原生支持 HTAP 应用场景，加速复杂查询。3.2：原生支持 HTAP 应用场景，加速复杂查询。
db_revision_version str: 实例的内核版本。
deletion_protection str: 实例是否开启了删除保护功能。取值范围：enabled：开启。disabled：关闭。
endpoints Sequence[GetInstanceEndpoint]: 连接终端的详细信息。
id str: Uniquely identifies the resource.
instance_id str: 实例 ID。
instance_name str: 实例名称。命名规则：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需在 1~128 个字符内。
instance_status str: 实例状态。
lower_case_table_names str: 表名是否区分大小写。取值范围：0：表名称大小写敏感，后端根据实际表名存储。1：表名称不区分大小写，后端存储时将表名称统一为小写字母。
maintenance_window GetInstanceMaintenanceWindow: 实例的可维护时间窗口信息。
node_number int: 实例节点数量。取值范围为 2~16 个。
node_spec str: 实例的节点规格代码。
nodes Sequence[GetInstanceNode]: 实例节点的详细信息。
number int: 创建的实例数量，取值范围 1~50，默认值为 1。
port int: 为实例默认创建的连接终端指定私网端口号。默认取值为 3306，取值范围为 1000~65534。
pre_paid_storage_in_gb int: 预付费的存储总容量大小，单位 GiB。
project_name str: 实例所属的项目名称。
spec_family str: 实例规格类型，取值：General：通用型。Exclusive：独享型。
storage_charge_type str: 存储计费类型，不传入该参数时，存储计费类型默认与计算计费类型取值一致。取值：PostPaid：按量计费（后付费）。PrePaid：包年包月（预付费）。
storage_used_gi_b float: 已使用存储空间大小，单位 GiB。
subnet_id str: 子网 ID。子网必须属于所选的可用区。
super_account_name str: 高权限用户的账号名称。账号名称需满足以下要求：名称唯一，且长度在 2~32 个字符内。由字母、数字、中划线（-）、下划线（_）组成。以字母开头，以字母或数字结尾。名称内不能包含禁用关键词。
super_account_password str: 高权限账号的密码。账号密码需满足以下要求：只能包含大小写字母、数字和特殊字符（如 ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/）。长度需在 8~32 个字符内。至少包含大写字母、小写字母、数字或特殊字符中的 3 种。
tags Sequence[GetInstanceTag]: 实例绑定的标签键和标签值数组对象。
template_id str: 参数模板 ID。
time_zone str: 实例的时区。国内所有地域默认时区为 UTC +08:00。
vpc_id str: 私有网络（VPC） ID。
zone_ids str: 可用区 ID。

chargeDetail Property Map: 计费详细信息。
createdTime String: 实例的创建时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
dbEngineVersion String: 实例兼容版本。取值范围：MySQL80：表示兼容社区 MySQL 8.0 版本。MySQL57：表示兼容社区 MySQL 5.7 版本。
dbMinorVersion String: 根据兼容版本，选择 veDB MySQL 小版本。当 DBEngineVersion 取值为 MySQL57 时，该参数取值默认为 2.0。当 DBEngineVersion 取值为 MySQL80 时，该参数取值范围如下：3.0（默认）：veDB MySQL 稳定版，100% 兼容 MySQL 8.0。3.1：原生支持 HTAP 应用场景，加速复杂查询。3.2：原生支持 HTAP 应用场景，加速复杂查询。
dbRevisionVersion String: 实例的内核版本。
deletionProtection String: 实例是否开启了删除保护功能。取值范围：enabled：开启。disabled：关闭。
endpoints List<Property Map>: 连接终端的详细信息。
id String: Uniquely identifies the resource.
instanceId String: 实例 ID。
instanceName String: 实例名称。命名规则：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需在 1~128 个字符内。
instanceStatus String: 实例状态。
lowerCaseTableNames String: 表名是否区分大小写。取值范围：0：表名称大小写敏感，后端根据实际表名存储。1：表名称不区分大小写，后端存储时将表名称统一为小写字母。
maintenanceWindow Property Map: 实例的可维护时间窗口信息。
nodeNumber Number: 实例节点数量。取值范围为 2~16 个。
nodeSpec String: 实例的节点规格代码。
nodes List<Property Map>: 实例节点的详细信息。
number Number: 创建的实例数量，取值范围 1~50，默认值为 1。
port Number: 为实例默认创建的连接终端指定私网端口号。默认取值为 3306，取值范围为 1000~65534。
prePaidStorageInGb Number: 预付费的存储总容量大小，单位 GiB。
projectName String: 实例所属的项目名称。
specFamily String: 实例规格类型，取值：General：通用型。Exclusive：独享型。
storageChargeType String: 存储计费类型，不传入该参数时，存储计费类型默认与计算计费类型取值一致。取值：PostPaid：按量计费（后付费）。PrePaid：包年包月（预付费）。
storageUsedGiB Number: 已使用存储空间大小，单位 GiB。
subnetId String: 子网 ID。子网必须属于所选的可用区。
superAccountName String: 高权限用户的账号名称。账号名称需满足以下要求：名称唯一，且长度在 2~32 个字符内。由字母、数字、中划线（-）、下划线（_）组成。以字母开头，以字母或数字结尾。名称内不能包含禁用关键词。
superAccountPassword String: 高权限账号的密码。账号密码需满足以下要求：只能包含大小写字母、数字和特殊字符（如 ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/）。长度需在 8~32 个字符内。至少包含大写字母、小写字母、数字或特殊字符中的 3 种。
tags List<Property Map>: 实例绑定的标签键和标签值数组对象。
templateId String: 参数模板 ID。
timeZone String: 实例的时区。国内所有地域默认时区为 UTC +08:00。
vpcId String: 私有网络（VPC） ID。
zoneIds String: 可用区 ID。

Supporting Types

GetInstanceChargeDetail

AutoRenew bool: 预付费场景下是否自动续费。取值：true：自动续费。false：不自动续费。
ChargeEndTime string: 预付费场景下计费到期的时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
ChargeStartTime string: 计费开始的时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
ChargeStatus string: 付费状态：Normal：正常。Overdue：欠费。Shutdown：关停。
ChargeType string: 计费类型。PostPaid：按量计费；PrePaid：包年包月。
OverdueReclaimTime string: 欠费关停时预计释放时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
OverdueTime string: 欠费关停时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
Period int: 预付费场景下的购买时长。
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：欠费。Shutdown：关停。
ChargeType string: 计费类型。PostPaid：按量计费；PrePaid：包年包月。
OverdueReclaimTime string: 欠费关停时预计释放时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
OverdueTime string: 欠费关停时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
Period int: 预付费场景下的购买时长。
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：欠费。Shutdown：关停。
chargeType String: 计费类型。PostPaid：按量计费；PrePaid：包年包月。
overdueReclaimTime String: 欠费关停时预计释放时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
overdueTime String: 欠费关停时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
period Integer: 预付费场景下的购买时长。
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：欠费。Shutdown：关停。
chargeType string: 计费类型。PostPaid：按量计费；PrePaid：包年包月。
overdueReclaimTime string: 欠费关停时预计释放时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
overdueTime string: 欠费关停时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
period number: 预付费场景下的购买时长。
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：欠费。Shutdown：关停。
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: 预付费场景下的购买时长。
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：欠费。Shutdown：关停。
chargeType String: 计费类型。PostPaid：按量计费；PrePaid：包年包月。
overdueReclaimTime String: 欠费关停时预计释放时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
overdueTime String: 欠费关停时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
period Number: 预付费场景下的购买时长。
periodUnit String: 预付费场景下的购买周期。Month：包月。Year：包年。

GetInstanceEndpoint

Addresses List<Volcengine.GetInstanceEndpointAddress>: 连接地址信息。
AutoAddNewNodes bool: 是否允许自动加入新节点，取值：true：是。false：否。
ConsistLevel string: 一致性级别，仅对读写模式的连接终端有效。取值：Eventual：最终一致性。Session：会话一致性。Global：全局一致性。
ConsistTimeout int: 延迟很大时，只读节点同步最新数据的超时时间，单位为 us，取值范围为 1us~100000000us。
ConsistTimeoutAction string: 只读节点同步数据超时后的超时策略，支持以下两种策略：ReturnError：返回 SQL 报错（wait replication complete timeout, please retry）。ReadMaster：发送请求到主节点。
Description string: 地址描述。
DistributedTransaction bool: 是否开启事务拆分，仅对读写模式的连接终端有效。取值：true：是。false：否。
EndpointId string: 实例连接终端 ID。
EndpointName string: 实例连接终端名称。
EndpointType string: 连接终端类型，取值：Cluster：默认终端。Primary：主节点终端。Custom：自定义终端。
MasterAcceptReadRequests bool: 主节点是否接受读请求。仅对读写模式的连接终端有效。true：是。false：否。
NodeIds List<string>: 连接终端配置的节点列表。
ReadWriteMode string: 连接终端的读写模式，取值：ReadWrite: 读写。ReadOnly: 只读。

Addresses []GetInstanceEndpointAddress: 连接地址信息。
AutoAddNewNodes bool: 是否允许自动加入新节点，取值：true：是。false：否。
ConsistLevel string: 一致性级别，仅对读写模式的连接终端有效。取值：Eventual：最终一致性。Session：会话一致性。Global：全局一致性。
ConsistTimeout int: 延迟很大时，只读节点同步最新数据的超时时间，单位为 us，取值范围为 1us~100000000us。
ConsistTimeoutAction string: 只读节点同步数据超时后的超时策略，支持以下两种策略：ReturnError：返回 SQL 报错（wait replication complete timeout, please retry）。ReadMaster：发送请求到主节点。
Description string: 地址描述。
DistributedTransaction bool: 是否开启事务拆分，仅对读写模式的连接终端有效。取值：true：是。false：否。
EndpointId string: 实例连接终端 ID。
EndpointName string: 实例连接终端名称。
EndpointType string: 连接终端类型，取值：Cluster：默认终端。Primary：主节点终端。Custom：自定义终端。
MasterAcceptReadRequests bool: 主节点是否接受读请求。仅对读写模式的连接终端有效。true：是。false：否。
NodeIds []string: 连接终端配置的节点列表。
ReadWriteMode string: 连接终端的读写模式，取值：ReadWrite: 读写。ReadOnly: 只读。

addresses List<GetInstanceEndpointAddress>: 连接地址信息。
autoAddNewNodes Boolean: 是否允许自动加入新节点，取值：true：是。false：否。
consistLevel String: 一致性级别，仅对读写模式的连接终端有效。取值：Eventual：最终一致性。Session：会话一致性。Global：全局一致性。
consistTimeout Integer: 延迟很大时，只读节点同步最新数据的超时时间，单位为 us，取值范围为 1us~100000000us。
consistTimeoutAction String: 只读节点同步数据超时后的超时策略，支持以下两种策略：ReturnError：返回 SQL 报错（wait replication complete timeout, please retry）。ReadMaster：发送请求到主节点。
description String: 地址描述。
distributedTransaction Boolean: 是否开启事务拆分，仅对读写模式的连接终端有效。取值：true：是。false：否。
endpointId String: 实例连接终端 ID。
endpointName String: 实例连接终端名称。
endpointType String: 连接终端类型，取值：Cluster：默认终端。Primary：主节点终端。Custom：自定义终端。
masterAcceptReadRequests Boolean: 主节点是否接受读请求。仅对读写模式的连接终端有效。true：是。false：否。
nodeIds List<String>: 连接终端配置的节点列表。
readWriteMode String: 连接终端的读写模式，取值：ReadWrite: 读写。ReadOnly: 只读。

addresses GetInstanceEndpointAddress[]: 连接地址信息。
autoAddNewNodes boolean: 是否允许自动加入新节点，取值：true：是。false：否。
consistLevel string: 一致性级别，仅对读写模式的连接终端有效。取值：Eventual：最终一致性。Session：会话一致性。Global：全局一致性。
consistTimeout number: 延迟很大时，只读节点同步最新数据的超时时间，单位为 us，取值范围为 1us~100000000us。
consistTimeoutAction string: 只读节点同步数据超时后的超时策略，支持以下两种策略：ReturnError：返回 SQL 报错（wait replication complete timeout, please retry）。ReadMaster：发送请求到主节点。
description string: 地址描述。
distributedTransaction boolean: 是否开启事务拆分，仅对读写模式的连接终端有效。取值：true：是。false：否。
endpointId string: 实例连接终端 ID。
endpointName string: 实例连接终端名称。
endpointType string: 连接终端类型，取值：Cluster：默认终端。Primary：主节点终端。Custom：自定义终端。
masterAcceptReadRequests boolean: 主节点是否接受读请求。仅对读写模式的连接终端有效。true：是。false：否。
nodeIds string[]: 连接终端配置的节点列表。
readWriteMode string: 连接终端的读写模式，取值：ReadWrite: 读写。ReadOnly: 只读。

addresses Sequence[GetInstanceEndpointAddress]: 连接地址信息。
auto_add_new_nodes bool: 是否允许自动加入新节点，取值：true：是。false：否。
consist_level str: 一致性级别，仅对读写模式的连接终端有效。取值：Eventual：最终一致性。Session：会话一致性。Global：全局一致性。
consist_timeout int: 延迟很大时，只读节点同步最新数据的超时时间，单位为 us，取值范围为 1us~100000000us。
consist_timeout_action str: 只读节点同步数据超时后的超时策略，支持以下两种策略：ReturnError：返回 SQL 报错（wait replication complete timeout, please retry）。ReadMaster：发送请求到主节点。
description str: 地址描述。
distributed_transaction bool: 是否开启事务拆分，仅对读写模式的连接终端有效。取值：true：是。false：否。
endpoint_id str: 实例连接终端 ID。
endpoint_name str: 实例连接终端名称。
endpoint_type str: 连接终端类型，取值：Cluster：默认终端。Primary：主节点终端。Custom：自定义终端。
master_accept_read_requests bool: 主节点是否接受读请求。仅对读写模式的连接终端有效。true：是。false：否。
node_ids Sequence[str]: 连接终端配置的节点列表。
read_write_mode str: 连接终端的读写模式，取值：ReadWrite: 读写。ReadOnly: 只读。

addresses List<Property Map>: 连接地址信息。
autoAddNewNodes Boolean: 是否允许自动加入新节点，取值：true：是。false：否。
consistLevel String: 一致性级别，仅对读写模式的连接终端有效。取值：Eventual：最终一致性。Session：会话一致性。Global：全局一致性。
consistTimeout Number: 延迟很大时，只读节点同步最新数据的超时时间，单位为 us，取值范围为 1us~100000000us。
consistTimeoutAction String: 只读节点同步数据超时后的超时策略，支持以下两种策略：ReturnError：返回 SQL 报错（wait replication complete timeout, please retry）。ReadMaster：发送请求到主节点。
description String: 地址描述。
distributedTransaction Boolean: 是否开启事务拆分，仅对读写模式的连接终端有效。取值：true：是。false：否。
endpointId String: 实例连接终端 ID。
endpointName String: 实例连接终端名称。
endpointType String: 连接终端类型，取值：Cluster：默认终端。Primary：主节点终端。Custom：自定义终端。
masterAcceptReadRequests Boolean: 主节点是否接受读请求。仅对读写模式的连接终端有效。true：是。false：否。
nodeIds List<String>: 连接终端配置的节点列表。
readWriteMode String: 连接终端的读写模式，取值：ReadWrite: 读写。ReadOnly: 只读。

GetInstanceEndpointAddress

DnsVisibility bool: 解析方式。当前返回值只能为 false。
Domain string: 实例内网访问域名。
EipId string: 公网 ID。
IpAddress string: IP 地址。
NetworkType string: 网络类型：Private：私有网络 VPC。Public：公网访问。
Port string: 实例内网访问端口。
SubnetId string: 子网 ID。子网必须属于所选的可用区。

DnsVisibility bool: 解析方式。当前返回值只能为 false。
Domain string: 实例内网访问域名。
EipId string: 公网 ID。
IpAddress string: IP 地址。
NetworkType string: 网络类型：Private：私有网络 VPC。Public：公网访问。
Port string: 实例内网访问端口。
SubnetId string: 子网 ID。子网必须属于所选的可用区。

dnsVisibility Boolean: 解析方式。当前返回值只能为 false。
domain String: 实例内网访问域名。
eipId String: 公网 ID。
ipAddress String: IP 地址。
networkType String: 网络类型：Private：私有网络 VPC。Public：公网访问。
port String: 实例内网访问端口。
subnetId String: 子网 ID。子网必须属于所选的可用区。

dnsVisibility boolean: 解析方式。当前返回值只能为 false。
domain string: 实例内网访问域名。
eipId string: 公网 ID。
ipAddress string: IP 地址。
networkType string: 网络类型：Private：私有网络 VPC。Public：公网访问。
port string: 实例内网访问端口。
subnetId string: 子网 ID。子网必须属于所选的可用区。

dns_visibility bool: 解析方式。当前返回值只能为 false。
domain str: 实例内网访问域名。
eip_id str: 公网 ID。
ip_address str: IP 地址。
network_type str: 网络类型：Private：私有网络 VPC。Public：公网访问。
port str: 实例内网访问端口。
subnet_id str: 子网 ID。子网必须属于所选的可用区。

dnsVisibility Boolean: 解析方式。当前返回值只能为 false。
domain String: 实例内网访问域名。
eipId String: 公网 ID。
ipAddress String: IP 地址。
networkType String: 网络类型：Private：私有网络 VPC。Public：公网访问。
port String: 实例内网访问端口。
subnetId String: 子网 ID。子网必须属于所选的可用区。

GetInstanceMaintenanceWindow

DayKind string: 可维护周期粒度，默认取值为：Week（周）。
DayOfMonths List<int>: 指定每月哪一天为可维护时间段，默认为空，表示每天都指定。
DayOfWeeks List<string>: 每周的哪一天为可维护时间段，默认取值为每一天：Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday。
MaintenanceTime string: 实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC 时间）。

DayKind string: 可维护周期粒度，默认取值为：Week（周）。
DayOfMonths []int: 指定每月哪一天为可维护时间段，默认为空，表示每天都指定。
DayOfWeeks []string: 每周的哪一天为可维护时间段，默认取值为每一天：Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday。
MaintenanceTime string: 实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC 时间）。

dayKind String: 可维护周期粒度，默认取值为：Week（周）。
dayOfMonths List<Integer>: 指定每月哪一天为可维护时间段，默认为空，表示每天都指定。
dayOfWeeks List<String>: 每周的哪一天为可维护时间段，默认取值为每一天：Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday。
maintenanceTime String: 实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC 时间）。

dayKind string: 可维护周期粒度，默认取值为：Week（周）。
dayOfMonths number[]: 指定每月哪一天为可维护时间段，默认为空，表示每天都指定。
dayOfWeeks string[]: 每周的哪一天为可维护时间段，默认取值为每一天：Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday。
maintenanceTime string: 实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC 时间）。

day_kind str: 可维护周期粒度，默认取值为：Week（周）。
day_of_months Sequence[int]: 指定每月哪一天为可维护时间段，默认为空，表示每天都指定。
day_of_weeks Sequence[str]: 每周的哪一天为可维护时间段，默认取值为每一天：Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday。
maintenance_time str: 实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC 时间）。

dayKind String: 可维护周期粒度，默认取值为：Week（周）。
dayOfMonths List<Number>: 指定每月哪一天为可维护时间段，默认为空，表示每天都指定。
dayOfWeeks List<String>: 每周的哪一天为可维护时间段，默认取值为每一天：Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday。
maintenanceTime String: 实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC 时间）。

GetInstanceNode

FailoverPriority int: 节点切主的优先级，取值范围为 0~15。数值越大，优先级越高。
Memory int: 内存大小，单位为 GiB。
NodeId string: 节点 ID。
NodeSpec string: 节点规格。
NodeType string: 节点类型。取值：Primary：主节点。ReadOnly：只读节点。
VCpu int: CPU 大小，例如当取值为 1 时表示 CPU 大小为 1U。
ZoneId string: 可用区 ID。

FailoverPriority int: 节点切主的优先级，取值范围为 0~15。数值越大，优先级越高。
Memory int: 内存大小，单位为 GiB。
NodeId string: 节点 ID。
NodeSpec string: 节点规格。
NodeType string: 节点类型。取值：Primary：主节点。ReadOnly：只读节点。
VCpu int: CPU 大小，例如当取值为 1 时表示 CPU 大小为 1U。
ZoneId string: 可用区 ID。

failoverPriority Integer: 节点切主的优先级，取值范围为 0~15。数值越大，优先级越高。
memory Integer: 内存大小，单位为 GiB。
nodeId String: 节点 ID。
nodeSpec String: 节点规格。
nodeType String: 节点类型。取值：Primary：主节点。ReadOnly：只读节点。
vCpu Integer: CPU 大小，例如当取值为 1 时表示 CPU 大小为 1U。
zoneId String: 可用区 ID。

failoverPriority number: 节点切主的优先级，取值范围为 0~15。数值越大，优先级越高。
memory number: 内存大小，单位为 GiB。
nodeId string: 节点 ID。
nodeSpec string: 节点规格。
nodeType string: 节点类型。取值：Primary：主节点。ReadOnly：只读节点。
vCpu number: CPU 大小，例如当取值为 1 时表示 CPU 大小为 1U。
zoneId string: 可用区 ID。

failover_priority int: 节点切主的优先级，取值范围为 0~15。数值越大，优先级越高。
memory int: 内存大小，单位为 GiB。
node_id str: 节点 ID。
node_spec str: 节点规格。
node_type str: 节点类型。取值：Primary：主节点。ReadOnly：只读节点。
v_cpu int: CPU 大小，例如当取值为 1 时表示 CPU 大小为 1U。
zone_id str: 可用区 ID。

failoverPriority Number: 节点切主的优先级，取值范围为 0~15。数值越大，优先级越高。
memory Number: 内存大小，单位为 GiB。
nodeId String: 节点 ID。
nodeSpec String: 节点规格。
nodeType String: 节点类型。取值：Primary：主节点。ReadOnly：只读节点。
vCpu Number: CPU 大小，例如当取值为 1 时表示 CPU 大小为 1U。
zoneId String: 可用区 ID。

GetInstanceTag

Key string: 用户标签的标签键。长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。若标签键开头或结尾存在空格，系统会自动为其去除。
Value string: 用户标签的标签值。允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。大小写敏感。若标签值开头或结尾存在空格，系统会自动为其去除。

Key string: 用户标签的标签键。长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。若标签键开头或结尾存在空格，系统会自动为其去除。
Value string: 用户标签的标签值。允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。大小写敏感。若标签值开头或结尾存在空格，系统会自动为其去除。

key String: 用户标签的标签键。长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。若标签键开头或结尾存在空格，系统会自动为其去除。
value String: 用户标签的标签值。允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。大小写敏感。若标签值开头或结尾存在空格，系统会自动为其去除。

key string: 用户标签的标签键。长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。若标签键开头或结尾存在空格，系统会自动为其去除。
value string: 用户标签的标签值。允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。大小写敏感。若标签值开头或结尾存在空格，系统会自动为其去除。

key str: 用户标签的标签键。长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。若标签键开头或结尾存在空格，系统会自动为其去除。
value str: 用户标签的标签值。允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。大小写敏感。若标签值开头或结尾存在空格，系统会自动为其去除。

key String: 用户标签的标签键。长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。若标签键开头或结尾存在空格，系统会自动为其去除。
value String: 用户标签的标签值。允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。大小写敏感。若标签值开头或结尾存在空格，系统会自动为其去除。