bytepluscc.vedbm.getInstance

bytepluscc v0.0.21, Apr 2 26

Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 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: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 Byteplus.GetInstanceChargeDetail: Billing details.
CreatedTime string: Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)
DbEngineVersion string: Instance compatible version. Options: MySQL80: Compatible with community MySQL 8.0. MySQL57: Compatible with community MySQL 5.7
DbMinorVersion string: Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL57, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL80, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.
DbRevisionVersion string: Instance kernel version.
DeletionProtection string: Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.
Endpoints List<Byteplus.GetInstanceEndpoint>: Endpoint details
Id string: Uniquely identifies the resource.
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.
LowerCaseTableNames string: Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.
MaintenanceWindow Byteplus.GetInstanceMaintenanceWindow: Instance maintenance window information
NodeNumber int: Number of instance nodes. Value range: 2–16.
NodeSpec string: Instance node specification code.
Nodes List<Byteplus.GetInstanceNode>: Instance node details
Number int: Number of instances to create. Range: 1~50. Default: 1
Port int: Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.
PrePaidStorageInGb int: Total prepaid storage capacity, in GiB
ProjectName string: Project name to which the instance belongs.
SpecFamily string: Instance specification type. Values: General: general purpose. Exclusive: dedicated.
StorageChargeType string: Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).
StorageUsedGiB double: Used storage space, in GiB
SubnetId string: Subnet ID. The subnet must belong to the selected availability zone.
SuperAccountName string: Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords
SuperAccountPassword string: Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.
Tags List<Byteplus.GetInstanceTag>: Array object of tag keys and tag values bound to the instance.
TemplateId string: Parameter template ID
TimeZone string: Instance time zone. The default time zone for all regions in China is UTC +08:00.
VpcId string: Private network (VPC) ID.
ZoneIds string: Availability zone ID

ChargeDetail GetInstanceChargeDetail: Billing details.
CreatedTime string: Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)
DbEngineVersion string: Instance compatible version. Options: MySQL80: Compatible with community MySQL 8.0. MySQL57: Compatible with community MySQL 5.7
DbMinorVersion string: Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL57, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL80, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.
DbRevisionVersion string: Instance kernel version.
DeletionProtection string: Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.
Endpoints []GetInstanceEndpoint: Endpoint details
Id string: Uniquely identifies the resource.
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.
LowerCaseTableNames string: Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.
MaintenanceWindow GetInstanceMaintenanceWindow: Instance maintenance window information
NodeNumber int: Number of instance nodes. Value range: 2–16.
NodeSpec string: Instance node specification code.
Nodes []GetInstanceNode: Instance node details
Number int: Number of instances to create. Range: 1~50. Default: 1
Port int: Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.
PrePaidStorageInGb int: Total prepaid storage capacity, in GiB
ProjectName string: Project name to which the instance belongs.
SpecFamily string: Instance specification type. Values: General: general purpose. Exclusive: dedicated.
StorageChargeType string: Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).
StorageUsedGiB float64: Used storage space, in GiB
SubnetId string: Subnet ID. The subnet must belong to the selected availability zone.
SuperAccountName string: Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords
SuperAccountPassword string: Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.
Tags []GetInstanceTag: Array object of tag keys and tag values bound to the instance.
TemplateId string: Parameter template ID
TimeZone string: Instance time zone. The default time zone for all regions in China is UTC +08:00.
VpcId string: Private network (VPC) ID.
ZoneIds string: Availability zone ID

chargeDetail GetInstanceChargeDetail: Billing details.
createdTime String: Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)
dbEngineVersion String: Instance compatible version. Options: MySQL80: Compatible with community MySQL 8.0. MySQL57: Compatible with community MySQL 5.7
dbMinorVersion String: Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL57, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL80, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.
dbRevisionVersion String: Instance kernel version.
deletionProtection String: Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.
endpoints List<GetInstanceEndpoint>: Endpoint details
id String: Uniquely identifies the resource.
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.
lowerCaseTableNames String: Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.
maintenanceWindow GetInstanceMaintenanceWindow: Instance maintenance window information
nodeNumber Integer: Number of instance nodes. Value range: 2–16.
nodeSpec String: Instance node specification code.
nodes List<GetInstanceNode>: Instance node details
number Integer: Number of instances to create. Range: 1~50. Default: 1
port Integer: Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.
prePaidStorageInGb Integer: Total prepaid storage capacity, in GiB
projectName String: Project name to which the instance belongs.
specFamily String: Instance specification type. Values: General: general purpose. Exclusive: dedicated.
storageChargeType String: Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).
storageUsedGiB Double: Used storage space, in GiB
subnetId String: Subnet ID. The subnet must belong to the selected availability zone.
superAccountName String: Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords
superAccountPassword String: Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.
tags List<GetInstanceTag>: Array object of tag keys and tag values bound to the instance.
templateId String: Parameter template ID
timeZone String: Instance time zone. The default time zone for all regions in China is UTC +08:00.
vpcId String: Private network (VPC) ID.
zoneIds String: Availability zone ID

chargeDetail GetInstanceChargeDetail: Billing details.
createdTime string: Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)
dbEngineVersion string: Instance compatible version. Options: MySQL80: Compatible with community MySQL 8.0. MySQL57: Compatible with community MySQL 5.7
dbMinorVersion string: Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL57, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL80, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.
dbRevisionVersion string: Instance kernel version.
deletionProtection string: Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.
endpoints GetInstanceEndpoint[]: Endpoint details
id string: Uniquely identifies the resource.
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.
lowerCaseTableNames string: Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.
maintenanceWindow GetInstanceMaintenanceWindow: Instance maintenance window information
nodeNumber number: Number of instance nodes. Value range: 2–16.
nodeSpec string: Instance node specification code.
nodes GetInstanceNode[]: Instance node details
number number: Number of instances to create. Range: 1~50. Default: 1
port number: Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.
prePaidStorageInGb number: Total prepaid storage capacity, in GiB
projectName string: Project name to which the instance belongs.
specFamily string: Instance specification type. Values: General: general purpose. Exclusive: dedicated.
storageChargeType string: Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).
storageUsedGiB number: Used storage space, in GiB
subnetId string: Subnet ID. The subnet must belong to the selected availability zone.
superAccountName string: Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords
superAccountPassword string: Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.
tags GetInstanceTag[]: Array object of tag keys and tag values bound to the instance.
templateId string: Parameter template ID
timeZone string: Instance time zone. The default time zone for all regions in China is UTC +08:00.
vpcId string: Private network (VPC) ID.
zoneIds string: Availability zone ID

charge_detail GetInstanceChargeDetail: Billing details.
created_time str: Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)
db_engine_version str: Instance compatible version. Options: MySQL80: Compatible with community MySQL 8.0. MySQL57: Compatible with community MySQL 5.7
db_minor_version str: Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL57, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL80, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.
db_revision_version str: Instance kernel version.
deletion_protection str: Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.
endpoints Sequence[GetInstanceEndpoint]: Endpoint details
id str: Uniquely identifies the resource.
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.
lower_case_table_names str: Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.
maintenance_window GetInstanceMaintenanceWindow: Instance maintenance window information
node_number int: Number of instance nodes. Value range: 2–16.
node_spec str: Instance node specification code.
nodes Sequence[GetInstanceNode]: Instance node details
number int: Number of instances to create. Range: 1~50. Default: 1
port int: Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.
pre_paid_storage_in_gb int: Total prepaid storage capacity, in GiB
project_name str: Project name to which the instance belongs.
spec_family str: Instance specification type. Values: General: general purpose. Exclusive: dedicated.
storage_charge_type str: Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).
storage_used_gi_b float: Used storage space, in GiB
subnet_id str: Subnet ID. The subnet must belong to the selected availability zone.
super_account_name str: Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords
super_account_password str: Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.
tags Sequence[GetInstanceTag]: Array object of tag keys and tag values bound to the instance.
template_id str: Parameter template ID
time_zone str: Instance time zone. The default time zone for all regions in China is UTC +08:00.
vpc_id str: Private network (VPC) ID.
zone_ids str: Availability zone ID

chargeDetail Property Map: Billing details.
createdTime String: Instance creation time, format: YYYY-MM-DDTHH:MM:SSZ (UTC time)
dbEngineVersion String: Instance compatible version. Options: MySQL80: Compatible with community MySQL 8.0. MySQL57: Compatible with community MySQL 5.7
dbMinorVersion String: Select the veDB MySQL minor version based on compatibility. When DBEngineVersion is set to MySQL57, the default value for this parameter is 2.0. When DBEngineVersion is set to MySQL80, the parameter value options are as follows: 3.0 (default): veDB MySQL stable version, 100% compatible with MySQL 8.0. 3.1: Native support for HTAP scenarios, accelerates complex queries. 3.2: Native support for HTAP scenarios, accelerates complex queries.
dbRevisionVersion String: Instance kernel version.
deletionProtection String: Whether deletion protection is enabled for the instance. Value range: enabled: enabled. disabled: disabled.
endpoints List<Property Map>: Endpoint details
id String: Uniquely identifies the resource.
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.
lowerCaseTableNames String: Whether table names are case-sensitive. Value range: 0: table names are case-sensitive; backend stores according to actual table name. 1: table names are not case-sensitive; backend stores table names in lowercase.
maintenanceWindow Property Map: Instance maintenance window information
nodeNumber Number: Number of instance nodes. Value range: 2–16.
nodeSpec String: Instance node specification code.
nodes List<Property Map>: Instance node details
number Number: Number of instances to create. Range: 1~50. Default: 1
port Number: Specify the private network port number for the default connection endpoint created for the instance. Default value is 3306. Value range: 1000–65534.
prePaidStorageInGb Number: Total prepaid storage capacity, in GiB
projectName String: Project name to which the instance belongs.
specFamily String: Instance specification type. Values: General: general purpose. Exclusive: dedicated.
storageChargeType String: Storage billing type. If this parameter is not specified, the storage billing type defaults to the same value as the compute billing type. Values: PostPaid: pay-as-you-go. PrePaid: annual/monthly subscription (prepaid).
storageUsedGiB Number: Used storage space, in GiB
subnetId String: Subnet ID. The subnet must belong to the selected availability zone.
superAccountName String: Account name for privileged user. Requirements: Must be unique, 2–32 characters. Letters, numbers, hyphens (-), and underscores (_) only. Must start with a letter and end with a letter or number. Cannot contain prohibited keywords
superAccountPassword String: Password for high-privilege account. The password must meet the following requirements: can only contain uppercase and lowercase letters, numbers, and special characters (such as ~!@#$%^&*_-+=`|(){}[]:;'<>,.?/). Length must be between 8 and 32 characters. Must include at least three of the following: uppercase letters, lowercase letters, numbers, or special characters.
tags List<Property Map>: Array object of tag keys and tag values bound to the instance.
templateId String: Parameter template ID
timeZone String: Instance time zone. The default time zone for all regions in China is UTC +08:00.
vpcId String: Private network (VPC) ID.
zoneIds String: Availability zone ID

Supporting Types

GetInstanceChargeDetail

AutoRenew bool: Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.
ChargeEndTime string: Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
ChargeStartTime string: Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
ChargeStatus string: Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown
ChargeType string: Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription
OverdueReclaimTime string: Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
OverdueTime string: Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
Period int: Purchase duration for prepaid scenarios.
PeriodUnit string: Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.

AutoRenew bool: Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.
ChargeEndTime string: Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
ChargeStartTime string: Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
ChargeStatus string: Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown
ChargeType string: Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription
OverdueReclaimTime string: Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
OverdueTime string: Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
Period int: Purchase duration for prepaid scenarios.
PeriodUnit string: Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.

autoRenew Boolean: Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.
chargeEndTime String: Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
chargeStartTime String: Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
chargeStatus String: Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown
chargeType String: Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription
overdueReclaimTime String: Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
overdueTime String: Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
period Integer: Purchase duration for prepaid scenarios.
periodUnit String: Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.

autoRenew boolean: Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.
chargeEndTime string: Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
chargeStartTime string: Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
chargeStatus string: Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown
chargeType string: Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription
overdueReclaimTime string: Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
overdueTime string: Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
period number: Purchase duration for prepaid scenarios.
periodUnit string: Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.

auto_renew bool: Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.
charge_end_time str: Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
charge_start_time str: Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
charge_status str: Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown
charge_type str: Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription
overdue_reclaim_time str: Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
overdue_time str: Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
period int: Purchase duration for prepaid scenarios.
period_unit str: Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.

autoRenew Boolean: Whether to enable auto-renewal in prepaid scenarios. Values: true: auto-renewal. false: no auto-renewal.
chargeEndTime String: Billing expiration time for prepaid scenarios, format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
chargeStartTime String: Billing start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
chargeStatus String: Payment status: Normal: Normal. Overdue: Overdue. Shutdown: Shutdown
chargeType String: Billing type. PostPaid: Pay-as-you-go. PrePaid: yearly/monthly subscription
overdueReclaimTime String: Estimated release time when shut down due to overdue payment. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time)
overdueTime String: Shutdown time for overdue payments. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
period Number: Purchase duration for prepaid scenarios.
periodUnit String: Purchase period for prepaid scenarios. Month: monthly subscription. Year: annual subscription.

GetInstanceEndpoint

Addresses List<Byteplus.GetInstanceEndpointAddress>: Connection address information.
AutoAddNewNodes bool: Whether to allow automatic addition of new nodes. Values: true: yes. false: no.
ConsistLevel string: Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.
ConsistTimeout int: When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us
ConsistTimeoutAction string: Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.
Description string: Address description
DistributedTransaction bool: Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.
EndpointId string: Instance connection endpoint ID.
EndpointName string: Instance connection endpoint name.
EndpointType string: Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.
MasterAcceptReadRequests bool: Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No
NodeIds List<string>: Node list configured for the connection endpoint.
ReadWriteMode string: Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only

Addresses []GetInstanceEndpointAddress: Connection address information.
AutoAddNewNodes bool: Whether to allow automatic addition of new nodes. Values: true: yes. false: no.
ConsistLevel string: Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.
ConsistTimeout int: When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us
ConsistTimeoutAction string: Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.
Description string: Address description
DistributedTransaction bool: Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.
EndpointId string: Instance connection endpoint ID.
EndpointName string: Instance connection endpoint name.
EndpointType string: Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.
MasterAcceptReadRequests bool: Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No
NodeIds []string: Node list configured for the connection endpoint.
ReadWriteMode string: Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only

addresses List<GetInstanceEndpointAddress>: Connection address information.
autoAddNewNodes Boolean: Whether to allow automatic addition of new nodes. Values: true: yes. false: no.
consistLevel String: Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.
consistTimeout Integer: When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us
consistTimeoutAction String: Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.
description String: Address description
distributedTransaction Boolean: Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.
endpointId String: Instance connection endpoint ID.
endpointName String: Instance connection endpoint name.
endpointType String: Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.
masterAcceptReadRequests Boolean: Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No
nodeIds List<String>: Node list configured for the connection endpoint.
readWriteMode String: Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only

addresses GetInstanceEndpointAddress[]: Connection address information.
autoAddNewNodes boolean: Whether to allow automatic addition of new nodes. Values: true: yes. false: no.
consistLevel string: Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.
consistTimeout number: When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us
consistTimeoutAction string: Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.
description string: Address description
distributedTransaction boolean: Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.
endpointId string: Instance connection endpoint ID.
endpointName string: Instance connection endpoint name.
endpointType string: Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.
masterAcceptReadRequests boolean: Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No
nodeIds string[]: Node list configured for the connection endpoint.
readWriteMode string: Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only

addresses Sequence[GetInstanceEndpointAddress]: Connection address information.
auto_add_new_nodes bool: Whether to allow automatic addition of new nodes. Values: true: yes. false: no.
consist_level str: Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.
consist_timeout int: When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us
consist_timeout_action str: Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.
description str: Address description
distributed_transaction bool: Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.
endpoint_id str: Instance connection endpoint ID.
endpoint_name str: Instance connection endpoint name.
endpoint_type str: Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.
master_accept_read_requests bool: Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No
node_ids Sequence[str]: Node list configured for the connection endpoint.
read_write_mode str: Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only

addresses List<Property Map>: Connection address information.
autoAddNewNodes Boolean: Whether to allow automatic addition of new nodes. Values: true: yes. false: no.
consistLevel String: Consistency level, applicable only to read-write mode connection endpoints. Values: Eventual: eventual consistency. Session: session consistency. Global: global consistency.
consistTimeout Number: When latency is high, the timeout for read-only nodes to synchronize the latest data, in microseconds (us). Range: 1us~100000000us
consistTimeoutAction String: Timeout policy for read-only node data synchronization. Supports the following two policies: ReturnError: Returns SQL error (wait replication complete timeout, please retry). ReadMaster: Sends request to the primary node.
description String: Address description
distributedTransaction Boolean: Whether to enable transaction splitting. Only effective for read-write mode endpoints. Values: true: yes. false: no.
endpointId String: Instance connection endpoint ID.
endpointName String: Instance connection endpoint name.
endpointType String: Connection endpoint type. Values: Cluster: default endpoint. Primary: primary node endpoint. Custom: custom endpoint.
masterAcceptReadRequests Boolean: Whether the primary node accepts read requests. Applies only to read/write mode endpoints. true: Yes. false: No
nodeIds List<String>: Node list configured for the connection endpoint.
readWriteMode String: Endpoint read/write mode. Options: ReadWrite: Read/write. ReadOnly: Read-only

GetInstanceEndpointAddress

DnsVisibility bool: Parsing method. The current return value can only be false.
Domain string: Instance private access domain name.
EipId string: Public network ID.
IpAddress string: IP address.
NetworkType string: Network type: Private: private network VPC. Public: public access.
Port string: Instance private network access port.
SubnetId string: Subnet ID. The subnet must belong to the selected availability zone.

DnsVisibility bool: Parsing method. The current return value can only be false.
Domain string: Instance private access domain name.
EipId string: Public network ID.
IpAddress string: IP address.
NetworkType string: Network type: Private: private network VPC. Public: public access.
Port string: Instance private network access port.
SubnetId string: Subnet ID. The subnet must belong to the selected availability zone.

dnsVisibility Boolean: Parsing method. The current return value can only be false.
domain String: Instance private access domain name.
eipId String: Public network ID.
ipAddress String: IP address.
networkType String: Network type: Private: private network VPC. Public: public access.
port String: Instance private network access port.
subnetId String: Subnet ID. The subnet must belong to the selected availability zone.

dnsVisibility boolean: Parsing method. The current return value can only be false.
domain string: Instance private access domain name.
eipId string: Public network ID.
ipAddress string: IP address.
networkType string: Network type: Private: private network VPC. Public: public access.
port string: Instance private network access port.
subnetId string: Subnet ID. The subnet must belong to the selected availability zone.

dns_visibility bool: Parsing method. The current return value can only be false.
domain str: Instance private access domain name.
eip_id str: Public network ID.
ip_address str: IP address.
network_type str: Network type: Private: private network VPC. Public: public access.
port str: Instance private network access port.
subnet_id str: Subnet ID. The subnet must belong to the selected availability zone.

dnsVisibility Boolean: Parsing method. The current return value can only be false.
domain String: Instance private access domain name.
eipId String: Public network ID.
ipAddress String: IP address.
networkType String: Network type: Private: private network VPC. Public: public access.
port String: Instance private network access port.
subnetId String: Subnet ID. The subnet must belong to the selected availability zone.

GetInstanceMaintenanceWindow

DayKind string: Maintenance cycle granularity. Default value: Week.
DayOfMonths List<int>: Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.
DayOfWeeks List<string>: Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
MaintenanceTime string: Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).

DayKind string: Maintenance cycle granularity. Default value: Week.
DayOfMonths []int: Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.
DayOfWeeks []string: Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
MaintenanceTime string: Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).

dayKind String: Maintenance cycle granularity. Default value: Week.
dayOfMonths List<Integer>: Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.
dayOfWeeks List<String>: Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
maintenanceTime String: Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).

dayKind string: Maintenance cycle granularity. Default value: Week.
dayOfMonths number[]: Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.
dayOfWeeks string[]: Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
maintenanceTime string: Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).

day_kind str: Maintenance cycle granularity. Default value: Week.
day_of_months Sequence[int]: Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.
day_of_weeks Sequence[str]: Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
maintenance_time str: Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).

dayKind String: Maintenance cycle granularity. Default value: Week.
dayOfMonths List<Number>: Specify which day of the month is the maintenance window. Default is empty, meaning every day is specified.
dayOfWeeks List<String>: Which day of the week is the maintenance window. Default value is every day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
maintenanceTime String: Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC time).

GetInstanceNode

FailoverPriority int: Node failover priority. Range: 0~15. Higher values indicate higher priority
Memory int: Memory size, in GiB.
NodeId string: Node ID
NodeSpec string: Node specification.
NodeType string: Node type. Values: Primary: primary node. ReadOnly: read-only node.
VCpu int: CPU size. For example, a value of 1 indicates a CPU size of 1U.
ZoneId string: Availability zone ID

FailoverPriority int: Node failover priority. Range: 0~15. Higher values indicate higher priority
Memory int: Memory size, in GiB.
NodeId string: Node ID
NodeSpec string: Node specification.
NodeType string: Node type. Values: Primary: primary node. ReadOnly: read-only node.
VCpu int: CPU size. For example, a value of 1 indicates a CPU size of 1U.
ZoneId string: Availability zone ID

failoverPriority Integer: Node failover priority. Range: 0~15. Higher values indicate higher priority
memory Integer: Memory size, in GiB.
nodeId String: Node ID
nodeSpec String: Node specification.
nodeType String: Node type. Values: Primary: primary node. ReadOnly: read-only node.
vCpu Integer: CPU size. For example, a value of 1 indicates a CPU size of 1U.
zoneId String: Availability zone ID

failoverPriority number: Node failover priority. Range: 0~15. Higher values indicate higher priority
memory number: Memory size, in GiB.
nodeId string: Node ID
nodeSpec string: Node specification.
nodeType string: Node type. Values: Primary: primary node. ReadOnly: read-only node.
vCpu number: CPU size. For example, a value of 1 indicates a CPU size of 1U.
zoneId string: Availability zone ID

failover_priority int: Node failover priority. Range: 0~15. Higher values indicate higher priority
memory int: Memory size, in GiB.
node_id str: Node ID
node_spec str: Node specification.
node_type str: Node type. Values: Primary: primary node. ReadOnly: read-only node.
v_cpu int: CPU size. For example, a value of 1 indicates a CPU size of 1U.
zone_id str: Availability zone ID

failoverPriority Number: Node failover priority. Range: 0~15. Higher values indicate higher priority
memory Number: Memory size, in GiB.
nodeId String: Node ID
nodeSpec String: Node specification.
nodeType String: Node type. Values: Primary: primary node. ReadOnly: read-only node.
vCpu Number: CPU size. For example, a value of 1 indicates a CPU size of 1U.
zoneId String: Availability zone ID

GetInstanceTag

Key string: User tag key. Length range: 1~128 characters. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system will automatically remove it
Value string: User tag value. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). Case-sensitive. If the tag value starts or ends with a space, the system will automatically remove it

Key string: User tag key. Length range: 1~128 characters. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system will automatically remove it
Value string: User tag value. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). Case-sensitive. If the tag value starts or ends with a space, the system will automatically remove it

key String: User tag key. Length range: 1~128 characters. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system will automatically remove it
value String: User tag value. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). Case-sensitive. If the tag value starts or ends with a space, the system will automatically remove it

key string: User tag key. Length range: 1~128 characters. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system will automatically remove it
value string: User tag value. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). Case-sensitive. If the tag value starts or ends with a space, the system will automatically remove it

key str: User tag key. Length range: 1~128 characters. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system will automatically remove it
value str: User tag value. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). Case-sensitive. If the tag value starts or ends with a space, the system will automatically remove it

key String: User tag key. Length range: 1~128 characters. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). If the tag key starts or ends with a space, the system will automatically remove it
value String: User tag value. Allows input of characters from all languages, numbers, spaces ( ), underscores (_), periods (.), colons (:), slashes (/), equals (=), plus (+), hyphens (-), and @ (@). Case-sensitive. If the tag value starts or ends with a space, the system will automatically remove it