Auth
用户权限
被如下接口引用:SetAccountUserPrivilege。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
NameSpace | String | 是 | *表示所有数据库,db.name表示特定的name数据库。 |
Mask | Integer | 是 | 用于控制权限,0无权限,1只读,2只写,3读写。 |
BackupDownloadTask
备份下载任务
被如下接口引用:DescribeBackupDownloadTask。
名称 | 类型 | 描述 |
---|---|---|
CreateTime | String | 任务创建时间 |
BackupName | String | 备份文件名 |
ReplicaSetId | String | 分片名称 |
BackupSize | Integer | 备份数据大小,单位为字节 |
Status | Integer | 任务状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试 |
Percent | Integer | 任务进度百分比 |
TimeSpend | Integer | 耗时,单位为秒 |
Url | String | 备份数据下载链接 |
BackupMethod | Integer | 备份文件备份类型,0-逻辑备份,1-物理备份 |
BackupDesc | String | 发起备份时指定的备注信息 注意:此字段可能返回 null,表示取不到有效值。 |
BackupDownloadTaskStatus
创建备份下载任务结果
被如下接口引用:CreateBackupDownloadTask。
名称 | 类型 | 描述 |
---|---|---|
ReplicaSetId | String | 分片名 |
Status | Integer | 任务当前状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试 |
BackupFile
备份文件存储信息
被如下接口引用:DescribeBackupAccess。
名称 | 类型 | 描述 |
---|---|---|
ReplicateSetId | String | 备份文件所属的副本集/分片ID |
File | String | 备份文件保存路径 |
BackupInfo
备份信息
被如下接口引用:DescribeDBBackups。
名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例ID |
BackupType | Integer | 备份方式,0-自动备份,1-手动备份 |
BackupName | String | 备份名称 |
BackupDesc | String | 备份备注 注意:此字段可能返回 null,表示取不到有效值。 |
BackupSize | Integer | 备份文件大小,单位KB 注意:此字段可能返回 null,表示取不到有效值。 |
StartTime | String | 备份开始时间 注意:此字段可能返回 null,表示取不到有效值。 |
EndTime | String | 备份结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
Status | Integer | 备份状态,1-备份中,2-备份成功 |
BackupMethod | Integer | 备份方法,0-逻辑备份,1-物理备份 |
ClientConnection
客户端连接信息,包括客户端IP和连接数
被如下接口引用:DescribeClientConnections。
名称 | 类型 | 描述 |
---|---|---|
IP | String | 连接的客户端IP |
Count | Integer | 对应客户端IP的连接数 |
InternalService | Boolean | 是否为内部ip |
CurrentOp
云数据库实例当前操作
被如下接口引用:DescribeCurrentOp。
名称 | 类型 | 描述 |
---|---|---|
OpId | Integer | 操作序号 注意:此字段可能返回 null,表示取不到有效值。 |
Ns | String | 操作所在的命名空间,形式如db.collection 注意:此字段可能返回 null,表示取不到有效值。 |
Query | String | 操作执行语句 注意:此字段可能返回 null,表示取不到有效值。 |
Op | String | 操作类型,可能的取值:aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command 注意:此字段可能返回 null,表示取不到有效值。 |
ReplicaSetName | String | 操作所在的分片名称 |
State | String | 筛选条件,节点状态,可能的取值为:Primary、Secondary 注意:此字段可能返回 null,表示取不到有效值。 |
Operation | String | 操作详细信息 注意:此字段可能返回 null,表示取不到有效值。 |
NodeName | String | 操作所在的节点名称 |
MicrosecsRunning | Integer | 操作已执行时间(ms) 注意:此字段可能返回 null,表示取不到有效值。 |
DBInstanceInfo
实例信息
被如下接口引用:DescribeDBInstances。
名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例ID |
Region | String | 地域信息 |
DBInstancePrice
数据库实例价格
被如下接口引用:InquirePriceCreateDBInstances, InquirePriceModifyDBInstanceSpec, InquirePriceRenewDBInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
UnitPrice | Float | 是 | 单价 注意:此字段可能返回 null,表示取不到有效值。 |
OriginalPrice | Float | 是 | 原价 |
DiscountPrice | Float | 是 | 折扣加 |
InstanceChargePrepaid
描述了实例的计费模式
被如下接口引用:InquirePriceRenewDBInstances, RenewDBInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Period | Integer | 否 | 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。 (InquirePriceRenewDBInstances,RenewDBInstances调用时必填) |
RenewFlag | String | 否 | 自动续费标识。取值范围: NOTIFY_AND_AUTO_RENEW:通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费 默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 (InquirePriceRenewDBInstances,RenewDBInstances调用时必填) |
InstanceDetail
实例详情
被如下接口引用:DescribeDBInstances。
名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例ID |
InstanceName | String | 实例名称 |
PayMode | Integer | 付费类型,可能的返回值:1-包年包月;0-按量计费 |
ProjectId | Integer | 项目ID |
ClusterType | Integer | 集群类型,可能的返回值:0-副本集实例,1-分片实例, |
Region | String | 地域信息 |
Zone | String | 可用区信息 |
NetType | Integer | 网络类型,可能的返回值:0-基础网络,1-私有网络 |
VpcId | String | 私有网络的ID |
SubnetId | String | 私有网络的子网ID |
Status | Integer | 实例状态,可能的返回值:0-待初始化,1-流程处理中,2-运行中,-2-实例已过期 |
Vip | String | 实例IP |
Vport | Integer | 端口号 |
CreateTime | Timestamp | 实例创建时间 |
DeadLine | Timestamp | 实例到期时间 |
MongoVersion | String | 实例版本信息 |
Memory | Integer | 实例内存规格,单位为MB |
Volume | Integer | 实例磁盘规格,单位为MB |
CpuNum | Integer | 实例CPU核心数 |
MachineType | String | 实例机器类型 |
SecondaryNum | Integer | 实例从节点数 |
ReplicationSetNum | Integer | 实例分片数 |
AutoRenewFlag | Integer | 实例自动续费标志,可能的返回值:0-手动续费,1-自动续费,2-确认不续费 |
UsedVolume | Integer | 已用容量,单位MB |
MaintenanceStart | String | 维护窗口起始时间 |
MaintenanceEnd | String | 维护窗口结束时间 |
ReplicaSets | Array of ShardInfo | 分片信息 |
ReadonlyInstances | Array of DBInstanceInfo | 只读实例信息 |
StandbyInstances | Array of DBInstanceInfo | 灾备实例信息 |
CloneInstances | Array of DBInstanceInfo | 临时实例信息 |
RelatedInstance | DBInstanceInfo | 关联实例信息,对于正式实例,该字段表示它的临时实例信息;对于临时实例,则表示它的正式实例信息;如果为只读/灾备实例,则表示他的主实例信息 |
Tags | Array of TagInfo | 实例标签信息集合 |
InstanceVer | Integer | 实例版本标记 |
ClusterVer | Integer | 实例版本标记 |
Protocol | Integer | 协议信息,可能的返回值:1-mongodb,2-dynamodb |
InstanceType | Integer | 实例类型,可能的返回值,1-正式实例,2-临时实例,3-只读实例,4-灾备实例 |
InstanceStatusDesc | String | 实例状态描述 |
RealInstanceId | String | 实例对应的物理实例id,回档并替换过的实例有不同的InstanceId和RealInstanceId,从barad获取监控数据等场景下需要用物理id获取 |
InstanceEnumParam
实例可修改参数枚举类型集合。
被如下接口引用:DescribeInstanceParams。
名称 | 类型 | 描述 |
---|---|---|
CurrentValue | String | 参数当前值 |
DefaultValue | String | 默认值 |
EnumValue | Array of String | 枚举值,所有支持的值 |
NeedRestart | String | 是否需要重启生效 1:需要重启后生效;0:无需重启,设置成功即可生效; |
ParamName | String | 参数名称 |
Tips | Array of String | 中英文说明 |
ValueType | String | 参数值类型说明 |
Status | Integer | 是否为运行中参数值 1:运行中参数值;0:非运行中参数值; |
InstanceIntegerParam
实例可修改参数integer类型集合。
被如下接口引用:DescribeInstanceParams。
名称 | 类型 | 描述 |
---|---|---|
CurrentValue | String | 当前值 |
DefaultValue | String | 默认值 |
Max | String | 最大值 |
Min | String | 最小值 |
NeedRestart | String | 是否需要重启生效 1:需要重启后生效;0:无需重启,设置成功即可生效; |
ParamName | String | 参数名称 |
Tips | Array of String | 参数说明 |
ValueType | String | 参数类型 |
Status | Integer | 是否为运行中参数值 1:运行中参数值;0:非运行中参数值; |
Unit | String | 冗余字段,可忽略 |
InstanceMultiParam
实例可修改参数Multi类型集合。
被如下接口引用:DescribeInstanceParams。
名称 | 类型 | 描述 |
---|---|---|
CurrentValue | String | 当前值 |
DefaultValue | String | 默认值 |
EnumValue | Array of String | 指导值范围 |
NeedRestart | String | 是否需要重启生效 1:需要重启后生效;0:无需重启,设置成功即可生效; |
ParamName | String | 参数名称 |
Status | Integer | 是否为运行中参数值 1:运行中参数值;0:非运行中参数值; |
Tips | Array of String | 参数说明 |
ValueType | String | 当前值的类型描述,默认为multi |
InstanceTextParam
实例可修改参数text类型集合。
被如下接口引用:DescribeInstanceParams。
名称 | 类型 | 描述 |
---|---|---|
CurrentValue | String | 当前值 |
DefaultValue | String | 默认值 |
NeedRestart | String | 是否需要重启 |
ParamName | String | 参数名称 |
TextValue | String | text类型值 |
Tips | Array of String | 参数说明 |
ValueType | String | 值类型说明 |
Status | String | 是否为运行中参数值 1:运行中参数值;0:非运行中参数值; |
ModifyNetworkAddress
修改数据库地址
被如下接口引用:ModifyDBInstanceNetworkAddress。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
NewIPAddress | String | 是 | 新IP地址。 |
OldIpAddress | String | 是 | 原IP地址。 |
Operation
需要终止的操作
被如下接口引用:KillOps。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ReplicaSetName | String | 是 | 操作所在的分片名 |
NodeName | String | 是 | 操作所在的节点名 |
OpId | Integer | 是 | 操作序号 |
ReplicaSetInfo
分片信息
被如下接口引用:CreateBackupDownloadTask。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ReplicaSetId | String | 是 | 副本集ID |
SecurityGroup
安全组信息
被如下接口引用:DescribeSecurityGroup。
名称 | 类型 | 描述 |
---|---|---|
ProjectId | Integer | 所属项目id |
CreateTime | String | 创建时间 |
Inbound | Array of SecurityGroupBound | 入站规则 |
Outbound | Array of SecurityGroupBound | 出站规则 |
SecurityGroupId | String | 安全组id |
SecurityGroupName | String | 安全组名称 |
SecurityGroupRemark | String | 安全组备注 |
SecurityGroupBound
安全组规则
被如下接口引用:DescribeSecurityGroup。
名称 | 类型 | 描述 |
---|---|---|
Action | String | 执行规则。ACCEPT或DROP |
CidrIp | String | ip段。 |
PortRange | String | 端口范围 |
IpProtocol | String | 传输层协议。tcp,udp或ALL |
Id | String | 安全组id代表的地址集合 |
AddressModule | String | 地址组id代表的地址集合 |
ServiceModule | String | 服务组id代表的协议和端口集合 |
Desc | String | 描述 |
ShardInfo
实例分片详情
被如下接口引用:DescribeDBInstances。
名称 | 类型 | 描述 |
---|---|---|
UsedVolume | Float | 分片已使用容量 |
ReplicaSetId | String | 分片ID |
ReplicaSetName | String | 分片名 |
Memory | Integer | 分片内存规格,单位为MB |
Volume | Integer | 分片磁盘规格,单位为MB |
OplogSize | Integer | 分片Oplog大小,单位为MB |
SecondaryNum | Integer | 分片从节点数 |
RealReplicaSetId | String | 分片物理id |
SlowLogPattern
用于描述MongoDB数据库慢日志统计信息
被如下接口引用:DescribeSlowLogPatterns。
名称 | 类型 | 描述 |
---|---|---|
Pattern | String | 慢日志模式 |
MaxTime | Integer | 最大执行时间 |
AverageTime | Integer | 平均执行时间 |
Total | Integer | 该模式慢日志条数 |
SpecItem
mongodb售卖规格
被如下接口引用:DescribeSpecInfo。
名称 | 类型 | 描述 |
---|---|---|
SpecCode | String | 规格信息标识 |
Status | Integer | 规格有效标志,取值:0-停止售卖,1-开放售卖 |
Cpu | Integer | 计算资源规格,单位为CPU核心数 |
Memory | Integer | 内存规格,单位为MB |
DefaultStorage | Integer | 默认磁盘规格,单位MB |
MaxStorage | Integer | 最大磁盘规格,单位MB |
MinStorage | Integer | 最小磁盘规格,单位MB |
Qps | Integer | 可承载qps信息 |
Conns | Integer | 连接数限制 |
MongoVersionCode | String | 实例mongodb版本信息 |
MongoVersionValue | Integer | 实例mongodb版本号 |
Version | String | 实例mongodb版本号(短) |
EngineName | String | 存储引擎 |
ClusterType | Integer | 集群类型,取值:1-分片集群,0-副本集集群 |
MinNodeNum | Integer | 最小副本集从节点数 |
MaxNodeNum | Integer | 最大副本集从节点数 |
MinReplicateSetNum | Integer | 最小分片数 |
MaxReplicateSetNum | Integer | 最大分片数 |
MinReplicateSetNodeNum | Integer | 最小分片从节点数 |
MaxReplicateSetNodeNum | Integer | 最大分片从节点数 |
MachineType | String | 机器类型,取值:0-HIO,4-HIO10G |
SpecificationInfo
实例规格信息
被如下接口引用:DescribeSpecInfo。
名称 | 类型 | 描述 |
---|---|---|
Region | String | 地域信息 |
Zone | String | 可用区信息 |
SpecItems | Array of SpecItem | 售卖规格信息 |
SupportMultiAZ | Integer | 是否支持跨可用区部署 1-支持,0-不支持 |
TagInfo
实例标签信息
被如下接口引用:CreateDBInstance, CreateDBInstanceHour, DescribeDBInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TagKey | String | 是 | 标签键 |
TagValue | String | 是 | 标签值 |