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

ksyun/client/monitor/v20210101/models.py

@@ -0,0 +1,330 @@
+from ksyun.common.abstract_model import AbstractModel
+
+class ListAlarmPolicyRequest(AbstractModel):
+    """ListAlarmPolicy请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询告警策略
+        :param PageIndex: 页号，起始值：1
+        :type PathPrefix: Int
+        :param PageSize: 分页时每页显示的数据行数。
+
+> 取值范围 1~100
+        :type PathPrefix: Int
+        """
+        self.PageIndex = None
+        self.PageSize = None
+
+    def _deserialize(self, params):
+        if params.get("PageIndex"):
+            self.PageIndex = params.get("PageIndex")
+        if params.get("PageSize"):
+            self.PageSize = params.get("PageSize")
+
+
+class DescribeAlarmPolicyRequest(AbstractModel):
+    """DescribeAlarmPolicy请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询告警策略详细信息
+        :param PolicyId: 告警策略ID，详见[查询告警策略](https://docs.ksyun.com/documents/40346)
+        :type PathPrefix: Int
+        """
+        self.PolicyId = None
+
+    def _deserialize(self, params):
+        if params.get("PolicyId"):
+            self.PolicyId = params.get("PolicyId")
+
+
+class DescribePolicyObjectRequest(AbstractModel):
+    """DescribePolicyObject请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询告警策略关联实例明细
+        :param PolicyId: 告警策略ID，详见[查询告警策略](https://docs.ksyun.com/documents/40346)
+        :type PathPrefix: Int
+        :param PageIndex: 页号，起始值：1
+        :type PathPrefix: Int
+        :param PageSize: 分页时每页显示的数据行数。
+
+> 取值范围 1~100
+        :type PathPrefix: Int
+        """
+        self.PolicyId = None
+        self.PageIndex = None
+        self.PageSize = None
+
+    def _deserialize(self, params):
+        if params.get("PolicyId"):
+            self.PolicyId = params.get("PolicyId")
+        if params.get("PageIndex"):
+            self.PageIndex = params.get("PageIndex")
+        if params.get("PageSize"):
+            self.PageSize = params.get("PageSize")
+
+
+class DescribeAlarmReceivesRequest(AbstractModel):
+    """DescribeAlarmReceives请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询告警策略关联的接收人
+        :param PolicyId: 告警策略ID，详见[查询告警策略](https://docs.ksyun.com/documents/40346)
+        :type PathPrefix: Int
+        """
+        self.PolicyId = None
+
+    def _deserialize(self, params):
+        if params.get("PolicyId"):
+            self.PolicyId = params.get("PolicyId")
+
+
+class AddAlarmReceivesRequest(AbstractModel):
+    """AddAlarmReceives请求参数结构体
+    """
+
+    def __init__(self):
+        r"""添加告警策略关联的接收人
+        :param PolicyId: 告警策略ID，详见[查询告警策略](https://docs.ksyun.com/documents/40346)
+        :type PathPrefix: Int
+        :param ContactFlag: 告警联系人类型。取值：
+- 1: 联系组
+- 2: 联系人
+        :type PathPrefix: Int
+        :param ContactWay: 告警通知方式。取值：
+- 1: 发送邮件
+- 2: 发送短信
+- 3: 发送邮件和短信
+        :type PathPrefix: Int
+        :param ContactId: 告警联系人ID或告警联系组ID。
+
+> **说明：** 参数支持多个联系人或联系组ID。
+        :type PathPrefix: Array
+        """
+        self.PolicyId = None
+        self.ContactFlag = None
+        self.ContactWay = None
+        self.ContactId = None
+
+    def _deserialize(self, params):
+        if params.get("PolicyId"):
+            self.PolicyId = params.get("PolicyId")
+        if params.get("ContactFlag"):
+            self.ContactFlag = params.get("ContactFlag")
+        if params.get("ContactWay"):
+            self.ContactWay = params.get("ContactWay")
+        if params.get("ContactId"):
+            self.ContactId = params.get("ContactId")
+
+
+class DeleteAlarmReceivesRequest(AbstractModel):
+    """DeleteAlarmReceives请求参数结构体
+    """
+
+    def __init__(self):
+        r"""删除告警策略关联的接收人
+        :param PolicyId: 告警策略ID，详见[查询告警策略](https://docs.ksyun.com/documents/40346)
+        :type PathPrefix: Int
+        :param ContactFlag: 告警联系人类型。取值：
+- 1: 联系组
+- 2: 联系人
+        :type PathPrefix: Int
+        :param ContactId: 告警联系人ID或告警联系组ID。
+
+> **说明：** 参数支持多个联系人或联系组ID。
+        :type PathPrefix: Array
+        """
+        self.PolicyId = None
+        self.ContactFlag = None
+        self.ContactId = None
+
+    def _deserialize(self, params):
+        if params.get("PolicyId"):
+            self.PolicyId = params.get("PolicyId")
+        if params.get("ContactFlag"):
+            self.ContactFlag = params.get("ContactFlag")
+        if params.get("ContactId"):
+            self.ContactId = params.get("ContactId")
+
+
+class GetUserGroupRequest(AbstractModel):
+    """GetUserGroup请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询联系组
+        """
+
+    def _deserialize(self, params):
+        return
+
+
+class GetAlertUserRequest(AbstractModel):
+    """GetAlertUser请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询联系人
+        :param UserGrpId: 联系组ID，详见 [获取联系组](获取联系组)。
+
+
+> **说明：** 默认：表示全部；
+> **示例：** `UserGrpId.1=100&UserGrpId.2=101`
+(如果用户需要获取两个联系组的人员信息)
+        :type PathPrefix: Filter
+        """
+        self.UserGrpId = None
+
+    def _deserialize(self, params):
+        if params.get("UserGrpId"):
+            self.UserGrpId = params.get("UserGrpId")
+
+
+class UpdateAlertUserStatusRequest(AbstractModel):
+    """UpdateAlertUserStatus请求参数结构体
+    """
+
+    def __init__(self):
+        r"""启用或禁用联系人
+        :param UserId: 联系人ID，支持多个。
+        :type PathPrefix: Array
+        :param UserStatus: 告警联系人状态。取值：
+- 1：启用
+- 2：禁用
+        :type PathPrefix: Int
+        """
+        self.UserId = None
+        self.UserStatus = None
+
+    def _deserialize(self, params):
+        if params.get("UserId"):
+            self.UserId = params.get("UserId")
+        if params.get("UserStatus"):
+            self.UserStatus = params.get("UserStatus")
+
+
+class DescribeSysEventGroupListRequest(AbstractModel):
+    """DescribeSysEventGroupList请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询事件分组列表
+        :param Namespace: 表示一类云产品，指定命名空间, 示例值：
+- KEC: 云服务器
+- KS3：对象存储
+        :type PathPrefix: String
+        :param StartTime: 起始时间。
+
+> **Tips**：请注意时间格式为Unix时间戳（毫秒），从1970年1月1日开始所经过的毫秒数。
+        :type PathPrefix: Int
+        :param EndTime: 结束时间。
+        :type PathPrefix: Int
+        :param EventName: 指定事件名称，多个间以逗号分隔。
+        :type PathPrefix: String
+        :param InstanceId: 指定实例ID查询事件，多个间以逗号分隔，最多可查询20个实例
+        :type PathPrefix: Array
+        :param Order: 结果按照事件创建时间排序方式。
+- 0：倒序 
+- 1：正序
+        :type PathPrefix: Boolean
+        :param PageIndex: 页号
+        :type PathPrefix: Int
+        :param PageSize: 每页显示的数据行数
+        :type PathPrefix: Int
+        """
+        self.Namespace = None
+        self.StartTime = None
+        self.EndTime = None
+        self.EventName = None
+        self.InstanceId = None
+        self.Order = None
+        self.PageIndex = None
+        self.PageSize = None
+
+    def _deserialize(self, params):
+        if params.get("Namespace"):
+            self.Namespace = params.get("Namespace")
+        if params.get("StartTime"):
+            self.StartTime = params.get("StartTime")
+        if params.get("EndTime"):
+            self.EndTime = params.get("EndTime")
+        if params.get("EventName"):
+            self.EventName = params.get("EventName")
+        if params.get("InstanceId"):
+            self.InstanceId = params.get("InstanceId")
+        if params.get("Order"):
+            self.Order = params.get("Order")
+        if params.get("PageIndex"):
+            self.PageIndex = params.get("PageIndex")
+        if params.get("PageSize"):
+            self.PageSize = params.get("PageSize")
+
+
+class DescribeMonitorProductListRequest(AbstractModel):
+    """DescribeMonitorProductList请求参数结构体
+    """
+
+    def __init__(self):
+        r"""描述监控云服务类别，支持项目
+        """
+
+    def _deserialize(self, params):
+        return
+
+
+class DescribeAlertHistoriesRequest(AbstractModel):
+    """DescribeAlertHistories请求参数结构体
+    """
+
+    def __init__(self):
+        r"""获取告警历史记录
+        :param StartTime: 开始时间。
+
+> 时间格式：Unix时间戳(秒)
+        :type PathPrefix: Int
+        :param EndTime: 结束时间。
+
+> 时间格式：Unix时间戳(秒)
+        :type PathPrefix: Int
+        :param ProductType: 产品ID，详情 [获取产品列表](https://docs.ksyun.com/documents/42040?type=3)
+        :type PathPrefix: Int
+        :param PolicyId: 指定策略ID查询。
+        :type PathPrefix: Int
+        :param InstanceId: 指定告警资源ID。
+
+> 不支持批量资源ID查询。
+        :type PathPrefix: String
+        :param PageIndex: 页数。
+        :type PathPrefix: Int
+        :param PageSize: 每页最多显示记录数。
+        :type PathPrefix: Int
+        """
+        self.StartTime = None
+        self.EndTime = None
+        self.ProductType = None
+        self.PolicyId = None
+        self.InstanceId = None
+        self.PageIndex = None
+        self.PageSize = None
+
+    def _deserialize(self, params):
+        if params.get("StartTime"):
+            self.StartTime = params.get("StartTime")
+        if params.get("EndTime"):
+            self.EndTime = params.get("EndTime")
+        if params.get("ProductType"):
+            self.ProductType = params.get("ProductType")
+        if params.get("PolicyId"):
+            self.PolicyId = params.get("PolicyId")
+        if params.get("InstanceId"):
+            self.InstanceId = params.get("InstanceId")
+        if params.get("PageIndex"):
+            self.PageIndex = params.get("PageIndex")
+        if params.get("PageSize"):
+            self.PageSize = params.get("PageSize")
+
+

ksyun/client/monitor/v20220101/client.py

@@ -0,0 +1,56 @@
+import json
+
+from ksyun.common.exception.ksyun_sdk_exception import KsyunSDKException
+from ksyun.common.abstract_client import AbstractClient
+
+
+class MonitorClient(AbstractClient):
+    _apiVersion = '2022-01-01'
+    _endpoint = 'monitor.api.ksyun.com'
+    _service = 'monitor'
+    def CreateAlarmPolicy(self, request):
+        """创建告警策略
+        :param request: Request instance for CreateAlarmPolicy.
+        :type request: :class:`ksyun.client.monitor.v20220101.models.CreateAlarmPolicyRequest`
+        """
+        try:
+            params = request._serialize()
+            body = self.call_judge("CreateAlarmPolicy", params, "application/x-www-form-urlencoded")
+            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(e.message, e.message)
+
+
+    def DeleteAlarmPolicy(self, request):
+        """删除告警策略
+        :param request: Request instance for DeleteAlarmPolicy.
+        :type request: :class:`ksyun.client.monitor.v20220101.models.DeleteAlarmPolicyRequest`
+        """
+        try:
+            params = request._serialize()
+            body = self.call_judge("DeleteAlarmPolicy", 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(e.message, e.message)
+
+

ksyun/client/monitor/v20220101/models.py

@@ -0,0 +1,32 @@
+from ksyun.common.abstract_model import AbstractModel
+
+class CreateAlarmPolicyRequest(AbstractModel):
+    """CreateAlarmPolicy请求参数结构体
+    """
+
+    def __init__(self):
+        r"""创建告警策略
+        """
+
+    def _deserialize(self, params):
+        return
+
+
+class DeleteAlarmPolicyRequest(AbstractModel):
+    """DeleteAlarmPolicy请求参数结构体
+    """
+
+    def __init__(self):
+        r"""删除告警策略
+        :param PolicyIds: 告警策略ID。
+
+> **说明：** 支持同时删除多个策略。
+        :type PathPrefix: Array
+        """
+        self.PolicyIds = None
+
+    def _deserialize(self, params):
+        if params.get("PolicyIds"):
+            self.PolicyIds = params.get("PolicyIds")
+
+

ksyun/client/monitor/v20250101/client.py

@@ -0,0 +1,79 @@
+import json
+
+from ksyun.common.exception.ksyun_sdk_exception import KsyunSDKException
+from ksyun.common.abstract_client import AbstractClient
+
+
+class MonitorClient(AbstractClient):
+    _apiVersion = '2025-01-01'
+    _endpoint = 'monitor.api.ksyun.com'
+    _service = 'monitor'
+    def DescribeAlertingResources(self, request):
+        """正在告警资源列表
+        :param request: Request instance for DescribeAlertingResources.
+        :type request: :class:`ksyun.client.monitor.v20250101.models.DescribeAlertingResourcesRequest`
+        """
+        try:
+            params = request._serialize()
+            body = self.call_judge("DescribeAlertingResources", 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(e.message, e.message)
+
+
+    def DescribeSystemEventAttributes(self, request):
+        """查询系统事件详情
+        :param request: Request instance for DescribeSystemEventAttributes.
+        :type request: :class:`ksyun.client.monitor.v20250101.models.DescribeSystemEventAttributesRequest`
+        """
+        try:
+            params = request._serialize()
+            body = self.call_judge("DescribeSystemEventAttributes", params, "application/x-www-form-urlencoded")
+            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(e.message, e.message)
+
+
+    def ListAlarmEffectInstance(self, request):
+        """获取故障影响实例列表
+        :param request: Request instance for ListAlarmEffectInstance.
+        :type request: :class:`ksyun.client.monitor.v20250101.models.ListAlarmEffectInstanceRequest`
+        """
+        try:
+            params = request._serialize()
+            body = self.call_judge("ListAlarmEffectInstance", params, "application/x-www-form-urlencoded")
+            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(e.message, e.message)
+
+

ksyun/client/monitor/v20250101/models.py

@@ -0,0 +1,156 @@
+from ksyun.common.abstract_model import AbstractModel
+
+class DescribeAlertingResourcesRequest(AbstractModel):
+    """DescribeAlertingResources请求参数结构体
+    """
+
+    def __init__(self):
+        r"""正在告警资源列表
+        :param Namespace: 指定命名空间。
+        :type PathPrefix: String
+        :param StartTime: 起始时间。
+
+> 时间格式：`Unix` 时间戳
+
+> **注意：** StartTime 时间戳要小于30天，目前只能支持查30以内的数据。
+        :type PathPrefix: Int
+        :param EndTime: 结束时间。
+
+> 时间格式：`Unix` 时间戳
+        :type PathPrefix: Int
+        """
+        self.Namespace = None
+        self.StartTime = None
+        self.EndTime = None
+
+    def _deserialize(self, params):
+        if params.get("Namespace"):
+            self.Namespace = params.get("Namespace")
+        if params.get("StartTime"):
+            self.StartTime = params.get("StartTime")
+        if params.get("EndTime"):
+            self.EndTime = params.get("EndTime")
+
+
+class DescribeSystemEventAttributesRequest(AbstractModel):
+    """DescribeSystemEventAttributes请求参数结构体
+    """
+
+    def __init__(self):
+        r"""查询系统事件详情
+        :param StartTime: 开始时间。
+
+> **Tips：** 请注意时间格式为Unix时间戳（毫秒），从1970年1月1日开始所经过的毫秒数。
+        :type PathPrefix: Int
+        :param EndTime: 结束时间。
+
+> **Tips：** 请注意时间格式为Unix时间戳（毫秒），从1970年1月1日开始所经过的毫秒数。
+        :type PathPrefix: Int
+        :param Namespace: 表示一类云产品，指定命名空间。
+        :type PathPrefix: String
+        :param EventType: 事件类型。
+
+> **说明：**
+> 关于事件类型的取值，可参考：[云产品事件列表](https://docs.ksyun.com/directories/3753?type=1)
+        :type PathPrefix: String
+        :param EventName: 事件名称。
+
+> **说明：**
+> 关于事件类型的取值，可参考：[云产品事件列表](https://docs.ksyun.com/directories/3753?type=1)
+
+
+> **Tips：** 支持同时查询多个事件，多个事件之间用逗号分隔，最多可查询10个事件。
+        :type PathPrefix: String
+        :param Level: 事件级别。
+
+有效值：
+- Critical：严重
+- Warn(Warning)：警告
+- Info：信息
+
+        :type PathPrefix: String
+        :param Status: 事件状态。
+
+> **说明：**
+> 关于事件类型的取值，可参考：[云产品事件列表](https://docs.ksyun.com/directories/3753?type=1)
+        :type PathPrefix: String
+        :param SearchKeywords: 搜索事件内容包含的关键字。
+
+取值：
+- 如果您待搜索事件的内容中包括 a 和 b，可以搜索a and b。
+- 如果您待搜索事件的内容中包括 a 或 b，可以搜索a or b。
+        :type PathPrefix: String
+        :param PageIndex: 页码。
+
+取值范围：1~10000。
+        :type PathPrefix: Int
+        :param PageSize: 每页显示记录条数。
+
+取值范围：1~100。
+        :type PathPrefix: Int
+        """
+        self.StartTime = None
+        self.EndTime = None
+        self.Namespace = None
+        self.EventType = None
+        self.EventName = None
+        self.Level = None
+        self.Status = None
+        self.SearchKeywords = None
+        self.PageIndex = None
+        self.PageSize = None
+
+    def _deserialize(self, params):
+        if params.get("StartTime"):
+            self.StartTime = params.get("StartTime")
+        if params.get("EndTime"):
+            self.EndTime = params.get("EndTime")
+        if params.get("Namespace"):
+            self.Namespace = params.get("Namespace")
+        if params.get("EventType"):
+            self.EventType = params.get("EventType")
+        if params.get("EventName"):
+            self.EventName = params.get("EventName")
+        if params.get("Level"):
+            self.Level = params.get("Level")
+        if params.get("Status"):
+            self.Status = params.get("Status")
+        if params.get("SearchKeywords"):
+            self.SearchKeywords = params.get("SearchKeywords")
+        if params.get("PageIndex"):
+            self.PageIndex = params.get("PageIndex")
+        if params.get("PageSize"):
+            self.PageSize = params.get("PageSize")
+
+
+class ListAlarmEffectInstanceRequest(AbstractModel):
+    """ListAlarmEffectInstance请求参数结构体
+    """
+
+    def __init__(self):
+        r"""获取故障影响实例列表
+        :param StartTime: 开始时间。
+        :type PathPrefix: Int
+        :param EndTime: 结束时间。
+        :type PathPrefix: Int
+        :param PageIndex: 页数。
+        :type PathPrefix: Int
+        :param PageSize: 每页显示最大数量。
+        :type PathPrefix: Int
+        """
+        self.StartTime = None
+        self.EndTime = None
+        self.PageIndex = None
+        self.PageSize = None
+
+    def _deserialize(self, params):
+        if params.get("StartTime"):
+            self.StartTime = params.get("StartTime")
+        if params.get("EndTime"):
+            self.EndTime = params.get("EndTime")
+        if params.get("PageIndex"):
+            self.PageIndex = params.get("PageIndex")
+        if params.get("PageSize"):
+            self.PageSize = params.get("PageSize")
+
+