alibabacloud-sls20201230 4.0.0__py3-none-any.whl → 4.1.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1131,9 +1131,6 @@ class Ticket(TeaModel):
1131
1131
  number: int = None,
1132
1132
  ticket: str = None,
1133
1133
  ticket_id: str = None,
1134
- type: str = None,
1135
- unlimited_expiration: bool = None,
1136
- unlimited_number: bool = None,
1137
1134
  used_number: int = None,
1138
1135
  valid: bool = None,
1139
1136
  ):
@@ -1146,9 +1143,6 @@ class Ticket(TeaModel):
1146
1143
  self.number = number
1147
1144
  self.ticket = ticket
1148
1145
  self.ticket_id = ticket_id
1149
- self.type = type
1150
- self.unlimited_expiration = unlimited_expiration
1151
- self.unlimited_number = unlimited_number
1152
1146
  self.used_number = used_number
1153
1147
  self.valid = valid
1154
1148
 
@@ -1179,12 +1173,6 @@ class Ticket(TeaModel):
1179
1173
  result['ticket'] = self.ticket
1180
1174
  if self.ticket_id is not None:
1181
1175
  result['ticketId'] = self.ticket_id
1182
- if self.type is not None:
1183
- result['type'] = self.type
1184
- if self.unlimited_expiration is not None:
1185
- result['unlimitedExpiration'] = self.unlimited_expiration
1186
- if self.unlimited_number is not None:
1187
- result['unlimitedNumber'] = self.unlimited_number
1188
1176
  if self.used_number is not None:
1189
1177
  result['usedNumber'] = self.used_number
1190
1178
  if self.valid is not None:
@@ -1211,12 +1199,6 @@ class Ticket(TeaModel):
1211
1199
  self.ticket = m.get('ticket')
1212
1200
  if m.get('ticketId') is not None:
1213
1201
  self.ticket_id = m.get('ticketId')
1214
- if m.get('type') is not None:
1215
- self.type = m.get('type')
1216
- if m.get('unlimitedExpiration') is not None:
1217
- self.unlimited_expiration = m.get('unlimitedExpiration')
1218
- if m.get('unlimitedNumber') is not None:
1219
- self.unlimited_number = m.get('unlimitedNumber')
1220
1202
  if m.get('usedNumber') is not None:
1221
1203
  self.used_number = m.get('usedNumber')
1222
1204
  if m.get('valid') is not None:
@@ -2341,11 +2323,23 @@ class KeysValue(TeaModel):
2341
2323
  token: List[str] = None,
2342
2324
  doc_value: bool = None,
2343
2325
  ):
2326
+ # Specifies whether to enable case sensitivity. This parameter is required only when **type** is set to **text**. Valid values:
2327
+ #
2328
+ # * true
2329
+ # * false (default)
2344
2330
  self.case_sensitive = case_sensitive
2331
+ # Specifies whether to include Chinese characters. This parameter is required only when **type** is set to **text**. Valid values:
2332
+ #
2333
+ # * true
2334
+ # * false (default)
2345
2335
  self.chn = chn
2336
+ # The data type of the field value. Valid values: text, json, double, and long.
2346
2337
  self.type = type
2338
+ # The alias of the field.
2347
2339
  self.alias = alias
2340
+ # The delimiters that are used to split text.
2348
2341
  self.token = token
2342
+ # Specifies whether to turn on Enable Analytics for the field.
2349
2343
  self.doc_value = doc_value
2350
2344
 
2351
2345
  def validate(self):
@@ -2771,8 +2765,19 @@ class CreateConsumerGroupRequest(TeaModel):
2771
2765
  order: bool = None,
2772
2766
  timeout: int = None,
2773
2767
  ):
2768
+ # The name of the consumer group. The name must be unique in a project.
2774
2769
  self.consumer_group = consumer_group
2770
+ # Specifies whether to consume data in sequence. Valid values:
2771
+ #
2772
+ # * true
2773
+ #
2774
+ # * In a shard, data is consumed in ascending order based on the value of the \*\*\__tag\_\_:\__receive_time\_\_\*\* field.
2775
+ # * If a shard is split, data in the original shard is consumed first. Then, data in the new shards is consumed at the same time.
2776
+ # * If shards are merged, data in the original shards is consumed first. Then, data in the new shard is consumed.
2777
+ #
2778
+ # * false Data in all shards is consumed at the same time. If a new shard is generated after a shard is split or after shards are merged, data in the new shard is immediately consumed.
2775
2779
  self.order = order
2780
+ # The timeout period. If the server does not receive heartbeats from a consumer within the timeout period, the server deletes the consumer. Unit: seconds.
2776
2781
  self.timeout = timeout
2777
2782
 
2778
2783
  def validate(self):
@@ -2905,6 +2910,7 @@ class CreateDomainRequest(TeaModel):
2905
2910
  self,
2906
2911
  domain_name: str = None,
2907
2912
  ):
2913
+ # The domain name.
2908
2914
  self.domain_name = domain_name
2909
2915
 
2910
2916
  def validate(self):
@@ -2970,10 +2976,21 @@ class CreateIndexRequestLine(TeaModel):
2970
2976
  include_keys: List[str] = None,
2971
2977
  token: List[str] = None,
2972
2978
  ):
2979
+ # Specifies whether to enable case sensitivity. Valid values:
2980
+ #
2981
+ # * true
2982
+ # * false (default)
2973
2983
  self.case_sensitive = case_sensitive
2984
+ # Specifies whether to include Chinese characters. Valid values:
2985
+ #
2986
+ # * true
2987
+ # * false (default)
2974
2988
  self.chn = chn
2989
+ # The excluded fields. You cannot specify both include_keys and exclude_keys.
2975
2990
  self.exclude_keys = exclude_keys
2991
+ # The included fields. You cannot specify both include_keys and exclude_keys.
2976
2992
  self.include_keys = include_keys
2993
+ # The delimiters. You can specify a delimiter to delimit the content of a field value. For more information about delimiters, see Example.
2977
2994
  self.token = token
2978
2995
 
2979
2996
  def validate(self):
@@ -3023,12 +3040,19 @@ class CreateIndexRequest(TeaModel):
3023
3040
  max_text_len: int = None,
3024
3041
  ttl: int = None,
3025
3042
  ):
3043
+ # The configuration of field indexes. A field index is a key-value pair in which the key specifies the name of the field and the value specifies the index configuration of the field. You must specify this parameter, the line parameter, or both parameters. For more information, see Example.
3026
3044
  self.keys = keys
3045
+ # The configuration of full-text indexes. You must specify this parameter, the keys parameter, or both parameters. For more information, see Example.
3027
3046
  self.line = line
3047
+ # Specifies whether to turn on LogReduce. After you turn on LogReduce, either the whitelist or blacklist takes effect.
3028
3048
  self.log_reduce = log_reduce
3049
+ # The fields in the blacklist that you want to use to cluster logs.
3029
3050
  self.log_reduce_black_list = log_reduce_black_list
3051
+ # The fields in the whitelist that you want to use to cluster logs.
3030
3052
  self.log_reduce_white_list = log_reduce_white_list
3053
+ # The maximum length of a field value that can be retained. Default value: 2048. Unit: bytes. The default value is equal to 2 KB. You can change the value of max_text_len. Valid values: 64 to 16384.
3031
3054
  self.max_text_len = max_text_len
3055
+ # The retention period of logs. Unit: days. Valid values: 7, 30, and 90.
3032
3056
  self.ttl = ttl
3033
3057
 
3034
3058
  def validate(self):
@@ -3135,16 +3159,53 @@ class CreateLogStoreRequest(TeaModel):
3135
3159
  telemetry_type: str = None,
3136
3160
  ttl: int = None,
3137
3161
  ):
3162
+ # Specifies whether to record public IP addresses. Default value: false. Valid values:
3163
+ #
3164
+ # * true
3165
+ # * false
3138
3166
  self.append_meta = append_meta
3167
+ # Specifies whether to enable automatic sharding. Valid values:
3168
+ #
3169
+ # * true
3170
+ # * false
3139
3171
  self.auto_split = auto_split
3172
+ # Specifies whether to enable the web tracking feature. Default value: false. Valid values:
3173
+ #
3174
+ # * true
3175
+ # * false
3140
3176
  self.enable_tracking = enable_tracking
3177
+ # The data structure of the encryption configuration.
3141
3178
  self.encrypt_conf = encrypt_conf
3179
+ # The retention period of data in the hot storage tier of the Logstore. Unit: days. You can specify a value that ranges from 30 to the value of ttl.
3180
+ #
3181
+ # Hot data that is stored for longer than the period specified by hot_ttl is converted to cold data. For more information, see [Enable hot and cold-tiered storage for a Logstore](~~308645~~).
3142
3182
  self.hot_ttl = hot_ttl
3183
+ # The name of the Logstore. The name must meet the following requirements:
3184
+ #
3185
+ # * The name must be unique in a project.
3186
+ # * The name can contain only lowercase letters, digits, hyphens (-), and underscores (\_).
3187
+ # * The name must start and end with a lowercase letter or a digit.
3188
+ # * The name must be 3 to 63 characters in length.
3143
3189
  self.logstore_name = logstore_name
3190
+ # The maximum number of shards into which existing shards can be automatically split. Valid values: 1 to 64.
3191
+ #
3192
+ # > If you set autoSplit to true, you must configure this parameter.
3144
3193
  self.max_split_shard = max_split_shard
3194
+ # The type of the Logstore. Log Service provides the following types of Logstores: Standard Logstores and Query Logstores. Valid values:
3195
+ #
3196
+ # * **standard**: Standard Logstore. This type of Logstore supports the log analysis feature and is suitable for scenarios such as real-time monitoring and interactive analysis. You can also use this type of Logstore to build a comprehensive observability system.
3197
+ # * **query**: Query Logstore. This type of Logstore supports high-performance queries. The index traffic fee of a Query Logstore is approximately half that of a Standard Logstore. Query Logstores do not support SQL analysis. Query Logstores are suitable for scenarios in which the amount of data is large, the log retention period is long, or log analysis is not required. Log retention periods of weeks or months are considered long.
3145
3198
  self.mode = mode
3199
+ # The number of shards.
3200
+ #
3201
+ # > You cannot call the CreateLogStore operation to change the number of shards. You can call the SplitShard or MergeShards operation to change the number of shards.
3146
3202
  self.shard_count = shard_count
3203
+ # The type of the observable data. Valid values:
3204
+ #
3205
+ # * None: logs
3206
+ # * Metrics: metrics
3147
3207
  self.telemetry_type = telemetry_type
3208
+ # The retention period of data. Unit: days. Valid values: 1 to 3000. If you set this parameter to 3650, data is permanently stored.
3148
3209
  self.ttl = ttl
3149
3210
 
3150
3211
  def validate(self):
@@ -3249,7 +3310,18 @@ class CreateLoggingRequestLoggingDetails(TeaModel):
3249
3310
  logstore: str = None,
3250
3311
  type: str = None,
3251
3312
  ):
3313
+ # The name of the Logstore to which service logs of the type are stored.
3252
3314
  self.logstore = logstore
3315
+ # The type of service logs. Valid values:
3316
+ #
3317
+ # * consumergroup_log: the consumption delay logs of consumer groups.
3318
+ # * logtail_alarm: the alert logs of Logtail.
3319
+ # * operation_log: the operation logs.
3320
+ # * logtail_profile: the collection logs of Logtail.
3321
+ # * metering: the metering logs.
3322
+ # * logtail_status: the status logs of Logtail.
3323
+ # * scheduledsqlalert: the run logs of Scheduled SQL jobs.
3324
+ # * etl_alert: the run logs of data transformation jobs.
3253
3325
  self.type = type
3254
3326
 
3255
3327
  def validate(self):
@@ -3282,7 +3354,9 @@ class CreateLoggingRequest(TeaModel):
3282
3354
  logging_details: List[CreateLoggingRequestLoggingDetails] = None,
3283
3355
  logging_project: str = None,
3284
3356
  ):
3357
+ # The configurations of service logs.
3285
3358
  self.logging_details = logging_details
3359
+ # The name of the project to which service logs are stored.
3286
3360
  self.logging_project = logging_project
3287
3361
 
3288
3362
  def validate(self):
@@ -3454,7 +3528,9 @@ class CreateMachineGroupRequestGroupAttribute(TeaModel):
3454
3528
  external_name: str = None,
3455
3529
  group_topic: str = None,
3456
3530
  ):
3531
+ # The identifier of the external management system on which the machine group depends.
3457
3532
  self.external_name = external_name
3533
+ # The log topic of the machine group.
3458
3534
  self.group_topic = group_topic
3459
3535
 
3460
3536
  def validate(self):
@@ -3490,10 +3566,26 @@ class CreateMachineGroupRequest(TeaModel):
3490
3566
  machine_identify_type: str = None,
3491
3567
  machine_list: List[str] = None,
3492
3568
  ):
3569
+ # The attributes of the machine group.
3493
3570
  self.group_attribute = group_attribute
3571
+ # The name of the machine group. The name must meet the following requirements:
3572
+ #
3573
+ # * The name of each machine group in a project must be unique.
3574
+ # * It can contain only lowercase letters, digits, hyphens (-), and underscores (\_).
3575
+ # * It must start and end with a lowercase letter or a digit.
3576
+ # * It must be 3 to 128 characters in length.
3494
3577
  self.group_name = group_name
3578
+ # The type of the machine group. The parameter can be left empty.
3495
3579
  self.group_type = group_type
3580
+ # The type of the machine group identifier. Valid values:
3581
+ #
3582
+ # * ip: The machine group uses IP addresses as identifiers.
3583
+ # * userdefined: The machine group uses custom identifiers.
3496
3584
  self.machine_identify_type = machine_identify_type
3585
+ # The identifiers of machine group.
3586
+ #
3587
+ # * If you set machineIdentifyType to ip, enter the IP address of the machine.
3588
+ # * If you set machineIdentifyType to userdefined, enter a custom identifier.
3497
3589
  self.machine_list = machine_list
3498
3590
 
3499
3591
  def validate(self):
@@ -3574,7 +3666,9 @@ class CreateOssExternalStoreRequestParameterColumns(TeaModel):
3574
3666
  name: str = None,
3575
3667
  type: str = None,
3576
3668
  ):
3669
+ # The name of the field.
3577
3670
  self.name = name
3671
+ # The type of the field.
3578
3672
  self.type = type
3579
3673
 
3580
3674
  def validate(self):
@@ -3611,11 +3705,17 @@ class CreateOssExternalStoreRequestParameter(TeaModel):
3611
3705
  endpoint: str = None,
3612
3706
  objects: List[str] = None,
3613
3707
  ):
3708
+ # The AccessKey ID of your account.
3614
3709
  self.accessid = accessid
3710
+ # The AccessKey secret of your account.
3615
3711
  self.accesskey = accesskey
3712
+ # The name of the OSS bucket.
3616
3713
  self.bucket = bucket
3714
+ # The associated fields.
3617
3715
  self.columns = columns
3716
+ # The OSS endpoint.
3618
3717
  self.endpoint = endpoint
3718
+ # The associated objects.
3619
3719
  self.objects = objects
3620
3720
 
3621
3721
  def validate(self):
@@ -3673,8 +3773,11 @@ class CreateOssExternalStoreRequest(TeaModel):
3673
3773
  parameter: CreateOssExternalStoreRequestParameter = None,
3674
3774
  store_type: str = None,
3675
3775
  ):
3776
+ # The name of the external store.
3676
3777
  self.external_store_name = external_store_name
3778
+ # The parameters that are configured for the external store.
3677
3779
  self.parameter = parameter
3780
+ # The type of the external store. Set the value to oss.
3678
3781
  self.store_type = store_type
3679
3782
 
3680
3783
  def validate(self):
@@ -3749,9 +3852,18 @@ class CreateProjectRequest(TeaModel):
3749
3852
  project_name: str = None,
3750
3853
  resource_group_id: str = None,
3751
3854
  ):
3855
+ # Data redundancy type
3752
3856
  self.data_redundancy_type = data_redundancy_type
3857
+ # The description of the project.
3753
3858
  self.description = description
3859
+ # The name of the project. The name must be unique in a region. You cannot change the name after you create the project. The name must meet the following requirements:
3860
+ #
3861
+ # * The name must be unique.
3862
+ # * It can contain only lowercase letters, digits, and hyphens (-).
3863
+ # * It must start and end with a lowercase letter or a digit.
3864
+ # * It must be 3 to 63 characters in length.
3754
3865
  self.project_name = project_name
3866
+ # The ID of the resource group.
3755
3867
  self.resource_group_id = resource_group_id
3756
3868
 
3757
3869
  def validate(self):
@@ -3833,14 +3945,23 @@ class CreateRdsExternalStoreRequestParameter(TeaModel):
3833
3945
  username: str = None,
3834
3946
  vpc_id: str = None,
3835
3947
  ):
3948
+ # The name of the database in the ApsaraDB RDS for MySQL instance.
3836
3949
  self.db = db
3950
+ # The internal or public endpoint of the ApsaraDB RDS for MySQL instance.
3837
3951
  self.host = host
3952
+ # The ID of the ApsaraDB RDS for MySQL instance.
3838
3953
  self.instance_id = instance_id
3954
+ # The password that is used to log on to the ApsaraDB RDS for MySQL instance.
3839
3955
  self.password = password
3956
+ # The internal or public port of the ApsaraDB RDS for MySQL instance.
3840
3957
  self.port = port
3958
+ # The region where the ApsaraDB RDS for MySQL instance resides. Valid values: cn-qingdao, cn-beijing, and cn-hangzhou.
3841
3959
  self.region = region
3960
+ # The name of the database table in the ApsaraDB RDS for MySQL instance.
3842
3961
  self.table = table
3962
+ # The username that is used to log on to the ApsaraDB RDS for MySQL instance.
3843
3963
  self.username = username
3964
+ # The ID of the VPC to which the ApsaraDB RDS for MySQL instance belongs.
3844
3965
  self.vpc_id = vpc_id
3845
3966
 
3846
3967
  def validate(self):
@@ -3902,8 +4023,11 @@ class CreateRdsExternalStoreRequest(TeaModel):
3902
4023
  parameter: CreateRdsExternalStoreRequestParameter = None,
3903
4024
  store_type: str = None,
3904
4025
  ):
4026
+ # The name of the external store. The name must be unique in a project and must be different from Logstore names.
3905
4027
  self.external_store_name = external_store_name
4028
+ # The parameter struct.
3906
4029
  self.parameter = parameter
4030
+ # The storage type. Set the value to rds-vpc, which indicates an ApsaraDB RDS for MySQL database in a virtual private cloud (VPC).
3907
4031
  self.store_type = store_type
3908
4032
 
3909
4033
  def validate(self):
@@ -3979,10 +4103,15 @@ class CreateSavedSearchRequest(TeaModel):
3979
4103
  search_query: str = None,
3980
4104
  topic: str = None,
3981
4105
  ):
4106
+ # The display name.
3982
4107
  self.display_name = display_name
4108
+ # The name of the Logstore to which the saved search belongs.
3983
4109
  self.logstore = logstore
4110
+ # The name of the saved search. The name must be 3 to 63 characters in length.
3984
4111
  self.savedsearch_name = savedsearch_name
4112
+ # The query statement of the saved search. A query statement consists of a search statement and an analytic statement in the `Search statement|Analytic statement` format. For more information about search statements and analytic statements, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).
3985
4113
  self.search_query = search_query
4114
+ # The topic of the log.
3986
4115
  self.topic = topic
3987
4116
 
3988
4117
  def validate(self):
@@ -4055,110 +4184,6 @@ class CreateSavedSearchResponse(TeaModel):
4055
4184
  return self
4056
4185
 
4057
4186
 
4058
- class CreateTicketRequest(TeaModel):
4059
- def __init__(
4060
- self,
4061
- play_access_key_id: str = None,
4062
- play_access_key_secret: str = None,
4063
- ):
4064
- self.play_access_key_id = play_access_key_id
4065
- self.play_access_key_secret = play_access_key_secret
4066
-
4067
- def validate(self):
4068
- pass
4069
-
4070
- def to_map(self):
4071
- _map = super().to_map()
4072
- if _map is not None:
4073
- return _map
4074
-
4075
- result = dict()
4076
- if self.play_access_key_id is not None:
4077
- result['playAccessKeyId'] = self.play_access_key_id
4078
- if self.play_access_key_secret is not None:
4079
- result['playAccessKeySecret'] = self.play_access_key_secret
4080
- return result
4081
-
4082
- def from_map(self, m: dict = None):
4083
- m = m or dict()
4084
- if m.get('playAccessKeyId') is not None:
4085
- self.play_access_key_id = m.get('playAccessKeyId')
4086
- if m.get('playAccessKeySecret') is not None:
4087
- self.play_access_key_secret = m.get('playAccessKeySecret')
4088
- return self
4089
-
4090
-
4091
- class CreateTicketResponseBody(TeaModel):
4092
- def __init__(
4093
- self,
4094
- ticket: str = None,
4095
- ):
4096
- self.ticket = ticket
4097
-
4098
- def validate(self):
4099
- pass
4100
-
4101
- def to_map(self):
4102
- _map = super().to_map()
4103
- if _map is not None:
4104
- return _map
4105
-
4106
- result = dict()
4107
- if self.ticket is not None:
4108
- result['ticket'] = self.ticket
4109
- return result
4110
-
4111
- def from_map(self, m: dict = None):
4112
- m = m or dict()
4113
- if m.get('ticket') is not None:
4114
- self.ticket = m.get('ticket')
4115
- return self
4116
-
4117
-
4118
- class CreateTicketResponse(TeaModel):
4119
- def __init__(
4120
- self,
4121
- headers: Dict[str, str] = None,
4122
- status_code: int = None,
4123
- body: CreateTicketResponseBody = None,
4124
- ):
4125
- self.headers = headers
4126
- self.status_code = status_code
4127
- self.body = body
4128
-
4129
- def validate(self):
4130
- self.validate_required(self.headers, 'headers')
4131
- self.validate_required(self.status_code, 'status_code')
4132
- self.validate_required(self.body, 'body')
4133
- if self.body:
4134
- self.body.validate()
4135
-
4136
- def to_map(self):
4137
- _map = super().to_map()
4138
- if _map is not None:
4139
- return _map
4140
-
4141
- result = dict()
4142
- if self.headers is not None:
4143
- result['headers'] = self.headers
4144
- if self.status_code is not None:
4145
- result['statusCode'] = self.status_code
4146
- if self.body is not None:
4147
- result['body'] = self.body.to_map()
4148
- return result
4149
-
4150
- def from_map(self, m: dict = None):
4151
- m = m or dict()
4152
- if m.get('headers') is not None:
4153
- self.headers = m.get('headers')
4154
- if m.get('statusCode') is not None:
4155
- self.status_code = m.get('statusCode')
4156
- if m.get('body') is not None:
4157
- temp_model = CreateTicketResponseBody()
4158
- self.body = temp_model.from_map(m['body'])
4159
- return self
4160
-
4161
-
4162
4187
  class DeleteAnnotationDataResponse(TeaModel):
4163
4188
  def __init__(
4164
4189
  self,
@@ -4979,7 +5004,9 @@ class GetAppliedConfigsResponseBody(TeaModel):
4979
5004
  configs: List[str] = None,
4980
5005
  count: int = None,
4981
5006
  ):
5007
+ # The names of the Logtail configurations.
4982
5008
  self.configs = configs
5009
+ # The number of Logtail configurations.
4983
5010
  self.count = count
4984
5011
 
4985
5012
  def validate(self):
@@ -5056,7 +5083,9 @@ class GetAppliedMachineGroupsResponseBody(TeaModel):
5056
5083
  count: int = None,
5057
5084
  machinegroups: List[str] = None,
5058
5085
  ):
5086
+ # The number of returned machine groups.
5059
5087
  self.count = count
5088
+ # The names of the returned machine groups.
5060
5089
  self.machinegroups = machinegroups
5061
5090
 
5062
5091
  def validate(self):
@@ -5132,6 +5161,10 @@ class GetCheckPointRequest(TeaModel):
5132
5161
  self,
5133
5162
  shard: int = None,
5134
5163
  ):
5164
+ # The shard ID.
5165
+ #
5166
+ # * If the specified shard does not exist, an empty list is returned.
5167
+ # * If no shard ID is specified, the checkpoints of all shards are returned.
5135
5168
  self.shard = shard
5136
5169
 
5137
5170
  def validate(self):
@@ -5162,10 +5195,13 @@ class GetCheckPointResponseBody(TeaModel):
5162
5195
  update_time: int = None,
5163
5196
  consumer: str = None,
5164
5197
  ):
5165
- # Shard ID
5198
+ # The shard ID.
5166
5199
  self.shard = shard
5200
+ # The value of the checkpoint.
5167
5201
  self.checkpoint = checkpoint
5202
+ # The time when the checkpoint was last updated. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
5168
5203
  self.update_time = update_time
5204
+ # The consumer at the checkpoint.
5169
5205
  self.consumer = consumer
5170
5206
 
5171
5207
  def validate(self):
@@ -5609,10 +5645,15 @@ class GetContextLogsRequest(TeaModel):
5609
5645
  pack_meta: str = None,
5610
5646
  type: str = None,
5611
5647
  ):
5648
+ # The number of logs that you want to obtain and are generated before the generation time of the start log. Valid values: (0,100].
5612
5649
  self.back_lines = back_lines
5650
+ # The number of logs that you want to obtain and are generated after the generation time of the start log. Valid values: (0,100].
5613
5651
  self.forward_lines = forward_lines
5652
+ # The unique identifier of the log group to which the start log belongs.
5614
5653
  self.pack_id = pack_id
5654
+ # The unique context identifier of the start log in the log group.
5615
5655
  self.pack_meta = pack_meta
5656
+ # The type of the data in the Logstore. Set the value to context_log.
5616
5657
  self.type = type
5617
5658
 
5618
5659
  def validate(self):
@@ -5660,10 +5701,18 @@ class GetContextLogsResponseBody(TeaModel):
5660
5701
  progress: str = None,
5661
5702
  total_lines: int = None,
5662
5703
  ):
5704
+ # The number of logs that are generated before the generation time of the start log.
5663
5705
  self.back_lines = back_lines
5706
+ # The number of logs that are generated after the generation time of the start log.
5664
5707
  self.forward_lines = forward_lines
5708
+ # The logs that are returned.
5665
5709
  self.logs = logs
5710
+ # Indicates whether the query and analysis results are complete. Valid values:
5711
+ #
5712
+ # * Complete: The query is successful, and the complete query and analysis results are returned.
5713
+ # * Incomplete: The query is successful, but the query and analysis results are incomplete. To obtain the complete results, you must repeat the request.
5666
5714
  self.progress = progress
5715
+ # The total number of logs that are returned. The logs include the start log that is specified in the request.
5667
5716
  self.total_lines = total_lines
5668
5717
 
5669
5718
  def validate(self):
@@ -5751,6 +5800,7 @@ class GetCursorRequest(TeaModel):
5751
5800
  self,
5752
5801
  from_: str = None,
5753
5802
  ):
5803
+ # The point in time that you want to use to query a cursor. Set the value to a UNIX timestamp or a string such as `begin` and `end`.
5754
5804
  self.from_ = from_
5755
5805
 
5756
5806
  def validate(self):
@@ -5778,6 +5828,7 @@ class GetCursorResponseBody(TeaModel):
5778
5828
  self,
5779
5829
  cursor: str = None,
5780
5830
  ):
5831
+ # The value of the cursor.
5781
5832
  self.cursor = cursor
5782
5833
 
5783
5834
  def validate(self):
@@ -5849,6 +5900,7 @@ class GetCursorTimeRequest(TeaModel):
5849
5900
  self,
5850
5901
  cursor: str = None,
5851
5902
  ):
5903
+ # The cursor.
5852
5904
  self.cursor = cursor
5853
5905
 
5854
5906
  def validate(self):
@@ -5876,6 +5928,7 @@ class GetCursorTimeResponseBody(TeaModel):
5876
5928
  self,
5877
5929
  cursor_time: str = None,
5878
5930
  ):
5931
+ # The server time that is queried based on the cursor. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.
5879
5932
  self.cursor_time = cursor_time
5880
5933
 
5881
5934
  def validate(self):
@@ -6038,9 +6091,13 @@ class GetHistogramsRequest(TeaModel):
6038
6091
  to: int = None,
6039
6092
  topic: str = None,
6040
6093
  ):
6094
+ # The start time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
6041
6095
  self.from_ = from_
6096
+ # The search statement. Only search statements are supported. Analytic statements are not supported. For more information about the syntax of search statements, see [Log search overview](~~43772~~).
6042
6097
  self.query = query
6098
+ # The end time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
6043
6099
  self.to = to
6100
+ # The topic of the logs.
6044
6101
  self.topic = topic
6045
6102
 
6046
6103
  def validate(self):
@@ -6083,9 +6140,21 @@ class GetHistogramsResponseBody(TeaModel):
6083
6140
  count: int = None,
6084
6141
  progress: str = None,
6085
6142
  ):
6143
+ # The start time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
6144
+ #
6145
+ # The time range that is specified in this operation is a left-closed, right-open interval. The interval includes the start time specified by the from parameter, but does not include the end time specified by the to parameter. If you specify the same value for the from and to parameters, the interval is invalid, and an error message is returned.
6086
6146
  self.from_ = from_
6147
+ # The end time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
6148
+ #
6149
+ # The time range that is specified in this operation is a left-closed, right-open interval. The interval includes the start time specified by the from parameter, but does not include the end time specified by the to parameter. If you specify the same value for the from and to parameters, the interval is invalid, and an error message is returned.
6087
6150
  self.to = to
6151
+ # The number of logs that are generated within the subinterval.
6088
6152
  self.count = count
6153
+ # Indicates whether the query and analysis results in the subinterval is complete. Valid values:
6154
+ #
6155
+ # Complete: The query is successful, and the complete query and analysis results are returned.
6156
+ #
6157
+ # Incomplete: The query is successful, but the query and analysis results are incomplete. To obtain the complete results, you must repeat the request.
6089
6158
  self.progress = progress
6090
6159
 
6091
6160
  def validate(self):
@@ -6179,10 +6248,21 @@ class GetIndexResponseBodyLine(TeaModel):
6179
6248
  include_keys: List[str] = None,
6180
6249
  token: List[str] = None,
6181
6250
  ):
6251
+ # Indicates whether case sensitivity is enabled. Valid values:
6252
+ #
6253
+ # * true
6254
+ # * false
6182
6255
  self.case_sensitive = case_sensitive
6256
+ # Indicates whether Chinese characters are included. Valid values:
6257
+ #
6258
+ # * true
6259
+ # * false
6183
6260
  self.chn = chn
6261
+ # The excluded fields.
6184
6262
  self.exclude_keys = exclude_keys
6263
+ # The included fields.
6185
6264
  self.include_keys = include_keys
6265
+ # The delimiters.
6186
6266
  self.token = token
6187
6267
 
6188
6268
  def validate(self):
@@ -6235,15 +6315,25 @@ class GetIndexResponseBody(TeaModel):
6235
6315
  storage: str = None,
6236
6316
  ttl: int = None,
6237
6317
  ):
6318
+ # The type of the index.
6238
6319
  self.index_mode = index_mode
6320
+ # The configurations of field indexes. A field index is in the key-value format in which the key specifies the name of the field and the value specifies the index configuration of the field.
6239
6321
  self.keys = keys
6322
+ # The time when the index configurations were last updated. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.
6240
6323
  self.last_modify_time = last_modify_time
6324
+ # The configurations of full-text indexes.
6241
6325
  self.line = line
6326
+ # Indicates whether the log clustering feature is enabled.
6242
6327
  self.log_reduce = log_reduce
6328
+ # The fields in the blacklist that are used to cluster logs. This parameter is valid only if the log clustering feature is enabled.
6243
6329
  self.log_reduce_black_list = log_reduce_black_list
6330
+ # The fields in the whitelist that are used to cluster logs. This parameter is valid only if the log clustering feature is enabled.
6244
6331
  self.log_reduce_white_list = log_reduce_white_list
6332
+ # The maximum length of a field value that can be retained. Default value: 2048. Unit: bytes. The default value is equal to 2 KB. You can change the value of the max_text_len parameter. Valid values: 64 to 16384. Unit: bytes.
6245
6333
  self.max_text_len = max_text_len
6334
+ # The storage type. The value is fixed as pg.
6246
6335
  self.storage = storage
6336
+ # The lifecycle of the index file. Valid values: 7, 30, and 90. Unit: day.
6247
6337
  self.ttl = ttl
6248
6338
 
6249
6339
  def validate(self):
@@ -6528,13 +6618,56 @@ class GetLogsRequest(TeaModel):
6528
6618
  to: int = None,
6529
6619
  topic: str = None,
6530
6620
  ):
6621
+ # The beginning of the time range to query. The value is the log time that is specified when log data is written.
6622
+ #
6623
+ # * The time range that is specified in this operation is a left-closed, right-open interval. The interval includes the start time specified by the **from** parameter, but does not include the end time specified by the **to** parameter. If you specify the same value for the **from** and **to** parameters, the interval is invalid, and an error message is returned.
6624
+ # * The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.
6625
+ #
6626
+ # > To ensure that full data can be queried, specify a query time range that is accurate to the minute. If you also specify a time range in an analytic statement, Simple Log Service uses the time range specified in the analytic statement for query and analysis.
6627
+ #
6628
+ # If you want to specify a time range that is accurate to the second in your analytic statement, you must use the from_unixtime or to_unixtime function to convert the time format. For more information about the functions, see [from_unixtime function](~~63451~~) and [to_unixtime function](~~63451~~). Examples:
6629
+ #
6630
+ # * `* | SELECT * FROM log WHERE from_unixtime(__time__) > from_unixtime(1664186624) AND from_unixtime(__time__) < now()`
6631
+ # * `* | SELECT * FROM log WHERE __time__ > to_unixtime(date_parse(\"2022-10-19 15:46:05\", \"%Y-%m-%d %H:%i:%s\")) AND __time__ < to_unixtime(now())`
6531
6632
  self.from_ = from_
6633
+ # The maximum number of logs to return for the request. This parameter takes effect only when the query parameter is set to a search statement. Minimum value: 0. Maximum value: 100. Default value: 100.
6532
6634
  self.line = line
6635
+ # The line from which the query starts. This parameter takes effect only when the query parameter is set to a search statement. Default value: 0.
6533
6636
  self.offset = offset
6637
+ # Specifies whether to enable the Dedicated SQL feature. For more information, see [Enable Dedicated SQL](~~223777~~). Valid values:
6638
+ #
6639
+ # * true: enables the Dedicated SQL feature.
6640
+ # * false (default): enables the Standard SQL feature.
6641
+ #
6642
+ # You can use the powerSql or **query** parameter to configure Dedicated SQL.
6534
6643
  self.power_sql = power_sql
6644
+ # The search statement or the query statement. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~). If you add `set session parallel_sql=true;` to the analytic statement in the query parameter, Dedicated SQL is used. For example, you can set the query parameter to `* | set session parallel_sql=true; select count(*) as pv`. For more information about common errors that may occur during log query and analysis, see [How do I resolve common errors that occur when I query and analyze logs?](~~61628~~)
6645
+ #
6646
+ # > If you specify an analytic statement in the value of the query parameter, the line and offset parameters do not take effect. In this case, we recommend that you set the line and offset parameters to 0 and use the LIMIT clause to limit the number of logs to return on each page. For more information, see [Paged query](~~89994~~).
6535
6647
  self.query = query
6648
+ # Specifies whether to return logs in reverse chronological order of log timestamps. The log timestamps are accurate to the minute. Valid values:
6649
+ #
6650
+ # * true: returns logs in reverse chronological order of log timestamps.
6651
+ # * false (default): returns logs in chronological order of log timestamps.
6652
+ #
6653
+ # >
6654
+ #
6655
+ # * The reverse parameter takes effect only when the query parameter is set to a search statement. The reverse parameter specifies the method used to sort returned logs.
6656
+ # * If the query parameter is set to a query statement, the reverse parameter does not take effect. The method used to sort returned logs is specified by the ORDER BY clause in the analytic statement. If you use the keyword asc in the ORDER BY clause, the logs are sorted in chronological order. If you use the keyword desc in the ORDER BY clause, the logs are sorted in reverse chronological order. By default, asc is used in the ORDER BY clause.
6536
6657
  self.reverse = reverse
6658
+ # The end of the time range to query. The value is the log time that is specified when log data is written.
6659
+ #
6660
+ # * The time range that is specified in this operation is a left-closed, right-open interval. The interval includes the start time specified by the **from** parameter, but does not include the end time specified by the **to** parameter. If you specify the same value for the **from** and **to** parameters, the interval is invalid, and an error message is returned.
6661
+ # * The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.
6662
+ #
6663
+ # > To ensure that full data can be queried, specify a query time range that is accurate to the minute. If you also specify a time range in an analytic statement, Simple Log Service uses the time range specified in the analytic statement for query and analysis.
6664
+ #
6665
+ # If you want to specify a time range that is accurate to the second in your analytic statement, you must use the from_unixtime or to_unixtime function to convert the time format. For more information about the functions, see [from_unixtime function](~~63451~~) and [to_unixtime function](~~63451~~). Examples:
6666
+ #
6667
+ # * `* | SELECT * FROM log WHERE from_unixtime(__time__) > from_unixtime(1664186624) AND from_unixtime(__time__) < now()`
6668
+ # * `* | SELECT * FROM log WHERE __time__ > to_unixtime(date_parse(\"2022-10-19 15:46:05\", \"%Y-%m-%d %H:%i:%s\")) AND __time__ < to_unixtime(now())`
6537
6669
  self.to = to
6670
+ # The topic of the logs. The default value is double quotation marks (""). For more information, see [Topic](~~48881~~).
6538
6671
  self.topic = topic
6539
6672
 
6540
6673
  def validate(self):
@@ -6633,6 +6766,7 @@ class GetLogsV2Headers(TeaModel):
6633
6766
  accept_encoding: str = None,
6634
6767
  ):
6635
6768
  self.common_headers = common_headers
6769
+ # The compression method.
6636
6770
  self.accept_encoding = accept_encoding
6637
6771
 
6638
6772
  def validate(self):
@@ -6674,17 +6808,36 @@ class GetLogsV2Request(TeaModel):
6674
6808
  to: int = None,
6675
6809
  topic: str = None,
6676
6810
  ):
6811
+ # Specifies whether to page forward or backward for the scan-based query or the phrase query.
6677
6812
  self.forward = forward
6813
+ # The beginning of the time range to query. The value is the log time that is specified when log data is written.
6814
+ #
6815
+ # The time range specified by the from and to parameters is a left-closed and right-open interval. Each interval includes the specified start time but does not include the specified end time. If you specify the same value for the from and to parameters, the interval is invalid, and an error message is returned. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.
6678
6816
  self.from_ = from_
6817
+ # The maximum number of logs to return for the request. This parameter takes effect only when the query parameter is set to a search statement. Valid values: 0 to 100. Default value: 100.
6679
6818
  self.line = line
6819
+ # The row from which the query starts. This parameter takes effect only when the query parameter is set to a search statement. Default value: 0.
6680
6820
  self.offset = offset
6821
+ # Specifies whether to enable the SQL enhancement feature. By default, the feature is disabled.
6681
6822
  self.power_sql = power_sql
6823
+ # The search statement or the query statement. For more information, see the "Log search overview" and "Log analysis overview" topics.
6824
+ #
6825
+ # If you add set session parallel_sql=true; to the analytic statement in the query parameter, the dedicated SQL feature is enabled. Example: \* | set session parallel_sql=true; select count(\*) as pv.
6826
+ #
6827
+ # Note: If you specify an analytic statement in the query parameter, the line and offset parameters are invalid for this operation. In this case, we recommend that you set the line and offset parameters to 0 and use a LIMIT clause to limit the number of entries to return on each page. For more information, see the "Perform paged queries" topic.
6682
6828
  self.query = query
6829
+ # Specifies whether to return logs in reverse chronological order of log timestamps. The log timestamps are accurate to the minute. Valid values:
6830
+ #
6831
+ # true: returns logs in reverse chronological order of log timestamps. false (default): returns logs in chronological order of log timestamps. Note The reverse parameter takes effect only when the query parameter is set to a search statement. The reverse parameter specifies the method used to sort the returned logs. If the query parameter is set to a query statement, which consists of a search statement and an analytic statement, the reverse parameter does not take effect. The method used to sort the returned logs is specified by the ORDER BY clause in the analytic statement. If you use the keyword asc in the ORDER BY clause, the logs are sorted in chronological order. If you use the keyword desc in the ORDER BY clause, the logs are sorted in reverse chronological order. By default, asc is used in the ORDER BY clause.
6683
6832
  self.reverse = reverse
6684
6833
  self.session = session
6685
- # Shard ID
6834
+ # The ID of the shard.
6686
6835
  self.shard = shard
6836
+ # The end of the time range to query. The value is the log time that is specified when log data is written.
6837
+ #
6838
+ # The time range specified by the from and to parameters is a left-closed and right-open interval. Each interval includes the specified start time but does not include the specified end time. If you specify the same value for the from and to parameters, the interval is invalid, and an error message is returned. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.
6687
6839
  self.to = to
6840
+ # The topic of the logs. Default value: double quotation marks ("").
6688
6841
  self.topic = topic
6689
6842
 
6690
6843
  def validate(self):
@@ -6763,17 +6916,32 @@ class GetLogsV2ResponseBodyMeta(TeaModel):
6763
6916
  terms: List[Dict[str, Any]] = None,
6764
6917
  where_query: str = None,
6765
6918
  ):
6919
+ # The SQL statement after | in the query statement.
6766
6920
  self.agg_query = agg_query
6921
+ # The number of rows that are returned.
6767
6922
  self.count = count
6923
+ # The amount of time that is consumed by the request. Unit: milliseconds.
6768
6924
  self.elapsed_millisecond = elapsed_millisecond
6925
+ # Indicates whether the query is an SQL query.
6769
6926
  self.has_sql = has_sql
6927
+ # Indicates whether the returned result is accurate.
6770
6928
  self.is_accurate = is_accurate
6929
+ # All keys in the query result.
6771
6930
  self.keys = keys
6931
+ # The number of logs that are processed in the request.
6772
6932
  self.processed_bytes = processed_bytes
6933
+ # The number of rows that are processed in the request.
6773
6934
  self.processed_rows = processed_rows
6935
+ # Indicates whether the query result is complete. Valid values:
6936
+ #
6937
+ # * Complete: The query was successful, and the complete result is returned.
6938
+ # * Incomplete: The query was successful, but the query result is incomplete. To obtain the complete result, you must call the operation again.
6774
6939
  self.progress = progress
6940
+ # The type of observable data.
6775
6941
  self.telementry_type = telementry_type
6942
+ # All terms in the query statement.
6776
6943
  self.terms = terms
6944
+ # The part before | in the query statement.
6777
6945
  self.where_query = where_query
6778
6946
 
6779
6947
  def validate(self):
@@ -6846,7 +7014,9 @@ class GetLogsV2ResponseBody(TeaModel):
6846
7014
  data: List[Dict[str, str]] = None,
6847
7015
  meta: GetLogsV2ResponseBodyMeta = None,
6848
7016
  ):
7017
+ # The returned result.
6849
7018
  self.data = data
7019
+ # The metadata that is returned.
6850
7020
  self.meta = meta
6851
7021
 
6852
7022
  def validate(self):
@@ -6963,6 +7133,118 @@ class GetLogtailPipelineConfigResponse(TeaModel):
6963
7133
  return self
6964
7134
 
6965
7135
 
7136
+ class GetMLServiceResultsRequest(TeaModel):
7137
+ def __init__(
7138
+ self,
7139
+ allow_builtin: bool = None,
7140
+ body: MLServiceAnalysisParam = None,
7141
+ ):
7142
+ self.allow_builtin = allow_builtin
7143
+ self.body = body
7144
+
7145
+ def validate(self):
7146
+ if self.body:
7147
+ self.body.validate()
7148
+
7149
+ def to_map(self):
7150
+ _map = super().to_map()
7151
+ if _map is not None:
7152
+ return _map
7153
+
7154
+ result = dict()
7155
+ if self.allow_builtin is not None:
7156
+ result['allowBuiltin'] = self.allow_builtin
7157
+ if self.body is not None:
7158
+ result['body'] = self.body.to_map()
7159
+ return result
7160
+
7161
+ def from_map(self, m: dict = None):
7162
+ m = m or dict()
7163
+ if m.get('allowBuiltin') is not None:
7164
+ self.allow_builtin = m.get('allowBuiltin')
7165
+ if m.get('body') is not None:
7166
+ temp_model = MLServiceAnalysisParam()
7167
+ self.body = temp_model.from_map(m['body'])
7168
+ return self
7169
+
7170
+
7171
+ class GetMLServiceResultsResponseBody(TeaModel):
7172
+ def __init__(
7173
+ self,
7174
+ data: List[Dict[str, str]] = None,
7175
+ status: Dict[str, str] = None,
7176
+ ):
7177
+ self.data = data
7178
+ self.status = status
7179
+
7180
+ def validate(self):
7181
+ pass
7182
+
7183
+ def to_map(self):
7184
+ _map = super().to_map()
7185
+ if _map is not None:
7186
+ return _map
7187
+
7188
+ result = dict()
7189
+ if self.data is not None:
7190
+ result['data'] = self.data
7191
+ if self.status is not None:
7192
+ result['status'] = self.status
7193
+ return result
7194
+
7195
+ def from_map(self, m: dict = None):
7196
+ m = m or dict()
7197
+ if m.get('data') is not None:
7198
+ self.data = m.get('data')
7199
+ if m.get('status') is not None:
7200
+ self.status = m.get('status')
7201
+ return self
7202
+
7203
+
7204
+ class GetMLServiceResultsResponse(TeaModel):
7205
+ def __init__(
7206
+ self,
7207
+ headers: Dict[str, str] = None,
7208
+ status_code: int = None,
7209
+ body: GetMLServiceResultsResponseBody = None,
7210
+ ):
7211
+ self.headers = headers
7212
+ self.status_code = status_code
7213
+ self.body = body
7214
+
7215
+ def validate(self):
7216
+ self.validate_required(self.headers, 'headers')
7217
+ self.validate_required(self.status_code, 'status_code')
7218
+ self.validate_required(self.body, 'body')
7219
+ if self.body:
7220
+ self.body.validate()
7221
+
7222
+ def to_map(self):
7223
+ _map = super().to_map()
7224
+ if _map is not None:
7225
+ return _map
7226
+
7227
+ result = dict()
7228
+ if self.headers is not None:
7229
+ result['headers'] = self.headers
7230
+ if self.status_code is not None:
7231
+ result['statusCode'] = self.status_code
7232
+ if self.body is not None:
7233
+ result['body'] = self.body.to_map()
7234
+ return result
7235
+
7236
+ def from_map(self, m: dict = None):
7237
+ m = m or dict()
7238
+ if m.get('headers') is not None:
7239
+ self.headers = m.get('headers')
7240
+ if m.get('statusCode') is not None:
7241
+ self.status_code = m.get('statusCode')
7242
+ if m.get('body') is not None:
7243
+ temp_model = GetMLServiceResultsResponseBody()
7244
+ self.body = temp_model.from_map(m['body'])
7245
+ return self
7246
+
7247
+
6966
7248
  class GetMachineGroupResponse(TeaModel):
6967
7249
  def __init__(
6968
7250
  self,
@@ -7057,7 +7339,14 @@ class GetProjectLogsRequest(TeaModel):
7057
7339
  power_sql: bool = None,
7058
7340
  query: str = None,
7059
7341
  ):
7342
+ # Specifies whether to enable the Dedicated SQL feature. For more information, see [Enable Dedicated SQL](~~223777~~). Valid values:
7343
+ #
7344
+ # * true
7345
+ # * false (default): enables the Standard SQL feature.
7346
+ #
7347
+ # You can use the powerSql or **query** parameter to configure Dedicated SQL.
7060
7348
  self.power_sql = power_sql
7349
+ # The standard SQL statement. In this example, the SQL statement queries the number of page views (PVs) from 2022-03-01 10:41:40 to 2022-03-01 10:56:40 in a Logstore whose name is nginx-moni.
7061
7350
  self.query = query
7062
7351
 
7063
7352
  def validate(self):
@@ -7219,10 +7508,15 @@ class GetShipperStatusRequest(TeaModel):
7219
7508
  status: str = None,
7220
7509
  to: int = None,
7221
7510
  ):
7511
+ # The start time of the log shipping job. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
7222
7512
  self.from_ = from_
7513
+ # The line from which the query starts. Default value: 0.
7223
7514
  self.offset = offset
7515
+ # The number of entries per page. Default value: 100. Maximum value: 500.
7224
7516
  self.size = size
7517
+ # The status of the log shipping job. This parameter is empty by default, which indicates that log shipping jobs in all states are returned. Valid values: success, fail, and running.
7225
7518
  self.status = status
7519
+ # The end time of the log shipping job. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
7226
7520
  self.to = to
7227
7521
 
7228
7522
  def validate(self):
@@ -7268,8 +7562,11 @@ class GetShipperStatusResponseBodyStatistics(TeaModel):
7268
7562
  running: int = None,
7269
7563
  success: int = None,
7270
7564
  ):
7565
+ # The number of log shipping jobs that are in the fail state.
7271
7566
  self.fail = fail
7567
+ # The number of log shipping jobs that are in the running state.
7272
7568
  self.running = running
7569
+ # The number of log shipping jobs that are in the success state.
7273
7570
  self.success = success
7274
7571
 
7275
7572
  def validate(self):
@@ -7312,13 +7609,21 @@ class GetShipperStatusResponseBodyTasks(TeaModel):
7312
7609
  task_message: str = None,
7313
7610
  task_status: str = None,
7314
7611
  ):
7612
+ # The ID of the log shipping job.
7315
7613
  self.id = id
7614
+ # The error code of the log shipping job.
7316
7615
  self.task_code = task_code
7616
+ # The start time of the log shipping job. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
7317
7617
  self.task_create_time = task_create_time
7618
+ # The number of logs that are shipped in the log shipping job.
7318
7619
  self.task_data_lines = task_data_lines
7620
+ # The end time of the log shipping job. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
7319
7621
  self.task_finish_time = task_finish_time
7622
+ # The time when Simple Log Service receives the most recent log of the log shipping job. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
7320
7623
  self.task_last_data_receive_time = task_last_data_receive_time
7624
+ # The error message of the log shipping job.
7321
7625
  self.task_message = task_message
7626
+ # The status of the log shipping job. Valid values: running, success, and fail.
7322
7627
  self.task_status = task_status
7323
7628
 
7324
7629
  def validate(self):
@@ -7377,9 +7682,13 @@ class GetShipperStatusResponseBody(TeaModel):
7377
7682
  tasks: GetShipperStatusResponseBodyTasks = None,
7378
7683
  total: int = None,
7379
7684
  ):
7685
+ # The number of log shipping jobs returned on the current page.
7380
7686
  self.count = count
7687
+ # The statistics about log shipping jobs.
7381
7688
  self.statistics = statistics
7689
+ # The details of log shipping jobs.
7382
7690
  self.tasks = tasks
7691
+ # The total number of log shipping jobs.
7383
7692
  self.total = total
7384
7693
 
7385
7694
  def validate(self):
@@ -8605,8 +8914,11 @@ class ListDomainsRequest(TeaModel):
8605
8914
  offset: int = None,
8606
8915
  size: int = None,
8607
8916
  ):
8917
+ # The domain name that is used to match custom domain names. For example, if you set domainName to `example.com`, the matched domain names are `a.example.com` and `b.example.com`.
8608
8918
  self.domain_name = domain_name
8919
+ # The line from which the query starts. Default value: 0.
8609
8920
  self.offset = offset
8921
+ # The number of entries per page. Default value: 500. Maximum value: 500.
8610
8922
  self.size = size
8611
8923
 
8612
8924
  def validate(self):
@@ -8644,8 +8956,11 @@ class ListDomainsResponseBody(TeaModel):
8644
8956
  domains: List[str] = None,
8645
8957
  total: int = None,
8646
8958
  ):
8959
+ # The number of domain names that are returned on the current page.
8647
8960
  self.count = count
8961
+ # The domain names.
8648
8962
  self.domains = domains
8963
+ # The total number of domain names that are returned.
8649
8964
  self.total = total
8650
8965
 
8651
8966
  def validate(self):
@@ -8727,8 +9042,11 @@ class ListExternalStoreRequest(TeaModel):
8727
9042
  offset: int = None,
8728
9043
  sizs: int = None,
8729
9044
  ):
9045
+ # The name of the external store. You can query external stores that contain a specified string.
8730
9046
  self.external_store_name = external_store_name
9047
+ # The line from which the query starts. Default value: 0.
8731
9048
  self.offset = offset
9049
+ # The number of entries per page. Maximum value: 500.
8732
9050
  self.sizs = sizs
8733
9051
 
8734
9052
  def validate(self):
@@ -8766,8 +9084,11 @@ class ListExternalStoreResponseBody(TeaModel):
8766
9084
  externalstores: List[ExternalStore] = None,
8767
9085
  total: int = None,
8768
9086
  ):
9087
+ # The number of external stores returned on the current page.
8769
9088
  self.count = count
9089
+ # The names of the external stores.
8770
9090
  self.externalstores = externalstores
9091
+ # The number of external stores that meet the query conditions.
8771
9092
  self.total = total
8772
9093
 
8773
9094
  def validate(self):
@@ -8859,10 +9180,21 @@ class ListLogStoresRequest(TeaModel):
8859
9180
  size: int = None,
8860
9181
  telemetry_type: str = None,
8861
9182
  ):
9183
+ # The name of the Logstore. Fuzzy match is supported. For example, if you enter test, Logstores whose name contains test are returned.
8862
9184
  self.logstore_name = logstore_name
9185
+ # The type of the Logstore. Valid values: standard and query.
9186
+ #
9187
+ # * **standard**: Standard Logstore. This type of Logstore supports the log analysis feature and is suitable for scenarios such as real-time monitoring and interactive analysis. You can also use this type of Logstore to build a comprehensive observability system.
9188
+ # * **query**: Query Logstore. This type of Logstore supports high-performance queries. The index traffic fee of a Query Logstore is approximately half that of a Standard Logstore. Query Logstores do not support SQL analysis. Query Logstores are suitable for scenarios in which the volume of data is large, the log retention period is long, or log analysis is not required. Log retention periods of weeks or months are considered long.
8863
9189
  self.mode = mode
9190
+ # The line from which the query starts. Default value: 0.
8864
9191
  self.offset = offset
9192
+ # The number of entries per page. Maximum value: 500. Default value: 500.
8865
9193
  self.size = size
9194
+ # The type of the data that you want to query. Valid values:
9195
+ #
9196
+ # * None: logs
9197
+ # * Metrics: metrics
8866
9198
  self.telemetry_type = telemetry_type
8867
9199
 
8868
9200
  def validate(self):
@@ -8908,8 +9240,11 @@ class ListLogStoresResponseBody(TeaModel):
8908
9240
  logstores: List[str] = None,
8909
9241
  total: int = None,
8910
9242
  ):
9243
+ # The number of entries that are returned on the current page.
8911
9244
  self.count = count
9245
+ # The Logstores that meet the query conditions.
8912
9246
  self.logstores = logstores
9247
+ # The number of the Logstores that meet the query conditions.
8913
9248
  self.total = total
8914
9249
 
8915
9250
  def validate(self):
@@ -9119,8 +9454,11 @@ class ListMachineGroupRequest(TeaModel):
9119
9454
  offset: int = None,
9120
9455
  size: int = None,
9121
9456
  ):
9457
+ # The name of the machine group. This parameter is used to filter machine groups. Partial match is supported.
9122
9458
  self.group_name = group_name
9459
+ # The line from which the query starts. Default value: 0.
9123
9460
  self.offset = offset
9461
+ # The number of entries per page. Maximum value: 500.
9124
9462
  self.size = size
9125
9463
 
9126
9464
  def validate(self):
@@ -9158,8 +9496,11 @@ class ListMachineGroupResponseBody(TeaModel):
9158
9496
  machinegroups: List[str] = None,
9159
9497
  total: int = None,
9160
9498
  ):
9499
+ # The number of machine groups that are returned on the current page.
9161
9500
  self.count = count
9501
+ # The machine groups that meet the query conditions.
9162
9502
  self.machinegroups = machinegroups
9503
+ # The total number of machine groups that meet the query conditions.
9163
9504
  self.total = total
9164
9505
 
9165
9506
  def validate(self):
@@ -9240,7 +9581,9 @@ class ListMachinesRequest(TeaModel):
9240
9581
  offset: int = None,
9241
9582
  size: int = None,
9242
9583
  ):
9584
+ # The line from which the query starts. Default value: 0.
9243
9585
  self.offset = offset
9586
+ # The number of entries per page. Default value: 100. Maximum value: 500.
9244
9587
  self.size = size
9245
9588
 
9246
9589
  def validate(self):
@@ -9274,8 +9617,11 @@ class ListMachinesResponseBody(TeaModel):
9274
9617
  machines: List[Machine] = None,
9275
9618
  total: int = None,
9276
9619
  ):
9620
+ # The number of machines that are returned on the current page.
9277
9621
  self.count = count
9622
+ # The machines that are returned.
9278
9623
  self.machines = machines
9624
+ # The total number of machines.
9279
9625
  self.total = total
9280
9626
 
9281
9627
  def validate(self):
@@ -9363,10 +9709,15 @@ class ListProjectRequest(TeaModel):
9363
9709
  self,
9364
9710
  offset: int = None,
9365
9711
  project_name: str = None,
9712
+ resource_group_id: str = None,
9366
9713
  size: int = None,
9367
9714
  ):
9715
+ # The line from which the query starts. Default value: 0.
9368
9716
  self.offset = offset
9717
+ # The name of the project.
9369
9718
  self.project_name = project_name
9719
+ self.resource_group_id = resource_group_id
9720
+ # The number of entries per page. Default value: 100. This operation can return up to 500 projects.
9370
9721
  self.size = size
9371
9722
 
9372
9723
  def validate(self):
@@ -9382,6 +9733,8 @@ class ListProjectRequest(TeaModel):
9382
9733
  result['offset'] = self.offset
9383
9734
  if self.project_name is not None:
9384
9735
  result['projectName'] = self.project_name
9736
+ if self.resource_group_id is not None:
9737
+ result['resourceGroupId'] = self.resource_group_id
9385
9738
  if self.size is not None:
9386
9739
  result['size'] = self.size
9387
9740
  return result
@@ -9392,6 +9745,8 @@ class ListProjectRequest(TeaModel):
9392
9745
  self.offset = m.get('offset')
9393
9746
  if m.get('projectName') is not None:
9394
9747
  self.project_name = m.get('projectName')
9748
+ if m.get('resourceGroupId') is not None:
9749
+ self.resource_group_id = m.get('resourceGroupId')
9395
9750
  if m.get('size') is not None:
9396
9751
  self.size = m.get('size')
9397
9752
  return self
@@ -9404,8 +9759,11 @@ class ListProjectResponseBody(TeaModel):
9404
9759
  projects: List[Project] = None,
9405
9760
  total: int = None,
9406
9761
  ):
9762
+ # The number of returned projects on the current page.
9407
9763
  self.count = count
9764
+ # The projects that meet the query conditions.
9408
9765
  self.projects = projects
9766
+ # The total number of projects that meet the query conditions.
9409
9767
  self.total = total
9410
9768
 
9411
9769
  def validate(self):
@@ -9494,7 +9852,9 @@ class ListSavedSearchRequest(TeaModel):
9494
9852
  offset: int = None,
9495
9853
  size: int = None,
9496
9854
  ):
9855
+ # The line from which the query starts. Default value: 0.
9497
9856
  self.offset = offset
9857
+ # The number of entries per page. Maximum value: 500.
9498
9858
  self.size = size
9499
9859
 
9500
9860
  def validate(self):
@@ -9528,8 +9888,11 @@ class ListSavedSearchResponseBody(TeaModel):
9528
9888
  savedsearch_items: List[SavedSearch] = None,
9529
9889
  total: int = None,
9530
9890
  ):
9891
+ # The number of saved searches returned on the current page.
9531
9892
  self.count = count
9893
+ # The saved searches.
9532
9894
  self.savedsearch_items = savedsearch_items
9895
+ # The total number of saved searches that meet the query conditions.
9533
9896
  self.total = total
9534
9897
 
9535
9898
  def validate(self):
@@ -9669,8 +10032,11 @@ class ListShipperResponseBody(TeaModel):
9669
10032
  shipper: List[str] = None,
9670
10033
  total: int = None,
9671
10034
  ):
10035
+ # The number of log shipping jobs returned.
9672
10036
  self.count = count
10037
+ # The names of the log shipping jobs.
9673
10038
  self.shipper = shipper
10039
+ # The total number of log shipping jobs.
9674
10040
  self.total = total
9675
10041
 
9676
10042
  def validate(self):
@@ -9751,7 +10117,9 @@ class ListTagResourcesRequestTags(TeaModel):
9751
10117
  key: str = None,
9752
10118
  value: str = None,
9753
10119
  ):
10120
+ # The key of the tag that you want to use to filter resources. For example, if you set the key to `"test-key"`, only resources to which the key is added are returned.``
9754
10121
  self.key = key
10122
+ # The value of the tag that you want to use to filter resources. If you set the value to null, resources are filtered based only on the key of the tag.
9755
10123
  self.value = value
9756
10124
 
9757
10125
  def validate(self):
@@ -9785,8 +10153,13 @@ class ListTagResourcesRequest(TeaModel):
9785
10153
  resource_type: str = None,
9786
10154
  tags: List[ListTagResourcesRequestTags] = None,
9787
10155
  ):
10156
+ # The IDs of the resources for which you want to query tags. You must specify at least one of resourceId and tags.
9788
10157
  self.resource_id = resource_id
10158
+ # The type of the resource. Set the value to project.
9789
10159
  self.resource_type = resource_type
10160
+ # The tags that you want to use to filter resources based on exact match. Each tag is a key-value pair. You must specify at least one of resourceId and tags.
10161
+ #
10162
+ # You can enter up to 20 tags.
9790
10163
  self.tags = tags
9791
10164
 
9792
10165
  def validate(self):
@@ -9832,8 +10205,13 @@ class ListTagResourcesShrinkRequest(TeaModel):
9832
10205
  resource_type: str = None,
9833
10206
  tags_shrink: str = None,
9834
10207
  ):
10208
+ # The IDs of the resources for which you want to query tags. You must specify at least one of resourceId and tags.
9835
10209
  self.resource_id_shrink = resource_id_shrink
10210
+ # The type of the resource. Set the value to project.
9836
10211
  self.resource_type = resource_type
10212
+ # The tags that you want to use to filter resources based on exact match. Each tag is a key-value pair. You must specify at least one of resourceId and tags.
10213
+ #
10214
+ # You can enter up to 20 tags.
9837
10215
  self.tags_shrink = tags_shrink
9838
10216
 
9839
10217
  def validate(self):
@@ -9872,9 +10250,13 @@ class ListTagResourcesResponseBodyTagResources(TeaModel):
9872
10250
  tag_key: str = None,
9873
10251
  tag_value: str = None,
9874
10252
  ):
10253
+ # The ID of the resource.
9875
10254
  self.resource_id = resource_id
10255
+ # The type of the resource.
9876
10256
  self.resource_type = resource_type
10257
+ # The key of the tag.
9877
10258
  self.tag_key = tag_key
10259
+ # The value of the tag.
9878
10260
  self.tag_value = tag_value
9879
10261
 
9880
10262
  def validate(self):
@@ -9915,7 +10297,9 @@ class ListTagResourcesResponseBody(TeaModel):
9915
10297
  next_token: str = None,
9916
10298
  tag_resources: List[ListTagResourcesResponseBodyTagResources] = None,
9917
10299
  ):
10300
+ # The pagination token that is used in the next request to retrieve a new page of results.
9918
10301
  self.next_token = next_token
10302
+ # The returned tags.
9919
10303
  self.tag_resources = tag_resources
9920
10304
 
9921
10305
  def validate(self):
@@ -10074,6 +10458,7 @@ class PutProjectPolicyRequest(TeaModel):
10074
10458
  self,
10075
10459
  body: str = None,
10076
10460
  ):
10461
+ # The project policy.
10077
10462
  self.body = body
10078
10463
 
10079
10464
  def validate(self):
@@ -10361,7 +10746,9 @@ class SplitShardRequest(TeaModel):
10361
10746
  key: str = None,
10362
10747
  shard_count: int = None,
10363
10748
  ):
10749
+ # The position where the shard is split.
10364
10750
  self.key = key
10751
+ # The number of new shards that are generated after splitting.
10365
10752
  self.shard_count = shard_count
10366
10753
 
10367
10754
  def validate(self):
@@ -10444,7 +10831,16 @@ class TagResourcesRequestTags(TeaModel):
10444
10831
  key: str = None,
10445
10832
  value: str = None,
10446
10833
  ):
10834
+ # The key of the tag. The key must meet the following requirements:
10835
+ #
10836
+ # * The key must be `1 to 128` characters in length.
10837
+ # * The key cannot contain `"http://"` or `"https://"`.
10838
+ # * The key cannot start with `"acs:"` or `"aliyun"`.
10447
10839
  self.key = key
10840
+ # The value of the tag. The value must meet the following requirements:
10841
+ #
10842
+ # * The value must be `1 to 128` characters in length.
10843
+ # * The value cannot contain `"http://"` or `"https://"`.
10448
10844
  self.value = value
10449
10845
 
10450
10846
  def validate(self):
@@ -10478,8 +10874,11 @@ class TagResourcesRequest(TeaModel):
10478
10874
  resource_type: str = None,
10479
10875
  tags: List[TagResourcesRequestTags] = None,
10480
10876
  ):
10877
+ # The resource IDs. You can specify only one resource and add tags to the resource.
10481
10878
  self.resource_id = resource_id
10879
+ # The type of the resource. Set the value to project.
10482
10880
  self.resource_type = resource_type
10881
+ # The tags that you want to add to the resource. Up to 20 tags are supported at a time. Each tag is a key-value pair.
10483
10882
  self.tags = tags
10484
10883
 
10485
10884
  def validate(self):
@@ -10826,7 +11225,12 @@ class UpdateConsumerGroupRequest(TeaModel):
10826
11225
  order: bool = None,
10827
11226
  timeout: int = None,
10828
11227
  ):
11228
+ # Specifies whether to consume data in sequence. Valid values:
11229
+ #
11230
+ # * true: If a shard is split, the data in the original shard is consumed first. Then, the data in the new shards is consumed at the same time. If shards are merged, the data in the original shards is consumed first. Then, the data in the new shard is consumed.
11231
+ # * false: The data in all shards is consumed at the same time. If a new shard is generated after a shard is split or shards are merged, the data in the new shard is immediately consumed.
10829
11232
  self.order = order
11233
+ # The timeout period. If Simple Log Service does not receive heartbeats from a consumer within the timeout period, Simple Log Service deletes the consumer. Unit: seconds.
10830
11234
  self.timeout = timeout
10831
11235
 
10832
11236
  def validate(self):
@@ -10989,10 +11393,21 @@ class UpdateIndexRequestLine(TeaModel):
10989
11393
  include_keys: List[str] = None,
10990
11394
  token: List[str] = None,
10991
11395
  ):
11396
+ # Specifies whether to enable case sensitivity. Valid values:
11397
+ #
11398
+ # * true
11399
+ # * false
10992
11400
  self.case_sensitive = case_sensitive
11401
+ # Specifies whether to include Chinese characters. Valid values:
11402
+ #
11403
+ # * true
11404
+ # * false
10993
11405
  self.chn = chn
11406
+ # The excluded fields. You cannot specify both include_keys and exclude_keys.
10994
11407
  self.exclude_keys = exclude_keys
11408
+ # The included fields. You cannot specify both include_keys and exclude_keys.
10995
11409
  self.include_keys = include_keys
11410
+ # The delimiters that are used to split text.
10996
11411
  self.token = token
10997
11412
 
10998
11413
  def validate(self):
@@ -11042,12 +11457,19 @@ class UpdateIndexRequest(TeaModel):
11042
11457
  max_text_len: int = None,
11043
11458
  ttl: int = None,
11044
11459
  ):
11460
+ # The configuration of field indexes. A field index is a key-value pair in which the key specifies the name of the field and the value specifies the index configuration of the field.
11045
11461
  self.keys = keys
11462
+ # The configuration of full-text indexes.
11046
11463
  self.line = line
11464
+ # Specifies whether to turn on LogReduce. If you turn on LogReduce, only one of `log_reduce_white_list` and `log_reduce_black_list` takes effect.
11047
11465
  self.log_reduce = log_reduce
11466
+ # The fields in the blacklist that you want to use to cluster logs.
11048
11467
  self.log_reduce_black_list = log_reduce_black_list
11468
+ # The fields in the whitelist that you want to use to cluster logs.
11049
11469
  self.log_reduce_white_list = log_reduce_white_list
11470
+ # The maximum length of a field value that can be retained.
11050
11471
  self.max_text_len = max_text_len
11472
+ # The retention period of data. Unit: days. Valid values: 7, 30, and 90.
11051
11473
  self.ttl = ttl
11052
11474
 
11053
11475
  def validate(self):
@@ -11154,16 +11576,46 @@ class UpdateLogStoreRequest(TeaModel):
11154
11576
  telemetry_type: str = None,
11155
11577
  ttl: int = None,
11156
11578
  ):
11579
+ # Specifies whether to record public IP addresses. Default value: false. Valid values:
11580
+ #
11581
+ # * true
11582
+ # * false
11157
11583
  self.append_meta = append_meta
11584
+ # Specifies whether to enable automatic sharding. Valid values:
11585
+ #
11586
+ # * true
11587
+ # * false
11158
11588
  self.auto_split = auto_split
11589
+ # Specifies whether to enable the web tracking feature. Default value: false. Valid values:
11590
+ #
11591
+ # * true
11592
+ # * false
11159
11593
  self.enable_tracking = enable_tracking
11594
+ # The data structure of the encryption configuration.
11160
11595
  self.encrypt_conf = encrypt_conf
11596
+ # The retention period of data in the hot storage tier of the Logstore. Minimum value: 30. Unit: day. You can specify a value that ranges from 30 to the value of ttl. Hot data that is stored for longer than the period specified by hot_ttl is converted to cold data. For more information, see [Enable hot and cold-tiered storage for a Logstore](~~308645~~).
11161
11597
  self.hot_ttl = hot_ttl
11598
+ # The name of the Logstore.
11162
11599
  self.logstore_name = logstore_name
11600
+ # The maximum number of shards into which existing shards can be automatically split. Valid values: 1 to 64.
11601
+ #
11602
+ # > If you set autoSplit to true, you must specify maxSplitShard.
11163
11603
  self.max_split_shard = max_split_shard
11604
+ # The type of the Logstore. Simple Log Service provides two types of Logstores: Standard Logstores and Query Logstores.
11605
+ #
11606
+ # * **standard**: Standard Logstore. This type of Logstore supports the log analysis feature and is suitable for scenarios such as real-time monitoring and interactive analysis. You can also use this type of Logstore to build a comprehensive observability system.
11607
+ # * **query**: Query Logstore. This type of Logstore supports high-performance queries. The index traffic fee of a Query Logstore is approximately half that of a Standard Logstore. Query Logstores do not support SQL analysis. Query Logstores are suitable for scenarios in which the volume of data is large, the log retention period is long, or log analysis is not required. Log retention periods of weeks or months are considered long.
11164
11608
  self.mode = mode
11609
+ # The number of shards.
11610
+ #
11611
+ # > You cannot call the UpdateLogstore operation to change the number of shards. You can call the SplitShard or MergeShards operation to change the number of shards.
11165
11612
  self.shard_count = shard_count
11613
+ # The type of the log that you want to query. Valid values:
11614
+ #
11615
+ # * None: all types of logs.
11616
+ # * Metrics: metrics.
11166
11617
  self.telemetry_type = telemetry_type
11618
+ # The retention period of data. Unit: day. Valid values: 1 to 3650. If you set ttl to 3650, data is permanently stored.
11167
11619
  self.ttl = ttl
11168
11620
 
11169
11621
  def validate(self):
@@ -11329,7 +11781,18 @@ class UpdateLoggingRequestLoggingDetails(TeaModel):
11329
11781
  logstore: str = None,
11330
11782
  type: str = None,
11331
11783
  ):
11784
+ # The name of the Logstore to which you want to save service logs.
11332
11785
  self.logstore = logstore
11786
+ # The type of service logs. Valid values:
11787
+ #
11788
+ # * consumergroup_log: the consumption delay logs of consumer groups.
11789
+ # * logtail_alarm: the alert logs of Logtail.
11790
+ # * operation_log: the operation logs.
11791
+ # * logtail_profile: the collection logs of Logtail.
11792
+ # * metering: the metering logs.
11793
+ # * logtail_status: the status logs of Logtail.
11794
+ # * scheduledsqlalert: the operational logs of Scheduled SQL jobs.
11795
+ # * etl_alert: the operational logs of data transformation jobs.
11333
11796
  self.type = type
11334
11797
 
11335
11798
  def validate(self):
@@ -11362,7 +11825,9 @@ class UpdateLoggingRequest(TeaModel):
11362
11825
  logging_details: List[UpdateLoggingRequestLoggingDetails] = None,
11363
11826
  logging_project: str = None,
11364
11827
  ):
11828
+ # The configurations of service logs.
11365
11829
  self.logging_details = logging_details
11830
+ # The name of the project to which you want to save service logs.
11366
11831
  self.logging_project = logging_project
11367
11832
 
11368
11833
  def validate(self):
@@ -11534,7 +11999,9 @@ class UpdateMachineGroupRequestGroupAttribute(TeaModel):
11534
11999
  external_name: str = None,
11535
12000
  group_topic: str = None,
11536
12001
  ):
12002
+ # The identifier of the external management system on which the machine group depends. This parameter is empty by default.
11537
12003
  self.external_name = external_name
12004
+ # The topic of the machine group. This parameter is empty by default.
11538
12005
  self.group_topic = group_topic
11539
12006
 
11540
12007
  def validate(self):
@@ -11570,10 +12037,21 @@ class UpdateMachineGroupRequest(TeaModel):
11570
12037
  machine_identify_type: str = None,
11571
12038
  machine_list: List[str] = None,
11572
12039
  ):
12040
+ # The attribute of the machine group. This parameter is empty by default.
11573
12041
  self.group_attribute = group_attribute
12042
+ # The name of the machine group.
11574
12043
  self.group_name = group_name
12044
+ # The type of the machine group. Set the value to an empty string.
11575
12045
  self.group_type = group_type
12046
+ # The identifier type of the machine group. Valid values:
12047
+ #
12048
+ # * ip: The machine group uses IP addresses as identifiers.
12049
+ # * userdefined: The machine group uses custom identifiers.
11576
12050
  self.machine_identify_type = machine_identify_type
12051
+ # The identifiers of the machines in the machine group.
12052
+ #
12053
+ # * If you set machineIdentifyType to ip, enter the IP addresses of the machines.
12054
+ # * If you set machineIdentifyType to userdefined, enter a custom identifier.
11577
12055
  self.machine_list = machine_list
11578
12056
 
11579
12057
  def validate(self):
@@ -11654,7 +12132,9 @@ class UpdateMachineGroupMachineRequest(TeaModel):
11654
12132
  action: str = None,
11655
12133
  body: List[str] = None,
11656
12134
  ):
12135
+ # The operation on the machine. Valid values: add and delete. A value of add specifies to add the machine to the machine group. A value of delete specifies to remove the machine from the machine group.
11657
12136
  self.action = action
12137
+ # The machines to be added or removed.
11658
12138
  self.body = body
11659
12139
 
11660
12140
  def validate(self):
@@ -11721,7 +12201,9 @@ class UpdateOssExternalStoreRequestParameterColumns(TeaModel):
11721
12201
  name: str = None,
11722
12202
  type: str = None,
11723
12203
  ):
12204
+ # The key of the field.
11724
12205
  self.name = name
12206
+ # The type of the field.
11725
12207
  self.type = type
11726
12208
 
11727
12209
  def validate(self):
@@ -11758,11 +12240,17 @@ class UpdateOssExternalStoreRequestParameter(TeaModel):
11758
12240
  endpoint: str = None,
11759
12241
  objects: List[str] = None,
11760
12242
  ):
12243
+ # The AccessKey ID of your account.
11761
12244
  self.accessid = accessid
12245
+ # The AccessKey secret of your account.
11762
12246
  self.accesskey = accesskey
12247
+ # The name of the OSS bucket.
11763
12248
  self.bucket = bucket
12249
+ # The associated fields.
11764
12250
  self.columns = columns
12251
+ # The OSS endpoint.
11765
12252
  self.endpoint = endpoint
12253
+ # The associated objects.
11766
12254
  self.objects = objects
11767
12255
 
11768
12256
  def validate(self):
@@ -11820,8 +12308,11 @@ class UpdateOssExternalStoreRequest(TeaModel):
11820
12308
  parameter: UpdateOssExternalStoreRequestParameter = None,
11821
12309
  store_type: str = None,
11822
12310
  ):
12311
+ # The name of the external store.
11823
12312
  self.external_store_name = external_store_name
12313
+ # The parameters that are configured for the external store.
11824
12314
  self.parameter = parameter
12315
+ # The type of the external store. Set the value to oss.
11825
12316
  self.store_type = store_type
11826
12317
 
11827
12318
  def validate(self):
@@ -11893,6 +12384,7 @@ class UpdateProjectRequest(TeaModel):
11893
12384
  self,
11894
12385
  description: str = None,
11895
12386
  ):
12387
+ # The description of the project. The default value is an empty string.
11896
12388
  self.description = description
11897
12389
 
11898
12390
  def validate(self):
@@ -11962,14 +12454,23 @@ class UpdateRdsExternalStoreRequestParameter(TeaModel):
11962
12454
  username: str = None,
11963
12455
  vpc_id: str = None,
11964
12456
  ):
12457
+ # The name of the database in the ApsaraDB RDS for MySQL instance.
11965
12458
  self.db = db
12459
+ # The internal or public endpoint of the ApsaraDB RDS for MySQL instance.
11966
12460
  self.host = host
12461
+ # The ID of the ApsaraDB RDS for MySQL instance.
11967
12462
  self.instance_id = instance_id
12463
+ # The password that is used to log on to the ApsaraDB RDS for MySQL instance.
11968
12464
  self.password = password
12465
+ # The internal or public port of the ApsaraDB RDS for MySQL instance.
11969
12466
  self.port = port
12467
+ # The region where the ApsaraDB RDS for MySQL instance resides. Valid values: cn-qingdao, cn-beijing, and cn-hangzhou.
11970
12468
  self.region = region
12469
+ # The name of the database table in the ApsaraDB RDS for MySQL instance.
11971
12470
  self.table = table
12471
+ # The username that is used to log on to the ApsaraDB RDS for MySQL instance.
11972
12472
  self.username = username
12473
+ # The ID of the VPC to which the ApsaraDB RDS for MySQL instance belongs.
11973
12474
  self.vpc_id = vpc_id
11974
12475
 
11975
12476
  def validate(self):
@@ -12031,8 +12532,11 @@ class UpdateRdsExternalStoreRequest(TeaModel):
12031
12532
  parameter: UpdateRdsExternalStoreRequestParameter = None,
12032
12533
  store_type: str = None,
12033
12534
  ):
12535
+ # The name of the external store.
12034
12536
  self.external_store_name = external_store_name
12537
+ # The parameter struct.
12035
12538
  self.parameter = parameter
12539
+ # The storage type. Set the value to rds-vpc, which indicates an ApsaraDB RDS for MySQL database in a virtual private cloud (VPC).
12036
12540
  self.store_type = store_type
12037
12541
 
12038
12542
  def validate(self):
@@ -12108,10 +12612,17 @@ class UpdateSavedSearchRequest(TeaModel):
12108
12612
  search_query: str = None,
12109
12613
  topic: str = None,
12110
12614
  ):
12615
+ # The display name.
12111
12616
  self.display_name = display_name
12617
+ # The name of the Logstore to which the saved search belongs.
12112
12618
  self.logstore = logstore
12619
+ # The name of the saved search. The name must be 3 to 63 characters in length.
12113
12620
  self.savedsearch_name = savedsearch_name
12621
+ # The search statement or the query statement of the saved search. A query statement consists of a search statement and an analytic statement in the Search statement|Analytic statement format.
12622
+ #
12623
+ # For more information, see Log search overview and Log analysis overview.
12114
12624
  self.search_query = search_query
12625
+ # The topic of the logs.
12115
12626
  self.topic = topic
12116
12627
 
12117
12628
  def validate(self):