summaryrefslogtreecommitdiff
path: root/data/en_us/mssp/2016-12-28/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/mssp/2016-12-28/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/mssp/2016-12-28/api-docs.php')
-rw-r--r--data/en_us/mssp/2016-12-28/api-docs.php6981
1 files changed, 2529 insertions, 4452 deletions
diff --git a/data/en_us/mssp/2016-12-28/api-docs.php b/data/en_us/mssp/2016-12-28/api-docs.php
index ff02950..52d8ea1 100644
--- a/data/en_us/mssp/2016-12-28/api-docs.php
+++ b/data/en_us/mssp/2016-12-28/api-docs.php
@@ -1,165 +1,105 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'mssp',
- 'version' => '2016-12-28',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'mssp', 'version' => '2016-12-28'],
'directories' => [
- [
- 'id' => 0,
- 'title' => '其它',
- 'type' => 'directory',
- 'children' => [
- 'CreateServiceLinkedRole',
- 'DescribeServiceLinkedRole',
- 'PageServiceCustomer',
- 'GetSuspPageSummary',
- 'GetAlarmDetailById',
- 'GetVulListById',
- 'GetDetailById',
- 'GetVulPageSummary',
- 'GetDocumentSummary',
- 'GetSafetyCover',
- 'GetAttackedAssetDeal',
- 'GetWorkTaskSummary',
- 'GetSuspEventSummary',
- 'GetVulSummary',
- 'GetRecentDocument',
- 'GetBaselineSummary',
- 'GetDocumentPage',
- 'GetDocumentDownloadUrl',
- 'GetSuspEventPage',
- 'GetVulItemPage',
- 'GetUserStatus',
- 'CreateServiceWorkOrder',
- 'GetConsoleScore',
- 'GetSowList',
- 'DisposeWorkTask',
- 'DisposeServiceWorkOrder',
- 'SendCustomEvent',
- 'DeleteDjbhReport',
- 'ConfirmDjbhReport',
- ],
- ],
+ 'ConfirmDjbhReport', 'CreateServiceLinkedRole', 'CreateServiceWorkOrder', 'DeleteDjbhReport', 'DescribeServiceLinkedRole', 'DisposeServiceWorkOrder', 'DisposeWorkTask', 'GetAlarmDetailById', 'GetAttackedAssetDeal', 'GetBaselineSummary', 'GetConsoleScore', 'GetDetailById', 'GetDocumentDownloadUrl', 'GetDocumentPage', 'GetDocumentSummary', 'GetRecentDocument', 'GetSafetyCover', 'GetSowList', 'GetSuspEventPage', 'GetSuspEventSummary',
+ 'GetSuspPageSummary', 'GetUserStatus', 'GetVulItemPage', 'GetVulListById', 'GetVulPageSummary', 'GetVulSummary', 'GetWorkTaskSummary', 'PageServiceCustomer', 'SendCustomEvent',
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateServiceLinkedRole' => [
- 'summary' => 'Create Service-Linked Role',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ConfirmDjbhReport' => [
+ 'summary' => 'Confirms receipt of a classified protection evaluation report.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '83729',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeNodes' => ['FEATUREsos6B7B1Q'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Lang',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Language.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
- ],
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'Region ID.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The primary key ID of the report.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '24563', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'example' => '592B80F0-7674-56A4-9027-8A0A9ACDBD56',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EF801DD1-D934-51B3-92D4-776CE17B184F'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF801DD1-D934-51B3-92D4-776CE17B184F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => 'Confirm receipt of a classified protection evaluation report',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:ConfirmDjbhReport',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"592B80F0-7674-56A4-9027-8A0A9ACDBD56\\"\\n}","type":"json"}]',
- 'title' => 'Create Service-Linked Role',
- 'translator' => 'machine',
],
- 'DescribeServiceLinkedRole' => [
- 'summary' => 'Query Service-Linked Role',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateServiceLinkedRole' => [
+ 'summary' => 'Creates a service-linked role.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '83735',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeCode' => '83729',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => 'Language.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => 'The language.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'Region ID.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
@@ -167,1134 +107,658 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'EntityRoleGrant' => [
- 'description' => 'Whether the service-linked role permission is granted:'."\n"
- .'- true: Granted.'."\n"
- .'- false: Not granted.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'example' => '02F8BBF3-2D61-5982-8911-EEB387BE3AF8',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '592B80F0-7674-56A4-9027-8A0A9ACDBD56', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EntityRoleGrant\\": true,\\n \\"RequestId\\": \\"02F8BBF3-2D61-5982-8911-EEB387BE3AF8\\"\\n}","type":"json"}]',
- 'title' => 'Query Service-Linked Role',
- 'translator' => 'machine',
- ],
- 'PageServiceCustomer' => [
- 'summary' => 'Service Customer Information Query',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create a service-linked role',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:CreateServiceLinkedRole',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"592B80F0-7674-56A4-9027-8A0A9ACDBD56\\"\\n}","type":"json"}]',
+ ],
+ 'CreateServiceWorkOrder' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '173423',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeCode' => '216184',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
],
'parameters' => [
[
- 'name' => 'CurrentPage',
+ 'name' => 'WorkOrderName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The name of the ticket.', 'type' => 'string', 'required' => true, 'example' => '安全月报交付任务'],
+ ],
+ [
+ 'name' => 'WorkOrderType',
'in' => 'formData',
'schema' => [
- 'description' => 'The page number of the query result, default is 1.',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'The type of the ticket.',
+ 'enumValueTitles' => [
+ 'YEAR_MEETING' => 'annual meeting.', 'SYSTEM_VULNERABILITY_SCAN' => 'scanner vulnerability scan.', 'RISK_BRIEFING' => 'risk briefing.', 'SUMMARY_REPORT' => 'summary report.', 'DING_TALK_CUSTOMER' => 'DingTalk customer consultation.', 'MONTH_REPORT' => 'monthly report.', 'YEAR_REPORT' => 'annual report.', 'OTHER_REPORTS' => 'other reports.', 'PLATFORM_VULNERABILITY_MONITOR' => 'vulnerability inspection and monitoring.', 'PROJECT_PLAN' => 'project plan.',
+ 'PROJECT_SUMMARY_MEETING' => 'project summary meeting.', 'SYSTEM_SECURITY_ACCESS' => 'security assessment.', 'PROJECT_QUARTERLY_MEETING' => 'project quarterly meeting.', 'LARGE_SCREEN' => 'security dashboard.', 'USER_SURVEY' => 'user survey.', 'CUSTOMER_VIEW' => 'customer follow-up.', 'MANUAL' => 'manual operation.', 'RISK_NOTIFY' => 'risk notification.', 'QUARTERLY_REPORT' => 'quarterly report.', 'YUNDUN_VULNERABILITY_SCAN' => 'Security Center vulnerability scan.',
+ 'PROJECT_LAUNCH_MEETING' => 'project launch meeting.',
+ ],
+ 'type' => 'string',
'required' => true,
- 'example' => '1',
+ 'example' => 'MONTH_REPORT',
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'WorkOrderSource',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The source of the ticket.', 'type' => 'string', 'required' => true, 'example' => '工单迁移'],
+ ],
+ [
+ 'name' => 'WorkOrderStatus',
'in' => 'formData',
'schema' => [
- 'description' => 'Number of records per page.',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'The status of the ticket.',
+ 'enumValueTitles' => ['UNPROCESSED' => 'pending.', 'PROCESSING' => 'processing.', 'BACK' => 'returned.', 'PROCESSED' => 'completed.', 'INVALID' => 'false positive.', 'IGNORED' => 'ignored.'],
+ 'type' => 'string',
'required' => true,
- 'example' => '10',
+ 'example' => 'UNPROCESSED',
],
],
[
+ 'name' => 'CustomerId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ID of the customer.', 'type' => 'string', 'required' => true, 'example' => '1477832102462645'],
+ ],
+ [
'name' => 'StartTime',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Start time. The format is a Unix timestamp, which is the number of milliseconds since January 1, 1970.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1710641101000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1734788109000'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'Operator',
'in' => 'formData',
- 'schema' => [
- 'description' => 'End time. The format is a Unix timestamp, which is the number of milliseconds since January 1, 1970.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1710641101123',
- ],
+ 'schema' => ['title' => '', 'description' => 'The operator.', 'type' => 'string', 'required' => true, 'example' => '426556'],
],
[
- 'name' => 'AuthStatus',
+ 'name' => 'OperateType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The type of the operation.', 'type' => 'string', 'required' => true, 'example' => 'CREATE'],
+ ],
+ [
+ 'name' => 'OperateRemark',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The remarks for the operation.', 'type' => 'string', 'required' => true, 'example' => '新建'],
+ ],
+ [
+ 'name' => 'WorkOrderDetail',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The details of the ticket.', 'type' => 'string', 'required' => true, 'example' => '{"questionDetail":"测试工单","answerDetail":""}'],
+ ],
+ [
+ 'name' => 'DurationDay',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The duration in days.', 'type' => 'string', 'required' => true, 'example' => '5'],
+ ],
+ [
+ 'name' => 'IsAttachment',
'in' => 'formData',
'schema' => [
- 'description' => 'Authorization status.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 1 => '授权',
- 9 => '未授权',
- ],
- 'example' => '1',
+ 'title' => '',
+ 'description' => 'The attachment requirement.',
+ 'enumValueTitles' => ['Y' => 'yes.', 'N' => 'no.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Y',
],
],
[
- 'name' => 'MonitorAuthStatus',
+ 'name' => 'IsWorkOrderNotify',
'in' => 'formData',
'schema' => [
- 'description' => 'Cloud Security - Alert authorization status.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 1 => '授权',
- 9 => '未授权',
- ],
- 'example' => '1',
+ 'title' => '',
+ 'description' => 'Specifies whether a reminder notification is required.',
+ 'enumValueTitles' => ['Y' => 'yes.', 'N' => 'no.'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Y',
],
],
[
- 'name' => 'CmAuthStatus',
+ 'name' => 'NotifyDay',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The number of days in advance to send a reminder notification.', 'type' => 'string', 'required' => false, 'example' => '5'],
+ ],
+ [
+ 'name' => 'Creator',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The creator of the ticket.', 'type' => 'string', 'required' => true, 'example' => '426556'],
+ ],
+ [
+ 'name' => 'NotifyId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ID of the notification.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'IsMilestone',
'in' => 'formData',
'schema' => [
- 'description' => 'Cloud Monitoring - Alert authorization status.',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'Specifies whether this is a milestone.',
+ 'enumValueTitles' => ['Y' => 'yes.', 'N' => 'no.'],
+ 'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- '未授权',
- '授权',
- ],
- 'example' => '1',
+ 'example' => 'Y',
+ 'title' => '',
],
],
+ [
+ 'name' => 'Priority',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'PageInfo' => [
- 'description' => 'Pagination information.',
+ 'Data' => [
+ 'description' => 'The data returned by the operation.',
'type' => 'object',
'properties' => [
- 'CurrentPage' => [
- 'description' => 'The current page number in pagination queries.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'Number of items per page.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => 'Total number of query results.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- ],
- ],
- 'Data' => [
- 'description' => 'Data query results.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Query result object.',
- 'type' => 'object',
- 'properties' => [
- 'UserId' => [
- 'description' => 'Customer ID.',
- 'type' => 'string',
- 'example' => '1667751131382856',
- ],
- 'Aliuid' => [
- 'description' => 'Customer UID.',
- 'type' => 'string',
- 'example' => '1667751131382856',
- ],
- 'Name' => [
- 'description' => 'Customer name.',
- 'type' => 'string',
- 'example' => '中国工程院',
- ],
- 'OwnId' => [
- 'description' => 'Owner name.',
- 'type' => 'string',
- 'example' => '常温',
- ],
- 'Level' => [
- 'description' => 'Customer level.',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'GC1' => 'GC1',
- 'GC3' => 'GC3',
- 'GC2' => 'GC2',
- 'GC5' => 'GC5',
- 'GC4' => 'GC4',
- 'GC7' => 'GC7',
- 'GC6' => 'GC6',
- ],
- 'example' => 'GC1',
- ],
- 'Version' => [
- 'description' => 'Version information.',
- 'type' => 'string',
- 'example' => '企业版',
- ],
- 'AuthStatus' => [
- 'description' => 'Authorization status.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- 1 => '已授权',
- 9 => '未授权',
- ],
- 'example' => '1',
- ],
- 'MonitorAuthStatus' => [
- 'description' => 'Cloud Security - Alert authorization status.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- 1 => '已授权',
- 9 => '未授权',
- ],
- 'example' => '1',
- ],
- 'CmAuthStatus' => [
- 'description' => 'Cloud Monitoring - Alert authorization status.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- '未授权',
- '已授权',
- ],
- 'example' => '0',
- ],
- 'StartTime' => [
- 'description' => 'Start time. The format is a Unix timestamp, which is the number of milliseconds since January 1, 1970.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1710123149000',
- ],
- 'EndTime' => [
- 'description' => 'End time. The format is a Unix timestamp, which is the number of milliseconds since January 1, 1970.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1710123149222',
- ],
- ],
+ 'Id' => ['title' => '', 'description' => 'The primary key.', 'type' => 'integer', 'format' => 'int64', 'example' => '1978941'],
+ 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1734788109000'],
+ 'WorkOrderName' => ['title' => '', 'description' => 'The name of the ticket.', 'type' => 'string', 'example' => '安全月报交付任务'],
+ 'WorkOrderType' => ['title' => '', 'description' => 'The type of the ticket.', 'type' => 'string', 'example' => 'MONTH_REPORT'],
+ 'WorkOrderSource' => ['title' => '', 'description' => 'The source of the ticket.', 'type' => 'string', 'example' => '工单迁移'],
+ 'CustomerId' => ['title' => '', 'description' => 'The ID of the customer.', 'type' => 'string', 'example' => '1477832102462645'],
+ 'StartTime' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1734788109000'],
+ 'EndTime' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1734788109000'],
+ 'CompleteTime' => ['title' => '', 'description' => 'The completion time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1734788109000'],
+ 'WorkOrderStatus' => ['title' => '', 'description' => 'The status of the ticket.', 'type' => 'string', 'example' => 'UNPROCESSED'],
+ 'OwnerId' => ['title' => '', 'description' => 'The owner.', 'type' => 'string', 'example' => '426556'],
+ 'WorkOrderDetail' => ['title' => '', 'description' => 'The details of the ticket.', 'type' => 'string', 'example' => '{"questionDetail":"测试工单","answerDetail":""}'."\n"],
+ 'Creator' => ['title' => '', 'description' => 'The creator of the ticket.', 'type' => 'string', 'example' => '426556'],
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '808A307F-9513-5099-AAA5-98D4EF199140',
- ],
- 'Code' => [
- 'description' => 'Interface return code.',
- 'type' => 'string',
- 'example' => 'System error or openapi error',
- ],
- 'Message' => [
- 'description' => 'Return message. When the request is successful, it returns a success message; when the request fails, it returns the reason for the failure.',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Request return status.'."\n"
- .'- true: Success.'."\n"
- .'- false: Failure.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '7DC44321-7AAE-51CD-8E5F-CEB968569042'],
+ 'Code' => ['description' => 'The status code of the operation.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The call was successful.'."\n"
+ ."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100\\n },\\n \\"Data\\": [\\n {\\n \\"UserId\\": \\"1667751131382856\\",\\n \\"Aliuid\\": \\"1667751131382856\\",\\n \\"Name\\": \\"中国工程院\\",\\n \\"OwnId\\": \\"常温\\",\\n \\"Level\\": \\"GC1\\",\\n \\"Version\\": \\"企业版\\",\\n \\"AuthStatus\\": 1,\\n \\"MonitorAuthStatus\\": 1,\\n \\"CmAuthStatus\\": 0,\\n \\"StartTime\\": 1710123149000,\\n \\"EndTime\\": 1710123149222\\n }\\n ],\\n \\"RequestId\\": \\"808A307F-9513-5099-AAA5-98D4EF199140\\",\\n \\"Code\\": \\"System error or openapi error\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Service Customer Information Query',
- 'translator' => 'machine',
- ],
- 'GetSuspPageSummary' => [
- 'summary' => 'Alarm Page Statistics',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Create a service ticket',
+ 'summary' => 'Creates a service ticket.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:CreateServiceWorkOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 1978941,\\n \\"CreateTime\\": 1734788109000,\\n \\"WorkOrderName\\": \\"安全月报交付任务\\",\\n \\"WorkOrderType\\": \\"MONTH_REPORT\\",\\n \\"WorkOrderSource\\": \\"工单迁移\\",\\n \\"CustomerId\\": \\"1477832102462645\\",\\n \\"StartTime\\": 1734788109000,\\n \\"EndTime\\": 1734788109000,\\n \\"CompleteTime\\": 1734788109000,\\n \\"WorkOrderStatus\\": \\"UNPROCESSED\\",\\n \\"OwnerId\\": \\"426556\\",\\n \\"WorkOrderDetail\\": \\"{\\\\\\"questionDetail\\\\\\":\\\\\\"测试工单\\\\\\",\\\\\\"answerDetail\\\\\\":\\\\\\"\\\\\\"}\\\\n\\",\\n \\"Creator\\": \\"426556\\"\\n },\\n \\"RequestId\\": \\"7DC44321-7AAE-51CD-8E5F-CEB968569042\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteDjbhReport' => [
+ 'summary' => 'Deletes a classified protection evaluation report.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '180003',
- 'abilityTreeNodes' => [
- 'FEATUREsos0FVTHS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsos6B7B1Q'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [],
+ 'parameters' => [
+ [
+ 'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The primary key ID of the report.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '26579', 'title' => ''],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => 'Data returned by the interface.',
- 'type' => 'object',
- 'properties' => [
- 'WaitHandleCount' => [
- 'title' => '未处理数量',
- 'description' => 'Number of unhandled items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'HandingCount' => [
- 'title' => '处理中的数量',
- 'description' => 'Number of items being processed.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'CompletedCount' => [
- 'title' => '处理完成的数量',
- 'description' => 'Number of completed items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总数量',
- 'description' => 'Total number of items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '30',
- ],
- 'HighCount' => [
- 'title' => '高风险数量',
- 'description' => 'Number of high-risk items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'MediumCount' => [
- 'title' => '中风险数量',
- 'description' => 'Number of medium-risk items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'LowCount' => [
- 'title' => '低风险数量',
- 'description' => 'Number of low-risk items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'EF801DD1-D934-51B3-92D4-776CE17B184F',
- ],
- 'Code' => [
- 'description' => 'Interface response code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Prompt message for the result returned.',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the call was successful.'."\n"
- .'- **true**: Call succeeded.'."\n"
- .'- **false**: Call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '86786E4C-6416-55CF-9AB6-5E275B68801D'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86786E4C-6416-55CF-9AB6-5E275B68801D\\",\\n \\"Code\\": \\"successful\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a classified protection evaluation report',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:DeleteDjbhReport',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"WaitHandleCount\\": 10,\\n \\"HandingCount\\": 10,\\n \\"CompletedCount\\": 10,\\n \\"TotalCount\\": 30,\\n \\"HighCount\\": 10,\\n \\"MediumCount\\": 10,\\n \\"LowCount\\": 10\\n },\\n \\"RequestId\\": \\"EF801DD1-D934-51B3-92D4-776CE17B184F\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Alarm Page Statistics',
- 'translator' => 'machine',
],
- 'GetAlarmDetailById' => [
- 'summary' => 'Query Alarm Details',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeServiceLinkedRole' => [
+ 'summary' => 'Queries the service-linked role.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '179907',
- 'abilityTreeNodes' => [
- 'FEATUREsos0FVTHS',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '83735',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
],
'parameters' => [
[
- 'name' => 'Id',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '主键id',
- 'description' => 'Primary key ID.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '20077761',
- ],
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The language.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => 'Data returned by the interface.',
- 'type' => 'object',
- 'properties' => [
- 'EventDetails' => [
- 'title' => '事件详情信息',
- 'description' => 'Event details information.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Data object.',
- 'type' => 'object',
- 'properties' => [
- 'NameDisplay' => [
- 'title' => '告警事件显示名称',
- 'description' => 'Alarm event display name.',
- 'type' => 'string',
- 'example' => 'Login with unusual location',
- ],
- 'ValueDisplay' => [
- 'title' => '告警事件发生路径',
- 'description' => 'Path where the alarm event occurred.',
- 'type' => 'string',
- 'example' => '/etc/crontab',
- ],
- 'Type' => [
- 'title' => '告警事件类型',
- 'description' => 'Alarm event type.',
- 'type' => 'string',
- 'example' => 'text',
- ],
- 'Value' => [
- 'title' => '告警事件发生路径',
- 'description' => 'Path where the alarm event occurred.',
- 'type' => 'string',
- 'example' => '/etc/crontab',
- ],
- ],
- ],
- ],
- 'Desc' => [
- 'title' => '描述',
- 'description' => 'Description.',
- 'type' => 'string',
- 'example' => 'webshell',
- ],
- 'TacticDisplayName' => [
- 'title' => 'ATT&CK的战术名称。',
- 'description' => 'ATT&CK tactic name.',
- 'type' => 'string',
- 'example' => 'Malicious scripts-Malicious script code execution',
- ],
- 'AlarmEventTypeDisplay' => [
- 'title' => '告警事件类型',
- 'description' => 'Alarm event type.',
- 'type' => 'string',
- 'example' => 'Login with unusual location',
- ],
- 'ContainHwMode' => [
- 'title' => '重保模式',
- 'description' => 'Whether high-protection mode is enabled. true means enabled, false means not enabled.',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'AlarmId' => [
- 'title' => '告警id',
- 'description' => 'Alarm ID.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '202427220',
- ],
- 'AlarmSource' => [
- 'title' => '告警来源',
- 'description' => 'Alarm source.',
- 'type' => 'string',
- 'example' => 'SUSP_EVENT',
- ],
- 'AlarmName' => [
- 'title' => '告警名称',
- 'description' => 'Alarm name.',
- 'type' => 'string',
- 'example' => '负载均衡可挂载服务器数量告警',
- ],
- 'AlarmTime' => [
- 'title' => '最新告警时间',
- 'description' => 'Latest alarm time.',
- 'type' => 'string',
- 'example' => '2018-09-26 01:51:01',
- ],
- 'DealTime' => [
- 'title' => '告警处理时间',
- 'description' => 'Alarm handling time.',
- 'type' => 'string',
- 'example' => '2018-09-26 01:51:01',
- ],
- 'Status' => [
- 'title' => '处理状态',
- 'description' => 'Handling status.',
- 'type' => 'string',
- 'example' => '要查询的告警事件状态。取值：'."\n"
- ."\n"
- .'0：全部'."\n"
- .'1：待处理'."\n"
- .'2：已忽略'."\n"
- .'4：已确认'."\n"
- .'8：已标记为误报'."\n"
- .'16：处理中'."\n"
- .'32：处理完毕'."\n"
- .'64：已经过期'."\n"
- .'128：已经删除'."\n"
- .'512：自动拦截中'."\n"
- .'513：自动拦截完毕',
- ],
- 'OwnerId' => [
- 'title' => '负责人',
- 'description' => 'Owner.',
- 'type' => 'string',
- 'example' => '324546',
- ],
- 'Remark' => [
- 'title' => '处置方式',
- 'description' => 'Disposal method.',
- 'type' => 'string',
- 'example' => '192.168.XX.XX',
- ],
- 'InstanceName' => [
- 'title' => '受影响资产',
- 'description' => 'Affected asset.',
- 'type' => 'string',
- 'example' => 'nginx',
- ],
- 'EventLevel' => [
- 'title' => '告警等级',
- 'description' => 'Alarm level.',
- 'type' => 'string',
- 'example' => 'suspicious',
- ],
- 'OccurrenceTime' => [
- 'title' => '首次发生时间',
- 'description' => 'First occurrence time',
- 'type' => 'string',
- 'example' => '2018-09-26 01:51:01',
- ],
- 'InternetIp' => [
- 'title' => '公网ip',
- 'description' => 'Public IP.',
- 'type' => 'string',
- 'example' => '47.116.126.79',
- ],
- 'IntranetIp' => [
- 'title' => '内网ip',
- 'description' => 'Private IP.',
- 'type' => 'string',
- 'example' => '172.19.195.176',
- ],
- 'Id' => [
- 'title' => '工单主键id',
- 'description' => 'Primary key ID of the work order.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '9772',
- ],
- 'AlarmEventType' => [
- 'title' => '告警事件类型',
- 'description' => 'Alarm event type.',
- 'type' => 'string',
- 'example' => 'Unusual Logon',
- ],
- 'AnalysisResult' => [
- 'title' => '分析过程',
- 'description' => 'Analysis process.',
- 'type' => 'string',
- 'example' => '[{"value":"服务器可能已被黑客攻击，存在恶意进程在运行。 分析过程：告警显示，服务端存在一个名为”dns.exe”的进程在访问”polling.burpcollaborator.net”，这是一个被黑名单列出的恶意域名。在正常情况下,”dns.exe”不应该单独存在于系统的路径下，并且也不应该访问这类恶意域名。因此，这个进程可能是黑客留下的恶意进程。","key":"结论"},{"value":"尽快对服务器进行全面扫描，清除恶意进程。同时，联系网络安全专家进行深入调查，以确定是否有其他潜在的安全威胁。","key":"处置建议"}]',
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '5C1B0668-442C-57AE-9668-D894B0B012EB',
- ],
- 'Code' => [
- 'description' => 'API response code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Return message.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the operation was successful: - true: Success. - false: Failure.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'EntityRoleGrant' => ['description' => 'Indicates whether the service-linked role permission is granted. Valid values:'."\n"
+ .'- true: Granted.'."\n"
+ .'- false: Not granted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '02F8BBF3-2D61-5982-8911-EEB387BE3AF8', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"EventDetails\\": [\\n {\\n \\"NameDisplay\\": \\"Login with unusual location\\",\\n \\"ValueDisplay\\": \\"/etc/crontab\\",\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"/etc/crontab\\"\\n }\\n ],\\n \\"Desc\\": \\"webshell\\",\\n \\"TacticDisplayName\\": \\"Malicious scripts-Malicious script code execution\\",\\n \\"AlarmEventTypeDisplay\\": \\"Login with unusual location\\",\\n \\"ContainHwMode\\": false,\\n \\"AlarmId\\": 202427220,\\n \\"AlarmSource\\": \\"SUSP_EVENT\\",\\n \\"AlarmName\\": \\"负载均衡可挂载服务器数量告警\\",\\n \\"AlarmTime\\": \\"2018-09-26 01:51:01\\",\\n \\"DealTime\\": \\"2018-09-26 01:51:01\\",\\n \\"Status\\": \\"要查询的告警事件状态。取值：\\\\n\\\\n0：全部\\\\n1：待处理\\\\n2：已忽略\\\\n4：已确认\\\\n8：已标记为误报\\\\n16：处理中\\\\n32：处理完毕\\\\n64：已经过期\\\\n128：已经删除\\\\n512：自动拦截中\\\\n513：自动拦截完毕\\",\\n \\"OwnerId\\": \\"324546\\",\\n \\"Remark\\": \\"192.168.XX.XX\\",\\n \\"InstanceName\\": \\"nginx\\",\\n \\"EventLevel\\": \\"suspicious\\",\\n \\"OccurrenceTime\\": \\"2018-09-26 01:51:01\\",\\n \\"InternetIp\\": \\"47.116.126.79\\",\\n \\"IntranetIp\\": \\"172.19.195.176\\",\\n \\"Id\\": 9772,\\n \\"AlarmEventType\\": \\"Unusual Logon\\",\\n \\"AnalysisResult\\": \\"[{\\\\\\"value\\\\\\":\\\\\\"服务器可能已被黑客攻击，存在恶意进程在运行。 分析过程：告警显示，服务端存在一个名为”dns.exe”的进程在访问”polling.burpcollaborator.net”，这是一个被黑名单列出的恶意域名。在正常情况下,”dns.exe”不应该单独存在于系统的路径下，并且也不应该访问这类恶意域名。因此，这个进程可能是黑客留下的恶意进程。\\\\\\",\\\\\\"key\\\\\\":\\\\\\"结论\\\\\\"},{\\\\\\"value\\\\\\":\\\\\\"尽快对服务器进行全面扫描，清除恶意进程。同时，联系网络安全专家进行深入调查，以确定是否有其他潜在的安全威胁。\\\\\\",\\\\\\"key\\\\\\":\\\\\\"处置建议\\\\\\"}]\\"\\n },\\n \\"RequestId\\": \\"5C1B0668-442C-57AE-9668-D894B0B012EB\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Query Alarm Details',
- 'translator' => 'machine',
- ],
- 'GetVulListById' => [
- 'summary' => 'Query processed details',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Query service-linked role',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:DescribeServiceLinkedRole',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EntityRoleGrant\\": true,\\n \\"RequestId\\": \\"02F8BBF3-2D61-5982-8911-EEB387BE3AF8\\"\\n}","type":"json"}]',
+ ],
+ 'DisposeServiceWorkOrder' => [
+ 'summary' => 'Processes a service ticket.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '179781',
- 'abilityTreeNodes' => [
- 'FEATUREsosYT8XCW',
- ],
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '226218',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
],
'parameters' => [
[
- 'name' => 'CurrentPage',
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前页',
- 'description' => 'Current page',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The ticket ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23172'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'WorkOrderName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ticket name.', 'type' => 'string', 'required' => true, 'example' => '安全产品配置问题与超量提醒'],
+ ],
+ [
+ 'name' => 'WorkOrderStatus',
'in' => 'formData',
'schema' => [
- 'title' => '每页大小',
- 'description' => 'Page size',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'The ticket status.',
+ 'enumValueTitles' => ['UNPROCESSED' => 'Pending.', 'PROCESSING' => 'Processing.', 'BACK' => 'Returned.', 'PROCESSED' => 'Processed.', 'INVALID' => 'False positive.', 'IGNORED' => 'Ignored.'],
+ 'type' => 'string',
'required' => false,
- 'example' => '10',
+ 'example' => 'PROCESSED',
],
],
[
- 'name' => 'Id',
+ 'name' => 'Operator',
'in' => 'formData',
- 'schema' => [
- 'title' => '主键id',
- 'description' => 'Primary key ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '4209205',
- ],
+ 'schema' => ['title' => '', 'description' => 'The operator.', 'type' => 'string', 'required' => true, 'example' => '396120'],
],
[
- 'name' => 'Dealed',
+ 'name' => 'OperateType',
'in' => 'formData',
'schema' => [
- 'title' => '是否已处理；y:已处理；n:未处理',
- 'description' => 'Whether it has been processed; y: processed; n: not processed',
+ 'title' => '',
+ 'description' => 'The operation type.',
+ 'enumValueTitles' => ['SECURITY_CONSULTATION_ANSWERS' => 'Security consultation - answer.', 'CREATE' => 'Create.', 'FIELD_CHANGE' => 'Field change.', 'UPGRADE' => 'Upgrade.', 'PROCESSED' => 'Processed.', 'BACK' => 'Return.', 'FORWARD' => 'Forward.', 'DELAY' => 'Delay.', 'START_PROCESSING' => 'Start processing.'],
'type' => 'string',
- 'required' => false,
- 'example' => 'n',
+ 'required' => true,
+ 'example' => 'PROCESSED',
],
],
[
- 'name' => 'Necessity',
+ 'name' => 'OperateRemark',
'in' => 'formData',
- 'schema' => [
- 'title' => '风险等级',
- 'description' => 'Risk level',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'asap,later,nntf',
- ],
+ 'schema' => ['title' => '', 'description' => 'The operation remarks.', 'type' => 'string', 'required' => true, 'example' => '处理完成'],
],
[
- 'name' => 'Remark',
+ 'name' => 'ForwardOwnerId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The forward recipient.', 'type' => 'string', 'required' => false, 'example' => '405639'],
+ ],
+ [
+ 'name' => 'UpgradeOwnerId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The upgrade recipient.', 'type' => 'string', 'required' => false, 'example' => '336333'],
+ ],
+ [
+ 'name' => 'IsAttachment',
'in' => 'formData',
'schema' => [
- 'title' => '要查询漏洞的资产信息，可以设置为资产名称、公网IP或私网IP。',
- 'description' => 'Asset information of the vulnerability to be queried, which can be set as asset name, public IP, or private IP.',
+ 'title' => '',
+ 'description' => 'Specifies whether an attachment is required.',
+ 'enumValueTitles' => ['Y' => 'yes.', 'N' => 'no.'],
'type' => 'string',
'required' => false,
- 'example' => 'production_nat_cn-hangzhou_zone_105',
+ 'example' => 'Y',
],
],
[
- 'name' => 'Uuids',
+ 'name' => 'IsWorkOrderNotify',
'in' => 'formData',
'schema' => [
- 'title' => '要查询漏洞的服务器的UUID，多个UUID之间使用半角逗号（,）分隔',
- 'description' => 'UUID of the server with the vulnerability to be queried. Multiple UUIDs should be separated by a comma (,).',
+ 'title' => '',
+ 'description' => 'The ticket notification.',
+ 'enumValueTitles' => ['Y' => 'yes.', 'N' => 'no.'],
'type' => 'string',
'required' => false,
- 'example' => '3615b908-995a-4edb-bc85-1981b4e94ba0,9c52cf9a-d8ba-4e31-ae06-500b879ee4e6,4b7de3cf-c4ac-42fc-8804-35070493dc29,f3c01525-0777-4c97-88d9-bec11afd4a6a,a80bd516-c4f3-4c27-a169-c8abfaf9e89e',
+ 'example' => 'Y',
],
],
+ [
+ 'name' => 'AttachmentName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The attachment name.', 'type' => 'string', 'required' => false, 'example' => 'bbaa133c-0ac2-489f-9fc8-39f91c2e770c_20230301-20240403-服务工单列表.xlsx'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1733788109000'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1734788109000'],
+ ],
+ [
+ 'name' => 'NotifyId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The notification ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'WorkOrderDetail',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The ticket details.', 'type' => 'string', 'required' => false, 'example' => '{"questionDetail":"测试工单","answerDetail":""}'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'PageInfo' => [
- 'description' => 'Pagination information.',
- 'type' => 'object',
- 'properties' => [
- 'CurrentPage' => [
- 'description' => 'Current page number.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'Number of items per page in the returned data.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => 'Total number of records in the query result.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- ],
- ],
- 'Data' => [
- 'description' => 'Data returned by the interface.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Data object.',
- 'type' => 'object',
- 'properties' => [
- 'Necessity' => [
- 'title' => '漏洞修复必要性等级',
- 'description' => 'Necessity level of vulnerability repair',
- 'type' => 'string',
- 'example' => 'later,asap,nntf',
- ],
- 'RepairTs' => [
- 'title' => '漏洞修复时间戳',
- 'description' => 'Timestamp of vulnerability repair',
- 'type' => 'string',
- 'example' => '1541207563000',
- ],
- 'Uuid' => [
- 'title' => '资产实例的UUID。',
- 'description' => 'UUID of the asset instance.',
- 'type' => 'string',
- 'example' => 'hdm_5cf2eaf263c021b354877943f181956d',
- ],
- 'Status' => [
- 'title' => '漏洞状态',
- 'description' => 'Vulnerability status:'."\n"
- .'1: Not fixed'."\n"
- .'2: Fix failed'."\n"
- .'3: Rollback failed'."\n"
- .'4: Fixing'."\n"
- .'5: Rolling back'."\n"
- .'6: Verifying'."\n"
- .'7: Fixed successfully'."\n"
- .'8: Fixed successfully, pending reboot'."\n"
- .'9: Rolled back successfully'."\n"
- .'10: Ignored'."\n"
- .'11: Rolled back successfully, pending reboot'."\n"
- .'12: Vulnerability does not exist'."\n"
- .'20: Expired',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'InternetIp' => [
- 'title' => '资产公网IP',
- 'description' => 'Public IP of the asset',
- 'type' => 'string',
- 'example' => '39.101.73.28',
- ],
- 'Tag' => [
- 'title' => '漏洞标签',
- 'description' => 'Vulnerability tag',
- 'type' => 'string',
- 'example' => 'Restart Required',
- ],
- 'Name' => [
- 'title' => '漏洞名称',
- 'description' => 'Vulnerability name',
- 'type' => 'string',
- 'example' => 'SCA:ACSV-2020-111301',
- ],
- 'Related' => [
- 'title' => '漏洞关联的CVE列表，有多个取值时用半角逗号（,）分隔',
- 'description' => 'List of associated CVEs for the vulnerability, separated by commas (,) if there are multiple values.',
- 'type' => 'string',
- 'example' => 'CVE-2020-13935',
- ],
- 'IntranetIp' => [
- 'title' => '资产私网IP',
- 'description' => 'Private IP of the asset',
- 'type' => 'string',
- 'example' => '172.22.216.17',
- ],
- 'LastTs' => [
- 'title' => '最后发现漏洞的时间戳',
- 'description' => 'Timestamp of the last time the vulnerability was detected',
- 'type' => 'string',
- 'example' => '1620404763000',
- ],
- 'FirstTs' => [
- 'title' => '首次发现漏洞的时间戳',
- 'description' => 'Timestamp of the first time the vulnerability was detected',
- 'type' => 'string',
- 'example' => '1620404763000',
- ],
- 'AliasName' => [
- 'title' => '漏洞别名',
- 'description' => 'Vulnerability Alias',
- 'type' => 'string',
- 'example' => 'Tomcat websocket 拒绝服务漏洞利用代码披露（CVE-2020-13935）',
- ],
- 'InstanceName' => [
- 'title' => '资产实例名称',
- 'description' => 'Instance name of the asset',
- 'type' => 'string',
- 'example' => '凌星-CentOS',
- ],
- 'RepairCmd' => [
- 'title' => '修复命令',
- 'description' => 'Repair command',
- 'type' => 'string',
- 'example' => '*** update python-perf',
- ],
- 'EffectMsgDTOS' => [
- 'title' => '影响说明',
- 'description' => 'Impact description',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Data object.',
- 'type' => 'object',
- 'properties' => [
- 'SoftName' => [
- 'title' => '软件名称',
- 'description' => 'Software name',
- 'type' => 'string',
- 'example' => 'python-perf 3.10.0',
- ],
- 'MatchList' => [
- 'title' => '命中',
- 'description' => 'Hit',
- 'type' => 'string',
- 'example' => 'fastjson(jar) extendField.safemode equals false',
- ],
- 'Path' => [
- 'title' => '路径',
- 'description' => 'Path',
- 'type' => 'string',
- 'example' => '/uat6/qry/enquiry/policy/yrtPolicyList',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'D38B3D2F-67FD-57FF-87D1-C431D2C70F76',
- ],
- 'Code' => [
- 'description' => 'API response code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Prompt message for the returned result.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the call was successful. Values: - **true**: Yes. - **false**: No.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => 'ED520610-6231-5D80-BADD-A8CDC7BBC809'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100\\n },\\n \\"Data\\": [\\n {\\n \\"Necessity\\": \\"later,asap,nntf\\",\\n \\"RepairTs\\": \\"1541207563000\\",\\n \\"Uuid\\": \\"hdm_5cf2eaf263c021b354877943f181956d\\",\\n \\"Status\\": \\"1\\",\\n \\"InternetIp\\": \\"39.101.73.28\\",\\n \\"Tag\\": \\"Restart Required\\",\\n \\"Name\\": \\"SCA:ACSV-2020-111301\\",\\n \\"Related\\": \\"CVE-2020-13935\\",\\n \\"IntranetIp\\": \\"172.22.216.17\\",\\n \\"LastTs\\": \\"1620404763000\\",\\n \\"FirstTs\\": \\"1620404763000\\",\\n \\"AliasName\\": \\"Tomcat websocket 拒绝服务漏洞利用代码披露（CVE-2020-13935）\\",\\n \\"InstanceName\\": \\"凌星-CentOS\\",\\n \\"RepairCmd\\": \\"*** update python-perf\\",\\n \\"EffectMsgDTOS\\": [\\n {\\n \\"SoftName\\": \\"python-perf 3.10.0\\",\\n \\"MatchList\\": \\"fastjson(jar) extendField.safemode equals false\\",\\n \\"Path\\": \\"/uat6/qry/enquiry/policy/yrtPolicyList\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"D38B3D2F-67FD-57FF-87D1-C431D2C70F76\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Query Processed Details',
- 'translator' => 'machine',
- ],
- 'GetDetailById' => [
- 'summary' => 'Query Risk Details',
- 'methods' => [
- 'get',
- 'post',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ED520610-6231-5D80-BADD-A8CDC7BBC809\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Process a service ticket',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:DisposeServiceWorkOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DisposeWorkTask' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '179782',
- 'abilityTreeNodes' => [
- 'FEATUREsosYT8XCW',
- ],
+ 'abilityTreeCode' => '247511',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Id',
+ 'name' => 'Operator',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The operator.', 'type' => 'string', 'required' => true, 'example' => 'WB01089929', 'title' => ''],
+ ],
+ [
+ 'name' => 'TaskIds',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The ticket IDs, separated by commas.', 'type' => 'string', 'required' => true, 'example' => '10310', 'title' => ''],
+ ],
+ [
+ 'name' => 'Status',
'in' => 'formData',
'schema' => [
- 'title' => '主键id',
- 'description' => 'Primary key ID.',
+ 'description' => 'The ticket status.',
+ 'enumValueTitles' => [1 => 'pending.', 'processing.', 'completed.', 'false positive.', 'ignored.', 'under review.', 'reviewed.', 'sending - pending approval.', 'sent.', 'revoking - pending approval.', 'revoked.', 'sending failed - approval rejected.', 'revoking failed - approval rejected.', 'returned.', 'added to whitelist in console.', 'added to whitelist on customer side.', 'sending - process terminated.', 'revoking - process terminated.'],
'type' => 'integer',
- 'format' => 'int64',
+ 'format' => 'int32',
'required' => true,
- 'example' => '22',
+ 'example' => '8',
+ 'title' => '',
+ ],
+ ],
+ [
+ 'name' => 'OptRemark',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The operation remarks.', 'type' => 'string', 'required' => true, 'example' => '处理完成', 'title' => ''],
+ ],
+ [
+ 'name' => 'WorkTaskAnalysisResults',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['type' => 'integer', 'format' => 'int64', 'example' => '1445078', 'description' => '', 'title' => ''],
+ 'AnalysisResult' => ['type' => 'string', 'example' => '您好， 根据您提供的告警详情，xxx', 'description' => '', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'SyncSasDeal',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => '', 'title' => ''],
+ ],
+ [
+ 'name' => 'SyncWafApisecDeal',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => '', 'title' => ''],
+ ],
+ [
+ 'name' => 'SyncSasSiemEventDeal',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => '', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => 'Data query result.',
- 'type' => 'object',
- 'properties' => [
- 'VulDetails' => [
- 'title' => '漏洞详情',
- 'description' => 'Vulnerability details.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Data object.',
- 'type' => 'object',
- 'properties' => [
- 'CveId' => [
- 'title' => 'CVE编号',
- 'description' => 'CVE ID.',
- 'type' => 'string',
- 'example' => 'CVE-2022-21291',
- ],
- 'CvssScore' => [
- 'title' => '该漏洞在阿里云漏洞库中的CVSS评分',
- 'description' => 'The CVSS score of the vulnerability in the Alibaba Cloud vulnerability database.',
- 'type' => 'string',
- 'example' => '10.0',
- ],
- 'Title' => [
- 'title' => '漏洞公告的标题',
- 'description' => 'Title of the vulnerability announcement.',
- 'type' => 'string',
- 'example' => 'Chanjet T-Plus SetupAccount/Upload. Aspx file upload vulnerability(CNVD-2022-60632)',
- ],
- 'FixSuggestion' => [
- 'title' => '处理建议',
- 'description' => 'Fix suggestion.',
- 'type' => 'string',
- 'example' => 'https://avd.aliyun.com/detail/CVE-2022-21291',
- ],
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DAB46EC5-3746-59C4-B6D2-469F442EC73F',
- ],
- 'Code' => [
- 'description' => 'Interface return code.',
- 'type' => 'string',
- 'example' => '404',
- ],
- 'Message' => [
- 'description' => 'Return message.',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the call was successful. Values: - **true**: indicates a successful call. - **false**: indicates a failed call.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '86786E4C-6416-55CF-9AB6-5E275B68801D'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'Success.', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"VulDetails\\": [\\n {\\n \\"CveId\\": \\"CVE-2022-21291\\",\\n \\"CvssScore\\": \\"10.0\\",\\n \\"Title\\": \\"Chanjet T-Plus SetupAccount/Upload. Aspx file upload vulnerability(CNVD-2022-60632)\\",\\n \\"FixSuggestion\\": \\"https://avd.aliyun.com/detail/CVE-2022-21291\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"DAB46EC5-3746-59C4-B6D2-469F442EC73F\\",\\n \\"Code\\": \\"404\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Query Risk Details',
- 'translator' => 'machine',
- ],
- 'GetVulPageSummary' => [
- 'summary' => 'Risk Page Statistics',
- 'methods' => [
- 'get',
- 'post',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Process alert tickets',
+ 'summary' => 'Processes alert tickets.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:DisposeWorkTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86786E4C-6416-55CF-9AB6-5E275B68801D\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetAlarmDetailById' => [
+ 'summary' => 'Queries the details of an alert.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1303,128 +767,118 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '180002',
- 'abilityTreeNodes' => [
- 'FEATUREsosYT8XCW',
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '179907',
+ 'abilityTreeNodes' => ['FEATUREsos0FVTHS'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20077761'],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'Data query result.',
+ 'description' => 'The data returned by the operation.',
'type' => 'object',
'properties' => [
- 'WaitHandleCount' => [
- 'title' => '未处理数量',
- 'description' => 'Number of unhandled items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- 'HandingCount' => [
- 'title' => '处理中的数量',
- 'description' => 'Number of items being handled.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '6',
- ],
- 'CompletedCount' => [
- 'title' => '处理完成的数量',
- 'description' => 'Number of completed items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1990',
- ],
- 'TotalCount' => [
- 'title' => '总数量',
- 'description' => 'Total number of items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2000',
- ],
- 'HighCount' => [
- 'title' => '高风险数量',
- 'description' => 'Number of high-risk items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '500',
- ],
- 'MediumCount' => [
- 'title' => '中风险数量',
- 'description' => 'Number of medium-risk items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '500',
- ],
- 'LowCount' => [
- 'title' => '低风险数量',
- 'description' => 'Number of low-risk items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
+ 'EventDetails' => [
+ 'title' => '',
+ 'description' => 'The event details.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NameDisplay' => ['title' => '', 'description' => 'The display name of the alert event.', 'type' => 'string', 'example' => 'Login with unusual location'],
+ 'ValueDisplay' => ['title' => '', 'description' => 'The path where the alert event occurred.', 'type' => 'string', 'example' => '/etc/crontab'],
+ 'Type' => ['title' => '', 'description' => 'The event type of the alerting event.', 'type' => 'string', 'example' => 'text'],
+ 'Value' => ['title' => '', 'description' => 'The path where the alert event occurred.', 'type' => 'string', 'example' => '/etc/crontab'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'Desc' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'webshell'],
+ 'TacticDisplayName' => ['title' => '', 'description' => 'The ATT&CK tactic name.', 'type' => 'string', 'example' => 'Malicious scripts-Malicious script code execution'],
+ 'AlarmEventTypeDisplay' => ['title' => '', 'description' => 'The alerting event type.', 'type' => 'string', 'example' => 'Login with unusual location'],
+ 'ContainHwMode' => ['title' => '', 'description' => 'Indicates whether critical event protection mode is enabled. Valid values:'."\n"
+ ."\n"
+ .'- true: Enabled.'."\n"
+ .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'false'],
+ 'AlarmId' => ['title' => '', 'description' => 'The alert ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '202427220'],
+ 'AlarmSource' => ['title' => '', 'description' => 'The alert source.', 'type' => 'string', 'example' => 'SUSP_EVENT'],
+ 'AlarmName' => ['title' => '', 'description' => 'The alert name.', 'type' => 'string', 'example' => '负载均衡可挂载服务器数量告警'],
+ 'AlarmTime' => ['title' => '', 'description' => 'The most recent alert time.', 'type' => 'string', 'example' => '2018-09-26 01:51:01'],
+ 'DealTime' => ['title' => '', 'description' => 'The time when the alert was handled.', 'type' => 'string', 'example' => '2018-09-26 01:51:01'],
+ 'Status' => ['title' => '', 'description' => 'The handling status.', 'type' => 'string', 'example' => '要查询的告警事件状态。取值：'."\n"
+ ."\n"
+ .'0：全部'."\n"
+ .'1：待处理'."\n"
+ .'2：已忽略'."\n"
+ .'4：已确认'."\n"
+ .'8：已标记为误报'."\n"
+ .'16：处理中'."\n"
+ .'32：处理完毕'."\n"
+ .'64：已经过期'."\n"
+ .'128：已经删除'."\n"
+ .'512：自动拦截中'."\n"
+ .'513：自动拦截完毕'],
+ 'OwnerId' => ['title' => '', 'description' => 'The owner.', 'type' => 'string', 'example' => '324546'],
+ 'Remark' => ['title' => '', 'description' => 'The handling method.', 'type' => 'string', 'example' => '192.168.XX.XX'],
+ 'InstanceName' => ['title' => '', 'description' => 'The affected asset.', 'type' => 'string', 'example' => 'nginx'],
+ 'EventLevel' => ['title' => '', 'description' => 'The alert level.', 'type' => 'string', 'example' => 'suspicious'],
+ 'OccurrenceTime' => ['title' => '', 'description' => 'The time when the alert first occurred.', 'type' => 'string', 'example' => '2018-09-26 01:51:01'],
+ 'InternetIp' => ['title' => '', 'description' => 'The public IP address.', 'type' => 'string', 'example' => '47.116.126.79'],
+ 'IntranetIp' => ['title' => '', 'description' => 'The internal IP address.', 'type' => 'string', 'example' => '172.19.195.176'],
+ 'Id' => ['title' => '', 'description' => 'The primary key ID of the ticket.', 'type' => 'integer', 'format' => 'int64', 'example' => '9772'],
+ 'AlarmEventType' => ['title' => '', 'description' => 'The alerting event type.', 'type' => 'string', 'example' => 'Unusual Logon'],
+ 'AnalysisResult' => ['title' => '', 'description' => 'The analysis process.', 'type' => 'string', 'example' => '[{"value":"服务器可能已被黑客攻击，存在恶意进程在运行。 分析过程：告警显示，服务端存在一个名为”dns.exe”的进程在访问”polling.burpcollaborator.net”，这是一个被黑名单列出的恶意域名。在正常情况下,”dns.exe”不应该单独存在于系统的路径下，并且也不应该访问这类恶意域名。因此，这个进程可能是黑客留下的恶意进程。","key":"结论"},{"value":"尽快对服务器进行全面扫描，清除恶意进程。同时，联系网络安全专家进行深入调查，以确定是否有其他潜在的安全威胁。","key":"处置建议"}]'],
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A3A575C8-80F9-5F04-AA24-CCAC246884A3',
- ],
- 'Code' => [
- 'description' => 'Interface return code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Return message.',
- 'type' => 'string',
- 'example' => 'operation success',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful. - **true**: The call was successful. - **false**: The call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '5C1B0668-442C-57AE-9668-D894B0B012EB'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: Successful.'."\n"
+ .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'Query alert details',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetAlarmDetailById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"WaitHandleCount\\": 4,\\n \\"HandingCount\\": 6,\\n \\"CompletedCount\\": 1990,\\n \\"TotalCount\\": 2000,\\n \\"HighCount\\": 500,\\n \\"MediumCount\\": 500,\\n \\"LowCount\\": 1000\\n },\\n \\"RequestId\\": \\"A3A575C8-80F9-5F04-AA24-CCAC246884A3\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"operation success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Risk Page Statistics',
- 'translator' => 'machine',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"EventDetails\\": [\\n {\\n \\"NameDisplay\\": \\"Login with unusual location\\",\\n \\"ValueDisplay\\": \\"/etc/crontab\\",\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"/etc/crontab\\"\\n }\\n ],\\n \\"Desc\\": \\"webshell\\",\\n \\"TacticDisplayName\\": \\"Malicious scripts-Malicious script code execution\\",\\n \\"AlarmEventTypeDisplay\\": \\"Login with unusual location\\",\\n \\"ContainHwMode\\": false,\\n \\"AlarmId\\": 202427220,\\n \\"AlarmSource\\": \\"SUSP_EVENT\\",\\n \\"AlarmName\\": \\"负载均衡可挂载服务器数量告警\\",\\n \\"AlarmTime\\": \\"2018-09-26 01:51:01\\",\\n \\"DealTime\\": \\"2018-09-26 01:51:01\\",\\n \\"Status\\": \\"要查询的告警事件状态。取值：\\\\n\\\\n0：全部\\\\n1：待处理\\\\n2：已忽略\\\\n4：已确认\\\\n8：已标记为误报\\\\n16：处理中\\\\n32：处理完毕\\\\n64：已经过期\\\\n128：已经删除\\\\n512：自动拦截中\\\\n513：自动拦截完毕\\",\\n \\"OwnerId\\": \\"324546\\",\\n \\"Remark\\": \\"192.168.XX.XX\\",\\n \\"InstanceName\\": \\"nginx\\",\\n \\"EventLevel\\": \\"suspicious\\",\\n \\"OccurrenceTime\\": \\"2018-09-26 01:51:01\\",\\n \\"InternetIp\\": \\"47.116.126.79\\",\\n \\"IntranetIp\\": \\"172.19.195.176\\",\\n \\"Id\\": 9772,\\n \\"AlarmEventType\\": \\"Unusual Logon\\",\\n \\"AnalysisResult\\": \\"[{\\\\\\"value\\\\\\":\\\\\\"服务器可能已被黑客攻击，存在恶意进程在运行。 分析过程：告警显示，服务端存在一个名为”dns.exe”的进程在访问”polling.burpcollaborator.net”，这是一个被黑名单列出的恶意域名。在正常情况下,”dns.exe”不应该单独存在于系统的路径下，并且也不应该访问这类恶意域名。因此，这个进程可能是黑客留下的恶意进程。\\\\\\",\\\\\\"key\\\\\\":\\\\\\"结论\\\\\\"},{\\\\\\"value\\\\\\":\\\\\\"尽快对服务器进行全面扫描，清除恶意进程。同时，联系网络安全专家进行深入调查，以确定是否有其他潜在的安全威胁。\\\\\\",\\\\\\"key\\\\\\":\\\\\\"处置建议\\\\\\"}]\\"\\n },\\n \\"RequestId\\": \\"5C1B0668-442C-57AE-9668-D894B0B012EB\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetDocumentSummary' => [
- 'summary' => 'Service Report Home Page Statistics Acquisition',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetAttackedAssetDeal' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1436,107 +890,108 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '179771',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeCode' => '179684',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
+ 'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ReportType',
+ 'name' => 'DateType',
'in' => 'formData',
'schema' => [
- 'title' => '服务报告类型',
- 'description' => 'Type of service report.',
+ 'title' => '',
+ 'description' => 'The time filter type. You can filter by the last 7 days, last 30 days, last half year, or a custom time range.',
+ 'enumValueTitles' => ['oneYear' => 'last year.', 'month' => 'last month.', 'halfYear' => 'last half year.', 'customize' => 'custom.'],
'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 1 => '安全服务',
- '应急响应',
- '风险评估',
- '漏洞扫描',
- '等保测评',
- ],
- 'example' => '1',
+ 'required' => true,
+ 'example' => 'month',
],
],
+ [
+ 'name' => 'StartDate',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732268720000'],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732268720000'],
+ ],
+ [
+ 'name' => 'SuspEventSource',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The source of the alert event.', 'type' => 'string', 'required' => false, 'example' => '暂时无需传参，有问题请联系管理员'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'Data query result.',
+ 'description' => 'The data query result.',
'type' => 'object',
'properties' => [
- 'Frequency' => [
- 'title' => '次数',
- 'description' => 'Number of services or days.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'DocumentCount' => [
- 'title' => '份数',
- 'description' => 'Number of documents.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
+ 'EcsTrendList' => [
+ 'title' => '',
+ 'description' => 'The convergence trend list of attacked assets.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Date' => ['title' => '', 'description' => 'The time point.', 'type' => 'string', 'example' => '202312或20231205'],
+ 'DealCount' => ['title' => '', 'description' => 'The number of handled items.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ 'FindCount' => ['title' => '', 'description' => 'The number of discovered items.', 'type' => 'integer', 'format' => 'int64', 'example' => '暂时无值，有疑问请联系管理员'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7903F2DE-D9EE-5D16-8A08-E9223E54B281',
- ],
- 'Code' => [
- 'description' => 'Interface return code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Prompt message for the returned result.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful. Values:'."\n"
- .'- **true**: Yes.'."\n"
- .'- **false**: No.',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '1E74F11C-B4A8-5774-962C-02003BA8504E'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the query was successful.<br />'."\n"
+ .'**Valid values:**'."\n"
+ .'* true: Successful.'."\n"
+ .'* false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Frequency\\": 10,\\n \\"DocumentCount\\": 10\\n },\\n \\"RequestId\\": \\"7903F2DE-D9EE-5D16-8A08-E9223E54B281\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Service Report Home Page Statistics Acquisition',
- 'translator' => 'machine',
- ],
- 'GetSafetyCover' => [
- 'summary' => 'Get Safety Coverage',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Attacked asset convergence trend',
+ 'summary' => 'Queries the convergence trend of attacked assets.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetAttackedAssetDeal',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"EcsTrendList\\": [\\n {\\n \\"Date\\": \\"202312或20231205\\",\\n \\"DealCount\\": 2,\\n \\"FindCount\\": 0\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1E74F11C-B4A8-5774-962C-02003BA8504E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetBaselineSummary' => [
+ 'summary' => 'Queries the compliance risk convergence trend.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1548,10 +1003,8 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '179686',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeCode' => '179683',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -1560,8 +1013,9 @@
'name' => 'DateType',
'in' => 'formData',
'schema' => [
- 'title' => '筛选时间类型 支持按最近7天、最近30天、最近半年、自定义等方式进行时间的筛选',
- 'description' => 'Filter time type, supports filtering by the last 7 days, the last 30 days, the last half year, or custom time periods.',
+ 'title' => '',
+ 'description' => 'The time filter type. Supports filtering by last 7 days, last 30 days, last half year, or custom time range.',
+ 'enumValueTitles' => ['oneYear' => 'last year.', 'month' => 'last 30 days.', 'halfYear' => 'last half year.', 'customize' => 'custom.'],
'type' => 'string',
'required' => true,
'example' => 'month',
@@ -1570,223 +1024,84 @@
[
'name' => 'StartDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => 'Start time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1732255620000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1729478485000'],
],
[
'name' => 'EndDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '结束时间',
- 'description' => 'End time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1732268720000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732156885986'],
],
[
'name' => 'SuspEventSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '告警事件来源',
- 'description' => 'Alert event source.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '该接口不用传',
- ],
+ 'schema' => ['title' => '', 'description' => 'The alert event source.', 'type' => 'string', 'required' => false, 'example' => '该字段暂未使用，有问题请联系管理员'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'Data query result.',
+ 'description' => 'The data returned by the operation.',
'type' => 'object',
'properties' => [
- 'WafProtection' => [
- 'title' => 'WAF防护覆盖',
- 'description' => 'WAF protection coverage.',
- 'type' => 'object',
- 'properties' => [
- 'ProtectionCount' => [
- 'title' => '防护的数量',
- 'description' => 'Number of protected items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'NoProtectionCount' => [
- 'title' => '未防护的数量',
- 'description' => 'Number of unprotected items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'TotalCount' => [
- 'title' => '总数量',
- 'description' => 'Total number of items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'ProtectionRate' => [
- 'title' => '防护率',
- 'description' => 'Protection rate.',
- 'type' => 'string',
- 'example' => '50.00',
- ],
- 'ProtectionGrowthRate' => [
- 'title' => '防护率同比',
- 'description' => 'Year-over-year growth in protection rate.',
- 'type' => 'string',
- 'example' => '35.00',
- ],
- ],
- ],
- 'EcsProtection' => [
- 'title' => 'ECS防护覆盖',
- 'description' => 'ECS protection coverage.',
- 'type' => 'object',
- 'properties' => [
- 'ProtectionCount' => [
- 'title' => '防护的数量',
- 'description' => 'Number of protected items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'NoProtectionCount' => [
- 'title' => '未防护的数量',
- 'description' => 'Number of unprotected items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'TotalCount' => [
- 'title' => '总数量',
- 'description' => 'Total number of items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'ProtectionRate' => [
- 'title' => '防护率',
- 'description' => 'Protection rate.',
- 'type' => 'string',
- 'example' => '50.00',
- ],
- 'ProtectionGrowthRate' => [
- 'title' => '防护率同比',
- 'description' => 'Year-over-year growth in protection rate.',
- 'type' => 'string',
- 'example' => '35.00',
- ],
- ],
- ],
- 'CfwProtection' => [
- 'title' => 'CFW防护覆盖',
- 'description' => 'CFW protection coverage.',
- 'type' => 'object',
- 'properties' => [
- 'ProtectionCount' => [
- 'title' => '防护的数量',
- 'description' => 'Number of protected items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'NoProtectionCount' => [
- 'title' => '未防护的数量',
- 'description' => 'Number of unprotected items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'TotalCount' => [
- 'title' => '总数量',
- 'description' => 'Total quantity.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'ProtectionRate' => [
- 'title' => '防护率',
- 'description' => 'Protection rate.',
- 'type' => 'string',
- 'example' => '50.00',
- ],
- 'ProtectionGrowthRate' => [
- 'title' => '防护率同比',
- 'description' => 'Year-over-year protection rate.',
- 'type' => 'string',
- 'example' => '35.00',
+ 'TrendDTOList' => [
+ 'description' => 'The collection of baseline statistics.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Date' => ['title' => '', 'description' => 'The time point.', 'type' => 'string', 'example' => '202408或者20240801'],
+ 'DealCount' => ['title' => '', 'description' => 'The number of handled items.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'FindCount' => ['title' => '', 'description' => 'The number of discovered items.', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '564f8bb9-df3c-42a0-877a-b35d48f66603',
- ],
- 'Code' => [
- 'description' => 'API return code.',
- 'type' => 'string',
- 'example' => '404',
- ],
- 'Message' => [
- 'description' => 'Message of the response result.',
- 'type' => 'string',
- 'example' => 'system error',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful:'."\n"
- .'- **true**: Call succeeded.'."\n"
- .'- **false**: Call failed.'."\n",
- 'type' => 'boolean',
- 'example' => 'True',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '67D61738-5E38-5164-947A-34E3850D493A'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n"
+ .'- true: Successful.'."\n"
+ .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Compliance risk convergence trend',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetBaselineSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"WafProtection\\": {\\n \\"ProtectionCount\\": 5,\\n \\"NoProtectionCount\\": 5,\\n \\"TotalCount\\": 10,\\n \\"ProtectionRate\\": \\"50.00\\",\\n \\"ProtectionGrowthRate\\": \\"35.00\\"\\n },\\n \\"EcsProtection\\": {\\n \\"ProtectionCount\\": 5,\\n \\"NoProtectionCount\\": 5,\\n \\"TotalCount\\": 10,\\n \\"ProtectionRate\\": \\"50.00\\",\\n \\"ProtectionGrowthRate\\": \\"35.00\\"\\n },\\n \\"CfwProtection\\": {\\n \\"ProtectionCount\\": 5,\\n \\"NoProtectionCount\\": 5,\\n \\"TotalCount\\": 10,\\n \\"ProtectionRate\\": \\"50.00\\",\\n \\"ProtectionGrowthRate\\": \\"35.00\\"\\n }\\n },\\n \\"RequestId\\": \\"564f8bb9-df3c-42a0-877a-b35d48f66603\\",\\n \\"Code\\": \\"404\\",\\n \\"Message\\": \\"system error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Get Safety Coverage',
- 'translator' => 'machine',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TrendDTOList\\": [\\n {\\n \\"Date\\": \\"202408或者20240801\\",\\n \\"DealCount\\": 10,\\n \\"FindCount\\": 12\\n }\\n ]\\n },\\n \\"RequestId\\": \\"67D61738-5E38-5164-947A-34E3850D493A\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetAttackedAssetDeal' => [
- 'summary' => 'Trend of Attacked Asset Convergence',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetConsoleScore' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1798,163 +1113,184 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '179684',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '215083',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
],
'parameters' => [
[
'name' => 'DateType',
'in' => 'formData',
'schema' => [
- 'title' => '筛选时间类型 支持按最近7天、最近30天、最近半年、自定义等方式进行时间的筛选',
- 'description' => 'Time filter type, supporting filtering by the last 7 days, the last 30 days, the last half year, or custom time periods.',
+ 'title' => '',
+ 'description' => 'Filter time type. Supports filtering by the last 7 days, last 30 days, last half year, custom, and other methods. An empty value indicates the last 7 days.',
+ 'enumValueTitles' => ['oneYear' => 'Last year', 'month' => 'Last 30 days', 'halfYear' => 'Last half year', 'customize' => 'Custom'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'oneYear' => '最近一年',
- 'month' => '最近一个月',
- 'halfYear' => '最近半年',
- 'customize' => '自定义',
- ],
'example' => 'month',
],
],
[
'name' => 'StartDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => 'Start time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1732268720000',
- ],
+ 'schema' => ['title' => '', 'description' => 'Start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1729478485000'],
],
[
'name' => 'EndDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '结束时间',
- 'description' => 'End time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1732268720000',
- ],
+ 'schema' => ['title' => '', 'description' => 'End time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732156885986'],
],
[
'name' => 'SuspEventSource',
'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'Alert event source.', 'type' => 'string', 'required' => false, 'example' => '该字段暂未使用，有问题请联系管理员'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '告警事件来源',
- 'description' => 'Source of the alert event.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '暂时无需传参，有问题请联系管理员',
+ 'title' => '',
+ 'description' => 'Request response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => ['description' => 'The data returned by the API.', 'type' => 'any', 'example' => '{'."\n"
+ .' "score": "94.00",'."\n"
+ .' "consoleScoreTrendDTOS": ['."\n"
+ .' {'."\n"
+ .' "date": "20241009",'."\n"
+ .' "score": "100.0"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "cyclicYearOverYear": "-6.00",'."\n"
+ .' "recordDate": "20241209",'."\n"
+ .' "weeklyYearOverYear": "1.62",'."\n"
+ .' "aboveWholeNetworkUserRatio": "6.25",'."\n"
+ .' "aliUid": "1601097845544644",'."\n"
+ .' "detailJson": "[{\\"detailDTO\\":[{\\"count\\":0,\\"itemName\\":\\"应用漏洞POC验证\\",\\"mark\\":\\"1\\"},{\\"count\\":0,\\"itemName\\":\\"未授权访问漏洞（公网暴露）\\",\\"mark\\":\\"1\\"},{\\"count\\":0,\\"itemName\\":\\"后台弱口令漏洞（公网暴露）\\",\\"mark\\":\\"1\\"},{\\"count\\":0,\\"itemName\\":\\"文件上传漏洞（公网暴露）\\",\\"mark\\":\\"1\\"}],\\"markRate\\":\\"0.5\\",\\"markType\\":\\"vul\\"},{\\"detailDTO\\":[{\\"count\\":12,\\"itemName\\":\\"WAF3.0回源配置不正确\\",\\"mark\\":\\"1\\"},{\\"count\\":0,\\"itemName\\":\\"AK泄露检查未开启\\",\\"mark\\":\\"1\\"},{\\"count\\":0,\\"itemName\\":\\"DNAT管理端口开放\\",\\"mark\\":\\"1\\"},{\\"count\\":0,\\"itemName\\":\\"高危端口暴露\\",\\"mark\\":\\"0.5\\"}],\\"markRate\\":\\"0.5\\",\\"markType\\":\\"risk\\"}]"'."\n"
+ .'}', 'title' => ''],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => 'D0937B0F-9180-5F70-B6ED-0BA22591627F'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the operation is successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'example' => '',
],
],
],
+ 'errorCodes' => [
+ 401 => [
+ ['errorCode' => 'ConsoleScoreEmpty', 'errorMessage' => 'get score data is empty.', 'description' => ''],
+ ],
+ ],
+ 'title' => 'Get Console Score',
+ 'summary' => 'Get Console Score.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetConsoleScore',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\n \\\\\\"score\\\\\\": \\\\\\"94.00\\\\\\",\\\\n \\\\\\"consoleScoreTrendDTOS\\\\\\": [\\\\n {\\\\n \\\\\\"date\\\\\\": \\\\\\"20241009\\\\\\",\\\\n \\\\\\"score\\\\\\": \\\\\\"100.0\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"cyclicYearOverYear\\\\\\": \\\\\\"-6.00\\\\\\",\\\\n \\\\\\"recordDate\\\\\\": \\\\\\"20241209\\\\\\",\\\\n \\\\\\"weeklyYearOverYear\\\\\\": \\\\\\"1.62\\\\\\",\\\\n \\\\\\"aboveWholeNetworkUserRatio\\\\\\": \\\\\\"6.25\\\\\\",\\\\n \\\\\\"aliUid\\\\\\": \\\\\\"1601097845544644\\\\\\",\\\\n \\\\\\"detailJson\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"detailDTO\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"应用漏洞POC验证\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"未授权访问漏洞（公网暴露）\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"后台弱口令漏洞（公网暴露）\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"文件上传漏洞（公网暴露）\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"markRate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.5\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"markType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"vul\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"detailDTO\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":12,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"WAF3.0回源配置不正确\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AK泄露检查未开启\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DNAT管理端口开放\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"高危端口暴露\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.5\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"markRate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.5\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"markType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"risk\\\\\\\\\\\\\\"}]\\\\\\"\\\\n}\\",\\n \\"RequestId\\": \\"D0937B0F-9180-5F70-B6ED-0BA22591627F\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetDetailById' => [
+ 'summary' => 'Queries risk details.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '179782',
+ 'abilityTreeNodes' => ['FEATUREsosYT8XCW'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'Data query result.',
+ 'description' => 'The data query result.',
'type' => 'object',
'properties' => [
- 'EcsTrendList' => [
- 'title' => '被攻击资产收敛趋势集合',
- 'description' => 'Collection of attacked asset convergence trends.',
+ 'VulDetails' => [
+ 'title' => '',
+ 'description' => 'The vulnerability details.',
'type' => 'array',
'items' => [
- 'description' => 'Data object.',
+ 'description' => 'The data object.',
'type' => 'object',
'properties' => [
- 'Date' => [
- 'title' => '时间节点',
- 'description' => 'Date point.',
- 'type' => 'string',
- 'example' => '202312或20231205',
- ],
- 'DealCount' => [
- 'title' => '处理的数量',
- 'description' => 'Number of processed items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'FindCount' => [
- 'title' => '发现的数量',
- 'description' => 'Number of discovered items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '暂时无值，有疑问请联系管理员',
- ],
+ 'CveId' => ['title' => '', 'description' => 'The CVE ID.', 'type' => 'string', 'example' => 'CVE-2022-21291'],
+ 'CvssScore' => ['title' => '', 'description' => 'The CVSS score of the vulnerability in the Alibaba Cloud vulnerability database.', 'type' => 'string', 'example' => '10.0'],
+ 'Title' => ['title' => '', 'description' => 'The title of the vulnerability advisory.', 'type' => 'string', 'example' => 'Chanjet T-Plus SetupAccount/Upload. Aspx file upload vulnerability(CNVD-2022-60632)'],
+ 'FixSuggestion' => ['title' => '', 'description' => 'The remediation suggestion.', 'type' => 'string', 'example' => 'https://avd.aliyun.com/detail/CVE-2022-21291'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1E74F11C-B4A8-5774-962C-02003BA8504E',
- ],
- 'Code' => [
- 'description' => 'Interface return code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Return message.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the query was successful.<br />'."\n"
- .'**Enum values:**'."\n"
- .'* true: Success.'."\n"
- .'* false: Failure.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => 'DAB46EC5-3746-59C4-B6D2-469F442EC73F'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '404', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'Query risk details',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetDetailById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"EcsTrendList\\": [\\n {\\n \\"Date\\": \\"202312或20231205\\",\\n \\"DealCount\\": 2,\\n \\"FindCount\\": 0\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1E74F11C-B4A8-5774-962C-02003BA8504E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Trend of Attacked Asset Convergence',
- 'translator' => 'machine',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"VulDetails\\": [\\n {\\n \\"CveId\\": \\"CVE-2022-21291\\",\\n \\"CvssScore\\": \\"10.0\\",\\n \\"Title\\": \\"Chanjet T-Plus SetupAccount/Upload. Aspx file upload vulnerability(CNVD-2022-60632)\\",\\n \\"FixSuggestion\\": \\"https://avd.aliyun.com/detail/CVE-2022-21291\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"DAB46EC5-3746-59C4-B6D2-469F442EC73F\\",\\n \\"Code\\": \\"404\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetWorkTaskSummary' => [
- 'summary' => 'Get the First Line Work Order Statistics',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetDocumentDownloadUrl' => [
+ 'summary' => 'Downloads a single service report.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1966,484 +1302,236 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '179659',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeCode' => '185959',
+ 'abilityTreeNodes' => ['FEATUREsosOEHKXE'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'DateType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '筛选时间类型 支持按最近7天、最近30天、最近半年、自定义等方式进行时间的筛选',
- 'description' => 'Filter time type, supports filtering by the last 7 days, the last 30 days, the last half year, or custom time periods.',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'oneYear' => '最近一年',
- 'month' => '最近30天',
- 'halfYear' => '最近半年',
- 'customize' => '自定义',
- ],
- 'example' => 'month',
- ],
- ],
- [
- 'name' => 'StartDate',
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => 'Start time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1729478485000',
- ],
+ 'schema' => ['description' => 'The document management ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '175815', 'title' => ''],
],
[
- 'name' => 'EndDate',
+ 'name' => 'ReportType',
'in' => 'formData',
'schema' => [
- 'title' => '结束时间',
- 'description' => 'End time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1732156885986',
+ 'description' => 'The report type.',
+ 'enumValueTitles' => [1 => 'Security service.', 'Emergency response.', 'Risk assessment.', 'Vulnerability scan.', 'Classified protection assessment.', 'SOS classified protection assessment.'],
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ 'title' => '',
],
],
[
- 'name' => 'SuspEventSource',
+ 'name' => 'FileKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '告警事件来源',
- 'description' => 'Alert event source.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '该字段暂时未用，有问题请联系管理员',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => 'Data returned by the interface.',
- 'type' => 'object',
- 'properties' => [
- 'WorkTaskCount' => [
- 'title' => '服务响应次数',
- 'description' => 'Number of service responses.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'WorkTaskGrowthRate' => [
- 'title' => '服务响应次数同比增长',
- 'description' => 'Year-over-year growth rate of service responses.',
- 'type' => 'string',
- 'example' => '20',
- ],
- 'DealAverageDuration' => [
- 'title' => '平均响应时效(分钟)',
- 'description' => 'Average response time (in minutes).',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '60',
- ],
- 'DealAverageDurationGrowthRate' => [
- 'title' => '平均响应时效同比增长',
- 'description' => 'Year-over-year growth rate of average response time.',
- 'type' => 'string',
- 'example' => '20',
- ],
- 'WorkTaskDealRate' => [
- 'title' => '问题闭环率',
- 'description' => 'Problem closure rate.',
- 'type' => 'string',
- 'example' => '90',
- ],
- 'WorkTaskDealRateGrowthRate' => [
- 'title' => '问题闭环率同比',
- 'description' => 'Year-over-year growth rate of problem closure rate.',
- 'type' => 'string',
- 'example' => '20',
- ],
- 'DealWorkTaskCount' => [
- 'title' => '响应工单次数',
- 'description' => 'Number of work orders responded to.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'DealWorkTaskCountRate' => [
- 'title' => '响应工单次数同比',
- 'description' => 'Year-over-year growth rate of the number of work orders responded to.',
- 'type' => 'string',
- 'example' => '20',
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'EF801DD1-D934-51B3-92D4-776CE17B184F',
- ],
- 'Code' => [
- 'description' => 'Response code.',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => 'Prompt message for the response result.',
- 'type' => 'string',
- 'example' => 'Successful!',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful. - **true**: The call was successful. - **false**: The call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Data' => ['description' => 'The OSS file access URL.', 'type' => 'string', 'example' => 'https://oos-cn.ctyunapi.cn/example-bucket/test/1.jpg', 'title' => ''],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => 'C7BE80B4-7692-54FA-AB22-2A7DF08C4754'],
+ 'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Download a single service report',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetDocumentDownloadUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"WorkTaskCount\\": 10,\\n \\"WorkTaskGrowthRate\\": \\"20\\",\\n \\"DealAverageDuration\\": 60,\\n \\"DealAverageDurationGrowthRate\\": \\"20\\",\\n \\"WorkTaskDealRate\\": \\"90\\",\\n \\"WorkTaskDealRateGrowthRate\\": \\"20\\",\\n \\"DealWorkTaskCount\\": 100,\\n \\"DealWorkTaskCountRate\\": \\"20\\"\\n },\\n \\"RequestId\\": \\"EF801DD1-D934-51B3-92D4-776CE17B184F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Get the First Line Work Order Statistics',
- 'translator' => 'machine',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"https://oos-cn.ctyunapi.cn/example-bucket/test/1.jpg\\",\\n \\"RequestId\\": \\"C7BE80B4-7692-54FA-AB22-2A7DF08C4754\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetSuspEventSummary' => [
- 'summary' => 'Get Alert Statistics',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetDocumentPage' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '179681',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeCode' => '185960',
+ 'abilityTreeNodes' => ['FEATUREsosOEHKXE'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'DateType',
+ 'name' => 'CurrentPage',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'],
+ ],
+ [
+ 'name' => 'ReportType',
'in' => 'formData',
'schema' => [
- 'title' => '筛选时间类型 支持按最近7天、最近30天、最近半年、自定义等方式进行时间的筛选',
- 'description' => 'Filter time type. Supports filtering by the last 7 days, the last 30 days, the last half year, or custom time ranges.',
+ 'title' => '',
+ 'description' => 'The report type. Valid values:'."\n"
+ .'- 1: security service'."\n"
+ .'- 2: emergency response'."\n"
+ .'- 3: risk assessment'."\n"
+ .'- 4: vulnerability scan'."\n"
+ .'- 5: classified protection assessment.',
+ 'enumValueTitles' => [1 => 'Security service.', 'Emergency response.', 'Risk assessment.', 'Vulnerability scan.', 'Classified protection assessment.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'oneYear' => '最近一年',
- 'month' => '最近30天',
- 'halfYear' => '最近半年',
- 'customize' => '自定义',
- ],
- 'example' => 'month',
+ 'example' => '1',
],
],
[
- 'name' => 'StartDate',
+ 'name' => 'DocumentName',
'in' => 'formData',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => 'Start time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1729478485000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The document name.', 'type' => 'string', 'required' => false, 'example' => '季度报告'],
],
[
- 'name' => 'EndDate',
+ 'name' => 'DeliveredBy',
'in' => 'formData',
- 'schema' => [
- 'title' => '结束时间',
- 'description' => 'End time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1732156885986',
- ],
+ 'schema' => ['title' => '', 'description' => 'The person who delivered the report.', 'type' => 'string', 'required' => false, 'example' => '张三'],
],
[
- 'name' => 'SuspEventSource',
+ 'name' => 'DocumentType',
'in' => 'formData',
'schema' => [
- 'title' => '告警事件来源',
- 'description' => 'Alert event source.',
+ 'title' => '',
+ 'description' => 'The document type. Valid values:'."\n"
+ .'- 0: daily report'."\n"
+ .'- 1: weekly report'."\n"
+ .'- 2: monthly report'."\n"
+ .'- 3: quarterly summary report'."\n"
+ .'- 4: annual summary report'."\n"
+ .'- 5: service summary report'."\n"
+ .'- 6: emergency response report'."\n"
+ .'- 7: vulnerability scan report'."\n"
+ .'- 8: risk assessment report'."\n"
+ .'- 9: other report'."\n"
+ .'- 10: meeting report'."\n"
+ .'- 15: classified protection assessment report.',
+ 'enumValueTitles' => ['Daily report.', 'Weekly report.', 'Monthly report.', 'Quarterly summary report.', 'Annual summary report.', 'Service summary report.', 'Emergency response report.', 'Vulnerability scan report.', 'Risk assessment report.', 'Other report.', 'Meeting report.', 15 => 'Classified protection assessment report.'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'SYSTEM_SECURITY_EVENT' => '云安全中心告警旧数据源',
- 'SUSP_CUSTOM_WAF' => 'MDR_WAF事件',
- 'SUSP_EVENT' => '云安全中心',
- 'SUSP_CUSTOM_DDOS' => 'MDR_DDOS事件',
- 'SUSP_CUSTOM_CFW' => 'MDR_CFW事件',
- ],
- 'example' => 'SUSP_EVENT',
+ 'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => 'Data returned by the interface.',
+ 'PageInfo' => [
+ 'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
- 'SuspEventDealSummaryDTO' => [
- 'title' => '告警处理概况',
- 'description' => 'Overview of alert handling.',
- 'type' => 'object',
- 'properties' => [
- 'WaitHandleCount' => [
- 'title' => '未处理告警数量',
- 'description' => 'Number of unhandled alerts.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'HandingCount' => [
- 'title' => '处理中',
- 'description' => 'In progress.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'CompletedCount' => [
- 'title' => '处理完成',
- 'description' => 'Completed.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'title' => '总告警数',
- 'description' => 'Total number of alerts.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '35',
- ],
- 'HandingRate' => [
- 'title' => '告警处置率',
- 'description' => 'Alert handling rate.',
- 'type' => 'string',
- 'example' => '90',
- ],
- 'TotalGrowthRate' => [
- 'title' => '告警同比',
- 'description' => 'Year-over-year comparison of alerts.',
- 'type' => 'string',
- 'example' => '10',
- ],
- ],
- ],
- 'SuspEventTrendDTO' => [
- 'title' => '告警响应趋势',
- 'description' => 'Trend of alert responses.',
- 'type' => 'object',
- 'properties' => [
- 'TrendList' => [
- 'title' => '告警的趋势',
- 'description' => 'Trend of alerts.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Data object.',
- 'type' => 'object',
- 'properties' => [
- 'Date' => [
- 'title' => '时间节点',
- 'description' => 'Time point.',
- 'type' => 'string',
- 'example' => '202405或者20240501',
- ],
- 'DealCount' => [
- 'title' => '处理的数量',
- 'description' => 'Number of handled alerts.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'FindCount' => [
- 'title' => '发现的数量',
- 'description' => 'Number of discovered alerts.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '15',
- ],
- ],
- ],
- ],
- ],
- ],
- 'SuspEventTopDTO' => [
- 'title' => '处置告警前TOP 10',
- 'description' => 'Top 10 alerts before handling.',
- 'type' => 'object',
- 'properties' => [
- 'SuspEventList' => [
- 'title' => '处置告警前TOP 10',
- 'description' => 'Top 10 before handling alarms',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Data object.',
- 'type' => 'object',
- 'properties' => [
- 'EventName' => [
- 'title' => '告警名称',
- 'description' => 'Alert name.',
- 'type' => 'string',
- 'example' => '主动外连风险 IP',
- ],
- 'TaskCount' => [
- 'title' => '数量',
- 'description' => 'Count.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '7',
- ],
- ],
- ],
- ],
- ],
- ],
- 'NetworkAttackTrendDTO' => [
- 'title' => '网络攻击趋势',
- 'description' => 'Network attack trend.',
- 'type' => 'object',
- 'properties' => [
- 'TrendList' => [
- 'title' => '各攻击项趋势节点集合',
- 'description' => 'Collection of trend nodes for each attack item.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Data object.',
- 'type' => 'object',
- 'properties' => [
- 'Date' => [
- 'title' => '日期',
- 'description' => 'Date.',
- 'type' => 'string',
- 'example' => '202409或20240901',
- ],
- 'DdosCount' => [
- 'title' => 'DDOS数量',
- 'description' => 'DDoS count.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'WafCount' => [
- 'title' => 'WAF数量',
- 'description' => 'WAF count.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'EipCount' => [
- 'title' => 'EIP数量',
- 'description' => 'EIP count.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- ],
- ],
- ],
+ 'CurrentPage' => ['description' => 'The page number of the current page in a paging query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '3149', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Data' => [
+ 'description' => 'The response data.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '', 'description' => 'The primary key ID of the document.', 'type' => 'integer', 'format' => 'int64', 'example' => '346409'],
+ 'DocumentType' => ['title' => '', 'description' => 'The service report type.', 'type' => 'string', 'example' => '3'],
+ 'DeliveredBy' => ['title' => '', 'description' => 'The person who delivered the report.', 'type' => 'string', 'example' => '张三'],
+ 'UploadTime' => ['title' => '', 'description' => 'The time when the report was generated.', 'type' => 'string', 'example' => '2023-03-21 17:26:34'],
+ 'DocumentName' => ['title' => '', 'description' => 'The report name.', 'type' => 'string', 'example' => '季度报告'],
+ 'ReportStatus' => [
+ 'description' => 'The report status. Valid values:'."\n"
+ .'- userConfirmed: Archived.'."\n"
+ .'- uploaded: Pending user review.',
+ 'enumValueTitles' => ['userConfirmed' => 'Archived.', 'uploaded' => 'Pending user review.'],
+ 'type' => 'string',
+ 'example' => 'uploaded',
+ 'title' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '9B2DAE9B-B901-5818-AFEF-E5637D938280',
- ],
- 'Code' => [
- 'description' => 'API response code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Prompt message for the returned result.',
- 'type' => 'string',
- 'example' => 'Successful!',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful.'."\n"
- .'- true: Call succeeded.'."\n"
- .'- false: Call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '04DAD7B4-E1DA-5C2C-8E5C-A1EDC880CF60'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned with the result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query service reports',
+ 'summary' => 'Queries service reports.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetDocumentPage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SuspEventDealSummaryDTO\\": {\\n \\"WaitHandleCount\\": 10,\\n \\"HandingCount\\": 5,\\n \\"CompletedCount\\": 20,\\n \\"TotalCount\\": 35,\\n \\"HandingRate\\": \\"90\\",\\n \\"TotalGrowthRate\\": \\"10\\"\\n },\\n \\"SuspEventTrendDTO\\": {\\n \\"TrendList\\": [\\n {\\n \\"Date\\": \\"202405或者20240501\\",\\n \\"DealCount\\": 10,\\n \\"FindCount\\": 15\\n }\\n ]\\n },\\n \\"SuspEventTopDTO\\": {\\n \\"SuspEventList\\": [\\n {\\n \\"EventName\\": \\"主动外连风险 IP\\",\\n \\"TaskCount\\": 7\\n }\\n ]\\n },\\n \\"NetworkAttackTrendDTO\\": {\\n \\"TrendList\\": [\\n {\\n \\"Date\\": \\"202409或20240901\\",\\n \\"DdosCount\\": 10,\\n \\"WafCount\\": 10,\\n \\"EipCount\\": 10\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"9B2DAE9B-B901-5818-AFEF-E5637D938280\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Get Alert Statistics',
- 'translator' => 'machine',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3149\\n },\\n \\"Data\\": [\\n {\\n \\"Id\\": 346409,\\n \\"DocumentType\\": \\"3\\",\\n \\"DeliveredBy\\": \\"张三\\",\\n \\"UploadTime\\": \\"2023-03-21 17:26:34\\",\\n \\"DocumentName\\": \\"季度报告\\",\\n \\"ReportStatus\\": \\"uploaded\\"\\n }\\n ],\\n \\"RequestId\\": \\"04DAD7B4-E1DA-5C2C-8E5C-A1EDC880CF60\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetVulSummary' => [
- 'summary' => 'Get Risk Statistics',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetDocumentSummary' => [
+ 'summary' => 'Retrieves the statistics on the homepage of a service report.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2455,180 +1543,73 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '179685',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
- 'autoTest' => true,
+ 'abilityTreeCode' => '179771',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'DateType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '筛选时间类型 支持按最近7天、最近30天、最近半年、自定义等方式进行时间的筛选',
- 'description' => 'Filter time type. Supports filtering by the last 7 days, the last 30 days, the last half year, or a custom time range.',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'oneYear' => '最近一年',
- 'month' => '最近30天',
- 'halfYear' => '最近半年',
- 'customize' => '自定义',
- ],
- 'example' => 'month',
- ],
- ],
- [
- 'name' => 'StartDate',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => 'Start time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1729478485000',
- ],
- ],
- [
- 'name' => 'EndDate',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '结束时间',
- 'description' => 'End time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1732156885986',
- ],
- ],
- [
- 'name' => 'SuspEventSource',
+ 'name' => 'ReportType',
'in' => 'formData',
'schema' => [
- 'title' => '告警事件来源',
- 'description' => 'Alert event source.',
+ 'title' => '',
+ 'description' => 'The type of the service report.',
+ 'enumValueTitles' => [1 => 'Security service.', 'Emergency response.', 'Risk assessment.', 'Vulnerability scanning.', 'Classified protection assessment.'],
'type' => 'string',
'required' => false,
- 'example' => '该字段暂未使用，有问题请联系管理员',
+ 'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'Data returned by the interface.',
+ 'description' => 'The data query result.',
'type' => 'object',
'properties' => [
- 'WaitHandleCount' => [
- 'title' => '未处理数量',
- 'description' => 'Number of unhandled items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'CompletedCount' => [
- 'title' => '处理完成',
- 'description' => 'Number of completed items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'DealRate' => [
- 'title' => '风险收敛率',
- 'description' => 'Risk convergence rate.',
- 'type' => 'string',
- 'example' => '50',
- ],
- 'TrendList' => [
- 'title' => '发现漏洞趋势节点集合',
- 'description' => 'Collection of vulnerability trend nodes.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Data object.',
- 'type' => 'object',
- 'properties' => [
- 'Date' => [
- 'title' => '时间节点',
- 'description' => 'Time point.',
- 'type' => 'string',
- 'example' => '202407或者20240701',
- ],
- 'DealCount' => [
- 'title' => '处理的数量',
- 'description' => 'Number of handled items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'FindCount' => [
- 'title' => '发现的数量',
- 'description' => 'Number of discovered items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '15',
- ],
- ],
- ],
- ],
+ 'Frequency' => ['title' => '', 'description' => 'The number of service sessions or days.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'DocumentCount' => ['title' => '', 'description' => 'The number of documents.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'EF801DD1-D934-51B3-92D4-776CE17B184F',
- ],
- 'Code' => [
- 'description' => 'Interface response code.',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => 'Prompt message for the response result.',
- 'type' => 'string',
- 'example' => 'system error',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful. - **true**: The call was successful. - **false**: The call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '7903F2DE-D9EE-5D16-8A08-E9223E54B281'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned with the result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'Retrieve service report homepage statistics',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetDocumentSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"WaitHandleCount\\": 5,\\n \\"CompletedCount\\": 10,\\n \\"DealRate\\": \\"50\\",\\n \\"TrendList\\": [\\n {\\n \\"Date\\": \\"202407或者20240701\\",\\n \\"DealCount\\": 10,\\n \\"FindCount\\": 15\\n }\\n ]\\n },\\n \\"RequestId\\": \\"EF801DD1-D934-51B3-92D4-776CE17B184F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"system error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Get Risk Statistics',
- 'translator' => 'machine',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Frequency\\": 10,\\n \\"DocumentCount\\": 10\\n },\\n \\"RequestId\\": \\"7903F2DE-D9EE-5D16-8A08-E9223E54B281\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetRecentDocument' => [
- 'summary' => 'Get Recently Uploaded Service Reports',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2641,9 +1622,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '179682',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -2651,135 +1630,83 @@
[
'name' => 'DateType',
'in' => 'formData',
- 'schema' => [
- 'title' => '筛选时间类型 支持按最近7天、最近30天、最近半年、自定义等方式进行时间的筛选',
- 'description' => 'Filter time type, supports filtering by the last 7 days, the last 30 days, the last half year, or custom time ranges.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '该字段暂未使用，有问题请联系管理员',
- ],
+ 'schema' => ['title' => '', 'description' => 'The time filter type. Supports filtering by the last 7 days, last 30 days, last 6 months, or a custom time range.', 'type' => 'string', 'required' => true, 'example' => '该字段暂未使用，有问题请联系管理员'],
],
[
'name' => 'StartDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => 'Start time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '该字段暂未使用，有问题请联系管理员',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1724788109000'],
],
[
'name' => 'EndDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '结束时间',
- 'description' => 'End time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '该字段暂未使用，有问题请联系管理员',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1734788109000'],
],
[
'name' => 'SuspEventSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '告警事件来源',
- 'description' => 'Alert event source.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '该字段暂未使用，有问题请联系管理员',
- ],
+ 'schema' => ['title' => '', 'description' => 'The alert event source.', 'type' => 'string', 'required' => false, 'example' => '该字段暂未使用，有问题请联系管理员'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'Data returned by the interface.',
+ 'description' => 'The data returned by the operation.',
'type' => 'array',
'items' => [
- 'description' => 'Data object.',
+ 'description' => 'The data object.',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '文档名称',
- 'description' => 'Document name',
- 'type' => 'string',
- 'example' => '文档名称测试',
- ],
- 'Id' => [
- 'title' => 'id',
- 'description' => 'Primary key ID.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '360491',
- ],
- 'UploadTime' => [
- 'title' => '上传时间',
- 'description' => 'Upload time.',
- 'type' => 'string',
- 'example' => '2023-03-20 14:30:38',
- ],
+ 'Name' => ['title' => '', 'description' => 'The document name.', 'type' => 'string', 'example' => '文档名称测试'],
+ 'Id' => ['title' => '', 'description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '360491'],
+ 'UploadTime' => ['title' => '', 'description' => 'The upload time.', 'type' => 'string', 'example' => '2023-03-20 14:30:38'],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '4916FA8D-F294-518D-B373-8B59D63CAB19',
- ],
- 'Code' => [
- 'description' => 'Interface response code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Response message.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful. - **true**: The call was successful. - **false**: The call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '4916FA8D-F294-518D-B373-8B59D63CAB19'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve the most recently uploaded service reports',
+ 'summary' => 'Retrieves the most recently uploaded service reports.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetRecentDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"文档名称测试\\",\\n \\"Id\\": 360491,\\n \\"UploadTime\\": \\"2023-03-20 14:30:38\\"\\n }\\n ],\\n \\"RequestId\\": \\"4916FA8D-F294-518D-B373-8B59D63CAB19\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Get Recently Uploaded Service Reports',
- 'translator' => 'machine',
],
- 'GetBaselineSummary' => [
- 'summary' => 'Compliance Risk Convergence Trend',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetSafetyCover' => [
+ 'summary' => 'Retrieves the security protection coverage.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2791,10 +1718,8 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '179683',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeCode' => '179686',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -2802,496 +1727,222 @@
[
'name' => 'DateType',
'in' => 'formData',
- 'schema' => [
- 'title' => '筛选时间类型 支持按最近7天、最近30天、最近半年、自定义等方式进行时间的筛选',
- 'description' => 'Time filter type, supports filtering by the last 7 days, the last 30 days, the last half year, or custom time periods.',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'oneYear' => '最近一年',
- 'month' => '最近30天',
- 'halfYear' => '最近半年',
- 'customize' => '自定义',
- ],
- 'example' => 'month',
- ],
+ 'schema' => ['title' => '', 'description' => 'The time filter type. Supports filtering by last 7 days, last 30 days, last half year, or custom time range.', 'type' => 'string', 'required' => true, 'example' => 'month'],
],
[
'name' => 'StartDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => 'Start time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1729478485000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732255620000'],
],
[
'name' => 'EndDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '结束时间',
- 'description' => 'End time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1732156885986',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732268720000'],
],
[
'name' => 'SuspEventSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '告警事件来源',
- 'description' => 'Alert event source.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '该字段暂未使用，有问题请联系管理员',
- ],
+ 'schema' => ['title' => '', 'description' => 'The alert event source.', 'type' => 'string', 'required' => false, 'example' => '该接口不用传'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'Data returned by the interface.',
+ 'description' => 'The query result.',
'type' => 'object',
'properties' => [
- 'TrendDTOList' => [
- 'description' => 'Collection of baseline statistical data.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Data object.',
- 'type' => 'object',
- 'properties' => [
- 'Date' => [
- 'title' => '时间节点',
- 'description' => 'Date point.',
- 'type' => 'string',
- 'example' => '202408或者20240801',
- ],
- 'DealCount' => [
- 'title' => '处理的数量',
- 'description' => 'Number of processed items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'FindCount' => [
- 'title' => '发现的数量',
- 'description' => 'Number of discovered items.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- ],
+ 'WafProtection' => [
+ 'title' => '',
+ 'description' => 'The WAF protection coverage.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProtectionCount' => ['title' => '', 'description' => 'The number of protected assets.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'NoProtectionCount' => ['title' => '', 'description' => 'The number of unprotected assets.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of assets.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'ProtectionRate' => ['title' => '', 'description' => 'The protection rate.', 'type' => 'string', 'example' => '50.00'],
+ 'ProtectionGrowthRate' => ['title' => '', 'description' => 'The year-over-year growth rate of the protection rate.', 'type' => 'string', 'example' => '35.00'],
],
+ 'example' => '',
+ ],
+ 'EcsProtection' => [
+ 'title' => '',
+ 'description' => 'The ECS protection coverage.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProtectionCount' => ['title' => '', 'description' => 'The number of protected assets.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'NoProtectionCount' => ['title' => '', 'description' => 'The number of unprotected assets.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of assets.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'ProtectionRate' => ['title' => '', 'description' => 'The protection rate.', 'type' => 'string', 'example' => '50.00'],
+ 'ProtectionGrowthRate' => ['title' => '', 'description' => 'The year-over-year growth rate of the protection rate.', 'type' => 'string', 'example' => '35.00'],
+ ],
+ 'example' => '',
+ ],
+ 'CfwProtection' => [
+ 'title' => '',
+ 'description' => 'The Cloud Firewall (CFW) protection coverage.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProtectionCount' => ['title' => '', 'description' => 'The number of protected assets.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'NoProtectionCount' => ['title' => '', 'description' => 'The number of unprotected assets.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of assets.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'ProtectionRate' => ['title' => '', 'description' => 'The protection rate.', 'type' => 'string', 'example' => '50.00'],
+ 'ProtectionGrowthRate' => ['title' => '', 'description' => 'The year-over-year growth rate of the protection rate.', 'type' => 'string', 'example' => '35.00'],
+ ],
+ 'example' => '',
],
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '67D61738-5E38-5164-947A-34E3850D493A',
- ],
- 'Code' => [
- 'description' => 'Interface response code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Prompt message for the returned result.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the operation was successful. Values: true: success; false: failure.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '564f8bb9-df3c-42a0-877a-b35d48f66603'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '404', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'system error', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve security protection coverage',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetSafetyCover',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TrendDTOList\\": [\\n {\\n \\"Date\\": \\"202408或者20240801\\",\\n \\"DealCount\\": 10,\\n \\"FindCount\\": 12\\n }\\n ]\\n },\\n \\"RequestId\\": \\"67D61738-5E38-5164-947A-34E3850D493A\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Compliance Risk Convergence Trend',
- 'translator' => 'machine',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"WafProtection\\": {\\n \\"ProtectionCount\\": 5,\\n \\"NoProtectionCount\\": 5,\\n \\"TotalCount\\": 10,\\n \\"ProtectionRate\\": \\"50.00\\",\\n \\"ProtectionGrowthRate\\": \\"35.00\\"\\n },\\n \\"EcsProtection\\": {\\n \\"ProtectionCount\\": 5,\\n \\"NoProtectionCount\\": 5,\\n \\"TotalCount\\": 10,\\n \\"ProtectionRate\\": \\"50.00\\",\\n \\"ProtectionGrowthRate\\": \\"35.00\\"\\n },\\n \\"CfwProtection\\": {\\n \\"ProtectionCount\\": 5,\\n \\"NoProtectionCount\\": 5,\\n \\"TotalCount\\": 10,\\n \\"ProtectionRate\\": \\"50.00\\",\\n \\"ProtectionGrowthRate\\": \\"35.00\\"\\n }\\n },\\n \\"RequestId\\": \\"564f8bb9-df3c-42a0-877a-b35d48f66603\\",\\n \\"Code\\": \\"404\\",\\n \\"Message\\": \\"system error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetDocumentPage' => [
- 'summary' => 'Service Report Query',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetSowList' => [
+ 'summary' => 'Retrieves the SOW list.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '185960',
- 'abilityTreeNodes' => [
- 'FEATUREsosOEHKXE',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '212416',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
],
'parameters' => [
[
- 'name' => 'CurrentPage',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '当前页',
- 'description' => 'Current page.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '每页大小',
- 'description' => 'Page size.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '20',
- ],
- ],
- [
- 'name' => 'ReportType',
+ 'name' => 'DateType',
'in' => 'formData',
'schema' => [
- 'title' => '文档类型',
- 'description' => 'Report type.',
+ 'title' => '',
+ 'description' => 'The time filter type. Supports filtering by last 7 days, last 30 days, last half year, or custom time range.',
+ 'enumValueTitles' => ['oneYear' => 'last year.', 'month' => 'last 30 days.', 'halfYear' => 'last half year.', 'customize' => 'custom.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 1 => '安全服务',
- '应急响应',
- '风险评估',
- '漏洞扫描',
- '等保测评',
- ],
- 'example' => '1',
+ 'example' => 'month',
],
],
[
- 'name' => 'DocumentName',
+ 'name' => 'StartDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '文档名称',
- 'description' => 'Document name.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'month report',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1729478485000'],
],
[
- 'name' => 'DeliveredBy',
+ 'name' => 'EndDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '交付人',
- 'description' => 'Delivered by.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'luna',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732156885986'],
],
[
- 'name' => 'DocumentType',
+ 'name' => 'SuspEventSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '报告类型',
- 'description' => 'Document type.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- '日报',
- '周报',
- '月报',
- '季度总结报告',
- '年度总结报告',
- '服务总结报告',
- '应急响应报告',
- '漏扫扫描报告',
- '风险评估报告',
- '其他报告',
- '会议报告',
- 15 => '等保测评报告',
- ],
- 'example' => '0',
- ],
+ 'schema' => ['title' => '', 'description' => 'The alert event source.', 'type' => 'string', 'required' => false, 'example' => '该字段暂未使用，有问题请联系管理员'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'PageInfo' => [
- 'description' => 'Pagination information.',
- 'type' => 'object',
- 'properties' => [
- 'CurrentPage' => [
- 'description' => 'The current page number in pagination queries.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'Number of items per page in the returned data.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => 'Total number of queried items.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3149',
- ],
- ],
- ],
'Data' => [
- 'description' => 'Response data.',
+ 'description' => 'The data returned by the operation.',
'type' => 'array',
'items' => [
- 'description' => 'Data object.',
+ 'description' => 'The data object.',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '文档主键id',
- 'description' => 'Primary key ID of the document.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '346409',
- ],
- 'DocumentType' => [
- 'title' => '服务报告类型',
- 'description' => 'Service report type.',
- 'type' => 'string',
- 'example' => '3',
- ],
- 'DeliveredBy' => [
- 'title' => '交付人',
- 'description' => 'Delivered by.',
- 'type' => 'string',
- 'example' => 'luna',
- ],
- 'UploadTime' => [
- 'title' => '报告生成时间',
- 'description' => 'Report generation time.',
- 'type' => 'string',
- 'example' => '2023-03-21 17:26:34',
- ],
- 'DocumentName' => [
- 'title' => '报告名称',
- 'description' => 'Report name.',
- 'type' => 'string',
- 'example' => 'month report',
- ],
- 'ReportStatus' => [
- 'description' => 'Report status.',
+ 'TaskTypeName' => ['title' => '', 'description' => 'The task type.', 'type' => 'string', 'example' => '安全风险评估'],
+ 'StartTime' => ['title' => '', 'description' => 'The start time.', 'type' => 'string', 'example' => '2023-03-24 16:51:26'],
+ 'CompleteTime' => ['title' => '', 'description' => 'The completion time.', 'type' => 'string', 'example' => '2024-03-28 16:19:35'],
+ 'Progress' => [
+ 'title' => '',
+ 'description' => 'The progress. Valid values:'."\n"
+ .'- COMPLETED: Completed.'."\n"
+ .'- IN_PROCESS: In progress.'."\n"
+ .'- IN_PREPARATION: In preparation.',
+ 'enumValueTitles' => ['COMPLETED' => 'Completed.', 'IN_PROCESS' => 'In progress.', 'IN_PREPARATION' => 'In preparation.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'userConfirmed' => '已归档',
- 'uploaded' => '用户待查收',
- ],
- 'example' => 'uploaded',
+ 'example' => 'IN_PREPARATION',
],
+ 'RecordCount' => ['title' => '', 'description' => 'The number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '173'],
+ 'WorkOrderName' => ['title' => '', 'description' => 'The ticket name.', 'type' => 'string', 'example' => '安全产品配置问题与超量提醒'],
+ 'OperateRemark' => ['title' => '', 'description' => 'The operation remarks.', 'type' => 'string', 'example' => '新建'],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '04DAD7B4-E1DA-5C2C-8E5C-A1EDC880CF60',
- ],
- 'Code' => [
- 'description' => 'API response code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Prompt message for the result.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the call was successful. - **true**: The call was successful. - **false**: The call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => 'FA8883BC-CB18-5E28-A113-8249917CA05E'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3149\\n },\\n \\"Data\\": [\\n {\\n \\"Id\\": 346409,\\n \\"DocumentType\\": \\"3\\",\\n \\"DeliveredBy\\": \\"张三\\",\\n \\"UploadTime\\": \\"2023-03-21 17:26:34\\",\\n \\"DocumentName\\": \\"季度报告\\",\\n \\"ReportStatus\\": \\"uploaded\\"\\n }\\n ],\\n \\"RequestId\\": \\"04DAD7B4-E1DA-5C2C-8E5C-A1EDC880CF60\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Service Report Query',
- 'translator' => 'machine',
- ],
- 'GetDocumentDownloadUrl' => [
- 'summary' => 'Single Service Report Download',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
+ 'title' => 'Retrieve SOW list',
+ 'changeSet' => [],
+ 'ramActions' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '185959',
- 'abilityTreeNodes' => [
- 'FEATUREsosOEHKXE',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'Id',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Document management ID.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '175815',
- ],
- ],
- [
- 'name' => 'ReportType',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Report type.',
- 'example' => '5',
- ],
- ],
- [
- 'name' => 'FileKey',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'description' => 'OSS file access URL.',
- 'type' => 'string',
- 'example' => 'https://oos-cn.ctyunapi.cn/example-bucket/test/1.jpg',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'C7BE80B4-7692-54FA-AB22-2A7DF08C4754',
- ],
- 'Code' => [
- 'description' => 'API status code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Message of the returned result.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful: - **true**: The call was successful. - **false**: The call failed. ',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetSowList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"https://oos-cn.ctyunapi.cn/example-bucket/test/1.jpg\\",\\n \\"RequestId\\": \\"C7BE80B4-7692-54FA-AB22-2A7DF08C4754\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Single Service Report Download',
- 'translator' => 'machine',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TaskTypeName\\": \\"安全风险评估\\",\\n \\"StartTime\\": \\"2023-03-24 16:51:26\\",\\n \\"CompleteTime\\": \\"2024-03-28 16:19:35\\",\\n \\"Progress\\": \\"IN_PREPARATION\\",\\n \\"RecordCount\\": 173,\\n \\"WorkOrderName\\": \\"安全产品配置问题与超量提醒\\",\\n \\"OperateRemark\\": \\"新建\\"\\n }\\n ],\\n \\"RequestId\\": \\"FA8883BC-CB18-5E28-A113-8249917CA05E\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetSuspEventPage' => [
- 'summary' => 'Alarm Disposal Query',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3304,9 +1955,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '185961',
- 'abilityTreeNodes' => [
- 'FEATUREsos0FVTHS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsos0FVTHS'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -3314,42 +1963,22 @@
[
'name' => 'CurrentPage',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前页页码',
- 'description' => 'Current page number.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页大小',
- 'description' => 'Number of items per page.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
[
'name' => 'Source',
'in' => 'formData',
'schema' => [
- 'title' => '告警来源',
- 'description' => 'Alarm source.',
+ 'title' => '',
+ 'description' => 'The alert source.',
+ 'enumValueTitles' => ['SYSTEM_SECURITY_EVENT' => 'Legacy data source of Security Center alerts.', 'SUSP_CUSTOM_WAF' => 'MDR_WAF event.', 'SUSP_EVENT' => 'Security Center.', 'SUSP_CUSTOM_DDOS' => 'MDR_DDOS event.', 'SUSP_CUSTOM_CFW' => 'MDR_CFW event.'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'SYSTEM_SECURITY_EVENT' => '云安全中心告警旧数据源',
- 'SUSP_CUSTOM_WAF' => 'MDR_WAF事件',
- 'SUSP_EVENT' => '云安全中心',
- 'SUSP_CUSTOM_DDOS' => 'MDR_DDOS事件',
- 'SUSP_CUSTOM_CFW' => 'MDR_CFW事件',
- ],
'example' => 'SUSP_EVENT',
],
],
@@ -3357,561 +1986,387 @@
'name' => 'Status',
'in' => 'formData',
'schema' => [
- 'title' => '处置状态',
- 'description' => 'Disposal status.',
+ 'title' => '',
+ 'description' => 'The handling status.',
+ 'enumValueTitles' => [1 => 'pending.', 'processing.', 'completed.', 'false positive.', 'ignored.', 15 => 'whitelisted in the console.', 'whitelisted on the customer side.'],
'type' => 'integer',
'format' => 'int32',
'required' => false,
- 'enumValueTitles' => [
- 1 => '待处理',
- '处理中',
- '处理完成',
- '误报',
- '已忽略',
- 15 => '控制台已加白',
- '客户侧已加白',
- ],
'example' => '1',
],
],
[
'name' => 'AlarmStartTime',
'in' => 'formData',
- 'schema' => [
- 'title' => '告警开始时间',
- 'description' => 'Alarm start time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1722515522000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time of the alert.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1722515522000'],
],
[
'name' => 'AlarmEndTime',
'in' => 'formData',
- 'schema' => [
- 'title' => '告警结束时间',
- 'description' => 'Alarm end time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1732515522000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end time of the alert.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1732515522000'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
'PageInfo' => [
- 'description' => 'Pagination information.',
+ 'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
- 'CurrentPage' => [
- 'description' => 'The current page number in pagination queries.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'The number of items displayed per page in the returned data.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => 'Total number of query results.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'CurrentPage' => ['description' => 'The page number of the current page in a paging query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page in the returned data.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries in the query result.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'Data' => [
- 'description' => 'Data returned by the interface.',
+ 'description' => 'The data returned by the operation.',
'type' => 'array',
'items' => [
- 'description' => 'Data object.',
+ 'description' => 'The data object.',
'type' => 'object',
'properties' => [
- 'AlarmId' => [
- 'title' => '告警id',
- 'description' => 'Alarm ID.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5b1eeebe4f22daa2b177298234214fa3',
- ],
- 'AlarmSource' => [
- 'title' => '告警来源',
- 'description' => 'Alarm source.',
- 'type' => 'string',
- 'example' => 'SUSP_EVENT',
- ],
- 'AlarmName' => [
- 'title' => '告警名称',
- 'description' => 'Alarm name.',
- 'type' => 'string',
- 'example' => 'Web服务漏洞利用',
- ],
- 'AlarmTime' => [
- 'title' => '最新告警时间',
- 'description' => 'Latest alarm time.',
- 'type' => 'string',
- 'example' => '1722515522000'."\n",
- ],
- 'DealTime' => [
- 'title' => '告警处理时间',
- 'description' => 'Alarm handling time.',
- 'type' => 'string',
- 'example' => '1732515522000'."\n",
- ],
+ 'AlarmId' => ['title' => '', 'description' => 'The alert ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5b1eeebe4f22daa2b177298234214fa3'],
+ 'AlarmSource' => ['title' => '', 'description' => 'The alert source.', 'type' => 'string', 'example' => 'SUSP_EVENT'],
+ 'AlarmName' => ['title' => '', 'description' => 'The alert name.', 'type' => 'string', 'example' => 'Web服务漏洞利用'],
+ 'AlarmTime' => ['title' => '', 'description' => 'The most recent alert time.', 'type' => 'string', 'example' => '1722515522000'."\n"],
+ 'DealTime' => ['title' => '', 'description' => 'The time when the alert was handled.', 'type' => 'string', 'example' => '1732515522000'."\n"],
'Status' => [
- 'title' => '处理状态',
- 'description' => 'Handling status.',
+ 'title' => '',
+ 'description' => 'The handling status.',
+ 'enumValueTitles' => [1 => 'Unhandled.', 'processing.', 'Handled.', 'Handled.', 'Handled.', 15 => 'Handled.', 'Handled.'],
'type' => 'string',
- 'enumValueTitles' => [
- 1 => '未处理',
- '处理中',
- '已处理',
- '已处理',
- '已处理',
- 15 => '已处理',
- '已处理',
- ],
'example' => '未处理',
],
- 'OwnerId' => [
- 'title' => '负责人',
- 'description' => 'Owner ID.',
- 'type' => 'string',
- 'example' => '张三',
- ],
- 'Remark' => [
- 'title' => '处置方式',
- 'description' => 'Disposal method.',
- 'type' => 'string',
- 'example' => '处理完成',
- ],
- 'InstanceName' => [
- 'title' => '受影响资产',
- 'description' => 'Affected asset.',
- 'type' => 'string',
- 'example' => 'shells-azhou',
- ],
+ 'OwnerId' => ['title' => '', 'description' => 'The owner.', 'type' => 'string', 'example' => '张三'],
+ 'Remark' => ['title' => '', 'description' => 'The handling method.', 'type' => 'string', 'example' => '处理完成'],
+ 'InstanceName' => ['title' => '', 'description' => 'The affected asset.', 'type' => 'string', 'example' => 'shells-azhou'],
'EventLevel' => [
- 'title' => '告警等级',
- 'description' => 'Alarm level.',
+ 'title' => '',
+ 'description' => 'The alert level.',
+ 'enumValueTitles' => ['serious' => 'Critical.', 'suspicious' => 'Suspicious.', 'remind' => 'Reminder.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'serious' => '紧急',
- 'suspicious' => '可疑',
- 'remind' => '提醒',
- ],
'example' => 'suspicious',
],
- 'OccurrenceTime' => [
- 'title' => '首次发生时间',
- 'description' => 'First occurrence time.',
- 'type' => 'string',
- 'example' => '该字段暂未使用，有问题请联系管理员',
- ],
- 'InternetIp' => [
- 'title' => '公网ip',
- 'description' => 'Public IP address.',
- 'type' => 'string',
- 'example' => '47.99.188.31',
- ],
- 'IntranetIp' => [
- 'title' => '内网ip',
- 'description' => 'Private IP address.',
- 'type' => 'string',
- 'example' => '172.16.109.130',
- ],
- 'Id' => [
- 'title' => '工单主键id',
- 'description' => 'Ticket primary key id.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '9947',
- ],
- 'AlarmEventType' => [
- 'title' => '告警事件类型',
- 'description' => 'Alarm event type.',
- 'type' => 'string',
- 'example' => '精准防御',
- ],
- 'AnalysisResult' => [
- 'title' => '分析过程',
- 'description' => 'Analysis process.',
- 'type' => 'string',
- 'example' => '[{"value":"服务器可能已被黑客攻击，存在恶意进程在运行。 分析过程：告警显示，服务端存在一个名为”dns.exe”的进程在访问”polling.burpcollaborator.net”，这是一个被黑名单列出的恶意域名。在正常情况下,”dns.exe”不应该单独存在于系统的路径下，并且也不应该访问这类恶意域名。因此，这个进程可能是黑客留下的恶意进程。","key":"结论"},{"value":"尽快对服务器进行全面扫描，清除恶意进程。同时，联系网络安全专家进行深入调查，以确定是否有其他潜在的安全威胁。","key":"处置建议"}]',
- ],
+ 'OccurrenceTime' => ['title' => '', 'description' => 'The time of the first occurrence.', 'type' => 'string', 'example' => '该字段暂未使用，有问题请联系管理员'],
+ 'InternetIp' => ['title' => '', 'description' => 'The public IP address.', 'type' => 'string', 'example' => '47.99.188.31'],
+ 'IntranetIp' => ['title' => '', 'description' => 'The internal IP address.', 'type' => 'string', 'example' => '172.16.109.130'],
+ 'Id' => ['title' => '', 'description' => 'The primary key ID of the ticket.', 'type' => 'integer', 'format' => 'int64', 'example' => '9947'],
+ 'AlarmEventType' => ['title' => '', 'description' => 'The alert event type.', 'type' => 'string', 'example' => '精准防御'],
+ 'AnalysisResult' => ['title' => '', 'description' => 'The analysis process.', 'type' => 'string', 'example' => '[{"value":"服务器可能已被黑客攻击，存在恶意进程在运行。 分析过程：告警显示，服务端存在一个名为”dns.exe”的进程在访问”polling.burpcollaborator.net”，这是一个被黑名单列出的恶意域名。在正常情况下,”dns.exe”不应该单独存在于系统的路径下，并且也不应该访问这类恶意域名。因此，这个进程可能是黑客留下的恶意进程。","key":"结论"},{"value":"尽快对服务器进行全面扫描，清除恶意进程。同时，联系网络安全专家进行深入调查，以确定是否有其他潜在的安全威胁。","key":"处置建议"}]'],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AFA6F7B7-7C4B-58BB-B8FB-E0FFA4483561',
- ],
- 'Code' => [
- 'description' => 'API response code.',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => 'Prompt message of the returned result.',
- 'type' => 'string',
- 'example' => 'system error',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful.'."\n"
- .'- **true**: The call was successful. - **false**: The call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => 'AFA6F7B7-7C4B-58BB-B8FB-E0FFA4483561'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'Message' => ['description' => 'The message returned with the result.', 'type' => 'string', 'example' => 'system error', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ ."\n"
+ .'- **true**: The call was successful.'."\n"
+ ."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query alert handling records',
+ 'summary' => 'Queries alert handling records.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetSuspEventPage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100\\n },\\n \\"Data\\": [\\n {\\n \\"AlarmId\\": 0,\\n \\"AlarmSource\\": \\"SUSP_EVENT\\",\\n \\"AlarmName\\": \\"Web服务漏洞利用\\",\\n \\"AlarmTime\\": \\"1722515522000\\\\n\\",\\n \\"DealTime\\": \\"1732515522000\\\\n\\",\\n \\"Status\\": \\"未处理\\",\\n \\"OwnerId\\": \\"张三\\",\\n \\"Remark\\": \\"处理完成\\",\\n \\"InstanceName\\": \\"shells-azhou\\",\\n \\"EventLevel\\": \\"suspicious\\",\\n \\"OccurrenceTime\\": \\"该字段暂未使用，有问题请联系管理员\\",\\n \\"InternetIp\\": \\"47.99.188.31\\",\\n \\"IntranetIp\\": \\"172.16.109.130\\",\\n \\"Id\\": 9947,\\n \\"AlarmEventType\\": \\"精准防御\\",\\n \\"AnalysisResult\\": \\"[{\\\\\\"value\\\\\\":\\\\\\"服务器可能已被黑客攻击，存在恶意进程在运行。 分析过程：告警显示，服务端存在一个名为”dns.exe”的进程在访问”polling.burpcollaborator.net”，这是一个被黑名单列出的恶意域名。在正常情况下,”dns.exe”不应该单独存在于系统的路径下，并且也不应该访问这类恶意域名。因此，这个进程可能是黑客留下的恶意进程。\\\\\\",\\\\\\"key\\\\\\":\\\\\\"结论\\\\\\"},{\\\\\\"value\\\\\\":\\\\\\"尽快对服务器进行全面扫描，清除恶意进程。同时，联系网络安全专家进行深入调查，以确定是否有其他潜在的安全威胁。\\\\\\",\\\\\\"key\\\\\\":\\\\\\"处置建议\\\\\\"}]\\"\\n }\\n ],\\n \\"RequestId\\": \\"AFA6F7B7-7C4B-58BB-B8FB-E0FFA4483561\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"system error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Alarm Disposal Query',
- 'translator' => 'machine',
],
- 'GetVulItemPage' => [
- 'summary' => 'Risk Query',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetSuspEventSummary' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '185958',
- 'abilityTreeNodes' => [
- 'FEATUREsosYT8XCW',
- ],
+ 'abilityTreeCode' => '179681',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'CurrentPage',
+ 'name' => 'DateType',
'in' => 'formData',
'schema' => [
- 'description' => 'Current page number.',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '',
+ 'description' => 'The time filter type. You can filter by the last 7 days, last 30 days, last half year, or a custom time range.',
+ 'enumValueTitles' => ['oneYear' => 'last year.', 'month' => 'last 30 days.', 'halfYear' => 'last half year.', 'customize' => 'custom time range.'],
+ 'type' => 'string',
'required' => true,
- 'example' => '1',
+ 'example' => 'month',
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'StartDate',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Number of items to display per page in the returned data.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1729478485000'],
],
[
- 'name' => 'ScanType',
+ 'name' => 'EndDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '漏洞类型',
- 'description' => 'Vulnerability type.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'sca' => '软件成分分析',
- 'app' => '应用漏洞',
- 'cve' => 'Linux漏洞',
- 'cms' => 'WebCMS漏洞',
- 'sys' => 'Windows漏洞',
- 'emg' => '应急漏洞',
- ],
- 'example' => 'sca',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732156885986'],
],
[
- 'name' => 'Level',
+ 'name' => 'SuspEventSource',
'in' => 'formData',
'schema' => [
- 'title' => '风险等级',
- 'description' => 'Risk level.',
+ 'title' => '',
+ 'description' => 'The source of the alert event.',
+ 'enumValueTitles' => ['SYSTEM_SECURITY_EVENT' => 'legacy data source of Security Center alerts.', 'SUSP_CUSTOM_WAF' => 'MDR_WAF events.', 'SUSP_EVENT' => 'Security Center.', 'SUSP_CUSTOM_DDOS' => 'MDR_DDOS events.', 'SUSP_CUSTOM_CFW' => 'MDR_CFW events.'],
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'nntf' => '低',
- 'later' => '中',
- 'asap' => '高',
- ],
- 'example' => 'later',
+ 'example' => 'SUSP_EVENT',
],
],
- [
- 'name' => 'Dealed',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '处理状态 y:已处理；n:未处理；h:处理中',
- 'description' => 'Processing status. y: processed; n: unprocessed; h: processing.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'n',
+ 'title' => '',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The data returned by the operation.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SuspEventDealSummaryDTO' => [
+ 'title' => '',
+ 'description' => 'The alert handling summary.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WaitHandleCount' => ['title' => '', 'description' => 'The number of unhandled alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'HandingCount' => ['title' => '', 'description' => 'The number of alerts being handled.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'CompletedCount' => ['title' => '', 'description' => 'The number of handled alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '35'],
+ 'HandingRate' => ['title' => '', 'description' => 'The alert handling rate.', 'type' => 'string', 'example' => '90'],
+ 'TotalGrowthRate' => ['title' => '', 'description' => 'The year-over-year growth rate of alerts.', 'type' => 'string', 'example' => '10'],
+ ],
+ 'example' => '',
+ ],
+ 'SuspEventTrendDTO' => [
+ 'title' => '',
+ 'description' => 'The alert response trend.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TrendList' => [
+ 'title' => '',
+ 'description' => 'The alert trend data.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Date' => ['title' => '', 'description' => 'The time point.', 'type' => 'string', 'example' => '202405或者20240501'],
+ 'DealCount' => ['title' => '', 'description' => 'The number of handled alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'FindCount' => ['title' => '', 'description' => 'The number of detected alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'SuspEventTopDTO' => [
+ 'title' => '',
+ 'description' => 'The top 10 alerts before handling.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SuspEventList' => [
+ 'title' => '',
+ 'description' => 'The top 10 alerts before handling.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EventName' => ['title' => '', 'description' => 'The alert name.', 'type' => 'string', 'example' => '主动外连风险 IP'],
+ 'TaskCount' => ['title' => '', 'description' => 'The count.', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'NetworkAttackTrendDTO' => [
+ 'title' => '',
+ 'description' => 'The network attack trend.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TrendList' => [
+ 'title' => '',
+ 'description' => 'The trend data points for each attack type.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Date' => ['title' => '', 'description' => 'The date.', 'type' => 'string', 'example' => '202409或20240901'],
+ 'DdosCount' => ['title' => '', 'description' => 'The number of DDoS attacks.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'WafCount' => ['title' => '', 'description' => 'The number of WAF attacks.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'EipCount' => ['title' => '', 'description' => 'The number of EIP attacks.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '9B2DAE9B-B901-5818-AFEF-E5637D938280'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The call was successful.'."\n"
+ ."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve alert statistics',
+ 'summary' => 'Retrieves statistics of security alerts.',
+ 'changeSet' => [],
+ 'ramActions' => [
[
- 'name' => 'Name',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '漏洞名称',
- 'description' => 'Vulnerability name.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oval:com.redhat.rhsa:def:20183665',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetSuspEventSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SuspEventDealSummaryDTO\\": {\\n \\"WaitHandleCount\\": 10,\\n \\"HandingCount\\": 5,\\n \\"CompletedCount\\": 20,\\n \\"TotalCount\\": 35,\\n \\"HandingRate\\": \\"90\\",\\n \\"TotalGrowthRate\\": \\"10\\"\\n },\\n \\"SuspEventTrendDTO\\": {\\n \\"TrendList\\": [\\n {\\n \\"Date\\": \\"202405或者20240501\\",\\n \\"DealCount\\": 10,\\n \\"FindCount\\": 15\\n }\\n ]\\n },\\n \\"SuspEventTopDTO\\": {\\n \\"SuspEventList\\": [\\n {\\n \\"EventName\\": \\"主动外连风险 IP\\",\\n \\"TaskCount\\": 7\\n }\\n ]\\n },\\n \\"NetworkAttackTrendDTO\\": {\\n \\"TrendList\\": [\\n {\\n \\"Date\\": \\"202409或20240901\\",\\n \\"DdosCount\\": 10,\\n \\"WafCount\\": 10,\\n \\"EipCount\\": 10\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"9B2DAE9B-B901-5818-AFEF-E5637D938280\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetSuspPageSummary' => [
+ 'summary' => 'Retrieves alert page statistics.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'AliasName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '漏洞别名',
- 'description' => 'Vulnerability alias.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'RHSA-2018:3665-Important: NetworkManager security update',
- ],
+ 'AK' => [],
],
],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '180003',
+ 'abilityTreeNodes' => ['FEATUREsos0FVTHS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'PageInfo' => [
- 'description' => 'Pagination information.',
+ 'Data' => [
+ 'description' => 'The data returned by the operation.',
'type' => 'object',
'properties' => [
- 'CurrentPage' => [
- 'description' => 'The current page number for pagination queries.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => 'Number of items to display per page in the returned data.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => 'Total number of records in the query result.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '163',
- ],
- ],
- ],
- 'Data' => [
- 'description' => 'Data returned by the interface.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Data object.',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '主键id',
- 'description' => 'Primary key ID.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '353845',
- ],
- 'CustomerId' => [
- 'title' => '用户id',
- 'description' => 'User ID.',
- 'type' => 'string',
- 'example' => '1940494487193744',
- ],
- 'AliasName' => [
- 'title' => '漏洞别名。',
- 'description' => 'Vulnerability alias.',
- 'type' => 'string',
- 'example' => 'RHSA-2024:4620: libndp 安全更新',
- ],
- 'AsapCount' => [
- 'title' => '修复优先级为高的漏洞的数量。',
- 'description' => 'Number of high-priority vulnerabilities to be fixed.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '74',
- ],
- 'FindTime' => [
- 'title' => '漏洞最后发现的时间戳',
- 'description' => 'Timestamp of the last discovery of the vulnerability.',
- 'type' => 'string',
- 'example' => '2023-04-23 14:47:34',
- ],
- 'HandledCount' => [
- 'title' => '已处理的漏洞数量。',
- 'description' => 'Number of processed vulnerabilities.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'LaterCount' => [
- 'title' => '修复优先级为中的漏洞的数量。',
- 'description' => 'Number of medium-priority vulnerabilities to be fixed.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Name' => [
- 'title' => '漏洞名称。',
- 'description' => 'Vulnerability name.',
- 'type' => 'string',
- 'example' => 'oval:com.redhat.rhsa:def:20205002',
- ],
- 'NntfCount' => [
- 'title' => '修复优先级为低的漏洞的数量。',
- 'description' => 'Number of low-priority vulnerabilities to be fixed.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'Tags' => [
- 'title' => '标签',
- 'description' => 'Tags.',
- 'type' => 'string',
- 'example' => 'Elevation of Privilege',
- ],
- 'TotalFixCount' => [
- 'title' => '已修复漏洞的总数量。',
- 'description' => 'Total number of fixed vulnerabilities.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'ScanType' => [
- 'title' => '漏洞类型。取值：',
- 'description' => 'Vulnerability type.',
- 'type' => 'string',
- 'example' => 'sca',
- ],
- 'Level' => [
- 'title' => '风险等级',
- 'description' => 'Risk level',
- 'type' => 'string',
- 'example' => 'later',
- ],
- 'Dealed' => [
- 'title' => '处理状态',
- 'description' => 'Processing status.',
- 'type' => 'string',
- 'example' => 'y',
- ],
- 'Related' => [
- 'title' => 'cve编号',
- 'description' => 'CVE number.',
- 'type' => 'string',
- 'example' => 'CVE-2019-20907',
- ],
- 'RelatedCveCount' => [
- 'title' => '关联的cve编号的数量',
- 'description' => 'Number of related CVE numbers.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'CveUrlPrefix' => [
- 'title' => 'cve修复建议地址前缀',
- 'description' => 'Prefix for the CVE remediation advice URL.',
- 'type' => 'string',
- 'example' => 'https://avd.aliyun.com/detail/',
- ],
- ],
+ 'WaitHandleCount' => ['title' => '', 'description' => 'The number of unhandled alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'HandingCount' => ['title' => '', 'description' => 'The number of alerts being handled.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'CompletedCount' => ['title' => '', 'description' => 'The number of handled alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
+ 'HighCount' => ['title' => '', 'description' => 'The number of high-risk alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'MediumCount' => ['title' => '', 'description' => 'The number of medium-risk alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'LowCount' => ['title' => '', 'description' => 'The number of low-risk alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request response.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '02F8BBF3-2D61-5982-8911-EEB387BE3AF8',
- ],
- 'Code' => [
- 'description' => 'API response code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Prompt message for the returned result.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful.'."\n"
- .'true: Call succeeded. false: Call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => 'EF801DD1-D934-51B3-92D4-776CE17B184F'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Alert page statistics',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetSuspPageSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 163\\n },\\n \\"Data\\": [\\n {\\n \\"Id\\": 353845,\\n \\"CustomerId\\": \\"1940494487193744\\",\\n \\"AliasName\\": \\"RHSA-2024:4620: libndp 安全更新\\",\\n \\"AsapCount\\": 74,\\n \\"FindTime\\": \\"2023-04-23 14:47:34\\",\\n \\"HandledCount\\": 20,\\n \\"LaterCount\\": 10,\\n \\"Name\\": \\"oval:com.redhat.rhsa:def:20205002\\",\\n \\"NntfCount\\": 8,\\n \\"Tags\\": \\"Elevation of Privilege\\",\\n \\"TotalFixCount\\": 50,\\n \\"ScanType\\": \\"sca\\",\\n \\"Level\\": \\"later\\",\\n \\"Dealed\\": \\"y\\",\\n \\"Related\\": \\"CVE-2019-20907\\",\\n \\"RelatedCveCount\\": 20,\\n \\"CveUrlPrefix\\": \\"https://avd.aliyun.com/detail/\\"\\n }\\n ],\\n \\"RequestId\\": \\"02F8BBF3-2D61-5982-8911-EEB387BE3AF8\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Risk Query',
- 'translator' => 'machine',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"WaitHandleCount\\": 10,\\n \\"HandingCount\\": 10,\\n \\"CompletedCount\\": 10,\\n \\"TotalCount\\": 30,\\n \\"HighCount\\": 10,\\n \\"MediumCount\\": 10,\\n \\"LowCount\\": 10\\n },\\n \\"RequestId\\": \\"EF801DD1-D934-51B3-92D4-776CE17B184F\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetUserStatus' => [
- 'summary' => 'Query User Activation Status',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3924,9 +2379,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '191425',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -3934,668 +2387,466 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'Data returned by the interface.',
+ 'description' => 'The data returned by the operation.',
'type' => 'object',
'properties' => [
'Status' => [
- 'description' => 'Status.',
+ 'description' => 'The status.',
+ 'enumValueTitles' => ['NotEnabled' => 'Not enabled.', 'FirstLogin' => 'First login.', 'Enabled' => 'Enabled.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'NotEnabled' => '未启用',
- 'FirstLogin' => '首次登录',
- 'Enabled' => '启用',
- ],
'example' => 'FirstLogin',
+ 'title' => '',
],
'Version' => [
- 'title' => '版本',
- 'description' => 'Version.',
+ 'title' => '',
+ 'description' => 'The version.',
+ 'enumValueTitles' => ['qiye' => 'MDR Enterprise Edition.', 'huhang' => 'MDR Escort Edition.', 'saszhjia' => 'Security Center Expert Edition.', 'mdrjichu' => 'MDR Basic Edition.', 'cfwtuoguan' => 'CFW Managed Edition.', 'mdrgaoji' => 'MDR Advanced Edition.', 'waftuoguan' => 'WAF Managed Edition.', 'base' => 'Basic Edition.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'qiye' => 'MDR企业版',
- 'huhang' => 'MDR护航版',
- 'saszhjia' => '云安全中心专家版',
- 'mdrjichu' => 'MDR基础版',
- 'cfwtuoguan' => 'CFW托管版',
- 'mdrgaoji' => 'MDR高级版',
- 'waftuoguan' => 'WAF托管版',
- 'base' => '基础版',
- ],
'example' => 'mdrjichu',
],
- 'EndDate' => [
- 'description' => 'End date.',
- 'type' => 'string',
- 'example' => '2023-09-28 00:00:00',
- ],
- 'InstanceId' => [
- 'description' => 'Instance ID.',
- 'type' => 'string',
- 'example' => '726cec3c-4887-4354-8c21-c0ad12e10fc2',
- ],
- 'StartDate' => [
- 'description' => 'Start date.',
- 'type' => 'string',
- 'example' => '2023-09-20 00:00:00',
- ],
+ 'EndDate' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2023-09-28 00:00:00', 'title' => ''],
+ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '726cec3c-4887-4354-8c21-c0ad12e10fc2', 'title' => ''],
+ 'StartDate' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2023-09-20 00:00:00', 'title' => ''],
'CustomerType' => [
- 'description' => 'Customer type.',
+ 'description' => 'The customer type.',
+ 'enumValueTitles' => ['official' => 'Official customer.', 'trial' => 'Trial customer.'],
'type' => 'string',
- 'enumValueTitles' => [
- 'official' => '正式客户',
- 'trial' => '试用客户',
- ],
'example' => 'official',
+ 'title' => '',
],
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'D8DBD769-613E-5E6B-A9FD-B622375B152D',
- ],
- 'Code' => [
- 'description' => 'Interface response code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Prompt message of the returned result.',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the call was successful. - **true**: The call was successful. - **false**: The call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => 'D8DBD769-613E-5E6B-A9FD-B622375B152D'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful.'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query user activation status',
+ 'summary' => 'Queries the activation status of a user.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetUserStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Status\\": \\"FirstLogin\\",\\n \\"Version\\": \\"mdrjichu\\",\\n \\"EndDate\\": \\"2023-09-28 00:00:00\\",\\n \\"InstanceId\\": \\"726cec3c-4887-4354-8c21-c0ad12e10fc2\\",\\n \\"StartDate\\": \\"2023-09-20 00:00:00\\",\\n \\"CustomerType\\": \\"official\\"\\n },\\n \\"RequestId\\": \\"D8DBD769-613E-5E6B-A9FD-B622375B152D\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Query User Activation Status',
- 'translator' => 'machine',
],
- 'CreateServiceWorkOrder' => [
- 'summary' => 'Create Service Work Order',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetVulItemPage' => [
+ 'summary' => 'Queries security risks.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '216184',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeCode' => '185958',
+ 'abilityTreeNodes' => ['FEATUREsosYT8XCW'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'WorkOrderName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '工单名称',
- 'description' => 'Work order name.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Delivery task of safety monthly report',
- ],
- ],
- [
- 'name' => 'WorkOrderType',
+ 'name' => 'CurrentPage',
'in' => 'formData',
- 'schema' => [
- 'title' => '工单类型',
- 'description' => 'Work order type.',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'YEAR_MEETING' => '年度会议',
- 'SYSTEM_VULNERABILITY_SCAN' => '扫描器漏洞扫描',
- 'RISK_BRIEFING' => '风险讲解会',
- 'SUMMARY_REPORT' => '总结报告',
- 'DING_TALK_CUSTOMER' => '客户钉钉咨询',
- 'MONTH_REPORT' => '月报',
- 'YEAR_REPORT' => '年度报告',
- 'OTHER_REPORTS' => '其他报告',
- 'PLATFORM_VULNERABILITY_MONITOR' => '漏洞巡检监控',
- 'PROJECT_PLAN' => '项目计划',
- 'PROJECT_SUMMARY_MEETING' => '项目总结会',
- 'SYSTEM_SECURITY_ACCESS' => '安全评估',
- 'PROJECT_QUARTERLY_MEETING' => '项目季度会',
- 'LARGE_SCREEN' => '安全大屏',
- 'USER_SURVEY' => '用户调研',
- 'CUSTOMER_VIEW' => '客户回访',
- 'MANUAL' => '人工',
- 'RISK_NOTIFY' => '风险提醒',
- 'QUARTERLY_REPORT' => '季报',
- 'YUNDUN_VULNERABILITY_SCAN' => '云安全中心漏洞扫描',
- 'PROJECT_LAUNCH_MEETING' => '项目启动会',
- ],
- 'example' => 'MONTH_REPORT',
- ],
+ 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'WorkOrderSource',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '工单来源',
- 'description' => 'Work order source.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Work order migration',
- ],
+ 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'WorkOrderStatus',
+ 'name' => 'ScanType',
'in' => 'formData',
'schema' => [
- 'title' => '工单状态',
- 'description' => 'Work order status.',
+ 'title' => '',
+ 'description' => 'The vulnerability type.',
+ 'enumValueTitles' => ['sca' => 'software composition analysis.', 'app' => 'application vulnerability.', 'cve' => 'Linux vulnerability.', 'cms' => 'WebCMS vulnerability.', 'sys' => 'Windows vulnerability.', 'emg' => 'emergency vulnerability.'],
'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'UNPROCESSED' => '待处理',
- 'PROCESSING' => '处理中',
- 'BACK' => '已退回',
- 'PROCESSED' => '处理完成',
- 'INVALID' => '误报',
- 'IGNORED' => '已忽略',
- ],
- 'example' => 'UNPROCESSED',
+ 'required' => false,
+ 'example' => 'sca',
],
],
[
- 'name' => 'CustomerId',
+ 'name' => 'Level',
'in' => 'formData',
'schema' => [
- 'title' => '客户ID',
- 'description' => 'Customer ID.',
+ 'title' => '',
+ 'description' => 'The risk level.',
+ 'enumValueTitles' => ['nntf' => 'low.', 'later' => 'medium.', 'asap' => 'high.'],
'type' => 'string',
- 'required' => true,
- 'example' => '1477832102462645',
+ 'required' => false,
+ 'example' => 'later',
],
],
[
- 'name' => 'StartTime',
+ 'name' => 'Dealed',
'in' => 'formData',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => 'Start time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1734788109000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The processing status. Valid values:'."\n"
+ .'- y: handled.'."\n"
+ .'- n: unhandled.'."\n"
+ .'- h: handling.', 'type' => 'string', 'required' => false, 'example' => 'n'],
],
[
- 'name' => 'Operator',
+ 'name' => 'Name',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作人',
- 'description' => 'Operator.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '426556',
- ],
+ 'schema' => ['title' => '', 'description' => 'The vulnerability name.', 'type' => 'string', 'required' => false, 'example' => 'oval:com.redhat.rhsa:def:20183665'],
],
[
- 'name' => 'OperateType',
+ 'name' => 'AliasName',
'in' => 'formData',
- 'schema' => [
- 'title' => '操作类型',
- 'description' => 'Operation type.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CREATE',
- ],
+ 'schema' => ['title' => '', 'description' => 'The vulnerability alias.', 'type' => 'string', 'required' => false, 'example' => 'RHSA-2018:3665-Important: NetworkManager security update'],
],
- [
- 'name' => 'OperateRemark',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '操作备注',
- 'description' => 'Operation remarks.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'newly built',
+ 'title' => '',
+ 'description' => 'The response.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageInfo' => [
+ 'description' => 'The pagination information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CurrentPage' => ['description' => 'The page number of the current page in a paging query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of records in the query result.', 'type' => 'integer', 'format' => 'int32', 'example' => '163', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned by the operation.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '', 'description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '353845'],
+ 'CustomerId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '1940494487193744'],
+ 'AliasName' => ['title' => '', 'description' => 'The vulnerability alias.', 'type' => 'string', 'example' => 'RHSA-2024:4620: libndp 安全更新'],
+ 'AsapCount' => ['title' => '', 'description' => 'The number of vulnerabilities with a high fix priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '74'],
+ 'FindTime' => ['title' => '', 'description' => 'The timestamp when the vulnerability was last detected.', 'type' => 'string', 'example' => '2023-04-23 14:47:34'],
+ 'HandledCount' => ['title' => '', 'description' => 'The number of handled vulnerabilities.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'LaterCount' => ['title' => '', 'description' => 'The number of vulnerabilities with a medium fix priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Name' => ['title' => '', 'description' => 'The vulnerability name.', 'type' => 'string', 'example' => 'oval:com.redhat.rhsa:def:20205002'],
+ 'NntfCount' => ['title' => '', 'description' => 'The number of vulnerabilities with a low fix priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ 'Tags' => ['title' => '', 'description' => 'The tags.', 'type' => 'string', 'example' => 'Elevation of Privilege'],
+ 'TotalFixCount' => ['title' => '', 'description' => 'The total number of fixed vulnerabilities.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'ScanType' => ['title' => '', 'description' => 'The vulnerability type.', 'type' => 'string', 'example' => 'sca'],
+ 'Level' => ['title' => '', 'description' => 'The risk level.', 'type' => 'string', 'example' => 'later'],
+ 'Dealed' => ['title' => '', 'description' => 'The processing status.', 'type' => 'string', 'example' => 'y'],
+ 'Related' => ['title' => '', 'description' => 'The CVE ID.', 'type' => 'string', 'example' => 'CVE-2019-20907'],
+ 'RelatedCveCount' => ['title' => '', 'description' => 'The number of associated CVE IDs.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'CveUrlPrefix' => ['title' => '', 'description' => 'The URL prefix for CVE fix suggestions.', 'type' => 'string', 'example' => 'https://avd.aliyun.com/detail/'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '02F8BBF3-2D61-5982-8911-EEB387BE3AF8'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The call was successful.'."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ ],
+ 'example' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query security risks',
+ 'changeSet' => [],
+ 'ramActions' => [
[
- 'name' => 'WorkOrderDetail',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '工单详情',
- 'description' => 'Work order details.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{"questionDetail":"测试工单","answerDetail":""}',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetVulItemPage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 163\\n },\\n \\"Data\\": [\\n {\\n \\"Id\\": 353845,\\n \\"CustomerId\\": \\"1940494487193744\\",\\n \\"AliasName\\": \\"RHSA-2024:4620: libndp 安全更新\\",\\n \\"AsapCount\\": 74,\\n \\"FindTime\\": \\"2023-04-23 14:47:34\\",\\n \\"HandledCount\\": 20,\\n \\"LaterCount\\": 10,\\n \\"Name\\": \\"oval:com.redhat.rhsa:def:20205002\\",\\n \\"NntfCount\\": 8,\\n \\"Tags\\": \\"Elevation of Privilege\\",\\n \\"TotalFixCount\\": 50,\\n \\"ScanType\\": \\"sca\\",\\n \\"Level\\": \\"later\\",\\n \\"Dealed\\": \\"y\\",\\n \\"Related\\": \\"CVE-2019-20907\\",\\n \\"RelatedCveCount\\": 20,\\n \\"CveUrlPrefix\\": \\"https://avd.aliyun.com/detail/\\"\\n }\\n ],\\n \\"RequestId\\": \\"02F8BBF3-2D61-5982-8911-EEB387BE3AF8\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetVulListById' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'DurationDay',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '持续天数',
- 'description' => 'Duration in days.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '5',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '179781',
+ 'abilityTreeNodes' => ['FEATUREsosYT8XCW'],
+ ],
+ 'parameters' => [
[
- 'name' => 'IsAttachment',
+ 'name' => 'CurrentPage',
'in' => 'formData',
- 'schema' => [
- 'title' => '附件要求',
- 'description' => 'Attachment requirement.',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'Y' => '是',
- 'N' => '否',
- ],
- 'example' => 'Y',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'IsWorkOrderNotify',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否需要提醒',
- 'description' => 'Whether a reminder is needed.',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'Y' => '是',
- 'N' => '否',
- ],
- 'example' => 'Y',
- ],
+ 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'NotifyDay',
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'title' => '提前提醒天数',
- 'description' => 'Number of days for advance notification.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '5',
- ],
+ 'schema' => ['title' => '', 'description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '4209205'],
],
[
- 'name' => 'Creator',
+ 'name' => 'Dealed',
'in' => 'formData',
- 'schema' => [
- 'title' => '创建人',
- 'description' => 'Creator.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '426556',
- ],
+ 'schema' => ['title' => '', 'description' => 'Specifies whether the vulnerability has been processed. Valid values:'."\n"
+ ."\n"
+ .'- y: processed'."\n"
+ .'- n: not processed.', 'type' => 'string', 'required' => false, 'example' => 'n'],
],
[
- 'name' => 'NotifyId',
+ 'name' => 'Necessity',
'in' => 'formData',
- 'schema' => [
- 'title' => '通知ID',
- 'description' => 'Notification ID.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '', 'description' => 'The risk level.', 'type' => 'string', 'required' => false, 'example' => 'asap,later,nntf'],
],
[
- 'name' => 'IsMilestone',
+ 'name' => 'Remark',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Is milestone.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Y' => '是',
- 'N' => '否',
- ],
- 'example' => 'Y',
- ],
+ 'schema' => ['title' => '', 'description' => 'The asset information of the vulnerability to query. You can set this parameter to the asset name, public IP address, or private IP address.', 'type' => 'string', 'required' => false, 'example' => 'production_nat_cn-hangzhou_zone_105'],
],
[
- 'name' => 'Priority',
+ 'name' => 'Uuids',
'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'schema' => ['title' => '', 'description' => 'The UUIDs of the servers for which you want to query vulnerabilities. Separate multiple UUIDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '3615b908-995a-4edb-bc85-1981b4e94ba0,9c52cf9a-d8ba-4e31-ae06-500b879ee4e6,4b7de3cf-c4ac-42fc-8804-35070493dc29,f3c01525-0777-4c97-88d9-bec11afd4a6a,a80bd516-c4f3-4c27-a169-c8abfaf9e89e'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => 'Data returned by the interface.',
+ 'PageInfo' => [
+ 'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '主键',
- 'description' => 'Primary key.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1978941',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => 'Creation time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1734788109000',
- ],
- 'WorkOrderName' => [
- 'title' => '工单名称',
- 'description' => 'Work order name.',
- 'type' => 'string',
- 'example' => 'Delivery task of safety monthly report',
- ],
- 'WorkOrderType' => [
- 'title' => '工单名称',
- 'description' => 'Work order type.',
- 'type' => 'string',
- 'example' => 'MONTH_REPORT',
- ],
- 'WorkOrderSource' => [
- 'title' => '工单来源',
- 'description' => 'Work order source.',
- 'type' => 'string',
- 'example' => 'Work order migration',
- ],
- 'CustomerId' => [
- 'title' => '客户ID',
- 'description' => 'Customer ID.',
- 'type' => 'string',
- 'example' => '1477832102462645',
- ],
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => 'Start time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1734788109000',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'description' => 'End time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1734788109000',
- ],
- 'CompleteTime' => [
- 'title' => '完成时间',
- 'description' => 'Completion time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1734788109000',
- ],
- 'WorkOrderStatus' => [
- 'title' => '工单状态',
- 'description' => 'Work order status.',
- 'type' => 'string',
- 'example' => 'UNPROCESSED',
- ],
- 'OwnerId' => [
- 'title' => '负责人',
- 'description' => 'Owner.',
- 'type' => 'string',
- 'example' => '426556',
- ],
- 'WorkOrderDetail' => [
- 'title' => '工单详情',
- 'description' => 'Work order details.',
- 'type' => 'string',
- 'example' => '{"questionDetail":"测试工单","answerDetail":""}'."\n",
- ],
- 'Creator' => [
- 'title' => '创建人',
- 'description' => 'Creator.',
- 'type' => 'string',
- 'example' => '426556',
- ],
+ 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of records in the query result.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7DC44321-7AAE-51CD-8E5F-CEB968569042',
- ],
- 'Code' => [
- 'description' => 'Interface status code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Prompt message of the returned result.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful.'."\n"
- ."\n"
- .'- **true**: Call succeeded.'."\n"
- ."\n"
- .'- **false**: Call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Data' => [
+ 'description' => 'The data returned by the operation.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Necessity' => ['title' => '', 'description' => 'The necessity level of vulnerability fixing.', 'type' => 'string', 'example' => 'later,asap,nntf'],
+ 'RepairTs' => ['title' => '', 'description' => 'The timestamp when the vulnerability was fixed.', 'type' => 'string', 'example' => '1541207563000'],
+ 'Uuid' => ['title' => '', 'description' => 'The UUID of the asset instance.', 'type' => 'string', 'example' => 'hdm_5cf2eaf263c021b354877943f181956d'],
+ 'Status' => ['title' => '', 'description' => 'The vulnerability status. Valid values:'."\n"
+ ."\n"
+ .'- 1: unfixed'."\n"
+ .'- 2: fix failed'."\n"
+ .'- 3: rollback failed'."\n"
+ .'- 4: fixing'."\n"
+ .'- 5: rolling back'."\n"
+ .'- 6: verifying'."\n"
+ .'- 7: fixed'."\n"
+ .'- 8: fixed, pending restart'."\n"
+ .'- 9: rollback succeeded'."\n"
+ .'- 10: ignored'."\n"
+ .'- 11: rollback succeeded, pending restart'."\n"
+ .'- 12: vulnerability does not exist'."\n"
+ .'- 20: expired.', 'type' => 'string', 'example' => '1'],
+ 'InternetIp' => ['title' => '', 'description' => 'The public IP address of the asset.', 'type' => 'string', 'example' => '39.101.73.28'],
+ 'Tag' => ['title' => '', 'description' => 'The vulnerability tag.', 'type' => 'string', 'example' => 'Restart Required'],
+ 'Name' => ['title' => '', 'description' => 'The vulnerability name.', 'type' => 'string', 'example' => 'SCA:ACSV-2020-111301'],
+ 'Related' => ['title' => '', 'description' => 'The list of CVEs associated with the vulnerability. Multiple values are separated by commas (,).', 'type' => 'string', 'example' => 'CVE-2020-13935'],
+ 'IntranetIp' => ['title' => '', 'description' => 'The private IP address of the asset.', 'type' => 'string', 'example' => '172.22.216.17'],
+ 'LastTs' => ['title' => '', 'description' => 'The timestamp when the vulnerability was last detected.', 'type' => 'string', 'example' => '1620404763000'],
+ 'FirstTs' => ['title' => '', 'description' => 'The timestamp when the vulnerability was first detected.', 'type' => 'string', 'example' => '1620404763000'],
+ 'AliasName' => ['title' => '', 'description' => 'The alias of the vulnerability.', 'type' => 'string', 'example' => 'Tomcat websocket 拒绝服务漏洞利用代码披露（CVE-2020-13935）'],
+ 'InstanceName' => ['title' => '', 'description' => 'The name of the asset instance.', 'type' => 'string', 'example' => '凌星-CentOS'],
+ 'RepairCmd' => ['title' => '', 'description' => 'The fix command.', 'type' => 'string', 'example' => '*** update python-perf'],
+ 'EffectMsgDTOS' => [
+ 'title' => '',
+ 'description' => 'The impact description.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SoftName' => ['title' => '', 'description' => 'The software name.', 'type' => 'string', 'example' => 'python-perf 3.10.0'],
+ 'MatchList' => ['title' => '', 'description' => 'The hit.', 'type' => 'string', 'example' => 'fastjson(jar) extendField.safemode equals false'],
+ 'Path' => ['title' => '', 'description' => 'The path.', 'type' => 'string', 'example' => '/uat6/qry/enquiry/policy/yrtPolicyList'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => 'D38B3D2F-67FD-57FF-87D1-C431D2C70F76'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 1978941,\\n \\"CreateTime\\": 1734788109000,\\n \\"WorkOrderName\\": \\"安全月报交付任务\\",\\n \\"WorkOrderType\\": \\"MONTH_REPORT\\",\\n \\"WorkOrderSource\\": \\"工单迁移\\",\\n \\"CustomerId\\": \\"1477832102462645\\",\\n \\"StartTime\\": 1734788109000,\\n \\"EndTime\\": 1734788109000,\\n \\"CompleteTime\\": 1734788109000,\\n \\"WorkOrderStatus\\": \\"UNPROCESSED\\",\\n \\"OwnerId\\": \\"426556\\",\\n \\"WorkOrderDetail\\": \\"{\\\\\\"questionDetail\\\\\\":\\\\\\"测试工单\\\\\\",\\\\\\"answerDetail\\\\\\":\\\\\\"\\\\\\"}\\\\n\\",\\n \\"Creator\\": \\"426556\\"\\n },\\n \\"RequestId\\": \\"7DC44321-7AAE-51CD-8E5F-CEB968569042\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Create Service Work Order',
- 'translator' => 'machine',
- ],
- 'GetConsoleScore' => [
- 'summary' => 'Get Console Score',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Query processed vulnerability details',
+ 'summary' => 'Queries the details of processed vulnerabilities.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetVulListById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100\\n },\\n \\"Data\\": [\\n {\\n \\"Necessity\\": \\"later,asap,nntf\\",\\n \\"RepairTs\\": \\"1541207563000\\",\\n \\"Uuid\\": \\"hdm_5cf2eaf263c021b354877943f181956d\\",\\n \\"Status\\": \\"1\\",\\n \\"InternetIp\\": \\"39.101.73.28\\",\\n \\"Tag\\": \\"Restart Required\\",\\n \\"Name\\": \\"SCA:ACSV-2020-111301\\",\\n \\"Related\\": \\"CVE-2020-13935\\",\\n \\"IntranetIp\\": \\"172.22.216.17\\",\\n \\"LastTs\\": \\"1620404763000\\",\\n \\"FirstTs\\": \\"1620404763000\\",\\n \\"AliasName\\": \\"Tomcat websocket 拒绝服务漏洞利用代码披露（CVE-2020-13935）\\",\\n \\"InstanceName\\": \\"凌星-CentOS\\",\\n \\"RepairCmd\\": \\"*** update python-perf\\",\\n \\"EffectMsgDTOS\\": [\\n {\\n \\"SoftName\\": \\"python-perf 3.10.0\\",\\n \\"MatchList\\": \\"fastjson(jar) extendField.safemode equals false\\",\\n \\"Path\\": \\"/uat6/qry/enquiry/policy/yrtPolicyList\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"D38B3D2F-67FD-57FF-87D1-C431D2C70F76\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetVulPageSummary' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '215083',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'DateType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '筛选时间类型 支持按最近7天、最近30天、最近半年、自定义等方式进行时间的筛选',
- 'description' => 'Filter time type, supports filtering by the last 7 days, last 30 days, last half year, or custom. If empty, it represents the last 7 days.',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'oneYear' => '最近一年',
- 'month' => '最近30天',
- 'halfYear' => '最近半年',
- 'customize' => '自定义',
- ],
- 'example' => 'month',
- ],
- ],
- [
- 'name' => 'StartDate',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => 'Start date.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1729478485000',
- ],
- ],
- [
- 'name' => 'EndDate',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '结束时间',
- 'description' => 'End date.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1732156885986',
- ],
- ],
- [
- 'name' => 'SuspEventSource',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '告警事件来源',
- 'description' => 'Source of alert events.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '该字段暂未使用，有问题请联系管理员',
- ],
- ],
+ 'abilityTreeCode' => '180002',
+ 'abilityTreeNodes' => ['FEATUREsosYT8XCW'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'Data returned by the interface.',
- 'type' => 'any',
- 'example' => '{'."\n"
- .' "score": "94.00",'."\n"
- .' "consoleScoreTrendDTOS": ['."\n"
- .' {'."\n"
- .' "date": "20241009",'."\n"
- .' "score": "100.0"'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "cyclicYearOverYear": "-6.00",'."\n"
- .' "recordDate": "20241209",'."\n"
- .' "weeklyYearOverYear": "1.62",'."\n"
- .' "aboveWholeNetworkUserRatio": "6.25",'."\n"
- .' "aliUid": "1601097845544644",'."\n"
- .' "detailJson": "[{\\"detailDTO\\":[{\\"count\\":0,\\"itemName\\":\\"应用漏洞POC验证\\",\\"mark\\":\\"1\\"},{\\"count\\":0,\\"itemName\\":\\"未授权访问漏洞（公网暴露）\\",\\"mark\\":\\"1\\"},{\\"count\\":0,\\"itemName\\":\\"后台弱口令漏洞（公网暴露）\\",\\"mark\\":\\"1\\"},{\\"count\\":0,\\"itemName\\":\\"文件上传漏洞（公网暴露）\\",\\"mark\\":\\"1\\"}],\\"markRate\\":\\"0.5\\",\\"markType\\":\\"vul\\"},{\\"detailDTO\\":[{\\"count\\":12,\\"itemName\\":\\"WAF3.0回源配置不正确\\",\\"mark\\":\\"1\\"},{\\"count\\":0,\\"itemName\\":\\"AK泄露检查未开启\\",\\"mark\\":\\"1\\"},{\\"count\\":0,\\"itemName\\":\\"DNAT管理端口开放\\",\\"mark\\":\\"1\\"},{\\"count\\":0,\\"itemName\\":\\"高危端口暴露\\",\\"mark\\":\\"0.5\\"}],\\"markRate\\":\\"0.5\\",\\"markType\\":\\"risk\\"}]"'."\n"
- .'}',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'D0937B0F-9180-5F70-B6ED-0BA22591627F',
- ],
- 'Code' => [
- 'description' => 'Interface response code.',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => 'Prompt message for the result returned.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Indicates whether the operation was successful. true means success, false means failure.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'description' => 'The data query result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WaitHandleCount' => ['title' => '', 'description' => 'The number of unhandled alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ 'HandingCount' => ['title' => '', 'description' => 'The number of alerts being handled.', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
+ 'CompletedCount' => ['title' => '', 'description' => 'The number of handled alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '1990'],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '2000'],
+ 'HighCount' => ['title' => '', 'description' => 'The number of high-risk alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '500'],
+ 'MediumCount' => ['title' => '', 'description' => 'The number of medium-risk alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '500'],
+ 'LowCount' => ['title' => '', 'description' => 'The number of low-risk alerts.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => 'A3A575C8-80F9-5F04-AA24-CCAC246884A3'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'operation success', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 401 => [
- [
- 'errorCode' => 'ConsoleScoreEmpty',
- 'errorMessage' => 'get score data is empty.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query alert page statistics',
+ 'summary' => 'Queries alert page statistics.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetVulPageSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\n \\\\\\"score\\\\\\": \\\\\\"94.00\\\\\\",\\\\n \\\\\\"consoleScoreTrendDTOS\\\\\\": [\\\\n {\\\\n \\\\\\"date\\\\\\": \\\\\\"20241009\\\\\\",\\\\n \\\\\\"score\\\\\\": \\\\\\"100.0\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"cyclicYearOverYear\\\\\\": \\\\\\"-6.00\\\\\\",\\\\n \\\\\\"recordDate\\\\\\": \\\\\\"20241209\\\\\\",\\\\n \\\\\\"weeklyYearOverYear\\\\\\": \\\\\\"1.62\\\\\\",\\\\n \\\\\\"aboveWholeNetworkUserRatio\\\\\\": \\\\\\"6.25\\\\\\",\\\\n \\\\\\"aliUid\\\\\\": \\\\\\"1601097845544644\\\\\\",\\\\n \\\\\\"detailJson\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"detailDTO\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"应用漏洞POC验证\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"未授权访问漏洞（公网暴露）\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"后台弱口令漏洞（公网暴露）\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"文件上传漏洞（公网暴露）\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"markRate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.5\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"markType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"vul\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"detailDTO\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":12,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"WAF3.0回源配置不正确\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AK泄露检查未开启\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DNAT管理端口开放\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"itemName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"高危端口暴露\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.5\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"markRate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.5\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"markType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"risk\\\\\\\\\\\\\\"}]\\\\\\"\\\\n}\\",\\n \\"RequestId\\": \\"D0937B0F-9180-5F70-B6ED-0BA22591627F\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Get Console Score',
- 'translator' => 'machine',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"WaitHandleCount\\": 4,\\n \\"HandingCount\\": 6,\\n \\"CompletedCount\\": 1990,\\n \\"TotalCount\\": 2000,\\n \\"HighCount\\": 500,\\n \\"MediumCount\\": 500,\\n \\"LowCount\\": 1000\\n },\\n \\"RequestId\\": \\"A3A575C8-80F9-5F04-AA24-CCAC246884A3\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"operation success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetSowList' => [
- 'summary' => 'Get SOW List',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetVulSummary' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4604,638 +2855,393 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '212416',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '179685',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'DateType',
'in' => 'formData',
'schema' => [
- 'title' => '筛选时间类型 支持按最近7天、最近30天、最近半年、自定义等方式进行时间的筛选',
- 'description' => 'Filter time type, supports filtering by the last 7 days, the last 30 days, the last half year, or custom time ranges.',
+ 'title' => '',
+ 'description' => 'The time filter type. You can filter by the last 7 days, last 30 days, last half year, or a custom time range.',
+ 'enumValueTitles' => ['oneYear' => 'last year.', 'month' => 'last 30 days.', 'halfYear' => 'last half year.', 'customize' => 'custom.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'oneYear' => '最近一年',
- 'month' => '最近30天',
- 'halfYear' => '最近半年',
- 'customize' => '自定义',
- ],
'example' => 'month',
],
],
[
'name' => 'StartDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => 'Start time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1729478485000',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1729478485000'],
],
[
'name' => 'EndDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '结束时间',
- 'description' => 'End time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1732156885986',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732156885986'],
],
[
'name' => 'SuspEventSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '告警事件来源',
- 'description' => 'Alert event source.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '该字段暂未使用，有问题请联系管理员',
- ],
+ 'schema' => ['title' => '', 'description' => 'The source of the alert event.', 'type' => 'string', 'required' => false, 'example' => '该字段暂未使用，有问题请联系管理员'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'Data returned by the interface.',
- 'type' => 'array',
- 'items' => [
- 'description' => 'Data object.',
- 'type' => 'object',
- 'properties' => [
- 'TaskTypeName' => [
- 'title' => '任务类型',
- 'description' => 'Task type.',
- 'type' => 'string',
- 'example' => '安全风险评估',
- ],
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => 'Start time.',
- 'type' => 'string',
- 'example' => '2023-03-24 16:51:26',
- ],
- 'CompleteTime' => [
- 'title' => '完成时间',
- 'description' => 'Completion time.',
- 'type' => 'string',
- 'example' => '2024-03-28 16:19:35',
- ],
- 'Progress' => [
- 'title' => '进展',
- 'description' => 'Progress.',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'COMPLETED' => '已完成',
- 'IN_PROCESS' => '进行中',
- 'IN_PREPARATION' => '准备中',
+ 'description' => 'The data returned by the operation.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WaitHandleCount' => ['title' => '', 'description' => 'The number of unhandled risks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'CompletedCount' => ['title' => '', 'description' => 'The number of handled risks.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'DealRate' => ['title' => '', 'description' => 'The risk convergence rate.', 'type' => 'string', 'example' => '50'],
+ 'TrendList' => [
+ 'title' => '',
+ 'description' => 'The collection of vulnerability discovery trend nodes.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Date' => ['title' => '', 'description' => 'The time node.', 'type' => 'string', 'example' => '202407或者20240701'],
+ 'DealCount' => ['title' => '', 'description' => 'The number of handled risks.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'FindCount' => ['title' => '', 'description' => 'The number of discovered risks.', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
],
- 'example' => 'IN_PREPARATION',
- ],
- 'RecordCount' => [
- 'title' => '记录数',
- 'description' => 'Record count.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '173',
- ],
- 'WorkOrderName' => [
- 'title' => '工单名称',
- 'description' => 'Work order name.',
- 'type' => 'string',
- 'example' => '安全产品配置问题与超量提醒',
- ],
- 'OperateRemark' => [
- 'title' => '操作备注',
- 'description' => 'Operation remarks.',
- 'type' => 'string',
- 'example' => '新建',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FA8883BC-CB18-5E28-A113-8249917CA05E',
- ],
- 'Code' => [
- 'description' => 'Interface response code.',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => 'Prompt information for the returned result.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful. - **true**: The call was successful. - **false**: The call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => 'EF801DD1-D934-51B3-92D4-776CE17B184F'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'system error', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TaskTypeName\\": \\"安全风险评估\\",\\n \\"StartTime\\": \\"2023-03-24 16:51:26\\",\\n \\"CompleteTime\\": \\"2024-03-28 16:19:35\\",\\n \\"Progress\\": \\"IN_PREPARATION\\",\\n \\"RecordCount\\": 173,\\n \\"WorkOrderName\\": \\"安全产品配置问题与超量提醒\\",\\n \\"OperateRemark\\": \\"新建\\"\\n }\\n ],\\n \\"RequestId\\": \\"FA8883BC-CB18-5E28-A113-8249917CA05E\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Get SOW List',
- 'translator' => 'machine',
- ],
- 'DisposeWorkTask' => [
- 'summary' => 'Handle Alert Work Order',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve risk statistics',
+ 'summary' => 'Retrieves statistics on security risks.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetVulSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"WaitHandleCount\\": 5,\\n \\"CompletedCount\\": 10,\\n \\"DealRate\\": \\"50\\",\\n \\"TrendList\\": [\\n {\\n \\"Date\\": \\"202407或者20240701\\",\\n \\"DealCount\\": 10,\\n \\"FindCount\\": 15\\n }\\n ]\\n },\\n \\"RequestId\\": \\"EF801DD1-D934-51B3-92D4-776CE17B184F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"system error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetWorkTaskSummary' => [
+ 'summary' => 'Retrieves statistics for frontline tickets.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '247511',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeCode' => '179659',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
+ 'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Operator',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Operator.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'WB01089929',
- ],
- ],
- [
- 'name' => 'TaskIds',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Work order ID, multiple IDs separated by commas.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '10310',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Work order status.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'enumValueTitles' => [
- 1 => '待处理',
- '处理中',
- '处理完成',
- '误报',
- '已忽略',
- '审核中',
- '已审核',
- '发送中-待审批',
- '已发送',
- '撤回中-待审批',
- '已撤回',
- '发送失败-审批拒绝',
- '撤回失败-审批拒绝',
- '退回',
- '控制台已加白',
- '客户侧已加白',
- '发送-流程终止',
- '撤回-流程终止',
- ],
- 'example' => '8',
- ],
- ],
- [
- 'name' => 'OptRemark',
+ 'name' => 'DateType',
'in' => 'formData',
'schema' => [
- 'description' => 'Operation remarks.',
+ 'title' => '',
+ 'description' => 'The time filter type. Supports filtering by last 7 days, last 30 days, last half year, custom range, and other options.',
+ 'enumValueTitles' => ['oneYear' => 'last year.', 'month' => 'last 30 days.', 'halfYear' => 'last half year.', 'customize' => 'custom.'],
'type' => 'string',
'required' => true,
- 'example' => '处理完成',
- ],
- ],
- [
- 'name' => 'WorkTaskAnalysisResults',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '告警ai分析结果',
- 'type' => 'array',
- 'items' => [
- 'title' => 'ai分析结果数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'title' => '工单ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1445078',
- ],
- 'AnalysisResult' => [
- 'title' => 'ai分析结果',
- 'type' => 'string',
- 'example' => '您好， 根据您提供的告警详情，xxx',
- ],
- ],
- ],
+ 'example' => 'month',
],
],
[
- 'name' => 'SyncSasDeal',
+ 'name' => 'StartDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '同步云安全中心我已手动处理',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1729478485000'],
],
[
- 'name' => 'SyncWafApisecDeal',
+ 'name' => 'EndDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '同步waf已确认',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732156885986'],
],
[
- 'name' => 'SyncSasSiemEventDeal',
+ 'name' => 'SuspEventSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '同步cloudsiem已确认',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'schema' => ['title' => '', 'description' => 'The alert event source.', 'type' => 'string', 'required' => false, 'example' => '该字段暂时未用，有问题请联系管理员'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '86786E4C-6416-55CF-9AB6-5E275B68801D',
- ],
- 'Code' => [
- 'description' => 'Interface response code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Prompt message of the returned result.',
- 'type' => 'string',
- 'example' => 'Success.',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful. - **true**: The call was successful. - **false**: The call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Data' => [
+ 'description' => 'The data returned by the operation.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkTaskCount' => ['title' => '', 'description' => 'The number of service responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'WorkTaskGrowthRate' => ['title' => '', 'description' => 'The year-over-year growth rate of service responses.', 'type' => 'string', 'example' => '20'],
+ 'DealAverageDuration' => ['title' => '', 'description' => 'The average response time (in minutes).', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
+ 'DealAverageDurationGrowthRate' => ['title' => '', 'description' => 'The year-over-year growth rate of the average response time.', 'type' => 'string', 'example' => '20'],
+ 'WorkTaskDealRate' => ['title' => '', 'description' => 'The issue closure rate.', 'type' => 'string', 'example' => '90'],
+ 'WorkTaskDealRateGrowthRate' => ['title' => '', 'description' => 'The year-over-year change in the issue closure rate.', 'type' => 'string', 'example' => '20'],
+ 'DealWorkTaskCount' => ['title' => '', 'description' => 'The number of responded tickets.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'DealWorkTaskCountRate' => ['title' => '', 'description' => 'The year-over-year change in the number of responded tickets.', 'type' => 'string', 'example' => '20'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => 'EF801DD1-D934-51B3-92D4-776CE17B184F'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ .'- **true**: The call was successful.'."\n"
+ .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve frontline ticket statistics',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetWorkTaskSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86786E4C-6416-55CF-9AB6-5E275B68801D\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Handle Alert Work Order',
- 'translator' => 'machine',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"WorkTaskCount\\": 10,\\n \\"WorkTaskGrowthRate\\": \\"20\\",\\n \\"DealAverageDuration\\": 60,\\n \\"DealAverageDurationGrowthRate\\": \\"20\\",\\n \\"WorkTaskDealRate\\": \\"90\\",\\n \\"WorkTaskDealRateGrowthRate\\": \\"20\\",\\n \\"DealWorkTaskCount\\": 100,\\n \\"DealWorkTaskCountRate\\": \\"20\\"\\n },\\n \\"RequestId\\": \\"EF801DD1-D934-51B3-92D4-776CE17B184F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'DisposeServiceWorkOrder' => [
- 'summary' => 'Process Service Work Order',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'PageServiceCustomer' => [
+ 'summary' => 'Queries service customer information.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '226218',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeCode' => '173423',
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
],
'parameters' => [
[
- 'name' => 'Id',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '工单ID',
- 'description' => 'Work order ID.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '23172',
- ],
- ],
- [
- 'name' => 'WorkOrderName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '工单名称',
- 'description' => 'Work order name.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '安全产品配置问题与超量提醒',
- ],
- ],
- [
- 'name' => 'WorkOrderStatus',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '工单状态',
- 'description' => 'Work order status.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'UNPROCESSED' => '待处理',
- 'PROCESSING' => '处理中',
- 'BACK' => '已退回',
- 'PROCESSED' => '处理完成',
- 'INVALID' => '误报',
- 'IGNORED' => '已忽略',
- ],
- 'example' => 'PROCESSED',
- ],
- ],
- [
- 'name' => 'Operator',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '操作人',
- 'description' => 'Operator.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '396120',
- ],
- ],
- [
- 'name' => 'OperateType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '处理类型',
- 'description' => 'Processing type.',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'SECURITY_CONSULTATION_ANSWERS' => '安全咨询-回答',
- 'CREATE' => '新建',
- 'FIELD_CHANGE' => '字段变更',
- 'UPGRADE' => '升级',
- 'PROCESSED' => '处理完成',
- 'BACK' => '退回',
- 'FORWARD' => '转交',
- 'DELAY' => '延期',
- 'START_PROCESSING' => '开始处理',
- ],
- 'example' => 'PROCESSED',
- ],
- ],
- [
- 'name' => 'OperateRemark',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '操作备注',
- 'description' => 'Operation remarks.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '处理完成',
- ],
- ],
- [
- 'name' => 'ForwardOwnerId',
+ 'name' => 'CurrentPage',
'in' => 'formData',
- 'schema' => [
- 'title' => '转交人',
- 'description' => 'Forward to owner.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '405639',
- ],
+ 'schema' => ['description' => 'The page number of the query results. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'UpgradeOwnerId',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '升级人',
- 'description' => 'Upgrade owner.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '336333',
- ],
+ 'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'IsAttachment',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '附件要求',
- 'description' => 'Attachment requirement.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Y' => '是',
- 'N' => '否',
- ],
- 'example' => 'Y',
- ],
- ],
- [
- 'name' => 'IsWorkOrderNotify',
+ 'name' => 'StartTime',
'in' => 'formData',
- 'schema' => [
- 'title' => '工单提醒',
- 'description' => 'Work order notification.',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Y' => '是',
- 'N' => '否',
- ],
- 'example' => 'Y',
- ],
+ 'schema' => ['description' => 'The start time. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710641101000', 'title' => ''],
],
[
- 'name' => 'AttachmentName',
+ 'name' => 'EndTime',
'in' => 'formData',
- 'schema' => [
- 'title' => '附件名称',
- 'description' => 'Attachment name.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bbaa133c-0ac2-489f-9fc8-39f91c2e770c_20230301-20240403-服务工单列表.xlsx',
- ],
+ 'schema' => ['description' => 'The end time. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710641101123', 'title' => ''],
],
[
- 'name' => 'StartTime',
+ 'name' => 'AuthStatus',
'in' => 'formData',
'schema' => [
- 'title' => '开始时间',
- 'description' => 'Start time.',
+ 'description' => 'The authorization status.',
+ 'enumValueTitles' => [1 => 'authorized.', 9 => 'unauthorized.'],
'type' => 'integer',
- 'format' => 'int64',
+ 'format' => 'int32',
'required' => false,
- 'example' => '2024-04-02 00:00:00',
+ 'example' => '1',
+ 'title' => '',
],
],
[
- 'name' => 'EndTime',
+ 'name' => 'MonitorAuthStatus',
'in' => 'formData',
'schema' => [
- 'title' => '结束时间',
- 'description' => 'End time.',
+ 'description' => 'The authorization status for China Cloud Security alerts.',
+ 'enumValueTitles' => [1 => 'authorized.', 9 => 'unauthorized.'],
'type' => 'integer',
- 'format' => 'int64',
+ 'format' => 'int32',
'required' => false,
- 'example' => '2024-04-14 00:00:00',
+ 'example' => '1',
+ 'title' => '',
],
],
[
- 'name' => 'NotifyId',
+ 'name' => 'CmAuthStatus',
'in' => 'formData',
'schema' => [
- 'title' => '通知ID',
- 'description' => 'Notification ID.',
+ 'description' => 'The authorization status for CloudMonitor alerts.',
+ 'enumValueTitles' => ['unauthorized.', 'authorized.'],
'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'WorkOrderDetail',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '工单详情',
- 'description' => 'Work order details.',
- 'type' => 'string',
+ 'format' => 'int32',
'required' => false,
- 'example' => '{"questionDetail":"测试工单","answerDetail":""}',
+ 'example' => '1',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ED520610-6231-5D80-BADD-A8CDC7BBC809',
- ],
- 'Code' => [
- 'description' => 'API response code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Prompt message of the returned result.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful. - **true**: The call was successful. - **false**: The call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'PageInfo' => [
+ 'description' => 'The pagination information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'CurrentPage' => ['description' => 'The page number of the current page in paging.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'Data' => [
+ 'description' => 'The data query results.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The query result object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => ['description' => 'The customer ID.', 'type' => 'string', 'example' => '1667751131382856', 'title' => ''],
+ 'Aliuid' => ['description' => 'The customer UID.', 'type' => 'string', 'example' => '1667751131382856', 'title' => ''],
+ 'Name' => ['description' => 'The customer name.', 'type' => 'string', 'example' => '中国工程院', 'title' => ''],
+ 'OwnId' => ['description' => 'The name of the owner.', 'type' => 'string', 'example' => '常温', 'title' => ''],
+ 'Level' => [
+ 'description' => 'The customer level.',
+ 'enumValueTitles' => ['GC1' => 'GC1', 'GC3' => 'GC3', 'GC2' => 'GC2', 'GC5' => 'GC5', 'GC4' => 'GC4', 'GC7' => 'GC7', 'GC6' => 'GC6'],
+ 'type' => 'string',
+ 'example' => 'GC1',
+ 'title' => '',
+ ],
+ 'Version' => ['description' => 'The version information.', 'type' => 'string', 'example' => '企业版', 'title' => ''],
+ 'AuthStatus' => [
+ 'description' => 'The authorization status.',
+ 'enumValueTitles' => [1 => 'authorized.', 9 => 'unauthorized.'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'title' => '',
+ ],
+ 'MonitorAuthStatus' => [
+ 'description' => 'The authorization status for China Cloud Security alerts.',
+ 'enumValueTitles' => [1 => 'authorized.', 9 => 'unauthorized.'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'title' => '',
+ ],
+ 'CmAuthStatus' => [
+ 'description' => 'The authorization status for CloudMonitor alerts.',
+ 'enumValueTitles' => ['unauthorized.', 'authorized.'],
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ 'title' => '',
+ ],
+ 'StartTime' => ['description' => 'The start time. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710123149000', 'title' => ''],
+ 'EndTime' => ['description' => 'The end time. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710123149222', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '808A307F-9513-5099-AAA5-98D4EF199140'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'System error or openapi error', 'title' => ''],
+ 'Message' => ['description' => 'The response message. A success message is returned if the request succeeds. A failure reason is returned if the request fails.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ .'- true: The request was successful.'."\n"
+ .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100\\n },\\n \\"Data\\": [\\n {\\n \\"UserId\\": \\"1667751131382856\\",\\n \\"Aliuid\\": \\"1667751131382856\\",\\n \\"Name\\": \\"中国工程院\\",\\n \\"OwnId\\": \\"常温\\",\\n \\"Level\\": \\"GC1\\",\\n \\"Version\\": \\"企业版\\",\\n \\"AuthStatus\\": 1,\\n \\"MonitorAuthStatus\\": 1,\\n \\"CmAuthStatus\\": 0,\\n \\"StartTime\\": 1710123149000,\\n \\"EndTime\\": 1710123149222\\n }\\n ],\\n \\"RequestId\\": \\"808A307F-9513-5099-AAA5-98D4EF199140\\",\\n \\"Code\\": \\"System error or openapi error\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Query service customer information',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:PageServiceCustomer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ED520610-6231-5D80-BADD-A8CDC7BBC809\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Process Service Work Order',
- 'translator' => 'machine',
],
'SendCustomEvent' => [
- 'summary' => 'Send Custom Alert Event',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Sends a custom alert event.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5248,304 +3254,142 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '247510',
- 'abilityTreeNodes' => [
- 'FEATUREsos0PY09L',
- ],
+ 'abilityTreeNodes' => ['FEATUREsos0PY09L'],
],
'parameters' => [
[
'name' => 'CustomerId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'User ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1214484929940219',
- ],
+ 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '1214484929940219', 'title' => ''],
],
[
'name' => 'DataSource',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Data source.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aegis_suspicious_event',
- ],
+ 'schema' => ['description' => 'The data source.', 'type' => 'string', 'required' => false, 'example' => 'aegis_suspicious_event', 'title' => ''],
],
[
'name' => 'EventDescription',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Event details.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '疑似病毒木马启动运行。',
- ],
+ 'schema' => ['description' => 'The event details.', 'type' => 'string', 'required' => false, 'example' => '疑似病毒木马启动运行。', 'title' => ''],
],
[
'name' => 'EventDetails',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Alert event details.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[{"name":"提示","type":"text","value":"在您的系统上发现可疑进程启动行为，通常与病毒木马或入侵事件相关"},{"name":"ATT&CK攻击阶段","type":"text","value":"代码执行"},{"name":"恶意行为","type":"text","value":"可疑的漏洞利用代码执行"},{"name":"规则类型","type":"text","value":"进程启动"},{"name":"规则引擎","type":"text","value":"精准攻击识别引擎"},{"name":"处置动作","type":"text","value":"阻断行为"},{"name":"进程路径","type":"text","value":"/usr/bin/python3.9"},{"name":"命令行","type":"text","value":"python3 /root/poc/python/cve-2018-15473.py --username root --port 22"},{"name":"父进程路径","type":"text","value":"/bin/gunkit"},{"name":"父进程命令行","type":"text","value":"gunkit serve-grpc --addr unix:///data/gunkit-grpc.sock"},{"name":"进程ID","type":"text","value":"22714"},{"name":"父进程ID","type":"text","value":"2986"},{"name":"描述","type":"text","value":"主动防御检测到可疑进程启动行为，这类可疑进程通常存在于特殊的系统目录，或通过后缀伪装成文档/音频/图片等文件诱导用户运行，该异常行为已被成功拦截"},{"name":"处置建议","type":"text","value":"请您及时排查是否是正常的业务操作，如果您觉得此次拦截是非预期的，那您可以在主动防御 - 恶意行为防御页面中，关闭“可疑进程启动“规则集或者将受影响机器从管理主机中移除"},{"name":"父进程关系","type":"processChain","value":"1:::/usr/lib/systemd/systemd --switched-root --system --deserialize 22 &&& 2939:::/usr/local/bin/containerd-shim-runc-v2 -namespace moby -id 270f164903b47d4e219b410b8d11d9079a7ad1bac8133aea604598300d3b03d5 -address /run/containerd/containerd.sock &&& 2962:::/usr/bin/python3 /usr/bin/supervisord -n &&& 2986:::gunkit serve-grpc --addr unix:///data/gunkit-grpc.sock"}]',
- ],
+ 'schema' => ['description' => 'The alert event details.', 'type' => 'string', 'required' => false, 'example' => '[{"name":"提示","type":"text","value":"在您的系统上发现可疑进程启动行为，通常与病毒木马或入侵事件相关"},{"name":"ATT&CK攻击阶段","type":"text","value":"代码执行"},{"name":"恶意行为","type":"text","value":"可疑的漏洞利用代码执行"},{"name":"规则类型","type":"text","value":"进程启动"},{"name":"规则引擎","type":"text","value":"精准攻击识别引擎"},{"name":"处置动作","type":"text","value":"阻断行为"},{"name":"进程路径","type":"text","value":"/usr/bin/python3.9"},{"name":"命令行","type":"text","value":"python3 /root/poc/python/cve-2018-15473.py --username root --port 22"},{"name":"父进程路径","type":"text","value":"/bin/gunkit"},{"name":"父进程命令行","type":"text","value":"gunkit serve-grpc --addr unix:///data/gunkit-grpc.sock"},{"name":"进程ID","type":"text","value":"22714"},{"name":"父进程ID","type":"text","value":"2986"},{"name":"描述","type":"text","value":"主动防御检测到可疑进程启动行为，这类可疑进程通常存在于特殊的系统目录，或通过后缀伪装成文档/音频/图片等文件诱导用户运行，该异常行为已被成功拦截"},{"name":"处置建议","type":"text","value":"请您及时排查是否是正常的业务操作，如果您觉得此次拦截是非预期的，那您可以在主动防御 - 恶意行为防御页面中，关闭“可疑进程启动“规则集或者将受影响机器从管理主机中移除"},{"name":"父进程关系","type":"processChain","value":"1:::/usr/lib/systemd/systemd --switched-root --system --deserialize 22 &&& 2939:::/usr/local/bin/containerd-shim-runc-v2 -namespace moby -id 270f164903b47d4e219b410b8d11d9079a7ad1bac8133aea604598300d3b03d5 -address /run/containerd/containerd.sock &&& 2962:::/usr/bin/python3 /usr/bin/supervisord -n &&& 2986:::gunkit serve-grpc --addr unix:///data/gunkit-grpc.sock"}]', 'title' => ''],
],
[
'name' => 'EventName',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Event name.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '客户端离线 Client offline',
- ],
+ 'schema' => ['description' => 'The event name.', 'type' => 'string', 'required' => true, 'example' => '客户端离线', 'title' => ''],
],
[
'name' => 'EventType',
'in' => 'formData',
'schema' => [
- 'description' => 'Event type.',
- 'type' => 'string',
- 'required' => true,
+ 'description' => 'The event type.',
'enumValueTitles' => [
- 'SUMMARY_REPORT' => '总结报告',
- 'MONTH_REPORT' => '月报',
- 'SYSTEM_EVENT' => '系统事件',
- 'OTHER_REPORTS' => '其他报告',
- 'PLATFORM_VULNERABILITY_MONITOR' => '漏洞巡检监控',
- 'PROJECT_SUMMARY_MEETING' => '项目总结会',
- 'CUSTOM_EVENT' => '自定义事件',
- 'SLS_LOG_SUSP_EVENT' => '云安全中心-LOG',
- 'CUSTOMER_VIEW' => '客户回访',
- 'MANUAL' => '人工',
- 'RISK_NOTIFY' => '风险提醒',
- 'SUSP_CUSTOM_CFW' => 'MDR_CFW事件',
- 'PROJECT_LAUNCH_MEETING' => '项目启动会',
- 'SYSTEM_VULNERABILITY_SCAN' => '扫描器漏洞扫描',
- 'RISK_BRIEFING' => '风险讲解会',
- 'DING_TALK_CUSTOMER' => '客户钉钉咨询',
- 'SUSP_CUSTOM_SAS' => 'MDR_SAS事件',
- 'SYSTEM_SECURITY_EVENT' => '安全事件',
- 'SYSTEM_SECURITY_ACCESS' => '安全评估',
- 'SYSTEM_PROJECT_DELIVERY' => '项目交付',
- 'SUSP_CUSTOM_WAF' => 'MDR_WAF事件',
- 'SUSP_EVENT' => '云安全中心-SUSP_EVENT',
- 'PROJECT_QUARTERLY_MEETING' => '项目季度会',
- 'SUSP_CUSTOM_DDOS' => 'MDR_DDOS事件',
- 'SUSP_CUSTOM_OTHER' => 'MDR_其他事件',
- 'QUARTERLY_REPORT' => '季报',
- 'SUSP_CUSTOM_EVENT' => '自定义事件',
- 'YUNDUN_VULNERABILITY_SCAN' => '云安全中心漏洞扫描',
+ 'SUMMARY_REPORT' => 'summary report.', 'MONTH_REPORT' => 'monthly report.', 'SYSTEM_EVENT' => 'system event.', 'OTHER_REPORTS' => 'other reports.', 'PLATFORM_VULNERABILITY_MONITOR' => 'vulnerability scan monitoring.', 'PROJECT_SUMMARY_MEETING' => 'project summary meeting.', 'CUSTOM_EVENT' => 'custom event.', 'SLS_LOG_SUSP_EVENT' => 'Security Center - LOG.', 'CUSTOMER_VIEW' => 'customer follow-up.', 'MANUAL' => 'manual.',
+ 'RISK_NOTIFY' => 'risk notification.', 'SUSP_CUSTOM_CFW' => 'MDR_CFW event.', 'PROJECT_LAUNCH_MEETING' => 'project launch meeting.', 'SYSTEM_VULNERABILITY_SCAN' => 'scanner vulnerability scan.', 'RISK_BRIEFING' => 'risk briefing.', 'DING_TALK_CUSTOMER' => 'customer DingTalk consultation.', 'SUSP_CUSTOM_SAS' => 'MDR_SAS event.', 'SYSTEM_SECURITY_EVENT' => 'security event.', 'SYSTEM_SECURITY_ACCESS' => 'security assessment.', 'SYSTEM_PROJECT_DELIVERY' => 'project delivery.',
+ 'SUSP_CUSTOM_WAF' => 'MDR_WAF event.', 'SUSP_EVENT' => 'Security Center - SUSP_EVENT.', 'PROJECT_QUARTERLY_MEETING' => 'project quarterly meeting.', 'SUSP_CUSTOM_DDOS' => 'MDR_DDOS event.', 'SUSP_CUSTOM_OTHER' => 'MDR_Other event.', 'QUARTERLY_REPORT' => 'quarterly report.', 'SUSP_CUSTOM_EVENT' => 'custom event.', 'YUNDUN_VULNERABILITY_SCAN' => 'Security Center vulnerability scan.',
],
+ 'type' => 'string',
+ 'required' => true,
'example' => 'SUSP_CUSTOM_CFW',
+ 'title' => '',
],
],
[
'name' => 'OccurrenceTime',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The first occurrence time of the alert event.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1724956996000',
- ],
+ 'schema' => ['description' => 'The time when the alert event first occurred.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1724956996000', 'title' => ''],
],
[
'name' => 'FindTime',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Alert discovery time.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '2023-04-23 14:47:34',
- ],
+ 'schema' => ['description' => 'The time when the alert was detected.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1734788109000', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Instance ID.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'i-uf60h3ns25bzq9eyf8ps',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-uf60h3ns25bzq9eyf8ps', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Instance name.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '猫吉-售卖-MDR扫描器集群1',
- ],
+ 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => '猫吉-售卖-MDR扫描器集群1', 'title' => ''],
],
[
'name' => 'IsSend',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Whether to send.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0',
- ],
+ 'schema' => ['description' => 'Specifies whether to send the event.', 'type' => 'string', 'required' => true, 'example' => '0', 'title' => ''],
],
[
'name' => 'Level',
'in' => 'formData',
'schema' => [
- 'description' => 'Event level.',
+ 'description' => 'The event level.',
+ 'enumValueTitles' => ['serious' => 'critical.', 'suspicious' => 'suspicious.', 'remind' => 'reminder.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'serious' => '紧急',
- 'suspicious' => '可疑',
- 'remind' => '提醒',
- ],
'example' => 'serious',
+ 'title' => '',
],
],
[
'name' => 'Product',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Product name.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CloudSecCenter',
- ],
+ 'schema' => ['description' => 'The product name.', 'type' => 'string', 'required' => false, 'example' => 'CloudSecCenter', 'title' => ''],
],
[
'name' => 'UniqueId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'Unique ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '68888f02-98f2-492b-a2b2-5b13295755b7',
- ],
+ 'schema' => ['description' => 'The unique ID.', 'type' => 'string', 'required' => true, 'example' => '68888f02-98f2-492b-a2b2-5b13295755b7', 'title' => ''],
],
[
'name' => 'Uuid',
'in' => 'formData',
- 'schema' => [
- 'description' => 'UUID.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '93B6CDAB-7D2E-33D2-9EBA-25D561A2E95F',
- ],
+ 'schema' => ['description' => 'The UUID.', 'type' => 'string', 'required' => false, 'example' => '93B6CDAB-7D2E-33D2-9EBA-25D561A2E95F', 'title' => ''],
],
[
'name' => 'EventMarkdown',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'None',
- 'description' => 'Details of markdown format',
- ],
+ 'schema' => ['description' => 'The event details in Markdown format.', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
'Data' => [
- 'description' => 'Interface return data.',
+ 'description' => 'The data returned by the operation.',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '工单Id',
- 'description' => 'Work order ID.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1914348',
- ],
- 'WorkTaskName' => [
- 'title' => '工单名称',
- 'description' => 'Work order name.',
- 'type' => 'string',
- 'example' => '22端口禁止任意IP访问 ',
- ],
- 'EventId' => [
- 'title' => '告警ID',
- 'description' => 'Alert ID.',
- 'type' => 'string',
- 'example' => 'c0dc71d1-8a1d-4043-9767-f6c420e34901-81bd',
- ],
- 'EventType' => [
- 'title' => '告警类型',
- 'description' => 'Alert type.',
- 'type' => 'string',
- 'example' => 'SUSP_CUSTOM_WAF',
- ],
- 'CustomerId' => [
- 'title' => '服务uid',
- 'description' => 'Service UID.',
- 'type' => 'string',
- 'example' => '1601097845544644',
- ],
- 'CustomerName' => [
- 'title' => '客户名称',
- 'description' => 'Customer name.',
- 'type' => 'string',
- 'example' => 'Tianjin Ruipengsheng Technology Development Co., Ltd',
- ],
- 'OwnerId' => [
- 'title' => '负责人',
- 'description' => 'Owner ID.',
- 'type' => 'string',
- 'example' => '352675',
- ],
- 'OwnerName' => [
- 'title' => '负责人名称',
- 'description' => 'Owner name.',
- 'type' => 'string',
- 'example' => 'Le Ya',
- ],
+ 'Id' => ['title' => '', 'description' => 'The ticket ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1914348'],
+ 'WorkTaskName' => ['title' => '', 'description' => 'The ticket name.', 'type' => 'string', 'example' => '22端口禁止任意IP访问 '],
+ 'EventId' => ['title' => '', 'description' => 'The alert ID.', 'type' => 'string', 'example' => 'c0dc71d1-8a1d-4043-9767-f6c420e34901-81bd'],
+ 'EventType' => ['title' => '', 'description' => 'The alerting type.', 'type' => 'string', 'example' => 'SUSP_CUSTOM_WAF'],
+ 'CustomerId' => ['title' => '', 'description' => 'The service UID.', 'type' => 'string', 'example' => '1601097845544644'],
+ 'CustomerName' => ['title' => '', 'description' => 'The customer name.', 'type' => 'string', 'example' => '天津瑞鹏昇科技发展有限公司'],
+ 'OwnerId' => ['title' => '', 'description' => 'The owner.', 'type' => 'string', 'example' => '352675'],
+ 'OwnerName' => ['title' => '', 'description' => 'The owner name.', 'type' => 'string', 'example' => '乐牙'],
],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'required' => true,
- 'example' => '606EB377-155D-5AEB-AC4F-F013444A4C45',
- ],
- 'Code' => [
- 'description' => 'Interface response code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'Return message. When the request is successful, it returns a success message; when the request fails, it returns the reason for the failure.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful.'."\n"
- ."\n"
- .'- true: Call succeeded.'."\n"
- ."\n"
- .'- false: Call failed.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '606EB377-155D-5AEB-AC4F-F013444A4C45'],
+ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'The returned message. If the request is successful, a success message is returned. If the request fails, the failure reason is returned.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: The call was successful.'."\n"
+ ."\n"
+ .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'example' => '',
],
],
],
@@ -5554,180 +3398,413 @@
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 1914348,\\n \\"WorkTaskName\\": \\"22端口禁止任意IP访问 \\",\\n \\"EventId\\": \\"c0dc71d1-8a1d-4043-9767-f6c420e34901-81bd\\",\\n \\"EventType\\": \\"SUSP_CUSTOM_WAF\\",\\n \\"CustomerId\\": \\"1601097845544644\\",\\n \\"CustomerName\\": \\"天津瑞鹏昇科技发展有限公司\\",\\n \\"OwnerId\\": \\"352675\\",\\n \\"OwnerName\\": \\"乐牙\\"\\n },\\n \\"RequestId\\": \\"606EB377-155D-5AEB-AC4F-F013444A4C45\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'Send Custom Alert Event',
- 'translator' => 'machine',
+ 'title' => 'Send a custom alert event',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:SendCustomEvent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
- 'DeleteDjbhReport' => [
- 'summary' => 'Delete Security Assessment Report',
- 'path' => '',
- 'methods' => [
- 'post',
+ ],
+ 'endpoints' => [
+ ['regionId' => 'public', 'regionName' => 'Public network', 'areaId' => 'other', 'areaName' => 'Other', 'public' => 'mssp.aliyuncs.com', 'endpoint' => 'mssp.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [],
+ 'changeSet' => [],
+ 'ram' => [
+ 'productCode' => 'Mssp',
+ 'productName' => 'Managed Security Service',
+ 'ramCodes' => ['yundun-mss'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'CreateServiceWorkOrder',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:CreateServiceWorkOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'GetDetailById',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetDetailById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetVulItemPage',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetVulItemPage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'DisposeWorkTask',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:DisposeWorkTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetVulPageSummary',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetVulPageSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDocumentDownloadUrl',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetDocumentDownloadUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateServiceLinkedRole',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:CreateServiceLinkedRole',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDjbhReport',
+ 'description' => '',
'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsos6B7B1Q',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:DeleteDjbhReport',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'Id',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Primary key ID of the report.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '26579',
+ [
+ 'apiName' => 'GetVulSummary',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetVulSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'example' => '86786E4C-6416-55CF-9AB6-5E275B68801D',
- ],
- 'Code' => [
- 'description' => 'API response code.',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Message' => [
- 'description' => 'Prompt message for the returned result.',
- 'type' => 'string',
- 'example' => 'Successful!',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful. - **true**: The call was successful. - **false**: The call failed.',
- 'type' => 'string',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'GetWorkTaskSummary',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetWorkTaskSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'GetSuspEventPage',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetSuspEventPage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86786E4C-6416-55CF-9AB6-5E275B68801D\\",\\n \\"Code\\": \\"successful\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
- 'title' => 'Delete Security Assessment Report',
- 'translator' => 'machine',
- ],
- 'ConfirmDjbhReport' => [
- 'summary' => 'Confirm Receipt of Security Assessment Report',
- 'path' => '',
- 'methods' => [
- 'post',
+ [
+ 'apiName' => 'GetUserStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetUserStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'ConfirmDjbhReport',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:ConfirmDjbhReport',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetSowList',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetSowList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'DescribeServiceLinkedRole',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:DescribeServiceLinkedRole',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PageServiceCustomer',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:PageServiceCustomer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSafetyCover',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetSafetyCover',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SendCustomEvent',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:SendCustomEvent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDocumentSummary',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetDocumentSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetConsoleScore',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetConsoleScore',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSuspPageSummary',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetSuspPageSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetBaselineSummary',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetBaselineSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAttackedAssetDeal',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetAttackedAssetDeal',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetVulListById',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetVulListById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DisposeServiceWorkOrder',
+ 'description' => '',
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsos6B7B1Q',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:DisposeServiceWorkOrder',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'Id',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'Primary key ID of the report.',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '24563',
+ [
+ 'apiName' => 'GetSuspEventSummary',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetSuspEventSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Request response.',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Request ID.',
- 'type' => 'string',
- 'example' => 'EF801DD1-D934-51B3-92D4-776CE17B184F',
- ],
- 'Code' => [
- 'description' => 'API response code.',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => 'Return message.',
- 'type' => 'string',
- 'example' => 'Successful!',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP status code.',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => 'Whether the call was successful. - **true**: The call was successful. - **false**: The call failed.',
- 'type' => 'string',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'GetAlarmDetailById',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetAlarmDetailById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'GetDocumentPage',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetDocumentPage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRecentDocument',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-mss:GetRecentDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Mssp', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF801DD1-D934-51B3-92D4-776CE17B184F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
- 'title' => 'Confirm Receipt of Security Assessment Report',
- 'translator' => 'machine',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'public',
- 'endpoint' => 'mssp.aliyuncs.com',
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 20:57:52 +0000