Documentation
¶
Index ¶
- type ArchitectureVersion
- type Az
- type Backup
- type BackupSpec
- type ConnectionAddr
- type DescribeParam
- type Disk
- type FilterGroup
- type Flavor
- type FullImportTask
- type Instance
- type K8sServiceAddr
- type MigrationTask
- type ModifyParam
- type NodeFlavor
- type NodeSpec
- type ReplicationSpec
- type ReplicationTask
- type ResourceInfo
- type Tag
- type TiDBNode
- type TidbInstanceAttribute
- type TidbInstanceSpec
- type WhiteList
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ArchitectureVersion ¶ added in v1.60.0
type Backup ¶
type Backup struct {
/* 备份ID (Optional) */
BackupId string `json:"backupId"`
/* 备份名称,最长支持64个英文字符或等长的中文字符 (Optional) */
BackupName string `json:"backupName"`
/* 备份所属实例ID (Optional) */
InstanceId string `json:"instanceId"`
/* 备份状态 (Optional) */
BackupStatus string `json:"backupStatus"`
/* 备份开始时间 (Optional) */
BackupStartTime string `json:"backupStartTime"`
/* 备份结束时间 (Optional) */
BackupEndTime string `json:"backupEndTime"`
/* 备份类型 (Optional) */
BackupType string `json:"backupType"`
/* 备份模式 (Optional) */
BackupMode string `json:"backupMode"`
/* 整个备份集大小,单位:Byte (Optional) */
BackupSizeByte int64 `json:"backupSizeByte"`
}
type BackupSpec ¶
type BackupSpec struct {
/* 备份名称,最长支持64个英文字符或等长的中文字符 */
BackupName string `json:"backupName"`
}
type ConnectionAddr ¶
type ConnectionAddr struct {
/* 连接信息的类型,目前支持以下类型:
- database: 通常数据访问,读写等
- pd: 数据迁移时连接PD节点
- monitor: 查看监控数据
- dms: 使用DMS客户端,访问数据库
(Optional) */
AddrType string `json:"addrType"`
/* 公网地址,域名或IP (Optional) */
InternetAddr string `json:"internetAddr"`
/* VPC内网地址,域名或IP (Optional) */
IntranetAddr string `json:"intranetAddr"`
/* 端口 (Optional) */
Port string `json:"port"`
}
type DescribeParam ¶
type DescribeParam struct {
/* 参数名称 (Optional) */
Name string `json:"name"`
/* 参数的描述 (Optional) */
Description string `json:"description"`
/* 参数的节点类型,包括TiKV,TiDB,PD,TiFlash (Optional) */
NodeType string `json:"nodeType"`
/* 参数的默认数值 (Optional) */
DefaultValue string `json:"defaultValue"`
/* 参数的当前值 (Optional) */
CurrentValue string `json:"currentValue"`
/* 参数修改是否需要重启生效,大小写敏感 -true:参数需要重启才能生效 -false:参数无需重启生效 (Optional) */
NeedRestart bool `json:"needRestart"`
}
type FilterGroup ¶
type Flavor ¶
type Flavor struct {
/* 规格代码,如tidb.s1.xlarge (Optional) */
InstanceClass string `json:"instanceClass"`
/* cpu核数 (Optional) */
Cpu int `json:"cpu"`
/* 内存大小,单位GB (Optional) */
MemoryGB int `json:"memoryGB"`
/* 默认存储规格,单位GB (Optional) */
DefaultStorageGB int `json:"defaultStorageGB"`
/* 该规格支持的存储空间,单位GB (Optional) */
StorageGB []int `json:"storageGB"`
}
type FullImportTask ¶
type Instance ¶
type Instance struct {
/* 实例ID (Optional) */
InstanceId string `json:"instanceId"`
/* 实例名称 (Optional) */
InstanceName string `json:"instanceName"`
/* 实例引擎版本 (Optional) */
EngineVersion string `json:"engineVersion"`
/* CPU架构 (Optional) */
Architecture string `json:"architecture"`
/* 实例引擎版本的详细版本号 (Optional) */
MinorVersion string `json:"minorVersion"`
/* 集群中节点的总数 (Optional) */
TotalNodeNum int `json:"totalNodeNum"`
/* 整个集群总的CPU核数 (Optional) */
TotalCPU int `json:"totalCPU"`
/* 整个集群总的内存大小,单位GB (Optional) */
TotalMemoryGB int `json:"totalMemoryGB"`
/* 整个集群总的存储空间大小,单位GB (Optional) */
TotalStorageGB int `json:"totalStorageGB"`
/* 地域ID (Optional) */
RegionId string `json:"regionId"`
/* 可用区ID,目前仅支持单可用区 (Optional) */
AzId []string `json:"azId"`
/* VPC的ID (Optional) */
VpcId string `json:"vpcId"`
/* 子网的ID (Optional) */
SubnetId string `json:"subnetId"`
/* 实例状态,参见[枚举参数定义](../Enum-Definitions/Enum-Definitions.md) (Optional) */
InstanceStatus string `json:"instanceStatus"`
/* 实例创建时间, UTC 时间格式 (Optional) */
CreateTime string `json:"createTime"`
/* 计费配置 (Optional) */
Charge charge.Charge `json:"charge"`
/* 标签信息 (Optional) */
Tags []Tag `json:"tags"`
}
type K8sServiceAddr ¶
type MigrationTask ¶
type MigrationTask struct {
/* 迁移任务ID (Optional) */
TaskId string `json:"taskId"`
/* 迁移任务类型,大小写不敏感,FULL_IMPORT:全量数据导入 (Optional) */
MigrationType string `json:"migrationType"`
/* 任务状态 (Optional) */
Status string `json:"status"`
/* 任务开始时间 (Optional) */
StartTime string `json:"startTime"`
/* 任务结束时间 (Optional) */
EndTime string `json:"endTime"`
/* 任务持续时间,单位分钟 (Optional) */
Duration int `json:"duration"`
/* 迁移的数据文件名,包含bucket的全路径,例如dbbak/my_erp/erp.tar.gz (Optional) */
FileName string `json:"fileName"`
}
type ModifyParam ¶
type NodeFlavor ¶
type NodeSpec ¶
type NodeSpec struct {
/* 节点类型:tidb、tikv、pd、monitor */
NodeType string `json:"nodeType"`
/* 节点数 */
NodeNum int `json:"nodeNum"`
/* 节点的规格代码 */
NodeClass string `json:"nodeClass"`
/* cpu核数 (Optional) */
Cpu *int `json:"cpu"`
/* 内存大小,单位GB (Optional) */
MemoryGB *int `json:"memoryGB"`
/* 存储类型 */
StorageType string `json:"storageType"`
/* 存储空间,单位GB */
StorageGB int `json:"storageGB"`
}
type ReplicationSpec ¶
type ReplicationSpec struct {
/* 复制的起始时间戳 (Optional) */
StartTS *string `json:"startTS"`
/* 要复制的对象列表 (Optional) */
ReplicationObjects []string `json:"replicationObjects"`
/* 目标实例类型 (Optional) */
TargetType *string `json:"targetType"`
/* 目标实例IP (Optional) */
TargetIP *string `json:"targetIP"`
/* 目标实例端口 (Optional) */
TargetPort *string `json:"targetPort"`
/* 目标实例备注说明 (Optional) */
TargetComment *string `json:"targetComment"`
/* 目标类型为TiDB或MySQL时,连接目标实例的用户名 (Optional) */
TargetUser *string `json:"targetUser"`
/* 目标类型为TiDB或MySQL时,连接目标实例的密码 (Optional) */
TargetPassword *string `json:"targetPassword"`
/* Kafka的Topic (Optional) */
KafkaTopic *string `json:"kafkaTopic"`
/* Kafka的版本 (Optional) */
KafkaVersion *string `json:"kafkaVersion"`
/* 消息的格式 (Optional) */
KafkaProtocol *string `json:"kafkaProtocol"`
}
type ReplicationTask ¶
type ReplicationTask struct {
/* 复制任务ID (Optional) */
TaskId string `json:"taskId"`
/* 目标实例类型 (Optional) */
TargetType string `json:"targetType"`
/* 复制的对象,格式为"库名.表名”,支持?* 通配符,例如 db1.* 、 db2.tab? ,*.* 表示复制整个实例 (Optional) */
ReplicationObjects string `json:"replicationObjects"`
/* 目标实例IP (Optional) */
TargetIP string `json:"targetIP"`
/* 目标实例端口 (Optional) */
TargetPort string `json:"targetPort"`
/* 目标类型为TiDB或MySQL时,连接目标实例的用户名 (Optional) */
TargetUser string `json:"targetUser"`
/* Kafka的Topic (Optional) */
KafkaTopic string `json:"kafkaTopic"`
/* Kafka的版本 (Optional) */
KafkaVersion string `json:"kafkaVersion"`
/* 目标实例备注说明 (Optional) */
TargetComment string `json:"targetComment"`
/* 任务状态 (Optional) */
TaskStatus string `json:"taskStatus"`
/* 复制的起始时间 (Optional) */
StartTime string `json:"startTime"`
/* Checkpoint时间 (Optional) */
CheckpointTime string `json:"checkpointTime"`
/* 任务创建时间 (Optional) */
CreateTime string `json:"createTime"`
}
type ResourceInfo ¶
type TiDBNode ¶
type TiDBNode struct {
/* 节点ID (Optional) */
NodeId string `json:"nodeId"`
/* 节点类型,支持,tidb,tikv,pd,tiflash,monitor (Optional) */
NodeType string `json:"nodeType"`
/* 节点状态 (Optional) */
NodeStatus string `json:"nodeStatus"`
/* CPU 使用百分比,例如0.832表示CPU使用率为83.2% (Optional) */
CpuUtil float32 `json:"cpuUtil"`
/* 内存使用百分比,例如0.832表示内存使用率为83.2% (Optional) */
MemeryUtil float32 `json:"memeryUtil"`
/* 存储使用百分比,例如0.832表示存储使用率为83.2% (Optional) */
DiskUsage float32 `json:"diskUsage"`
}
type TidbInstanceAttribute ¶
type TidbInstanceAttribute struct {
/* 实例ID (Optional) */
InstanceId string `json:"instanceId"`
/* 实例名称 (Optional) */
InstanceName string `json:"instanceName"`
/* 实例引擎版本 (Optional) */
EngineVersion string `json:"engineVersion"`
/* CPU架构 (Optional) */
Architecture string `json:"architecture"`
/* 实例引擎版本的详细版本号 (Optional) */
MinorVersion string `json:"minorVersion"`
/* 集群中节点的总数 (Optional) */
TotalNodeNum int `json:"totalNodeNum"`
/* TiDB节点规格和数目 (Optional) */
TidbNodeSpec NodeSpec `json:"tidbNodeSpec"`
/* TiKV节点规格和数目 (Optional) */
TikvNodeSpec NodeSpec `json:"tikvNodeSpec"`
/* PD节点规格和数目 (Optional) */
PdNodeSpec NodeSpec `json:"pdNodeSpec"`
/* Monitor节点规格,只能有1个Monitor节点 (Optional) */
MonitorNodeSpec NodeSpec `json:"monitorNodeSpec"`
/* TiFlash节点规格和数目 (Optional) */
TiflashNodeSpec NodeSpec `json:"tiflashNodeSpec"`
/* Ticdc节点规格和数目 (Optional) */
TicdcNodeSpec NodeSpec `json:"ticdcNodeSpec"`
/* 整个集群总的CPU核数 (Optional) */
TotalCPU int `json:"totalCPU"`
/* 整个集群总的内存大小,单位GB (Optional) */
TotalMemoryGB int `json:"totalMemoryGB"`
/* 整个集群总的存储空间大小,单位GB (Optional) */
TotalStorageGB int `json:"totalStorageGB"`
/* 地域ID (Optional) */
RegionId string `json:"regionId"`
/* 可用区ID,目前仅支持单可用区 (Optional) */
AzId []string `json:"azId"`
/* VPC的ID (Optional) */
VpcId string `json:"vpcId"`
/* 子网的ID (Optional) */
SubnetId string `json:"subnetId"`
/* TiDB内网域名 (Optional) */
InternalDomainName string `json:"internalDomainName"`
/* TiDB公网域名 (Optional) */
PublicDomainName string `json:"publicDomainName"`
/* TiDB监控的内网域名 (Optional) */
MonitorInternalDomainName string `json:"monitorInternalDomainName"`
/* TiDB监控的公网域名 (Optional) */
MonitorPublicDomainName string `json:"monitorPublicDomainName"`
/* PD的内网域名 (Optional) */
PdInternalDomainName string `json:"pdInternalDomainName"`
/* PD的公网域名 (Optional) */
PdPublicDomainName string `json:"pdPublicDomainName"`
/* DMS的内网域名 (Optional) */
DmsInternalDomainName string `json:"dmsInternalDomainName"`
/* DMS的公网域名 (Optional) */
DmsPublicDomainName string `json:"dmsPublicDomainName"`
/* 应用访问端口 (Optional) */
InstancePort string `json:"instancePort"`
/* TiDB监控的端口 (Optional) */
MonitorPort string `json:"monitorPort"`
/* PD的端口 (Optional) */
PdPort string `json:"pdPort"`
/* DMS的端口 (Optional) */
DmsPort string `json:"dmsPort"`
/* 实例状态,参见[枚举参数定义](../Enum-Definitions/Enum-Definitions.md) (Optional) */
InstanceStatus string `json:"instanceStatus"`
/* 实例创建时间, UTC 时间格式 (Optional) */
CreateTime string `json:"createTime"`
/* 计费配置 (Optional) */
Charge charge.Charge `json:"charge"`
/* 标签信息 (Optional) */
Tags []Tag `json:"tags"`
}
type TidbInstanceSpec ¶
type TidbInstanceSpec struct {
/* 实例名 */
InstanceName string `json:"instanceName"`
/* TiDB引擎版本 (Optional) */
EngineVersion *string `json:"engineVersion"`
/* CPU架构 */
Architecture string `json:"architecture"`
/* TiDB节点规格和数目 */
TidbNodeSpec *NodeSpec `json:"tidbNodeSpec"`
/* TiKV节点规格和数目 */
TikvNodeSpec *NodeSpec `json:"tikvNodeSpec"`
/* PD节点规格和数目 */
PdNodeSpec *NodeSpec `json:"pdNodeSpec"`
/* Monitor节点规格,只能有1个Monitor节点 */
MonitorNodeSpec *NodeSpec `json:"monitorNodeSpec"`
/* TiFlash节点规格和数目 (Optional) */
TiflashNodeSpec *NodeSpec `json:"tiflashNodeSpec"`
/* Ticdc节点规格和数目 (Optional) */
TicdcNodeSpec *NodeSpec `json:"ticdcNodeSpec"`
/* 可用区ID,目前仅支持单可用区部署 */
AzId []string `json:"azId"`
/* VPC的ID */
VpcId string `json:"vpcId"`
/* 子网ID */
SubnetId string `json:"subnetId"`
/* 计费规格,包括计费类型,计费周期等 */
ChargeSpec *charge.ChargeSpec `json:"chargeSpec"`
/* 标签信息 (Optional) */
TagSpec []Tag `json:"tagSpec"`
}
Source Files
¶
- ArchitectureVersion.go
- Az.go
- Backup.go
- BackupSpec.go
- ConnectionAddr.go
- DescribeParam.go
- Disk.go
- FilterGroup.go
- Flavor.go
- FullImportTask.go
- Instance.go
- K8sServiceAddr.go
- MigrationTask.go
- ModifyParam.go
- NodeFlavor.go
- NodeSpec.go
- ReplicationSpec.go
- ReplicationTask.go
- ResourceInfo.go
- Tag.go
- TiDBNode.go
- TidbInstanceAttribute.go
- TidbInstanceSpec.go
- WhiteList.go
Click to show internal directories.
Click to hide internal directories.