You need to enable JavaScript to run this app.
导航
云数据库 MySQL 版
  • 文档首页
    • /
  • 云数据库 MySQL 版

数据结构

最近更新时间：2023.12.07 15:00:54

首次发布时间：2021.12.01 13:14:55

我的收藏

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

AccountInfoObject

名称类型示例值描述
AccountNameStringtestuser账号名称。
AccountDescString这是一段账号的描述信息。账号的描述信息。如果账号没有描述信息，该字段为空。
AccountTypeStringNormal账号类型，取值：
  • Super ：高权限账号。
  • Normal ：普通账号。
    • AccountStatusStringAvailable账号状态，取值：
  • Available：可用。
  • Unavailable：不可用。
    • DBPrivilegesArray of DBPrivilege[
    {
    "DBName": "testdb",
    "AccountPrivilege": "ReadOnly",
    "AccountPrivilegeStr": "SELECT,LOCK TABLES,SHOW VIEW"
    }
    ]    		账号数据库权限列表。

    AllowListObject

    名称类型示例值描述
    AllowListDescStringtest白名单的备注。
    AllowListIdStringacl-d1fd76693bd54e658912e7337d5b****白名单 ID。
    AllowListNameStringtest白名单名称。
    AllowListIPNumInteger2白名单内的 IP 地址（或地址段）总数。
    AllowListTypeStringIPv4白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    AssociatedInstanceNumInteger1白名单下绑定的实例总数。

    AssociatedInstanceObject

    名称类型示例值描述
    InstanceIdStringrds-mysql-h441603c68aaa****已绑定当前白名单的实例 ID。
    InstanceNameStringtest已绑定当前白名单的实例名称。
    VPCStringvpc-2743n1ihbxla87fap8tap****实例所属的私有网络 ID。

    BackupInfoObject

    名称类型示例值描述
    BackupIdStringxxx备份 ID。
    BackupStatusStringSuccess备份状态，取值：
  • Success：成功。
  • Failed ：失败。
  • Running ：执行中。
    • BackupStrategyStringInstance备份策略：
    Instance：实例备份。
    BackupTypeStringPhysical备份类型。取值：
    Physical：物理备份。
    BackupModeStringFull备份方式。取值：
  • Full：全量备份。
  • Increment：增量备份。
    • CreateTypeStringSystem创建备份的主体身份。取值：
  • System：系统。
  • User：用户。
    • BackupFileNameStringfull-1638021415869047766-163802160043687****.xbstream备份文件名。
    BackupFileSizeInteger1024备份文件大小，单位为 byte。
    BackupStartTimeString2021-12-02 10:00:00备份的开始时间，格式： yyyy-MM-dd HH:mm:ss（ UTC 时间）。
    BackupEndTimeString2021-12-02 10:00:10备份的结束时间，格式： yyyy-MM-dd HH:mm:ss（ UTC 时间）。

    BasicInfoObject

    名称类型示例值描述
    AllowListVersionStringv1白名单版本。取值：v1，v2。
    InstanceIdStringrds-mysql-h441603c68aaa****-0实例 ID。
    InstanceNameStringrds-mysql-h441603c68aaa****实例名称。
    InstanceStatusStringRunning实例状态，取值：
  • Running：运行中。
  • Creating：创建中。
  • Deleting：删除中。
  • Restarting：重启中。
  • Restoring：恢复中。
  • Updating：变更中。
  • Upgrading：升级中。
  • Error：错误。
    • CreateTimeString2021-12-02 10:00:00实例的创建时间。
    InstanceTypeStringHA实例类型，取值：
    HA：高可用版。
    DBEngineStringMySQL数据库类型，取值：
    MySQL 。
    DBEngineVersionStringMySQL_Community_5_7数据库版本，取值范围：
  • MySQL_Community_5_7： MySQL 5.7 版本
  • MySQL_8_0： MySQL 8.0 版本
    • InstanceSpecObject{
    "CpuNum": 2,
    "MemInGb": 4,
    "SpecName" : "rds.mysql.2c4g"
    }    		实例规格。
    StorageSpaceGBInteger100实例存储空间，单位为 GB。
    RegionStringcn-beijing实例所在的地域。
    ZoneStringcn-beijing-a实例所在的可用区。
    VpcIDStringvpc-3ajzohyfaru9s340jz1rp****私有网络（VPC） ID。
    UpdateTimeString2021-12-02 10:00:10实例的修改时间。
    ChargeTypeStringPostPaid计费类型。取值：
  • PostPaid：后付费（按量计费）。
  • Prepaid：预付费（包年包月）。
    • ChargeStatusStringNormal计费状态。 取值：
  • Normal：正常。
  • Overdue：到期或欠费。
    • ReadOnlyInstanceIdsArray of String["rds-mysql-re3dea8448e7f****"]该实例下的只读节点 ID。
    TempModifyStartTimeString2023-05-11T13:48:58.000Z临时升配的开始时间。
    TempModifyEndTimeString2023-05-16T13:48:58.000Z临时升配的结束时间。

    ChargeInfoObject

    名称类型是否必选示例值描述
    ChargeTypeString是postpaid计费类型。取值：
  • postpaid：后付费（按量计费）。
  • prepaid：预付费（包年包月）。

    • AutoRenew

    Boolean

    否

    true

    是否自动续费。默认值： autorenew_enable。取值：

  • true：是。
  • false：否。

    说明

    若ChargeType设置了预付费（即 prepaid），该参数必填。

    • PeriodUnitInteger否month预付费场景下的购买周期。取值：
  • month：包月（默认）。
  • year：包年。

    • Period

    Integer

    否

    1

    购买时长。默认值为 1。

    说明

    若ChargeType设置了预付费（即 prepaid），该参数必填。

    NumberInteger否1实例购买数量。取值为 1~10 间的整数，默认值为 1。

    ConnectionInfoObject

    名称类型示例值描述
    InternalDomainStringrdsmysqlh441603c68aaa****.rds.ivolces.com实例内网访问域名。
    InternalPortString3306实例内网访问端口。
    PublicDomainString100.100.***.**实例公网访问域名。
    PublicPortString3306实例公网访问端口。
    EnableReadWriteSplittingStringEnable是否已开启读写分离，取值：
  • Enable：开启。
  • Disable：未开启。（默认）
    • EnableReadOnlyStringEnable是否已开启全局只读，取值：
  • Enable：开启。
  • Disable：未开启。（默认）

    • DBInfoObject

    名称类型示例值描述
    DBNameStringtestdb数据库名。
    DBDescString这是一段数据库的描述信息。数据库的描述信息。如果数据库没有描述信息，该字段为空。
    DBStatusStringRunning数据库状态。取值：
  • Creating：创建中。
  • Running：运行中。
  • Deleting：删除中。
    • CharacterSetNameStringutf8数据库字符集。
    AccountNamesStringtestuser1,testuser2数据库绑定的账号，使用逗号分隔。

    DBPrivilegeObject

    名称类型示例值描述
    DBNameStringtestdb数据库名称。
    AccountPrivilegeStringCustom数据库权限类型，取值：
  • ReadWrite ：读写权限。
  • ReadOnly：只读权限。
  • DDLOnly：仅 DDL 。
  • DMLOnly：仅 DML 。
  • Custom：自定义权限。
    • AccountPrivilegeStrStringSELECT,INSERT数据库权限字符串，使用逗号分隔。

    InstanceInfoObject

    名称类型示例值描述
    InstanceIdStringrds-mysql-h441603c68aaa****实例 ID
    InstanceNameStringrds-mysql-h441603c68aaa****实例名称。
    InstanceStatusStringRunning实例状态，取值：
  • Running：运行中。
  • Creating：创建中。
  • Deleting：删除中。
  • Restarting：重启中。
  • Restoring：恢复中。
  • Updating：变更中。
  • Upgrading：升级中。
  • MasterChanging：主备切换中。
  • Error：错误。
    • CreateTimeString2021-12-02 10:00:00实例的创建时间。
    InstanceTypeStringHA实例类型，取值：
    HA：高可用版。
    DBEngineStringMySQL数据库类型，取值：
    MySQL 。
    DBEngineVersionStringMySQL_Community_5_7数据库版本，取值范围：
  • MySQL_Community_5_7： MySQL 5.7 版本
  • MySQL_8_0： MySQL 8.0 版本
    • InstanceSpecArray of InstanceSpec{
    "CpuNum": 2,
    "MemInGb" : 4,
    "SpecName": "rds.mysql.2c4g"
    }    		实例规格。
    StorageSpaceGBInteger100实例总存储空间，单位为 GB。
    RegionStringcn-beijing实例所属的地域。
    ZoneStringcn-beijing-a实例所属的可用区。
    VpcIDStringvpc-3ajzohyfaru9s340jz1rp****私有网络（VPC）ID。
    UpdateTimeString2021-12-02 10:00:10实例的修改时间。
    ChargeTypeStringPostPaid计费类型。取值：
  • PostPaid：后付费（按量计费）。
  • Prepaid：预付费（包年包月）。
    • ChargeStatusStringNormal计费状态。 取值：
  • Normal：正常。
  • Overdue：到期或欠费。
    • ReadOnlyInstanceIdsArray of String["rds-mysql-re3dea8448e7f****"]该实例下的只读节点 ID。
    TempModifyStartTimeString2023-05-11T13:48:58.000Z临时升配的开始时间。
    TempModifyEndTimeString2023-05-16T13:48:58.000Z临时升配的结束时间。

    InstanceParamChgObject

    名称类型示例值描述
    NameStringauto_increment_increment参数名称
    OldValueString1修改前参数值
    NewValueString2修改后参数值
    RestartBooleanfalse是否需要重启

    InstanceParamObject

    名称类型示例值描述
    NameStringauto_increment_increment实例参数名称
    DefaultValueString1参数默认值
    RunningValueString1参数运行值
    RestartBooleanFALSE是否重启
    ValueRangeString[1-65535]参数取值范围
    DescriptionStringAuto-increment columns are incremented by this.描述
    ExpectValueString1参数期望值

    InstanceParamsHistoryInfoObject

    名称类型示例值描述
    ParameterNameStringauto_increment_increment实例参数名称
    OldParameterValueString1修改前的参数值
    NewParameterValueString2修改后的参数值

    ParamsStatus

    String

    Applied

    生效状态。取值范围：
    Applied - 已生效
    Syncing - 正在生效
    Failed - 生效失败

    ModifyTimeString2021-12-02 10:00:00修改时间

    InstanceSpecObject

    名称类型示例值描述
    CpuNumInteger2CPU 核数。
    MemInGbInteger4内存，单位为 GB。
    SpecNameStringrds.mysql.2c4g实例的规格名称。

    ParameterTemplateInfoObject

    名称类型示例值描述
    AccountIdString0账户 ID。
    CreateTimeString2022/10/10 10:10:10创建时间。
    NeedRestartBooleanTRUE模板是否包含需要重启的参数。
    ParameterNumInteger100模板包含的参数个数。
    TemplateCategoryStringDBEngine可选值：DBEngine、Proxy。
    TemplateDescStringMySQL 8.0 default parameter template参数模板描述。
    TemplateIdStringmysql-sys-80bb93aa14be22d0参数模板 ID。
    TemplateNameStringMySQL_8.0_Default参数模板名称。

    TemplateParams

    Array of InstanceParamObject

    [
    {
    "Name": "auto_increment_increment",
    "RunningValue": "1"
    }
    ]

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

    TemplateSourceStringSystem参数模板的类型。可选值：System（系统模板）、 User（用户模板）。

    TemplateType

    String

    MySQL

    参数模板数据库类型，取值范围：
    MySQL - MySQL 数据库。

    TemplateTypeVersionStringMySQL_Community_5_7参数模板数据库版本，取值范围：
  • MySQL_Community_5_7： MySQL 5.7 版本
  • MySQL_8_0： MySQL 8.0 版本
    • UpdateTimeString2022/10/10 10:10:10修改时间。

    NodeInfoObject

    名称类型示例值描述
    NodeIdStringrdsmysqlh441603c68aaa****实例 ID。
    ZoneIdStringcn-beijing-a可用区 ID。
    NodeTypeStringPrimary节点类型。 Primary 节点有且只有 1 个， Secondary 节点有且只有 1 个， Read-Only 节点可选 0~10 个。取值：
  • Primary：主节点。
  • Secondary：备节点。
  • ReadOnly：只读节点。
    • NodeSpecStringrds.mysql.1c2g节点规格。实例规格取值范围：
  • rds.mysql.1c2g
  • rds.mysql.2c4g
  • rds.mysql.2c8g
  • rds.mysql.2c16g
  • rds.mysql.4c8g
  • rds.mysql.4c16g
  • rds.mysql.4c32g
  • rds.mysql.8c16g
  • rds.mysql.8c32g
  • rds.mysql.8c64g
  • rds.mysql.16c32g
  • rds.mysql.16c64g
  • rds.mysql.16c96g
  • rds.mysql.16c128g
  • rds.mysql.32c64g
  • rds.mysql.32c128g
  • rds.mysql.32c256g
  • rds.mysql.64c128g
  • rds.mysql.64c256g
  • rds.mysql.64c512g
  • rds.mysql.88c720g
  • rds.mysql.108c864g
    • NodeOperateTypeStringModify操作类型。取值范围：
  • Create：增加。
  • Delete：删除。
  • Modify：修改。

    • RegionObject

    名称类型示例值描述
    IdStringcn-beijing地域 ID。
    ValueStringcn-beijing地域名称。

    VPCObject

    名称类型示例值描述
    IdStringvpc-3ajzohyfaru9s340jz1rp****VPC ID。
    ValueStringVpc001VPC 的名称。

    WhiteIPGroupObject

    名称类型示例值描述
    GroupNameStringdepartment1IP 白名单分组名称。
    IPListArray of String["111.62.1**.**"]组的 IP 列表。

    ZoneObject

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