tencentcloud-sdk-mongodb 3.0.840 → 3.0.841

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96c5b03906a1b9f49e7e29c796adaab881727d55
-  data.tar.gz: b5b9d8f8eefa531bc0f9d59ec8c1e31aa58cf97c
+  metadata.gz: ab761002530e579cf91d88cdbc4b88e0ef4f72a8
+  data.tar.gz: b982ac0d24fc6972ac496673052beac595ba9f01
 SHA512:
-  metadata.gz: 8e51d82bc98bfed921f964ffb364657424bb9e051f5d7123eb51f268a25baee67035d79f611256f51fd86976b0dea1a3f6569877e46e740b8cdca7b54b56c3f0
-  data.tar.gz: 64b89a51b0b6a8de8189d9ba0aba9dc7ad53ddfec9572b7557513dc57d854119ed3ce412371bb946a826494230b4ba5e91328c19f65eef6e09d5dab636377ae4
+  metadata.gz: 71143282e89375e2e8213d6cdf3321ebbcfec76c1fdd2ebc16bffb858677754ab7a06b7d5f5f5e34895cc17e8bb0f1f90336c0a4219935b62dd5b3014f406716
+  data.tar.gz: ef1c2b5c6c201cf759a2b1d5f5405c78d0314b7516e456d0d5f287d05858adaa4fdf70928bf6495a2294aa9e294d48a337148a56210b6c4f744c688d24ce57e5

data/lib/VERSION

@@ -1 +1 @@
-3.0.840
+3.0.841

data/lib/v20190725/client.rb

@@ -269,6 +269,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 本接口（DescribeBackupRules）用于获取实例自动备份配置信息。
+
+        # @param request: Request instance for DescribeBackupRules.
+        # @type request: :class:`Tencentcloud::mongodb::V20190725::DescribeBackupRulesRequest`
+        # @rtype: :class:`Tencentcloud::mongodb::V20190725::DescribeBackupRulesResponse`
+        def DescribeBackupRules(request)
+          body = send_request('DescribeBackupRules', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DescribeBackupRulesResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 本接口（DescribeClientConnections）用于查询实例客户端连接信息，包括连接 IP 和连接数量。
 
         # @param request: Request instance for DescribeClientConnections.
@@ -533,6 +557,54 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 获取实例透明加密的开启状态
+
+        # @param request: Request instance for DescribeTransparentDataEncryptionStatus.
+        # @type request: :class:`Tencentcloud::mongodb::V20190725::DescribeTransparentDataEncryptionStatusRequest`
+        # @rtype: :class:`Tencentcloud::mongodb::V20190725::DescribeTransparentDataEncryptionStatusResponse`
+        def DescribeTransparentDataEncryptionStatus(request)
+          body = send_request('DescribeTransparentDataEncryptionStatus', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DescribeTransparentDataEncryptionStatusResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
+        # 本接口(EnableTransparentDataEncryption)用于开启云数据库 MongoDB 的透明加密能力。
+
+        # @param request: Request instance for EnableTransparentDataEncryption.
+        # @type request: :class:`Tencentcloud::mongodb::V20190725::EnableTransparentDataEncryptionRequest`
+        # @rtype: :class:`Tencentcloud::mongodb::V20190725::EnableTransparentDataEncryptionResponse`
+        def EnableTransparentDataEncryption(request)
+          body = send_request('EnableTransparentDataEncryption', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = EnableTransparentDataEncryptionResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 该接口用于发起按 Key 闪回任务，依据数据的闪回 Key（默认为 id）对数据进行极速回档，快速恢复业务。
         # **说明：按 Key 闪回于2023年09月11日正式进行公测，在此期间，该接口仅对公测用户开放。**
 
@@ -894,6 +966,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 本接口(SetBackupRules)用于设置 MongoDB 云数据库的自动备份规则。
+
+        # @param request: Request instance for SetBackupRules.
+        # @type request: :class:`Tencentcloud::mongodb::V20190725::SetBackupRulesRequest`
+        # @rtype: :class:`Tencentcloud::mongodb::V20190725::SetBackupRulesResponse`
+        def SetBackupRules(request)
+          body = send_request('SetBackupRules', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = SetBackupRulesResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 本接口（SetInstanceMaintenance ） 用于设置实例维护时间窗。
 
         # @param request: Request instance for SetInstanceMaintenance.

data/lib/v20190725/models.rb

@@ -1077,6 +1077,52 @@ module TencentCloud
         end
       end
 
+      # DescribeBackupRules请求参数结构体
+      class DescribeBackupRulesRequest < TencentCloud::Common::AbstractModel
+        # @param InstanceId: 指定实例ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
+        # @type InstanceId: String
+
+        attr_accessor :InstanceId
+
+        def initialize(instanceid=nil)
+          @InstanceId = instanceid
+        end
+
+        def deserialize(params)
+          @InstanceId = params['InstanceId']
+        end
+      end
+
+      # DescribeBackupRules返回参数结构体
+      class DescribeBackupRulesResponse < TencentCloud::Common::AbstractModel
+        # @param BackupSaveTime: 备份数据保留期限。单位为：天。
+        # @type BackupSaveTime: Integer
+        # @param BackupTime: 自动备份开始时间。
+        # @type BackupTime: Integer
+        # @param BackupMethod: 备份方式。
+        # - 0：逻辑备份。
+        # - 1：物理备份。
+        # @type BackupMethod: Integer
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :BackupSaveTime, :BackupTime, :BackupMethod, :RequestId
+
+        def initialize(backupsavetime=nil, backuptime=nil, backupmethod=nil, requestid=nil)
+          @BackupSaveTime = backupsavetime
+          @BackupTime = backuptime
+          @BackupMethod = backupmethod
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @BackupSaveTime = params['BackupSaveTime']
+          @BackupTime = params['BackupTime']
+          @BackupMethod = params['BackupMethod']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # DescribeClientConnections请求参数结构体
       class DescribeClientConnectionsRequest < TencentCloud::Common::AbstractModel
         # @param InstanceId: 指定待查询的实例ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
@@ -1829,6 +1875,100 @@ module TencentCloud
         end
       end
 
+      # DescribeTransparentDataEncryptionStatus请求参数结构体
+      class DescribeTransparentDataEncryptionStatusRequest < TencentCloud::Common::AbstractModel
+        # @param InstanceId: 指定实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
+        # @type InstanceId: String
+
+        attr_accessor :InstanceId
+
+        def initialize(instanceid=nil)
+          @InstanceId = instanceid
+        end
+
+        def deserialize(params)
+          @InstanceId = params['InstanceId']
+        end
+      end
+
+      # DescribeTransparentDataEncryptionStatus返回参数结构体
+      class DescribeTransparentDataEncryptionStatusResponse < TencentCloud::Common::AbstractModel
+        # @param TransparentDataEncryptionStatus: 表示是否开启了透明加密。
+        # - close：未开启。
+        # - open：已开启。
+        # @type TransparentDataEncryptionStatus: String
+        # @param KeyInfoList: 已绑定的密钥列表，如未绑定，返回null。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type KeyInfoList: Array
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :TransparentDataEncryptionStatus, :KeyInfoList, :RequestId
+
+        def initialize(transparentdataencryptionstatus=nil, keyinfolist=nil, requestid=nil)
+          @TransparentDataEncryptionStatus = transparentdataencryptionstatus
+          @KeyInfoList = keyinfolist
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @TransparentDataEncryptionStatus = params['TransparentDataEncryptionStatus']
+          unless params['KeyInfoList'].nil?
+            @KeyInfoList = []
+            params['KeyInfoList'].each do |i|
+              kmsinfodetail_tmp = KMSInfoDetail.new
+              kmsinfodetail_tmp.deserialize(i)
+              @KeyInfoList << kmsinfodetail_tmp
+            end
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
+      # EnableTransparentDataEncryption请求参数结构体
+      class EnableTransparentDataEncryptionRequest < TencentCloud::Common::AbstractModel
+        # @param InstanceId: 实例 ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。目前支持通用版本包含：4.4、5.0，云盘版暂不支持。
+        # @type InstanceId: String
+        # @param KmsRegion:  [密钥管理系统（Key Management Service，KMS）](https://cloud.tencent.com/document/product/573/18809)服务所在地域，例如 ap-shanghai。
+        # @type KmsRegion: String
+        # @param KeyId: 密钥 ID。若不设置该参数，不指定具体的密钥 ID，由腾讯云自动生成密钥。
+        # @type KeyId: String
+
+        attr_accessor :InstanceId, :KmsRegion, :KeyId
+
+        def initialize(instanceid=nil, kmsregion=nil, keyid=nil)
+          @InstanceId = instanceid
+          @KmsRegion = kmsregion
+          @KeyId = keyid
+        end
+
+        def deserialize(params)
+          @InstanceId = params['InstanceId']
+          @KmsRegion = params['KmsRegion']
+          @KeyId = params['KeyId']
+        end
+      end
+
+      # EnableTransparentDataEncryption返回参数结构体
+      class EnableTransparentDataEncryptionResponse < TencentCloud::Common::AbstractModel
+        # @param FlowId: 开启透明加密的异步流程id，用于查询流程状态。
+        # @type FlowId: Integer
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :FlowId, :RequestId
+
+        def initialize(flowid=nil, requestid=nil)
+          @FlowId = flowid
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @FlowId = params['FlowId']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # 按key回档，用于筛选数据的键值对
       class FBKeyValue < TencentCloud::Common::AbstractModel
         # @param Key: 用于按key回档过滤的key
@@ -2734,6 +2874,48 @@ module TencentCloud
         end
       end
 
+      # KMS密钥信息
+      class KMSInfoDetail < TencentCloud::Common::AbstractModel
+        # @param KeyId: 主密钥 ID。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type KeyId: String
+        # @param KeyName: 主密钥名称。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type KeyName: String
+        # @param CreateTime: 实例与密钥绑定时间。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CreateTime: String
+        # @param Status: 密钥状态。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Status: String
+        # @param KeyUsage: 密钥用途。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type KeyUsage: String
+        # @param KeyOrigin: 密钥来源。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type KeyOrigin: String
+
+        attr_accessor :KeyId, :KeyName, :CreateTime, :Status, :KeyUsage, :KeyOrigin
+
+        def initialize(keyid=nil, keyname=nil, createtime=nil, status=nil, keyusage=nil, keyorigin=nil)
+          @KeyId = keyid
+          @KeyName = keyname
+          @CreateTime = createtime
+          @Status = status
+          @KeyUsage = keyusage
+          @KeyOrigin = keyorigin
+        end
+
+        def deserialize(params)
+          @KeyId = params['KeyId']
+          @KeyName = params['KeyName']
+          @CreateTime = params['CreateTime']
+          @Status = params['Status']
+          @KeyUsage = params['KeyUsage']
+          @KeyOrigin = params['KeyOrigin']
+        end
+      end
+
       # KillOps请求参数结构体
       class KillOpsRequest < TencentCloud::Common::AbstractModel
         # @param InstanceId: 实例ID，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
@@ -3480,6 +3662,56 @@ module TencentCloud
         end
       end
 
+      # SetBackupRules请求参数结构体
+      class SetBackupRulesRequest < TencentCloud::Common::AbstractModel
+        # @param InstanceId: 实例 ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
+        # @type InstanceId: String
+        # @param BackupMethod: 设置自动备份方式。- 0：逻辑备份。- 1：物理备份。-3：快照备份(仅云盘版支持)。
+        # @type BackupMethod: Integer
+        # @param BackupTime: 设置自动备份开始时间。取值范围为：[0,23]，例如：该参数设置为2，表示02:00开始备份。
+        # @type BackupTime: Integer
+        # @param Notify: 设置自动备份发生错误时，是否发送失败告警。
+        # - true：发送。
+        # - false：不发送。
+        # @type Notify: Boolean
+        # @param BackupRetentionPeriod: 指定备份数据保存天数。默认为 7 天，支持设置为7、30、90、180、365。
+        # @type BackupRetentionPeriod: Integer
+
+        attr_accessor :InstanceId, :BackupMethod, :BackupTime, :Notify, :BackupRetentionPeriod
+
+        def initialize(instanceid=nil, backupmethod=nil, backuptime=nil, notify=nil, backupretentionperiod=nil)
+          @InstanceId = instanceid
+          @BackupMethod = backupmethod
+          @BackupTime = backuptime
+          @Notify = notify
+          @BackupRetentionPeriod = backupretentionperiod
+        end
+
+        def deserialize(params)
+          @InstanceId = params['InstanceId']
+          @BackupMethod = params['BackupMethod']
+          @BackupTime = params['BackupTime']
+          @Notify = params['Notify']
+          @BackupRetentionPeriod = params['BackupRetentionPeriod']
+        end
+      end
+
+      # SetBackupRules返回参数结构体
+      class SetBackupRulesResponse < TencentCloud::Common::AbstractModel
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RequestId
+
+        def initialize(requestid=nil)
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @RequestId = params['RequestId']
+        end
+      end
+
       # SetInstanceMaintenance请求参数结构体
       class SetInstanceMaintenanceRequest < TencentCloud::Common::AbstractModel
         # @param InstanceId: 指定实例ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-mongodb
 version: !ruby/object:Gem::Version
-  version: 3.0.840
+  version: 3.0.841
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-09 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common