Documentation
¶
Overview ¶
Package tidb include resources of ucloud tidb product
See also
- API: https://docs.ucloud.cn/api/tidb-api/index
- Product: https://www.ucloud.cn/site/product/tidb.html
for detail.
Index ¶
- type BackupData
- type CreateTiDBClusterServiceParamLabels
- type CreateTiDBClusterServiceParamNodeConfig
- type CreateTiDBClusterServiceParamOrderDetail
- type CreateTiDBClusterServiceParamSecGroupInfo
- type CreateTiDBClusterServiceRequest
- type CreateTiDBClusterServiceResponse
- type CreateTiDBServiceRequest
- type CreateTiDBServiceResponse
- type DeleteTiDBClusterServiceRequest
- type DeleteTiDBClusterServiceResponse
- type DeleteTiDBServiceRequest
- type DeleteTiDBServiceResponse
- type GetTiDBClusterServiceRequest
- type GetTiDBClusterServiceResponse
- type GetTiDBClusterUhostSpecsRequest
- type GetTiDBClusterUhostSpecsResponse
- type ListTiDBClusterBackupRequest
- type ListTiDBClusterBackupResponse
- type ListTiDBClusterRestoreRequest
- type ListTiDBClusterRestoreResponse
- type ListTiDBClusterServiceRequest
- type ListTiDBClusterServiceResponse
- type ModifyTiDBClusterBinlogParamNodeConfig
- type ModifyTiDBClusterBinlogRequest
- type ModifyTiDBClusterBinlogResponse
- type ModifyTiDBClusterNodeParamNodeConfig
- type ModifyTiDBClusterNodeRequest
- type ModifyTiDBClusterNodeResponse
- type ModifyTiDBClusterTiFlashParamNodeConfig
- type ModifyTiDBClusterTiFlashRequest
- type ModifyTiDBClusterTiFlashResponse
- type ModifyTiDBClusterUhostDiskParamNodeConfig
- type ModifyTiDBClusterUhostDiskRequest
- type ModifyTiDBClusterUhostDiskResponse
- type ModifyTiDBClusterUhostSpecsParamNodeConfig
- type ModifyTiDBClusterUhostSpecsRequest
- type ModifyTiDBClusterUhostSpecsResponse
- type RestoreData
- type ServiceData
- type ServiceID
- type SetTiDBConfigParamConfigs
- type SetTiDBConfigRequest
- type SetTiDBConfigResponse
- type StartTiDBClusterBackupRequest
- type StartTiDBClusterBackupResponse
- type StartTiDBClusterRestoreRequest
- type StartTiDBClusterRestoreResponse
- type TiDBClient
- func (c *TiDBClient) CreateTiDBClusterService(req *CreateTiDBClusterServiceRequest) (*CreateTiDBClusterServiceResponse, error)
- func (c *TiDBClient) CreateTiDBService(req *CreateTiDBServiceRequest) (*CreateTiDBServiceResponse, error)
- func (c *TiDBClient) DeleteTiDBClusterService(req *DeleteTiDBClusterServiceRequest) (*DeleteTiDBClusterServiceResponse, error)
- func (c *TiDBClient) DeleteTiDBService(req *DeleteTiDBServiceRequest) (*DeleteTiDBServiceResponse, error)
- func (c *TiDBClient) GetTiDBClusterService(req *GetTiDBClusterServiceRequest) (*GetTiDBClusterServiceResponse, error)
- func (c *TiDBClient) GetTiDBClusterUhostSpecs(req *GetTiDBClusterUhostSpecsRequest) (*GetTiDBClusterUhostSpecsResponse, error)
- func (c *TiDBClient) ListTiDBClusterBackup(req *ListTiDBClusterBackupRequest) (*ListTiDBClusterBackupResponse, error)
- func (c *TiDBClient) ListTiDBClusterRestore(req *ListTiDBClusterRestoreRequest) (*ListTiDBClusterRestoreResponse, error)
- func (c *TiDBClient) ListTiDBClusterService(req *ListTiDBClusterServiceRequest) (*ListTiDBClusterServiceResponse, error)
- func (c *TiDBClient) ModifyTiDBClusterBinlog(req *ModifyTiDBClusterBinlogRequest) (*ModifyTiDBClusterBinlogResponse, error)
- func (c *TiDBClient) ModifyTiDBClusterNode(req *ModifyTiDBClusterNodeRequest) (*ModifyTiDBClusterNodeResponse, error)
- func (c *TiDBClient) ModifyTiDBClusterTiFlash(req *ModifyTiDBClusterTiFlashRequest) (*ModifyTiDBClusterTiFlashResponse, error)
- func (c *TiDBClient) ModifyTiDBClusterUhostDisk(req *ModifyTiDBClusterUhostDiskRequest) (*ModifyTiDBClusterUhostDiskResponse, error)
- func (c *TiDBClient) ModifyTiDBClusterUhostSpecs(req *ModifyTiDBClusterUhostSpecsRequest) (*ModifyTiDBClusterUhostSpecsResponse, error)
- func (c *TiDBClient) NewCreateTiDBClusterServiceRequest() *CreateTiDBClusterServiceRequest
- func (c *TiDBClient) NewCreateTiDBServiceRequest() *CreateTiDBServiceRequest
- func (c *TiDBClient) NewDeleteTiDBClusterServiceRequest() *DeleteTiDBClusterServiceRequest
- func (c *TiDBClient) NewDeleteTiDBServiceRequest() *DeleteTiDBServiceRequest
- func (c *TiDBClient) NewGetTiDBClusterServiceRequest() *GetTiDBClusterServiceRequest
- func (c *TiDBClient) NewGetTiDBClusterUhostSpecsRequest() *GetTiDBClusterUhostSpecsRequest
- func (c *TiDBClient) NewListTiDBClusterBackupRequest() *ListTiDBClusterBackupRequest
- func (c *TiDBClient) NewListTiDBClusterRestoreRequest() *ListTiDBClusterRestoreRequest
- func (c *TiDBClient) NewListTiDBClusterServiceRequest() *ListTiDBClusterServiceRequest
- func (c *TiDBClient) NewModifyTiDBClusterBinlogRequest() *ModifyTiDBClusterBinlogRequest
- func (c *TiDBClient) NewModifyTiDBClusterNodeRequest() *ModifyTiDBClusterNodeRequest
- func (c *TiDBClient) NewModifyTiDBClusterTiFlashRequest() *ModifyTiDBClusterTiFlashRequest
- func (c *TiDBClient) NewModifyTiDBClusterUhostDiskRequest() *ModifyTiDBClusterUhostDiskRequest
- func (c *TiDBClient) NewModifyTiDBClusterUhostSpecsRequest() *ModifyTiDBClusterUhostSpecsRequest
- func (c *TiDBClient) NewSetTiDBConfigRequest() *SetTiDBConfigRequest
- func (c *TiDBClient) NewStartTiDBClusterBackupRequest() *StartTiDBClusterBackupRequest
- func (c *TiDBClient) NewStartTiDBClusterRestoreRequest() *StartTiDBClusterRestoreRequest
- func (c *TiDBClient) NewUpgradeTiDBClusterRequest() *UpgradeTiDBClusterRequest
- func (c *TiDBClient) SetTiDBConfig(req *SetTiDBConfigRequest) (*SetTiDBConfigResponse, error)
- func (c *TiDBClient) StartTiDBClusterBackup(req *StartTiDBClusterBackupRequest) (*StartTiDBClusterBackupResponse, error)
- func (c *TiDBClient) StartTiDBClusterRestore(req *StartTiDBClusterRestoreRequest) (*StartTiDBClusterRestoreResponse, error)
- func (c *TiDBClient) UpgradeTiDBCluster(req *UpgradeTiDBClusterRequest) (*UpgradeTiDBClusterResponse, error)
- type UTiDBServiceData
- type UhostSpecs
- type UpgradeTiDBClusterRequest
- type UpgradeTiDBClusterResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BackupData ¶ added in v0.22.68
type BackupData struct {
// 备份结束时间
BackupEndTime int
// 备份 ID
BackupId string
// 备份文件大小,单位:MB
BackupSize int
// 备份起始时间
BackupStartTime int
// 备份方式
BackupType string
// 备份状态
State string
}
BackupData - Backup数据
type CreateTiDBClusterServiceParamLabels ¶ added in v0.22.68
type CreateTiDBClusterServiceParamLabels struct {
// 用户资源标签的键值
Key *string `required:"false"`
// 用户资源标签的值
Value *string `required:"false"`
}
CreateTiDBClusterServiceParamLabels is request schema for complex param
type CreateTiDBClusterServiceParamNodeConfig ¶ added in v0.22.68
type CreateTiDBClusterServiceParamNodeConfig struct {
// 节点规格ID
ConfigId *string `required:"true"`
// 节点磁盘容量
DiskSize *int `required:"true"`
// 节点数量
NodeCount *int `required:"true"`
// 节点类型
ServerType *string `required:"true"`
}
CreateTiDBClusterServiceParamNodeConfig is request schema for complex param
type CreateTiDBClusterServiceParamOrderDetail ¶ added in v0.22.68
type CreateTiDBClusterServiceParamOrderDetail struct {
// 计费项数量
Multiple *int `required:"true"`
// 计费项名称,CPU / MEM / DISK
ProductName *string `required:"true"`
}
CreateTiDBClusterServiceParamOrderDetail is request schema for complex param
type CreateTiDBClusterServiceParamSecGroupInfo ¶ added in v0.22.68
type CreateTiDBClusterServiceParamSecGroupInfo struct {
// 安全组优先级。取值范围[1, 5]
Priority *int `required:"false"`
// 安全组 ID。至多可以同时绑定5个安全组。
SecGroupId *string `required:"false"`
}
CreateTiDBClusterServiceParamSecGroupInfo is request schema for complex param
type CreateTiDBClusterServiceRequest ¶ added in v0.22.68
type CreateTiDBClusterServiceRequest struct {
request.CommonBase
// 活动ID。
ActivityId *int `required:"false"`
// 告警策略IDs
AlertStrategyIds []int `required:"false"`
// 计费模式。枚举值为: Year,按年付费; Month,按月付费; Dynamic,按小时付费(需开启权限)。默认为月付
ChargeType *string `required:"true"`
// 代金券Id
Coupon *string `required:"true"`
// 容灾类型:10:同可用区,20:跨可用区,默认是同可用区
DTType *string `required:"true"`
// 集群版本号
DbVersion *string `required:"false"`
// 指定Ip地址
Ip *string `required:"false"`
//
Labels []CreateTiDBClusterServiceParamLabels `required:"false"`
// 集群名称
Name *string `required:"true"`
//
NodeConfig []CreateTiDBClusterServiceParamNodeConfig `required:"false"`
//
OrderDetail []CreateTiDBClusterServiceParamOrderDetail `required:"false"`
// 集群密码
Password *string `required:"true"`
// 指定端口
Port *string `required:"false"`
// 活动ID。若有产品折扣,则由各产品与计费约定。
PromotionId *string `required:"false"`
// 公网Ulb ID
PubUlbId *string `required:"true"`
// 购买时长。默认: 1。按小时购买(Dynamic)时无需此参数。 月付时,此参数传0,代表了购买至月末
Quantity *float64 `required:"true"`
// 活动规则ID。
RuleId *int `required:"false"`
//
SecGroupInfo []CreateTiDBClusterServiceParamSecGroupInfo `required:"false"`
// 子网ID
SubnetId *string `required:"true"`
// 参数模版ID
TemplateId *string `required:"false"`
// VPC id
VPCId *string `required:"true"`
}
CreateTiDBClusterServiceRequest is request schema for CreateTiDBClusterService action
type CreateTiDBClusterServiceResponse ¶ added in v0.22.68
type CreateTiDBClusterServiceResponse struct {
response.CommonBase
// 详情详情
Data ServiceData
}
CreateTiDBClusterServiceResponse is response schema for CreateTiDBClusterService action
type CreateTiDBServiceRequest ¶
type CreateTiDBServiceRequest struct {
request.CommonBase
//
DTType *string `required:"false"`
//
Ip *string `required:"false"`
//
Name *string `required:"true"`
//
Password *string `required:"true"`
//
Port *string `required:"false"`
//
SubnetId *string `required:"true"`
//
TikvMemoryHardTh *string `required:"false"`
//
VPCId *string `required:"true"`
}
CreateTiDBServiceRequest is request schema for CreateTiDBService action
type CreateTiDBServiceResponse ¶
type CreateTiDBServiceResponse struct {
response.CommonBase
//
Data ServiceID
//
Message string
//
ServiceId string
}
CreateTiDBServiceResponse is response schema for CreateTiDBService action
type DeleteTiDBClusterServiceRequest ¶ added in v0.22.68
type DeleteTiDBClusterServiceRequest struct {
request.CommonBase
// 是否清理备份数据
DeleteBackup *bool `required:"false"`
// 集群ID
Id *string `required:"true"`
}
DeleteTiDBClusterServiceRequest is request schema for DeleteTiDBClusterService action
type DeleteTiDBClusterServiceResponse ¶ added in v0.22.68
type DeleteTiDBClusterServiceResponse struct {
response.CommonBase
// 集群ID
ServiceId string
}
DeleteTiDBClusterServiceResponse is response schema for DeleteTiDBClusterService action
type DeleteTiDBServiceRequest ¶
type DeleteTiDBServiceRequest struct {
request.CommonBase
//
Id *string `required:"true"`
}
DeleteTiDBServiceRequest is request schema for DeleteTiDBService action
type DeleteTiDBServiceResponse ¶
type DeleteTiDBServiceResponse struct {
response.CommonBase
//
Message string
//
ServiceId string
}
DeleteTiDBServiceResponse is response schema for DeleteTiDBService action
type GetTiDBClusterServiceRequest ¶ added in v0.22.68
type GetTiDBClusterServiceRequest struct {
request.CommonBase
// 实例ID
Id *string `required:"true"`
}
GetTiDBClusterServiceRequest is request schema for GetTiDBClusterService action
type GetTiDBClusterServiceResponse ¶ added in v0.22.68
type GetTiDBClusterServiceResponse struct {
response.CommonBase
// 集群详情
Data UTiDBServiceData
}
GetTiDBClusterServiceResponse is response schema for GetTiDBClusterService action
type GetTiDBClusterUhostSpecsRequest ¶ added in v0.22.68
type GetTiDBClusterUhostSpecsRequest struct {
request.CommonBase
// 节点类型列表
NodeTypes []string `required:"true"`
}
GetTiDBClusterUhostSpecsRequest is request schema for GetTiDBClusterUhostSpecs action
type GetTiDBClusterUhostSpecsResponse ¶ added in v0.22.68
type GetTiDBClusterUhostSpecsResponse struct {
response.CommonBase
// 详情
Data []UhostSpecs
}
GetTiDBClusterUhostSpecsResponse is response schema for GetTiDBClusterUhostSpecs action
type ListTiDBClusterBackupRequest ¶ added in v0.22.68
type ListTiDBClusterBackupRequest struct {
request.CommonBase
// 实例id
Id *string `required:"true"`
// 返回数据长度,默认为30,最大30
Limit *int `required:"false"`
// 列表起始位置偏移量,默认为0
Offset *int `required:"false"`
}
ListTiDBClusterBackupRequest is request schema for ListTiDBClusterBackup action
type ListTiDBClusterBackupResponse ¶ added in v0.22.68
type ListTiDBClusterBackupResponse struct {
response.CommonBase
// 备份信息
Data BackupData
// 备份总数
TotalCount int
}
ListTiDBClusterBackupResponse is response schema for ListTiDBClusterBackup action
type ListTiDBClusterRestoreRequest ¶ added in v0.22.68
type ListTiDBClusterRestoreRequest struct {
request.CommonBase
// 实例的服务Id
Id *string `required:"true"`
// 返回数据长度,默认为30,最大30
Limit *int `required:"true"`
// 列表起始位置偏移量,默认为0
Offset *int `required:"true"`
}
ListTiDBClusterRestoreRequest is request schema for ListTiDBClusterRestore action
type ListTiDBClusterRestoreResponse ¶ added in v0.22.68
type ListTiDBClusterRestoreResponse struct {
response.CommonBase
// 恢复信息
RestoreData RestoreData
}
ListTiDBClusterRestoreResponse is response schema for ListTiDBClusterRestore action
type ListTiDBClusterServiceRequest ¶ added in v0.22.68
type ListTiDBClusterServiceRequest struct {
request.CommonBase
// 返回数据长度,默认为20,最大100
Limit *string `required:"false"`
// 列表起始位置偏移量,默认为0
Offset *string `required:"false"`
}
ListTiDBClusterServiceRequest is request schema for ListTiDBClusterService action
type ListTiDBClusterServiceResponse ¶ added in v0.22.68
type ListTiDBClusterServiceResponse struct {
response.CommonBase
// 集群列表
Data []UTiDBServiceData
}
ListTiDBClusterServiceResponse is response schema for ListTiDBClusterService action
type ModifyTiDBClusterBinlogParamNodeConfig ¶ added in v0.22.68
type ModifyTiDBClusterBinlogParamNodeConfig struct {
// 节点配置ID
ConfigId *string `required:"true"`
// 节点磁盘大小
DiskSize *int `required:"true"`
// 节点个数
NodeCount *int `required:"true"`
// 节点角色
ServerType *string `required:"true"`
}
ModifyTiDBClusterBinlogParamNodeConfig is request schema for complex param
type ModifyTiDBClusterBinlogRequest ¶ added in v0.22.68
type ModifyTiDBClusterBinlogRequest struct {
request.CommonBase
// binlog 状态
Enable *string `required:"true"`
// TIDB service id
Id *string `required:"true"`
//
NodeConfig *ModifyTiDBClusterBinlogParamNodeConfig `required:"false"`
}
ModifyTiDBClusterBinlogRequest is request schema for ModifyTiDBClusterBinlog action
type ModifyTiDBClusterBinlogResponse ¶ added in v0.22.68
type ModifyTiDBClusterBinlogResponse struct {
response.CommonBase
// ServiceId
ServiceId string
}
ModifyTiDBClusterBinlogResponse is response schema for ModifyTiDBClusterBinlog action
type ModifyTiDBClusterNodeParamNodeConfig ¶ added in v0.22.68
type ModifyTiDBClusterNodeParamNodeConfig struct {
// 节点配置ID
ConfigId *string `required:"true"`
// 节点个数
NodeCount *int `required:"true"`
// 节点角色
ServerType *string `required:"true"`
}
ModifyTiDBClusterNodeParamNodeConfig is request schema for complex param
type ModifyTiDBClusterNodeRequest ¶ added in v0.22.68
type ModifyTiDBClusterNodeRequest struct {
request.CommonBase
// TIDB service id
Id *string `required:"true"`
//
NodeConfig *ModifyTiDBClusterNodeParamNodeConfig `required:"false"`
// 扩缩类型,枚举值为:SCALEOUT,扩容;SCALEIN,缩容;
ScaleType *string `required:"true"`
// 缩容节点ID,缩容时必填
ServerId *string `required:"false"`
// 开始时间
StartTime *int `required:"false"`
}
ModifyTiDBClusterNodeRequest is request schema for ModifyTiDBClusterNode action
type ModifyTiDBClusterNodeResponse ¶ added in v0.22.68
type ModifyTiDBClusterNodeResponse struct {
response.CommonBase
// ServiceId
ServiceId string
}
ModifyTiDBClusterNodeResponse is response schema for ModifyTiDBClusterNode action
type ModifyTiDBClusterTiFlashParamNodeConfig ¶ added in v0.22.68
type ModifyTiDBClusterTiFlashParamNodeConfig struct {
// 节点配置ID
ConfigId *string `required:"true"`
// 节点磁盘大小
DiskSize *int `required:"true"`
// 节点个数
NodeCount *int `required:"true"`
// 节点角色
ServerType *string `required:"true"`
}
ModifyTiDBClusterTiFlashParamNodeConfig is request schema for complex param
type ModifyTiDBClusterTiFlashRequest ¶ added in v0.22.68
type ModifyTiDBClusterTiFlashRequest struct {
request.CommonBase
// tiflash 状态
Enable *string `required:"true"`
// TIDB service id
Id *string `required:"true"`
//
NodeConfig *ModifyTiDBClusterTiFlashParamNodeConfig `required:"false"`
}
ModifyTiDBClusterTiFlashRequest is request schema for ModifyTiDBClusterTiFlash action
type ModifyTiDBClusterTiFlashResponse ¶ added in v0.22.68
type ModifyTiDBClusterTiFlashResponse struct {
response.CommonBase
// ServiceId
ServiceId string
}
ModifyTiDBClusterTiFlashResponse is response schema for ModifyTiDBClusterTiFlash action
type ModifyTiDBClusterUhostDiskParamNodeConfig ¶ added in v0.22.68
type ModifyTiDBClusterUhostDiskParamNodeConfig struct {
// 磁盘容量
DiskSize *int `required:"true"`
// 节点角色
ServerType *string `required:"true"`
}
ModifyTiDBClusterUhostDiskParamNodeConfig is request schema for complex param
type ModifyTiDBClusterUhostDiskRequest ¶ added in v0.22.68
type ModifyTiDBClusterUhostDiskRequest struct {
request.CommonBase
// 实例ID
Id *string `required:"true"`
//
NodeConfig *ModifyTiDBClusterUhostDiskParamNodeConfig `required:"false"`
// 扩缩类型,枚举值为:SCALEOUT,扩容;SCALEIN,缩容;
ScaleType *string `required:"true"`
// 开始时间
StartTime *int `required:"false"`
}
ModifyTiDBClusterUhostDiskRequest is request schema for ModifyTiDBClusterUhostDisk action
type ModifyTiDBClusterUhostDiskResponse ¶ added in v0.22.68
type ModifyTiDBClusterUhostDiskResponse struct {
response.CommonBase
// 实例ID
ServiceId string
}
ModifyTiDBClusterUhostDiskResponse is response schema for ModifyTiDBClusterUhostDisk action
type ModifyTiDBClusterUhostSpecsParamNodeConfig ¶ added in v0.22.68
type ModifyTiDBClusterUhostSpecsParamNodeConfig struct {
// 机器规格ID
ConfigId *string `required:"true"`
// 节点角色
ServerType *string `required:"true"`
}
ModifyTiDBClusterUhostSpecsParamNodeConfig is request schema for complex param
type ModifyTiDBClusterUhostSpecsRequest ¶ added in v0.22.68
type ModifyTiDBClusterUhostSpecsRequest struct {
request.CommonBase
// 实例ID
Id *string `required:"true"`
//
NodeConfig *ModifyTiDBClusterUhostSpecsParamNodeConfig `required:"false"`
// 开始时间
StartTime *int `required:"false"`
}
ModifyTiDBClusterUhostSpecsRequest is request schema for ModifyTiDBClusterUhostSpecs action
type ModifyTiDBClusterUhostSpecsResponse ¶ added in v0.22.68
type ModifyTiDBClusterUhostSpecsResponse struct {
response.CommonBase
// 实例ID
ServiceId string
}
ModifyTiDBClusterUhostSpecsResponse is response schema for ModifyTiDBClusterUhostSpecs action
type RestoreData ¶ added in v0.22.68
type RestoreData struct {
// 备份Id
BackupId string
// 恢复的结束时间
RestoreEndTime int
// 恢复的Id
RestoreId string
// 恢复的起始时间
RestoreStartTime int
// 源实例Id
SourceServiceId string
// 恢复的状态
State string
// 目标实例Id
TargetServiceId string
}
RestoreData - 恢复的数据
type ServiceData ¶ added in v0.22.68
type ServiceData struct {
// 服务ID
Id string
}
ServiceData - 服务ID
type SetTiDBConfigParamConfigs ¶
type SetTiDBConfigParamConfigs struct {
//
Name *string `required:"true"`
//
Value *string `required:"true"`
}
SetTiDBConfigParamConfigs is request schema for complex param
type SetTiDBConfigRequest ¶
type SetTiDBConfigRequest struct {
request.CommonBase
//
Configs []SetTiDBConfigParamConfigs `required:"false"`
//
Id *string `required:"true"`
}
SetTiDBConfigRequest is request schema for SetTiDBConfig action
type SetTiDBConfigResponse ¶
type SetTiDBConfigResponse struct {
response.CommonBase
//
ServiceId string
}
SetTiDBConfigResponse is response schema for SetTiDBConfig action
type StartTiDBClusterBackupRequest ¶ added in v0.22.68
type StartTiDBClusterBackupRequest struct {
request.CommonBase
// 备份过滤规则
BackupFilter *string `required:"false"`
// 备份时间
BackupTs *string `required:"false"`
// 实例的服务Id
Id *string `required:"true"`
}
StartTiDBClusterBackupRequest is request schema for StartTiDBClusterBackup action
type StartTiDBClusterBackupResponse ¶ added in v0.22.68
type StartTiDBClusterBackupResponse struct {
response.CommonBase
// 备份id
BackupId string
// 返回信息
Message string
// 实例id
ServiceId string
}
StartTiDBClusterBackupResponse is response schema for StartTiDBClusterBackup action
type StartTiDBClusterRestoreRequest ¶ added in v0.22.68
type StartTiDBClusterRestoreRequest struct {
request.CommonBase
// 备份id
BackupId *string `required:"true"`
// 实例id
Id *string `required:"true"`
}
StartTiDBClusterRestoreRequest is request schema for StartTiDBClusterRestore action
type StartTiDBClusterRestoreResponse ¶ added in v0.22.68
type StartTiDBClusterRestoreResponse struct {
response.CommonBase
// 返回信息
Message string
// 恢复任务Id
RestoreId string
// 实例id
ServiceId string
}
StartTiDBClusterRestoreResponse is response schema for StartTiDBClusterRestore action
type TiDBClient ¶
TiDBClient is the client of TiDB
func NewClient ¶
func NewClient(config *ucloud.Config, credential *auth.Credential) *TiDBClient
NewClient will return a instance of TiDBClient
func (*TiDBClient) CreateTiDBClusterService ¶ added in v0.22.68
func (c *TiDBClient) CreateTiDBClusterService(req *CreateTiDBClusterServiceRequest) (*CreateTiDBClusterServiceResponse, error)
API: CreateTiDBClusterService
创建预付费实例
func (*TiDBClient) CreateTiDBService ¶
func (c *TiDBClient) CreateTiDBService(req *CreateTiDBServiceRequest) (*CreateTiDBServiceResponse, error)
API: CreateTiDBService
func (*TiDBClient) DeleteTiDBClusterService ¶ added in v0.22.68
func (c *TiDBClient) DeleteTiDBClusterService(req *DeleteTiDBClusterServiceRequest) (*DeleteTiDBClusterServiceResponse, error)
API: DeleteTiDBClusterService
删除预付费实例
func (*TiDBClient) DeleteTiDBService ¶
func (c *TiDBClient) DeleteTiDBService(req *DeleteTiDBServiceRequest) (*DeleteTiDBServiceResponse, error)
API: DeleteTiDBService
func (*TiDBClient) GetTiDBClusterService ¶ added in v0.22.68
func (c *TiDBClient) GetTiDBClusterService(req *GetTiDBClusterServiceRequest) (*GetTiDBClusterServiceResponse, error)
API: GetTiDBClusterService
获取预付费实例详情
func (*TiDBClient) GetTiDBClusterUhostSpecs ¶ added in v0.22.68
func (c *TiDBClient) GetTiDBClusterUhostSpecs(req *GetTiDBClusterUhostSpecsRequest) (*GetTiDBClusterUhostSpecsResponse, error)
API: GetTiDBClusterUhostSpecs
拉取预付费机器规格信息
func (*TiDBClient) ListTiDBClusterBackup ¶ added in v0.22.68
func (c *TiDBClient) ListTiDBClusterBackup(req *ListTiDBClusterBackupRequest) (*ListTiDBClusterBackupResponse, error)
API: ListTiDBClusterBackup
列出按实例备份tidb的备份列表
func (*TiDBClient) ListTiDBClusterRestore ¶ added in v0.22.68
func (c *TiDBClient) ListTiDBClusterRestore(req *ListTiDBClusterRestoreRequest) (*ListTiDBClusterRestoreResponse, error)
API: ListTiDBClusterRestore
列出实例恢复列表
func (*TiDBClient) ListTiDBClusterService ¶ added in v0.22.68
func (c *TiDBClient) ListTiDBClusterService(req *ListTiDBClusterServiceRequest) (*ListTiDBClusterServiceResponse, error)
API: ListTiDBClusterService
拉取预付费实例列表
func (*TiDBClient) ModifyTiDBClusterBinlog ¶ added in v0.22.68
func (c *TiDBClient) ModifyTiDBClusterBinlog(req *ModifyTiDBClusterBinlogRequest) (*ModifyTiDBClusterBinlogResponse, error)
API: ModifyTiDBClusterBinlog
开启/关闭 binlog
func (*TiDBClient) ModifyTiDBClusterNode ¶ added in v0.22.68
func (c *TiDBClient) ModifyTiDBClusterNode(req *ModifyTiDBClusterNodeRequest) (*ModifyTiDBClusterNodeResponse, error)
API: ModifyTiDBClusterNode
集群扩缩容
func (*TiDBClient) ModifyTiDBClusterTiFlash ¶ added in v0.22.68
func (c *TiDBClient) ModifyTiDBClusterTiFlash(req *ModifyTiDBClusterTiFlashRequest) (*ModifyTiDBClusterTiFlashResponse, error)
API: ModifyTiDBClusterTiFlash
开启/关闭 tiflash
func (*TiDBClient) ModifyTiDBClusterUhostDisk ¶ added in v0.22.68
func (c *TiDBClient) ModifyTiDBClusterUhostDisk(req *ModifyTiDBClusterUhostDiskRequest) (*ModifyTiDBClusterUhostDiskResponse, error)
API: ModifyTiDBClusterUhostDisk
变更集群节点磁盘容量
func (*TiDBClient) ModifyTiDBClusterUhostSpecs ¶ added in v0.22.68
func (c *TiDBClient) ModifyTiDBClusterUhostSpecs(req *ModifyTiDBClusterUhostSpecsRequest) (*ModifyTiDBClusterUhostSpecsResponse, error)
API: ModifyTiDBClusterUhostSpecs
修改集群主机规格
func (*TiDBClient) NewCreateTiDBClusterServiceRequest ¶ added in v0.22.68
func (c *TiDBClient) NewCreateTiDBClusterServiceRequest() *CreateTiDBClusterServiceRequest
NewCreateTiDBClusterServiceRequest will create request of CreateTiDBClusterService action.
func (*TiDBClient) NewCreateTiDBServiceRequest ¶
func (c *TiDBClient) NewCreateTiDBServiceRequest() *CreateTiDBServiceRequest
NewCreateTiDBServiceRequest will create request of CreateTiDBService action.
func (*TiDBClient) NewDeleteTiDBClusterServiceRequest ¶ added in v0.22.68
func (c *TiDBClient) NewDeleteTiDBClusterServiceRequest() *DeleteTiDBClusterServiceRequest
NewDeleteTiDBClusterServiceRequest will create request of DeleteTiDBClusterService action.
func (*TiDBClient) NewDeleteTiDBServiceRequest ¶
func (c *TiDBClient) NewDeleteTiDBServiceRequest() *DeleteTiDBServiceRequest
NewDeleteTiDBServiceRequest will create request of DeleteTiDBService action.
func (*TiDBClient) NewGetTiDBClusterServiceRequest ¶ added in v0.22.68
func (c *TiDBClient) NewGetTiDBClusterServiceRequest() *GetTiDBClusterServiceRequest
NewGetTiDBClusterServiceRequest will create request of GetTiDBClusterService action.
func (*TiDBClient) NewGetTiDBClusterUhostSpecsRequest ¶ added in v0.22.68
func (c *TiDBClient) NewGetTiDBClusterUhostSpecsRequest() *GetTiDBClusterUhostSpecsRequest
NewGetTiDBClusterUhostSpecsRequest will create request of GetTiDBClusterUhostSpecs action.
func (*TiDBClient) NewListTiDBClusterBackupRequest ¶ added in v0.22.68
func (c *TiDBClient) NewListTiDBClusterBackupRequest() *ListTiDBClusterBackupRequest
NewListTiDBClusterBackupRequest will create request of ListTiDBClusterBackup action.
func (*TiDBClient) NewListTiDBClusterRestoreRequest ¶ added in v0.22.68
func (c *TiDBClient) NewListTiDBClusterRestoreRequest() *ListTiDBClusterRestoreRequest
NewListTiDBClusterRestoreRequest will create request of ListTiDBClusterRestore action.
func (*TiDBClient) NewListTiDBClusterServiceRequest ¶ added in v0.22.68
func (c *TiDBClient) NewListTiDBClusterServiceRequest() *ListTiDBClusterServiceRequest
NewListTiDBClusterServiceRequest will create request of ListTiDBClusterService action.
func (*TiDBClient) NewModifyTiDBClusterBinlogRequest ¶ added in v0.22.68
func (c *TiDBClient) NewModifyTiDBClusterBinlogRequest() *ModifyTiDBClusterBinlogRequest
NewModifyTiDBClusterBinlogRequest will create request of ModifyTiDBClusterBinlog action.
func (*TiDBClient) NewModifyTiDBClusterNodeRequest ¶ added in v0.22.68
func (c *TiDBClient) NewModifyTiDBClusterNodeRequest() *ModifyTiDBClusterNodeRequest
NewModifyTiDBClusterNodeRequest will create request of ModifyTiDBClusterNode action.
func (*TiDBClient) NewModifyTiDBClusterTiFlashRequest ¶ added in v0.22.68
func (c *TiDBClient) NewModifyTiDBClusterTiFlashRequest() *ModifyTiDBClusterTiFlashRequest
NewModifyTiDBClusterTiFlashRequest will create request of ModifyTiDBClusterTiFlash action.
func (*TiDBClient) NewModifyTiDBClusterUhostDiskRequest ¶ added in v0.22.68
func (c *TiDBClient) NewModifyTiDBClusterUhostDiskRequest() *ModifyTiDBClusterUhostDiskRequest
NewModifyTiDBClusterUhostDiskRequest will create request of ModifyTiDBClusterUhostDisk action.
func (*TiDBClient) NewModifyTiDBClusterUhostSpecsRequest ¶ added in v0.22.68
func (c *TiDBClient) NewModifyTiDBClusterUhostSpecsRequest() *ModifyTiDBClusterUhostSpecsRequest
NewModifyTiDBClusterUhostSpecsRequest will create request of ModifyTiDBClusterUhostSpecs action.
func (*TiDBClient) NewSetTiDBConfigRequest ¶
func (c *TiDBClient) NewSetTiDBConfigRequest() *SetTiDBConfigRequest
NewSetTiDBConfigRequest will create request of SetTiDBConfig action.
func (*TiDBClient) NewStartTiDBClusterBackupRequest ¶ added in v0.22.68
func (c *TiDBClient) NewStartTiDBClusterBackupRequest() *StartTiDBClusterBackupRequest
NewStartTiDBClusterBackupRequest will create request of StartTiDBClusterBackup action.
func (*TiDBClient) NewStartTiDBClusterRestoreRequest ¶ added in v0.22.68
func (c *TiDBClient) NewStartTiDBClusterRestoreRequest() *StartTiDBClusterRestoreRequest
NewStartTiDBClusterRestoreRequest will create request of StartTiDBClusterRestore action.
func (*TiDBClient) NewUpgradeTiDBClusterRequest ¶ added in v0.22.68
func (c *TiDBClient) NewUpgradeTiDBClusterRequest() *UpgradeTiDBClusterRequest
NewUpgradeTiDBClusterRequest will create request of UpgradeTiDBCluster action.
func (*TiDBClient) SetTiDBConfig ¶
func (c *TiDBClient) SetTiDBConfig(req *SetTiDBConfigRequest) (*SetTiDBConfigResponse, error)
API: SetTiDBConfig
func (*TiDBClient) StartTiDBClusterBackup ¶ added in v0.22.68
func (c *TiDBClient) StartTiDBClusterBackup(req *StartTiDBClusterBackupRequest) (*StartTiDBClusterBackupResponse, error)
API: StartTiDBClusterBackup
开始按实例计费的tidb的备份
func (*TiDBClient) StartTiDBClusterRestore ¶ added in v0.22.68
func (c *TiDBClient) StartTiDBClusterRestore(req *StartTiDBClusterRestoreRequest) (*StartTiDBClusterRestoreResponse, error)
API: StartTiDBClusterRestore
开始按实例计费tidb的恢复
func (*TiDBClient) UpgradeTiDBCluster ¶ added in v0.22.68
func (c *TiDBClient) UpgradeTiDBCluster(req *UpgradeTiDBClusterRequest) (*UpgradeTiDBClusterResponse, error)
API: UpgradeTiDBCluster
升级预付费tidb集群
type UTiDBServiceData ¶ added in v0.22.68
type UTiDBServiceData struct {
// 自动备份状态
AutoBackup string
// 集群Binlog服务状态
BinlogState string
// 创建时间
CreateTime int
// 容灾类型
DTType int
// Dashboard地址
DashboardUrl string
// grafana地址
GrafanaUrl string
// 集群ID
Id string
// 集群ip
Ip string
// 集群名称
Name string
// 集群端口
Port int
// 集群状态
State string
// 子网ID
SubnetId string
// 集群TiFlash服务状态
TiFlashState string
// 私有网Id
VPCId string
// 集群版本
Version string
}
UTiDBServiceData - 预付费实例详情
type UhostSpecs ¶ added in v0.22.68
type UhostSpecs struct {
// 节点规格ID
ConfigId string
// 节点规格名称
ConfigName string
// CPU核数
CoreNum int
// 磁盘容量变更步长
DiskStep int
// 最大磁盘容量
MaxDiskCapacity int
// 内存
Memory int
// 最小磁盘容量
MinDiskCapacity int
// 节点类型
NodeType string
}
UhostSpecs - 预付费机器规格
type UpgradeTiDBClusterRequest ¶ added in v0.22.68
type UpgradeTiDBClusterRequest struct {
request.CommonBase
// 目标版本号
DbVersion *string `required:"true"`
// 实例id
Id *string `required:"true"`
// 任务开始时间
StartTime *int `required:"false"`
}
UpgradeTiDBClusterRequest is request schema for UpgradeTiDBCluster action
type UpgradeTiDBClusterResponse ¶ added in v0.22.68
type UpgradeTiDBClusterResponse struct {
response.CommonBase
// 返回信息
Message string
}
UpgradeTiDBClusterResponse is response schema for UpgradeTiDBCluster action