数据结构
最近更新时间: 2024-09-11 15:04:53
InstanceSummary
实例摘要信息
被如下接口引用：DescribeDBInstanceSummaries
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 否 | String | 实例ID |
| InstanceName | 是 | 否 | String | 实例名称 |
| Status | 是 | 否 | Int64 | 实例状态，0-实例待初始化；1-实例处理中；2-实例运行中；-2-实例已隔离 |
| MongoVersion | 是 | 否 | String | mongodb版本 |
| Ip | 是 | 否 | String | 实例ip |
| NodeNum | 是 | 否 | Uint64 | 节点个数 |
| ReplicateSetNum | 是 | 否 | Uint64 | 副本集个数 |
Outbound
安全组出站规则
被如下接口引用：DescribeProjectSecurityGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 策略，ACCEPT或者DROP。 |
| AddressModule | 是 | 否 | String | 地址组id代表的地址集合。 |
| CidrIp | 是 | 否 | String | 来源Ip或Ip段，例如192.168.0.0/16。 |
| Desc | 是 | 否 | String | 描述。 |
| IpProtocol | 是 | 否 | String | 网络协议，支持udp、tcp等。 |
| PortRange | 是 | 否 | String | 端口。 |
| ServiceModule | 是 | 否 | String | 服务组id代表的协议和端口集合。 |
| Id | 是 | 否 | String | 安全组id代表的地址集合。 |
InstanceChargePrepaid
描述了实例的计费模式
被如下接口引用：InquirePriceRenewDBInstances、RenewDBInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Period | 否 | 否 | Int64 | 购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。 |
| RenewFlag | 否 | 否 | String | 自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 |
ResourceInfo
资源信息
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceNum | 否 | 否 | Uint64 | 实例数量 |
| ReplsetNum | 否 | 否 | Uint64 | 副本集实例数量 |
| ShardNum | 否 | 否 | Uint64 | 分片实例数量 |
| TotalCPU | 否 | 否 | Uint64 | 总CPU |
| UsedCPU | 否 | 否 | Uint64 | 已用CPU |
| UsedCPURatio | 否 | 否 | String | 已用CPU占比 |
| TotalMemory | 否 | 否 | Uint64 | 总内存 |
| UsedMemory | 否 | 否 | Uint64 | 已用内存 |
| UsedMemoryRatio | 否 | 否 | String | 已用内存占比 |
| TotalVolume | 否 | 否 | Uint64 | 总磁盘 |
| UsedVolume | 否 | 否 | Uint64 | 已用磁盘 |
| UsedVolumeRatio | 否 | 否 | String | 已用磁盘占比 |
ShardInfo
实例分片详情
被如下接口引用：DescribeDBInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UsedVolume | 是 | 否 | Float | 分片已使用容量 |
| ReplicaSetId | 是 | 否 | String | 分片ID |
| ReplicaSetName | 是 | 否 | String | 分片名 |
| Memory | 是 | 否 | Uint64 | 分片内存规格，单位为MB |
| Volume | 是 | 否 | Uint64 | 分片磁盘规格，单位为MB |
| OplogSize | 是 | 否 | Uint64 | 分片Oplog大小，单位为MB |
| SecondaryNum | 是 | 否 | Uint64 | 分片从节点数 |
| RealReplicaSetId | 是 | 否 | String | 分片物理id |
SpecificationInfo
实例规格信息
被如下接口引用：DescribeSpecInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 是 | 否 | String | 地域信息 |
| Zone | 是 | 否 | String | 可用区信息 |
| SpecItems | 是 | 否 | Array of SpecItem | 售卖规格信息 |
InstanceDetail
实例详情
被如下接口引用：DescribeDBInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 否 | String | 实例ID |
| InstanceName | 是 | 否 | String | 实例名称 |
| PayMode | 是 | 否 | Uint64 | 付费类型，可能的返回值：1-包年包月；0-按量计费 |
| ProjectId | 是 | 否 | Uint64 | 项目ID |
| ClusterType | 是 | 否 | Uint64 | 集群类型，可能的返回值：0-副本集实例，1-分片实例， |
| Region | 是 | 否 | String | 地域信息 |
| Zone | 是 | 否 | String | 可用区信息 |
| NetType | 是 | 否 | Uint64 | 网络类型，可能的返回值：0-基础网络，1-私有网络 |
| VpcId | 是 | 否 | String | 私有网络的ID |
| SubnetId | 是 | 否 | String | 私有网络的子网ID |
| Status | 是 | 否 | Int64 | 实例状态，可能的返回值：0-待初始化，1-流程处理中，2-运行中，-2-实例已过期 |
| Vip | 是 | 否 | String | 实例IP |
| Vport | 是 | 否 | Uint64 | 端口号 |
| CreateTime | 是 | 否 | Datetime | 实例创建时间 |
| DeadLine | 是 | 否 | Datetime | 实例到期时间 |
| MongoVersion | 是 | 否 | String | 实例版本信息 |
| Memory | 是 | 否 | Uint64 | 实例内存规格，单位为MB |
| Volume | 是 | 否 | Uint64 | 实例磁盘规格，单位为MB |
| CpuNum | 是 | 否 | Uint64 | 实例CPU核心数 |
| MachineType | 是 | 否 | String | 实例机器类型 |
| SecondaryNum | 是 | 否 | Uint64 | 实例从节点数 |
| ReplicationSetNum | 是 | 否 | Uint64 | 实例分片数 |
| AutoRenewFlag | 是 | 否 | Int64 | 实例自动续费标志，可能的返回值：0-手动续费，1-自动续费，2-确认不续费 |
| UsedVolume | 是 | 否 | Uint64 | 已用容量，单位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 | 是 | 否 | Uint64 | 实例版本标记 |
| ClusterVer | 是 | 否 | Uint64 | 实例版本标记 |
| Protocol | 是 | 否 | Uint64 | 协议信息，可能的返回值：1-mongodb，2-dynamodb |
| InstanceType | 是 | 否 | Uint64 | 实例类型，可能的返回值，1-正式实例，2-临时实例，3-只读实例，4-灾备实例 |
| InstanceStatusDesc | 是 | 否 | String | 实例状态描述 |
| RealInstanceId | 是 | 否 | String | 实例对应的物理实例id，回档并替换过的实例有不同的InstanceId和RealInstanceId，从barad获取监控数据等场景下需要用物理id获取 |
ModifyNetworkAddress
修改数据库地址
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NewIPAddress | 是 | 否 | String | 新IP地址。 |
| OldIpAddress | 是 | 否 | String | 原IP地址。 |
Operation
需要终止的操作
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ReplicaSetName | 是 | 否 | String | 操作所在的分片名 |
| NodeName | 是 | 否 | String | 操作所在的节点名 |
| OpId | 是 | 否 | Int64 | 操作序号 |
CommonDBInstanceInfo
实例信息
被如下接口引用：DescribeCommonDBInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AppId | 是 | 否 | Uint64 | AppId |
| Region | 是 | 否 | String | 地域 |
| Zone | 是 | 否 | String | 可用区 |
| ProjectId | 是 | 否 | Uint64 | 项目ID |
| PayMode | 是 | 否 | Uint64 | 付费模式 |
| InstanceId | 是 | 否 | String | 实例ID |
| InstanceName | 是 | 否 | String | 实例名称 |
| Status | 是 | 否 | Uint64 | 状态 |
| NetType | 是 | 否 | Uint64 | 网络类型 |
| VpcId | 是 | 否 | String | 私有网络ID |
| SubnetId | 是 | 否 | String | 子网ID |
| Vips | 是 | 否 | Array of String | vip信息 |
| Vport | 是 | 否 | Uint64 | vip信息 |
| CreateTime | 是 | 否 | String | 创建时间 |
| ClusterType | 是 | 否 | Uint64 | 实例类型：0 副本集；1 分片 |
MongodNodeInfo
mongod节点信息
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ProductId | 否 | 否 | String | 计费项ID |
| ProductIdDescribe | 否 | 否 | String | 计费项名称 |
| UsageUnit | 否 | 否 | String | 产品用量单位 |
| UsageValue | 否 | 否 | Uint64 | 产品用量 |
SlowLogPattern
用于描述MongoDB数据库慢日志统计信息
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Pattern | 是 | 否 | String | 慢日志模式 |
| MaxTime | 是 | 否 | Uint64 | 最大执行时间 |
| AverageTime | 是 | 否 | Uint64 | 平均执行时间 |
| Total | 是 | 否 | Uint64 | 该模式慢日志条数 |
BackupFile
备份文件存储信息
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ReplicateSetId | 是 | 否 | String | 备份文件所属的副本集/分片ID |
| File | 是 | 否 | String | 备份文件保存路径 |
Inbound
安全组入站规则
被如下接口引用：DescribeProjectSecurityGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 策略，ACCEPT或者DROP。 |
| AddressModule | 是 | 否 | String | 地址组id代表的地址集合。 |
| CidrIp | 是 | 否 | String | 来源Ip或Ip段，例如192.168.0.0/16。 |
| Desc | 是 | 否 | String | 描述。 |
| IpProtocol | 是 | 否 | String | 网络协议，支持udp、tcp等。 |
| PortRange | 是 | 否 | String | 端口。 |
| ServiceModule | 是 | 否 | String | 服务组id代表的协议和端口集合。 |
| Id | 是 | 否 | String | 安全组id代表的地址集合。 |
BackupInfo
备份信息
被如下接口引用：DescribeDBBackups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 否 | String | 实例ID |
| BackupType | 是 | 否 | Uint64 | 备份方式，0-自动备份，1-手动备份 |
| BackupName | 是 | 否 | String | 备份名称 |
| BackupDesc | 是 | 是 | String | 备份备注 |
| BackupSize | 是 | 是 | Uint64 | 备份文件大小，单位KB |
| StartTime | 是 | 是 | String | 备份开始时间 |
| EndTime | 是 | 是 | String | 备份结束时间 |
| Status | 是 | 否 | Uint64 | 备份状态，1-备份中，2-备份成功 |
| BackupMethod | 是 | 否 | Uint64 | 备份方法，0-逻辑备份，1-物理备份 |
DBInstanceInfo
实例信息
被如下接口引用：DescribeDBInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 否 | String | 实例ID |
| Region | 是 | 否 | String | 地域信息 |
CurrentOp
云数据库实例当前操作
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| OpId | 是 | 是 | Int64 | 操作序号 |
| Ns | 是 | 是 | String | 操作所在的命名空间，形式如db.collection |
| Query | 是 | 是 | String | 操作执行语句 |
| Op | 是 | 是 | String | 操作类型，可能的取值：aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command |
| ReplicaSetName | 是 | 否 | String | 操作所在的分片名称 |
| State | 是 | 是 | String | 筛选条件，节点状态，可能的取值为：Primary、Secondary |
| Operation | 是 | 是 | String | 操作详细信息 |
| NodeName | 是 | 否 | String | 操作所在的节点名称 |
| MicrosecsRunning | 是 | 是 | Uint64 | 操作已执行时间（ms） |
NetworkAddress
数据库实例网络地址
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NetworkType | 是 | 否 | String | 网络类型，可选值包括：VPC（专有网络）、BASIC（基础网络） |
| UniqVpcId | 是 | 是 | String | IP地址所属私有网络统一ID，若为基础网络，该字段为空。 |
| UniqSubnetId | 是 | 是 | String | IP地址所属子网统一ID，若为基础网络，该字段为空。 |
| IPAddress | 是 | 否 | String | IP地址。 |
| Port | 是 | 否 | Uint64 | 端口号。 |
SpecItem
mongodb售卖规格
被如下接口引用：DescribeSpecInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SpecCode | 是 | 否 | String | 规格信息标识 |
| Status | 是 | 否 | Uint64 | 规格有效标志，取值：0-停止售卖，1-开放售卖 |
| Cpu | 是 | 否 | Uint64 | 规格有效标志，取值：0-停止售卖，1-开放售卖 |
| Memory | 是 | 否 | Uint64 | 内存规格，单位为MB |
| DefaultStorage | 是 | 否 | Uint64 | 默认磁盘规格，单位MB |
| MaxStorage | 是 | 否 | Uint64 | 最大磁盘规格，单位MB |
| MinStorage | 是 | 否 | Uint64 | 最小磁盘规格，单位MB |
| Qps | 是 | 否 | Uint64 | 可承载qps信息 |
| Conns | 是 | 否 | Uint64 | 连接数限制 |
| MongoVersionCode | 是 | 否 | String | 实例mongodb版本信息 |
| MongoVersionValue | 是 | 否 | Uint64 | 实例mongodb版本号 |
| Version | 是 | 否 | String | 实例mongodb版本号（短） |
| EngineName | 是 | 否 | String | 存储引擎 |
| ClusterType | 是 | 否 | Uint64 | 集群类型，取值：1-分片集群，0-副本集集群 |
| MinNodeNum | 是 | 否 | Uint64 | 最小副本集从节点数 |
| MaxNodeNum | 是 | 否 | Uint64 | 最大副本集从节点数 |
| MinReplicateSetNum | 是 | 否 | Uint64 | 最小分片数 |
| MaxReplicateSetNum | 是 | 否 | Uint64 | 最大分片数 |
| MinReplicateSetNodeNum | 是 | 否 | Uint64 | 最小分片从节点数 |
| MaxReplicateSetNodeNum | 是 | 否 | Uint64 | 最大分片从节点数 |
| MachineType | 是 | 否 | String | 机器类型，取值：0-HIO，4-HIO10G |
TagInfo
实例标签信息
被如下接口引用：CreateDBInstance、CreateDBInstanceHour、DescribeDBInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 是 | 否 | String | 标签键 |
| TagValue | 是 | 否 | String | 标签值 |
ClientConnection
客户端连接信息，包括客户端IP和连接数
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| IP | 是 | 否 | String | 连接的客户端IP |
| Count | 是 | 否 | Uint64 | 对应客户端IP的连接数 |
DBInstancePrice
数据库实例价格
被如下接口引用：InquirePriceCreateDBInstances、InquirePriceModifyDBInstanceSpec、InquirePriceRenewDBInstances
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UnitPrice | 是 | 是 | Float | 单价 |
| OriginalPrice | 是 | 否 | Float | 原价 |
| DiscountPrice | 是 | 否 | Float | 折扣加 |
SecurityGroup
安全组规则
被如下接口引用：DescribeProjectSecurityGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CreateTime | 是 | 否 | String | 创建时间，时间格式：yyyy-mm-dd hh:mm:ss。 |
| ProjectId | 是 | 否 | Uint64 | 项目ID。 |
| SecurityGroupId | 是 | 否 | String | 安全组ID。 |
| SecurityGroupName | 是 | 否 | String | 安全组名称。 |
| SecurityGroupRemark | 是 | 否 | String | 安全组备注。 |
| Outbound | 是 | 否 | Array of Outbound | 出站规则。 |
| Inbound | 是 | 否 | Array of Inbound | 入站规则。 |