|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +# Copyright (c) Alibaba, Inc. and its affiliates. |
| 3 | +"""Security center read interface. |
| 4 | +
|
| 5 | +Exposes the two highest-value read endpoints: ``GET /security/overview`` |
| 6 | +(24h dashboard) and ``GET /security/agent_logs`` (alert list). Other |
| 7 | +security endpoints (asset summary, policies, alert detail, export, |
| 8 | +authorization, activation) are not surfaced here. |
| 9 | +""" |
| 10 | + |
| 11 | +from __future__ import annotations |
| 12 | + |
| 13 | +from typing import Any, Mapping, Optional, Sequence |
| 14 | + |
| 15 | +from dashscope.agentstudio.types import SecurityAlertList, SecurityOverview |
| 16 | +from dashscope.agentstudio.types.params import SecurityListAgentLogsParams |
| 17 | + |
| 18 | +_PATH_SECURITY_OVERVIEW = "/security/overview" |
| 19 | +_PATH_SECURITY_AGENT_LOGS = "/security/agent_logs" |
| 20 | + |
| 21 | + |
| 22 | +def _overview_from_payload(payload: Mapping[str, Any]) -> SecurityOverview: |
| 23 | + return SecurityOverview(**dict(payload)) |
| 24 | + |
| 25 | + |
| 26 | +def _alert_list_from_payload(payload: Mapping[str, Any]) -> SecurityAlertList: |
| 27 | + return SecurityAlertList(**dict(payload)) |
| 28 | + |
| 29 | + |
| 30 | +class Security: |
| 31 | + """Security center read interface (overview + agent logs).""" |
| 32 | + |
| 33 | + def __init__(self, client) -> None: |
| 34 | + self._client = client |
| 35 | + |
| 36 | + def overview(self) -> SecurityOverview: |
| 37 | + """24h protection dashboard (``GET /security/overview``).""" |
| 38 | + resp = self._client.transport.request( |
| 39 | + "GET", |
| 40 | + _PATH_SECURITY_OVERVIEW, |
| 41 | + ) |
| 42 | + return _overview_from_payload(resp.data) |
| 43 | + |
| 44 | + def list_agent_logs( |
| 45 | + self, |
| 46 | + *, |
| 47 | + current_page: Optional[int] = None, |
| 48 | + page_size: Optional[int] = None, |
| 49 | + risk_level: Optional[str] = None, |
| 50 | + status: Optional[str] = None, |
| 51 | + risk_name: Optional[str] = None, |
| 52 | + app_name: Optional[str] = None, |
| 53 | + asset_type: Optional[str] = None, |
| 54 | + vendor: Optional[str] = None, |
| 55 | + order_by: Optional[str] = None, |
| 56 | + order: Optional[str] = None, |
| 57 | + lang: Optional[str] = None, |
| 58 | + status_list: Optional[Sequence[str]] = None, |
| 59 | + ) -> SecurityAlertList: |
| 60 | + """Alert list (``GET /security/agent_logs``). |
| 61 | +
|
| 62 | + Page-number pagination: pass ``current_page + 1`` for the next |
| 63 | + page, or use the returned ``next_page`` cursor if non-null. |
| 64 | + ``check_time`` / ``handle_time`` on rows are millisecond strings. |
| 65 | + """ |
| 66 | + params = SecurityListAgentLogsParams( |
| 67 | + current_page=current_page, |
| 68 | + page_size=page_size, |
| 69 | + risk_level=risk_level, |
| 70 | + status=status, |
| 71 | + risk_name=risk_name, |
| 72 | + app_name=app_name, |
| 73 | + asset_type=asset_type, |
| 74 | + vendor=vendor, |
| 75 | + order_by=order_by, |
| 76 | + order=order, |
| 77 | + lang=lang, |
| 78 | + status_list=status_list, |
| 79 | + ).to_dict() |
| 80 | + resp = self._client.transport.request( |
| 81 | + "GET", |
| 82 | + _PATH_SECURITY_AGENT_LOGS, |
| 83 | + params=params, |
| 84 | + ) |
| 85 | + return _alert_list_from_payload(resp.data) |
| 86 | + |
| 87 | + |
| 88 | +class AsyncSecurity: |
| 89 | + """Async security center read interface.""" |
| 90 | + |
| 91 | + def __init__(self, client) -> None: |
| 92 | + self._client = client |
| 93 | + |
| 94 | + async def overview(self) -> SecurityOverview: |
| 95 | + resp = await self._client.transport.request( |
| 96 | + "GET", |
| 97 | + _PATH_SECURITY_OVERVIEW, |
| 98 | + ) |
| 99 | + return _overview_from_payload(resp.data) |
| 100 | + |
| 101 | + async def list_agent_logs( |
| 102 | + self, |
| 103 | + *, |
| 104 | + current_page: Optional[int] = None, |
| 105 | + page_size: Optional[int] = None, |
| 106 | + risk_level: Optional[str] = None, |
| 107 | + status: Optional[str] = None, |
| 108 | + risk_name: Optional[str] = None, |
| 109 | + app_name: Optional[str] = None, |
| 110 | + asset_type: Optional[str] = None, |
| 111 | + vendor: Optional[str] = None, |
| 112 | + order_by: Optional[str] = None, |
| 113 | + order: Optional[str] = None, |
| 114 | + lang: Optional[str] = None, |
| 115 | + status_list: Optional[Sequence[str]] = None, |
| 116 | + ) -> SecurityAlertList: |
| 117 | + params = SecurityListAgentLogsParams( |
| 118 | + current_page=current_page, |
| 119 | + page_size=page_size, |
| 120 | + risk_level=risk_level, |
| 121 | + status=status, |
| 122 | + risk_name=risk_name, |
| 123 | + app_name=app_name, |
| 124 | + asset_type=asset_type, |
| 125 | + vendor=vendor, |
| 126 | + order_by=order_by, |
| 127 | + order=order, |
| 128 | + lang=lang, |
| 129 | + status_list=status_list, |
| 130 | + ).to_dict() |
| 131 | + resp = await self._client.transport.request( |
| 132 | + "GET", |
| 133 | + _PATH_SECURITY_AGENT_LOGS, |
| 134 | + params=params, |
| 135 | + ) |
| 136 | + return _alert_list_from_payload(resp.data) |
0 commit comments