client

func (*TidbClient) AddWhiteListGroup ¶

func (c *TidbClient) AddWhiteListGroup(request *tidb.AddWhiteListGroupRequest) (*tidb.AddWhiteListGroupResponse, error)

增加白名单分组，用于用户管理不同类型或者来源的 IP 白名单。

func (*TidbClient) CreateAccount ¶

func (c *TidbClient) CreateAccount(request *tidb.CreateAccountRequest) (*tidb.CreateAccountResponse, error)

创建数据库的高权限管理账号，用户可以使用客户端、应用程序等通过该账号和密码登录 TiDB 实例，然后通过SQL创建数据库和其他用户。一个数据库实例只能创建一个高权限账号。

func (*TidbClient) CreateBackup ¶

func (c *TidbClient) CreateBackup(request *tidb.CreateBackupRequest) (*tidb.CreateBackupResponse, error)

进行 TiDB 实例的全量备份，对实例中所有的数据库进行备份。同一时间，只能有一个正在运行的备份任务。

func (*TidbClient) CreateDataMigration ¶

func (c *TidbClient) CreateDataMigration(request *tidb.CreateDataMigrationRequest) (*tidb.CreateDataMigrationResponse, error)

创建一个数据迁移任务，可以将对象存储 OSS 中的数据导入到 TiDB 实例中，具体可以参考帮助文档。

func (*TidbClient) CreateInstance ¶

func (c *TidbClient) CreateInstance(request *tidb.CreateInstanceRequest) (*tidb.CreateInstanceResponse, error)

创建一个 TiDB 实例。创建时需要指定 TiDB 各类节点的数目，规格，存储空间等。 TiFlash和TiCDC节点在创建时不是必须的，可以在需要时，通过扩容的功能创建TiFlash和TiCDC节点。

func (*TidbClient) CreateInstanceByTime ¶ added in v1.60.0

func (c *TidbClient) CreateInstanceByTime(request *tidb.CreateInstanceByTimeRequest) (*tidb.CreateInstanceByTimeResponse, error)

根据日志备份创建一个新的 TiDB 实例

func (*TidbClient) CreateInstanceFromBackup ¶

func (c *TidbClient) CreateInstanceFromBackup(request *tidb.CreateInstanceFromBackupRequest) (*tidb.CreateInstanceFromBackupResponse, error)

创建一个新的 TiDB 实例，并将指定的备份恢复到该实例上。

func (*TidbClient) CreateReplication ¶ added in v1.58.0

func (c *TidbClient) CreateReplication(request *tidb.CreateReplicationRequest) (*tidb.CreateReplicationResponse, error)

创建一个数据复制任务，可以将 TiDB 的增量数据同步到下游的 MySQL， TiDB 或者 Kafka 中。

func (*TidbClient) DeleteBackup ¶

func (c *TidbClient) DeleteBackup(request *tidb.DeleteBackupRequest) (*tidb.DeleteBackupResponse, error)

删除TiDB的备份，仅允许删除用户创建的备份，系统的自动备份不允许删除。

func (*TidbClient) DeleteInstance ¶

func (c *TidbClient) DeleteInstance(request *tidb.DeleteInstanceRequest) (*tidb.DeleteInstanceResponse, error)

删除指定的 TiDB 实例。实例删除后，数据不可恢复，请谨慎使用。

func (*TidbClient) DeleteReplication ¶ added in v1.58.0

func (c *TidbClient) DeleteReplication(request *tidb.DeleteReplicationRequest) (*tidb.DeleteReplicationResponse, error)

删除指定的复制任务。

func (*TidbClient) DeleteWhiteListGroup ¶

func (c *TidbClient) DeleteWhiteListGroup(request *tidb.DeleteWhiteListGroupRequest) (*tidb.DeleteWhiteListGroupResponse, error)

删除指定的白名单分组。

func (*TidbClient) DescribeAccounts ¶

func (c *TidbClient) DescribeAccounts(request *tidb.DescribeAccountsRequest) (*tidb.DescribeAccountsResponse, error)

查看当前实例下的账号信息。

func (*TidbClient) DescribeAvailableDBInfoInternel ¶ added in v1.60.0

func (c *TidbClient) DescribeAvailableDBInfoInternel(request *tidb.DescribeAvailableDBInfoInternelRequest) (*tidb.DescribeAvailableDBInfoInternelResponse, error)

查询 TiDB支持的基本信息。

func (*TidbClient) DescribeBackupPolicy ¶

func (c *TidbClient) DescribeBackupPolicy(request *tidb.DescribeBackupPolicyRequest) (*tidb.DescribeBackupPolicyResponse, error)

查看实例当前的备份策略。

func (*TidbClient) DescribeBackups ¶

func (c *TidbClient) DescribeBackups(request *tidb.DescribeBackupsRequest) (*tidb.DescribeBackupsResponse, error)

查看该实例下所有备份的详细信息。

func (*TidbClient) DescribeDataMigration ¶

func (c *TidbClient) DescribeDataMigration(request *tidb.DescribeDataMigrationRequest) (*tidb.DescribeDataMigrationResponse, error)

查询 TiDB 数据迁移任务的详细信息，例如任务的开始、完成时间，任务状态等等。

func (*TidbClient) DescribeInstanceAttributes ¶

func (c *TidbClient) DescribeInstanceAttributes(request *tidb.DescribeInstanceAttributesRequest) (*tidb.DescribeInstanceAttributesResponse, error)

查询 TiDB 实例的详细信息，例如TiDB的具体版本号，各个节点的规格、存储空间以及连接信息等等。

func (*TidbClient) DescribeInstanceClasses ¶

func (c *TidbClient) DescribeInstanceClasses(request *tidb.DescribeInstanceClassesRequest) (*tidb.DescribeInstanceClassesResponse, error)

获取各种 TiDB 节点支持的具体规格。

func (*TidbClient) DescribeInstances ¶

func (c *TidbClient) DescribeInstances(request *tidb.DescribeInstancesRequest) (*tidb.DescribeInstancesResponse, error)

查询当前账号下所有的 TiDB 实例。

func (*TidbClient) DescribeNodes ¶

func (c *TidbClient) DescribeNodes(request *tidb.DescribeNodesRequest) (*tidb.DescribeNodesResponse, error)

获取某个实例下的所有节点的主要性能信息，如CPU，内存，存储空间等。 该性能信息从云监控获取，为上一个监控周期的数据。

func (*TidbClient) DescribeOrderableInstanceType ¶

func (c *TidbClient) DescribeOrderableInstanceType(request *tidb.DescribeOrderableInstanceTypeRequest) (*tidb.DescribeOrderableInstanceTypeResponse, error)

获取当前用户售罄信息。

func (*TidbClient) DescribeParameters ¶

func (c *TidbClient) DescribeParameters(request *tidb.DescribeParametersRequest) (*tidb.DescribeParametersResponse, error)

查看TiDB实例的主要配置参数。

func (*TidbClient) DescribeReplications ¶ added in v1.58.0

func (c *TidbClient) DescribeReplications(request *tidb.DescribeReplicationsRequest) (*tidb.DescribeReplicationsResponse, error)

查询当前实例下所有的复制任务。

func (*TidbClient) DescribeRestoreTimeInterval ¶ added in v1.60.0

func (c *TidbClient) DescribeRestoreTimeInterval(request *tidb.DescribeRestoreTimeIntervalRequest) (*tidb.DescribeRestoreTimeIntervalResponse, error)

获取实例按时间点创建时间，可选择的最早时间和最晚时间

func (*TidbClient) DescribeSSL ¶ added in v1.58.0

func (c *TidbClient) DescribeSSL(request *tidb.DescribeSSLRequest) (*tidb.DescribeSSLResponse, error)

查询 TiDB 实例的 SSL 的开启状态。

func (*TidbClient) DescribeUpgradePlan ¶

func (c *TidbClient) DescribeUpgradePlan(request *tidb.DescribeUpgradePlanRequest) (*tidb.DescribeUpgradePlanResponse, error)

查询当前 TiDB 实例的升级计划。

func (*TidbClient) DescribeUpgradeVersions ¶

func (c *TidbClient) DescribeUpgradeVersions(request *tidb.DescribeUpgradeVersionsRequest) (*tidb.DescribeUpgradeVersionsResponse, error)

获取当前 TiDB 实例可升级到的目标版本。

func (*TidbClient) DescribeVersions ¶

func (c *TidbClient) DescribeVersions(request *tidb.DescribeVersionsRequest) (*tidb.DescribeVersionsResponse, error)

查询指定地域下 TiDB 服务支持的数据库版本。

func (*TidbClient) DescribeWhiteList ¶

func (c *TidbClient) DescribeWhiteList(request *tidb.DescribeWhiteListRequest) (*tidb.DescribeWhiteListResponse, error)

查看实例当前白名单。白名单是允许访问当前实例的IP/IP段列表，缺省情况下，白名单对本VPC开放。如果用户开启了外网访问的功能，还需要对外网的IP配置白名单。

func (*TidbClient) DisableInternetAccess ¶ added in v1.58.0

func (c *TidbClient) DisableInternetAccess(request *tidb.DisableInternetAccessRequest) (*tidb.DisableInternetAccessResponse, error)

关闭 TiDB 实例的 Internet 公网服务。 关闭后，将不能在 VPC 外访问 TiDB 实例。

func (*TidbClient) DisableLogger ¶

func (c *TidbClient) DisableLogger()

func (*TidbClient) DisableSSL ¶ added in v1.58.0

func (c *TidbClient) DisableSSL(request *tidb.DisableSSLRequest) (*tidb.DisableSSLResponse, error)

关闭 TiDB 和 MySQL 客户端之间的 SSL 连接功能。

func (*TidbClient) EnableInternetAccess ¶ added in v1.58.0

func (c *TidbClient) EnableInternetAccess(request *tidb.EnableInternetAccessRequest) (*tidb.EnableInternetAccessResponse, error)

开启 TiDB 实例的 Internet 公网服务。开启后，并配置 IP 白名单后，可以在 VPC 外通过公网域名访问 TiDB 实例。

func (*TidbClient) EnableSSL ¶ added in v1.58.0

func (c *TidbClient) EnableSSL(request *tidb.EnableSSLRequest) (*tidb.EnableSSLResponse, error)

开启 TiDB 和 MySQL 客户端之间的 SSL 连接功能。

func (*TidbClient) ModifyBackupPolicy ¶

func (c *TidbClient) ModifyBackupPolicy(request *tidb.ModifyBackupPolicyRequest) (*tidb.ModifyBackupPolicyResponse, error)

修改 TiDB 实例备份策略，例如全量备份的日期，时间等。

func (*TidbClient) ModifyInstanceName ¶

func (c *TidbClient) ModifyInstanceName(request *tidb.ModifyInstanceNameRequest) (*tidb.ModifyInstanceNameResponse, error)

修改实例名称，可支持中文，实例名的具体规则可参见帮助中心文档。

func (*TidbClient) ModifyInstanceSpec ¶

func (c *TidbClient) ModifyInstanceSpec(request *tidb.ModifyInstanceSpecRequest) (*tidb.ModifyInstanceSpecResponse, error)

修改 TiDB 实例中各类节点中的数目与规格。支持 TiDB 节点和 Monitor 节点数目和规格的同时调整。 如果当前实例无 TiFlash 和 TiCDC 节点，那么在增加 TiFlash 和 TiCDC 节点数目时，可同时指定其规格。

func (*TidbClient) ModifyNodeNum ¶

func (c *TidbClient) ModifyNodeNum(request *tidb.ModifyNodeNumRequest) (*tidb.ModifyNodeNumResponse, error)

修改 TiDB 实例中各类节点的数量。如果当前实例无TiFlash和TiCDC节点，那么在增加TiFlash和TiCDC节点数目时，可同时指定其规格。

func (*TidbClient) ModifyParameters ¶

func (c *TidbClient) ModifyParameters(request *tidb.ModifyParametersRequest) (*tidb.ModifyParametersResponse, error)

修改TiDB实例的配置参数。部分参数修改后，需要重启才能生效，具体可以参考PingCAP的相关文档。

func (*TidbClient) ModifyReplication ¶ added in v1.58.0

func (c *TidbClient) ModifyReplication(request *tidb.ModifyReplicationRequest) (*tidb.ModifyReplicationResponse, error)

修改复制任务，修改前需要先暂停复制任务。为保证复制任务的可靠性，目前仅允许修改部分配置。

func (*TidbClient) ModifyWhiteList ¶

func (c *TidbClient) ModifyWhiteList(request *tidb.ModifyWhiteListRequest) (*tidb.ModifyWhiteListResponse, error)

修改允许访问实例的IP白名单。白名单是允许访问当前实例的IP/IP段列表，缺省情况下，白名单对本VPC开放。如果用户开启了外网访问的功能，还需要对外网的IP配置白名单。

func (*TidbClient) RebootPod ¶

func (c *TidbClient) RebootPod(request *tidb.RebootPodRequest) (*tidb.RebootPodResponse, error)

重启实例的某类节点。重启采用滚动重启的方式，如果该类节点有多个，通常不会中断实例的服务。

func (*TidbClient) ResetPassword ¶

func (c *TidbClient) ResetPassword(request *tidb.ResetPasswordRequest) (*tidb.ResetPasswordResponse, error)

重置 TiDB 实例的高权限账号的密码。

func (*TidbClient) ResumeReplication ¶ added in v1.58.0

func (c *TidbClient) ResumeReplication(request *tidb.ResumeReplicationRequest) (*tidb.ResumeReplicationResponse, error)

继续处于“暂停”状态的复制任务。

func (*TidbClient) SetConfig ¶

func (c *TidbClient) SetConfig(config *core.Config)

func (*TidbClient) SetLogger ¶

func (c *TidbClient) SetLogger(logger core.Logger)

func (*TidbClient) StopReplication ¶ added in v1.58.0

func (c *TidbClient) StopReplication(request *tidb.StopReplicationRequest) (*tidb.StopReplicationResponse, error)

暂停指定的复制任务。注意：如果暂停的时间过长，会导致 TiCDC 节点的磁盘空间写满，导致复制任务错误或失败。

func (*TidbClient) UpgradeEngineVersion ¶

func (c *TidbClient) UpgradeEngineVersion(request *tidb.UpgradeEngineVersionRequest) (*tidb.UpgradeEngineVersionResponse, error)

升级TiDB引擎版本，例如从4.0.8 升级到 5.4.0等。

func (*TidbClient) VerifyFilefromOSS ¶

func (c *TidbClient) VerifyFilefromOSS(request *tidb.VerifyFilefromOSSRequest) (*tidb.VerifyFilefromOSSResponse, error)

校验需要导入的备份文件在OSS上是否存在，需要的读取权限是否具备。