You need to enable JavaScript to run this app.
导航
SDK 发布历史
最近更新时间:2024.07.26 14:51:05首次发布时间:2024.03.14 22:52:08

2024-07-25

发布 Python(v1.0.94)、GO(v1.0.150)、Java(v0.1.122)三个版本的 SDK。本次发布涉及的接口更新如下:

API变更记录
AssociateAllowList更新请求参数 InstanceIds 和 AllowListIds 的描述信息,增加数量限制信息。

CreateBackup

  • 为请求参数 BackupMethod 增加取值 Logical

  • 为请求参数 BackupType 增加取值 DumpAll,并更新相关描述信息。

  • 为请求参数 BackupMeta 补充前提条件、互斥情况和数量限制。

  • 增加示例:创建备份方式为全库备份的逻辑备份、创建备份方式为库表备份的逻辑备份

  • 更新返回参数。

CreateDBAccount更新请求参数 AccountPassword 的取值范围。
CreateDBEndpoint修改请求参数 EndpointType 的取值,移除可取值 Primary。

CreateDBInstance

  • 新增请求参数 MaintenanceWindow,并更新请求示例。

  • 更新参数 SuperAccountPassword 的取值范围。

DeleteDataBackup移除该接口的使用限制。

DescribeBackups

  • 新增请求参数 CreateType。

  • 为请求参数 BackupMethod 补充取值 Logical,并更新请求示例。

  • 为请求参数 BackupType 增加取值 DumpAll,并更新相关描述信息。

  • 为请求参数 BackupId、BackupStatus、BackupMethod、BackupType 补充默认值相关的说明。

  • 更新返回示例。

DescribeDBInstanceParameters增加请求参数 NodeId。

DescribeDBInstances

  • 新增请求参数 InstanceType、NodeSpec 和 TagFilters。

  • 更新返回示例。

DescribeDBInstanceSSL新增返回参数 Address,并更新返回示例。
DescribeFailoverLogs新增请求参数 EndTime 和 StartTime。
DescribeReadOnlyNodeDelay修改返回参数 DelayReplicationTime 的类型为 Long。

GetBackupDownloadLink

  • 修改返回参数 DownloadProgress 的类型为 Long。

  • 更新接口注意事项。

  • 更新请求参数 BackupId 的描述信息。

  • 新增返回参数 InnerBackupDownloadLink。

  • 更新返回参数 BackupFileName 和 BackupId 的描述信息。

  • 更新返回参数 BackupFileSize 的单位。

  • 更新返回示例。

ModifyAllowList新增请求参数 UpdateSecurityGroup。
ModifyDBInstanceParameters新增请求参数 ParamApplyScope 和 CustomNodeIds。
ModifyReadOnlyNodeDelayReplicationTime修改请求参数 DelayReplicationTime 的类型为 Long。
ResetDBAccount更新请求参数 AccountPassword 的取值范围。
RestoreToExistedInstance更新请求参数 BackupId 的描述信息。
RestoreToNewInstance更新请求参数 BackupId 的描述信息。
数据结构 - BackupMetaObject增加参数 TableNames。

数据结构 - BackupObject

  • 新增 IsEncrypted 参数。

  • 修改参数 BackupFileSize 的类型为 Long。

  • 为参数 BackupType 增加取值 DumpAll

数据结构 - BasicInfoObject

  • 修改参数 StorageSpace 的类型为 Long。

  • 为参数 InstanceStatus 增加取值 ChargeTypeChanging:计费类型变更中。

  • 为参数 InstanceStatus 增加取值 :NetWorkChanging:网络变更中。

  • 为 InstanceStatus 增加以下取值:

    • Recycled:已回收。

    • TDEUpdating:TDE 修改中。

    • Closed:关停。

    • Maintaining:维护中。

    • CreateFailed:创建失败。

    • Closing:关停中。

    • SSLUpdating:SSL 变更中。

    • AllowListMaintaining:白名单变更中。

    • Unknown:未知。

    • ProxyCreating:代理开启中。

    • ProxyDeleting:代理关闭中。

    • 更新取值 MasterChanging 的描述信息。

数据结构 - BinlogFilesObject

  • 新增 IsEncrypted 参数。

  • 修改参数 FileSize 的类型为 Long。

数据结构 - ChargeItemPriceObject修改参数 ChargeItemValue 的类型为 Long。
数据结构 - ConfigItemPriceObject修改参数 Quantity 的类型为 Long。

数据结构 - EndpointObject

  • 修改参数 EndpointType 的取值,移除可取值 Primary 和 Cluster。

  • 修改参数 Description 的示例值和描述信息。

  • 修改参数 EndpointName 的示例值。

数据结构 - InstanceObject

  • 为参数 InstanceStatus 增加取值 :NetWorkChanging:网络变更中。

  • 更新参数 ZoneId 的描述信息。

  • 增加参数 NodeCPUUsedPercentage、NodeMemoryUsedPercentage 和 NodeSpaceUsedPercentage。

  • 增加参数 Tags 和 ZoneIds。

  • 为 InstanceStatus 增加以下取值:

    • Recycled:已回收。

    • TDEUpdating:TDE 修改中。

    • Closed:关停。

    • Maintaining:维护中。

    • CreateFailed:创建失败。

    • Closing:关停中。

    • SSLUpdating:SSL 变更中。

    • AllowListMaintaining:白名单变更中。

    • Unknown:未知。

    • ProxyCreating:代理开启中。

    • ProxyDeleting:代理关闭中。

    • ChargeTypeChanging:计费类型变更中。

    • 更新取值 MasterChanging 的描述信息。

数据结构 - MaintenanceWindowObject删除参数 DayOfMonth。
数据结构 - ParameterTemplateInfoObject修改参数 ParameterNum 的类型为 Long。
数据结构 - TaskInfoObject修改参数 CostTimeMS 的类型为 Long。

2024-05-23

发布 Python(v1.0.83)、GO(v1.0.137)、Java(v0.1.111) 三个版本的 SDK。本次发布涉及的接口更新如下:

接口更新
CreateDatabase修改请求字段 DBName 的描述信息。
CreateDBAccount修改请求字段 AccountName 的描述信息。

CreateDBInstance

  • 新增请求字段 Port,更新请求示例(新增 Port 字段)。
  • 更新请求字段 VpcId 和 SubnetId 的示例值和描述信息。
  • 修改请求字段 SuperAccountName 的描述信息。

DescribeBinlogFiles

  • 更新返回字段 BinlogFiles 的示例值。
  • 更新返回示例,为每个返回的 BinlogFilesObject 增加 NodeId。
  • 修改字段 BackupFileNumber 的取值上限。

ModifyDBEndpointAddress

  • 在接口描述新增说明事项。
  • 在请求字段 Port 的描述信息增加说明。

ModifyDBInstanceChargeType

  • 修改接口的描述信息。
  • 修改请求字段 PeriodUnit 和 Period 为可选。
ModifyDBInstanceName更新请求参数 InstanceNewName 的描述信息。

ModifyTask

  • 新增请求字段 InstanceId。
  • 更新请求示例和返回示例。
RestoreToCrossRegionInstance新增接口。

RestoreToNewInstance

  • 新增请求字段 Port,更新请求示例(新增 Port 字段)。
  • 更新请求字段 VpcId 和 SubnetId 的示例值和描述信息。
数据结构 - BinlogFilesObject增加字段 NodeId。
数据结构 - NodeInfoObject为字段 ZoneId 补充描述信息。

2024-04-11

发布 Python(v1.0.74)、GO(v1.0.131)、Java(v0.1.105)三个版本的 SDK。本次发布涉及的接口更新如下:

接口更新
ModifyDBEndpointAddress修改接口的使用说明(支持修改公网端口)和请求字段 Port 的描述信息。
CreateAllowList新增请求参数 SecurityGroupBindInfos、AllowListCategory、UserAllowList。
ModifyAllowList新增请求参数 SecurityGroupBindInfos、AllowListCategory、UserAllowList,修改接口的使用限制。
DescribeAllowLists更新接口文档的返回示例。
DescribeAllowListDetail新增返回参数 AllowListCategory、SecurityGroupBindInfos 和 UserAllowList。
DescribePlannedEvents为请求参数 EventType 新增取值 HostOffline。
CreateParameterTemplate更新请求参数 TemplateTypeVersion 的取值和接口的请求示例。
ModifyParameterTemplate更新请求参数 TemplateParams 的描述信息,增加说明。
DescribeParameterTemplate更新接口的请求示例。
ListParameterTemplates更新请求参数 TemplateTypeVersion 的取值。
数据结构 - InstanceParamObject增加说明和字段 DefaultValue、Description、Restart 和 ValueRange。
数据结构 - ParameterTemplateInfoObject为字段 TemplateParams 增加示例值。

2024-03-14

发布 Python(v1.0.69)、Go(v1.0.125)、Java(v0.1.101)三个版本的 SDK。该版本的改动点如下:

新增

该版本 SDK 新增了以下接口:

接口说明
MigrateToOtherZone调用 MigrateToOtherZone 接口将指定实例的节点迁移至同一地域下的其他可用区。
DescribeReadOnlyNodeDelay调用 DescribeReadOnlyNodeDelay 接口查询只读节点的延迟复制配置。
ModifyReadOnlyNodeDelayReplicationTime调用 ModifyReadOnlyNodeDelayReplicationTime 接口配置只读节点的延迟复制功能。
ModifyDBAccountHost调用 ModifyDBAccountHost 接口修改普通数据库账号可访问数据库的 IP 地址。
DownloadSSLCertificate调用 DownloadSSLCertificate 接口下载指定 MySQL 实例的 SSL 证书。
DeleteDataBackup调用 DeleteDataBackup 接口删除指定 MySQL 实例的手动备份文件。
ListParameterTemplates调用 ListParameterTemplates 接口查询 MySQL 实例的参数模板列表。
DescribeTasks调用 DescribeTasks 接口查询任务。
ModifyTask调用 ModifyTask 接口编辑任务。
DescribePlannedEvents调用 DescribePlannedEvents 接口查询计划内事件的列表信息。
ModifyPlannedEventExecuteTime调用 ModifyPlannedEventExecuteTime 接口推迟计划内运维事件执行的时间。
DescribeFailoverLogs调用 DescribeFailoverLogs 接口查询 MySQL 实例的主备切换日志。

修改

该版本 SDK 对以下接口进行了修改:

接口改动点
CopyParameterTemplate更新请求参数 TemplateName 为必选项。
CreateAllowList更新请求参数 AllowList 为非必选项。
CreateBackup更新返回参数为空。

CreateDBAccount

  • 新增必选请求参数 AccountType。
  • 更新请求参数 AccountName、AccountPassword 为必选项。
  • 删除了请求参数 AccountPrivilegesInfo。
CreateDBEndpoint更新请求参数为必选项 EndpointType。
CreateDBInstance更新请求参数 DBEngineVersion、StorageSpace、StorageType、SubnetId、VpcId 为必选项。

CreateDatabase

  • 更新请求参数 DBName 为必选项。
  • 删除了请求参数 DatabasePrivilegesInfo。
CreateParameterTemplate更新请求参数 TemplateName 为必选项。
DescribeAllowLists更新请求参数 RegionId 为必选项。
DescribeAvailabilityZones删除了请求参数 RegionId。
DescribeAvailableCrossRegion更新请求参数 RegionId 为必选项。
DescribeBinlogFiles更新请求参数 EndTime、InstanceId、StartTime 为必选项。
DescribeCrossBackupPolicy更新请求参数 InstanceId 为必选项。

DescribeDBAccounts

  • 返回参数删除了 AccountsInfo 字段。

  • 返回参数 Accounts 嵌套对象删除了字段AccountPrivilegesInfo。

DescribeDBInstanceDetail返回参数结构体删除了 ConnectionInfo、NodeDetailInfo。
DescribeDBInstancePriceDetail更新请求参数 ChargeType、StorageSpace、StorageType 为必选项。
DescribeDBInstanceTDE新增了必选参数 InstanceId。
DescribeDBInstances删除返回参数 InstancesInfo。
DescribeDBProxyConfig更新请求参数 InstanceId 为必选项。

DescribeDatabases

更新请求参数 InstanceId 为必选项。
返回参数删除了字段 DatabasesInfo。

DescribeParameterTemplate

返回参数 TemplateInfo 下 TemplateParams 参数删除了字段 Description。

DownloadBackup更新请求参数 BackupId 为必选项。
GetBackupDownloadLink更新请求参数 BackupId 为必选项。
ModifyBackupPolicy更新请求参数 InstanceId 为必选项。
ModifyCrossBackupPolicy更新请求参数 InstanceId 为必选项。
ModifyDBEndpointAddress更新请求参数 EndpointId、NetworkType 为必选项。

ModifyDBInstanceChargeType

更新请求参数 ChargeType、Period、PeriodUnit 为必选项。

ModifyDBInstanceMaintenanceWindow更新请求参数 MaintenanceTime 为必选项。
ModifyDBInstanceParameters返回参数更新为空。
ModifyDBInstanceSyncMode更新请求参数 SyncMode 为必选项。
ModifyDBInstanceTDE更新请求参数 TDEStatus 为必选项。
ModifyParameterTemplate更新请求参数 TemplateName 为必选项。
ResetDBAccount更新请求参数 AccountPassword 为必选项。
RestoreToExistedInstance更新请求参数 SourceDBInstanceId 为必选项。
SaveAsParameterTemplate更新请求参数 TemplateName 为必选项。
SwitchDBInstanceHA更新请求参数 NodeId 为必选项。