Storage information of a backup file
Used by actions: DescribeBackupAccess.
| Name | Type | Description |
|---|---|---|
| ReplicateSetId | String | ID of the replica set/shard to which a backup file belongs |
| File | String | Path to a backup file |
Backup information
Used by actions: DescribeDBBackups.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| BackupType | Integer | Backup mode. 0: automatic backup; 1: manual backup |
| BackupName | String | Backup name |
| BackupDesc | String | Backup remarks Note: This field may return null, indicating that no valid values can be obtained. |
| BackupSize | Integer | Backup file size in KB Note: This field may return null, indicating that no valid values can be obtained. |
| StartTime | String | Backup start time Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | String | Backup end time Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Backup status. 1: backing up; 2: backed up successful |
| BackupMethod | Integer | Backup method. 0: logical backup; 1: physical backup |
Client connection information, including client IP and number of connections
Used by actions: DescribeClientConnections.
| Name | Type | Description |
|---|---|---|
| IP | String | Client IP of a connection |
| Count | Integer | Number of connections corresponding to a client IP |
Instance information
Used by actions: DescribeDBInstances.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| Region | String | Region information |
Instance price
Used by actions: InquirePriceCreateDBInstances, InquirePriceModifyDBInstanceSpec, InquirePriceRenewDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| UnitPrice | Float | Yes | Unit price. Note: this field may return null, indicating that no valid values can be obtained. |
| OriginalPrice | Float | Yes | Original price. |
| DiscountPrice | Float | Yes | Discounted price. |
Description on the billing mode of an instance
Used by actions: InquirePriceRenewDBInstances, RenewDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Period | Integer | No | Purchased usage period (in month). Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. Default value: 1.(This parameter is required in InquirePriceRenewDBInstances and RenewDBInstances APIs.) |
| RenewFlag | String | No | Auto-renewal flag. Valid values:NOTIFY_AND_AUTO_RENEW: notify expiration and renew automaticallyNOTIFY_AND_MANUAL_RENEW: notify expiration but not renew automaticallyDISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify expiration nor renew automaticallyDefault value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis when the account balance is sufficient.(This parameter is required in InquirePriceRenewDBInstances and RenewDBInstances APIs.) |
Instance details
Used by actions: DescribeDBInstances.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| PayMode | Integer | Billing type. Valid value: 0 (pay-as-you-go) |
| ProjectId | Integer | Project ID |
| ClusterType | Integer | Cluster type. Valid values: 0 (replica set instance), 1 (sharding instance), |
| Region | String | Region information |
| Zone | String | AZ information |
| NetType | Integer | Network type. Valid values: 0 (basic network), 1 (VPC) |
| VpcId | String | VPC ID |
| SubnetId | String | Subnet ID of VPC |
| Status | Integer | Instance status. Valid values: 0 (to be initialized), 1 (in process), 2 (running), -2 (expired) |
| Vip | String | Instance IP |
| Vport | Integer | Port number |
| CreateTime | Timestamp | Instance creation time |
| DeadLine | Timestamp | Instance expiration time |
| MongoVersion | String | Instance version information |
| Memory | Integer | Instance memory size in MB |
| Volume | Integer | Instance disk size in MB |
| CpuNum | Integer | Number of CPU cores of an instance |
| MachineType | String | Instance machine type |
| SecondaryNum | Integer | Number of secondary nodes of an instance |
| ReplicationSetNum | Integer | Number of instance shards |
| AutoRenewFlag | Integer | Instance auto-renewal flag. Valid values: 0 (manual renewal), 1 (auto-renewal), 2 (no renewal upon expiration) |
| UsedVolume | Integer | Used capacity in MB |
| MaintenanceStart | String | Start time of the maintenance time window |
| MaintenanceEnd | String | End time of the maintenance time window |
| ReplicaSets | Array of ShardInfo | Shard information |
| ReadonlyInstances | Array of DBInstanceInfo | Information of read-only instances |
| StandbyInstances | Array of DBInstanceInfo | Information of disaster recovery instances |
| CloneInstances | Array of DBInstanceInfo | Information of temp instances |
| RelatedInstance | DBInstanceInfo | Information of associated instances. For a promoted instance, this field represents information of its temp instance; for a temp instance, this field represents information of its promoted instance; and for a read-only/disaster recovery instance, this field represents information of its primary instance |
| Tags | Array of TagInfo | Instance tag information set |
| InstanceVer | Integer | Instance version tag |
| ClusterVer | Integer | Instance version tag |
| Protocol | Integer | Protocol information. Valid values: 1 (mongodb), 2 (dynamodb) |
| InstanceType | Integer | Instance type. Valid values: 1 (promoted instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance) |
| InstanceStatusDesc | String | Instance status description |
| RealInstanceId | String | Physical instance ID. For an instance that has been rolled back and replaced, its InstanceId and RealInstanceId are different. The physical instance ID is needed in such scenarios as getting monitoring data from Barad |
Details of an instance shard
Used by actions: DescribeDBInstances.
| Name | Type | Description |
|---|---|---|
| UsedVolume | Float | Used shard capacity |
| ReplicaSetId | String | Shard ID |
| ReplicaSetName | String | Shard name |
| Memory | Integer | Shard memory size in MB |
| Volume | Integer | Shard disk size in MB |
| OplogSize | Integer | Shard oplog size in MB |
| SecondaryNum | Integer | Number of secondary nodes of a shard |
| RealReplicaSetId | String | Shard physical ID |
Slow log statistics of MongoDB database
Used by actions: DescribeSlowLogPatterns.
| Name | Type | Description |
|---|---|---|
| Pattern | String | Slow log pattern |
| MaxTime | Integer | Maximum execution time |
| AverageTime | Integer | Average execution time |
| Total | Integer | Number of slow logs in this pattern |
Specifications of purchasable MongoDB instances
Used by actions: DescribeSpecInfo.
| Name | Type | Description |
|---|---|---|
| SpecCode | String | Specification information identifier |
| Status | Integer | Specification purchasable flag. Valid values: 0 (not purchasable), 1 (purchasable) |
| Cpu | Integer | Specification purchasable flag. Valid values: 0 (not purchasable), 1 (purchasable) |
| Memory | Integer | Memory size in MB |
| DefaultStorage | Integer | Default disk size in MB |
| MaxStorage | Integer | Maximum disk size in MB |
| MinStorage | Integer | Minimum disk size in MB |
| Qps | Integer | Maximum QPS |
| Conns | Integer | Maximum number of connections |
| MongoVersionCode | String | MongoDB version information of an instance |
| MongoVersionValue | Integer | MongoDB version number of an instance |
| Version | String | MongoDB version number of an instance (short) |
| EngineName | String | Storage engine |
| ClusterType | Integer | Cluster type. Valid values: 1 (sharding cluster), 0 (replica set cluster) |
| MinNodeNum | Integer | Minimum number of secondary nodes in a replica set |
| MaxNodeNum | Integer | Maximum number of secondary nodes in a replica set |
| MinReplicateSetNum | Integer | Minimum number of shards |
| MaxReplicateSetNum | Integer | Maximum number of shards |
| MinReplicateSetNodeNum | Integer | Minimum number of secondary nodes in a shard |
| MaxReplicateSetNodeNum | Integer | Maximum number of secondary nodes in a shard |
| MachineType | String | Server type. Valid values: 0 (HIO), 4 (HIO10G) |
Instance specification information
Used by actions: DescribeSpecInfo.
| Name | Type | Description |
|---|---|---|
| Region | String | Region information |
| Zone | String | AZ information |
| SpecItems | Array of SpecItem | Purchasable specification information |
Instance tag information
Used by actions: CreateDBInstance, CreateDBInstanceHour, DescribeDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
Was this page helpful?