Data Types
Last updated:2026-03-13 18:56:46
Data Types
Last updated: 2026-03-13 18:56:46
ArchiveLogInterval
Recoverable time interval
Used by actions: DescribeDBSAvailableRecoveryTime.
| Name | Type | Required | Description |
|---|---|---|---|
| EndTime | String | No | End time. Note: This field may return null, indicating that no valid values can be obtained. |
| MajorVersion | String | No | Major version. Note: This field may return null, indicating that no valid values can be obtained. |
| MinorVersion | String | No | Minor version. Note: This field may return null, indicating that no valid values can be obtained. |
| StartTime | String | No | Start time. Note: This field may return null, indicating that no valid values can be obtained. |
BackupPolicyModelInput
Modify backup policy object.
Used by actions: ModifyDBSBackupPolicy.
| Name | Type | Required | Description |
|---|---|---|---|
| BackupEndTime | String | No | Backup end time. |
| BackupMethod | String | No | Backup method: physical physical backup, snapshot snapshot backup |
| BackupStartTime | String | No | Backup start time |
| EnableFull | Integer | No | Whether full backup is enabled |
| EnableLog | Integer | No | Whether to enable log backup |
| FullRetentionPeriod | Integer | No | Full backup retention time can currently only be set to 7 days. |
| InstanceId | String | No | Instance ID. |
| LogRetentionPeriod | Integer | No | Log retention days. currently, can only set retention to 7 days. |
| PeriodTime | String | No | Days of the week to perform backup. |
| StorageType | String | No | Storage type: COS, SNAPSHOT valid values:
|
CloneInstanceModel
Clone instance object.
Used by actions: DescribeDBSCloneInstances.
| Name | Type | Description |
|---|---|---|
| CloneEndTime | String | Clone task end time. Note: This field may return null, indicating that no valid values can be obtained. |
| CloneId | Integer | Clone record ID. Note: This field may return null, indicating that no valid values can be obtained. |
| CloneInsType | String | Clone instance type. Note: This field may return null, indicating that no valid values can be obtained. |
| CloneInstanceId | String | Clone instance ID. Note: This field may return null, indicating that no valid values can be obtained. |
| CloneInstanceIsDeleted | Boolean | Whether the clone instance is deleted. Note: This field may return null, indicating that no valid values can be obtained. |
| CloneProgress | Float | Task progress of clone. Note: This field may return null, indicating that no valid values can be obtained. |
| CloneStartTime | String | Task start time of the clone. Note: This field may return null, indicating that no valid values can be obtained. |
| CloneStatus | String | Task status. Note: This field may return null, indicating that no valid values can be obtained. |
| CloneTime | String | Clone time. Note: This field may return null, indicating that no valid values can be obtained. |
| CloneType | String | Clone type. Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | Creation time. Note: This field may return null, indicating that no valid values can be obtained. |
| DBType | String | Engine type. Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | Region. Note: This field may return null, indicating that no valid values can be obtained. |
| SourceInstanceId | String | Source instance ID. Note: This field may return null, indicating that no valid values can be obtained. |
ConstraintRange
Value range of the constraint type.
Used by actions: DescribeDBParameters.
| Name | Type | Description |
|---|---|---|
| Min | String | Minimum value when the constraint type is section. |
| Max | String | Specifies the maximum value when the constraint type is section. |
DBParamValue
Cloud database parameter information.
Used by actions: ModifyDBParameters.
| Name | Type | Required | Description |
|---|---|---|---|
| Param | String | Yes | Parameter name. |
| Value | String | Yes | Parameter value. |
DatabaseFunction
Database function information.
Used by actions: DescribeDatabaseObjects.
| Name | Type | Description |
|---|---|---|
| Func | String | Function name. |
DatabaseProcedure
Database stored procedure information.
Used by actions: DescribeDatabaseObjects.
| Name | Type | Description |
|---|---|---|
| Proc | String | Stored procedure name. |
DatabaseTable
Database table information.
Used by actions: DescribeDatabaseObjects.
| Name | Type | Description |
|---|---|---|
| Table | String | Table name |
DatabaseView
Database view information.
Used by actions: DescribeDatabaseObjects.
| Name | Type | Description |
|---|---|---|
| View | String | View name. |
ParamConstraint
Parameter constraints.
Used by actions: DescribeDBParameters.
| Name | Type | Description |
|---|---|---|
| Type | String | Constraint type, for example enumeration, interval. |
| Enum | String | Lists the available options when the constraint type is enum. Note: This field may return null, indicating that no valid values can be obtained. |
| Range | ConstraintRange | Value range when the constraint type is section. Note: This field may return null, indicating that no valid values can be obtained. |
| String | String | Valid values when the constraint type is string. Note: This field may return null, indicating that no valid values can be obtained. |
ParamDesc
DB parameter description.
Used by actions: DescribeDBParameters.
| Name | Type | Description |
|---|---|---|
| Param | String | Parameter name. |
| Value | String | Current parameter value. |
| SetValue | String | The configured value is the same as the value once the parameter takes effect. Note: This field may return null, indicating that no valid values can be obtained. |
| Default | String | System default value. |
| Constraint | ParamConstraint | Parameter limits. Note: This field may return null, indicating that no valid values can be obtained. |
| HaveSetValue | Boolean | Whether a value has been set. false: not set. true: has set. |
| NeedRestart | Boolean | true: restart required. |
| Description | String | Parameter description. Note: This field may return null, indicating that no valid values can be obtained. |
SecurityGroup
Security group details.
Used by actions: DescribeDBSecurityGroups.
| Name | Type | Description |
|---|---|---|
| ProjectId | Integer | Project ID. |
| CreateTime | String | CreationTime, time format: yyyy-mm-dd hh:mm:ss. |
| SecurityGroupId | String | Security group ID. |
| SecurityGroupName | String | Security group name. |
| SecurityGroupRemark | String | Security group remarks |
| Inbound | Array of SecurityGroupBound | Inbound rule. |
| Outbound | Array of SecurityGroupBound | Outbound rule. |
SecurityGroupBound
Inbound and outbound rules.
Used by actions: DescribeDBSecurityGroups.
| Name | Type | Description |
|---|---|---|
| CidrIp | String | Source IP or IP range, such as 192.168.0.0/16. |
| Action | String | Policy, ACCEPT or DROP. |
| PortRange | String | Port. |
| IpProtocol | String | Network protocol, supports UDP, TCP. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback