本文汇总云数据库 veDB MySQL 版的 API 接口中使用的数据结构定义详情。
账号列表信息。被 DescribeDBAccounts 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AccountName | String | testuser | 账号名称。 |
AccountType | String | Normal | 账号类型:
|
AccountPrivileges | Array of AccountPrivilegeObject | 请参见返回示例。 | 账号的权限信息。详细信息,请参见 AccountPrivilegeObject。 |
账号的权限信息。被以下接口和数据结构引用:
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DBName | String | 是 | db1 | 需授权的数据库名称。 |
AccountPrivilege | String | 是 | ReadWrite | 授权数据库权限类型:
|
AccountPrivilegeDetail | String | 否 | INSERT,UPDATE,DELETE,CREATE | 权限类型所包含的具体 SQL 操作权限,多个字符串之间使用英文逗号(,)分隔。
|
地址信息。被 EndpointObject 数据结构引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DNSVisibility | Boolean | false | 解析方式。当前返回值只能为 false (火山引擎私网解析)。 |
Domain | String | vedbm-fkfb7ag0****.master.mysql.vedb.ivolces.com | 实例内网访问域名。 |
IPAddress | String | 100...*** | IP 地址。 |
NetworkType | String | Private | 网络类型:
|
Port | String | 3306 | 实例内网访问端口。 |
SubnetId | String | subnet-3tfam28a**** | 子网 ID。子网必须属于所选的可用区。 说明 子网是私有网络内的 IP 地址块,私有网络中的所有云资源都必须部署在子网内,子网为云资源分配私网 IP 地址。 |
EipId | String | eip-13g56dc5u2uio3n6nu4kb**** | 公网 ID。 |
白名单列表信息。被 DescribeAllowLists和 DescribeInstanceAllowLists 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AllowListId | String | acl-31f52387922a40a7a60ff21365f6**** | 白名单 ID。 |
AllowListName | String | byte_ndb_system_inte****_* | 白名单名称。 |
AllowListDesc | String | test | 白名单的备注。 |
AllowListType | String | IPv4 | 白名单内的 IP 地址类型。当前仅支持指定为 IPv4 ,表示 IPv4 地址。 |
AllowListIPNum | Integer | 3 | 包含 IP 或 IP 段的总数量。 |
AssociatedInstanceNum | Integer | 0 | 绑定的全部实例数量。 |
ProjectName | String | default | 白名单所属的项目名称。 |
已绑定当前白名单的实例信息。被 DescribeAllowListDetail 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
InstanceId | String | vedbm-ca12cbqv**** | 实例 ID。 |
InstanceName | String | test | 实例名称。 |
VPC | String | vpc-3tgjebmlgq4e8i4m**** | VPC ID。 |
ProjectName | String | default | 白名单所属的项目名称。 |
备份列表信息。被 DescribeBackups 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
BackupId | String | snap-64b6****-7837 | 备份 ID。 |
BackupStatus | String | Success | 备份状态,取值:
|
CreateType | String | Physical | 创建类型,取值:
|
BackupMethod | String | Physical | 备份方式,目前仅支持物理备份,取值为 Physical 。 |
BackupType | String | Full | 备份类型,目前仅支持全量备份,取值为 Full 。 |
BackupFileSize | Integer | 437 | 备份文件大小,单位为 KiB。 |
BackupStartTime | String | 2023-07-19T06:20:22Z | 备份的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
BackupEndTime | String | 2023-07-19T06:31:28Z | 备份的结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
ConsistentTime | String | 2023-07-19T06:20:22Z | 一致性备份的时间点,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
计费的详细信息。被接口 DescribeDBInstanceDetail 和数据结构 InstanceObject 引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ChargeType | String | PostPaid | 计算计费类型,取值:
|
ChargeStatus | String | Normal | 付费状态:
|
OverdueReclaimTime | String | 2022-09-27T06:09:20Z | 欠费关停时预计释放时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
OverdueTime | String | 2022-10-04T07:50:22Z | 欠费关停时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
AutoRenew | Boolean |
| 预付费场景下是否自动续费。取值:
|
ChargeStartTime | String | 2023-09-22T08:08:35Z | 计费开始的时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
ChargeEndTime | String | 2023-09-22T08:08:35Z | 预付费场景下计费到期的时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
数据库列表信息。被 DescribeDatabases 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBName | String | testdb | 数据库名称。 |
CharacterSetName | String | utf8 | 数据库字符集:
|
DatabasesPrivileges | Array of DatabasesprivilegeObject | 请参见返回示例。 | 数据库的权限信息。详细信息,请参见 DatabasesprivilegeObject。 |
数据库权限信息。被接口 CreateDatabase 和数据结构 DatabaseObject 引用。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
AccountName | String | 是 | user1 | 需授权的账号名称。 |
AccountPrivilege | String | 是 | ReadWrite | 授权数据库权限类型:
|
AccountPrivilegeDetail | String | 否 | INSERT,UPDATE,DELETE,CREATE | 权限类型所包含的具体 SQL 操作权限,多个字符串之间使用英文逗号(,)分隔。
|
实例的库表信息,被 DescribeRecoverableTables 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Database | String | test_db | 数据库名称。 |
Tables | Array of String | ["table1","table2","table3"] | 指定数据库下的表信息。 |
DatabaseRecoverable | Boolean | true | 是否整库可恢复,取值:
|
TablesInfo | map<String, DBTableInfoObjectTablesInfo> | {"table6": {"TableRecoverable": false},"table7": {"TableRecoverable": false}} | 目标数据库下不可恢复的表信息。关于 DBTableInfoObjectTablesInfo 的更多详情,请参见 DBTableInfoObjectTablesInfo。 说明 当 |
目标表是否可恢复。被结构体 DBTableInfoObject 引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TableRecoverable | Boolean | false | 表示目标表是否可恢复,取值:
|
实例的连接信息。被 DescribeDBInstanceDetail 和 DescribeDBEndpoint 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Addresses | Array of AddressObject | 请参见返回示例。 | 地址信息。详细信息,请参见 AddressObject。 |
AutoAddNewNodes | Boolean | true | 是否允许自动加入新节点,取值:
|
Description | String | 主地址 | 地址描述。 |
EndpointId | String | vedbm-h441603c68aaa**** | 实例连接终端 ID。 |
EndpointName | String | 默认终端 | 实例连接终端名称。 |
EndpointType | String | Cluster | 连接终端类型,取值:
|
MasterAcceptReadRequests | Boolean | true | 主节点是否接受读请求。仅对读写模式的连接终端有效。
|
NodeIds | Array of String | ["vedbm-r3sar8zi****-0", "vedbm-r3sar8zi****-1"] | 连接终端配置的节点列表。 |
ReadWriteMode | String | ReadWrite | 连接终端的读写模式,取值:
|
DistributedTransaction | Boolean | true | 是否开启事务拆分,仅对读写模式的连接终端有效。取值:
|
ConsistLevel | String | Session | 一致性级别,仅对读写模式的连接终端有效。取值:
|
ConsistTimeout | Integer | 10000 | 延迟很大时,只读节点同步最新数据的超时时间,单位为 us,取值范围为 1us~100000000us。 说明 当 |
ConsistTimeoutAction | String | ReadMaster | 只读节点同步数据超时后的超时策略,支持以下两种策略:
说明 当 |
实例列表的相关信息。被 DescribeDBInstances 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
InstanceId | String | vedbm-d4mx2akm**** | 实例 ID。 |
InstanceName | String | test | 实例名称。 |
InstanceStatus | String | Running | 实例状态。 说明 关于实例状态的详细说明,请参见实例状态说明。 |
CreateTime | String | 2022-06-21T07:54:05Z | 实例的创建时间,格式:YYYY-MM-DDTHH:MM:SSZ(UTC 时间)。 |
DBEngineVersion | String | MySQL_8_0 | 数据库引擎版本,取值固定为 MySQL_8_0 。 |
ProjectName | String | vedb_project | 实例所属的项目名称。 说明 项目是一个虚拟的概念,包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理,并且控制项目内用户和角色管理这些资源的权限。更多详情,请参见资源管理。 |
ZoneIds | String | cn-beijing-a | 实例所属的可用区。 |
VpcId | String | vpc-3ajzohyfaru9s340jz1rp**** | 私有网络(VPC)ID。 |
TimeZone | String | UTC +08:00 | 实例的时区。国内所有地域默认时区为 UTC +08:00 。 |
StorageChargeType | String | PostPaid | 存储计费类型,取值:
|
PrePaidStorageInGB | Integer | 50 | 预付费的存储总容量大小,单位 GiB。 |
StorageUsedGiB | Double | 0.44 | 已使用存储空间大小,单位 GiB。 |
ChargeDetail | ChargeDetailObject | 请参见返回示例。 | 计费信息。详细信息,请参见 ChargeDetailObject。 |
RegionId | String | cn-beijing | 地域 ID。 |
SubnetId | String | subnet-1g15j13jtzgu88ibuxwqp**** | 子网 ID。子网必须属于所选的可用区。 |
Nodes | Array of NodeObject | 请参见返回示例。 | 实例节点的详细信息。详细信息,请参见 NodeObject。 |
Tags | Array of TagObject | 请参见返回示例。 | 实例绑定的标签键和标签值数组对象。关于 Tags 的更多详情,请参见 TagObject。 |
DeletionProtection | String | enabled | 实例是否开启了删除保护功能。取值范围:
|
DBRevisionVersion | String | 3.0.2.1 | 实例的内核版本。关于实例内核版本的详细信息,请参见版本号管理。 |
SpecFamily | String | Exclusive | 实例规格类型,取值:
|
LowerCaseTableNames | String | 1 | 表名是否区分大小写。取值范围:
|
实例的基本信息。被 DescribeDBInstanceDetail 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
InstanceId | String | vedbm-h441603c68aaa**** | 实例 ID。 |
InstanceName | String | test | 实例名称。 |
InstanceStatus | String | Running | 实例状态。 说明 关于实例状态的详细说明,请参见实例状态说明。 |
RegionId | String | cn-beijing | 地域 ID。 说明 您可以调用 DescribeRegions 接口查询可创建实例的地域信息,包括地域 ID。 |
ZoneIds | String | cn-beijing-a | 可用区 ID。 说明 可调用 DescribeAvailabilityZones 接口查询 veDB MySQL 实例支持的可用区资源。 |
DBEngineVersion | String | MySQL_8_0 | 数据库引擎版本,取值固定为 MySQL_8_0 。 |
SpecFamily | String | Exclusive | 实例规格类型,取值:
|
CreateTime | String | 2022-06-21T07:54:05Z | 实例的创建时间,格式 YYYY-MM-DDTHH:MM:SSZ(UTC 时间)。 |
StorageChargeType | String | PostPaid | 存储计费类型,取值:
|
PrePaidStorageInGB | Integer | 50 | 预付费的存储总容量大小,单位 GiB。 |
StorageUsedGiB | Double | 0.23 | 已使用存储空间大小,单位 GiB。 |
VpcId | String | vpc-3cikbvy7jw0e86c6rrt8i**** | 私有网络(VPC) ID。 |
SubnetId | String | subnet-1g0d851lg1s748ibuxxvg**** | 子网 ID。子网必须属于所选的可用区。 说明 子网是私有网络内的 IP 地址块,私有网络中的所有云资源都必须部署在子网内,子网为云资源分配私网 IP 地址。 |
TimeZone | String | UTC +08:00 | 实例的时区。国内所有地域默认时区为 UTC +08:00 。 |
ProjectName | String | vedb_project | 实例所属的项目名称。 说明 项目是一个虚拟的概念,包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理,并且控制项目内用户和角色管理这些资源的权限。更多详情,请参见资源管理。 |
LowerCaseTableNames | String | 1 | 表名是否区分大小写,默认取值为 1。
|
InstanceStructures | Array of InstanceStructureObject | 请参见返回示例。 | 实例的部署架构信息。详细信息请参见 InstanceStructureObject。 |
DeletionProtection | String | enabled | 实例是否开启了删除保护功能。取值范围:
|
实例的架构信息。被数据结构 InstanceDetailObject 引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
SubInstanceType | String | Primary | 实例类型,取固定值 Primary (主实例)。 |
ZoneIds | String | cn-beijing-b | 可用区 ID。 |
Nodes | Array of NodeObject | 请参见返回示例。 | 实例节点的详细信息。详细信息,请参见 NodeObject。 |
实例节点的详细信息。被接口 DescribeDBInstanceDetail 和数据结构 InstanceObject 引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
NodeId | String | vedbm-h441603c68aaa****-** | 节点 ID。 |
ZoneId | String | cn-beijing-a | 可用区 ID。 |
NodeType | String | Primary | 节点类型。取值:
|
vCPU | Integer | 8 | CPU 大小,例如当取值为 1 时表示 CPU 大小为 1U。 |
Memory | Integer | 32 | 内存大小,单位为 GiB。 |
NodeSpec | String | vedb.mysql.x4.xlarge | 实例的节点规格。 说明 关于实例节点规格的详细信息,请参见产品规格。 |
规格代码列表信息。被 DescribeDBInstanceSpecs 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Connection | Integer | 400 | 最大连接数。 |
Memory | Integer | 8 | 内存大小,单位为 GiB。 |
NodeSpec | String | vedb.mysql.x4.xlarge | 实例规格代码。 |
PrePaidMinStorage | Integer | 50 | 存储空间下限,单位为 GiB。 |
PrePaidMaxStorage | Integer | 2000000 | 存储空间上限,单位为 GiB。 |
SpecFamily | String | General | 实例规格类型,取值:
|
vCPU | Integer | 8 | CPU 大小。例如:1 表示 1vCPU。 |
MaxIops | Integer | 66000 | 最大 IOPS。 |
实例节点规格配置信息。被 ModifyDBInstanceSpec (2024-01-01)接口引用。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
NodeType | String | 是 | DBEngine | 节点类型。取值:
|
NodeSpec | String | 是 | vedb.mysql.x4.large | 实例的节点规格代码。 说明 关于实例节点规格的详细信息,请参见产品规格。 |
NodeNumber | Integer | 是 | 2 | 实例的节点数量。
|
ZoneId | String | 是 | cn-beijing-a | 可用区 ID。 说明 您可以调用 DescribeDBInstanceDetail 接口,查询指定实例所在的可用区 ID。 |
地域列表的相关信息。被 DescribeRegions 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Description | String | 华北 2(北京) | 地域描述。 |
RegionId | String | cn-beijing | 地域 ID。 |
RegionName | String | cn-beijing | 地域名称。 |
Status | String | Available | 地域状态。 |
实例可恢复的时间范围。被 DescribeRecoverableTime 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
EarliestRecoverableTime | String | 2023-07-14T03:47:31Z | 实例最早可恢复的时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间),为空表示实例目前不可恢复。 |
LatestRecoverableTime | String | 2023-07-14T03:47:31Z | 实例最晚可恢复的时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间),为空表示实例目前不可恢复。 |
实例绑定的标签键和标签值数组对象。被以下接口引用。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Key | String | 是 | department | 实例绑定的标签键。
|
Value | String | 否 | game | 实例绑定的标签值。
|
用于查询筛选的标签键值对数组对象。被 DescribeDBInstances 接口引用。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Key | String | 是 | department | 用于查询筛选的标签键。 |
Value | String | 否 | game | 用于查询筛选的标签值。 说明 若绑定标签时,设置了标签值,则筛选时该参数必填。 |
库表恢复时,需要恢复的库信息,被 RestoreTable 接口引用。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DBName | String | 是 | testdb1 | 需要恢复的目标库名。 |
NewDBName | String | 是 | testdb2 | 恢复后的新库名。 说明
|
Table | Array of TableObject | 否 | 请参见请求示例。 | 指定恢复的数据库中的表。关于 Table 的详细信息,请参见TableObject。 说明
|
库表恢复时,需要恢复的表信息,被 TableMetaObject 数据结构引用。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
TableName | String | 是 | table1 | 需要恢复的目标表名。 |
NewTableName | String | 是 | table2 | 恢复后的新表名。 |
可用区的相关信息。被 DescribeAvailabilityZones 接口引用。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ZoneId | String | cn-beijing-a | 可用区 ID。 |
ZoneName | String | cn-beijing-a | 可用区名称。 |
Descripition | String | 可用区A | 可用区描述。 |
Status | String | Normal | 可用区状态。 |