kingsoftcloud-sdk-python 1.1.1__py2.py3-none-any.whl → 1.5.8.49__py2.py3-none-any.whl

ksyun/client/mongodb/v20170101/models.py

@@ -77,7 +77,7 @@ class DeleteMongoDBInstanceRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""删除实例
+        r"""删除实例。
         :param InstanceId: 实例ID
         :type PathPrefix: String
         """
@@ -109,7 +109,7 @@ class DescribeMongoDBInstancesRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""查询账号下实例列表
+        r"""查询实例列表
         :param Area: 按可用区筛选。
         :type PathPrefix: String
         :param Vip: 实例IP地址。
@@ -118,8 +118,7 @@ class DescribeMongoDBInstancesRequest(AbstractModel):
         :type PathPrefix: String
         :param VnetId: 终端子网ID。
         :type PathPrefix: String
-        :param IamProjectId: 项目ID。                           
- 默认是0(默认项目),如果查询全部项目，需要传入所有的项目ID，‘,’隔开。
+        :param IamProjectId: 项目制ID。如需指定查询多个项目制下实例，用‘,’隔开。默认查询全部项目制。
         :type PathPrefix: String
         :param InstanceId: 实例Id。
         :type PathPrefix: String
@@ -206,12 +205,17 @@ class DescribeMongoDBInstanceNodeRequest(AbstractModel):
         r"""查询副本集实例节点信息
         :param InstanceId: 实例ID。
         :type PathPrefix: String
+        :param NodeId: 分片集群的shard节点的ID。暂不支持批量查询。
+        :type PathPrefix: String
         """
         self.InstanceId = None
+        self.NodeId = None
 
     def _deserialize(self, params):
         if params.get("InstanceId"):
             self.InstanceId = params.get("InstanceId")
+        if params.get("NodeId"):
+            self.NodeId = params.get("NodeId")
 
 
 class RenameMongoDBInstanceRequest(AbstractModel):
@@ -240,7 +244,7 @@ class ResetPasswordMongoDBInstanceRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""修改密码
+        r"""修改实例密码
         :param InstanceId: 实例id
         :type PathPrefix: String
         :param InstancePassword: 实例修改后的密码。8-30个字符，必须包含大小写字母和数字，支持特殊字符字符为!@#$%^&*()_+=-
@@ -261,7 +265,7 @@ class RestartMongoDBInstanceRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""重启实例
+        r"""重启实例。
         :param InstanceId: 实例ID
         :type PathPrefix: String
         """
@@ -277,7 +281,7 @@ class CreateMongoDBSnapshotRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""创建手动备份
+        r"""手动创建备份
         :param InstanceId: 实例Id。
         :type PathPrefix: String
         :param Name: 备份名称
@@ -350,7 +354,7 @@ class DeleteMongoDBSnapshotRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""删除备份
+        r"""删除备份。
         :param InstanceId: 实例Id。
         :type PathPrefix: String
         :param SnapshotId: 备份Id
@@ -371,7 +375,7 @@ class RenameMongoDBSnapshotRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""备份重命名
+        r"""修改备份名称
         :param InstanceId: 实例id
 
         :type PathPrefix: String
@@ -420,6 +424,32 @@ class AddSecurityGroupRuleRequest(AbstractModel):
             self.Type = params.get("Type")
 
 
+class DeleteSecurityGroupRulesRequest(AbstractModel):
+    """DeleteSecurityGroupRules请求参数结构体
+    """
+
+    def __init__(self):
+        r"""删除安全组规则
+        :param Cidrs: cidr字段集合。安全组规则id在白名单列表中获取。 
+        :type PathPrefix: String
+        :param InstanceId: 实例ID。
+        :type PathPrefix: String
+        :param Type: 网络类型	。可选：IPV4 或者 IPV6。 请注意，字段值严格大写。
+        :type PathPrefix: String
+        """
+        self.Cidrs = None
+        self.InstanceId = None
+        self.Type = None
+
+    def _deserialize(self, params):
+        if params.get("Cidrs"):
+            self.Cidrs = params.get("Cidrs")
+        if params.get("InstanceId"):
+            self.InstanceId = params.get("InstanceId")
+        if params.get("Type"):
+            self.Type = params.get("Type")
+
+
 class ListSecurityGroupRulesRequest(AbstractModel):
     """ListSecurityGroupRules请求参数结构体
     """
@@ -488,8 +518,8 @@ class DescribeMongoDBShardNodeRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""分片集群实例shard节点查询
-        :param InstanceId: 实例ID
+        r"""查询分片集群实例shard节点信息
+        :param InstanceId: 实例Id
         :type PathPrefix: String
         """
         self.InstanceId = None
@@ -504,15 +534,11 @@ class DescribeValidRegionRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""查询用户可用机房详情
-        :param Action: Action
-        :type PathPrefix: String
+        r"""查询用户可用机房列表
         """
-        self.Action = None
 
     def _deserialize(self, params):
-        if params.get("Action"):
-            self.Action = params.get("Action")
+        return
 
 
 class AllocateEipRequest(AbstractModel):
@@ -558,14 +584,10 @@ class DescribeRegionsRequest(AbstractModel):
 
     def __init__(self):
         r"""查询机房可用区
-        :param Action: Action
-        :type PathPrefix: String
         """
-        self.Action = None
 
     def _deserialize(self, params):
-        if params.get("Action"):
-            self.Action = params.get("Action")
+        return
 
 
 class CreateMongoDBShardInstanceRequest(AbstractModel):
@@ -660,16 +682,21 @@ class DownloadSnapshotRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""下载备份
+        r"""下载备份。
         :param SnapshotId: 备份ID。请注意：暂不支持分片集群实例备份的下载。
 
+        :type PathPrefix: String
+        :param InstanceId: 实例Id。
         :type PathPrefix: String
         """
         self.SnapshotId = None
+        self.InstanceId = None
 
     def _deserialize(self, params):
         if params.get("SnapshotId"):
             self.SnapshotId = params.get("SnapshotId")
+        if params.get("InstanceId"):
+            self.InstanceId = params.get("InstanceId")
 
 
 class CloneInstanceRequest(AbstractModel):
@@ -739,7 +766,7 @@ class DescribeShardNodeRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""查询分片集群shard节点列表
+        r"""查询分片集群shard节点信息
         :param InstanceId: 分片集群实例id
         :type PathPrefix: String
         """
@@ -755,15 +782,11 @@ class DescribeInstanceStatisticRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""概览页统计接口
-        :param Action: Action
-        :type PathPrefix: String
+        r"""实例概览统计
         """
-        self.Action = None
 
     def _deserialize(self, params):
-        if params.get("Action"):
-            self.Action = params.get("Action")
+        return
 
 
 class AddClusterNodeRequest(AbstractModel):
@@ -823,7 +846,7 @@ class DescribeSlowLogDetailRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""DescribeSlowLogDetail
+        r"""查询实例运行慢日志
         :param InstanceId: 实例ID。
 
         :type PathPrefix: String
@@ -876,7 +899,7 @@ class DescribeSlowLogStatisticsRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""DescribeSlowLogStatistics
+        r"""实例运行慢日志统计
         :param InstanceId: 实例ID。
         :type PathPrefix: String
         :param NodeId: 节点ID。选填节点ID则查询该节点下的慢SQL统计数据
@@ -923,7 +946,7 @@ class DescribeSlowLogDatabaseRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""DescribeSlowLogDatabase
+        r"""查询慢日志数据库列表
         :param InstanceId: 实例ID。
         :type PathPrefix: String
         :param NodeId: 节点ID。加上节点ID则查询该节点下的慢SQL数据库信息。
@@ -995,7 +1018,7 @@ class UpdateMongoDBInstanceClusterRequest(AbstractModel):
     """
 
     def __init__(self):
-        r"""分片集群节点更配
+        r"""分片集群节点配置大小更配
         :param InstanceId: 实例ID。
         :type PathPrefix: String
         :param InstanceClass: 实例套餐 可选:  1C2G        2C4G        4C8G         8C16G    8C32G    16C64G
@@ -1027,3 +1050,197 @@ class UpdateMongoDBInstanceClusterRequest(AbstractModel):
             self.Storage = params.get("Storage")
 
 
+class DescribeClusterForRestoreRequest(AbstractModel):
+    """DescribeClusterForRestore请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询分片集群可恢复配置
+        :param InstanceId: MongoDB分片集群实例ID。
+        :type PathPrefix: String
+        :param ResetTimePoint: 恢复时间点。
+        :type PathPrefix: String
+        """
+        self.InstanceId = None
+        self.ResetTimePoint = None
+
+    def _deserialize(self, params):
+        if params.get("InstanceId"):
+            self.InstanceId = params.get("InstanceId")
+        if params.get("ResetTimePoint"):
+            self.ResetTimePoint = params.get("ResetTimePoint")
+
+
+class DescribeDefaultParamsRequest(AbstractModel):
+    """DescribeDefaultParams请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询默认参数模板
+        :param DbVersion: 实例版本
+        :type PathPrefix: String
+        """
+        self.DbVersion = None
+
+    def _deserialize(self, params):
+        if params.get("DbVersion"):
+            self.DbVersion = params.get("DbVersion")
+
+
+class CreateParamGroupRequest(AbstractModel):
+    """CreateParamGroup请求参数结构体
+    """
+
+    def __init__(self):
+        r"""创建参数组
+        :param ParamGroupName: 参数组名称
+        :type PathPrefix: String
+        :param Description: 参数组描述
+        :type PathPrefix: String
+        :param DbVersion: 实例版本
+        :type PathPrefix: Double
+        :param Params: 参数项
+        :type PathPrefix: String
+        """
+        self.ParamGroupName = None
+        self.Description = None
+        self.DbVersion = None
+        self.Params = None
+
+    def _deserialize(self, params):
+        if params.get("ParamGroupName"):
+            self.ParamGroupName = params.get("ParamGroupName")
+        if params.get("Description"):
+            self.Description = params.get("Description")
+        if params.get("DbVersion"):
+            self.DbVersion = params.get("DbVersion")
+        if params.get("Params"):
+            self.Params = params.get("Params")
+
+
+class DescribeParamGroupListRequest(AbstractModel):
+    """DescribeParamGroupList请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询参数组列表
+        :param DbVersion: 实例版本
+        :type PathPrefix: String
+        :param NameSearch: 按名称筛选
+        :type PathPrefix: String
+        :param Offset: 偏移量
+        :type PathPrefix: String
+        :param Limit: 返回最大数据量
+        :type PathPrefix: String
+        """
+        self.DbVersion = None
+        self.NameSearch = None
+        self.Offset = None
+        self.Limit = None
+
+    def _deserialize(self, params):
+        if params.get("DbVersion"):
+            self.DbVersion = params.get("DbVersion")
+        if params.get("NameSearch"):
+            self.NameSearch = params.get("NameSearch")
+        if params.get("Offset"):
+            self.Offset = params.get("Offset")
+        if params.get("Limit"):
+            self.Limit = params.get("Limit")
+
+
+class DescribeParamGroupInfoRequest(AbstractModel):
+    """DescribeParamGroupInfo请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询参数组详情
+        :param ParamGroupId: 参数组Id
+        :type PathPrefix: String
+        """
+        self.ParamGroupId = None
+
+    def _deserialize(self, params):
+        if params.get("ParamGroupId"):
+            self.ParamGroupId = params.get("ParamGroupId")
+
+
+class DescribeModifyHistoryRequest(AbstractModel):
+    """DescribeModifyHistory请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询参数组修改历史
+        :param ParamName: 指定查询某个参数项的修改历史。
+        :type PathPrefix: String
+        :param Offset: 偏移量
+        :type PathPrefix: Int
+        :param Limit: 每页最大返回记录数
+        :type PathPrefix: Int
+        """
+        self.ParamName = None
+        self.Offset = None
+        self.Limit = None
+
+    def _deserialize(self, params):
+        if params.get("ParamName"):
+            self.ParamName = params.get("ParamName")
+        if params.get("Offset"):
+            self.Offset = params.get("Offset")
+        if params.get("Limit"):
+            self.Limit = params.get("Limit")
+
+
+class DescribeInstanceParamsRequest(AbstractModel):
+    """DescribeInstanceParams请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询实例参数配置
+        :param InstanceId: 实例Id
+        :type PathPrefix: String
+        """
+        self.InstanceId = None
+
+    def _deserialize(self, params):
+        if params.get("InstanceId"):
+            self.InstanceId = params.get("InstanceId")
+
+
+class ModifyParamGroupRequest(AbstractModel):
+    """ModifyParamGroup请求参数结构体
+    """
+
+    def __init__(self):
+        r"""修改参数组
+        :param NewParamGroupName: 新参数组名称
+        :type PathPrefix: String
+        :param NewDescription: 新参数组描述
+        :type PathPrefix: String
+        """
+        self.NewParamGroupName = None
+        self.NewDescription = None
+
+    def _deserialize(self, params):
+        if params.get("NewParamGroupName"):
+            self.NewParamGroupName = params.get("NewParamGroupName")
+        if params.get("NewDescription"):
+            self.NewDescription = params.get("NewDescription")
+
+
+class DeleteParamGroupRequest(AbstractModel):
+    """DeleteParamGroup请求参数结构体
+    """
+
+    def __init__(self):
+        r"""删除参数组
+        :param ParamGroupId: 删除参数组
+        :type PathPrefix: String
+        """
+        self.ParamGroupId = None
+
+    def _deserialize(self, params):
+        if params.get("ParamGroupId"):
+            self.ParamGroupId = params.get("ParamGroupId")
+
+

ksyun/client/mongodb/v20250101/client.py

@@ -0,0 +1,31 @@
+import json
+
+from ksyun.common.exception.ksyun_sdk_exception import KsyunSDKException
+from ksyun.common.abstract_client import AbstractClient
+
+
+class MongodbClient(AbstractClient):
+    _apiVersion = '2025-01-01'
+    _endpoint = 'mongodb.api.ksyun.com'
+    _service = 'mongodb'
+    def DescribeDefaultParams(self, request):
+        """查询默认参数模板
+        :param request: Request instance for DescribeDefaultParams.
+        :type request: :class:`ksyun.client.mongodb.v20250101.models.DescribeDefaultParamsRequest`
+        """
+        try:
+            params = request._serialize()
+            body = self.call_judge("DescribeDefaultParams", params, "application/json")
+            response = json.loads(body)
+            if "Error" not in response:
+                return body
+            else:
+                code = response["Error"]["Code"]
+                message = response["Error"]["Message"]
+                req_id = response["RequestId"]
+                raise KsyunSDKException(code, message, req_id)
+        except Exception as e:
+            if isinstance(e, KsyunSDKException):
+                raise
+            else:
+                raise KsyunSDKException(message=str(e))

ksyun/client/mongodb/v20250101/models.py

@@ -0,0 +1,18 @@
+from ksyun.common.abstract_model import AbstractModel
+
+class DescribeDefaultParamsRequest(AbstractModel):
+    """DescribeDefaultParams请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询默认参数模板
+        :param DbVersion: 实例版本
+        :type PathPrefix: Double
+        """
+        self.DbVersion = None
+
+    def _deserialize(self, params):
+        if params.get("DbVersion"):
+            self.DbVersion = params.get("DbVersion")
+
+

ksyun/client/monitor/v20100525/client.py

@@ -0,0 +1,54 @@
+import json
+
+from ksyun.common.exception.ksyun_sdk_exception import KsyunSDKException
+from ksyun.common.abstract_client import AbstractClient
+
+
+class MonitorClient(AbstractClient):
+    _apiVersion = '2010-05-25'
+    _endpoint = 'monitor.api.ksyun.com'
+    _service = 'monitor'
+    def GetMetricStatistics(self, request):
+        """获取监控数据
+        :param request: Request instance for GetMetricStatistics.
+        :type request: :class:`ksyun.client.monitor.v20100525.models.GetMetricStatisticsRequest`
+        """
+        try:
+            params = request._serialize()
+            body = self.call_judge("GetMetricStatistics", params, "application/json")
+            response = json.loads(body)
+            if "Error" not in response:
+                return body
+            else:
+                code = response["Error"]["Code"]
+                message = response["Error"]["Message"]
+                req_id = response["RequestId"]
+                raise KsyunSDKException(code, message, req_id)
+        except Exception as e:
+            if isinstance(e, KsyunSDKException):
+                raise
+            else:
+                raise KsyunSDKException(message=str(e))
+
+
+    def ListMetrics(self, request):
+        """查看实例对应的监控指标
+        :param request: Request instance for ListMetrics.
+        :type request: :class:`ksyun.client.monitor.v20100525.models.ListMetricsRequest`
+        """
+        try:
+            params = request._serialize()
+            body = self.call_judge("ListMetrics", params, "application/json")
+            response = json.loads(body)
+            if "Error" not in response:
+                return body
+            else:
+                code = response["Error"]["Code"]
+                message = response["Error"]["Message"]
+                req_id = response["RequestId"]
+                raise KsyunSDKException(code, message, req_id)
+        except Exception as e:
+            if isinstance(e, KsyunSDKException):
+                raise
+            else:
+                raise KsyunSDKException(message=str(e))

ksyun/client/monitor/v20100525/models.py

@@ -0,0 +1,108 @@
+from ksyun.common.abstract_model import AbstractModel
+
+class GetMetricStatisticsRequest(AbstractModel):
+    """GetMetricStatistics请求参数结构体
+    """
+
+    def __init__(self):
+        r"""获取监控数据
+        :param Namespace: 表示一类云产品，指定命名空间。
+        :type PathPrefix: String
+        :param InstanceID: 监控实例的ID。
+
+> **特别注意：** 需要额外关注部分产品线实例ID，具体如下：
+> - KS3: 实例ID为 BucketName，并非 BucketID；
+> - MongoDB：实例ID前添加`user` 前缀；
+        :type PathPrefix: String
+        :param MetricName: 监控项名称
+        :type PathPrefix: String
+        :param StartTime: 起始时间。
+
+> **时间格式：** `2023-07-19T16:00:50Z`
+        :type PathPrefix: String
+        :param EndTime: 结束时间。
+
+> **时间格式：** `2023-07-19T16:09:50Z`
+
+> **特别注意：** 数据采集可能存在有2分钟左右的延迟，EndTime的值应当比当前时间延迟两分钟，
+>
+> 假设当前时间为：2023-07-19T16:11:50Z，那么 EndTime=2023-07-19T16:09:50Z。
+        :type PathPrefix: String
+        :param Aggregate: 数据聚合的方法。目前支持：
+
+- Average
+- Max
+- Min
+
+> **注意：** 如果查询的数据与控制台监控视图不一致，可能是由于该参数导致。
+        :type PathPrefix: String
+        :param Period: 统计粒度，单位为秒。
+
+> **注意：** 该参数值应为60的整数倍，值的大小可能会导致数据与控制台展示不一致。
+>
+> 默认值为空时，将不对数据进行降采样，按产品线的推送频率进行展示。
+        :type PathPrefix: String
+        """
+        self.Namespace = None
+        self.InstanceID = None
+        self.MetricName = None
+        self.StartTime = None
+        self.EndTime = None
+        self.Aggregate = None
+        self.Period = None
+
+    def _deserialize(self, params):
+        if params.get("Namespace"):
+            self.Namespace = params.get("Namespace")
+        if params.get("InstanceID"):
+            self.InstanceID = params.get("InstanceID")
+        if params.get("MetricName"):
+            self.MetricName = params.get("MetricName")
+        if params.get("StartTime"):
+            self.StartTime = params.get("StartTime")
+        if params.get("EndTime"):
+            self.EndTime = params.get("EndTime")
+        if params.get("Aggregate"):
+            self.Aggregate = params.get("Aggregate")
+        if params.get("Period"):
+            self.Period = params.get("Period")
+
+
+class ListMetricsRequest(AbstractModel):
+    """ListMetrics请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查看实例对应的监控指标
+        :param Namespace: 表示一类云产品，指定命名空间。
+        :type PathPrefix: String
+        :param InstanceID: 实例ID。
+        :type PathPrefix: String
+        :param MetricName: 监控项。
+        :type PathPrefix: String
+        :param PageIndex: 页号，起始值：1
+        :type PathPrefix: Int
+        :param PageSize: 分页时每页显示的数据行数。
+
+> 默认值：获取实例下所有监控项
+        :type PathPrefix: Int
+        """
+        self.Namespace = None
+        self.InstanceID = None
+        self.MetricName = None
+        self.PageIndex = None
+        self.PageSize = None
+
+    def _deserialize(self, params):
+        if params.get("Namespace"):
+            self.Namespace = params.get("Namespace")
+        if params.get("InstanceID"):
+            self.InstanceID = params.get("InstanceID")
+        if params.get("MetricName"):
+            self.MetricName = params.get("MetricName")
+        if params.get("PageIndex"):
+            self.PageIndex = params.get("PageIndex")
+        if params.get("PageSize"):
+            self.PageSize = params.get("PageSize")
+
+