Data Types
Last updated: 2025-10-24 14:32:33
Data Types
Last updated: 2025-10-24 14:32:33
Cluster
Instance-related information.
Used by actions: DescribeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| AppID | Integer | No | User APP ID. Note: This field may return null, indicating that no valid values can be obtained. |
| ClusterID | String | No | Instance ID. Note: This field may return null, indicating that no valid values can be obtained. |
| AccountID | String | No | Account ID.Note: This field may return null, indicating that no valid values can be obtained. |
| Name | String | No | Customizes the instance name. Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | No | Region.Note: This field may return null, indicating that no valid values can be obtained. |
| Zones | String | No | Availability zone.Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Instance status. 0: running; 1: creating; 16: adjusting configuration; 17: isolating; 18: to be terminated; 19: recovering; 20: shutting down; 21: terminating; 22: terminated. Note: This field may return null, indicating that no valid values can be obtained. |
| Period | Period | No | Instance validity period. Note: This field may return null, indicating that no valid values can be obtained. |
| CreatedAt | Timestamp ISO8601 | No | Creation time.Note: This field may return null, indicating that no valid values can be obtained. |
| UpdatedAt | Timestamp ISO8601 | No | Last modification time. Note: This field may return null, indicating that no valid values can be obtained. |
| Tenant | Tenant | No | Internal features of the product. Note: This field may return null, indicating that no valid values can be obtained. |
| Tags | Array of Tag | No | Tag. Note: This field may return null, indicating that no valid values can be obtained. |
| Security | Array of String | No | Security group information.Note: This field may return null, indicating that no valid values can be obtained. |
Database
Database-related information.
Used by actions: DescribeDatabases.
| Name | Type | Required | Description |
|---|---|---|---|
| ClusterID | String | No | Instance ID. Note: This field may return null, indicating that no valid values can be obtained. |
| Name | String | No | Database name.Note: This field may return null, indicating that no valid values can be obtained. |
| CoolDownInDays | Integer | No | Cold storage time (days). Note: This field may return null, indicating that no valid values can be obtained. |
| RetentionInDays | Integer | No | Data retention time (days). Note: This field may return null, indicating that no valid values can be obtained. |
| Remark | String | No | Remarks.Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Status. 0: initializing resources; 1: creating resources; 2: normal status; 3: deleting resources; 4: deleted resources; 5: disabling resources; 6: disabled resources; 7: abnormal resources, and manual operation is required. Note: This field may return null, indicating that no valid values can be obtained. |
| CreatedAt | Timestamp ISO8601 | No | Creation time.Note: This field may return null, indicating that no valid values can be obtained. |
| UpdatedAt | Timestamp ISO8601 | No | Last modification time. Note: This field may return null, indicating that no valid values can be obtained. |
Filter
Query filter.
Used by actions: DescribeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Filter parameter. |
| Op | String | No | Filter expression. |
| Values | Array of String | No | Value involved in filtering. |
Order
Sorting parameter, which is used for sorting the query results.
Used by actions: DescribeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Sorting field. |
| Type | String | No | Sorting method. |
Period
Validity period.
Used by actions: DescribeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| StartTime | Timestamp ISO8601 | No | Start time. Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | Timestamp ISO8601 | No | End time. Note: This field may return null, indicating that no valid values can be obtained. |
Tag
Tag.
Used by actions: DescribeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | Key. Note: This field may return null, indicating that no valid values can be obtained. |
| Value | String | No | Value. Note: This field may return null, indicating that no valid values can be obtained. |
Tenant
Internal features of the product.
Used by actions: DescribeClusters.
| Name | Type | Required | Description |
|---|---|---|---|
| IsPasswordEncrypted | Boolean | No | Whether the password is encrypted. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback