数据结构

AccountType

String

否

Normal

账号类型，取值范围：

• Super：高权限账号。
• Normal：普通账号。

AccountStatus

String

否

Available

账号状态：取值为：

• Unavailable：不可用。
• Available：可用。

AccountPrivilege

String

是

ReadWrite

授权数据库权限类型，当数据库引擎为 MySQL 时，取值范围：

• ReadWrite：读写权限。
• ReadOnly：只读权限。
• DDLOnly：仅 DDL 权限。
• DMLOnly：仅 DML 权限。
• Custom：自定义权限。

AccountPrivilegeDetail

String

否

SELECT,INSERT,UPDATE

数据库权限字符串，
作为请求参数时，当 AccountPrivilege 为 Custom 时必填，取值：

• SELECT
• INSERT
• UPDATE
• DELETE
• CREATE
• DROP
• REFERENCES
• INDEX
• ALTER
• CREATE TEMPORARY TABLES
• LOCK TABLES
• EXECUTE
• CREATE VIEW
• SHOW VIEW
• CREATE ROUTINE
• ALTER ROUTINE
• EVENT
• TRIGGER
  作为返回结果时，不管 AccountPrivilege 是不是 Custom，都展示 AccountPrivilege 的详细权限。

DNSVisibility

Boolean

否

false

• false：火山引擎私网解析（默认）。
• true：火山引擎私网以及公网解析。

NetworkType

String

否

Private

网络地址类型，取值为：

• Private：私网地址。
• Public：公网地址。

AllowListCategory

String

否

Default

白名单分类。取值：

• Ordinary：普通白名单。
• Default：默认白名单。

BackupStatus

String

否

Success

备份状态，取值：

• Success：成功。
• Failed：失败。
• Running：执行中。

BackupType

String

否

Full

备份类型，取值：

• Full：全量备份。
• Increment：增量备份。

CreateType

String

否

System

创建类型，取值：

• System：系统。
• User：用户。

DBTableInfos

Array of DBTableInfoObject

否

[
{
"Database": "database1",
"Tables":
[
"table1"
]
}
]

备份集中包含的数据库表信息，最多可包括 1 万张表。关于 DBTableInfoObject 的更多详情，请参见数据结构。

DownloadStatus

String

否

NotDownload

下载状态。取值：

• NotDownload：未下载。
• Success：已下载。
• Failed：下载失败。
• Running：下载中。

IsExpired

Boolean

否

false

备份是否过期。取值：

• true：已过期。
• false：未过期。

ErrorMessage

String

否

备份失败的错误信息。

InstanceStatus

String

否

Running

实例状态，取值：

• Creating：创建中。
• Running：运行中。
• Deleting：删除中。
• Restarting：重启中。
• Updating：变更中。
• Restoring：恢复中。
• Error：错误。
• Upgrading：升级中。
• Recycled：已回收。
• MasterChanging：主节点切换中。
• TDEUpdating：TDE 修改中。
• Closed：关停。
• Maintaining：维护中。
• CreateFailed：创建失败。
• Closing：关停中。
• SSLUpdating：SSL 变更中。
• AllowListMaintaining：白名单变更中。
• Unknown：未知。
• ProxyCreating：代理开启中。
• ProxyDeleting：代理关闭中。

DBEngineVersion

String

否

MySQL_8_0

• MySQL_5_7：MySQL 5.7
• MySQL_8_0：MySQL 8.0

兼容版本。取值：

LowerCaseTableNames

String

否

true

表名是否区分大小写，默认取值为 true。取值：

• false：表名被存储成固定且表名称大小写敏感。
• true：表名将被存储成小写且表名称大小写不敏感。

DataSyncMode

String

否

SemiSync

数据同步方式，取值：

• SemiSync：半同步。
• Async：异步。

Tags

Array of TagObject

否

[
{
"Key": "key1",
"Value": "value1"
}
]

绑定的标签键和标签值数组对象。关于 Tags 的更多详情，请参见数据结构。

BackupStatus

String

否

Success

备份状态。取值：

• Success：备份成功。
• Failed：备份失败。
• Running：备份中。

DownloadStatus

String

否

NotDownload

下载状态。取值：

• NotDownload：未下载。
• Success：已下载。
• Failed：下载失败。
• Running：下载中。

ChargeType

String

否

PostPaid

付费类型。取值：

• PostPaid：按量付费（后付费）。
• PrePaid：包年包月（预付费）。

AutoRenew

Boolean

否

true

预付费场景下是否自动续费。

• true：到期自动续费。
• false：到期不自动续费。

PeriodUnit

String

否

Month

预付费场景下的购买周期。

• Month：购买周期为月。
• Year：购买周期为年。

ChargeStatus

String

否

Normal

付费状态。取值：

• Normal：正常。
• Overdue：欠费。
• Unpaid：等待支付。

ChargeType

String

是

PostPaid

付费类型。取值：

• PostPaid：按量付费（后付费）。
• PrePaid：包年包月（预付费）。

AutoRenew

Boolean

否

true

预付费场景下是否到期自动续费。

• true：到期自动续费。
• false：到期不自动续费。默认。

PeriodUnit

String

否

Month

预付费场景下的购买周期。

• Month：购买周期为月。默认。
• Year：购买周期为年。

Period

Integer

否

1

预付费场景下的购买时长。默认值为 1。

Number

Integer

否

1

实例购买数量。默认值为 1。

ChargeItemType

String

否

Primary

付费项名称，取值：

• Primary：主节点。
• Secondary：备节点。
• ReadOnly：只读节点
• Storage： 物理存储空间。

ChargeItemKey

String

否

rds.mysql.d1.1c2g_cn-guangzhou

如果 ChargeItemType 取值为 Primary、Secondary 或 ReadOnly，则该参数返回实例的规格，如 rds.mysql.d1.1c2g_cn-guangzhou。

如果 ChargeItemType 取值为 Storage，该参数返回存储的 Key。

ChargeItemValue

Integer

否

100

如果 ChargeItemType 取值为 Primary、Secondary 或 ReadOnly，则该参数返回实例节点个数，均为 1。

如果 ChargeItemType 取值为 Storage，该参数返回单个节点存储空间大小。

Allowed

Boolean

否

true

是否允许切换 proxy 状态。取值：

• true：允许切换 proxy。
• false：不允许切换 proxy。

DBStatus

String

否

Available

数据库状态。取值为：

• Unavailable：不可用。
• Available：可用。

DatabasePrivileges

Array of DatabasePrivilegeObject

否

[
{
"AccountName": "user1",
"AccountPrivilege":"ReadWrite"
}
]

数据库账号权限列表。更多关于 DatabasePrivileges 的详细信息，请参见数据结构。

Host

String

否

%

指定的数据库账号可以访问数据库的 IP 地址。默认值为 %。

• 若指定 Host 为 %，允许该账号从任意 IP 地址访问数据库。
• 若指定 Host 为 192.10.10.%，则表示该账号可从 192.10.10.0~192.10.10.255 之间的 IP 地址访问数据库。
• 指定的 Host 需要添加在实例所绑定的白名单中，

AccountPrivilege

String

是

ReadWrite

授予的账号权限类型，取值：

• ReadWrite：读写权限。
• ReadOnly：只读权限。
• DDLOnly：仅 DDL 权限。
• DMLOnly：仅 DML 权限。
• Custom：自定义权限。

AccountPrivilegeDetail

String

否

SELECT,INSERT,UPDATE

数据库权限字符串。
作为请求参数时，当 AccountPrivilege 取值为 Custom 时必填，取值：

• SELECT
• INSERT
• UPDATE
• DELETE
• CREATE
• DROP
• REFERENCES
• INDEX
• ALTER
• CREATE TEMPORARY TABLES
• LOCK TABLES
• EXECUTE
• CREATE VIEW
• SHOW VIEW
• CREATE ROUTINE
• ALTER ROUTINE
• EVENT
• TRIGGER
  作为返回结果时，不管 AccountPrivilege 的值是否为 Custom，都会展示 AccountPrivilege 的详细权限。

EndpointType

String

否

Cluster

终端类型：

• Cluster：默认终端（默认创建）。
• Primary：主节点终端。
• Custom：自定义终端。

ReadWriteMode

String

否

ReadOnly

读写模式：

• ReadWrite：读写。
• ReadOnly：只读。

Addresses

Array of AddressObject

否

[
{
"DNSVisibility":FALSE,
"Domain":"mysql38f7a19b****.rds.ivolces.com",
"EipId":"",
"IPAddress":"192.168.24.114",
"NetworkType":"Private",
"Port":"3306",
"SubnetId":"subnet-2bzr8zdx5o8ao2dx0efq4****"
}
]

地址列表。更多关于 Addresses 的详细信息，请参见数据结构。

ReadOnlyNodeWeight

Array of NodeWeightObject

否

[
{
"NodeType" : "Primary",
"Weight" : 100
},
{
"NodeId" : "mysql-050b3e08****-2",
"Weight" : 100
},
{
"NodeId" : "mysql-050b3e08****-3",
"Weight" : 200
}
]

连接终端配置的节点列表及对应的只读权重。更多关于 ReadOnlyNodeWeight 的信息，请参见数据结构。

AutoAddNewNodes

String

否

Enable

当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：

• Enable：自动加入
• Disable：不自动加入（默认）。

EnableReadWriteSplitting

String

否

Enable

是否已开启读写分离，取值：

• Enable：开启。
• Disable：未开启。

EnableReadOnly

String

否

Enable

是否已开启全局只读，取值：

• Enable：开启。
• Disable：未开启。

HAChangeType

String

否

TakeOver

主备切换类型。

• TakeOver：用户手动切换主节点。
• FailOver：实例故障切换主节点。

Enable

Boolean

否

false

是否开启。取值：

• true：开启。
• false：关闭。

Support

Boolean

否

true

是否支持该功能。取值：

• true：支持。
• false：不支持。

InstanceStatus

String

否

Running

实例状态，取值如下：

• Running：运行中。
• Creating：创建中。
• Deleting：删除中。
• Restarting：重启中。
• Restoring：恢复中。
• Updating：变更中。
• Upgrading：升级中。
• MasterChanging：主备切换中。
• Error：错误。

DBEngineVersion

String

否

MySQL_8_0

兼容版本。取值：

• MySQL_5_7：MySQL 5.7
• MySQL_8_0：MySQL 8.0

LowerCaseTableNames

String

否

1

表名是否区分大小写，默认取值为 1。取值范围：

• 0：表名被存储成固定且表名称大小写敏感。
• 1：表名将被存储成小写且表名称大小写不敏感。

AddressObject

Array of AddressObject

否

[
{
"Domain":"mysql77c004acdd3c.rds.ivolces.com",
"EipId":"",
"IPAddress":"",
"NetworkType":"Private",
"Port":"3306",
"SubnetId":""
}
]

默认终端的连接信息。更多关于 Addresses 的详细信息，请参见数据结构。

MaintenanceWindow

MaintenanceWindowObject

否

{
"DayKind": "Week",
"DayOfMonth": [],
"DayOfWeek": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"MaintenanceTime": "18:00Z-21:59Z"
}

可维护窗口。可维护窗口。更多关于 MaintenanceWindow 的信息，请参见数据结构。

Restart

Boolean

否

false

修改参数后是否需要重启实例。

• true：需要重启。
• false：不需重启。

DBEngineVersion

String

否

MySQL_8_0

兼容版本。取值：

• MySQL_5_7： MySQL 5.7 版本
• MySQL_8_0： MySQL 8.0 版本。

SpecFamily

String

否

General

实例规格类型。取值：

• General，通用型规格。
• Shared：共享型规格。

SpecStatus

String

否

Normal

规格所在可用区的状态，包含以下状态：

• Normal：在售。
• Soldout：售罄。

DayKind

String

否

Week

可维护周期粒度，取值：

• Week：周。
• Month：月。

NodeType

String

是

Primary

节点类型，取值：

• Primary：主节点。
• Secondary：备节点。
• ReadOnly：只读节点。

NodeOperateType

String

否

Modify

操作类型。创建实例时无需传入，修改实例配置时需要传入。取值范围：

• Create：增加。
• Delete：删除。
• Modify：修改。

NodeType

String

否

Primary

节点类型。取值：

• Primary：主节点。
• Secondary：备节点。
• ReadOnly：只读节点。

NodeStatus

String

否

Running

节点状态，取值：

• Running：运行中。
• Creating：创建中。
• Deleting：删除中。
• Restarting：重启中。
• Restoring：恢复中。
• Updating：变更中。
• Upgrading：升级中。
• Error：错误。

Weight

Integer

否

100

节点的读权重，以 100 递增，最大值为 10000。

Status

String

否

Applied

状态。取值：

• Applied：已生效。
• Invalid：未生效。
• Syncing：正在应用，尚未生效。

TemplateParams

Array of InstanceParamObject

否

[
{
"DefaultValue": "1",
"Description": "Auto-increment columns are incremented by this.",
"ExpectValue": "",
"Name": "auto_increment_increment",
"Restart": false,
"RunningValue": "1",
"ValueRange": "[1-65535]"
}
]

模板所包含的参数。关于 TemplateParams 的更多详细信息，请参见数据结构。

TemplateSource

String

否

System

参数模板的类型。取值：

• System：系统模板。
• User：用户模板。

TemplateTypeVersion

String

否

MySQL_5_7

参数模板数据库版本，取值范围：

• MySQL_5_7：MySQL 5.7 版本。
• MySQL_8_0：MySQL 8.0 版本。

IsUrgent

Boolean

否

true

是否为紧急事件。取值：

• true：是。
• false：否。

Status

String

否

Waiting

事件状态。

• Waiting：待执行
• Initiated：已发起
• Canceled：已取消。
• Succeed：成功。
• Fail：失败。

Type

String

否

CurDataSize

当前阶段

• CostTime：当前阶段的耗时。
• CurDataSize：当前导入的数据量。
• CurBinlog：当前回放的 Binlog 文件数量。
• RemainCostTime：剩余的耗时。
• RemainDataSize：剩余导入的数据量。
• RemainBinlog：剩余回放的 Binlog 文件数量。

Unit

String

否

Bytes

单位。取值：

• MS：毫秒。
• Bytes：字节。
• Files：（文件）个数。

BindMode

String

是

AssociateEcsIp

关联安全组的模式。取值：

• IngressDirectionIp：入方向 IP。
• AssociateEcsIp：关联 ECSIP。

SecurityGroupName

String

否

测试安全组

安全组名称。

NewDBName

String

否

testdb2

DB 新名称。
如果只是恢复表，其值可以与 DBName 一样。

Table

Array of TableObject

否

[
{
"TableName" : "table1",
"NewTableName" : "table2"
}
]

指定恢复的 DB 内的表，当 Table 为空时全库恢复。更多关于 Table 的信息，请参见数据结构。

Value

String

否

ExampleValue

用于查询筛选的标签值。

ConfigInfos

Array of ConfigInfoObject

否

[
{
"ConfigInfoKey": "AllowListIPs",
"ConfigInfoValue": ["127.0.0.1"]
}
]

配置信息。关于 ConfigInfos 的更多详细信息，请参见数据结构。

RelatedInstanceInfos

RelatedInstanceInfoObject

否

{
"InstanceID": "mysql-5bde124c****"
}

任务相关的实例。关于 RelatedInstanceInfos 的更多详细信息，请参见 数据结构。

TaskCategory

String

否

任务分类。取值：

• BackupRecoveryManagement：备份恢复管理。
• DatabaseAdminManagement：数据库管理。
• DatabaseProxy：数据库代理。
• HighAvailability：高可用。
• InstanceAttribute：实例属性。
• InstanceManagement：实例管理。
• MonitoringPerformance：监控和性能。
• NetworkManagement：网络管理。
• SecurityManagement：安全管理。
• SystemMaintainManagement：系统运维管理。
• VersionUpgrade：版本升级。
• Other：其他。

TaskProgress

Array of TaskProgressObject

否

[
{
"Name": "InstanceInitialization",
"StepStatus": "Success"
},
{
"Name": "InstanceRecoveryPreparation",
"StepStatus": "Failed"
},
{
"Name": "DataBackupImport",
"StepStatus": "UnExecuted"
},
{
"Name": "LogBackupBinlogAdd",
"StepStatus": "UnExecuted"
},
{
"Name": "TaskSuccessful",
"StepStatus": "UnExecuted"
}
]

进度详情。更多关于 TaskProgress 的详细信息，请参见数据结构。

TaskSource

String

否

任务来源。取值：

• User：租户。
• System：系统。
• SystemUser：内部运维。
• UserMaintain：系统/运维管理员发起的、租户可见的维护操作。

TaskStatus

String

否

Success

任务状态，取值：

• Running：执行中。
• Success：执行成功。
• WaitSwitch：等待执行。
• Failed：执行失败。
• Timeout：执行超时。
• Canceled：取消。

Name

String

否

InstanceInitialization

步骤名称。取值：

• InstanceInitialization：任务初始化。
• InstanceRecoveryPreparation 实例恢复准备。
• DataBackupImport：冷备导入。
• LogBackupBinlogAdd：Binlog 回放。
• TaskSuccessful：任务成功。

StepStatus

String

否

Success

步骤状态。取值：

• Running：运行中。
• Success：成功。
• Failed：失败。
• Unexecuted：未执行。

StepExtraInfo

Array of StepExtraInfoObject

否

[
{
"Type": "CurDataSize",
"Unit": "Bytes",
"Value": 7579256
},
{
"Type": "RemainDataSize",
"Unit": "Bytes",
"Value": 0
}
]

步骤的具体信息。关于 StepExtraInfo 的更多详细信息，请参见数据结构。