Data Types
Last updated: 2025-11-13 20:52:44
Data Types
Last updated: 2025-11-13 20:52:44
APIGWParams
APIGWParams description
Used by actions: CreateConnection, ListConnections.
| Name | Type | Required | Description |
|---|---|---|---|
| Protocol | String | Yes | HTTPS |
| Method | String | Yes | POST |
CkafkaDeliveryParams
Parameter of the Kafka topic to be delivered to
Used by actions: ListRules.
| Name | Type | Required | Description |
|---|---|---|---|
| TopicName | String | Yes | ckafka topic name |
| ResourceDescription | String | Yes | Six-Segment QCS description of CKafka resource |
CkafkaParams
CKafka connector parameter
Used by actions: CreateConnection, ListConnections.
| Name | Type | Required | Description |
|---|---|---|---|
| Offset | String | Yes | kafka offset |
| TopicName | String | Yes | ckafka topic |
CkafkaTargetParams
CKafka delivery target description
Used by actions: CreateTarget.
| Name | Type | Required | Description |
|---|---|---|---|
| TopicName | String | Yes | CKafka topic to be delivered to |
| RetryPolicy | RetryPolicy | Yes | Retry policy |
Connection
Connection information
Used by actions: ListConnections.
| Name | Type | Description |
|---|---|---|
| Status | String | Status |
| ModTime | Timestamp ISO8601 | Update time |
| Enable | Boolean | Switch |
| Description | String | Description |
| AddTime | Timestamp ISO8601 | Creation time |
| ConnectionId | String | Connector ID |
| EventBusId | String | Event bus ID |
| ConnectionDescription | ConnectionDescription | Connector description |
| ConnectionName | String | Connector name |
| Type | String | Type |
ConnectionBrief
Connector basic information
Used by actions: ListEventBuses.
| Name | Type | Description |
|---|---|---|
| Type | String | Connector type Note: This field may return null, indicating that no valid values can be obtained. |
| Status | String | Connector status Note: This field may return null, indicating that no valid values can be obtained. |
ConnectionDescription
Connection description
Used by actions: CreateConnection, ListConnections.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceDescription | String | Yes | Six-Segment QCS resource description. For more information, see Resource Description Method |
| APIGWParams | APIGWParams | No | API Gateway parameters Note: this field may return null, indicating that no valid values can be obtained. |
| CkafkaParams | CkafkaParams | No | CKafka parameters Note: this field may return null, indicating that no valid values can be obtained. |
| DTSParams | DTSParams | No | Data Transfer Service (DTS) connector information Note: This field may return null, indicating that no valid values can be obtained. |
DTSParams
Data Transfer Service (DTS) connector information
Used by actions: CreateConnection, ListConnections.
| Name | Type | Required | Description |
|---|
DeadLetterConfig
DLQ configuration of rule
Used by actions: ListRules.
| Name | Type | Required | Description |
|---|---|---|---|
| DisposeMethod | String | Yes | Three modes are supported: DLQ, drop, and ignore error, which correspond to DLQ, DROP, and IGNORE_ERROR respectively |
| CkafkaDeliveryParams | CkafkaDeliveryParams | No | If the DLQ mode is set, this option is required. Error messages will be delivered to the corresponding Kafka topic Note: this field may return null, indicating that no valid values can be obtained. |
ESTargetParams
ES rule targets
Used by actions: CreateTarget.
| Name | Type | Required | Description |
|---|---|---|---|
| NetMode | String | Yes | Network connection type |
| IndexPrefix | String | Yes | Index prefix |
| RotationInterval | String | Yes | ES log rotation interval |
| OutputMode | String | Yes | DTS event configuration |
| IndexSuffixMode | String | Yes | DTS indexing configuration |
| IndexTemplateType | String | No | ES template type |
EtlFilter
Describes how to filter data
Used by actions: CheckTransformation, CreateTransformation, GetTransformation, UpdateTransformation.
| Name | Type | Required | Description |
|---|---|---|---|
| Filter | String | Yes | The syntax is the same as that of Rule |
EventBus
Event bus information
Used by actions: ListEventBuses.
| Name | Type | Description |
|---|---|---|
| ModTime | Timestamp ISO8601 | Update time |
| Description | String | Event bus description, which can contain up to 200 characters of any type |
| AddTime | Timestamp ISO8601 | Creation time |
| EventBusName | String | Event bus name, which can contain 2–60 letters, digits, underscores, and hyphens and must start with a letter and end with a digit or letter |
| EventBusId | String | Event bus ID |
| Type | String | Event bus type |
| PayMode | String | Billing Mode Note: This field may return null, indicating that no valid values can be obtained. |
| ConnectionBriefs | Array of ConnectionBrief | Connector basic information Note: This field may return null, indicating that no valid values can be obtained. |
| TargetBriefs | Array of TargetBrief | Target information Note: This field may return null, indicating that no valid values can be obtained. |
Extraction
Describes how to extract data
Used by actions: CheckTransformation, CreateTransformation, GetTransformation, UpdateTransformation.
| Name | Type | Required | Description |
|---|---|---|---|
| ExtractionInputPath | String | Yes | JsonPath, which will be $. by default if not specified |
| Format | String | Yes | Valid values: TEXT/JSON |
| TextParams | TextParams | No | Only required for TextNote: this field may return null, indicating that no valid values can be obtained. |
Filter
Key-Value pair filter for conditional filtering queries, such as filtering ID, name, and status
- If more than one filter exists, the logical relationship between these filters is
AND. - If multiple values exist in one filter, the logical relationship between these values is
OR.
Used by actions: ListEventBuses.
| Name | Type | Required | Description |
|---|---|---|---|
| Values | Array of String | Yes | One or more filter values. |
| Name | String | Yes | Filter name. |
LogFilter
Definition of filter parameters of log query-related API
Used by actions: DescribeLogTagValue, SearchLog.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | Field name |
| Operator | String | No | Operator. Values: eq (Equal to), neq (Not equal to), like, not like, lt (Smaller than), lte (Smaller than and equal to), gt (Greater than), gte (Greater than and equal to), range (Within the range) and norange (Not in the range). |
| Value | String | No | Filter value. Two values should be entered for range operation, separated by a comma (,). |
| Type | String | No | The logical relationship between conditions. Values: AND and OR. |
| Filters | Array of LogFilters | No | LogFilters array |
LogFilters
Log filters
Used by actions: DescribeLogTagValue, SearchLog.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Field name |
| Operator | String | Yes | Operator. Values: eq (Equal to), neq (Not equal to), like, not like, lt (Smaller than), lte (Smaller than and equal to), gt (Greater than), gte (Greater than and equal to), range (Within the range) and norange (Not in the range). |
| Value | String | Yes | Filter value. Two values should be entered for range operation, separated by a comma (,) |
OutputStructParam
Transform output parameter
Used by actions: CheckTransformation, CreateTransformation, GetTransformation, UpdateTransformation.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Key in the corresponding JSON output |
| Value | String | Yes | You can enter a JsonPath, constant, or built-in date type |
| ValueType | String | Yes | Data type of Value. Valid values: STRING, NUMBER, BOOLEAN, NULL, SYS_VARIABLE, JSONPATH |
RetryPolicy
Description of CKafka delivery target retry policy
Used by actions: CreateTarget.
| Name | Type | Required | Description |
|---|---|---|---|
| RetryInterval | Integer | Yes | Retry interval in seconds |
| MaxRetryAttempts | Integer | Yes | Maximum number of retries |
Rule
Rule information
Used by actions: ListRules.
| Name | Type | Description |
|---|---|---|
| Status | String | Status |
| ModTime | Timestamp ISO8601 | Modification time |
| Enable | Boolean | Switch |
| Description | String | Description |
| RuleId | String | Rule ID |
| AddTime | Timestamp ISO8601 | Creation time |
| EventBusId | String | Event bus ID |
| RuleName | String | Rule name |
| Targets | Array of TargetBrief | Target overview Note: this field may return null, indicating that no valid values can be obtained. |
| DeadLetterConfig | DeadLetterConfig | DLQ rule set by the rule, which may be null Note: this field may return null, indicating that no valid values can be obtained. |
SCFParams
SCF parameter
Used by actions: CreateTarget.
| Name | Type | Required | Description |
|---|---|---|---|
| BatchTimeout | Integer | No | Maximum waiting time for batch delivery |
| BatchEventCount | Integer | No | Maximum number of events in batch delivery |
| EnableBatchDelivery | Boolean | No | Enables batch delivery |
SearchLogResult
Retails of returned logs
Used by actions: SearchLog.
| Name | Type | Description |
|---|---|---|
| Timestamp | String | Log reported time Note: This field may return·null, indicating that no valid values can be obtained. |
| Message | String | Log details Note: This field may return·null, indicating that no valid values can be obtained. |
| Source | String | Event source Note: This field may return·null, indicating that no valid values can be obtained. |
| Type | String | The event type. Note: This field may return·null, indicating that no valid values can be obtained. |
| RuleIds | String | Event matching rule Note: This field may return·null, indicating that no valid values can be obtained. |
| Subject | String | The instance ID. Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | The region. Note: This field may return·null, indicating that no valid values can be obtained. |
| Status | String | Event status Note: This field may return·null, indicating that no valid values can be obtained. |
Target
Target information
Used by actions: ListTargets.
| Name | Type | Description |
|---|---|---|
| Type | String | Target type |
| EventBusId | String | Event bus ID |
| TargetId | String | Target ID |
| TargetDescription | TargetDescription | Target description |
| RuleId | String | Event rule ID |
| EnableBatchDelivery | Boolean | Enables batch delivery Note: this field may return null, indicating that no valid values can be obtained. |
| BatchTimeout | Integer | Maximum waiting time for batch delivery Note: this field may return null, indicating that no valid values can be obtained. |
| BatchEventCount | Integer | Maximum number of events in batch delivery Note: this field may return null, indicating that no valid values can be obtained. |
TargetBrief
Target overview
Used by actions: ListEventBuses, ListRules.
| Name | Type | Description |
|---|---|---|
| TargetId | String | Target ID |
| Type | String | Target type |
TargetDescription
Target description
Used by actions: CreateTarget, ListTargets.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceDescription | String | Yes | Six-Segment QCS resource description. For more information, see Resource Description Method |
| SCFParams | SCFParams | No | SCF parameter |
| CkafkaTargetParams | CkafkaTargetParams | No | CKafka parameters |
| ESTargetParams | ESTargetParams | No | ElasticSearch parameters |
TextParams
Describes how to slice data
Used by actions: CheckTransformation, CreateTransformation, GetTransformation, UpdateTransformation.
| Name | Type | Required | Description |
|---|---|---|---|
| Separator | String | No | Comma, | , tab, space, line break, %, or #, which can contain only 1 character. Note: this field may return null, indicating that no valid values can be obtained. |
| Regex | String | No | Entered regex (128 characters) Note: this field may return null, indicating that no valid values can be obtained. |
Transform
Describes how to transform data
Used by actions: CheckTransformation, CreateTransformation, GetTransformation, UpdateTransformation.
| Name | Type | Required | Description |
|---|---|---|---|
| OutputStructs | Array of OutputStructParam | Yes | Describes how to transform data |
Transformation
Transformer
Used by actions: CheckTransformation, CreateTransformation, GetTransformation, UpdateTransformation.
| Name | Type | Required | Description |
|---|---|---|---|
| Extraction | Extraction | No | Describes how to extract data Note: this field may return null, indicating that no valid values can be obtained. |
| EtlFilter | EtlFilter | No | Describes how to filter data Note: this field may return null, indicating that no valid values can be obtained. |
| Transform | Transform | No | Describes how to transform data 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