Documentation
¶
Index ¶
- type TidbClient
- func (c *TidbClient) AddWhiteListGroup(request *tidb.AddWhiteListGroupRequest) (*tidb.AddWhiteListGroupResponse, error)
- func (c *TidbClient) CreateAccount(request *tidb.CreateAccountRequest) (*tidb.CreateAccountResponse, error)
- func (c *TidbClient) CreateBackup(request *tidb.CreateBackupRequest) (*tidb.CreateBackupResponse, error)
- func (c *TidbClient) CreateDataMigration(request *tidb.CreateDataMigrationRequest) (*tidb.CreateDataMigrationResponse, error)
- func (c *TidbClient) CreateInstance(request *tidb.CreateInstanceRequest) (*tidb.CreateInstanceResponse, error)
- func (c *TidbClient) CreateInstanceFromBackup(request *tidb.CreateInstanceFromBackupRequest) (*tidb.CreateInstanceFromBackupResponse, error)
- func (c *TidbClient) DeleteBackup(request *tidb.DeleteBackupRequest) (*tidb.DeleteBackupResponse, error)
- func (c *TidbClient) DeleteInstance(request *tidb.DeleteInstanceRequest) (*tidb.DeleteInstanceResponse, error)
- func (c *TidbClient) DeleteWhiteListGroup(request *tidb.DeleteWhiteListGroupRequest) (*tidb.DeleteWhiteListGroupResponse, error)
- func (c *TidbClient) DescribeAccounts(request *tidb.DescribeAccountsRequest) (*tidb.DescribeAccountsResponse, error)
- func (c *TidbClient) DescribeAvailableZones(request *tidb.DescribeAvailableZonesRequest) (*tidb.DescribeAvailableZonesResponse, error)
- func (c *TidbClient) DescribeBackupPolicy(request *tidb.DescribeBackupPolicyRequest) (*tidb.DescribeBackupPolicyResponse, error)
- func (c *TidbClient) DescribeBackups(request *tidb.DescribeBackupsRequest) (*tidb.DescribeBackupsResponse, error)
- func (c *TidbClient) DescribeDataMigration(request *tidb.DescribeDataMigrationRequest) (*tidb.DescribeDataMigrationResponse, error)
- func (c *TidbClient) DescribeInstanceAttributes(request *tidb.DescribeInstanceAttributesRequest) (*tidb.DescribeInstanceAttributesResponse, error)
- func (c *TidbClient) DescribeInstanceClasses(request *tidb.DescribeInstanceClassesRequest) (*tidb.DescribeInstanceClassesResponse, error)
- func (c *TidbClient) DescribeInstances(request *tidb.DescribeInstancesRequest) (*tidb.DescribeInstancesResponse, error)
- func (c *TidbClient) DescribeNodes(request *tidb.DescribeNodesRequest) (*tidb.DescribeNodesResponse, error)
- func (c *TidbClient) DescribeOrderableInstanceType(request *tidb.DescribeOrderableInstanceTypeRequest) (*tidb.DescribeOrderableInstanceTypeResponse, error)
- func (c *TidbClient) DescribeParameters(request *tidb.DescribeParametersRequest) (*tidb.DescribeParametersResponse, error)
- func (c *TidbClient) DescribeUpgradePlan(request *tidb.DescribeUpgradePlanRequest) (*tidb.DescribeUpgradePlanResponse, error)
- func (c *TidbClient) DescribeUpgradeVersions(request *tidb.DescribeUpgradeVersionsRequest) (*tidb.DescribeUpgradeVersionsResponse, error)
- func (c *TidbClient) DescribeVersions(request *tidb.DescribeVersionsRequest) (*tidb.DescribeVersionsResponse, error)
- func (c *TidbClient) DescribeWhiteList(request *tidb.DescribeWhiteListRequest) (*tidb.DescribeWhiteListResponse, error)
- func (c *TidbClient) DisableLogger()
- func (c *TidbClient) ModifyBackupPolicy(request *tidb.ModifyBackupPolicyRequest) (*tidb.ModifyBackupPolicyResponse, error)
- func (c *TidbClient) ModifyInstanceName(request *tidb.ModifyInstanceNameRequest) (*tidb.ModifyInstanceNameResponse, error)
- func (c *TidbClient) ModifyInstanceSpec(request *tidb.ModifyInstanceSpecRequest) (*tidb.ModifyInstanceSpecResponse, error)
- func (c *TidbClient) ModifyNodeNum(request *tidb.ModifyNodeNumRequest) (*tidb.ModifyNodeNumResponse, error)
- func (c *TidbClient) ModifyParameters(request *tidb.ModifyParametersRequest) (*tidb.ModifyParametersResponse, error)
- func (c *TidbClient) ModifyWhiteList(request *tidb.ModifyWhiteListRequest) (*tidb.ModifyWhiteListResponse, error)
- func (c *TidbClient) RebootPod(request *tidb.RebootPodRequest) (*tidb.RebootPodResponse, error)
- func (c *TidbClient) ResetPassword(request *tidb.ResetPasswordRequest) (*tidb.ResetPasswordResponse, error)
- func (c *TidbClient) SetConfig(config *core.Config)
- func (c *TidbClient) SetLogger(logger core.Logger)
- func (c *TidbClient) UpgradeEngineVersion(request *tidb.UpgradeEngineVersionRequest) (*tidb.UpgradeEngineVersionResponse, error)
- func (c *TidbClient) VerifyFilefromOSS(request *tidb.VerifyFilefromOSSRequest) (*tidb.VerifyFilefromOSSResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type TidbClient ¶
type TidbClient struct {
core.JDCloudClient
}
func NewTidbClient ¶
func NewTidbClient(credential *core.Credential) *TidbClient
func (*TidbClient) AddWhiteListGroup ¶
func (c *TidbClient) AddWhiteListGroup(request *tidb.AddWhiteListGroupRequest) (*tidb.AddWhiteListGroupResponse, error)
增加白名单分组。
func (*TidbClient) CreateAccount ¶
func (c *TidbClient) CreateAccount(request *tidb.CreateAccountRequest) (*tidb.CreateAccountResponse, error)
创建数据库账号,用户可以使用客户端,应用程序等通过该账号和密码登录数据库实例。
func (*TidbClient) CreateBackup ¶
func (c *TidbClient) CreateBackup(request *tidb.CreateBackupRequest) (*tidb.CreateBackupResponse, error)
创建一个实例全量备份,可以对整个实例所有的数据库进行全量备份。同一时间点,只能有一个正在运行的备份任务
func (*TidbClient) CreateDataMigration ¶
func (c *TidbClient) CreateDataMigration(request *tidb.CreateDataMigrationRequest) (*tidb.CreateDataMigrationResponse, error)
查询 TiDB 数据迁移任务的信息
func (*TidbClient) CreateInstance ¶
func (c *TidbClient) CreateInstance(request *tidb.CreateInstanceRequest) (*tidb.CreateInstanceResponse, error)
创建一个TiDB实例
func (*TidbClient) CreateInstanceFromBackup ¶
func (c *TidbClient) CreateInstanceFromBackup(request *tidb.CreateInstanceFromBackupRequest) (*tidb.CreateInstanceFromBackupResponse, error)
根据源实例全量备份创建一个新实例
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) 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) DescribeAvailableZones ¶
func (c *TidbClient) DescribeAvailableZones(request *tidb.DescribeAvailableZonesRequest) (*tidb.DescribeAvailableZonesResponse, error)
获取可用区
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 实例的详细信息
func (*TidbClient) DescribeInstanceClasses ¶
func (c *TidbClient) DescribeInstanceClasses(request *tidb.DescribeInstanceClassesRequest) (*tidb.DescribeInstanceClassesResponse, error)
规格获取接口
func (*TidbClient) DescribeInstances ¶
func (c *TidbClient) DescribeInstances(request *tidb.DescribeInstancesRequest) (*tidb.DescribeInstancesResponse, error)
查询实例列表
func (*TidbClient) DescribeNodes ¶
func (c *TidbClient) DescribeNodes(request *tidb.DescribeNodesRequest) (*tidb.DescribeNodesResponse, error)
获取某个实例下的节点信息
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) 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) DisableLogger ¶
func (c *TidbClient) DisableLogger()
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)
修改实例规格,包含节点的水平扩容与垂直扩容
func (*TidbClient) ModifyNodeNum ¶
func (c *TidbClient) ModifyNodeNum(request *tidb.ModifyNodeNumRequest) (*tidb.ModifyNodeNumResponse, error)
增加实例的节点数量。
func (*TidbClient) ModifyParameters ¶
func (c *TidbClient) ModifyParameters(request *tidb.ModifyParametersRequest) (*tidb.ModifyParametersResponse, error)
修改TiDB实例的配置参数。部分参数修改后,需要重启才能生效,具体可以参考PingCAP的相关文档
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)
重启实例的pod
func (*TidbClient) ResetPassword ¶
func (c *TidbClient) ResetPassword(request *tidb.ResetPasswordRequest) (*tidb.ResetPasswordResponse, error)
创建数据库账号,用户可以使用客户端,应用程序等通过该账号和密码登录RDS数据库实例。
func (*TidbClient) SetConfig ¶
func (c *TidbClient) SetConfig(config *core.Config)
func (*TidbClient) SetLogger ¶
func (c *TidbClient) SetLogger(logger core.Logger)
func (*TidbClient) UpgradeEngineVersion ¶
func (c *TidbClient) UpgradeEngineVersion(request *tidb.UpgradeEngineVersionRequest) (*tidb.UpgradeEngineVersionResponse, error)
升级TiDB引擎版本,例如从4.0.6 升级到4.0.8. 目前支持小版本的升级,可升级到平台支持的最新的小版本
func (*TidbClient) VerifyFilefromOSS ¶
func (c *TidbClient) VerifyFilefromOSS(request *tidb.VerifyFilefromOSSRequest) (*tidb.VerifyFilefromOSSResponse, error)
校验需要导入的备份文件在OSS上是否存在,需要的读取权限是否具备