tencentcloud-sdk-mongodb 3.0.546 → 3.0.548

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d7abfbd37a0566dee0a0c21a8ca156d8fe23d80
-  data.tar.gz: b51feedb1cc68ae8c15a6f7ee557e6334a9c2420
+  metadata.gz: a2c97d2882c0c66e853cc0d78a1b05e0bd39d6ff
+  data.tar.gz: eef3b3b77a91bcbf61d14fbddc4d34279128c401
 SHA512:
-  metadata.gz: 88a21b259bcaaa0379ab4f95bea052b1e6dbb890645315b53d1e9aa0c533c19313e330d9984efefc388227b370822d897f3982bd850a61d92295e280d23db22a
-  data.tar.gz: 5fc80b152f769829f6035ce0dbdcee0e0efd1a0509b38c4881c10b98bcb5920b76e4c96bac9c0aded632f33b16df9f8650d42cd1643d1412ab02510bda7150af
+  metadata.gz: 7d59fd4d39ee016a82d0905406ad040243d323d53b2f742e172a35f9b2738175bc620c39a7dcc7cbe23e0d0af389691db34b735f1fa1c3cbd0e5ecfd9dfb9620
+  data.tar.gz: 4f63f8977c3e61fa3bdc414bbccf00cae95ca3b9b3769d867881e9e4fbbf581eddd6cb7a5e385072441b296566710842fc3c8d01a0bfbbb13733b0e1a5663d58

data/lib/VERSION

@@ -1 +1 @@
-3.0.546
+3.0.548

data/lib/v20190725/client.rb

@@ -53,7 +53,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 本接口(CreateAccountUser)用于创建mongodb实例账号。
+        # 本接口（CreateAccountUser）用于自定义实例访问账号。
 
         # @param request: Request instance for CreateAccountUser.
         # @type request: :class:`Tencentcloud::mongodb::V20190725::CreateAccountUserRequest`
@@ -77,7 +77,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 备份实例接口
+        # 本接口（CreateBackupDBInstance）用于备份实例。
 
         # @param request: Request instance for CreateBackupDBInstance.
         # @type request: :class:`Tencentcloud::mongodb::V20190725::CreateBackupDBInstanceRequest`
@@ -173,7 +173,31 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 本接口(DescribeAccountUsers)用于获取当前实例的全部账号。
+        # 本接口（DeleteAccountUser）用于删除实例的自定义账号。
+
+        # @param request: Request instance for DeleteAccountUser.
+        # @type request: :class:`Tencentcloud::mongodb::V20190725::DeleteAccountUserRequest`
+        # @rtype: :class:`Tencentcloud::mongodb::V20190725::DeleteAccountUserResponse`
+        def DeleteAccountUser(request)
+          body = send_request('DeleteAccountUser', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DeleteAccountUserResponse.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
+
+        # 本接口（DescribeAccountUsers）用于获取当前实例的全部账号。
 
         # @param request: Request instance for DescribeAccountUsers.
         # @type request: :class:`Tencentcloud::mongodb::V20190725::DescribeAccountUsersRequest`
@@ -245,7 +269,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 本接口(DescribeClientConnections)用于查询实例客户端连接信息，包括连接IP和连接数量。
+        # 本接口（DescribeClientConnections）用于查询实例客户端连接信息，包括连接 IP 和连接数量。
 
         # @param request: Request instance for DescribeClientConnections.
         # @type request: :class:`Tencentcloud::mongodb::V20190725::DescribeClientConnectionsRequest`
@@ -389,7 +413,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 本接口(DescribeInstanceParams)用于查询当前实例可修改的参数列表。
+        # 本接口（DescribeInstanceParams）用于查询当前实例可修改的参数列表。
 
         # @param request: Request instance for DescribeInstanceParams.
         # @type request: :class:`Tencentcloud::mongodb::V20190725::DescribeInstanceParamsRequest`
@@ -821,7 +845,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 本接口(SetAccountUserPrivilege)用于设置mongodb实例的账号权限。
+        # 本接口（SetAccountUserPrivilege）用于设置实例的账号权限。
 
         # @param request: Request instance for SetAccountUserPrivilege.
         # @type request: :class:`Tencentcloud::mongodb::V20190725::SetAccountUserPrivilegeRequest`

data/lib/v20190725/models.rb

@@ -229,7 +229,7 @@ module TencentCloud
 
       # CreateAccountUser请求参数结构体
       class CreateAccountUserRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例 ID。
+        # @param InstanceId: 实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
         # @type InstanceId: String
         # @param UserName: 新账号名称。其格式要求如下：<ul><li>字符范围[1,32]。</li><li>可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“_”与短划线“-”。</li></ul>
         # @type UserName: String
@@ -292,11 +292,13 @@ module TencentCloud
 
       # CreateBackupDBInstance请求参数结构体
       class CreateBackupDBInstanceRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例id
+        # @param InstanceId: 实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
         # @type InstanceId: String
-        # @param BackupMethod: 0-逻辑备份，1-物理备份
+        # @param BackupMethod: 设置备份方式。
+        # - 0：逻辑备份。
+        # - 1：物理备份。
         # @type BackupMethod: Integer
-        # @param BackupRemark: 备份备注
+        # @param BackupRemark: 备份备注信息。
         # @type BackupRemark: String
 
         attr_accessor :InstanceId, :BackupMethod, :BackupRemark
@@ -316,7 +318,7 @@ module TencentCloud
 
       # CreateBackupDBInstance返回参数结构体
       class CreateBackupDBInstanceResponse < TencentCloud::Common::AbstractModel
-        # @param AsyncRequestId: 查询备份流程的状态
+        # @param AsyncRequestId: 查询备份流程的状态。
         # @type AsyncRequestId: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -829,9 +831,53 @@ module TencentCloud
         end
       end
 
+      # DeleteAccountUser请求参数结构体
+      class DeleteAccountUserRequest < TencentCloud::Common::AbstractModel
+        # @param InstanceId: 指定待删除账号的实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
+        # @type InstanceId: String
+        # @param UserName: 配置待删除的账号名。
+        # @type UserName: String
+        # @param MongoUserPassword: 配置 mongouser 对应的密码。mongouser为系统默认账号，输入其对应的密码。
+        # @type MongoUserPassword: String
+
+        attr_accessor :InstanceId, :UserName, :MongoUserPassword
+        
+        def initialize(instanceid=nil, username=nil, mongouserpassword=nil)
+          @InstanceId = instanceid
+          @UserName = username
+          @MongoUserPassword = mongouserpassword
+        end
+
+        def deserialize(params)
+          @InstanceId = params['InstanceId']
+          @UserName = params['UserName']
+          @MongoUserPassword = params['MongoUserPassword']
+        end
+      end
+
+      # DeleteAccountUser返回参数结构体
+      class DeleteAccountUserResponse < TencentCloud::Common::AbstractModel
+        # @param FlowId: 账户删除任务ID。
+        # @type FlowId: Integer
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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
+
       # DescribeAccountUsers请求参数结构体
       class DescribeAccountUsersRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例ID。
+        # @param InstanceId: 指定待获取账号的实例ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
         # @type InstanceId: String
 
         attr_accessor :InstanceId
@@ -989,11 +1035,11 @@ module TencentCloud
 
       # DescribeClientConnections请求参数结构体
       class DescribeClientConnectionsRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例ID，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
+        # @param InstanceId: 指定待查询的实例ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
         # @type InstanceId: String
-        # @param Limit: 单次请求返回的数量，最小值为1，最大值为1000，默认值为1000。
+        # @param Limit: 单次请求返回的数量。最小值为1，最大值为1000，默认值为1000。
         # @type Limit: Integer
-        # @param Offset: 偏移量，默认值为0。
+        # @param Offset: 偏移量，默认值为0。Offset=Limit*(页码-1)。
         # @type Offset: Integer
 
         attr_accessor :InstanceId, :Limit, :Offset
@@ -1013,7 +1059,7 @@ module TencentCloud
 
       # DescribeClientConnections返回参数结构体
       class DescribeClientConnectionsResponse < TencentCloud::Common::AbstractModel
-        # @param Clients: 客户端连接信息，包括客户端IP和对应IP的连接数量。
+        # @param Clients: 客户端连接信息，包括客户端 IP 和对应 IP 的连接数量。
         # @type Clients: Array
         # @param TotalCount: 满足条件的记录总条数，可用于分页查询。
         # @type TotalCount: Integer
@@ -1323,7 +1369,7 @@ module TencentCloud
 
       # DescribeDBInstances请求参数结构体
       class DescribeDBInstancesRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceIds: 实例ID列表。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
+        # @param InstanceIds: 实例 ID 列表。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
         # @type InstanceIds: Array
         # @param InstanceType: 实例类型。取值范围如下：<ul><li>0：所有实例。</li><li>1：正式实例。</li><li>2：临时实例。</li><li>3：只读实例。</li><li>-1：正式实例、只读、灾备实例。</li></ul>
         # @type InstanceType: Integer
@@ -1435,7 +1481,7 @@ module TencentCloud
 
       # DescribeInstanceParams请求参数结构体
       class DescribeInstanceParamsRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例ID
+        # @param InstanceId: 指定待查询参数列表的实例ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
         # @type InstanceId: String
 
         attr_accessor :InstanceId
@@ -1451,13 +1497,13 @@ module TencentCloud
 
       # DescribeInstanceParams返回参数结构体
       class DescribeInstanceParamsResponse < TencentCloud::Common::AbstractModel
-        # @param InstanceEnumParam: 值为枚举类型参数集合
+        # @param InstanceEnumParam: 参数值为枚举类型参数集合。
         # @type InstanceEnumParam: Array
-        # @param InstanceIntegerParam: 值为integer类型参数集合
+        # @param InstanceIntegerParam: 参数值为 Integer 类型参数集合。
         # @type InstanceIntegerParam: Array
-        # @param InstanceTextParam: 值为text类型的参数集合
+        # @param InstanceTextParam: 参数值为 Text 类型的参数集合。
         # @type InstanceTextParam: Array
-        # @param InstanceMultiParam: 值为混合类型的参数集合
+        # @param InstanceMultiParam: 参数值为混合类型的参数集合。
         # @type InstanceMultiParam: Array
         # @param TotalCount: 当前实例支持修改的参数个数统计 如0
         # @type TotalCount: Integer
@@ -2242,21 +2288,25 @@ module TencentCloud
 
       # 实例可修改参数枚举类型集合。
       class InstanceEnumParam < TencentCloud::Common::AbstractModel
-        # @param CurrentValue: 参数当前值
+        # @param CurrentValue: 参数当前值。
         # @type CurrentValue: String
-        # @param DefaultValue: 默认值
+        # @param DefaultValue: 参数默认值。
         # @type DefaultValue: String
-        # @param EnumValue: 枚举值，所有支持的值
+        # @param EnumValue: 枚举值，所有支持的值。
         # @type EnumValue: Array
-        # @param NeedRestart: 是否需要重启生效 1:需要重启后生效；0：无需重启，设置成功即可生效；
+        # @param NeedRestart: 参数修改之后是否需要重启生效。
+        # - 1：需要重启后生效。
+        # - 0：无需重启，设置成功即可生效。
         # @type NeedRestart: String
-        # @param ParamName: 参数名称
+        # @param ParamName: 参数名称。
         # @type ParamName: String
-        # @param Tips: 中英文说明
+        # @param Tips: 参数说明。
         # @type Tips: Array
-        # @param ValueType: 参数值类型说明
+        # @param ValueType: 参数值类型说明。
         # @type ValueType: String
-        # @param Status: 是否为运行中参数值 1:运行中参数值；0：非运行中参数值；
+        # @param Status: 是否为运行中参数值。
+        # - 1：运行中参数值。
+        # - 0：非运行中参数值。
         # @type Status: Integer
 
         attr_accessor :CurrentValue, :DefaultValue, :EnumValue, :NeedRestart, :ParamName, :Tips, :ValueType, :Status
@@ -2284,27 +2334,31 @@ module TencentCloud
         end
       end
 
-      # 实例可修改参数integer类型集合。
+      # 实例可修改参数 Integer 类型集合。
       class InstanceIntegerParam < TencentCloud::Common::AbstractModel
-        # @param CurrentValue: 当前值
+        # @param CurrentValue: 参数当前值。
         # @type CurrentValue: String
-        # @param DefaultValue: 默认值
+        # @param DefaultValue: 参数默认值。
         # @type DefaultValue: String
-        # @param Max: 最大值
+        # @param Max: 参数最大值。
         # @type Max: String
-        # @param Min: 最小值
+        # @param Min: 最小值。
         # @type Min: String
-        # @param NeedRestart: 是否需要重启生效 1:需要重启后生效；0：无需重启，设置成功即可生效；
+        # @param NeedRestart: 参数修改之后是否需要重启生效。
+        # - 1:需要重启后生效。
+        # - 0：无需重启，设置成功即可生效。
         # @type NeedRestart: String
-        # @param ParamName: 参数名称
+        # @param ParamName: 参数名称。
         # @type ParamName: String
-        # @param Tips: 参数说明
+        # @param Tips: 参数说明。
         # @type Tips: Array
-        # @param ValueType: 参数类型
+        # @param ValueType: 参数类型。
         # @type ValueType: String
-        # @param Status: 是否为运行中参数值 1:运行中参数值；0：非运行中参数值；
+        # @param Status: 是否为运行中参数值。
+        # - 1：运行中参数值。
+        # - 0：非运行中参数值。
         # @type Status: Integer
-        # @param Unit: 冗余字段，可忽略
+        # @param Unit: 冗余字段，可忽略。
         # @type Unit: String
 
         attr_accessor :CurrentValue, :DefaultValue, :Max, :Min, :NeedRestart, :ParamName, :Tips, :ValueType, :Status, :Unit
@@ -2338,21 +2392,25 @@ module TencentCloud
 
       # 实例可修改参数Multi类型集合。
       class InstanceMultiParam < TencentCloud::Common::AbstractModel
-        # @param CurrentValue: 当前值
+        # @param CurrentValue: 参数当前值。
         # @type CurrentValue: String
-        # @param DefaultValue: 默认值
+        # @param DefaultValue: 参数默认值。
         # @type DefaultValue: String
-        # @param EnumValue: 指导值范围
+        # @param EnumValue: 参考值范围。
         # @type EnumValue: Array
-        # @param NeedRestart: 是否需要重启生效 1:需要重启后生效；0：无需重启，设置成功即可生效；
+        # @param NeedRestart: 参数修改后是否需要重启才会生效。
+        # - 1：需要重启后生效。
+        # - 0：无需重启，设置成功即可生效。
         # @type NeedRestart: String
-        # @param ParamName: 参数名称
+        # @param ParamName: 参数名称。
         # @type ParamName: String
-        # @param Status: 是否为运行中参数值 1:运行中参数值；0：非运行中参数值；
+        # @param Status: 是否为运行中参数值。
+        # - 1：运行中参数值。
+        # - 0：非运行中参数值。
         # @type Status: Integer
-        # @param Tips: 参数说明
+        # @param Tips: 参数说明。
         # @type Tips: Array
-        # @param ValueType: 当前值的类型描述，默认为multi
+        # @param ValueType: 当前值的类型描述，默认为multi。
         # @type ValueType: String
 
         attr_accessor :CurrentValue, :DefaultValue, :EnumValue, :NeedRestart, :ParamName, :Status, :Tips, :ValueType
@@ -2380,23 +2438,25 @@ module TencentCloud
         end
       end
 
-      # 实例可修改参数text类型集合。
+      # 实例可修改参数为 Text 类型的参数集合。
       class InstanceTextParam < TencentCloud::Common::AbstractModel
-        # @param CurrentValue: 当前值
+        # @param CurrentValue: 参数当前值。
         # @type CurrentValue: String
-        # @param DefaultValue: 默认值
+        # @param DefaultValue: 参数默认值。
         # @type DefaultValue: String
-        # @param NeedRestart: 是否需要重启
+        # @param NeedRestart: 修改参数值之后是否需要重启。
         # @type NeedRestart: String
-        # @param ParamName: 参数名称
+        # @param ParamName: 参数名称。
         # @type ParamName: String
-        # @param TextValue: text类型值
+        # @param TextValue: Text 类型参数对应的值。
         # @type TextValue: String
-        # @param Tips: 参数说明
+        # @param Tips: 参数说明。
         # @type Tips: Array
-        # @param ValueType: 值类型说明
+        # @param ValueType: 参数值类型说明。
         # @type ValueType: String
-        # @param Status: 是否为运行中参数值 1:运行中参数值；0：非运行中参数值；
+        # @param Status: 是否为运行中的参数值。
+        # - 1：运行中参数值。
+        # - 0：非运行中参数值。
         # @type Status: String
 
         attr_accessor :CurrentValue, :DefaultValue, :NeedRestart, :ParamName, :TextValue, :Tips, :ValueType, :Status
@@ -3089,11 +3149,11 @@ module TencentCloud
 
       # SetAccountUserPrivilege请求参数结构体
       class SetAccountUserPrivilegeRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例ID。
+        # @param InstanceId: 指定待设置账号的实例ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
         # @type InstanceId: String
-        # @param UserName: 账号名称。
+        # @param UserName: 设置账号名称。
         # @type UserName: String
-        # @param AuthRole: 权限信息。
+        # @param AuthRole: 设置权限信息。
         # @type AuthRole: Array
 
         attr_accessor :InstanceId, :UserName, :AuthRole
@@ -3120,7 +3180,7 @@ module TencentCloud
 
       # SetAccountUserPrivilege返回参数结构体
       class SetAccountUserPrivilegeResponse < TencentCloud::Common::AbstractModel
-        # @param FlowId: 设置任务ID,用于查询是否设置完成
+        # @param FlowId: 任务ID。
         # @type FlowId: Integer
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-mongodb
 version: !ruby/object:Gem::Version
-  version: 3.0.546
+  version: 3.0.548
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-07 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common