You need to enable JavaScript to run this app.
导航
数据结构
最近更新时间:2024.05.28 11:14:22首次发布时间:2022.04.12 19:06:09

本文汇总云数据库 veDB MySQL 版的 API 接口中使用的数据结构定义详情。

AccountObject

账号列表信息。被 DescribeDBAccounts 接口引用。

名称类型示例值描述
AccountNameStringtestuser账号名称。

AccountType

String

Normal

账号类型:

  • Super:高权限账号。
  • Normal:普通账号。
AccountPrivilegesArray of AccountPrivilegeObject请参见返回示例账号的权限信息。详细信息,请参见 AccountPrivilegeObject

AccountPrivilegeObject

账号的权限信息。被以下接口和数据结构引用:

名称类型是否必选示例值描述
DBNameStringdb1需授权的数据库名称。

AccountPrivilege

String

ReadWrite

授权数据库权限类型:

  • ReadWrite:读写权限。
  • ReadOnly:只读权限。
  • DDLOnly:仅 DDL 权限。
  • DMLOnly:仅 DML 权限。

AddressesObject

地址信息。被 EndpointObject 数据结构引用。

名称类型示例值描述
DNSVisibilityBooleanfalse解析方式。当前返回值只能为 false(火山引擎私网解析)。
DomainStringvedbm-fkfb7ag0****.master.mysql.vedb.ivolces.com实例内网访问域名。
IPAddressString100...***IP 地址。

NetworkType

String

Private

网络类型:

  • Private:私有网络 VPC。
  • Public:公网访问。
PortString3306实例内网访问端口。

SubnetId

String

subnet-3tfam28a****

子网 ID。子网必须属于所选的可用区。

说明

子网是私有网络内的 IP 地址块,私有网络中的所有云资源都必须部署在子网内,子网为云资源分配私网 IP 地址。

EipIdStringeip-13g56dc5u2uio3n6nu4kb****公网 ID。

AllowListObject

白名单列表信息。被 DescribeAllowLists 接口引用。

名称类型示例值描述
AllowListIdStringacl-31f52387922a40a7a60ff21365f6****白名单 ID。
AllowListNameStringbyte_ndb_system_inte****_*白名单名称。
AllowListDescStringtest白名单的备注。
AllowListTypeStringIPv4白名单内的 IP 地址类型。当前仅支持指定为 IPv4,表示 IPv4 地址。
AllowListIPNumInteger3包含 IP 或 IP 段的总数量。
AssociatedInstanceNumInteger0绑定的全部实例数量。

AssociatedInstanceObject

已绑定当前白名单的实例信息。被 DescribeAllowListDetail 接口引用。

名称类型示例值描述
InstanceIdStringvedbm-ca12cbqv****实例 ID。
InstanceNameStringtest实例名称。
VPCStringvpc-3tgjebmlgq4e8i4m****VPC ID。

BackupObject

备份列表信息。被 DescribeBackups 接口引用。

名称类型示例值描述
BackupIdStringsnap-64b6****-7837备份 ID。

BackupStatus

String

Success

备份状态,取值:

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

CreateType

String

Physical

创建类型,取值:

  • System:系统,即自动备份。
  • User:用户,即手动备份。
BackupMethodStringPhysical备份方式,目前仅支持物理备份,取值为 Physical
BackupTypeStringFull备份类型,目前仅支持全量备份,取值为 Full
BackupFileSizeInteger437备份文件大小,单位为 KiB。
BackupStartTimeString2023-07-19T06:20:22Z备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
BackupEndTimeString2023-07-19T06:31:28Z备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
ConsistentTimeString2023-07-19T06:20:22Z一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

ChargeDetailObject

计费的详细信息。被接口 DescribeDBInstanceDetail 和数据结构 InstanceObject 引用。

名称类型示例值描述

ChargeType

String

PostPaid

计算计费类型,取值:

  • PostPaid:按量计费(后付费)。
  • PrePaid:包年包月(预付费)。

ChargeStatus

String

Normal

付费状态:

  • Normal:正常。
  • Overdue:欠费。
OverdueReclaimTimeString2022-09-27T06:09:20Z欠费关停时预计释放时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
OverdueTimeString2022-10-04T07:50:22Z欠费关停时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

AutoRenew

Boolean

true

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

  • true:自动续费。
  • false:不自动续费。
ChargeStartTimeString2023-09-22T08:08:35Z计费开始的时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。
ChargeEndTimeString2023-09-22T08:08:35Z预付费场景下计费到期的时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

DatabaseObject

数据库列表信息。被 DescribeDatabases 接口引用。

名称类型示例值描述
DBNameStringtestdb数据库名称。

CharacterSetName

String

utf8

数据库字符集:

  • utf8mb4(默认)
  • utf8
  • latin1
  • ascii
DatabasesPrivilegesArray of DatabasesprivilegeObject请参见返回示例数据库的权限信息。详细信息,请参见 DatabasesprivilegeObject

DatabasesPrivilegeObject

数据库权限信息。被接口 CreateDatabase 和数据结构 DatabaseObject 引用。

名称类型示例值描述
AccountNameStringuser1需授权的账号名称。

AccountPrivilege

String

ReadWrite

授权数据库权限类型:

  • ReadWrite:读写权限。
  • ReadOnly:只读权限。
  • DDLOnly:仅 DDL 权限。
  • DMLOnly:仅 DML 权限。

DBTableInfoObject

实例可恢复的库表信息,被 DescribeRecoverableTables 接口引用。

名称类型示例值描述
DatabaseStringtest_db数据库名称。
TablesArray of String["table1","table2","table3"]指定数据库下的表信息。

EndpointObject

实例的连接信息。被 DescribeDBInstanceDetailDescribeDBEndpoint 接口引用。

名称类型示例值描述
AddressesArray of AddressesObject请参见返回示例地址信息。详细信息,请参见 AddressesObject

AutoAddNewNodes

Boolean

true

是否允许自动加入新节点,取值:

  • true:是。
  • false:否(默认)。
DescriptionString主地址地址描述。
EndpointIdStringvedbm-h441603c68aaa****实例连接终端 ID。
EndpointNameString默认终端实例连接终端名称。

EndpointType

String

Cluster

连接终端类型,取值:

  • Cluster:默认终端。
  • Primary:主节点终端。
  • Custom:自定义终端。

MasterAcceptReadRequests

Boolean

true

主节点是否接受读请求。仅对读写模式的连接终端有效。

  • true:是。
  • false:否。
NodeIdsArray of String["vedbm-r3sar8zi****-0", "vedbm-r3sar8zi****-1"]连接终端配置的节点列表。

ReadWriteMode

String

ReadWrite

连接终端的读写模式,取值:

  • ReadWrite: 读写。
  • ReadOnly: 只读。

DistributedTransaction

Boolean

true

是否开启事务拆分,仅对读写模式的连接终端有效。取值:

  • true:是。
  • false:否。

ConsistLevel

String

Session

一致性级别,仅对读写模式的连接终端有效。取值:

  • Eventual:最终一致性。
  • Session:会话一致性。
  • Global:全局一致性。

ConsistTimeout

Integer

10000

延迟很大时,只读节点同步最新数据的超时时间,单位为 us,取值范围为 1us~100000000us。

说明

ConsistLevel 取值为 GlobalSession 时,该参数才生效。

ConsistTimeoutAction

Integer

ReadMaster

只读节点同步数据超时后的超时策略,支持以下两种策略:

  • ReturnError:返回 SQL 报错(wait replication complete timeout, please retry)。
  • ReadMaster:发送请求到主节点(默认)。

说明

ConsistLevel 取值为 GlobalSession 时,该参数才生效。

InstanceObject

实例列表的相关信息。被 DescribeDBInstances 接口引用。

名称类型示例值描述
InstanceIdStringvedbm-d4mx2akm****实例 ID。
InstanceNameStringtest实例名称。

InstanceStatus

String

Running

实例状态,取值:

  • WaitingPaid:等待支付。
  • Running:运行中。
  • Creating:创建中。
  • Scaling:变更配置中。
  • Restarting:重启中。
  • Restoring:恢复中。
  • Upgrading:升级版本中。
  • PrimaryChanging:主备切换中。
  • Unavailable:不可用。
  • Deleting:删除中。
  • Deleted:已释放。
  • CreateFailed:创建失败。
  • Closing:关停中。
  • Expired:到期。
  • Owing:欠费中。
  • Resuming:恢复中。
  • AllowListMaintaining:白名单维护中。
CreateTimeString2022-06-21T07:54:05Z实例的创建时间,格式:YYYY-MM-DDTHH:MM:SSZ(UTC 时间)。
DBEngineVersionStringMySQL_8_0数据库引擎版本,取值固定为 MySQL_8_0

ProjectName

String

vedb_project

实例所属的项目名称。

说明

项目是一个虚拟的概念,包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理,并且控制项目内用户和角色管理这些资源的权限。更多详情,请参见资源管理

ZoneIdsStringcn-beijing-a实例所属的可用区。
VpcIdStringvpc-3ajzohyfaru9s340jz1rp****私有网络(VPC)ID。
TimeZoneStringUTC +08:00实例的时区。国内所有地域默认时区为 UTC +08:00

StorageChargeType

String

PostPaid

存储计费类型,取值:

  • PostPaid:按量计费(后付费)。
  • PrePaid:包年包月(预付费)。
PrePaidStorageInGBFloat50预付费的存储总容量大小,单位 GiB。
StorageUsedGiBFloat0.44已使用存储空间大小,单位 GiB。
ChargeDetailChargeDetailObject请参见返回示例计费信息。详细信息,请参见 ChargeDetailObject
RegionIdStringcn-beijing地域 ID。
SubnetIdStringsubnet-1g15j13jtzgu88ibuxwqp****子网 ID。子网必须属于所选的可用区。
NodesArray of NodeObject请参见返回示例实例的规格。详细信息,请参见 NodeObject
TagsArray of TagObject请参见返回示例实例绑定的标签键和标签值数组对象。关于 Tags 的更多详情,请参见 TagObject

InstanceDetailObject

实例的基本信息。被 DescribeDBInstanceDetail 接口引用。

名称类型示例值描述
InstanceIdStringvedbm-h441603c68aaa****实例 ID。
InstanceNameStringtest实例名称。

InstanceStatus

String

Running

实例状态,取值:

  • WaitingPaid:等待支付。
  • Running:运行中。
  • Creating:创建中。
  • Scaling:变更配置中。
  • Restarting:重启中。
  • Restoring:恢复中。
  • Upgrading:升级版本中。
  • PrimaryChanging:主备切换中。
  • Unavailable:不可用。
  • Deleting:删除中。
  • Deleted:已释放。
  • CreateFailed:创建失败。
  • Closing:关停中。
  • Expired:到期。
  • Owing:欠费中。
  • Resuming:恢复中。
  • AllowListMaintaining:白名单维护中。

RegionId

String

cn-beijing

地域 ID。

说明

您可以调用 DescribeRegions 接口查询可创建实例的地域信息,包括地域 ID。

ZoneIds

String

cn-beijing-a

可用区 ID。

说明

可调用 DescribeAvailabilityZones 接口查询 veDB MySQL 实例支持的可用区资源。

DBEngineVersionStringMySQL_8_0数据库引擎版本,取值固定为 MySQL_8_0

SpecFamily

String

Exclusive

实例规格类型,取值:

  • General:通用型。
  • Exclusive:独享型。
CreateTimeString2022-06-21T07:54:05Z实例的创建时间,格式 YYYY-MM-DDTHH:MM:SSZ(UTC 时间)。

StorageChargeType

String

PostPaid

存储计费类型,取值:

  • PostPaid:按量计费(后付费)。
  • PrePaid:包年包月(预付费)。
PrePaidStorageInGBFloat50预付费的存储总容量大小,单位 GiB。
StorageUsedGiBFloat0.23已使用存储空间大小,单位 GiB。
VpcIdStringvpc-3cikbvy7jw0e86c6rrt8i****私有网络(VPC) ID。

SubnetId

String

subnet-1g0d851lg1s748ibuxxvg****

子网 ID。子网必须属于所选的可用区。

说明

子网是私有网络内的 IP 地址块,私有网络中的所有云资源都必须部署在子网内,子网为云资源分配私网 IP 地址。

TimeZoneStringUTC +08:00实例的时区。国内所有地域默认时区为 UTC +08:00

ProjectName

String

vedb_project

实例所属的项目名称。

说明

项目是一个虚拟的概念,包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理,并且控制项目内用户和角色管理这些资源的权限。更多详情,请参见资源管理

LowerCaseTableNames

String

1

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

  • 0:表名称大小写敏感,后端根据实际表名存储。
  • 1:(默认)表名称不区分大小写,后端存储时将表名称统一为小写字母。
InstanceStructuresArray of InstanceStructureObject请参见返回示例实例的部署架构信息。详细信息请参见 InstanceStructureObject

InstanceStructureObject

实例的架构信息。被数据结构 InstanceDetailObject 引用。

名称类型示例值描述
SubInstanceTypeStringPrimary实例类型,取固定值 Primary(主实例)。
ZoneIdsStringcn-beijing-b可用区 ID。
NodesArray of NodeObject请参见返回示例实例的规格。详细信息,请参见 NodeObject

NodeObject

实例规格的详细信息。被接口 DescribeDBInstanceDetail 和数据结构 InstanceObject 引用。

名称类型示例值描述
NodeIdStringvedbm-h441603c68aaa****-**节点 ID。
ZoneIdStringcn-beijing-a可用区 ID。

NodeType

String

Primary

节点类型。取值:

  • Primary:主节点。
  • ReadOnly:只读节点。
vCPUInteger8CPU 大小,例如当取值为 1 时表示 CPU 大小为 1U。
MemoryInteger32内存大小,单位为 GiB。

NodeSpec

String

vedb.mysql.x4.xlarge

实例的节点规格。

说明

关于实例节点规格的详细信息,请参见产品规格

NodeSpecObject

规格代码列表信息。被 DescribeDBInstanceSpecs 接口引用。

名称类型示例值描述
ConnectionInteger400最大连接数。
MemoryInteger8内存大小,单位为 GiB。
NodeSpecStringvedb.mysql.x4.xlarge实例规格代码。
PrePaidMinStorageInteger50存储空间下限,单位为 GiB。
PrePaidMaxStorageInteger2000000存储空间上限,单位为 GiB。

SpecFamily

String

General

实例规格类型,取值:

  • General:通用型。
  • Exclusive:独享型。
vCPUInteger8CPU 大小。例如:1 表示 1vCPU。

RegionObject

地域列表的相关信息。被 DescribeRegions 接口引用。

名称类型示例值描述
RegionIdStringcn-beijing地域 ID。
RegionNameString华北 2(北京)地域名称。

RecoverableTimeInfoObject

实例可恢复的时间范围。被 DescribeRecoverableTime 接口引用。

名称类型示例值描述
EarliestRecoverableTimeString2023-07-14T03:47:31Z实例最早可恢复的时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间),为空表示实例目前不可恢复。
LatestRecoverableTimeString2023-07-14T03:47:31Z实例最晚可恢复的时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间),为空表示实例目前不可恢复。

TagObject

实例绑定的标签键和标签值数组对象。被以下接口引用。

名称类型是否必选示例值描述

Key

String

department

实例绑定的标签键。

Value

String

game

实例绑定的标签值。

TagFilterObject

用于查询筛选的标签键值对数组对象。被 DescribeDBInstances 接口引用。

名称类型是否必选示例值描述
KeyStringdepartment用于查询筛选的标签键。

Value

String

game

用于查询筛选的标签值。

说明

若绑定标签时,设置了标签值,则筛选时该参数必填。

TableMetaObject

库表恢复时,需要恢复的库信息,被 RestoreTable 接口引用。

名称类型是否必选示例值描述
DBNameStringtestdb1需要恢复的目标库名。

NewDBName

String

testdb2

恢复后的新库名。

说明

NewDBName(新库名)不能与 DBName(原库名)相同,否则执行库表恢复操作会失败。

Table

Array of TableObject

请参见请求示例

指定恢复的数据库中的表。关于 Table 的详细信息,请参见TagObject

说明

  • Table 为空时表示恢复指定库下所有的表。
  • 单次最多支持恢复 100 张表或 100 个数据库。

TableObject

库表恢复时,需要恢复的表信息,被 TableMetaObject 数据结构引用。

名称类型是否必选示例值描述
TableNameStringtable1需要恢复的目标表名。
NewTableNameStringtable2恢复后的新表名。

ZoneObject

可用区的相关信息。被 DescribeAvailabilityZones 接口引用。

名称类型示例值描述
ZoneIdStringcn-beijing-a可用区 ID。
ZoneNameStringcn-beijing-a可用区名称。
DescripitionString华北 2(北京) - 可用区 A可用区描述。