Data Types
Last updated: 2025-12-03 10:42:20
AddNodeList
Node details of the instance to be modified.
Used by actions: ModifyDBInstanceSpec.
| Name | Type | Required | Description |
|---|---|---|---|
| Role | String | Yes | Roles of nodes to be added. - SECONDARY: Mongod node. - READONLY: read-only node. - MONGOS: Mongos node. |
| Zone | String | Yes | AZ corresponding to the node. For the currently supported AZs, see Regions and AZs. - Single AZ: All nodes are in the same AZ. - Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be added should be specified. After addition, the number of nodes in any 2 AZs should be greater than that in the third AZ. |
Auth
Used by actions: CreateAccountUser, SetAccountUserPrivilege.
| Name | Type | Required | Description |
|---|---|---|---|
| Mask | Integer | Yes | Permission information of the current account. - 0: no permissions. - 1: read-only. - 3: read-write. Note: This field may return null, indicating that no valid values can be obtained. |
| NameSpace | String | Yes | Specifies the name of the database that has the current account permissions. - *: indicates all databases. - db.name: indicates the database with a specific name. Note: This field may return null, indicating that no valid values can be obtained. |
BackupDownloadTask
Backup download task information
Used by actions: DescribeBackupDownloadTask.
| Name | Type | Description |
|---|---|---|
| CreateTime | String | Task creation time. |
| BackupName | String | Backup file name. |
| ReplicaSetId | String | Shard name. |
| BackupSize | Integer | Backup data size, in bytes. |
| Status | Integer | Task status. - 0: wait for execution. - 1: downloading. - 2: download completed. - 3: download failed. - 4: wait for retry. |
| Percent | Integer | Task progress percentage. |
| TimeSpend | Integer | Duration, in seconds. |
| Url | String | Download link for backup data. |
| BackupMethod | Integer | Backup method. - 0: logical backup. - 1: physical backup. - 3: snapshot backup. Note: 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently. 2. Physical backup is not supported when storage encryption is enabled for the instance. |
| BackupDesc | String | Specified remarks for initiating backup tasks. |
| Region | String | Region information. |
| Bucket | String | Bucket information. |
BackupDownloadTaskStatus
Result of creating a backup download task.
Used by actions: CreateBackupDownloadTask.
| Name | Type | Description |
|---|---|---|
| ReplicaSetId | String | Shard name. |
| Status | Integer | Current status of the task. - 0: wait for execution. - 1: downloading. - 2: download completed. - 3: download failed. - 4: wait for retry. |
BackupInfo
Backup information.
Used by actions: DescribeDBBackups.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| BackupType | Integer | Backup method. - 0: automatic backup. - 1: manual backup. |
| BackupName | String | Backup file name. |
| BackupDesc | String | Backup task remarks. |
| BackupSize | Integer | Backup file size, in KB. |
| StartTime | String | Backup start time. |
| EndTime | String | Backup end time. |
| Status | Integer | Backup status. - 1: backing up. - 2: backup successful. |
| BackupMethod | Integer | Backup method. - 0: logical backup. - 1: physical backup. - 3: snapshot backup. Note: - The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently. - Physical backup is not supported when storage encryption is enabled for the instance. |
| BackId | Integer | Backup record ID. |
| DeleteTime | String | Backup deletion time. |
| BackupRegion | String | Cross-region backup region. |
| RestoreTime | String | Rollback time supported by the backup. |
ClientConnection
Client connection information, including client IP and number of connections
Used by actions: DescribeClientConnections.
| Name | Type | Description |
|---|---|---|
| IP | String | IP address of the connected client. |
| Count | Integer | Number of connections corresponding to the client IP address. |
| InternalService | Boolean | Whether it is an internal IP address. |
CurrentOp
Current operation on the TencentDB for MongoDB instance.
Used by actions: DescribeCurrentOp.
| Name | Type | Description |
|---|---|---|
| OpId | Integer | Operation number. |
| Ns | String | Namespace where the operation is located, in the format of db.collection. |
| Query | String | Execution statement of the operation. |
| Op | String | Operation type. - none: special status; idle connections or internal tasks. - update: update data. - insert: insertion operation. - query: query operation. - command: command operation. - getmore: obtain more data. - remove: deletion operation. - killcursors: operation of releasing the query cursor. |
| ReplicaSetName | String | Name of the shard where the operation is performed. |
| NodeName | String | Name of the node where the operation is performed. |
| Operation | String | Detailed information about the operation. |
| State | String | Node role. - primary: primary node. - secondary: secondary node. |
| MicrosecsRunning | Integer | Execution time of the operation, in ms. |
| ExecNode | String | Information about the node where the current operation is performed. |
DBInstanceInfo
Instance information
Used by actions: DescribeDBInstances.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| Region | String | Region information |
DBInstancePrice
Instance price
Used by actions: InquirePriceCreateDBInstances, InquirePriceModifyDBInstanceSpec, InquirePriceRenewDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| UnitPrice | Float | Yes | Unit price of the instance, in USD. |
| OriginalPrice | Float | Yes | Original price of the instance, in USD. |
| DiscountPrice | Float | Yes | Discount price of the instance, in USD. |
InstanceChargePrepaid
Description on the billing mode of an instance
Used by actions: InquirePriceRenewDBInstances, RenewDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| Period | Integer | No | Instance purchase duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Default value: 1. |
| RenewFlag | String | No | Automatic renewal flag. Valid values: - NOTIFY_AND_AUTO_RENEW: A notification is sent upon expiration, and the instance is renewed automatically. If the account balance is sufficient, the instance will be renewed automatically on a monthly basis after expiration. - NOTIFY_AND_MANUAL_RENEW: A notification is sent upon expiration, but the instance is not renewed automatically. Default value: NOTIFY_AND_MANUAL_RENEW. - DISABLE_NOTIFY_AND_MANUAL_RENEW: No notification is sent upon expiration, and the instance is not renewed automatically. |
InstanceDetail
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. - 0: replica set instance. - 1: sharded cluster instance. |
| Region | String | Region information |
| Zone | String | AZ information |
| NetType | Integer | Network type. - 0: basic network. - 1: VPC. |
| VpcId | String | VPC ID |
| SubnetId | String | Subnet ID of VPC |
| Status | Integer | Instance status. - 0: to be initialized. - 1: processing, such as specification changes and parameter modifications. - 2: running normally. - -2: isolated (yearly/monthly subscription). - -3: isolated (pay-as-you-go). |
| Vip | String | Instance IP |
| Vport | Integer | Port number |
| CreateTime | Timestamp | Instance creation time |
| DeadLine | Timestamp | Instance expiration time |
| MongoVersion | String | Storage engine version information on instances. - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine. - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine. - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine. - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine. - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine. - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. |
| Memory | Integer | Instance memory specification, in MB. |
| Volume | Integer | Instance disk specification, in MB. |
| CpuNum | Integer | Number of the instance CPU cores. |
| MachineType | String | Instance machine type. - HIO10G: general HIO 10GE type. - HCD: Cloud Disk Edition type. |
| SecondaryNum | Integer | Number of secondary nodes of an instance |
| ReplicationSetNum | Integer | Number of instance shards |
| AutoRenewFlag | Integer | Automatic renewal flag for the instance. - 0: manual renewal. - 1: automatic renewal. - 2: no renewal after confirmation. |
| UsedVolume | Integer | Used capacity, in MB. |
| MaintenanceStart | String | Start time of the maintenance time |
| MaintenanceEnd | String | End time of the maintenance time |
| 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 regular instance, this field represents the information of its temp instance; for a temp instance, this field represents the information of its regular instance; and for a read-only instance or a disaster recovery instance, this field represents the information of its primary instance. |
| Tags | Array of TagInfo | Instance tag information set |
| InstanceVer | Integer | Instance version |
| ClusterVer | Integer | Instance version |
| Protocol | Integer | Protocol information: mongodb. |
| InstanceType | Integer | Instance type. - 0: all instances. - 1: formal instance. - 2: temporary instance. - 3: read-only instance. - -1: include the formal, read-only, and disaster recovery instance simultaneously. |
| InstanceStatusDesc | String | Instance status description. |
| RealInstanceId | String | Physical instance ID corresponding to the instance. The instances that have been rolled back and replaced have different InstanceIds and RealInstanceIds, which need to be obtained through the physical ID in scenarios such as obtaining monitoring data from Barad. |
| MongosNodeNum | Integer | Number of Mongos nodes. |
| MongosMemory | Integer | Mongos node memory, in MB. |
| MongosCpuNum | Integer | Number of Mongos node CPU cores. |
| ConfigServerNodeNum | Integer | Number of ConfigServer nodes. |
| ConfigServerMemory | Integer | Config Server node memory, in MB. |
| ConfigServerVolume | Integer | Config Server node disk size, in MB. |
| ConfigServerCpuNum | Integer | Number of ConfigServer node CPU cores. |
| ReadonlyNodeNum | Integer | Number of read-only nodes. |
InstanceEnumParam
The collection of modifiable enum parameters of an instance.
Used by actions: DescribeInstanceParams.
| Name | Type | Description |
|---|---|---|
| CurrentValue | String | Current parameter value. |
| DefaultValue | String | Default parameter value. |
| EnumValue | Array of String | Enumerated values, which indicate all supported values. |
| NeedRestart | String | Whether a restart is required for the parameters to take effect after modification. - 1: Restart is required for the parameters to take effect. - 0: Restart is not required. Once set, the parameters take effect immediately. |
| ParamName | String | Parameter name. |
| Tips | Array of String | Parameter description. |
| ValueType | String | Parameter type description. |
| Status | Integer | Whether the parameter values are used during running. - 1. parameter values used during running. - 0: parameter values not used during running. |
InstanceIntegerParam
Collection of modifiable instance parameters of the Integer type.
Used by actions: DescribeInstanceParams.
| Name | Type | Description |
|---|---|---|
| CurrentValue | String | Current parameter value. |
| DefaultValue | String | Default parameter value. |
| Max | String | Maximum parameter value. |
| Min | String | Minimum value. |
| NeedRestart | String | Whether a restart is required for the parameters to take effect after modification. - 1: Restart is required for the parameters to take effect. - 0: Restart is not required. Once set, the parameters take effect immediately. |
| ParamName | String | Parameter name. |
| Tips | Array of String | Parameter description. |
| ValueType | String | Parameter type. |
| Status | Integer | Whether the parameter values are used during running. - 1. parameter values used during running. - 0: parameter values not used during running. |
| Unit | String | Redundant field. It can be ignored. |
InstanceMultiParam
The collection of modifiable string parameters of an instance which are used to represent time ranges.
Used by actions: DescribeInstanceParams.
| Name | Type | Description |
|---|---|---|
| CurrentValue | String | Current parameter value. |
| DefaultValue | String | Default parameter value. |
| EnumValue | Array of String | Reference value range. |
| NeedRestart | String | Whether a restart is required for the parameters to take effect after modification. - 1: Restart is required for the parameters to take effect. - 0: Restart is not required. Once set, the parameters take effect immediately. |
| ParamName | String | Parameter name. |
| Status | Integer | Whether the parameter values are used during running. - 1. parameter values used during running. - 0: parameter values not used during running. |
| Tips | Array of String | Parameter description. |
| ValueType | String | Describes the type of the current values. Default value: multi. |
InstanceTextParam
Collection of modifiable instance parameters whose values are of the Text type.
Used by actions: DescribeInstanceParams.
| Name | Type | Description |
|---|---|---|
| CurrentValue | String | Current parameter value. |
| DefaultValue | String | Default parameter value. |
| NeedRestart | String | Whether a restart is required after the parameter values are modified. |
| ParamName | String | Parameter name. |
| TextValue | String | Corresponding values of the Text-type parameters. |
| Tips | Array of String | Parameter description. |
| ValueType | String | Parameter type description. |
| Status | String | Whether the parameter values are used during running. - 1. parameter values used during running. - 0: parameter values not used during running. |
LogInfo
Log details.
Used by actions: DescribeMongodbLogs.
| Name | Type | Description |
|---|---|---|
| LogComponent | String | Log category. Note: This field may return null, indicating that no valid values can be obtained. |
| LogLevel | String | Log level. Note: This field may return null, indicating that no valid values can be obtained. |
| LogTime | String | Log generation time. Note: This field may return null, indicating that no valid values can be obtained. |
| LogDetail | String | Log details. Note: This field may return null, indicating that no valid values can be obtained. |
| LogConnection | String | Log connection information. Note: This field may return null, indicating that no valid values can be obtained. |
| LogId | String | Log ID. Note: This field may return null, indicating that no valid values can be obtained. |
ModifyMongoDBParamType
Modifies the request parameters of a TencentDB for MongoDB instance.
Used by actions: ModifyInstanceParams.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Parameter name to be modified. Strictly refer to the parameter names supported by the current instance, which are obtained through DescribeInstanceParams. |
| Value | String | Yes | Corresponding value of the parameter name to be modified. Strictly refer to the value ranges corresponding to the parameters obtained through DescribeInstanceParams. |
ModifyNetworkAddress
Database IP to be modified
Used by actions: ModifyDBInstanceNetworkAddress.
| Name | Type | Required | Description |
|---|---|---|---|
| NewIPAddress | String | Yes | New IP |
| OldIpAddress | String | Yes | Old IP |
NodeProperty
Node attributes.
Used by actions: DescribeDBInstanceNodeProperty.
| Name | Type | Description |
|---|---|---|
| Zone | String | Node AZ. |
| NodeName | String | Node name. |
| Address | String | Node access address. |
| WanServiceAddress | String | Public network access address (IP address or domain name) of the node. The example value is an IP address. |
| Role | String | Node role. - PRIMARY: primary node. - SECONDARY: secondary node. - READONLY: read-only node. - ARBITER: arbitration node. |
| Hidden | Boolean | Whether the node is a hidden node. - true: a hidden node. - false: not a hidden node. |
| Status | String | Node status. - NORMAL: running normally. - STARTUP: starting. - STARTUP2: starting and processing the intermediate data. - RECOVERING: recovering and not available. - DOWN: offline. - UNKNOWN: unknown status. - ROLLBACK: rolling back. - REMOVED: removed. |
| SlaveDelay | Integer | Delay time of primary-secondary synchronization, in seconds. |
| Priority | Integer | Node priority. Value range: [0, 100]. A larger value indicates a higher priority. |
| Votes | Integer | Node voting right. - 1: The node has the right to vote. - 0: The node does not have the right to vote. |
| Tags | Array of NodeTag | Node tag. Note: This field may return null, indicating that no valid values can be obtained. |
| ReplicateSetId | String | Replica set ID. |
NodeTag
Node tag.
Used by actions: DescribeDBInstanceNodeProperty.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | No | Node tag key. |
| TagValue | String | No | Node tag value. |
Operation
Operation to be terminated.
Used by actions: KillOps.
| Name | Type | Required | Description |
|---|---|---|---|
| ReplicaSetName | String | Yes | Name of the shard where the operation is performed. The DescribeCurrentOp API can be called to query the shard name. |
| NodeName | String | Yes | Name of the node where the operation is performed. The DescribeCurrentOp API can be called to query the node name. |
| OpId | Integer | Yes | Operation number. The DescribeCurrentOp API can be called to query the operation number. |
RemoveNodeList
Node details of the instance to be modified.
Used by actions: ModifyDBInstanceSpec.
| Name | Type | Required | Description |
|---|---|---|---|
| Role | String | Yes | Roles of nodes to be deleted. - SECONDARY: Mongod secondary node. - READONLY: read-only node. - MONGOS: Mongos node. |
| NodeName | String | Yes | IDs of nodes to be deleted. For a sharded cluster instance, specify the names of nodes to be deleted on one shard. Nodes with the same names on other shards will also be deleted. - Obtaining method: Log in to the TencentDB for MongoDB console, go to the Node Management tab, and obtain the node ID. - Note: For a sharded cluster instance, specify the IDs of nodes on shard 0. For example, cmgo-6hfk****_0-node-primary. |
| Zone | String | Yes | AZ corresponding to the node. For the currently supported AZs, see Regions and AZs. - Single AZ: all nodes are in the same AZ. - Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be deleted should be specified. After deletion, the number of nodes in any 2 AZs should be larger than that in the third AZ. |
ReplicaSetInfo
Shard information.
Used by actions: CreateBackupDownloadTask.
| Name | Type | Required | Description |
|---|---|---|---|
| ReplicaSetId | String | Yes | Replica set ID. |
ReplicateSetInfo
Replica set information.
Used by actions: DescribeDBInstanceNodeProperty.
| Name | Type | Description |
|---|---|---|
| Nodes | Array of NodeProperty | Node attributes. |
SecurityGroup
Security group information
Used by actions: DescribeSecurityGroup.
| Name | Type | Description |
|---|---|---|
| ProjectId | Integer | Associated project ID. |
| CreateTime | String | Security group creation time. |
| Inbound | Array of SecurityGroupBound | Security group inbound rule. |
| Outbound | Array of SecurityGroupBound | Security group outbound rule. |
| SecurityGroupId | String | Security group ID. |
| SecurityGroupName | String | Security group name. |
| SecurityGroupRemark | String | Security group remarks. |
SecurityGroupBound
Security group rule
Used by actions: DescribeSecurityGroup.
| Name | Type | Description |
|---|---|---|
| Action | String | Execution policy. - ACCEPT: allow. Access requests for the port can be released. - DROP: reject. Data packets are discarded without any response. |
| CidrIp | String | Inbound IP address or IP range for database access. |
| PortRange | String | Port for database access. |
| IpProtocol | String | Transport layer protocol: TCP. |
| Id | String | Security group ID. |
| AddressModule | String | Parameter template ID for the IP address or IP address group. Log in to the parameter template console to obtain the parameter template IP address details. |
| ServiceModule | String | Parameter template ID for the protocol port or protocol port group. Log in to the parameter template console to obtain the parameter template protocol port details. |
| Desc | String | Security group description information. |
ShardInfo
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 |
SlowLogItem
Slow log details.
Used by actions: DescribeDetailedSlowLogs.
| Name | Type | Description |
|---|---|---|
| Log | String | Slow log details. |
| NodeName | String | Node name. |
| QueryHash | String | Queries the hash value. |
SlowLogPattern
Slow log statistics of MongoDB database
Used by actions: DescribeSlowLogPatterns.
| Name | Type | Description |
|---|---|---|
| Pattern | String | Slow log output format: database name.table name.command. |
| QueryHash | String | queryHash value carried during slow log recording. It can be used to identify a query type. |
| MaxTime | Integer | Maximum execution time, in milliseconds. |
| AverageTime | Integer | Average execution time, in milliseconds. |
| Total | Integer | Number of slow logs. |
SpecItem
TencentDB for MongoDB instance sales specification.
Used by actions: DescribeSpecInfo.
| Name | Type | Description |
|---|---|---|
| SpecCode | String | Specification information identifier. Format: mongo.HIO10G.128G. It consists of three parts: node type, specification type, and memory specification. - Node type: mongo indicates a Mongod node; mongos indicates a Mongos node; cfgstr indicates a ConfigServer node. - Specification type: HIO10G indicates the general HIO 10GE type; HCD indicates the Cloud Disk Edition type. - Memory specification, in GB. Valid values: 4, 8, 16, 32, 64, 128, 240, and 512. 128g indicates 128 GB. |
| Status | Integer | Saleable specification status flag. Valid values are as follows: - 0: selling stopped. - 1: available for sale. |
| Cpu | Integer | Computing resource specification, indicating the number of CPU cores. |
| Memory | Integer | Memory specification. Unit: MB. |
| DefaultStorage | Integer | Default disk specification. Unit: MB. |
| MaxStorage | Integer | Maximum disk specification. Unit: MB. |
| MinStorage | Integer | Minimum disk specification. Unit: MB. |
| Qps | Integer | Maximum number of requests per second. Unit: requests/second. |
| Conns | Integer | Maximum number of connections supported for the specification. |
| MongoVersionCode | String | Storage engine version information on instances. - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine. - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine. - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine. - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine. - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. |
| MongoVersionValue | Integer | Digital version corresponding to the instance version. |
| Version | String | Instance version information. Valid values: 4.2, 4.4, 5.0, 6.0, and 7.0. |
| EngineName | String | Storage engine. |
| ClusterType | Integer | Cluster type. Valid values are as follows: - 1: sharded cluster. - 0: replica set cluster. |
| MinNodeNum | Integer | Minimum number of nodes for each replica set. |
| MaxNodeNum | Integer | Maximum number of nodes for each replica set. |
| MinReplicateSetNum | Integer | Minimum number of shards. |
| MaxReplicateSetNum | Integer | Maximum number of shards. |
| MinReplicateSetNodeNum | Integer | Minimum number of nodes for each shard. |
| MaxReplicateSetNodeNum | Integer | Maximum number of nodes for each shard. |
| MachineType | String | Cluster specification type. Valid values are as follows: - HIO10G: general high-I/O 10GE type. - HCD: cloud disk type. |
SpecificationInfo
Instance specification information.
Used by actions: DescribeSpecInfo.
| Name | Type | Description |
|---|---|---|
| Region | String | Region information. |
| Zone | String | AZ information. |
| SpecItems | Array of SpecItem | Sales specification information. |
| SupportMultiAZ | Integer | Whether cross-AZ deployment is supported. - 1: supported. - 0: not supported. |
TagInfo
Instance tag information
Used by actions: CreateDBInstance, CreateDBInstanceHour, DescribeDBInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
Task
Log download task description.
Used by actions: DescribeLogDownloadTasks.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskType | Integer | No | Download task type. 0: slow log; 1: error log. |
| TaskId | String | No | Task ID. |
| CreateTime | String | No | Creation time. Note: This field may return null, indicating that no valid values can be obtained. |
| UpdateTime | String | No | Update time. Note: This field may return null, indicating that no valid values can be obtained. |
| FileSize | Integer | No | File size. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Task status. 0: initialized; 1: running; 2: successful; 3: failed. Note: This field may return null, indicating that no valid values can be obtained. |
| Percent | Integer | No | Percentage. Note: This field may return null, indicating that no valid values can be obtained. |
| Url | String | No | Download URL. Note: This field may return null, indicating that no valid values can be obtained. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback