tencentcloud-sdk-python 3.0.1140__py2.py3-none-any.whl → 3.0.1141__py2.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.
tencentcloud/__init__.py CHANGED
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.0.1140'
17
+ __version__ = '3.0.1141'
@@ -256,6 +256,29 @@ class CdbClient(AbstractClient):
256
256
  raise TencentCloudSDKException(type(e).__name__, str(e))
257
257
 
258
258
 
259
+ def CloseSSL(self, request):
260
+ """关闭SSL连接功能。
261
+
262
+ :param request: Request instance for CloseSSL.
263
+ :type request: :class:`tencentcloud.cdb.v20170320.models.CloseSSLRequest`
264
+ :rtype: :class:`tencentcloud.cdb.v20170320.models.CloseSSLResponse`
265
+
266
+ """
267
+ try:
268
+ params = request._serialize()
269
+ headers = request.headers
270
+ body = self.call("CloseSSL", params, headers=headers)
271
+ response = json.loads(body)
272
+ model = models.CloseSSLResponse()
273
+ model._deserialize(response["Response"])
274
+ return model
275
+ except Exception as e:
276
+ if isinstance(e, TencentCloudSDKException):
277
+ raise
278
+ else:
279
+ raise TencentCloudSDKException(type(e).__name__, str(e))
280
+
281
+
259
282
  def CloseWanService(self, request):
260
283
  """本接口(CloseWanService)用于关闭云数据库实例的外网访问。关闭外网访问后,外网地址将不可访问。
261
284
 
@@ -2210,6 +2233,29 @@ class CdbClient(AbstractClient):
2210
2233
  raise TencentCloudSDKException(type(e).__name__, str(e))
2211
2234
 
2212
2235
 
2236
+ def DescribeSSLStatus(self, request):
2237
+ """查询 SSL 开通情况。如果已经开通 SSL ,会同步返回证书下载链接。
2238
+
2239
+ :param request: Request instance for DescribeSSLStatus.
2240
+ :type request: :class:`tencentcloud.cdb.v20170320.models.DescribeSSLStatusRequest`
2241
+ :rtype: :class:`tencentcloud.cdb.v20170320.models.DescribeSSLStatusResponse`
2242
+
2243
+ """
2244
+ try:
2245
+ params = request._serialize()
2246
+ headers = request.headers
2247
+ body = self.call("DescribeSSLStatus", params, headers=headers)
2248
+ response = json.loads(body)
2249
+ model = models.DescribeSSLStatusResponse()
2250
+ model._deserialize(response["Response"])
2251
+ return model
2252
+ except Exception as e:
2253
+ if isinstance(e, TencentCloudSDKException):
2254
+ raise
2255
+ else:
2256
+ raise TencentCloudSDKException(type(e).__name__, str(e))
2257
+
2258
+
2213
2259
  def DescribeSlowLogData(self, request):
2214
2260
  """条件检索实例的慢日志。只允许查看一个月之内的慢日志。
2215
2261
  使用时需要注意:可能存在单条慢日志太大,导致整个http请求的回包太大,进而引发接口超时。一旦发生超时,建议您缩小查询时的Limit参数值,从而降低包的大小,让接口能够及时返回内容。
@@ -3288,6 +3334,29 @@ class CdbClient(AbstractClient):
3288
3334
  raise TencentCloudSDKException(type(e).__name__, str(e))
3289
3335
 
3290
3336
 
3337
+ def OpenSSL(self, request):
3338
+ """开启SSL连接功能。
3339
+
3340
+ :param request: Request instance for OpenSSL.
3341
+ :type request: :class:`tencentcloud.cdb.v20170320.models.OpenSSLRequest`
3342
+ :rtype: :class:`tencentcloud.cdb.v20170320.models.OpenSSLResponse`
3343
+
3344
+ """
3345
+ try:
3346
+ params = request._serialize()
3347
+ headers = request.headers
3348
+ body = self.call("OpenSSL", params, headers=headers)
3349
+ response = json.loads(body)
3350
+ model = models.OpenSSLResponse()
3351
+ model._deserialize(response["Response"])
3352
+ return model
3353
+ except Exception as e:
3354
+ if isinstance(e, TencentCloudSDKException):
3355
+ raise
3356
+ else:
3357
+ raise TencentCloudSDKException(type(e).__name__, str(e))
3358
+
3359
+
3291
3360
  def OpenWanService(self, request):
3292
3361
  """本接口(OpenWanService)用于开通实例外网访问。
3293
3362
 
@@ -4334,6 +4334,88 @@ class CloseCdbProxyAddressResponse(AbstractModel):
4334
4334
  self._RequestId = params.get("RequestId")
4335
4335
 
4336
4336
 
4337
+ class CloseSSLRequest(AbstractModel):
4338
+ """CloseSSL请求参数结构体
4339
+
4340
+ """
4341
+
4342
+ def __init__(self):
4343
+ r"""
4344
+ :param _InstanceId: 实例 ID 。只读组 ID为空时必填。
4345
+ :type InstanceId: str
4346
+ :param _RoGroupId: 只读组 ID。实例 ID为空时必填。
4347
+ :type RoGroupId: str
4348
+ """
4349
+ self._InstanceId = None
4350
+ self._RoGroupId = None
4351
+
4352
+ @property
4353
+ def InstanceId(self):
4354
+ return self._InstanceId
4355
+
4356
+ @InstanceId.setter
4357
+ def InstanceId(self, InstanceId):
4358
+ self._InstanceId = InstanceId
4359
+
4360
+ @property
4361
+ def RoGroupId(self):
4362
+ return self._RoGroupId
4363
+
4364
+ @RoGroupId.setter
4365
+ def RoGroupId(self, RoGroupId):
4366
+ self._RoGroupId = RoGroupId
4367
+
4368
+
4369
+ def _deserialize(self, params):
4370
+ self._InstanceId = params.get("InstanceId")
4371
+ self._RoGroupId = params.get("RoGroupId")
4372
+ memeber_set = set(params.keys())
4373
+ for name, value in vars(self).items():
4374
+ property_name = name[1:]
4375
+ if property_name in memeber_set:
4376
+ memeber_set.remove(property_name)
4377
+ if len(memeber_set) > 0:
4378
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
4379
+
4380
+
4381
+
4382
+ class CloseSSLResponse(AbstractModel):
4383
+ """CloseSSL返回参数结构体
4384
+
4385
+ """
4386
+
4387
+ def __init__(self):
4388
+ r"""
4389
+ :param _AsyncRequestId: 异步请求 ID。
4390
+ :type AsyncRequestId: str
4391
+ :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4392
+ :type RequestId: str
4393
+ """
4394
+ self._AsyncRequestId = None
4395
+ self._RequestId = None
4396
+
4397
+ @property
4398
+ def AsyncRequestId(self):
4399
+ return self._AsyncRequestId
4400
+
4401
+ @AsyncRequestId.setter
4402
+ def AsyncRequestId(self, AsyncRequestId):
4403
+ self._AsyncRequestId = AsyncRequestId
4404
+
4405
+ @property
4406
+ def RequestId(self):
4407
+ return self._RequestId
4408
+
4409
+ @RequestId.setter
4410
+ def RequestId(self, RequestId):
4411
+ self._RequestId = RequestId
4412
+
4413
+
4414
+ def _deserialize(self, params):
4415
+ self._AsyncRequestId = params.get("AsyncRequestId")
4416
+ self._RequestId = params.get("RequestId")
4417
+
4418
+
4337
4419
  class CloseWanServiceRequest(AbstractModel):
4338
4420
  """CloseWanService请求参数结构体
4339
4421
 
@@ -16312,6 +16394,100 @@ class DescribeRollbackTaskDetailResponse(AbstractModel):
16312
16394
  self._RequestId = params.get("RequestId")
16313
16395
 
16314
16396
 
16397
+ class DescribeSSLStatusRequest(AbstractModel):
16398
+ """DescribeSSLStatus请求参数结构体
16399
+
16400
+ """
16401
+
16402
+ def __init__(self):
16403
+ r"""
16404
+ :param _InstanceId: 实例 ID 。只读组 ID为空时必填。
16405
+ :type InstanceId: str
16406
+ :param _RoGroupId: 只读组 ID。实例 ID为空时必填。
16407
+ :type RoGroupId: str
16408
+ """
16409
+ self._InstanceId = None
16410
+ self._RoGroupId = None
16411
+
16412
+ @property
16413
+ def InstanceId(self):
16414
+ return self._InstanceId
16415
+
16416
+ @InstanceId.setter
16417
+ def InstanceId(self, InstanceId):
16418
+ self._InstanceId = InstanceId
16419
+
16420
+ @property
16421
+ def RoGroupId(self):
16422
+ return self._RoGroupId
16423
+
16424
+ @RoGroupId.setter
16425
+ def RoGroupId(self, RoGroupId):
16426
+ self._RoGroupId = RoGroupId
16427
+
16428
+
16429
+ def _deserialize(self, params):
16430
+ self._InstanceId = params.get("InstanceId")
16431
+ self._RoGroupId = params.get("RoGroupId")
16432
+ memeber_set = set(params.keys())
16433
+ for name, value in vars(self).items():
16434
+ property_name = name[1:]
16435
+ if property_name in memeber_set:
16436
+ memeber_set.remove(property_name)
16437
+ if len(memeber_set) > 0:
16438
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
16439
+
16440
+
16441
+
16442
+ class DescribeSSLStatusResponse(AbstractModel):
16443
+ """DescribeSSLStatus返回参数结构体
16444
+
16445
+ """
16446
+
16447
+ def __init__(self):
16448
+ r"""
16449
+ :param _Status: 是否开通 SSL 。ON 代表开通 ,OFF 代表未开通。
16450
+ :type Status: str
16451
+ :param _Url: 证书下载链接。
16452
+ :type Url: str
16453
+ :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
16454
+ :type RequestId: str
16455
+ """
16456
+ self._Status = None
16457
+ self._Url = None
16458
+ self._RequestId = None
16459
+
16460
+ @property
16461
+ def Status(self):
16462
+ return self._Status
16463
+
16464
+ @Status.setter
16465
+ def Status(self, Status):
16466
+ self._Status = Status
16467
+
16468
+ @property
16469
+ def Url(self):
16470
+ return self._Url
16471
+
16472
+ @Url.setter
16473
+ def Url(self, Url):
16474
+ self._Url = Url
16475
+
16476
+ @property
16477
+ def RequestId(self):
16478
+ return self._RequestId
16479
+
16480
+ @RequestId.setter
16481
+ def RequestId(self, RequestId):
16482
+ self._RequestId = RequestId
16483
+
16484
+
16485
+ def _deserialize(self, params):
16486
+ self._Status = params.get("Status")
16487
+ self._Url = params.get("Url")
16488
+ self._RequestId = params.get("RequestId")
16489
+
16490
+
16315
16491
  class DescribeSlowLogDataRequest(AbstractModel):
16316
16492
  """DescribeSlowLogData请求参数结构体
16317
16493
 
@@ -23749,6 +23925,88 @@ class OpenDBInstanceGTIDResponse(AbstractModel):
23749
23925
  self._RequestId = params.get("RequestId")
23750
23926
 
23751
23927
 
23928
+ class OpenSSLRequest(AbstractModel):
23929
+ """OpenSSL请求参数结构体
23930
+
23931
+ """
23932
+
23933
+ def __init__(self):
23934
+ r"""
23935
+ :param _InstanceId: 实例 ID 。
23936
+ :type InstanceId: str
23937
+ :param _RoGroupId: 只读组 ID。
23938
+ :type RoGroupId: str
23939
+ """
23940
+ self._InstanceId = None
23941
+ self._RoGroupId = None
23942
+
23943
+ @property
23944
+ def InstanceId(self):
23945
+ return self._InstanceId
23946
+
23947
+ @InstanceId.setter
23948
+ def InstanceId(self, InstanceId):
23949
+ self._InstanceId = InstanceId
23950
+
23951
+ @property
23952
+ def RoGroupId(self):
23953
+ return self._RoGroupId
23954
+
23955
+ @RoGroupId.setter
23956
+ def RoGroupId(self, RoGroupId):
23957
+ self._RoGroupId = RoGroupId
23958
+
23959
+
23960
+ def _deserialize(self, params):
23961
+ self._InstanceId = params.get("InstanceId")
23962
+ self._RoGroupId = params.get("RoGroupId")
23963
+ memeber_set = set(params.keys())
23964
+ for name, value in vars(self).items():
23965
+ property_name = name[1:]
23966
+ if property_name in memeber_set:
23967
+ memeber_set.remove(property_name)
23968
+ if len(memeber_set) > 0:
23969
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
23970
+
23971
+
23972
+
23973
+ class OpenSSLResponse(AbstractModel):
23974
+ """OpenSSL返回参数结构体
23975
+
23976
+ """
23977
+
23978
+ def __init__(self):
23979
+ r"""
23980
+ :param _AsyncRequestId: 异步请求 ID。
23981
+ :type AsyncRequestId: str
23982
+ :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
23983
+ :type RequestId: str
23984
+ """
23985
+ self._AsyncRequestId = None
23986
+ self._RequestId = None
23987
+
23988
+ @property
23989
+ def AsyncRequestId(self):
23990
+ return self._AsyncRequestId
23991
+
23992
+ @AsyncRequestId.setter
23993
+ def AsyncRequestId(self, AsyncRequestId):
23994
+ self._AsyncRequestId = AsyncRequestId
23995
+
23996
+ @property
23997
+ def RequestId(self):
23998
+ return self._RequestId
23999
+
24000
+ @RequestId.setter
24001
+ def RequestId(self, RequestId):
24002
+ self._RequestId = RequestId
24003
+
24004
+
24005
+ def _deserialize(self, params):
24006
+ self._AsyncRequestId = params.get("AsyncRequestId")
24007
+ self._RequestId = params.get("RequestId")
24008
+
24009
+
23752
24010
  class OpenWanServiceRequest(AbstractModel):
23753
24011
  """OpenWanService请求参数结构体
23754
24012
 
@@ -3062,6 +3062,8 @@ class CreateListenerRequest(AbstractModel):
3062
3062
  :type MaxCps: int
3063
3063
  :param _IdleConnectTimeout: 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。默认值:900,取值范围:共享型实例和独占型实例支持:300~900,性能容量型实例支持:300~2000。如需设置超过2000s,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category),最大可设置到3600s。
3064
3064
  :type IdleConnectTimeout: int
3065
+ :param _SnatEnable: 是否开启SNAT。
3066
+ :type SnatEnable: bool
3065
3067
  """
3066
3068
  self._LoadBalancerId = None
3067
3069
  self._Ports = None
@@ -3081,6 +3083,7 @@ class CreateListenerRequest(AbstractModel):
3081
3083
  self._MaxConn = None
3082
3084
  self._MaxCps = None
3083
3085
  self._IdleConnectTimeout = None
3086
+ self._SnatEnable = None
3084
3087
 
3085
3088
  @property
3086
3089
  def LoadBalancerId(self):
@@ -3226,6 +3229,14 @@ class CreateListenerRequest(AbstractModel):
3226
3229
  def IdleConnectTimeout(self, IdleConnectTimeout):
3227
3230
  self._IdleConnectTimeout = IdleConnectTimeout
3228
3231
 
3232
+ @property
3233
+ def SnatEnable(self):
3234
+ return self._SnatEnable
3235
+
3236
+ @SnatEnable.setter
3237
+ def SnatEnable(self, SnatEnable):
3238
+ self._SnatEnable = SnatEnable
3239
+
3229
3240
 
3230
3241
  def _deserialize(self, params):
3231
3242
  self._LoadBalancerId = params.get("LoadBalancerId")
@@ -3252,6 +3263,7 @@ class CreateListenerRequest(AbstractModel):
3252
3263
  self._MaxConn = params.get("MaxConn")
3253
3264
  self._MaxCps = params.get("MaxCps")
3254
3265
  self._IdleConnectTimeout = params.get("IdleConnectTimeout")
3266
+ self._SnatEnable = params.get("SnatEnable")
3255
3267
  memeber_set = set(params.keys())
3256
3268
  for name, value in vars(self).items():
3257
3269
  property_name = name[1:]
@@ -12801,6 +12813,8 @@ class ModifyListenerRequest(AbstractModel):
12801
12813
  :type MaxCps: int
12802
12814
  :param _IdleConnectTimeout: 空闲连接超时时间,此参数仅适用于TCP监听器,单位:秒。默认值:900,取值范围:共享型实例和独占型实例支持:300~900,性能容量型实例支持:300~2000。如需设置超过2000s,请通过 [工单申请](https://console.cloud.tencent.com/workorder/category),最大可设置到3600s。
12803
12815
  :type IdleConnectTimeout: int
12816
+ :param _SnatEnable: 是否开启SNAT。
12817
+ :type SnatEnable: bool
12804
12818
  """
12805
12819
  self._LoadBalancerId = None
12806
12820
  self._ListenerId = None
@@ -12818,6 +12832,7 @@ class ModifyListenerRequest(AbstractModel):
12818
12832
  self._MaxConn = None
12819
12833
  self._MaxCps = None
12820
12834
  self._IdleConnectTimeout = None
12835
+ self._SnatEnable = None
12821
12836
 
12822
12837
  @property
12823
12838
  def LoadBalancerId(self):
@@ -12947,6 +12962,14 @@ class ModifyListenerRequest(AbstractModel):
12947
12962
  def IdleConnectTimeout(self, IdleConnectTimeout):
12948
12963
  self._IdleConnectTimeout = IdleConnectTimeout
12949
12964
 
12965
+ @property
12966
+ def SnatEnable(self):
12967
+ return self._SnatEnable
12968
+
12969
+ @SnatEnable.setter
12970
+ def SnatEnable(self, SnatEnable):
12971
+ self._SnatEnable = SnatEnable
12972
+
12950
12973
 
12951
12974
  def _deserialize(self, params):
12952
12975
  self._LoadBalancerId = params.get("LoadBalancerId")
@@ -12971,6 +12994,7 @@ class ModifyListenerRequest(AbstractModel):
12971
12994
  self._MaxConn = params.get("MaxConn")
12972
12995
  self._MaxCps = params.get("MaxCps")
12973
12996
  self._IdleConnectTimeout = params.get("IdleConnectTimeout")
12997
+ self._SnatEnable = params.get("SnatEnable")
12974
12998
  memeber_set = set(params.keys())
12975
12999
  for name, value in vars(self).items():
12976
13000
  property_name = name[1:]
@@ -3386,19 +3386,29 @@ class CreateAlarmNoticeRequest(AbstractModel):
3386
3386
  :param _Name: 通知渠道组名称。
3387
3387
  :type Name: str
3388
3388
  :param _Type: 通知类型。可选值:
3389
- <li> Trigger - 告警触发 </li>
3390
- <li> Recovery - 告警恢复</li>
3391
- <li> All - 告警触发和告警恢复</li>
3389
+ - Trigger - 告警触发
3390
+ - Recovery - 告警恢复
3391
+ - All - 告警触发和告警恢复
3392
+
3393
+
3394
+ 注意:
3395
+ - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
3396
+ - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
3392
3397
  :type Type: str
3393
3398
  :param _NoticeReceivers: 通知接收对象。
3399
+ 注意:
3400
+ - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
3401
+ - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
3394
3402
  :type NoticeReceivers: list of NoticeReceiver
3395
3403
  :param _WebCallbacks: 接口回调信息(包括企业微信)。
3404
+ 注意:
3405
+ - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
3406
+ - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
3396
3407
  :type WebCallbacks: list of WebCallback
3397
3408
  :param _NoticeRules: 通知规则。
3398
-
3399
3409
  注意:
3400
-
3401
- - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,2组配置互斥。
3410
+ - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
3411
+ - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
3402
3412
 
3403
3413
 
3404
3414
  :type NoticeRules: list of NoticeRule
@@ -4304,7 +4314,7 @@ class CreateConfigRequest(AbstractModel):
4304
4314
  :type Name: str
4305
4315
  :param _Output: 采集配置所属日志主题ID即TopicId
4306
4316
  :type Output: str
4307
- :param _Path: 日志采集路径,包含文件名
4317
+ :param _Path: 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填
4308
4318
  :type Path: str
4309
4319
  :param _LogType: 采集的日志类型,默认为minimalist_log。支持以下类型:
4310
4320
  - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
@@ -7456,7 +7466,7 @@ class DeleteConfigExtraRequest(AbstractModel):
7456
7466
 
7457
7467
  def __init__(self):
7458
7468
  r"""
7459
- :param _ConfigExtraId: 采集规则扩展配置ID
7469
+ :param _ConfigExtraId: 特殊采集规则扩展配置ID
7460
7470
  :type ConfigExtraId: str
7461
7471
  """
7462
7472
  self._ConfigExtraId = None
@@ -8902,7 +8912,27 @@ class DescribeConfigExtrasRequest(AbstractModel):
8902
8912
 
8903
8913
  def __init__(self):
8904
8914
  r"""
8905
- :param _Filters: 支持的key: topicId,name, configExtraId, machineGroupId
8915
+ :param _Filters: name
8916
+ - 按照【特殊采集配置名称】进行模糊匹配过滤。
8917
+ - 类型:String
8918
+ - 必选:否
8919
+
8920
+ configExtraId
8921
+ - 按照【特殊采集配置ID】进行过滤。
8922
+ - 类型:String
8923
+ - 必选:否
8924
+
8925
+ topicId
8926
+ - 按照【日志主题】进行过滤。
8927
+ - 类型:String
8928
+ - 必选:否
8929
+
8930
+ machineGroupId
8931
+ - 按照【机器组ID】进行过滤。
8932
+ - 类型:String
8933
+ - 必选:否
8934
+
8935
+ 每次请求的Filters的上限为10,Filter.Values的上限为5。
8906
8936
  :type Filters: list of Filter
8907
8937
  :param _Offset: 分页的偏移量,默认值为0
8908
8938
  :type Offset: int
@@ -12020,7 +12050,7 @@ class ExtractRuleInfo(AbstractModel):
12020
12050
  :param _UnMatchUpLoadSwitch: 解析失败日志是否上传,true表示上传,false表示不上传
12021
12051
  注意:此字段可能返回 null,表示取不到有效值。
12022
12052
  :type UnMatchUpLoadSwitch: bool
12023
- :param _UnMatchLogKey: 失败日志的key
12053
+ :param _UnMatchLogKey: 失败日志的key,当UnMatchUpLoadSwitch为true时必填
12024
12054
  注意:此字段可能返回 null,表示取不到有效值。
12025
12055
  :type UnMatchLogKey: str
12026
12056
  :param _Backtracking: 增量采集模式下的回溯数据量,默认:-1(全量采集);其他非负数表示增量采集(从最新的位置,往前采集${Backtracking}字节(Byte)的日志)最大支持1073741824(1G)。
@@ -12029,20 +12059,23 @@ class ExtractRuleInfo(AbstractModel):
12029
12059
  注意:此字段可能返回 null,表示取不到有效值。
12030
12060
  :type Backtracking: int
12031
12061
  :param _IsGBK: 是否为Gbk编码。 0:否;1:是。
12032
- 注意:
12062
+ 注意
12063
+ - 目前取0值时,表示UTF-8编码
12033
12064
  - COS导入不支持此字段。
12034
12065
  注意:此字段可能返回 null,表示取不到有效值。
12035
12066
  :type IsGBK: int
12036
12067
  :param _JsonStandard: 是否为标准json。 0:否; 1:是。
12068
+
12069
+ - 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
12037
12070
  注意:此字段可能返回 null,表示取不到有效值。
12038
12071
  :type JsonStandard: int
12039
- :param _Protocol: syslog传输协议,取值为tcp或者udp
12072
+ :param _Protocol: syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。
12040
12073
  注意:
12041
12074
  - 该字段适用于:创建采集规则配置、修改采集规则配置。
12042
12075
  - COS导入不支持此字段。
12043
12076
  注意:此字段可能返回 null,表示取不到有效值。
12044
12077
  :type Protocol: str
12045
- :param _Address: syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port]。举例:127.0.0.1:9000
12078
+ :param _Address: syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。
12046
12079
  注意:
12047
12080
  - 该字段适用于:创建采集规则配置、修改采集规则配置。
12048
12081
  - COS导入不支持此字段。
@@ -12051,6 +12084,7 @@ class ExtractRuleInfo(AbstractModel):
12051
12084
  :param _ParseProtocol: rfc3164:指定系统日志采集使用RFC3164协议解析日志。
12052
12085
  rfc5424:指定系统日志采集使用RFC5424协议解析日志。
12053
12086
  auto:自动匹配rfc3164或者rfc5424其中一种协议。
12087
+ 只有在LogType为service_syslog时生效,其余类型无需填写。
12054
12088
  注意:
12055
12089
  - 该字段适用于:创建采集规则配置、修改采集规则配置
12056
12090
  - COS导入不支持此字段。
@@ -12071,9 +12105,7 @@ auto:自动匹配rfc3164或者rfc5424其中一种协议。
12071
12105
  - MetadataType为2时必填。
12072
12106
  - COS导入不支持此字段。
12073
12107
  :type MetaTags: list of MetaTagInfo
12074
- :param _EventLogRules: Windows事件日志采集。
12075
- 注意:
12076
- - COS导入不支持此字段。
12108
+ :param _EventLogRules: Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。
12077
12109
  :type EventLogRules: list of EventLog
12078
12110
  """
12079
12111
  self._TimeKey = None
@@ -17679,23 +17711,28 @@ class NoticeReceiver(AbstractModel):
17679
17711
  def __init__(self):
17680
17712
  r"""
17681
17713
  :param _ReceiverType: 接受者类型。可选值:
17682
- <br><li> Uin - 用户ID
17683
- <br><li> Group - 用户组ID
17714
+ - Uin - 用户ID
17715
+ - Group - 用户组ID
17684
17716
  暂不支持其余接收者类型。
17685
17717
  :type ReceiverType: str
17686
17718
  :param _ReceiverIds: 接收者。
17719
+ 当ReceiverType为Uin时,ReceiverIds的值为用户id。[子用户信息查询](https://cloud.tencent.com/document/product/598/36258)
17720
+ 当ReceiverType为Group时,ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/14985)
17687
17721
  :type ReceiverIds: list of int
17688
17722
  :param _ReceiverChannels: 通知接收渠道。
17689
- <br><li> Email - 邮件
17690
- <br><li> Sms - 短信
17691
- <br><li> WeChat - 微信
17692
- <br><li> Phone - 电话
17723
+ - Email - 邮件
17724
+ - Sms - 短信
17725
+ - WeChat - 微信
17726
+ - Phone - 电话
17693
17727
  :type ReceiverChannels: list of str
17694
17728
  :param _StartTime: 允许接收信息的开始时间。
17695
17729
  :type StartTime: str
17696
17730
  :param _EndTime: 允许接收信息的结束时间。
17697
17731
  :type EndTime: str
17698
- :param _Index: 位序
17732
+ :param _Index: 位序。
17733
+
17734
+ - 入参无效。
17735
+ - 出参时有效。
17699
17736
  :type Index: int
17700
17737
  """
17701
17738
  self._ReceiverType = None
@@ -17784,7 +17821,12 @@ class NoticeRule(AbstractModel):
17784
17821
  :param _WebCallbacks: 告警通知模板回调信息。
17785
17822
  注意:此字段可能返回 null,表示取不到有效值。
17786
17823
  :type WebCallbacks: list of WebCallback
17787
- :param _Rule: 匹配规则。
17824
+ :param _Rule: 匹配规则 JSON串。
17825
+ `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1,2]\",\"Type\":\"Value\"}]}]}
17826
+ `
17827
+ 以上示例表示:
17828
+ 规则:
17829
+ 通知类型属于告警通知,恢复通知
17788
17830
  注意:此字段可能返回 null,表示取不到有效值。
17789
17831
  :type Rule: str
17790
17832
  """
@@ -21158,15 +21200,17 @@ class WebCallback(AbstractModel):
21158
21200
 
21159
21201
  def __init__(self):
21160
21202
  r"""
21161
- :param _Url: 回调地址。
21203
+ :param _Url: 回调地址。最大支持1024个字节数。
21162
21204
  :type Url: str
21163
21205
  :param _CallbackType: 回调的类型。可选值:
21164
- <li> WeCom
21165
- <li> Http
21206
+ - WeCom
21207
+ - Http
21208
+ - DingTalk
21209
+ - Lark
21166
21210
  :type CallbackType: str
21167
21211
  :param _Method: 回调方法。可选值:
21168
- <li> POST
21169
- <li> PUT
21212
+ - POST
21213
+ - PUT
21170
21214
  默认值为POST。CallbackType为Http时为必选。
21171
21215
  注意:此字段可能返回 null,表示取不到有效值。
21172
21216
  :type Method: str
@@ -21178,7 +21222,9 @@ class WebCallback(AbstractModel):
21178
21222
  注意:该参数已废弃,请在<a href="https://cloud.tencent.com/document/product/614/56466">创建告警策略</a>接口CallBack参数中指定请求内容。
21179
21223
  注意:此字段可能返回 null,表示取不到有效值。
21180
21224
  :type Body: str
21181
- :param _Index: 序号
21225
+ :param _Index: 序号。
21226
+ - 入参无效。
21227
+ - 出参有效。
21182
21228
  :type Index: int
21183
21229
  """
21184
21230
  self._Url = None