Documentation
¶
Index ¶
- type AvailableZones
- type Backup
- type BackupDownloadURL
- type BackupSynchronicity
- type Configserver
- type DBInstance
- type DBInstanceInternal
- type DBInstanceSpec
- type Flavor
- type MongodbInfos
- type Mongos
- type Quota
- type Shard
- type ShardingDBInstanceSpec
- type SpaceId
- type Tag
- type Topology
- type TopologyPair
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AvailableZones ¶ added in v1.0.10
type Backup ¶
type Backup struct {
/* 备份ID (Optional) */
BackupId string `json:"backupId"`
/* 备份名称 (Optional) */
BackupName string `json:"backupName"`
/* 备份所属实例ID (Optional) */
InstanceId string `json:"instanceId"`
/* 备份状态,Waiting(等待中)、Running(备份中)、Finished(已完成)、(Failed错误) (Optional) */
BackupStatus string `json:"backupStatus"`
/* 备份开始时间 (Optional) */
BackupStartTime string `json:"backupStartTime"`
/* 备份结束时间 (Optional) */
BackupEndTime string `json:"backupEndTime"`
/* 备份模式,Automated(系统自动备份)、Manual(手动备份) (Optional) */
BackupMode string `json:"backupMode"`
/* 备份方式,Logical - 逻辑备份、Physical - 物理备份 (Optional) */
BackupMethod string `json:"backupMethod"`
/* 整个备份集大小,单位:Byte (Optional) */
BackupSizeByte int `json:"backupSizeByte"`
}
type BackupDownloadURL ¶
type BackupDownloadURL struct {
/* 备份名称 (Optional) */
BackupName string `json:"backupName"`
/* 公网下载链接的地址 (Optional) */
BackupInternetDownloadURL string `json:"backupInternetDownloadURL"`
/* 内网下载链接的地址 (Optional) */
BackupIntranetDownloadURL string `json:"backupIntranetDownloadURL"`
/* 公网和内网的下载链接过期时间 (Optional) */
LinkExpiredTime string `json:"linkExpiredTime"`
}
type BackupSynchronicity ¶ added in v1.0.10
type BackupSynchronicity struct {
/* 跨地域备份同步服务ID (Optional) */
ServiceId string `json:"serviceId"`
/* MongoDB 实例ID (Optional) */
InstanceId string `json:"instanceId"`
/* MongoDB 实例名称 (Optional) */
InstanceName string `json:"instanceName"`
/* 跨地域备份同步服务状态,正常,running;错误,error (Optional) */
ServiceStatus string `json:"serviceStatus"`
/* 源实例所在地域 (Optional) */
SrcRegion string `json:"srcRegion"`
/* 跨地域备份同步服务的目的地域 (Optional) */
DstRegion string `json:"dstRegion"`
/* 数据库类型 (Optional) */
Engine string `json:"engine"`
/* 数据库版本 (Optional) */
EngineVersion string `json:"engineVersion"`
/* 创建时间 (Optional) */
CreateTime string `json:"createTime"`
/* 跨地域备份的最新数据时间点 (Optional) */
NewestDataTime string `json:"newestDataTime"`
}
type Configserver ¶ added in v1.21.0
type Configserver struct {
/* configserver节点ID (Optional) */
ConfigserverNodeId string `json:"configserverNodeId"`
/* configserver节点状态 (Optional) */
ConfigserverNodeStatus string `json:"configserverNodeStatus"`
/* configserver节点名称,configserver (Optional) */
ConfigserverNodeName string `json:"configserverNodeName"`
/* configserver节点规格代码 (Optional) */
ConfigserverNodeType string `json:"configserverNodeType"`
/* configserver节点所在地域 (Optional) */
ConfigserverNodeAzId string `json:"configserverNodeAzId"`
/* configserver节点的CPU (Optional) */
ConfigserverNodeCPU int `json:"configserverNodeCPU"`
/* configserver节点的Memory (Optional) */
ConfigserverNodeMemoryGB int `json:"configserverNodeMemoryGB"`
}
type DBInstance ¶
type DBInstance struct {
/* 实例ID (Optional) */
InstanceId string `json:"instanceId"`
/* 实例名称 (Optional) */
InstanceName string `json:"instanceName"`
/* 实例类型,副本集:Replication;分片集群:Sharding; (Optional) */
InstanceType string `json:"instanceType"`
/* 数据库类型 (Optional) */
Engine string `json:"engine"`
/* 数据库版本 (Optional) */
EngineVersion string `json:"engineVersion"`
/* 存储类型。LOCAL_SSD -本地盘SSD、LOCAL_NVMe -本地盘NVMe、EBS_SSD-SSD云盘。 (Optional) */
InstanceStorageType string `json:"instanceStorageType"`
/* 实例数据加密(存储类型为云硬盘才支持数据加密)。 false:不加密;true:加密。缺省为false。 (Optional) */
StorageEncrypted bool `json:"storageEncrypted"`
/* 副本集实例规格代码 (Optional) */
InstanceClass string `json:"instanceClass"`
/* 副本集存储空间 (Optional) */
InstanceStorageGB int `json:"instanceStorageGB"`
/* 副本集CPU核数 (Optional) */
InstanceCPU int `json:"instanceCPU"`
/* 副本集内存,单位GB (Optional) */
InstanceMemoryGB int `json:"instanceMemoryGB"`
/* 副本集可用区区ID,依次为主、从、隐藏节点所在可用区 (Optional) */
AzId []string `json:"azId"`
/* VPCID (Optional) */
VpcId string `json:"vpcId"`
/* 子网ID (Optional) */
SubnetId string `json:"subnetId"`
/* 副本集名称 (Optional) */
ReplicaSetName string `json:"replicaSetName"`
/* 副本集域名 (Optional) */
InstanceDomain string `json:"instanceDomain"`
/* 默认库名 (Optional) */
DBName string `json:"dBName"`
/* 默认用户名 (Optional) */
AccountName string `json:"accountName"`
/* 副本集访问端口 (Optional) */
InstancePort string `json:"instancePort"`
/* 实例状态.RUNNING:运行, ERROR:错误 ,BUILDING:创建中, DELETING:删除中, RESTORING:恢复中, RESIZING:变配中 (Optional) */
InstanceStatus string `json:"instanceStatus"`
/* 自动备份保留时间 (Optional) */
BackupRetentionPeriod int `json:"backupRetentionPeriod"`
/* 创建时间 (Optional) */
CreateTime string `json:"createTime"`
/* 自动备份时间,如:00:00-02:00,表示0点到2点进行数据库自动备份 (Optional) */
PreferredBackupWindow string `json:"preferredBackupWindow"`
/* 系统维护时间,如:00:00-02:00,表示0点到2点进行系统维护 (Optional) */
PreferredmaintenanceWindow string `json:"preferredmaintenanceWindow"`
/* 计费信息 (Optional) */
Charge charge.Charge `json:"charge"`
/* 是否设置白名单,true:已设置,false:未设置 (Optional) */
IsSetSecurityIps bool `json:"isSetSecurityIps"`
/* 标签 (Optional) */
Tags []Tag `json:"tags"`
/* mongos信息 (Optional) */
Mongos []Mongos `json:"mongos"`
/* configserver信息 (Optional) */
Configserver []Configserver `json:"configserver"`
/* shard信息 (Optional) */
Shard []Shard `json:"shard"`
}
type DBInstanceInternal ¶ added in v1.21.0
type DBInstanceInternal struct {
/* 实例ID (Optional) */
InstanceId string `json:"instanceId"`
/* 实例名称 (Optional) */
InstanceName string `json:"instanceName"`
/* 实例状态.RUNNING:运行, ERROR:错误 ,BUILDING:创建中, DELETING:删除中, RESTORING:恢复中, RESIZING:变配中 (Optional) */
InstanceStatus string `json:"instanceStatus"`
}
type DBInstanceSpec ¶
type DBInstanceSpec struct {
/* 实例名称,只支持数字、字母、英文下划线、中文,且不少于2字符不超过32字符。 (Optional) */
InstanceName *string `json:"instanceName"`
/* 数据库类型,MongoDB (Optional) */
Engine *string `json:"engine"`
/* 数据库版本,3.2 (Optional) */
EngineVersion *string `json:"engineVersion"`
/* 实例规格代码。mongo.s1.small:1核2G;mongo.s1.medium:2核4G;mongo.s1.large:4核8G;mongo.s1.xlarge:8核16G;mongo.s2.2xlarge:8核32G;mongo.s2.4xlarge:16核64G; */
InstanceClass string `json:"instanceClass"`
/* 存储空间,单位GB,取值10-1000,10的倍数。 */
InstanceStorageGB int `json:"instanceStorageGB"`
/* 是否选择多可用区部署 */
MultiAZ bool `json:"multiAZ"`
/* 可用区ID,必填,依次为primary、secondary、hidden所在的可用区ID。multiAZ选择否,则三个节点需要写相同的可用区ID;multiAZ选择是,如当前地域的可用区数量为2,则primary与secondary的可用区ID需相同,且与hidden不同;如当前地域的可用区数量大于2,则3个可用区ID均需不同。 */
AzId []string `json:"azId"`
/* VPCID */
VpcId string `json:"vpcId"`
/* 子网ID */
SubnetId string `json:"subnetId"`
/* 密码,必须包含且只支持字母及数字,不少于8字符不超过16字符。 (Optional) */
Password *string `json:"password"`
/* 按备份创建使用的具体备份ID (Optional) */
BackupId *string `json:"backupId"`
/* 基于一个实例的备份创建新实例,如填写则restoreTime也需要填写。 (Optional) */
OriginDBInstanceId *string `json:"originDBInstanceId"`
/* 用户指定备份保留周期内的任意时间点,如2011-06-11T16:00:00Z,非必填,与backupId互斥。 (Optional) */
RestoreTime *string `json:"restoreTime"`
/* 存储类型。参考枚举参数定义,LOCAL_SSD -本地盘SSD、LOCAL_NVMe -本地盘NVMe,缺省值为:LOCAL_SSD (Optional) */
InstanceStorageType *string `json:"instanceStorageType"`
/* 实例数据加密(存储类型为云硬盘才支持数据加密)。 false:不加密;true:加密。缺省为false。 (Optional) */
StorageEncrypted *bool `json:"storageEncrypted"`
}
type Flavor ¶ added in v1.0.10
type Flavor struct {
/* 实例类型,副本集:Replication;分片集群:Sharding (Optional) */
InstanceType string `json:"instanceType"`
/* 副本集规格代码 (Optional) */
InstanceClass string `json:"instanceClass"`
/* 分片集群节点角色,mongos、configserver、shard (Optional) */
NodeRole string `json:"nodeRole"`
/* 分片集群节点规格代码 (Optional) */
NodeType string `json:"nodeType"`
/* CPU核数 (Optional) */
Cpu int `json:"cpu"`
/* 内存 ,单位GB (Optional) */
Memory int `json:"memory"`
/* iops (Optional) */
Iops int `json:"iops"`
/* 最大连接数 (Optional) */
MaxLink int `json:"maxLink"`
/* 最大磁盘数,单位GB (Optional) */
MaxDisk int `json:"maxDisk"`
/* 最下磁盘数,单位GB (Optional) */
MinDisk int `json:"minDisk"`
/* 磁盘步长 (Optional) */
DiskStep int `json:"diskStep"`
/* 存储类型。LOCAL_SSD -本地盘SSD、LOCAL_NVMe -本地盘NVMe、EBS_SSD-SSD云盘。 (Optional) */
InstanceStorageType string `json:"instanceStorageType"`
}
type MongodbInfos ¶ added in v1.0.10
type Mongos ¶ added in v1.21.0
type Mongos struct {
/* mongos节点ID (Optional) */
MongosNodeId string `json:"mongosNodeId"`
/* mongos节点状态 (Optional) */
MongosNodeStatus string `json:"mongosNodeStatus"`
/* mongos节点名称,mongos-N (Optional) */
MongosNodeName string `json:"mongosNodeName"`
/* mongos节点规格代码 (Optional) */
MongosNodeType string `json:"mongosNodeType"`
/* mongos节点域名 (Optional) */
MongosNodeDomain string `json:"mongosNodeDomain"`
/* mongos节点端口 (Optional) */
MongosNodePort string `json:"mongosNodePort"`
/* mongos节点所在地域 (Optional) */
MongosNodeAzId string `json:"mongosNodeAzId"`
/* mongos节点的CPU (Optional) */
MongosNodeCPU int `json:"mongosNodeCPU"`
/* mongos节点的Memory (Optional) */
MongosNodeMemoryGB int `json:"mongosNodeMemoryGB"`
}
type Shard ¶ added in v1.21.0
type Shard struct {
/* shard节点ID (Optional) */
ShardNodeId string `json:"shardNodeId"`
/* shard节点状态 (Optional) */
ShardNodeStatus string `json:"shardNodeStatus"`
/* shard节点名称,shad-N (Optional) */
ShardNodeName string `json:"shardNodeName"`
/* shard节点规格代码 (Optional) */
ShardNodeType string `json:"shardNodeType"`
/* shard节点存储空间 (Optional) */
ShardNodeStorageGB int `json:"shardNodeStorageGB"`
/* shard节点所在地域 (Optional) */
ShardNodeAzId string `json:"shardNodeAzId"`
/* shard节点的CPU (Optional) */
ShardNodeCPU int `json:"shardNodeCPU"`
/* shard节点的Memory (Optional) */
ShardNodeMemoryGB int `json:"shardNodeMemoryGB"`
}
type ShardingDBInstanceSpec ¶ added in v1.21.0
type ShardingDBInstanceSpec struct {
/* 实例名称,名称只支持中文、数字、大小写字母及英文下划线“_”及中划线“-”,2-32个字符。 (Optional) */
InstanceName *string `json:"instanceName"`
/* 数据库类型,默认为MongoDB。 (Optional) */
Engine *string `json:"engine"`
/* 数据库版本,支持:3.4, 3.6;默认为3.6。 (Optional) */
EngineVersion *string `json:"engineVersion"`
/* mongos节点规格代码,必填。 */
MongosNodeType string `json:"mongosNodeType"`
/* mongos节点数量,支持2-32个,必填。 (Optional) */
MongosNodeNumber *int `json:"mongosNodeNumber"`
/* configserve节点规格代码,默认为mongo.m1.small。 (Optional) */
ConfigserverNodeType *string `json:"configserverNodeType"`
/* shard节点规格代码,必填。 */
ShardNodeType string `json:"shardNodeType"`
/* shard节点存储空间,单位GB,取值10-1000,10的倍数,必填。 */
ShardNodeStorageGB int `json:"shardNodeStorageGB"`
/* mongos节点数量,支持2-32个,必填。 */
ShardNodeNumber int `json:"shardNodeNumber"`
/* 是否选择多可用区部署,默认为否。 (Optional) */
MultiAZ *bool `json:"multiAZ"`
/* 必填。单可用区部署,填写1个可用区;多可用区部署,依次填写每个mongos所在可用区,数量与mognos节点数量一致。 */
MongosAzId []string `json:"mongosAzId"`
/* 必填。单可用区部署,填写1个可用区;多可用区部署,需填写3个可用区,依次为副本集的primary、secondary、hidden所在的可用区,将应用到分片集群的shard节点和configserver节点的全部副本集。 */
ShardAzId []string `json:"shardAzId"`
/* VPCID */
VpcId string `json:"vpcId"`
/* 子网ID */
SubnetId string `json:"subnetId"`
/* 密码,必须包含且只支持字母及数字,不少于8字符不超过16字符。 (Optional) */
Password *string `json:"password"`
/* 基于一个实例的备份创建新实例,如填写则restoreTime也需要填写。 (Optional) */
OriginDBInstanceId *string `json:"originDBInstanceId"`
/* 用户指定备份保留周期内的任意时间点,如2011-06-11T16:00:00Z。 (Optional) */
RestoreTime *string `json:"restoreTime"`
/* 存储类型,支持:LOCAL_SSD -本地盘SSD、EBS_SSD -云盘;默认值为:LOCAL_SSD。 (Optional) */
InstanceStorageType *string `json:"instanceStorageType"`
/* 实例数据加密(存储类型为云硬盘才支持数据加密). false:不加密; true:加密. 缺省为false. (Optional) */
StorageEncrypted *bool `json:"storageEncrypted"`
/* 跨域服务ID,用于跨地域按时间点创建实例 (Optional) */
ServiceId *string `json:"serviceId"`
}
type Topology ¶ added in v1.0.10
type Topology struct {
/* 主 (Optional) */
Primary TopologyPair `json:"primary"`
/* 备 (Optional) */
Secondary []TopologyPair `json:"secondary"`
/* 隐藏 (Optional) */
Hidden []TopologyPair `json:"hidden"`
}
Click to show internal directories.
Click to hide internal directories.