published on Thursday, May 14, 2026 by Volcengine
published on Thursday, May 14, 2026 by Volcengine
Volcano Engine Cloud Database MySQL Edition is an elastic and reliable online relational database service built on the open-source MySQL database. MySQL instances are deployed using cloud-native methods and local SSD storage, delivering high-performance read and write capabilities. The service is fully compatible with the MySQL engine and offers a complete suite of solutions, including instance management, backup and recovery, log management, monitoring and alerts, and data migration. This helps enterprises simplify complex database management and operations, allowing them to focus more time and resources on their core business.
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
rDSMySQLInstanceDemo:
type: volcenginecc:rdsmysql:Instance
name: RDSMySQLInstanceDemo
properties:
deletionProtection: Disabled
dbEngineVersion: MySQL_5_7
nodes:
- zone_id: cn-beijing-a
node_spec: rds.mysql.c.s.1c2g
node_type: Primary
- zone_id: cn-beijing-a
node_spec: rds.mysql.c.s.1c2g
node_type: Secondary
- zone_id: cn-beijing-a
node_spec: rds.mysql.c.s.1c2g
node_type: ReadOnly
storageType: CloudESSD_PL0
storageSpace: 100
instanceType: DoubleNode
vpcId: vpc-rrco37ovjq4gv0x58xxxxx
subnetId: subnet-rrwqhg3qzxfkv0x57xxxxx
instanceName: RDSMySQLInstanceDemo
superAccountName: test_account
superAccountPassword: '***********'
lowerCaseTableNames: '1'
dbTimeZone: UTC +08:00
chargeDetail:
charge_type: PostPaid
auto_renew: false
number: 1
allowListIds:
- acl-8cde5e16f44143788234ca4489xxxxx
- acl-31f6053bd6be4cff88c1b205d20xxxxx
port: 3306
maintenanceWindow:
day_kind: Week
day_of_week:
- Monday
maintenance_time: 18:00Z-21:59Z
autoStorageScalingConfig:
enable_storage_auto_scale: true
storage_threshold: 10
storage_upper_bound: 3000
projectName: default
tags:
- key: env
value: test
Example coming soon!
Create Instance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);@overload
def Instance(resource_name: str,
args: InstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Instance(resource_name: str,
opts: Optional[ResourceOptions] = None,
nodes: Optional[Sequence[InstanceNodeArgs]] = None,
vpc_id: Optional[str] = None,
subnet_id: Optional[str] = None,
charge_detail: Optional[InstanceChargeDetailArgs] = None,
storage_type: Optional[str] = None,
db_engine_version: Optional[str] = None,
storage_space: Optional[int] = None,
db_param_group_id: Optional[str] = None,
port: Optional[int] = None,
global_read_only: Optional[bool] = None,
instance_name: Optional[str] = None,
instance_type: Optional[str] = None,
lower_case_table_names: Optional[str] = None,
maintenance_window: Optional[InstanceMaintenanceWindowArgs] = None,
node_spec: Optional[str] = None,
db_time_zone: Optional[str] = None,
deletion_protection: Optional[str] = None,
project_name: Optional[str] = None,
allow_list_ids: Optional[Sequence[str]] = None,
cpu_num: Optional[int] = None,
auto_upgrade_minor_version: Optional[str] = None,
super_account_name: Optional[str] = None,
super_account_password: Optional[str] = None,
sync_mode: Optional[str] = None,
tags: Optional[Sequence[InstanceTagArgs]] = None,
auto_storage_scaling_config: Optional[InstanceAutoStorageScalingConfigArgs] = None)func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: volcenginecc:rdsmysql:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "volcenginecc_rdsmysql_instance" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleinstanceResourceResourceFromRdsmysqlinstance = new Volcenginecc.Rdsmysql.Instance("exampleinstanceResourceResourceFromRdsmysqlinstance", new()
{
Nodes = new[]
{
new Volcenginecc.Rdsmysql.Inputs.InstanceNodeArgs
{
NodeSpec = "string",
NodeType = "string",
ZoneId = "string",
},
},
VpcId = "string",
SubnetId = "string",
ChargeDetail = new Volcenginecc.Rdsmysql.Inputs.InstanceChargeDetailArgs
{
ChargeType = "string",
AutoRenew = false,
ChargeEndTime = "string",
ChargeStartTime = "string",
ChargeStatus = "string",
Number = 0,
OverdueReclaimTime = "string",
OverdueTime = "string",
Period = 0,
PeriodUnit = "string",
TempModifyEndTime = "string",
TempModifyStartTime = "string",
},
StorageType = "string",
DbEngineVersion = "string",
StorageSpace = 0,
DbParamGroupId = "string",
Port = 0,
GlobalReadOnly = false,
InstanceName = "string",
InstanceType = "string",
LowerCaseTableNames = "string",
MaintenanceWindow = new Volcenginecc.Rdsmysql.Inputs.InstanceMaintenanceWindowArgs
{
DayKind = "string",
DayOfWeeks = new[]
{
"string",
},
MaintenanceTime = "string",
},
NodeSpec = "string",
DbTimeZone = "string",
DeletionProtection = "string",
ProjectName = "string",
AllowListIds = new[]
{
"string",
},
CpuNum = 0,
AutoUpgradeMinorVersion = "string",
SuperAccountName = "string",
SuperAccountPassword = "string",
SyncMode = "string",
Tags = new[]
{
new Volcenginecc.Rdsmysql.Inputs.InstanceTagArgs
{
Key = "string",
Value = "string",
},
},
AutoStorageScalingConfig = new Volcenginecc.Rdsmysql.Inputs.InstanceAutoStorageScalingConfigArgs
{
EnableStorageAutoScale = false,
StorageThreshold = 0,
StorageUpperBound = 0,
},
});
example, err := rdsmysql.NewInstance(ctx, "exampleinstanceResourceResourceFromRdsmysqlinstance", &rdsmysql.InstanceArgs{
Nodes: rdsmysql.InstanceNodeArray{
&rdsmysql.InstanceNodeArgs{
NodeSpec: pulumi.String("string"),
NodeType: pulumi.String("string"),
ZoneId: pulumi.String("string"),
},
},
VpcId: pulumi.String("string"),
SubnetId: pulumi.String("string"),
ChargeDetail: &rdsmysql.InstanceChargeDetailArgs{
ChargeType: pulumi.String("string"),
AutoRenew: pulumi.Bool(false),
ChargeEndTime: pulumi.String("string"),
ChargeStartTime: pulumi.String("string"),
ChargeStatus: pulumi.String("string"),
Number: pulumi.Int(0),
OverdueReclaimTime: pulumi.String("string"),
OverdueTime: pulumi.String("string"),
Period: pulumi.Int(0),
PeriodUnit: pulumi.String("string"),
TempModifyEndTime: pulumi.String("string"),
TempModifyStartTime: pulumi.String("string"),
},
StorageType: pulumi.String("string"),
DbEngineVersion: pulumi.String("string"),
StorageSpace: pulumi.Int(0),
DbParamGroupId: pulumi.String("string"),
Port: pulumi.Int(0),
GlobalReadOnly: pulumi.Bool(false),
InstanceName: pulumi.String("string"),
InstanceType: pulumi.String("string"),
LowerCaseTableNames: pulumi.String("string"),
MaintenanceWindow: &rdsmysql.InstanceMaintenanceWindowArgs{
DayKind: pulumi.String("string"),
DayOfWeeks: pulumi.StringArray{
pulumi.String("string"),
},
MaintenanceTime: pulumi.String("string"),
},
NodeSpec: pulumi.String("string"),
DbTimeZone: pulumi.String("string"),
DeletionProtection: pulumi.String("string"),
ProjectName: pulumi.String("string"),
AllowListIds: pulumi.StringArray{
pulumi.String("string"),
},
CpuNum: pulumi.Int(0),
AutoUpgradeMinorVersion: pulumi.String("string"),
SuperAccountName: pulumi.String("string"),
SuperAccountPassword: pulumi.String("string"),
SyncMode: pulumi.String("string"),
Tags: rdsmysql.InstanceTagArray{
&rdsmysql.InstanceTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
AutoStorageScalingConfig: &rdsmysql.InstanceAutoStorageScalingConfigArgs{
EnableStorageAutoScale: pulumi.Bool(false),
StorageThreshold: pulumi.Int(0),
StorageUpperBound: pulumi.Int(0),
},
})
resource "volcenginecc_rdsmysql_instance" "exampleinstanceResourceResourceFromRdsmysqlinstance" {
nodes {
node_spec = "string"
node_type = "string"
zone_id = "string"
}
vpc_id = "string"
subnet_id = "string"
charge_detail = {
charge_type = "string"
auto_renew = false
charge_end_time = "string"
charge_start_time = "string"
charge_status = "string"
number = 0
overdue_reclaim_time = "string"
overdue_time = "string"
period = 0
period_unit = "string"
temp_modify_end_time = "string"
temp_modify_start_time = "string"
}
storage_type = "string"
db_engine_version = "string"
storage_space = 0
db_param_group_id = "string"
port = 0
global_read_only = false
instance_name = "string"
instance_type = "string"
lower_case_table_names = "string"
maintenance_window = {
day_kind = "string"
day_of_weeks = ["string"]
maintenance_time = "string"
}
node_spec = "string"
db_time_zone = "string"
deletion_protection = "string"
project_name = "string"
allow_list_ids = ["string"]
cpu_num = 0
auto_upgrade_minor_version = "string"
super_account_name = "string"
super_account_password = "string"
sync_mode = "string"
tags {
key = "string"
value = "string"
}
auto_storage_scaling_config = {
enable_storage_auto_scale = false
storage_threshold = 0
storage_upper_bound = 0
}
}
var exampleinstanceResourceResourceFromRdsmysqlinstance = new com.volcengine.volcenginecc.rdsmysql.Instance("exampleinstanceResourceResourceFromRdsmysqlinstance", com.volcengine.volcenginecc.rdsmysql.InstanceArgs.builder()
.nodes(InstanceNodeArgs.builder()
.nodeSpec("string")
.nodeType("string")
.zoneId("string")
.build())
.vpcId("string")
.subnetId("string")
.chargeDetail(InstanceChargeDetailArgs.builder()
.chargeType("string")
.autoRenew(false)
.chargeEndTime("string")
.chargeStartTime("string")
.chargeStatus("string")
.number(0)
.overdueReclaimTime("string")
.overdueTime("string")
.period(0)
.periodUnit("string")
.tempModifyEndTime("string")
.tempModifyStartTime("string")
.build())
.storageType("string")
.dbEngineVersion("string")
.storageSpace(0)
.dbParamGroupId("string")
.port(0)
.globalReadOnly(false)
.instanceName("string")
.instanceType("string")
.lowerCaseTableNames("string")
.maintenanceWindow(InstanceMaintenanceWindowArgs.builder()
.dayKind("string")
.dayOfWeeks("string")
.maintenanceTime("string")
.build())
.nodeSpec("string")
.dbTimeZone("string")
.deletionProtection("string")
.projectName("string")
.allowListIds("string")
.cpuNum(0)
.autoUpgradeMinorVersion("string")
.superAccountName("string")
.superAccountPassword("string")
.syncMode("string")
.tags(InstanceTagArgs.builder()
.key("string")
.value("string")
.build())
.autoStorageScalingConfig(InstanceAutoStorageScalingConfigArgs.builder()
.enableStorageAutoScale(false)
.storageThreshold(0)
.storageUpperBound(0)
.build())
.build());
exampleinstance_resource_resource_from_rdsmysqlinstance = volcenginecc.rdsmysql.Instance("exampleinstanceResourceResourceFromRdsmysqlinstance",
nodes=[{
"node_spec": "string",
"node_type": "string",
"zone_id": "string",
}],
vpc_id="string",
subnet_id="string",
charge_detail={
"charge_type": "string",
"auto_renew": False,
"charge_end_time": "string",
"charge_start_time": "string",
"charge_status": "string",
"number": 0,
"overdue_reclaim_time": "string",
"overdue_time": "string",
"period": 0,
"period_unit": "string",
"temp_modify_end_time": "string",
"temp_modify_start_time": "string",
},
storage_type="string",
db_engine_version="string",
storage_space=0,
db_param_group_id="string",
port=0,
global_read_only=False,
instance_name="string",
instance_type="string",
lower_case_table_names="string",
maintenance_window={
"day_kind": "string",
"day_of_weeks": ["string"],
"maintenance_time": "string",
},
node_spec="string",
db_time_zone="string",
deletion_protection="string",
project_name="string",
allow_list_ids=["string"],
cpu_num=0,
auto_upgrade_minor_version="string",
super_account_name="string",
super_account_password="string",
sync_mode="string",
tags=[{
"key": "string",
"value": "string",
}],
auto_storage_scaling_config={
"enable_storage_auto_scale": False,
"storage_threshold": 0,
"storage_upper_bound": 0,
})
const exampleinstanceResourceResourceFromRdsmysqlinstance = new volcenginecc.rdsmysql.Instance("exampleinstanceResourceResourceFromRdsmysqlinstance", {
nodes: [{
nodeSpec: "string",
nodeType: "string",
zoneId: "string",
}],
vpcId: "string",
subnetId: "string",
chargeDetail: {
chargeType: "string",
autoRenew: false,
chargeEndTime: "string",
chargeStartTime: "string",
chargeStatus: "string",
number: 0,
overdueReclaimTime: "string",
overdueTime: "string",
period: 0,
periodUnit: "string",
tempModifyEndTime: "string",
tempModifyStartTime: "string",
},
storageType: "string",
dbEngineVersion: "string",
storageSpace: 0,
dbParamGroupId: "string",
port: 0,
globalReadOnly: false,
instanceName: "string",
instanceType: "string",
lowerCaseTableNames: "string",
maintenanceWindow: {
dayKind: "string",
dayOfWeeks: ["string"],
maintenanceTime: "string",
},
nodeSpec: "string",
dbTimeZone: "string",
deletionProtection: "string",
projectName: "string",
allowListIds: ["string"],
cpuNum: 0,
autoUpgradeMinorVersion: "string",
superAccountName: "string",
superAccountPassword: "string",
syncMode: "string",
tags: [{
key: "string",
value: "string",
}],
autoStorageScalingConfig: {
enableStorageAutoScale: false,
storageThreshold: 0,
storageUpperBound: 0,
},
});
type: volcenginecc:rdsmysql:Instance
properties:
allowListIds:
- string
autoStorageScalingConfig:
enableStorageAutoScale: false
storageThreshold: 0
storageUpperBound: 0
autoUpgradeMinorVersion: string
chargeDetail:
autoRenew: false
chargeEndTime: string
chargeStartTime: string
chargeStatus: string
chargeType: string
number: 0
overdueReclaimTime: string
overdueTime: string
period: 0
periodUnit: string
tempModifyEndTime: string
tempModifyStartTime: string
cpuNum: 0
dbEngineVersion: string
dbParamGroupId: string
dbTimeZone: string
deletionProtection: string
globalReadOnly: false
instanceName: string
instanceType: string
lowerCaseTableNames: string
maintenanceWindow:
dayKind: string
dayOfWeeks:
- string
maintenanceTime: string
nodeSpec: string
nodes:
- nodeSpec: string
nodeType: string
zoneId: string
port: 0
projectName: string
storageSpace: 0
storageType: string
subnetId: string
superAccountName: string
superAccountPassword: string
syncMode: string
tags:
- key: string
value: string
vpcId: string
Instance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Instance resource accepts the following input properties:
- Charge
Detail Volcengine.Instance Charge Detail - Billing method
- Db
Engine stringVersion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- Nodes
List<Volcengine.
Instance Node> - Storage
Space int - Total storage space of the instance, in GB
- Storage
Type string - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- Subnet
Id string - Subnet ID.
- Vpc
Id string - VPC (Virtual Private Cloud) ID.
- Allow
List List<string>Ids - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- Auto
Storage Volcengine.Scaling Config Instance Auto Storage Scaling Config - Auto scaling configuration
- Auto
Upgrade stringMinor Version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- Cpu
Num int - Number of CPU cores for the database proxy service of the instance
- Db
Param stringGroup Id - Parameter template ID. Default value is the default parameter template for the database engine version
- Db
Time stringZone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- Deletion
Protection string - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- Global
Read boolOnly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- Instance
Name string - Instance name.
- Instance
Type string - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- Lower
Case stringTable Names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- Maintenance
Window Volcengine.Instance Maintenance Window - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- Node
Spec string - Node specifications.
- Port int
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- Project
Name string - Project.
- Super
Account stringName - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- Super
Account stringPassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- Sync
Mode string - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
-
List<Volcengine.
Instance Tag>
- Charge
Detail InstanceCharge Detail Args - Billing method
- Db
Engine stringVersion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- Nodes
[]Instance
Node Args - Storage
Space int - Total storage space of the instance, in GB
- Storage
Type string - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- Subnet
Id string - Subnet ID.
- Vpc
Id string - VPC (Virtual Private Cloud) ID.
- Allow
List []stringIds - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- Auto
Storage InstanceScaling Config Auto Storage Scaling Config Args - Auto scaling configuration
- Auto
Upgrade stringMinor Version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- Cpu
Num int - Number of CPU cores for the database proxy service of the instance
- Db
Param stringGroup Id - Parameter template ID. Default value is the default parameter template for the database engine version
- Db
Time stringZone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- Deletion
Protection string - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- Global
Read boolOnly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- Instance
Name string - Instance name.
- Instance
Type string - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- Lower
Case stringTable Names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- Maintenance
Window InstanceMaintenance Window Args - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- Node
Spec string - Node specifications.
- Port int
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- Project
Name string - Project.
- Super
Account stringName - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- Super
Account stringPassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- Sync
Mode string - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
-
[]Instance
Tag Args
- charge_
detail object - Billing method
- db_
engine_ stringversion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- nodes list(object)
- storage_
space number - Total storage space of the instance, in GB
- storage_
type string - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- subnet_
id string - Subnet ID.
- vpc_
id string - VPC (Virtual Private Cloud) ID.
- allow_
list_ list(string)ids - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- auto_
storage_ objectscaling_ config - Auto scaling configuration
- auto_
upgrade_ stringminor_ version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- cpu_
num number - Number of CPU cores for the database proxy service of the instance
- db_
param_ stringgroup_ id - Parameter template ID. Default value is the default parameter template for the database engine version
- db_
time_ stringzone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- deletion_
protection string - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- global_
read_ boolonly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- instance_
name string - Instance name.
- instance_
type string - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- lower_
case_ stringtable_ names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- maintenance_
window object - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- node_
spec string - Node specifications.
- port number
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- project_
name string - Project.
- super_
account_ stringname - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- super_
account_ stringpassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- sync_
mode string - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
- list(object)
- charge
Detail InstanceCharge Detail - Billing method
- db
Engine StringVersion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- nodes
List<Instance
Node> - storage
Space Integer - Total storage space of the instance, in GB
- storage
Type String - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- subnet
Id String - Subnet ID.
- vpc
Id String - VPC (Virtual Private Cloud) ID.
- allow
List List<String>Ids - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- auto
Storage InstanceScaling Config Auto Storage Scaling Config - Auto scaling configuration
- auto
Upgrade StringMinor Version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- cpu
Num Integer - Number of CPU cores for the database proxy service of the instance
- db
Param StringGroup Id - Parameter template ID. Default value is the default parameter template for the database engine version
- db
Time StringZone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- deletion
Protection String - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- global
Read BooleanOnly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- instance
Name String - Instance name.
- instance
Type String - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- lower
Case StringTable Names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- maintenance
Window InstanceMaintenance Window - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- node
Spec String - Node specifications.
- port Integer
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- project
Name String - Project.
- super
Account StringName - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- super
Account StringPassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- sync
Mode String - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
-
List<Instance
Tag>
- charge
Detail InstanceCharge Detail - Billing method
- db
Engine stringVersion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- nodes
Instance
Node[] - storage
Space number - Total storage space of the instance, in GB
- storage
Type string - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- subnet
Id string - Subnet ID.
- vpc
Id string - VPC (Virtual Private Cloud) ID.
- allow
List string[]Ids - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- auto
Storage InstanceScaling Config Auto Storage Scaling Config - Auto scaling configuration
- auto
Upgrade stringMinor Version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- cpu
Num number - Number of CPU cores for the database proxy service of the instance
- db
Param stringGroup Id - Parameter template ID. Default value is the default parameter template for the database engine version
- db
Time stringZone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- deletion
Protection string - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- global
Read booleanOnly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- instance
Name string - Instance name.
- instance
Type string - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- lower
Case stringTable Names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- maintenance
Window InstanceMaintenance Window - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- node
Spec string - Node specifications.
- port number
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- project
Name string - Project.
- super
Account stringName - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- super
Account stringPassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- sync
Mode string - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
-
Instance
Tag[]
- charge_
detail InstanceCharge Detail Args - Billing method
- db_
engine_ strversion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- nodes
Sequence[Instance
Node Args] - storage_
space int - Total storage space of the instance, in GB
- storage_
type str - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- subnet_
id str - Subnet ID.
- vpc_
id str - VPC (Virtual Private Cloud) ID.
- allow_
list_ Sequence[str]ids - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- auto_
storage_ Instancescaling_ config Auto Storage Scaling Config Args - Auto scaling configuration
- auto_
upgrade_ strminor_ version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- cpu_
num int - Number of CPU cores for the database proxy service of the instance
- db_
param_ strgroup_ id - Parameter template ID. Default value is the default parameter template for the database engine version
- db_
time_ strzone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- deletion_
protection str - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- global_
read_ boolonly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- instance_
name str - Instance name.
- instance_
type str - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- lower_
case_ strtable_ names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- maintenance_
window InstanceMaintenance Window Args - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- node_
spec str - Node specifications.
- port int
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- project_
name str - Project.
- super_
account_ strname - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- super_
account_ strpassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- sync_
mode str - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
-
Sequence[Instance
Tag Args]
- charge
Detail Property Map - Billing method
- db
Engine StringVersion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- nodes List<Property Map>
- storage
Space Number - Total storage space of the instance, in GB
- storage
Type String - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- subnet
Id String - Subnet ID.
- vpc
Id String - VPC (Virtual Private Cloud) ID.
- allow
List List<String>Ids - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- auto
Storage Property MapScaling Config - Auto scaling configuration
- auto
Upgrade StringMinor Version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- cpu
Num Number - Number of CPU cores for the database proxy service of the instance
- db
Param StringGroup Id - Parameter template ID. Default value is the default parameter template for the database engine version
- db
Time StringZone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- deletion
Protection String - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- global
Read BooleanOnly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- instance
Name String - Instance name.
- instance
Type String - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- lower
Case StringTable Names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- maintenance
Window Property Map - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- node
Spec String - Node specifications.
- port Number
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- project
Name String - Project.
- super
Account StringName - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- super
Account StringPassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- sync
Mode String - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- Address
Objects List<Volcengine.Instance Address Object> - Allow
List stringVersion - Allowlist version
- Backup
Audit intLog Size - Space used by audit logs in backup.
- Backup
Bin intLog Size - Space used by binlog logs in backup.
- Backup
Data intSize - Space used by data in backup.
- Backup
Error intLog Size - Space used by error logs in backups.
- Backup
Free intQuota Size - Free backup storage space, in GB
- Backup
Log intSize - Space used by logs in backups.
- Backup
Slow intLog Size - Space used by slow logs in backups.
- Backup
Use double - Backup space used by the instance, in GB
- Basic
Backup intBinlog Size - Space used by Binlog logs in basic backups.
- Basic
Backup intData Size - Space used by data in the base backup
- Created
Time string - Instance creation local time.
- Current
Kernel stringVersion - Instance kernel minor version.
- Disaster
Recovery List<Volcengine.Instances Instance Disaster Recovery Instance> - Dr
Dts stringTask Id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- Dr
Dts stringTask Name - Name of synchronization tasks between primary and disaster recovery instances.
- Dr
Dts stringTask Status - Status of synchronization tasks between primary and disaster recovery instances.
- Dr
Seconds intBehind Master - Latency between the disaster recovery instance and the primary instance.
- Endpoints
List<Volcengine.
Instance Endpoint> - Has
Disaster boolRecovery Instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- Has
Green boolInstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Id string - Instance ID.
- Instance
Status string - Instance status.
- Master
Instance stringId - Primary instance ID
- Master
Instance stringName - Primary instance name.
- Memory int
- Memory size. Unit: GB.
- Node
Cpu doubleUsed Percentage - Average CPU usage of the primary node in the instance over the past minute.
- Node
Memory doubleUsed Percentage - Average memory usage of the primary node over the past minute
- Node
Number string - Number of nodes.
- Node
Space doubleUsed Percentage - Average disk usage of the primary node over the past minute
- Proxy
Detail Volcengine.Instance Proxy Detail - proxy information
- Storage
Audit intLog Size - Space used by audit logs in instance storage
- Storage
Bin intLog Size - Binlog space usage in the instance storage
- Storage
Data intSize - Space used by data in instance storage.
- Storage
Error intLog Size - Space used by error logs in instance storage.
- Storage
Log intSize - Space used by logs in the instance storage
- Storage
Slow intLog Size - Space used by slow logs in instance storage
- Storage
Use double - Storage space used by the instance, in GB
- Time
Zone string - Time zone
- Updated
Time string - Instance updates local time.
- Vcpu int
- CPU size. For example: 1 means 1U.
- Zone
Id string - Availability zone of the instance's primary node.
- Zone
Ids List<string> - List of availability zones for each node in the instance.
- Address
Objects []InstanceAddress Object - Allow
List stringVersion - Allowlist version
- Backup
Audit intLog Size - Space used by audit logs in backup.
- Backup
Bin intLog Size - Space used by binlog logs in backup.
- Backup
Data intSize - Space used by data in backup.
- Backup
Error intLog Size - Space used by error logs in backups.
- Backup
Free intQuota Size - Free backup storage space, in GB
- Backup
Log intSize - Space used by logs in backups.
- Backup
Slow intLog Size - Space used by slow logs in backups.
- Backup
Use float64 - Backup space used by the instance, in GB
- Basic
Backup intBinlog Size - Space used by Binlog logs in basic backups.
- Basic
Backup intData Size - Space used by data in the base backup
- Created
Time string - Instance creation local time.
- Current
Kernel stringVersion - Instance kernel minor version.
- Disaster
Recovery []InstanceInstances Disaster Recovery Instance - Dr
Dts stringTask Id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- Dr
Dts stringTask Name - Name of synchronization tasks between primary and disaster recovery instances.
- Dr
Dts stringTask Status - Status of synchronization tasks between primary and disaster recovery instances.
- Dr
Seconds intBehind Master - Latency between the disaster recovery instance and the primary instance.
- Endpoints
[]Instance
Endpoint - Has
Disaster boolRecovery Instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- Has
Green boolInstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Id string - Instance ID.
- Instance
Status string - Instance status.
- Master
Instance stringId - Primary instance ID
- Master
Instance stringName - Primary instance name.
- Memory int
- Memory size. Unit: GB.
- Node
Cpu float64Used Percentage - Average CPU usage of the primary node in the instance over the past minute.
- Node
Memory float64Used Percentage - Average memory usage of the primary node over the past minute
- Node
Number string - Number of nodes.
- Node
Space float64Used Percentage - Average disk usage of the primary node over the past minute
- Proxy
Detail InstanceProxy Detail - proxy information
- Storage
Audit intLog Size - Space used by audit logs in instance storage
- Storage
Bin intLog Size - Binlog space usage in the instance storage
- Storage
Data intSize - Space used by data in instance storage.
- Storage
Error intLog Size - Space used by error logs in instance storage.
- Storage
Log intSize - Space used by logs in the instance storage
- Storage
Slow intLog Size - Space used by slow logs in instance storage
- Storage
Use float64 - Storage space used by the instance, in GB
- Time
Zone string - Time zone
- Updated
Time string - Instance updates local time.
- Vcpu int
- CPU size. For example: 1 means 1U.
- Zone
Id string - Availability zone of the instance's primary node.
- Zone
Ids []string - List of availability zones for each node in the instance.
- address_
objects list(object) - allow_
list_ stringversion - Allowlist version
- backup_
audit_ numberlog_ size - Space used by audit logs in backup.
- backup_
bin_ numberlog_ size - Space used by binlog logs in backup.
- backup_
data_ numbersize - Space used by data in backup.
- backup_
error_ numberlog_ size - Space used by error logs in backups.
- backup_
free_ numberquota_ size - Free backup storage space, in GB
- backup_
log_ numbersize - Space used by logs in backups.
- backup_
slow_ numberlog_ size - Space used by slow logs in backups.
- backup_
use number - Backup space used by the instance, in GB
- basic_
backup_ numberbinlog_ size - Space used by Binlog logs in basic backups.
- basic_
backup_ numberdata_ size - Space used by data in the base backup
- created_
time string - Instance creation local time.
- current_
kernel_ stringversion - Instance kernel minor version.
- disaster_
recovery_ list(object)instances - dr_
dts_ stringtask_ id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- dr_
dts_ stringtask_ name - Name of synchronization tasks between primary and disaster recovery instances.
- dr_
dts_ stringtask_ status - Status of synchronization tasks between primary and disaster recovery instances.
- dr_
seconds_ numberbehind_ master - Latency between the disaster recovery instance and the primary instance.
- endpoints list(object)
- has_
disaster_ boolrecovery_ instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- has_
green_ boolinstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- id string
- The provider-assigned unique ID for this managed resource.
- instance_
id string - Instance ID.
- instance_
status string - Instance status.
- master_
instance_ stringid - Primary instance ID
- master_
instance_ stringname - Primary instance name.
- memory number
- Memory size. Unit: GB.
- node_
cpu_ numberused_ percentage - Average CPU usage of the primary node in the instance over the past minute.
- node_
memory_ numberused_ percentage - Average memory usage of the primary node over the past minute
- node_
number string - Number of nodes.
- node_
space_ numberused_ percentage - Average disk usage of the primary node over the past minute
- proxy_
detail object - proxy information
- storage_
audit_ numberlog_ size - Space used by audit logs in instance storage
- storage_
bin_ numberlog_ size - Binlog space usage in the instance storage
- storage_
data_ numbersize - Space used by data in instance storage.
- storage_
error_ numberlog_ size - Space used by error logs in instance storage.
- storage_
log_ numbersize - Space used by logs in the instance storage
- storage_
slow_ numberlog_ size - Space used by slow logs in instance storage
- storage_
use number - Storage space used by the instance, in GB
- time_
zone string - Time zone
- updated_
time string - Instance updates local time.
- vcpu number
- CPU size. For example: 1 means 1U.
- zone_
id string - Availability zone of the instance's primary node.
- zone_
ids list(string) - List of availability zones for each node in the instance.
- address
Objects List<InstanceAddress Object> - allow
List StringVersion - Allowlist version
- backup
Audit IntegerLog Size - Space used by audit logs in backup.
- backup
Bin IntegerLog Size - Space used by binlog logs in backup.
- backup
Data IntegerSize - Space used by data in backup.
- backup
Error IntegerLog Size - Space used by error logs in backups.
- backup
Free IntegerQuota Size - Free backup storage space, in GB
- backup
Log IntegerSize - Space used by logs in backups.
- backup
Slow IntegerLog Size - Space used by slow logs in backups.
- backup
Use Double - Backup space used by the instance, in GB
- basic
Backup IntegerBinlog Size - Space used by Binlog logs in basic backups.
- basic
Backup IntegerData Size - Space used by data in the base backup
- created
Time String - Instance creation local time.
- current
Kernel StringVersion - Instance kernel minor version.
- disaster
Recovery List<InstanceInstances Disaster Recovery Instance> - dr
Dts StringTask Id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- dr
Dts StringTask Name - Name of synchronization tasks between primary and disaster recovery instances.
- dr
Dts StringTask Status - Status of synchronization tasks between primary and disaster recovery instances.
- dr
Seconds IntegerBehind Master - Latency between the disaster recovery instance and the primary instance.
- endpoints
List<Instance
Endpoint> - has
Disaster BooleanRecovery Instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- has
Green BooleanInstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Id String - Instance ID.
- instance
Status String - Instance status.
- master
Instance StringId - Primary instance ID
- master
Instance StringName - Primary instance name.
- memory Integer
- Memory size. Unit: GB.
- node
Cpu DoubleUsed Percentage - Average CPU usage of the primary node in the instance over the past minute.
- node
Memory DoubleUsed Percentage - Average memory usage of the primary node over the past minute
- node
Number String - Number of nodes.
- node
Space DoubleUsed Percentage - Average disk usage of the primary node over the past minute
- proxy
Detail InstanceProxy Detail - proxy information
- storage
Audit IntegerLog Size - Space used by audit logs in instance storage
- storage
Bin IntegerLog Size - Binlog space usage in the instance storage
- storage
Data IntegerSize - Space used by data in instance storage.
- storage
Error IntegerLog Size - Space used by error logs in instance storage.
- storage
Log IntegerSize - Space used by logs in the instance storage
- storage
Slow IntegerLog Size - Space used by slow logs in instance storage
- storage
Use Double - Storage space used by the instance, in GB
- time
Zone String - Time zone
- updated
Time String - Instance updates local time.
- vcpu Integer
- CPU size. For example: 1 means 1U.
- zone
Id String - Availability zone of the instance's primary node.
- zone
Ids List<String> - List of availability zones for each node in the instance.
- address
Objects InstanceAddress Object[] - allow
List stringVersion - Allowlist version
- backup
Audit numberLog Size - Space used by audit logs in backup.
- backup
Bin numberLog Size - Space used by binlog logs in backup.
- backup
Data numberSize - Space used by data in backup.
- backup
Error numberLog Size - Space used by error logs in backups.
- backup
Free numberQuota Size - Free backup storage space, in GB
- backup
Log numberSize - Space used by logs in backups.
- backup
Slow numberLog Size - Space used by slow logs in backups.
- backup
Use number - Backup space used by the instance, in GB
- basic
Backup numberBinlog Size - Space used by Binlog logs in basic backups.
- basic
Backup numberData Size - Space used by data in the base backup
- created
Time string - Instance creation local time.
- current
Kernel stringVersion - Instance kernel minor version.
- disaster
Recovery InstanceInstances Disaster Recovery Instance[] - dr
Dts stringTask Id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- dr
Dts stringTask Name - Name of synchronization tasks between primary and disaster recovery instances.
- dr
Dts stringTask Status - Status of synchronization tasks between primary and disaster recovery instances.
- dr
Seconds numberBehind Master - Latency between the disaster recovery instance and the primary instance.
- endpoints
Instance
Endpoint[] - has
Disaster booleanRecovery Instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- has
Green booleanInstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- id string
- The provider-assigned unique ID for this managed resource.
- instance
Id string - Instance ID.
- instance
Status string - Instance status.
- master
Instance stringId - Primary instance ID
- master
Instance stringName - Primary instance name.
- memory number
- Memory size. Unit: GB.
- node
Cpu numberUsed Percentage - Average CPU usage of the primary node in the instance over the past minute.
- node
Memory numberUsed Percentage - Average memory usage of the primary node over the past minute
- node
Number string - Number of nodes.
- node
Space numberUsed Percentage - Average disk usage of the primary node over the past minute
- proxy
Detail InstanceProxy Detail - proxy information
- storage
Audit numberLog Size - Space used by audit logs in instance storage
- storage
Bin numberLog Size - Binlog space usage in the instance storage
- storage
Data numberSize - Space used by data in instance storage.
- storage
Error numberLog Size - Space used by error logs in instance storage.
- storage
Log numberSize - Space used by logs in the instance storage
- storage
Slow numberLog Size - Space used by slow logs in instance storage
- storage
Use number - Storage space used by the instance, in GB
- time
Zone string - Time zone
- updated
Time string - Instance updates local time.
- vcpu number
- CPU size. For example: 1 means 1U.
- zone
Id string - Availability zone of the instance's primary node.
- zone
Ids string[] - List of availability zones for each node in the instance.
- address_
objects Sequence[InstanceAddress Object] - allow_
list_ strversion - Allowlist version
- backup_
audit_ intlog_ size - Space used by audit logs in backup.
- backup_
bin_ intlog_ size - Space used by binlog logs in backup.
- backup_
data_ intsize - Space used by data in backup.
- backup_
error_ intlog_ size - Space used by error logs in backups.
- backup_
free_ intquota_ size - Free backup storage space, in GB
- backup_
log_ intsize - Space used by logs in backups.
- backup_
slow_ intlog_ size - Space used by slow logs in backups.
- backup_
use float - Backup space used by the instance, in GB
- basic_
backup_ intbinlog_ size - Space used by Binlog logs in basic backups.
- basic_
backup_ intdata_ size - Space used by data in the base backup
- created_
time str - Instance creation local time.
- current_
kernel_ strversion - Instance kernel minor version.
- disaster_
recovery_ Sequence[Instanceinstances Disaster Recovery Instance] - dr_
dts_ strtask_ id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- dr_
dts_ strtask_ name - Name of synchronization tasks between primary and disaster recovery instances.
- dr_
dts_ strtask_ status - Status of synchronization tasks between primary and disaster recovery instances.
- dr_
seconds_ intbehind_ master - Latency between the disaster recovery instance and the primary instance.
- endpoints
Sequence[Instance
Endpoint] - has_
disaster_ boolrecovery_ instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- has_
green_ boolinstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- id str
- The provider-assigned unique ID for this managed resource.
- instance_
id str - Instance ID.
- instance_
status str - Instance status.
- master_
instance_ strid - Primary instance ID
- master_
instance_ strname - Primary instance name.
- memory int
- Memory size. Unit: GB.
- node_
cpu_ floatused_ percentage - Average CPU usage of the primary node in the instance over the past minute.
- node_
memory_ floatused_ percentage - Average memory usage of the primary node over the past minute
- node_
number str - Number of nodes.
- node_
space_ floatused_ percentage - Average disk usage of the primary node over the past minute
- proxy_
detail InstanceProxy Detail - proxy information
- storage_
audit_ intlog_ size - Space used by audit logs in instance storage
- storage_
bin_ intlog_ size - Binlog space usage in the instance storage
- storage_
data_ intsize - Space used by data in instance storage.
- storage_
error_ intlog_ size - Space used by error logs in instance storage.
- storage_
log_ intsize - Space used by logs in the instance storage
- storage_
slow_ intlog_ size - Space used by slow logs in instance storage
- storage_
use float - Storage space used by the instance, in GB
- time_
zone str - Time zone
- updated_
time str - Instance updates local time.
- vcpu int
- CPU size. For example: 1 means 1U.
- zone_
id str - Availability zone of the instance's primary node.
- zone_
ids Sequence[str] - List of availability zones for each node in the instance.
- address
Objects List<Property Map> - allow
List StringVersion - Allowlist version
- backup
Audit NumberLog Size - Space used by audit logs in backup.
- backup
Bin NumberLog Size - Space used by binlog logs in backup.
- backup
Data NumberSize - Space used by data in backup.
- backup
Error NumberLog Size - Space used by error logs in backups.
- backup
Free NumberQuota Size - Free backup storage space, in GB
- backup
Log NumberSize - Space used by logs in backups.
- backup
Slow NumberLog Size - Space used by slow logs in backups.
- backup
Use Number - Backup space used by the instance, in GB
- basic
Backup NumberBinlog Size - Space used by Binlog logs in basic backups.
- basic
Backup NumberData Size - Space used by data in the base backup
- created
Time String - Instance creation local time.
- current
Kernel StringVersion - Instance kernel minor version.
- disaster
Recovery List<Property Map>Instances - dr
Dts StringTask Id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- dr
Dts StringTask Name - Name of synchronization tasks between primary and disaster recovery instances.
- dr
Dts StringTask Status - Status of synchronization tasks between primary and disaster recovery instances.
- dr
Seconds NumberBehind Master - Latency between the disaster recovery instance and the primary instance.
- endpoints List<Property Map>
- has
Disaster BooleanRecovery Instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- has
Green BooleanInstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Id String - Instance ID.
- instance
Status String - Instance status.
- master
Instance StringId - Primary instance ID
- master
Instance StringName - Primary instance name.
- memory Number
- Memory size. Unit: GB.
- node
Cpu NumberUsed Percentage - Average CPU usage of the primary node in the instance over the past minute.
- node
Memory NumberUsed Percentage - Average memory usage of the primary node over the past minute
- node
Number String - Number of nodes.
- node
Space NumberUsed Percentage - Average disk usage of the primary node over the past minute
- proxy
Detail Property Map - proxy information
- storage
Audit NumberLog Size - Space used by audit logs in instance storage
- storage
Bin NumberLog Size - Binlog space usage in the instance storage
- storage
Data NumberSize - Space used by data in instance storage.
- storage
Error NumberLog Size - Space used by error logs in instance storage.
- storage
Log NumberSize - Space used by logs in the instance storage
- storage
Slow NumberLog Size - Space used by slow logs in instance storage
- storage
Use Number - Storage space used by the instance, in GB
- time
Zone String - Time zone
- updated
Time String - Instance updates local time.
- vcpu Number
- CPU size. For example: 1 means 1U.
- zone
Id String - Availability zone of the instance's primary node.
- zone
Ids List<String> - List of availability zones for each node in the instance.
Look up Existing Instance Resource
Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
address_objects: Optional[Sequence[InstanceAddressObjectArgs]] = None,
allow_list_ids: Optional[Sequence[str]] = None,
allow_list_version: Optional[str] = None,
auto_storage_scaling_config: Optional[InstanceAutoStorageScalingConfigArgs] = None,
auto_upgrade_minor_version: Optional[str] = None,
backup_audit_log_size: Optional[int] = None,
backup_bin_log_size: Optional[int] = None,
backup_data_size: Optional[int] = None,
backup_error_log_size: Optional[int] = None,
backup_free_quota_size: Optional[int] = None,
backup_log_size: Optional[int] = None,
backup_slow_log_size: Optional[int] = None,
backup_use: Optional[float] = None,
basic_backup_binlog_size: Optional[int] = None,
basic_backup_data_size: Optional[int] = None,
charge_detail: Optional[InstanceChargeDetailArgs] = None,
cpu_num: Optional[int] = None,
created_time: Optional[str] = None,
current_kernel_version: Optional[str] = None,
db_engine_version: Optional[str] = None,
db_param_group_id: Optional[str] = None,
db_time_zone: Optional[str] = None,
deletion_protection: Optional[str] = None,
disaster_recovery_instances: Optional[Sequence[InstanceDisasterRecoveryInstanceArgs]] = None,
dr_dts_task_id: Optional[str] = None,
dr_dts_task_name: Optional[str] = None,
dr_dts_task_status: Optional[str] = None,
dr_seconds_behind_master: Optional[int] = None,
endpoints: Optional[Sequence[InstanceEndpointArgs]] = None,
global_read_only: Optional[bool] = None,
has_disaster_recovery_instances: Optional[bool] = None,
has_green_instance: Optional[bool] = None,
instance_id: Optional[str] = None,
instance_name: Optional[str] = None,
instance_status: Optional[str] = None,
instance_type: Optional[str] = None,
lower_case_table_names: Optional[str] = None,
maintenance_window: Optional[InstanceMaintenanceWindowArgs] = None,
master_instance_id: Optional[str] = None,
master_instance_name: Optional[str] = None,
memory: Optional[int] = None,
node_cpu_used_percentage: Optional[float] = None,
node_memory_used_percentage: Optional[float] = None,
node_number: Optional[str] = None,
node_space_used_percentage: Optional[float] = None,
node_spec: Optional[str] = None,
nodes: Optional[Sequence[InstanceNodeArgs]] = None,
port: Optional[int] = None,
project_name: Optional[str] = None,
proxy_detail: Optional[InstanceProxyDetailArgs] = None,
storage_audit_log_size: Optional[int] = None,
storage_bin_log_size: Optional[int] = None,
storage_data_size: Optional[int] = None,
storage_error_log_size: Optional[int] = None,
storage_log_size: Optional[int] = None,
storage_slow_log_size: Optional[int] = None,
storage_space: Optional[int] = None,
storage_type: Optional[str] = None,
storage_use: Optional[float] = None,
subnet_id: Optional[str] = None,
super_account_name: Optional[str] = None,
super_account_password: Optional[str] = None,
sync_mode: Optional[str] = None,
tags: Optional[Sequence[InstanceTagArgs]] = None,
time_zone: Optional[str] = None,
updated_time: Optional[str] = None,
vcpu: Optional[int] = None,
vpc_id: Optional[str] = None,
zone_id: Optional[str] = None,
zone_ids: Optional[Sequence[str]] = None) -> Instancefunc GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)resources: _: type: volcenginecc:rdsmysql:Instance get: id: ${id}import {
to = volcenginecc_rdsmysql_instance.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Address
Objects List<Volcengine.Instance Address Object> - Allow
List List<string>Ids - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- Allow
List stringVersion - Allowlist version
- Auto
Storage Volcengine.Scaling Config Instance Auto Storage Scaling Config - Auto scaling configuration
- Auto
Upgrade stringMinor Version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- Backup
Audit intLog Size - Space used by audit logs in backup.
- Backup
Bin intLog Size - Space used by binlog logs in backup.
- Backup
Data intSize - Space used by data in backup.
- Backup
Error intLog Size - Space used by error logs in backups.
- Backup
Free intQuota Size - Free backup storage space, in GB
- Backup
Log intSize - Space used by logs in backups.
- Backup
Slow intLog Size - Space used by slow logs in backups.
- Backup
Use double - Backup space used by the instance, in GB
- Basic
Backup intBinlog Size - Space used by Binlog logs in basic backups.
- Basic
Backup intData Size - Space used by data in the base backup
- Charge
Detail Volcengine.Instance Charge Detail - Billing method
- Cpu
Num int - Number of CPU cores for the database proxy service of the instance
- Created
Time string - Instance creation local time.
- Current
Kernel stringVersion - Instance kernel minor version.
- Db
Engine stringVersion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- Db
Param stringGroup Id - Parameter template ID. Default value is the default parameter template for the database engine version
- Db
Time stringZone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- Deletion
Protection string - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- Disaster
Recovery List<Volcengine.Instances Instance Disaster Recovery Instance> - Dr
Dts stringTask Id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- Dr
Dts stringTask Name - Name of synchronization tasks between primary and disaster recovery instances.
- Dr
Dts stringTask Status - Status of synchronization tasks between primary and disaster recovery instances.
- Dr
Seconds intBehind Master - Latency between the disaster recovery instance and the primary instance.
- Endpoints
List<Volcengine.
Instance Endpoint> - Global
Read boolOnly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- Has
Disaster boolRecovery Instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- Has
Green boolInstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- Instance
Id string - Instance ID.
- Instance
Name string - Instance name.
- Instance
Status string - Instance status.
- Instance
Type string - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- Lower
Case stringTable Names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- Maintenance
Window Volcengine.Instance Maintenance Window - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- Master
Instance stringId - Primary instance ID
- Master
Instance stringName - Primary instance name.
- Memory int
- Memory size. Unit: GB.
- Node
Cpu doubleUsed Percentage - Average CPU usage of the primary node in the instance over the past minute.
- Node
Memory doubleUsed Percentage - Average memory usage of the primary node over the past minute
- Node
Number string - Number of nodes.
- Node
Space doubleUsed Percentage - Average disk usage of the primary node over the past minute
- Node
Spec string - Node specifications.
- Nodes
List<Volcengine.
Instance Node> - Port int
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- Project
Name string - Project.
- Proxy
Detail Volcengine.Instance Proxy Detail - proxy information
- Storage
Audit intLog Size - Space used by audit logs in instance storage
- Storage
Bin intLog Size - Binlog space usage in the instance storage
- Storage
Data intSize - Space used by data in instance storage.
- Storage
Error intLog Size - Space used by error logs in instance storage.
- Storage
Log intSize - Space used by logs in the instance storage
- Storage
Slow intLog Size - Space used by slow logs in instance storage
- Storage
Space int - Total storage space of the instance, in GB
- Storage
Type string - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- Storage
Use double - Storage space used by the instance, in GB
- Subnet
Id string - Subnet ID.
- Super
Account stringName - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- Super
Account stringPassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- Sync
Mode string - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
-
List<Volcengine.
Instance Tag> - Time
Zone string - Time zone
- Updated
Time string - Instance updates local time.
- Vcpu int
- CPU size. For example: 1 means 1U.
- Vpc
Id string - VPC (Virtual Private Cloud) ID.
- Zone
Id string - Availability zone of the instance's primary node.
- Zone
Ids List<string> - List of availability zones for each node in the instance.
- Address
Objects []InstanceAddress Object Args - Allow
List []stringIds - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- Allow
List stringVersion - Allowlist version
- Auto
Storage InstanceScaling Config Auto Storage Scaling Config Args - Auto scaling configuration
- Auto
Upgrade stringMinor Version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- Backup
Audit intLog Size - Space used by audit logs in backup.
- Backup
Bin intLog Size - Space used by binlog logs in backup.
- Backup
Data intSize - Space used by data in backup.
- Backup
Error intLog Size - Space used by error logs in backups.
- Backup
Free intQuota Size - Free backup storage space, in GB
- Backup
Log intSize - Space used by logs in backups.
- Backup
Slow intLog Size - Space used by slow logs in backups.
- Backup
Use float64 - Backup space used by the instance, in GB
- Basic
Backup intBinlog Size - Space used by Binlog logs in basic backups.
- Basic
Backup intData Size - Space used by data in the base backup
- Charge
Detail InstanceCharge Detail Args - Billing method
- Cpu
Num int - Number of CPU cores for the database proxy service of the instance
- Created
Time string - Instance creation local time.
- Current
Kernel stringVersion - Instance kernel minor version.
- Db
Engine stringVersion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- Db
Param stringGroup Id - Parameter template ID. Default value is the default parameter template for the database engine version
- Db
Time stringZone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- Deletion
Protection string - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- Disaster
Recovery []InstanceInstances Disaster Recovery Instance Args - Dr
Dts stringTask Id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- Dr
Dts stringTask Name - Name of synchronization tasks between primary and disaster recovery instances.
- Dr
Dts stringTask Status - Status of synchronization tasks between primary and disaster recovery instances.
- Dr
Seconds intBehind Master - Latency between the disaster recovery instance and the primary instance.
- Endpoints
[]Instance
Endpoint Args - Global
Read boolOnly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- Has
Disaster boolRecovery Instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- Has
Green boolInstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- Instance
Id string - Instance ID.
- Instance
Name string - Instance name.
- Instance
Status string - Instance status.
- Instance
Type string - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- Lower
Case stringTable Names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- Maintenance
Window InstanceMaintenance Window Args - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- Master
Instance stringId - Primary instance ID
- Master
Instance stringName - Primary instance name.
- Memory int
- Memory size. Unit: GB.
- Node
Cpu float64Used Percentage - Average CPU usage of the primary node in the instance over the past minute.
- Node
Memory float64Used Percentage - Average memory usage of the primary node over the past minute
- Node
Number string - Number of nodes.
- Node
Space float64Used Percentage - Average disk usage of the primary node over the past minute
- Node
Spec string - Node specifications.
- Nodes
[]Instance
Node Args - Port int
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- Project
Name string - Project.
- Proxy
Detail InstanceProxy Detail Args - proxy information
- Storage
Audit intLog Size - Space used by audit logs in instance storage
- Storage
Bin intLog Size - Binlog space usage in the instance storage
- Storage
Data intSize - Space used by data in instance storage.
- Storage
Error intLog Size - Space used by error logs in instance storage.
- Storage
Log intSize - Space used by logs in the instance storage
- Storage
Slow intLog Size - Space used by slow logs in instance storage
- Storage
Space int - Total storage space of the instance, in GB
- Storage
Type string - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- Storage
Use float64 - Storage space used by the instance, in GB
- Subnet
Id string - Subnet ID.
- Super
Account stringName - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- Super
Account stringPassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- Sync
Mode string - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
-
[]Instance
Tag Args - Time
Zone string - Time zone
- Updated
Time string - Instance updates local time.
- Vcpu int
- CPU size. For example: 1 means 1U.
- Vpc
Id string - VPC (Virtual Private Cloud) ID.
- Zone
Id string - Availability zone of the instance's primary node.
- Zone
Ids []string - List of availability zones for each node in the instance.
- address_
objects list(object) - allow_
list_ list(string)ids - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- allow_
list_ stringversion - Allowlist version
- auto_
storage_ objectscaling_ config - Auto scaling configuration
- auto_
upgrade_ stringminor_ version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- backup_
audit_ numberlog_ size - Space used by audit logs in backup.
- backup_
bin_ numberlog_ size - Space used by binlog logs in backup.
- backup_
data_ numbersize - Space used by data in backup.
- backup_
error_ numberlog_ size - Space used by error logs in backups.
- backup_
free_ numberquota_ size - Free backup storage space, in GB
- backup_
log_ numbersize - Space used by logs in backups.
- backup_
slow_ numberlog_ size - Space used by slow logs in backups.
- backup_
use number - Backup space used by the instance, in GB
- basic_
backup_ numberbinlog_ size - Space used by Binlog logs in basic backups.
- basic_
backup_ numberdata_ size - Space used by data in the base backup
- charge_
detail object - Billing method
- cpu_
num number - Number of CPU cores for the database proxy service of the instance
- created_
time string - Instance creation local time.
- current_
kernel_ stringversion - Instance kernel minor version.
- db_
engine_ stringversion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- db_
param_ stringgroup_ id - Parameter template ID. Default value is the default parameter template for the database engine version
- db_
time_ stringzone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- deletion_
protection string - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- disaster_
recovery_ list(object)instances - dr_
dts_ stringtask_ id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- dr_
dts_ stringtask_ name - Name of synchronization tasks between primary and disaster recovery instances.
- dr_
dts_ stringtask_ status - Status of synchronization tasks between primary and disaster recovery instances.
- dr_
seconds_ numberbehind_ master - Latency between the disaster recovery instance and the primary instance.
- endpoints list(object)
- global_
read_ boolonly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- has_
disaster_ boolrecovery_ instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- has_
green_ boolinstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- instance_
id string - Instance ID.
- instance_
name string - Instance name.
- instance_
status string - Instance status.
- instance_
type string - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- lower_
case_ stringtable_ names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- maintenance_
window object - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- master_
instance_ stringid - Primary instance ID
- master_
instance_ stringname - Primary instance name.
- memory number
- Memory size. Unit: GB.
- node_
cpu_ numberused_ percentage - Average CPU usage of the primary node in the instance over the past minute.
- node_
memory_ numberused_ percentage - Average memory usage of the primary node over the past minute
- node_
number string - Number of nodes.
- node_
space_ numberused_ percentage - Average disk usage of the primary node over the past minute
- node_
spec string - Node specifications.
- nodes list(object)
- port number
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- project_
name string - Project.
- proxy_
detail object - proxy information
- storage_
audit_ numberlog_ size - Space used by audit logs in instance storage
- storage_
bin_ numberlog_ size - Binlog space usage in the instance storage
- storage_
data_ numbersize - Space used by data in instance storage.
- storage_
error_ numberlog_ size - Space used by error logs in instance storage.
- storage_
log_ numbersize - Space used by logs in the instance storage
- storage_
slow_ numberlog_ size - Space used by slow logs in instance storage
- storage_
space number - Total storage space of the instance, in GB
- storage_
type string - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- storage_
use number - Storage space used by the instance, in GB
- subnet_
id string - Subnet ID.
- super_
account_ stringname - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- super_
account_ stringpassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- sync_
mode string - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
- list(object)
- time_
zone string - Time zone
- updated_
time string - Instance updates local time.
- vcpu number
- CPU size. For example: 1 means 1U.
- vpc_
id string - VPC (Virtual Private Cloud) ID.
- zone_
id string - Availability zone of the instance's primary node.
- zone_
ids list(string) - List of availability zones for each node in the instance.
- address
Objects List<InstanceAddress Object> - allow
List List<String>Ids - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- allow
List StringVersion - Allowlist version
- auto
Storage InstanceScaling Config Auto Storage Scaling Config - Auto scaling configuration
- auto
Upgrade StringMinor Version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- backup
Audit IntegerLog Size - Space used by audit logs in backup.
- backup
Bin IntegerLog Size - Space used by binlog logs in backup.
- backup
Data IntegerSize - Space used by data in backup.
- backup
Error IntegerLog Size - Space used by error logs in backups.
- backup
Free IntegerQuota Size - Free backup storage space, in GB
- backup
Log IntegerSize - Space used by logs in backups.
- backup
Slow IntegerLog Size - Space used by slow logs in backups.
- backup
Use Double - Backup space used by the instance, in GB
- basic
Backup IntegerBinlog Size - Space used by Binlog logs in basic backups.
- basic
Backup IntegerData Size - Space used by data in the base backup
- charge
Detail InstanceCharge Detail - Billing method
- cpu
Num Integer - Number of CPU cores for the database proxy service of the instance
- created
Time String - Instance creation local time.
- current
Kernel StringVersion - Instance kernel minor version.
- db
Engine StringVersion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- db
Param StringGroup Id - Parameter template ID. Default value is the default parameter template for the database engine version
- db
Time StringZone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- deletion
Protection String - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- disaster
Recovery List<InstanceInstances Disaster Recovery Instance> - dr
Dts StringTask Id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- dr
Dts StringTask Name - Name of synchronization tasks between primary and disaster recovery instances.
- dr
Dts StringTask Status - Status of synchronization tasks between primary and disaster recovery instances.
- dr
Seconds IntegerBehind Master - Latency between the disaster recovery instance and the primary instance.
- endpoints
List<Instance
Endpoint> - global
Read BooleanOnly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- has
Disaster BooleanRecovery Instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- has
Green BooleanInstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- instance
Id String - Instance ID.
- instance
Name String - Instance name.
- instance
Status String - Instance status.
- instance
Type String - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- lower
Case StringTable Names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- maintenance
Window InstanceMaintenance Window - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- master
Instance StringId - Primary instance ID
- master
Instance StringName - Primary instance name.
- memory Integer
- Memory size. Unit: GB.
- node
Cpu DoubleUsed Percentage - Average CPU usage of the primary node in the instance over the past minute.
- node
Memory DoubleUsed Percentage - Average memory usage of the primary node over the past minute
- node
Number String - Number of nodes.
- node
Space DoubleUsed Percentage - Average disk usage of the primary node over the past minute
- node
Spec String - Node specifications.
- nodes
List<Instance
Node> - port Integer
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- project
Name String - Project.
- proxy
Detail InstanceProxy Detail - proxy information
- storage
Audit IntegerLog Size - Space used by audit logs in instance storage
- storage
Bin IntegerLog Size - Binlog space usage in the instance storage
- storage
Data IntegerSize - Space used by data in instance storage.
- storage
Error IntegerLog Size - Space used by error logs in instance storage.
- storage
Log IntegerSize - Space used by logs in the instance storage
- storage
Slow IntegerLog Size - Space used by slow logs in instance storage
- storage
Space Integer - Total storage space of the instance, in GB
- storage
Type String - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- storage
Use Double - Storage space used by the instance, in GB
- subnet
Id String - Subnet ID.
- super
Account StringName - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- super
Account StringPassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- sync
Mode String - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
-
List<Instance
Tag> - time
Zone String - Time zone
- updated
Time String - Instance updates local time.
- vcpu Integer
- CPU size. For example: 1 means 1U.
- vpc
Id String - VPC (Virtual Private Cloud) ID.
- zone
Id String - Availability zone of the instance's primary node.
- zone
Ids List<String> - List of availability zones for each node in the instance.
- address
Objects InstanceAddress Object[] - allow
List string[]Ids - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- allow
List stringVersion - Allowlist version
- auto
Storage InstanceScaling Config Auto Storage Scaling Config - Auto scaling configuration
- auto
Upgrade stringMinor Version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- backup
Audit numberLog Size - Space used by audit logs in backup.
- backup
Bin numberLog Size - Space used by binlog logs in backup.
- backup
Data numberSize - Space used by data in backup.
- backup
Error numberLog Size - Space used by error logs in backups.
- backup
Free numberQuota Size - Free backup storage space, in GB
- backup
Log numberSize - Space used by logs in backups.
- backup
Slow numberLog Size - Space used by slow logs in backups.
- backup
Use number - Backup space used by the instance, in GB
- basic
Backup numberBinlog Size - Space used by Binlog logs in basic backups.
- basic
Backup numberData Size - Space used by data in the base backup
- charge
Detail InstanceCharge Detail - Billing method
- cpu
Num number - Number of CPU cores for the database proxy service of the instance
- created
Time string - Instance creation local time.
- current
Kernel stringVersion - Instance kernel minor version.
- db
Engine stringVersion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- db
Param stringGroup Id - Parameter template ID. Default value is the default parameter template for the database engine version
- db
Time stringZone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- deletion
Protection string - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- disaster
Recovery InstanceInstances Disaster Recovery Instance[] - dr
Dts stringTask Id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- dr
Dts stringTask Name - Name of synchronization tasks between primary and disaster recovery instances.
- dr
Dts stringTask Status - Status of synchronization tasks between primary and disaster recovery instances.
- dr
Seconds numberBehind Master - Latency between the disaster recovery instance and the primary instance.
- endpoints
Instance
Endpoint[] - global
Read booleanOnly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- has
Disaster booleanRecovery Instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- has
Green booleanInstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- instance
Id string - Instance ID.
- instance
Name string - Instance name.
- instance
Status string - Instance status.
- instance
Type string - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- lower
Case stringTable Names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- maintenance
Window InstanceMaintenance Window - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- master
Instance stringId - Primary instance ID
- master
Instance stringName - Primary instance name.
- memory number
- Memory size. Unit: GB.
- node
Cpu numberUsed Percentage - Average CPU usage of the primary node in the instance over the past minute.
- node
Memory numberUsed Percentage - Average memory usage of the primary node over the past minute
- node
Number string - Number of nodes.
- node
Space numberUsed Percentage - Average disk usage of the primary node over the past minute
- node
Spec string - Node specifications.
- nodes
Instance
Node[] - port number
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- project
Name string - Project.
- proxy
Detail InstanceProxy Detail - proxy information
- storage
Audit numberLog Size - Space used by audit logs in instance storage
- storage
Bin numberLog Size - Binlog space usage in the instance storage
- storage
Data numberSize - Space used by data in instance storage.
- storage
Error numberLog Size - Space used by error logs in instance storage.
- storage
Log numberSize - Space used by logs in the instance storage
- storage
Slow numberLog Size - Space used by slow logs in instance storage
- storage
Space number - Total storage space of the instance, in GB
- storage
Type string - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- storage
Use number - Storage space used by the instance, in GB
- subnet
Id string - Subnet ID.
- super
Account stringName - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- super
Account stringPassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- sync
Mode string - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
-
Instance
Tag[] - time
Zone string - Time zone
- updated
Time string - Instance updates local time.
- vcpu number
- CPU size. For example: 1 means 1U.
- vpc
Id string - VPC (Virtual Private Cloud) ID.
- zone
Id string - Availability zone of the instance's primary node.
- zone
Ids string[] - List of availability zones for each node in the instance.
- address_
objects Sequence[InstanceAddress Object Args] - allow_
list_ Sequence[str]ids - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- allow_
list_ strversion - Allowlist version
- auto_
storage_ Instancescaling_ config Auto Storage Scaling Config Args - Auto scaling configuration
- auto_
upgrade_ strminor_ version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- backup_
audit_ intlog_ size - Space used by audit logs in backup.
- backup_
bin_ intlog_ size - Space used by binlog logs in backup.
- backup_
data_ intsize - Space used by data in backup.
- backup_
error_ intlog_ size - Space used by error logs in backups.
- backup_
free_ intquota_ size - Free backup storage space, in GB
- backup_
log_ intsize - Space used by logs in backups.
- backup_
slow_ intlog_ size - Space used by slow logs in backups.
- backup_
use float - Backup space used by the instance, in GB
- basic_
backup_ intbinlog_ size - Space used by Binlog logs in basic backups.
- basic_
backup_ intdata_ size - Space used by data in the base backup
- charge_
detail InstanceCharge Detail Args - Billing method
- cpu_
num int - Number of CPU cores for the database proxy service of the instance
- created_
time str - Instance creation local time.
- current_
kernel_ strversion - Instance kernel minor version.
- db_
engine_ strversion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- db_
param_ strgroup_ id - Parameter template ID. Default value is the default parameter template for the database engine version
- db_
time_ strzone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- deletion_
protection str - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- disaster_
recovery_ Sequence[Instanceinstances Disaster Recovery Instance Args] - dr_
dts_ strtask_ id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- dr_
dts_ strtask_ name - Name of synchronization tasks between primary and disaster recovery instances.
- dr_
dts_ strtask_ status - Status of synchronization tasks between primary and disaster recovery instances.
- dr_
seconds_ intbehind_ master - Latency between the disaster recovery instance and the primary instance.
- endpoints
Sequence[Instance
Endpoint Args] - global_
read_ boolonly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- has_
disaster_ boolrecovery_ instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- has_
green_ boolinstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- instance_
id str - Instance ID.
- instance_
name str - Instance name.
- instance_
status str - Instance status.
- instance_
type str - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- lower_
case_ strtable_ names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- maintenance_
window InstanceMaintenance Window Args - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- master_
instance_ strid - Primary instance ID
- master_
instance_ strname - Primary instance name.
- memory int
- Memory size. Unit: GB.
- node_
cpu_ floatused_ percentage - Average CPU usage of the primary node in the instance over the past minute.
- node_
memory_ floatused_ percentage - Average memory usage of the primary node over the past minute
- node_
number str - Number of nodes.
- node_
space_ floatused_ percentage - Average disk usage of the primary node over the past minute
- node_
spec str - Node specifications.
- nodes
Sequence[Instance
Node Args] - port int
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- project_
name str - Project.
- proxy_
detail InstanceProxy Detail Args - proxy information
- storage_
audit_ intlog_ size - Space used by audit logs in instance storage
- storage_
bin_ intlog_ size - Binlog space usage in the instance storage
- storage_
data_ intsize - Space used by data in instance storage.
- storage_
error_ intlog_ size - Space used by error logs in instance storage.
- storage_
log_ intsize - Space used by logs in the instance storage
- storage_
slow_ intlog_ size - Space used by slow logs in instance storage
- storage_
space int - Total storage space of the instance, in GB
- storage_
type str - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- storage_
use float - Storage space used by the instance, in GB
- subnet_
id str - Subnet ID.
- super_
account_ strname - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- super_
account_ strpassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- sync_
mode str - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
-
Sequence[Instance
Tag Args] - time_
zone str - Time zone
- updated_
time str - Instance updates local time.
- vcpu int
- CPU size. For example: 1 means 1U.
- vpc_
id str - VPC (Virtual Private Cloud) ID.
- zone_
id str - Availability zone of the instance's primary node.
- zone_
ids Sequence[str] - List of availability zones for each node in the instance.
- address
Objects List<Property Map> - allow
List List<String>Ids - Allowlist ID. To bind multiple allowlists, separate allowlist IDs with commas (,). Each instance can bind up to 100 allowlists
- allow
List StringVersion - Allowlist version
- auto
Storage Property MapScaling Config - Auto scaling configuration
- auto
Upgrade StringMinor Version - Instance kernel minor version upgrade policy. Values: Auto: Automatic upgrade. Manual: Manual upgrade.
- backup
Audit NumberLog Size - Space used by audit logs in backup.
- backup
Bin NumberLog Size - Space used by binlog logs in backup.
- backup
Data NumberSize - Space used by data in backup.
- backup
Error NumberLog Size - Space used by error logs in backups.
- backup
Free NumberQuota Size - Free backup storage space, in GB
- backup
Log NumberSize - Space used by logs in backups.
- backup
Slow NumberLog Size - Space used by slow logs in backups.
- backup
Use Number - Backup space used by the instance, in GB
- basic
Backup NumberBinlog Size - Space used by Binlog logs in basic backups.
- basic
Backup NumberData Size - Space used by data in the base backup
- charge
Detail Property Map - Billing method
- cpu
Num Number - Number of CPU cores for the database proxy service of the instance
- created
Time String - Instance creation local time.
- current
Kernel StringVersion - Instance kernel minor version.
- db
Engine StringVersion - Compatible versions. Values: MySQL57: MySQL 5.7 version. MySQL80: MySQL 8.0 version
- db
Param StringGroup Id - Parameter template ID. Default value is the default parameter template for the database engine version
- db
Time StringZone - Time zone. Supports UTC -12:00 ~ +13:00. Default is the time zone of the region.
- deletion
Protection String - Whether to enable instance deletion protection. Values: Enabled: Yes. Disabled: No. Default value.
- disaster
Recovery List<Property Map>Instances - dr
Dts StringTask Id - ID of the data synchronization link between the primary and disaster recovery instances in the DTS data synchronization task.
- dr
Dts StringTask Name - Name of synchronization tasks between primary and disaster recovery instances.
- dr
Dts StringTask Status - Status of synchronization tasks between primary and disaster recovery instances.
- dr
Seconds NumberBehind Master - Latency between the disaster recovery instance and the primary instance.
- endpoints List<Property Map>
- global
Read BooleanOnly - Enable global read-only mode. Values: true: enabled. false: disabled (default is false)
- has
Disaster BooleanRecovery Instances - Whether the instance has a disaster recovery instance. Values: true: Yes. false: No.
- has
Green BooleanInstance - Is the instance in blue-green deployment? Values: true: yes. false: no.
- instance
Id String - Instance ID.
- instance
Name String - Instance name.
- instance
Status String - Instance status.
- instance
Type String - Instance type. Values: DoubleNode: dual-node type. MultiNode: multi-node type
- lower
Case StringTable Names - Whether table names are case-sensitive. Default value is true. Values: false: Table names are stored as fixed and are case-sensitive. true: Table names are stored in lowercase and are case-insensitive.
- maintenance
Window Property Map - Specify the maintenance window for the instance when creating it. This field is optional. If not set, the default is UTC18:00Z-21:59Z every day of the week (Beijing time 02:00-05:59).
- master
Instance StringId - Primary instance ID
- master
Instance StringName - Primary instance name.
- memory Number
- Memory size. Unit: GB.
- node
Cpu NumberUsed Percentage - Average CPU usage of the primary node in the instance over the past minute.
- node
Memory NumberUsed Percentage - Average memory usage of the primary node over the past minute
- node
Number String - Number of nodes.
- node
Space NumberUsed Percentage - Average disk usage of the primary node over the past minute
- node
Spec String - Node specifications.
- nodes List<Property Map>
- port Number
- Default endpoint private network port. Port range: 1000~65534, default is 3306. When creating a new connection endpoint or enabling a new address, the default endpoint private network port is used for real-time configuration as the default port.
- project
Name String - Project.
- proxy
Detail Property Map - proxy information
- storage
Audit NumberLog Size - Space used by audit logs in instance storage
- storage
Bin NumberLog Size - Binlog space usage in the instance storage
- storage
Data NumberSize - Space used by data in instance storage.
- storage
Error NumberLog Size - Space used by error logs in instance storage.
- storage
Log NumberSize - Space used by logs in the instance storage
- storage
Slow NumberLog Size - Space used by slow logs in instance storage
- storage
Space Number - Total storage space of the instance, in GB
- storage
Type String - Instance storage type. Value range: LocalSSD: local disk. CloudESSDFlexPL: FlexPL cloud disk. CloudESSDPL0: PL0 cloud disk.
- storage
Use Number - Storage space used by the instance, in GB
- subnet
Id String - Subnet ID.
- super
Account StringName - High-privilege account name. If this parameter is not provided, a high-privilege account will not be created by default.
- super
Account StringPassword - Password for high-privilege account. Password rules: 8–32 characters in length. Must contain at least three of the following: uppercase letters, lowercase letters, numbers, special characters. Special characters: !@#$%^&*()_+-=,.&?|/.
- sync
Mode String - Data synchronization mode: SemiSync: semi-synchronous. Async: asynchronous
- List<Property Map>
- time
Zone String - Time zone
- updated
Time String - Instance updates local time.
- vcpu Number
- CPU size. For example: 1 means 1U.
- vpc
Id String - VPC (Virtual Private Cloud) ID.
- zone
Id String - Availability zone of the instance's primary node.
- zone
Ids List<String> - List of availability zones for each node in the instance.
Supporting Types
InstanceAddressObject, InstanceAddressObjectArgs
- Dns
Visibility bool - false: private network resolution (default). true: private and public network resolution.
- Domain string
- Connection domain name
- Eip
Id string - EIP ID, valid only for Public addresses.
- Internet
Protocol string - IP protocol version. Value: IPv4.
- Ip
Address string - IP address.
- Network
Type string - Network address type. Values: Private: private address. Public: public address
- Port string
- Port
- Subnet
Id string - Subnet ID, valid only for Private addresses
- Dns
Visibility bool - false: private network resolution (default). true: private and public network resolution.
- Domain string
- Connection domain name
- Eip
Id string - EIP ID, valid only for Public addresses.
- Internet
Protocol string - IP protocol version. Value: IPv4.
- Ip
Address string - IP address.
- Network
Type string - Network address type. Values: Private: private address. Public: public address
- Port string
- Port
- Subnet
Id string - Subnet ID, valid only for Private addresses
- dns_
visibility bool - false: private network resolution (default). true: private and public network resolution.
- domain string
- Connection domain name
- eip_
id string - EIP ID, valid only for Public addresses.
- internet_
protocol string - IP protocol version. Value: IPv4.
- ip_
address string - IP address.
- network_
type string - Network address type. Values: Private: private address. Public: public address
- port string
- Port
- subnet_
id string - Subnet ID, valid only for Private addresses
- dns
Visibility Boolean - false: private network resolution (default). true: private and public network resolution.
- domain String
- Connection domain name
- eip
Id String - EIP ID, valid only for Public addresses.
- internet
Protocol String - IP protocol version. Value: IPv4.
- ip
Address String - IP address.
- network
Type String - Network address type. Values: Private: private address. Public: public address
- port String
- Port
- subnet
Id String - Subnet ID, valid only for Private addresses
- dns
Visibility boolean - false: private network resolution (default). true: private and public network resolution.
- domain string
- Connection domain name
- eip
Id string - EIP ID, valid only for Public addresses.
- internet
Protocol string - IP protocol version. Value: IPv4.
- ip
Address string - IP address.
- network
Type string - Network address type. Values: Private: private address. Public: public address
- port string
- Port
- subnet
Id string - Subnet ID, valid only for Private addresses
- dns_
visibility bool - false: private network resolution (default). true: private and public network resolution.
- domain str
- Connection domain name
- eip_
id str - EIP ID, valid only for Public addresses.
- internet_
protocol str - IP protocol version. Value: IPv4.
- ip_
address str - IP address.
- network_
type str - Network address type. Values: Private: private address. Public: public address
- port str
- Port
- subnet_
id str - Subnet ID, valid only for Private addresses
- dns
Visibility Boolean - false: private network resolution (default). true: private and public network resolution.
- domain String
- Connection domain name
- eip
Id String - EIP ID, valid only for Public addresses.
- internet
Protocol String - IP protocol version. Value: IPv4.
- ip
Address String - IP address.
- network
Type String - Network address type. Values: Private: private address. Public: public address
- port String
- Port
- subnet
Id String - Subnet ID, valid only for Private addresses
InstanceAutoStorageScalingConfig, InstanceAutoStorageScalingConfigArgs
- Enable
Storage boolAuto Scale - Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
- Storage
Threshold int - Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
- Storage
Upper intBound - Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
- Enable
Storage boolAuto Scale - Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
- Storage
Threshold int - Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
- Storage
Upper intBound - Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
- enable_
storage_ boolauto_ scale - Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
- storage_
threshold number - Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
- storage_
upper_ numberbound - Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
- enable
Storage BooleanAuto Scale - Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
- storage
Threshold Integer - Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
- storage
Upper IntegerBound - Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
- enable
Storage booleanAuto Scale - Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
- storage
Threshold number - Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
- storage
Upper numberBound - Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
- enable_
storage_ boolauto_ scale - Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
- storage_
threshold int - Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
- storage_
upper_ intbound - Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
- enable
Storage BooleanAuto Scale - Whether to enable automatic scaling for the instance. Values: true: Yes. false: No.
- storage
Threshold Number - Percentage of available storage space that triggers automatic scaling. Value range: 10–50, default: 10, unit: %
- storage
Upper NumberBound - Maximum storage space for automatic expansion. The minimum value is instance storage space + 20 GB; the maximum value is the upper limit of the storage space range for the primary node specification, in GB. See details about selectable storage space ranges for different specifications.
InstanceChargeDetail, InstanceChargeDetailArgs
- Charge
Type string - Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
- Auto
Renew bool - Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
- Charge
End stringTime - Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- Charge
Start stringTime - Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- Charge
Status string - Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
- Number int
- Number of instances to purchase. Value range: 1–50. Default: 1
- Overdue
Reclaim stringTime - Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
- Overdue
Time string - Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- Period int
- Purchase duration in prepaid scenarios.
- Period
Unit string - Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
- Temp
Modify stringEnd Time - Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- Temp
Modify stringStart Time - Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- Charge
Type string - Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
- Auto
Renew bool - Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
- Charge
End stringTime - Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- Charge
Start stringTime - Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- Charge
Status string - Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
- Number int
- Number of instances to purchase. Value range: 1–50. Default: 1
- Overdue
Reclaim stringTime - Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
- Overdue
Time string - Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- Period int
- Purchase duration in prepaid scenarios.
- Period
Unit string - Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
- Temp
Modify stringEnd Time - Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- Temp
Modify stringStart Time - Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- charge_
type string - Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
- auto_
renew bool - Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
- charge_
end_ stringtime - Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- charge_
start_ stringtime - Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- charge_
status string - Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
- number number
- Number of instances to purchase. Value range: 1–50. Default: 1
- overdue_
reclaim_ stringtime - Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
- overdue_
time string - Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- period number
- Purchase duration in prepaid scenarios.
- period_
unit string - Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
- temp_
modify_ stringend_ time - Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- temp_
modify_ stringstart_ time - Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- charge
Type String - Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
- auto
Renew Boolean - Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
- charge
End StringTime - Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- charge
Start StringTime - Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- charge
Status String - Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
- number Integer
- Number of instances to purchase. Value range: 1–50. Default: 1
- overdue
Reclaim StringTime - Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
- overdue
Time String - Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- period Integer
- Purchase duration in prepaid scenarios.
- period
Unit String - Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
- temp
Modify StringEnd Time - Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- temp
Modify StringStart Time - Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- charge
Type string - Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
- auto
Renew boolean - Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
- charge
End stringTime - Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- charge
Start stringTime - Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- charge
Status string - Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
- number number
- Number of instances to purchase. Value range: 1–50. Default: 1
- overdue
Reclaim stringTime - Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
- overdue
Time string - Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- period number
- Purchase duration in prepaid scenarios.
- period
Unit string - Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
- temp
Modify stringEnd Time - Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- temp
Modify stringStart Time - Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- charge_
type str - Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
- auto_
renew bool - Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
- charge_
end_ strtime - Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- charge_
start_ strtime - Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- charge_
status str - Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
- number int
- Number of instances to purchase. Value range: 1–50. Default: 1
- overdue_
reclaim_ strtime - Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
- overdue_
time str - Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- period int
- Purchase duration in prepaid scenarios.
- period_
unit str - Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
- temp_
modify_ strend_ time - Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- temp_
modify_ strstart_ time - Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- charge
Type String - Billing type. Options: PrePaid: subscription. PostPaid: pay-as-you-go
- auto
Renew Boolean - Enable auto-renewal for prepaid scenarios. Values: true: auto-renewal. false: do not auto-renew
- charge
End StringTime - Billing end time for subscription instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- charge
Start StringTime - Billing start time for the instance (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
- charge
Status String - Instance billing status. Values: Normal: normal. Overdue: overdue. Unpaid: pending payment.
- number Number
- Number of instances to purchase. Value range: 1–50. Default: 1
- overdue
Reclaim StringTime - Estimated release time after the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription), in UTC. Format: yyyy-MM-ddTHH:mm:ss.sssZ
- overdue
Time String - Time when the instance is stopped due to overdue payment (pay-as-you-go) or expiration (subscription) (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- period Number
- Purchase duration in prepaid scenarios.
- period
Unit String - Purchase cycle in prepaid scenarios. Month: monthly purchase cycle (default). Year: yearly purchase cycle.
- temp
Modify StringEnd Time - Restore time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ.
- temp
Modify StringStart Time - Start time for temporary scaling (UTC). Format: yyyy-MM-ddTHH:mm:ss.sssZ
InstanceDisasterRecoveryInstance, InstanceDisasterRecoveryInstanceArgs
- Dts
Task stringId - ID of synchronization tasks between primary and disaster recovery instances.
- Dts
Task stringName - Name of the synchronization task between the primary instance and the disaster recovery instance
- Dts
Task stringStatus - Status of synchronization tasks between the primary instance and the disaster recovery instance
- Instance
Id string - Disaster recovery instance ID.
- Instance
Name string - Name of disaster recovery instance.
- Seconds
Behind intMaster - Latency between the disaster recovery instance and the primary instance.
- Dts
Task stringId - ID of synchronization tasks between primary and disaster recovery instances.
- Dts
Task stringName - Name of the synchronization task between the primary instance and the disaster recovery instance
- Dts
Task stringStatus - Status of synchronization tasks between the primary instance and the disaster recovery instance
- Instance
Id string - Disaster recovery instance ID.
- Instance
Name string - Name of disaster recovery instance.
- Seconds
Behind intMaster - Latency between the disaster recovery instance and the primary instance.
- dts_
task_ stringid - ID of synchronization tasks between primary and disaster recovery instances.
- dts_
task_ stringname - Name of the synchronization task between the primary instance and the disaster recovery instance
- dts_
task_ stringstatus - Status of synchronization tasks between the primary instance and the disaster recovery instance
- instance_
id string - Disaster recovery instance ID.
- instance_
name string - Name of disaster recovery instance.
- seconds_
behind_ numbermaster - Latency between the disaster recovery instance and the primary instance.
- dts
Task StringId - ID of synchronization tasks between primary and disaster recovery instances.
- dts
Task StringName - Name of the synchronization task between the primary instance and the disaster recovery instance
- dts
Task StringStatus - Status of synchronization tasks between the primary instance and the disaster recovery instance
- instance
Id String - Disaster recovery instance ID.
- instance
Name String - Name of disaster recovery instance.
- seconds
Behind IntegerMaster - Latency between the disaster recovery instance and the primary instance.
- dts
Task stringId - ID of synchronization tasks between primary and disaster recovery instances.
- dts
Task stringName - Name of the synchronization task between the primary instance and the disaster recovery instance
- dts
Task stringStatus - Status of synchronization tasks between the primary instance and the disaster recovery instance
- instance
Id string - Disaster recovery instance ID.
- instance
Name string - Name of disaster recovery instance.
- seconds
Behind numberMaster - Latency between the disaster recovery instance and the primary instance.
- dts_
task_ strid - ID of synchronization tasks between primary and disaster recovery instances.
- dts_
task_ strname - Name of the synchronization task between the primary instance and the disaster recovery instance
- dts_
task_ strstatus - Status of synchronization tasks between the primary instance and the disaster recovery instance
- instance_
id str - Disaster recovery instance ID.
- instance_
name str - Name of disaster recovery instance.
- seconds_
behind_ intmaster - Latency between the disaster recovery instance and the primary instance.
- dts
Task StringId - ID of synchronization tasks between primary and disaster recovery instances.
- dts
Task StringName - Name of the synchronization task between the primary instance and the disaster recovery instance
- dts
Task StringStatus - Status of synchronization tasks between the primary instance and the disaster recovery instance
- instance
Id String - Disaster recovery instance ID.
- instance
Name String - Name of disaster recovery instance.
- seconds
Behind NumberMaster - Latency between the disaster recovery instance and the primary instance.
InstanceEndpoint, InstanceEndpointArgs
- Auto
Add stringNew Nodes - When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
- List<string>
- Connection endpoint tag.
- Connection
Mode string - Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
- Connection
Pool stringType - Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
- Description string
- Description of the connection endpoint
- Enable
Connection boolPersistent - Enable connection keep-alive. Options: true: yes. false: no
- Enable
Read stringOnly - Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
- Enable
Read stringWrite Splitting - Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
- Endpoint
Id string - Instance connection endpoint ID.
- Endpoint
Name string - Instance connection endpoint name.
- Endpoint
Type string - Endpoint type. Value: Custom, custom endpoint.
- Idle
Connection boolReclaim - Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
- Implicit
Trans boolSplit - Whether to enable transaction separation. Values: true: Yes. false: No.
- Master
Node boolRouting - Whether to enable primary node routing. Values: true: Yes. false: No.
- Master
Protector intTimeout - Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
- Multi
Statements stringMode - Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
- Overload
Protection bool - Overload protection enabled. Values: true: yes. false: no
- Read
Only stringNode Distribution Type - Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
- Read
Only intNode Max Delay Time - Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
- Read
Only List<Volcengine.Node Weights Instance Endpoint Read Only Node Weight> - Read
Write stringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only
- Auto
Add stringNew Nodes - When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
- []string
- Connection endpoint tag.
- Connection
Mode string - Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
- Connection
Pool stringType - Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
- Description string
- Description of the connection endpoint
- Enable
Connection boolPersistent - Enable connection keep-alive. Options: true: yes. false: no
- Enable
Read stringOnly - Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
- Enable
Read stringWrite Splitting - Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
- Endpoint
Id string - Instance connection endpoint ID.
- Endpoint
Name string - Instance connection endpoint name.
- Endpoint
Type string - Endpoint type. Value: Custom, custom endpoint.
- Idle
Connection boolReclaim - Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
- Implicit
Trans boolSplit - Whether to enable transaction separation. Values: true: Yes. false: No.
- Master
Node boolRouting - Whether to enable primary node routing. Values: true: Yes. false: No.
- Master
Protector intTimeout - Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
- Multi
Statements stringMode - Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
- Overload
Protection bool - Overload protection enabled. Values: true: yes. false: no
- Read
Only stringNode Distribution Type - Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
- Read
Only intNode Max Delay Time - Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
- Read
Only []InstanceNode Weights Endpoint Read Only Node Weight - Read
Write stringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only
- auto_
add_ stringnew_ nodes - When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
- list(string)
- Connection endpoint tag.
- connection_
mode string - Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
- connection_
pool_ stringtype - Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
- description string
- Description of the connection endpoint
- enable_
connection_ boolpersistent - Enable connection keep-alive. Options: true: yes. false: no
- enable_
read_ stringonly - Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
- enable_
read_ stringwrite_ splitting - Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
- endpoint_
id string - Instance connection endpoint ID.
- endpoint_
name string - Instance connection endpoint name.
- endpoint_
type string - Endpoint type. Value: Custom, custom endpoint.
- idle_
connection_ boolreclaim - Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
- implicit_
trans_ boolsplit - Whether to enable transaction separation. Values: true: Yes. false: No.
- master_
node_ boolrouting - Whether to enable primary node routing. Values: true: Yes. false: No.
- master_
protector_ numbertimeout - Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
- multi_
statements_ stringmode - Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
- overload_
protection bool - Overload protection enabled. Values: true: yes. false: no
- read_
only_ stringnode_ distribution_ type - Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
- read_
only_ numbernode_ max_ delay_ time - Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
- read_
only_ list(object)node_ weights - read_
write_ stringmode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only
- auto
Add StringNew Nodes - When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
- List<String>
- Connection endpoint tag.
- connection
Mode String - Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
- connection
Pool StringType - Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
- description String
- Description of the connection endpoint
- enable
Connection BooleanPersistent - Enable connection keep-alive. Options: true: yes. false: no
- enable
Read StringOnly - Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
- enable
Read StringWrite Splitting - Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
- endpoint
Id String - Instance connection endpoint ID.
- endpoint
Name String - Instance connection endpoint name.
- endpoint
Type String - Endpoint type. Value: Custom, custom endpoint.
- idle
Connection BooleanReclaim - Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
- implicit
Trans BooleanSplit - Whether to enable transaction separation. Values: true: Yes. false: No.
- master
Node BooleanRouting - Whether to enable primary node routing. Values: true: Yes. false: No.
- master
Protector IntegerTimeout - Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
- multi
Statements StringMode - Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
- overload
Protection Boolean - Overload protection enabled. Values: true: yes. false: no
- read
Only StringNode Distribution Type - Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
- read
Only IntegerNode Max Delay Time - Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
- read
Only List<InstanceNode Weights Endpoint Read Only Node Weight> - read
Write StringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only
- auto
Add stringNew Nodes - When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
- string[]
- Connection endpoint tag.
- connection
Mode string - Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
- connection
Pool stringType - Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
- description string
- Description of the connection endpoint
- enable
Connection booleanPersistent - Enable connection keep-alive. Options: true: yes. false: no
- enable
Read stringOnly - Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
- enable
Read stringWrite Splitting - Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
- endpoint
Id string - Instance connection endpoint ID.
- endpoint
Name string - Instance connection endpoint name.
- endpoint
Type string - Endpoint type. Value: Custom, custom endpoint.
- idle
Connection booleanReclaim - Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
- implicit
Trans booleanSplit - Whether to enable transaction separation. Values: true: Yes. false: No.
- master
Node booleanRouting - Whether to enable primary node routing. Values: true: Yes. false: No.
- master
Protector numberTimeout - Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
- multi
Statements stringMode - Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
- overload
Protection boolean - Overload protection enabled. Values: true: yes. false: no
- read
Only stringNode Distribution Type - Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
- read
Only numberNode Max Delay Time - Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
- read
Only InstanceNode Weights Endpoint Read Only Node Weight[] - read
Write stringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only
- auto_
add_ strnew_ nodes - When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
- Sequence[str]
- Connection endpoint tag.
- connection_
mode str - Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
- connection_
pool_ strtype - Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
- description str
- Description of the connection endpoint
- enable_
connection_ boolpersistent - Enable connection keep-alive. Options: true: yes. false: no
- enable_
read_ stronly - Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
- enable_
read_ strwrite_ splitting - Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
- endpoint_
id str - Instance connection endpoint ID.
- endpoint_
name str - Instance connection endpoint name.
- endpoint_
type str - Endpoint type. Value: Custom, custom endpoint.
- idle_
connection_ boolreclaim - Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
- implicit_
trans_ boolsplit - Whether to enable transaction separation. Values: true: Yes. false: No.
- master_
node_ boolrouting - Whether to enable primary node routing. Values: true: Yes. false: No.
- master_
protector_ inttimeout - Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
- multi_
statements_ strmode - Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
- overload_
protection bool - Overload protection enabled. Values: true: yes. false: no
- read_
only_ strnode_ distribution_ type - Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
- read_
only_ intnode_ max_ delay_ time - Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
- read_
only_ Sequence[Instancenode_ weights Endpoint Read Only Node Weight] - read_
write_ strmode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only
- auto
Add StringNew Nodes - When the endpoint type is read/write or read-only, you can set whether new nodes join automatically. Values: Enable: auto join. Disable: do not auto join (default)
- List<String>
- Connection endpoint tag.
- connection
Mode String - Connection endpoint type. Values: Proxy: proxy endpoint. Direct: direct endpoint
- connection
Pool StringType - Connection pool type for proxy terminal. Values: Transaction: Transaction-level connection pool. Default value. Direct: Direct mode.
- description String
- Description of the connection endpoint
- enable
Connection BooleanPersistent - Enable connection keep-alive. Options: true: yes. false: no
- enable
Read StringOnly - Is global read-only enabled? Values: Enable: enabled. Disable: not enabled.
- enable
Read StringWrite Splitting - Whether to enable read/write separation. Values: Enable: Enabled. Disable: Not enabled.
- endpoint
Id String - Instance connection endpoint ID.
- endpoint
Name String - Instance connection endpoint name.
- endpoint
Type String - Endpoint type. Value: Custom, custom endpoint.
- idle
Connection BooleanReclaim - Whether the idle connection recycling feature is enabled. true: Enabled. false: Not enabled.
- implicit
Trans BooleanSplit - Whether to enable transaction separation. Values: true: Yes. false: No.
- master
Node BooleanRouting - Whether to enable primary node routing. Values: true: Yes. false: No.
- master
Protector NumberTimeout - Overload protection timeout. Value range: integer between 60 and 7200, in seconds.
- multi
Statements StringMode - Multi-Statements mode for proxy endpoints. Values: Strict: strict mode (default). Loose: loose mode
- overload
Protection Boolean - Overload protection enabled. Values: true: yes. false: no
- read
Only StringNode Distribution Type - Read weight allocation mode. This parameter is required when read/write splitting is enabled (set to true). For request parameters in the CreateDBEndpoint and ModifyDBEndpoint APIs, valid values are: LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling. For response parameters in the DescribeDBInstanceDetail API, valid values are: Default: automatic allocation based on specification weights. Custom: custom weight allocation. RoundRobin: round-robin scheduling. LoadSchedule: load scheduling. RoundRobinCustom: custom weighted round-robin scheduling. RoundRobinAuto: automatic weighted round-robin scheduling.
- read
Only NumberNode Max Delay Time - Read-only node latency threshold. Value range: 1~3600, default is 30, unit: seconds.
- read
Only List<Property Map>Node Weights - read
Write StringMode - Read/write mode: ReadWrite: read/write. ReadOnly: read-only
InstanceEndpointReadOnlyNodeWeight, InstanceEndpointReadOnlyNodeWeightArgs
InstanceMaintenanceWindow, InstanceMaintenanceWindowArgs
- Day
Kind string - Maintenance cycle granularity. Value: Week.
- Day
Of List<string>Weeks - Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
- Maintenance
Time string - Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
- Day
Kind string - Maintenance cycle granularity. Value: Week.
- Day
Of []stringWeeks - Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
- Maintenance
Time string - Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
- day_
kind string - Maintenance cycle granularity. Value: Week.
- day_
of_ list(string)weeks - Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
- maintenance_
time string - Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
- day
Kind String - Maintenance cycle granularity. Value: Week.
- day
Of List<String>Weeks - Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
- maintenance
Time String - Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
- day
Kind string - Maintenance cycle granularity. Value: Week.
- day
Of string[]Weeks - Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
- maintenance
Time string - Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
- day_
kind str - Maintenance cycle granularity. Value: Week.
- day_
of_ Sequence[str]weeks - Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
- maintenance_
time str - Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
- day
Kind String - Maintenance cycle granularity. Value: Week.
- day
Of List<String>Weeks - Specify the days of the week when the maintenance window is active. Multiple selections allowed. Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.
- maintenance
Time String - Instance maintenance window. Format: HH:mmZ-HH:mmZ (UTC). Note: Specifies the time period during which maintenance can be performed.
InstanceNode, InstanceNodeArgs
InstanceProxyDetail, InstanceProxyDetailArgs
- Db
Proxy stringStatus - Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
- Proxy
Resource Volcengine.Info Instance Proxy Detail Proxy Resource Info - Resource information for the instance's database proxy service
- Db
Proxy stringStatus - Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
- Proxy
Resource InstanceInfo Proxy Detail Proxy Resource Info - Resource information for the instance's database proxy service
- db_
proxy_ stringstatus - Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
- proxy_
resource_ objectinfo - Resource information for the instance's database proxy service
- db
Proxy StringStatus - Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
- proxy
Resource InstanceInfo Proxy Detail Proxy Resource Info - Resource information for the instance's database proxy service
- db
Proxy stringStatus - Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
- proxy
Resource InstanceInfo Proxy Detail Proxy Resource Info - Resource information for the instance's database proxy service
- db_
proxy_ strstatus - Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
- proxy_
resource_ Instanceinfo Proxy Detail Proxy Resource Info - Resource information for the instance's database proxy service
- db
Proxy StringStatus - Status of the instance database proxy feature. Values: Creating: proxy enabling. Running: proxy running. Shutdown: proxy disabled. Deleting: proxy disabling
- proxy
Resource Property MapInfo - Resource information for the instance's database proxy service
InstanceProxyDetailProxyResourceInfo, InstanceProxyDetailProxyResourceInfoArgs
- Current
Proxy intCpu Num - Current number of cores for the instance database proxy service
- Max
Proxy intCpu Num - Maximum number of cores configurable for database proxy service.
- Min
Proxy intCpu Num - Minimum number of CPU cores configurable for the database proxy service
- Current
Proxy intCpu Num - Current number of cores for the instance database proxy service
- Max
Proxy intCpu Num - Maximum number of cores configurable for database proxy service.
- Min
Proxy intCpu Num - Minimum number of CPU cores configurable for the database proxy service
- current_
proxy_ numbercpu_ num - Current number of cores for the instance database proxy service
- max_
proxy_ numbercpu_ num - Maximum number of cores configurable for database proxy service.
- min_
proxy_ numbercpu_ num - Minimum number of CPU cores configurable for the database proxy service
- current
Proxy IntegerCpu Num - Current number of cores for the instance database proxy service
- max
Proxy IntegerCpu Num - Maximum number of cores configurable for database proxy service.
- min
Proxy IntegerCpu Num - Minimum number of CPU cores configurable for the database proxy service
- current
Proxy numberCpu Num - Current number of cores for the instance database proxy service
- max
Proxy numberCpu Num - Maximum number of cores configurable for database proxy service.
- min
Proxy numberCpu Num - Minimum number of CPU cores configurable for the database proxy service
- current_
proxy_ intcpu_ num - Current number of cores for the instance database proxy service
- max_
proxy_ intcpu_ num - Maximum number of cores configurable for database proxy service.
- min_
proxy_ intcpu_ num - Minimum number of CPU cores configurable for the database proxy service
- current
Proxy NumberCpu Num - Current number of cores for the instance database proxy service
- max
Proxy NumberCpu Num - Maximum number of cores configurable for database proxy service.
- min
Proxy NumberCpu Num - Minimum number of CPU cores configurable for the database proxy service
InstanceTag, InstanceTagArgs
Import
$ pulumi import volcenginecc:rdsmysql/instance:Instance example "instance_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
published on Thursday, May 14, 2026 by Volcengine
