summaryrefslogtreecommitdiff
path: root/data/en_us/gemp/2021-04-13/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/en_us/gemp/2021-04-13/api-docs.php')
-rw-r--r--data/en_us/gemp/2021-04-13/api-docs.php32538
1 files changed, 14624 insertions, 17914 deletions
diff --git a/data/en_us/gemp/2021-04-13/api-docs.php b/data/en_us/gemp/2021-04-13/api-docs.php
index 833797f..89d5236 100644
--- a/data/en_us/gemp/2021-04-13/api-docs.php
+++ b/data/en_us/gemp/2021-04-13/api-docs.php
@@ -1,120 +1,33 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'GEMP',
- 'version' => '2021-04-13',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'GEMP', 'version' => '2021-04-13'],
'directories' => [
[
- 'id' => 167154,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'CreateIntegrationConfig',
- 'DisableIntegrationConfig',
- 'EnableIntegrationConfig',
- 'GetIntegrationConfig',
- 'ListIntegrationConfigs',
- 'ListIntegrationConfigTimelines',
- 'ConfirmIntegrationConfig',
- 'DeleteIntegrationConfig',
- 'UpdateIntegrationConfig',
- 'RefreshIntegrationConfigKey',
- ],
- ],
- [
- 'id' => 167201,
- 'title' => null,
+ 'children' => ['CreateIntegrationConfig', 'DisableIntegrationConfig', 'EnableIntegrationConfig', 'GetIntegrationConfig', 'ListIntegrationConfigs', 'ListIntegrationConfigTimelines', 'ConfirmIntegrationConfig', 'DeleteIntegrationConfig', 'UpdateIntegrationConfig', 'RefreshIntegrationConfigKey'],
'type' => 'directory',
- 'children' => [
- 'GetUserGuideStatus',
- 'UpdateUserGuideStatus',
- 'CreateUser',
- 'DeleteUser',
- 'GetUser',
- 'ListUsers',
- 'UpdateUser',
- 'ListUserSerivceGroups',
- ],
- ],
- [
- 'id' => 167134,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'ListServiceGroupMonitorSourceTemplates',
- 'ListDataReportForServiceGroup',
- 'CheckWebhook',
- 'EnableServiceGroupWebhook',
- 'CreateServiceGroup',
- 'DeleteServiceGroup',
- 'DeleteServiceGroupUser',
- 'GetServiceGroup',
- 'ListServiceGroups',
- 'UpdateServiceGroup',
- 'DisableServiceGroupWebhook',
- ],
+ 'title' => 'Integration configuration',
],
[
- 'id' => 198423,
- 'title' => null,
+ 'children' => ['GetUserGuideStatus', 'UpdateUserGuideStatus', 'ListUserSerivceGroups'],
'type' => 'directory',
- 'children' => [
- 'GetServiceGroupSpecialPersonScheduling',
- 'GetServiceGroupSchedulingPreview',
- 'GetServiceGroupPersonScheduling',
- 'CreateServiceGroupScheduling',
- 'GetServiceGroupScheduling',
- 'UpdateServiceGroupSpecialDayScheduling',
- 'UpdateServiceGroupScheduling',
- ],
+ 'title' => 'Personnel',
],
[
- 'id' => 167129,
- 'title' => null,
+ 'children' => ['ListServiceGroupMonitorSourceTemplates', 'ListDataReportForServiceGroup', 'CheckWebhook', 'EnableServiceGroupWebhook', 'CreateServiceGroup', 'DeleteServiceGroup', 'DeleteServiceGroupUser', 'GetServiceGroup', 'ListServiceGroups', 'UpdateServiceGroup', 'DisableServiceGroupWebhook'],
'type' => 'directory',
- 'children' => [
- 'CreateService',
- 'DeleteService',
- 'GetService',
- 'ListServices',
- 'UpdateService',
- ],
+ 'title' => 'Service groups',
],
[
- 'id' => 167145,
- 'title' => null,
+ 'children' => ['GetServiceGroupSpecialPersonScheduling', 'GetServiceGroupSchedulingPreview', 'GetServiceGroupPersonScheduling', 'CreateServiceGroupScheduling', 'GetServiceGroupScheduling', 'UpdateServiceGroupSpecialDayScheduling', 'UpdateServiceGroupScheduling'],
'type' => 'directory',
- 'children' => [
- 'CreateRouteRule',
- 'DeleteRouteRule',
- 'DisableRouteRule',
- 'EnableRouteRule',
- 'GetRouteRule',
- 'ListRouteRules',
- 'UpdateRouteRule',
- 'VerifyRouteRule',
- ],
+ 'title' => 'Scheduling',
],
[
- 'id' => 167149,
- 'title' => null,
+ 'children' => ['CreateRouteRule', 'DeleteRouteRule', 'DisableRouteRule', 'EnableRouteRule', 'GetRouteRule', 'ListRouteRules', 'UpdateRouteRule', 'VerifyRouteRule'],
'type' => 'directory',
- 'children' => [
- 'CreateSubscription',
- 'DeleteSubscription',
- 'EnableSubscription',
- 'UpdateSubscription',
- 'GetSubscription',
- 'DisableSubscription',
- 'ListSubscriptions',
- ],
+ 'title' => 'Routing rules',
],
[
- 'id' => 167189,
- 'title' => null,
- 'type' => 'directory',
'children' => [
'CreateIncidentSubtotal',
'ListIncidentSubtotals',
@@ -122,191 +35,90 @@
'DeleteIncident',
'CreateIncident',
'DeliverIncident',
- 'GetIncident',
'GetIncidentStatistics',
'FinishIncident',
'UpdateIncident',
'RespondIncident',
- 'ListIncidents',
'ListIncidentDetailTimelines',
- 'ListIncidentTimelines',
[
- 'id' => 198426,
- 'title' => null,
+ 'children' => ['GetIncidentSubtotalCount', 'GetSimilarIncidentStatistics'],
'type' => 'directory',
- 'children' => [
- 'GetIncidentSubtotalCount',
- 'GetSimilarIncidentStatistics',
- ],
+ 'title' => 'Similar events',
],
],
+ 'type' => 'directory',
+ 'title' => 'Events',
],
[
- 'id' => 198425,
- 'title' => null,
+ 'children' => ['ListTrendForSourceEvent', 'ListSourceEventsForMonitorSource', 'ListSourceEvents', 'GetEvent'],
'type' => 'directory',
- 'children' => [
- 'ListTrendForSourceEvent',
- 'ListSourceEventsForMonitorSource',
- 'ListSourceEvents',
- 'ListAlerts',
- 'GetEvent',
- ],
+ 'title' => 'Alerts',
],
[
- 'id' => 167162,
- 'title' => null,
- 'type' => 'directory',
'children' => [
- 'GeneratePictureUploadSign',
- 'ListProblemDetailOperations',
- 'UpdateProblemImprovement',
- 'ListSubscriptionServiceGroups',
- 'CreateProblem',
- 'CreateProblemMeasure',
- 'CreateProblemSubtotal',
- 'CreateProblemTimeline',
- 'CreateProblemTimelines',
- 'AddProblemServiceGroup',
- 'UpdateProblem',
- 'UpdateProblemNotice',
- 'UpdateProblemTimeline',
- 'GenerateProblemPictureUploadSign',
- 'ListProblemOperations',
- 'ListProblems',
- 'ListProblemSubtotals',
- 'CancelProblem',
- 'FinishProblem',
- 'RecoverProblem',
- 'ReplayProblem',
- 'RevokeProblemRecovery',
- 'GenerateProblemPictureLink',
- 'UpdateProblemEffectionService',
- 'DeleteProblemEffectionService',
- 'UpdateProblemMeasure',
- 'DeleteProblem',
- 'GetProblem',
- 'GetProblemImprovement',
- 'DeleteProblemMeasure',
- 'DeleteProblemTimeline',
- 'ListProblemTimeLines',
- 'GetProblemEffectionService',
- 'GetProblemPreview',
- 'RemoveProblemServiceGroup',
- 'CreateProblemEffectionService',
+ 'GeneratePictureUploadSign', 'ListProblemDetailOperations', 'UpdateProblemImprovement', 'ListSubscriptionServiceGroups', 'CreateProblem', 'CreateProblemMeasure', 'CreateProblemSubtotal', 'CreateProblemTimeline', 'CreateProblemTimelines', 'AddProblemServiceGroup', 'UpdateProblem', 'UpdateProblemNotice', 'UpdateProblemTimeline', 'GenerateProblemPictureUploadSign', 'ListProblemOperations', 'ListProblems', 'ListProblemSubtotals', 'CancelProblem', 'FinishProblem', 'RecoverProblem',
+ 'ReplayProblem', 'RevokeProblemRecovery', 'GenerateProblemPictureLink', 'UpdateProblemEffectionService', 'DeleteProblemEffectionService', 'UpdateProblemMeasure', 'DeleteProblem', 'GetProblem', 'GetProblemImprovement', 'DeleteProblemMeasure', 'DeleteProblemTimeline', 'ListProblemTimeLines', 'GetProblemEffectionService', 'GetProblemPreview', 'RemoveProblemServiceGroup', 'CreateProblemEffectionService',
],
+ 'type' => 'directory',
+ 'title' => 'Incidents',
],
[
- 'id' => 198424,
- 'title' => null,
+ 'children' => ['GetResourceStatistics', 'ListConfigs', 'ListDictionaries', 'ListMonitorSources'],
'type' => 'directory',
- 'children' => [
- 'GetResourceStatistics',
- 'ListConfigs',
- 'ListDictionaries',
- 'ListMonitorSources',
- ],
+ 'title' => 'Global configuration',
],
[
- 'id' => 198422,
- 'title' => null,
+ 'children' => ['CreateTenantApplication', 'GetTenantApplication'],
'type' => 'directory',
- 'children' => [
- 'CreateTenantApplication',
- 'GetTenantApplication',
- ],
+ 'title' => 'Mobile applications',
],
[
- 'id' => 177155,
- 'title' => null,
+ 'children' => ['PushMonitor'],
'type' => 'directory',
- 'children' => [
- 'PushMonitor',
- ],
+ 'title' => 'Business monitoring',
],
[
- 'id' => 167181,
- 'title' => null,
+ 'children' => ['ListEscalationPlanServices', 'CreateEscalationPlan', 'DeleteEscalationPlan', 'DisableEscalationPlan', 'EnableEscalationPlan', 'GetEscalationPlan', 'ListEscalationPlans', 'UpdateEscalationPlan'],
'type' => 'directory',
- 'children' => [
- 'ListEscalationPlanServices',
- 'CreateEscalationPlan',
- 'DeleteEscalationPlan',
- 'DisableEscalationPlan',
- 'EnableEscalationPlan',
- 'GetEscalationPlan',
- 'ListEscalationPlans',
- 'UpdateEscalationPlan',
- ],
+ 'title' => 'Upgrade plans',
],
[
- 'id' => 167147,
- 'title' => null,
+ 'children' => ['CreateRichText', 'GetRichText', 'UpdateRichText'],
'type' => 'directory',
- 'children' => [
- 'CreateRichText',
- 'GetRichText',
- 'UpdateRichText',
- ],
+ 'title' => 'Rich text',
],
[
- 'id' => 177100,
- 'title' => null,
- 'type' => 'directory',
'children' => [
- 'ListIncidentDetailEscalationPlans',
- 'GetHomePageGuidance',
- 'ListChartDataForServiceGroup',
- 'ListDataReportForUser',
- 'ListChartDataForUser',
- 'GeneratePictureLink',
- 'RemoveIntegrationConfig',
- 'ListByMonitorSourceId',
- 'ListRouteRulesByService',
- 'GetTenantStatus',
- 'BillingStatistics',
- 'DeleteServiceGroupScheduling',
- 'ListEscalationPlansByNoticeObject',
- 'UnbindUser',
- 'ListRouteRulesByAssignWhoId',
- 'ListServiceGroupsByUserId',
+ 'ListIncidentDetailEscalationPlans', 'GetHomePageGuidance', 'ListChartDataForServiceGroup', 'ListDataReportForUser', 'ListChartDataForUser', 'GeneratePictureLink', 'RemoveIntegrationConfig', 'ListByMonitorSourceId', 'ListRouteRulesByService', 'GetTenantStatus', 'BillingStatistics', 'DeleteServiceGroupScheduling', 'ListEscalationPlansByNoticeObject', 'UnbindUser', 'ListRouteRulesByAssignWhoId', 'ListServiceGroupsByUserId', 'CreateService', 'CreateSubscription', 'CreateUser', 'DeleteService',
+ 'DeleteSubscription', 'DeleteUser', 'DisableSubscription', 'EnableSubscription', 'GetIncident', 'GetService', 'GetSubscription', 'GetUser', 'ListAlerts', 'ListIncidentTimelines', 'ListIncidents', 'ListServices', 'ListSubscriptions', 'ListUsers', 'UpdateService', 'UpdateSubscription', 'UpdateUser',
],
+ 'type' => 'directory',
+ 'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateIntegrationConfig' => [
- 'summary' => '创建集成配置',
- 'path' => '/integrationConfig/create',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AddProblemServiceGroup' => [
+ 'summary' => 'Adds a new problem emergency collaboration group.',
+ 'path' => '/problem/addServiceGroup',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempBHVB81',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZVI8H5'],
],
'parameters' => [
[
@@ -314,203 +126,171 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'Request body.',
'properties' => [
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
+ 'problemId' => ['description' => 'Problem ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'],
+ 'serviceGroupIds' => [
+ 'description' => 'Emergency collaboration group.',
+ 'items' => ['description' => 'Emergency collaboration group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '应急协同组ID', 'required' => false, 'title' => ''],
'required' => false,
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
],
'required' => false,
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'data',
- 'properties' => [
- 'integrationConfigId' => [
- 'description' => '',
- 'example' => '101',
- 'format' => 'int64',
- 'title' => '集成配置id',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '5AD6E6BC-2582-4E0E-832D-52CB1B922253'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IntegationConfigAlreadyExists',
- 'errorMessage' => 'The specified integration config already exists.',
- ],
- [
- 'errorCode' => 'CreateIntegrationConfigFail',
- 'errorMessage' => 'Failed to create integration config.',
- ],
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5AD6E6BC-2582-4E0E-832D-52CB1B922253\\"\\n}","type":"json"}]',
+ 'title' => 'Create an incident emergency collaboration group',
+ 'changeSet' => [],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'MonitorSourceNotExists',
- 'errorMessage' => 'The specified monitor source does not exist.',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:AddProblemServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"data\\": {\\n \\"integrationConfigId\\": 101\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateIntegrationConfigResponse>\\n <data>\\n <integrationConfigId>12345703</integrationConfigId>\\n </data>\\n <requestId>E0FACD07-6BC4-4384-819D-B1523BD5EB85</requestId>\\n</CreateIntegrationConfigResponse>","errorExample":""}]',
- ],
- 'DisableIntegrationConfig' => [
- 'summary' => '禁用集成配置',
- 'path' => '/integrationConfig/disable',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddProblemServiceGroup'],
+ ],
],
+ ],
+ 'BillingStatistics' => [
+ 'summary' => 'Billing display',
+ 'path' => '/charging/details',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempSLACC7',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'A short description of struct',
- 'properties' => [
- 'integrationConfigId' => [
- 'description' => '',
- 'example' => '12345703',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'required' => false,
- 'title' => '幂等id',
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- 'title' => 'A short description of struct',
- 'type' => 'object',
- ],
- ],
+ 'abilityTreeNodes' => ['FEATUREgempV73LIB'],
],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
+ 'type' => 'object',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'title' => 'requestId',
- 'type' => 'string',
+ 'data' => [
+ 'description' => 'Return result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ruleCount' => ['description' => 'Total number of transfer rules.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'ruleCountFree' => ['description' => 'Number of free transfer rules.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'subscriptionNotifyCount' => ['description' => 'Number of subscription notifications.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'subscriptionNotifyCountFree' => ['description' => 'Number of free subscription notifications.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'escalationPlanCount' => ['description' => 'Number of escalation policies.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'escalationPlanCountFree' => ['description' => 'Number of free escalation policies.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'hasScheduleServiceGroupCount' => ['description' => 'Number of service schedules.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'hasScheduleServiceGroupCountFree' => ['description' => 'Number of free service schedules.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'appUserCount' => ['description' => 'Number of Cloud DingTalk collaborations.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'appUserCountFree' => ['description' => 'Number of free Cloud DingTalk collaboration users.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'eventReportApi' => ['description' => 'Alert reporting.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'eventReportApiFree' => ['description' => 'Number of free alert reports.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'smsSend' => ['description' => 'Number of text messages.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'smsSendFree' => ['description' => 'Number of free text messages.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'voiceSend' => ['description' => 'Number of calls.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'voiceSendFree' => ['description' => 'Number of free calls.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'emailSend' => ['description' => 'Number of emails.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'emailSendFree' => ['description' => 'Number of free emails.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'imMsgSend' => ['description' => 'Number of instant messages.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'imMsgSendFree' => ['description' => 'Number of free instant messages.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'type' => ['description' => 'Query status under system control:'."\n"
+ ."\n"
+ .'- true: Enable database query.'."\n"
+ ."\n"
+ .'- false: Disable database query.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '4A83AF20-B471-5646-A2CA-2DC688A13013', 'title' => ''],
],
- 'title' => 'Schema of Response',
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IntegationConfigNotIntegrated',
- 'errorMessage' => 'The specified integration config is not integrated.',
- ],
- [
- 'errorCode' => 'IntegationConfigAlreadyDisable',
- 'errorMessage' => 'The specified integration config is already disabled.',
- ],
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"ruleCount\\": 0,\\n \\"ruleCountFree\\": 0,\\n \\"subscriptionNotifyCount\\": 0,\\n \\"subscriptionNotifyCountFree\\": 0,\\n \\"escalationPlanCount\\": 0,\\n \\"escalationPlanCountFree\\": 0,\\n \\"hasScheduleServiceGroupCount\\": 0,\\n \\"hasScheduleServiceGroupCountFree\\": 0,\\n \\"appUserCount\\": 0,\\n \\"appUserCountFree\\": 0,\\n \\"eventReportApi\\": 0,\\n \\"eventReportApiFree\\": 0,\\n \\"smsSend\\": 0,\\n \\"smsSendFree\\": 0,\\n \\"voiceSend\\": 0,\\n \\"voiceSendFree\\": 0,\\n \\"emailSend\\": 0,\\n \\"emailSendFree\\": 0,\\n \\"imMsgSend\\": 0,\\n \\"imMsgSendFree\\": 0,\\n \\"type\\": true\\n },\\n \\"RequestId\\": \\"4A83AF20-B471-5646-A2CA-2DC688A13013\\"\\n}","type":"json"}]',
+ 'title' => 'Billing Display',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-14T14:03:56.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-07-14T13:13:04.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'IntegationConfigNotExists',
- 'errorMessage' => 'The specified integration config does not exist.',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'gemp:BillingStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableIntegrationConfigResponse>\\n <requestId>9B77C7A5-DFBC-4CEF-A710-C802EA9EA8EE</requestId>\\n</DisableIntegrationConfigResponse>","errorExample":""}]',
- ],
- 'EnableIntegrationConfig' => [
- 'summary' => '启用集成配置',
- 'path' => '/integrationConfig/enable',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BillingStatistics'],
+ ],
],
+ ],
+ 'CancelProblem' => [
+ 'summary' => 'Fault cancellation.',
+ 'path' => '/problem/cancel',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempBHVB81',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempWLQJXL'],
],
'parameters' => [
[
@@ -518,95 +298,97 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
- 'properties' => [
- 'integrationConfigId' => [
- 'description' => '',
- 'example' => '101',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'required' => false,
- 'title' => '幂等id',
- 'type' => 'string',
- ],
+ 'description' => 'The request body.',
+ 'properties' => [
+ 'problemId' => ['description' => 'The problem ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '312', 'title' => '', 'required' => false],
+ 'cancelReasonDescription' => ['description' => 'The description of the cancellation reason.', 'type' => 'string', 'example' => '原因描述', 'title' => '', 'required' => false],
+ 'cancelReason' => ['description' => 'The cancellation reason.', 'type' => 'integer', 'format' => 'int64', 'example' => '取消原因', 'title' => '', 'required' => false],
+ 'problemNotifyType' => ['description' => '- PROBLEM\\_NOTIFY: Notification type.'."\n"
+ ."\n"
+ .'- PROBLEM\\_NOTIFY: Problem notification.'."\n"
+ ."\n"
+ .'- PROBLEM\\_UPDATE: Problem update.'."\n"
+ ."\n"
+ .'- PROBLEM\\_UPGRADE: Problem upgrade.'."\n"
+ ."\n"
+ .'- PROBLEM\\_DEGRADE: Problem downgrade.'."\n"
+ ."\n"
+ .'- PROBLEM\\_RECOVER: Problem recovery.'."\n"
+ ."\n"
+ .'- PROBLEM\\_REISSUE: Problem reissue.'."\n"
+ ."\n"
+ .'- PROBLEM\\_CANCEL: Problem cancellation.', 'type' => 'integer', 'format' => 'int64', 'example' => 'PROBLEM_NOTIFY', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'The idempotence token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B81E84B5-8FD1-45F3-969A-B5067AADCFFF'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IntegationConfigNotIntegrated',
- 'errorMessage' => 'The specified integration config is not integrated.',
- ],
- [
- 'errorCode' => 'IntegationConfigAlreadyEnable',
- 'errorMessage' => 'The specified integration config is already enabled.',
- ],
+ 400 => [
+ ['errorCode' => 'ProblemStatusError', 'errorMessage' => 'The problem status is abnormal.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B81E84B5-8FD1-45F3-969A-B5067AADCFFF\\"\\n}","type":"json"}]',
+ 'title' => 'Cancel a fault',
+ 'changeSet' => [],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'IntegationConfigNotExists',
- 'errorMessage' => 'The specified integration config does not exist.',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:CancelProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableIntegrationConfigResponse>\\n <requestId>953F7437-1A7E-41A5-BAD9-086E20E579F8</requestId>\\n</EnableIntegrationConfigResponse>","errorExample":""}]',
- ],
- 'GetIntegrationConfig' => [
- 'summary' => '获取集成配置详情',
- 'path' => '/integrationConfig/detail',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelProblem'],
+ ],
],
+ ],
+ 'CheckWebhook' => [
+ 'summary' => 'Validate the validity of the webhook URL. ',
+ 'path' => '/services/check/webhook',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempBHVB81',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempU4CBQS'],
],
'parameters' => [
[
@@ -615,22 +397,14 @@
'style' => 'json',
'schema' => [
'description' => 'A short description of struct',
+ 'example' => 'body',
'properties' => [
- 'integrationConfigId' => [
- 'description' => '',
- 'example' => '68',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '集成配置id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'required' => false,
- 'title' => '幂等id',
- 'type' => 'string',
- ],
+ 'clientToken' => ['description' => 'Idempotency validation. ', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'webhook' => ['description' => 'Webhook URL. ', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=XXX', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'webhookType' => ['description' => 'Webhook URL type: '."\n"
+ .'- WeCom: WEIXIN_GROUP. '."\n"
+ .'- DingTalk group: DING_GROUP. '."\n"
+ .'- Lark group: FEISHU_GROUP. ', 'example' => 'DING_GROUP', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
@@ -643,108 +417,62 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'data',
- 'properties' => [
- 'integrationConfigId' => [
- 'description' => '',
- 'example' => '101',
- 'format' => 'int64',
- 'title' => '集成配置id、',
- 'type' => 'integer',
- ],
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '65',
- 'format' => 'int64',
- 'title' => '监控源id',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'Zabbix',
- 'title' => '监控源名称',
- 'type' => 'string',
- ],
- 'monitorSourceShortName' => [
- 'description' => '',
- 'example' => 'Zabbix',
- 'title' => '监控源简称',
- 'type' => 'string',
- ],
- 'accessKey' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'title' => '集成秘钥',
- 'type' => 'string',
- ],
- 'isReceivedEvent' => [
- 'description' => '',
- 'example' => 'True',
- 'title' => '是否接收报警',
- 'type' => 'boolean',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'INTEGRATED',
- 'title' => '集成配置状态,DISABLE 禁用,INTEGRATED 已集成,UNINTEGRATED未集成',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'IntegationConfigNotExists',
- 'errorMessage' => 'The specified integration config does not exist.',
- ],
+ 403 => [
+ ['errorCode' => 'WebhookVerificationError', 'errorMessage' => 'A webhook verification error occurred.', 'description' => ''],
+ ['errorCode' => 'WebhookAddressFormatError', 'errorMessage' => 'The webhook address format is invalid.', 'description' => ''],
+ ['errorCode' => 'WebhookAccessRestricts', 'errorMessage' => 'Traffic is restricted for webhook access.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"data\\": {\\n \\"integrationConfigId\\": 101,\\n \\"monitorSourceId\\": 65,\\n \\"monitorSourceName\\": \\"Zabbix\\",\\n \\"monitorSourceShortName\\": \\"Zabbix\\",\\n \\"accessKey\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"isReceivedEvent\\": true,\\n \\"status\\": \\"INTEGRATED\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetIntegrationConfigResponse>\\n <requestId>601FA6A2-AC5C-4B59-BE11-378F887A6A11</requestId>\\n <data>\\n <integrationConfigId>101</integrationConfigId>\\n <monitorSourceId>65</monitorSourceId>\\n <monitorSourceName>Zabbix</monitorSourceName>\\n <monitorSourceShortName>Zabbix</monitorSourceShortName>\\n <accessKey>601FA6A2-AC5C-4B59-BE11-378F887A6A11</accessKey>\\n <isReceivedEvent>true</isReceivedEvent>\\n <status>INTEGRATED</status>\\n </data>\\n</GetIntegrationConfigResponse>","errorExample":""}]',
- ],
- 'ListIntegrationConfigs' => [
- 'summary' => '获取集成配置列表',
- 'path' => '/integrationConfig/list',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","type":"json"}]',
+ 'title' => 'Validate webhook ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'gemp:CheckWebhook',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckWebhook'],
+ ],
],
+ ],
+ 'ConfirmIntegrationConfig' => [
+ 'summary' => 'Confirm the integration configuration. ',
+ 'path' => '/integrationConfig/confirm',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempBHVB81',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempRI7VNP'],
],
'parameters' => [
[
@@ -754,23 +482,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'Zabbix',
- 'required' => false,
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'required' => false,
- 'title' => '幂等id',
- 'type' => 'string',
- ],
+ 'integrationConfigId' => ['description' => 'Integration configuration ID. ', 'example' => '101', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotency token. ', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -779,119 +497,63 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'data',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'integrationConfigId' => [
- 'description' => '',
- 'example' => '1023',
- 'format' => 'int64',
- 'title' => '集成配置id',
- 'type' => 'integer',
- ],
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '87',
- 'format' => 'int64',
- 'title' => '监控源id',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'Zabbix',
- 'title' => '监控源名城',
- 'type' => 'string',
- ],
- 'monitorSourceShortName' => [
- 'description' => '',
- 'example' => 'Zabbix',
- 'title' => '监控源简称',
- 'type' => 'string',
- ],
- 'isReceivedEvent' => [
- 'description' => '',
- 'example' => 'false',
- 'title' => '是否已接受报警',
- 'type' => 'boolean',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'NOT_INTEGRATED',
- 'title' => '集成配置状态',
- 'type' => 'string',
- ],
- 'monitorSourceType' => [
- 'title' => '0:非自定义监控源 1:自定义监控源',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'type' => 'string', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"data\\": [\\n {\\n \\"integrationConfigId\\": 1023,\\n \\"monitorSourceId\\": 87,\\n \\"monitorSourceName\\": \\"Zabbix\\",\\n \\"monitorSourceShortName\\": \\"Zabbix\\",\\n \\"isReceivedEvent\\": false,\\n \\"status\\": \\"NOT_INTEGRATED\\",\\n \\"monitorSourceType\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListIntegrationConfigsResponse>\\n <requestId>601FA6A2-AC5C-4B59-BE11-378F887A6A11</requestId>\\n <data>\\n <integrationConfigId>1023</integrationConfigId>\\n <monitorSourceId>87</monitorSourceId>\\n <monitorSourceName>Zabbix</monitorSourceName>\\n <monitorSourceShortName>Zabbix</monitorSourceShortName>\\n <isReceivedEvent>false</isReceivedEvent>\\n <status>NOT_INTEGRATED</status>\\n </data>\\n</ListIntegrationConfigsResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{'."\n"
- .' "monitorSourceName" : "Zabbix",'."\n"
- .' "clientToken" : "601FA6A2-AC5C-4B59-BE11-378F887A6A11"'."\n"
- .'}',
- 'responseParamsDescription' => '{'."\n"
- .' "requestId": "601FA6A2-AC5C-4B59-BE11-378F887A6A11",'."\n"
- .' "data": ['."\n"
- .' {'."\n"
- .' "integrationConfigId": 1023,'."\n"
- .' "monitorSourceId": 87,'."\n"
- .' "monitorSourceName": "Zabbix",'."\n"
- .' "monitorSourceShortName": "Zabbix",'."\n"
- .' "isReceivedEvent": false,'."\n"
- .' "status": "NOT_INTEGRATED"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .'}',
- ],
- 'ListIntegrationConfigTimelines' => [
- 'summary' => '获取集成配置动态',
- 'path' => '/integrationConfig/timeline',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'IntegationConfigAlreadyIntegrated', 'errorMessage' => 'The specified integration config is already integrated.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'IntegationConfigNotExists', 'errorMessage' => 'The specified integration config does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\"\\n}","type":"json"}]',
+ 'title' => 'Confirm Integration Configuration ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'gemp:ConfirmIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConfirmIntegrationConfig'],
+ ],
],
+ ],
+ 'CreateEscalationPlan' => [
+ 'summary' => 'Create an escalation plan.',
+ 'path' => '/escalationPlan/create',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempBHVB81',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempGUN0ZL'],
],
'parameters' => [
[
@@ -901,41 +563,127 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'integrationConfigId' => [
- 'description' => '',
- 'example' => '101',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '集成配置id',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '分页参数',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '分页参数',
- 'type' => 'integer',
+ 'escalationPlanName' => ['description' => 'Escalation plan name.', 'example' => 'name123', 'required' => true, 'title' => '', 'type' => 'string'],
+ 'escalationPlanDescription' => ['description' => 'Escalation plan description.', 'example' => 'desc2322424', 'required' => true, 'title' => '', 'type' => 'string'],
+ 'escalationPlanScopeObjects' => [
+ 'description' => 'List of escalation plan scope objects.',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'scopeObjectId' => ['description' => 'Scope object ID.', 'example' => '23433', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'scope' => ['description' => 'Scope object type.', 'example' => 'SERVICE', 'required' => false, 'title' => '', 'type' => 'string'],
+ ],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'required' => false,
- 'title' => '幂等参数',
- 'type' => 'string',
+ 'escalationPlanRules' => [
+ 'description' => 'List of escalation plan rules.',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'escalationPlanConditions' => [
+ 'description' => 'Escalation conditions.',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'level' => ['description' => 'Management event Level. Valid values: P1 to P4, where P1 is the highest Priority and P4 is the lowest. ', 'example' => 'P1', 'required' => true, 'title' => '', 'type' => 'string'],
+ 'effection' => ['description' => 'Impact level. Valid values: '."\n"
+ ."\n"
+ .'- HIGH: High '."\n"
+ .'- LOW: Low', 'example' => 'LOW', 'required' => true, 'title' => '', 'type' => 'string'],
+ ],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'escalationPlanStrategies' => [
+ 'description' => 'Upgrade policy. ',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'noticeTime' => ['description' => 'Notification time.', 'example' => '40', 'required' => true, 'title' => '', 'type' => 'string'],
+ 'noticeObjects' => [
+ 'description' => 'List of escalation notification object IDs. ',
+ 'items' => ['description' => 'Notification object. ', 'example' => '23', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'noticeChannels' => [
+ 'description' => 'Escalation notification policy.',
+ 'items' => ['description' => 'List of notification channels. ', 'example' => '["SMS","PHONE"]', 'required' => true, 'type' => 'string', 'title' => ''],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'enableWebhook' => ['description' => 'Whether webhook is enabled. '."\n"
+ ."\n"
+ .'- true: Yes '."\n"
+ .'- false: No ', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'],
+ 'serviceGroupIds' => [
+ 'description' => 'Service group ID. ',
+ 'items' => ['description' => 'Service group ID. ', 'example' => '434', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'escalationPlanType' => ['description' => 'The escalation type. ', 'title' => 'Escalation Type ', 'type' => 'string', 'required' => false, 'example' => 'UN_FINISH'],
+ 'noticeRoleList' => [
+ 'description' => 'The list of roles to notify. ',
+ 'title' => 'Notification Role List ',
+ 'type' => 'array',
+ 'items' => ['description' => 'The list of roles. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10asqwqwwqwq', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'escalationPlanType' => ['description' => 'The escalation type (deprecated; this parameter can be left blank). ', 'example' => 'UN_FINISH', 'required' => false, 'title' => '', 'type' => 'string'],
+ ],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'clientToken' => ['description' => 'clientToken', 'example' => '6b404f14-****-4b53-a1a1-30a58bREQUEST', 'required' => false, 'title' => 'clientToken', 'type' => 'string'],
+ 'isGlobal' => ['description' => 'Indicates whether the policy is global. '."\n"
+ .'- true: Yes '."\n"
+ .'- false: No', 'title' => 'Is Global Policy', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -944,107 +692,75 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D', 'title' => 'Id of the request', 'type' => 'string'],
'data' => [
'description' => 'data',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'title' => [
- 'description' => '',
- 'example' => '',
- 'title' => '主题',
- 'type' => 'string',
- ],
- 'description' => [
- 'description' => '',
- 'example' => '',
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2021-04-05 10:10:10',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
+ 'properties' => [
+ 'escalationPlanId' => ['description' => 'Escalation plan ID.', 'example' => '234532', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
],
- 'type' => 'array',
- ],
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'title' => 'requestId',
- 'type' => 'string',
- ],
- 'totalCount' => [
- 'description' => 'totalCount',
- 'example' => '103',
- 'format' => 'int64',
- 'title' => 'totalCount',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => 'pageNumber',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => 'pageNumber',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => 'pageSize',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => 'pageSize',
- 'type' => 'integer',
+ 'title' => 'data',
+ 'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'IntegationConfigNotExists',
- 'errorMessage' => 'The specified integration config does not exist.',
- ],
+ 400 => [
+ ['errorCode' => 'EscalationPlanRuleNull', 'errorMessage' => 'Escalation plan rule can not be null.', 'description' => ''],
+ ['errorCode' => 'EscalationPlanServiceNull', 'errorMessage' => 'Escalation plan service can not be nulll', 'description' => ''],
+ ['errorCode' => 'EscalationPlanAlreadyExisted', 'errorMessage' => 'The escalation plan already exists.', 'description' => ''],
+ ['errorCode' => 'EscalationPlanServiceAleardyRelated', 'errorMessage' => 'The specified service is already related.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"data\\": [\\n {\\n \\"title\\": \\"时间线标题\\",\\n \\"description\\": \\"描述xxxxx\\",\\n \\"createTime\\": \\"2021-04-05 10:10:10\\"\\n }\\n ],\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"totalCount\\": 103,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListIntegrationConfigTimelinesResponse>\\n <data>\\n <title>时间线标题</title>\\n <description>描述xxxxx</description>\\n <createTime>2021-04-05 10:10:10</createTime>\\n </data>\\n <requestId>601FA6A2-AC5C-4B59-BE11-378F887A6A11</requestId>\\n <totalCount>103</totalCount>\\n <pageNumber>1</pageNumber>\\n <pageSize>10</pageSize>\\n</ListIntegrationConfigTimelinesResponse>","errorExample":""}]',
- ],
- 'ConfirmIntegrationConfig' => [
- 'summary' => '确认集成配置',
- 'path' => '/integrationConfig/confirm',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC21925D\\",\\n \\"data\\": {\\n \\"escalationPlanId\\": 234532\\n }\\n}","type":"json"}]',
+ 'title' => 'Create an escalation plan',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-03-03T02:18:07.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateEscalationPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEscalationPlan'],
+ ],
],
+ ],
+ 'CreateIncident' => [
+ 'summary' => 'Manually create an incident.',
+ 'path' => '/incident/manualSave',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempRI7VNP',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempKAIUZH'],
],
'parameters' => [
[
@@ -1052,26 +768,31 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'body',
'properties' => [
- 'integrationConfigId' => [
- 'description' => '',
- 'example' => '101',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
+ 'incidentLevel' => ['description' => 'Event level: P1, P2, P3, P4', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'P1'],
+ 'clientToken' => ['description' => 'Idempotency token', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef729f'],
+ 'relatedServiceId' => ['description' => 'Service ID', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '12312'],
+ 'effect' => ['description' => 'Impact level: HIGH, LOW', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'LOW'],
+ 'incidentTitle' => ['description' => 'Incident title', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '事件标题A'],
+ 'assignUserId' => ['description' => 'Assignee ID', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '12312'],
+ 'incidentDescription' => ['description' => 'Incident description', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '事件描述B'],
+ 'channels' => [
+ 'description' => 'Notification channels<br>'."\n"
+ .'SMS (text message), EMAIL (email)<br>'."\n"
+ .'PHONE (phone call), WEIXIN\\_GROUP (WeCom group), DING\\_GROUP (DingTalk group), WEBHOOK (webhook notification)<br><br>',
+ 'items' => ['description' => 'Notification channel', 'type' => 'string', 'example' => 'SMS', 'required' => false, 'title' => ''],
'required' => false,
- 'title' => '幂等id',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'serviceGroupId' => ['description' => '12000', 'type' => 'integer', 'format' => 'int64', 'example' => '服务组id', 'title' => '', 'required' => false],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -1080,63 +801,71 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
+ 'data' => [
'description' => 'Id of the request',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'type' => 'string',
+ 'properties' => [
+ 'incidentId' => ['description' => 'Incident primary key ID', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '事件Id'],
+ ],
+ 'title' => 'Id of the request',
+ 'type' => 'object',
+ 'example' => '',
],
+ 'requestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IntegationConfigAlreadyIntegrated',
- 'errorMessage' => 'The specified integration config is already integrated.',
- ],
+ 404 => [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified Resource is not found.', 'description' => 'The specified Resource is not found.'],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"incidentId\\": 0\\n },\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","type":"json"}]',
+ 'title' => 'Manually create a management event',
+ 'changeSet' => [
+ ['createdAt' => '2021-07-16T04:09:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'IntegationConfigNotExists',
- 'errorMessage' => 'The specified integration config does not exist.',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\"\\n}","errorExample":""},{"type":"xml","example":"<ConfirmIntegrationConfigResponse>\\n <requestId>ADAB577F-5192-4301-B7C8-BE7B0FDB255E</requestId>\\n</ConfirmIntegrationConfigResponse>","errorExample":""}]',
- ],
- 'DeleteIntegrationConfig' => [
- 'summary' => '删除集成配置',
- 'path' => '/integrationConfig/delete',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIncident'],
+ ],
],
+ ],
+ 'CreateIncidentSubtotal' => [
+ 'summary' => 'Add a subtotal to a management event.',
+ 'path' => '/incident/save/subtotal',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempSLACC7',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempHBPHMV'],
],
'parameters' => [
[
@@ -1144,27 +873,16 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'body',
'properties' => [
- 'integrationConfigId' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '集成配置id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'required' => false,
- 'title' => '幂等id',
- 'type' => 'string',
- ],
+ 'incidentId' => ['description' => 'Management event ID.', 'example' => '12312', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'description' => ['description' => 'Description.', 'example' => '描述', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'clientToken' => ['description' => 'Idempotency validation.', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -1173,58 +891,73 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['description' => 'requestId', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'title' => 'requestId', 'type' => 'string'],
+ 'data' => [
+ 'description' => 'data',
+ 'properties' => [
+ 'subtotalId' => ['description' => 'Subtotal ID.', 'example' => '123', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IncidentStatusInvalid', 'errorMessage' => 'The incident status is invalid.', 'description' => ''],
+ ['errorCode' => 'IncidentUpdateInvalid', 'errorMessage' => 'The incident update is invalid.', 'description' => ''],
+ ],
404 => [
- [
- 'errorCode' => 'IntegationConfigNotExists',
- 'errorMessage' => 'The specified integration config does not exist.',
- ],
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIntegrationConfigResponse>\\n <requestId>601FA6A2-AC5C-4B59-BE11-378F887A6A11</requestId>\\n</DeleteIntegrationConfigResponse>","errorExample":""}]',
- ],
- 'UpdateIntegrationConfig' => [
- 'summary' => '更新集成配置',
- 'path' => '/integrationConfig/update',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"subtotalId\\": 123\\n }\\n}","type":"json"}]',
+ 'title' => 'Add a subtotal to a management event',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateIncidentSubtotal',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIncidentSubtotal'],
+ ],
],
+ ],
+ 'CreateIntegrationConfig' => [
+ 'summary' => 'Create an integration configuration. ',
+ 'path' => '/integrationConfig/create',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempBHVB81',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempBHVB81'],
],
'parameters' => [
[
@@ -1232,33 +965,15 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'body',
'properties' => [
- 'integrationConfigId' => [
- 'description' => '',
- 'example' => '103',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'accessKey' => [
- 'description' => 'accessKey',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'required' => false,
- 'title' => '集成秘钥',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F987A6A98',
- 'required' => false,
- 'title' => '幂等id',
- 'type' => 'string',
- ],
+ 'monitorSourceId' => ['description' => 'Monitoring source ID. ', 'example' => '23469', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotency token. ', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'required' => false, 'type' => 'string', 'title' => ''],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -1267,64 +982,73 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['description' => 'id of the request', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'type' => 'string', 'title' => ''],
+ 'data' => [
+ 'description' => 'data',
+ 'properties' => [
+ 'integrationConfigId' => ['description' => 'Integration configuration ID. ', 'example' => '101', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'IntegationConfigNotDisable',
- 'errorMessage' => 'The specified integration config is not disabled.',
- ],
+ ['errorCode' => 'IntegationConfigAlreadyExists', 'errorMessage' => 'The specified integration config already exists.', 'description' => ''],
+ ['errorCode' => 'CreateIntegrationConfigFail', 'errorMessage' => 'Failed to create integration config.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IntegationConfigNotExists',
- 'errorMessage' => 'The specified integration config does not exist.',
- ],
+ ['errorCode' => 'MonitorSourceNotExists', 'errorMessage' => 'The specified monitor source does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateIntegrationConfigResponse>\\n <requestId>CE900955-A6DD-4923-9F53-6283B9D0D32A</requestId>\\n</UpdateIntegrationConfigResponse>","errorExample":""}]',
- ],
- 'RefreshIntegrationConfigKey' => [
- 'summary' => '刷新集成配置key',
- 'path' => '/integrationConfig/refreshKey',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"data\\": {\\n \\"integrationConfigId\\": 101\\n }\\n}","type":"json"}]',
+ 'title' => 'Create Integration Configuration ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIntegrationConfig'],
+ ],
],
+ ],
+ 'CreateProblem' => [
+ 'summary' => 'A new fault has occurred.',
+ 'path' => '/problem/upgrade',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempBHVB81',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZB7ZAW'],
],
'parameters' => [
[
@@ -1332,104 +1056,131 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
- 'properties' => [
- 'integrationConfigId' => [
- 'description' => '',
- 'example' => '102',
- 'format' => 'int64',
+ 'description' => 'Request body.',
+ 'properties' => [
+ 'problemName' => ['description' => 'Problem name.', 'type' => 'string', 'example' => '故障A', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'Idempotent check token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'E789D869-DB13-4913-BAA8-A1F56F94B94D'],
+ 'problemStatus' => ['description' => 'Problem status:'."\n"
+ ."\n"
+ .'- HANDLING: In progress.'."\n"
+ ."\n"
+ .'- RECOVERED: Recovered.'."\n"
+ ."\n"
+ .'- REPLAYING: Replaying.'."\n"
+ ."\n"
+ .'- REPLAYED: Replayed.'."\n"
+ ."\n"
+ .'- CANCEL: Canceled.', 'type' => 'string', 'example' => 'HANDLING', 'title' => '', 'required' => false],
+ 'problemLevel' => ['description' => 'Problem level in descending order:'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'string', 'example' => 'P2', 'title' => '', 'required' => false],
+ 'progressSummary' => ['description' => 'Progress summary.', 'type' => 'string', 'example' => '进展摘要', 'title' => '', 'required' => false],
+ 'relatedServiceId' => ['description' => 'Service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123122', 'title' => '', 'required' => false],
+ 'mainHandlerId' => ['description' => 'Main handler.', 'type' => 'integer', 'format' => 'int64', 'example' => '32121', 'title' => '', 'required' => false],
+ 'preliminaryReason' => ['description' => 'Preliminary reason.', 'type' => 'string', 'example' => '初步原因', 'title' => '', 'required' => false],
+ 'discoverTime' => ['description' => 'Discovery time.', 'type' => 'string', 'example' => '2020-10-02 00:00:00', 'title' => '', 'required' => false],
+ 'recoveryTime' => ['description' => 'Recovery time.', 'type' => 'string', 'example' => '2020-10-02 00:00:00', 'title' => '', 'required' => false],
+ 'affectServiceIds' => [
+ 'description' => 'List of affected services.',
+ 'items' => ['description' => 'Affected service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1232231', 'required' => false, 'title' => ''],
'required' => false,
- 'type' => 'integer',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
+ 'serviceGroupIds' => [
+ 'description' => 'Emergency collaboration group.',
+ 'items' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '213121', 'required' => false, 'title' => ''],
'required' => false,
- 'title' => '幂等id',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'incidentId' => ['description' => 'Event ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123221', 'title' => '', 'required' => false],
+ 'problemNotifyType' => ['description' => 'Notification type.', 'type' => 'string', 'example' => 'PROBLEM_NOTIFY', 'title' => '', 'required' => false],
+ 'progressSummaryRichTextId' => ['description' => 'Progress description rich text ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '343', 'title' => '', 'required' => false],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'E789D869-DB13-4933-BAA8-A1F56F94B94D'],
'data' => [
- 'description' => 'data',
+ 'description' => 'Result.',
'properties' => [
- 'key' => [
- 'description' => '',
- 'example' => '859FA6A2-AC5C-4B09-BE23-986F887H6A232',
- 'title' => '集成秘钥',
- 'type' => 'string',
- ],
+ 'problemId' => ['description' => 'Problem ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '321331'],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'IntegationConfigNotDisable',
- 'errorMessage' => 'The specified integration config is not disabled.',
- ],
+ 404 => [
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E789D869-DB13-4933-BAA8-A1F56F94B94D\\",\\n \\"data\\": {\\n \\"problemId\\": 321331\\n }\\n}","type":"json"}]',
+ 'title' => 'Problem upgrade ',
+ 'changeSet' => [],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'IntegationConfigNotExists',
- 'errorMessage' => 'The specified integration config does not exist.',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"data\\": {\\n \\"key\\": \\"859FA6A2-AC5C-4B09-BE23-986F887H6A232\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RefreshIntegrationConfigKeyResponse>\\n <requestId>601FA6A2-AC5C-4B59-BE11-378F887A6A11</requestId>\\n <data>\\n <key>859FA6A2-AC5C-4B09-BE23-986F887H6A232</key>\\n </data>\\n</RefreshIntegrationConfigKeyResponse>","errorExample":""}]',
- ],
- 'GetUserGuideStatus' => [
- 'summary' => '查询用户新手引导状态',
- 'path' => '/user/guide/status',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProblem'],
+ ],
],
+ ],
+ 'CreateProblemEffectionService' => [
+ 'summary' => 'Create an impact service. ',
+ 'path' => '/problem/process/effectionService/create',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempVWXIZC',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZVI8H5'],
],
'parameters' => [
[
@@ -1439,17 +1190,27 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
+ 'serviceId' => ['description' => 'Impact service ID. ', 'example' => '185647232', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'level' => ['description' => 'Impact level. ', 'example' => 'P1', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'status' => ['description' => 'Impact status: '."\n"
+ .'- 0: Not recovered. '."\n"
+ .'- 1: Recovered. ', 'example' => '0', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'description' => ['description' => 'Impact description. ', 'example' => '这是一个影响描述。', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'pictureUrl' => [
+ 'description' => 'Image URLs. ',
+ 'items' => ['description' => 'Image key. ', 'example' => 'problem/xxxxxxxssxxxa2c8-40b9-9162-08a6c2e338e2', 'required' => false, 'type' => 'string', 'title' => ''],
'required' => false,
- 'title' => '幂等校验',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'problemId' => ['description' => 'Problem ID. ', 'example' => '164327640', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'clientToken', 'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c', 'required' => false, 'title' => 'clientToken', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -1458,56 +1219,72 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'id of the request', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81', 'type' => 'string', 'title' => ''],
'data' => [
- 'description' => 'map',
- 'example' => '{ "data": { "monitorGuide": false, "userRamId": 1344371, "serviceGuide": false, "noticeGuide": false, "userGuide": true, "serviceGroupGuide": false, "routeRuleGuide": false, "incidentGuide": true }',
- 'title' => 'map',
+ 'description' => 'data',
+ 'properties' => [
+ 'effectionServiceId' => ['description' => 'Impact service ID. ', 'example' => '125647350', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ ],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetUserGuideStatusResponse>\\n <data>\\n <monitorGuide>false</monitorGuide>\\n <userRamId>1344371</userRamId>\\n <serviceGuide>false</serviceGuide>\\n <noticeGuide>false</noticeGuide>\\n <userGuide>true</userGuide>\\n <serviceGroupGuide>false</serviceGroupGuide>\\n <routeRuleGuide>false</routeRuleGuide>\\n <incidentGuide>true</incidentGuide>\\n </data>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n</GetUserGuideStatusResponse>","errorExample":""}]',
- ],
- 'UpdateUserGuideStatus' => [
- 'summary' => '更新用户新手引导状态',
- 'path' => '/user/update/guide/status',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'EffectionServiceAlreadyExisted', 'errorMessage' => 'EffectionService already exists.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\",\\n \\"data\\": {\\n \\"effectionServiceId\\": 125647350\\n }\\n}","type":"json"}]',
+ 'title' => 'Create an impact service ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateProblemEffectionService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProblemEffectionService'],
+ ],
],
+ ],
+ 'CreateProblemMeasure' => [
+ 'summary' => 'Creates an improvement measure for a problem.',
+ 'path' => '/problem/improvement/measure/save',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempVWXIZC',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempLC8226'],
],
'parameters' => [
[
@@ -1515,79 +1292,98 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'required' => false,
- 'title' => '幂等校验',
- 'type' => 'string',
- ],
- 'guideAction' => [
- 'description' => '',
- 'example' => 'SERVICE_GROUP_GUIDE',
- 'required' => false,
- 'title' => 'INCIDENT_GUIDE 事件线 INCIDENT_GUIDE配置人员 USER_GUIDE 服务组 SERVICE_GROUP_GUIDE 服务 SERVICE_GUIDE 集成配置 MONITOR_GUIDE 流转规则 ROUTE_RULE_GUIDE 通知订阅 NOTICE_GUIDE',
- 'type' => 'string',
- ],
+ 'description' => 'The request body.',
+ 'properties' => [
+ 'type' => ['description' => 'The type of the measure.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ 'problemId' => ['description' => 'The ID of the problem.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23', 'title' => ''],
+ 'content' => ['description' => 'The content of the measure.', 'type' => 'string', 'example' => '措施内容', 'title' => '', 'required' => false],
+ 'checkStandard' => ['description' => 'The acceptance criteria.', 'type' => 'string', 'example' => '标准', 'title' => '', 'required' => false],
+ 'checkUserId' => ['description' => 'The ID of the user who accepts the measure.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => '', 'required' => false],
+ 'planFinishTime' => ['description' => 'The planned completion time.', 'type' => 'string', 'example' => '2020-01-23 00:00:00', 'title' => '', 'required' => false],
+ 'directorId' => ['description' => 'The ID of the owner.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => '', 'required' => false],
+ 'stalkerId' => ['description' => 'The ID of the tracker.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => '', 'required' => false],
+ 'status' => ['description' => 'The status of the measure. Valid values:'."\n"
+ ."\n"
+ .'- IMPROVED'."\n"
+ ."\n"
+ .'- UNIMPROVED', 'type' => 'string', 'example' => 'IMPROVED', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'The idempotence token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812'],
+ 'data' => [
+ 'description' => 'The returned data.',
+ 'properties' => [
+ 'measureId' => ['description' => 'The ID of the improvement measure.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1231'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateUserGuideStatusResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n</UpdateUserGuideStatusResponse>","errorExample":""}]',
- ],
- 'CreateUser' => [
- 'summary' => '创建用户',
- 'path' => '/user/create',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\",\\n \\"data\\": {\\n \\"measureId\\": 1231\\n }\\n}","type":"json"}]',
+ 'title' => 'Create a Fault Improvement Measure ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateProblemMeasure',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProblemMeasure'],
+ ],
],
+ ],
+ 'CreateProblemSubtotal' => [
+ 'summary' => 'Add a subtotal note to a fault.',
+ 'path' => '/problem/save/subtotal',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempT8ZOYV',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZB7ZAW'],
],
'parameters' => [
[
@@ -1597,49 +1393,14 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'ramId' => [
- 'description' => '',
- 'example' => '4787654378343',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'phone' => [
- 'description' => '',
- 'example' => '188898989892',
- 'required' => false,
- 'type' => 'string',
- ],
- 'username' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'email' => [
- 'description' => '',
- 'example' => '5678@qq.com',
- 'required' => false,
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'required' => false,
- 'type' => 'string',
- ],
- 'roleIdList' => [
- 'title' => '角色ID列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
+ 'problemId' => ['description' => 'Fault ID.', 'example' => '1231', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'description' => ['description' => 'Subtotal text.', 'example' => '描述', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'clientToken' => ['description' => 'Idempotency validation token.', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3814', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -1648,85 +1409,69 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd381A', 'title' => 'Id of the request', 'type' => 'string'],
'data' => [
- 'description' => 'data',
+ 'description' => 'object',
'properties' => [
- 'userId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
+ 'subtotalId' => ['description' => 'Subtotal ID.', 'example' => '123', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'PhoneAlreadyExists',
- 'errorMessage' => 'The specified phone number already exists.',
- ],
- [
- 'errorCode' => 'UserCountExcess',
- 'errorMessage' => 'Available users have run out, please upgrade to a higher version.',
- ],
- ],
- 402 => [
- [
- 'errorCode' => 'IdentitySelectionError',
- 'errorMessage' => 'Identity selection error',
- ],
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd381A\\",\\n \\"data\\": {\\n \\"subtotalId\\": 123\\n }\\n}","type":"json"}]',
+ 'title' => 'Add a subtotal note to a fault',
+ 'changeSet' => [],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'UserAlreadyExists',
- 'errorMessage' => 'The specified user already exists.',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateProblemSubtotal',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\",\\n \\"data\\": {\\n \\"userId\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateUserResponse>\\n <requestId>c26f36de-1ec8-496a-a828-880676c5ef81</requestId>\\n <data>\\n <userId>1</userId>\\n </data>\\n</CreateUserResponse>","errorExample":""}]',
- ],
- 'DeleteUser' => [
- 'summary' => '删除用户',
- 'path' => '/user/delete',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProblemSubtotal'],
+ ],
],
+ ],
+ 'CreateProblemTimeline' => [
+ 'summary' => 'Creates a problem timeline node.',
+ 'path' => '/problem/process/timeline/create',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempT8ZOYV',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZVI8H5'],
],
'parameters' => [
[
@@ -1736,25 +1481,16 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'userId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'problemId' => ['description' => 'Problem ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102', 'title' => ''],
+ 'keyNode' => ['description' => 'Key node lookup table: PROBLEM\\_KEY\\_NODE', 'type' => 'string', 'required' => false, 'example' => 'PROBLEM_KEY_NODE', 'title' => ''],
+ 'content' => ['description' => 'Node content', 'type' => 'string', 'example' => '时间线内容XXXX', 'title' => '', 'required' => false],
+ 'time' => ['description' => 'Occurrence time', 'type' => 'string', 'example' => '2021-06-06 12:11:22', 'title' => '', 'required' => false],
+ 'clientToken' => ['title' => 'clientToken', 'description' => 'Idempotent identity', 'type' => 'string', 'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -1763,76 +1499,69 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'title' => 'id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'id of the request', 'description' => 'id of the request', 'type' => 'string', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88'],
+ 'data' => [
+ 'description' => 'data',
+ 'properties' => [
+ 'problemTimelineId' => ['description' => 'Problem timeline ID', 'type' => 'integer', 'format' => 'int64', 'example' => '102', 'title' => ''],
+ ],
+ 'title' => 'Object',
+ 'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'DeleteUserFail ',
- 'errorMessage' => 'The user has been associated with route rule.',
- ],
- ],
- [
- [
- 'errorCode' => 'DeleteUserFail ',
- 'errorMessage' => 'The user has been associated with escalationPlan.',
- ],
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"problemTimelineId\\": 102\\n }\\n}","type":"json"}]',
+ 'title' => 'Create a fault timeline node',
+ 'changeSet' => [],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'DeleteUserFail ',
- 'errorMessage' => 'Users are scheduled.',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateProblemTimeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 404 => [
- [
- 'errorCode' => 'UserNotExists',
- 'errorMessage' => 'The specified user does not exist.',
- ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProblemTimeline'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteUserResponse>\\n <requestId>c26f36de-1ec8-496a-a828-880676c5ef81</requestId>\\n</DeleteUserResponse>","errorExample":""}]',
],
- 'GetUser' => [
- 'summary' => '获取用户详情',
- 'path' => '/user/getUser',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateProblemTimelines' => [
+ 'summary' => 'Create time points in batch.',
+ 'path' => '/problem/process/timeline/batchCreate',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempT8ZOYV',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempLC8226'],
],
'parameters' => [
[
@@ -1842,25 +1571,14 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'userId' => [
- 'description' => '',
- 'example' => '63',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'problemId' => ['description' => 'Problem ID.', 'example' => '423', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'timelineNodes' => ['description' => 'Timeline nodes.', 'example' => '2018-01-01 18:01,谁做了什么事情\\n2018-01-01 18:01,谁做了什么事情\\n2018-01-01 18:01,谁做了什么事情', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'clientToken' => ['description' => 'clientToken', 'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c', 'required' => false, 'title' => 'clientToken', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -1869,166 +1587,79 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'id of the request', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88', 'type' => 'string', 'title' => ''],
'data' => [
- 'description' => '',
+ 'description' => 'data',
'properties' => [
- 'userId' => [
- 'description' => '',
- 'example' => '63',
- 'format' => 'int64',
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- 'ramId' => [
- 'description' => 'ramId',
- 'example' => '1344383',
- 'title' => 'ramId',
- 'type' => 'string',
- ],
- 'isEditableUser' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '是否可编辑',
- 'type' => 'boolean',
- ],
- 'accountType' => [
- 'description' => '',
- 'example' => 'SUB',
- 'title' => 'CUSTOMER:主账号,SUB:子账号',
- 'type' => 'string',
- ],
- 'email' => [
- 'description' => 'email',
- 'example' => '5678***@qq.com',
- 'title' => 'email',
- 'type' => 'string',
- ],
- 'username' => [
- 'description' => '',
- 'example' => '',
- 'title' => '用户昵称',
- 'type' => 'string',
- ],
- 'phone' => [
- 'description' => '',
- 'example' => '1390000****',
- 'title' => '用户手机号',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2021-09-09 09:09:09',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'isRelated' => [
- 'description' => '',
- 'example' => 'RELATE',
- 'title' => '是否关联',
- 'type' => 'string',
- ],
- 'serviceGroups' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'name' => [
- 'description' => '',
- 'example' => '山口组',
- 'title' => '服务组名称',
- 'type' => 'string',
- ],
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '10000',
- 'format' => 'int64',
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '所属服务组',
- 'type' => 'array',
- ],
- 'roleIdList' => [
- 'title' => '角色ID列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'roleNameList' => [
- 'title' => '角色名称列表',
+ 'problemTimelineIds' => [
+ 'description' => 'List of timeline IDs.',
+ 'items' => ['description' => 'Timeline ID.', 'example' => '435', 'format' => 'int64', 'type' => 'integer', 'title' => ''],
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'isActive' => [
- 'title' => '账号是否激活 1已激活 0未激活',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'example' => '',
],
],
- 'title' => '用户',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'UserNotExists',
- 'errorMessage' => 'The specified user does not exist.',
+ 403 => [
+ ['errorCode' => 'TimelineFormatException', 'errorMessage' => 'The timeline format is invalid.', 'description' => ''],
+ ['errorCode' => 'TimeFormatException', 'errorMessage' => 'The time format is invalid.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"problemTimelineIds\\": [\\n 435\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Create time points in batch.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateProblemTimelines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProblemTimelines'],
+ ],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\",\\n \\"data\\": {\\n \\"userId\\": 63,\\n \\"ramId\\": \\"1344383\\",\\n \\"isEditableUser\\": true,\\n \\"accountType\\": \\"1\\",\\n \\"email\\": \\"5678***@qq.com\\",\\n \\"username\\": \\"马先生\\",\\n \\"phone\\": \\"1390000****\\",\\n \\"createTime\\": \\"2021-09-09 09:09:09\\",\\n \\"isRelated\\": \\"RELATE\\",\\n \\"serviceGroups\\": [\\n {\\n \\"name\\": \\"研发组\\",\\n \\"serviceGroupId\\": 10000\\n }\\n ],\\n \\"roleIdList\\": [\\n 0\\n ],\\n \\"roleNameList\\": [\\n \\"\\"\\n ],\\n \\"isActive\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetUserResponse>\\n <requestId>c26f36de-1ec8-496a-a828-880676c5ef81</requestId>\\n <data>\\n <userId>63</userId>\\n <ramId>1344383</ramId>\\n <isEditableUser>true</isEditableUser>\\n <accountType>SUB</accountType>\\n <email>5678***@qq.com</email>\\n <username>张珊</username>\\n <phone>1390000****</phone>\\n </data>\\n</GetUserResponse>","errorExample":""}]',
],
- 'ListUsers' => [
- 'summary' => '人员列表',
- 'path' => '/user/list',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateRichText' => [
+ 'summary' => 'Creates a rich text.',
+ 'path' => '/rich/create',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempT8ZOYV',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempHBPHMV'],
],
'parameters' => [
[
@@ -2036,255 +1667,96 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'The request body.',
'properties' => [
- 'username' => [
- 'description' => '',
- 'example' => '张三',
- 'required' => false,
- 'title' => '人员名称',
- 'type' => 'string',
- ],
- 'phone' => [
- 'description' => '',
- 'example' => '1887879****',
- 'required' => false,
- 'title' => '人员手机号',
- 'type' => 'string',
- ],
- 'ramId' => [
- 'description' => '',
- 'example' => '1344383',
- 'required' => false,
- 'title' => 'ramID',
- 'type' => 'string',
- ],
- 'scene' => [
- 'description' => '',
- 'example' => 'USER_LIST',
- 'format' => 'int64',
- 'required' => false,
- 'title' => 'USER_LIST列表 ALL_USERS下拉',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => 'clientToken',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '分页参数',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '分页参数',
- 'type' => 'integer',
- ],
- 'synergyChannel' => [
- 'description' => '',
- 'example' => 'DINGDING',
- 'required' => false,
- 'title' => '移动应用协同渠道',
- 'type' => 'string',
- ],
+ 'instanceId' => ['description' => 'The resource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '140080050'."\n", 'title' => '', 'required' => false],
+ 'instanceType' => ['description' => 'The resource type.'."\n"
+ ."\n"
+ .'- INCIDENT: event.'."\n"
+ ."\n"
+ .'- ALERT: alert.'."\n"
+ ."\n"
+ .'- PROBLEM: problem.', 'type' => 'string', 'example' => 'INCIDENT', 'title' => '', 'required' => false],
+ 'richText' => ['description' => 'The rich text content.', 'type' => 'string', 'example' => '这是一个富文本', 'title' => '', 'required' => false],
],
'required' => false,
- 'title' => 'A short description of struct',
+ 'title' => 'body',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'title' => 'id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88'],
'data' => [
- 'description' => 'data',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'userId' => [
- 'description' => '',
- 'example' => '1234',
- 'format' => 'int64',
- 'title' => '用户id',
- 'type' => 'integer',
- ],
- 'ramId' => [
- 'description' => '',
- 'example' => '53624523',
- 'format' => 'int64',
- 'title' => '子账号ramId',
- 'type' => 'integer',
- ],
- 'username' => [
- 'description' => '',
- 'example' => '',
- 'title' => '用户名',
- 'type' => 'string',
- ],
- 'phone' => [
- 'description' => '',
- 'example' => '1390000****',
- 'title' => '手机',
- 'type' => 'string',
- ],
- 'email' => [
- 'description' => '',
- 'example' => '2345****@qq.com',
- 'title' => '邮箱',
- 'type' => 'string',
- ],
- 'isEditableUser' => [
- 'description' => '',
- 'example' => 'true',
- 'format' => 'int64',
- 'title' => '是否可编辑',
- 'type' => 'integer',
- ],
- 'accountType' => [
- 'description' => '',
- 'example' => 'SUB',
- 'format' => 'int64',
- 'title' => '账户类型',
- 'type' => 'integer',
- ],
- 'appAccount' => [
- 'description' => '',
- 'example' => '23456tre',
- 'title' => '移动应用账户',
- 'type' => 'string',
- ],
- 'synergyChannel' => [
- 'description' => '',
- 'example' => 'DINGDING',
- 'title' => '移动应用协同渠道',
- 'type' => 'string',
- ],
- 'isRelated' => [
- 'description' => '',
- 'example' => 'RELATED关联 NOT_RELATED 未关联',
- 'title' => '是否关联',
- 'type' => 'string',
- ],
- 'isOperation' => [
- 'title' => '是否可操作(删除,取消关联) 1可操作 0不可操作',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'isRam' => [
- 'title' => '是否是主账号 1是 0不是',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'roleIdList' => [
- 'title' => '角色ID列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'roleNameList' => [
- 'title' => '角色名称列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'isActive' => [
- 'title' => '账号是否激活 1已激活 0未激活',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'gmtCreate' => [
- 'type' => 'string',
- ],
- 'gmtActive' => [
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
+ 'description' => 'The returned data.',
+ 'properties' => [
+ 'instanceId' => ['description' => 'The resource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '140080050'."\n", 'title' => ''],
+ 'instanceType' => ['description' => 'The resource type.'."\n"
+ ."\n"
+ .'- 0: event.'."\n"
+ ."\n"
+ .'- 1: alert.'."\n"
+ ."\n"
+ .'- 2: problem.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'richText' => ['description' => 'The rich text content.', 'type' => 'string', 'example' => '这是一个富文本', 'title' => ''],
],
'title' => 'data',
- 'type' => 'array',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '总条数',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '分页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '分页',
- 'type' => 'integer',
+ 'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\",\\n \\"data\\": [\\n {\\n \\"userId\\": 1234,\\n \\"ramId\\": 53624523,\\n \\"username\\": \\"张先生\\",\\n \\"phone\\": \\"1887879****\\",\\n \\"email\\": \\"2345****@qq.com\\",\\n \\"isEditableUser\\": 0,\\n \\"accountType\\": 1,\\n \\"appAccount\\": \\"23456tre\\",\\n \\"synergyChannel\\": \\"DINGDING\\",\\n \\"isRelated\\": \\"RELATED\\",\\n \\"isOperation\\": 1,\\n \\"isRam\\": 1,\\n \\"roleIdList\\": [\\n 0\\n ],\\n \\"roleNameList\\": [\\n \\"\\"\\n ],\\n \\"isActive\\": 1,\\n \\"gmtCreate\\": \\"\\",\\n \\"gmtActive\\": \\"\\"\\n }\\n ],\\n \\"totalCount\\": 100,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListUsersResponse>\\n <requestId>c26f36de-1ec8-496a-a828-880676c5ef81</requestId>\\n <data>\\n <userId>1234</userId>\\n <ramId>53624523</ramId>\\n <username>张珊</username>\\n <phone>1390000****</phone>\\n <email>2345****@qq.com</email>\\n <appAccount>23456tre</appAccount>\\n <synergyChannel>DINGDING</synergyChannel>\\n <isRelated>RELATED关联 NOT_RELATED 未关联</isRelated>\\n </data>\\n <totalCount>100</totalCount>\\n <pageNumber>1</pageNumber>\\n <pageSize>10</pageSize>\\n</ListUsersResponse>","errorExample":""}]',
- ],
- 'UpdateUser' => [
- 'summary' => '更新用户',
- 'path' => '/user/update',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"instanceId\\": 140080050,\\n \\"instanceType\\": 0,\\n \\"richText\\": \\"这是一个富文本\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Create rich text',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateRichText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRichText'],
+ ],
],
+ ],
+ 'CreateRouteRule' => [
+ 'summary' => 'Creates a routing rule.',
+ 'path' => '/routeRule/save',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempT8ZOYV',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempLJVP1W'],
],
'parameters' => [
[
@@ -2292,129 +1764,237 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
- 'properties' => [
- 'ramId' => [
- 'description' => '',
- 'example' => '2243564',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '用户ramId',
- 'type' => 'integer',
- ],
- 'phone' => [
- 'description' => '',
- 'example' => '18887878****',
- 'required' => false,
- 'title' => '手机号',
- 'type' => 'string',
+ 'description' => 'Parameters for creating a routing rule.',
+ 'properties' => [
+ 'ruleName' => ['description' => 'The name of the routing rule.', 'type' => 'string', 'required' => true, 'example' => '规则名称', 'title' => ''],
+ 'enableStatus' => ['description' => 'Enable status:'."\n"
+ ."\n"
+ .'- disable: Disable.'."\n"
+ ."\n"
+ .'- enable: Enable.', 'type' => 'string', 'example' => 'enable', 'title' => '', 'required' => false],
+ 'relatedServiceId' => ['description' => 'The ID of the associated service.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''],
+ 'routeType' => ['description' => 'Routing type:'."\n"
+ ."\n"
+ .'- INCIDENT: Triggering event.'."\n"
+ ."\n"
+ .'- ALERT: Trigger alerts only.', 'type' => 'string', 'required' => true, 'example' => 'INCIDENT', 'title' => ''],
+ 'incidentLevel' => ['description' => 'Event level: P1, P2, P3, P4 in decreasing order.', 'type' => 'string', 'required' => true, 'example' => 'P1', 'title' => ''],
+ 'assignObjectId' => ['description' => 'The ID of the event assignment object (service group ID or user ID).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '65', 'title' => ''],
+ 'assignObjectType' => ['description' => 'Event assignment object type:'."\n"
+ ."\n"
+ .'- SERVICEGROUP: Service group.'."\n"
+ ."\n"
+ .'- USER: Single user.', 'type' => 'string', 'required' => true, 'example' => 'SERVICEGROUP', 'title' => ''],
+ 'effection' => ['description' => 'Impact level:'."\n"
+ ."\n"
+ .'- LOW: General.'."\n"
+ ."\n"
+ .'- HIGH: Critical.', 'type' => 'string', 'required' => true, 'example' => 'LOW', 'title' => ''],
+ 'timeWindow' => ['description' => 'Time window.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''],
+ 'matchCount' => ['description' => 'Number of hits.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', 'title' => ''],
+ 'timeWindowUnit' => ['description' => 'Time window unit:'."\n"
+ ."\n"
+ .'- MINUTE: Minute.'."\n"
+ ."\n"
+ .'- SECOND: Second.', 'type' => 'string', 'required' => true, 'example' => 'MINUTE', 'title' => ''],
+ 'routeChildRules' => [
+ 'description' => 'Array of child rules.',
+ 'items' => [
+ 'description' => 'Child rule.',
+ 'properties' => [
+ 'monitorSourceId' => ['description' => 'Monitoring source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'conditions' => [
+ 'description' => 'List of matching conditions.',
+ 'items' => [
+ 'description' => 'Condition.',
+ 'properties' => [
+ 'key' => ['description' => 'Matching key.', 'type' => 'string', 'required' => true, 'example' => 'payload.summary', 'title' => ''],
+ 'value' => ['description' => 'Matching value.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''],
+ 'operationSymbol' => ['description' => 'Operator.', 'type' => 'string', 'required' => true, 'example' => 'equals', 'title' => ''],
+ ],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'childConditionRelation' => ['description' => '- 0: AND.'."\n"
+ ."\n"
+ .'- 1: OR.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => '', 'required' => false],
+ 'problemLevel' => ['title' => 'Problem Severity Level', 'description' => 'Problem level: P1, P2, P3, P4 in decreasing order.', 'type' => 'string', 'required' => false, 'example' => 'P1'],
+ ],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'username' => [
- 'description' => '',
+ 'notifyChannels' => [
+ 'description' => 'List of notification channels.',
+ 'items' => ['description' => 'Notification channel:'."\n"
+ ."\n"
+ .'- SMS: Text message.'."\n"
+ ."\n"
+ .'- PHONE: Voice.'."\n"
+ ."\n"
+ .'- EMAIL: Email.'."\n"
+ ."\n"
+ .'- WEBHOOK: Group notification.', 'type' => 'string', 'required' => true, 'example' => '[SMS,PHONE]', 'title' => ''],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
'example' => '',
- 'required' => false,
- 'title' => '用户名',
- 'type' => 'string',
],
- 'email' => [
- 'description' => '',
- 'example' => '78799****@qq.com',
+ 'clientToken' => ['description' => 'Idempotent token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
+ 'childRuleRelation' => ['description' => 'Child rule relation:'."\n"
+ ."\n"
+ .'- AND: AND.'."\n"
+ ."\n"
+ .'- OR: OR.', 'type' => 'string', 'required' => true, 'example' => 'AND', 'title' => ''],
+ 'problemLevelGroup' => [
+ 'description' => 'Problem level group.',
+ 'additionalProperties' => [
+ 'description' => 'Problem level.',
+ 'type' => 'object',
+ 'properties' => [
+ 'childRuleRelation' => ['title' => 'Child Rule Relation, 0 for AND, 1 for OR ', 'description' => 'Child rule relation:'."\n"
+ ."\n"
+ .'- 0: AND.'."\n"
+ ."\n"
+ .'- 1: OR.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'matchCount' => ['title' => 'Suppression: Hit count', 'description' => 'Suppression: Number of hits.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ 'timeWindow' => ['title' => 'Suppression: Time Window ', 'description' => 'Suppression: Time window.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'],
+ 'timeWindowUnit' => ['title' => 'Suppression: Time Window Unit ', 'description' => 'Suppression: Time window unit.', 'type' => 'string', 'required' => false, 'example' => 'M'],
+ 'enableUpgrade' => ['title' => 'Upgrade: Whether to upgrade', 'description' => 'Upgrade: Enable upgrade.', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'upgradeTimeWindow' => ['title' => 'Upgrade: Time window', 'description' => 'Upgrade: Time window.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'],
+ 'upgradeTimeWindowUnit' => ['title' => 'Upgrade: Time Window Unit ', 'description' => 'Upgrade: Time window unit.', 'type' => 'string', 'required' => false, 'example' => 'M'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'object',
'required' => false,
- 'title' => '邮件',
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
- 'userId' => [
- 'description' => '',
- 'example' => '111',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '用户ID',
- 'type' => 'integer',
+ 'coverageProblemLevels' => [
+ 'description' => 'Problem level coverage.',
+ 'title' => 'Fault level overwrite ',
+ 'type' => 'array',
+ 'items' => ['description' => 'Problem level type.', 'type' => 'string', 'required' => false, 'example' => 'P1', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
+ 'problemEffectionServices' => [
+ 'description' => 'Affected services.',
+ 'title' => 'Services affected by the fault',
+ 'type' => 'array',
+ 'items' => ['description' => 'Affected service ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
+ 'example' => '',
],
- 'roleIdList' => [
- 'title' => '用户角色',
+ 'convergenceFields' => [
+ 'description' => 'Collection of convergence fields.',
+ 'title' => 'Collection of convergence fields',
'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'items' => ['description' => 'Collection of convergence fields.', 'type' => 'string', 'required' => false, 'example' => 'app', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
],
+ 'convergenceType' => ['title' => 'Convergence Type (0: Stream Rule Convergence, 1: Field Convergence) ', 'description' => 'Convergence type:'."\n"
+ ."\n"
+ .'- 0: Routing rule convergence.'."\n"
+ ."\n"
+ .'- 1: Field convergence.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
'required' => false,
- 'title' => 'A short description of struct',
+ 'title' => '',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'type' => 'string',
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '请求ID', 'title' => ''],
+ 'data' => [
+ 'description' => 'Return result.',
+ 'example' => '65',
+ 'properties' => [
+ 'routeRuleId' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ ],
+ 'title' => '',
+ 'type' => 'object',
],
],
- 'title' => 'Schema of Response',
+ 'title' => '',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'PhoneAlreadyExists',
- 'errorMessage' => 'The specified phone number already exists.',
- ],
+ ['errorCode' => 'AddRouteRuleFail', 'errorMessage' => 'Failed to add the rule.', 'description' => ''],
+ ['errorCode' => 'RouteRuleNameAlreadyExisted', 'errorMessage' => 'The rule name already exists.', 'description' => ''],
],
- 404 => [
- [
- 'errorCode' => 'UserNotExists',
- 'errorMessage' => 'The specified user does not exist.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"请求ID\\",\\n \\"data\\": {\\n \\"routeRuleId\\": 1000\\n }\\n}","type":"json"}]',
+ 'title' => 'Create a stream routing rule ',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-07T12:30:08.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-02-21T02:23:11.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:48.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateUserResponse>\\n <requestId>c26f36de-1ec8-496a-a828-880676c5ef81</requestId>\\n</UpdateUserResponse>","errorExample":""}]',
- ],
- 'ListUserSerivceGroups' => [
- 'summary' => '用户预览',
- 'path' => '/user/preview/detail',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRouteRule'],
+ ],
],
+ ],
+ 'CreateService' => [
+ 'summary' => 'Creates a service.',
+ 'path' => '/services/save',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempCICFVA',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
'parameters' => [
[
@@ -2422,155 +2002,99 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'userId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => 'clientToken',
- 'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef729f',
+ 'serviceDescription' => ['description' => 'Service description.', 'type' => 'string', 'example' => '服务描述', 'title' => '', 'required' => false],
+ 'serviceName' => ['description' => 'Service name.', 'type' => 'string', 'required' => true, 'example' => '服务名字', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
+ 'escalationPlanId' => ['title' => 'Upgrade policy ID ', 'description' => 'Upgrade policy ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '345'],
+ 'serviceGroupIdList' => [
+ 'description' => 'Service group ID.',
+ 'title' => 'List of service group IDs ',
+ 'type' => 'array',
+ 'items' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''],
'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
+ 'example' => '',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef7291',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
'data' => [
- 'description' => 'data',
+ 'description' => 'Service ID.',
+ 'example' => '1',
'properties' => [
- 'ramId' => [
- 'description' => '',
- 'example' => '321',
- 'format' => 'int64',
- 'title' => 'RAM子账号ID',
- 'type' => 'integer',
- ],
- 'userId' => [
- 'description' => '',
- 'example' => '321',
- 'format' => 'int64',
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- 'username' => [
- 'description' => '',
- 'example' => '小明',
- 'title' => '用户昵称',
- 'type' => 'string',
- ],
- 'phone' => [
- 'description' => '',
- 'example' => '1390000****',
- 'title' => '手机号',
- 'type' => 'string',
- ],
- 'email' => [
- 'description' => '',
- 'example' => '12121****@163.com',
- 'title' => '邮箱',
- 'type' => 'string',
- ],
- 'serviceGroups' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'title' => '服务组id',
- 'type' => 'integer',
- ],
- 'serviceGroupName' => [
- 'description' => '',
- 'example' => '服务组A',
- 'title' => '服务组名称',
- 'type' => 'string',
- ],
- 'serviceGroupDescription' => [
- 'description' => '',
- 'example' => '描述',
- 'title' => '服务组描述',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '人员所属服务组',
- 'type' => 'array',
- ],
+ 'serviceId' => ['description' => 'Service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
],
+ 'title' => '',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'UserTypeNotExisted',
- 'errorMessage' => 'The user type does not exist.',
- ],
+ 400 => [
+ ['errorCode' => 'AddServiceFail', 'errorMessage' => 'Failed to add the service.', 'description' => ''],
+ ['errorCode' => 'ServiceNameAlreadyExisted', 'errorMessage' => 'The service name is already in use.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"2b63cdef-7ac3-4892-a76d-0f3389ef7291\\",\\n \\"data\\": {\\n \\"ramId\\": 321,\\n \\"userId\\": 321,\\n \\"username\\": \\"马先生\\",\\n \\"phone\\": \\"1390000****\\",\\n \\"email\\": \\"12121****@163.com\\",\\n \\"serviceGroups\\": [\\n {\\n \\"serviceGroupId\\": 123,\\n \\"serviceGroupName\\": \\"测试组\\",\\n \\"serviceGroupDescription\\": \\"这是一个服务组描述\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListUserSerivceGroupsResponse>\\n <requestId>2b63cdef-7ac3-4892-a76d-0f3389ef7291</requestId>\\n <data>\\n <ramId>321</ramId>\\n <userId>321</userId>\\n <username>小明</username>\\n <phone>1390000****</phone>\\n <email>12121****@163.com</email>\\n <serviceGroups>\\n <serviceGroupId>123</serviceGroupId>\\n <serviceGroupName>服务组A</serviceGroupName>\\n <serviceGroupDescription>描述</serviceGroupDescription>\\n </serviceGroups>\\n </data>\\n</ListUserSerivceGroupsResponse>","errorExample":""}]',
- ],
- 'ListServiceGroupMonitorSourceTemplates' => [
- 'summary' => '查询服务组监控源模版列表',
- 'path' => '/services/group/listServiceGroupMonitorSourceTemplates',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": {\\n \\"serviceId\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'Create a service ',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:53.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateService'],
+ ],
+ ],
+ ],
+ 'CreateServiceGroup' => [
+ 'summary' => 'Creates a service group.',
+ 'path' => '/services/group/insert',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempE3KJ0U',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
'parameters' => [
[
@@ -2578,137 +2102,136 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'xxxx',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
- 'requestId' => [
- 'description' => '',
- 'example' => 'xxxxx',
- 'required' => false,
- 'title' => '请求ID',
- 'type' => 'string',
+ 'serviceGroupName' => ['description' => 'Service group name.', 'type' => 'string', 'required' => true, 'example' => '我的服务组', 'title' => ''],
+ 'userIds' => [
+ 'description' => 'User IDs.',
+ 'items' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '65', 'title' => ''],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
+ 'enableWebhook' => ['description' => 'Enable or disable the webhook:'."\n"
+ ."\n"
+ .'- DISABLE: Disable the webhook.'."\n"
+ ."\n"
+ .'- ENABLE: Enable the webhook.', 'type' => 'string', 'required' => true, 'example' => 'ENABLE', 'title' => ''],
+ 'webhookType' => ['description' => 'Webhook type:'."\n"
+ ."\n"
+ .'- WEIXIN\\_GROUP: WeChat.'."\n"
+ ."\n"
+ .'- DING\\_GROUP: DingTalk.'."\n"
+ ."\n"
+ .'- FEISHU\\_GROUP: Lark.', 'type' => 'string', 'required' => true, 'example' => 'DING_GROUP', 'title' => ''],
+ 'serviceGroupDescription' => ['description' => 'Service group description.', 'type' => 'string', 'example' => '这个是一个服务描述', 'title' => '', 'required' => false],
+ 'webhookLink' => ['title' => 'webhookLink', 'description' => 'Webhook URL.', 'type' => 'string', 'required' => true, 'example' => 'https://oapi.ding****.com/robot/send?access_token=****'],
+ 'monitorSourceTemplates' => [
+ 'description' => 'Monitoring source message templates.',
+ 'items' => [
+ 'description' => 'Monitoring source message template.',
+ 'properties' => [
+ 'templateId' => ['description' => 'Message template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => '', 'required' => false],
+ 'monitorSourceId' => ['description' => 'Monitoring source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => '', 'required' => false],
+ 'monitorSourceName' => ['description' => 'Monitoring source name.', 'type' => 'string', 'example' => 'zabbix', 'title' => '', 'required' => false],
+ 'templateContent' => ['description' => 'Template content.', 'type' => 'string', 'example' => 'xx', 'title' => '', 'required' => false],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'title' => '服务组ID',
- 'type' => 'integer',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
'data' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'title' => '监控源ID',
- 'type' => 'integer',
- ],
- 'templateId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'title' => '消息模版ID',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'zabbix',
- 'title' => '监控报警源名字',
- 'type' => 'string',
- ],
- 'templateContent' => [
- 'description' => '',
- 'example' => '""',
- 'title' => '模板内容',
- 'type' => 'string',
- ],
- 'fields' => [
- 'description' => '',
- 'items' => [
- 'description' => '1',
- 'example' => '字段',
- 'type' => 'string',
- ],
- 'title' => '字段',
- 'type' => 'array',
- ],
- ],
- 'type' => 'object',
+ 'description' => 'Service group ID.',
+ 'example' => '1',
+ 'properties' => [
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
],
- 'title' => 'data',
- 'type' => 'array',
+ 'title' => '',
+ 'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxx\\",\\n \\"data\\": [\\n {\\n \\"monitorSourceId\\": 1000,\\n \\"templateId\\": 1000,\\n \\"monitorSourceName\\": \\"zabbix\\",\\n \\"templateContent\\": \\"\\\\\\"\\\\\\"\\",\\n \\"fields\\": [\\n \\"字段\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListServiceGroupMonitorSourceTemplatesResponse>\\n <data>\\n <monitorSourceId>1000</monitorSourceId>\\n <templateId>1000</templateId>\\n <monitorSourceName>zabbix</monitorSourceName>\\n </data>\\n</ListServiceGroupMonitorSourceTemplatesResponse>","errorExample":""}]',
- 'extraInfo' => '"data":{'."\n"
- .' "requestId":"550DB2BE-98DE-0368-A52C-8F6BC78CD113"'."\n"
- .' }',
- 'requestParamsDescription' => '{"serviceGroupId":"180030020","clientToken":"ca65dca3-73d1-49a9-9020-04598f4c28ab"}',
- ],
- 'ListDataReportForServiceGroup' => [
- 'summary' => '查询服务组事件统计报表',
- 'path' => '/statistics/listDataReportForServiceGroup',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ServiceGroupWebHookLinkAlreadyExisted', 'errorMessage' => 'The webhook link is already in use.', 'description' => ''],
+ ['errorCode' => 'ServiceGroupNameAlreadyExisted', 'errorMessage' => 'The service group name is already in use.', 'description' => ''],
+ ['errorCode' => 'AddServiceGroupFail', 'errorMessage' => 'Failed to add the service group.', 'description' => ''],
+ ],
+ 405 => [
+ ['errorCode' => 'openFailed', 'errorMessage' => 'open Failed', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": {\\n \\"serviceGroupId\\": 1000\\n }\\n}","type":"json"}]',
+ 'title' => 'Create a service group',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-27T12:01:25.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-07-16T04:09:45.000Z', 'description' => 'Request parameters changed'],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceGroup'],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'CreateServiceGroupScheduling' => [
+ 'summary' => 'Create a new service group scheduling.',
+ 'path' => '/services/group/scheduling/save',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp20VVML',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempUBXKF7'],
],
'parameters' => [
[
@@ -2716,202 +2239,220 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'startTime' => [
- 'description' => '',
- 'example' => '2021-09-09',
- 'required' => false,
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'description' => '',
- 'example' => '2021-09-30',
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', 'title' => ''],
+ 'schedulingWay' => ['description' => 'Scheduling method:'."\n"
+ ."\n"
+ .'- FAST: Fast scheduling.'."\n"
+ ."\n"
+ .'- FINE: Fine-grained scheduling.', 'type' => 'string', 'required' => true, 'example' => 'FAST', 'title' => ''],
+ 'fastScheduling' => [
+ 'description' => 'You can enable fast scheduling.',
+ 'example' => '12',
+ 'properties' => [
+ 'singleDuration' => ['description' => 'Duration per person.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => '', 'required' => false],
+ 'dutyPlan' => ['description' => 'Duty plan:'."\n"
+ ."\n"
+ .'- FAST\\_CHOICE: Fast choice.'."\n"
+ ."\n"
+ .'- CUSTOM: Custom.', 'type' => 'string', 'example' => 'FAST_CHOICE', 'title' => '', 'required' => false],
+ 'singleDurationUnit' => ['description' => 'Duration unit:'."\n"
+ ."\n"
+ .'- HOUR: Hour.'."\n"
+ ."\n"
+ .'- DAY: Day.', 'type' => 'string', 'example' => 'DAY', 'title' => '', 'required' => false],
+ 'schedulingUsers' => [
+ 'description' => 'Users for fast rotation scheduling.',
+ 'items' => [
+ 'description' => 'Fast rotation user.',
+ 'properties' => [
+ 'schedulingUserId' => ['description' => 'Rotation user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '6666', 'title' => '', 'required' => false],
+ 'schedulingOrder' => ['description' => 'Scheduling order.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'schedulingObjectType' => ['title' => 'Scheduling Object Type ', 'description' => 'Scheduling type:'."\n"
+ ."\n"
+ .'- 0: Single-person scheduling.'."\n"
+ ."\n"
+ .'- 1: Multi-person scheduling.', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'schedulingUserIdList' => [
+ 'description' => 'User IDs for multi-person scheduling.',
+ 'title' => 'User IDs for Multi-User Scheduling ',
+ 'type' => 'array',
+ 'items' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'title' => '结束时间',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'title' => '页码',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'pageSize' => [
- 'title' => '分页大小',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'type' => 'object',
],
- 'serviceGroupName' => [
- 'description' => '',
- 'example' => 'A服务组',
+ 'fineScheduling' => [
+ 'description' => 'Fine-grained scheduling configuration.',
+ 'properties' => [
+ 'period' => ['description' => 'Rotation period.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ 'periodUnit' => ['description' => 'Rotation period unit:'."\n"
+ ."\n"
+ .'- HOUR: Hour.'."\n"
+ ."\n"
+ .'- DAY: Day.', 'type' => 'string', 'example' => 'DAY', 'title' => '', 'required' => false],
+ 'shiftType' => ['description' => 'Shift type:'."\n"
+ ."\n"
+ .'- MORNING\\_NIGHT: Morning and night shifts.'."\n"
+ ."\n"
+ .'- MORNING\\_NOON\\_NIGHT: Morning, noon, and night shifts.'."\n"
+ ."\n"
+ .'- CUSTOM: Custom.', 'type' => 'string', 'example' => 'MORNING_NIGHT', 'title' => '', 'required' => false],
+ 'schedulingFineShifts' => [
+ 'description' => 'Personnel information for fine-grained shift scheduling.',
+ 'items' => [
+ 'description' => 'Shift information.',
+ 'properties' => [
+ 'schedulingStartTime' => ['description' => 'Scheduling start time.', 'type' => 'string', 'example' => '2020-08-13', 'title' => '', 'required' => false],
+ 'schedulingEndTime' => ['description' => 'Scheduling end time.', 'type' => 'string', 'example' => '2020-10-13', 'title' => '', 'required' => false],
+ 'schedulingOrder' => ['description' => 'Scheduling order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ 'skipOneDay' => ['description' => 'Whether the shift spans across days:'."\n"
+ ."\n"
+ .'- true: Yes.'."\n"
+ ."\n"
+ .'- false: No.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false],
+ 'cycleOrder' => ['description' => 'Rotation sequence.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ 'shiftName' => ['description' => 'Shift name.', 'type' => 'string', 'example' => '早班', 'title' => '', 'required' => false],
+ 'schedulingUserId' => ['description' => 'Scheduled user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => '', 'required' => false],
+ 'schedulingObjectType' => ['title' => 'Scheduling Object Type', 'description' => 'Scheduling object type.', 'type' => 'string', 'required' => false, 'example' => ''],
+ 'schedulingUserIdList' => [
+ 'description' => 'User IDs for multi-person scheduling.',
+ 'title' => 'User IDs for Multi-Person Scheduling ',
+ 'type' => 'array',
+ 'items' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'schedulingTemplateFineShifts' => [
+ 'description' => 'Fine-grained scheduling template.',
+ 'items' => [
+ 'description' => 'Fine-grained scheduling template.',
+ 'properties' => [
+ 'schedulingStartTime' => ['description' => 'Scheduling start time.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2021-09-01 08:00:00'],
+ 'schedulingEndTime' => ['description' => 'Scheduling end time.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2021-10-01 08:00:00'],
+ 'schedulingOrder' => ['description' => 'Scheduling order.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'],
+ 'schedulingUserId' => ['description' => 'Scheduled user ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'],
+ 'schedulingUserName' => ['description' => 'The username of the scheduled user.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '刘先生'],
+ 'skipOneDay' => ['description' => 'Whether the shift spans across days.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'],
+ 'schedulingObjectType' => ['title' => 'Scheduling Object Type ', 'description' => 'Scheduling object type.', 'type' => 'string', 'required' => false, 'example' => ''],
+ 'schedulingUserIdList' => [
+ 'description' => 'User IDs for multi-person scheduling.',
+ 'title' => 'User IDs for Multi-User Scheduling',
+ 'type' => 'array',
+ 'items' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'title' => '服务组名称',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'serviceGroupName' => [
- 'description' => '',
- 'example' => '服务组',
- 'title' => '服务组名字',
- 'type' => 'string',
- ],
- 'incidentCount' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '事件数量',
- 'type' => 'integer',
- ],
- 'escalationIncidentCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '升级事件数量',
- 'type' => 'integer',
- ],
- 'unAcknowledgedEscalationIncidentCount' => [
- 'description' => '',
- 'example' => '200',
- 'format' => 'int64',
- 'title' => '未响应升级事件数量',
- 'type' => 'integer',
- ],
- 'unFinishEscalationIncidentCount' => [
- 'description' => '',
- 'example' => '200',
- 'format' => 'int64',
- 'title' => '未完成升级事件数量',
- 'type' => 'integer',
- ],
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'meanTimeToAcknowledge' => [
- 'description' => 'MRRA',
- 'example' => '3分19秒',
- 'format' => 'int64',
- 'title' => 'MRRA',
- 'type' => 'integer',
- ],
- 'meanTimeToRepair' => [
- 'description' => 'MTTR',
- 'example' => '3分19秒',
- 'format' => 'int64',
- 'title' => 'MTTR',
- 'type' => 'integer',
- ],
- 'finishProportion' => [
- 'description' => '',
- 'example' => '19%',
- 'title' => '完结率',
- 'type' => 'string',
- ],
- 'finishIncidentCount' => [
- 'description' => '',
- 'example' => '111',
- 'format' => 'int64',
- 'title' => '事件完结数',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '统计数据',
- 'type' => 'array',
- ],
- 'pageSIze' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '页大小',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '当前页',
- 'type' => 'integer',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '总数',
- 'type' => 'integer',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'xxxxxxxxxx'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"8D0F6435-162E-5088-84A1-4178C0F209CD\\",\\n \\"data\\": [\\n {\\n \\"serviceGroupName\\": \\"标准集成服务组\\",\\n \\"incidentCount\\": 1,\\n \\"escalationIncidentCount\\": 100,\\n \\"unAcknowledgedEscalationIncidentCount\\": 200,\\n \\"unFinishEscalationIncidentCount\\": 200,\\n \\"serviceGroupId\\": 103419260,\\n \\"meanTimeToAcknowledge\\": 0,\\n \\"meanTimeToRepair\\": 0,\\n \\"finishProportion\\": \\"0%\\",\\n \\"finishIncidentCount\\": 111\\n }\\n ],\\n \\"pageSIze\\": 10,\\n \\"pageNumber\\": 1,\\n \\"totalCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"<ListDataReportForServiceGroupResponse>\\n <requestId>xxxxxxx</requestId>\\n <data>\\n <serviceGroupName>服务组</serviceGroupName>\\n <incidentCount>1</incidentCount>\\n <escalationIncidentCount>100</escalationIncidentCount>\\n <unAcknowledgedEscalationIncidentCount>200</unAcknowledgedEscalationIncidentCount>\\n <unFinishEscalationIncidentCount>200</unFinishEscalationIncidentCount>\\n <serviceGroupId>100</serviceGroupId>\\n <finishProportion>19%</finishProportion>\\n </data>\\n</ListDataReportForServiceGroupResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{'."\n"
- .' "pageNumber": 1,'."\n"
- .' "pageSize": 10,'."\n"
- .' "startTime": "2021-11-02",'."\n"
- .' "endTime": "2021-11-09",'."\n"
- .' "clientToken": "ec1eba2b-cbd9-4daa-aa6e-d127a27989bc"'."\n"
- .'}',
- ],
- 'CheckWebhook' => [
- 'summary' => '校验webhook地址',
- 'path' => '/services/check/webhook',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxxxxxxxx\\"\\n}","type":"json"}]',
+ 'title' => 'Create a service group schedule',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-26T13:01:21.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-09-10T01:53:17.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateServiceGroupScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceGroupScheduling'],
+ ],
],
+ ],
+ 'CreateSubscription' => [
+ 'summary' => 'Create a notification subscription. ',
+ 'path' => '/notify/subscription/create',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempU4CBQS',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempJPZI30'],
],
'parameters' => [
[
@@ -2920,33 +2461,122 @@
'style' => 'json',
'schema' => [
'description' => 'A short description of struct',
- 'example' => 'body',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
+ 'subscriptionTitle' => ['description' => 'Notification subscription name.', 'example' => 'testSubscription', 'required' => true, 'title' => '', 'type' => 'string'],
+ 'scope' => ['description' => 'Subscription range type.', 'example' => 'SERVICE', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'notifyObjectType' => ['description' => 'Notification object type. ', 'example' => 'USER', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'expiredType' => ['description' => 'Subscription validity period. ', 'example' => 'LONG_TERM', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'period' => ['description' => 'Short-term time segment. ', 'example' => '20天', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'scopeObjectList' => [
+ 'description' => 'List of subscription scopes.',
+ 'items' => [
+ 'description' => 'Object',
+ 'properties' => [
+ 'scopeObjectId' => ['description' => 'Scope object ID.', 'example' => '1', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ ],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'webhook' => [
- 'description' => '',
- 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=XXX',
- 'required' => false,
- 'title' => 'webook地址',
- 'type' => 'string',
+ 'notifyObjectList' => [
+ 'description' => 'List of notification objects. ',
+ 'items' => [
+ 'description' => 'Object',
+ 'properties' => [
+ 'notifyObjectId' => ['description' => 'Notification object ID. ', 'example' => '2', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ ],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'webhookType' => [
- 'description' => '',
- 'example' => 'DING_GROUP',
- 'required' => false,
- 'title' => 'webhook地址类型 企业微信WEIXIN_GROUP 钉钉群 DING_GROUP 飞书 FEISHU_GROUP',
- 'type' => 'string',
+ 'notifyStrategyList' => [
+ 'description' => 'List of notification policies.',
+ 'items' => [
+ 'description' => 'Object',
+ 'properties' => [
+ 'instanceType' => ['description' => 'Subscribed instance type: '."\n"
+ .'- INCIDENT: management event. '."\n"
+ .'- ALERT: alert. '."\n"
+ .'- PROBLEM: problem.', 'example' => 'INCIDENT', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'strategies' => [
+ 'description' => 'Conditions in JSON format, containing multiple conditions such as Level, Impact, and key-value pairs. ',
+ 'items' => [
+ 'description' => 'Object',
+ 'properties' => [
+ 'conditions' => [
+ 'description' => 'Notification policy conditions. ',
+ 'items' => [
+ 'description' => 'Object',
+ 'properties' => [
+ 'effection' => ['description' => 'Impact scope. ', 'example' => 'HIGH', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'problemNotifyType' => ['description' => 'Problem notification type.', 'example' => 'PROBLEM_UPDATE', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'level' => ['description' => 'Level.', 'example' => 'P1', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'action' => ['description' => 'Action.', 'example' => 'INCIDENT_TRIGGER', 'required' => false, 'title' => '', 'type' => 'string'],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'channels' => ['description' => 'Channels, separated by commas.', 'example' => 'SMS,PHONE', 'required' => true, 'title' => '', 'type' => 'string'],
+ 'periodChannel' => [
+ 'description' => 'Channel for time-segmented notification subscription.',
+ 'properties' => [
+ 'workday' => ['description' => 'Notification subscription Channel for weekdays. ', 'example' => 'SMS,PHONE', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'nonWorkday' => ['description' => 'Channel for notification subscription on non-workdays.', 'example' => 'SMS,PHONE', 'required' => false, 'title' => '', 'type' => 'string'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ ],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'clientToken' => ['description' => 'Idempotent parameter.', 'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'startTime' => ['description' => 'Effective start time.', 'example' => '2021-02-03 10:10:10', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'endTime' => ['description' => 'Expiration time.', 'example' => '2021-11-03 10:10:10', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -2955,66 +2585,72 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['description' => 'request id', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88', 'title' => 'request id', 'type' => 'string'],
+ 'data' => [
+ 'description' => 'data',
+ 'properties' => [
+ 'subscriptionId' => ['description' => 'Subscription ID. ', 'example' => '101', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'WebhookVerificationError',
- 'errorMessage' => 'A webhook verification error occurred.',
- ],
- [
- 'errorCode' => 'WebhookAddressFormatError',
- 'errorMessage' => 'The webhook address format is invalid.',
- ],
- [
- 'errorCode' => 'WebhookAccessRestricts',
- 'errorMessage' => 'Traffic is restricted for webhook access.',
- ],
+ ['errorCode' => 'NotifySubsAlreadyExists', 'errorMessage' => 'The specified subscription already exists.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"<CheckWebhookResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n</CheckWebhookResponse>","errorExample":""}]',
- ],
- 'EnableServiceGroupWebhook' => [
- 'summary' => '启用服务组的webhook',
- 'path' => '/services/group/enableWebhook',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"subscriptionId\\": 101\\n }\\n}","type":"json"}]',
+ 'title' => 'Create Notification Subscription ',
+ 'changeSet' => [
+ ['createdAt' => '2021-07-16T04:09:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:37.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSubscription'],
+ ],
],
+ ],
+ 'CreateTenantApplication' => [
+ 'summary' => 'Create a mobile application.',
+ 'path' => '/mobileApp/create',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempU4CBQS'],
],
'parameters' => [
[
@@ -3024,25 +2660,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'channel' => ['description' => 'Application collaboration channel.', 'example' => 'DINGDING', 'required' => true, 'title' => '', 'type' => 'string'],
+ 'clientToken' => ['description' => 'Idempotency identity.', 'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6', 'required' => true, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -3051,62 +2675,72 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['description' => 'id of the req', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88', 'title' => 'id of the req', 'type' => 'string'],
+ 'data' => [
+ 'description' => 'data',
+ 'properties' => [
+ 'openUrl' => ['description' => 'Activation URL.', 'example' => 'http://xxxx', 'title' => '', 'type' => 'string'],
+ 'progress' => ['description' => 'Activation progress status. '."\n"
+ .'- OPENED: Activated. '."\n"
+ .'- OPENING: Activating.', 'example' => 'OPENED', 'title' => '', 'type' => 'string'],
+ ],
+ 'title' => 'data',
+ 'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EnableServiceGroupWebhookFail',
- 'errorMessage' => 'Failed to enable the service group webhook.',
- ],
- [
- 'errorCode' => 'ServiceGroupNotExisted',
- 'errorMessage' => 'The service group does not exist.',
- ],
+ ['errorCode' => 'TenantAppAlreadyExisit', 'errorMessage' => 'App is opened.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableServiceGroupWebhookResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n</EnableServiceGroupWebhookResponse>","errorExample":""}]',
- ],
- 'CreateServiceGroup' => [
- 'summary' => '创建服务组',
- 'path' => '/services/group/insert',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"openUrl\\": \\"http://xxxx\\",\\n \\"progress\\": \\"OPENED\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Create a mobile application',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateTenantApplication',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTenantApplication'],
+ ],
],
+ ],
+ 'CreateUser' => [
+ 'summary' => 'Creates a user.',
+ 'path' => '/user/create',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempT8ZOYV'],
],
'parameters' => [
[
@@ -3114,198 +2748,107 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'serviceGroupName' => [
- 'description' => '',
- 'example' => '冲上云霄',
- 'required' => true,
- 'title' => '服务小组名称',
- 'type' => 'string',
- ],
- 'userIds' => [
- 'description' => '',
- 'items' => [
- 'example' => '65',
- 'format' => 'int64',
- 'required' => true,
- 'type' => 'integer',
- ],
- 'required' => true,
- 'title' => '小组人员用户ID',
- 'type' => 'array',
- ],
- 'enableWebhook' => [
- 'description' => '',
- 'example' => 'ENABLE',
- 'required' => true,
- 'title' => 'ENABLE 启用 DISABLE 禁用',
- 'type' => 'string',
- ],
- 'webhookType' => [
- 'description' => '',
- 'example' => 'WEIXIN_GROUP',
- 'required' => true,
- 'title' => 'WEIXIN_GROUP微信 DING_GROUP钉钉 FEISHU_GROUP飞书',
- 'type' => 'string',
- ],
- 'serviceGroupDescription' => [
- 'description' => '',
- 'example' => '服务描述',
- 'required' => false,
- 'title' => '服务描述',
- 'type' => 'string',
- ],
- 'webhookLink' => [
- 'description' => 'webhooklink',
- 'example' => 'WWWWWWW',
- 'required' => true,
- 'title' => 'webhookLink',
- 'type' => 'string',
- ],
- 'monitorSourceTemplates' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'templateId' => [
- 'description' => '',
- 'example' => '111',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '消息模版ID',
- 'type' => 'integer',
- ],
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '111',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '监控源ID',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'zabbix',
- 'required' => false,
- 'title' => '监控源名字',
- 'type' => 'string',
- ],
- 'templateContent' => [
- 'description' => '',
- 'example' => 'xx',
- 'required' => false,
- 'title' => '模板内容',
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '监控源消息模版',
+ 'ramId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4787654378343', 'title' => ''],
+ 'phone' => ['description' => 'Phone number.', 'type' => 'string', 'required' => false, 'example' => '1888898****', 'title' => ''],
+ 'username' => ['description' => 'Username.', 'type' => 'string', 'required' => false, 'example' => '张先生', 'title' => ''],
+ 'email' => ['description' => 'Email address.', 'type' => 'string', 'required' => false, 'example' => '12121****@qq.com', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'required' => false, 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81', 'title' => ''],
+ 'roleIdList' => [
+ 'description' => 'List of role IDs.',
+ 'title' => 'List of role IDs',
'type' => 'array',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
+ 'items' => ['description' => 'User role.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''],
'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
+ 'example' => '',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81', 'title' => ''],
'data' => [
- 'description' => '',
- 'example' => '1',
+ 'description' => 'Response data.',
'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
+ 'userId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
],
- 'title' => '服务组ID',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'ServiceGroupWebHookLinkAlreadyExisted',
- 'errorMessage' => 'The webhook link is already in use.',
- ],
- [
- 'errorCode' => 'ServiceGroupNameAlreadyExisted',
- 'errorMessage' => 'The service group name is already in use.',
- ],
- [
- 'errorCode' => 'AddServiceGroupFail',
- 'errorMessage' => 'Failed to add the service group.',
- ],
+ ['errorCode' => 'PhoneAlreadyExists', 'errorMessage' => 'The specified phone number already exists.', 'description' => ''],
+ ['errorCode' => 'UserCountExcess', 'errorMessage' => 'Available users have run out, please upgrade to a higher version.', 'description' => 'Available users have run out, please upgrade to a higher version'],
],
- 405 => [
- [
- 'errorCode' => 'openFailed',
- 'errorMessage' => 'open Failed',
- ],
+ 402 => [
+ ['errorCode' => 'IdentitySelectionError', 'errorMessage' => 'Identity selection error', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'UserAlreadyExists', 'errorMessage' => 'The specified user already exists.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": {\\n \\"serviceGroupId\\": 1000\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateServiceGroupResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n <data>\\n <serviceGroupId>1000</serviceGroupId>\\n </data>\\n</CreateServiceGroupResponse>","errorExample":""}]',
- ],
- 'DeleteServiceGroup' => [
- 'summary' => '删除服务组',
- 'path' => '/services/group/delete',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\",\\n \\"data\\": {\\n \\"userId\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'Create a user',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-15T11:46:18.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-04-13T12:01:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUser'],
+ ],
],
+ ],
+ 'DeleteEscalationPlan' => [
+ 'summary' => 'Delete an upgrade plan.',
+ 'path' => '/escalationPlan/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempGUN0ZL'],
],
'parameters' => [
[
@@ -3315,25 +2858,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'escalationPlanId' => ['description' => 'Upgrade plan ID.', 'example' => '234534', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency identity.', 'example' => 'A5A1****-9C47-011C-9C73-A376BC2REQUEST', 'required' => false, 'title' => 'clientToken', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -3342,74 +2873,60 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'DeleteServiceGroupFail',
- 'errorMessage' => 'Failed to delete the service group.',
- ],
- [
- 'errorCode' => 'ServiceGroupNotExisted',
- 'errorMessage' => 'The service group does not exist.',
- ],
+ 404 => [
+ ['errorCode' => 'EscalationPlanNotExists', 'errorMessage' => 'The specified escalation plan does not exist.', 'description' => ''],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC21925D\\"\\n}","type":"json"}]',
+ 'title' => 'Delete an upgrade plan',
+ 'changeSet' => [],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'ServiceGroupNotExisted',
- 'errorMessage' => 'The service group does not exist.',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteEscalationPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- [
- [
- 'errorCode' => 'DeleteServiceGroupFail',
- 'errorMessage' => 'The service group has been associated with escalationPlan.',
- ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEscalationPlan'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteServiceGroupResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n</DeleteServiceGroupResponse>","errorExample":""}]',
],
- 'DeleteServiceGroupUser' => [
- 'summary' => '删除服务组成员',
- 'path' => '/services/group/deleteServiceGroupUser',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteIncident' => [
+ 'summary' => 'Delete a management event.',
+ 'path' => '/incident/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempT8ZOYV',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempKAIUZH'],
],
'parameters' => [
[
@@ -3417,50 +2934,15 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'body',
'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '66666',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'oldUserId' => [
- 'description' => '',
- 'example' => '777777',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '老的用户ID',
- 'type' => 'integer',
- ],
- 'newUserId' => [
- 'description' => '',
- 'example' => '88888',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '新的用户',
- 'type' => 'integer',
- ],
- 'removeUser' => [
- 'description' => '',
- 'example' => 'true',
- 'required' => false,
- 'title' => '删除服务组成员',
- 'type' => 'boolean',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'xxxxxx',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'clientToken' => ['description' => 'Idempotency validation.', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'incidentId' => ['description' => 'Management event ID.', 'example' => '12321', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -3469,50 +2951,64 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteServiceGroupUserResponse>\\n <requestId>xxxxxx</requestId>\\n</DeleteServiceGroupUserResponse>","errorExample":""}]',
- ],
- 'GetServiceGroup' => [
- 'summary' => '查询服务组详情',
- 'path' => '/services/group/detail',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IncidentStatusInvalid', 'errorMessage' => 'The incident status is invalid.', 'description' => ''],
+ ['errorCode' => 'IncidentUpdateInvalid', 'errorMessage' => 'The incident update is invalid.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a management event',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIncident'],
+ ],
],
+ ],
+ 'DeleteIntegrationConfig' => [
+ 'summary' => 'Delete an integration configuration.',
+ 'path' => '/integrationConfig/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempSLACC7'],
],
'parameters' => [
[
@@ -3522,25 +3018,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '2323232',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'integrationConfigId' => ['description' => 'Integration configuration ID.', 'example' => '100', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotent ID.', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -3549,159 +3033,60 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => '请求ID',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'properties' => [
- 'updateTime' => [
- 'description' => '',
- 'example' => '2020-05-03 15:39:39',
- 'title' => '修改时间',
- 'type' => 'string',
- ],
- 'users' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'userId' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- 'userName' => [
- 'description' => '',
- 'example' => 'jack',
- 'title' => '用户名字',
- 'type' => 'string',
- ],
- 'phone' => [
- 'description' => '',
- 'example' => '1390000****',
- 'title' => '手机号',
- 'type' => 'string',
- ],
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'roleNameList' => [
- 'title' => '角色列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '角色名称',
- 'type' => 'string',
- 'example' => '测试',
- ],
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '用户ID',
- 'type' => 'array',
- ],
- 'serviceGroupDescription' => [
- 'description' => '',
- 'example' => '服务描述',
- 'title' => '服务组描述',
- 'type' => 'string',
- ],
- 'webhookLink' => [
- 'description' => '',
- 'example' => 'wwwwwww',
- 'title' => 'webhook 跳转地址',
- 'type' => 'string',
- ],
- 'webhookType' => [
- 'description' => '',
- 'example' => 'WEIXIN_GROUP',
- 'title' => 'WEIXIN_GROUP 微信 DING_GROUP 钉钉 FEISHU_GROUP飞书',
- 'type' => 'string',
- ],
- 'enableWebhook' => [
- 'description' => '',
- 'example' => 'ENABLE',
- 'title' => 'ENABLE 启用 DISABLE 禁用',
- 'type' => 'string',
- ],
- 'serviceGroupName' => [
- 'description' => '',
- 'example' => '冲上云霄',
- 'title' => '服务组名称',
- 'type' => 'string',
- ],
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2020-08-08 10:00:00',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ServiceGroupNotExisted',
- 'errorMessage' => 'The service group does not exist.',
- ],
+ 404 => [
+ ['errorCode' => 'IntegationConfigNotExists', 'errorMessage' => 'The specified integration config does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": {\\n \\"updateTime\\": \\"2020-05-03 15:39:39\\",\\n \\"users\\": [\\n {\\n \\"userId\\": 10,\\n \\"userName\\": \\"jack\\",\\n \\"phone\\": \\"1390000****\\",\\n \\"serviceGroupId\\": 1,\\n \\"roleNameList\\": [\\n \\"测试\\"\\n ]\\n }\\n ],\\n \\"serviceGroupDescription\\": \\"服务描述\\",\\n \\"webhookLink\\": \\"wwwwwww\\",\\n \\"webhookType\\": \\"WEIXIN_GROUP\\",\\n \\"enableWebhook\\": \\"ENABLE\\",\\n \\"serviceGroupName\\": \\"冲上云霄\\",\\n \\"serviceGroupId\\": 1000,\\n \\"createTime\\": \\"2020-08-08 10:00:00\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetServiceGroupResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n <data>\\n <updateTime>2020-05-03 15:39:39</updateTime>\\n <users>\\n <userId>10</userId>\\n <userName>jack</userName>\\n <phone>1390000****</phone>\\n <serviceGroupId>1</serviceGroupId>\\n </users>\\n <serviceGroupDescription>服务描述</serviceGroupDescription>\\n <webhookLink>wwwwwww</webhookLink>\\n <webhookType>WEIXIN_GROUP</webhookType>\\n <enableWebhook>ENABLE</enableWebhook>\\n <serviceGroupName>冲上云霄</serviceGroupName>\\n <serviceGroupId>1000</serviceGroupId>\\n <createTime>2020-08-08 10:00:00</createTime>\\n </data>\\n</GetServiceGroupResponse>","errorExample":""}]',
- ],
- 'ListServiceGroups' => [
- 'summary' => '查询服务组列表',
- 'path' => '/services/group/list',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\"\\n}","type":"json"}]',
+ 'title' => 'Delete integration configuration',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntegrationConfig'],
+ ],
],
+ ],
+ 'DeleteProblem' => [
+ 'summary' => 'Delete a fault.',
+ 'path' => '/problem/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZVI8H5'],
],
'parameters' => [
[
@@ -3711,74 +3096,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'queryName' => [
- 'description' => '',
- 'example' => '王宇',
- 'required' => false,
- 'title' => '搜索名称',
- 'type' => 'string',
- ],
- 'queryType' => [
- 'description' => '',
- 'example' => 'USER',
- 'required' => false,
- 'title' => '搜索类型。USER用户 SERVICEGROUP服务组',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '当前页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '页大小',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
- 'isScheduled' => [
- 'description' => '',
- 'example' => 'false',
- 'required' => false,
- 'title' => '是否已经排班',
- 'type' => 'boolean',
- ],
- 'orderByScheduleStatus' => [
- 'description' => '',
- 'example' => 'false',
- 'required' => false,
- 'title' => '是否根据排班状态排序',
- 'type' => 'boolean',
- ],
- 'userId' => [
- 'description' => '',
- 'example' => '100000',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- 'serviceId' => [
- 'title' => '服务的查询',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'problemId' => ['description' => 'Fault ID.', 'example' => '1231', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency validation.', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -3787,178 +3111,60 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'sssss',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'isScheduled' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '是否已经排班',
- 'type' => 'boolean',
- ],
- 'serviceGroupName' => [
- 'description' => '',
- 'example' => '服务组',
- 'title' => '服务组名字',
- 'type' => 'string',
- ],
- 'serviceGroupDescription' => [
- 'description' => '',
- 'example' => '服务描述',
- 'title' => '服务组描述',
- 'type' => 'string',
- ],
- 'updateTime' => [
- 'description' => '',
- 'example' => '2020-08-09 15:50:30',
- 'title' => '修改时间',
- 'type' => 'string',
- ],
- 'enableWebhook' => [
- 'description' => '',
- 'example' => 'ENABLE',
- 'title' => 'ENABLE 启用 DISABLE 禁用',
- 'type' => 'string',
- ],
- 'webhookType' => [
- 'description' => '',
- 'example' => 'WEIXIN_GROUP',
- 'title' => 'WEIXIN_GROUP微信DING_GROUP钉钉FEISHU_GROUP飞书',
- 'type' => 'string',
- ],
- 'webhookLink' => [
- 'description' => '',
- 'example' => 'wwwwwwwwww',
- 'title' => 'webhook 跳转地址',
- 'type' => 'string',
- ],
- 'users' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'userId' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- 'userName' => [
- 'description' => '',
- 'example' => 'jack',
- 'title' => '用户名字',
- 'type' => 'string',
- ],
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'phone' => [
- 'description' => '',
- 'example' => '1390000****',
- 'title' => '手机号',
- 'type' => 'string',
- ],
- 'email' => [
- 'description' => '',
- 'example' => 'wy930***@163.com',
- 'title' => '邮箱',
- 'type' => 'string',
- ],
- 'isRelated' => [
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '服务组用户列表',
- 'type' => 'array',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '服务组列表',
- 'type' => 'array',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '当前页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '分页大小',
- 'type' => 'integer',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '总条数',
- 'type' => 'integer',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"sssss\\",\\n \\"data\\": [\\n {\\n \\"serviceGroupId\\": 1,\\n \\"isScheduled\\": true,\\n \\"serviceGroupName\\": \\"我的服务组\\",\\n \\"serviceGroupDescription\\": \\"服务组描述\\",\\n \\"updateTime\\": \\"2020-08-09 15:50:30\\",\\n \\"enableWebhook\\": \\"ENABLE\\",\\n \\"webhookType\\": \\"WEIXIN_GROUP\\",\\n \\"webhookLink\\": \\"wwwwwwwwww\\",\\n \\"users\\": [\\n {\\n \\"userId\\": 10,\\n \\"userName\\": \\"jack\\",\\n \\"serviceGroupId\\": 1,\\n \\"phone\\": \\"1390000****\\",\\n \\"email\\": \\"wy930***@163.com\\",\\n \\"isRelated\\": 1\\n }\\n ]\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"<ListServiceGroupsResponse>\\n <requestId>sssss</requestId>\\n <data>\\n <serviceGroupId>1</serviceGroupId>\\n <isScheduled>true</isScheduled>\\n <serviceGroupName>我的服务组</serviceGroupName>\\n <serviceGroupDescription>服务组描述</serviceGroupDescription>\\n <updateTime>2020-08-09 15:50:30</updateTime>\\n <enableWebhook>ENABLE</enableWebhook>\\n <webhookType>WEIXIN_GROUP</webhookType>\\n <webhookLink>wwwwwwwwww</webhookLink>\\n <users>\\n <userId>10</userId>\\n <userName>jack</userName>\\n <serviceGroupId>1</serviceGroupId>\\n <phone>1390000****</phone>\\n <email>wy930***@163.com</email>\\n </users>\\n </data>\\n <pageNumber>1</pageNumber>\\n <pageSize>10</pageSize>\\n <totalCount>100</totalCount>\\n</ListServiceGroupsResponse>","errorExample":""}]',
- ],
- 'UpdateServiceGroup' => [
- 'summary' => '更新服务组',
- 'path' => '/services/group/modify',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a fault',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProblem'],
+ ],
],
+ ],
+ 'DeleteProblemEffectionService' => [
+ 'summary' => 'Delete the impact service.',
+ 'path' => '/problem/process/effectionService/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempIOV4BX'],
],
'parameters' => [
[
@@ -3968,116 +3174,14 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'enableWebhook' => [
- 'description' => '',
- 'example' => 'ENABLE',
- 'required' => true,
- 'title' => 'ENABLE 启用 DISABLE 禁用',
- 'type' => 'string',
- ],
- 'webhookType' => [
- 'description' => '',
- 'example' => 'WEIXINGROUP',
- 'required' => true,
- 'title' => 'WEIXIN_GROUP微信DING_GROUP钉钉FEISHU_GROUP飞书',
- 'type' => 'string',
- ],
- 'webhookLink' => [
- 'description' => '',
- 'example' => 'wwwwwww',
- 'required' => true,
- 'title' => 'webhook跳转地址',
- 'type' => 'string',
- ],
- 'serviceGroupName' => [
- 'description' => '',
- 'example' => '冲上云霄',
- 'required' => true,
- 'title' => '服务组名字',
- 'type' => 'string',
- ],
- 'serviceGroupDescription' => [
- 'description' => '',
- 'example' => '飞车',
- 'required' => false,
- 'title' => '服务描述',
- 'type' => 'string',
- ],
- 'userIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '55',
- 'format' => 'int64',
- 'required' => true,
- 'type' => 'integer',
- ],
- 'required' => true,
- 'title' => '用户ID列表修改后的',
- 'type' => 'array',
- ],
- 'monitorSourceTemplates' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'templateId' => [
- 'description' => '',
- 'example' => '1111',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '消息模版ID',
- 'type' => 'integer',
- ],
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '11111',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '监控报警源Id',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'zabbix',
- 'required' => false,
- 'title' => '监控报警源',
- 'type' => 'string',
- ],
- 'templateContent' => [
- 'description' => '',
- 'example' => 'xxxx',
- 'required' => false,
- 'title' => '消息模版内容',
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '监控源模版列表',
- 'type' => 'array',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'effectionServiceId' => ['description' => 'Impact service ID', 'example' => '567', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'problemId' => ['description' => 'Problem ID', 'example' => '876', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'clientToken', 'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c', 'required' => false, 'title' => 'clientToken', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -4086,76 +3190,60 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ServiceGroupNotExisted',
- 'errorMessage' => 'The service group does not exist.',
- ],
- [
- 'errorCode' => 'EditServiceGroupFail',
- 'errorMessage' => 'Failed to edit the service group.',
- ],
- [
- 'errorCode' => 'ServiceGroupWebHookLinkAlreadyExisted',
- 'errorMessage' => 'The webhook link is already in use.',
- ],
- [
- 'errorCode' => 'ServiceGroupNameAlreadyExisted',
- 'errorMessage' => 'The service group name is already in use.',
- ],
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
- 405 => [
- [
- 'errorCode' => 'openFailed',
- 'errorMessage' => 'open Failed',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"e0b6735e-1a04-4d6b-a625-d2350612492c\\"\\n}","type":"json"}]',
+ 'title' => 'Delete the impact service',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteProblemEffectionService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateServiceGroupResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n</UpdateServiceGroupResponse>","errorExample":""}]',
- ],
- 'DisableServiceGroupWebhook' => [
- 'summary' => '禁用服务组的webhook',
- 'path' => '/services/group/disableWebhook',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProblemEffectionService'],
+ ],
],
+ ],
+ 'DeleteProblemMeasure' => [
+ 'summary' => 'Delete a fault improvement measure. ',
+ 'path' => '/problem/improvement/measure/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZB7ZAW'],
],
'parameters' => [
[
@@ -4165,25 +3253,14 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'measureId' => ['description' => 'The ID of the fault improvement measure. ', 'example' => '1213', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'problemId' => ['description' => 'The fault ID. ', 'example' => '2131', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'clientToken' => ['description' => 'An idempotency validation token. ', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -4192,58 +3269,60 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'DisableWebhookFailed',
- 'errorMessage' => 'Disabling webhook failed.',
- ],
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableServiceGroupWebhookResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n</DisableServiceGroupWebhookResponse>","errorExample":""}]',
- ],
- 'GetServiceGroupSpecialPersonScheduling' => [
- 'summary' => '查询指定人员的服务组排班',
- 'path' => '/services/group/scheduling/getUserScheduling',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a fault improvement measure ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteProblemMeasure',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProblemMeasure'],
+ ],
],
+ ],
+ 'DeleteProblemTimeline' => [
+ 'summary' => 'Delete a fault management event timeline edge zone.',
+ 'path' => '/problem/process/timeline/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempUBXKF7',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp65LXE3'],
],
'parameters' => [
[
@@ -4253,33 +3332,14 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'userId' => [
- 'description' => '',
- 'example' => '66666',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '77777',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'problemTimelineId' => ['description' => 'Timeline ID.', 'example' => '11', 'format' => 'int64', 'required' => false, 'title' => 'ID', 'type' => 'integer'],
+ 'problemId' => ['description' => 'Fault ID.', 'example' => '102', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency identity.', 'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11', 'required' => false, 'title' => 'clientToken', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -4288,106 +3348,60 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingStartTime' => [
- 'description' => '',
- 'example' => '2021-08-17 00:00:00',
- 'title' => '排班开始时间',
- 'type' => 'string',
- ],
- 'schedulingEndTime' => [
- 'description' => '',
- 'example' => '2021-08-17 12:00:00',
- 'title' => '排班结束时间',
- 'type' => 'string',
- ],
- 'schedulingDate' => [
- 'description' => '',
- 'example' => '2021-08-17',
- 'title' => '排班日期',
- 'type' => 'string',
- ],
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '8888',
- 'format' => 'int64',
- 'title' => '服务组id',
- 'type' => 'integer',
- ],
- 'serviceGroupName' => [
- 'description' => '',
- 'example' => '刘德华',
- 'title' => '服务组名字',
- 'type' => 'string',
- ],
- 'schedulingUserId' => [
- 'description' => '',
- 'example' => '111111',
- 'format' => 'int64',
- 'title' => '排班用户ID',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '人员排班信息',
- 'type' => 'array',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxx\\",\\n \\"data\\": [\\n {\\n \\"schedulingStartTime\\": \\"2021-08-17 00:00:00\\",\\n \\"schedulingEndTime\\": \\"2021-08-17 12:00:00\\",\\n \\"schedulingDate\\": \\"2021-08-17\\",\\n \\"serviceGroupId\\": 8888,\\n \\"serviceGroupName\\": \\"雪豹突击队\\",\\n \\"schedulingUserId\\": 111111\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetServiceGroupSpecialPersonSchedulingResponse>\\n <requestId>xxxxxx</requestId>\\n <data>\\n <schedulingStartTime>2021-08-17 00:00:00</schedulingStartTime>\\n <schedulingEndTime>2021-08-17 12:00:00</schedulingEndTime>\\n <schedulingDate>2021-08-17</schedulingDate>\\n <serviceGroupId>8888</serviceGroupId>\\n <serviceGroupName>雪豹突击队</serviceGroupName>\\n <schedulingUserId>111111</schedulingUserId>\\n </data>\\n</GetServiceGroupSpecialPersonSchedulingResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{'."\n"
- .' "userId" : 66666,'."\n"
- .' "serviceGroupId" : 77777,'."\n"
- .' "clientToken" : "C4BE3837-1A13-413B-A225-2C88188E8A43",'."\n"
- .' "startTime" : "2020-09-01 00:00:00",'."\n"
- .' "endTime" : "2020-09-31 23:59:59"'."\n"
- .'}'."\n",
- ],
- 'GetServiceGroupSchedulingPreview' => [
- 'summary' => '预览服务组排班',
- 'path' => '/services/group/scheduling/preview',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a fault management event timeline edge zone',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteProblemTimeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProblemTimeline'],
+ ],
],
+ ],
+ 'DeleteRouteRule' => [
+ 'summary' => 'Deletes a routing rule.',
+ 'path' => '/routeRule/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempUBXKF7',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempLJVP1W'],
],
'parameters' => [
[
@@ -4395,244 +3409,81 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'The request body.',
'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '55555',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'schedulingWay' => [
- 'description' => '',
- 'example' => 'FAST',
- 'required' => true,
- 'title' => '排班方式 FAST 快速排班 FINE 精细排班',
- 'type' => 'string',
- ],
- 'fastScheduling' => [
- 'description' => '',
- 'properties' => [
- 'singleDuration' => [
- 'description' => '',
- 'example' => '12',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '每人排班时长',
- 'type' => 'integer',
- ],
- 'dutyPlan' => [
- 'description' => 'FAST_CHOICE',
- 'example' => 'FAST_CHOICE',
- 'required' => false,
- 'title' => '值班方案 dutyPlan FAST_CHOICE 快速选择 CUSTOM 自定义',
- 'type' => 'string',
- ],
- 'singleDurationUnit' => [
- 'description' => 'DAY',
- 'example' => 'DAY',
- 'required' => false,
- 'title' => '每人排班时长单位 HOUR 小时 DAY 天',
- 'type' => 'string',
- ],
- 'schedulingUsers' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingUserId' => [
- 'description' => '',
- 'example' => '122222',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '轮班用户ID',
- 'type' => 'integer',
- ],
- 'schedulingOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '排班顺序',
- 'type' => 'integer',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '快速轮班用户',
- 'type' => 'array',
- ],
- ],
- 'required' => false,
- 'title' => '快速排班',
- 'type' => 'object',
- ],
- 'fineScheduling' => [
- 'description' => '',
- 'properties' => [
- 'period' => [
- 'description' => '',
- 'example' => '2',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '循环周期',
- 'type' => 'integer',
- ],
- 'periodUnit' => [
- 'description' => '',
- 'example' => 'DAY',
- 'required' => false,
- 'title' => '循环周期单位 HOUR 小时 DAY 天',
- 'type' => 'string',
- ],
- 'shiftType' => [
- 'description' => '',
- 'example' => 'MORNING_NIGHT',
- 'required' => false,
- 'title' => '班次类型 MORNING_NIGHT 早晚班 MORNING_NOON_NIGHT 早中晚班 CUSTOM 自定义',
- 'type' => 'string',
- ],
- 'schedulingFineShifts' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingStartTime' => [
- 'description' => '',
- 'example' => '2020-08-13',
- 'required' => false,
- 'title' => '排班开始时间',
- 'type' => 'string',
- ],
- 'schedulingEndTime' => [
- 'description' => '',
- 'example' => '2020-10-13',
- 'required' => false,
- 'title' => '排班结束时间',
- 'type' => 'string',
- ],
- 'schedulingOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '排班顺序',
- 'type' => 'integer',
- ],
- 'shiftName' => [
- 'description' => '',
- 'example' => '早班',
- 'required' => false,
- 'title' => '班次名称',
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '精细排班班次人员信息',
- 'type' => 'array',
- ],
- ],
- 'required' => false,
- 'title' => '精细排',
- 'type' => 'object',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'description' => '',
- 'example' => '2021-09-01 00:00:00',
- 'required' => false,
- 'title' => '排班结束时间',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'description' => '',
- 'example' => '2021-11-01 00:00:00',
- 'required' => false,
- 'title' => '排班开始时间',
- 'type' => 'string',
- ],
+ 'routeRuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''],
+ 'clientToken' => ['description' => 'The idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxxxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'title' => '服务组排班信息',
- 'type' => 'object',
- ],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter is not valid. %s',
- ],
+ ['errorCode' => 'DeleteEnabledRuleFail', 'errorMessage' => 'Failed to delete the rule with the enabled status.', 'description' => ''],
+ ['errorCode' => 'DeleteRuleFail', 'errorMessage' => 'Failed to delete the rules.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'RouteRuleNotExisted', 'errorMessage' => 'The rule does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"85C203BF-D1A6-562C-AAEC-5EAB9D2756CF\\",\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetServiceGroupSchedulingPreviewResponse>\\n <requestId>xxxxxxxxx</requestId>\\n</GetServiceGroupSchedulingPreviewResponse>","errorExample":""}]',
- ],
- 'GetServiceGroupPersonScheduling' => [
- 'summary' => '查询用户某个服务组的排班',
- 'path' => '/services/group/scheduling/user/getScheduling',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": 0\\n}","type":"json"}]',
+ 'title' => 'Delete a stream rule',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRouteRule'],
+ ],
],
+ ],
+ 'DeleteService' => [
+ 'summary' => 'Delete a service.',
+ 'path' => '/services/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempCICFVA',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
'parameters' => [
[
@@ -4642,47 +3493,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'userId' => [
- 'description' => '',
- 'example' => '66666',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '77777',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'description' => '',
- 'example' => '2020-09-01 00:00:00',
- 'required' => false,
- 'title' => '排班开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'description' => '',
- 'example' => '2020-09-31 00:00:00',
- 'required' => false,
- 'title' => '排班结束时间',
- 'type' => 'string',
- ],
+ 'serviceId' => ['description' => 'Service ID.', 'example' => '10002000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency token.', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -4691,55 +3508,63 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'title' => '排班日历',
- 'type' => 'object',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxx\\",\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetServiceGroupPersonSchedulingResponse>\\n <requestId>xxxxx</requestId>\\n</GetServiceGroupPersonSchedulingResponse>","errorExample":""}]',
- ],
- 'CreateServiceGroupScheduling' => [
- 'summary' => '新增服务组排班',
- 'path' => '/services/group/scheduling/save',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'DeleteServiceFail', 'errorMessage' => 'Failed to delete the service.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'ServiceNotExisted', 'errorMessage' => 'The service does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","type":"json"}]',
+ 'title' => 'Delete Service',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteService'],
+ ],
],
+ ],
+ 'DeleteServiceGroup' => [
+ 'summary' => 'Delete a service group. ',
+ 'path' => '/services/group/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempUBXKF7',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
'parameters' => [
[
@@ -4749,280 +3574,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'schedulingWay' => [
- 'description' => '',
- 'example' => 'FAST',
- 'required' => true,
- 'title' => '排班方式 FAST 快速排班 FINE 精细排班',
- 'type' => 'string',
- ],
- 'fastScheduling' => [
- 'description' => '',
- 'example' => '12',
- 'properties' => [
- 'singleDuration' => [
- 'description' => '',
- 'example' => '12',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '每人排班时长',
- 'type' => 'integer',
- ],
- 'dutyPlan' => [
- 'description' => '',
- 'example' => 'FAST_CHOICE',
- 'required' => false,
- 'title' => '值班方案 dutyPlan FAST_CHOICE 快速选择 CUSTOM 自定义',
- 'type' => 'string',
- ],
- 'singleDurationUnit' => [
- 'description' => '',
- 'example' => 'DAY',
- 'required' => false,
- 'title' => '每人排班时常单位 HOUR 小时 DAY 天',
- 'type' => 'string',
- ],
- 'schedulingUsers' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingUserId' => [
- 'description' => '',
- 'example' => '6666',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '轮班用户ID',
- 'type' => 'integer',
- ],
- 'schedulingOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '排班顺序',
- 'type' => 'integer',
- ],
- 'schedulingObjectType' => [
- 'title' => '排班对象类型',
- 'type' => 'string',
- ],
- 'schedulingUserIdList' => [
- 'title' => '多人排班时,人员Id',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '快速轮班用户',
- 'type' => 'array',
- ],
- ],
- 'required' => false,
- 'title' => '快速排班',
- 'type' => 'object',
- ],
- 'fineScheduling' => [
- 'description' => '',
- 'properties' => [
- 'period' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '循环周期',
- 'type' => 'integer',
- ],
- 'periodUnit' => [
- 'description' => '',
- 'example' => 'DAY',
- 'required' => false,
- 'title' => '循环周期单位 HOUR 小时 DAY 天',
- 'type' => 'string',
- ],
- 'shiftType' => [
- 'description' => '',
- 'example' => 'MORNING_NIGHT',
- 'required' => false,
- 'title' => '班次类型 MORNING_NIGHT 早晚班 MORNING_NOON_NIGHT 早中晚班 CUSTOM 自定义',
- 'type' => 'string',
- ],
- 'schedulingFineShifts' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingStartTime' => [
- 'description' => '',
- 'example' => '2020-08-13',
- 'required' => false,
- 'title' => '排班开始时间',
- 'type' => 'string',
- ],
- 'schedulingEndTime' => [
- 'description' => '',
- 'example' => '2020-10-13',
- 'required' => false,
- 'title' => '排班结束时间',
- 'type' => 'string',
- ],
- 'schedulingOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '排班顺序',
- 'type' => 'integer',
- ],
- 'skipOneDay' => [
- 'description' => '',
- 'example' => 'fasle',
- 'required' => false,
- 'title' => '是否跨天',
- 'type' => 'boolean',
- ],
- 'cycleOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '循环次序',
- 'type' => 'integer',
- ],
- 'shiftName' => [
- 'description' => '',
- 'example' => '早班',
- 'required' => false,
- 'title' => '班次名称',
- 'type' => 'string',
- ],
- 'schedulingUserId' => [
- 'description' => '',
- 'example' => '11',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '排班用户ID',
- 'type' => 'integer',
- ],
- 'schedulingObjectType' => [
- 'title' => '排班对象类型',
- 'type' => 'string',
- ],
- 'schedulingUserIdList' => [
- 'title' => '多人排班时,人员Id',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '精细排班信息表',
- 'type' => 'array',
- ],
- 'schedulingTemplateFineShifts' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingStartTime' => [
- 'description' => '',
- 'example' => '2021-09-01 08:00:00',
- 'required' => false,
- 'title' => '排班开始时间',
- 'type' => 'string',
- ],
- 'schedulingEndTime' => [
- 'description' => '',
- 'example' => '2021-10-01 08:00:00',
- 'required' => false,
- 'title' => '排班结束时间',
- 'type' => 'string',
- ],
- 'schedulingOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '排班顺序',
- 'type' => 'integer',
- ],
- 'schedulingUserId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- 'schedulingUserName' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '用户名字',
- 'type' => 'string',
- ],
- 'skipOneDay' => [
- 'description' => '',
- 'example' => 'false',
- 'required' => false,
- 'title' => '是否跨天',
- 'type' => 'boolean',
- ],
- 'schedulingObjectType' => [
- 'title' => '排班对象类型',
- 'type' => 'string',
- ],
- 'schedulingUserIdList' => [
- 'title' => '多人排班时,人员Id',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '精细排班模版',
- 'type' => 'array',
- ],
- ],
- 'required' => false,
- 'title' => '精细排班',
- 'type' => 'object',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'serviceGroupId' => ['description' => 'Service ID. ', 'example' => '1000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency token. ', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -5031,51 +3589,129 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxxxxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateServiceGroupSchedulingResponse>\\n <requestId>xxxxxxxxxx</requestId>\\n</CreateServiceGroupSchedulingResponse>","errorExample":""}]',
- ],
- 'GetServiceGroupScheduling' => [
- 'summary' => '查询服务组排班详情',
- 'path' => '/services/group/scheduling/detail',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'DeleteServiceGroupFail', 'errorMessage' => 'Failed to delete the service group.', 'description' => 'Failed to delete the service group.'],
+ ['errorCode' => 'ServiceGroupNotExisted', 'errorMessage' => 'The service group does not exist.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'ServiceGroupNotExisted', 'errorMessage' => 'The service group does not exist.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'DeleteServiceGroupFail', 'errorMessage' => 'The service group has been associated with escalationPlan.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","type":"json"}]',
+ 'title' => 'Delete service group ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteServiceGroup'],
+ ],
],
+ ],
+ 'DeleteServiceGroupScheduling' => [
+ 'summary' => 'Deletes a schedule.',
+ 'path' => '/services/group/scheduling/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempCICFVA',
+ 'abilityTreeNodes' => ['FEATUREgempUBXKF7'],
+ ],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'type' => 'string', 'description' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 401 => [
+ ['errorCode' => 'DeleteServiceGroupSchedulingFail', 'errorMessage' => 'The service group has been associated with route rule. ', 'description' => ''],
+ ],
+ ],
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteServiceGroupScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteServiceGroupScheduling',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteServiceGroupScheduling'],
+ ],
+ ],
+ ],
+ 'DeleteServiceGroupUser' => [
+ 'summary' => 'Delete a member from a service group. ',
+ 'path' => '/services/group/deleteServiceGroupUser',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgempT8ZOYV'],
+ ],
'parameters' => [
[
'name' => 'body',
@@ -5084,25 +3720,16 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '9999',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'serviceGroupId' => ['description' => 'Service group ID. ', 'example' => '66666', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'oldUserId' => ['description' => 'Old User ID. ', 'example' => '777777', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'newUserId' => ['description' => 'New User ID. ', 'example' => '88888', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'removeUser' => ['description' => 'Delete a service group member. ', 'example' => 'true', 'required' => false, 'title' => '', 'type' => 'boolean'],
+ 'clientToken' => ['description' => 'Idempotency token. ', 'example' => 'xxxxxx', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -5111,349 +3738,57 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxxxxxxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'properties' => [
- 'schedulingWay' => [
- 'description' => '',
- 'example' => 'FINE',
- 'title' => '排班方式 FAST 快速排班 FINE 精细排班',
- 'type' => 'string',
- ],
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '99999',
- 'format' => 'int64',
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'fastScheduling' => [
- 'description' => '',
- 'properties' => [
- 'singleDuration' => [
- 'description' => '',
- 'example' => '12',
- 'format' => 'int32',
- 'title' => '每人排班时长',
- 'type' => 'integer',
- ],
- 'dutyPlan' => [
- 'description' => '',
- 'example' => 'FAST_CHOICE',
- 'title' => '值班方案 dutyPlan FAST_CHOICE 快速选择 CUSTOM 自定义',
- 'type' => 'string',
- ],
- 'singleDurationUnit' => [
- 'description' => '',
- 'example' => 'DAY',
- 'title' => '每人排班时长单位 HOUR 小时 DAY 天',
- 'type' => 'string',
- ],
- 'schedulingUsers' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingUserId' => [
- 'description' => '',
- 'example' => '66666',
- 'format' => 'int64',
- 'title' => '轮班用户ID',
- 'type' => 'integer',
- ],
- 'schedulingOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '排班顺序',
- 'type' => 'integer',
- ],
- 'schedulingUserName' => [
- 'description' => '',
- 'example' => '张杰',
- 'title' => '轮班用户名字',
- 'type' => 'string',
- ],
- 'schedulingUserIdList' => [
- 'title' => '多人排班时,人员Id',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'schedulingObjectType' => [
- 'title' => '排班对象类型',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '快速轮班用户',
- 'type' => 'array',
- ],
- 'id' => [
- 'description' => '',
- 'example' => '2222',
- 'format' => 'int64',
- 'title' => '快速排班ID',
- 'type' => 'integer',
- ],
- ],
- 'title' => '快速排班',
- 'type' => 'object',
- ],
- 'fineScheduling' => [
- 'description' => '',
- 'properties' => [
- 'period' => [
- 'description' => '1',
- 'example' => '循环周期',
- 'format' => 'int32',
- 'title' => '1',
- 'type' => 'integer',
- ],
- 'id' => [
- 'description' => '1',
- 'example' => '精细排班ID',
- 'format' => 'int64',
- 'title' => '1',
- 'type' => 'integer',
- ],
- 'periodUnit' => [
- 'description' => '',
- 'example' => 'DAY',
- 'title' => '循环周期单位 HOUR 小时 DAY 天',
- 'type' => 'string',
- ],
- 'shiftType' => [
- 'description' => '',
- 'example' => 'MORNING_NIGHT',
- 'title' => '班次类型 MORNING_NIGHT 早晚班 MORNING_NOON_NIGHT 早中晚班 CUSTOM 自定义',
- 'type' => 'string',
- ],
- 'schedulingFineShifts' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingStartTime' => [
- 'description' => '',
- 'example' => '2020-08-13',
- 'title' => '排班开始时间',
- 'type' => 'string',
- ],
- 'schedulingEndTime' => [
- 'description' => '',
- 'example' => '2020-10-13',
- 'title' => '排班结束时间',
- 'type' => 'string',
- ],
- 'schedulingOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '排班顺序',
- 'type' => 'integer',
- ],
- 'shiftName' => [
- 'description' => '',
- 'example' => '早班',
- 'title' => '班次名称',
- 'type' => 'string',
- ],
- 'cycleOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '循环次序',
- 'type' => 'integer',
- ],
- 'schedulingUserId' => [
- 'description' => '',
- 'example' => '1111',
- 'format' => 'int64',
- 'title' => '排班用户ID',
- 'type' => 'integer',
- ],
- 'skipOneDay' => [
- 'description' => '',
- 'example' => 'false',
- 'title' => '是否跨天',
- 'type' => 'boolean',
- ],
- 'schedulingUserName' => [
- 'description' => '',
- 'example' => '刘德华',
- 'title' => '排班用户名字',
- 'type' => 'string',
- ],
- 'schedulingUserIdList' => [
- 'title' => '多人排班时,人员Id',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'schedulingObjectType' => [
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '精细排班班次人员信息',
- 'type' => 'array',
- ],
- 'schedulingTemplateFineShifts' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingStartTime' => [
- 'description' => '',
- 'example' => '2021-09-01 00:00:00',
- 'title' => '排班开始时间',
- 'type' => 'string',
- ],
- 'schedulingEndTime' => [
- 'description' => '',
- 'example' => '2021-10-01 00:00:00',
- 'title' => '排班结束时间',
- 'type' => 'string',
- ],
- 'schedulingOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '排班顺序',
- 'type' => 'integer',
- ],
- 'schedulingUserId' => [
- 'description' => '',
- 'example' => '1',
- 'title' => '用户ID',
- 'type' => 'string',
- ],
- 'skipOneDay' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '是否跨天',
- 'type' => 'boolean',
- ],
- 'schedulingUserName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '排班用户名字',
- 'type' => 'string',
- ],
- 'shiftName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '班次名称',
- 'type' => 'string',
- ],
- 'schedulingUserIdList' => [
- 'title' => '多人排班时,人员Id',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'schedulingObjectType' => [
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '精细排班模版',
- 'type' => 'array',
- ],
- ],
- 'title' => '精细排班',
- 'type' => 'object',
- ],
- 'users' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'userId' => [
- 'description' => '',
- 'example' => '',
- 'format' => 'int64',
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- 'userName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '用户名字',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '已经排班',
- 'type' => 'array',
- ],
- ],
- 'title' => '排班详情',
- 'type' => 'object',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'xxxxxx', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified Resource is not found.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxxxx\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a member from a service group ',
+ 'changeSet' => [
+ ['createdAt' => '2021-10-20T13:27:37.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteServiceGroupUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxxxxxxxx\\",\\n \\"data\\": {\\n \\"schedulingWay\\": \\"FINE\\",\\n \\"serviceGroupId\\": 99999,\\n \\"fastScheduling\\": {\\n \\"singleDuration\\": 12,\\n \\"dutyPlan\\": \\"FAST_CHOICE\\",\\n \\"singleDurationUnit\\": \\"DAY\\",\\n \\"schedulingUsers\\": [\\n {\\n \\"schedulingUserId\\": 66666,\\n \\"schedulingOrder\\": 1,\\n \\"schedulingUserName\\": \\"张先生\\",\\n \\"schedulingUserIdList\\": [\\n 66666\\n ],\\n \\"schedulingObjectType\\": \\"single\\"\\n }\\n ],\\n \\"id\\": 2222\\n },\\n \\"fineScheduling\\": {\\n \\"period\\": 0,\\n \\"id\\": 0,\\n \\"periodUnit\\": \\"DAY\\",\\n \\"shiftType\\": \\"MORNING_NIGHT\\",\\n \\"schedulingFineShifts\\": [\\n {\\n \\"schedulingStartTime\\": \\"2020-08-13\\",\\n \\"schedulingEndTime\\": \\"2020-10-13\\",\\n \\"schedulingOrder\\": 1,\\n \\"shiftName\\": \\"早班\\",\\n \\"cycleOrder\\": 1,\\n \\"schedulingUserId\\": 1111,\\n \\"skipOneDay\\": false,\\n \\"schedulingUserName\\": \\"刘德华\\",\\n \\"schedulingUserIdList\\": [\\n 66666\\n ],\\n \\"schedulingObjectType\\": \\"single\\"\\n }\\n ],\\n \\"schedulingTemplateFineShifts\\": [\\n {\\n \\"schedulingStartTime\\": \\"2021-09-01 00:00:00\\",\\n \\"schedulingEndTime\\": \\"2021-10-01 00:00:00\\",\\n \\"schedulingOrder\\": 1,\\n \\"schedulingUserId\\": \\"1\\",\\n \\"skipOneDay\\": true,\\n \\"schedulingUserName\\": \\"刘德华\\",\\n \\"shiftName\\": \\"早班\\",\\n \\"schedulingUserIdList\\": [\\n 66666\\n ],\\n \\"schedulingObjectType\\": \\"single\\"\\n }\\n ]\\n },\\n \\"users\\": [\\n {\\n \\"userId\\": 66666,\\n \\"userName\\": \\"用户名字\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetServiceGroupSchedulingResponse>\\n <requestId>xxxxxxxxxxxx</requestId>\\n <data>\\n <schedulingWay>FINE</schedulingWay>\\n <serviceGroupId>99999</serviceGroupId>\\n <fastScheduling>\\n <singleDuration>12</singleDuration>\\n <dutyPlan>FAST_CHOICE</dutyPlan>\\n <singleDurationUnit>DAY</singleDurationUnit>\\n <schedulingUsers>\\n <schedulingUserId>66666</schedulingUserId>\\n <schedulingOrder>1</schedulingOrder>\\n <schedulingUserName>张杰</schedulingUserName>\\n </schedulingUsers>\\n <id>2222</id>\\n </fastScheduling>\\n <fineScheduling>\\n <periodUnit>DAY</periodUnit>\\n <shiftType>MORNING_NIGHT</shiftType>\\n <schedulingFineShifts>\\n <schedulingStartTime>2020-08-13</schedulingStartTime>\\n <schedulingEndTime>2020-10-13</schedulingEndTime>\\n <schedulingOrder>1</schedulingOrder>\\n <shiftName>早班</shiftName>\\n <cycleOrder>1</cycleOrder>\\n <schedulingUserId>1111</schedulingUserId>\\n <skipOneDay>false</skipOneDay>\\n <schedulingUserName>刘德华</schedulingUserName>\\n </schedulingFineShifts>\\n <schedulingTemplateFineShifts>\\n <schedulingStartTime>2021-09-01 00:00:00</schedulingStartTime>\\n <schedulingEndTime>2021-10-01 00:00:00</schedulingEndTime>\\n <schedulingOrder>1</schedulingOrder>\\n <schedulingUserId>1</schedulingUserId>\\n <skipOneDay>true</skipOneDay>\\n <schedulingUserName>刘德华</schedulingUserName>\\n <shiftName>早班</shiftName>\\n </schedulingTemplateFineShifts>\\n </fineScheduling>\\n <users>\\n <userName>用户名字</userName>\\n </users>\\n </data>\\n</GetServiceGroupSchedulingResponse>","errorExample":""}]',
- ],
- 'UpdateServiceGroupSpecialDayScheduling' => [
- 'summary' => '修改指定日期的服务组排班',
- 'path' => '/services/group/scheduling/updateSpecialDayScheduling',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteServiceGroupUser'],
+ ],
],
+ ],
+ 'DeleteSubscription' => [
+ 'summary' => 'Delete a notification subscription.',
+ 'path' => '/notify/subscription/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempU4CBQS',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempJPZI30'],
],
'parameters' => [
[
@@ -5461,89 +3796,14 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'body',
'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '6666',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'schedulingDate' => [
- 'description' => '',
- 'example' => '2021-08-19',
- 'required' => true,
- 'title' => '排班日期',
- 'type' => 'string',
- ],
- 'schedulingSpecialDays' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingStartTime' => [
- 'description' => '',
- 'example' => '2021-08-19 08:00:00',
- 'required' => true,
- 'title' => '排班开始时间',
- 'type' => 'string',
- ],
- 'schedulingEndTime' => [
- 'description' => '',
- 'example' => '2021-08-19 12:00:00',
- 'required' => true,
- 'title' => '排班结束时间',
- 'type' => 'string',
- ],
- 'schedulingUserId' => [
- 'description' => '',
- 'example' => '64',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '排班用户ID',
- 'type' => 'integer',
- ],
- 'schedulingOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '班次顺序',
- 'type' => 'integer',
- ],
- 'schedulingObjectType' => [
- 'title' => '排班对象类型',
- 'type' => 'string',
- ],
- 'schedulingUserIdList' => [
- 'title' => '多人排班时,人员Id',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '特殊排班信息',
- 'type' => 'array',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'subscriptionId' => ['description' => 'Subscription ID.', 'example' => '10', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -5552,58 +3812,55 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'requestId', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81', 'title' => 'requestId', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified Resource is not found.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","type":"json"}]',
+ 'title' => 'Delete Notification Subscription',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateServiceGroupSpecialDaySchedulingResponse>\\n <requestId>xxxxxxxx</requestId>\\n</UpdateServiceGroupSpecialDaySchedulingResponse>","errorExample":""}]',
- ],
- 'UpdateServiceGroupScheduling' => [
- 'summary' => '修改服务组排班',
- 'path' => '/services/group/scheduling/update',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSubscription'],
+ ],
],
+ ],
+ 'DeleteUser' => [
+ 'summary' => 'Delete a user.',
+ 'path' => '/user/delete',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempCICFVA',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempT8ZOYV'],
],
'parameters' => [
[
@@ -5613,295 +3870,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'schedulingWay' => [
- 'description' => '',
- 'example' => 'FAST',
- 'required' => true,
- 'title' => '排班方式 FAST 快速排班 FINE 精细排班',
- 'type' => 'string',
- ],
- 'fastScheduling' => [
- 'description' => '',
- 'example' => 'HOUR',
- 'properties' => [
- 'singleDuration' => [
- 'description' => '',
- 'example' => '12',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '每人排班时长',
- 'type' => 'integer',
- ],
- 'dutyPlan' => [
- 'description' => '',
- 'example' => 'FAST_CHOICE',
- 'required' => false,
- 'title' => '值班方案 dutyPlan FAST_CHOICE 快速选择 CUSTOM 自定义',
- 'type' => 'string',
- ],
- 'singleDurationUnit' => [
- 'description' => '',
- 'example' => 'DAY',
- 'required' => false,
- 'title' => '每人排班时长单位 HOUR 小时 DAY 天',
- 'type' => 'string',
- ],
- 'schedulingUsers' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingUserId' => [
- 'description' => '',
- 'example' => '6666',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '轮班用户ID',
- 'type' => 'integer',
- ],
- 'schedulingOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '排班顺序',
- 'type' => 'integer',
- ],
- 'schedulingObjectType' => [
- 'title' => '排班对象类型',
- 'type' => 'string',
- ],
- 'schedulingUserIdList' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '快速轮班用户',
- 'type' => 'array',
- ],
- 'id' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '快速排班ID',
- 'type' => 'integer',
- ],
- ],
- 'required' => false,
- 'title' => '快速排班',
- 'type' => 'object',
- ],
- 'fineScheduling' => [
- 'description' => '',
- 'properties' => [
- 'period' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '循环周期',
- 'type' => 'integer',
- ],
- 'periodUnit' => [
- 'description' => '',
- 'example' => 'DAY',
- 'required' => false,
- 'title' => '循环周期单位 HOUR 小时 DAY 天',
- 'type' => 'string',
- ],
- 'shiftType' => [
- 'description' => '',
- 'example' => 'MORNING_NIGHT',
- 'required' => false,
- 'title' => '班次类型 MORNING_NIGHT 早晚班 MORNING_NOON_NIGHT 早中晚班 CUSTOM 自定义',
- 'type' => 'string',
- ],
- 'schedulingFineShifts' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingStartTime' => [
- 'description' => '',
- 'example' => '2020-08-13',
- 'required' => false,
- 'title' => '排班开始时间',
- 'type' => 'string',
- ],
- 'schedulingEndTime' => [
- 'description' => '',
- 'example' => '2020-10-13',
- 'required' => false,
- 'title' => '排班结束时间',
- 'type' => 'string',
- ],
- 'schedulingOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '排班顺序',
- 'type' => 'integer',
- ],
- 'shiftName' => [
- 'description' => '',
- 'example' => '早班',
- 'required' => false,
- 'title' => '班次名称',
- 'type' => 'string',
- ],
- 'skipOneDay' => [
- 'description' => '',
- 'example' => 'true',
- 'required' => false,
- 'title' => '是否跨天',
- 'type' => 'boolean',
- ],
- 'schedulingUserId' => [
- 'description' => '',
- 'example' => '32',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '排班用户ID',
- 'type' => 'integer',
- ],
- 'cycleOrder' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '轮训次序',
- 'type' => 'integer',
- ],
- 'schedulingObjectType' => [
- 'title' => '排班对象类型',
- 'type' => 'string',
- ],
- 'schedulingUserIdList' => [
- 'title' => '多人排班时,人员Id',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '精细排班班次人员信息',
- 'type' => 'array',
- ],
- 'schedulingTemplateFineShifts' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'schedulingStartTime' => [
- 'description' => '',
- 'example' => '2021-10-01 00:00:00',
- 'required' => false,
- 'title' => '排班开始时间',
- 'type' => 'string',
- ],
- 'schedulingEndTime' => [
- 'description' => '',
- 'example' => '2021-11-01 00:00:00',
- 'required' => false,
- 'title' => '排班结束时间',
- 'type' => 'string',
- ],
- 'schedulingOrder' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '排班顺序',
- 'type' => 'integer',
- ],
- 'schedulingUserId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '排班用户ID',
- 'type' => 'integer',
- ],
- 'shiftName' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '班次名称',
- 'type' => 'string',
- ],
- 'skipOneDay' => [
- 'description' => '',
- 'example' => 'false',
- 'required' => false,
- 'title' => '是否跨天',
- 'type' => 'boolean',
- ],
- 'schedulingObjectType' => [
- 'title' => '排班对象类型',
- 'type' => 'string',
- ],
- 'schedulingUserIdList' => [
- 'title' => '多人排班时,人员Id',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '精细排班模版',
- 'type' => 'array',
- ],
- 'id' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '精细排班ID',
- 'type' => 'integer',
- ],
- ],
- 'required' => false,
- 'title' => '精细排班',
- 'type' => 'object',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'userId' => ['description' => 'User ID.', 'example' => '1', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency token.', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -5910,58 +3885,69 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxxxxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'id of the request', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81', 'title' => 'id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter is not valid. %s',
- ],
+ ['errorCode' => 'DeleteUserFail ', 'errorMessage' => 'The user has been associated with route rule.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'DeleteUserFail ', 'errorMessage' => 'The user has been associated with escalationPlan.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'DeleteUserFail ', 'errorMessage' => 'Users are scheduled.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'UserNotExists', 'errorMessage' => 'The specified user does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateServiceGroupSchedulingResponse>\\n <requestId>xxxxxxxxxx</requestId>\\n</UpdateServiceGroupSchedulingResponse>","errorExample":""}]',
- ],
- 'CreateService' => [
- 'summary' => '创建服务',
- 'path' => '/services/save',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","type":"json"}]',
+ 'title' => 'Delete User',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUser'],
+ ],
],
+ ],
+ 'DeliverIncident' => [
+ 'summary' => 'Change owner of a management event. ',
+ 'path' => '/incident/deliver',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempKAIUZH'],
],
'parameters' => [
[
@@ -5971,44 +3957,14 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceDescription' => [
- 'description' => '',
- 'example' => '服务描述',
- 'required' => false,
- 'title' => '服务描述',
- 'type' => 'string',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => '服务名称',
- 'required' => true,
- 'title' => '服务名称',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
- 'escalationPlanId' => [
- 'title' => '升级策略ID',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'serviceGroupIdList' => [
- 'title' => '服务组ID列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
+ 'incidentId' => ['description' => 'Management event ID. ', 'example' => '1223212', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'assignUserId' => ['description' => 'User ID to whom the event is reassigned. ', 'example' => '212321', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency validation ID. ', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61CS9A221', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -6017,77 +3973,64 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'example' => '1',
- 'properties' => [
- 'serviceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '服务ID',
- 'type' => 'integer',
- ],
- ],
- 'title' => '服务ID',
- 'type' => 'object',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2FS', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'AddServiceFail',
- 'errorMessage' => 'Failed to add the service.',
- ],
- [
- 'errorCode' => 'ServiceNameAlreadyExisted',
- 'errorMessage' => 'The service name is already in use.',
- ],
+ ['errorCode' => 'IncidentUpdateInvalid', 'errorMessage' => 'The incident update is invalid.', 'description' => ''],
+ ['errorCode' => 'IncidentStatusInvalid', 'errorMessage' => 'The incident status is invalid.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": {\\n \\"serviceId\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateServiceResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n <data>\\n <serviceId>1</serviceId>\\n </data>\\n</CreateServiceResponse>","errorExample":""}]',
- ],
- 'DeleteService' => [
- 'summary' => '删除服务',
- 'path' => '/services/delete',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2FS\\"\\n}","type":"json"}]',
+ 'title' => 'Change Owner of Management Event ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:DeliverIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeliverIncident'],
+ ],
],
+ ],
+ 'DisableEscalationPlan' => [
+ 'summary' => 'Disable an upgrade plan.',
+ 'path' => '/escalationPlan/disable',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempGUN0ZL'],
],
'parameters' => [
[
@@ -6097,25 +4040,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceId' => [
- 'description' => '',
- 'example' => '10002000',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '服务ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'escalationPlanId' => ['description' => 'Upgrade plan ID.', 'example' => '234534', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency identity.', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST', 'required' => false, 'title' => 'clientToken', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -6124,64 +4055,63 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'DeleteServiceFail',
- 'errorMessage' => 'Failed to delete the service.',
- ],
+ ['errorCode' => 'EscalationPlanAlreadyDisable', 'errorMessage' => 'The escalation plan is already disabled.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'ServiceNotExisted',
- 'errorMessage' => 'The service does not exist.',
- ],
+ ['errorCode' => 'EscalationPlanNotExists', 'errorMessage' => 'The specified escalation plan does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteServiceResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n</DeleteServiceResponse>","errorExample":""}]',
- ],
- 'GetService' => [
- 'summary' => '服务详情',
- 'path' => '/services/detail',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC21925D\\"\\n}","type":"json"}]',
+ 'title' => 'Disable an upgrade plan',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:DisableEscalationPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableEscalationPlan'],
+ ],
],
+ ],
+ 'DisableIntegrationConfig' => [
+ 'summary' => 'Disable the integration configuration.',
+ 'path' => '/integrationConfig/disable',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempSLACC7'],
],
'parameters' => [
[
@@ -6191,25 +4121,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '服务ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'integrationConfigId' => ['description' => 'Integration configuration ID', 'example' => '12345703', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotency identity', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -6218,109 +4136,64 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'properties' => [
- 'serviceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '服务ID',
- 'type' => 'integer',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '服务名字',
- 'type' => 'string',
- ],
- 'serviceDescription' => [
- 'description' => '',
- 'example' => '',
- 'title' => '服务描述',
- 'type' => 'string',
- ],
- 'updateTime' => [
- 'description' => '',
- 'example' => '2020-03-08 12:53:53',
- 'title' => '修改时间',
- 'type' => 'string',
- ],
- 'serviceGroupIdList' => [
- 'title' => '服务组ID列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '服务组ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- 'default' => '1',
- ],
- 'minItems' => 0,
- ],
- 'escalationPlanId' => [
- 'title' => '升级策略ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- 'title' => '服务详情',
- 'type' => 'object',
- ],
+ 'requestId' => ['description' => 'requestId', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'title' => 'requestId', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ServiceNotExisted',
- 'errorMessage' => 'The service does not exist.',
- ],
+ 403 => [
+ ['errorCode' => 'IntegationConfigNotIntegrated', 'errorMessage' => 'The specified integration config is not integrated.', 'description' => ''],
+ ['errorCode' => 'IntegationConfigAlreadyDisable', 'errorMessage' => 'The specified integration config is already disabled.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'IntegationConfigNotExists', 'errorMessage' => 'The specified integration config does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": {\\n \\"serviceId\\": 1,\\n \\"serviceName\\": \\"保洁服务\\",\\n \\"serviceDescription\\": \\"服务描述\\",\\n \\"updateTime\\": \\"2020-03-08 12:53:53\\",\\n \\"serviceGroupIdList\\": [\\n 1\\n ],\\n \\"escalationPlanId\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetServiceResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n <data>\\n <serviceId>1</serviceId>\\n <serviceName>保洁服务</serviceName>\\n <serviceDescription>服务描述</serviceDescription>\\n <updateTime>2020-03-08 12:53:53</updateTime>\\n </data>\\n</GetServiceResponse>","errorExample":""}]',
- ],
- 'ListServices' => [
- 'summary' => '查询服务组列表',
- 'path' => '/services/list',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\"\\n}","type":"json"}]',
+ 'title' => 'Disable the integration configuration',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:DisableIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableIntegrationConfig'],
+ ],
],
+ ],
+ 'DisableRouteRule' => [
+ 'summary' => 'Disable a rule.',
+ 'path' => '/routeRule/disable',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempLJVP1W'],
],
'parameters' => [
[
@@ -6328,42 +4201,15 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'body',
'properties' => [
- 'serviceName' => [
- 'description' => '',
- 'example' => '冲上云霄',
- 'required' => false,
- 'title' => '服务名称',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '当前页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '页大小',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'routeRuleId' => ['description' => 'Rule ID.', 'example' => '1', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency token.', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -6372,129 +4218,62 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'serviceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '服务ID',
- 'type' => 'integer',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => '冲上云霄',
- 'title' => '服务名字',
- 'type' => 'string',
- ],
- 'serviceDescription' => [
- 'description' => '',
- 'example' => '服务描述',
- 'title' => '服务描述',
- 'type' => 'string',
- ],
- 'updateTime' => [
- 'description' => '',
- 'example' => '2020-09-08 14:30:30',
- 'title' => '修改时间',
- 'type' => 'string',
- ],
- 'isValid' => [
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'escalationPlanName' => [
- 'title' => '升级策略名称',
- 'type' => 'string',
- ],
- 'escalationPlanId' => [
- 'title' => '升级策略ID',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'serviceGroupIdList' => [
- 'title' => '服务组ID列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '服务组ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '当前页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '页大小',
- 'type' => 'integer',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '总条数',
- 'type' => 'integer',
- ],
+ 'requestId' => ['description' => 'Request ID.', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'required' => true, 'title' => '', 'type' => 'string'],
+ 'data' => ['description' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'example' => 'null', 'format' => 'int64', 'title' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'type' => 'integer'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": [\\n {\\n \\"serviceId\\": 1,\\n \\"serviceName\\": \\"购物车\\",\\n \\"serviceDescription\\": \\"服务描述\\",\\n \\"updateTime\\": \\"2020-09-08 14:30:30\\",\\n \\"isValid\\": 1,\\n \\"escalationPlanName\\": \\"\\",\\n \\"escalationPlanId\\": 0,\\n \\"serviceGroupIdList\\": [\\n 1\\n ]\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"<ListServicesResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n <data>\\n <serviceId>1</serviceId>\\n <serviceName>购物车</serviceName>\\n <serviceDescription>服务描述</serviceDescription>\\n <updateTime>2020-09-08 14:30:30</updateTime>\\n </data>\\n <pageNumber>1</pageNumber>\\n <pageSIze>10</pageSIze>\\n <totalCount>100</totalCount>\\n</ListServicesResponse>","errorExample":""}]',
- ],
- 'UpdateService' => [
- 'summary' => '更新服务',
- 'path' => '/services/update',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'RouteRuleNotExisted', 'errorMessage' => 'The rule does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": 0\\n}","type":"json"}]',
+ 'title' => 'Disable Rule',
+ 'requestParamsDescription' => "\n",
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:DisableRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableRouteRule'],
+ ],
],
+ ],
+ 'DisableServiceGroupWebhook' => [
+ 'summary' => 'Disable the webhook of a service group.',
+ 'path' => '/services/group/disableWebhook',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
'parameters' => [
[
@@ -6504,52 +4283,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceDescription' => [
- 'description' => '',
- 'example' => '服务描述',
- 'required' => false,
- 'title' => '服务描述',
- 'type' => 'string',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => '服务名字',
- 'required' => false,
- 'title' => '服务名字',
- 'type' => 'string',
- ],
- 'serviceId' => [
- 'description' => '',
- 'example' => '10002000',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '服务ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
- 'escalationPlanId' => [
- 'title' => '升级策略ID',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'serviceGroupIdList' => [
- 'title' => '服务组ID列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'example' => '1', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency token.', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -6558,70 +4298,60 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'example' => 'null',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EditServiceFail',
- 'errorMessage' => 'Failed to edit the service.',
- ],
+ ['errorCode' => 'DisableWebhookFailed', 'errorMessage' => 'Disabling webhook failed.', 'description' => ''],
],
- 404 => [
- [
- 'errorCode' => 'ServiceNotExisted',
- 'errorMessage' => 'The service does not exist.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","type":"json"}]',
+ 'title' => 'Disable the webhook of a service group',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:DisableServiceGroupWebhook',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": 0\\n}","errorExample":""},{"type":"xml","example":"<UpdateServiceResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n</UpdateServiceResponse>","errorExample":""}]',
- ],
- 'CreateRouteRule' => [
- 'summary' => '创建流转规则',
- 'path' => '/routeRule/save',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableServiceGroupWebhook'],
+ ],
],
+ ],
+ 'DisableSubscription' => [
+ 'summary' => 'Disable notification subscription. ',
+ 'path' => '/notify/subscription/doDisable',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLJVP1W',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempM00V6L'],
],
'parameters' => [
[
@@ -6629,254 +4359,14 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '代表创建时间的资源属性字段',
+ 'description' => 'A short description of struct',
'properties' => [
- 'ruleName' => [
- 'description' => '',
- 'example' => '这是一个规则',
- 'format' => 'byte',
- 'required' => true,
- 'title' => '规则名称',
- 'type' => 'string',
- ],
- 'enableStatus' => [
- 'description' => '',
- 'example' => 'false',
- 'required' => false,
- 'title' => '启用状态',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '关联服务ID',
- 'type' => 'integer',
- ],
- 'routeType' => [
- 'description' => '',
- 'example' => 'INCIDENT',
- 'required' => true,
- 'title' => '路由类型:INCIDENT 触发事件 ALERT仅触发报警',
- 'type' => 'string',
- ],
- 'incidentLevel' => [
- 'description' => '',
- 'example' => 'P1',
- 'required' => true,
- 'title' => '事件级别 P1 P2 P3 P4',
- 'type' => 'string',
- ],
- 'assignObjectId' => [
- 'description' => '',
- 'example' => '65',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '事件分派对象ID(服务组ID 或用户ID)',
- 'type' => 'integer',
- ],
- 'assignObjectType' => [
- 'description' => '',
- 'example' => 'SERVICEGROUP',
- 'required' => true,
- 'title' => '事件分派对象类型 SERVICEGROUP服务组 USER 单个用户',
- 'type' => 'string',
- ],
- 'effection' => [
- 'description' => '',
- 'example' => 'LOW',
- 'required' => true,
- 'title' => '影响程度 LOW-一般 HIGH-严重',
- 'type' => 'string',
- ],
- 'timeWindow' => [
- 'description' => '',
- 'example' => '2',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '时间窗口',
- 'type' => 'integer',
- ],
- 'matchCount' => [
- 'description' => '',
- 'example' => '3',
- 'format' => 'int32',
- 'required' => true,
- 'title' => '命中次数',
- 'type' => 'integer',
- ],
- 'timeWindowUnit' => [
- 'description' => '',
- 'example' => 'MINUTE',
- 'required' => true,
- 'title' => '时间窗口单位 MINUTE 分钟 SECOND 秒',
- 'type' => 'string',
- ],
- 'routeChildRules' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '监控源ID',
- 'type' => 'integer',
- ],
- 'conditions' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'key' => [
- 'description' => '',
- 'example' => 'payload.summary',
- 'required' => true,
- 'title' => '字段名称',
- 'type' => 'string',
- ],
- 'value' => [
- 'description' => '',
- 'example' => '123',
- 'required' => true,
- 'title' => '字段值',
- 'type' => 'string',
- ],
- 'operationSymbol' => [
- 'description' => '',
- 'example' => 'equals',
- 'required' => true,
- 'title' => '操作符号:notContain 不包含;contain 包含;equals 等于;notEquals 不等于;',
- 'type' => 'string',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '条件',
- 'type' => 'array',
- ],
- 'childConditionRelation' => [
- 'description' => '',
- 'example' => '0',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '0-与,1-或',
- 'type' => 'integer',
- ],
- 'problemLevel' => [
- 'title' => '故障级别',
- 'type' => 'string',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '子规则',
- 'type' => 'array',
- ],
- 'notifyChannels' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '[SMS,PHONE]',
- 'required' => true,
- 'type' => 'string',
- ],
- 'required' => true,
- 'title' => '通知渠道。 SMS 短信 EMAIL 邮件 PHONE电话 WEIXIN_GROUP 企微群 DING_GROUP钉钉群',
- 'type' => 'array',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
- 'childRuleRelation' => [
- 'description' => '',
- 'example' => 'AND',
- 'required' => true,
- 'title' => '子规则关系AND,OR',
- 'type' => 'string',
- ],
- 'problemLevelGroup' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'childRuleRelation' => [
- 'title' => '子规则关系,0与,1或',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'matchCount' => [
- 'title' => '抑制:命中次数',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'timeWindow' => [
- 'title' => '抑制:时间窗口',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'timeWindowUnit' => [
- 'title' => '抑制:时间窗口单位',
- 'type' => 'string',
- ],
- 'enableUpgrade' => [
- 'title' => '升级:是否升级',
- 'type' => 'boolean',
- ],
- 'upgradeTimeWindow' => [
- 'title' => '升级:时间窗口',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'upgradeTimeWindowUnit' => [
- 'title' => '升级:时间窗口单位',
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'coverageProblemLevels' => [
- 'title' => '故障等级覆盖',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'problemEffectionServices' => [
- 'title' => '故障影响服务',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'convergenceFields' => [
- 'title' => '收敛字段集合',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'convergenceType' => [
- 'title' => '收敛类型(0:流转规则收敛,1:字段收敛)',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'subscriptionId' => ['description' => 'Subscription ID. ', 'example' => '89', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
],
'required' => false,
- 'title' => '创建规则参数',
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -6885,77 +4375,63 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => '',
- 'example' => '请求ID',
- 'title' => '请求',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'example' => '65',
- 'properties' => [
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'title' => '规则ID',
- 'type' => 'integer',
- ],
- ],
- 'title' => '结果',
- 'type' => 'object',
- ],
+ 'requestId' => ['description' => 'requestId', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88', 'type' => 'string', 'title' => ''],
],
- 'title' => '响应参数',
+ 'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'AddRouteRuleFail',
- 'errorMessage' => 'Failed to add the rule.',
- ],
- [
- 'errorCode' => 'RouteRuleNameAlreadyExisted',
- 'errorMessage' => 'The rule name already exists.',
- ],
+ 403 => [
+ ['errorCode' => 'NotifySubsAlreadyDisable', 'errorMessage' => 'The specified subscription is already disabled.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'NotifySubsNotExists', 'errorMessage' => 'The specified subscription does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"请求ID\\",\\n \\"data\\": {\\n \\"routeRuleId\\": 1000\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateRouteRuleResponse>\\n <requestId>请求ID</requestId>\\n <data>\\n <routeRuleId>1000</routeRuleId>\\n </data>\\n</CreateRouteRuleResponse>","errorExample":""}]',
- ],
- 'DeleteRouteRule' => [
- 'summary' => '删除流转规则',
- 'path' => '/routeRule/delete',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","type":"json"}]',
+ 'title' => 'Disable notification subscription ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:DisableSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSubscription'],
+ ],
],
+ ],
+ 'EnableEscalationPlan' => [
+ 'summary' => 'Enable an escalation plan.',
+ 'path' => '/escalationPlan/enable',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLJVP1W',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempGUN0ZL'],
],
'parameters' => [
[
@@ -6963,26 +4439,15 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'A short description of struct',
'properties' => [
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '10000',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '规则ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'escalationPlanId' => ['description' => 'The escalation plan ID.', 'example' => '234534', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'An idempotency identity.', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST', 'required' => false, 'title' => 'clientToken', 'type' => 'string'],
],
'required' => false,
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -6991,69 +4456,63 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'format' => 'int64',
- 'title' => '请求ID',
- 'type' => 'integer',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'DeleteEnabledRuleFail',
- 'errorMessage' => 'Failed to delete the rule with the enabled status.',
- ],
- [
- 'errorCode' => 'DeleteRuleFail',
- 'errorMessage' => 'Failed to delete the rules.',
- ],
+ ['errorCode' => 'EscalationPlanAlreadyEnable', 'errorMessage' => 'The escalation plan is already enabled.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'RouteRuleNotExisted',
- 'errorMessage' => 'The rule does not exist.',
- ],
+ ['errorCode' => 'EscalationPlanNotExists', 'errorMessage' => 'The specified escalation plan does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": 0\\n}","errorExample":""},{"type":"xml","example":"<DeleteRouteRuleResponse/>","errorExample":""}]',
- ],
- 'DisableRouteRule' => [
- 'summary' => '禁用规则',
- 'path' => '/routeRule/disable',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC21925D\\"\\n}","type":"json"}]',
+ 'title' => 'Enable an escalation plan',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:EnableEscalationPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableEscalationPlan'],
+ ],
],
+ ],
+ 'EnableIntegrationConfig' => [
+ 'summary' => 'Enable the integration configuration. ',
+ 'path' => '/integrationConfig/enable',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLJVP1W',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempBHVB81'],
],
'parameters' => [
[
@@ -7061,26 +4520,15 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'A short description of struct',
'properties' => [
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '请求ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'integrationConfigId' => ['description' => 'Integration configuration ID. ', 'example' => '197667760', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotency identity. ', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -7089,67 +4537,64 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => true,
- 'title' => '请求ID',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'example' => 'null',
- 'format' => 'int64',
- 'title' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'type' => 'integer',
- ],
+ 'requestId' => ['description' => 'requestId', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'type' => 'string', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'RouteRuleNotExisted',
- 'errorMessage' => 'The rule does not exist.',
+ 403 => [
+ ['errorCode' => 'IntegationConfigNotIntegrated', 'errorMessage' => 'The specified integration config is not integrated.', 'description' => ''],
+ ['errorCode' => 'IntegationConfigAlreadyEnable', 'errorMessage' => 'The specified integration config is already enabled.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'IntegationConfigNotExists', 'errorMessage' => 'The specified integration config does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\"\\n}","type":"json"}]',
+ 'title' => 'Enable Integration Configuration ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:EnableIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": 0\\n}","errorExample":""},{"type":"xml","example":"<DisableRouteRuleResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n</DisableRouteRuleResponse>","errorExample":""}]',
- 'requestParamsDescription' => "\n",
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableIntegrationConfig'],
+ ],
+ ],
],
'EnableRouteRule' => [
- 'summary' => '启用规则',
+ 'summary' => 'Enables a routing rule.',
'path' => '/routeRule/enable',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLJVP1W',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempLJVP1W'],
],
'parameters' => [
[
@@ -7157,97 +4602,81 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'Request Body.',
'properties' => [
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '规则ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => true,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'routeRuleId' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotent token.', 'type' => 'string', 'required' => true, 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => ''],
],
'required' => false,
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => '请求ID',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'example' => 'null',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => ''],
+ 'data' => ['description' => 'Returned data.', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', 'title' => ''],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EnableRouteRuleFail',
- 'errorMessage' => 'Failed to enable the rules.',
- ],
+ ['errorCode' => 'EnableRouteRuleFail', 'errorMessage' => 'Failed to enable the rules.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'RouteRuleNotExisted',
- 'errorMessage' => 'The rule does not exist.',
- ],
+ ['errorCode' => 'RouteRuleNotExisted', 'errorMessage' => 'The rule does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": 0\\n}","errorExample":""},{"type":"xml","example":"<EnableRouteRuleResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n</EnableRouteRuleResponse>","errorExample":""}]',
- ],
- 'GetRouteRule' => [
- 'summary' => '查询流转规则详情',
- 'path' => '/routeRule/detail',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": 0\\n}","type":"json"}]',
+ 'title' => 'Enable Rule',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:EnableRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableRouteRule'],
+ ],
],
+ ],
+ 'EnableServiceGroupWebhook' => [
+ 'summary' => 'Enable the webhook for a service group. ',
+ 'path' => '/services/group/enableWebhook',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempJRUU6V',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
'parameters' => [
[
@@ -7255,26 +4684,15 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'A short description of struct',
'properties' => [
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '规则ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'serviceGroupId' => ['description' => 'Service group ID. ', 'example' => '1', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency token. ', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -7283,354 +4701,61 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => '',
- 'example' => '6B9347ED-FD93-42B4-B9A4-7282962F5D6A',
- 'title' => '请求ID',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'properties' => [
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '180000000',
- 'format' => 'int64',
- 'title' => '规则ID',
- 'type' => 'integer',
- ],
- 'ruleName' => [
- 'description' => '',
- 'example' => '规则1',
- 'title' => '流转规则名字',
- 'type' => 'string',
- ],
- 'timeWindow' => [
- 'description' => '',
- 'example' => '3',
- 'format' => 'int32',
- 'title' => '时间窗口',
- 'type' => 'integer',
- ],
- 'relatedServiceName' => [
- 'description' => '',
- 'example' => '冲上云霄',
- 'title' => '关联服务名称',
- 'type' => 'string',
- ],
- 'enableStatus' => [
- 'description' => '',
- 'example' => 'DISABLE',
- 'title' => '是否启用 DISABLE禁用 ENABLE 启用',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'title' => '关联服务ID',
- 'type' => 'integer',
- ],
- 'routeType' => [
- 'description' => '',
- 'example' => 'INCIDENT',
- 'title' => '路由类型:INCIDENT 触发事件 ALERT 仅触发报警',
- 'type' => 'string',
- ],
- 'incidentLevel' => [
- 'description' => '',
- 'example' => 'P1',
- 'title' => '事件级别 P1 P2 P3 P4',
- 'type' => 'string',
- ],
- 'assignObjectId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'title' => '事件分派对象ID(服务组ID 或用户ID)',
- 'type' => 'integer',
- ],
- 'assignObjectType' => [
- 'description' => '',
- 'example' => 'SERVICEGROUP',
- 'title' => '事件分派对象类型 SERVICEGROUP 服务组 USER 单个用户',
- 'type' => 'string',
- ],
- 'effection' => [
- 'description' => '',
- 'example' => 'LOW',
- 'title' => '影响程度 LOW一般 HIGH-严重',
- 'type' => 'string',
- ],
- 'matchCount' => [
- 'description' => '',
- 'example' => '3',
- 'format' => 'int64',
- 'title' => '命中次数',
- 'type' => 'integer',
- ],
- 'childRuleRelation' => [
- 'description' => '',
- 'example' => 'AND、OR',
- 'title' => '子规则关系,0与,1或',
- 'type' => 'string',
- ],
- 'eventRouteChildRules' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'childRouteRuleId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'title' => '子规则ID',
- 'type' => 'integer',
- ],
- 'isValidChildRule' => [
- 'description' => '',
- 'example' => 'false',
- 'title' => '是否有效得规则true有效 false无效',
- 'type' => 'boolean',
- ],
- 'parentRuleId' => [
- 'description' => '',
- 'example' => '1800',
- 'format' => 'int64',
- 'title' => '规则ID',
- 'type' => 'integer',
- ],
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '监控源ID',
- 'type' => 'integer',
- ],
- 'monitorIntegrationConfigId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '集成配置ID',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'zabbix',
- 'title' => '监控源名称',
- 'type' => 'string',
- ],
- 'childConditionRelation' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '子条件计算关系,0-与,1-或',
- 'type' => 'integer',
- ],
- 'conditions' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'key' => [
- 'description' => '',
- 'example' => 'alarmName',
- 'title' => '条件可以',
- 'type' => 'string',
- ],
- 'value' => [
- 'description' => '',
- 'example' => 'Zabbix server',
- 'title' => '匹配值',
- 'type' => 'string',
- ],
- 'operationSymbol' => [
- 'description' => '',
- 'example' => 'contain',
- 'title' => '操作符',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '条件',
- 'type' => 'array',
- ],
- 'problemLevel' => [
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '子规则',
- 'type' => 'array',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2020-09-08 15:30:30',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'updateTime' => [
- 'description' => '',
- 'example' => '2020-09-08 15:30:30',
- 'title' => '修改时间',
- 'type' => 'string',
- ],
- 'notifyChannels' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '[SMS,PHONE]',
- 'type' => 'string',
- ],
- 'title' => '通知渠道',
- 'type' => 'array',
- ],
- 'notifyChannelNames' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '[短信,电话]',
- 'type' => 'string',
- ],
- 'title' => '通知渠道名称',
- 'type' => 'array',
- ],
- 'assignObjectName' => [
- 'description' => '',
- 'example' => '刘德华',
- 'title' => '通知对象名称',
- 'type' => 'string',
- ],
- 'relServiceDeleteType' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '服务删除字段',
- 'type' => 'integer',
- ],
- 'problemLevelGroup' => [
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'childRuleRelation' => [
- 'title' => '子规则关系,0与,1或',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'matchCount' => [
- 'title' => '抑制:命中次数',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'timeWindow' => [
- 'title' => '抑制:时间窗口',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'timeWindowUnit' => [
- 'title' => '抑制:时间窗口单位',
- 'type' => 'string',
- ],
- 'enableUpgrade' => [
- 'title' => '升级:是否升级',
- 'type' => 'boolean',
- ],
- 'upgradeTimeWindow' => [
- 'title' => '升级:时间窗口',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'upgradeTimeWindowUnit' => [
- 'title' => '升级:时间窗口单位',
- 'type' => 'string',
- ],
- ],
- ],
- 'type' => 'object',
- ],
- 'coverageProblemLevels' => [
- 'description' => '',
- 'items' => [
- 'type' => 'string',
- ],
- 'title' => '故障等级覆盖',
- 'type' => 'array',
- ],
- 'problemEffectionServices' => [
- 'description' => '',
- 'items' => [
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'title' => '故障影响服务',
- 'type' => 'array',
- ],
- 'convergenceFields' => [
- 'title' => '收敛字段集合',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'convergenceType' => [
- 'title' => '收敛类型(0:流转规则收敛,1:字段收敛)',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- 'title' => '规则详情',
- 'type' => 'object',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'RouteRuleNotExisted',
- 'errorMessage' => 'The rule does not exist.',
- ],
+ 400 => [
+ ['errorCode' => 'EnableServiceGroupWebhookFail', 'errorMessage' => 'Failed to enable the service group webhook.', 'description' => ''],
+ ['errorCode' => 'ServiceGroupNotExisted', 'errorMessage' => 'The service group does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"6B9347ED-FD93-42B4-B9A4-7282962F5D6A\\",\\n \\"data\\": {\\n \\"routeRuleId\\": 180000000,\\n \\"ruleName\\": \\"规则1\\",\\n \\"timeWindow\\": 3,\\n \\"relatedServiceName\\": \\"冲上云霄\\",\\n \\"enableStatus\\": \\"disable\\",\\n \\"relatedServiceId\\": 1000,\\n \\"routeType\\": \\"INCIDENT\\",\\n \\"incidentLevel\\": \\"P1\\",\\n \\"assignObjectId\\": 1000,\\n \\"assignObjectType\\": \\"SERVICEGROUP\\",\\n \\"effection\\": \\"LOW\\",\\n \\"matchCount\\": 3,\\n \\"childRuleRelation\\": \\"AND、OR\\",\\n \\"eventRouteChildRules\\": [\\n {\\n \\"childRouteRuleId\\": 1000,\\n \\"isValidChildRule\\": false,\\n \\"parentRuleId\\": 1800,\\n \\"monitorSourceId\\": 1,\\n \\"monitorIntegrationConfigId\\": 1,\\n \\"monitorSourceName\\": \\"zabbix\\",\\n \\"childConditionRelation\\": 1,\\n \\"conditions\\": [\\n {\\n \\"key\\": \\"alarmName\\",\\n \\"value\\": \\"Zabbix server\\",\\n \\"operationSymbol\\": \\"contain\\"\\n }\\n ],\\n \\"problemLevel\\": \\"1\\"\\n }\\n ],\\n \\"createTime\\": \\"2020-09-08 15:30:30\\",\\n \\"updateTime\\": \\"2020-09-08 15:30:30\\",\\n \\"notifyChannels\\": [\\n \\"[SMS,PHONE]\\"\\n ],\\n \\"notifyChannelNames\\": [\\n \\"[短信,电话]\\"\\n ],\\n \\"assignObjectName\\": \\"刘先生\\",\\n \\"relServiceDeleteType\\": 1,\\n \\"problemLevelGroup\\": {\\n \\"key\\": {\\n \\"childRuleRelation\\": 11,\\n \\"matchCount\\": 11,\\n \\"timeWindow\\": 1,\\n \\"timeWindowUnit\\": \\"1\\",\\n \\"enableUpgrade\\": true,\\n \\"upgradeTimeWindow\\": 1,\\n \\"upgradeTimeWindowUnit\\": \\"1\\"\\n }\\n },\\n \\"coverageProblemLevels\\": [\\n \\"1\\"\\n ],\\n \\"problemEffectionServices\\": [\\n 1\\n ],\\n \\"convergenceFields\\": [\\n \\"name\\"\\n ],\\n \\"convergenceType\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetRouteRuleResponse>\\n <requestId>6B9347ED-FD93-42B4-B9A4-7282962F5D6A</requestId>\\n <data>\\n <routeRuleId>180000000</routeRuleId>\\n <subscriptionName>我的订阅</subscriptionName>\\n <ruleName>规则1</ruleName>\\n <timeWindow>3</timeWindow>\\n <relatedServiceName>冲上云霄</relatedServiceName>\\n <enableStatus>DISABLE</enableStatus>\\n <relatedServiceId>1000</relatedServiceId>\\n <routeType>INCIDENT</routeType>\\n <incidentLevel>P1</incidentLevel>\\n <assignObjectId>1000</assignObjectId>\\n <assignObjectType>SERVICEGROUP</assignObjectType>\\n <effection>LOW</effection>\\n <matchCount>3</matchCount>\\n <eventRouteChildRules>\\n <childRouteRuleId>1000</childRouteRuleId>\\n <isValidChildRule>false</isValidChildRule>\\n <parentRuleId>1800</parentRuleId>\\n <monitorSourceId>1</monitorSourceId>\\n <monitorIntegrationConfigId>1</monitorIntegrationConfigId>\\n <monitorSourceName>zabbix</monitorSourceName>\\n <conditions>\\n <key>alarmName</key>\\n <value>Zabbix server</value>\\n <operationSymbol>contain</operationSymbol>\\n </conditions>\\n </eventRouteChildRules>\\n <createTime>2020-09-08 15:30:30</createTime>\\n <updateTime>2020-09-08 15:30:30</updateTime>\\n <notifyChannels>[SMS,PHONE]</notifyChannels>\\n <notifyChannelNames>[短信,电话]</notifyChannelNames>\\n <assignObjectName>刘德华</assignObjectName>\\n </data>\\n</GetRouteRuleResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{'."\n"
- .' "routeRuleId" : 1,'."\n"
- .' "}',
- ],
- 'ListRouteRules' => [
- 'summary' => '查询流转规则列表',
- 'path' => '/routeRule/list',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","type":"json"}]',
+ 'title' => 'Enable the webhook for a service group ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:EnableServiceGroupWebhook',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableServiceGroupWebhook'],
+ ],
],
+ ],
+ 'EnableSubscription' => [
+ 'summary' => 'Enable Notifications subscription.',
+ 'path' => '/notify/subscription/enable',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempJRUU6V',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempJPZI30'],
],
'parameters' => [
[
@@ -7638,64 +4763,14 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'A short description of struct',
'properties' => [
- 'ruleName' => [
- 'description' => '',
- 'example' => '规则名字',
- 'format' => 'byte',
- 'required' => false,
- 'title' => '规则名称',
- 'type' => 'string',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => '冲上云霄',
- 'format' => 'byte',
- 'required' => false,
- 'title' => '服务名称',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '第几页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '页的大小',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
- 'routeType' => [
- 'description' => '',
- 'example' => '0',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '路由类型:0触发事件 1仅触发报警 r',
- 'type' => 'integer',
- ],
- 'notFilterRouteRuleDeleted' => [
- 'required' => false,
- 'title' => '不过滤已删除流转规则(为true时,已删除过滤对象也会查到)',
- 'type' => 'boolean',
- ],
+ 'subscriptionId' => ['description' => 'Subscription ID.', 'example' => '10', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
],
'required' => false,
- 'title' => '规则列表查询入参数',
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -7704,542 +4779,158 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13B-A225-2C88188E8A43',
- 'title' => '请求ID',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '10000',
- 'format' => 'int64',
- 'title' => '规则ID',
- 'type' => 'integer',
- ],
- 'tenantRamId' => [
- 'description' => '',
- 'example' => '1344383',
- 'format' => 'int64',
- 'title' => '租户ID',
- 'type' => 'integer',
- ],
- 'ruleName' => [
- 'description' => '',
- 'example' => '规则名字',
- 'title' => '规则名称',
- 'type' => 'string',
- ],
- 'relatedServiceName' => [
- 'description' => '',
- 'example' => '关联服务名字',
- 'title' => '服务名称',
- 'type' => 'string',
- ],
- 'timeWindow' => [
- 'description' => '',
- 'example' => '时间窗口',
- 'format' => 'int64',
- 'title' => '时间窗口',
- 'type' => 'integer',
- ],
- 'matchCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '命中次数',
- 'type' => 'integer',
- ],
- 'timeWindowUnit' => [
- 'description' => '',
- 'example' => 'MINUTE',
- 'format' => 'int64',
- 'title' => '时间窗口单位 MINUTE 分钟 SECOND 秒',
- 'type' => 'integer',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '关联服务ID',
- 'type' => 'integer',
- ],
- 'routeType' => [
- 'description' => '',
- 'example' => 'INCIDENT',
- 'title' => '路由类型:INCIDENT 触发事件 ALERT 仅触发报警',
- 'type' => 'string',
- ],
- 'incidentLevel' => [
- 'description' => '',
- 'example' => 'P1',
- 'title' => '事件级别 P1 P2 P3 P4',
- 'type' => 'string',
- ],
- 'assignObjectId' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '事件分派对象ID(服务组ID 或用户ID)',
- 'type' => 'integer',
- ],
- 'assignObjectType' => [
- 'description' => '',
- 'example' => 'SERVICEGROUP',
- 'title' => '事件分派对象类型 SERVICEGROUP 服务组 USER 单个用户',
- 'type' => 'string',
- ],
- 'effection' => [
- 'description' => '',
- 'example' => 'LOW',
- 'title' => '影响程度 LOW-一般 HIGH-严重',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2020-03-05 15:53:55',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'updateTime' => [
- 'description' => '',
- 'example' => '2020-03-05 15:53:55',
- 'title' => '修改时间',
- 'type' => 'string',
- ],
- 'enableStatus' => [
- 'description' => '',
- 'example' => 'DISABLE',
- 'title' => '是否启用 DISABLE禁用. ENABLE 启用',
- 'type' => 'string',
- ],
- 'monitorSourceNames' => [
- 'description' => '',
- 'example' => 'zabbix',
- 'title' => '监控源名称',
- 'type' => 'string',
- ],
- 'relServiceDeleteType' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '服务删除字段',
- 'type' => 'integer',
- ],
- 'isValid' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '是否有效 0无效 1有效',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '规则列表',
- 'type' => 'array',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '总条数',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '第几页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '分页大小',
- 'type' => 'integer',
- ],
+ 'requestId' => ['description' => 'requestId', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81', 'type' => 'string', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13B-A225-2C88188E8A43\\",\\n \\"data\\": [\\n {\\n \\"routeRuleId\\": 10000,\\n \\"tenantRamId\\": 1344383,\\n \\"ruleName\\": \\"规则名字\\",\\n \\"relatedServiceName\\": \\"关联服务名字\\",\\n \\"timeWindow\\": 0,\\n \\"matchCount\\": 10,\\n \\"timeWindowUnit\\": 0,\\n \\"relatedServiceId\\": 1,\\n \\"routeType\\": \\"INCIDENT\\",\\n \\"incidentLevel\\": \\"P1\\",\\n \\"assignObjectId\\": 10,\\n \\"assignObjectType\\": \\"SERVICEGROUP\\",\\n \\"effection\\": \\"LOW\\",\\n \\"createTime\\": \\"2020-03-05 15:53:55\\",\\n \\"updateTime\\": \\"2020-03-05 15:53:55\\",\\n \\"enableStatus\\": \\"DISABLE\\",\\n \\"monitorSourceNames\\": \\"zabbix\\",\\n \\"relServiceDeleteType\\": 1,\\n \\"isValid\\": 1\\n }\\n ],\\n \\"totalCount\\": 10,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListRouteRulesResponse>\\n <requestId>C4BE3837-1A13B-A225-2C88188E8A43</requestId>\\n <data>\\n <routeRuleId>10000</routeRuleId>\\n <tenantRamId>1344383</tenantRamId>\\n <ruleName>规则名字</ruleName>\\n <relatedServiceName>关联服务名字</relatedServiceName>\\n <matchCount>10</matchCount>\\n <relatedServiceId>1</relatedServiceId>\\n <routeType>INCIDENT</routeType>\\n <incidentLevel>P1</incidentLevel>\\n <assignObjectId>10</assignObjectId>\\n <assignObjectType>SERVICEGROUP</assignObjectType>\\n <effection>LOW</effection>\\n <createTime>2020-03-05 15:53:55</createTime>\\n <updateTime>2020-03-05 15:53:55</updateTime>\\n <enableStatus>DISABLE</enableStatus>\\n <monitorSourceNames>zabbix</monitorSourceNames>\\n </data>\\n <totalCount>10</totalCount>\\n <pageNumber>1</pageNumber>\\n <pageSize>10</pageSize>\\n</ListRouteRulesResponse>","errorExample":""}]',
- ],
- 'UpdateRouteRule' => [
- 'summary' => '更新流转规则',
- 'path' => '/routeRule/edit',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NotifySubsAlreadyEnable', 'errorMessage' => 'The specified subscription is already enabled.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'NotifySubsNotExists', 'errorMessage' => 'The specified subscription does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","type":"json"}]',
+ 'title' => 'Enable Notifications subscription',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:EnableSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSubscription'],
+ ],
+ ],
+ ],
+ 'FinishIncident' => [
+ 'summary' => 'Finishes an incident.',
+ 'path' => '/incident/finish',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLJVP1W',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempKAIUZH'],
],
'parameters' => [
[
- 'name' => 'body',
+ 'name' => 'Body',
'in' => 'body',
- 'style' => 'json',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'body',
+ 'description' => 'Request body parameters.',
'properties' => [
- 'ruleName' => [
- 'description' => '',
- 'example' => '规则1',
- 'required' => true,
- 'title' => '规则名称',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '关联服务ID',
- 'type' => 'integer',
- ],
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '规则ID',
- 'type' => 'integer',
- ],
- 'routeType' => [
- 'description' => '',
- 'example' => 'ALERT',
- 'required' => true,
- 'title' => '路由类型:INCIDENT 触发事件 ALERT 仅触发报警',
- 'type' => 'string',
- ],
- 'incidentLevel' => [
- 'description' => '',
- 'example' => 'P1',
- 'required' => true,
- 'title' => '事件级别 1-P1 2-P2 3-P3 4-P4',
- 'type' => 'string',
- ],
- 'assignObjectId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '事件分派对象ID(服务组ID 或用户ID)',
- 'type' => 'integer',
- ],
- 'assignObjectType' => [
- 'description' => '',
- 'example' => 'SERVICEGROUP',
- 'required' => true,
- 'title' => '事件分派对象类型 SERVICEGROUP服务组 USER 单个用户',
- 'type' => 'string',
- ],
- 'effection' => [
- 'description' => '',
- 'example' => 'LOW',
- 'required' => true,
- 'title' => '影响程度 LOW-一般 HIGH-严重',
- 'type' => 'string',
- ],
- 'timeWindow' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'required' => true,
- 'title' => '时间窗口',
- 'type' => 'integer',
- ],
- 'timeWindowUnit' => [
- 'description' => '',
- 'example' => 'MINUTE',
- 'required' => true,
- 'title' => '时间窗口单位 MINUTE 分钟 SECOND 秒',
- 'type' => 'string',
- ],
- 'matchCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '命中次数',
- 'type' => 'integer',
- ],
- 'routeChildRules' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'childRouteRuleId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '子规则ID 不填表示新增',
- 'type' => 'integer',
- ],
- 'conditions' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'key' => [
- 'description' => '',
- 'example' => 'payload.summary',
- 'required' => true,
- 'title' => '字段',
- 'type' => 'string',
- ],
- 'value' => [
- 'description' => '',
- 'example' => '123',
- 'required' => true,
- 'title' => '字段取值',
- 'type' => 'string',
- ],
- 'operationSymbol' => [
- 'description' => '',
- 'example' => 'equals',
- 'required' => true,
- 'title' => '操作符',
- 'type' => 'string',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '条件',
- 'type' => 'array',
- ],
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '监控源ID',
- 'type' => 'integer',
- ],
- 'isValidChildRule' => [
- 'description' => '',
- 'example' => 'false',
- 'required' => true,
- 'title' => 'true 删除子规则 false编辑子规则',
- 'type' => 'boolean',
- ],
- 'childConditionRelation' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '子条件计算关系',
- 'type' => 'integer',
- ],
- 'problemLevel' => [
- 'type' => 'string',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '子规则',
- 'type' => 'array',
- ],
- 'notifyChannels' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '[SMS,PHONE]',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'incidentIds' => [
+ 'description' => 'Incident IDs. You can specify up to 10 IDs.',
+ 'items' => ['description' => 'An incident ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12321', 'title' => ''],
'required' => true,
- 'title' => '通知渠道 SMS 短信 EMAIL 邮件 PHONE 电话 WEIXIN_GROUP 企微群 DING_GROUP 钉钉群',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
- 'childRuleRelation' => [
- 'description' => '',
- 'example' => 'AND',
- 'required' => false,
- 'title' => 'AND',
- 'type' => 'string',
- ],
- 'problemLevelGroup' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'properties' => [
- 'childRuleRelation' => [
- 'title' => '子规则关系,0与,1或',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'matchCount' => [
- 'title' => '抑制:命中次数',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'timeWindow' => [
- 'title' => '抑制:时间窗口',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'timeWindowUnit' => [
- 'title' => '抑制:时间窗口单位',
- 'type' => 'string',
- ],
- 'enableUpgrade' => [
- 'title' => '升级:是否升级',
- 'type' => 'boolean',
- ],
- 'upgradeTimeWindow' => [
- 'title' => '升级:时间窗口',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'upgradeTimeWindowUnit' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'coverageProblemLevels' => [
- 'title' => '故障等级覆盖',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'problemEffectionServices' => [
- 'title' => '故障影响服务',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'convergenceFields' => [
- 'title' => '收敛字段集合',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'convergenceType' => [
- 'title' => '收敛类型(0:流转规则收敛,1:字段收敛)',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'incidentFinishReason' => ['description' => 'The reason for finishing the incident.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ 'incidentFinishReasonDescription' => ['description' => 'A description of the reason for finishing the incident.', 'type' => 'string', 'example' => '原因', 'title' => '', 'required' => false],
+ 'incidentFinishSolution' => ['description' => 'The solution applied to resolve the incident.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => '', 'required' => false],
+ 'incidentFinishSolutionDescription' => ['description' => 'A description of the solution applied to resolve the incident.', 'type' => 'string', 'example' => '原因', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'An idempotency token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2DC'],
],
- 'required' => false,
- 'title' => '编辑流转规则入参',
+ 'required' => true,
+ 'title' => '',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
'properties' => [
- 'requestId' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => '请求ID',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'example' => 'null',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
+ 'requestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9'],
],
- 'title' => '响应',
+ 'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RouteRuleNameAlreadyExisted',
- 'errorMessage' => 'The rule name already exists.',
- ],
+ ['errorCode' => 'IncidentUpdateInvalid', 'errorMessage' => 'The incident update is invalid.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'RouteRuleNotExisted',
- 'errorMessage' => 'The rule does not exist.',
- ],
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": 0\\n}","errorExample":""},{"type":"xml","example":"<UpdateRouteRuleResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n</UpdateRouteRuleResponse>","errorExample":""}]',
- ],
- 'VerifyRouteRule' => [
- 'summary' => '验证流转规则',
- 'path' => '/routeRule/verify',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","type":"json"}]',
+ 'title' => 'Complete Event',
+ 'requestParamsDescription' => '{"incidentIds":\\[170003050],"incidentFinishReason":"1","incidentFinishReasonDescription":"222","incidentFinishSolution":"1","incidentFinishSolutionDescription":"22222222","clientToken":"155afb33-2300-4c7c-a114-4c8ab1ef4ba7"}',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-10T09:29:57.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:FinishIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FinishIncident'],
+ ],
],
+ ],
+ 'FinishProblem' => [
+ 'summary' => 'Complete the fault resolution.',
+ 'path' => '/problem/finish',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLJVP1W',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZB7ZAW'],
],
'parameters' => [
[
@@ -8249,61 +4940,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '1111',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '规则id',
- 'type' => 'integer',
- ],
- 'testSourceEvents' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '{}',
- 'properties' => [
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '监控告警源ID',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'zabbix',
- 'required' => false,
- 'title' => '监控告警源名称',
- 'type' => 'string',
- ],
- 'eventTime' => [
- 'description' => '',
- 'example' => '2021-09-08 13:00:00',
- 'required' => false,
- 'title' => '告警上报时间',
- 'type' => 'string',
- ],
- 'eventJson' => [
- 'description' => '',
- 'example' => '{}',
- 'required' => false,
- 'title' => '告警内容',
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '测试告警',
- 'type' => 'array',
- ],
+ 'problemId' => ['description' => 'Fault ID.', 'example' => '3123', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency validation.', 'example' => '6338F42D-ED0B-442C-932C-657300AFB4BB', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -8312,139 +4955,63 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'properties' => [
- 'isValidRule' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '验证是否成功',
- 'type' => 'boolean',
- ],
- 'routeType' => [
- 'description' => '',
- 'example' => 'INCIDENT、ALERT',
- 'title' => '事件或者报警',
- 'type' => 'string',
- ],
- 'notifySubscriptionNames' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '',
- 'properties' => [
- 'subscriptionId' => [
- 'description' => '',
- 'example' => '111111',
- 'format' => 'int64',
- 'title' => '订阅ID',
- 'type' => 'integer',
- ],
- 'title' => [
- 'description' => '',
- 'example' => '订阅名称',
- 'title' => '订阅名称',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '订阅名称',
- 'type' => 'array',
- ],
- 'escalationPlans' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'escalationPlanName' => [
- 'description' => '',
- 'example' => '升级计划1',
- 'title' => '升级计划名称',
- 'type' => 'string',
- ],
- 'escalationPlanId' => [
- 'description' => '',
- 'example' => '111111',
- 'format' => 'int64',
- 'title' => '升级计划ID',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '升级策略名称',
- 'type' => 'array',
- ],
- 'routeRuleFailReason' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'title' => '流转规则验证失败的原因',
- 'type' => 'array',
- ],
- 'monitorSourceIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '1000',
- 'example' => '验证失败监控源ID',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'title' => '验证失败监控源ID',
- 'type' => 'array',
- ],
- ],
- 'title' => '验证结果',
- 'type' => 'object',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => '6338F42D-ED0B-442C-932C-657300AFB4BB', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxx\\",\\n \\"data\\": {\\n \\"isValidRule\\": true,\\n \\"routeType\\": \\"INCIDENT、ALERT\\",\\n \\"notifySubscriptionNames\\": [\\n {\\n \\"subscriptionId\\": 111111,\\n \\"title\\": \\"订阅名称\\"\\n }\\n ],\\n \\"escalationPlans\\": [\\n {\\n \\"escalationPlanName\\": \\"升级计划1\\",\\n \\"escalationPlanId\\": 111111\\n }\\n ],\\n \\"routeRuleFailReason\\": [\\n \\"alertName不匹配\\"\\n ],\\n \\"monitorSourceIds\\": [\\n 0\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<VerifyRouteRuleResponse>\\n <requestId>xxxxxx</requestId>\\n <data>\\n <isValidRule>true</isValidRule>\\n <routeType>INCIDENT、ALERT</routeType>\\n <notifySubscriptionNames>我的订阅</notifySubscriptionNames>\\n <escalationPlanNames>升级策略1</escalationPlanNames>\\n <routeRuleFailReason>alertName不匹配</routeRuleFailReason>\\n </data>\\n</VerifyRouteRuleResponse>","errorExample":""}]',
- ],
- 'CreateSubscription' => [
- 'summary' => '创建通知订阅',
- 'path' => '/notify/subscription/create',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ProblemStatusError', 'errorMessage' => 'The problem status is abnormal.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6338F42D-ED0B-442C-932C-657300AFB4BB\\"\\n}","type":"json"}]',
+ 'title' => 'Fault Resolution Completion',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:FinishProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FinishProblem'],
+ ],
],
+ ],
+ 'GeneratePictureLink' => [
+ 'summary' => 'Generate Image Link ',
+ 'path' => '/rich/oss/getPictureLink',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempJPZI30',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempHBPHMV'],
],
'parameters' => [
[
@@ -8454,215 +5021,20 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'subscriptionTitle' => [
- 'description' => '',
- 'example' => 'testSubscription',
- 'required' => true,
- 'title' => '通知订阅名称',
- 'type' => 'string',
- ],
- 'scope' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '订阅范围类型',
- 'type' => 'integer',
- ],
- 'notifyObjectType' => [
- 'description' => '',
- 'example' => 'USER',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '通知对象类型',
- 'type' => 'integer',
- ],
- 'expiredType' => [
- 'description' => '',
- 'example' => 'LONG_TERM',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '订阅时效',
- 'type' => 'integer',
- ],
- 'period' => [
- 'description' => '',
- 'example' => '1个月',
+ 'keys' => [
+ 'description' => 'keys',
+ 'items' => ['description' => 'oss key', 'example' => 'oss key', 'required' => false, 'type' => 'string', 'title' => ''],
'required' => false,
- 'title' => '时间段',
- 'type' => 'string',
- ],
- 'scopeObjectList' => [
- 'description' => '',
- 'items' => [
- 'description' => 'Object',
- 'properties' => [
- 'scopeObjectId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '订阅范围对象id',
- 'type' => 'integer',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '订阅范围列表',
- 'type' => 'array',
- ],
- 'notifyObjectList' => [
- 'description' => '',
- 'items' => [
- 'description' => 'Object',
- 'properties' => [
- 'notifyObjectId' => [
- 'description' => '',
- 'example' => '2',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '通知对象id',
- 'type' => 'integer',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '通知对象列表',
- 'type' => 'array',
- ],
- 'notifyStrategyList' => [
- 'description' => '',
- 'items' => [
- 'description' => 'Object',
- 'properties' => [
- 'instanceType' => [
- 'description' => '',
- 'example' => 'INCIDENT',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '订阅实例类型,事件、报警、故障',
- 'type' => 'integer',
- ],
- 'strategies' => [
- 'description' => '',
- 'items' => [
- 'description' => 'Object',
- 'properties' => [
- 'conditions' => [
- 'description' => '',
- 'items' => [
- 'description' => 'Object',
- 'properties' => [
- 'effection' => [
- 'description' => '',
- 'example' => 'HIGH',
- 'required' => false,
- 'title' => '影响范围',
- 'type' => 'string',
- ],
- 'problemNotifyType' => [
- 'description' => '',
- 'example' => 'PROBLEM_UPDATE',
- 'required' => false,
- 'title' => '故障通知类型',
- 'type' => 'string',
- ],
- 'level' => [
- 'description' => '',
- 'example' => 'P1',
- 'required' => false,
- 'title' => '等级',
- 'type' => 'string',
- ],
- 'action' => [
- 'description' => '',
- 'example' => 'INCIDENT_TRIGGER',
- 'required' => false,
- 'title' => '时间动作',
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '通知策略条件',
- 'type' => 'array',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '条件。json格式,包含多个条件,比如级别、影响程度 kv格式',
- 'type' => 'array',
- ],
- 'channels' => [
- 'description' => '',
- 'example' => 'SMS,PHONE',
- 'required' => true,
- 'title' => '渠道,多个逗号分隔',
- 'type' => 'string',
- ],
- 'periodChannel' => [
- 'description' => '',
- 'properties' => [
- 'workday' => [
- 'description' => '',
- 'example' => 'SMS,PHONE',
- 'required' => false,
- 'title' => '工作时段',
- 'type' => 'string',
- ],
- 'nonWorkday' => [
- 'description' => '',
- 'example' => 'SMS,PHONE',
- 'required' => false,
- 'title' => '非工作时段',
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- 'title' => '分时段渠道',
- 'type' => 'object',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '通知策略列表',
+ 'title' => 'keys',
'type' => 'array',
+ 'example' => '',
],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
- 'required' => false,
- 'title' => '幂等参数',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'description' => '',
- 'example' => '2021-02-03 10:10:10',
- 'required' => false,
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'description' => '',
- 'example' => '2021-11-03 10:10:10',
- 'required' => false,
- 'title' => '结束时间',
- 'type' => 'string',
- ],
+ 'problemId' => ['description' => 'Problem ID.', 'example' => '50002020', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -8671,71 +5043,94 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'request id',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'title' => 'request id',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'xxxxxx', 'title' => 'Id of the request', 'type' => 'string'],
'data' => [
'description' => 'data',
'properties' => [
- 'subscriptionId' => [
- 'description' => '',
- 'example' => '101',
- 'format' => 'int64',
- 'title' => '订阅id',
- 'type' => 'integer',
+ 'links' => [
+ 'description' => 'array',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'key' => ['description' => 'oss key', 'example' => 'problem/38b2a36d-484d-4242-b9cf-d243e5*****', 'title' => 'oss key', 'type' => 'string'],
+ 'link' => ['description' => 'url', 'example' => 'http://*****-bucket.oss-cn-shanghai.aliyuncs.com/problem/38b2a36d-484d-4242-b9cf-d243e53a82c6?Expires=1625662477&OSSAccessKeyId=LTAI****************&Signature=1NFnt%2BnudD%2F%2BHVc31b6v5%2FF*****', 'title' => 'url', 'type' => 'string'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => 'array',
+ 'type' => 'array',
+ 'example' => '',
],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NotifySubsAlreadyExists',
- 'errorMessage' => 'The specified subscription already exists.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxxxx\\",\\n \\"data\\": {\\n \\"links\\": [\\n {\\n \\"key\\": \\"problem/38b2a36d-484d-4242-b9cf-d243e5*****\\",\\n \\"link\\": \\"http://*****-bucket.oss-cn-shanghai.aliyuncs.com/problem/38b2a36d-484d-4242-b9cf-d243e53a82c6?Expires=1625662477&OSSAccessKeyId=LTAI****************&Signature=1NFnt%2BnudD%2F%2BHVc31b6v5%2FF*****\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Generate Image Link ',
+ 'requestParamsDescription' => '{'."\n"
+ .' "keys" : [ "oss key" ],'."\n"
+ .' "problemId" : 50002020'."\n"
+ .'}',
+ 'responseParamsDescription' => '{'."\n"
+ .' "requestId": "xxxxxx",'."\n"
+ .' "data": {'."\n"
+ .' "links": ['."\n"
+ .' {'."\n"
+ .' "key": "problem/38b2a36d-484d-4242-b9cf-d243e53a82c6",'."\n"
+ .' "link": "http://gam-objects-bucket.oss-cn-shanghai.aliyuncs.com/problem/38b2a36d-484d-4242-b9cf-d243e53a82c6?Expires=1625662477&OSSAccessKeyId=XXXX&Signature=XXXX"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .'}',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-08T11:07:03.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GeneratePictureLink',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"subscriptionId\\": 101\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateSubscriptionResponse>\\n <data>\\n <subscriptionId>70002030</subscriptionId>\\n </data>\\n <requestId>366D5476-734A-4DA5-963E-9724F87470BC</requestId>\\n</CreateSubscriptionResponse>","errorExample":""}]',
- ],
- 'DeleteSubscription' => [
- 'summary' => '删除通知订阅',
- 'path' => '/notify/subscription/delete',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GeneratePictureLink'],
+ ],
],
+ ],
+ 'GeneratePictureUploadSign' => [
+ 'summary' => 'Generate image upload signature information. ',
+ 'path' => '/rich/oss/generatePostPolicy',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempJPZI30',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempHBPHMV'],
],
'parameters' => [
[
@@ -8743,18 +5138,40 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'A short description of struct',
'properties' => [
- 'subscriptionId' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
+ 'instanceId' => ['description' => 'Resource ID. ', 'example' => '123123', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'instanceType' => ['description' => 'Resource Type: '."\n"
+ .'- INCIDENT: management event image. '."\n"
+ .'- ALERT: Alerting image. '."\n"
+ .'- PROBLEM: Problem image. ', 'example' => 'INCIDENT', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'files' => [
+ 'description' => 'List of image files. ',
+ 'items' => [
+ 'properties' => [
+ 'fileName' => ['description' => 'Image name.', 'example' => '文件', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'fileType' => ['description' => 'The following image types are supported:'."\n"
+ .'- JPEG'."\n"
+ .'- PNG'."\n"
+ .'- GIF', 'example' => 'JPG', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'fileSize' => ['description' => 'File size in bytes.', 'example' => '100', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'description' => 'List of image files. ',
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'type' => 'integer',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
],
'required' => false,
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -8763,50 +5180,88 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'title' => 'requestId',
- 'type' => 'string',
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd', 'title' => 'Id of the request', 'type' => 'string'],
+ 'data' => [
+ 'description' => 'data',
+ 'properties' => [
+ 'bucketName' => ['description' => 'oss bucket name', 'example' => 'gam-objects-bucket', 'title' => 'oss bucket name', 'type' => 'string'],
+ 'policy' => ['description' => 'policy', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19', 'title' => 'policy', 'type' => 'string'],
+ 'signature' => ['description' => 'signature', 'example' => 'SHqvIkwUNQd8Hervklir*****', 'title' => 'signature', 'type' => 'string'],
+ 'accessKeyId' => ['description' => 'accessKeyId', 'example' => 'LTAI****************', 'title' => 'accessKeyId', 'type' => 'string'],
+ 'url' => ['description' => 'url', 'example' => 'https://*****-bucket.oss-cn-shanghai.aliyuncs.com', 'title' => 'url', 'type' => 'string'],
+ 'files' => [
+ 'description' => 'files',
+ 'items' => [
+ 'properties' => [
+ 'fileName' => ['description' => 'Image name. ', 'example' => '文件A', 'title' => '', 'type' => 'string'],
+ 'fileType' => ['description' => 'Image type.', 'example' => 'JPG', 'title' => '', 'type' => 'string'],
+ 'fileSize' => ['description' => 'Image size. ', 'example' => '100', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'key' => ['description' => 'oss key', 'example' => 'problem/25a2316c-b08d-41a5-9f41-*****', 'title' => 'oss key', 'type' => 'string'],
+ ],
+ 'type' => 'object',
+ 'description' => 'Image list. ',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => 'files',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ ],
+ 'title' => 'data',
+ 'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSubscriptionResponse>\\n <requestId>7C56D225-7C34-40BB-9624-C8BA449260E6</requestId>\\n</DeleteSubscriptionResponse>","errorExample":""}]',
- ],
- 'EnableSubscription' => [
- 'summary' => '启用通知订阅',
- 'path' => '/notify/subscription/enable',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"e2d4306a-bf4d-4345-9ae6-158223c85dbd\\",\\n \\"data\\": {\\n \\"bucketName\\": \\"gam-objects-bucket\\",\\n \\"policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19\\",\\n \\"signature\\": \\"SHqvIkwUNQd8Hervklir*****\\",\\n \\"accessKeyId\\": \\"LTAI****************\\",\\n \\"url\\": \\"https://*****-bucket.oss-cn-shanghai.aliyuncs.com\\",\\n \\"files\\": [\\n {\\n \\"fileName\\": \\"文件A\\",\\n \\"fileType\\": \\"JPG\\",\\n \\"fileSize\\": 100,\\n \\"key\\": \\"problem/25a2316c-b08d-41a5-9f41-*****\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Generate Image Upload Signature Information ',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-08T11:07:03.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'gemp:GeneratePictureUploadSign',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GeneratePictureUploadSign'],
+ ],
+ ],
+ ],
+ 'GenerateProblemPictureLink' => [
+ 'summary' => 'Obtain the fault image links.',
+ 'path' => '/problem/process/oss/getPresignedLink',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempJPZI30',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZB7ZAW'],
],
'parameters' => [
[
@@ -8816,17 +5271,20 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'subscriptionId' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
+ 'keys' => [
+ 'description' => 'oss key',
+ 'items' => ['description' => 'keys', 'example' => 'problem/38b2a7893-484d-8989-b9cf-d243e53a82c6', 'required' => false, 'type' => 'string', 'title' => ''],
'required' => false,
- 'type' => 'integer',
+ 'title' => 'oss key',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'problemId' => ['description' => 'Fault ID.', 'example' => '50002021', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -8835,63 +5293,84 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'type' => 'string',
+ 'requestId' => ['description' => 'requestId', 'example' => 'c26f36de-1ec8-496a-a828-88067879ef81', 'title' => 'requestId', 'type' => 'string'],
+ 'data' => [
+ 'description' => 'data',
+ 'properties' => [
+ 'links' => [
+ 'description' => 'List of image links.',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'key' => ['description' => 'oss key', 'example' => 'problem/xxxxxxxxxx-484d-4242-b9cf-xxxxxxxxxx', 'title' => 'oss key', 'type' => 'string'],
+ 'link' => ['description' => 'Image link.', 'example' => 'http://xxxx-xxxx-bucket.oss-cn-xxxx.aliyuncs.com/pxxxx/38xxxxd-4789-4242-b9cfxxxxxxxxc6?Expires=1xxxxxxxxxx7&OSSAccessKeyId=xxxxxxxxxxxxxx7&Signature=xxxxxxxxxxxxxxxxxxxxxx', 'title' => '', 'type' => 'string'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NotifySubsAlreadyEnable',
- 'errorMessage' => 'The specified subscription is already enabled.',
- ],
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-88067879ef81\\",\\n \\"data\\": {\\n \\"links\\": [\\n {\\n \\"key\\": \\"problem/xxxxxxxxxx-484d-4242-b9cf-xxxxxxxxxx\\",\\n \\"link\\": \\"http://xxxx-xxxx-bucket.oss-cn-xxxx.aliyuncs.com/pxxxx/38xxxxd-4789-4242-b9cfxxxxxxxxc6?Expires=1xxxxxxxxxx7&OSSAccessKeyId=xxxxxxxxxxxxxx7&Signature=xxxxxxxxxxxxxxxxxxxxxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain the fault image links',
+ 'changeSet' => [],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'NotifySubsNotExists',
- 'errorMessage' => 'The specified subscription does not exist.',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GenerateProblemPictureLink',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableSubscriptionResponse>\\n <requestId>7C56D225-7C34-40BB-9624-C8BA449260E6</requestId>\\n</EnableSubscriptionResponse>","errorExample":""}]',
- ],
- 'UpdateSubscription' => [
- 'summary' => '更新通知订阅',
- 'path' => '/notify/subscription/update',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateProblemPictureLink'],
+ ],
],
+ ],
+ 'GenerateProblemPictureUploadSign' => [
+ 'summary' => 'Obtain signature information for uploading fault images. ',
+ 'path' => '/problem/process/oss/generatePostPolicy',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempJPZI30',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp4EPB1U'],
],
'parameters' => [
[
@@ -8901,236 +5380,15 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'subscriptionId' => [
- 'description' => '',
- 'example' => '80002020',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '主键',
- 'type' => 'integer',
- ],
- 'subscriptionTitle' => [
- 'description' => '',
- 'example' => 'newSubs244',
- 'required' => true,
- 'title' => '通知订阅名称',
- 'type' => 'string',
- ],
- 'scope' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'required' => true,
- 'title' => '订阅范围类型',
- 'type' => 'string',
- ],
- 'notifyObjectType' => [
- 'description' => '',
- 'example' => 'USER',
- 'required' => true,
- 'title' => '通知对象类型',
- 'type' => 'string',
- ],
- 'expiredType' => [
- 'description' => '',
- 'example' => 'LONG_TERM',
- 'required' => true,
- 'title' => '订阅时效',
- 'type' => 'string',
- ],
- 'period' => [
- 'description' => '',
- 'example' => '1个月',
- 'required' => false,
- 'title' => '时间段字符串',
- 'type' => 'string',
- ],
- 'scopeObjectList' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '主键id',
- 'type' => 'integer',
- ],
- 'scopeObjectId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '订阅范围对象id',
- 'type' => 'integer',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '订阅范围列表',
- 'type' => 'array',
- ],
- 'notifyObjectList' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '主键id',
- 'type' => 'integer',
- ],
- 'notifyObjectId' => [
- 'description' => '',
- 'example' => '19',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '通知对象id',
- 'type' => 'integer',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '通知对象列表',
- 'type' => 'array',
- ],
- 'notifyStrategyList' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'instanceType' => [
- 'description' => '',
- 'example' => 'INCIDENT',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '订阅实例类型,事件、报警、故障',
- 'type' => 'integer',
- ],
- 'strategies' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '10',
- 'required' => false,
- 'title' => 'id',
- 'type' => 'string',
- ],
- 'channels' => [
- 'description' => '',
- 'example' => 'SMS,WEIXIN_GROUP',
- 'required' => false,
- 'title' => '故障等级',
- 'type' => 'string',
- ],
- 'conditions' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'level' => [
- 'description' => '',
- 'example' => 'P1',
- 'required' => false,
- 'title' => '等级',
- 'type' => 'string',
- ],
- 'effection' => [
- 'description' => '',
- 'example' => 'HIGH',
- 'required' => false,
- 'title' => '影响程度',
- 'type' => 'string',
- ],
- 'problemNotifyType' => [
- 'description' => '',
- 'example' => 'PROBLEM_NOTIFY',
- 'required' => false,
- 'title' => '故障通知类型',
- 'type' => 'string',
- ],
- 'action' => [
- 'description' => '',
- 'example' => 'INCIDENT_TRIGGER',
- 'required' => false,
- 'title' => '事件动作',
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '影响程度',
- 'type' => 'array',
- ],
- 'periodChannel' => [
- 'description' => '',
- 'properties' => [
- 'workday' => [
- 'description' => '',
- 'example' => 'SMS,WEIXIN_GROUP',
- 'required' => false,
- 'title' => '工作时间',
- 'type' => 'string',
- ],
- 'nonWorkday' => [
- 'description' => '',
- 'example' => 'SMS,WEIXIN_GROUP',
- 'required' => false,
- 'title' => '非工作时间',
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- 'title' => '分时段通知渠道',
- 'type' => 'object',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '通知策略',
- 'type' => 'array',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '通知策略列表',
- 'type' => 'array',
- ],
- 'startTime' => [
- 'description' => '',
- 'example' => '2021-04-04 10:10:11',
- 'required' => false,
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'description' => '',
- 'example' => '2022-05-09 10:10:23',
- 'required' => false,
- 'title' => '结束时间',
- 'type' => 'string',
- ],
+ 'fileName' => ['description' => 'File name. ', 'example' => 'test', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'fileType' => ['description' => 'File type. ', 'example' => 'png', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'fileSize' => ['description' => 'File size unit (KB). ', 'example' => '1000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'problemId' => ['description' => 'Problem ID. ', 'example' => '67876', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -9139,63 +5397,71 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'type' => 'string',
+ 'requestId' => ['description' => 'requestId', 'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd', 'title' => 'requestId', 'type' => 'string'],
+ 'data' => [
+ 'description' => 'data',
+ 'properties' => [
+ 'bucketName' => ['description' => 'oss bucket name', 'example' => 'xxxx-xxxx-xxxx', 'title' => 'oss bucket name', 'type' => 'string'],
+ 'key' => ['description' => 'oss key', 'example' => 'problem/xxxxxxxxxxxxxxxx1-b3185d529277', 'title' => 'oss key', 'type' => 'string'],
+ 'policy' => ['description' => 'policy', 'example' => 'eyJleHBpcmF0a0p0IjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19', 'title' => 'policy', 'type' => 'string'],
+ 'signature' => ['description' => 'signature', 'example' => 'SHqvIkwUNQd0o0rvklir2K8U+ts=', 'title' => 'signature', 'type' => 'string'],
+ 'url' => ['description' => 'url', 'example' => 'https://xxx-xxx-bucket.oss-cn-shanghai.aliyuncs.com', 'title' => 'url', 'type' => 'string'],
+ 'accessKeyId' => ['description' => 'ossaccessKeyId', 'example' => 'XXXXXXXH8GMy1iLRCno7', 'title' => 'ossaccessKeyId', 'type' => 'string'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NotifySubsAlreadyExists',
- 'errorMessage' => 'The specified subscription already exists.',
- ],
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"e2d4306a-bf4d-4345-9ae6-158223c85dbd\\",\\n \\"data\\": {\\n \\"bucketName\\": \\"xxxx-xxxx-xxxx\\",\\n \\"key\\": \\"problem/xxxxxxxxxxxxxxxx1-b3185d529277\\",\\n \\"policy\\": \\"eyJleHBpcmF0a0p0IjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19\\",\\n \\"signature\\": \\"SHqvIkwUNQd0o0rvklir2K8U+ts=\\",\\n \\"url\\": \\"https://xxx-xxx-bucket.oss-cn-shanghai.aliyuncs.com\\",\\n \\"accessKeyId\\": \\"XXXXXXXH8GMy1iLRCno7\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain signature information for uploading fault images ',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-15T11:46:18.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'NotifySubsNotExists',
- 'errorMessage' => 'The specified subscription does not exist.',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GenerateProblemPictureUploadSign',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateSubscriptionResponse>\\n <requestId>7C56D225-7C34-40BB-9624-C8BA449260E6</requestId>\\n</UpdateSubscriptionResponse>","errorExample":""}]',
- ],
- 'GetSubscription' => [
- 'summary' => '通知订阅详情',
- 'path' => '/notify/subscription/detail',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateProblemPictureUploadSign'],
+ ],
],
+ ],
+ 'GetEscalationPlan' => [
+ 'summary' => 'Retrieve detailed information about a specified dynamic lookup table.',
+ 'path' => '/escalationPlan/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp2C8J2M',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempGUN0ZL'],
],
'parameters' => [
[
@@ -9205,400 +5471,221 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'subscriptionId' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'notFilterScopeObjectDeleted' => [
- 'title' => '不过滤已删除订阅范围对象(为true时,已删除过滤对象也会查到)',
- 'type' => 'boolean',
- ],
+ 'escalationPlanId' => ['description' => 'Escalation plan ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '345', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotency token', 'type' => 'string', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST'],
'data' => [
- 'description' => 'Object',
+ 'description' => 'Data',
'properties' => [
- 'subscriptionId' => [
- 'description' => '',
- 'example' => '68',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'subscriptionTitle' => [
- 'description' => '',
- 'example' => 'newTitle',
- 'title' => '通知订阅名称',
- 'type' => 'string',
- ],
- 'scope' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'title' => '0 全部 1服务 2 流转规则',
- 'type' => 'string',
- ],
- 'notifyObjectType' => [
- 'description' => '',
- 'example' => 'USER',
- 'title' => '0服务组 1个人',
- 'type' => 'string',
- ],
- 'expiredType' => [
- 'description' => '',
- 'example' => 'LONG_TERM',
- 'title' => '有效期类型 0 长期 1短期',
- 'type' => 'string',
- ],
- 'period' => [
- 'description' => '',
- 'example' => '1个月',
- 'title' => '时间段字符串',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'description' => '',
- 'example' => '2020-05-9 10:10:10',
- 'title' => '时效开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'description' => '',
- 'example' => '2021-08-9 10:10:10',
- 'title' => '时效结束时间',
- 'type' => 'string',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'ENABLE',
- 'title' => '1 启用 0禁用',
- 'type' => 'string',
- ],
- 'scopeObjectList' => [
- 'description' => 'Array',
+ 'escalationPlanId' => ['description' => 'Escalation plan ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2345', 'title' => ''],
+ 'escalationPlanName' => ['description' => 'Escalation plan name', 'type' => 'string', 'example' => '升级计划234', 'title' => ''],
+ 'escalationPlanDescription' => ['description' => 'Escalation plan description', 'type' => 'string', 'example' => '描述1234', 'title' => ''],
+ 'escalationPlanScopeObjects' => [
+ 'description' => 'Escalation plan scope objects',
'items' => [
'description' => 'Object',
'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => 'id主键',
- 'type' => 'integer',
- ],
- 'scope' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'title' => '订阅范围类型 0 全部 1服务 2 流转规则',
- 'type' => 'string',
- ],
- 'scopeObjectId' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '订阅范围对象关联表主键id',
- 'type' => 'integer',
- ],
- 'scopeObject' => [
- 'description' => '',
- 'example' => '',
- 'title' => '订阅范围对象名称',
- 'type' => 'string',
- ],
- 'isValid' => [
- 'title' => '是否有效 0无效 1有效',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'scopeObjectId' => ['description' => 'Scope object ID', 'type' => 'integer', 'format' => 'int64', 'example' => '234', 'title' => ''],
+ 'scope' => ['description' => 'Scope object type', 'type' => 'string', 'example' => 'SERVICE', 'title' => ''],
+ 'scopeObjectName' => ['description' => 'Scope object name', 'type' => 'string', 'example' => 'xx服务', 'title' => ''],
+ 'escalationPlanScopeObjects' => ['description' => 'Service deletion flag. 1: active. 0: deleted.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'scopeObjectDeletedType' => ['description' => 'Service deletion flag. 1: active. 0: deleted.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
- 'notifyObjectList' => [
- 'description' => '',
+ 'escalationPlanRules' => [
+ 'description' => 'Escalation plan rules',
'items' => [
'description' => 'Object',
'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '23',
- 'format' => 'int64',
- 'title' => 'id主键',
- 'type' => 'integer',
- ],
- 'notifyObjectType' => [
- 'description' => '',
- 'example' => 'USER',
- 'format' => 'int64',
- 'title' => '通知对象类型0服务组 1个人',
- 'type' => 'integer',
- ],
- 'notifyObjectId' => [
- 'description' => '',
- 'example' => '19',
- 'format' => 'int64',
- 'title' => '关联主键id',
- 'type' => 'integer',
- ],
- 'name' => [
- 'description' => '',
- 'example' => 'TestName',
- 'title' => '通知对象名',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '通知对象列表',
- 'type' => 'array',
- ],
- 'notifyStrategyList' => [
- 'description' => '',
- 'items' => [
- 'description' => 'Object'."\n",
- 'properties' => [
- 'instanceType' => [
- 'description' => '',
- 'example' => 'INCIDENT',
- 'format' => 'int64',
- 'title' => '订阅实例类型,0事件、1报警、2故障',
- 'type' => 'integer',
+ 'escalationPlanRuleId' => ['description' => 'Escalation plan rule ID', 'type' => 'integer', 'format' => 'int64', 'example' => '345', 'title' => ''],
+ 'escalationPlanConditions' => [
+ 'description' => 'Escalation plan conditions',
+ 'items' => [
+ 'description' => 'Object',
+ 'properties' => [
+ 'level' => ['description' => 'Event level', 'type' => 'string', 'example' => 'P1', 'title' => ''],
+ 'effection' => ['description' => 'Impact level', 'type' => 'string', 'example' => 'LOW', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'strategies' => [
- 'description' => '',
+ 'escalationPlanStrategies' => [
+ 'description' => 'Escalation plan strategies',
'items' => [
'description' => 'Object',
'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '12',
- 'format' => 'int64',
- 'title' => '策略主键',
- 'type' => 'integer',
- ],
- 'channels' => [
- 'description' => '',
- 'example' => 'SMS',
- 'title' => '通知渠道',
- 'type' => 'string',
- ],
- 'conditions' => [
- 'description' => '',
+ 'noticeTime' => ['description' => 'Notification time (minutes)', 'type' => 'integer', 'format' => 'int64', 'example' => '40', 'title' => ''],
+ 'escalationPlanType' => ['description' => 'Escalation plan type', 'type' => 'string', 'example' => 'UN_ACKNOWLEDGE', 'title' => ''],
+ 'noticeObjectList' => [
+ 'description' => 'Notification recipients',
'items' => [
'description' => 'Object',
'properties' => [
- 'effection' => [
- 'description' => '',
- 'example' => 'HIGH',
- 'title' => '影响范围',
- 'type' => 'string',
- ],
- 'problemNotifyType' => [
- 'description' => '',
- 'example' => 'PROBLEM_NOTIFY',
- 'title' => '故障通知类型',
- 'type' => 'string',
- ],
- 'level' => [
- 'description' => '',
- 'example' => 'P1',
- 'title' => '等级',
- 'type' => 'string',
- ],
- 'action' => [
- 'description' => '',
- 'example' => 'INCIDENT_TRIGGER',
- 'title' => '事件动作',
- 'type' => 'string',
- ],
+ 'noticeObjectId' => ['description' => 'Notification recipient ID', 'type' => 'integer', 'format' => 'int64', 'example' => '234', 'title' => ''],
+ 'noticeObjectName' => ['description' => 'Notification recipient name', 'type' => 'string', 'example' => '张老三', 'title' => ''],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '条件',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
- 'periodChannel' => [
- 'description' => '',
- 'properties' => [
- 'workday' => [
- 'description' => '',
- 'example' => 'DINGDING',
- 'title' => '工作时间',
- 'type' => 'string',
+ 'noticeChannels' => ['description' => 'Notification channel', 'type' => 'string', 'example' => 'SMS', 'title' => ''],
+ 'enableWebhook' => ['description' => 'Enable group notifications', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'serviceGroups' => [
+ 'description' => 'Service groups',
+ 'items' => [
+ 'properties' => [
+ 'id' => ['description' => 'Service group ID', 'type' => 'integer', 'format' => 'int64', 'example' => '343', 'title' => ''],
+ 'serviceGroupName' => ['description' => 'Service group name', 'type' => 'string', 'example' => 'VCD是', 'title' => ''],
],
- 'nonWorkday' => [
- 'description' => '',
- 'example' => 'DINGDING',
- 'title' => '非工作时间',
- 'type' => 'string',
+ 'type' => 'object',
+ 'description' => 'Service group',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'noticeObjects' => [
+ 'description' => 'Notification recipients',
+ 'type' => 'array',
+ 'items' => ['description' => 'Notification recipient ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'noticeRoleList' => [
+ 'description' => 'Role IDs',
+ 'type' => 'array',
+ 'items' => ['description' => 'The list of role IDs.', 'type' => 'integer', 'format' => 'int64', 'example' => '222', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'noticeRoleObjectList' => [
+ 'description' => 'Role objects',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A list of role objects.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'Notification recipient ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => ''],
+ 'name' => ['description' => 'Notification recipient name', 'type' => 'string', 'example' => 'XX服务组', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '分时间段渠道',
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '策略',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '通知策略列表',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
+ 'createTime' => ['description' => 'Creation time', 'type' => 'string', 'example' => '2021-09-09 09:09:09', 'title' => ''],
+ 'isGlobal' => ['title' => 'Indicates whether it is a global policy ', 'description' => 'Is global policy. true: yes. false: no.', 'type' => 'boolean', 'default' => 'false', 'example' => 'true'],
],
+ 'title' => 'data',
'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'NotifySubsNotExists',
- 'errorMessage' => 'The specified subscription does not exist.',
- ],
+ ['errorCode' => 'EscalationPlanNotExists', 'errorMessage' => 'The specified escalation plan does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"subscriptionId\\": 68,\\n \\"subscriptionTitle\\": \\"newTitle\\",\\n \\"scope\\": \\"SERVICE\\",\\n \\"notifyObjectType\\": \\"USER\\",\\n \\"expiredType\\": \\"LONG_TERM\\",\\n \\"period\\": \\"1个月\\",\\n \\"startTime\\": \\"2020-05-09 10:10:10\\",\\n \\"endTime\\": \\"2021-08-09 10:10:10\\",\\n \\"status\\": \\"ENABLE\\",\\n \\"scopeObjectList\\": [\\n {\\n \\"id\\": 10,\\n \\"scope\\": \\"SERVICE\\",\\n \\"scopeObjectId\\": 10,\\n \\"scopeObject\\": \\"阿里云\\",\\n \\"isValid\\": 1\\n }\\n ],\\n \\"notifyObjectList\\": [\\n {\\n \\"id\\": 23,\\n \\"notifyObjectType\\": 0,\\n \\"notifyObjectId\\": 19,\\n \\"name\\": \\"TestName\\"\\n }\\n ],\\n \\"notifyStrategyList\\": [\\n {\\n \\"instanceType\\": 0,\\n \\"strategies\\": [\\n {\\n \\"id\\": 12,\\n \\"channels\\": \\"SMS\\",\\n \\"conditions\\": [\\n {\\n \\"effection\\": \\"HIGH\\",\\n \\"problemNotifyType\\": \\"PROBLEM_NOTIFY\\",\\n \\"level\\": \\"P1\\",\\n \\"action\\": \\"INCIDENT_TRIGGER\\"\\n }\\n ],\\n \\"periodChannel\\": {\\n \\"workday\\": \\"DINGDING\\",\\n \\"nonWorkday\\": \\"DINGDING\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSubscriptionResponse>\\n <requestId>10REQUES-AC5C-4B59-BE11-378F117A6A88</requestId>\\n <data>\\n <subscriptionId>68</subscriptionId>\\n <subscriptionTitle>newTitle</subscriptionTitle>\\n <scope>SERVICE</scope>\\n <notifyObjectType>USER</notifyObjectType>\\n <expiredType>LONG_TERM</expiredType>\\n <period>1个月</period>\\n <startTime>2020-05-9 10:10:10</startTime>\\n <endTime>2021-08-9 10:10:10</endTime>\\n <status>ENABLE</status>\\n <scopeObjectList>\\n <id>10</id>\\n <scope>SERVICE</scope>\\n <scopeObjectId>10</scopeObjectId>\\n <scopeObject>阿里云</scopeObject>\\n </scopeObjectList>\\n <notifyObjectList>\\n <id>23</id>\\n <notifyObjectId>19</notifyObjectId>\\n <name>TestName</name>\\n </notifyObjectList>\\n <notifyStrategyList>\\n <strategies>\\n <id>12</id>\\n <channels>SMS</channels>\\n <conditions>\\n <effection>HIGH</effection>\\n <problemNotifyType>PROBLEM_NOTIFY</problemNotifyType>\\n <level>P1</level>\\n <action>INCIDENT_TRIGGER</action>\\n </conditions>\\n <periodChannel>\\n <workday>DINGDING</workday>\\n <nonWorkday>DINGDING</nonWorkday>\\n </periodChannel>\\n </strategies>\\n </notifyStrategyList>\\n </data>\\n</GetSubscriptionResponse>","errorExample":""}]',
- ],
- 'DisableSubscription' => [
- 'summary' => '禁用集成配置',
- 'path' => '/notify/subscription/doDisable',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempM00V6L',
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\",\\n \\"data\\": {\\n \\"escalationPlanId\\": 2345,\\n \\"escalationPlanName\\": \\"升级计划234\\",\\n \\"escalationPlanDescription\\": \\"描述1234\\",\\n \\"escalationPlanScopeObjects\\": [\\n {\\n \\"scopeObjectId\\": 234,\\n \\"scope\\": \\"SERVICE\\",\\n \\"scopeObjectName\\": \\"xx服务\\",\\n \\"escalationPlanScopeObjects\\": 1,\\n \\"scopeObjectDeletedType\\": 1\\n }\\n ],\\n \\"escalationPlanRules\\": [\\n {\\n \\"escalationPlanRuleId\\": 345,\\n \\"escalationPlanConditions\\": [\\n {\\n \\"level\\": \\"P1\\",\\n \\"effection\\": \\"LOW\\"\\n }\\n ],\\n \\"escalationPlanStrategies\\": [\\n {\\n \\"noticeTime\\": 40,\\n \\"escalationPlanType\\": \\"UN_ACKNOWLEDGE\\",\\n \\"noticeObjectList\\": [\\n {\\n \\"noticeObjectId\\": 234,\\n \\"noticeObjectName\\": \\"张老三\\"\\n }\\n ],\\n \\"noticeChannels\\": \\"SMS\\",\\n \\"enableWebhook\\": true,\\n \\"serviceGroups\\": [\\n {\\n \\"id\\": 343,\\n \\"serviceGroupName\\": \\"VCD是\\"\\n }\\n ],\\n \\"noticeObjects\\": [\\n 111\\n ],\\n \\"noticeRoleList\\": [\\n 222\\n ],\\n \\"noticeRoleObjectList\\": [\\n {\\n \\"id\\": 111,\\n \\"name\\": \\"XX服务组\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"createTime\\": \\"2021-09-09 09:09:09\\",\\n \\"isGlobal\\": true\\n }\\n}","type":"json"}]',
+ 'title' => 'Escalation Plan Details',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:53.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-06-07T11:52:18.000Z', 'description' => 'Response parameters changed'],
],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'A short description of struct',
- 'properties' => [
- 'subscriptionId' => [
- 'description' => '',
- 'example' => '89',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetEscalationPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => false,
- 'title' => 'A short description of struct',
- 'type' => 'object',
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => 'Schema of Response',
- 'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'type' => 'string',
- ],
- ],
- 'title' => 'Schema of Response',
- 'type' => 'object',
- ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEscalationPlan'],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NotifySubsAlreadyDisable',
- 'errorMessage' => 'The specified subscription is already disabled.',
- ],
- ],
- [
- [
- 'errorCode' => 'NotifySubsNotExists',
- 'errorMessage' => 'The specified subscription does not exist.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableSubscriptionResponse>\\n <requestId>7C56D225-7C34-40BB-9624-C8BA449260E6</requestId>\\n</DisableSubscriptionResponse>","errorExample":""}]',
],
- 'ListSubscriptions' => [
- 'summary' => '通知订阅列表',
- 'path' => '/notify/subscription/list',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetEvent' => [
+ 'summary' => 'Query the most recent alert.',
+ 'path' => '/events/getLastTimeEvent',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp2C8J2M',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempERNU0Z'],
],
'parameters' => [
[
@@ -9608,72 +5695,12 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '第几页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '一页几条',
- 'type' => 'integer',
- ],
- 'subscriptionTitle' => [
- 'description' => '',
- 'example' => 'newTitle',
- 'required' => false,
- 'title' => '通知订阅名',
- 'type' => 'string',
- ],
- 'scope' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'required' => false,
- 'title' => '订阅范围类型 0全部1服务2流转规则',
- 'type' => 'string',
- ],
- 'scopeObject' => [
- 'description' => '',
- 'example' => 'TestName',
- 'required' => false,
- 'title' => '订阅范围对象名称',
- 'type' => 'string',
- ],
- 'notifyObjectType' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'required' => false,
- 'title' => '通知对象类型notifyWhoType:0服务组 1个人',
- 'type' => 'string',
- ],
- 'notifyObject' => [
- 'description' => '',
- 'example' => 'test',
- 'required' => false,
- 'title' => '通知对象名',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
- 'required' => false,
- 'title' => '幂等参数',
- 'type' => 'string',
- ],
- 'notFilterScopeObjectDeleted' => [
- 'title' => '不过滤已删除订阅范围对象(为true时,已删除过滤对象也会查到)',
- 'type' => 'boolean',
- ],
+ 'monitorSourceId' => ['description' => 'Monitor source ID cannot be empty.', 'example' => '1', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -9682,215 +5709,67 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'title' => 'id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'XXXXXXXXXXXX', 'title' => 'Id of the request', 'type' => 'string'],
'data' => [
- 'description' => 'data',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'subscriptionId' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '订阅id',
- 'type' => 'integer',
- ],
- 'subscriptionTitle' => [
- 'description' => '',
- 'example' => 'test',
- 'title' => '通知订阅名称',
- 'type' => 'string',
- ],
- 'scope' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'format' => 'int64',
- 'title' => '0 全部 1服务 2 流转规则',
- 'type' => 'integer',
- ],
- 'notifyObjectType' => [
- 'description' => '',
- 'example' => 'USER',
- 'format' => 'int64',
- 'title' => '0服务组 1个人',
- 'type' => 'integer',
- ],
- 'expiredType' => [
- 'description' => '',
- 'example' => 'LONG_TERM',
- 'title' => '有效期类型 0 长期 1短期',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'description' => '',
- 'example' => '2020-05-09 10:10:10',
- 'title' => '时效开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'description' => '',
- 'example' => '2022-05-09 10:10:10',
- 'title' => '时效结束时间',
- 'type' => 'string',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'ENABLE',
- 'title' => 'ENABLE 启用 DISABLE禁用',
- 'type' => 'string',
- ],
- 'scopeObjectList' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => 'id主键',
- 'type' => 'integer',
- ],
- 'scope' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'format' => 'int64',
- 'title' => '订阅范围类型 ALL全部 SERVICE服务 ROUTETULE流转规则',
- 'type' => 'integer',
- ],
- 'scopeObjectId' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '订阅范围对象关联表主键id',
- 'type' => 'integer',
- ],
- 'scopeObject' => [
- 'description' => '',
- 'example' => '阿里云服务',
- 'title' => '订阅范围对象名称',
- 'type' => 'string',
- ],
- 'isValid' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '订阅范围列表',
- 'type' => 'array',
- ],
- 'notifyObjectList' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => 'id主键',
- 'type' => 'integer',
- ],
- 'notifyObjectType' => [
- 'description' => '',
- 'example' => 'USER',
- 'format' => 'int64',
- 'title' => '通知对象类型0服务组 1个人',
- 'type' => 'integer',
- ],
- 'notifyObjectId' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '关联主键id',
- 'type' => 'integer',
- ],
- 'name' => [
- 'description' => '',
- 'example' => '张珊',
- 'title' => '通知对象名',
- 'type' => 'string',
- ],
- 'isValid' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '通知对象列表',
- 'type' => 'array',
- ],
- ],
- 'type' => 'object',
+ 'description' => 'Return Result.',
+ 'properties' => [
+ 'monitorSourceId' => ['description' => 'Alert source ID.', 'example' => '1', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'monitorSourceName' => ['description' => 'Alert source name.', 'example' => 'zabbix', 'title' => '', 'type' => 'string'],
+ 'eventTime' => ['description' => 'Alert reporting time.', 'example' => '2002-09-08 15:30:35', 'title' => '', 'type' => 'string'],
+ 'eventJson' => ['description' => 'Alert content.', 'example' => '“”', 'title' => '', 'type' => 'string'],
],
- 'type' => 'array',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '分页参数',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '分页参数',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '分页参数',
- 'type' => 'integer',
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": [\\n {\\n \\"subscriptionId\\": 10,\\n \\"subscriptionTitle\\": \\"test\\",\\n \\"scope\\": 0,\\n \\"notifyObjectType\\": 0,\\n \\"expiredType\\": \\"LONG_TERM\\",\\n \\"startTime\\": \\"2020-05-09 10:10:10\\",\\n \\"endTime\\": \\"2022-05-09 10:10:10\\",\\n \\"status\\": \\"ENABLE\\",\\n \\"scopeObjectList\\": [\\n {\\n \\"id\\": 10,\\n \\"scope\\": 0,\\n \\"scopeObjectId\\": 10,\\n \\"scopeObject\\": \\"阿里云服务\\",\\n \\"isValid\\": 0\\n }\\n ],\\n \\"notifyObjectList\\": [\\n {\\n \\"id\\": 10,\\n \\"notifyObjectType\\": 0,\\n \\"notifyObjectId\\": 10,\\n \\"name\\": \\"张珊\\",\\n \\"isValid\\": 0\\n }\\n ]\\n }\\n ],\\n \\"totalCount\\": 100,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListSubscriptionsResponse>\\n <requestId>10REQUES-AC5C-4B59-BE11-378F117A6A88</requestId>\\n <data>\\n <subscriptionId>10</subscriptionId>\\n <subscriptionTitle>test</subscriptionTitle>\\n <expiredType>LONG_TERM</expiredType>\\n <startTime>2020-05-09 10:10:10</startTime>\\n <endTime>2022-05-09 10:10:10</endTime>\\n <status>ENABLE</status>\\n <scopeObjectList>\\n <id>10</id>\\n <scopeObjectId>10</scopeObjectId>\\n <scopeObject>阿里云服务</scopeObject>\\n </scopeObjectList>\\n <notifyObjectList>\\n <id>10</id>\\n <notifyObjectId>10</notifyObjectId>\\n <name>张珊</name>\\n </notifyObjectList>\\n </data>\\n <totalCount>100</totalCount>\\n <pageNumber>1</pageNumber>\\n <pageSize>10</pageSize>\\n</ListSubscriptionsResponse>","errorExample":""}]',
- ],
- 'CreateIncidentSubtotal' => [
- 'summary' => '新增事件小计',
- 'path' => '/incident/save/subtotal',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"XXXXXXXXXXXX\\",\\n \\"data\\": {\\n \\"monitorSourceId\\": 1,\\n \\"monitorSourceName\\": \\"zabbix\\",\\n \\"eventTime\\": \\"2002-09-08 15:30:35\\",\\n \\"eventJson\\": \\"“”\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Query the most recent alert',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetEvent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEvent'],
+ ],
],
+ ],
+ 'GetHomePageGuidance' => [
+ 'summary' => 'Query homepage guidance configuration.',
+ 'path' => '/guidance/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempHBPHMV',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempVWXIZC'],
],
'parameters' => [
[
@@ -9898,116 +5777,101 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'Query parameters for homepage guidance.',
'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '事件id',
- 'type' => 'integer',
- ],
- 'description' => [
- 'description' => '',
- 'example' => '描述',
- 'required' => false,
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'required' => false,
- 'title' => '幂等校验Id',
- 'type' => 'string',
- ],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '7564AA8A-7F49-594E-8E33-F43EB3875116'],
],
'required' => false,
+ 'title' => '',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'requestId',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'xxxxxx'],
'data' => [
- 'description' => 'data',
+ 'description' => 'Homepage guidance configuration.',
'properties' => [
- 'subtotalId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'title' => '小计Id',
- 'type' => 'integer',
- ],
+ 'serviceStatus' => ['description' => 'Service configuration status.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'usersStatus' => ['description' => 'User configuration status.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'serviceGroupStatus' => ['description' => 'Service group configuration status.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'notifySubscriptionStatus' => ['description' => 'Notification subscription configuration status.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IncidentStatusInvalid',
- 'errorMessage' => 'The incident status is invalid.',
- ],
- [
- 'errorCode' => 'IncidentUpdateInvalid',
- 'errorMessage' => 'The incident update is invalid.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxxxx\\",\\n \\"data\\": {\\n \\"serviceStatus\\": true,\\n \\"usersStatus\\": true,\\n \\"serviceGroupStatus\\": true,\\n \\"notifySubscriptionStatus\\": true\\n }\\n}","type":"json"}]',
+ 'title' => 'Query Home Page Configuration Guide',
+ 'requestParamsDescription' => '{'."\n"
+ .'"pageNumber": 1,'."\n"
+ .'"pageSize": 10,'."\n"
+ .'"clientToken": "89b3ed86-e8d6-43b4-82a6-a711055806eb"'."\n"
+ .'}',
+ 'responseParamsDescription' => '```'."\n"
+ .'{'."\n"
+ .' "data": {'."\n"
+ .' "usersStatus": true,'."\n"
+ .' "serviceStatus": true,'."\n"
+ .' "notifySubscriptionStatus": false,'."\n"
+ .' "serviceGroupStatus": true'."\n"
+ .' },'."\n"
+ .' "requestId": "CAB6E15D-ECE8-54A4-87C3-D701862DD4A2"'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2021-10-20T13:27:37.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetHomePageGuidance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 404 => [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
- ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHomePageGuidance'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"subtotalId\\": 123\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateIncidentSubtotalResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n <data>\\n <subtotalId>123</subtotalId>\\n </data>\\n</CreateIncidentSubtotalResponse>","errorExample":""}]',
],
- 'ListIncidentSubtotals' => [
- 'summary' => '查询事件小计',
- 'path' => '/incident/list/subtotal',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetIncident' => [
+ 'summary' => 'Event details.',
+ 'path' => '/incident/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZF76LB',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempJ0ENN8'],
],
'parameters' => [
[
@@ -10017,125 +5881,122 @@
'schema' => [
'description' => 'body',
'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '3123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '事件ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE62E59A2E9',
- 'required' => false,
- 'title' => '幂等校验',
- 'type' => 'string',
- ],
+ 'incidentId' => ['description' => 'The event ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '32113'],
+ 'clientToken' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef729f'],
],
'required' => false,
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef7291', 'title' => ''],
'data' => [
'description' => 'data',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'description' => [
- 'description' => '',
- 'example' => '',
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2021-06-23 00:00:00',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'createUserName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '操作人',
- 'type' => 'string',
- ],
- 'createUserPhone' => [
- 'description' => '',
- 'example' => '130****1111',
- 'title' => '操作人手机号',
- 'type' => 'string',
- ],
- 'createUserId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'title' => '操作人Id',
- 'type' => 'integer',
- ],
+ 'properties' => [
+ 'incidentId' => ['description' => 'The event ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3213', 'title' => ''],
+ 'routeRuleId' => ['description' => 'The routing rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3123', 'title' => ''],
+ 'routeRuleName' => ['description' => 'The name of the routing rule.', 'type' => 'string', 'example' => '流转规则A', 'title' => ''],
+ 'relatedServiceId' => ['description' => 'The ID of the associated service.', 'type' => 'integer', 'format' => 'int64', 'example' => '312312', 'title' => ''],
+ 'relatedServiceName' => ['description' => 'The name of the associated service.', 'type' => 'string', 'example' => '服务A', 'title' => ''],
+ 'relatedServiceDescription' => ['description' => 'The description of the associated service.', 'type' => 'string', 'example' => '关联服务描述', 'title' => ''],
+ 'incidentStatus' => ['description' => 'The status of the event. Valid values: ASSIGNED, RESPONDED, and FINISHED.', 'type' => 'string', 'example' => 'FINISHE', 'title' => ''],
+ 'incidentLevel' => ['description' => 'The level of the event. The levels are P1, P2, P3, and P4, in descending order of severity.', 'type' => 'string', 'example' => 'P4', 'title' => ''],
+ 'effect' => ['description' => 'The impact level. Valid values: HIGH and LOW.', 'type' => 'string', 'example' => 'LOW', 'title' => ''],
+ 'assignUserId' => ['description' => 'The ID of the user to whom the event is assigned.', 'type' => 'integer', 'format' => 'int64', 'example' => '12312', 'title' => ''],
+ 'assignUserName' => ['description' => 'The name of the user to whom the event is assigned. This name is obtained from the user table.', 'type' => 'string', 'example' => '小明', 'title' => ''],
+ 'assignUserPhone' => ['description' => 'The phone number of the user to whom the event is assigned.', 'type' => 'string', 'example' => '1390000****', 'title' => ''],
+ 'incidentNumber' => ['description' => 'The event number.', 'type' => 'string', 'example' => 'I3443831000000016247759753663894', 'title' => ''],
+ 'incidentTitle' => ['description' => 'The event title.', 'type' => 'string', 'example' => '事件标题', 'title' => ''],
+ 'createTime' => ['description' => 'The time when the event was created.', 'type' => 'string', 'example' => '2020-01-10 00:00:00', 'title' => ''],
+ 'isManual' => ['description' => 'The source of the event. A value of \\`true\\` indicates that the event was created manually. A value of \\`false\\` indicates that the event was created automatically.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'isUpgrade' => ['description' => 'Indicates whether the event was escalated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'incidentDescription' => ['description' => 'The event description.', 'type' => 'string', 'example' => '事件描述', 'title' => ''],
+ 'problemId' => ['description' => 'The problem ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '232113'],
+ 'problemNumber' => ['description' => 'The problem number.', 'type' => 'string', 'title' => '', 'example' => '3332113231453321'],
+ 'durationTime' => ['description' => 'The duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000000', 'title' => ''],
+ 'notifyChannels' => [
+ 'description' => 'The notification channels.',
+ 'example' => '1 短信 2 邮件 3 电话 4 企微群 5 钉钉群 6飞书 7 群通知 8 slack',
+ 'items' => ['type' => 'string', 'example' => 'WEBHOOK', 'description' => '', 'title' => ''],
+ 'title' => '',
+ 'type' => 'array',
],
- 'type' => 'object',
+ 'relatedServiceGroupName' => ['description' => 'The name of the associated service group.', 'type' => 'string', 'example' => '服务组A', 'title' => ''],
+ 'relatedServiceGroupId' => ['description' => 'The ID of the associated service group.', 'type' => 'integer', 'format' => 'int64', 'example' => '13000', 'title' => ''],
+ 'relServiceDeleteType' => ['description' => 'The service deletion field.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'relRouteRuleDeleteType' => ['description' => 'The rule deletion field.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'assignToWhoIsValid' => ['description' => 'Indicates whether the assigned user is valid. A value of 1 indicates that the user is valid. A value of 0 indicates that the user is invalid.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'relServiceGroupIsValid' => ['description' => 'Indicates whether the associated service group is valid. A value of 1 indicates that the group is valid. A value of 0 indicates that the group is invalid.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'defaultAssignToWhoName' => ['description' => 'The name of the default assignee.', 'type' => 'string', 'title' => '', 'example' => '小明'],
+ 'defaultAssignToWho' => ['description' => 'The ID of the default assignee.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1212'],
+ 'defaultAssignToWhoIsValid' => ['description' => 'The status of the default assignee. A value of 1 indicates that the assignee is normal. A value of 0 indicates that the assignee is deleted.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
],
- 'type' => 'array',
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2b63cdef-7ac3-4892-a76d-0f3389ef7291\\",\\n \\"data\\": {\\n \\"incidentId\\": 3213,\\n \\"routeRuleId\\": 3123,\\n \\"routeRuleName\\": \\"流转规则A\\",\\n \\"relatedServiceId\\": 312312,\\n \\"relatedServiceName\\": \\"服务A\\",\\n \\"relatedServiceDescription\\": \\"关联服务描述\\",\\n \\"incidentStatus\\": \\"FINISHE\\",\\n \\"incidentLevel\\": \\"P4\\",\\n \\"effect\\": \\"LOW\\",\\n \\"assignUserId\\": 12312,\\n \\"assignUserName\\": \\"小明\\",\\n \\"assignUserPhone\\": \\"1390000****\\",\\n \\"incidentNumber\\": \\"I3443831000000016247759753663894\\",\\n \\"incidentTitle\\": \\"事件标题\\",\\n \\"createTime\\": \\"2020-01-10 00:00:00\\",\\n \\"isManual\\": true,\\n \\"isUpgrade\\": true,\\n \\"incidentDescription\\": \\"事件描述\\",\\n \\"problemId\\": 232113,\\n \\"problemNumber\\": \\"3332113231453321\\",\\n \\"durationTime\\": 3000000,\\n \\"notifyChannels\\": [\\n \\"WEBHOOK\\"\\n ],\\n \\"relatedServiceGroupName\\": \\"服务组A\\",\\n \\"relatedServiceGroupId\\": 13000,\\n \\"relServiceDeleteType\\": 1,\\n \\"relRouteRuleDeleteType\\": 1,\\n \\"assignToWhoIsValid\\": 1,\\n \\"relServiceGroupIsValid\\": 1,\\n \\"defaultAssignToWhoName\\": \\"小明\\",\\n \\"defaultAssignToWho\\": 1212,\\n \\"defaultAssignToWhoIsValid\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'Management Event Details ',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-11T12:53:49.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIncident'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": [\\n {\\n \\"description\\": \\"小计描述\\",\\n \\"createTime\\": \\"2021-06-23 00:00:00\\",\\n \\"createUserName\\": \\"小明\\",\\n \\"createUserPhone\\": \\"130****1111\\",\\n \\"createUserId\\": 12312\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListIncidentSubtotalsResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n <data>\\n <description>小计描述</description>\\n <createTime>2021-06-23 00:00:00</createTime>\\n <createUserName>小明</createUserName>\\n <createUserPhone>130****1111</createUserPhone>\\n </data>\\n</ListIncidentSubtotalsResponse>","errorExample":""}]',
],
'GetIncidentListByIdList' => [
- 'summary' => '根据事件ID批量查询事件详情',
+ 'summary' => 'Queries the details of one or more incidents based on their IDs.',
'path' => '/incident/getIncidentListByIdList',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempJ0ENN8',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempJ0ENN8'],
],
'parameters' => [
[
@@ -10145,270 +6006,134 @@
'schema' => [
'description' => 'body',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'required' => false, 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'title' => ''],
'incidentIdList' => [
- 'description' => '',
- 'items' => [
- 'example' => '1122',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'description' => 'List of incident IDs.',
+ 'items' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1122', 'title' => ''],
'required' => false,
'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
],
'required' => false,
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
'data' => [
'description' => 'data',
'items' => [
- 'description' => '',
+ 'description' => 'Response data.',
'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '3213',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '10000',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'routeRuleName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'incidentStatus' => [
- 'description' => '',
- 'example' => 'FINISHE',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '213123',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'relatedServiceName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'effect' => [
- 'description' => '',
- 'example' => 'LOW',
- 'type' => 'string',
- ],
- 'assignUserId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'assignUserName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'assignUserPhone' => [
- 'description' => '',
- 'example' => '139****1111',
- 'type' => 'string',
- ],
- 'incidentTitle' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2010-03-09 15:53:45',
- 'type' => 'string',
- ],
- 'isManual' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'isUpgrade' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'incidentDescription' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'durationTime' => [
- 'description' => '',
- 'example' => '3000000',
- 'type' => 'string',
- ],
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3213', 'title' => ''],
+ 'routeRuleId' => ['description' => 'Routing rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ 'routeRuleName' => ['description' => 'Routing rule name.', 'type' => 'string', 'example' => '规则A', 'title' => ''],
+ 'incidentStatus' => ['description' => 'Incident status. Valid values: 0 (assigned), 1 (responded), 2 (resolved).', 'type' => 'string', 'example' => 'FINISHE', 'title' => ''],
+ 'relatedServiceId' => ['description' => 'Related service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '213123', 'title' => ''],
+ 'relatedServiceName' => ['description' => 'Related service name.', 'type' => 'string', 'example' => '服务A', 'title' => ''],
+ 'effect' => ['description' => 'Impact level. Valid values: HIGH, LOW.', 'type' => 'string', 'example' => 'LOW', 'title' => ''],
+ 'assignUserId' => ['description' => 'User ID assigned to the incident.', 'type' => 'integer', 'format' => 'int64', 'example' => '12312', 'title' => ''],
+ 'assignUserName' => ['description' => 'Name of the user assigned to the incident.', 'type' => 'string', 'example' => '小明', 'title' => ''],
+ 'assignUserPhone' => ['description' => 'Phone number of the user assigned to the incident.', 'type' => 'string', 'example' => '139****1111', 'title' => ''],
+ 'incidentTitle' => ['description' => 'Incident title.', 'type' => 'string', 'example' => '事件标题', 'title' => ''],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2010-03-09 15:53:45', 'title' => ''],
+ 'isManual' => ['description' => 'Indicates whether the incident was created manually. Valid values: true (manual), false (automatic).', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'isUpgrade' => ['description' => 'Indicates whether the incident was upgraded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'incidentDescription' => ['description' => 'Incident description.', 'type' => 'string', 'example' => '事件描述', 'title' => ''],
+ 'problemId' => ['description' => 'Problem ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12312', 'title' => ''],
+ 'durationTime' => ['description' => 'The duration of the incident.', 'type' => 'string', 'example' => '3000000', 'title' => ''],
'notifyChannels' => [
'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '[SMS,PHONE]',
- 'type' => 'string',
- ],
+ 'items' => ['description' => 'The channel for notifications.', 'type' => 'string', 'example' => '[SMS,PHONE]', 'title' => ''],
'type' => 'array',
- ],
- 'relatedServiceGroupName' => [
- 'description' => '',
+ 'title' => '',
'example' => '',
- 'type' => 'string',
- ],
- 'relatedServiceGroupId' => [
- 'description' => '',
- 'example' => '13000',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'relServiceDeleteType' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'relRouteRuleDeleteType' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'assignToWhoIsValid' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'relServiceGroupIsValid' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'defaultAssignToWhoName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'relatedServiceDescription' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'incidentLevel' => [
- 'description' => '',
- 'example' => 'P4',
- 'type' => 'string',
- ],
- 'incidentNumber' => [
- 'description' => '',
- 'example' => 'I13002001',
- 'type' => 'string',
- ],
- 'problemNumber' => [
- 'description' => '',
- 'example' => 'P1231231',
- 'type' => 'string',
- ],
- 'defaultAssignToWho' => [
- 'description' => '',
- 'example' => '1212',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'defaultAssignToWhoIsValid' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
],
+ 'relatedServiceGroupName' => ['description' => 'Related service group name.', 'type' => 'string', 'example' => '服务组A', 'title' => ''],
+ 'relatedServiceGroupId' => ['description' => 'Related service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '13000', 'title' => ''],
+ 'relServiceDeleteType' => ['description' => 'Service deletion flag.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'relRouteRuleDeleteType' => ['description' => 'Routing rule deletion flag.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'assignToWhoIsValid' => ['description' => 'Indicates whether the assigned user is valid. Valid values: 1 (valid), 0 (invalid).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'relServiceGroupIsValid' => ['description' => 'Indicates whether the related service group is valid. Valid values: 1 (valid), 0 (invalid).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'defaultAssignToWhoName' => ['description' => 'Name of the default assignee.', 'type' => 'string', 'example' => '小明', 'title' => ''],
+ 'relatedServiceDescription' => ['description' => 'Description of the related service.', 'type' => 'string', 'example' => '关联服务描述', 'title' => ''],
+ 'incidentLevel' => ['description' => 'Incident severity level. Valid values: P1, P2, P3, P4 (in descending order of severity).', 'type' => 'string', 'example' => 'P4', 'title' => ''],
+ 'incidentNumber' => ['description' => 'Incident number.', 'type' => 'string', 'example' => 'I13002001', 'title' => ''],
+ 'problemNumber' => ['description' => 'Problem number.', 'type' => 'string', 'example' => 'P1231231', 'title' => ''],
+ 'defaultAssignToWho' => ['description' => 'ID of the default assignee.', 'type' => 'integer', 'format' => 'int32', 'example' => '1212', 'title' => ''],
+ 'defaultAssignToWhoIsValid' => ['description' => 'Deletion status of the default assignee.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": [\\n {\\n \\"incidentId\\": 3213,\\n \\"routeRuleId\\": 10000,\\n \\"routeRuleName\\": \\"规则A\\",\\n \\"incidentStatus\\": \\"FINISHE\\",\\n \\"relatedServiceId\\": 213123,\\n \\"relatedServiceName\\": \\"服务A\\",\\n \\"effect\\": \\"LOW\\",\\n \\"assignUserId\\": 12312,\\n \\"assignUserName\\": \\"小明\\",\\n \\"assignUserPhone\\": \\"139****1111\\",\\n \\"incidentTitle\\": \\"事件标题\\",\\n \\"createTime\\": \\"2010-03-09 15:53:45\\",\\n \\"isManual\\": true,\\n \\"isUpgrade\\": true,\\n \\"incidentDescription\\": \\"事件描述\\",\\n \\"problemId\\": 12312,\\n \\"durationTime\\": \\"3000000\\",\\n \\"notifyChannels\\": [\\n \\"[SMS,PHONE]\\"\\n ],\\n \\"relatedServiceGroupName\\": \\"服务组A\\",\\n \\"relatedServiceGroupId\\": 13000,\\n \\"relServiceDeleteType\\": 1,\\n \\"relRouteRuleDeleteType\\": 1,\\n \\"assignToWhoIsValid\\": 1,\\n \\"relServiceGroupIsValid\\": 1,\\n \\"defaultAssignToWhoName\\": \\"小明\\",\\n \\"relatedServiceDescription\\": \\"关联服务描述\\",\\n \\"incidentLevel\\": \\"P4\\",\\n \\"incidentNumber\\": \\"I13002001\\",\\n \\"problemNumber\\": \\"P1231231\\",\\n \\"defaultAssignToWho\\": 1212,\\n \\"defaultAssignToWhoIsValid\\": 1\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query management event details by event ID',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetIncidentListByIdList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIncidentListByIdList'],
+ ],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": [\\n {\\n \\"incidentId\\": 3213,\\n \\"routeRuleId\\": 10000,\\n \\"routeRuleName\\": \\"规则A\\",\\n \\"incidentStatus\\": \\"FINISHE\\",\\n \\"relatedServiceId\\": 213123,\\n \\"relatedServiceName\\": \\"服务A\\",\\n \\"effect\\": \\"LOW\\",\\n \\"assignUserId\\": 12312,\\n \\"assignUserName\\": \\"小明\\",\\n \\"assignUserPhone\\": \\"139****1111\\",\\n \\"incidentTitle\\": \\"事件标题\\",\\n \\"createTime\\": \\"2010-03-09 15:53:45\\",\\n \\"isManual\\": true,\\n \\"isUpgrade\\": true,\\n \\"incidentDescription\\": \\"事件描述\\",\\n \\"problemId\\": 12312,\\n \\"durationTime\\": \\"3000000\\",\\n \\"notifyChannels\\": [\\n \\"[SMS,PHONE]\\"\\n ],\\n \\"relatedServiceGroupName\\": \\"服务组A\\",\\n \\"relatedServiceGroupId\\": 13000,\\n \\"relServiceDeleteType\\": 1,\\n \\"relRouteRuleDeleteType\\": 1,\\n \\"assignToWhoIsValid\\": 1,\\n \\"relServiceGroupIsValid\\": 1,\\n \\"defaultAssignToWhoName\\": \\"小明\\",\\n \\"relatedServiceDescription\\": \\"关联服务描述\\",\\n \\"incidentLevel\\": \\"P4\\",\\n \\"incidentNumber\\": \\"I13002001\\",\\n \\"problemNumber\\": \\"P1231231\\",\\n \\"defaultAssignToWho\\": 1212,\\n \\"defaultAssignToWhoIsValid\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetIncidentListByIdListResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n <data>\\n <incidentId>3213</incidentId>\\n <routeRuleId>10000</routeRuleId>\\n <routeRuleName>规则A</routeRuleName>\\n <incidentStatus>FINISHE</incidentStatus>\\n <relatedServiceId>213123</relatedServiceId>\\n <relatedServiceName>服务A</relatedServiceName>\\n <effect>LOW</effect>\\n <assignUserId>12312</assignUserId>\\n <assignUserName>小明</assignUserName>\\n <assignUserPhone>139****1111</assignUserPhone>\\n <incidentTitle>事件标题</incidentTitle>\\n <createTime>2010-03-09 15:53:45</createTime>\\n <isManual>true</isManual>\\n <isUpgrade>true</isUpgrade>\\n <incidentDescription>事件描述</incidentDescription>\\n <problemId>12312</problemId>\\n <durationTime>3000000</durationTime>\\n <notifyChannels>[SMS,PHONE]</notifyChannels>\\n <relatedServiceGroupName>服务组A</relatedServiceGroupName>\\n <relatedServiceGroupId>13000</relatedServiceGroupId>\\n <relServiceDeleteType>1</relServiceDeleteType>\\n <relRouteRuleDeleteType>1</relRouteRuleDeleteType>\\n <assignToWhoIsValid>1</assignToWhoIsValid>\\n <relServiceGroupIsValid>1</relServiceGroupIsValid>\\n <defaultAssignToWhoName>小明</defaultAssignToWhoName>\\n <relatedServiceDescription>关联服务描述</relatedServiceDescription>\\n <incidentLevel>P4</incidentLevel>\\n <incidentNumber>I13002001</incidentNumber>\\n <problemNumber>P1231231</problemNumber>\\n <defaultAssignToWho>1212</defaultAssignToWho>\\n <defaultAssignToWhoIsValid>1</defaultAssignToWhoIsValid>\\n </data>\\n</GetIncidentListByIdListResponse>","errorExample":""}]',
],
- 'DeleteIncident' => [
- 'summary' => '事件删除',
- 'path' => '/incident/delete',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetIncidentStatistics' => [
+ 'summary' => 'Management event statistics.',
+ 'path' => '/incident/count',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempKAIUZH',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempJ0ENN8'],
],
'parameters' => [
[
@@ -10416,96 +6141,91 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'A short description of struct',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'required' => false,
- 'title' => '幂等校验',
- 'type' => 'string',
- ],
- 'incidentId' => [
- 'description' => '',
- 'example' => '12321',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '事件Id',
- 'type' => 'integer',
- ],
+ 'clientToken' => ['description' => 'Idempotency validation ID.', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'object',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['description' => 'requestId', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'type' => 'string', 'title' => ''],
+ 'data' => [
+ 'description' => 'data',
+ 'properties' => [
+ 'myResponse' => ['description' => 'My pending responses.', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'],
+ 'myFinish' => ['description' => 'My completed.', 'example' => '11', 'format' => 'int32', 'title' => '', 'type' => 'integer'],
+ 'allResponse' => ['description' => 'All pending responses.', 'example' => '12', 'format' => 'int32', 'title' => '', 'type' => 'integer'],
+ 'allFinish' => ['description' => 'All completed.', 'example' => '113', 'format' => 'int32', 'title' => '', 'type' => 'integer'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
- 'title' => 'Schema of Response',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IncidentStatusInvalid',
- 'errorMessage' => 'The incident status is invalid.',
- ],
- [
- 'errorCode' => 'IncidentUpdateInvalid',
- 'errorMessage' => 'The incident update is invalid.',
- ],
+ 403 => [
+ ['errorCode' => 'UserNotAdded', 'errorMessage' => 'The user is not added to the system.', 'description' => 'The user did not added to system'],
],
- 404 => [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
- ],
+ [
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIncidentResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n</DeleteIncidentResponse>","errorExample":""}]',
- ],
- 'CreateIncident' => [
- 'summary' => '手动创建事件',
- 'path' => '/incident/manualSave',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"myResponse\\": 1,\\n \\"myFinish\\": 11,\\n \\"allResponse\\": 12,\\n \\"allFinish\\": 113\\n }\\n}","type":"json"}]',
+ 'title' => 'Management Event Statistics',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetIncidentStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIncidentStatistics'],
+ ],
],
+ ],
+ 'GetIncidentSubtotalCount' => [
+ 'summary' => 'Obtain the subtotal quantity of similar management events. ',
+ 'path' => '/incident/subtotal/count',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempKAIUZH',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp71I60H'],
],
'parameters' => [
[
@@ -10513,82 +6233,22 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'A short description of struct',
'properties' => [
- 'incidentLevel' => [
- 'description' => '',
- 'example' => 'P1',
- 'required' => false,
- 'title' => 'P1 事件级别 P1 P2 P3 P4',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef729f',
- 'required' => false,
- 'title' => '幂等UUID',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '关联服务ID',
- 'type' => 'integer',
- ],
- 'effect' => [
- 'description' => '',
- 'example' => 'LOW',
- 'required' => false,
- 'title' => '影响等级 高:HIGH 低 LOW',
- 'type' => 'string',
- ],
- 'incidentTitle' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '事件标题',
- 'type' => 'string',
- ],
- 'assignUserId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '分派的用户ID',
- 'type' => 'integer',
- ],
- 'incidentDescription' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '事件描述',
- 'type' => 'string',
- ],
- 'channels' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => 'SMS',
- 'required' => false,
- 'type' => 'string',
- ],
- 'required' => false,
- 'title' => '通知渠道 SMS 短信 EMAIL 邮件 PHONE 电话 WEIXIN_GROUP企微群 DING_GROUP 钉钉群',
+ 'incidentIds' => [
+ 'description' => 'List of management event IDs ',
+ 'items' => ['example' => '6754', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'description' => 'List of management event IDs ', 'title' => ''],
+ 'required' => true,
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
- 'serviceGroupId' => [
- 'description' => '12000',
- 'example' => '12312',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '服务组Id',
- 'type' => 'integer',
- ],
+ 'clientToken' => ['description' => 'Idempotency identity ', 'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -10598,71 +6258,63 @@
'description' => 'Schema of Response',
'properties' => [
'data' => [
- 'description' => 'Id of the request',
+ 'description' => 'data',
'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '',
- 'format' => 'int64',
- 'title' => '事件主健Id',
- 'type' => 'integer',
- ],
+ 'subtotalCount' => ['description' => 'map', 'example' => '{12:12}', 'title' => 'map', 'type' => 'object'],
+ 'requestId' => ['description' => 'id of the request', 'example' => '24343424234', 'title' => 'id of the request', 'type' => 'string'],
],
- 'title' => 'Id of the request',
+ 'title' => 'data',
'type' => 'object',
- ],
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'requestId',
- 'type' => 'string',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified Resource is not found.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"subtotalCount\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"requestId\\": \\"24343424234\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain the subtotal quantity of similar management events ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetIncidentSubtotalCount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"data\\": {\\n \\"incidentId\\": 0\\n },\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateIncidentResponse>\\n <data>\\n <incidentId>218</incidentId>\\n </data>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n</CreateIncidentResponse>","errorExample":""}]',
- ],
- 'DeliverIncident' => [
- 'summary' => '转交事件',
- 'path' => '/incident/deliver',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIncidentSubtotalCount'],
+ ],
],
+ ],
+ 'GetIntegrationConfig' => [
+ 'summary' => 'Integration configuration details.',
+ 'path' => '/integrationConfig/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempKAIUZH',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempBHVB81'],
],
'parameters' => [
[
@@ -10672,33 +6324,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '1223212',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '事件ID',
- 'type' => 'integer',
- ],
- 'assignUserId' => [
- 'description' => '',
- 'example' => '212321',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '转交用户ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61CS9A221',
- 'required' => false,
- 'title' => '幂等校验id',
- 'type' => 'string',
- ],
+ 'integrationConfigId' => ['description' => 'Integration configuration ID.', 'example' => '68', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency identity.', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -10707,68 +6339,78 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2FS',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['description' => 'Id of the request', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'title' => 'Id of the request', 'type' => 'string'],
+ 'data' => [
+ 'description' => 'data',
+ 'properties' => [
+ 'integrationConfigId' => ['description' => 'Integration configuration ID.', 'example' => '101', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'monitorSourceId' => ['description' => 'Monitoring source ID.', 'example' => '65', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'monitorSourceName' => ['description' => 'Name of the monitoring source.', 'example' => 'Zabbix', 'title' => '', 'type' => 'string'],
+ 'monitorSourceShortName' => ['description' => 'Short name of the monitoring source.', 'example' => 'Zabbix', 'title' => '', 'type' => 'string'],
+ 'accessKey' => ['description' => 'Integration key.', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'title' => '', 'type' => 'string'],
+ 'isReceivedEvent' => ['description' => 'Indicates whether alerts are accepted.', 'example' => 'True', 'title' => '', 'type' => 'boolean'],
+ 'status' => ['description' => 'Integration configuration status: '."\n"
+ .'- DISABLE: disabled. '."\n"
+ .'- INTEGRATED: integrated. '."\n"
+ .'- UNINTEGRATED: not integrated.', 'example' => 'INTEGRATED', 'title' => '', 'type' => 'string'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IncidentUpdateInvalid',
- 'errorMessage' => 'The incident update is invalid.',
- ],
- [
- 'errorCode' => 'IncidentStatusInvalid',
- 'errorMessage' => 'The incident status is invalid.',
- ],
- ],
404 => [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
- ],
+ ['errorCode' => 'IntegationConfigNotExists', 'errorMessage' => 'The specified integration config does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2FS\\"\\n}","errorExample":""},{"type":"xml","example":"<DeliverIncidentResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n</DeliverIncidentResponse>","errorExample":""}]',
- ],
- 'GetIncident' => [
- 'summary' => '事件详情',
- 'path' => '/incident/detail',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"data\\": {\\n \\"integrationConfigId\\": 101,\\n \\"monitorSourceId\\": 65,\\n \\"monitorSourceName\\": \\"Zabbix\\",\\n \\"monitorSourceShortName\\": \\"Zabbix\\",\\n \\"accessKey\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"isReceivedEvent\\": true,\\n \\"status\\": \\"INTEGRATED\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Integration configuration details',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIntegrationConfig'],
+ ],
],
+ ],
+ 'GetProblem' => [
+ 'summary' => 'Failure details.',
+ 'path' => '/problem/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempJ0ENN8',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempUCUJK5'],
],
'parameters' => [
[
@@ -10776,288 +6418,314 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'The request body.',
'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '32113',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '事件ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef729f',
- 'required' => false,
- 'title' => '幂等校验',
- 'type' => 'string',
- ],
+ 'problemId' => ['description' => 'The problem ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'clientToken' => ['description' => 'A client token to ensure idempotence.', 'type' => 'string', 'required' => false, 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => ''],
],
'required' => false,
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef7291',
- 'type' => 'string',
- ],
'data' => [
- 'description' => 'data',
+ 'description' => 'The details.',
'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '3213',
- 'format' => 'int64',
- 'title' => '事件Id',
- 'type' => 'integer',
- ],
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '3123',
- 'format' => 'int64',
- 'title' => '流转规则ID',
- 'type' => 'integer',
- ],
- 'routeRuleName' => [
- 'description' => '',
- 'example' => '流转规则A',
- 'title' => '流转规则名称',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '312312',
- 'format' => 'int64',
- 'title' => '关联服务ID',
- 'type' => 'integer',
- ],
- 'relatedServiceName' => [
- 'description' => '',
- 'example' => '服务A',
- 'title' => '关联服务名称',
- 'type' => 'string',
- ],
- 'relatedServiceDescription' => [
- 'description' => '',
- 'example' => '关联服务描述',
- 'title' => '关联服务描述',
- 'type' => 'string',
- ],
- 'incidentStatus' => [
- 'description' => '',
- 'example' => 'FINISHE',
- 'title' => '事件状态 ASSIGNED已分派 RESPONDED已响应 FINISHED已完结',
- 'type' => 'string',
- ],
- 'incidentLevel' => [
- 'description' => '',
- 'example' => 'P4',
- 'title' => '事件级别 P1 P2 P3 P4',
- 'type' => 'string',
- ],
- 'effect' => [
- 'description' => '',
- 'example' => 'LOW',
- 'title' => 'HIGH 影响等级 高:HIGH 低 LOW',
- 'type' => 'string',
- ],
- 'assignUserId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'title' => '分派的用户ID',
- 'type' => 'integer',
- ],
- 'assignUserName' => [
- 'description' => '',
- 'example' => '小明',
- 'title' => '分派的用户姓名 (用户表获取)',
- 'type' => 'string',
- ],
- 'assignUserPhone' => [
- 'description' => '',
- 'example' => '1390000****',
- 'title' => '分派的用户手机号',
- 'type' => 'string',
- ],
- 'incidentNumber' => [
- 'description' => '',
- 'example' => 'I3443831000000016247759753663894',
- 'title' => '事件编号',
- 'type' => 'string',
- ],
- 'incidentTitle' => [
- 'description' => '',
- 'example' => '事件标题',
- 'title' => '事件标题',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2020-01-10 00:00:00',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'isManual' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '事件来源 是:手动 否:自动',
- 'type' => 'boolean',
- ],
- 'isUpgrade' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '是否升级 是 否',
- 'type' => 'boolean',
- ],
- 'incidentDescription' => [
- 'description' => '',
- 'example' => '事件描述',
- 'title' => '事件描述',
- 'type' => 'string',
- ],
'problemId' => [
- 'description' => '',
- 'example' => '232113',
- 'format' => 'int64',
- 'title' => '故障Id',
+ 'title' => 'ID',
+ 'description' => 'The problem ID.',
'type' => 'integer',
- ],
- 'problemNumber' => [
- 'description' => '',
- 'example' => '3332113231453321',
- 'title' => '故障编号',
- 'type' => 'string',
- ],
- 'durationTime' => [
- 'description' => '',
- 'example' => '3000000',
'format' => 'int64',
- 'title' => '持续时间',
- 'type' => 'integer',
- ],
- 'notifyChannels' => [
- 'description' => '',
- 'example' => '1 短信 2 邮件 3 电话 4 企微群 5 钉钉群 6飞书 7 群通知 8 slack',
+ 'required' => true,
+ 'example' => '1',
+ 'enum' => ['Success', 'Fail', 'Cancel'],
+ ],
+ 'createTime' => ['description' => 'The time when the problem was created.', 'type' => 'string', 'example' => '2010-03-09 15:53:45', 'title' => ''],
+ 'incidentNumber' => ['description' => 'The event number.', 'type' => 'string', 'example' => 'I3443835000012016260833157948165', 'title' => ''],
+ 'incidentId' => ['description' => 'The event ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '130000032', 'title' => ''],
+ 'problemNumber' => ['description' => 'The problem number.', 'type' => 'string', 'example' => 'P34438300010030116260833538987481', 'title' => ''],
+ 'problemName' => ['description' => 'The name of the problem.', 'type' => 'string', 'example' => '故障', 'title' => ''],
+ 'problemStatus' => ['description' => 'The status of the problem.'."\n"
+ ."\n"
+ .'- HANDLING: The problem is being handled.'."\n"
+ ."\n"
+ .'- RECOVERED: The problem has been resolved.'."\n"
+ ."\n"
+ .'- REPLAYING: The problem is under review.'."\n"
+ ."\n"
+ .'- REPLAYED: The problem has been reviewed.'."\n"
+ ."\n"
+ .'- CANCEL: The problem has been canceled.', 'type' => 'integer', 'format' => 'int32', 'example' => 'HANDLING', 'title' => ''],
+ 'problemLevel' => ['description' => 'The level of the problem, in descending order of severity:'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'integer', 'format' => 'int32', 'example' => 'P1', 'title' => ''],
+ 'discoverTime' => ['description' => 'The time when the problem was discovered.', 'type' => 'string', 'example' => '2010-03-09 15:53:45', 'title' => ''],
+ 'recoveryTime' => ['description' => 'The time when the service recovered from the problem.', 'type' => 'string', 'example' => '2010-03-09 15:53:45', 'title' => ''],
+ 'relatedServiceId' => ['description' => 'The ID of the associated service.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'serviceName' => ['description' => 'The name of the associated service.', 'type' => 'string', 'example' => '服务', 'title' => ''],
+ 'progressSummary' => ['description' => 'The summary of the progress.', 'type' => 'string', 'example' => '进展摘要', 'title' => ''],
+ 'preliminaryReason' => ['description' => 'The preliminary cause of the problem.', 'type' => 'string', 'example' => '初步原因', 'title' => ''],
+ 'mainHandler' => ['description' => 'The primary handler of the problem.', 'type' => 'integer', 'format' => 'int64', 'example' => '小王', 'title' => ''],
+ 'mainHandlerId' => ['description' => 'The ID of the primary handler.', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', 'title' => ''],
+ 'mainHandlerPhone' => ['description' => 'The phone number of the primary handler.', 'type' => 'string', 'example' => '1308987****', 'title' => ''],
+ 'feedback' => ['description' => 'The feedback.', 'type' => 'string', 'example' => 'feedback', 'title' => ''],
+ 'cancelReasonDescription' => ['description' => 'The description of the cancellation reason.', 'type' => 'string', 'example' => '取消原因描述', 'title' => ''],
+ 'cancelReason' => ['description' => 'The reason for cancellation.', 'type' => 'integer', 'format' => 'int64', 'example' => '37', 'title' => ''],
+ 'durationTime' => ['description' => 'The duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '300000', 'title' => ''],
+ 'progressSummaryRichTextId' => ['description' => 'The ID of the rich text for the progress summary.', 'type' => 'integer', 'format' => 'int64', 'example' => '1231231', 'title' => ''],
+ 'handingProblemOperateLogs' => [
+ 'description' => 'The operation logs for the problem that is being handled.',
'items' => [
- 'description' => '',
- 'example' => 'WEBHOOK',
- 'type' => 'string',
+ 'description' => 'The operation logs for the problem that is being handled.',
+ 'properties' => [
+ 'operator' => ['description' => 'The operator.', 'type' => 'string', 'example' => '小王', 'title' => ''],
+ 'userId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '233', 'title' => ''],
+ 'actionName' => ['description' => 'The action name.', 'type' => 'string', 'example' => '取消故障', 'title' => ''],
+ 'actionTime' => ['description' => 'The name of the action.', 'type' => 'string', 'example' => '2010-03-09 15:53:45', 'title' => ''],
+ 'userIsValid' => ['description' => 'Indicates whether the user is valid.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '通知渠道',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
- 'relatedServiceGroupName' => [
- 'description' => '',
- 'example' => '服务组A',
- 'title' => '关联服务组名称',
- 'type' => 'string',
- ],
- 'relatedServiceGroupId' => [
- 'description' => '',
- 'example' => '13000',
- 'format' => 'int64',
- 'title' => '关联服服务id',
- 'type' => 'integer',
- ],
- 'relServiceDeleteType' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '服务删除字段',
- 'type' => 'integer',
+ 'restoredProblemOperateLogs' => [
+ 'description' => 'The operation logs for the resolved problem.',
+ 'items' => [
+ 'description' => 'The operation logs for the resolved problem.',
+ 'properties' => [
+ 'operator' => ['description' => 'The operator.', 'type' => 'string', 'example' => '小王', 'title' => ''],
+ 'userId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3232', 'title' => ''],
+ 'actionName' => ['description' => 'The action name.', 'type' => 'string', 'example' => '恢复故障', 'title' => ''],
+ 'actionTime' => ['description' => 'The name of the action.', 'type' => 'string', 'example' => '2020-08-08 15:39:39', 'title' => ''],
+ 'userIsValid' => ['description' => 'Indicates whether the user is valid.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'relRouteRuleDeleteType' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '规则删除字段',
- 'type' => 'integer',
+ 'replayingProblemOperateLogs' => [
+ 'description' => 'The operation logs for the problem that is under review.',
+ 'items' => [
+ 'description' => 'The operation logs for the problem that is under review.',
+ 'properties' => [
+ 'operator' => ['description' => 'The operator.', 'type' => 'string', 'example' => '小杰', 'title' => ''],
+ 'userId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '用户id', 'title' => ''],
+ 'actionName' => ['description' => 'The action name.', 'type' => 'string', 'example' => '复盘故障', 'title' => ''],
+ 'actionTime' => ['description' => 'The name of the action.', 'type' => 'string', 'example' => '2020-08-08 15:39:39', 'title' => ''],
+ 'userIsValid' => ['description' => 'Indicates whether the user is valid.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'assignToWhoIsValid' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '分派的用户是否生效,1生效,0失效',
- 'type' => 'integer',
+ 'replayProblemOperateLogs' => [
+ 'description' => 'The operation logs for the reviewed problem.',
+ 'items' => [
+ 'description' => 'The operation logs for the reviewed problem.',
+ 'properties' => [
+ 'operator' => ['description' => 'The operator.', 'type' => 'string', 'example' => '小王', 'title' => ''],
+ 'userId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2323', 'title' => ''],
+ 'actionName' => ['description' => 'The action name.', 'type' => 'string', 'example' => '复盘故障', 'title' => ''],
+ 'actionTime' => ['description' => 'Action name.', 'type' => 'string', 'example' => '2020-08-08 15:39:39', 'title' => ''],
+ 'userIsValid' => ['description' => 'Indicates whether the user is valid.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'relServiceGroupIsValid' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '关联服务组是否生效,1生效,0失效',
- 'type' => 'integer',
+ 'effectionServices' => [
+ 'description' => 'The affected services.',
+ 'items' => [
+ 'description' => 'The affected services.',
+ 'properties' => [
+ 'effectionServiceId' => ['description' => 'The service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'effectionLevel' => ['description' => 'The impact level, in descending order of severity:'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'integer', 'format' => 'int64', 'example' => 'P1', 'title' => ''],
+ 'effectionStatus' => ['description' => 'The status of the affected service:'."\n"
+ ."\n"
+ .'- RECOVERED: The service has recovered.'."\n"
+ ."\n"
+ .'- UN\\_RECOVERED: The service has not recovered.', 'type' => 'integer', 'format' => 'int32', 'example' => 'RESTORED', 'title' => ''],
+ 'description' => ['description' => 'The description of the impact.', 'type' => 'string', 'example' => '描述', 'title' => ''],
+ 'serviceName' => ['description' => 'The service name.', 'type' => 'string', 'example' => '购物车', 'title' => ''],
+ 'serviceDeleteType' => ['description' => 'The deletion status of the service:'."\n"
+ ."\n"
+ .'- 1: Normal.'."\n"
+ ."\n"
+ .'- 0: Deleted.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'defaultAssignToWhoName' => [
- 'description' => '',
- 'title' => '默认分配人名称',
- 'type' => 'string',
+ 'coordinationGroups' => [
+ 'description' => 'The emergency response groups.',
+ 'items' => [
+ 'description' => 'The emergency response groups.',
+ 'properties' => [
+ 'serviceGroupId' => ['description' => 'The service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'serviceGroupName' => ['description' => 'The name of the service group.', 'type' => 'string', 'example' => '冲上云霄', 'title' => ''],
+ 'isValid' => ['description' => 'Indicates whether the group is valid.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'defaultAssignToWho' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '默认分配人id',
- 'type' => 'integer',
+ 'timelines' => [
+ 'description' => 'The timeline of problem operations.',
+ 'items' => [
+ 'description' => 'The timeline of problem operations.',
+ 'properties' => [
+ 'keyNode' => ['description' => 'The key node. For more information, see the PROBLEM\\_KEY\\_NODE lookup table.', 'type' => 'string', 'title' => '', 'example' => '1,2,3,4,5,7,6,8,9,10'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'defaultAssignToWhoIsValid' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '默认分配人删除状态 1正常 0删除',
- 'type' => 'integer',
+ 'cancelProblemOperateLogs' => [
+ 'description' => 'The operation logs for the canceled problem.',
+ 'items' => [
+ 'description' => 'The operation logs for the canceled problem.',
+ 'properties' => [
+ 'operator' => ['description' => 'The operator.', 'type' => 'string', 'example' => '小王', 'title' => ''],
+ 'actionName' => ['description' => 'The action name.', 'type' => 'string', 'example' => '取消故障', 'title' => ''],
+ 'actionTime' => ['description' => 'The time of the operation.', 'type' => 'string', 'example' => '2020-09-08 15:38:38', 'title' => ''],
+ 'userId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '66666', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'serviceDeleteType' => ['title' => 'serviceDeleteType', 'description' => 'The deletion type of the service:'."\n"
+ ."\n"
+ .'- 1: Manually deleted.'."\n"
+ ."\n"
+ .'- 2: Automatically deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'mainHandlerIsValid' => ['description' => 'The validity status of the primary handler:'."\n"
+ ."\n"
+ .'- 0: Invalid.'."\n"
+ ."\n"
+ .'- 1: Valid.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'isRuleTrigger' => ['title' => 'Is rule triggered: 1 for Yes, 0 for No ', 'description' => 'Indicates whether the problem was triggered by a rule:'."\n"
+ ."\n"
+ .'- 0: No.'."\n"
+ ."\n"
+ .'- 1: Yes.', 'type' => 'boolean', 'example' => '1'],
],
+ 'title' => '',
'type' => 'object',
+ 'example' => '',
],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13-41VB-A225-2C88188E8A43', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
- ],
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"2b63cdef-7ac3-4892-a76d-0f3389ef7291\\",\\n \\"data\\": {\\n \\"incidentId\\": 3213,\\n \\"routeRuleId\\": 3123,\\n \\"routeRuleName\\": \\"流转规则A\\",\\n \\"relatedServiceId\\": 312312,\\n \\"relatedServiceName\\": \\"服务A\\",\\n \\"relatedServiceDescription\\": \\"关联服务描述\\",\\n \\"incidentStatus\\": \\"FINISHE\\",\\n \\"incidentLevel\\": \\"P4\\",\\n \\"effect\\": \\"LOW\\",\\n \\"assignUserId\\": 12312,\\n \\"assignUserName\\": \\"小明\\",\\n \\"assignUserPhone\\": \\"1390000****\\",\\n \\"incidentNumber\\": \\"I3443831000000016247759753663894\\",\\n \\"incidentTitle\\": \\"事件标题\\",\\n \\"createTime\\": \\"2020-01-10 00:00:00\\",\\n \\"isManual\\": true,\\n \\"isUpgrade\\": true,\\n \\"incidentDescription\\": \\"事件描述\\",\\n \\"problemId\\": 232113,\\n \\"problemNumber\\": \\"3332113231453321\\",\\n \\"durationTime\\": 3000000,\\n \\"notifyChannels\\": [\\n \\"WEBHOOK\\"\\n ],\\n \\"relatedServiceGroupName\\": \\"服务组A\\",\\n \\"relatedServiceGroupId\\": 13000,\\n \\"relServiceDeleteType\\": 1,\\n \\"relRouteRuleDeleteType\\": 1,\\n \\"assignToWhoIsValid\\": 1,\\n \\"relServiceGroupIsValid\\": 1,\\n \\"defaultAssignToWhoName\\": \\"小明\\",\\n \\"defaultAssignToWho\\": 1212,\\n \\"defaultAssignToWhoIsValid\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetIncidentResponse>\\n <requestId>2b63cdef-7ac3-4892-a76d-0f3389ef7291</requestId>\\n <data>\\n <incidentId>3213</incidentId>\\n <routeRuleId>3123</routeRuleId>\\n <routeRuleName>流转规则A</routeRuleName>\\n <relatedServiceId>312312</relatedServiceId>\\n <relatedServiceName>服务A</relatedServiceName>\\n <relatedServiceDescription>关联服务描述</relatedServiceDescription>\\n <incidentStatus>FINISHE</incidentStatus>\\n <incidentLevel>P4</incidentLevel>\\n <effect>LOW</effect>\\n <assignUserId>12312</assignUserId>\\n <assignUserName>小明</assignUserName>\\n <assignUserPhone>1390000****</assignUserPhone>\\n <incidentNumber>I3443831000000016247759753663894</incidentNumber>\\n <incidentTitle>事件标题</incidentTitle>\\n <createTime>2020-01-10 00:00:00</createTime>\\n <isManual>true</isManual>\\n <isUpgrade>true</isUpgrade>\\n <incidentDescription>事件描述</incidentDescription>\\n <problemId>232113</problemId>\\n <problemNumber>3332113231453321</problemNumber>\\n <durationTime>3000000</durationTime>\\n </data>\\n</GetIncidentResponse>","errorExample":""}]',
- ],
- 'GetIncidentStatistics' => [
- 'summary' => '事件统计',
- 'path' => '/incident/count',
- 'methods' => [
- 'post',
+ 'staticInfo' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"problemId\\": 1,\\n \\"createTime\\": \\"2010-03-09 15:53:45\\",\\n \\"incidentNumber\\": \\"I3443835000012016260833157948165\\",\\n \\"incidentId\\": 130000032,\\n \\"problemNumber\\": \\"P34438300010030116260833538987481\\",\\n \\"problemName\\": \\"故障\\",\\n \\"problemStatus\\": 0,\\n \\"problemLevel\\": 0,\\n \\"discoverTime\\": \\"2010-03-09 15:53:45\\",\\n \\"recoveryTime\\": \\"2010-03-09 15:53:45\\",\\n \\"relatedServiceId\\": 1,\\n \\"serviceName\\": \\"服务\\",\\n \\"progressSummary\\": \\"进展摘要\\",\\n \\"preliminaryReason\\": \\"初步原因\\",\\n \\"mainHandler\\": 0,\\n \\"mainHandlerId\\": 2000,\\n \\"mainHandlerPhone\\": \\"1308987****\\",\\n \\"feedback\\": \\"feedback\\",\\n \\"cancelReasonDescription\\": \\"取消原因描述\\",\\n \\"cancelReason\\": 37,\\n \\"durationTime\\": 300000,\\n \\"progressSummaryRichTextId\\": 1231231,\\n \\"handingProblemOperateLogs\\": [\\n {\\n \\"operator\\": \\"小王\\",\\n \\"userId\\": 233,\\n \\"actionName\\": \\"取消故障\\",\\n \\"actionTime\\": \\"2010-03-09 15:53:45\\",\\n \\"userIsValid\\": 1\\n }\\n ],\\n \\"restoredProblemOperateLogs\\": [\\n {\\n \\"operator\\": \\"小王\\",\\n \\"userId\\": 3232,\\n \\"actionName\\": \\"恢复故障\\",\\n \\"actionTime\\": \\"2020-08-08 15:39:39\\",\\n \\"userIsValid\\": 1\\n }\\n ],\\n \\"replayingProblemOperateLogs\\": [\\n {\\n \\"operator\\": \\"小杰\\",\\n \\"userId\\": 0,\\n \\"actionName\\": \\"复盘故障\\",\\n \\"actionTime\\": \\"2020-08-08 15:39:39\\",\\n \\"userIsValid\\": 1\\n }\\n ],\\n \\"replayProblemOperateLogs\\": [\\n {\\n \\"operator\\": \\"小王\\",\\n \\"userId\\": 2323,\\n \\"actionName\\": \\"复盘故障\\",\\n \\"actionTime\\": \\"2020-08-08 15:39:39\\",\\n \\"userIsValid\\": 1\\n }\\n ],\\n \\"effectionServices\\": [\\n {\\n \\"effectionServiceId\\": 1,\\n \\"effectionLevel\\": 0,\\n \\"effectionStatus\\": 0,\\n \\"description\\": \\"描述\\",\\n \\"serviceName\\": \\"购物车\\",\\n \\"serviceDeleteType\\": 1\\n }\\n ],\\n \\"coordinationGroups\\": [\\n {\\n \\"serviceGroupId\\": 1,\\n \\"serviceGroupName\\": \\"冲上云霄\\",\\n \\"isValid\\": 1\\n }\\n ],\\n \\"timelines\\": [\\n {\\n \\"keyNode\\": \\"1,2,3,4,5,7,6,8,9,10\\"\\n }\\n ],\\n \\"cancelProblemOperateLogs\\": [\\n {\\n \\"operator\\": \\"小王\\",\\n \\"actionName\\": \\"取消故障\\",\\n \\"actionTime\\": \\"2020-09-08 15:38:38\\",\\n \\"userId\\": 66666\\n }\\n ],\\n \\"serviceDeleteType\\": 1,\\n \\"mainHandlerIsValid\\": 1,\\n \\"isRuleTrigger\\": true\\n },\\n \\"requestId\\": \\"C4BE3837-1A13-41VB-A225-2C88188E8A43\\"\\n}","type":"json"}]',
+ 'title' => 'Problem details ',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-14T12:10:11.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:43.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProblem'],
+ ],
],
+ ],
+ 'GetProblemEffectionService' => [
+ 'summary' => 'Details of the services affected by the fault.',
+ 'path' => '/problem/process/effectionService/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempJ0ENN8',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempLC8226'],
],
'parameters' => [
[
@@ -11065,247 +6733,104 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request Body.',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'required' => false,
- 'title' => '幂等校验Id',
- 'type' => 'string',
- ],
+ 'effectionServiceId' => ['description' => 'ID primary key.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => '', 'required' => false],
+ 'problemId' => ['description' => 'Problem ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '46', 'title' => '', 'required' => false],
+ 'clientToken' => ['title' => 'clientToken', 'description' => 'Idempotent check ID.', 'type' => 'string', 'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'object',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'requestId', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd'],
'data' => [
- 'description' => 'data',
+ 'description' => 'Query result.',
'properties' => [
- 'myResponse' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '我的 待响应',
- 'type' => 'integer',
- ],
- 'myFinish' => [
- 'description' => '',
- 'example' => '11',
- 'format' => 'int32',
- 'title' => '我的 完结',
- 'type' => 'integer',
- ],
- 'allResponse' => [
- 'description' => '',
- 'example' => '12',
- 'format' => 'int32',
- 'title' => '所有 待响应',
- 'type' => 'integer',
- ],
- 'allFinish' => [
- 'description' => '',
- 'example' => '113',
- 'format' => 'int32',
- 'title' => '所有 完结',
- 'type' => 'integer',
+ 'effectionServiceId' => ['description' => 'Impacted service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '6442430', 'title' => ''],
+ 'serviceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => '哈哈', 'title' => ''],
+ 'serviceId' => ['description' => 'Service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '170000000', 'title' => ''],
+ 'level' => ['description' => 'Impact level.', 'type' => 'integer', 'format' => 'int64', 'example' => 'P2', 'title' => ''],
+ 'status' => ['description' => 'Impact status:'."\n"
+ ."\n"
+ .'- 0: Not recovered.'."\n"
+ ."\n"
+ .'- 1: Recovered.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'description' => ['description' => 'Impact description.', 'type' => 'string', 'example' => 'ew', 'title' => ''],
+ 'picUrl' => [
+ 'description' => 'Image link.',
+ 'items' => ['description' => 'Image key.', 'type' => 'string', 'example' => '[ "problem/axxxxxx2-1xxxx4565-be92-f44ae2xxxxx", "problem/7xxxxxxe314-49998-b9e7-399e78b41fbd", "problem/xxxxx-f40d-4611-0978-1d1f719a929a" ]', 'title' => ''],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'UserNotAdded',
- 'errorMessage' => 'The user is not added to the system.',
- ],
- ],
- [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"myResponse\\": 1,\\n \\"myFinish\\": 11,\\n \\"allResponse\\": 12,\\n \\"allFinish\\": 113\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetIncidentStatisticsResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n <data>\\n <myResponded>1</myResponded>\\n <myFinish>11</myFinish>\\n <allResponded>12</allResponded>\\n <allFinish>113</allFinish>\\n </data>\\n</GetIncidentStatisticsResponse>","errorExample":""}]',
- ],
- 'FinishIncident' => [
- 'summary' => '完结事件',
- 'path' => '/incident/finish',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempKAIUZH',
+ 404 => [
+ ['errorCode' => 'EffectionServiceNotExisted', 'errorMessage' => 'EffectionService does not exist.', 'description' => ''],
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
],
- 'parameters' => [
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"e2d4306a-bf4d-4345-9ae6-158223c85dbd\\",\\n \\"data\\": {\\n \\"effectionServiceId\\": 6442430,\\n \\"serviceName\\": \\"哈哈\\",\\n \\"serviceId\\": 170000000,\\n \\"level\\": 0,\\n \\"status\\": 1,\\n \\"description\\": \\"ew\\",\\n \\"picUrl\\": [\\n \\"[ \\\\\\"problem/axxxxxx2-1xxxx4565-be92-f44ae2xxxxx\\\\\\", \\\\\\"problem/7xxxxxxe314-49998-b9e7-399e78b41fbd\\\\\\", \\\\\\"problem/xxxxx-f40d-4611-0978-1d1f719a929a\\\\\\" ]\\"\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Service Details of Impact',
+ 'changeSet' => [],
+ 'ramActions' => [
[
- 'name' => 'Body',
- 'in' => 'body',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '',
- 'properties' => [
- 'incidentIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '12321',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'required' => true,
- 'title' => '事件ID数组',
- 'type' => 'array',
- ],
- 'incidentFinishReason' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '完结原因',
- 'type' => 'integer',
- ],
- 'incidentFinishReasonDescription' => [
- 'description' => '',
- 'example' => '原因描述',
- 'required' => false,
- 'title' => '原因描述',
- 'type' => 'string',
- ],
- 'incidentFinishSolution' => [
- 'description' => '',
- 'example' => '3',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '解决方案',
- 'type' => 'integer',
- ],
- 'incidentFinishSolutionDescription' => [
- 'description' => '',
- 'example' => '解决方案描述',
- 'required' => false,
- 'title' => '解决方案描述',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2DC',
- 'required' => false,
- 'title' => '幂等校验Id',
- 'type' => 'string',
- ],
- ],
- 'required' => true,
- 'title' => 'body参数',
- 'type' => 'object',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => 'Schema of Response',
- 'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'requestId',
- 'type' => 'string',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetProblemEffectionService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'title' => 'Schema of Response',
- 'type' => 'object',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IncidentUpdateInvalid',
- 'errorMessage' => 'The incident update is invalid.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
- ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProblemEffectionService'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"<FinishIncidentResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n <data/>\\n</FinishIncidentResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{"incidentIds":[170003050],"incidentFinishReason":"1","incidentFinishReasonDescription":"222","incidentFinishSolution":"1","incidentFinishSolutionDescription":"22222222","clientToken":"155afb33-2300-4c7c-a114-4c8ab1ef4ba7"}',
],
- 'UpdateIncident' => [
- 'summary' => '更新事件详情',
- 'path' => '/incident/update',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetProblemImprovement' => [
+ 'summary' => 'Details of post-incident reviews and improvements.',
+ 'path' => '/problem/improvement/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempKAIUZH',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1XQ9JR'],
],
'parameters' => [
[
@@ -11313,234 +6838,457 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'The request body.',
'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '事件Id',
- 'type' => 'integer',
- ],
- 'incidentLevel' => [
- 'description' => '',
- 'example' => 'P1',
- 'required' => false,
- 'title' => '级别',
- 'type' => 'string',
- ],
- 'effect' => [
- 'description' => '',
- 'example' => 'LOW',
- 'required' => false,
- 'title' => '影响程度',
- 'type' => 'string',
- ],
- 'incidentTitle' => [
- 'description' => '',
- 'example' => '事件标题',
- 'required' => false,
- 'title' => '事件标题',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A123',
- 'required' => false,
- 'title' => '幂等校验Id',
- 'type' => 'string',
- ],
+ 'problemId' => ['description' => 'The problem ID.', 'type' => 'string', 'example' => '312312', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'The idempotence token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3811'],
'data' => [
- 'description' => 'data',
+ 'description' => 'The impact record for the problem.',
'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '2312',
- 'format' => 'int64',
- 'title' => '事件id',
- 'type' => 'integer',
+ 'problemId' => ['description' => 'The problem ID.', 'type' => 'string', 'title' => '', 'example' => '231231'],
+ 'problemReason' => ['description' => 'The cause of the problem.', 'type' => 'string', 'title' => '', 'example' => '故障的原因'],
+ 'recentActivity' => ['description' => 'The lookup table for recent activities (PROBLEM\\_RECENT\\_ACTIVITY).', 'type' => 'string', 'title' => '', 'example' => '2'],
+ 'injectionMode' => ['description' => 'The lookup table for injection modes (PROBLEM\\_INJECTION\\_MODE).', 'type' => 'string', 'title' => '', 'example' => '3'],
+ 'recoveryMode' => ['description' => 'The lookup table for recovery modes (PROBLEM\\_RECOVERY\\_MODE).', 'type' => 'string', 'title' => '', 'example' => '2'],
+ 'discoverSource' => ['description' => 'The lookup table for discovery sources (PROBLEM\\_DISCOVER\\_SOURCE).', 'type' => 'string', 'title' => '', 'example' => '1'],
+ 'userReport' => ['description' => 'The lookup table for user reports (PROBLEM\\_USER\\_REPORT).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'monitorSourceName' => ['description' => 'The name of the monitoring source.', 'type' => 'string', 'title' => '', 'example' => 'Zabbix'],
+ 'relationChanges' => ['description' => 'The associated changes.', 'type' => 'string', 'title' => '', 'example' => '关联变更'],
+ 'dutyUserId' => ['description' => 'The ID of the problem owner.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '231'],
+ 'replayDutyUserId' => ['description' => 'The ID of the review owner.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '23123'],
+ 'replayDutyUserPhone' => ['description' => 'The phone number of the review owner.', 'type' => 'string', 'title' => '', 'example' => '1308787****'],
+ 'dutyDepartmentId' => ['description' => 'The department responsible for the problem.', 'type' => 'string', 'title' => '', 'example' => '12312'],
+ 'dutyUserName' => ['description' => 'The name of the problem owner.', 'type' => 'string', 'title' => '', 'example' => '小明'],
+ 'dutyUserPhone' => ['description' => 'The phone number of the problem owner.', 'type' => 'string', 'title' => '', 'example' => '13098898****'],
+ 'replayDutyUserName' => ['description' => 'The name of the review owner.', 'type' => 'string', 'title' => '', 'example' => '小花'],
+ 'remark' => ['description' => 'The remarks.', 'type' => 'string', 'title' => '', 'example' => '备注'],
+ 'isManual' => ['description' => 'Indicates whether the operation was manual.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'dutyDepartmentName' => ['description' => 'The name of the department responsible for the problem.', 'type' => 'string', 'title' => '', 'example' => '服务组B'],
+ 'measureList' => [
+ 'description' => 'The list of improvement measures.',
+ 'items' => [
+ 'description' => 'The list of improvement measures.',
+ 'properties' => [
+ 'measureId' => ['description' => 'The ID of the improvement measure. This ID is used for deletion or update operations.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12312'],
+ 'type' => ['description' => 'The lookup table for measure types (PROBLEM\\_REPLAY\\_IMPROVEMENT).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2'],
+ 'content' => ['description' => 'The content of the measure.', 'type' => 'string', 'title' => '', 'example' => '内容A'],
+ 'checkStandard' => ['description' => 'The acceptance criteria.', 'type' => 'string', 'title' => '', 'example' => '验收标准A'],
+ 'checkUserId' => ['description' => 'The ID of the verifier.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12'],
+ 'checkUserName' => ['description' => 'The name of the verifier.', 'type' => 'string', 'title' => '', 'example' => '小军'],
+ 'directorName' => ['description' => 'The name of the owner.', 'type' => 'string', 'title' => '', 'example' => '小张'],
+ 'stalkerName' => ['description' => 'The name of the tracker.', 'type' => 'string', 'title' => '', 'example' => '小李'],
+ 'planFinishTime' => ['description' => 'The planned completion time.', 'type' => 'string', 'title' => '', 'example' => '2021-05-01 00:00:00'],
+ 'directorId' => ['description' => 'The ID of the owner.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '212'],
+ 'stalkerId' => ['description' => 'The ID of the tracker.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '3121'],
+ 'status' => ['description' => 'The status. Valid values:'."\n"
+ ."\n"
+ .'- IMPROVED: The measure is implemented.'."\n"
+ ."\n"
+ .'- UNIMPROVED: The measure is not implemented.', 'type' => 'string', 'title' => '', 'example' => 'UNIMPROVED'],
+ 'checkUserIsValid' => ['title' => 'Indicates whether the validation user is invalid. 0 means invalid and 1 means valid.', 'description' => 'Indicates whether the verifier is valid. Valid values:'."\n"
+ ."\n"
+ .'- 0: Invalid.'."\n"
+ ."\n"
+ .'- 1: Valid.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'directorIsValid' => ['title' => 'Owner validity status, 0 for invalid and 1 for valid ', 'description' => 'Indicates whether the owner is valid. Valid values:'."\n"
+ ."\n"
+ .'- 0: Invalid.'."\n"
+ ."\n"
+ .'- 1: Valid.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'stalkerIsValid' => ['title' => 'Whether the trail assignee is invalid; 0 indicates invalid, and 1 indicates valid ', 'description' => 'Indicates whether the tracker is valid. Valid values:'."\n"
+ ."\n"
+ .'- 0: Invalid.'."\n"
+ ."\n"
+ .'- 1: Valid.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'customProblemReason' => ['title' => 'Custom fault reason ', 'description' => 'The custom cause of the problem.', 'type' => 'string', 'example' => '1'],
+ 'replayDutyUserIsValid' => ['title' => 'Replay Owner Validity Status, 0 Invalid 1 Valid', 'description' => 'Indicates whether the review owner is valid. Valid values:'."\n"
+ ."\n"
+ .'- 0: Invalid.'."\n"
+ ."\n"
+ .'- 1: Valid.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'dutyUserIsValid' => ['title' => 'Validity status of the person responsible for the fault, where 0 indicates invalid and 1 indicates valid ', 'description' => 'Indicates whether the problem owner is valid. Valid values:'."\n"
+ ."\n"
+ .'- 0: Invalid.'."\n"
+ ."\n"
+ .'- 1: Valid.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IncidentUpdateInvalid',
- 'errorMessage' => 'The incident update is invalid.',
- ],
- [
- 'errorCode' => 'IncidentStatusInvalid',
- 'errorMessage' => 'The incident status is invalid.',
- ],
- ],
404 => [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
- ],
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"incidentId\\": 2312\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateIncidentResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n <data>\\n <incidentId>2312</incidentId>\\n </data>\\n</UpdateIncidentResponse>","errorExample":""}]',
- ],
- 'RespondIncident' => [
- 'summary' => '事件响应',
- 'path' => '/incident/response',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3811\\",\\n \\"data\\": {\\n \\"problemId\\": \\"231231\\",\\n \\"problemReason\\": \\"故障的原因\\",\\n \\"recentActivity\\": \\"2\\",\\n \\"injectionMode\\": \\"3\\",\\n \\"recoveryMode\\": \\"2\\",\\n \\"discoverSource\\": \\"1\\",\\n \\"userReport\\": 1,\\n \\"monitorSourceName\\": \\"Zabbix\\",\\n \\"relationChanges\\": \\"关联变更\\",\\n \\"dutyUserId\\": 231,\\n \\"replayDutyUserId\\": 23123,\\n \\"replayDutyUserPhone\\": \\"1308787****\\",\\n \\"dutyDepartmentId\\": \\"12312\\",\\n \\"dutyUserName\\": \\"小明\\",\\n \\"dutyUserPhone\\": \\"13098898****\\",\\n \\"replayDutyUserName\\": \\"小花\\",\\n \\"remark\\": \\"备注\\",\\n \\"isManual\\": true,\\n \\"dutyDepartmentName\\": \\"服务组B\\",\\n \\"measureList\\": [\\n {\\n \\"measureId\\": 12312,\\n \\"type\\": 2,\\n \\"content\\": \\"内容A\\",\\n \\"checkStandard\\": \\"验收标准A\\",\\n \\"checkUserId\\": 12,\\n \\"checkUserName\\": \\"小军\\",\\n \\"directorName\\": \\"小张\\",\\n \\"stalkerName\\": \\"小李\\",\\n \\"planFinishTime\\": \\"2021-05-01 00:00:00\\",\\n \\"directorId\\": 212,\\n \\"stalkerId\\": 3121,\\n \\"status\\": \\"UNIMPROVED\\",\\n \\"checkUserIsValid\\": 1,\\n \\"directorIsValid\\": 1,\\n \\"stalkerIsValid\\": 1\\n }\\n ],\\n \\"customProblemReason\\": \\"1\\",\\n \\"replayDutyUserIsValid\\": 1,\\n \\"dutyUserIsValid\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'Fault Post-Mortem Improvement Details ',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-14T12:26:25.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetProblemImprovement',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProblemImprovement'],
+ ],
],
+ ],
+ 'GetProblemPreview' => [
+ 'summary' => 'Previews a problem notification.',
+ 'path' => '/problem/preview',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempHBPHMV',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempLC8226'],
],
'parameters' => [
[
- 'name' => 'Body',
+ 'name' => 'body',
'in' => 'body',
- 'style' => 'flat',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'properties' => [
- 'incidentIds' => [
- 'description' => '影响程度',
- 'items' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'description' => 'Request body.',
+ 'properties' => [
+ 'problemId' => ['description' => 'Problem ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '12312'],
+ 'problemNotifyType' => ['description' => 'Notification type:'."\n"
+ ."\n"
+ .'- PROBLEM\\_NOTIFY: Problem notification.'."\n"
+ ."\n"
+ .'- PROBLEM\\_UPDATE: Problem update.'."\n"
+ ."\n"
+ .'- PROBLEM\\_UPGRADE: Problem upgrade.'."\n"
+ ."\n"
+ .'- PROBLEM\\_DEGRADE: Problem downgrade.'."\n"
+ ."\n"
+ .'- PROBLEM\\_RECOVER: Problem recovery.'."\n"
+ ."\n"
+ .'- PROBLEM\\_REISSUE: Problem reissue.'."\n"
+ ."\n"
+ .'- PROBLEM\\_CANCEL: Problem cancellation.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'PROBLEM_NOTIFY'],
+ 'problemLevel' => ['description' => 'Problem severity level.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'P2'],
+ 'effectServiceIds' => [
+ 'description' => 'Affected services.',
+ 'items' => ['description' => 'Affected service ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1231', 'title' => ''],
'required' => false,
- 'title' => '事件ID数组',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A221',
+ 'relatedServiceId' => ['description' => 'Associated service ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '21312'],
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '213123'],
+ 'serviceGroupIds' => [
+ 'description' => 'Coordination group IDs.',
+ 'items' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12313', 'required' => false, 'title' => ''],
'required' => false,
- 'title' => '幂等校验Id',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '4361a0e1-6747-4834-96ce-0c4840f13812'],
],
- 'required' => true,
- 'title' => 'body参数',
+ 'required' => false,
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => '062E6568-E505-49D6-8DD0-8F11283EB0AB',
- 'title' => 'requestId',
- 'type' => 'string',
+ 'requestId' => ['title' => 'requestId', 'description' => 'Request ID.', 'type' => 'string', 'example' => '4361a0e1-6747-4834-96ce-0c2840fd3812'],
+ 'data' => [
+ 'description' => 'Downgrade rule.',
+ 'properties' => [
+ 'problem' => [
+ 'description' => 'Associated problem.',
+ 'properties' => [
+ 'problemName' => ['description' => 'Problem name.', 'type' => 'string', 'title' => '', 'example' => '故障名称'],
+ 'problemStatus' => ['description' => 'Problem status:'."\n"
+ ."\n"
+ .'- HANDLING: Handling.'."\n"
+ ."\n"
+ .'- RECOVERED: Recovered.'."\n"
+ ."\n"
+ .'- REPLAYING: Reviewing.'."\n"
+ ."\n"
+ .'- REPLAYED: Reviewed.'."\n"
+ ."\n"
+ .'- CANCEL: Canceled.', 'type' => 'string', 'title' => '', 'example' => 'HANDLING'],
+ 'problemLevel' => ['description' => 'Problem severity levels, in descending order:'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'string', 'title' => '', 'example' => 'P2'],
+ 'discoverTime' => ['description' => 'Discovery time.', 'type' => 'string', 'title' => '', 'example' => '2021-02-21 00:00:00'],
+ 'recoveryTime' => ['description' => 'Recovery time.', 'type' => 'string', 'title' => '', 'example' => '2021-02-21 00:00:00'],
+ 'serviceName' => ['description' => 'Associated service name.', 'type' => 'string', 'title' => '', 'example' => '服务A'],
+ 'progressSummary' => ['description' => 'Progress summary.', 'type' => 'string', 'title' => '', 'example' => '摘要123'],
+ 'preliminaryReason' => ['description' => 'Preliminary cause.', 'type' => 'string', 'title' => '', 'example' => '原因A'],
+ 'mainHandlerName' => ['description' => 'Main handler.', 'type' => 'string', 'title' => '', 'example' => '小明'],
+ 'mainHandlerId' => ['description' => 'Main handler ID.', 'type' => 'string', 'title' => '', 'example' => '231'],
+ 'isManual' => ['description' => 'Indicates whether the action is manual.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'isUpgrade' => ['description' => 'Indicates whether the problem was upgraded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'problemId' => ['description' => 'Problem ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123123'],
+ 'relatedServiceId' => ['description' => 'Associated service ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '213123'],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'title' => '', 'example' => '2021-02-21 00:00:00'],
+ 'progressSummaryRichTextId' => ['description' => 'Rich text ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12312', 'title' => ''],
+ 'coordinationGroups' => [
+ 'description' => 'Emergency coordination groups.',
+ 'items' => [
+ 'properties' => [
+ 'serviceGroupName' => ['description' => 'Service group name.', 'type' => 'string', 'title' => '', 'example' => '服务组A'],
+ 'serviceGroupId' => ['description' => 'Service ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1231'],
+ 'serviceGroupDescription' => ['description' => 'Service group description.', 'type' => 'string', 'title' => '', 'example' => '服务组描述'],
+ ],
+ 'type' => 'object',
+ 'description' => 'Emergency coordination group.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'effectionServices' => [
+ 'description' => 'Affected services.',
+ 'items' => [
+ 'properties' => [
+ 'serviceName' => ['description' => 'Affected service name.', 'type' => 'string', 'title' => '', 'example' => '服务B'],
+ 'serviceId' => ['description' => 'Affected service ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1231'],
+ ],
+ 'type' => 'object',
+ 'description' => 'Affected service.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'voice' => [
+ 'description' => 'The voice associated with the problem.',
+ 'properties' => [
+ 'count' => ['description' => 'The total number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12'],
+ 'users' => [
+ 'description' => 'User groups.',
+ 'items' => [
+ 'description' => 'User.',
+ 'properties' => [
+ 'username' => ['description' => 'The user.', 'type' => 'string', 'title' => '', 'example' => '用户名称'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ 'mail' => [
+ 'description' => 'The mailbox.',
+ 'properties' => [
+ 'count' => ['description' => 'The number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'],
+ 'users' => [
+ 'description' => 'User groups.',
+ 'items' => [
+ 'description' => 'User.',
+ 'properties' => [
+ 'username' => ['description' => 'Username.', 'type' => 'string', 'title' => '', 'example' => '用户名称'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ 'sms' => [
+ 'description' => 'SMS notifications.',
+ 'properties' => [
+ 'count' => ['description' => 'The total number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12'],
+ 'users' => [
+ 'description' => 'User groups.',
+ 'items' => [
+ 'description' => 'User.',
+ 'properties' => [
+ 'username' => ['description' => 'Username.', 'type' => 'string', 'title' => '', 'example' => '用户名称'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ 'webhook' => [
+ 'description' => 'Webhook notifications.',
+ 'properties' => [
+ 'count' => ['description' => 'Number of webhook notifications.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '32'],
+ 'serviceGroups' => [
+ 'description' => 'Service groups.',
+ 'items' => [
+ 'description' => 'Service group name.',
+ 'properties' => [
+ 'serviceName' => ['description' => 'Service name.', 'type' => 'string', 'title' => '', 'example' => '服务名称'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => 'webhook',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ 'upBeforeData' => ['description' => 'Data before upgrade.', 'type' => 'string', 'title' => '', 'example' => '最新升级前等级'],
+ 'upAfterData' => ['description' => 'Data after upgrade.', 'type' => 'string', 'title' => '', 'example' => '最新升级后等级'],
+ 'deBeforeData' => ['description' => 'Data before downgrade.', 'type' => 'string', 'title' => '', 'example' => '最新降级前等级'],
+ 'deAfterData' => ['description' => 'Data after downgrade.', 'type' => 'string', 'title' => '', 'example' => '最新降级后等级'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IncidentStatusInvalid',
- 'errorMessage' => 'The incident status is invalid.',
- ],
- [
- 'errorCode' => 'IncidentUpdateInvalid',
- 'errorMessage' => 'The incident update is invalid.',
- ],
- ],
404 => [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
- ],
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"062E6568-E505-49D6-8DD0-8F11283EB0AB\\"\\n}","errorExample":""},{"type":"xml","example":"<RespondIncidentResponse>\\n <requestId>062E6568-E505-49D6-8DD0-8F11283EB0AB</requestId>\\n <data>\\n <IncidentId>12312</IncidentId>\\n </data>\\n</RespondIncidentResponse>","errorExample":""}]',
- ],
- 'ListIncidents' => [
- 'summary' => '获取事件列表',
- 'path' => '/incident/list',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c2840fd3812\\",\\n \\"data\\": {\\n \\"problem\\": {\\n \\"problemName\\": \\"故障名称\\",\\n \\"problemStatus\\": \\"HANDLING\\",\\n \\"problemLevel\\": \\"P2\\",\\n \\"discoverTime\\": \\"2021-02-21 00:00:00\\",\\n \\"recoveryTime\\": \\"2021-02-21 00:00:00\\",\\n \\"serviceName\\": \\"服务A\\",\\n \\"progressSummary\\": \\"摘要123\\",\\n \\"preliminaryReason\\": \\"原因A\\",\\n \\"mainHandlerName\\": \\"小明\\",\\n \\"mainHandlerId\\": \\"231\\",\\n \\"isManual\\": true,\\n \\"isUpgrade\\": true,\\n \\"problemId\\": 123123,\\n \\"relatedServiceId\\": 213123,\\n \\"createTime\\": \\"2021-02-21 00:00:00\\",\\n \\"progressSummaryRichTextId\\": 12312,\\n \\"coordinationGroups\\": [\\n {\\n \\"serviceGroupName\\": \\"服务组A\\",\\n \\"serviceGroupId\\": 1231,\\n \\"serviceGroupDescription\\": \\"服务组描述\\"\\n }\\n ],\\n \\"effectionServices\\": [\\n {\\n \\"serviceName\\": \\"服务B\\",\\n \\"serviceId\\": 1231\\n }\\n ]\\n },\\n \\"voice\\": {\\n \\"count\\": 12,\\n \\"users\\": [\\n {\\n \\"username\\": \\"用户名称\\"\\n }\\n ]\\n },\\n \\"mail\\": {\\n \\"count\\": 123,\\n \\"users\\": [\\n {\\n \\"username\\": \\"用户名称\\"\\n }\\n ]\\n },\\n \\"sms\\": {\\n \\"count\\": 12,\\n \\"users\\": [\\n {\\n \\"username\\": \\"用户名称\\"\\n }\\n ]\\n },\\n \\"webhook\\": {\\n \\"count\\": 32,\\n \\"serviceGroups\\": [\\n {\\n \\"serviceName\\": \\"服务名称\\"\\n }\\n ]\\n },\\n \\"upBeforeData\\": \\"最新升级前等级\\",\\n \\"upAfterData\\": \\"最新升级后等级\\",\\n \\"deBeforeData\\": \\"最新降级前等级\\",\\n \\"deAfterData\\": \\"最新降级后等级\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Get Fault Notification Preview ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetProblemPreview',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProblemPreview'],
+ ],
],
+ ],
+ 'GetResourceStatistics' => [
+ 'summary' => 'Obtain Usage Summary.',
+ 'path' => '/config/resource/count',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZF76LB',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp20VVML'],
],
'parameters' => [
[
@@ -11549,90 +7297,12 @@
'style' => 'json',
'schema' => [
'description' => 'body',
+ 'example' => 'body',
'properties' => [
- 'incidentLevel' => [
- 'description' => '',
- 'example' => 'P1',
- 'required' => false,
- 'title' => '事件级别 P1 P2 P3 P4',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '行',
- 'type' => 'integer',
- ],
- 'effect' => [
- 'description' => '',
- 'example' => 'LOW',
- 'required' => false,
- 'title' => '影响等级 高:HIGH 低 LOW',
- 'type' => 'string',
- ],
- 'relationServiceId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '关联服务ID',
- 'type' => 'integer',
- ],
- 'incidentStatus' => [
- 'description' => '',
- 'example' => 'ASSIGNED',
- 'required' => false,
- 'title' => '事件状态 ASSIGNED已分派 RESPONDED已响应 FINISHED已完结',
- 'type' => 'string',
- ],
- 'me' => [
- 'description' => '',
- 'example' => 'true',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '是否自己 1是 0不是',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E1',
- 'required' => false,
- 'title' => '幂等校验id',
- 'type' => 'string',
- ],
- 'createStartTime' => [
- 'description' => '',
- 'example' => '2021-11-01 00:00:00',
- 'required' => false,
- 'title' => '创建开始时间',
- 'type' => 'string',
- ],
- 'createEndTime' => [
- 'description' => '',
- 'example' => '2021-11-10 00:00:00',
- 'required' => false,
- 'title' => '创建结束时间',
- 'type' => 'string',
- ],
- 'ruleName' => [
- 'description' => '',
- 'example' => 'sa',
- 'required' => false,
- 'title' => '流转规则名字',
- 'type' => 'string',
- ],
+ 'clientToken' => ['description' => 'Idempotency validation ID.', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
+ 'title' => 'body',
'type' => 'object',
],
],
@@ -11642,202 +7312,67 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'requestId',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'title' => 'Id of the request', 'type' => 'string'],
'data' => [
'description' => 'data',
- 'items' => [
- 'description' => 'IncidentItemType',
- 'properties' => [
- 'incidentId' => [
- 'description' => '修改时间',
- 'example' => '12321',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'routeRuleId' => [
- 'description' => '关联的服务ID',
- 'example' => '123',
- 'format' => 'int64',
- 'title' => '流转规则ID',
- 'type' => 'integer',
- ],
- 'routeRuleName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '流转规则',
- 'type' => 'string',
- ],
- 'incidentStatus' => [
- 'description' => '关联流转规则ID',
- 'example' => 'RESPONDED',
- 'title' => '事件状态 0已分派 1已响应 2已完结',
- 'type' => 'string',
- ],
- 'incidentLevel' => [
- 'description' => '影响程度',
- 'example' => 'P4',
- 'title' => '事件级别 P1 P2 P3 P4',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '事件状态',
- 'example' => '213123',
- 'format' => 'int64',
- 'title' => '关联服务ID',
- 'type' => 'integer',
- ],
- 'relatedServiceName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '关联服务名称',
- 'type' => 'string',
- ],
- 'effect' => [
- 'description' => '时间指派人ID',
- 'example' => 'HIGH',
- 'title' => '影响等级 高:HIGH 低 LOW',
- 'type' => 'string',
- ],
- 'assignUserId' => [
- 'description' => '代表创建时间的资源属性字段',
- 'example' => '21312',
- 'format' => 'int64',
- 'title' => '分派的用户ID',
- 'type' => 'integer',
- ],
- 'assignUserName' => [
- 'description' => '代表资源一级ID的资源属性字段',
- 'example' => '',
- 'readOnly' => true,
- 'title' => '分派的用户姓名',
- 'type' => 'string',
- ],
- 'assignUserPhone' => [
- 'description' => '',
- 'example' => '1390000****',
- 'title' => '分派人手机号',
- 'type' => 'string',
- ],
- 'incidentTitle' => [
- 'description' => '事件内容',
- 'example' => '',
- 'title' => '事件标题',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '事件级别',
- 'example' => '2020-10-1 00:00:00',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'isManual' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '事件来源 是=手动 否=自动',
- 'type' => 'boolean',
- ],
- 'incidentNumber' => [
- 'description' => '',
- 'example' => 'I3000021',
- 'title' => '事件编号',
- 'type' => 'string',
- ],
- 'relServiceDeleteType' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '服务删除字段 1正常 0删除',
- 'type' => 'integer',
- ],
- 'relRouteRuleDeleteType' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '规则删除字段 1正常 0删除',
- 'type' => 'integer',
- ],
- 'assignToWhoIsValid' => [
- 'description' => '',
- 'format' => 'int64',
- 'title' => '分派的用户是否生效,1生效,0失效',
- 'type' => 'integer',
- ],
- ],
- 'title' => 'IncidentItemType',
- 'type' => 'object',
+ 'properties' => [
+ 'incidentCount' => ['description' => 'Total number of management events.', 'example' => '1331', 'format' => 'int32', 'title' => '', 'type' => 'integer'],
+ 'alertCount' => ['description' => 'Total number of alerts.', 'example' => '123', 'format' => 'int32', 'title' => '', 'type' => 'integer'],
+ 'problemCount' => ['description' => 'Total number of faults.', 'example' => '221', 'format' => 'int32', 'title' => '', 'type' => 'integer'],
+ 'integrationCount' => ['description' => 'Total number of integrations.', 'example' => '2211', 'format' => 'int32', 'title' => '', 'type' => 'integer'],
],
- 'type' => 'array',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '60',
- 'format' => 'int32',
- 'title' => '总数',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'title' => '行',
- 'type' => 'integer',
+ 'title' => 'data',
+ 'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'UserNotAdded',
- 'errorMessage' => 'The user is not added to the system.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"incidentCount\\": 1331,\\n \\"alertCount\\": 123,\\n \\"problemCount\\": 221,\\n \\"integrationCount\\": 2211\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain Usage Summary',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetResourceStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": [\\n {\\n \\"incidentId\\": 12321,\\n \\"routeRuleId\\": 123,\\n \\"routeRuleName\\": \\"规则A\\",\\n \\"incidentStatus\\": \\"0\\",\\n \\"incidentLevel\\": \\"P4\\",\\n \\"relatedServiceId\\": 213123,\\n \\"relatedServiceName\\": \\"服务A\\",\\n \\"effect\\": \\"HIGH\\",\\n \\"assignUserId\\": 21312,\\n \\"assignUserName\\": \\"小明\\",\\n \\"assignUserPhone\\": \\"1390000****\\",\\n \\"incidentTitle\\": \\"事件A\\",\\n \\"createTime\\": \\"2020-10-1 00:00:00\\",\\n \\"isManual\\": true,\\n \\"incidentNumber\\": \\"I3000021\\",\\n \\"relServiceDeleteType\\": 1,\\n \\"relRouteRuleDeleteType\\": 1,\\n \\"assignToWhoIsValid\\": 8\\n }\\n ],\\n \\"totalCount\\": 60,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListIncidentsResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n <data>\\n <incidentId>12321</incidentId>\\n <routeRuleId>123</routeRuleId>\\n <routeRuleName>规则A</routeRuleName>\\n <incidentStatus>RESPONDED</incidentStatus>\\n <incidentLevel>P4</incidentLevel>\\n <relatedServiceId>213123</relatedServiceId>\\n <relatedServiceName>服务A</relatedServiceName>\\n <effect>HIGH</effect>\\n <assignUserId>21312</assignUserId>\\n <assignUserName>小明</assignUserName>\\n <assignUserPhone>1390000****</assignUserPhone>\\n <incidentTitle>事件A</incidentTitle>\\n <createTime>2020-10-1 00:00:00</createTime>\\n <isManual>true</isManual>\\n <incidentNumber>I3000021</incidentNumber>\\n </data>\\n <totalCount>60</totalCount>\\n <pageNumber>1</pageNumber>\\n <pageSize>10</pageSize>\\n</ListIncidentsResponse>","errorExample":""}]',
- ],
- 'ListIncidentDetailTimelines' => [
- 'summary' => '查询事件详情动态',
- 'path' => '/incident/detail/timeline',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceStatistics'],
+ ],
],
+ ],
+ 'GetRichText' => [
+ 'summary' => 'Retrieve rich text information.',
+ 'path' => '/rich/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempJ0ENN8',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp71I60H'],
],
'parameters' => [
[
@@ -11845,189 +7380,114 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'Request body.',
'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '事件ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'required' => false,
- 'title' => '幂等校验',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '行',
- 'type' => 'integer',
- ],
- 'idSort' => [
- 'title' => 'id排序方式(desc 倒序,asc 正序)',
- 'type' => 'string',
- ],
+ 'richTextId' => ['description' => 'Rich text ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '140080050', 'title' => '', 'required' => false],
+ 'instanceId' => ['description' => 'Resource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '140080050', 'title' => '', 'required' => false],
+ 'instanceType' => ['description' => 'Resource type:'."\n"
+ ."\n"
+ .'- INCIDENT: Event.'."\n"
+ ."\n"
+ .'- ALERT: Alert.'."\n"
+ ."\n"
+ .'- PROBLEM: Problem.', 'type' => 'string', 'required' => false, 'example' => 'INCIDENT', 'title' => ''],
],
'required' => false,
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '4AA343E4-AB98-56D9-B699-D932902BA3EC'],
'data' => [
- 'description' => 'data',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'title' => [
- 'description' => '',
- 'example' => '',
- 'title' => '主题',
- 'type' => 'string',
- ],
- 'description' => [
- 'description' => '',
- 'example' => '',
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'remark' => [
- 'description' => '',
- 'example' => '',
- 'title' => '备注',
- 'type' => 'string',
- ],
- 'relatedServiceName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '服务名称',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'incidentId' => [
- 'description' => '',
- 'example' => '',
- 'format' => 'int64',
- 'title' => '事件Id',
- 'type' => 'integer',
- ],
- 'action' => [
- 'description' => '',
- 'example' => 'INCIDENT_ADD',
- 'title' => '事件action',
- 'type' => 'string',
- ],
- 'snapshotData' => [
- 'description' => '',
- 'example' => '',
- 'title' => '快照数据',
- 'type' => 'string',
- ],
- 'relRouteRuleDeleteType' => [
- 'title' => '规则删除字段 1正常 0删除或者无规则',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- 'type' => 'object',
+ 'description' => 'Returned data.',
+ 'properties' => [
+ 'instanceId' => ['description' => 'Resource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '140080050', 'title' => ''],
+ 'richText' => ['description' => 'Rich text content.', 'type' => 'string', 'example' => '这是一个富文本', 'title' => ''],
+ 'instanceType' => ['description' => 'Resource type:'."\n"
+ ."\n"
+ .'- 0: Event.'."\n"
+ ."\n"
+ .'- 1: Alert.'."\n"
+ ."\n"
+ .'- 2: Problem.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
],
- 'type' => 'array',
- ],
- 'totalCount' => [
- 'description' => '',
+ 'title' => 'data',
+ 'type' => 'object',
'example' => '',
- 'format' => 'int32',
- 'title' => '总数',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4AA343E4-AB98-56D9-B699-D932902BA3EC\\",\\n \\"data\\": {\\n \\"instanceId\\": 140080050,\\n \\"richText\\": \\"这是一个富文本\\",\\n \\"instanceType\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve rich text information ',
+ 'requestParamsDescription' => '{'."\n"
+ .'"richTextId" : 111111,'."\n"
+ .'"instanceId" : 111111111,'."\n"
+ .'"instanceType" : "INCIDENT"'."\n"
+ .'}',
+ 'responseParamsDescription' => '{'."\n"
+ .'"elapsedTime": 0,'."\n"
+ .'"requestId": "4AA343E4-AB98-56D9-B699-D932902BA3EC",'."\n"
+ .'"success": true,'."\n"
+ .'"errCode": 200,'."\n"
+ .'"errMessage": null,'."\n"
+ .'"data": {'."\n"
+ .'"id": 140080050,'."\n"
+ .'"instanceId": 133,'."\n"
+ .'"instanceType": 0,'."\n"
+ .'"richText": "null"'."\n"
+ .'}'."\n"
+ .'}',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetRichText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": [\\n {\\n \\"title\\": \\"标题\\",\\n \\"description\\": \\"描述\\",\\n \\"remark\\": \\"备注A\\",\\n \\"relatedServiceName\\": \\"服务A\\",\\n \\"createTime\\": \\"创建时间\\",\\n \\"incidentId\\": 0,\\n \\"action\\": \\"INCIDENT_ADD\\",\\n \\"snapshotData\\": \\"{\\\\\\"userName\\\\\\":\\\\\\"小明\\\\\\"}\\",\\n \\"relRouteRuleDeleteType\\": 1\\n }\\n ],\\n \\"totalCount\\": 100,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListIncidentDetailTimelinesResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n <data>\\n <title>标题</title>\\n <description>描述</description>\\n <relatedServiceName>服务A</relatedServiceName>\\n <createTime>创建时间</createTime>\\n </data>\\n</ListIncidentDetailTimelinesResponse>","errorExample":""}]',
- ],
- 'ListIncidentTimelines' => [
- 'summary' => '事件动态',
- 'path' => '/incident/timeline',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRichText'],
+ ],
],
+ ],
+ 'GetRouteRule' => [
+ 'summary' => 'View rule details.',
+ 'path' => '/routeRule/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZF76LB',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempJRUU6V'],
],
'parameters' => [
[
@@ -12035,190 +7495,287 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'required' => false,
- 'title' => '幂等校验Id',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '行',
- 'type' => 'integer',
- ],
+ 'routeRuleId' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '6B9347ED-FD93-42B4-B9A4-7282962F5D6A', 'title' => ''],
'data' => [
- 'description' => 'data',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'title' => [
- 'description' => '',
- 'example' => '',
- 'title' => '动态',
- 'type' => 'string',
- ],
- 'description' => [
- 'description' => '',
- 'example' => '',
- 'format' => 'int64',
- 'title' => '描述',
- 'type' => 'integer',
- ],
- 'remark' => [
- 'description' => '',
- 'example' => '',
- 'title' => '备注',
- 'type' => 'string',
- ],
- 'relatedServiceName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '服务名称',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2021-06-23 00:00:00',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'incidentTitle' => [
- 'description' => '',
+ 'description' => 'Rule details.',
+ 'properties' => [
+ 'routeRuleId' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '180000000', 'title' => ''],
+ 'ruleName' => ['description' => 'Routing rule name.', 'type' => 'string', 'example' => '规则1', 'title' => ''],
+ 'timeWindow' => ['description' => 'Time window.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'relatedServiceName' => ['description' => 'Associated service name.', 'type' => 'string', 'example' => '冲上云霄', 'title' => ''],
+ 'enableStatus' => ['description' => 'Whether the rule is enabled:'."\n"
+ ."\n"
+ .'- DISABLE: Disabled.'."\n"
+ ."\n"
+ .'- ENABLE: Enabled.', 'type' => 'string', 'example' => 'disable', 'title' => ''],
+ 'relatedServiceId' => ['description' => 'Associated service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'routeType' => ['description' => 'Routing type:'."\n"
+ ."\n"
+ .'- INCIDENT: Trigger an incident.'."\n"
+ ."\n"
+ .'- ALERT: Trigger only an alert.', 'type' => 'string', 'example' => 'INCIDENT', 'title' => ''],
+ 'incidentLevel' => ['description' => 'Incident severity level:'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'string', 'example' => 'P1', 'title' => ''],
+ 'assignObjectId' => ['description' => 'Assigned object ID (service group ID or user ID).', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'assignObjectType' => ['description' => 'Assigned object type:'."\n"
+ ."\n"
+ .'- SERVICEGROUP: Service group.'."\n"
+ ."\n"
+ .'- USER: Individual user.', 'type' => 'string', 'example' => 'SERVICEGROUP', 'title' => ''],
+ 'effection' => ['description' => 'Severity:'."\n"
+ ."\n"
+ .'- LOW: Minor.'."\n"
+ ."\n"
+ .'- HIGH: Critical.', 'type' => 'string', 'example' => 'LOW', 'title' => ''],
+ 'matchCount' => ['description' => 'Number of matches.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''],
+ 'childRuleRelation' => ['description' => 'Child rule relationship:'."\n"
+ ."\n"
+ .'- AND: AND.'."\n"
+ ."\n"
+ .'- OR: OR.', 'type' => 'string', 'example' => 'AND、OR', 'title' => ''],
+ 'eventRouteChildRules' => [
+ 'description' => 'Child rules.',
+ 'items' => [
+ 'description' => 'Child rule.',
+ 'properties' => [
+ 'childRouteRuleId' => ['description' => 'Child rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'isValidChildRule' => ['description' => 'Whether the child rule is valid:'."\n"
+ ."\n"
+ .'- true: Valid.'."\n"
+ ."\n"
+ .'- false: Invalid.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'parentRuleId' => ['description' => 'Parent rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1800', 'title' => ''],
+ 'monitorSourceId' => ['description' => 'Monitoring source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'monitorIntegrationConfigId' => ['description' => 'Integration configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'monitorSourceName' => ['description' => 'Monitoring source name.', 'type' => 'string', 'example' => 'zabbix', 'title' => ''],
+ 'childConditionRelation' => ['description' => 'Child condition relationship:'."\n"
+ ."\n"
+ .'- 0: AND.'."\n"
+ ."\n"
+ .'- 1: OR.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'conditions' => [
+ 'description' => 'Matching conditions.',
+ 'items' => [
+ 'description' => 'Condition.',
+ 'properties' => [
+ 'key' => ['description' => 'Condition key.', 'type' => 'string', 'example' => 'alarmName', 'title' => ''],
+ 'value' => ['description' => 'Match value.', 'type' => 'string', 'example' => 'Zabbix server', 'title' => ''],
+ 'operationSymbol' => ['description' => 'Operator.', 'type' => 'string', 'example' => 'contain', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'problemLevel' => ['description' => 'Problem severity level.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
'example' => '',
- 'title' => '事件标题',
- 'type' => 'string',
- ],
- 'action' => [
- 'description' => '',
- 'example' => 'INCIDENT_ADD',
- 'title' => '动态类型 触发新增 INCIDENT_ADD 响应 INCIDENT_RESPONSE 转交 INCIDENT_DELIVER 变更 INCIDENT_UPDATE 添加小计 INCIDENT_ADD_SUBTOTAL 完结 INCIDENT_FINISH 分配 INCIDENT_ASSIGN 升级 INCIDENT_UPGRAD',
- 'type' => 'string',
- ],
- 'incidentId' => [
- 'description' => '',
- 'example' => '3321',
- 'format' => 'int64',
- 'title' => '事件Id',
- 'type' => 'integer',
- ],
- 'incidentNumber' => [
- 'description' => '',
- 'example' => 'I13002001',
- 'title' => '事件编号',
- 'type' => 'string',
],
- 'snapshotData' => [
- 'description' => '',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2020-09-08 15:30:30', 'title' => ''],
+ 'updateTime' => ['description' => 'Last update time.', 'type' => 'string', 'example' => '2020-09-08 15:30:30', 'title' => ''],
+ 'notifyChannels' => [
+ 'description' => 'Notification channels.',
+ 'items' => ['description' => 'Notification channel.', 'type' => 'string', 'example' => '[SMS,PHONE]', 'title' => ''],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'notifyChannelNames' => [
+ 'description' => 'Notification channel names.',
+ 'items' => ['description' => 'Notification channel name.', 'type' => 'string', 'example' => '[短信,电话]', 'title' => ''],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'assignObjectName' => ['description' => 'Assigned object name.', 'type' => 'string', 'example' => '刘先生', 'title' => ''],
+ 'relServiceDeleteType' => ['description' => 'Service deletion field.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'problemLevelGroup' => [
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'childRuleRelation' => ['description' => 'Child rule relationship.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '11'],
+ 'matchCount' => ['description' => 'Count.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '11'],
+ 'timeWindow' => ['description' => 'Time window.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'timeWindowUnit' => ['description' => 'Time unit.', 'type' => 'string', 'title' => '', 'example' => '1'],
+ 'enableUpgrade' => ['description' => 'Whether enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'upgradeTimeWindow' => ['description' => 'The time window for the upgrade.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'upgradeTimeWindowUnit' => ['description' => 'Service unit.', 'type' => 'string', 'title' => '', 'example' => '1'],
+ ],
+ 'description' => 'Service group.',
+ 'title' => '',
'example' => '',
- 'title' => '动态快照数据',
- 'type' => 'string',
- ],
- 'relRouteRuleDeleteType' => [
- 'title' => '规则删除字段',
- 'type' => 'integer',
- 'format' => 'int32',
],
+ 'type' => 'object',
+ 'description' => 'Problem severity level group.',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'object',
+ 'coverageProblemLevels' => [
+ 'description' => 'Problem severity level coverage.',
+ 'items' => ['description' => 'Problem severity level.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'problemEffectionServices' => [
+ 'description' => 'Services affected by the problem.',
+ 'items' => ['description' => 'Service associated with the problem.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'convergenceFields' => [
+ 'description' => 'Convergence field collection.',
+ 'title' => 'Convergence Fields Collection',
+ 'type' => 'array',
+ 'items' => ['description' => 'Convergence field name.', 'type' => 'string', 'example' => 'name', 'title' => ''],
+ 'example' => '',
+ ],
+ 'convergenceType' => ['title' => 'Convergence type (0: stream rule convergence, 1: field convergence) ', 'description' => 'Convergence type:'."\n"
+ ."\n"
+ .'- 0: Rule-based convergence.'."\n"
+ ."\n"
+ .'- 1: Field-based convergence.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
- 'type' => 'array',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '132',
- 'format' => 'int32',
- 'title' => '总数',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'type' => 'integer',
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
- ],
+ ['errorCode' => 'RouteRuleNotExisted', 'errorMessage' => 'The rule does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": [\\n {\\n \\"title\\": \\"标题\\",\\n \\"description\\": 0,\\n \\"remark\\": \\"备注A\\",\\n \\"relatedServiceName\\": \\"服务A\\",\\n \\"createTime\\": \\"2021-06-23 00:00:00\\",\\n \\"incidentTitle\\": \\"事件标题\\",\\n \\"action\\": \\"INCIDENT_ADD\\",\\n \\"incidentId\\": 3321,\\n \\"incidentNumber\\": \\"I13002001\\",\\n \\"snapshotData\\": \\"{\\\\\\"userName\\\\\\":\\\\\\"小明\\\\\\"}\\",\\n \\"relRouteRuleDeleteType\\": 1\\n }\\n ],\\n \\"totalCount\\": 132,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListIncidentTimelinesResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n <data>\\n <title>标题</title>\\n <relatedServiceName>服务A</relatedServiceName>\\n <createTime>2021-06-23 00:00:00</createTime>\\n <incidentTitle>事件标题</incidentTitle>\\n <aciton>INCIDENTRESPONSE</aciton>\\n </data>\\n</ListIncidentTimelinesResponse>","errorExample":""}]',
- ],
- 'GetIncidentSubtotalCount' => [
- 'summary' => '查询事件对应的小计数量',
- 'path' => '/incident/subtotal/count',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6B9347ED-FD93-42B4-B9A4-7282962F5D6A\\",\\n \\"data\\": {\\n \\"routeRuleId\\": 180000000,\\n \\"ruleName\\": \\"规则1\\",\\n \\"timeWindow\\": 3,\\n \\"relatedServiceName\\": \\"冲上云霄\\",\\n \\"enableStatus\\": \\"disable\\",\\n \\"relatedServiceId\\": 1000,\\n \\"routeType\\": \\"INCIDENT\\",\\n \\"incidentLevel\\": \\"P1\\",\\n \\"assignObjectId\\": 1000,\\n \\"assignObjectType\\": \\"SERVICEGROUP\\",\\n \\"effection\\": \\"LOW\\",\\n \\"matchCount\\": 3,\\n \\"childRuleRelation\\": \\"AND、OR\\",\\n \\"eventRouteChildRules\\": [\\n {\\n \\"childRouteRuleId\\": 1000,\\n \\"isValidChildRule\\": false,\\n \\"parentRuleId\\": 1800,\\n \\"monitorSourceId\\": 1,\\n \\"monitorIntegrationConfigId\\": 1,\\n \\"monitorSourceName\\": \\"zabbix\\",\\n \\"childConditionRelation\\": 1,\\n \\"conditions\\": [\\n {\\n \\"key\\": \\"alarmName\\",\\n \\"value\\": \\"Zabbix server\\",\\n \\"operationSymbol\\": \\"contain\\"\\n }\\n ],\\n \\"problemLevel\\": \\"1\\"\\n }\\n ],\\n \\"createTime\\": \\"2020-09-08 15:30:30\\",\\n \\"updateTime\\": \\"2020-09-08 15:30:30\\",\\n \\"notifyChannels\\": [\\n \\"[SMS,PHONE]\\"\\n ],\\n \\"notifyChannelNames\\": [\\n \\"[短信,电话]\\"\\n ],\\n \\"assignObjectName\\": \\"刘先生\\",\\n \\"relServiceDeleteType\\": 1,\\n \\"problemLevelGroup\\": {\\n \\"key\\": {\\n \\"childRuleRelation\\": 11,\\n \\"matchCount\\": 11,\\n \\"timeWindow\\": 1,\\n \\"timeWindowUnit\\": \\"1\\",\\n \\"enableUpgrade\\": true,\\n \\"upgradeTimeWindow\\": 1,\\n \\"upgradeTimeWindowUnit\\": \\"1\\"\\n }\\n },\\n \\"coverageProblemLevels\\": [\\n \\"1\\"\\n ],\\n \\"problemEffectionServices\\": [\\n 1\\n ],\\n \\"convergenceFields\\": [\\n \\"name\\"\\n ],\\n \\"convergenceType\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => 'View rule details',
+ 'requestParamsDescription' => '{'."\n"
+ .'"routeRuleId" : 1'."\n"
+ .'}',
+ 'responseParamsDescription' => '{'."\n"
+ .'"requestId": "6B9347ED-FD93-42B4-B9A4-7282962F5D6A",'."\n"
+ .'"data": {'."\n"
+ .'"routeRuleId": 180000000,'."\n"
+ .'"ruleName": "Rule 1",'."\n"
+ .'"timeWindow": 3,'."\n"
+ .'"relatedServiceName": "Soar to the Cloud",'."\n"
+ .'"enableStatus": "DISABLE",'."\n"
+ .'"relatedServiceId": 1000,'."\n"
+ .'"routeType": "INCIDENT",'."\n"
+ .'"incidentLevel": "P1",'."\n"
+ .'"assignObjectId": 1000,'."\n"
+ .'"assignObjectType": "SERVICEGROUP",'."\n"
+ .'"effection": "LOW",'."\n"
+ .'"matchCount": 3,'."\n"
+ .'"eventRouteChildRules": \\['."\n"
+ .'{'."\n"
+ .'"childRouteRuleId": 1000,'."\n"
+ .'"isValidChildRule": false,'."\n"
+ .'"parentRuleId": 1800,'."\n"
+ .'"monitorSourceId": 1,'."\n"
+ .'"monitorIntegrationConfigId": 1,'."\n"
+ .'"monitorSourceName": "zabbix",'."\n"
+ .'"conditions": \\['."\n"
+ .'{'."\n"
+ .'"key": "alarmName",'."\n"
+ .'"value": "Zabbix server",'."\n"
+ .'"operationSymbol": "contain"'."\n"
+ .'}'."\n"
+ .']'."\n"
+ .'}'."\n"
+ .'],'."\n"
+ .'"createTime": "2020-09-08 15:30:30",'."\n"
+ .'"updateTime": "2020-09-08 15:30:30",'."\n"
+ .'"notifyChannels": \\['."\n"
+ .'"\\[SMS,PHONE]"'."\n"
+ .'],'."\n"
+ .'"notifyChannelNames": \\['."\n"
+ .'"\\[SMS, PHONE]"'."\n"
+ .'],'."\n"
+ .'"assignObjectName": "Mr. Liu"'."\n"
+ .'}'."\n"
+ .'}',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-07T12:30:08.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-06-07T11:52:18.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRouteRule'],
+ ],
],
+ ],
+ 'GetService' => [
+ 'summary' => 'Queries the details of a service.',
+ 'path' => '/services/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp71I60H',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
'parameters' => [
[
@@ -12226,96 +7783,100 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'The request body.',
'properties' => [
- 'incidentIds' => [
- 'description' => '',
- 'items' => [
- 'example' => '6754',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'required' => true,
- 'title' => '事件id列表',
- 'type' => 'array',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
- 'required' => false,
- 'title' => '幂等标识',
- 'type' => 'string',
- ],
+ 'serviceId' => ['description' => 'The service ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1'],
+ 'clientToken' => ['description' => 'The idempotence token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
'data' => [
- 'description' => 'data',
+ 'description' => 'The service details.',
'properties' => [
- 'subtotalCount' => [
- 'description' => 'map',
- 'example' => '{12:12}',
- 'title' => 'map',
- 'type' => 'object',
- ],
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => '24343424234',
- 'title' => 'id of the request',
- 'type' => 'string',
+ 'serviceId' => ['description' => 'The service ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'serviceName' => ['description' => 'The service name.', 'type' => 'string', 'title' => '', 'example' => '保洁服务'],
+ 'serviceDescription' => ['description' => 'The service description.', 'type' => 'string', 'title' => '', 'example' => '服务描述'],
+ 'updateTime' => ['description' => 'The time when the service was last updated.', 'type' => 'string', 'title' => '', 'example' => '2020-03-08 12:53:53'],
+ 'serviceGroupIdList' => [
+ 'minItems' => 0,
+ 'description' => 'The list of service group IDs.',
+ 'title' => 'Service Group ID List',
+ 'type' => 'array',
+ 'items' => ['title' => 'Service Group ID', 'description' => 'The service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1'],
+ 'example' => '',
],
+ 'escalationPlanId' => ['title' => 'Escalation Policy ID', 'description' => 'The escalation policy ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
- 'title' => 'data',
+ 'title' => '',
'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"data\\": {\\n \\"subtotalCount\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"requestId\\": \\"24343424234\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetIncidentSubtotalCountResponse>\\n <data>\\n <subtotalCount>\\n <193594331>2</193594331>\\n </subtotalCount>\\n </data>\\n</GetIncidentSubtotalCountResponse>","errorExample":""}]',
- ],
- 'GetSimilarIncidentStatistics' => [
- 'summary' => '相似事件统计信息',
- 'path' => '/incident/similarIncident/statistics',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'ServiceNotExisted', 'errorMessage' => 'The service does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": {\\n \\"serviceId\\": 1,\\n \\"serviceName\\": \\"保洁服务\\",\\n \\"serviceDescription\\": \\"服务描述\\",\\n \\"updateTime\\": \\"2020-03-08 12:53:53\\",\\n \\"serviceGroupIdList\\": [\\n 1\\n ],\\n \\"escalationPlanId\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'Query Service Details ',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:53.000Z', 'description' => 'Response parameters changed'],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetService'],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'GetServiceGroup' => [
+ 'summary' => 'View the details of a service group.',
+ 'path' => '/services/group/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp3X5SLU',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
'parameters' => [
[
@@ -12323,385 +7884,127 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '32',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '事件id',
- 'type' => 'integer',
- ],
- 'incidentTitle' => [
- 'description' => '',
- 'example' => 'xxx事件',
- 'required' => true,
- 'title' => '事件标题',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2021-09-09 09:09:09',
- 'required' => true,
- 'title' => '触发时间',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '23',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '关联服务id',
- 'type' => 'integer',
- ],
- 'events' => [
- 'description' => '',
- 'items' => [
- 'example' => 'xxx',
- 'required' => true,
- 'type' => 'string',
- ],
- 'required' => true,
- 'title' => '事件告警内容',
- 'type' => 'array',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
- 'required' => false,
- 'title' => '幂等标识',
- 'type' => 'string',
- ],
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2323232', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
- 'title' => 'id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => ''],
'data' => [
- 'description' => 'data',
+ 'description' => 'Returned result.',
'properties' => [
- 'topFiveIncidents' => [
- 'description' => 'topFiveIncidents',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '32',
- 'format' => 'int64',
- 'title' => '事件id',
- 'type' => 'integer',
- ],
- 'incidentNumber' => [
- 'description' => '',
- 'example' => 'I34324',
- 'title' => '事件编号',
- 'type' => 'string',
- ],
- 'incidentTitle' => [
- 'description' => '',
- 'example' => 'xxx事件',
- 'title' => '事件标题',
- 'type' => 'string',
- ],
- 'relatedRouteRuleId' => [
- 'description' => '',
- 'example' => '4343',
- 'format' => 'int64',
- 'title' => '流转规则id',
- 'type' => 'integer',
- ],
- 'relatedRouteRuleName' => [
- 'description' => '',
- 'example' => 'xxx',
- 'title' => '流转规则名称',
- 'type' => 'string',
- ],
- 'finishReason' => [
- 'description' => '',
- 'example' => '2',
- 'format' => 'int64',
- 'title' => '触发原因',
- 'type' => 'integer',
- ],
- 'finishReasonDescription' => [
- 'description' => '',
- 'example' => 'xxxx原因',
- 'title' => '触发原因描述',
- 'type' => 'string',
- ],
- 'incidentFinishSolution' => [
- 'description' => '',
- 'example' => '5',
- 'format' => 'int64',
- 'title' => '解决方案',
- 'type' => 'integer',
- ],
- 'finishSolutionDescription' => [
- 'description' => '',
- 'example' => 'xxx方案',
- 'title' => '解决方案描述',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2021-09-09 09:09:09',
- 'title' => '触发时间',
- 'type' => 'string',
- ],
- 'assignUserId' => [
- 'description' => '',
- 'example' => '43',
- 'title' => '分派人id',
- 'type' => 'string',
- ],
- 'assignUserName' => [
- 'description' => '',
- 'example' => '张老三',
- 'title' => '分派人',
- 'type' => 'string',
- ],
- 'durationTime' => [
- 'description' => '',
- 'example' => '6787678767',
- 'format' => 'int64',
- 'title' => '持续时间',
- 'type' => 'integer',
- ],
- 'similarScore' => [
- 'description' => '',
- 'example' => '1992.21',
- 'title' => '相似度',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => 'topFiveIncidents',
- 'type' => 'array',
- ],
- 'countInSixMonths' => [
- 'description' => '',
- 'example' => '43',
- 'format' => 'int64',
- 'title' => '6月内相似事件数量',
- 'type' => 'integer',
- ],
- 'countInSevenDays' => [
- 'description' => '',
- 'example' => '8',
- 'format' => 'int64',
- 'title' => '7天内相似事件数量',
- 'type' => 'integer',
- ],
- 'dailySimilarIncidents' => [
- 'description' => '',
- 'example' => '{}',
+ 'updateTime' => ['description' => 'Modification time.', 'type' => 'string', 'example' => '2020-05-03 15:39:39', 'title' => ''],
+ 'users' => [
+ 'description' => 'Array of user IDs.',
'items' => [
- 'description' => 'object',
+ 'description' => 'User ID.',
'properties' => [
- 'date' => [
- 'description' => '',
- 'example' => '2021-03-07',
- 'title' => '日期',
- 'type' => 'string',
- ],
- 'commitment' => [
- 'description' => '',
- 'example' => '0',
- 'format' => 'int64',
- 'title' => '数量',
- 'type' => 'integer',
- ],
- 'month' => [
- 'description' => '',
- 'example' => '2',
- 'format' => 'int64',
- 'title' => '月份',
- 'type' => 'integer',
- ],
- 'week' => [
- 'description' => '',
- 'example' => '1',
- 'title' => '周',
- 'type' => 'string',
- ],
- 'day' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '星期几',
- 'type' => 'integer',
- ],
- 'similarIncidents' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '5435',
- 'format' => 'int64',
- 'title' => '事件id',
- 'type' => 'integer',
- ],
- 'incidentNumber' => [
- 'description' => '',
- 'example' => 'I234432',
- 'title' => '事件编号',
- 'type' => 'string',
- ],
- 'incidentTitle' => [
- 'description' => '',
- 'example' => '线性代数发多少',
- 'title' => '事件名称',
- 'type' => 'string',
- ],
- 'relatedRouteRuleId' => [
- 'description' => '',
- 'example' => '334',
- 'format' => 'int64',
- 'title' => '流转规则id',
- 'type' => 'integer',
- ],
- 'relatedRouteRuleName' => [
- 'description' => '',
- 'example' => 'xxx规则',
- 'title' => '流转规则名称',
- 'type' => 'string',
- ],
- 'finishReason' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '触发原因',
- 'type' => 'integer',
- ],
- 'finishReasonDescription' => [
- 'description' => '',
- 'example' => 'xx原因',
- 'title' => '触发原因描述',
- 'type' => 'string',
- ],
- 'incidentFinishSolution' => [
- 'description' => '',
- 'example' => '5',
- 'format' => 'int64',
- 'title' => '解决方案',
- 'type' => 'integer',
- ],
- 'finishSolutionDescription' => [
- 'description' => '',
- 'example' => 'xxx方案',
- 'title' => '解决方案描述',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2021-09-09 09:09:09',
- 'title' => '触发时间',
- 'type' => 'string',
- ],
- 'assignUserName' => [
- 'description' => '',
- 'example' => '张老三',
- 'title' => '分派人',
- 'type' => 'string',
- ],
- 'assignUserId' => [
- 'description' => '',
- 'example' => '433',
- 'format' => 'int64',
- 'title' => '分派人id',
- 'type' => 'integer',
- ],
- 'durationTime' => [
- 'description' => '',
- 'example' => '6789765678',
- 'format' => 'int64',
- 'title' => '持续时间',
- 'type' => 'integer',
- ],
- 'similarScore' => [
- 'description' => '',
- 'example' => '1003.567',
- 'title' => '相似度',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '相似事件列表',
+ 'userId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'userName' => ['description' => 'Username.', 'type' => 'string', 'example' => 'jack', 'title' => ''],
+ 'phone' => ['description' => 'Phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''],
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'roleNameList' => [
+ 'description' => 'Role list.',
+ 'title' => 'Role List ',
'type' => 'array',
+ 'items' => ['title' => 'Role Name ', 'description' => 'Role name.', 'type' => 'string', 'example' => '测试'],
+ 'example' => '',
],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '根据日期分类',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => 'uyihg6789',
- 'title' => 'id of the request',
- 'type' => 'string',
- ],
+ 'serviceGroupDescription' => ['description' => 'Service group description.', 'type' => 'string', 'example' => '服务描述', 'title' => ''],
+ 'webhookLink' => ['description' => 'Webhook URL.', 'type' => 'string', 'example' => 'wwwwwww', 'title' => ''],
+ 'webhookType' => ['description' => 'Webhook type:'."\n"
+ ."\n"
+ .'- WEIXIN\\_GROUP: WeCom group.'."\n"
+ ."\n"
+ .'- DING\\_GROUP: DingTalk group.', 'type' => 'string', 'example' => 'WEIXIN_GROUP', 'title' => ''],
+ 'enableWebhook' => ['description' => '- ENABLE: Enable.'."\n"
+ ."\n"
+ .'- DISABLE: Disable.', 'type' => 'string', 'example' => 'ENABLE', 'title' => ''],
+ 'serviceGroupName' => ['description' => 'Service group name.', 'type' => 'string', 'example' => '冲上云霄', 'title' => ''],
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2020-08-08 10:00:00', 'title' => ''],
],
- 'title' => 'data',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"7C56D225-7C34-40BB-9624-C8BA449260E6\\",\\n \\"data\\": {\\n \\"topFiveIncidents\\": [\\n {\\n \\"incidentId\\": 32,\\n \\"incidentNumber\\": \\"I34324\\",\\n \\"incidentTitle\\": \\"测试事件标题\\",\\n \\"relatedRouteRuleId\\": 4343,\\n \\"relatedRouteRuleName\\": \\"xxx\\",\\n \\"finishReason\\": 2,\\n \\"finishReasonDescription\\": \\"处罚原因描述测试\\",\\n \\"incidentFinishSolution\\": 5,\\n \\"finishSolutionDescription\\": \\"测试方案\\",\\n \\"createTime\\": \\"2021-09-09 09:09:09\\",\\n \\"assignUserId\\": \\"43\\",\\n \\"assignUserName\\": \\"马先生\\",\\n \\"durationTime\\": 6787678767,\\n \\"similarScore\\": \\"1992.21\\"\\n }\\n ],\\n \\"countInSixMonths\\": 43,\\n \\"countInSevenDays\\": 8,\\n \\"dailySimilarIncidents\\": [\\n {\\n \\"date\\": \\"2021-03-07\\",\\n \\"commitment\\": 0,\\n \\"month\\": 2,\\n \\"week\\": \\"1\\",\\n \\"day\\": 1,\\n \\"similarIncidents\\": [\\n {\\n \\"incidentId\\": 5435,\\n \\"incidentNumber\\": \\"I234432\\",\\n \\"incidentTitle\\": \\"事件A\\",\\n \\"relatedRouteRuleId\\": 334,\\n \\"relatedRouteRuleName\\": \\"测试规则A\\",\\n \\"finishReason\\": 1,\\n \\"finishReasonDescription\\": \\"测试原因B\\",\\n \\"incidentFinishSolution\\": 5,\\n \\"finishSolutionDescription\\": \\"测试方案A\\",\\n \\"createTime\\": \\"2021-09-09 09:09:09\\",\\n \\"assignUserName\\": \\"马先生\\",\\n \\"assignUserId\\": 433,\\n \\"durationTime\\": 6789765678,\\n \\"similarScore\\": \\"1003.567\\"\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"7C56D225-7C34-40BB-9624-C8BA449260E6\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSimilarIncidentStatisticsResponse>\\n <requestId>7C56D225-7C34-40BB-9624-C8BA449260E6</requestId>\\n <data>\\n <topFiveIncidents>\\n <incidentId>32</incidentId>\\n <incidentNumber>I34324</incidentNumber>\\n <incidentTitle>xxx事件</incidentTitle>\\n <relatedRouteRuleId>4343</relatedRouteRuleId>\\n <relatedRouteRuleName>xxx</relatedRouteRuleName>\\n <finishReason>2</finishReason>\\n <finishReasonDescription>xxxx原因</finishReasonDescription>\\n <incidentFinishSolution>5</incidentFinishSolution>\\n <finishSolutionDescription>xxx方案</finishSolutionDescription>\\n <createTime>2021-09-09 09:09:09</createTime>\\n <assignUserId>43</assignUserId>\\n <assignUserName>张老三</assignUserName>\\n <durationTime>6787678767</durationTime>\\n <similarScore>1992.21</similarScore>\\n </topFiveIncidents>\\n <countInSixMonths>43</countInSixMonths>\\n <countInSevenDays>8</countInSevenDays>\\n <dailySimilarIncidents>\\n <date>2021-03-07</date>\\n <commitment>0</commitment>\\n <month>2</month>\\n <week>1</week>\\n <day>1</day>\\n <similarIncidents>\\n <incidentId>5435</incidentId>\\n <incidentNumber>I234432</incidentNumber>\\n <incidentTitle>线性代数发多少</incidentTitle>\\n <relatedRouteRuleId>334</relatedRouteRuleId>\\n <relatedRouteRuleName>xxx规则</relatedRouteRuleName>\\n <finishReason>1</finishReason>\\n <finishReasonDescription>xx原因</finishReasonDescription>\\n <incidentFinishSolution>5</incidentFinishSolution>\\n <finishSolutionDescription>xxx方案</finishSolutionDescription>\\n <createTime>2021-09-09 09:09:09</createTime>\\n <assignUserName>张老三</assignUserName>\\n <assignUserId>433</assignUserId>\\n <durationTime>6789765678</durationTime>\\n <similarScore>1003.567</similarScore>\\n </similarIncidents>\\n </dailySimilarIncidents>\\n <requestId>uyihg6789</requestId>\\n </data>\\n</GetSimilarIncidentStatisticsResponse>","errorExample":""}]',
- ],
- 'ListTrendForSourceEvent' => [
- 'summary' => '查询原始告警趋势',
- 'path' => '/events/querySourceEventTrend',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ServiceGroupNotExisted', 'errorMessage' => 'The service group does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": {\\n \\"updateTime\\": \\"2020-05-03 15:39:39\\",\\n \\"users\\": [\\n {\\n \\"userId\\": 10,\\n \\"userName\\": \\"jack\\",\\n \\"phone\\": \\"1390000****\\",\\n \\"serviceGroupId\\": 1,\\n \\"roleNameList\\": [\\n \\"测试\\"\\n ]\\n }\\n ],\\n \\"serviceGroupDescription\\": \\"服务描述\\",\\n \\"webhookLink\\": \\"wwwwwww\\",\\n \\"webhookType\\": \\"WEIXIN_GROUP\\",\\n \\"enableWebhook\\": \\"ENABLE\\",\\n \\"serviceGroupName\\": \\"冲上云霄\\",\\n \\"serviceGroupId\\": 1000,\\n \\"createTime\\": \\"2020-08-08 10:00:00\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'View service group details',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:45.000Z', 'description' => 'Response parameters changed'],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceGroup'],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'GetServiceGroupPersonScheduling' => [
+ 'summary' => 'Query the schedule of a service group for a specific user.',
+ 'path' => '/services/group/scheduling/user/getScheduling',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempIFJI1O',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempCICFVA'],
],
'parameters' => [
[
@@ -12711,54 +8014,16 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'requestId' => [
- 'description' => '',
- 'example' => 'xxxx',
- 'required' => false,
- 'title' => '请求ID',
- 'type' => 'string',
- ],
- 'instanceId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '报警ID',
- 'type' => 'integer',
- ],
- 'instanceType' => [
- 'description' => '',
- 'example' => 'INCIDENT',
- 'required' => false,
- 'title' => '类型',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'description' => '',
- 'example' => '2020-10-10 00:00:00',
- 'required' => false,
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'description' => '',
- 'example' => '2020-10-10 23:59:59',
- 'required' => false,
- 'title' => '结束时间',
- 'type' => 'string',
- ],
- 'timeUnit' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '时间单位毫秒',
- 'type' => 'integer',
- ],
+ 'userId' => ['description' => 'User ID.', 'example' => '66666', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'example' => '77777', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency token.', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'startTime' => ['description' => 'Schedule start time.', 'example' => '2020-09-01 00:00:00', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'endTime' => ['description' => 'Schedule end time.', 'example' => '2020-09-31 00:00:00', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -12767,93 +8032,58 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'maxSustainTime' => [
- 'description' => '',
- 'example' => '10920312312312',
- 'format' => 'int64',
- 'title' => '最大持续时长',
- 'type' => 'integer',
- ],
- 'convergenceRate' => [
- 'description' => '',
- 'example' => '90.90%',
- 'title' => '收敛率',
- 'type' => 'string',
- ],
- 'sourceEventsStatMap' => [
- 'description' => '',
- 'example' => '{ "Grafana": [ { "evenTime": "2021-11-15 14:29:59", "eventCount": 4, "monitorSourceName": "Grafana", "monitorSourceCounts": null, "sustainTime": 15646 }, { "evenTime": "2021-11-15 14:30:36", "eventCount": 7, "monitorSourceName": "Grafana", "monitorSourceCounts": null, "sustainTime": 52638 } ] }',
- 'title' => '按监控源分组统计数据',
- 'type' => 'object',
- ],
- 'skipDay' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '是否跨天',
- 'type' => 'boolean',
- ],
- 'unit' => [
- 'description' => '',
- 'example' => '1000',
- 'title' => '时间单位',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '统计列表',
- 'type' => 'array',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'xxxxx', 'title' => 'Id of the request', 'type' => 'string'],
+ 'data' => ['description' => 'Schedule calendar.', 'title' => '', 'type' => 'object', 'example' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxx\\",\\n \\"data\\": [\\n {\\n \\"maxSustainTime\\": 10920312312312,\\n \\"convergenceRate\\": \\"90.90%\\",\\n \\"sourceEventsStatMap\\": {\\n \\"Grafana\\": [\\n {\\n \\"evenTime\\": \\"2021-11-15 14:29:59\\",\\n \\"eventCount\\": 4,\\n \\"monitorSourceName\\": \\"Grafana\\",\\n \\"monitorSourceCounts\\": null,\\n \\"sustainTime\\": 15646\\n },\\n {\\n \\"evenTime\\": \\"2021-11-15 14:30:36\\",\\n \\"eventCount\\": 7,\\n \\"monitorSourceName\\": \\"Grafana\\",\\n \\"monitorSourceCounts\\": null,\\n \\"sustainTime\\": 52638\\n }\\n ]\\n },\\n \\"skipDay\\": true,\\n \\"unit\\": \\"1000\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTrendForSourceEventResponse>\\n <requestId>xxxxx</requestId>\\n <data>\\n <maxSustainTime>10920312312312</maxSustainTime>\\n <convergenceRate>90.90%</convergenceRate>\\n </data>\\n</ListTrendForSourceEventResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{"instanceId":78958441,"instanceType":"ALERT","clientToken":"82af9e74-6592-435d-aa06-345562cdd37c"}',
- ],
- 'ListSourceEventsForMonitorSource' => [
- 'summary' => '查询监控员最近10次告警',
- 'path' => '/events/queryLastestEvents',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxxx\\",\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'Query the schedule of a service group for a specific user',
+ 'changeSet' => [
+ ['createdAt' => '2021-10-20T13:27:37.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetServiceGroupPersonScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceGroupPersonScheduling'],
+ ],
],
+ ],
+ 'GetServiceGroupScheduling' => [
+ 'summary' => 'Queries the scheduling details of a service group.',
+ 'path' => '/services/group/scheduling/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempW81V8D',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempCICFVA'],
],
'parameters' => [
[
@@ -12861,120 +8091,236 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '监控源ID',
- 'type' => 'integer',
- ],
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9999', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'xxxxxxxxxxxx'],
'data' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '1000',
- 'title' => '监控源ID',
- 'type' => 'boolean',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'zabbix',
- 'title' => '监控源名称',
- 'type' => 'string',
+ 'description' => 'Scheduling details.',
+ 'properties' => [
+ 'schedulingWay' => ['description' => 'Scheduling method:'."\n"
+ ."\n"
+ .'- FAST: Fast scheduling.'."\n"
+ ."\n"
+ .'- FINE: Fine-grained scheduling.', 'type' => 'string', 'example' => 'FINE', 'title' => ''],
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '99999', 'title' => ''],
+ 'fastScheduling' => [
+ 'description' => 'Fast scheduling.',
+ 'properties' => [
+ 'singleDuration' => ['description' => 'Duration per person.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
+ 'dutyPlan' => ['description' => 'Duty plan:'."\n"
+ ."\n"
+ .'- FAST\\_CHOICE: Fast selection.'."\n"
+ ."\n"
+ .'- CUSTOM: Custom.', 'type' => 'string', 'example' => 'FAST_CHOICE', 'title' => ''],
+ 'singleDurationUnit' => ['description' => 'Unit for duration per person:'."\n"
+ ."\n"
+ .'- HOUR: Hour.'."\n"
+ ."\n"
+ .'- DAY: Day.', 'type' => 'string', 'example' => 'DAY', 'title' => ''],
+ 'schedulingUsers' => [
+ 'description' => 'Fast rotation users.',
+ 'items' => [
+ 'description' => 'Fast scheduling user.',
+ 'properties' => [
+ 'schedulingUserId' => ['description' => 'Rotation user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '66666', 'title' => ''],
+ 'schedulingOrder' => ['description' => 'Scheduling order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'schedulingUserName' => ['description' => 'Rotation user name.', 'type' => 'string', 'example' => '张先生', 'title' => ''],
+ 'schedulingUserIdList' => [
+ 'description' => 'User IDs for multi-person scheduling.',
+ 'title' => 'User IDs for Multi-User Shift Scheduling ',
+ 'type' => 'array',
+ 'items' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '66666', 'title' => ''],
+ 'example' => '',
+ ],
+ 'schedulingObjectType' => ['title' => 'Scheduling object type', 'description' => 'Scheduling object type.', 'type' => 'string', 'example' => 'single'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'id' => ['description' => 'Fast scheduling ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2222', 'title' => ''],
],
- 'eventTime' => [
- 'description' => '',
- 'example' => '2020-01-01 18:30:00',
- 'title' => '告警上报时间',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ 'fineScheduling' => [
+ 'description' => 'Fine-grained scheduling.',
+ 'properties' => [
+ 'period' => ['title' => '1', 'description' => 'Cycle period.', 'type' => 'integer', 'format' => 'int32', 'example' => '循环周期'],
+ 'id' => ['title' => '1', 'description' => 'Fine-grained scheduling ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '精细排班ID'],
+ 'periodUnit' => ['description' => 'Unit for cycle period:'."\n"
+ ."\n"
+ .'- HOUR: Hour.'."\n"
+ ."\n"
+ .'- DAY: Day.', 'type' => 'string', 'example' => 'DAY', 'title' => ''],
+ 'shiftType' => ['description' => 'Shift type:'."\n"
+ ."\n"
+ .'- MORNING\\_NIGHT: Morning and night shifts.'."\n"
+ ."\n"
+ .'- MORNING\\_NOON\\_NIGHT: Morning, noon, and night shifts.'."\n"
+ ."\n"
+ .'- CUSTOM: Custom.', 'type' => 'string', 'example' => 'MORNING_NIGHT', 'title' => ''],
+ 'schedulingFineShifts' => [
+ 'description' => 'Fine-grained scheduling shift personnel information.',
+ 'items' => [
+ 'description' => 'Fine-grained scheduling.',
+ 'properties' => [
+ 'schedulingStartTime' => ['description' => 'Scheduling start time.', 'type' => 'string', 'example' => '2020-08-13', 'title' => ''],
+ 'schedulingEndTime' => ['description' => 'Scheduling end time.', 'type' => 'string', 'example' => '2020-10-13', 'title' => ''],
+ 'schedulingOrder' => ['description' => 'Scheduling order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'shiftName' => ['description' => 'Shift name.', 'type' => 'string', 'example' => '早班', 'title' => ''],
+ 'cycleOrder' => ['description' => 'Cycle order.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'schedulingUserId' => ['description' => 'Scheduling user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', 'title' => ''],
+ 'skipOneDay' => ['description' => 'Spans days.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'schedulingUserName' => ['description' => 'Scheduling user name.', 'type' => 'string', 'example' => '刘德华', 'title' => ''],
+ 'schedulingUserIdList' => [
+ 'description' => 'User IDs for multi-person scheduling.',
+ 'title' => 'User IDs for Multi-User Scheduling',
+ 'type' => 'array',
+ 'items' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '66666', 'title' => ''],
+ 'example' => '',
+ ],
+ 'schedulingObjectType' => ['description' => 'Task scheduling type.', 'type' => 'string', 'example' => 'single', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'schedulingTemplateFineShifts' => [
+ 'description' => 'Fine-grained scheduling template.',
+ 'items' => [
+ 'description' => 'Fine-grained scheduling template.',
+ 'properties' => [
+ 'schedulingStartTime' => ['description' => 'Scheduling start time.', 'type' => 'string', 'title' => '', 'example' => '2021-09-01 00:00:00'],
+ 'schedulingEndTime' => ['description' => 'Scheduling end time.', 'type' => 'string', 'title' => '', 'example' => '2021-10-01 00:00:00'],
+ 'schedulingOrder' => ['description' => 'Scheduling order.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'schedulingUserId' => ['description' => 'User ID.', 'type' => 'string', 'title' => '', 'example' => '1'],
+ 'skipOneDay' => ['description' => 'Spans days.', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'schedulingUserName' => ['description' => 'Scheduling user name.', 'type' => 'string', 'title' => '', 'example' => '刘德华'],
+ 'shiftName' => ['description' => 'Shift name.', 'type' => 'string', 'title' => '', 'example' => '早班'],
+ 'schedulingUserIdList' => [
+ 'description' => 'User IDs for multi-person scheduling.',
+ 'title' => 'User IDs for Multi-user Scheduling',
+ 'type' => 'array',
+ 'items' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '66666', 'title' => ''],
+ 'example' => '',
+ ],
+ 'schedulingObjectType' => ['description' => 'Task scheduling type.', 'type' => 'string', 'example' => 'single', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
],
- 'eventJson' => [
- 'description' => '',
- 'example' => '{}',
- 'title' => '告警内容',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ 'users' => [
+ 'description' => 'The users are scheduled.',
+ 'items' => [
+ 'description' => 'Scheduled user.',
+ 'properties' => [
+ 'userId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '66666'],
+ 'userName' => ['description' => 'User name.', 'type' => 'string', 'title' => '', 'example' => '用户名字'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'type' => 'object',
],
- 'title' => '告警列表',
- 'type' => 'array',
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxx\\",\\n \\"data\\": [\\n {\\n \\"monitorSourceId\\": true,\\n \\"monitorSourceName\\": \\"zabbix\\",\\n \\"eventTime\\": \\"2020-01-01 18:30:00\\",\\n \\"eventJson\\": \\"{}\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListSourceEventsForMonitorSourceResponse>\\n <requestId>xxxxxx</requestId>\\n <data>\\n <monitorSourceId>false</monitorSourceId>\\n <monitorSourceName>zabbix</monitorSourceName>\\n <eventTime>2020-01-01 18:30:00</eventTime>\\n <eventJson>{}</eventJson>\\n </data>\\n</ListSourceEventsForMonitorSourceResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{'."\n"
- .' "monitorSourceId" : 1000'."\n"
- .'}',
- 'responseParamsDescription' => '{'."\n"
- .' "requestId": "xxxxxx",'."\n"
- .' "data": ['."\n"
- .' {'."\n"
- .' "monitorSourceId": false,'."\n"
- .' "monitorSourceName": "zabbix",'."\n"
- .' "eventTime": "2020-01-01 18:30:00",'."\n"
- .' "eventJson": "{}"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .'}',
- ],
- 'ListSourceEvents' => [
- 'summary' => '原始告警列表查询',
- 'path' => '/events/listOriginalEvent',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified Resource is not found.', 'description' => 'The specified Resource is not found.'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxxxxxxxxxx\\",\\n \\"data\\": {\\n \\"schedulingWay\\": \\"FINE\\",\\n \\"serviceGroupId\\": 99999,\\n \\"fastScheduling\\": {\\n \\"singleDuration\\": 12,\\n \\"dutyPlan\\": \\"FAST_CHOICE\\",\\n \\"singleDurationUnit\\": \\"DAY\\",\\n \\"schedulingUsers\\": [\\n {\\n \\"schedulingUserId\\": 66666,\\n \\"schedulingOrder\\": 1,\\n \\"schedulingUserName\\": \\"张先生\\",\\n \\"schedulingUserIdList\\": [\\n 66666\\n ],\\n \\"schedulingObjectType\\": \\"single\\"\\n }\\n ],\\n \\"id\\": 2222\\n },\\n \\"fineScheduling\\": {\\n \\"period\\": 0,\\n \\"id\\": 0,\\n \\"periodUnit\\": \\"DAY\\",\\n \\"shiftType\\": \\"MORNING_NIGHT\\",\\n \\"schedulingFineShifts\\": [\\n {\\n \\"schedulingStartTime\\": \\"2020-08-13\\",\\n \\"schedulingEndTime\\": \\"2020-10-13\\",\\n \\"schedulingOrder\\": 1,\\n \\"shiftName\\": \\"早班\\",\\n \\"cycleOrder\\": 1,\\n \\"schedulingUserId\\": 1111,\\n \\"skipOneDay\\": false,\\n \\"schedulingUserName\\": \\"刘德华\\",\\n \\"schedulingUserIdList\\": [\\n 66666\\n ],\\n \\"schedulingObjectType\\": \\"single\\"\\n }\\n ],\\n \\"schedulingTemplateFineShifts\\": [\\n {\\n \\"schedulingStartTime\\": \\"2021-09-01 00:00:00\\",\\n \\"schedulingEndTime\\": \\"2021-10-01 00:00:00\\",\\n \\"schedulingOrder\\": 1,\\n \\"schedulingUserId\\": \\"1\\",\\n \\"skipOneDay\\": true,\\n \\"schedulingUserName\\": \\"刘德华\\",\\n \\"shiftName\\": \\"早班\\",\\n \\"schedulingUserIdList\\": [\\n 66666\\n ],\\n \\"schedulingObjectType\\": \\"single\\"\\n }\\n ]\\n },\\n \\"users\\": [\\n {\\n \\"userId\\": 66666,\\n \\"userName\\": \\"用户名字\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Query service group scheduling details',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-26T13:01:21.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-09-10T01:53:17.000Z', 'description' => 'OpenAPI offline'],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetServiceGroupScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceGroupScheduling'],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'GetServiceGroupSchedulingPreview' => [
+ 'summary' => 'Preview service group scheduling.',
+ 'path' => '/services/group/scheduling/preview',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempW81V8D',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempUBXKF7'],
],
'parameters' => [
[
@@ -12982,224 +8328,167 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'instanceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '报警或者事件ID',
- 'type' => 'integer',
- ],
- 'instanceType' => [
- 'description' => '',
- 'example' => 'INCIDENT',
- 'required' => true,
- 'title' => 'INCIDENT 事件、ALERT 报警、PROBLEM 故障',
- 'type' => 'string',
- ],
- 'startRowKey' => [
- 'description' => '',
- 'example' => '9223370410626682599-1344383-78954515-1-0a6e01a1701447fd9ef18b079edd2c6d',
- 'required' => false,
- 'title' => 'startRowKey 用来查询下一页的数据',
- 'type' => 'string',
- ],
- 'stopRowKey' => [
- 'description' => '',
- 'example' => '9223370410626682599-1344383-78954515-1-0a6e01a1701447fd9ef18b079edd2c6d',
- 'required' => false,
- 'title' => 'stopRowKey 用来查询上一页的数据',
- 'type' => 'string',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '页大小',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '当前页',
- 'type' => 'integer',
- ],
- 'startTime' => [
- 'description' => '2020-09-10 13:00:00',
- 'example' => '2020-10-01 00:00:00',
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '55555', 'title' => ''],
+ 'schedulingWay' => ['description' => 'Scheduling method:'."\n"
+ ."\n"
+ .'- FAST: Fast scheduling.'."\n"
+ ."\n"
+ .'- FINE: Fine-grained scheduling.', 'type' => 'string', 'required' => true, 'example' => 'FAST', 'title' => ''],
+ 'fastScheduling' => [
+ 'description' => 'Fast scheduling settings.',
+ 'properties' => [
+ 'singleDuration' => ['description' => 'Shift duration per person.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => '', 'required' => false],
+ 'dutyPlan' => ['description' => 'Duty plan:'."\n"
+ ."\n"
+ .'- FAST\\_CHOICE: Fast selection.'."\n"
+ ."\n"
+ .'- CUSTOM: Custom.', 'type' => 'string', 'example' => 'FAST_CHOICE', 'title' => '', 'required' => false],
+ 'singleDurationUnit' => ['description' => 'Shift duration unit:'."\n"
+ ."\n"
+ .'- HOUR: Hour.'."\n"
+ ."\n"
+ .'- DAY: Day.', 'type' => 'string', 'example' => 'DAY', 'title' => '', 'required' => false],
+ 'schedulingUsers' => [
+ 'description' => 'Users for fast rotation scheduling.',
+ 'items' => [
+ 'description' => 'User for fast rotation scheduling.',
+ 'properties' => [
+ 'schedulingUserId' => ['description' => 'User ID for rotation scheduling.', 'type' => 'integer', 'format' => 'int64', 'example' => '122222', 'title' => '', 'required' => false],
+ 'schedulingOrder' => ['description' => 'Scheduling order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'title' => '开始时间',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
],
- 'endTime' => [
- 'description' => '2020-09-18 13:00:00',
- 'example' => '2020-10-01 23:59:59',
+ 'fineScheduling' => [
+ 'description' => 'Fine-grained scheduling settings.',
+ 'properties' => [
+ 'period' => ['description' => 'Cycle period.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '2'],
+ 'periodUnit' => ['description' => 'Cycle period unit:'."\n"
+ ."\n"
+ .'- HOUR: Hour.'."\n"
+ ."\n"
+ .'- DAY: Day.', 'type' => 'string', 'example' => 'DAY', 'title' => '', 'required' => false],
+ 'shiftType' => ['description' => 'Shift type:'."\n"
+ ."\n"
+ .'- MORNING\\_NIGHT: Morning and night shifts.'."\n"
+ ."\n"
+ .'- MORNING\\_NOON\\_NIGHT: Morning, noon, and night shifts.'."\n"
+ ."\n"
+ .'- CUSTOM: Custom.', 'type' => 'string', 'example' => 'MORNING_NIGHT', 'title' => '', 'required' => false],
+ 'schedulingFineShifts' => [
+ 'description' => 'Staff information for fine-grained shift scheduling.',
+ 'items' => [
+ 'description' => 'Staff information for fine-grained shift scheduling.',
+ 'properties' => [
+ 'schedulingStartTime' => ['description' => 'Scheduling start time.', 'type' => 'string', 'example' => '2020-08-13', 'title' => '', 'required' => false],
+ 'schedulingEndTime' => ['description' => 'Scheduling end time.', 'type' => 'string', 'example' => '2020-10-13', 'title' => '', 'required' => false],
+ 'schedulingOrder' => ['description' => 'Scheduling order.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'shiftName' => ['description' => 'Shift name.', 'type' => 'string', 'example' => '早班', 'title' => '', 'required' => false],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'title' => '结束时间',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
+ 'endTime' => ['description' => 'Preview start time for on-call duty.', 'type' => 'string', 'example' => '2021-09-01 00:00:00', 'title' => '', 'required' => false],
+ 'startTime' => ['description' => 'Preview end time for on-call duty.', 'type' => 'string', 'example' => '2021-11-01 00:00:00', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => '请求ID',
- 'type' => 'string',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '总条数',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '当前页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'title' => '页大小',
- 'type' => 'integer',
- ],
- 'data' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '规则ID',
- 'type' => 'integer',
- ],
- 'instanceType' => [
- 'description' => '',
- 'example' => 'INCIDENT',
- 'title' => 'INCIDENT 事件、ALERT 报警、PROBLEM 故障',
- 'type' => 'string',
- ],
- 'instanceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '关联对象ID',
- 'type' => 'integer',
- ],
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '监控告警源ID',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'zabbix',
- 'title' => '监控告警源名称',
- 'type' => 'string',
- ],
- 'eventTime' => [
- 'description' => '',
- 'example' => '2020-09-08 15:53:34',
- 'title' => '告警上报时间',
- 'type' => 'string',
- ],
- 'tenantRamId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '租户ID',
- 'type' => 'integer',
- ],
- 'eventJson' => [
- 'description' => '',
- 'example' => '""',
- 'title' => '告警内容json',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
- 'lastRowKey' => [
- 'description' => 'lastRowKey',
- 'example' => '9223370412331485036-1344383-9967-1-8d729a1b176f493ca3be643b391d5ced',
- 'title' => 'lastRowKey',
- 'type' => 'string',
- ],
- 'firstRowKey' => [
- 'description' => 'firstRowKey',
- 'example' => '9223370412331485032-1344383-9967-1-08be8b08ef30441390072f3bfba71c94',
- 'title' => 'firstRowKey',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '85C203BF-D1A6-562C-AAEC-5EAB9D2756CF'],
+ 'data' => ['description' => 'Service group dates.', 'type' => 'object', 'title' => '', 'example' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"totalCount\\": 100,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"data\\": [\\n {\\n \\"routeRuleId\\": 1,\\n \\"instanceType\\": \\"INCIDENT\\",\\n \\"instanceId\\": 1,\\n \\"monitorSourceId\\": 1,\\n \\"monitorSourceName\\": \\"zabbix\\",\\n \\"eventTime\\": \\"2020-09-08 15:53:34\\",\\n \\"tenantRamId\\": 1,\\n \\"eventJson\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"lastRowKey\\": \\"9223370412331485036-1344383-9967-1-8d729a1b176f493ca3be643b391d5ced\\",\\n \\"firstRowKey\\": \\"9223370412331485032-1344383-9967-1-08be8b08ef30441390072f3bfba71c94\\"\\n}","errorExample":""},{"type":"xml","example":"<ListSourceEventsResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n <totalCount>100</totalCount>\\n <pageNumber>1</pageNumber>\\n <pageSize>20</pageSize>\\n <data>\\n <routeRuleId>1</routeRuleId>\\n <instanceType>INCIDENT</instanceType>\\n <instanceId>1</instanceId>\\n <monitorSourceId>1</monitorSourceId>\\n <monitorSourceName>zabbix</monitorSourceName>\\n <eventTime>2020-09-08 15:53:34</eventTime>\\n <tenantRamId>1</tenantRamId>\\n <eventJson>\\"\\"</eventJson>\\n </data>\\n <lastRowKey>9223370412331485036-1344383-9967-1-8d729a1b176f493ca3be643b391d5ced</lastRowKey>\\n <firstRowKey>9223370412331485032-1344383-9967-1-08be8b08ef30441390072f3bfba71c94</firstRowKey>\\n</ListSourceEventsResponse>","errorExample":""}]',
- ],
- 'ListAlerts' => [
- 'summary' => '报警列表查询',
- 'path' => '/alerts/list',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid. %s', 'description' => 'The specified parameter is not valid.'."\n"],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"85C203BF-D1A6-562C-AAEC-5EAB9D2756CF\\",\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'Preview service group scheduling',
+ 'changeSet' => [
+ ['createdAt' => '2021-09-10T01:53:17.000Z', 'description' => 'OpenAPI offline'],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetServiceGroupSchedulingPreview',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceGroupSchedulingPreview'],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'GetServiceGroupSpecialPersonScheduling' => [
+ 'summary' => 'Query the schedule for a specified person in a service group.',
+ 'path' => '/services/group/scheduling/getUserScheduling',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempERNU0Z',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempUBXKF7'],
],
'parameters' => [
[
@@ -13207,252 +8496,115 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'alertLevel' => [
- 'description' => '',
- 'example' => 'P1',
- 'required' => false,
- 'title' => '报警等级 P1 P2 P3 P4',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '服务id',
- 'type' => 'integer',
- ],
- 'alertName' => [
- 'description' => '',
- 'example' => '报警',
- 'required' => false,
- 'title' => '报警名称',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '当前页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '页大小',
- 'type' => 'integer',
- ],
- 'alertSourceName' => [
- 'description' => '',
- 'example' => '流转规则A',
- 'required' => false,
- 'title' => '报警来源',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'description' => '2020-09-10 13:00:00',
- 'example' => '2020-10-01 00:00:00',
- 'required' => false,
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'description' => '2020-09-10 21:00:00',
- 'example' => '2020-10-01 23:59:59',
- 'required' => false,
- 'title' => '结束时间',
- 'type' => 'string',
- ],
- 'ruleName' => [
- 'description' => '',
- 'example' => 'zabbix',
- 'required' => false,
- 'title' => '流转规则名字',
- 'type' => 'string',
- ],
- 'monitorSourceId' => [
- 'required' => false,
- 'title' => '原始信息来源id',
- 'type' => 'string',
- ],
+ 'userId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '66666', 'title' => ''],
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '77777', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => '请求ID',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'xxxxxx'],
'data' => [
- 'description' => '',
+ 'description' => 'Schedule information for the person.',
'items' => [
+ 'description' => 'Schedule item.',
'properties' => [
- 'alertId' => [
- 'description' => '',
- 'example' => '20000',
- 'format' => 'int64',
- 'title' => '报警ID',
- 'type' => 'integer',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2020-03-05 15:53:55',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'relatedServiceName' => [
- 'description' => '',
- 'example' => '服务A',
- 'title' => '关联服务名称',
- 'type' => 'string',
- ],
- 'alertLevel' => [
- 'description' => '',
- 'example' => 'P1',
- 'title' => '告警优先级 1,2,3,4 对应 p1,p2,p3,p4',
- 'type' => 'string',
- ],
- 'title' => [
- 'description' => '',
- 'example' => '报警',
- 'title' => '报警标题',
- 'type' => 'string',
- ],
- 'sourceEventCount' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '收敛量',
- 'type' => 'integer',
- ],
- 'alertSourceName' => [
- 'description' => '',
- 'example' => 'zabbix',
- 'title' => '报警源',
- 'type' => 'string',
- ],
- 'firstEventTime' => [
- 'description' => '',
- 'example' => '2021-09-08 18:30:00',
- 'title' => '第一次告警上报时间',
- 'type' => 'string',
- ],
- 'routeRuleId' => [
- 'description' => '',
- 'example' => '10000',
- 'format' => 'int64',
- 'title' => '关联流转规则ID',
- 'type' => 'integer',
- ],
- 'alertNumber' => [
- 'description' => '',
- 'example' => 'A123123123',
- 'title' => '报警编号',
- 'type' => 'string',
- ],
- 'routeRuleName' => [
- 'description' => '',
- 'example' => '流转规则',
- 'title' => '流转规则名字',
- 'type' => 'string',
- ],
- 'relServiceDeleteType' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '服务删除字段 1正常 0删除',
- 'type' => 'integer',
- ],
- 'routeRuleDeleteType' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '规则删除字段 1正常 0删除',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'title' => '原始数据名称',
- 'type' => 'string',
- ],
+ 'schedulingStartTime' => ['description' => 'Schedule start time.', 'type' => 'string', 'example' => '2021-08-17 00:00:00', 'title' => ''],
+ 'schedulingEndTime' => ['description' => 'Schedule end time.', 'type' => 'string', 'example' => '2021-08-17 12:00:00', 'title' => ''],
+ 'schedulingDate' => ['description' => 'Schedule date.', 'type' => 'string', 'example' => '2021-08-17', 'title' => ''],
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '8888', 'title' => ''],
+ 'serviceGroupName' => ['description' => 'Service group name.', 'type' => 'string', 'example' => '雪豹突击队', 'title' => ''],
+ 'schedulingUserId' => ['description' => 'Scheduled user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '111111', 'title' => ''],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '报警列表',
+ 'title' => '',
'type' => 'array',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '总条数',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '当前页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'title' => '页的大小',
- 'type' => 'integer',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": [\\n {\\n \\"alertId\\": 20000,\\n \\"createTime\\": \\"2020-03-05 15:53:55\\",\\n \\"relatedServiceName\\": \\"冲上云霄\\",\\n \\"alertLevel\\": \\"P1\\",\\n \\"title\\": \\"报警\\",\\n \\"sourceEventCount\\": 10,\\n \\"alertSourceName\\": \\"流转规则A\\",\\n \\"firstEventTime\\": \\"2021-09-08 18:30:00\\",\\n \\"routeRuleId\\": 10000,\\n \\"alertNumber\\": \\"A123123123\\",\\n \\"routeRuleName\\": \\"流转规则\\",\\n \\"relServiceDeleteType\\": 1,\\n \\"routeRuleDeleteType\\": 1,\\n \\"monitorSourceName\\": \\"name\\"\\n }\\n ],\\n \\"totalCount\\": 100,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListAlertsResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n <data>\\n <alertId>20000</alertId>\\n <createTime>2020-03-05 15:53:55</createTime>\\n <relatedServiceName>冲上云霄</relatedServiceName>\\n <alertLevel>P1</alertLevel>\\n <title>报警</title>\\n <sourceEventCount>10</sourceEventCount>\\n <alertSourceName>流转规则A</alertSourceName>\\n <routeRuleId>10000</routeRuleId>\\n <firstEventTime>2021-09-08 18:30:00</firstEventTime>\\n </data>\\n <totalCount>100</totalCount>\\n <pageNumber>1</pageNumber>\\n <pageSize>10</pageSize>\\n</ListAlertsResponse>","errorExample":""}]',
- ],
- 'GetEvent' => [
- 'summary' => '查询最近一次告警',
- 'path' => '/events/getLastTimeEvent',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxxxx\\",\\n \\"data\\": [\\n {\\n \\"schedulingStartTime\\": \\"2021-08-17 00:00:00\\",\\n \\"schedulingEndTime\\": \\"2021-08-17 12:00:00\\",\\n \\"schedulingDate\\": \\"2021-08-17\\",\\n \\"serviceGroupId\\": 8888,\\n \\"serviceGroupName\\": \\"雪豹突击队\\",\\n \\"schedulingUserId\\": 111111\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query the service group scheduling for a specified user',
+ 'requestParamsDescription' => '{'."\n"
+ .'"userId" : 66666,'."\n"
+ .'"serviceGroupId" : 77777,'."\n"
+ .'"clientToken" : "C4BE3837-1A13-413B-A225-2C88188E8A43",'."\n"
+ .'"startTime" : "2020-09-01 00:00:00",'."\n"
+ .'"endTime" : "2020-09-31 23:59:59"'."\n"
+ .'}',
+ 'responseParamsDescription' => '{'."\n"
+ .'"requestId": "xxxxxx",'."\n"
+ .'"data": \\['."\n"
+ .'{'."\n"
+ .'"schedulingStartTime": "2021-08-17 00:00:00",'."\n"
+ .'"schedulingEndTime": "2021-08-17 12:00:00",'."\n"
+ .'"schedulingDate": "2021-08-17",'."\n"
+ .'"serviceGroupId": 8888,'."\n"
+ .'"serviceGroupName": "Snow Leopard Commando Unit",'."\n"
+ .'"schedulingUserId": 111111'."\n"
+ .'}'."\n"
+ .']'."\n"
+ .'}',
+ 'changeSet' => [
+ ['createdAt' => '2021-09-10T01:53:15.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetServiceGroupSpecialPersonScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceGroupSpecialPersonScheduling'],
+ ],
],
+ ],
+ 'GetSimilarIncidentStatistics' => [
+ 'summary' => 'Lists similar incidents.',
+ 'path' => '/incident/similarIncident/statistics',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempERNU0Z',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp3X5SLU'],
],
'parameters' => [
[
@@ -13460,98 +8612,171 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '32', 'title' => ''],
+ 'incidentTitle' => ['description' => 'Incident title.', 'type' => 'string', 'required' => true, 'example' => '测试事件A', 'title' => ''],
+ 'createTime' => ['description' => 'Trigger time.', 'type' => 'string', 'required' => true, 'example' => '2021-09-09 09:09:09', 'title' => ''],
+ 'relatedServiceId' => ['description' => 'Related service ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '233116754', 'title' => ''],
+ 'events' => [
+ 'description' => 'Event alerting content.',
+ 'items' => ['description' => 'Event content.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''],
'required' => true,
- 'title' => '监控源ID不能为空',
- 'type' => 'integer',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'clientToken' => ['description' => 'Idempotent identity.', 'type' => 'string', 'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'XXXXXXXXXXXX',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6'],
'data' => [
- 'description' => '',
+ 'description' => 'Returned data.',
'properties' => [
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '告警源ID',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'zabbix',
- 'title' => '告警源名称',
- 'type' => 'string',
- ],
- 'eventTime' => [
- 'description' => '',
- 'example' => '2002-09-08 15:30:35',
- 'title' => '告警上报时间',
- 'type' => 'string',
+ 'topFiveIncidents' => [
+ 'description' => 'topFiveIncidents',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''],
+ 'incidentNumber' => ['description' => 'Incident number.', 'type' => 'string', 'example' => 'I34324', 'title' => ''],
+ 'incidentTitle' => ['description' => 'Incident title.', 'type' => 'string', 'example' => '测试事件标题', 'title' => ''],
+ 'relatedRouteRuleId' => ['description' => 'Flow rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '4343', 'title' => ''],
+ 'relatedRouteRuleName' => ['description' => 'Flow rule name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'finishReason' => ['description' => 'Trigger reason.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'finishReasonDescription' => ['description' => 'Trigger reason description.', 'type' => 'string', 'example' => '处罚原因描述测试', 'title' => ''],
+ 'incidentFinishSolution' => ['description' => 'Solution.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'finishSolutionDescription' => ['description' => 'Solution description.', 'type' => 'string', 'example' => '测试方案', 'title' => ''],
+ 'createTime' => ['description' => 'Trigger time.', 'type' => 'string', 'example' => '2021-09-09 09:09:09', 'title' => ''],
+ 'assignUserId' => ['description' => 'Assignee ID.', 'type' => 'string', 'example' => '43', 'title' => ''],
+ 'assignUserName' => ['description' => 'Assignee.', 'type' => 'string', 'example' => '马先生', 'title' => ''],
+ 'durationTime' => ['description' => 'Duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '6787678767', 'title' => ''],
+ 'similarScore' => ['description' => 'Similarity.', 'type' => 'string', 'example' => '1992.21', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => 'topFiveIncidents',
+ 'type' => 'array',
+ 'example' => '',
],
- 'eventJson' => [
- 'description' => '',
- 'example' => '“”',
- 'title' => '告警内容',
- 'type' => 'string',
+ 'countInSixMonths' => ['description' => 'Number of similar incidents in six months.', 'type' => 'integer', 'format' => 'int64', 'example' => '43', 'title' => ''],
+ 'countInSevenDays' => ['description' => 'Number of similar incidents in seven days.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''],
+ 'dailySimilarIncidents' => [
+ 'description' => 'Categorized by date.',
+ 'example' => '{}',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'date' => ['description' => 'Date.', 'type' => 'string', 'example' => '2021-03-07', 'title' => ''],
+ 'commitment' => ['description' => 'Quantity.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ 'month' => ['description' => 'Month.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
+ 'week' => ['description' => 'Week.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'day' => ['description' => 'Day of the week.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'similarIncidents' => [
+ 'description' => 'List of similar incidents.',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5435', 'title' => ''],
+ 'incidentNumber' => ['description' => 'Incident number.', 'type' => 'string', 'example' => 'I234432', 'title' => ''],
+ 'incidentTitle' => ['description' => 'Incident name.', 'type' => 'string', 'example' => '事件A', 'title' => ''],
+ 'relatedRouteRuleId' => ['description' => 'Flow rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '334', 'title' => ''],
+ 'relatedRouteRuleName' => ['description' => 'Flow rule name.', 'type' => 'string', 'example' => '测试规则A', 'title' => ''],
+ 'finishReason' => ['description' => 'Trigger reason.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'finishReasonDescription' => ['description' => 'Trigger reason description.', 'type' => 'string', 'example' => '测试原因B', 'title' => ''],
+ 'incidentFinishSolution' => ['description' => 'Solution.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'finishSolutionDescription' => ['description' => 'Solution description.', 'type' => 'string', 'example' => '测试方案A', 'title' => ''],
+ 'createTime' => ['description' => 'Trigger time.', 'type' => 'string', 'example' => '2021-09-09 09:09:09', 'title' => ''],
+ 'assignUserName' => ['description' => 'Assignee.', 'type' => 'string', 'example' => '马先生', 'title' => ''],
+ 'assignUserId' => ['description' => 'Assignee ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '433', 'title' => ''],
+ 'durationTime' => ['description' => 'Duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '6789765678', 'title' => ''],
+ 'similarScore' => ['description' => 'Similarity.', 'type' => 'string', 'example' => '1003.567', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
],
+ 'requestId' => ['title' => 'id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6'],
],
- 'title' => '告警',
+ 'title' => 'data',
'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"XXXXXXXXXXXX\\",\\n \\"data\\": {\\n \\"monitorSourceId\\": 1,\\n \\"monitorSourceName\\": \\"zabbix\\",\\n \\"eventTime\\": \\"2002-09-08 15:30:35\\",\\n \\"eventJson\\": \\"“”\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetEventResponse>\\n <requestId>XXXXXXXXXXXX</requestId>\\n <data>\\n <monitorSourceId>1</monitorSourceId>\\n <monitorSourceName>zabbix</monitorSourceName>\\n <eventTime>2002-09-08 15:30:35</eventTime>\\n <eventJson>“”</eventJson>\\n </data>\\n</GetEventResponse>","errorExample":""}]',
- ],
- 'GeneratePictureUploadSign' => [
- 'summary' => '图片批量上传',
- 'path' => '/rich/oss/generatePostPolicy',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"7C56D225-7C34-40BB-9624-C8BA449260E6\\",\\n \\"data\\": {\\n \\"topFiveIncidents\\": [\\n {\\n \\"incidentId\\": 32,\\n \\"incidentNumber\\": \\"I34324\\",\\n \\"incidentTitle\\": \\"测试事件标题\\",\\n \\"relatedRouteRuleId\\": 4343,\\n \\"relatedRouteRuleName\\": \\"xxx\\",\\n \\"finishReason\\": 2,\\n \\"finishReasonDescription\\": \\"处罚原因描述测试\\",\\n \\"incidentFinishSolution\\": 5,\\n \\"finishSolutionDescription\\": \\"测试方案\\",\\n \\"createTime\\": \\"2021-09-09 09:09:09\\",\\n \\"assignUserId\\": \\"43\\",\\n \\"assignUserName\\": \\"马先生\\",\\n \\"durationTime\\": 6787678767,\\n \\"similarScore\\": \\"1992.21\\"\\n }\\n ],\\n \\"countInSixMonths\\": 43,\\n \\"countInSevenDays\\": 8,\\n \\"dailySimilarIncidents\\": [\\n {\\n \\"date\\": \\"2021-03-07\\",\\n \\"commitment\\": 0,\\n \\"month\\": 2,\\n \\"week\\": \\"1\\",\\n \\"day\\": 1,\\n \\"similarIncidents\\": [\\n {\\n \\"incidentId\\": 5435,\\n \\"incidentNumber\\": \\"I234432\\",\\n \\"incidentTitle\\": \\"事件A\\",\\n \\"relatedRouteRuleId\\": 334,\\n \\"relatedRouteRuleName\\": \\"测试规则A\\",\\n \\"finishReason\\": 1,\\n \\"finishReasonDescription\\": \\"测试原因B\\",\\n \\"incidentFinishSolution\\": 5,\\n \\"finishSolutionDescription\\": \\"测试方案A\\",\\n \\"createTime\\": \\"2021-09-09 09:09:09\\",\\n \\"assignUserName\\": \\"马先生\\",\\n \\"assignUserId\\": 433,\\n \\"durationTime\\": 6789765678,\\n \\"similarScore\\": \\"1003.567\\"\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"7C56D225-7C34-40BB-9624-C8BA449260E6\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Similar Events List ',
+ 'changeSet' => [
+ ['createdAt' => '2021-09-23T09:39:58.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetSimilarIncidentStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSimilarIncidentStatistics'],
+ ],
+ ],
+ ],
+ 'GetSubscription' => [
+ 'summary' => 'Retrieve notification subscription details.',
+ 'path' => '/notify/subscription/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempHBPHMV',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp2C8J2M'],
],
'parameters' => [
[
@@ -13559,185 +8784,228 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'instanceId' => [
- 'description' => '',
- 'example' => '123123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '资源id',
- 'type' => 'integer',
- ],
- 'instanceType' => [
- 'description' => '',
- 'example' => 'INCIDENT 事件 ALERT告警 PROBLEM故障',
- 'required' => false,
- 'title' => '资源类型',
- 'type' => 'string',
- ],
- 'files' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'fileName' => [
- 'description' => '',
- 'example' => '文件A',
- 'required' => false,
- 'title' => '文件名称',
- 'type' => 'string',
- ],
- 'fileType' => [
- 'description' => '',
- 'example' => 'JPG',
- 'required' => false,
- 'title' => '文件类型',
- 'type' => 'string',
- ],
- 'fileSize' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '文件大小',
- 'type' => 'integer',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'required' => false,
- 'title' => '文件',
- 'type' => 'array',
- ],
+ 'subscriptionId' => ['description' => 'Subscription ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
+ 'notFilterScopeObjectDeleted' => ['title' => 'Do not filter deleted subscription scope objects (when true, deleted objects are also included in query results). '."\n", 'description' => 'Excludes deleted options from the results.', 'type' => 'boolean', 'required' => false, 'example' => ''],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88', 'title' => ''],
'data' => [
- 'description' => 'data',
+ 'description' => 'Response data.',
'properties' => [
- 'bucketName' => [
- 'description' => 'oss bucket name',
- 'example' => 'gam-objects-bucket',
- 'title' => 'oss bucket name',
- 'type' => 'string',
- ],
- 'policy' => [
- 'description' => 'policy',
- 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19',
- 'title' => 'policy',
- 'type' => 'string',
- ],
- 'signature' => [
- 'description' => 'signature',
- 'example' => 'SHqvIkwUNQd8Hervklir2K8U+ts=',
- 'title' => 'signature',
- 'type' => 'string',
- ],
- 'accessKeyId' => [
- 'description' => 'accessKeyId',
- 'example' => 'LTAI1tEoRVPw8GMy1iLRCno7',
- 'title' => 'accessKeyId',
- 'type' => 'string',
+ 'subscriptionId' => ['description' => 'Subscription ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '68', 'title' => ''],
+ 'subscriptionTitle' => ['description' => 'Notification subscription name.', 'type' => 'string', 'title' => '', 'example' => 'newTitle'],
+ 'scope' => ['description' => 'Subscription scope type:'."\n"
+ ."\n"
+ .'- ALL: All resources.'."\n"
+ ."\n"
+ .'- SERVICE: Service.'."\n"
+ ."\n"
+ .'- ROUTERULE: Routing rule.', 'type' => 'string', 'title' => '', 'example' => 'SERVICE'],
+ 'notifyObjectType' => ['description' => '- SERVICEGROUP: Service group.'."\n"
+ ."\n"
+ .'- USER: Individual user.', 'type' => 'string', 'title' => '', 'example' => 'USER'],
+ 'expiredType' => ['description' => 'Validity period type:'."\n"
+ ."\n"
+ .'- LONG\\_TERM: Long term.'."\n"
+ ."\n"
+ .'- SHORT\\_TERM: Short term.', 'type' => 'string', 'title' => '', 'example' => 'LONG_TERM'],
+ 'period' => ['description' => 'A string that specifies the time period.', 'type' => 'string', 'example' => '1个月', 'title' => ''],
+ 'startTime' => ['description' => 'Start time of validity period.', 'type' => 'string', 'title' => '', 'example' => '2020-05-09 10:10:10'],
+ 'endTime' => ['description' => 'End time of validity period.', 'type' => 'string', 'title' => '', 'example' => '2021-08-09 10:10:10'],
+ 'status' => ['description' => '- ENABLE: Enabled.'."\n"
+ ."\n"
+ .'- DISABLE: Disabled.', 'type' => 'string', 'title' => '', 'example' => 'ENABLE'],
+ 'scopeObjectList' => [
+ 'description' => 'List of scope objects.',
+ 'items' => [
+ 'description' => 'Subscription scope list.',
+ 'properties' => [
+ 'id' => ['description' => 'ID primary key.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
+ 'scope' => ['description' => 'Subscription scope type:'."\n"
+ ."\n"
+ .'- ALL: All resources.'."\n"
+ ."\n"
+ .'- SERVICE: Service.'."\n"
+ ."\n"
+ .'- ROUTERULE: Routing rule.', 'type' => 'string', 'title' => '', 'example' => 'SERVICE'],
+ 'scopeObjectId' => ['description' => 'Primary key ID of the scope object association table.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
+ 'scopeObject' => ['description' => 'Scope object name.', 'type' => 'string', 'title' => '', 'example' => '阿里云'],
+ 'isValid' => ['title' => 'Validity status: 0 for Invalid, 1 for Valid ', 'description' => 'Whether the scope object is valid:'."\n"
+ ."\n"
+ .'- 0: Invalid.'."\n"
+ ."\n"
+ .'- 1: Valid.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
- 'url' => [
- 'description' => 'url',
- 'example' => 'https://gam-objects-bucket.oss-cn-shanghai.aliyuncs.com',
- 'title' => 'url',
- 'type' => 'string',
+ 'notifyObjectList' => [
+ 'description' => 'List of notification recipients.',
+ 'items' => [
+ 'description' => 'A list of notification recipients.',
+ 'properties' => [
+ 'id' => ['description' => 'ID primary key.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '23'],
+ 'notifyObjectType' => ['description' => 'Notification recipient type:'."\n"
+ ."\n"
+ .'- SERVICEGROUP: Service group.'."\n"
+ ."\n"
+ .'- USER: Individual user.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'USER'],
+ 'notifyObjectId' => ['description' => 'Associated primary key ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '19'],
+ 'name' => ['description' => 'Notification recipient name.', 'type' => 'string', 'title' => '', 'example' => 'TestName'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'files' => [
- 'description' => 'files',
+ 'notifyStrategyList' => [
+ 'description' => 'List of notification strategies.',
'items' => [
+ 'description' => 'The list of notification subscriptions.',
'properties' => [
- 'fileName' => [
- 'description' => '',
- 'example' => '文件A',
- 'title' => '文件名称',
- 'type' => 'string',
- ],
- 'fileType' => [
- 'description' => '',
- 'example' => 'JPG',
- 'title' => '文件类型',
- 'type' => 'string',
- ],
- 'fileSize' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '文件大小',
- 'type' => 'integer',
- ],
- 'key' => [
- 'description' => 'oss key',
- 'example' => 'problem/25a2316c-b08d-41a5-9f41-b3185d529277',
- 'title' => 'oss key',
- 'type' => 'string',
+ 'instanceType' => ['description' => 'Subscription instance type:'."\n"
+ ."\n"
+ .'- INCIDENT: Incident.'."\n"
+ ."\n"
+ .'- ALERT: Alert.'."\n"
+ ."\n"
+ .'- PROBLEM: Problem.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'INCIDENT'],
+ 'strategies' => [
+ 'description' => 'Strategies.',
+ 'items' => [
+ 'description' => 'Strategy.',
+ 'properties' => [
+ 'id' => ['description' => 'Strategy primary key.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '12'],
+ 'channels' => ['description' => 'Notification channel.', 'type' => 'string', 'title' => '', 'example' => 'SMS'],
+ 'conditions' => [
+ 'description' => 'Conditions.',
+ 'items' => [
+ 'description' => 'Subscription condition.',
+ 'properties' => [
+ 'effection' => ['description' => 'Impact scope.', 'type' => 'string', 'title' => '', 'example' => 'HIGH'],
+ 'problemNotifyType' => ['description' => 'Problem notification type.', 'type' => 'string', 'title' => '', 'example' => 'PROBLEM_NOTIFY'],
+ 'level' => ['description' => 'Level.', 'type' => 'string', 'title' => '', 'example' => 'P1'],
+ 'action' => ['description' => 'A time-based action.', 'type' => 'string', 'example' => 'INCIDENT_TRIGGER', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'periodChannel' => [
+ 'description' => 'Time-based notification channel.',
+ 'properties' => [
+ 'workday' => ['description' => 'The working hours for the workday.', 'type' => 'string', 'example' => 'DINGDING', 'title' => ''],
+ 'nonWorkday' => ['description' => 'Non-working hours.', 'type' => 'string', 'example' => 'DINGDING', 'title' => ''],
+ ],
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => 'files',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
],
- 'title' => 'data',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"e2d4306a-bf4d-4345-9ae6-158223c85dbd\\",\\n \\"data\\": {\\n \\"bucketName\\": \\"gam-objects-bucket\\",\\n \\"policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19\\",\\n \\"signature\\": \\"SHqvIkwUNQd8Hervklir*****\\",\\n \\"accessKeyId\\": \\"LTAI****************\\",\\n \\"url\\": \\"https://*****-bucket.oss-cn-shanghai.aliyuncs.com\\",\\n \\"files\\": [\\n {\\n \\"fileName\\": \\"文件A\\",\\n \\"fileType\\": \\"JPG\\",\\n \\"fileSize\\": 100,\\n \\"key\\": \\"problem/25a2316c-b08d-41a5-9f41-*****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GeneratePictureUploadSignResponse>\\n <requestId>e2d4306a-bf4d-4345-9ae6-158223c85dbd</requestId>\\n <data>\\n <bucketName>gam-objects-bucket</bucketName>\\n <policy>eyJleHBpcmF0aW9uIjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19</policy>\\n <signature>SHqvIkwUNQd8Hervklir*****</signature>\\n <accessKeyId>LTAI1tEoRVPw8GMy1iLRC*****</accessKeyId>\\n <url>https://*****-bucket.oss-cn-shanghai.aliyuncs.com</url>\\n <files>\\n <fileName>文件A</fileName>\\n <fileType>JPG</fileType>\\n <fileSize>100</fileSize>\\n <key>problem/25a2316c-b08d-41a5-9f41-*****</key>\\n </files>\\n </data>\\n</GeneratePictureUploadSignResponse>","errorExample":""}]',
- ],
- 'ListProblemDetailOperations' => [
- 'summary' => '故障详情动态',
- 'path' => '/problem/detail/operations',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'NotifySubsNotExists', 'errorMessage' => 'The specified subscription does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"subscriptionId\\": 68,\\n \\"subscriptionTitle\\": \\"newTitle\\",\\n \\"scope\\": \\"SERVICE\\",\\n \\"notifyObjectType\\": \\"USER\\",\\n \\"expiredType\\": \\"LONG_TERM\\",\\n \\"period\\": \\"1个月\\",\\n \\"startTime\\": \\"2020-05-09 10:10:10\\",\\n \\"endTime\\": \\"2021-08-09 10:10:10\\",\\n \\"status\\": \\"ENABLE\\",\\n \\"scopeObjectList\\": [\\n {\\n \\"id\\": 10,\\n \\"scope\\": \\"SERVICE\\",\\n \\"scopeObjectId\\": 10,\\n \\"scopeObject\\": \\"阿里云\\",\\n \\"isValid\\": 1\\n }\\n ],\\n \\"notifyObjectList\\": [\\n {\\n \\"id\\": 23,\\n \\"notifyObjectType\\": 0,\\n \\"notifyObjectId\\": 19,\\n \\"name\\": \\"TestName\\"\\n }\\n ],\\n \\"notifyStrategyList\\": [\\n {\\n \\"instanceType\\": 0,\\n \\"strategies\\": [\\n {\\n \\"id\\": 12,\\n \\"channels\\": \\"SMS\\",\\n \\"conditions\\": [\\n {\\n \\"effection\\": \\"HIGH\\",\\n \\"problemNotifyType\\": \\"PROBLEM_NOTIFY\\",\\n \\"level\\": \\"P1\\",\\n \\"action\\": \\"INCIDENT_TRIGGER\\"\\n }\\n ],\\n \\"periodChannel\\": {\\n \\"workday\\": \\"DINGDING\\",\\n \\"nonWorkday\\": \\"DINGDING\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Notification subscription details '."\n",
+ 'changeSet' => [
+ ['createdAt' => '2022-06-07T11:46:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:37.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:37.000Z', 'description' => 'Response parameters changed'],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubscription'],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'GetTenantApplication' => [
+ 'summary' => 'View mobile application details.',
+ 'path' => '/mobileApp/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1XQ9JR',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempU4CBQS'],
],
'parameters' => [
[
@@ -13745,182 +9013,86 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'required' => false,
- 'title' => '幂等校验',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '行',
- 'type' => 'integer',
- ],
- 'createTimeSort' => [
- 'description' => '',
- 'example' => 'desc,asc',
- 'required' => false,
- 'title' => '时间排序',
- 'type' => 'string',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'required' => true, 'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6', 'title' => ''],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'requestId',
- 'type' => 'string',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '210',
- 'format' => 'int32',
- 'title' => '总数',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'title' => '行',
- 'type' => 'integer',
- ],
'data' => [
- 'description' => 'data',
- 'items' => [
- 'properties' => [
- 'title' => [
- 'description' => '',
- 'example' => '动态标题',
- 'title' => '动态标题',
- 'type' => 'string',
- ],
- 'description' => [
- 'description' => '',
- 'example' => '描述',
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'relatedServiceName' => [
- 'description' => '',
- 'example' => '服务A',
- 'title' => '服务',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2021-01-23 00:00:00',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'remark' => [
- 'description' => '',
- 'example' => '备注',
- 'title' => '备注',
- 'type' => 'string',
- ],
- 'action' => [
- 'description' => '',
- 'example' => 'PROBLEM_CANCEL',
- 'title' => '升级 PROBLEM_UPGRADE 撤销 PROBLEM_REVOKE 恢复 PROBLEM_RESTORE 复盘 PROBLEM_IN_REVIEW 完结 PROBLEM_REOPENED 取消 PROBLEM_CANCEL 更新故障通告 PROBLEM_UPDATE_NOTIFY 添加故障小计 PROBLEM_ADD_SUBTOTAL 更新故障 PROBLEM_UPDATE',
- 'type' => 'string',
- ],
- 'snapshotData' => [
- 'description' => '',
- 'example' => '{“userName”:"小明"}',
- 'title' => '快照数据',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
+ 'description' => 'Integration configuration.',
+ 'properties' => [
+ 'corporationId' => ['description' => 'Enterprise ID.', 'type' => 'string', 'example' => 'ding81913c*', 'title' => ''],
+ 'bizId' => ['description' => 'Business ID.', 'type' => 'string', 'example' => '7356', 'title' => ''],
+ 'progress' => ['description' => 'Progress status.', 'type' => 'string', 'example' => 'NOT_OPEN', 'title' => ''],
+ 'channel' => ['description' => 'Cloud-DingTalk collaboration channel.', 'type' => 'string', 'example' => 'DINGDING', 'title' => ''],
+ 'originalCorpId' => ['description' => 'Tenant ID.', 'type' => 'string', 'title' => '', 'example' => ''],
],
'title' => 'data',
- 'type' => 'array',
+ 'type' => 'object',
+ 'example' => '',
],
+ 'requestId' => ['title' => 'id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"totalCount\\": 210,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"data\\": [\\n {\\n \\"title\\": \\"动态标题\\",\\n \\"description\\": \\"描述\\",\\n \\"relatedServiceName\\": \\"服务A\\",\\n \\"createTime\\": \\"2021-01-23 00:00:00\\",\\n \\"remark\\": \\"备注\\",\\n \\"action\\": \\"PROBLEM_CANCEL\\",\\n \\"snapshotData\\": \\"{“userName”:\\\\\\"小明\\\\\\"}\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProblemDetailOperationsResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n <totalCount>210</totalCount>\\n <pageNumber>1</pageNumber>\\n <pageSize>10</pageSize>\\n <data>\\n <title>动态标题</title>\\n <description>描述</description>\\n <relatedServiceName>服务A</relatedServiceName>\\n <createTime>2021-01-23 00:00:00</createTime>\\n <remark>备注</remark>\\n <action>PROBLEM_CANCEL</action>\\n <snapshotData>{“userName”:\\"小明\\"}</snapshotData>\\n </data>\\n</ListProblemDetailOperationsResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{'."\n"
- .' "clientToken" : "FD200FAE-E98F-496E-BFE6-4CE61E59A2E9",'."\n"
- .' "pageNumber" : 1,'."\n"
- .' "pageSize" : 10,'."\n"
- .' "createTimeSort" : "desc,asc",'."\n"
- .' "problemId" : 1'."\n"
- .'}',
- ],
- 'UpdateProblemImprovement' => [
- 'summary' => '改进分析更新',
- 'path' => '/problem/improvement/update',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"corporationId\\": \\"ding81913c*\\",\\n \\"bizId\\": \\"7356\\",\\n \\"progress\\": \\"NOT_OPEN\\",\\n \\"channel\\": \\"DINGDING\\",\\n \\"originalCorpId\\": \\"\\"\\n },\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","type":"json"}]',
+ 'title' => 'Mobile application details',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-12T16:56:17.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetTenantApplication',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTenantApplication'],
+ ],
],
+ ],
+ 'GetTenantStatus' => [
+ 'summary' => 'Queries the enablement status of the O&M Event Center for a tenant.',
+ 'path' => '/tenant/getTenantStatus',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZVI8H5',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempXF96RS'],
],
'parameters' => [
[
@@ -13928,187 +9100,94 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
+ 'type' => 'object',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障ID',
- 'type' => 'integer',
- ],
- 'problemReason' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '故障原因',
- 'type' => 'string',
- ],
- 'recentActivity' => [
- 'description' => '',
- 'example' => '2',
- 'required' => false,
- 'title' => '最近活动 码表:PROBLEM_RECENT_ACTIVITY',
- 'type' => 'string',
- ],
- 'injectionMode' => [
- 'description' => '',
- 'example' => '1',
- 'required' => false,
- 'title' => '注入方式 码表:PROBLEM_INJECTION_MODE',
- 'type' => 'string',
- ],
- 'recoveryMode' => [
- 'description' => '',
- 'example' => '2',
- 'required' => false,
- 'title' => '恢复方式 码表:PROBLEM_RECOVERY_MODE',
- 'type' => 'string',
- ],
- 'discoverSource' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '发现来源 码表:PROBLEM_DISCOVER_SOURCE',
- 'type' => 'integer',
- ],
- 'userReport' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '用户上报 码表:PROBLEM_USER_REPORT',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'Zabbix',
- 'required' => false,
- 'title' => '监控源',
- 'type' => 'string',
- ],
- 'relationChanges' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '关联变更',
- 'type' => 'string',
- ],
- 'dutyUserId' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障责任人id',
- 'type' => 'integer',
- ],
- 'replayDutyUserId' => [
- 'description' => '',
- 'example' => '1213',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '复盘负责人id',
- 'type' => 'integer',
- ],
- 'dutyDepartmentName' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '故障责任部门',
- 'type' => 'string',
- ],
- 'dutyDepartmentId' => [
- 'description' => '',
- 'example' => '123123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障责任部门ID',
- 'type' => 'integer',
- ],
- 'remark' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '备注',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3813',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
- ],
- 'customProblemReason' => [
- 'title' => '自定义故障原因',
- 'type' => 'string',
- ],
+ 'tenantRamId' => ['description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '132649864', 'title' => ''],
],
'required' => false,
- 'title' => 'A short description of struct',
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response structure.',
+ 'type' => 'object',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => ' 2E7566D1-9E4A-58FA-AEB1-179F86634256'],
+ 'data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'tenantStatus' => ['description' => 'Tenant status:'."\n"
+ ."\n"
+ .'- 0: Enabled.'."\n"
+ ."\n"
+ .'- 1: Disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 'title' => 'Schema of Response',
- 'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\" 2E7566D1-9E4A-58FA-AEB1-179F86634256\\",\\n \\"data\\": {\\n \\"tenantStatus\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'Query the status of whether a tenant has enabled O&M Event Center.',
+ 'responseParamsDescription' => '```'."\n"
+ .'{'."\n"
+ .' "data": {'."\n"
+ .' "tenantStatus": 1'."\n"
+ .' },'."\n"
+ .' "requestId": "6F4514FD-6CE6-5133-B5D8-2B556FCED7A2"'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-14T13:13:04.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetTenantStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateProblemImprovementResponse>\\n <requestId>4361a0e1-6747-4834-96ce-0c4840fd3812</requestId>\\n</UpdateProblemImprovementResponse>","errorExample":""}]',
- ],
- 'ListSubscriptionServiceGroups' => [
- 'summary' => '订阅通知服务组查询',
- 'path' => '/problem/serviceGroup/list',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTenantStatus'],
+ ],
],
+ ],
+ 'GetUser' => [
+ 'summary' => 'View user details.',
+ 'path' => '/user/getUser',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp2C8J2M',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempT8ZOYV'],
],
'parameters' => [
[
@@ -14116,121 +9195,138 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'serviceIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '12313',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'required' => false,
- 'title' => '服务列表',
- 'type' => 'array',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '89f51d2e-5527-4f6c-a6c6-4411b5496e9f',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
- ],
+ 'userId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '63', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotent token.', 'type' => 'string', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '89f51d2e-5527-4f6c-a6c6-4411b5496e9f',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81'],
'data' => [
- 'description' => 'data',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'serviceId' => [
- 'description' => '',
- 'example' => '123113',
- 'format' => 'int64',
- 'title' => '主键',
- 'type' => 'integer',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '服务组名称',
- 'type' => 'string',
- ],
- 'serviceGroupDescription' => [
- 'description' => '',
+ 'description' => 'User.',
+ 'properties' => [
+ 'userId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '63'],
+ 'ramId' => ['title' => 'ramId', 'description' => 'RAM user ID.', 'type' => 'string', 'example' => '1344383'],
+ 'isEditableUser' => ['description' => 'Indicates whether the user is the current user.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'accountType' => ['description' => 'RAM account type:'."\n"
+ ."\n"
+ .'- 0: Alibaba Cloud account.'."\n"
+ ."\n"
+ .'- 1: RAM user.', 'type' => 'string', 'title' => '', 'example' => '1'],
+ 'email' => ['title' => 'email', 'description' => 'The email address.', 'type' => 'string', 'example' => '5678***@qq.com'],
+ 'username' => ['description' => 'User nickname.', 'type' => 'string', 'title' => '', 'example' => '马先生'],
+ 'phone' => ['description' => 'Mobile phone number.', 'type' => 'string', 'title' => '', 'example' => '1390000****'],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2021-09-09 09:09:09', 'title' => ''],
+ 'isRelated' => ['description' => 'Is associated.', 'type' => 'string', 'example' => 'RELATE', 'title' => ''],
+ 'serviceGroups' => [
+ 'description' => 'The service groups that the user belongs to.',
+ 'items' => [
+ 'properties' => [
+ 'name' => ['description' => 'Service group name.', 'type' => 'string', 'example' => '研发组', 'title' => ''],
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'description' => 'Service group.',
+ 'title' => '',
'example' => '',
- 'title' => '服务组描述',
- 'type' => 'string',
],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'type' => 'object',
+ 'roleIdList' => [
+ 'description' => 'Role ID list.',
+ 'title' => 'List of role IDs ',
+ 'type' => 'array',
+ 'items' => ['description' => 'Role ID list.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'example' => '',
+ ],
+ 'roleNameList' => [
+ 'description' => 'Role name list.',
+ 'title' => 'Role Name List',
+ 'type' => 'array',
+ 'items' => ['description' => 'Role name list.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'example' => '',
+ ],
+ 'isActive' => ['title' => 'Account Activation Status (1: Activated, 0: Not Activated)', 'description' => 'Is account active:'."\n"
+ ."\n"
+ .'- 1: Active.'."\n"
+ ."\n"
+ .'- 0: Inactive.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
- 'type' => 'array',
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ServiceGroupNotExisted',
- 'errorMessage' => 'The service group does not exist.',
- ],
+ 404 => [
+ ['errorCode' => 'UserNotExists', 'errorMessage' => 'The specified user does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"89f51d2e-5527-4f6c-a6c6-4411b5496e9f\\",\\n \\"data\\": [\\n {\\n \\"serviceId\\": 123113,\\n \\"serviceName\\": \\"服务A\\",\\n \\"serviceGroupDescription\\": \\"服务描述\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListSubscriptionServiceGroupsResponse>\\n <requestId>89f51d2e-5527-4f6c-a6c6-4411b5496e9f</requestId>\\n <data>\\n <serviceId>123113</serviceId>\\n <serviceName>服务A</serviceName>\\n <serviceGroupDescription>服务描述</serviceGroupDescription>\\n </data>\\n</ListSubscriptionServiceGroupsResponse>","errorExample":""}]',
- ],
- 'CreateProblem' => [
- 'summary' => '故障升级',
- 'path' => '/problem/upgrade',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\",\\n \\"data\\": {\\n \\"userId\\": 63,\\n \\"ramId\\": \\"1344383\\",\\n \\"isEditableUser\\": true,\\n \\"accountType\\": \\"1\\",\\n \\"email\\": \\"5678***@qq.com\\",\\n \\"username\\": \\"马先生\\",\\n \\"phone\\": \\"1390000****\\",\\n \\"createTime\\": \\"2021-09-09 09:09:09\\",\\n \\"isRelated\\": \\"RELATE\\",\\n \\"serviceGroups\\": [\\n {\\n \\"name\\": \\"研发组\\",\\n \\"serviceGroupId\\": 10000\\n }\\n ],\\n \\"roleIdList\\": [\\n 0\\n ],\\n \\"roleNameList\\": [\\n \\"\\"\\n ],\\n \\"isActive\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'View user details ',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-15T11:46:18.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-04-13T12:01:54.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:12:34.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'],
+ ],
],
+ ],
+ 'GetUserGuideStatus' => [
+ 'summary' => 'Obtain the user onboarding status.',
+ 'path' => '/user/guide/status',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZB7ZAW',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempVWXIZC'],
],
'parameters' => [
[
@@ -14238,132 +9334,14 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'A short description of struct',
'properties' => [
- 'problemName' => [
- 'description' => '',
- 'example' => '故障A',
- 'required' => false,
- 'title' => '故障名称',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'E789D869-DB13-4913-BAA8-A1F56F94B94D',
- 'required' => false,
- 'title' => '幂等校验Id',
- 'type' => 'string',
- ],
- 'problemStatus' => [
- 'description' => '',
- 'example' => 'HANDLING',
- 'required' => false,
- 'title' => '故障状态 HANDLING 处理中 RECOVERED 已恢复 REPLAYING 复盘中 REPLAYED 已复盘 CANCEL 已取消',
- 'type' => 'string',
- ],
- 'problemLevel' => [
- 'description' => '',
- 'example' => 'P2',
- 'required' => false,
- 'title' => '故障等级 1=P1 2=P2 3=P3 4=P4',
- 'type' => 'string',
- ],
- 'progressSummary' => [
- 'description' => '',
- 'example' => '进展摘要',
- 'required' => false,
- 'title' => '进展摘要',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '123122',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '所属服务',
- 'type' => 'integer',
- ],
- 'mainHandlerId' => [
- 'description' => '',
- 'example' => '32121',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '主要处理人',
- 'type' => 'integer',
- ],
- 'preliminaryReason' => [
- 'description' => '',
- 'example' => '初步原因',
- 'required' => false,
- 'title' => '初步原因',
- 'type' => 'string',
- ],
- 'discoverTime' => [
- 'description' => '',
- 'example' => '2020-10-02 00:00:00',
- 'required' => false,
- 'title' => '发现时间 (XXXX-XX-XX 00:00:00)',
- 'type' => 'string',
- ],
- 'recoveryTime' => [
- 'description' => '',
- 'example' => '2020-10-02 00:00:00',
- 'required' => false,
- 'title' => '恢复时间',
- 'type' => 'string',
- ],
- 'affectServiceIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '1232231',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'required' => false,
- 'title' => '影响服务列表',
- 'type' => 'array',
- ],
- 'serviceGroupIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '213121',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'required' => false,
- 'title' => '应急协同组',
- 'type' => 'array',
- ],
- 'incidentId' => [
- 'description' => '',
- 'example' => '123221',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '事件id',
- 'type' => 'integer',
- ],
- 'problemNotifyType' => [
- 'description' => '',
- 'example' => 'PROBLEM_NOTIFY',
- 'required' => false,
- 'title' => '通告类型',
- 'type' => 'string',
- ],
- 'progressSummaryRichTextId' => [
- 'description' => '',
- 'example' => '343',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '进展摘要富文本id',
- 'type' => 'integer',
- ],
+ 'clientToken' => ['description' => 'Idempotency validation.', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -14372,71 +9350,56 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'E789D869-DB13-4933-BAA8-A1F56F94B94D',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'data',
- 'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '321331',
- 'format' => 'int64',
- 'title' => '故障Id',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'title' => 'Id of the request', 'type' => 'string'],
+ 'data' => ['description' => 'map', 'example' => '{ "data": { "monitorGuide": false, "userRamId": 1344371, "serviceGuide": false, "noticeGuide": false, "userGuide": true, "serviceGroupGuide": false, "routeRuleGuide": false, "incidentGuide": true }', 'title' => 'map', 'type' => 'object'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'IncidentNotExtisted',
- 'errorMessage' => 'The incident does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain the user onboarding status',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetUserGuideStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"E789D869-DB13-4933-BAA8-A1F56F94B94D\\",\\n \\"data\\": {\\n \\"problemId\\": 321331\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateProblemResponse>\\n <requestId>E789D869-DB13-4933-BAA8-A1F56F94B94D</requestId>\\n <data>\\n <problemId>321331</problemId>\\n </data>\\n</CreateProblemResponse>","errorExample":""}]',
- ],
- 'CreateProblemMeasure' => [
- 'summary' => '改进措施新增',
- 'path' => '/problem/improvement/measure/save',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserGuideStatus'],
+ ],
],
+ ],
+ 'ListAlerts' => [
+ 'summary' => 'Queries a list of alerts.',
+ 'path' => '/alerts/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLC8226',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempERNU0Z'],
],
'parameters' => [
[
@@ -14444,160 +9407,132 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'The request body.',
'properties' => [
- 'type' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '措施类型',
- 'type' => 'integer',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '23',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '故障Id',
- 'type' => 'integer',
- ],
- 'content' => [
- 'description' => '',
- 'example' => '措施内容',
- 'required' => false,
- 'title' => '措施内容',
- 'type' => 'string',
- ],
- 'checkStandard' => [
- 'description' => '',
- 'example' => '标准',
- 'required' => false,
- 'title' => '验收标准',
- 'type' => 'string',
- ],
- 'checkUserId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '验收人id',
- 'type' => 'integer',
- ],
- 'planFinishTime' => [
- 'description' => '',
- 'example' => '2020-01-23 00:00:00',
- 'required' => false,
- 'title' => '计划完成时间',
- 'type' => 'string',
- ],
- 'directorId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '负责人id',
- 'type' => 'integer',
- ],
- 'stalkerId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '跟踪人id',
- 'type' => 'integer',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'IMPROVED',
- 'required' => false,
- 'title' => '状态 IMPROVED 改进 2 未改进UNIMPROVED',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
- ],
+ 'alertLevel' => ['description' => 'The alert level.', 'type' => 'string', 'example' => 'P1', 'title' => '', 'required' => false],
+ 'relatedServiceId' => ['description' => 'The ID of the associated service.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'alertName' => ['description' => 'The alert name.', 'type' => 'string', 'example' => '报警', 'title' => '', 'required' => false],
+ 'pageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'pageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => '', 'required' => false],
+ 'alertSourceName' => ['description' => 'The alert source.', 'type' => 'string', 'example' => '流转规则A', 'title' => '', 'required' => false],
+ 'startTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2020-09-10 13:00:00', 'title' => '', 'required' => false],
+ 'endTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2020-09-10 21:00:00', 'title' => '', 'required' => false],
+ 'ruleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => '规则名称', 'title' => '', 'required' => false],
+ 'monitorSourceId' => ['description' => 'The ID of the monitoring source.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'C4BE3837'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => ''],
'data' => [
- 'description' => 'data',
- 'properties' => [
- 'measureId' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'title' => '故障措施Id',
- 'type' => 'integer',
+ 'description' => 'The list of alerts.',
+ 'items' => [
+ 'properties' => [
+ 'alertId' => ['description' => 'The alert ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', 'title' => ''],
+ 'createTime' => ['description' => 'The time when the alert was created.', 'type' => 'string', 'example' => '2020-03-05 15:53:55', 'title' => ''],
+ 'relatedServiceName' => ['description' => 'The name of the associated service.', 'type' => 'string', 'example' => '冲上云霄', 'title' => ''],
+ 'alertLevel' => ['description' => 'The alert priority level. The levels are listed in descending order of priority:'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'string', 'example' => 'P1', 'title' => ''],
+ 'title' => ['description' => 'The alert title.', 'type' => 'string', 'example' => '报警', 'title' => ''],
+ 'sourceEventCount' => ['description' => 'The number of converged events.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'alertSourceName' => ['description' => 'The alert source.', 'type' => 'string', 'example' => '流转规则A', 'title' => ''],
+ 'firstEventTime' => ['description' => 'The time when the first alert was reported.', 'type' => 'string', 'example' => '2021-09-08 18:30:00', 'title' => ''],
+ 'routeRuleId' => ['description' => 'The ID of the associated stream rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ 'alertNumber' => ['description' => 'The alert number.', 'type' => 'string', 'example' => 'A123123123', 'title' => ''],
+ 'routeRuleName' => ['description' => 'The name of the stream rule.', 'type' => 'string', 'example' => '流转规则', 'title' => ''],
+ 'relServiceDeleteType' => ['description' => 'Indicates whether the associated service is deleted. Valid values:'."\n"
+ ."\n"
+ .'- 1: Normal.'."\n"
+ ."\n"
+ .'- 0: Deleted.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'routeRuleDeleteType' => ['description' => 'Indicates whether the rule is deleted. Valid values:'."\n"
+ ."\n"
+ .'- 1: Normal.'."\n"
+ ."\n"
+ .'- 0: Deleted.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'monitorSourceName' => ['description' => 'The name of the source data.', 'type' => 'string', 'title' => '', 'example' => 'name'],
],
+ 'type' => 'object',
+ 'description' => 'The list of alerts.',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'object',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'pageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": [\\n {\\n \\"alertId\\": 20000,\\n \\"createTime\\": \\"2020-03-05 15:53:55\\",\\n \\"relatedServiceName\\": \\"冲上云霄\\",\\n \\"alertLevel\\": \\"P1\\",\\n \\"title\\": \\"报警\\",\\n \\"sourceEventCount\\": 10,\\n \\"alertSourceName\\": \\"流转规则A\\",\\n \\"firstEventTime\\": \\"2021-09-08 18:30:00\\",\\n \\"routeRuleId\\": 10000,\\n \\"alertNumber\\": \\"A123123123\\",\\n \\"routeRuleName\\": \\"流转规则\\",\\n \\"relServiceDeleteType\\": 1,\\n \\"routeRuleDeleteType\\": 1,\\n \\"monitorSourceName\\": \\"name\\"\\n }\\n ],\\n \\"totalCount\\": 100,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","type":"json"}]',
+ 'title' => 'Alert list query ',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-14T12:26:25.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-06-07T11:52:18.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:41.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListAlerts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\",\\n \\"data\\": {\\n \\"measureId\\": 1231\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateProblemMeasureResponse>\\n <requestId>4361a0e1-6747-4834-96ce-0c4840fd3812</requestId>\\n <data>\\n <measureId>1231</measureId>\\n </data>\\n</CreateProblemMeasureResponse>","errorExample":""}]',
- ],
- 'CreateProblemSubtotal' => [
- 'summary' => '故障新增备注小计',
- 'path' => '/problem/save/subtotal',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlerts'],
+ ],
],
+ ],
+ 'ListByMonitorSourceId' => [
+ 'summary' => 'Monitoring association rules',
+ 'path' => '/routeRule/listByMonitorSourceId',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZB7ZAW',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempBHVB81'],
],
'parameters' => [
[
@@ -14605,107 +9540,89 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'title' => 'A short description of struct',
+ 'description' => 'Request body.',
+ 'type' => 'object',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '故障Id',
- 'type' => 'integer',
- ],
- 'description' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '小计文本',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3814',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
- ],
+ 'monitorSourceId' => ['description' => 'Monitoring source ID.', 'type' => 'string', 'required' => false, 'example' => '23469', 'title' => ''],
],
'required' => false,
- 'title' => 'A short description of struct',
- 'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'title' => 'Schema of Response',
+ 'description' => 'Response structure.',
+ 'type' => 'object',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd381A',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88'],
'data' => [
- 'description' => 'object',
- 'properties' => [
- 'subtotalId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'title' => '小计id',
- 'type' => 'integer',
+ 'title' => 'data',
+ 'description' => 'Returned data.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '164769572'],
+ 'ruleName' => ['description' => 'Rule name.', 'type' => 'string', 'example' => 'internal-alert-center-log', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'object',
+ 'example' => '',
],
],
- 'title' => 'Schema of Response',
- 'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": [\\n {\\n \\"id\\": 164769572,\\n \\"ruleName\\": \\"internal-alert-center-log\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'List of monitoring association rules ',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-07T11:35:47.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListByMonitorSourceId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd381A\\",\\n \\"data\\": {\\n \\"subtotalId\\": 123\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateProblemSubtotalResponse>\\n <requestId>4361a0e1-6747-4834-96ce-0c4840fd381A</requestId>\\n <data>\\n <subtotalId>123</subtotalId>\\n </data>\\n</CreateProblemSubtotalResponse>","errorExample":""}]',
- ],
- 'CreateProblemTimeline' => [
- 'summary' => '创建故障时间线节点',
- 'path' => '/problem/process/timeline/create',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListByMonitorSourceId'],
+ ],
],
+ ],
+ 'ListChartDataForServiceGroup' => [
+ 'summary' => 'Data Report chart Data API (service group).',
+ 'path' => '/statistics/chartDataForServiceGroup/',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZVI8H5',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempTZ0FO2'],
],
'parameters' => [
[
@@ -14715,46 +9632,14 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '102',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
- 'keyNode' => [
- 'description' => '',
- 'example' => 'NodeTest',
- 'required' => false,
- 'title' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
- 'type' => 'string',
- ],
- 'content' => [
- 'description' => '',
- 'example' => 'test123',
- 'required' => false,
- 'title' => '节点内容',
- 'type' => 'string',
- ],
- 'time' => [
- 'description' => '',
- 'example' => '2021-06-06 12:11:22',
- 'required' => false,
- 'title' => '发生时间',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
+ 'clientToken' => ['description' => 'clientToken', 'example' => '23es23s32xas23', 'required' => false, 'type' => 'string', 'title' => ''],
+ 'startTime' => ['description' => 'Start Time', 'example' => '2021-09-09', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'endTime' => ['description' => 'End Time', 'example' => '2021-10-09', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -14763,72 +9648,95 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'title' => 'id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => '1231212', 'title' => 'Id of the request', 'type' => 'string'],
'data' => [
'description' => 'data',
- 'properties' => [
- 'problemTimelineId' => [
- 'description' => '',
- 'example' => '102',
- 'format' => 'int64',
- 'title' => '故障事件线id',
- 'type' => 'integer',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'time' => ['description' => 'Time ', 'example' => '2021-09-09', 'title' => '', 'type' => 'string'],
+ 'incidentCount' => ['description' => 'Total number of management events', 'example' => '32', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'effectionLevel' => ['description' => 'Quantity grouped by impact level and time level ', 'example' => '{"P1HIGH":32}', 'title' => '', 'type' => 'object'],
+ 'meanTimeToAcknowledge' => ['description' => 'Daily mean response time in seconds ', 'example' => '323', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'meanTimeToRepair' => ['description' => 'Daily mean time to repair in seconds ', 'example' => '4343', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'totalMeanTimeToAcknowledge' => ['description' => 'Total mean response time', 'example' => '3334', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'totalMeanTimeToRepair' => ['description' => 'Total mean time to repair ', 'example' => '4343', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'escalationIncidentCount' => ['description' => 'Number of escalation management events', 'example' => '43', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'unAcknowledgedEscalationIncidentCount' => ['description' => 'Number of unacknowledged escalation management events ', 'example' => '23', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'unFinishEscalationIncidentCount' => ['description' => 'Number of unresolved escalation management events', 'example' => '23', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => 'Object',
- 'type' => 'object',
+ 'title' => 'data',
+ 'type' => 'array',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1231212\\",\\n \\"data\\": [\\n {\\n \\"time\\": \\"2021-09-09\\",\\n \\"incidentCount\\": 32,\\n \\"effectionLevel\\": {\\n \\"P1HIGH\\": 32\\n },\\n \\"meanTimeToAcknowledge\\": 323,\\n \\"meanTimeToRepair\\": 4343,\\n \\"totalMeanTimeToAcknowledge\\": 3334,\\n \\"totalMeanTimeToRepair\\": 4343,\\n \\"escalationIncidentCount\\": 43,\\n \\"unAcknowledgedEscalationIncidentCount\\": 23,\\n \\"unFinishEscalationIncidentCount\\": 23\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Data Report chart Data API (service group) ',
+ 'responseParamsDescription' => '{'."\n"
+ .' "requestId": "1231212",'."\n"
+ .' "data": ['."\n"
+ .' {'."\n"
+ .' "time": "2021-09-09",'."\n"
+ .' "incidentCount": 32,'."\n"
+ .' "meanTimeToAcknowledge": 323,'."\n"
+ .' "meanTimeToRepair": 4343,'."\n"
+ .' "totalMeanTimeToAcknowledge": 3334,'."\n"
+ .' "totalMeanTimeToRepair": 4343,'."\n"
+ .' "escalationIncidentCount": 43,'."\n"
+ .' "unAcknowledgedEscalationIncidentCount": 23,'."\n"
+ .' "unFinishEscalationIncidentCount": 23'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-16T01:59:34.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListChartDataForServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"problemTimelineId\\": 102\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateProblemTimelineResponse>\\n <requestId>10REQUES-AC5C-4B59-BE11-378F117A6A88</requestId>\\n <data>\\n <problemTimelineId>102</problemTimelineId>\\n </data>\\n</CreateProblemTimelineResponse>","errorExample":""}]',
- ],
- 'CreateProblemTimelines' => [
- 'summary' => '批量创建故障时间线节点',
- 'path' => '/problem/process/timeline/batchCreate',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'ListChartDataForUser' => [
+ 'summary' => 'Data Report chart Data API (Personnel).',
+ 'path' => '/statistics/chartDataForUser/',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLC8226',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempTZ0FO2'],
],
'parameters' => [
[
@@ -14838,32 +9746,14 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '423',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
- 'timelineNodes' => [
- 'description' => '',
- 'example' => '2018-01-01 18:01,谁做了什么事情\\n2018-01-01 18:01,谁做了什么事情\\n2018-01-01 18:01,谁做了什么事情',
- 'required' => false,
- 'title' => '时间线节点',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => 'clientToken',
- 'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
+ 'clientToken' => ['description' => 'clientToken', 'example' => '3232dsd32sd32gr', 'required' => false, 'type' => 'string', 'title' => ''],
+ 'startTime' => ['description' => 'Start Time.', 'example' => '2021-09-09', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'endTime' => ['description' => 'End Time.', 'example' => '2021-10-09', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -14872,83 +9762,100 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => '0F4AFF8E-DF59-5CA6-B184-9E5A2A14C8D6', 'title' => 'Id of the request', 'type' => 'string'],
'data' => [
'description' => 'data',
- 'properties' => [
- 'problemTimelineIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '435',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'type' => 'array',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'time' => ['description' => 'Time.', 'example' => '2021-09-09', 'title' => '', 'type' => 'string'],
+ 'incidentCount' => ['description' => 'Total number of management events.', 'example' => '32', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'effectionLevel' => ['description' => 'Statistics grouped by impact level and time level.', 'example' => '{"P1HIGH":32}', 'title' => '', 'type' => 'object'],
+ 'meanTimeToAcknowledge' => ['description' => 'Daily mean response time in seconds.', 'example' => '323', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'meanTimeToRepair' => ['description' => 'Daily mean time to repair in seconds.', 'example' => '4343', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'totalMeanTimeToAcknowledge' => ['description' => 'Total mean response time.', 'example' => '3334', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'totalMeanTimeToRepair' => ['description' => 'Total mean time to repair.', 'example' => '4343', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'escalationIncidentCount' => ['description' => 'Number of escalation management events.', 'example' => '43', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'unAcknowledgedEscalationIncidentCount' => ['description' => 'Number of unacknowledged escalation management events.', 'example' => '23', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
+ 'unFinishEscalationIncidentCount' => ['description' => 'Number of unresolved escalation management events.', 'example' => '23', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'object',
+ 'title' => 'data',
+ 'type' => 'array',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'TimelineFormatException',
- 'errorMessage' => 'The timeline format is invalid.',
- ],
- [
- 'errorCode' => 'TimeFormatException',
- 'errorMessage' => 'The time format is invalid.',
- ],
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0F4AFF8E-DF59-5CA6-B184-9E5A2A14C8D6\\",\\n \\"data\\": [\\n {\\n \\"time\\": \\"2021-09-09\\",\\n \\"incidentCount\\": 32,\\n \\"effectionLevel\\": {\\n \\"P1HIGH\\": 32\\n },\\n \\"meanTimeToAcknowledge\\": 323,\\n \\"meanTimeToRepair\\": 4343,\\n \\"totalMeanTimeToAcknowledge\\": 3334,\\n \\"totalMeanTimeToRepair\\": 4343,\\n \\"escalationIncidentCount\\": 43,\\n \\"unAcknowledgedEscalationIncidentCount\\": 23,\\n \\"unFinishEscalationIncidentCount\\": 23\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Data Report Chart Data API (Personnel)',
+ 'requestParamsDescription' => '{'."\n"
+ .' "clientToken" : "3232dsd32sd32gr",'."\n"
+ .' "startTime" : "2021-09-09",'."\n"
+ .' "endTime" : "2021-10-09"'."\n"
+ .'}',
+ 'responseParamsDescription' => '{'."\n"
+ .' "requestId": "1231212",'."\n"
+ .' "data": ['."\n"
+ .' {'."\n"
+ .' "time": "2021-09-09",'."\n"
+ .' "incidentCount": 32,'."\n"
+ .' "meanTimeToAcknowledge": 323,'."\n"
+ .' "meanTimeToRepair": 4343,'."\n"
+ .' "totalMeanTimeToAcknowledge": 3334,'."\n"
+ .' "totalMeanTimeToRepair": 4343,'."\n"
+ .' "escalationIncidentCount": 43,'."\n"
+ .' "unAcknowledgedEscalationIncidentCount": 23,'."\n"
+ .' "unFinishEscalationIncidentCount": 23'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-16T01:59:34.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListChartDataForUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"problemTimelineIds\\": [\\n 435\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateProblemTimelinesResponse>\\n <data>\\n <problemTimelineIds>435</problemTimelineIds>\\n </data>\\n</CreateProblemTimelinesResponse>","errorExample":""}]',
- ],
- 'AddProblemServiceGroup' => [
- 'summary' => '添加故障协同组',
- 'path' => '/problem/addServiceGroup',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'ListConfigs' => [
+ 'summary' => 'Retrieve all dynamic lookup table configuration items. ',
+ 'path' => '/config/all',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZVI8H5',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
'parameters' => [
[
@@ -14958,31 +9865,12 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障ID',
- 'type' => 'integer',
- ],
- 'serviceGroupIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '应急协同组ID',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'required' => false,
- 'title' => '应急协同组',
- 'type' => 'array',
- ],
+ 'clientToken' => ['description' => 'Idempotency validation ID.', 'example' => 'FD200FAE-E98F-496E-BFE6-CDE61E59A2E9', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -14991,50 +9879,83 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '5AD6E6BC-2582-4E0E-832D-52CB1B922253',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'data' => [
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'configDescription' => ['title' => '', 'type' => 'string', 'description' => 'Configuration type. ', 'example' => '产品设计'],
+ 'configCode' => ['title' => '', 'type' => 'string', 'example' => 'PROBLEM_REASON_DISASTER', 'description' => 'Configuration code. '],
+ 'parentCode' => ['title' => '', 'type' => 'string', 'description' => 'Parent configuration code. ', 'example' => 'PROBLEM_REASON'],
+ 'configKey' => ['title' => '', 'type' => 'string', 'example' => '2', 'description' => 'Configuration key item. '],
+ 'configValue' => ['title' => '', 'type' => 'string', 'example' => '产品设计', 'description' => 'The value corresponding to the configuration key.'],
+ 'requirement' => ['title' => '', 'type' => 'boolean', 'description' => 'Whether the item is required. '."\n"
+ .'- true: Yes. '."\n"
+ .'- false: No. ', 'example' => 'true'],
+ ],
+ 'description' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'array',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'data',
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
+ 'requestId' => ['description' => 'requestId', 'example' => 'uuid', 'title' => 'requestId', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"5AD6E6BC-2582-4E0E-832D-52CB1B922253\\"\\n}","errorExample":""},{"type":"xml","example":"<AddProblemServiceGroupResponse>\\n <requestId>5AD6E6BC-2582-4E0E-832D-52CB1B922253</requestId>\\n</AddProblemServiceGroupResponse>","errorExample":""}]',
- ],
- 'UpdateProblem' => [
- 'summary' => '更新故障',
- 'path' => '/problem/update',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"key\\": [\\n {\\n \\"configDescription\\": \\"产品设计\\",\\n \\"configCode\\": \\"PROBLEM_REASON_DISASTER\\",\\n \\"parentCode\\": \\"PROBLEM_REASON\\",\\n \\"configKey\\": \\"2\\",\\n \\"configValue\\": \\"产品设计\\",\\n \\"requirement\\": true\\n }\\n ]\\n },\\n \\"requestId\\": \\"uuid\\"\\n}","type":"json"}]',
+ 'title' => 'Lookup table configuration',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListConfigs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConfigs'],
+ ],
],
+ ],
+ 'ListDataReportForServiceGroup' => [
+ 'summary' => 'Retrieves paginated statistics for service groups.',
+ 'path' => '/statistics/listDataReportForServiceGroup',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZVI8H5',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp20VVML'],
],
'parameters' => [
[
@@ -15042,155 +9963,238 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'The request body.',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '213432',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障ID',
- 'type' => 'integer',
- ],
- 'problemName' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '故障名',
- 'type' => 'string',
- ],
- 'level' => [
- 'description' => '',
- 'example' => 'P1',
- 'required' => false,
- 'title' => '故障等级',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '所属服务',
- 'type' => 'integer',
- ],
- 'progressSummary' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '进展摘要',
- 'type' => 'string',
- ],
- 'preliminaryReason' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '初步原因',
- 'type' => 'string',
- ],
- 'mainHandlerId' => [
- 'description' => '',
- 'example' => '678',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '主要处理人',
- 'type' => 'integer',
- ],
- 'feedback' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '舆情反馈',
- 'type' => 'string',
- ],
- 'serviceGroupIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '102',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'required' => false,
- 'title' => '应急协同组',
- 'type' => 'array',
- ],
- 'progressSummaryRichTextId' => [
- 'description' => '',
- 'example' => '23232',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '进展摘要富文本id',
- 'type' => 'integer',
- ],
+ 'startTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2021-09-09', 'title' => '', 'required' => false],
+ 'endTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-10-22', 'title' => '', 'required' => false],
+ 'pageNumber' => ['title' => 'Page Number', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ 'pageSize' => ['title' => 'Page Size', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
+ 'serviceGroupName' => ['description' => 'The name of the service group.', 'type' => 'string', 'required' => false, 'example' => 'A服务组', 'title' => ''],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8D0F6435-162E-5088-84A1-4178C0F209CD'],
+ 'data' => [
+ 'description' => 'The statistics.',
+ 'items' => [
+ 'description' => 'The statistics.',
+ 'properties' => [
+ 'serviceGroupName' => ['description' => 'The name of the service group.', 'type' => 'string', 'example' => '标准集成服务组', 'title' => ''],
+ 'incidentCount' => ['description' => 'The number of events.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'escalationIncidentCount' => ['description' => 'The number of escalated events.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'unAcknowledgedEscalationIncidentCount' => ['description' => 'The number of unacknowledged escalated events.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'unFinishEscalationIncidentCount' => ['description' => 'The number of unfinished escalated events.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'serviceGroupId' => ['description' => 'The ID of the service group.', 'type' => 'integer', 'format' => 'int64', 'example' => '103419260', 'title' => ''],
+ 'meanTimeToAcknowledge' => ['title' => 'MRRA', 'description' => 'The average response time of the day.', 'type' => 'integer', 'format' => 'int64', 'example' => '3分19秒'],
+ 'meanTimeToRepair' => ['title' => 'MTTR', 'description' => 'The average time to resolution of the day.', 'type' => 'integer', 'format' => 'int64', 'example' => '3分19秒'],
+ 'finishProportion' => ['description' => 'The resolution rate.', 'type' => 'string', 'example' => '0%', 'title' => ''],
+ 'finishIncidentCount' => ['description' => 'The number of resolved events.', 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'pageSIze' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'pageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateProblemResponse>\\n <requestId>c26f36de-1ec8-496a-a828-880676c5ef81</requestId>\\n</UpdateProblemResponse>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8D0F6435-162E-5088-84A1-4178C0F209CD\\",\\n \\"data\\": [\\n {\\n \\"serviceGroupName\\": \\"标准集成服务组\\",\\n \\"incidentCount\\": 1,\\n \\"escalationIncidentCount\\": 100,\\n \\"unAcknowledgedEscalationIncidentCount\\": 200,\\n \\"unFinishEscalationIncidentCount\\": 200,\\n \\"serviceGroupId\\": 103419260,\\n \\"meanTimeToAcknowledge\\": 0,\\n \\"meanTimeToRepair\\": 0,\\n \\"finishProportion\\": \\"0%\\",\\n \\"finishIncidentCount\\": 111\\n }\\n ],\\n \\"pageSIze\\": 10,\\n \\"pageNumber\\": 1,\\n \\"totalCount\\": 100\\n}","type":"json"}]',
+ 'title' => 'Query service group management event statistical report ',
+ 'requestParamsDescription' => '{'."\n"
+ .'"pageNumber": 1,'."\n"
+ .'"pageSize": 10,'."\n"
+ .'"startTime": "2021-11-02",'."\n"
+ .'"endTime": "2021-11-09",'."\n"
+ .'"clientToken": "ec1eba2b-cbd9-4daa-aa6e-d127a27989bc"'."\n"
+ .'}',
'responseParamsDescription' => '{'."\n"
- .' "requestId": "c26f36de-1ec8-496a-a828-880676c5ef81"'."\n"
+ .'"requestId": "gdgsdgsggsdg",'."\n"
+ .'"data": \\['."\n"
+ .'{'."\n"
+ .'"meanTimeToAcknowledge": "66 days 37 minutes 50 seconds",'."\n"
+ .'"meanTimeToRepair": "20 hours 20 minutes 48 seconds",'."\n"
+ .'"finishProportion": "17.65%",'."\n"
+ .'"serviceGroupName": "Meal Group (DingTalk group)",'."\n"
+ .'"incidentCount": 34,'."\n"
+ .'"finishIncidentCount": 6,'."\n"
+ .'"escalationIncidentCount": 21,'."\n"
+ .'"unAcknowledgedEscalationIncidentCount": 20,'."\n"
+ .'"unFinishEscalationIncidentCount": 21,'."\n"
+ .'"serviceGroupId": 32'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"meanTimeToAcknowledge": "66 days 37 minutes 50 seconds",'."\n"
+ .'"meanTimeToRepair": "20 hours 20 minutes 48 seconds",'."\n"
+ .'"finishProportion": "25.00%",'."\n"
+ .'"serviceGroupName": "National Day Enterprise",'."\n"
+ .'"incidentCount": 24,'."\n"
+ .'"finishIncidentCount": 6,'."\n"
+ .'"escalationIncidentCount": 11,'."\n"
+ .'"unAcknowledgedEscalationIncidentCount": 10,'."\n"
+ .'"unFinishEscalationIncidentCount": 11,'."\n"
+ .'"serviceGroupId": 180020080'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"meanTimeToAcknowledge": "66 days 37 minutes 50 seconds",'."\n"
+ .'"meanTimeToRepair": "20 hours 20 minutes 48 seconds",'."\n"
+ .'"finishProportion": "25.00%",'."\n"
+ .'"serviceGroupName": "\\[Daily] Hujiangping\'s Test Service Group",'."\n"
+ .'"incidentCount": 24,'."\n"
+ .'"finishIncidentCount": 6,'."\n"
+ .'"escalationIncidentCount": 11,'."\n"
+ .'"unAcknowledgedEscalationIncidentCount": 10,'."\n"
+ .'"unFinishEscalationIncidentCount": 11,'."\n"
+ .'"serviceGroupId": 170020030'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"meanTimeToAcknowledge": "66 days 37 minutes 50 seconds",'."\n"
+ .'"meanTimeToRepair": "20 hours 20 minutes 48 seconds",'."\n"
+ .'"finishProportion": "25.00%",'."\n"
+ .'"serviceGroupName": "Slack",'."\n"
+ .'"incidentCount": 24,'."\n"
+ .'"finishIncidentCount": 6,'."\n"
+ .'"escalationIncidentCount": 11,'."\n"
+ .'"unAcknowledgedEscalationIncidentCount": 10,'."\n"
+ .'"unFinishEscalationIncidentCount": 11,'."\n"
+ .'"serviceGroupId": 110030020'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"meanTimeToAcknowledge": "66 days 37 minutes 50 seconds",'."\n"
+ .'"meanTimeToRepair": "11 days 33 minutes 35 seconds",'."\n"
+ .'"finishProportion": "9.09%",'."\n"
+ .'"serviceGroupName": "Lark Group",'."\n"
+ .'"incidentCount": 11,'."\n"
+ .'"finishIncidentCount": 1,'."\n"
+ .'"escalationIncidentCount": 10,'."\n"
+ .'"unAcknowledgedEscalationIncidentCount": 10,'."\n"
+ .'"unFinishEscalationIncidentCount": 10,'."\n"
+ .'"serviceGroupId": 130000010'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"meanTimeToAcknowledge": "66 days 37 minutes 50 seconds",'."\n"
+ .'"meanTimeToRepair": "11 days 33 minutes 35 seconds",'."\n"
+ .'"finishProportion": "9.09%",'."\n"
+ .'"serviceGroupName": "Detailed Scheduling",'."\n"
+ .'"incidentCount": 11,'."\n"
+ .'"finishIncidentCount": 1,'."\n"
+ .'"escalationIncidentCount": 10,'."\n"
+ .'"unAcknowledgedEscalationIncidentCount": 10,'."\n"
+ .'"unFinishEscalationIncidentCount": 10,'."\n"
+ .'"serviceGroupId": 110020010'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"meanTimeToAcknowledge": "0",'."\n"
+ .'"meanTimeToRepair": "0",'."\n"
+ .'"finishProportion": "0.00%",'."\n"
+ .'"serviceGroupName": "New Service Group 0927",'."\n"
+ .'"incidentCount": 8,'."\n"
+ .'"finishIncidentCount": 0,'."\n"
+ .'"escalationIncidentCount": 8,'."\n"
+ .'"unAcknowledgedEscalationIncidentCount": 8,'."\n"
+ .'"unFinishEscalationIncidentCount": 8,'."\n"
+ .'"serviceGroupId": 160020050'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"meanTimeToAcknowledge": "0",'."\n"
+ .'"meanTimeToRepair": "0",'."\n"
+ .'"finishProportion": "0.00%",'."\n"
+ .'"serviceGroupName": "ces",'."\n"
+ .'"incidentCount": 7,'."\n"
+ .'"finishIncidentCount": 0,'."\n"
+ .'"escalationIncidentCount": 7,'."\n"
+ .'"unAcknowledgedEscalationIncidentCount": 7,'."\n"
+ .'"unFinishEscalationIncidentCount": 7,'."\n"
+ .'"serviceGroupId": 170020040'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"meanTimeToAcknowledge": "0",'."\n"
+ .'"meanTimeToRepair": "0",'."\n"
+ .'"finishProportion": "0.00%",'."\n"
+ .'"serviceGroupName": "Card Service Group Test \\[Do Not Modify]",'."\n"
+ .'"incidentCount": 7,'."\n"
+ .'"finishIncidentCount": 0,'."\n"
+ .'"escalationIncidentCount": 7,'."\n"
+ .'"unAcknowledgedEscalationIncidentCount": 7,'."\n"
+ .'"unFinishEscalationIncidentCount": 7,'."\n"
+ .'"serviceGroupId": 160020030'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"meanTimeToAcknowledge": "0",'."\n"
+ .'"meanTimeToRepair": "0",'."\n"
+ .'"finishProportion": "0.00%",'."\n"
+ .'"serviceGroupName": "This is a service group 1018",'."\n"
+ .'"incidentCount": 7,'."\n"
+ .'"finishIncidentCount": 0,'."\n"
+ .'"escalationIncidentCount": 7,'."\n"
+ .'"unAcknowledgedEscalationIncidentCount": 7,'."\n"
+ .'"unFinishEscalationIncidentCount": 7,'."\n"
+ .'"serviceGroupId": 150020080'."\n"
+ .'}'."\n"
+ .'],'."\n"
+ .'"total": 313,'."\n"
+ .'"pageNum": 1,'."\n"
+ .'"pageSize": 10'."\n"
.'}',
- ],
- 'UpdateProblemNotice' => [
- 'summary' => '更新故障通知',
- 'path' => '/problem/notify',
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-27T10:57:22.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-11-16T01:59:34.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListDataReportForServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListDataReportForUser' => [
+ 'summary' => 'Query personal event statistics.',
+ 'path' => '/statistics/listDataReportForUser',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLC8226',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp20VVML'],
],
'parameters' => [
[
@@ -15198,93 +10202,126 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'Request body.',
'properties' => [
- 'problemNotifyType' => [
- 'description' => '',
- 'example' => 'PROBLEM_NOTIFY',
- 'required' => false,
- 'title' => '通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE: 故障补发 PROBLEM_CANCEL:故障取消',
- 'type' => 'string',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '1312',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障Id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'required' => false,
- 'title' => '幂等校验Id',
- 'type' => 'string',
- ],
+ 'startTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '2021-09-01', 'title' => '', 'required' => false],
+ 'endTime' => ['description' => 'End time.', 'type' => 'string', 'example' => '2021-09-30', 'title' => '', 'required' => false],
+ 'pageNumber' => ['description' => 'Page number for paging.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'pageSize' => ['description' => 'Page size for paging.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => '', 'required' => false],
],
'required' => false,
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'CAB6E15D-ECE8-54A4-87C3-D701862DD4A2'],
+ 'data' => [
+ 'description' => 'Personal statistics.',
+ 'items' => [
+ 'properties' => [
+ 'userName' => ['description' => 'Username.', 'type' => 'string', 'example' => 'wy', 'title' => ''],
+ 'escalationIncidentCount' => ['description' => 'Number of escalated incidents.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'distributionIncidentCount' => ['description' => 'Number of assigned incidents.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'finishIncidentNumber' => ['description' => 'Number of resolved incidents.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'unAcknowledgedEscalationIncidentCount' => ['description' => 'Number of unacknowledged escalations.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'unFinishEscalationIncidentCount' => ['description' => 'Number of unresolved escalations.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'meanTimeToAcknowledge' => ['title' => 'MRRA', 'description' => 'Average time to acknowledge an incident.', 'type' => 'string', 'example' => '3分50秒'],
+ 'meanTimeToRepair' => ['title' => 'MTTA', 'description' => 'Average time to resolve an incident.', 'type' => 'string', 'example' => '3分50秒'],
+ 'unDistributionIncidentCount' => ['description' => 'Number of resolved incidents not assigned to a user.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'finishProportion' => ['description' => 'Completion rate.', 'type' => 'string', 'example' => '20%', 'title' => ''],
+ 'userId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'totalCount' => ['description' => 'Total number of items.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CAB6E15D-ECE8-54A4-87C3-D701862DD4A2\\",\\n \\"data\\": [\\n {\\n \\"userName\\": \\"wy\\",\\n \\"escalationIncidentCount\\": 100,\\n \\"distributionIncidentCount\\": 100,\\n \\"finishIncidentNumber\\": 100,\\n \\"unAcknowledgedEscalationIncidentCount\\": 100,\\n \\"unFinishEscalationIncidentCount\\": 100,\\n \\"meanTimeToAcknowledge\\": \\"3分50秒\\",\\n \\"meanTimeToRepair\\": \\"3分50秒\\",\\n \\"unDistributionIncidentCount\\": 100,\\n \\"finishProportion\\": \\"20%\\",\\n \\"userId\\": 1111\\n }\\n ],\\n \\"totalCount\\": 100\\n}","type":"json"}]',
+ 'title' => 'Query personal management event statistics',
+ 'requestParamsDescription' => '{'."\n"
+ .'"pageNumber": 1,'."\n"
+ .'"pageSize": 10,'."\n"
+ .'"startTime": "2021-11-01",'."\n"
+ .'"endTime": "2021-11-08",'."\n"
+ .'"clientToken": "4b31b55b-32af-415a-b2fb-a88b4e066845"'."\n"
+ .'}',
+ 'responseParamsDescription' => '```'."\n"
+ .'{'."\n"
+ .' "data": ['."\n"
+ .' {'."\n"
+ .' "finishProportion": "0.00%",'."\n"
+ .' "unFinishEscalationIncidentCount": 0,'."\n"
+ .' "escalationIncidentCount": 0,'."\n"
+ .' "distributionIncidentCount": 0,'."\n"
+ .' "unAcknowledgedEscalationIncidentCount": 0,'."\n"
+ .' "userName": "root account",'."\n"
+ .' "userId": 171628425,'."\n"
+ .' "finishIncidentNumber": 0,'."\n"
+ .' "unDistributionIncidentCount": 0'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "requestId": "63667D16-6C2A-51DB-8A6A-280F1D6F251A",'."\n"
+ .' "totalCount": 1'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-16T01:59:34.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListDataReportForUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateProblemNoticeResponse>\\n <requestId>4361a0e1-6747-4834-96ce-0c4840fd3812</requestId>\\n</UpdateProblemNoticeResponse>","errorExample":""}]',
- ],
- 'UpdateProblemTimeline' => [
- 'summary' => '更新故障时间线节点',
- 'path' => '/problem/process/timeline/update',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'ListDictionaries' => [
+ 'summary' => 'Enumeration dictionary API.',
+ 'path' => '/dict/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZB7ZAW',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempLJVP1W'],
],
'parameters' => [
[
@@ -15294,54 +10331,12 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'problemTimelineId' => [
- 'description' => '',
- 'example' => '3940',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '时间节点id',
- 'type' => 'integer',
- ],
- 'keyNode' => [
- 'description' => '',
- 'example' => 'NodeTest',
- 'required' => false,
- 'title' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
- 'type' => 'string',
- ],
- 'content' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '节点内容',
- 'type' => 'string',
- ],
- 'time' => [
- 'description' => '',
- 'example' => '2021-01-08 10:10:10',
- 'required' => false,
- 'title' => '发生时间',
- 'type' => 'string',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '234',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
+ 'clientToken' => ['description' => 'Idempotency validation ID.', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'required' => false, 'type' => 'string', 'title' => ''],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -15350,62 +10345,73 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => ' id of the request',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'type' => 'string',
+ 'data' => [
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'code' => ['type' => 'string', 'example' => 'SMS', 'description' => 'Code value.', 'title' => ''],
+ 'description' => ['type' => 'string', 'description' => 'Comment.', 'example' => '短信', 'title' => ''],
+ ],
+ 'description' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'array',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => 'data',
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
+ 'requestId' => ['description' => 'id of the request'."\n", 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88', 'type' => 'string', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemTimelineNotExisted',
- 'errorMessage' => 'The problem timeline does not exist.',
- ],
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"key\\": [\\n {\\n \\"code\\": \\"SMS\\",\\n \\"description\\": \\"短信\\"\\n }\\n ]\\n },\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","type":"json"}]',
+ 'title' => 'Enumeration dictionary API',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListDictionaries',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateProblemTimelineResponse>\\n <requestId>c26f36de-1ec8-496a-a828-880676c5ef81</requestId>\\n</UpdateProblemTimelineResponse>","errorExample":""}]',
- ],
- 'GenerateProblemPictureUploadSign' => [
- 'summary' => '图片上传验签',
- 'path' => '/problem/process/oss/generatePostPolicy',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDictionaries'],
+ ],
],
+ ],
+ 'ListEscalationPlanServices' => [
+ 'summary' => 'List of selected scope objects (services) for the upgrade plan.',
+ 'path' => '/escalationPlan/services',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp4EPB1U',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'body',
@@ -15414,40 +10420,12 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'fileName' => [
- 'description' => '',
- 'example' => 'test',
- 'required' => false,
- 'title' => '文件名',
- 'type' => 'string',
- ],
- 'fileType' => [
- 'description' => '',
- 'example' => 'png',
- 'required' => false,
- 'title' => '文件类型',
- 'type' => 'string',
- ],
- 'fileSize' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '文件大小KB',
- 'type' => 'integer',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '67876',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
+ 'clientToken' => ['description' => 'clientToken', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST', 'required' => false, 'title' => 'clientToken', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -15456,92 +10434,71 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd',
- 'title' => 'requestId',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST', 'title' => 'Id of the request', 'type' => 'string'],
'data' => [
'description' => 'data',
- 'properties' => [
- 'bucketName' => [
- 'description' => 'oss bucket name',
- 'example' => 'xxxx-xxxx-xxxx',
- 'title' => 'oss bucket name',
- 'type' => 'string',
- ],
- 'key' => [
- 'description' => 'oss key',
- 'example' => 'problem/xxxxxxxxxxxxxxxx1-b3185d529277',
- 'title' => 'oss key',
- 'type' => 'string',
- ],
- 'policy' => [
- 'description' => 'policy',
- 'example' => 'eyJleHBpcmF0a0p0IjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19',
- 'title' => 'policy',
- 'type' => 'string',
- ],
- 'signature' => [
- 'description' => 'signature',
- 'example' => 'SHqvIkwUNQd0o0rvklir2K8U+ts=',
- 'title' => 'signature',
- 'type' => 'string',
- ],
- 'url' => [
- 'description' => 'url',
- 'example' => 'https://xxx-xxx-bucket.oss-cn-shanghai.aliyuncs.com',
- 'title' => 'url',
- 'type' => 'string',
- ],
- 'accessKeyId' => [
- 'description' => 'ossaccessKeyId',
- 'example' => 'XXXXXXXH8GMy1iLRCno7',
- 'title' => 'ossaccessKeyId',
- 'type' => 'string',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'scope' => ['description' => 'Range Type', 'example' => 'SERVICE', 'title' => '', 'type' => 'string'],
+ 'scopeObjectId' => ['description' => 'Scope object ID', 'example' => '23', 'format' => 'int64', 'title' => '', 'type' => 'integer'],
],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'object',
+ 'title' => 'data',
+ 'type' => 'array',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"e2d4306a-bf4d-4345-9ae6-158223c85dbd\\",\\n \\"data\\": {\\n \\"bucketName\\": \\"xxxx-xxxx-xxxx\\",\\n \\"key\\": \\"problem/xxxxxxxxxxxxxxxx1-b3185d529277\\",\\n \\"policy\\": \\"eyJleHBpcmF0a0p0IjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19\\",\\n \\"signature\\": \\"SHqvIkwUNQd0o0rvklir2K8U+ts=\\",\\n \\"url\\": \\"https://xxx-xxx-bucket.oss-cn-shanghai.aliyuncs.com\\",\\n \\"accessKeyId\\": \\"XXXXXXXH8GMy1iLRCno7\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GenerateProblemPictureUploadSignResponse>\\n <requestId>e2d4306a-bf4d-4345-9ae6-158223c85dbd</requestId>\\n <data>\\n <bucketName>xxxx-xxxx-xxxx</bucketName>\\n <key>problem/xxxxxxxxxxxxxxxx1-b3185d529277</key>\\n <policy>eyJleHBpcmF0a0p0IjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19</policy>\\n <signature>SHqvIkwUNQd0o0rvklir2K8U+ts=</signature>\\n <url>https://xxx-xxx-bucket.oss-cn-shanghai.aliyuncs.com</url>\\n <accessKeyId>XXXXXXXH8GMy1iLRCno7</accessKeyId>\\n </data>\\n</GenerateProblemPictureUploadSignResponse>","errorExample":""}]',
- ],
- 'ListProblemOperations' => [
- 'summary' => '查询故障7天内动态',
- 'path' => '/problem/operations',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\",\\n \\"data\\": [\\n {\\n \\"scope\\": \\"SERVICE\\",\\n \\"scopeObjectId\\": 23\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'List of selected scope objects for the upgrade plan',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEscalationPlanServices'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListEscalationPlanServices',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListEscalationPlans' => [
+ 'summary' => 'Upgrade plans',
+ 'path' => '/escalationPlan/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1XQ9JR',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempW7HVUW'],
],
'parameters' => [
[
@@ -15549,173 +10506,132 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '行',
- 'type' => 'integer',
- ],
+ 'escalationPlanName' => ['description' => 'Escalation plan name.', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false],
+ 'serviceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'ssxx', 'title' => '', 'required' => false],
+ 'clientToken' => ['title' => 'clientToken', 'description' => 'Idempotency token.', 'type' => 'string', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST', 'required' => false],
+ 'pageNumber' => ['title' => 'pageNumber', 'description' => 'Page number for pagination.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false],
+ 'pageSize' => ['title' => 'pageSize', 'description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'required' => false],
+ 'isGlobal' => ['description' => 'Indicates whether the escalation plan is global.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''],
+ 'status' => ['description' => 'Impact status. Valid values:'."\n"
+ ."\n"
+ .'- 0: Not recovered'."\n"
+ ."\n"
+ .'- 1: Recovered', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response schema.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '132',
- 'format' => 'int32',
- 'title' => '总数',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'title' => '页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'title' => '行',
- 'type' => 'integer',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST'],
'data' => [
- 'description' => 'data',
+ 'description' => 'Data.',
'items' => [
+ 'description' => 'object',
'properties' => [
- 'title' => [
- 'description' => '',
- 'example' => '动态标题',
- 'title' => '动态标题',
- 'type' => 'string',
- ],
- 'description' => [
- 'description' => '',
- 'example' => '描述',
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'relatedServiceName' => [
- 'description' => '',
- 'example' => '服务名称',
- 'title' => '服务名称',
- 'type' => 'string',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2021-01-23 00:00:00',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'action' => [
- 'description' => '',
- 'example' => 'PROBLEM_CANCEL',
- 'title' => '升级 PROBLEM_UPGRADE 撤销 PROBLEM_REVOKE 恢复 PROBLEM_RESTORE 复盘 PROBLEM_IN_REVIEW 完结 PROBLEM_REOPENED 取消 PROBLEM_CANCEL 更新故障通告 PROBLEM_UPDATE_NOTIFY 添加故障小计 PROBLEM_ADD_SUBTOTAL 更新故障 PROBLEM_UPDATE',
- 'type' => 'string',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'title' => '故障Id',
- 'type' => 'integer',
- ],
- 'problemName' => [
- 'description' => '',
- 'example' => '这是一个故障',
- 'title' => '故障名称',
- 'type' => 'string',
- ],
- 'problemNumber' => [
- 'description' => '',
- 'example' => 'P1231231',
- 'title' => '故障编号',
- 'type' => 'string',
- ],
- 'snapshotData' => [
- 'description' => '',
- 'example' => '{“userName”:"小明"}',
- 'title' => '快照数据',
- 'type' => 'string',
+ 'escalationPlanId' => ['description' => 'Escalation plan ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '43', 'title' => ''],
+ 'escalationPlanName' => ['description' => 'Escalation plan name.', 'type' => 'string', 'example' => '升级计划2345', 'title' => ''],
+ 'escalationPlanScopeObjects' => [
+ 'description' => 'Escalation plan scope objects.',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'scopeObjectId' => ['description' => 'Scope object ID (service ID).', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''],
+ 'scopeObjectName' => ['description' => 'Scope object name.', 'type' => 'string', 'example' => '服务1', 'title' => ''],
+ 'scope' => ['description' => 'Scope object type.', 'type' => 'string', 'example' => 'SERVICE', 'title' => ''],
+ 'scopeObjectDeletedType' => ['title' => 'Service deletion status: 1 for Normal, 0 for Deleted ', 'description' => 'Indicates whether the service is deleted. Valid values:'."\n"
+ ."\n"
+ .'- 1: Normal'."\n"
+ ."\n"
+ .'- 0: Deleted', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'status' => ['description' => 'Impact status. Valid values:'."\n"
+ ."\n"
+ .'- ENABLE: Enabled'."\n"
+ ."\n"
+ .'- DISABLE: Disabled', 'type' => 'string', 'example' => 'ENABLE', 'title' => ''],
+ 'modifyTime' => ['description' => 'Modification time.', 'type' => 'string', 'example' => '2021-09-09 09:09:09', 'title' => ''],
+ 'isGlobal' => ['title' => 'Is global policy ', 'description' => 'Indicates whether the escalation plan is global.', 'type' => 'boolean', 'default' => 'false', 'example' => ''],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
'title' => 'data',
'type' => 'array',
+ 'example' => '',
],
+ 'totalCount' => ['description' => 'Total number of items.', 'type' => 'integer', 'format' => 'int64', 'example' => '878', 'title' => ''],
+ 'pageNumber' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"totalCount\\": 132,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"data\\": [\\n {\\n \\"title\\": \\"动态标题\\",\\n \\"description\\": \\"描述\\",\\n \\"relatedServiceName\\": \\"服务名称\\",\\n \\"createTime\\": \\"2021-01-23 00:00:00\\",\\n \\"action\\": \\"PROBLEM_CANCEL\\",\\n \\"problemId\\": 12312,\\n \\"problemName\\": \\"这是一个故障\\",\\n \\"problemNumber\\": \\"P1231231\\",\\n \\"snapshotData\\": \\"{“userName”:\\\\\\"小明\\\\\\"}\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProblemOperationsResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n <totalCount>132</totalCount>\\n <pageNumber>1</pageNumber>\\n <pageSize>10</pageSize>\\n <data>\\n <title>动态标题</title>\\n <description>描述</description>\\n <relatedServiceName>服务名称</relatedServiceName>\\n <createTime>2021-01-23 00:00:00</createTime>\\n <action>PROBLEM_CANCEL</action>\\n <problemId>12312</problemId>\\n <problemName>这是一个故障</problemName>\\n </data>\\n</ListProblemOperationsResponse>","errorExample":""}]',
- ],
- 'ListProblems' => [
- 'summary' => '故障列表查询接口',
- 'path' => '/problem/listProblems',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\",\\n \\"data\\": [\\n {\\n \\"escalationPlanId\\": 43,\\n \\"escalationPlanName\\": \\"升级计划2345\\",\\n \\"escalationPlanScopeObjects\\": [\\n {\\n \\"scopeObjectId\\": 23,\\n \\"scopeObjectName\\": \\"服务1\\",\\n \\"scope\\": \\"SERVICE\\",\\n \\"scopeObjectDeletedType\\": 1\\n }\\n ],\\n \\"status\\": \\"ENABLE\\",\\n \\"modifyTime\\": \\"2021-09-09 09:09:09\\",\\n \\"isGlobal\\": false\\n }\\n ],\\n \\"totalCount\\": 878,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","type":"json"}]',
+ 'title' => 'Escalation Plan List',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:54.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2022-06-07T11:52:19.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEscalationPlans'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListEscalationPlans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListEscalationPlansByNoticeObject' => [
+ 'summary' => 'Retrieves escalation plans associated with a specified notification object.',
+ 'path' => '/escalationPlan/listByNoticeObject',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1XQ9JR',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempGUN0ZL'],
],
'parameters' => [
[
@@ -15723,487 +10639,503 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'type' => 'object',
'properties' => [
- 'queryType' => [
- 'description' => '',
- 'example' => 'RESPONSIBLE',
- 'required' => false,
- 'title' => 'RESPONSIBLE 我负责的 PARTICIPATED 我参与的 ALL 全部',
- 'type' => 'string',
- ],
- 'problemStatus' => [
- 'description' => '',
- 'example' => 'HANDLING',
- 'required' => false,
- 'title' => '故障状态 HANDLING 处理中 RECOVERED 已恢复 REPLAYING 复盘中 REPLAYED 已复盘 CANCEL 已取消',
- 'type' => 'string',
- ],
- 'problemLevel' => [
- 'description' => '',
- 'example' => 'P2',
- 'required' => false,
- 'title' => '故障等级 1=P1 2=P2 3=P3 4=P4',
- 'type' => 'string',
- ],
- 'affectServiceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '影响服务ID',
- 'type' => 'integer',
- ],
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '应急协同组',
- 'type' => 'integer',
- ],
- 'mainHandlerId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '主要处理人',
- 'type' => 'integer',
- ],
- 'repeaterId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '复盘负责人',
- 'type' => 'integer',
- ],
- 'discoveryStartTime' => [
- 'description' => '',
- 'example' => '2020-03-05 15:50:59',
- 'required' => false,
- 'title' => '发现开始时间',
- 'type' => 'string',
- ],
- 'discoveryEndTime' => [
- 'description' => '',
- 'example' => '2020-03-05 15:50:59',
- 'required' => false,
- 'title' => '发现结束时间',
- 'type' => 'string',
- ],
- 'restoreEndTime' => [
- 'description' => '',
- 'example' => '2020-03-05 15:50:59',
- 'required' => false,
- 'title' => '恢复结束时间',
- 'type' => 'string',
- ],
- 'restoreStartTime' => [
- 'description' => '',
- 'example' => '2020-03-05 15:50:59',
- 'required' => false,
- 'title' => '恢复开始时间',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '当前页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '页大小',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'noticeObjectId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'noticeObjectType' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
],
- 'required' => false,
- 'title' => 'A short description of struct',
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'title' => 'Schema of Response ',
+ 'type' => 'object',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request ', 'type' => 'string', 'description' => '', 'example' => ''],
'data' => [
- 'description' => '',
+ 'type' => 'array',
'items' => [
+ 'type' => 'object',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '故障id',
- 'type' => 'integer',
- ],
- 'isManual' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '是否手动',
- 'type' => 'boolean',
- ],
- 'isUpgrade' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '是否升级',
- 'type' => 'boolean',
- ],
- 'incidentId' => [
- 'description' => '',
- 'example' => '10000',
- 'format' => 'int64',
- 'title' => '事件ID',
- 'type' => 'integer',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2020-09-08 15:59:59',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'updateTime' => [
- 'description' => '',
- 'example' => '2020-09-08 15:59:59',
- 'title' => '修改时间',
- 'type' => 'string',
- ],
- 'problemNumber' => [
- 'description' => '',
- 'example' => 'P34438300000001116258132229577472',
- 'title' => '故障编号',
- 'type' => 'string',
- ],
- 'problemName' => [
- 'description' => '',
- 'example' => '故障',
- 'title' => '故障名称',
- 'type' => 'string',
- ],
- 'problemStatus' => [
- 'description' => '',
- 'example' => 'HANDLING',
- 'title' => '故障状态 HANDLING 处理中 RECOVERED 已恢复 REPLAYING 复盘中 REPLAYED 已复盘 CANCEL 已取消',
- 'type' => 'string',
- ],
- 'problemLevel' => [
- 'description' => '',
- 'example' => 'P1',
- 'title' => '故障等级 1=P1 2=P2 3=P3 4=P4',
- 'type' => 'string',
- ],
- 'discoverTime' => [
- 'description' => '',
- 'example' => '2020-09-08 15:59:59',
- 'title' => '发现时间',
- 'type' => 'string',
- ],
- 'recoveryTime' => [
- 'description' => '',
- 'example' => '2020-09-08 15:59:59',
- 'title' => '恢复时间',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '1',
- 'title' => '关联服务ID',
- 'type' => 'string',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => '服务1',
- 'title' => '关联服务名称',
- 'type' => 'string',
- ],
- 'affectServices' => [
- 'description' => '',
+ 'escalationPlanId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'escalationPlanName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'escalationPlanScopeObjects' => [
+ 'type' => 'array',
'items' => [
+ 'type' => 'object',
'properties' => [
- 'serviceId' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '影响服务ID',
- 'type' => 'integer',
- ],
- 'serviceDescription' => [
- 'description' => '',
- 'example' => '服务描述',
- 'title' => '服务描述',
- 'type' => 'string',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => '冲上云霄',
- 'title' => '服务名字',
- 'type' => 'string',
- ],
- 'updateTime' => [
- 'description' => '',
- 'example' => '2020-09-08 15:59:59',
- 'title' => '修改时间',
- 'type' => 'string',
- ],
+ 'scopeObjectId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'scopeObjectName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'scope' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'scopeObjectDeletedType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'array',
- ],
- 'mainHandlerId' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '主要处理人ID',
- 'type' => 'integer',
- ],
- 'mainHandlerName' => [
- 'description' => '',
- 'example' => '王宇',
- 'title' => '主要处理人名称',
- 'type' => 'string',
- ],
- 'cancelTime' => [
- 'description' => '',
- 'example' => '2020-09-08 15:59:59',
- 'title' => '取消时间',
- 'type' => 'string',
- ],
- 'finishTime' => [
'description' => '',
- 'example' => '2020-09-08 15:59:59',
- 'title' => '完结时间',
- 'type' => 'string',
- ],
- 'replayTime' => [
- 'description' => '',
- 'example' => '2020-09-08 15:59:59',
- 'title' => '复盘时间',
- 'type' => 'string',
- ],
- 'serviceDeletedType' => [
- 'title' => '服务删除字段',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'mainHandlerIsValid' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '',
+ 'example' => '',
],
+ 'status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'modifyTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'array',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '当前页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '页大小',
- 'type' => 'integer',
- ],
- 'totalCount' => [
'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '总条数',
- 'type' => 'integer',
+ 'title' => '',
+ 'example' => '',
],
],
- 'title' => 'Schema of Response',
- 'type' => 'object',
+ 'description' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": [\\n {\\n \\"problemId\\": 1,\\n \\"isManual\\": true,\\n \\"isUpgrade\\": true,\\n \\"incidentId\\": 10000,\\n \\"createTime\\": \\"2020-09-08 15:59:59\\",\\n \\"updateTime\\": \\"2020-09-08 15:59:59\\",\\n \\"problemNumber\\": \\"P34438300000001116258132229577472\\",\\n \\"problemName\\": \\"故障\\",\\n \\"problemStatus\\": \\"HANDLING\\",\\n \\"problemLevel\\": \\"P1\\",\\n \\"discoverTime\\": \\"2020-09-08 15:59:59\\",\\n \\"recoveryTime\\": \\"2020-09-08 15:59:59\\",\\n \\"relatedServiceId\\": \\"1\\",\\n \\"serviceName\\": \\"服务1\\",\\n \\"affectServices\\": [\\n {\\n \\"serviceId\\": 100,\\n \\"serviceDescription\\": \\"服务描述\\",\\n \\"serviceName\\": \\"冲上云霄\\",\\n \\"updateTime\\": \\"2020-09-08 15:59:59\\"\\n }\\n ],\\n \\"mainHandlerId\\": 100,\\n \\"mainHandlerName\\": \\"王宇\\",\\n \\"cancelTime\\": \\"2020-09-08 15:59:59\\",\\n \\"finishTime\\": \\"2020-09-08 15:59:59\\",\\n \\"replayTime\\": \\"2020-09-08 15:59:59\\",\\n \\"serviceDeletedType\\": 0,\\n \\"mainHandlerIsValid\\": 1\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"<ListProblemsResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n <data>\\n <problemId>1</problemId>\\n <isManual>true</isManual>\\n <isUpgrade>true</isUpgrade>\\n <incidentId>10000</incidentId>\\n <createTime>2020-09-08 15:59:59</createTime>\\n <updateTime>2020-09-08 15:59:59</updateTime>\\n <problemNumber>P34438300000001116258132229577472</problemNumber>\\n <problemName>故障</problemName>\\n <problemStatus>HANDLING</problemStatus>\\n <problemLevel>P1</problemLevel>\\n <discoverTime>2020-09-08 15:59:59</discoverTime>\\n <recoveryTime>2020-09-08 15:59:59</recoveryTime>\\n <relatedServiceId>1</relatedServiceId>\\n <serviceName>服务1</serviceName>\\n <affectServices>\\n <serviceId>100</serviceId>\\n <serviceDescription>服务描述</serviceDescription>\\n <serviceName>冲上云霄</serviceName>\\n <updateTime>2020-09-08 15:59:59</updateTime>\\n </affectServices>\\n <mainHandlerId>100</mainHandlerId>\\n <mainHandlerName>王宇</mainHandlerName>\\n <cancelTime>2020-09-08 15:59:59</cancelTime>\\n <finishTime>2020-09-08 15:59:59</finishTime>\\n <replayTime>2020-09-08 15:59:59</replayTime>\\n </data>\\n <pageNumber>1</pageNumber>\\n <pageSize>10</pageSize>\\n <totalCount>100</totalCount>\\n</ListProblemsResponse>","errorExample":""}]',
- ],
- 'ListProblemSubtotals' => [
- 'summary' => '查询故障小计',
- 'path' => '/problem/list/subtotal',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListEscalationPlansByNoticeObject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"data\\": [\\n {\\n \\"escalationPlanId\\": 0,\\n \\"escalationPlanName\\": \\"\\",\\n \\"escalationPlanScopeObjects\\": [\\n {\\n \\"scopeObjectId\\": 0,\\n \\"scopeObjectName\\": \\"\\",\\n \\"scope\\": \\"\\",\\n \\"scopeObjectDeletedType\\": 0\\n }\\n ],\\n \\"status\\": \\"\\",\\n \\"modifyTime\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListEscalationPlansByNoticeObject',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEscalationPlansByNoticeObject'],
+ ],
],
+ ],
+ 'ListIncidentDetailEscalationPlans' => [
+ 'summary' => 'This section lists the escalation plans associated with the incident.',
+ 'path' => '/incident/detail/escalation',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1XQ9JR',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障Id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fdB812',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
- ],
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2311', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '4361a0e1-6747-4834-96ce-0S4840fd3812',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9'],
'data' => [
- 'description' => 'data',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'description' => [
+ 'description' => 'Response data.',
+ 'properties' => [
+ 'escalationPlanId' => ['description' => 'Escalation plan ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '312123', 'title' => ''],
+ 'escalationPlanName' => ['description' => 'Escalation plan name.', 'type' => 'string', 'example' => '升级策略A', 'title' => ''],
+ 'unFinishEscalationPlan' => [
+ 'description' => 'List of uncompleted escalation plan rules.',
+ 'items' => [
+ 'properties' => [
+ 'escalationPlanType' => ['description' => 'Escalation plan type:'."\n"
+ ."\n"
+ .'- UN\\_ACKNOWLEDGE: Not acknowledged.'."\n"
+ ."\n"
+ .'- UN\\_FINISH: Not completed.', 'type' => 'string', 'example' => 'UN_FINISH', 'title' => ''],
+ 'noticeTime' => ['description' => 'Delay time, in minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'status' => ['description' => 'Rule trigger status.', 'type' => 'string', 'example' => 'UPGRADE', 'title' => ''],
+ 'startTime' => ['description' => 'Start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1629872386027', 'title' => ''],
+ 'noticeChannels' => [
+ 'description' => 'Notification channels.',
+ 'items' => ['description' => '- SMS: Text message.'."\n"
+ ."\n"
+ .'- PHONE: Phone call.', 'type' => 'string', 'example' => 'SMS', 'title' => ''],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'noticeObjectList' => [
+ 'description' => 'User information.',
+ 'items' => [
+ 'properties' => [
+ 'noticeObjectId' => ['description' => 'Notification recipient ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2311', 'title' => ''],
+ 'noticeObjectName' => ['description' => 'Notification recipient name.', 'type' => 'string', 'example' => '马先生', 'title' => ''],
+ 'noticeObjectPhone' => ['description' => 'Mobile phone number.', 'type' => 'string', 'example' => '130xxxxxxxx', 'title' => ''],
+ 'roleNameList' => [
+ 'description' => 'Role list.',
+ 'title' => 'Role List ',
+ 'type' => 'array',
+ 'items' => ['description' => 'Role name.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'serviceGroupList' => [
+ 'description' => 'Service group list.',
+ 'items' => [
+ 'properties' => [
+ 'id' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123132', 'title' => ''],
+ 'name' => ['description' => 'Service group name.', 'type' => 'string', 'example' => '服务组A', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'noticeRoleList' => [
+ 'description' => 'Role ID list.',
+ 'title' => 'Role ID List ',
+ 'type' => 'array',
+ 'items' => ['description' => 'A list of roles to notify.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'example' => '',
+ ],
+ 'noticeRoleObjectList' => [
+ 'description' => 'Role object list.',
+ 'title' => 'Role Object List ',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'Notification recipient ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '117', 'title' => ''],
+ 'name' => ['description' => 'Notification recipient name.', 'type' => 'string', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'type' => 'object',
'description' => '',
+ 'title' => '',
'example' => '',
- 'title' => '描述',
- 'type' => 'string',
],
- 'createTime' => [
- 'description' => '',
- 'example' => '2020-10-02 00:00:00',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'createRamName' => [
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'nuAcknowledgeEscalationPlan' => [
+ 'description' => 'Not-acknowledged escalation plan.',
+ 'items' => [
+ 'properties' => [
+ 'escalationPlanType' => ['description' => 'Escalation plan type:'."\n"
+ ."\n"
+ .'- UN\\_ACKNOWLEDGE: Not acknowledged.'."\n"
+ ."\n"
+ .'- UN\\_FINISH: Not completed.', 'type' => 'string', 'example' => 'UN_ACKNOWLEDGE', 'title' => ''],
+ 'noticeTime' => ['description' => 'Delay time, in minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'status' => ['description' => 'Rule trigger status.', 'type' => 'string', 'example' => 'UPGRADE', 'title' => ''],
+ 'startTime' => ['description' => 'Start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2021-09-09', 'title' => ''],
+ 'noticeChannels' => [
+ 'description' => 'Notification channels.',
+ 'items' => ['description' => 'Notification channel.', 'type' => 'string', 'example' => 'SMS', 'title' => ''],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'noticeObjectList' => [
+ 'description' => 'User information.',
+ 'items' => [
+ 'properties' => [
+ 'noticeObjectId' => ['description' => 'Notification recipient ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '31231', 'title' => ''],
+ 'noticeObjectName' => ['description' => 'Notification recipient name.', 'type' => 'string', 'example' => '马先生', 'title' => ''],
+ 'noticeObjectPhone' => ['description' => 'Notification recipient mobile phone number.', 'type' => 'string', 'example' => '130xxxxxxxxx', 'title' => ''],
+ 'roleNameList' => [
+ 'description' => 'Role list.',
+ 'title' => 'Role List ',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'type' => 'object',
+ 'description' => 'Notification recipient list.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'serviceGroupList' => [
+ 'description' => 'Service group list.',
+ 'items' => [
+ 'properties' => [
+ 'id' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1231', 'title' => ''],
+ 'name' => ['description' => 'Service group name.', 'type' => 'string', 'example' => '服务组A', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'description' => 'Service group list.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'noticeRoleList' => [
+ 'description' => 'Role ID list.',
+ 'title' => 'List of role IDs',
+ 'type' => 'array',
+ 'items' => ['description' => 'A list of role IDs.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'example' => '',
+ ],
+ 'noticeRoleObjectList' => [
+ 'description' => 'Role object list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Role object list.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'Role object ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100936', 'title' => ''],
+ 'name' => ['description' => 'Notification recipient name.', 'type' => 'string', 'example' => '通知对象名称A', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'type' => 'object',
'description' => '',
+ 'title' => '',
'example' => '',
- 'title' => '操作人',
- 'type' => 'string',
- ],
- 'createUserPhone' => [
- 'description' => '',
- 'example' => '130****11111',
- 'title' => '操作人手机号',
- 'type' => 'string',
],
- 'createUserId' => [
- 'description' => '',
- 'example' => '123123',
- 'format' => 'int64',
- 'title' => '人员id',
- 'type' => 'integer',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'convergenceEscalationPlan' => [
+ 'description' => 'The escalation policy for incidents with no response.',
+ 'items' => [
+ 'properties' => [
+ 'escalationPlanType' => ['description' => 'Escalation plan type:'."\n"
+ ."\n"
+ .'- UN\\_ACKNOWLEDGE: Not acknowledged.'."\n"
+ ."\n"
+ .'- UN\\_FINISH: Not completed.', 'type' => 'string', 'example' => 'UN_ACKNOWLEDGE', 'title' => ''],
+ 'noticeTime' => ['description' => 'Convergence target value.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'status' => ['description' => 'Rule trigger status.', 'type' => 'string', 'example' => 'UPGRADE', 'title' => ''],
+ 'startTime' => ['description' => 'Start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2021-09-09', 'title' => ''],
+ 'noticeChannels' => [
+ 'description' => 'Notification channels.',
+ 'items' => ['description' => 'Notification channel.', 'type' => 'string', 'example' => 'SMS', 'title' => ''],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'noticeObjectList' => [
+ 'description' => 'User information.',
+ 'items' => [
+ 'properties' => [
+ 'noticeObjectId' => ['description' => 'Notification recipient ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '31231', 'title' => ''],
+ 'noticeObjectName' => ['description' => 'Notification recipient name.', 'type' => 'string', 'example' => '马先生', 'title' => ''],
+ 'noticeObjectPhone' => ['description' => 'Notification recipient mobile phone number.', 'type' => 'string', 'example' => '130xxxxxxxxx', 'title' => ''],
+ 'roleNameList' => [
+ 'description' => 'Role list.',
+ 'title' => 'Role List ',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'type' => 'object',
+ 'description' => 'Notification recipient list.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'serviceGroupList' => [
+ 'description' => 'Service group list.',
+ 'items' => [
+ 'properties' => [
+ 'id' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1231', 'title' => ''],
+ 'name' => ['description' => 'Service group name.', 'type' => 'string', 'example' => '服务组A', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'description' => 'Service group list.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ ],
+ 'type' => 'object',
+ 'description' => 'Escalation plan.',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'type' => 'object',
],
- 'type' => 'array',
+ 'title' => 'data',
+ 'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"escalationPlanId\\": 312123,\\n \\"escalationPlanName\\": \\"升级策略A\\",\\n \\"unFinishEscalationPlan\\": [\\n {\\n \\"escalationPlanType\\": \\"UN_FINISH\\",\\n \\"noticeTime\\": 10,\\n \\"status\\": \\"UPGRADE\\",\\n \\"startTime\\": 1629872386027,\\n \\"noticeChannels\\": [\\n \\"SMS\\"\\n ],\\n \\"noticeObjectList\\": [\\n {\\n \\"noticeObjectId\\": 2311,\\n \\"noticeObjectName\\": \\"马先生\\",\\n \\"noticeObjectPhone\\": \\"130xxxxxxxx\\",\\n \\"roleNameList\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"serviceGroupList\\": [\\n {\\n \\"id\\": 123132,\\n \\"name\\": \\"服务组A\\"\\n }\\n ],\\n \\"noticeRoleList\\": [\\n 0\\n ],\\n \\"noticeRoleObjectList\\": [\\n {\\n \\"id\\": 117,\\n \\"name\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"nuAcknowledgeEscalationPlan\\": [\\n {\\n \\"escalationPlanType\\": \\"UN_ACKNOWLEDGE\\",\\n \\"noticeTime\\": 10,\\n \\"status\\": \\"UPGRADE\\",\\n \\"startTime\\": 0,\\n \\"noticeChannels\\": [\\n \\"SMS\\"\\n ],\\n \\"noticeObjectList\\": [\\n {\\n \\"noticeObjectId\\": 31231,\\n \\"noticeObjectName\\": \\"马先生\\",\\n \\"noticeObjectPhone\\": \\"130xxxxxxxxx\\",\\n \\"roleNameList\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"serviceGroupList\\": [\\n {\\n \\"id\\": 1231,\\n \\"name\\": \\"服务组A\\"\\n }\\n ],\\n \\"noticeRoleList\\": [\\n 0\\n ],\\n \\"noticeRoleObjectList\\": [\\n {\\n \\"id\\": 100936,\\n \\"name\\": \\"通知对象名称A\\"\\n }\\n ]\\n }\\n ],\\n \\"convergenceEscalationPlan\\": [\\n {\\n \\"escalationPlanType\\": \\"UN_ACKNOWLEDGE\\",\\n \\"noticeTime\\": 10,\\n \\"status\\": \\"UPGRADE\\",\\n \\"startTime\\": 0,\\n \\"noticeChannels\\": [\\n \\"SMS\\"\\n ],\\n \\"noticeObjectList\\": [\\n {\\n \\"noticeObjectId\\": 31231,\\n \\"noticeObjectName\\": \\"马先生\\",\\n \\"noticeObjectPhone\\": \\"130xxxxxxxxx\\",\\n \\"roleNameList\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"serviceGroupList\\": [\\n {\\n \\"id\\": 1231,\\n \\"name\\": \\"服务组A\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'List of escalation plans associated with the management event',
+ 'requestParamsDescription' => '{'."\n"
+ .'"incidentId" : 2311,'."\n"
+ .'"clientToken" : "FD200FAE-E98F-496E-BFE6-4CE61E59A2E9"'."\n"
+ .'}',
+ 'responseParamsDescription' => '{'."\n"
+ .'"requestId": "FD200FAE-E98F-496E-BFE6-4CE61E59A2E9",'."\n"
+ .'"data": {'."\n"
+ .'"escalationPlanId": 312123,'."\n"
+ .'"escalationPlanName": "Escalation Plan A",'."\n"
+ .'"unFinishEscalationPlan": \\['."\n"
+ .'{'."\n"
+ .'"escalationPlanType": "UN\\_FINISH",'."\n"
+ .'"noticeTime": 10,'."\n"
+ .'"status": "UPGRADE",'."\n"
+ .'"startTime": 1629872386027,'."\n"
+ .'"noticeChannels": \\['."\n"
+ .'"SMS"'."\n"
+ .'],'."\n"
+ .'"noticeObjectList": \\['."\n"
+ .'{'."\n"
+ .'"noticeObjectId": 2311,'."\n"
+ .'"noticeObjectName": "Xiao Ming",'."\n"
+ .'"noticeObjectPhone": "130xxxxxxxx"'."\n"
+ .'}'."\n"
+ .'],'."\n"
+ .'"serviceGroupList": \\['."\n"
+ .'{'."\n"
+ .'"id": 123132,'."\n"
+ .'"name": "Service Group A"'."\n"
+ .'}'."\n"
+ .']'."\n"
+ .'}'."\n"
+ .'],'."\n"
+ .'"nuAcknowledgeEscalationPlan": \\['."\n"
+ .'{'."\n"
+ .'"escalationPlanType": "UN\\_ACKNOWLEDGE",'."\n"
+ .'"noticeTime": 10,'."\n"
+ .'"status": "UPGRADE",'."\n"
+ .'"startTime": 1629872386027,'."\n"
+ .'"noticeChannels": \\['."\n"
+ .'"SMS"'."\n"
+ .'],'."\n"
+ .'"noticeObjectList": \\['."\n"
+ .'{'."\n"
+ .'"noticeObjectId": 31231,'."\n"
+ .'"noticeObjectName": "Xiao Hua",'."\n"
+ .'"noticeObjectPhone": "130xxxxxxxxx"'."\n"
+ .'}'."\n"
+ .'],'."\n"
+ .'"serviceGroupList": \\['."\n"
+ .'{'."\n"
+ .'"id": 1231,'."\n"
+ .'"name": "Service Group A"'."\n"
+ .'}'."\n"
+ .']'."\n"
+ .'}'."\n"
+ .']'."\n"
+ .'}'."\n"
+ .'}',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:53.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-10-27T12:01:25.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-09-10T01:53:15.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIncidentDetailEscalationPlans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0S4840fd3812\\",\\n \\"data\\": [\\n {\\n \\"description\\": \\"小计内容\\",\\n \\"createTime\\": \\"2020-10-02 00:00:00\\",\\n \\"createRamName\\": \\"小明\\",\\n \\"createUserPhone\\": \\"130****1111\\",\\n \\"createUserId\\": 123123\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProblemSubtotalsResponse>\\n <requestId>4361a0e1-6747-4834-96ce-0S4840fd3812</requestId>\\n <data>\\n <description>小计内容</description>\\n <createTime>2020-10-02 00:00:00</createTime>\\n <createRamName>小明</createRamName>\\n <createUserPhone>130****11111</createUserPhone>\\n </data>\\n</ListProblemSubtotalsResponse>","errorExample":""}]',
- ],
- 'CancelProblem' => [
- 'summary' => '故障取消',
- 'path' => '/problem/cancel',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIncidentDetailEscalationPlans'],
+ ],
],
+ ],
+ 'ListIncidentDetailTimelines' => [
+ 'summary' => 'This topic describes dynamic event details.',
+ 'path' => '/incident/detail/timeline',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempWLQJXL',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempJ0ENN8'],
],
'parameters' => [
[
@@ -16211,116 +11143,128 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '312',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
- 'cancelReasonDescription' => [
- 'description' => '',
- 'example' => '原因描述',
- 'required' => false,
- 'title' => '取消原因描述',
- 'type' => 'string',
- ],
- 'cancelReason' => [
- 'description' => '',
- 'example' => '取消原因',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '取消原因',
- 'type' => 'integer',
- ],
- 'problemNotifyType' => [
- 'description' => '',
- 'example' => 'PROBLEM_NOTIFY',
- 'format' => 'int64',
- 'required' => false,
- 'title' => 'PROBLEM_NOTIFY 通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE: 故障补发 PROBLEM_CANCEL:故障取消',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
- ],
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9'],
+ 'pageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'pageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => '', 'required' => false],
+ 'idSort' => ['title' => 'ID sorting method (desc for descending, asc for ascending) ', 'description' => 'Sort order.', 'type' => 'string', 'required' => false, 'example' => ''],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'B81E84B5-8FD1-45F3-969A-B5067AADCFFF',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9'],
+ 'data' => [
+ 'description' => 'Returned data.',
+ 'items' => [
+ 'description' => 'Returned data.',
+ 'properties' => [
+ 'title' => ['description' => 'Subject.', 'type' => 'string', 'title' => '', 'example' => '标题'],
+ 'description' => ['description' => 'Description.', 'type' => 'string', 'title' => '', 'example' => '描述'],
+ 'remark' => ['description' => 'Remarks.', 'type' => 'string', 'title' => '', 'example' => '备注A'],
+ 'relatedServiceName' => ['description' => 'Service name.', 'type' => 'string', 'title' => '', 'example' => '服务A'],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'title' => '', 'example' => '创建时间'],
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '事件Id'],
+ 'action' => ['description' => '- INCIDENT\\_ADD: Triggered creation.'."\n"
+ ."\n"
+ .'- INCIDENT\\_RESPONSE: Responded.'."\n"
+ ."\n"
+ .'- INCIDENT\\_DELIVER: Reassigned.'."\n"
+ ."\n"
+ .'- INCIDENT\\_UPDATE: Updated.'."\n"
+ ."\n"
+ .'- INCIDENT\\_ADD\\_SUBTOTAL: Added subtotal.'."\n"
+ ."\n"
+ .'- INCIDENT\\_FINISH: Closed.'."\n"
+ ."\n"
+ .'- INCIDENT\\_ASSIGN: Assigned.'."\n"
+ ."\n"
+ .'- INCIDENT\\_UPGRADE: Upgraded.', 'type' => 'string', 'title' => '', 'example' => 'INCIDENT_ADD'],
+ 'snapshotData' => ['description' => 'Snapshot data.', 'type' => 'string', 'title' => '', 'example' => '{"userName":"小明"}'],
+ 'relRouteRuleDeleteType' => ['title' => 'Rule deletion field: 1 for normal, 0 for deleted or no rule', 'description' => 'Rule deletion status:'."\n"
+ ."\n"
+ .'- 1: Normal.'."\n"
+ ."\n"
+ .'- 0: Deleted or no rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
+ 'totalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'],
+ 'pageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ProblemStatusError',
- 'errorMessage' => 'The problem status is abnormal.',
- ],
- ],
404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
- ],
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"B81E84B5-8FD1-45F3-969A-B5067AADCFFF\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelProblemResponse>\\n <requestId>B81E84B5-8FD1-45F3-969A-B5067AADCFFF</requestId>\\n</CancelProblemResponse>","errorExample":""}]',
- ],
- 'FinishProblem' => [
- 'summary' => '故障完结',
- 'path' => '/problem/finish',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": [\\n {\\n \\"title\\": \\"标题\\",\\n \\"description\\": \\"描述\\",\\n \\"remark\\": \\"备注A\\",\\n \\"relatedServiceName\\": \\"服务A\\",\\n \\"createTime\\": \\"创建时间\\",\\n \\"incidentId\\": 0,\\n \\"action\\": \\"INCIDENT_ADD\\",\\n \\"snapshotData\\": \\"{\\\\\\"userName\\\\\\":\\\\\\"小明\\\\\\"}\\",\\n \\"relRouteRuleDeleteType\\": 1\\n }\\n ],\\n \\"totalCount\\": 100,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","type":"json"}]',
+ 'title' => 'Dynamic Details of Management Event ',
+ 'changeSet' => [
+ ['createdAt' => '2022-09-06T12:16:29.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-06-07T11:52:18.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:38.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIncidentDetailTimelines'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIncidentDetailTimelines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListIncidentSubtotals' => [
+ 'summary' => 'Query incident subtotals.',
+ 'path' => '/incident/list/subtotal',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZB7ZAW',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZF76LB'],
],
'parameters' => [
[
@@ -16328,93 +11272,98 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '3123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障Id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '6338F42D-ED0B-442C-932C-657300AFB4BB',
- 'required' => false,
- 'title' => '幂等校验',
- 'type' => 'string',
- ],
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '3123'],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'FD200FAE-E98F-496E-BFE6-4CE62E59A2E9'],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '6338F42D-ED0B-442C-932C-657300AFB4BB',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9'],
+ 'data' => [
+ 'description' => 'data',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'description' => ['description' => 'Description.', 'type' => 'string', 'title' => '', 'example' => '小计描述'],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'title' => '', 'example' => '2021-06-23 00:00:00'],
+ 'createUserName' => ['description' => 'Operator name.', 'type' => 'string', 'title' => '', 'example' => '小明'],
+ 'createUserPhone' => ['description' => 'Operator phone number.', 'type' => 'string', 'example' => '130****1111', 'title' => ''],
+ 'createUserId' => ['description' => 'Operator ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12312', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ProblemStatusError',
- 'errorMessage' => 'The problem status is abnormal.',
- ],
- ],
404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
- ],
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"6338F42D-ED0B-442C-932C-657300AFB4BB\\"\\n}","errorExample":""},{"type":"xml","example":"<FinishProblemResponse>\\n <requestId>6338F42D-ED0B-442C-932C-657300AFB4BB</requestId>\\n</FinishProblemResponse>","errorExample":""}]',
- ],
- 'RecoverProblem' => [
- 'summary' => '故障恢复',
- 'path' => '/problem/recovery',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": [\\n {\\n \\"description\\": \\"小计描述\\",\\n \\"createTime\\": \\"2021-06-23 00:00:00\\",\\n \\"createUserName\\": \\"小明\\",\\n \\"createUserPhone\\": \\"130****1111\\",\\n \\"createUserId\\": 12312\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query the subtotal of management events',
+ 'changeSet' => [
+ ['createdAt' => '2021-07-16T04:09:38.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIncidentSubtotals',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIncidentSubtotals'],
+ ],
],
+ ],
+ 'ListIncidentTimelines' => [
+ 'summary' => 'Event dynamics.',
+ 'path' => '/incident/timeline',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZB7ZAW',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZF76LB'],
],
'parameters' => [
[
@@ -16422,100 +11371,125 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障ID',
- 'type' => 'integer',
- ],
- 'recoveryTime' => [
- 'description' => '',
- 'example' => '2020-02-01 00:00:00',
- 'required' => false,
- 'title' => '恢复时间',
- 'type' => 'string',
- ],
- 'problemNotifyType' => [
- 'description' => '',
- 'example' => 'PROBLEM_UPDATE',
- 'required' => false,
- 'title' => '通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE: 故障补发 PROBLEM_CANCEL:故障取消',
- 'type' => 'string',
- ],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9'],
+ 'pageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'pageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'EBC39DEF-C95B-46F8-9AE3-204F0B0A706D',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'title' => ''],
+ 'data' => [
+ 'description' => 'Returned data.',
+ 'items' => [
+ 'description' => 'The data returned.',
+ 'properties' => [
+ 'title' => ['description' => 'A dynamic update.', 'type' => 'string', 'title' => '', 'example' => '标题'],
+ 'description' => ['description' => 'Description.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '描述'],
+ 'remark' => ['description' => 'Remarks.', 'type' => 'string', 'title' => '', 'example' => '备注A'],
+ 'relatedServiceName' => ['description' => 'Service name.', 'type' => 'string', 'title' => '', 'example' => '服务A'],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'title' => '', 'example' => '2021-06-23 00:00:00'],
+ 'incidentTitle' => ['description' => 'Incident title.', 'type' => 'string', 'title' => '', 'example' => '事件标题'],
+ 'action' => ['description' => 'Action type:'."\n"
+ ."\n"
+ .'- Triggered creation: INCIDENT\\_ADD.'."\n"
+ ."\n"
+ .'- Response: INCIDENT\\_RESPONSE.'."\n"
+ ."\n"
+ .'- Reassignment: INCIDENT\\_DELIVER.'."\n"
+ ."\n"
+ .'- Update: INCIDENT\\_UPDATE.'."\n"
+ ."\n"
+ .'- Add subtotal: INCIDENT\\_ADD\\_SUBTOTAL.'."\n"
+ ."\n"
+ .'- Close: INCIDENT\\_FINISH.'."\n"
+ ."\n"
+ .'- Assign: INCIDENT\\_ASSIGN.'."\n"
+ ."\n"
+ .'- Upgrade: INCIDENT\\_UPGRAD.', 'type' => 'string', 'title' => '', 'example' => 'INCIDENT_ADD'],
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '3321'],
+ 'incidentNumber' => ['description' => 'Incident number.', 'type' => 'string', 'title' => '', 'example' => 'I13002001'],
+ 'snapshotData' => ['description' => 'The data of the dynamic snapshot.', 'type' => 'string', 'title' => '', 'example' => '{"userName":"小明"}'],
+ 'relRouteRuleDeleteType' => ['title' => 'Rule Deletion Field', 'description' => 'Routing rule deletion field.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
+ 'totalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '132'],
+ 'pageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ProblemStatusError',
- 'errorMessage' => 'The problem status is abnormal.',
- ],
- ],
404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
- ],
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"EBC39DEF-C95B-46F8-9AE3-204F0B0A706D\\"\\n}","errorExample":""},{"type":"xml","example":"<RecoverProblemResponse>\\n <requestId>EBC39DEF-C95B-46F8-9AE3-204F0B0A706D</requestId>\\n</RecoverProblemResponse>","errorExample":""}]',
- ],
- 'ReplayProblem' => [
- 'summary' => '故障复盘',
- 'path' => '/problem/replay',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": [\\n {\\n \\"title\\": \\"标题\\",\\n \\"description\\": 0,\\n \\"remark\\": \\"备注A\\",\\n \\"relatedServiceName\\": \\"服务A\\",\\n \\"createTime\\": \\"2021-06-23 00:00:00\\",\\n \\"incidentTitle\\": \\"事件标题\\",\\n \\"action\\": \\"INCIDENT_ADD\\",\\n \\"incidentId\\": 3321,\\n \\"incidentNumber\\": \\"I13002001\\",\\n \\"snapshotData\\": \\"{\\\\\\"userName\\\\\\":\\\\\\"小明\\\\\\"}\\",\\n \\"relRouteRuleDeleteType\\": 1\\n }\\n ],\\n \\"totalCount\\": 132,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","type":"json"}]',
+ 'title' => 'Management Event Dynamics ',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-07T11:52:18.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:38.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIncidentTimelines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIncidentTimelines'],
+ ],
],
+ ],
+ 'ListIncidents' => [
+ 'summary' => 'Lists incidents.',
+ 'path' => '/incident/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZB7ZAW',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZF76LB'],
],
'parameters' => [
[
@@ -16523,101 +11497,144 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
- 'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障ID',
- 'type' => 'integer',
- ],
- 'replayDutyUserId' => [
- 'description' => '',
- 'example' => '3123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '复盘负责人ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3212',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
- ],
+ 'description' => 'Request body.',
+ 'properties' => [
+ 'incidentLevel' => ['description' => 'Incident levels in descending order:'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'P1'],
+ 'pageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
+ 'pageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'],
+ 'effect' => ['description' => 'Impact level:'."\n"
+ ."\n"
+ .'- HIGH: High.'."\n"
+ ."\n"
+ .'- LOW: Low.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'LOW'],
+ 'relationServiceId' => ['description' => 'Associated service ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '12312'],
+ 'incidentStatus' => ['description' => 'Incident status:'."\n"
+ ."\n"
+ .'- ASSIGNED: Assigned.'."\n"
+ ."\n"
+ .'- RESPONDED: Responded.'."\n"
+ ."\n"
+ .'- FINISHED: Finished.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ASSIGNED'],
+ 'me' => ['description' => 'Whether it is yourself: 1 (yes), 0 (no).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
+ 'clientToken' => ['description' => 'Idempotency check.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E1'],
+ 'createStartTime' => ['description' => 'Start time of creation.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2021-11-01 00:00:00'],
+ 'createEndTime' => ['description' => 'End time of creation.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2021-11-10 00:00:00'],
+ 'ruleName' => ['description' => 'Routing rule name.', 'type' => 'string', 'example' => 'sa', 'title' => '', 'required' => false],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'B81E84B5-8FD1-45F3-969A-B5067AADCFFF',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'requestId', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9'],
+ 'data' => [
+ 'description' => 'data',
+ 'items' => [
+ 'description' => 'Incident type.',
+ 'properties' => [
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12321', 'title' => ''],
+ 'routeRuleId' => ['description' => 'Routing rule ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'],
+ 'routeRuleName' => ['description' => 'Routing rule name.', 'type' => 'string', 'title' => '', 'example' => '规则A'],
+ 'incidentStatus' => ['description' => 'Incident status: 0 (assigned), 1 (responded), 2 (finished).', 'type' => 'string', 'title' => '', 'example' => '0'],
+ 'incidentLevel' => ['description' => 'Incident level: P1, P2, P3, P4 in descending order.', 'type' => 'string', 'title' => '', 'example' => 'P4'],
+ 'relatedServiceId' => ['description' => 'Associated service ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '213123'],
+ 'relatedServiceName' => ['description' => 'Associated service name.', 'type' => 'string', 'title' => '', 'example' => '服务A'],
+ 'effect' => ['description' => 'Impact level: HIGH, LOW.', 'type' => 'string', 'title' => '', 'example' => 'HIGH'],
+ 'assignUserId' => ['description' => 'Assigned user ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '21312'],
+ 'assignUserName' => ['description' => 'Assigned user name.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => '小明'],
+ 'assignUserPhone' => ['description' => 'Assignee\'s phone number.', 'type' => 'string', 'title' => '', 'example' => '1390000****'],
+ 'incidentTitle' => ['description' => 'Incident title.', 'type' => 'string', 'title' => '', 'example' => '事件A'],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'title' => '', 'example' => '2020-10-1 00:00:00'],
+ 'isManual' => ['description' => 'Incident source: true (manual), false (automatic).', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'incidentNumber' => ['description' => 'Incident number.', 'type' => 'string', 'title' => '', 'example' => 'I3000021'],
+ 'relServiceDeleteType' => ['description' => 'Service deletion field: 1 (normal), 0 (deleted).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'relRouteRuleDeleteType' => ['description' => 'Rule deletion field: 1 (normal), 0 (deleted).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'assignToWhoIsValid' => ['description' => 'Whether the assigned user is valid: 1 (valid), 0 (invalid).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '008'],
+ ],
+ 'title' => 'IncidentItemType',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
+ 'totalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60'],
+ 'pageNumber' => ['description' => 'Page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'pageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ProblemStatusError',
- 'errorMessage' => 'The problem status is abnormal.',
- ],
+ 403 => [
+ ['errorCode' => 'UserNotAdded', 'errorMessage' => 'The user is not added to the system.', 'description' => 'The user did not added to system'],
],
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": [\\n {\\n \\"incidentId\\": 12321,\\n \\"routeRuleId\\": 123,\\n \\"routeRuleName\\": \\"规则A\\",\\n \\"incidentStatus\\": \\"0\\",\\n \\"incidentLevel\\": \\"P4\\",\\n \\"relatedServiceId\\": 213123,\\n \\"relatedServiceName\\": \\"服务A\\",\\n \\"effect\\": \\"HIGH\\",\\n \\"assignUserId\\": 21312,\\n \\"assignUserName\\": \\"小明\\",\\n \\"assignUserPhone\\": \\"1390000****\\",\\n \\"incidentTitle\\": \\"事件A\\",\\n \\"createTime\\": \\"2020-10-1 00:00:00\\",\\n \\"isManual\\": true,\\n \\"incidentNumber\\": \\"I3000021\\",\\n \\"relServiceDeleteType\\": 1,\\n \\"relRouteRuleDeleteType\\": 1,\\n \\"assignToWhoIsValid\\": 8\\n }\\n ],\\n \\"totalCount\\": 60,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","type":"json"}]',
+ 'title' => 'Event List',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-04T12:48:45.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-06-07T11:52:18.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:47.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:47.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIncidents'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIncidents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"B81E84B5-8FD1-45F3-969A-B5067AADCFFF\\"\\n}","errorExample":""},{"type":"xml","example":"<ReplayProblemResponse>\\n <requestId>B81E84B5-8FD1-45F3-969A-B5067AADCFFF</requestId>\\n</ReplayProblemResponse>","errorExample":""}]',
],
- 'RevokeProblemRecovery' => [
- 'summary' => '故障撤销恢复',
- 'path' => '/problem/revoke',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListIntegrationConfigTimelines' => [
+ 'summary' => 'Integration configuration operation log.',
+ 'path' => '/integrationConfig/timeline',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLC8226',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempBHVB81'],
],
'parameters' => [
[
@@ -16627,32 +11644,15 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障ID',
- 'type' => 'integer',
- ],
- 'problemNotifyType' => [
- 'description' => '',
- 'example' => 'PROBLEM_UPGRADE',
- 'required' => false,
- 'title' => '通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE: 故障补发 PROBLEM_CANCEL:故障取消',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2EF',
- 'required' => false,
- 'title' => '幂等校验Id',
- 'type' => 'string',
- ],
+ 'integrationConfigId' => ['description' => 'Integration configuration ID.', 'example' => '101', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'pageNumber' => ['description' => 'Pagination Parameters.', 'example' => '1', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'pageSize' => ['description' => 'Pagination parameters.', 'example' => '10', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency identity.', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -16661,64 +11661,80 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'data' => [
+ 'description' => 'data',
+ 'items' => [
+ 'description' => 'Timeline edge zone.',
+ 'properties' => [
+ 'title' => ['description' => 'Subject.', 'example' => '时间线标题', 'title' => '', 'type' => 'string'],
+ 'description' => ['description' => 'Description.', 'example' => '描述xxxxx', 'title' => '', 'type' => 'string'],
+ 'createTime' => ['description' => 'Creation Time.', 'example' => '2021-04-05 10:10:10', 'title' => '', 'type' => 'string'],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
+ 'requestId' => ['description' => 'requestId', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'title' => 'requestId', 'type' => 'string'],
+ 'totalCount' => ['description' => 'totalCount', 'example' => '103', 'format' => 'int64', 'title' => 'totalCount', 'type' => 'integer'],
+ 'pageNumber' => ['description' => 'pageNumber', 'example' => '1', 'format' => 'int64', 'title' => 'pageNumber', 'type' => 'integer'],
+ 'pageSize' => ['description' => 'pageSize', 'example' => '10', 'format' => 'int64', 'title' => 'pageSize', 'type' => 'integer'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ProblemStatusError',
- 'errorMessage' => 'The problem status is abnormal.',
- ],
- ],
404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
- ],
+ ['errorCode' => 'IntegationConfigNotExists', 'errorMessage' => 'The specified integration config does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"<RevokeProblemRecoveryResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n</RevokeProblemRecoveryResponse>","errorExample":""}]',
- ],
- 'GenerateProblemPictureLink' => [
- 'summary' => '获取图片下载url',
- 'path' => '/problem/process/oss/getPresignedLink',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"title\\": \\"时间线标题\\",\\n \\"description\\": \\"描述xxxxx\\",\\n \\"createTime\\": \\"2021-04-05 10:10:10\\"\\n }\\n ],\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"totalCount\\": 103,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","type":"json"}]',
+ 'title' => 'Integration Configuration Operation Log',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIntegrationConfigTimelines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationConfigTimelines'],
+ ],
],
+ ],
+ 'ListIntegrationConfigs' => [
+ 'summary' => 'Lists integration configurations.',
+ 'path' => '/integrationConfig/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZB7ZAW',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempBHVB81'],
],
'parameters' => [
[
@@ -16728,29 +11744,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'keys' => [
- 'description' => 'oss key',
- 'items' => [
- 'description' => 'keys',
- 'example' => 'problem/38b2a7893-484d-8989-b9cf-d243e53a82c6',
- 'required' => false,
- 'type' => 'string',
- ],
- 'required' => false,
- 'title' => 'oss key',
- 'type' => 'array',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '50002021',
- 'required' => false,
- 'title' => '故障id',
- 'type' => 'string',
- ],
+ 'monitorSourceName' => ['description' => 'The name of the monitoring source.', 'type' => 'string', 'required' => false, 'example' => 'Zabbix', 'title' => ''],
+ 'clientToken' => ['description' => 'The idempotence token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -16759,87 +11759,95 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'c26f36de-1ec8-496a-a828-88067879ef81',
- 'title' => 'requestId',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'id of the request', 'type' => 'string', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'title' => ''],
'data' => [
'description' => 'data',
- 'properties' => [
- 'links' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'key' => [
- 'description' => 'oss key',
- 'example' => 'problem/xxxxxxxxxx-484d-4242-b9cf-xxxxxxxxxx',
- 'title' => 'oss key',
- 'type' => 'string',
- ],
- 'link' => [
- 'description' => '',
- 'example' => 'http://xxxx-xxxx-bucket.oss-cn-xxxx.aliyuncs.com/pxxxx/38xxxxd-4789-4242-b9cfxxxxxxxxc6?Expires=1xxxxxxxxxx7&OSSAccessKeyId=xxxxxxxxxxxxxx7&Signature=xxxxxxxxxxxxxxxxxxxxxx',
- 'title' => '图片链接',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '图片链接列表',
- 'type' => 'array',
+ 'items' => [
+ 'description' => 'The integration configuration.',
+ 'properties' => [
+ 'integrationConfigId' => ['description' => 'The ID of the integration configuration.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1023'],
+ 'monitorSourceId' => ['description' => 'The ID of the monitoring source.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '87'],
+ 'monitorSourceName' => ['description' => 'The name of the monitoring source.', 'type' => 'string', 'title' => '', 'example' => 'Zabbix'],
+ 'monitorSourceShortName' => ['description' => 'The short name of the monitoring source.', 'type' => 'string', 'title' => '', 'example' => 'Zabbix'],
+ 'isReceivedEvent' => ['description' => 'Indicates whether an alert has been received.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'status' => ['description' => 'The status of the integration configuration.', 'type' => 'string', 'example' => 'NOT_INTEGRATED', 'title' => ''],
+ 'monitorSourceType' => ['title' => '0: Non-custom monitoring source 1: Custom monitoring source ', 'description' => 'The type of the monitoring source. 0 indicates a standard monitoring source. 1 indicates a custom monitoring source.', 'type' => 'integer', 'format' => 'int32', 'example' => ''],
],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'object',
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"data\\": [\\n {\\n \\"integrationConfigId\\": 1023,\\n \\"monitorSourceId\\": 87,\\n \\"monitorSourceName\\": \\"Zabbix\\",\\n \\"monitorSourceShortName\\": \\"Zabbix\\",\\n \\"isReceivedEvent\\": false,\\n \\"status\\": \\"NOT_INTEGRATED\\",\\n \\"monitorSourceType\\": 0\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Integration Configuration List ',
+ 'requestParamsDescription' => '{'."\n"
+ .'"monitorSourceName" : "Zabbix",'."\n"
+ .'"clientToken" : "601FA6A2-AC5C-4B59-BE11-378F887A6A11"'."\n"
+ .'}',
+ 'responseParamsDescription' => '{'."\n"
+ .'"requestId": "601FA6A2-AC5C-4B59-BE11-378F887A6A11",'."\n"
+ .'"data": \\['."\n"
+ .'{'."\n"
+ .'"integrationConfigId": 1023,'."\n"
+ .'"monitorSourceId": 87,'."\n"
+ .'"monitorSourceName": "Zabbix",'."\n"
+ .'"monitorSourceShortName": "Zabbix",'."\n"
+ .'"isReceivedEvent": false,'."\n"
+ .'"status": "NOT\\_INTEGRATED"'."\n"
+ .'}'."\n"
+ .']'."\n"
+ .'}',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:53.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIntegrationConfigs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-88067879ef81\\",\\n \\"data\\": {\\n \\"links\\": [\\n {\\n \\"key\\": \\"problem/xxxxxxxxxx-484d-4242-b9cf-xxxxxxxxxx\\",\\n \\"link\\": \\"http://xxxx-xxxx-bucket.oss-cn-xxxx.aliyuncs.com/pxxxx/38xxxxd-4789-4242-b9cfxxxxxxxxc6?Expires=1xxxxxxxxxx7&OSSAccessKeyId=xxxxxxxxxxxxxx7&Signature=xxxxxxxxxxxxxxxxxxxxxx\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GenerateProblemPictureLinkResponse>\\n <requestId>c26f36de-1ec8-496a-a828-88067879ef81</requestId>\\n <data>\\n <links>\\n <key>problem/xxxxxxxxxx-484d-4242-b9cf-xxxxxxxxxx</key>\\n <link>http://xxxx-xxxx-bucket.oss-cn-xxxx.aliyuncs.com/pxxxx/38xxxxd-4789-4242-b9cfxxxxxxxxc6?Expires=1xxxxxxxxxx7&amp;OSSAccessKeyId=xxxxxxxxxxxxxx7&amp;Signature=xxxxxxxxxxxxxxxxxxxxxx</link>\\n </links>\\n </data>\\n</GenerateProblemPictureLinkResponse>","errorExample":""}]',
- ],
- 'UpdateProblemEffectionService' => [
- 'summary' => '更新故障影响服务',
- 'path' => '/problem/process/effectionService/update',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationConfigs'],
+ ],
],
+ ],
+ 'ListMonitorSources' => [
+ 'summary' => 'ListMonitorSources',
+ 'path' => '/monitorSource/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZB7ZAW',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempBHVB81'],
],
'parameters' => [
[
@@ -16849,134 +11857,92 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'serviceId' => [
- 'description' => '',
- 'example' => '33',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '关联服务id',
- 'type' => 'integer',
- ],
- 'level' => [
- 'description' => '',
- 'example' => 'P1',
- 'required' => false,
- 'title' => '影响等级',
- 'type' => 'string',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'UN_RECOVERED',
- 'required' => false,
- 'title' => '影响状态 UN_RECOVERED 未恢复 RECOVERED已恢复',
- 'type' => 'string',
- ],
- 'description' => [
- 'description' => '',
- 'example' => '乐嘉国际大厦',
- 'required' => false,
- 'title' => '影响描述',
- 'type' => 'string',
- ],
- 'picUrl' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => 'problem/xxxxxxxx-a2c8-40b9-9162-08a6c2e338e2',
- 'required' => false,
- 'type' => 'string',
- ],
- 'required' => false,
- 'title' => '图片地址',
- 'type' => 'array',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '190000000',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
- 'effectionServiceId' => [
- 'description' => '',
- 'example' => '103',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '影响服务id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => 'clientToken',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
+ 'clientToken' => ['description' => 'Idempotency identity. ', 'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11', 'required' => false, 'type' => 'string', 'title' => ''],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'ffbf594-e093-46ad-bdcd-df4d7097125a',
- 'title' => 'requestId',
- 'type' => 'string',
+ 'data' => [
+ 'description' => 'data',
+ 'items' => [
+ 'properties' => [
+ 'monitorSourceId' => ['description' => 'Monitoring source ID. ', 'example' => '12', 'format' => 'int64', 'type' => 'integer', 'title' => ''],
+ 'monitorSourceName' => ['description' => 'Monitoring source name. ', 'example' => 'Zabbix', 'type' => 'string', 'title' => ''],
+ 'fieldKeys' => [
+ 'description' => 'List of monitoring source fields. ',
+ 'items' => ['description' => 'Monitoring source field. ', 'example' => 'payload.content', 'type' => 'string', 'title' => ''],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'type' => 'object',
+ 'description' => 'Returned data. ',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
+ 'requestId' => ['description' => 'id of the request', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88', 'type' => 'string', 'title' => ''],
],
- 'title' => 'Schema of Response',
'type' => 'object',
+ 'description' => 'Response structure. ',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"monitorSourceId\\": 12,\\n \\"monitorSourceName\\": \\"Zabbix\\",\\n \\"fieldKeys\\": [\\n \\"payload.content\\"\\n ]\\n }\\n ],\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","type":"json"}]',
+ 'title' => 'List of monitoring sources ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListMonitorSources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ffbf594-e093-46ad-bdcd-df4d7097125a\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateProblemEffectionServiceResponse>\\n <requestId>ffbf594-e093-46ad-bdcd-df4d7097125a</requestId>\\n</UpdateProblemEffectionServiceResponse>","errorExample":""}]',
- ],
- 'DeleteProblemEffectionService' => [
- 'summary' => '删除故障影响服务',
- 'path' => '/problem/process/effectionService/delete',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMonitorSources'],
+ ],
],
+ ],
+ 'ListProblemDetailOperations' => [
+ 'summary' => 'Dynamic Fault Details.',
+ 'path' => '/problem/detail/operations',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempIOV4BX',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1XQ9JR'],
],
'parameters' => [
[
@@ -16986,33 +11952,16 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'effectionServiceId' => [
- 'description' => '',
- 'example' => '567',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '影响服务ID',
- 'type' => 'integer',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '876',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => 'clientToken',
- 'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
+ 'clientToken' => ['description' => 'Idempotency token', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'title' => '', 'required' => false],
+ 'pageNumber' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ 'pageSize' => ['description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'required' => false],
+ 'createTimeSort' => ['description' => 'Creation time sort order', 'type' => 'string', 'example' => 'desc', 'title' => '', 'required' => false],
+ 'problemId' => ['description' => 'Problem ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -17021,58 +11970,106 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9'],
+ 'totalCount' => ['description' => 'Total count', 'type' => 'integer', 'format' => 'int32', 'example' => '210', 'title' => ''],
+ 'pageNumber' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'Number of rows', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'data' => [
+ 'description' => 'data',
+ 'items' => [
+ 'properties' => [
+ 'title' => ['description' => 'Dynamic title', 'type' => 'string', 'example' => '动态标题', 'title' => ''],
+ 'description' => ['description' => 'Description', 'type' => 'string', 'example' => '描述', 'title' => ''],
+ 'relatedServiceName' => ['description' => 'Service', 'type' => 'string', 'example' => '服务A', 'title' => ''],
+ 'createTime' => ['description' => 'Creation time', 'type' => 'string', 'example' => '2021-01-23 00:00:00', 'title' => ''],
+ 'remark' => ['description' => 'Remarks', 'type' => 'string', 'example' => '备注', 'title' => ''],
+ 'action' => ['description' => 'Upgrade (PROBLEM\\_UPGRADE), Revoke (PROBLEM\\_REVOKE), Restore (PROBLEM\\_RESTORE), Review (PROBLEM\\_IN\\_REVIEW), Complete (PROBLEM\\_REOPENED), Cancel (PROBLEM\\_CANCEL), Update problem notification (PROBLEM\\_UPDATE\\_NOTIFY), Add problem subtotal (PROBLEM\\_ADD\\_SUBTOTAL), Update problem (PROBLEM\\_UPDATE)', 'type' => 'string', 'example' => 'PROBLEM_CANCEL', 'title' => ''],
+ 'snapshotData' => ['description' => 'Snapshot data', 'type' => 'string', 'example' => '{“userName”:"小明"}', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => 'data',
+ 'type' => 'array',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"totalCount\\": 210,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"data\\": [\\n {\\n \\"title\\": \\"动态标题\\",\\n \\"description\\": \\"描述\\",\\n \\"relatedServiceName\\": \\"服务A\\",\\n \\"createTime\\": \\"2021-01-23 00:00:00\\",\\n \\"remark\\": \\"备注\\",\\n \\"action\\": \\"PROBLEM_CANCEL\\",\\n \\"snapshotData\\": \\"{“userName”:\\\\\\"小明\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Incident Details Timeline ',
+ 'requestParamsDescription' => '{'."\n"
+ .'"clientToken": "FD200FAE-E98F-496E-BFE6-4CE61E59A2E9",'."\n"
+ .'"pageNumber": 1,'."\n"
+ .'"pageSize": 10,'."\n"
+ .'"createTimeSort": "desc,asc",'."\n"
+ .'"problemId": 1'."\n"
+ .'}',
+ 'responseParamsDescription' => '{'."\n"
+ .'"requestId": "FD200FAE-E98F-496E-BFE6-4CE61E59A2E9",'."\n"
+ .'"totalCount": 210,'."\n"
+ .'"pageNumber": 1,'."\n"
+ .'"pageSize": 10,'."\n"
+ .'"data": \\['."\n"
+ .'{'."\n"
+ .'"title": "Dynamic title",'."\n"
+ .'"description": "Description",'."\n"
+ .'"relatedServiceName": "Service A",'."\n"
+ .'"createTime": "2021-01-23 00:00:00",'."\n"
+ .'"remark": "Remarks",'."\n"
+ .'"action": "PROBLEM\\_CANCEL",'."\n"
+ .'"snapshotData": "{\\\\"userName\\\\":\\\\"Xiao Ming\\\\"}"'."\n"
+ .'}'."\n"
+ .']'."\n"
+ .'}',
+ 'changeSet' => [
+ ['createdAt' => '2021-09-10T01:53:15.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-09-10T01:53:15.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListProblemDetailOperations',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"e0b6735e-1a04-4d6b-a625-d2350612492c\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteProblemEffectionServiceResponse>\\n <requestId>e0b6735e-1a04-4d6b-a625-d2350612492c</requestId>\\n</DeleteProblemEffectionServiceResponse>","errorExample":""}]',
- ],
- 'UpdateProblemMeasure' => [
- 'summary' => '改进措施更新',
- 'path' => '/problem/improvement/measure/update',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProblemDetailOperations'],
+ ],
],
+ ],
+ 'ListProblemOperations' => [
+ 'summary' => 'Provides a dynamic list of faults.',
+ 'path' => '/problem/operations',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZVI8H5',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1XQ9JR'],
],
'parameters' => [
[
@@ -17080,158 +12077,117 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'Request body.',
'properties' => [
- 'type' => [
- 'description' => '',
- 'example' => '3',
- 'format' => 'int32',
- 'required' => false,
- 'title' => '措施类型 码表 PROBLEM_REPLAY_IMPROVEMENT',
- 'type' => 'integer',
- ],
- 'content' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '措施内容',
- 'type' => 'string',
- ],
- 'checkStandard' => [
- 'description' => '',
- 'example' => '2',
- 'required' => false,
- 'title' => '验收标准',
- 'type' => 'string',
- ],
- 'checkUserId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '验收人id',
- 'type' => 'integer',
- ],
- 'directorId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '负责人id',
- 'type' => 'integer',
- ],
- 'stalkerId' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '跟踪人id',
- 'type' => 'integer',
- ],
- 'planFinishTime' => [
- 'description' => '',
- 'example' => '2021-01-21 00:00:00',
- 'required' => false,
- 'title' => '计划完成时间',
- 'type' => 'string',
- ],
- 'measureId' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '措施Id',
- 'type' => 'integer',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'UNIMPROVED',
- 'required' => false,
- 'title' => '状态 IMPROVED 改进 2 未改进UNIMPROVED',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '1233',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障Id',
- 'type' => 'integer',
- ],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'title' => '', 'required' => false],
+ 'pageNumber' => ['description' => 'Page number for pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ 'pageSize' => ['description' => 'Page size for pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'required' => false],
],
'required' => false,
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9'],
+ 'totalCount' => ['description' => 'Total number of items.', 'type' => 'integer', 'format' => 'int32', 'example' => '132', 'title' => ''],
+ 'pageNumber' => ['description' => 'Page number for pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'Page size for pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'data' => [
+ 'description' => 'Returned data.',
+ 'items' => [
+ 'properties' => [
+ 'title' => ['description' => 'Dynamic title.', 'type' => 'string', 'example' => '动态标题', 'title' => ''],
+ 'description' => ['description' => 'Description.', 'type' => 'string', 'example' => '描述', 'title' => ''],
+ 'relatedServiceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => '服务名称', 'title' => ''],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2021-01-23 00:00:00', 'title' => ''],
+ 'action' => ['description' => '- PROBLEM\\_UPGRADE: Upgrade.'."\n"
+ ."\n"
+ .'- PROBLEM\\_REVOKE: Revoke.'."\n"
+ ."\n"
+ .'- PROBLEM\\_RESTORE: Resume.'."\n"
+ ."\n"
+ .'- PROBLEM\\_IN\\_REVIEW: Review.'."\n"
+ ."\n"
+ .'- PROBLEM\\_REOPENED: Resolve.'."\n"
+ ."\n"
+ .'- PROBLEM\\_CANCEL: Cancel.'."\n"
+ ."\n"
+ .'- PROBLEM\\_UPDATE\\_NOTIFY: Update incident notification.'."\n"
+ ."\n"
+ .'- PROBLEM\\_ADD\\_SUBTOTAL: Add incident subtotal.'."\n"
+ ."\n"
+ .'- PROBLEM\\_UPDATE: Update incident.', 'type' => 'string', 'example' => 'PROBLEM_CANCEL', 'title' => ''],
+ 'problemId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12312', 'title' => ''],
+ 'problemName' => ['description' => 'Incident name.', 'type' => 'string', 'example' => '这是一个故障', 'title' => ''],
+ 'problemNumber' => ['description' => 'Incident number.', 'type' => 'string', 'example' => 'P1231231', 'title' => ''],
+ 'snapshotData' => ['description' => 'Snapshot data.', 'type' => 'string', 'example' => '{“userName”:"小明"}', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'description' => 'List of problems.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => 'data',
+ 'type' => 'array',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
- ],
- [
- 'errorCode' => 'ProblemMeasureNotExisted',
- 'errorMessage' => 'The problem measure does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"totalCount\\": 132,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"data\\": [\\n {\\n \\"title\\": \\"动态标题\\",\\n \\"description\\": \\"描述\\",\\n \\"relatedServiceName\\": \\"服务名称\\",\\n \\"createTime\\": \\"2021-01-23 00:00:00\\",\\n \\"action\\": \\"PROBLEM_CANCEL\\",\\n \\"problemId\\": 12312,\\n \\"problemName\\": \\"这是一个故障\\",\\n \\"problemNumber\\": \\"P1231231\\",\\n \\"snapshotData\\": \\"{“userName”:\\\\\\"小明\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Problem Dynamics ',
+ 'changeSet' => [
+ ['createdAt' => '2021-08-24T09:22:03.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListProblemOperations',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateProblemMeasureResponse>\\n <requestId>4361a0e1-6747-4834-96ce-0c4840fd3812</requestId>\\n</UpdateProblemMeasureResponse>","errorExample":""}]',
- ],
- 'DeleteProblem' => [
- 'summary' => '故障刪除',
- 'path' => '/problem/delete',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProblemOperations'],
+ ],
],
+ ],
+ 'ListProblemSubtotals' => [
+ 'summary' => 'Lists problem subtotals.',
+ 'path' => '/problem/list/subtotal',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZVI8H5',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1XQ9JR'],
],
'parameters' => [
[
@@ -17239,87 +12195,98 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障Id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'required' => false,
- 'title' => '幂等校验',
- 'type' => 'string',
- ],
+ 'problemId' => ['description' => 'Problem ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1231', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '4361a0e1-6747-4834-96ce-0c4840fdB812'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '4361a0e1-6747-4834-96ce-0S4840fd3812'],
+ 'data' => [
+ 'description' => 'Response data.',
+ 'items' => [
+ 'description' => 'Result.',
+ 'properties' => [
+ 'description' => ['description' => 'Description.', 'type' => 'string', 'title' => '', 'example' => '小计内容'],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'title' => '', 'example' => '2020-10-02 00:00:00'],
+ 'createRamName' => ['description' => 'Operator.', 'type' => 'string', 'title' => '', 'example' => '小明'],
+ 'createUserPhone' => ['description' => 'Operator\'s phone number.', 'type' => 'string', 'title' => '', 'example' => '130****1111'],
+ 'createUserId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
- ],
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteProblemResponse>\\n <requestId>4361a0e1-6747-4834-96ce-0c4840fd3812</requestId>\\n</DeleteProblemResponse>","errorExample":""}]',
- ],
- 'GetProblem' => [
- 'summary' => '查询故障详情',
- 'path' => '/problem/detail',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0S4840fd3812\\",\\n \\"data\\": [\\n {\\n \\"description\\": \\"小计内容\\",\\n \\"createTime\\": \\"2020-10-02 00:00:00\\",\\n \\"createRamName\\": \\"小明\\",\\n \\"createUserPhone\\": \\"130****1111\\",\\n \\"createUserId\\": 123123\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'List of fault summaries',
+ 'changeSet' => [
+ ['createdAt' => '2021-07-16T04:09:35.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListProblemSubtotals',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProblemSubtotals'],
+ ],
],
+ ],
+ 'ListProblemTimeLines' => [
+ 'summary' => 'Queries the list of problem timelines.',
+ 'path' => '/problem/detail/timeLines',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempUCUJK5',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZ5UD4L'],
],
'parameters' => [
[
@@ -17327,26 +12294,15 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
+ 'description' => 'A short description of struct',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '故障ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'problemId' => ['description' => 'Problem ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10002010', 'title' => '', 'required' => false],
+ 'clientToken' => ['title' => 'clientToken', 'description' => 'Idempotency token', 'type' => 'string', 'required' => false, 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
],
'required' => false,
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -17355,521 +12311,100 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
'data' => [
- 'description' => '',
- 'properties' => [
- 'problemId' => [
- 'description' => 'ID',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => true,
- 'title' => 'ID',
- 'type' => 'integer',
- 'enum' => [
- 'Success',
- 'Fail',
- 'Cancel',
- ],
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2010-03-09 15:53:45',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'incidentNumber' => [
- 'description' => '',
- 'example' => 'I3443835000012016260833157948165',
- 'title' => '事件编号',
- 'type' => 'string',
- ],
- 'incidentId' => [
- 'description' => '',
- 'example' => '130000032',
- 'format' => 'int64',
- 'title' => '事件id',
- 'type' => 'integer',
- ],
- 'problemNumber' => [
- 'description' => '',
- 'example' => 'P34438300010030116260833538987481',
- 'title' => '故障编号',
- 'type' => 'string',
- ],
- 'problemName' => [
- 'description' => '',
- 'example' => '故障',
- 'title' => '故障名称',
- 'type' => 'string',
- ],
- 'problemStatus' => [
- 'description' => '',
- 'example' => 'HANDLING',
- 'format' => 'int32',
- 'title' => '故障状态 HANDLING 处理中 RECOVERED 已恢复 REPLAYING 复盘中 REPLAYED 已复盘 CANCEL 已取消',
- 'type' => 'integer',
- ],
- 'problemLevel' => [
- 'description' => '',
- 'example' => 'P1',
- 'format' => 'int32',
- 'title' => '故障等级 P1 P2 P3 P4',
- 'type' => 'integer',
- ],
- 'discoverTime' => [
- 'description' => '',
- 'example' => '2010-03-09 15:53:45',
- 'title' => '发现时间',
- 'type' => 'string',
- ],
- 'recoveryTime' => [
- 'description' => '',
- 'example' => '2010-03-09 15:53:45',
- 'title' => '恢复时间',
- 'type' => 'string',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '关联服务ID',
- 'type' => 'integer',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => '服务',
- 'title' => '关联服务 名称',
- 'type' => 'string',
- ],
- 'progressSummary' => [
- 'description' => '',
- 'example' => '摘要',
- 'title' => '进展摘要',
- 'type' => 'string',
- ],
- 'preliminaryReason' => [
- 'description' => '',
- 'example' => '原因',
- 'title' => '初步原因',
- 'type' => 'string',
- ],
- 'mainHandler' => [
- 'description' => '',
- 'example' => '王宇',
- 'format' => 'int64',
- 'title' => '主要处理人',
- 'type' => 'integer',
- ],
- 'mainHandlerId' => [
- 'description' => '',
- 'example' => '2000',
- 'format' => 'int64',
- 'title' => '主要处理人ID',
- 'type' => 'integer',
- ],
- 'mainHandlerPhone' => [
- 'description' => '',
- 'example' => '1308987****',
- 'title' => '主要处理人手机号',
- 'type' => 'string',
- ],
- 'feedback' => [
- 'description' => '',
- 'example' => 'feedback',
- 'title' => '舆情反馈',
- 'type' => 'string',
- ],
- 'cancelReasonDescription' => [
- 'description' => '',
- 'example' => '理由',
- 'title' => '取消原因描述',
- 'type' => 'string',
- ],
- 'cancelReason' => [
- 'description' => '',
- 'example' => '取消理由',
- 'format' => 'int64',
- 'title' => '取消原因',
- 'type' => 'integer',
- ],
- 'durationTime' => [
- 'description' => '',
- 'example' => '300000',
- 'format' => 'int64',
- 'title' => '持续时间',
- 'type' => 'integer',
- ],
- 'progressSummaryRichTextId' => [
- 'description' => '',
- 'example' => '1231231',
- 'format' => 'int64',
- 'title' => '进展摘要富文本id',
- 'type' => 'integer',
- ],
- 'handingProblemOperateLogs' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'operator' => [
- 'description' => '',
- 'example' => '王宇',
- 'title' => '操作人',
- 'type' => 'string',
- ],
- 'userId' => [
- 'description' => '',
- 'example' => '233',
- 'format' => 'int64',
- 'title' => '用户id',
- 'type' => 'integer',
- ],
- 'actionName' => [
- 'description' => '',
- 'example' => '取消故障',
- 'title' => '动作名称',
- 'type' => 'string',
- ],
- 'actionTime' => [
- 'description' => '',
- 'example' => '2010-03-09 15:53:45',
- 'title' => '操作时间',
- 'type' => 'string',
- ],
- 'userIsValid' => [
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '处理中故障操作日志',
- 'type' => 'array',
- ],
- 'restoredProblemOperateLogs' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'operator' => [
- 'description' => '',
- 'example' => '王宇',
- 'title' => '操作人',
- 'type' => 'string',
- ],
- 'userId' => [
- 'description' => '',
- 'example' => '3232',
- 'format' => 'int64',
- 'title' => '用户id',
- 'type' => 'integer',
- ],
- 'actionName' => [
- 'description' => '',
- 'example' => '恢复故障',
- 'title' => '动作名称',
- 'type' => 'string',
- ],
- 'actionTime' => [
- 'description' => '',
- 'example' => '2020-08-08 15:39:39',
- 'title' => '操作时间',
- 'type' => 'string',
- ],
- 'userIsValid' => [
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '已恢复故障操作日志',
- 'type' => 'array',
- ],
- 'replayingProblemOperateLogs' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'operator' => [
- 'description' => '',
- 'example' => '刘杰',
- 'title' => '操作人',
- 'type' => 'string',
- ],
- 'userId' => [
- 'description' => '',
- 'example' => '用户id',
- 'format' => 'int64',
- 'title' => '用户id',
- 'type' => 'integer',
- ],
- 'actionName' => [
- 'description' => '',
- 'example' => '复盘故障',
- 'title' => '动作名称',
- 'type' => 'string',
- ],
- 'actionTime' => [
- 'description' => '',
- 'example' => '2020-08-08 15:39:39',
- 'title' => '操作时间',
- 'type' => 'string',
- ],
- 'userIsValid' => [
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '复盘中故障操作日志',
- 'type' => 'array',
- ],
- 'replayProblemOperateLogs' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'operator' => [
- 'description' => '',
- 'example' => '周宇凡',
- 'title' => '操作人',
- 'type' => 'string',
- ],
- 'userId' => [
- 'description' => '',
- 'example' => '2323',
- 'format' => 'int64',
- 'title' => '用户id',
- 'type' => 'integer',
- ],
- 'actionName' => [
- 'description' => '',
- 'example' => '复盘故障',
- 'title' => '动作名称',
- 'type' => 'string',
- ],
- 'actionTime' => [
- 'description' => '',
- 'example' => '2020-08-08 15:39:39',
- 'title' => '操作时间',
- 'type' => 'string',
- ],
- 'userIsValid' => [
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '已复盘故障操作日志',
- 'type' => 'array',
- ],
- 'effectionServices' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'effectionServiceId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '服务ID',
- 'type' => 'integer',
- ],
- 'effectionLevel' => [
- 'description' => '',
- 'example' => 'P1',
- 'format' => 'int64',
- 'title' => '影响等级 P1 . P2 P3 P4',
- 'type' => 'integer',
- ],
- 'effectionStatus' => [
- 'description' => '',
- 'example' => 'RESTORED',
- 'format' => 'int32',
- 'title' => '影响服务状态 RECOVERED 已经恢复 ,UN_RECOVERED 未恢复',
- 'type' => 'integer',
- ],
- 'description' => [
- 'description' => '',
- 'example' => '描述',
- 'title' => '影响描述',
- 'type' => 'string',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => '购物车',
- 'title' => '服务名称',
- 'type' => 'string',
- ],
- 'serviceDeleteType' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '服务删除字段 1正常 0删除',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '影响服务',
- 'type' => 'array',
- ],
- 'coordinationGroups' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '服务组ID',
- 'type' => 'integer',
- ],
- 'serviceGroupName' => [
- 'description' => '',
- 'example' => '清扫大队',
- 'title' => '服务组名字',
- 'type' => 'string',
- ],
- 'isValid' => [
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '应急协同组',
- 'type' => 'array',
- ],
- 'timelines' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'keyNode' => [
- 'description' => '',
- 'example' => '1,2,3,4,5,7,6,8,9,10',
- 'title' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '故障操作时间线',
- 'type' => 'array',
- ],
- 'cancelProblemOperateLogs' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'operator' => [
- 'description' => '',
- 'example' => '王宇',
- 'title' => '操作人',
- 'type' => 'string',
- ],
- 'actionName' => [
- 'description' => '',
- 'example' => '取消故障',
- 'title' => '动作名称',
- 'type' => 'string',
- ],
- 'actionTime' => [
- 'description' => '',
- 'example' => '2020-09-08 15:38:38',
- 'title' => '操作时间',
- 'type' => 'string',
- ],
- 'userId' => [
- 'description' => '',
- 'example' => '66666',
- 'format' => 'int64',
- 'title' => '用户ID',
- 'type' => 'integer',
+ 'description' => 'List of problem timelines',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'createTime' => ['description' => 'Creation time', 'type' => 'string', 'example' => '2020-08-08 15:38:38', 'title' => ''],
+ 'keyNode' => ['description' => 'Key node. Lookup table: PROBLEM\\_KEY\\_NODE (comma-separated)', 'type' => 'string', 'title' => '', 'example' => 'PROBLEM_INJECTION,PROBLEM_HAPPEN'],
+ 'content' => ['description' => 'Content', 'type' => 'string', 'example' => '内容', 'title' => ''],
+ 'isKey' => ['description' => 'Indicates whether this is a keyword. true means yes. false means no. Default is false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'updateTime' => ['description' => 'Update time', 'type' => 'string', 'example' => '2020-08-08 15:38:38', 'title' => ''],
+ 'time' => ['description' => 'Display time', 'type' => 'string', 'example' => '2020-08-08 15:38:38', 'title' => ''],
+ 'problemTimelineId' => ['description' => 'Timeline ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ 'usersInContent' => [
+ 'description' => 'User information in the content',
+ 'items' => [
+ 'description' => 'object',
+ 'properties' => [
+ 'userId' => ['description' => 'User ID', 'type' => 'integer', 'format' => 'int64', 'example' => '232', 'title' => ''],
+ 'username' => ['description' => 'Username', 'type' => 'string', 'example' => '张老萨', 'title' => ''],
+ 'isValid' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'object',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'title' => '已取消故障操作日志',
- 'type' => 'array',
- ],
- 'serviceDeleteType' => [
- 'description' => 'serviceDeleteType',
- 'format' => 'int32',
- 'title' => 'serviceDeleteType',
- 'type' => 'integer',
- ],
- 'mainHandlerIsValid' => [
- 'description' => '',
- 'format' => 'int64',
- 'title' => '主要处理人生效状态,1生效,0失效',
- 'type' => 'integer',
- ],
- 'isRuleTrigger' => [
- 'title' => '是否规则触发 1 是 0不是',
- 'type' => 'boolean',
],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '详情',
- 'type' => 'object',
- ],
- 'requestId' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-41VB-A225-2C88188E8A43',
- 'title' => '请求ID',
- 'type' => 'string',
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
- ],
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
],
- 'staticInfo' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"data\\": {\\n \\"problemId\\": 1,\\n \\"createTime\\": \\"2010-03-09 15:53:45\\",\\n \\"incidentNumber\\": \\"I3443835000012016260833157948165\\",\\n \\"incidentId\\": 130000032,\\n \\"problemNumber\\": \\"P34438300010030116260833538987481\\",\\n \\"problemName\\": \\"故障\\",\\n \\"problemStatus\\": 0,\\n \\"problemLevel\\": 0,\\n \\"discoverTime\\": \\"2010-03-09 15:53:45\\",\\n \\"recoveryTime\\": \\"2010-03-09 15:53:45\\",\\n \\"relatedServiceId\\": 1,\\n \\"serviceName\\": \\"服务\\",\\n \\"progressSummary\\": \\"进展摘要\\",\\n \\"preliminaryReason\\": \\"初步原因\\",\\n \\"mainHandler\\": 0,\\n \\"mainHandlerId\\": 2000,\\n \\"mainHandlerPhone\\": \\"1308987****\\",\\n \\"feedback\\": \\"feedback\\",\\n \\"cancelReasonDescription\\": \\"取消原因描述\\",\\n \\"cancelReason\\": 37,\\n \\"durationTime\\": 300000,\\n \\"progressSummaryRichTextId\\": 1231231,\\n \\"handingProblemOperateLogs\\": [\\n {\\n \\"operator\\": \\"小王\\",\\n \\"userId\\": 233,\\n \\"actionName\\": \\"取消故障\\",\\n \\"actionTime\\": \\"2010-03-09 15:53:45\\",\\n \\"userIsValid\\": 1\\n }\\n ],\\n \\"restoredProblemOperateLogs\\": [\\n {\\n \\"operator\\": \\"小王\\",\\n \\"userId\\": 3232,\\n \\"actionName\\": \\"恢复故障\\",\\n \\"actionTime\\": \\"2020-08-08 15:39:39\\",\\n \\"userIsValid\\": 1\\n }\\n ],\\n \\"replayingProblemOperateLogs\\": [\\n {\\n \\"operator\\": \\"小杰\\",\\n \\"userId\\": 0,\\n \\"actionName\\": \\"复盘故障\\",\\n \\"actionTime\\": \\"2020-08-08 15:39:39\\",\\n \\"userIsValid\\": 1\\n }\\n ],\\n \\"replayProblemOperateLogs\\": [\\n {\\n \\"operator\\": \\"小王\\",\\n \\"userId\\": 2323,\\n \\"actionName\\": \\"复盘故障\\",\\n \\"actionTime\\": \\"2020-08-08 15:39:39\\",\\n \\"userIsValid\\": 1\\n }\\n ],\\n \\"effectionServices\\": [\\n {\\n \\"effectionServiceId\\": 1,\\n \\"effectionLevel\\": 0,\\n \\"effectionStatus\\": 0,\\n \\"description\\": \\"描述\\",\\n \\"serviceName\\": \\"购物车\\",\\n \\"serviceDeleteType\\": 1\\n }\\n ],\\n \\"coordinationGroups\\": [\\n {\\n \\"serviceGroupId\\": 1,\\n \\"serviceGroupName\\": \\"冲上云霄\\",\\n \\"isValid\\": 1\\n }\\n ],\\n \\"timelines\\": [\\n {\\n \\"keyNode\\": \\"1,2,3,4,5,7,6,8,9,10\\"\\n }\\n ],\\n \\"cancelProblemOperateLogs\\": [\\n {\\n \\"operator\\": \\"小王\\",\\n \\"actionName\\": \\"取消故障\\",\\n \\"actionTime\\": \\"2020-09-08 15:38:38\\",\\n \\"userId\\": 66666\\n }\\n ],\\n \\"serviceDeleteType\\": 1,\\n \\"mainHandlerIsValid\\": 1,\\n \\"isRuleTrigger\\": true\\n },\\n \\"requestId\\": \\"C4BE3837-1A13-41VB-A225-2C88188E8A43\\"\\n}","errorExample":""},{"type":"xml","example":"<GetProblemResponse>\\n <data>\\n <problemId>1</problemId>\\n <createTime>2010-03-09 15:53:45</createTime>\\n <incidentNumber>I3443835000012016260833157948165</incidentNumber>\\n <incidentId>130000032</incidentId>\\n <problemNumber>P34438300010030116260833538987481</problemNumber>\\n <problemName>故障</problemName>\\n <discoverTime>2010-03-09 15:53:45</discoverTime>\\n <recoveryTime>2010-03-09 15:53:45</recoveryTime>\\n <relatedServiceId>1</relatedServiceId>\\n <serviceName>服务</serviceName>\\n <progressSummary>进展摘要</progressSummary>\\n <preliminaryReason>初步原因</preliminaryReason>\\n <mainHandlerId>2000</mainHandlerId>\\n <feedback>feedback</feedback>\\n <cancelReasonDescription>取消原因描述</cancelReasonDescription>\\n <handingProblemOperateLogs>\\n <operator>小王</operator>\\n <actionName>取消故障</actionName>\\n <actionTime>2010-03-09 15:53:45</actionTime>\\n </handingProblemOperateLogs>\\n <restoredProblemOperateLogs>\\n <operator>小王</operator>\\n <actionName>恢复故障</actionName>\\n <actionTime>2020-08-08 15:39:39</actionTime>\\n </restoredProblemOperateLogs>\\n <replayingProblemOperateLogs>\\n <operator>小杰</operator>\\n <actionName>复盘故障</actionName>\\n <actionTime>2020-08-08 15:39:39</actionTime>\\n </replayingProblemOperateLogs>\\n <replayProblemOperateLogs>\\n <operator>小王</operator>\\n <actionName>复盘故障</actionName>\\n <actionTime>2020-08-08 15:39:39</actionTime>\\n </replayProblemOperateLogs>\\n <effectionServices>\\n <effectionServiceId>1</effectionServiceId>\\n <description>描述</description>\\n <serviceName>购物车</serviceName>\\n </effectionServices>\\n <coordinationGroups>\\n <serviceGroupId>1</serviceGroupId>\\n <serviceGroupName>冲上云霄</serviceGroupName>\\n </coordinationGroups>\\n <timelines>\\n <keyNode>1,2,3,4,5,7,6,8,9,10</keyNode>\\n </timelines>\\n <cancelProblemOperateLogs>\\n <operator>小王</operator>\\n <actionName>取消故障</actionName>\\n <actionTime>2020-09-08 15:38:38</actionTime>\\n </cancelProblemOperateLogs>\\n </data>\\n <requestId>C4BE3837-1A13-41VB-A225-2C88188E8A43</requestId>\\n</GetProblemResponse>","errorExample":""}]',
- ],
- 'GetProblemImprovement' => [
- 'summary' => '改进分析详情',
- 'path' => '/problem/improvement/detail',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": [\\n {\\n \\"createTime\\": \\"2020-08-08 15:38:38\\",\\n \\"keyNode\\": \\"PROBLEM_INJECTION,PROBLEM_HAPPEN\\",\\n \\"content\\": \\"内容\\",\\n \\"isKey\\": true,\\n \\"updateTime\\": \\"2020-08-08 15:38:38\\",\\n \\"time\\": \\"2020-08-08 15:38:38\\",\\n \\"problemTimelineId\\": 10000,\\n \\"usersInContent\\": [\\n {\\n \\"userId\\": 232,\\n \\"username\\": \\"张老萨\\",\\n \\"isValid\\": 0\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query fault timeline list',
+ 'changeSet' => [
+ ['createdAt' => '2021-07-16T04:09:33.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListProblemTimeLines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProblemTimeLines'],
+ ],
],
+ ],
+ 'ListProblems' => [
+ 'summary' => 'Retrieve a list of problems.',
+ 'path' => '/problem/listProblems',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1XQ9JR',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1XQ9JR'],
],
'parameters' => [
[
@@ -17877,326 +12412,180 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
- 'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '312312',
- 'required' => false,
- 'title' => '故障ID',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
- ],
+ 'description' => 'Request body.',
+ 'properties' => [
+ 'queryType' => ['description' => '- RESPONSIBLE: Problems I am responsible for.'."\n"
+ ."\n"
+ .'- PARTICIPATED: Problems I participated in.'."\n"
+ ."\n"
+ .'- ALL: All problems.', 'type' => 'string', 'example' => 'RESPONSIBLE', 'title' => '', 'required' => false],
+ 'problemStatus' => ['description' => 'Problem status:'."\n"
+ ."\n"
+ .'- HANDLING: In progress.'."\n"
+ ."\n"
+ .'- RECOVERED: Recovered.'."\n"
+ ."\n"
+ .'- REPLAYING: Reviewing.'."\n"
+ ."\n"
+ .'- REPLAYED: Reviewed.'."\n"
+ ."\n"
+ .'- CANCEL: Canceled.', 'type' => 'string', 'example' => 'HANDLING', 'title' => '', 'required' => false],
+ 'problemLevel' => ['description' => 'Problem levels in descending order:'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'string', 'example' => 'P2', 'title' => '', 'required' => false],
+ 'affectServiceId' => ['description' => 'Affected service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'serviceGroupId' => ['description' => 'Emergency collaboration group.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'mainHandlerId' => ['description' => 'Primary handler.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'repeaterId' => ['description' => 'Review owner.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'discoveryStartTime' => ['description' => 'Discovery start time.', 'type' => 'string', 'example' => '2020-03-05 15:50:59', 'title' => '', 'required' => false],
+ 'discoveryEndTime' => ['description' => 'Discovery end time.', 'type' => 'string', 'example' => '2020-03-05 15:50:59', 'title' => '', 'required' => false],
+ 'restoreEndTime' => ['description' => 'Recovery end time.', 'type' => 'string', 'example' => '2020-03-05 15:50:59', 'title' => '', 'required' => false],
+ 'restoreStartTime' => ['description' => 'Recovery start time.', 'type' => 'string', 'example' => '2020-03-05 15:50:59', 'title' => '', 'required' => false],
+ 'pageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'pageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3811',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
'data' => [
- 'description' => 'data',
- 'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '231231',
- 'title' => '故障ID',
- 'type' => 'string',
- ],
- 'problemReason' => [
- 'description' => '',
- 'example' => '',
- 'title' => '故障原因',
- 'type' => 'string',
- ],
- 'recentActivity' => [
- 'description' => '',
- 'example' => '2',
- 'title' => '最近活动 码表:PROBLEM_RECENT_ACTIVITY',
- 'type' => 'string',
- ],
- 'injectionMode' => [
- 'description' => '',
- 'example' => '3',
- 'title' => '注入方式 码表:PROBLEM_INJECTION_MODE',
- 'type' => 'string',
- ],
- 'recoveryMode' => [
- 'description' => '',
- 'example' => '2',
- 'title' => '恢复方式 码表:PROBLEM_RECOVERY_MODE',
- 'type' => 'string',
- ],
- 'discoverSource' => [
- 'description' => '',
- 'example' => '1',
- 'title' => '发现来源 码表:PROBLEM_DISCOVER_SOURCE',
- 'type' => 'string',
- ],
- 'userReport' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '用户上报 码表:PROBLEM_USER_REPORT',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'Zabbix',
- 'title' => '监控源',
- 'type' => 'string',
- ],
- 'relationChanges' => [
- 'description' => '',
- 'example' => '',
- 'title' => '关联变更',
- 'type' => 'string',
- ],
- 'dutyUserId' => [
- 'description' => '',
- 'example' => '231',
- 'format' => 'int64',
- 'title' => '故障责任人id',
- 'type' => 'integer',
- ],
- 'replayDutyUserId' => [
- 'description' => '',
- 'example' => '23123',
- 'format' => 'int64',
- 'title' => '复盘负责人id',
- 'type' => 'integer',
- ],
- 'replayDutyUserPhone' => [
- 'description' => '',
- 'example' => '1308787****',
- 'title' => '复盘负责人手机号',
- 'type' => 'string',
- ],
- 'dutyDepartmentId' => [
- 'description' => '',
- 'example' => '12312',
- 'title' => '故障责任部门',
- 'type' => 'string',
- ],
- 'dutyUserName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '故障责任人名称',
- 'type' => 'string',
- ],
- 'dutyUserPhone' => [
- 'description' => '',
- 'example' => '13098898****',
- 'title' => '故障责任人手机号',
- 'type' => 'string',
- ],
- 'replayDutyUserName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '复盘负责人名称',
- 'type' => 'string',
- ],
- 'remark' => [
- 'description' => '',
- 'example' => '',
- 'title' => '备注',
- 'type' => 'string',
- ],
- 'isManual' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '是否手动',
- 'type' => 'boolean',
- ],
- 'dutyDepartmentName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '故障责任部门名称',
- 'type' => 'string',
- ],
- 'measureList' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'measureId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'title' => '改进措施id 用于删除或更新',
- 'type' => 'integer',
- ],
- 'type' => [
- 'description' => '',
- 'example' => '2',
- 'format' => 'int64',
- 'title' => '措施类型',
- 'type' => 'integer',
- ],
- 'content' => [
- 'description' => '',
- 'example' => '',
- 'title' => '措施内容',
- 'type' => 'string',
- ],
- 'checkStandard' => [
- 'description' => '',
- 'example' => '',
- 'title' => '验收标准',
- 'type' => 'string',
- ],
- 'checkUserId' => [
- 'description' => '',
- 'example' => '12',
- 'format' => 'int64',
- 'title' => '验收人id',
- 'type' => 'integer',
- ],
- 'checkUserName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '验收人名称',
- 'type' => 'string',
- ],
- 'directorName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '负责人名称',
- 'type' => 'string',
- ],
- 'stalkerName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '跟踪人名称',
- 'type' => 'string',
- ],
- 'planFinishTime' => [
- 'description' => '',
- 'example' => '2021-05-01 00:00:00',
- 'title' => '计划完成时间',
- 'type' => 'string',
- ],
- 'directorId' => [
- 'description' => '',
- 'example' => '212',
- 'format' => 'int64',
- 'title' => '负责人id',
- 'type' => 'integer',
- ],
- 'stalkerId' => [
- 'description' => '',
- 'example' => '3121',
- 'format' => 'int64',
- 'title' => '跟踪人id',
- 'type' => 'integer',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'UNIMPROVED',
- 'title' => 'UNIMPROVED 状态 IMPROVED 改进 2 未改进UNIMPROVED',
- 'type' => 'string',
- ],
- 'checkUserIsValid' => [
- 'title' => '验收人是否失效,0失效1生效',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'directorIsValid' => [
- 'title' => '负责人是否失效,0失效1生效',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'stalkerIsValid' => [
- 'title' => '跟踪人是否失效,0失效1生效',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => 'Problem list.',
+ 'items' => [
+ 'properties' => [
+ 'problemId' => ['description' => 'Problem ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'isManual' => ['description' => 'Is manual.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'isUpgrade' => ['description' => 'Is upgrade.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'incidentId' => ['description' => 'Event ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2020-09-08 15:59:59', 'title' => ''],
+ 'updateTime' => ['description' => 'Modification time.', 'type' => 'string', 'example' => '2020-09-08 15:59:59', 'title' => ''],
+ 'problemNumber' => ['description' => 'Problem number.', 'type' => 'string', 'example' => 'P34438300000001116258132229577472', 'title' => ''],
+ 'problemName' => ['description' => 'Problem name.', 'type' => 'string', 'example' => '故障', 'title' => ''],
+ 'problemStatus' => ['description' => 'Problem status:'."\n"
+ ."\n"
+ .'- HANDLING: In progress.'."\n"
+ ."\n"
+ .'- RECOVERED: Recovered.'."\n"
+ ."\n"
+ .'- REPLAYING: Reviewing.'."\n"
+ ."\n"
+ .'- REPLAYED: Reviewed.'."\n"
+ ."\n"
+ .'- CANCEL: Canceled.', 'type' => 'string', 'example' => 'HANDLING', 'title' => ''],
+ 'problemLevel' => ['description' => 'Problem levels in descending order:'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'string', 'example' => 'P1', 'title' => ''],
+ 'discoverTime' => ['description' => 'Discovery time.', 'type' => 'string', 'example' => '2020-09-08 15:59:59', 'title' => ''],
+ 'recoveryTime' => ['description' => 'Recovery time.', 'type' => 'string', 'example' => '2020-09-08 15:59:59', 'title' => ''],
+ 'relatedServiceId' => ['description' => 'Associated service ID.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'serviceName' => ['description' => 'Associated service name.', 'type' => 'string', 'example' => '服务1', 'title' => ''],
+ 'affectServices' => [
+ 'description' => 'Affected services.',
+ 'items' => [
+ 'properties' => [
+ 'serviceId' => ['description' => 'Affected service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'serviceDescription' => ['description' => 'Service description.', 'type' => 'string', 'example' => '服务描述', 'title' => ''],
+ 'serviceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => '冲上云霄', 'title' => ''],
+ 'updateTime' => ['description' => 'Modification time.', 'type' => 'string', 'example' => '2020-09-08 15:59:59', 'title' => ''],
],
+ 'type' => 'object',
+ 'description' => 'Affected service.',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'object',
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => '改进措施列表',
- 'type' => 'array',
- ],
- 'customProblemReason' => [
- 'title' => '自定义故障原因',
- 'type' => 'string',
- ],
- 'replayDutyUserIsValid' => [
- 'title' => '复盘负责人生效状态,0失效1生效',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'dutyUserIsValid' => [
- 'title' => '故障责任人生效状态,0失效1生效',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'mainHandlerId' => ['description' => 'Primary handler ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'mainHandlerName' => ['description' => 'Primary handler name.', 'type' => 'string', 'example' => '王宇', 'title' => ''],
+ 'cancelTime' => ['description' => 'Cancellation time.', 'type' => 'string', 'example' => '2020-09-08 15:59:59', 'title' => ''],
+ 'finishTime' => ['description' => 'Completion time.', 'type' => 'string', 'example' => '2020-09-08 15:59:59', 'title' => ''],
+ 'replayTime' => ['description' => 'Review time.', 'type' => 'string', 'example' => '2020-09-08 15:59:59', 'title' => ''],
+ 'serviceDeletedType' => ['title' => 'Service Deleted Field', 'description' => 'Service deletion field.', 'type' => 'integer', 'format' => 'int32', 'example' => ''],
+ 'mainHandlerIsValid' => ['description' => 'Primary handler ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
],
+ 'type' => 'object',
+ 'description' => 'Problem list.',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'object',
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
+ 'pageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'totalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": [\\n {\\n \\"problemId\\": 1,\\n \\"isManual\\": true,\\n \\"isUpgrade\\": true,\\n \\"incidentId\\": 10000,\\n \\"createTime\\": \\"2020-09-08 15:59:59\\",\\n \\"updateTime\\": \\"2020-09-08 15:59:59\\",\\n \\"problemNumber\\": \\"P34438300000001116258132229577472\\",\\n \\"problemName\\": \\"故障\\",\\n \\"problemStatus\\": \\"HANDLING\\",\\n \\"problemLevel\\": \\"P1\\",\\n \\"discoverTime\\": \\"2020-09-08 15:59:59\\",\\n \\"recoveryTime\\": \\"2020-09-08 15:59:59\\",\\n \\"relatedServiceId\\": \\"1\\",\\n \\"serviceName\\": \\"服务1\\",\\n \\"affectServices\\": [\\n {\\n \\"serviceId\\": 100,\\n \\"serviceDescription\\": \\"服务描述\\",\\n \\"serviceName\\": \\"冲上云霄\\",\\n \\"updateTime\\": \\"2020-09-08 15:59:59\\"\\n }\\n ],\\n \\"mainHandlerId\\": 100,\\n \\"mainHandlerName\\": \\"王宇\\",\\n \\"cancelTime\\": \\"2020-09-08 15:59:59\\",\\n \\"finishTime\\": \\"2020-09-08 15:59:59\\",\\n \\"replayTime\\": \\"2020-09-08 15:59:59\\",\\n \\"serviceDeletedType\\": 0,\\n \\"mainHandlerIsValid\\": 1\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 100\\n}","type":"json"}]',
+ 'title' => 'Query fault List',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListProblems',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3811\\",\\n \\"data\\": {\\n \\"problemId\\": \\"231231\\",\\n \\"problemReason\\": \\"故障的原因\\",\\n \\"recentActivity\\": \\"2\\",\\n \\"injectionMode\\": \\"3\\",\\n \\"recoveryMode\\": \\"2\\",\\n \\"discoverSource\\": \\"1\\",\\n \\"userReport\\": 1,\\n \\"monitorSourceName\\": \\"Zabbix\\",\\n \\"relationChanges\\": \\"关联变更\\",\\n \\"dutyUserId\\": 231,\\n \\"replayDutyUserId\\": 23123,\\n \\"replayDutyUserPhone\\": \\"1308787****\\",\\n \\"dutyDepartmentId\\": \\"12312\\",\\n \\"dutyUserName\\": \\"小明\\",\\n \\"dutyUserPhone\\": \\"13098898****\\",\\n \\"replayDutyUserName\\": \\"小花\\",\\n \\"remark\\": \\"备注\\",\\n \\"isManual\\": true,\\n \\"dutyDepartmentName\\": \\"服务组B\\",\\n \\"measureList\\": [\\n {\\n \\"measureId\\": 12312,\\n \\"type\\": 2,\\n \\"content\\": \\"内容A\\",\\n \\"checkStandard\\": \\"验收标准A\\",\\n \\"checkUserId\\": 12,\\n \\"checkUserName\\": \\"小军\\",\\n \\"directorName\\": \\"小张\\",\\n \\"stalkerName\\": \\"小李\\",\\n \\"planFinishTime\\": \\"2021-05-01 00:00:00\\",\\n \\"directorId\\": 212,\\n \\"stalkerId\\": 3121,\\n \\"status\\": \\"UNIMPROVED\\",\\n \\"checkUserIsValid\\": 1,\\n \\"directorIsValid\\": 1,\\n \\"stalkerIsValid\\": 1\\n }\\n ],\\n \\"customProblemReason\\": \\"1\\",\\n \\"replayDutyUserIsValid\\": 1,\\n \\"dutyUserIsValid\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetProblemImprovementResponse>\\n <requestId>4361a0e1-6747-4834-96ce-0c4840fd3811</requestId>\\n <data>\\n <problemId>231231</problemId>\\n <problemReason>故障的原因</problemReason>\\n <recentActivity>2</recentActivity>\\n <injectionMode>3</injectionMode>\\n <recoveryMode>2</recoveryMode>\\n <discoverSource>1</discoverSource>\\n <userReport>1</userReport>\\n <monitorSourceName>Zabbix</monitorSourceName>\\n <relationChanges>关联变更</relationChanges>\\n <dutyUserId>231</dutyUserId>\\n <replayDutyUserId>23123</replayDutyUserId>\\n <dutyDepartmentId>12312</dutyDepartmentId>\\n <dutyUserName>小明</dutyUserName>\\n <replayDutyUserName>小花</replayDutyUserName>\\n <remark>备注</remark>\\n <isManual>true</isManual>\\n <dutyDepartmentName>服务组B</dutyDepartmentName>\\n <measureList>\\n <measureId>12312</measureId>\\n <type>2</type>\\n <content>内容A</content>\\n <checkStandard>验收标准A</checkStandard>\\n <checkUserId>12</checkUserId>\\n <checkUserName>小军</checkUserName>\\n <directorName>小张</directorName>\\n <stalkerName>小李</stalkerName>\\n <planFinishTime>2021-05-01 00:00:00</planFinishTime>\\n <directorId>212</directorId>\\n <stalkerId>3121</stalkerId>\\n <status>UNIMPROVED</status>\\n </measureList>\\n </data>\\n</GetProblemImprovementResponse>","errorExample":""}]',
- ],
- 'DeleteProblemMeasure' => [
- 'summary' => '改进措施删除',
- 'path' => '/problem/improvement/measure/delete',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProblems'],
+ ],
],
+ ],
+ 'ListRouteRules' => [
+ 'summary' => 'Query the list of rules.',
+ 'path' => '/routeRule/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZB7ZAW',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempJRUU6V'],
],
'parameters' => [
[
@@ -18204,94 +12593,151 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'measureId' => [
- 'description' => '',
- 'example' => '1213',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障改成措施id',
- 'type' => 'integer',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '2131',
- 'required' => false,
- 'title' => '故障Id',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
- ],
+ 'ruleName' => ['description' => 'Rule name.', 'type' => 'string', 'format' => 'byte', 'example' => '规则', 'title' => '', 'required' => false],
+ 'serviceName' => ['description' => 'Service name.', 'type' => 'string', 'format' => 'byte', 'example' => '服务', 'title' => '', 'required' => false],
+ 'pageNumber' => ['description' => 'Paging page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ 'pageSize' => ['description' => 'Paging size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'An idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
+ 'routeType' => ['description' => 'Routing type:'."\n"
+ ."\n"
+ .'- 0: Triggering event.'."\n"
+ ."\n"
+ .'- 1: Trigger alerts only.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => '', 'required' => false],
+ 'notFilterRouteRuleDeleted' => ['description' => 'Do not filter deleted routing rules.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'],
],
'required' => false,
- 'title' => 'A short description of struct',
+ 'title' => '',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13B-A225-2C88188E8A43', 'title' => ''],
+ 'data' => [
+ 'description' => 'List of rules.',
+ 'items' => [
+ 'properties' => [
+ 'routeRuleId' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ 'tenantRamId' => ['description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1344383', 'title' => ''],
+ 'ruleName' => ['description' => 'Rule name.', 'type' => 'string', 'example' => '规则名字', 'title' => ''],
+ 'relatedServiceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => '关联服务名字', 'title' => ''],
+ 'timeWindow' => ['description' => 'Time window.', 'type' => 'integer', 'format' => 'int64', 'example' => '时间窗口', 'title' => ''],
+ 'matchCount' => ['description' => 'Hit count.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'timeWindowUnit' => ['description' => 'Time unit:'."\n"
+ ."\n"
+ .'- MINUTE: Minutes.'."\n"
+ ."\n"
+ .'- SECOND: Seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => 'MINUTE', 'title' => ''],
+ 'relatedServiceId' => ['description' => 'Associated service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'routeType' => ['description' => 'Routing type:'."\n"
+ ."\n"
+ .'- INCIDENT: Triggering event.'."\n"
+ ."\n"
+ .'- ALERT: Trigger alerts only.', 'type' => 'string', 'example' => 'INCIDENT', 'title' => ''],
+ 'incidentLevel' => ['description' => 'Incident level (descending):'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'string', 'example' => 'P1', 'title' => ''],
+ 'assignObjectId' => ['description' => 'Incident assignment object ID: Service group ID or user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'assignObjectType' => ['description' => 'Incident assignment object type:'."\n"
+ ."\n"
+ .'- SERVICEGROUP: Service group.'."\n"
+ ."\n"
+ .'- USER: Single user.', 'type' => 'string', 'example' => 'SERVICEGROUP', 'title' => ''],
+ 'effection' => ['description' => 'Impact level:'."\n"
+ ."\n"
+ .'- LOW: Low impact.'."\n"
+ ."\n"
+ .'- HIGH: Critical.', 'type' => 'string', 'example' => 'LOW', 'title' => ''],
+ 'createTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2020-03-05 15:53:55', 'title' => ''],
+ 'updateTime' => ['description' => 'Modification time.', 'type' => 'string', 'example' => '2020-03-05 15:53:55', 'title' => ''],
+ 'enableStatus' => ['description' => 'Is enabled:'."\n"
+ ."\n"
+ .'- DISABLE: Disabled.'."\n"
+ ."\n"
+ .'- ENABLE: Enabled.', 'type' => 'string', 'example' => 'DISABLE', 'title' => ''],
+ 'monitorSourceNames' => ['description' => 'Monitoring source name.', 'type' => 'string', 'example' => 'zabbix', 'title' => ''],
+ 'relServiceDeleteType' => ['description' => 'Service deletion field.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'isValid' => ['description' => 'Is valid:'."\n"
+ ."\n"
+ .'- 0: Invalid.'."\n"
+ ."\n"
+ .'- 1: Valid.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ ],
+ 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'totalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'pageNumber' => ['description' => 'Paging page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'Paging size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13B-A225-2C88188E8A43\\",\\n \\"data\\": [\\n {\\n \\"routeRuleId\\": 10000,\\n \\"tenantRamId\\": 1344383,\\n \\"ruleName\\": \\"规则名字\\",\\n \\"relatedServiceName\\": \\"关联服务名字\\",\\n \\"timeWindow\\": 0,\\n \\"matchCount\\": 10,\\n \\"timeWindowUnit\\": 0,\\n \\"relatedServiceId\\": 1,\\n \\"routeType\\": \\"INCIDENT\\",\\n \\"incidentLevel\\": \\"P1\\",\\n \\"assignObjectId\\": 10,\\n \\"assignObjectType\\": \\"SERVICEGROUP\\",\\n \\"effection\\": \\"LOW\\",\\n \\"createTime\\": \\"2020-03-05 15:53:55\\",\\n \\"updateTime\\": \\"2020-03-05 15:53:55\\",\\n \\"enableStatus\\": \\"DISABLE\\",\\n \\"monitorSourceNames\\": \\"zabbix\\",\\n \\"relServiceDeleteType\\": 1,\\n \\"isValid\\": 1\\n }\\n ],\\n \\"totalCount\\": 10,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","type":"json"}]',
+ 'title' => '查询规则列表',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-07T11:52:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListRouteRules',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteProblemMeasureResponse>\\n <requestId>4361a0e1-6747-4834-96ce-0c4840fd3812</requestId>\\n</DeleteProblemMeasureResponse>","errorExample":""}]',
- ],
- 'DeleteProblemTimeline' => [
- 'summary' => '删除影响服务',
- 'path' => '/problem/process/timeline/delete',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRouteRules'],
+ ],
],
+ ],
+ 'ListRouteRulesByAssignWhoId' => [
+ 'summary' => 'Retrieves the routing rules for a specified assignment object.',
+ 'path' => '/routeRule/listByAssignWhoId',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp65LXE3',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempJRUU6V'],
],
'parameters' => [
[
@@ -18299,95 +12745,163 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'type' => 'object',
'properties' => [
- 'problemTimelineId' => [
- 'description' => '',
- 'example' => '11',
- 'format' => 'int64',
- 'required' => false,
- 'title' => 'ID',
- 'type' => 'integer',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '102',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
+ 'assignWhoId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'assignWhoType' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
],
- 'required' => false,
- 'title' => 'A short description of struct',
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'title' => 'Schema of Response ',
+ 'type' => 'object',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'Id of the request ', 'type' => 'string', 'description' => '', 'example' => ''],
+ 'data' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ruleName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'id' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'tenantRamId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 'title' => 'Schema of Response',
- 'type' => 'object',
+ 'description' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListRouteRulesByAssignWhoId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteProblemTimelineResponse>\\n <requestId>10REQUES-AC5C-4B59-BE11-378F117A6A88</requestId>\\n</DeleteProblemTimelineResponse>","errorExample":""}]',
- ],
- 'ListProblemTimeLines' => [
- 'summary' => '查询故障操作时间线列表',
- 'path' => '/problem/detail/timeLines',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"data\\": [\\n {\\n \\"ruleName\\": \\"\\",\\n \\"id\\": 0,\\n \\"tenantRamId\\": 0\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListRouteRulesByAssignWhoId',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRouteRulesByAssignWhoId'],
+ ],
],
+ ],
+ 'ListRouteRulesByService' => [
+ 'summary' => 'Queries the routing rules for a service.',
+ 'path' => '/routeRule/listByService',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgempJRUU6V'],
+ ],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Request body.',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd381A'],
+ 'data' => [
+ 'description' => 'The returned data.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A list of rules.',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60852564'],
+ 'ruleName' => ['description' => 'The name of the rule.', 'type' => 'string', 'title' => '', 'example' => '规则1'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'totalCount' => ['description' => 'The total number of routing rules.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '103'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd381A\\",\\n \\"data\\": [\\n {\\n \\"id\\": 60852564,\\n \\"ruleName\\": \\"规则1\\"\\n }\\n ],\\n \\"totalCount\\": 103\\n}","type":"json"}]',
+ 'title' => 'Query Stream Rules by Service ID',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-07T11:53:05.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListRouteRulesByService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRouteRulesByService'],
+ ],
],
+ ],
+ 'ListServiceGroupMonitorSourceTemplates' => [
+ 'summary' => 'Lists message templates for a service group.',
+ 'path' => '/services/group/listServiceGroupMonitorSourceTemplates',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZ5UD4L',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempE3KJ0U'],
],
'parameters' => [
[
@@ -18395,168 +12909,677 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '10002010',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'xxxx', 'title' => '', 'required' => false],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'xxxxx', 'title' => '', 'required' => false],
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'xxxx'],
'data' => [
- 'description' => '',
+ 'description' => 'Template list.',
'items' => [
- 'description' => 'object',
+ 'description' => 'Template list.',
'properties' => [
- 'createTime' => [
- 'description' => '',
- 'example' => '2020-08-08 15:38:38',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'keyNode' => [
- 'description' => '',
- 'example' => 'PROBLEM_INJECTION,PROBLEM_HAPPEN',
- 'title' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
- 'type' => 'string',
- ],
- 'content' => [
- 'description' => '',
- 'example' => '内容',
- 'title' => '内容',
- 'type' => 'string',
- ],
- 'isKey' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '是否是关键字 true是 false不是 默认 false',
- 'type' => 'boolean',
- ],
- 'updateTime' => [
- 'description' => '',
- 'example' => '2020-08-08 15:38:38',
- 'title' => '修改时间',
- 'type' => 'string',
- ],
- 'time' => [
- 'description' => '',
- 'example' => '2020-08-08 15:38:38',
- 'title' => '展示时间',
- 'type' => 'string',
- ],
- 'problemTimelineId' => [
- 'description' => '',
- 'example' => '10000',
- 'format' => 'int64',
- 'title' => '时间线id',
- 'type' => 'integer',
- ],
- 'usersInContent' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'userId' => [
- 'description' => '',
- 'example' => '232',
- 'format' => 'int64',
- 'title' => '用户id',
- 'type' => 'integer',
- ],
- 'username' => [
- 'description' => '',
- 'example' => '张老萨',
- 'title' => '用户名',
- 'type' => 'string',
- ],
- 'isValid' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '内容中的用户信息',
+ 'monitorSourceId' => ['description' => 'Monitoring source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'templateId' => ['description' => 'Message template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'monitorSourceName' => ['description' => 'Monitoring alert source name.', 'type' => 'string', 'example' => 'zabbix', 'title' => ''],
+ 'templateContent' => ['description' => 'Template content.', 'type' => 'string', 'title' => '', 'example' => '""'],
+ 'fields' => [
+ 'description' => 'Fields.',
+ 'items' => ['description' => 'Field.', 'type' => 'string', 'example' => '字段', 'title' => ''],
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => 'data',
'type' => 'array',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx\\",\\n \\"data\\": [\\n {\\n \\"monitorSourceId\\": 1000,\\n \\"templateId\\": 1000,\\n \\"monitorSourceName\\": \\"zabbix\\",\\n \\"templateContent\\": \\"\\\\\\"\\\\\\"\\",\\n \\"fields\\": [\\n \\"字段\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query the message template list of a service group',
+ 'requestParamsDescription' => '{"serviceGroupId":"180030020"}',
+ 'responseParamsDescription' => '{'."\n"
+ ."\n"
+ .'```'."\n"
+ .'"requestId": "gdgsdgsggsdg",'."\n"
+ .'"data": ['."\n"
+ .' {'."\n"
+ .' "templateId": 3645786,'."\n"
+ .' "monitorSourceId": 23463,'."\n"
+ .' "monitorSourceName": "Standard Integration",'."\n"
+ .' "templateContent": "None",'."\n"
+ .' "fields": ['."\n"
+ .' "summary",'."\n"
+ .' "priority",'."\n"
+ .' "name",'."\n"
+ .' "timestamp",'."\n"
+ .' "region",'."\n"
+ .' "source",'."\n"
+ .' "application",'."\n"
+ .' "group",'."\n"
+ .' "class",'."\n"
+ .' "tags",'."\n"
+ .' "details"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645778,'."\n"
+ .' "monitorSourceId": 23465,'."\n"
+ .' "monitorSourceName": "Zabbix",'."\n"
+ .' "templateContent": "SSSSSSS",'."\n"
+ .' "fields": ['."\n"
+ .' "alarmContent",'."\n"
+ .' "eventId",'."\n"
+ .' "ip",'."\n"
+ .' "itemValue",'."\n"
+ .' "alarmName",'."\n"
+ .' "entityId",'."\n"
+ .' "eventType",'."\n"
+ .' "priority",'."\n"
+ .' "itemName",'."\n"
+ .' "entityName",'."\n"
+ .' "service",'."\n"
+ .' "host",'."\n"
+ .' "agentVersion"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645790,'."\n"
+ .' "monitorSourceId": 23466,'."\n"
+ .' "monitorSourceName": "Prometheus",'."\n"
+ .' "templateContent": "Alert time: ${startsAt}\\\\n Alert target: ${labels.instance}\\\\n Alert name: ${labels.alertname}\\\\n Alert content: ${description}",'."\n"
+ .' "fields": ['."\n"
+ .' "alerts[].generatorURL",'."\n"
+ .' "alerts[].fingerprint",'."\n"
+ .' "alerts[].annotations.summary",'."\n"
+ .' "alerts[].annotations.description",'."\n"
+ .' "alerts[].startsAt",'."\n"
+ .' "alerts[].endsAt",'."\n"
+ .' "alerts[].status",'."\n"
+ .' "alerts[].labels.severity",'."\n"
+ .' "alerts[].labels.instance",'."\n"
+ .' "alerts[].labels.alertname",'."\n"
+ .' "alerts[].labels.job",'."\n"
+ .' "commonLabels.severity",'."\n"
+ .' "commonLabels.instance",'."\n"
+ .' "commonLabels.alertname",'."\n"
+ .' "externalURL",'."\n"
+ .' "groupLabels.alertname",'."\n"
+ .' "receiver",'."\n"
+ .' "truncatedAlerts",'."\n"
+ .' "version",'."\n"
+ .' "commonAnnotations.summary",'."\n"
+ .' "commonAnnotations.description",'."\n"
+ .' "groupKey",'."\n"
+ .' "status",'."\n"
+ .' "commonLabels.job"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645795,'."\n"
+ .' "monitorSourceId": 23467,'."\n"
+ .' "monitorSourceName": "Nagios",'."\n"
+ .' "templateContent": "Alert content: ${content}",'."\n"
+ .' "fields": ['."\n"
+ .' "notifyActionType",'."\n"
+ .' "hostName",'."\n"
+ .' "hostState",'."\n"
+ .' "content"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645785,'."\n"
+ .' "monitorSourceId": 23468,'."\n"
+ .' "monitorSourceName": "Cloud Monitor",'."\n"
+ .' "templateContent": "Alert end time: ${timestamp}\\\\n Alert target: ${dimensions}\\\\n Alert name: ${alertName}\\\\n Alert level: ${triggerLevel}\\\\n Alert content: Current value ${curValue}. Region: ${regionId}. Application group name: ${productGroupName}",'."\n"
+ .' "fields": ['."\n"
+ .' "alertName",'."\n"
+ .' "alertState",'."\n"
+ .' "curValue",'."\n"
+ .' "dimensions",'."\n"
+ .' "expression",'."\n"
+ .' "instanceName",'."\n"
+ .' "lastTime",'."\n"
+ .' "metricName",'."\n"
+ .' "metricProject",'."\n"
+ .' "namespace",'."\n"
+ .' "preTriggerLevel",'."\n"
+ .' "productGroupName",'."\n"
+ .' "rawMetricName",'."\n"
+ .' "regionId",'."\n"
+ .' "regionName",'."\n"
+ .' "ruleId",'."\n"
+ .' "signature",'."\n"
+ .' "timestamp",'."\n"
+ .' "triggerLevel",'."\n"
+ .' "userId"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645787,'."\n"
+ .' "monitorSourceId": 23469,'."\n"
+ .' "monitorSourceName": "SLS",'."\n"
+ .' "templateContent": "Alert time: ${alert_time}\\\\n Alert target: ${project}\\\\n Alert name: ${alert_name}\\\\n Alert level: ${severity}\\\\n Alert content: Logstore: ${logstore}. Triggered data: ${fire_results_as_kv}. Region: ${region}",'."\n"
+ .' "fields": ['."\n"
+ .' "aliuid",'."\n"
+ .' "alert_instance_id",'."\n"
+ .' "alert_id",'."\n"
+ .' "alert_name",'."\n"
+ .' "region",'."\n"
+ .' "project",'."\n"
+ .' "alert_time",'."\n"
+ .' "alert_url",'."\n"
+ .' "query_url",'."\n"
+ .' "fire_time",'."\n"
+ .' "resolve_time",'."\n"
+ .' "status",'."\n"
+ .' "fire_results_count",'."\n"
+ .' "fire_results_as_kv",'."\n"
+ .' "labels",'."\n"
+ .' "annotations_title",'."\n"
+ .' "annotations_desc",'."\n"
+ .' "severity",'."\n"
+ .' "logstore",'."\n"
+ .' "fire_results"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645791,'."\n"
+ .' "monitorSourceId": 23470,'."\n"
+ .' "monitorSourceName": "ARMS",'."\n"
+ .' "templateContent": "Alert content: ${content}",'."\n"
+ .' "fields": ['."\n"
+ .' "content"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": null,'."\n"
+ .' "monitorSourceId": 23472,'."\n"
+ .' "monitorSourceName": "Tencent Cloud Cloud Monitor",'."\n"
+ .' "templateContent": null,'."\n"
+ .' "fields": ['."\n"
+ .' "recoverTime",'."\n"
+ .' "alarmStatus",'."\n"
+ .' "alarmType",'."\n"
+ .' "firstOccurTime",'."\n"
+ .' "durationTime",'."\n"
+ .' "sessionId",'."\n"
+ .' "alarmObjInfo.namespace",'."\n"
+ .' "alarmObjInfo.region",'."\n"
+ .' "alarmObjInfo.dimensions.unInstanceId",'."\n"
+ .' "alarmObjInfo.dimensions.objId",'."\n"
+ .' "alarmObjInfo.dimensions.objName",'."\n"
+ .' "alarmObjInfo.dimensions.deviceName",'."\n"
+ .' "alarmPolicyInfo.policyId",'."\n"
+ .' "alarmPolicyInfo.policyName",'."\n"
+ .' "alarmPolicyInfo.policyType",'."\n"
+ .' "alarmPolicyInfo.conditions.periodNum",'."\n"
+ .' "alarmPolicyInfo.conditions.unit",'."\n"
+ .' "alarmPolicyInfo.conditions.period",'."\n"
+ .' "alarmPolicyInfo.conditions.metricName",'."\n"
+ .' "alarmPolicyInfo.conditions.alarmNotifyPeriod",'."\n"
+ .' "alarmPolicyInfo.conditions.calcType",'."\n"
+ .' "alarmPolicyInfo.conditions.metricShowName",'."\n"
+ .' "alarmPolicyInfo.conditions.alarmNotifyType",'."\n"
+ .' "alarmPolicyInfo.conditions.currentValue",'."\n"
+ .' "alarmPolicyInfo.conditions.calcValue",'."\n"
+ .' "alarmPolicyInfo.policyTypeCName",'."\n"
+ .' "alarmPolicyInfo.policyTypeEname",'."\n"
+ .' "alarmObjInfo.dimensions.appid",'."\n"
+ .' "alarmObjInfo.dimensions.instanceid",'."\n"
+ .' "alarmObjInfo.dimensions.rnodeid",'."\n"
+ .' "alarmObjInfo.dimensions.AppId",'."\n"
+ .' "alarmObjInfo.dimensions.InstanceId",'."\n"
+ .' "alarmObjInfo.dimensions.pnodeid",'."\n"
+ .' "alarmObjInfo.dimensions.protocol",'."\n"
+ .' "alarmObjInfo.dimensions.vip",'."\n"
+ .' "alarmObjInfo.dimensions.port",'."\n"
+ .' "alarmObjInfo.dimensions.vport",'."\n"
+ .' "alarmObjInfo.dimensions.protocol",'."\n"
+ .' "alarmObjInfo.dimensions.vpcId",'."\n"
+ .' "alarmObjInfo.dimensions.lanIp",'."\n"
+ .' "alarmObjInfo.dimensions.loadBalancerPort",'."\n"
+ .' "alarmObjInfo.dimensions.uid",'."\n"
+ .' "alarmObjInfo.dimensions.clusterid",'."\n"
+ .' "alarmObjInfo.dimensions.target",'."\n"
+ .' "alarmObjInfo.dimensions.insttype",'."\n"
+ .' "alarmObjInfo.dimensions.ClusterId",'."\n"
+ .' "alarmObjInfo.dimensions.TableInstanceId",'."\n"
+ .' "alarmObjInfo.dimensions.cluster_name",'."\n"
+ .' "alarmObjInfo.dimensions.is_master",'."\n"
+ .' "alarmObjInfo.dimensions.set_name",'."\n"
+ .' "alarmObjInfo.dimensions.type",'."\n"
+ .' "alarmObjInfo.dimensions.zk_name",'."\n"
+ .' "alarmObjInfo.dimensions.function_name",'."\n"
+ .' "alarmObjInfo.dimensions.namespace",'."\n"
+ .' "alarmObjInfo.dimensions.version",'."\n"
+ .' "alarmObjInfo.dimensions.bucket",'."\n"
+ .' "alarmObjInfo.dimensions.uniq_nat_id",'."\n"
+ .' "alarmObjInfo.dimensions.vpnconnid",'."\n"
+ .' "alarmObjInfo.dimensions.directconnectgatewayid",'."\n"
+ .' "alarmObjInfo.dimensions.peeringconnectionid",'."\n"
+ .' "alarmObjInfo.dimensions.netdetectid",'."\n"
+ .' "alarmObjInfo.dimensions.__region__",'."\n"
+ .' "alarmObjInfo.dimensions.netgroup",'."\n"
+ .' "alarmObjInfo.dimensions.projectid",'."\n"
+ .' "alarmObjInfo.dimensions.domain",'."\n"
+ .' "alarmObjInfo.dimensions.topicid",'."\n"
+ .' "alarmObjInfo.dimensions.instance_id",'."\n"
+ .' "alarmObjInfo.dimensions.consumer_group",'."\n"
+ .' "alarmObjInfo.dimensions.topicname",'."\n"
+ .' "alarmObjInfo.dimensions.partition",'."\n"
+ .' "alarmObjInfo.dimensions.FileSystemId",'."\n"
+ .' "alarmObjInfo.dimensions.directconnectid",'."\n"
+ .' "alarmObjInfo.dimensions.directconnectconnid",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.deviceLanIp",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.deviceWanIp",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.uniqVpcId",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.IP",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.PeeringConnectionName",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.QosBandwidth",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.VpcName",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.VpcId",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.VpnGatewayName",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.InternetMaxBandwidthOut",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.ar",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.bandwidth",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.circuitNumber",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.dcType",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.connLocalIp",'."\n"
+ .' "alarmObjInfo.dimensions.objDetail.connPeerIp"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": null,'."\n"
+ .' "monitorSourceId": 23473,'."\n"
+ .' "monitorSourceName": "Huawei Cloud Cloud Monitor",'."\n"
+ .' "templateContent": null,'."\n"
+ .' "fields": ['."\n"
+ .' "message_type",'."\n"
+ .' "alarm_id",'."\n"
+ .' "alarm_name",'."\n"
+ .' "alarm_status",'."\n"
+ .' "time",'."\n"
+ .' "namespace",'."\n"
+ .' "metric_name",'."\n"
+ .' "dimension",'."\n"
+ .' "period",'."\n"
+ .' "filter",'."\n"
+ .' "comparison_operator",'."\n"
+ .' "value",'."\n"
+ .' "unit",'."\n"
+ .' "count",'."\n"
+ .' "alarmValue[].time",'."\n"
+ .' "alarmValue[].value",'."\n"
+ .' "sms_content",'."\n"
+ .' "template_variable.AccountName",'."\n"
+ .' "template_variable.Namespace",'."\n"
+ .' "template_variable.DimensionName",'."\n"
+ .' "template_variable.ResourceName",'."\n"
+ .' "template_variable.MetricName",'."\n"
+ .' "template_variable.IsAlarm",'."\n"
+ .' "template_variable.IsCycleTrigger",'."\n"
+ .' "template_variable.AlarmLevel",'."\n"
+ .' "template_variable.Region",'."\n"
+ .' "template_variable.ResourceId",'."\n"
+ .' "template_variable.PrivateIp",'."\n"
+ .' "template_variable.AlarmRule",'."\n"
+ .' "template_variable.CurrentData",'."\n"
+ .' "template_variable.AlarmTime",'."\n"
+ .' "template_variable.DataPointTime[]",'."\n"
+ .' "template_variable.AlarmRuleName",'."\n"
+ .' "template_variable.AlarmId",'."\n"
+ .' "template_variable.AlarmDesc",'."\n"
+ .' "template_variable.MonitoringRange",'."\n"
+ .' "template_variable.IsOriginalValue",'."\n"
+ .' "template_variable.Period",'."\n"
+ .' "template_variable.Filter",'."\n"
+ .' "template_variable.ComparisonOperator",'."\n"
+ .' "template_variable.Value",'."\n"
+ .' "template_variable.Unit",'."\n"
+ .' "template_variable.Count",'."\n"
+ .' "template_variable.EventContent",'."\n"
+ .' "template_variable.Link",'."\n"
+ .' "template_variable.IsIEC",'."\n"
+ .' "template_variable.DataPoint"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645788,'."\n"
+ .' "monitorSourceId": 23474,'."\n"
+ .' "monitorSourceName": "Cacti",'."\n"
+ .' "templateContent": "Alert content: ${subject}",'."\n"
+ .' "fields": ['."\n"
+ .' "subject"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645796,'."\n"
+ .' "monitorSourceId": 23475,'."\n"
+ .' "monitorSourceName": "SkyWalking",'."\n"
+ .' "templateContent": "Alert content: ${content}",'."\n"
+ .' "fields": ['."\n"
+ .' "content[].scopeId",'."\n"
+ .' "content[].scope",'."\n"
+ .' "content[].name",'."\n"
+ .' "content[].id0",'."\n"
+ .' "content[].id1",'."\n"
+ .' "content[].ruleName",'."\n"
+ .' "content[].alarmMessage",'."\n"
+ .' "content[].startTime"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": null,'."\n"
+ .' "monitorSourceId": 23476,'."\n"
+ .' "monitorSourceName": "Open-Falcon",'."\n"
+ .' "templateContent": null,'."\n"
+ .' "fields": ['."\n"
+ .' "step",'."\n"
+ .' "priority",'."\n"
+ .' "status",'."\n"
+ .' "stra_id",'."\n"
+ .' "metric",'."\n"
+ .' "time",'."\n"
+ .' "tpl_id",'."\n"
+ .' "exp_id",'."\n"
+ .' "left_value",'."\n"
+ .' "tags",'."\n"
+ .' "endpoint"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": null,'."\n"
+ .' "monitorSourceId": 23477,'."\n"
+ .' "monitorSourceName": "EventBridge",'."\n"
+ .' "templateContent": null,'."\n"
+ .' "fields": ['."\n"
+ .' "datacontenttype",'."\n"
+ .' "aliyunaccountid",'."\n"
+ .' "subject",'."\n"
+ .' "aliyunoriginalaccountid",'."\n"
+ .' "source",'."\n"
+ .' "type",'."\n"
+ .' "aliyunpublishtime",'."\n"
+ .' "specversion",'."\n"
+ .' "aliyuneventbusname",'."\n"
+ .' "id",'."\n"
+ .' "time",'."\n"
+ .' "aliyunregionid",'."\n"
+ .' "aliyunpublishaddr",'."\n"
+ .' "data",'."\n"
+ .' "data.resourceId",'."\n"
+ .' "data.publicIpAddress",'."\n"
+ .' "data.instanceName",'."\n"
+ .' "data.state",'."\n"
+ .' "data.privateIpAddress",'."\n"
+ .' "data.resourceType",'."\n"
+ .' "data.snapshotId",'."\n"
+ .' "data.snapshotType",'."\n"
+ .' "data.snapshotName",'."\n"
+ .' "data.diskId"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645793,'."\n"
+ .' "monitorSourceId": 23478,'."\n"
+ .' "monitorSourceName": "Grafana",'."\n"
+ .' "templateContent": "Alert name: ${ruleName}\\\\n Alert content: Panel ID: ${panelId}. Dashboard ID: ${dashboardId}. Metric: ${evalMatches.metric}. Current value: ${evalMatches.value}",'."\n"
+ .' "fields": ['."\n"
+ .' "panelId",'."\n"
+ .' "dashboardId",'."\n"
+ .' "ruleName",'."\n"
+ .' "state",'."\n"
+ .' "ruleId",'."\n"
+ .' "title",'."\n"
+ .' "ruleUrl",'."\n"
+ .' "orgId",'."\n"
+ .' "evalMatches[].metric",'."\n"
+ .' "evalMatches[].value",'."\n"
+ .' "evalMatches[].tags.instance",'."\n"
+ .' "evalMatches[].tags",'."\n"
+ .' "tags",'."\n"
+ .' "message",'."\n"
+ .' "imageUrl"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645784,'."\n"
+ .' "monitorSourceId": 23479,'."\n"
+ .' "monitorSourceName": "Managed Service for Prometheus",'."\n"
+ .' "templateContent": "Alert content: ${content}",'."\n"
+ .' "fields": ['."\n"
+ .' "content"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645789,'."\n"
+ .' "monitorSourceId": 23480,'."\n"
+ .' "monitorSourceName": "Legacy SLS",'."\n"
+ .' "templateContent": "Alert time: ${FireTime}\\\\n Alert target: ${Project}\\\\n Alert name: ${AlertDisplayName}\\\\n Alert content: Dashboard: ${Dashboard}. Triggered expression: ${RawCondition}",'."\n"
+ .' "fields": ['."\n"
+ .' "Aliuid",'."\n"
+ .' "Project",'."\n"
+ .' "AlertID",'."\n"
+ .' "AlertName",'."\n"
+ .' "AlertDisplayName",'."\n"
+ .' "Condition",'."\n"
+ .' "Aliuid",'."\n"
+ .' "RawCondition",'."\n"
+ .' "Dashboard",'."\n"
+ .' "DashboardUrl",'."\n"
+ .' "FireTime",'."\n"
+ .' "FullResultUrl"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645794,'."\n"
+ .' "monitorSourceId": 23481,'."\n"
+ .' "monitorSourceName": "Listen Cloud",'."\n"
+ .' "templateContent": "Alert time: ${beginTime}\\\\n Alert target: ${targetName}\\\\n Alert level: ${eventPriority}\\\\n Alert content: ${message}",'."\n"
+ .' "fields": ['."\n"
+ .' "eventTraceId",'."\n"
+ .' "targetName",'."\n"
+ .' "extra",'."\n"
+ .' "eventPriority",'."\n"
+ .' "threshold",'."\n"
+ .' "value",'."\n"
+ .' "beginTime",'."\n"
+ .' "endTime",'."\n"
+ .' "message",'."\n"
+ .' "sendTime"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": 3645792,'."\n"
+ .' "monitorSourceId": 23482,'."\n"
+ .' "monitorSourceName": "MonitorBao",'."\n"
+ .' "templateContent": "Alert time: ${fault_time}\\\\n Alert target: ${task_summary}\\\\n Alert name: ${task_name}\\\\n Alert level: ${message_type}\\\\n Alert content: ${content}",'."\n"
+ .' "fields": ['."\n"
+ .' "task_name",'."\n"
+ .' "message_status",'."\n"
+ .' "fault_time",'."\n"
+ .' "task_summary",'."\n"
+ .' "message_type",'."\n"
+ .' "task_id",'."\n"
+ .' "msg_id",'."\n"
+ .' "task_user_id",'."\n"
+ .' "task_type",'."\n"
+ .' "content",'."\n"
+ .' "message_detail",'."\n"
+ .' "message_detail.compare",'."\n"
+ .' "message_detail.unit",'."\n"
+ .' "message_detail.location_list_down",'."\n"
+ .' "message_detail.metric",'."\n"
+ .' "message_detail.location_num",'."\n"
+ .' "message_detail.value",'."\n"
+ .' "message_detail.location_type"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": null,'."\n"
+ .' "monitorSourceId": 23483,'."\n"
+ .' "monitorSourceName": "JD Cloud Cloud Monitor",'."\n"
+ .' "templateContent": null,'."\n"
+ .' "fields": ['."\n"
+ .' "resourceName",'."\n"
+ .' "threshold",'."\n"
+ .' "serviceCode",'."\n"
+ .' "currentValue",'."\n"
+ .' "requestId",'."\n"
+ .' "tags",'."\n"
+ .' "resourceId",'."\n"
+ .' "metric",'."\n"
+ .' "times",'."\n"
+ .' "alertTime",'."\n"
+ .' "region",'."\n"
+ .' "ipAddress"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": null,'."\n"
+ .' "monitorSourceId": 23484,'."\n"
+ .' "monitorSourceName": "Dynatrace",'."\n"
+ .' "templateContent": null,'."\n"
+ .' "fields": ['."\n"
+ .' "ProblemID",'."\n"
+ .' "ProblemSeverity",'."\n"
+ .' "PID",'."\n"
+ .' "ImpactedEntities",'."\n"
+ .' "ImpactedEntities[].type",'."\n"
+ .' "ImpactedEntities[].name",'."\n"
+ .' "ImpactedEntities[].entity",'."\n"
+ .' "ImpactedEntityNames",'."\n"
+ .' "ProblemURL",'."\n"
+ .' "ImpactedEntity",'."\n"
+ .' "ProblemDetailsText",'."\n"
+ .' "ProblemImpact",'."\n"
+ .' "ProblemTitle",'."\n"
+ .' "ProblemDetailsHTML",'."\n"
+ .' "State",'."\n"
+ .' "ProblemDetailsMarkdown",'."\n"
+ .' "Tags"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": null,'."\n"
+ .' "monitorSourceId": 23485,'."\n"
+ .' "monitorSourceName": "Grafana 8",'."\n"
+ .' "templateContent": null,'."\n"
+ .' "fields": ['."\n"
+ .' "commonLabels",'."\n"
+ .' "commonLabels.alertname",'."\n"
+ .' "commonLabels.tag",'."\n"
+ .' "externalURL",'."\n"
+ .' "groupLabels",'."\n"
+ .' "receiver",'."\n"
+ .' "title",'."\n"
+ .' "message",'."\n"
+ .' "version",'."\n"
+ .' "groupKey",'."\n"
+ .' "alerts",'."\n"
+ .' "alerts[].status",'."\n"
+ .' "alerts[].labels",'."\n"
+ .' "alerts[].labels.alertname",'."\n"
+ .' "alerts[].labels.tag",'."\n"
+ .' "alerts[].annotations",'."\n"
+ .' "alerts[].startsAt",'."\n"
+ .' "alerts[].endsAt",'."\n"
+ .' "alerts[].generatorURL",'."\n"
+ .' "alerts[].fingerprint",'."\n"
+ .' "alerts[].silenceURL",'."\n"
+ .' "alerts[].dashboardURL",'."\n"
+ .' "alerts[].panelURL",'."\n"
+ .' "alerts[].valueString",'."\n"
+ .' "truncatedAlerts",'."\n"
+ .' "state",'."\n"
+ .' "commonAnnotations",'."\n"
+ .' "status"'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "templateId": null,'."\n"
+ .' "monitorSourceId": 23486,'."\n"
+ .' "monitorSourceName": "Email Integration",'."\n"
+ .' "templateContent": null,'."\n"
+ .' "fields": ['."\n"
+ .' "FromAddress",'."\n"
+ .' "SendTo",'."\n"
+ .' "Subject",'."\n"
+ .' "MessageBody"'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .']'."\n"
+ .'```'."\n"
+ ."\n"
+ .'}',
+ 'extraInfo' => '"data":{'."\n"
+ .' "requestId":"550DB2BE-98DE-0368-A52C-8F6BC78CD113"'."\n"
+ .' }',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListServiceGroupMonitorSourceTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": [\\n {\\n \\"createTime\\": \\"2020-08-08 15:38:38\\",\\n \\"keyNode\\": \\"PROBLEM_INJECTION,PROBLEM_HAPPEN\\",\\n \\"content\\": \\"内容\\",\\n \\"isKey\\": true,\\n \\"updateTime\\": \\"2020-08-08 15:38:38\\",\\n \\"time\\": \\"2020-08-08 15:38:38\\",\\n \\"problemTimelineId\\": 10000,\\n \\"usersInContent\\": [\\n {\\n \\"userId\\": 232,\\n \\"username\\": \\"张老萨\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProblemTimeLinesResponse>\\n <requestId>C4BE3837-1A13-413B-A225-2C88188E8A43</requestId>\\n <data>\\n <createTime>2020-08-08 15:38:38</createTime>\\n <keyNode>1,2,3</keyNode>\\n <content>内容</content>\\n <isKey>true</isKey>\\n <updateTime>2020-08-08 15:38:38</updateTime>\\n <time>2020-08-08 15:38:38</time>\\n <problemTimelineId>10000</problemTimelineId>\\n </data>\\n</ListProblemTimeLinesResponse>","errorExample":""}]',
- ],
- 'GetProblemEffectionService' => [
- 'summary' => '查询故障影响服务',
- 'path' => '/problem/process/effectionService/detail',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceGroupMonitorSourceTemplates'],
+ ],
],
+ ],
+ 'ListServiceGroups' => [
+ 'summary' => 'Retrieves the list of service groups.',
+ 'path' => '/services/group/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLC8226',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
'parameters' => [
[
@@ -18564,605 +13587,209 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
- 'properties' => [
- 'effectionServiceId' => [
- 'description' => '',
- 'example' => '9',
- 'format' => 'int64',
- 'required' => false,
- 'title' => 'id主键',
- 'type' => 'integer',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '46',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => 'clientToken',
- 'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
+ 'description' => 'The request body.',
+ 'properties' => [
+ 'queryName' => ['description' => 'The search name.', 'type' => 'string', 'example' => '王先生', 'title' => '', 'required' => false],
+ 'queryType' => ['description' => 'The search type.'."\n"
+ ."\n"
+ .'- USER: user.'."\n"
+ ."\n"
+ .'- SERVICEGROUP: service group.', 'type' => 'string', 'example' => 'USER', 'title' => '', 'required' => false],
+ 'pageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'The idempotence token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
+ 'isScheduled' => ['description' => 'Indicates whether a schedule has been created.', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false],
+ 'orderByScheduleStatus' => ['description' => 'Sorts the results by schedule status.', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false],
+ 'userId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => '', 'required' => false],
+ 'serviceId' => ['title' => 'Service query', 'description' => 'The service ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '33'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd',
- 'title' => 'requestId',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'sssss'],
'data' => [
- 'description' => 'data',
- 'properties' => [
- 'effectionServiceId' => [
- 'description' => '',
- 'example' => '6442430',
- 'format' => 'int64',
- 'title' => '影响服务id',
- 'type' => 'integer',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => '哈哈',
- 'title' => '服务名称',
- 'type' => 'string',
- ],
- 'serviceId' => [
- 'description' => '',
- 'example' => '170000000',
- 'format' => 'int64',
- 'title' => '服务id',
- 'type' => 'integer',
- ],
- 'level' => [
- 'description' => '',
- 'example' => 'P2',
- 'format' => 'int64',
- 'title' => '影响等级',
- 'type' => 'integer',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'UN_RECOVERED',
- 'format' => 'int64',
- 'title' => '影响状态 0 未恢复 1已恢复',
- 'type' => 'integer',
- ],
- 'description' => [
- 'description' => '',
- 'example' => 'ew',
- 'title' => '影响描述',
- 'type' => 'string',
- ],
- 'picUrl' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '[ "problem/axxxxxx2-1xxxx4565-be92-f44ae2xxxxx", "problem/7xxxxxxe314-49998-b9e7-399e78b41fbd", "problem/xxxxx-f40d-4611-0978-1d1f719a929a" ]',
- 'type' => 'string',
+ 'description' => 'The list of service groups.',
+ 'items' => [
+ 'description' => 'The list of service groups.',
+ 'properties' => [
+ 'serviceGroupId' => ['description' => 'The service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'isScheduled' => ['description' => 'Indicates whether a schedule has been created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'serviceGroupName' => ['description' => 'The service group name.', 'type' => 'string', 'example' => '我的服务组', 'title' => ''],
+ 'serviceGroupDescription' => ['description' => 'The service group description.', 'type' => 'string', 'example' => '服务组描述', 'title' => ''],
+ 'updateTime' => ['description' => 'The time when the service group was last updated.', 'type' => 'string', 'example' => '2020-08-09 15:50:30', 'title' => ''],
+ 'enableWebhook' => ['description' => '- ENABLE: The webhook is enabled.'."\n"
+ ."\n"
+ .'- DISABLE: The webhook is disabled.', 'type' => 'string', 'example' => 'ENABLE', 'title' => ''],
+ 'webhookType' => ['description' => '- WEIXIN\\_GROUP: WeChat group.'."\n"
+ ."\n"
+ .'- DING\\_GROUP: DingTalk group.', 'type' => 'string', 'example' => 'WEIXIN_GROUP', 'title' => ''],
+ 'webhookLink' => ['description' => 'The webhook URL.', 'type' => 'string', 'example' => 'wwwwwwwwww', 'title' => ''],
+ 'users' => [
+ 'description' => 'The list of users in the service group.',
+ 'items' => [
+ 'description' => 'The user.',
+ 'properties' => [
+ 'userId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'userName' => ['description' => 'The username.', 'type' => 'string', 'example' => 'jack', 'title' => ''],
+ 'serviceGroupId' => ['description' => 'The service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'phone' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''],
+ 'email' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'wy930***@163.com', 'title' => ''],
+ 'isRelated' => ['description' => 'Indicates whether the user is associated with the mobile app.'."\n"
+ ."\n"
+ .'- 1: Yes.'."\n"
+ ."\n"
+ .'- 0: No.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'title' => '图片链接',
- 'type' => 'array',
],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'object',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'pageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'EffectionServiceNotExisted',
- 'errorMessage' => 'EffectionService does not exist.',
- ],
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"sssss\\",\\n \\"data\\": [\\n {\\n \\"serviceGroupId\\": 1,\\n \\"isScheduled\\": true,\\n \\"serviceGroupName\\": \\"我的服务组\\",\\n \\"serviceGroupDescription\\": \\"服务组描述\\",\\n \\"updateTime\\": \\"2020-08-09 15:50:30\\",\\n \\"enableWebhook\\": \\"ENABLE\\",\\n \\"webhookType\\": \\"WEIXIN_GROUP\\",\\n \\"webhookLink\\": \\"wwwwwwwwww\\",\\n \\"users\\": [\\n {\\n \\"userId\\": 10,\\n \\"userName\\": \\"jack\\",\\n \\"serviceGroupId\\": 1,\\n \\"phone\\": \\"1390000****\\",\\n \\"email\\": \\"wy930***@163.com\\",\\n \\"isRelated\\": 1\\n }\\n ]\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 100\\n}","type":"json"}]',
+ 'title' => 'Query service group list',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-09-19T12:15:27.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:37.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:37.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceGroups'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListServiceGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"e2d4306a-bf4d-4345-9ae6-158223c85dbd\\",\\n \\"data\\": {\\n \\"effectionServiceId\\": 6442430,\\n \\"serviceName\\": \\"哈哈\\",\\n \\"serviceId\\": 170000000,\\n \\"level\\": 0,\\n \\"status\\": 1,\\n \\"description\\": \\"ew\\",\\n \\"picUrl\\": [\\n \\"[ \\\\\\"problem/axxxxxx2-1xxxx4565-be92-f44ae2xxxxx\\\\\\", \\\\\\"problem/7xxxxxxe314-49998-b9e7-399e78b41fbd\\\\\\", \\\\\\"problem/xxxxx-f40d-4611-0978-1d1f719a929a\\\\\\" ]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetProblemEffectionServiceResponse>\\n <requestId>e2d4306a-bf4d-4345-9ae6-158223c85dbd</requestId>\\n <data>\\n <effectionServiceId>6442430</effectionServiceId>\\n <serviceName>哈哈</serviceName>\\n <serviceId>170000000</serviceId>\\n <description>ew</description>\\n <picUrl>[ \\"problem/axxxxxx2-1xxxx4565-be92-f44ae2xxxxx\\", \\"problem/7xxxxxxe314-49998-b9e7-399e78b41fbd\\", \\"problem/xxxxx-f40d-4611-0978-1d1f719a929a\\" ]</picUrl>\\n </data>\\n</GetProblemEffectionServiceResponse>","errorExample":""}]',
],
- 'GetProblemPreview' => [
- 'summary' => '通告预览',
- 'path' => '/problem/preview',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListServiceGroupsByUserId' => [
+ 'summary' => 'Queries the service groups associated with a member ID.',
+ 'path' => '/services/group/listByUserId',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLC8226',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'body',
- 'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
- 'problemNotifyType' => [
- 'description' => '',
- 'example' => 'PROBLEM_NOTIFY',
- 'required' => false,
- 'title' => '通告类型',
- 'type' => 'string',
- ],
- 'problemLevel' => [
- 'description' => '',
- 'example' => 'P2',
- 'required' => false,
- 'title' => '故障等级',
- 'type' => 'string',
- ],
- 'effectServiceIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'required' => false,
- 'title' => '影响服务',
- 'type' => 'array',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '21312',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '所属服务',
- 'type' => 'integer',
- ],
- 'incidentId' => [
- 'description' => '',
- 'example' => '213123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '事件Id',
- 'type' => 'integer',
- ],
- 'serviceGroupIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '12313',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'required' => false,
- 'title' => '应急协同组',
- 'type' => 'array',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840f13812',
- 'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'type' => 'object',
'properties' => [
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => '4361a0e1-6747-4834-96ce-0c2840fd3812',
- 'title' => 'requestId',
- 'type' => 'string',
- ],
+ 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'data' => [
- 'description' => 'data',
+ 'type' => 'object',
'properties' => [
- 'problem' => [
- 'description' => 'object',
- 'properties' => [
- 'problemName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '故障名称',
- 'type' => 'string',
- ],
- 'problemStatus' => [
- 'description' => '',
- 'example' => 'HANDLING',
- 'title' => '故障状态 1 处理中 2已恢复 3复盘中 4已复盘 5已取消',
- 'type' => 'string',
- ],
- 'problemLevel' => [
- 'description' => '',
- 'example' => 'P2',
- 'title' => '故障等级 1=P1 2=P2 3=P3 4=P4',
- 'type' => 'string',
- ],
- 'discoverTime' => [
- 'description' => '',
- 'example' => '2021-02-21 00:00:00',
- 'title' => '发现时间',
- 'type' => 'string',
- ],
- 'recoveryTime' => [
- 'description' => '',
- 'example' => '2021-02-21 00:00:00',
- 'title' => '恢复时间',
- 'type' => 'string',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '关联服务 名称',
- 'type' => 'string',
- ],
- 'progressSummary' => [
- 'description' => '',
- 'example' => '',
- 'title' => '进展摘要',
- 'type' => 'string',
- ],
- 'preliminaryReason' => [
- 'description' => '',
- 'example' => '',
- 'title' => '初步原因',
- 'type' => 'string',
- ],
- 'mainHandlerName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '主要处理人',
- 'type' => 'string',
- ],
- 'mainHandlerId' => [
- 'description' => '',
- 'example' => '231',
- 'title' => '主要处理人Id',
- 'type' => 'string',
- ],
- 'isManual' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '是否手动',
- 'type' => 'boolean',
- ],
- 'isUpgrade' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '是否升级',
- 'type' => 'boolean',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '123123',
- 'format' => 'int64',
- 'title' => '故障Id',
- 'type' => 'integer',
- ],
- 'relatedServiceId' => [
- 'description' => '',
- 'example' => '213123',
- 'format' => 'int64',
- 'title' => '关联服务ID',
- 'type' => 'integer',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2021-02-21 00:00:00',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'progressSummaryRichTextId' => [
- 'description' => '',
- 'example' => '12312',
- 'format' => 'int64',
- 'title' => '富文本id',
- 'type' => 'integer',
- ],
- 'coordinationGroups' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'serviceGroupName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '服务组名称',
- 'type' => 'string',
- ],
- 'serviceGroupId' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'title' => '服务Id',
- 'type' => 'integer',
- ],
- 'serviceGroupDescription' => [
- 'description' => '',
- 'example' => '',
- 'title' => '服务组Maison',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '应急协同组',
- 'type' => 'array',
- ],
- 'effectionServices' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'serviceName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '影响服务名称',
- 'type' => 'string',
- ],
- 'serviceId' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'title' => '影响服务Id',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '影响服务',
- 'type' => 'array',
- ],
- ],
- 'type' => 'object',
- ],
- 'voice' => [
- 'description' => '',
- 'properties' => [
- 'count' => [
- 'description' => '',
- 'example' => '12',
- 'format' => 'int64',
- 'title' => '数量',
- 'type' => 'integer',
- ],
- 'users' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'username' => [
- 'description' => '',
- 'example' => '',
- 'title' => '用户',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
- ],
- 'title' => '语音',
- 'type' => 'object',
- ],
- 'mail' => [
- 'description' => '',
- 'properties' => [
- 'count' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'title' => '数量',
- 'type' => 'integer',
- ],
- 'users' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'username' => [
- 'description' => '',
- 'example' => '',
- 'title' => '用户名称',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
- ],
- 'title' => '邮箱',
- 'type' => 'object',
- ],
- 'sms' => [
- 'description' => '',
- 'properties' => [
- 'count' => [
- 'description' => '',
- 'example' => '12',
- 'format' => 'int64',
- 'title' => '数量',
- 'type' => 'integer',
- ],
- 'users' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'properties' => [
- 'username' => [
- 'description' => '',
- 'example' => '',
- 'title' => '用户名称',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
- ],
- 'title' => '短信',
- 'type' => 'object',
- ],
- 'webhook' => [
- 'description' => 'webhook',
- 'properties' => [
- 'count' => [
- 'description' => '',
- 'example' => '32',
- 'format' => 'int64',
- 'title' => '数量',
- 'type' => 'integer',
- ],
- 'serviceGroups' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'serviceName' => [
- 'description' => '',
- 'example' => '',
- 'title' => '服务名称',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
- ],
- 'title' => 'webhook',
- 'type' => 'object',
- ],
- 'upBeforeData' => [
- 'description' => '',
- 'example' => '',
- 'title' => '升级前数据',
- 'type' => 'string',
- ],
- 'upAfterData' => [
- 'description' => '',
- 'example' => '',
- 'title' => '升级后数据',
- 'type' => 'string',
- ],
- 'deBeforeData' => [
- 'description' => '',
- 'example' => '',
- 'title' => '降级前数据',
- 'type' => 'string',
- ],
- 'deAfterData' => [
- 'description' => '',
- 'example' => '',
- 'title' => '降级后数据',
- 'type' => 'string',
- ],
+ 'serviceGroupId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'isScheduled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'serviceGroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 'title' => 'Schema of Response',
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListServiceGroupsByUserId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c2840fd3812\\",\\n \\"data\\": {\\n \\"problem\\": {\\n \\"problemName\\": \\"故障名称\\",\\n \\"problemStatus\\": \\"HANDLING\\",\\n \\"problemLevel\\": \\"P2\\",\\n \\"discoverTime\\": \\"2021-02-21 00:00:00\\",\\n \\"recoveryTime\\": \\"2021-02-21 00:00:00\\",\\n \\"serviceName\\": \\"服务A\\",\\n \\"progressSummary\\": \\"摘要123\\",\\n \\"preliminaryReason\\": \\"原因A\\",\\n \\"mainHandlerName\\": \\"小明\\",\\n \\"mainHandlerId\\": \\"231\\",\\n \\"isManual\\": true,\\n \\"isUpgrade\\": true,\\n \\"problemId\\": 123123,\\n \\"relatedServiceId\\": 213123,\\n \\"createTime\\": \\"2021-02-21 00:00:00\\",\\n \\"progressSummaryRichTextId\\": 12312,\\n \\"coordinationGroups\\": [\\n {\\n \\"serviceGroupName\\": \\"服务组A\\",\\n \\"serviceGroupId\\": 1231,\\n \\"serviceGroupDescription\\": \\"服务组描述\\"\\n }\\n ],\\n \\"effectionServices\\": [\\n {\\n \\"serviceName\\": \\"服务B\\",\\n \\"serviceId\\": 1231\\n }\\n ]\\n },\\n \\"voice\\": {\\n \\"count\\": 12,\\n \\"users\\": [\\n {\\n \\"username\\": \\"用户名称\\"\\n }\\n ]\\n },\\n \\"mail\\": {\\n \\"count\\": 123,\\n \\"users\\": [\\n {\\n \\"username\\": \\"用户名称\\"\\n }\\n ]\\n },\\n \\"sms\\": {\\n \\"count\\": 12,\\n \\"users\\": [\\n {\\n \\"username\\": \\"用户名称\\"\\n }\\n ]\\n },\\n \\"webhook\\": {\\n \\"count\\": 32,\\n \\"serviceGroups\\": [\\n {\\n \\"serviceName\\": \\"服务名称\\"\\n }\\n ]\\n },\\n \\"upBeforeData\\": \\"最新升级前等级\\",\\n \\"upAfterData\\": \\"最新升级后等级\\",\\n \\"deBeforeData\\": \\"最新降级前等级\\",\\n \\"deAfterData\\": \\"最新降级后等级\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetProblemPreviewResponse>\\n <requestId>4361a0e1-6747-4834-96ce-0c2840fd3812</requestId>\\n <data>\\n <problem>\\n <problemName>故障名称</problemName>\\n <problemStatus>HANDLING</problemStatus>\\n <problemLevel>P2</problemLevel>\\n <discoverTime>2021-02-21 00:00:00</discoverTime>\\n <recoveryTime>2021-02-21 00:00:00</recoveryTime>\\n <serviceName>服务A</serviceName>\\n <progressSummary>摘要123</progressSummary>\\n <preliminaryReason>原因A</preliminaryReason>\\n <mainHandlerName>小明</mainHandlerName>\\n <mainHandlerId>231</mainHandlerId>\\n <isManual>true</isManual>\\n <isUpgrade>true</isUpgrade>\\n <problemId>123123</problemId>\\n <relatedServiceId>213123</relatedServiceId>\\n <createTime>2021-02-21 00:00:00</createTime>\\n <coordinationGroups>\\n <serviceGroupName>服务组A</serviceGroupName>\\n <serviceGroupId>1231</serviceGroupId>\\n <serviceGroupDescription>服务组描述</serviceGroupDescription>\\n </coordinationGroups>\\n <effectionServices>\\n <serviceName>服务B</serviceName>\\n <serviceId>1231</serviceId>\\n </effectionServices>\\n </problem>\\n <voice>\\n <count>12</count>\\n <users>\\n <username>用户名称</username>\\n </users>\\n </voice>\\n <mail>\\n <count>123</count>\\n <users>\\n <username>用户名称</username>\\n </users>\\n </mail>\\n <sms>\\n <count>12</count>\\n <users>\\n <username>用户名称</username>\\n </users>\\n </sms>\\n <webhook>\\n <count>32</count>\\n <serviceGroups>\\n <serviceName>服务名称</serviceName>\\n </serviceGroups>\\n </webhook>\\n <upBeforeData>最新升级前等级</upBeforeData>\\n <upAfterData>最新升级后等级</upAfterData>\\n <deBeforeData>最新降级前等级</deBeforeData>\\n <deAfterData>最新降级后等级</deAfterData>\\n </data>\\n</GetProblemPreviewResponse>","errorExample":""}]',
- ],
- 'RemoveProblemServiceGroup' => [
- 'summary' => '删除故障协同组',
- 'path' => '/problem/removeServiceGroup',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"data\\": {\\n \\"serviceGroupId\\": 0,\\n \\"isScheduled\\": false,\\n \\"serviceGroupName\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'ListServiceGroupsByUserId',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceGroupsByUserId'],
+ ],
],
+ ],
+ 'ListServices' => [
+ 'summary' => 'View the list of services.',
+ 'path' => '/services/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1XQ9JR',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
'parameters' => [
[
@@ -19172,31 +13799,15 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'problemId' => [
- 'description' => '',
- 'example' => '13123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障ID',
- 'type' => 'integer',
- ],
- 'serviceGroupIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '应急协同组ID',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'required' => false,
- 'title' => '应急协同组',
- 'type' => 'array',
- ],
+ 'serviceName' => ['description' => 'Service name', 'type' => 'string', 'example' => '购物车', 'title' => '', 'required' => false],
+ 'pageNumber' => ['description' => 'Current page', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'Page size', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotency token', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -19205,50 +13816,88 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '5AD6E6BC-2582-4E0E-832D-52CB1B922253',
- 'title' => 'Id of the request',
- 'type' => 'string',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
+ 'data' => [
+ 'description' => 'List of services',
+ 'items' => [
+ 'properties' => [
+ 'serviceId' => ['description' => 'Service ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'serviceName' => ['description' => 'Service name', 'type' => 'string', 'example' => '购物车', 'title' => ''],
+ 'serviceDescription' => ['description' => 'Service description', 'type' => 'string', 'example' => '服务描述', 'title' => ''],
+ 'updateTime' => ['description' => 'Update time', 'type' => 'string', 'example' => '2020-09-08 14:30:30', 'title' => ''],
+ 'isValid' => ['description' => 'Is valid', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'escalationPlanName' => ['title' => 'Policy Name', 'description' => 'Upgrade policy name', 'type' => 'string', 'example' => ''],
+ 'escalationPlanId' => ['title' => 'Upgrade policy ID', 'description' => 'Upgrade policy ID', 'type' => 'integer', 'format' => 'int64', 'example' => ''],
+ 'serviceGroupIdList' => [
+ 'description' => 'List of service group IDs',
+ 'title' => 'Service group ID list',
+ 'type' => 'array',
+ 'items' => ['title' => 'Service group ID', 'description' => 'Service group ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1'],
+ 'example' => '',
+ ],
+ ],
+ 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
+ 'pageNumber' => ['description' => 'Current page', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'Page size', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'totalCount' => ['description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"5AD6E6BC-2582-4E0E-832D-52CB1B922253\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveProblemServiceGroupResponse>\\n <requestId>5AD6E6BC-2582-4E0E-832D-52CB1B922253</requestId>\\n</RemoveProblemServiceGroupResponse>","errorExample":""}]',
- ],
- 'CreateProblemEffectionService' => [
- 'summary' => '创建影响服务',
- 'path' => '/problem/process/effectionService/create',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": [\\n {\\n \\"serviceId\\": 1,\\n \\"serviceName\\": \\"购物车\\",\\n \\"serviceDescription\\": \\"服务描述\\",\\n \\"updateTime\\": \\"2020-09-08 14:30:30\\",\\n \\"isValid\\": 1,\\n \\"escalationPlanName\\": \\"\\",\\n \\"escalationPlanId\\": 0,\\n \\"serviceGroupIdList\\": [\\n 1\\n ]\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 100\\n}","type":"json"}]',
+ 'title' => 'View Service List',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:54.000Z', 'description' => 'Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListServices',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServices'],
+ ],
+ ],
+ ],
+ 'ListSourceEvents' => [
+ 'summary' => 'Retrieve the list of original alerts.',
+ 'path' => '/events/listOriginalEvent',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempZVI8H5',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempW81V8D'],
],
'parameters' => [
[
@@ -19256,146 +13905,120 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
- 'properties' => [
- 'serviceId' => [
- 'description' => '',
- 'example' => '170000000',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '影响服务id',
- 'type' => 'integer',
- ],
- 'level' => [
- 'description' => '',
- 'example' => 'P2',
- 'required' => false,
- 'title' => '影响等级',
- 'type' => 'string',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'UN_RECOVERED',
- 'required' => false,
- 'title' => '影响状态 0 未恢复 1已恢复',
- 'type' => 'string',
- ],
- 'description' => [
- 'description' => '',
- 'example' => 'erdwcdc',
- 'required' => false,
- 'title' => '影响描述',
- 'type' => 'string',
- ],
- 'pictureUrl' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => 'problem/xxxxxxxssxxxa2c8-40b9-9162-08a6c2e338e2',
- 'required' => false,
- 'type' => 'string',
- ],
- 'required' => false,
- 'title' => '图片地址',
- 'type' => 'array',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '150000000',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => 'clientToken',
- 'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
+ 'description' => 'Request body.',
+ 'properties' => [
+ 'instanceId' => ['description' => 'Alert or event ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'instanceType' => ['description' => 'Type:'."\n"
+ ."\n"
+ .'- INCIDENT: Event.'."\n"
+ ."\n"
+ .'- ALERT: Alert.'."\n"
+ ."\n"
+ .'- PROBLEM: Problem.', 'type' => 'string', 'required' => true, 'example' => 'INCIDENT', 'title' => ''],
+ 'startRowKey' => ['description' => 'Start rowkey.', 'type' => 'string', 'example' => '9223370410626682599-1344383-78954515-1-0a6e01a1701447fd9ef18b079edd2c6d', 'title' => '', 'required' => false],
+ 'stopRowKey' => ['description' => 'Stop rowkey.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '9223370410626682599-1344383-78954515-1-0a6e01a1701447fd9ef18b079edd2c6d'],
+ 'pageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'An idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
+ 'pageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'startTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '2020-09-10 13:00:00', 'title' => '', 'required' => false],
+ 'endTime' => ['description' => 'End time.', 'type' => 'string', 'example' => '2020-09-18 13:00:00', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => ''],
+ 'totalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'pageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'data' => [
- 'description' => 'data',
- 'properties' => [
- 'effectionServiceId' => [
- 'description' => '',
- 'example' => '6442430',
- 'format' => 'int64',
- 'title' => '影响服务id',
- 'type' => 'integer',
+ 'description' => 'Current page.',
+ 'items' => [
+ 'properties' => [
+ 'routeRuleId' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'instanceType' => ['description' => 'Type:'."\n"
+ ."\n"
+ .'- INCIDENT: Event.'."\n"
+ ."\n"
+ .'- ALERT: Alert.'."\n"
+ ."\n"
+ .'- PROBLEM: Problem.', 'type' => 'string', 'example' => 'INCIDENT', 'title' => ''],
+ 'instanceId' => ['description' => 'Associated object ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'monitorSourceId' => ['description' => 'Monitoring and alerting source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'monitorSourceName' => ['description' => 'Monitoring and alerting source name.', 'type' => 'string', 'example' => 'zabbix', 'title' => ''],
+ 'eventTime' => ['description' => 'Alert reporting time.', 'type' => 'string', 'example' => '2020-09-08 15:53:34', 'title' => ''],
+ 'tenantRamId' => ['description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'eventJson' => ['description' => 'Alert content format.', 'type' => 'string', 'title' => '', 'example' => '""'],
],
+ 'type' => 'object',
+ 'description' => 'Returned data.',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'object',
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
+ 'lastRowKey' => ['title' => 'lastRowKey', 'description' => 'Last rowkey.', 'type' => 'string', 'example' => '9223370412331485036-1344383-9967-1-8d729a1b176f493ca3be643b391d5ced'],
+ 'firstRowKey' => ['title' => 'firstRowKey', 'description' => 'First rowkey.', 'type' => 'string', 'example' => '9223370412331485032-1344383-9967-1-08be8b08ef30441390072f3bfba71c94'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'EffectionServiceAlreadyExisted',
- 'errorMessage' => 'EffectionService already exists.',
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"totalCount\\": 100,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"data\\": [\\n {\\n \\"routeRuleId\\": 1,\\n \\"instanceType\\": \\"INCIDENT\\",\\n \\"instanceId\\": 1,\\n \\"monitorSourceId\\": 1,\\n \\"monitorSourceName\\": \\"zabbix\\",\\n \\"eventTime\\": \\"2020-09-08 15:53:34\\",\\n \\"tenantRamId\\": 1,\\n \\"eventJson\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ],\\n \\"lastRowKey\\": \\"9223370412331485036-1344383-9967-1-8d729a1b176f493ca3be643b391d5ced\\",\\n \\"firstRowKey\\": \\"9223370412331485032-1344383-9967-1-08be8b08ef30441390072f3bfba71c94\\"\\n}","type":"json"}]',
+ 'title' => 'Query raw alert list ',
+ 'changeSet' => [
+ ['createdAt' => '2021-07-16T04:09:41.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSourceEvents'],
],
- 404 => [
- [
- 'errorCode' => 'ProblemNotExisted',
- 'errorMessage' => 'The problem does not exist.',
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListSourceEvents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\",\\n \\"data\\": {\\n \\"effectionServiceId\\": 125647350\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateProblemEffectionServiceResponse>\\n <requestId>c26f36de-1ec8-496a-a828-880676c5ef81</requestId>\\n <data>\\n <effectionServiceId>6442430</effectionServiceId>\\n </data>\\n</CreateProblemEffectionServiceResponse>","errorExample":""}]',
],
- 'GetResourceStatistics' => [
- 'summary' => '概览数据统计',
- 'path' => '/config/resource/count',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListSourceEventsForMonitorSource' => [
+ 'summary' => 'Retrieves a list of recent alerts.',
+ 'path' => '/events/queryLastestEvents',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp20VVML',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempW81V8D'],
],
'parameters' => [
[
@@ -19403,107 +14026,103 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
- 'example' => 'body',
+ 'description' => 'The request body.',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'required' => false,
- 'title' => '幂等校验',
- 'type' => 'string',
- ],
+ 'monitorSourceId' => ['description' => 'The monitoring source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => '', 'required' => false],
],
'required' => false,
- 'title' => 'body',
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxxxx'],
'data' => [
- 'description' => 'data',
- 'properties' => [
- 'incidentCount' => [
- 'description' => '',
- 'example' => '1331',
- 'format' => 'int32',
- 'title' => '事件总数',
- 'type' => 'integer',
- ],
- 'alertCount' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int32',
- 'title' => '报警总数',
- 'type' => 'integer',
- ],
- 'problemCount' => [
- 'description' => '',
- 'example' => '221',
- 'format' => 'int32',
- 'title' => '故障总数',
- 'type' => 'integer',
- ],
- 'integrationCount' => [
- 'description' => '',
- 'example' => '2211',
- 'format' => 'int32',
- 'title' => '集成总数',
- 'type' => 'integer',
+ 'description' => 'The list of alerts.',
+ 'items' => [
+ 'properties' => [
+ 'monitorSourceId' => ['description' => 'The monitoring source ID.', 'type' => 'boolean', 'example' => '1000', 'title' => ''],
+ 'monitorSourceName' => ['description' => 'The monitoring source name.', 'type' => 'string', 'example' => 'zabbix', 'title' => ''],
+ 'eventTime' => ['description' => 'The time when the alert was reported.', 'type' => 'string', 'example' => '2020-01-01 18:30:00', 'title' => ''],
+ 'eventJson' => ['description' => 'The alert content.', 'type' => 'string', 'title' => '', 'example' => '{}'],
],
+ 'type' => 'object',
+ 'description' => 'List of alerts.',
+ 'title' => '',
+ 'example' => '',
],
- 'title' => 'data',
- 'type' => 'object',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"incidentCount\\": 1331,\\n \\"alertCount\\": 123,\\n \\"problemCount\\": 221,\\n \\"integrationCount\\": 2211\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetResourceStatisticsResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n <data>\\n <incidentCount>1331</incidentCount>\\n <alertCount>123</alertCount>\\n <problemCount>221</problemCount>\\n <integrationCount>2211</integrationCount>\\n </data>\\n</GetResourceStatisticsResponse>","errorExample":""}]',
- ],
- 'ListConfigs' => [
- 'summary' => '全局码表配置',
- 'path' => '/config/all',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxxxx\\",\\n \\"data\\": [\\n {\\n \\"monitorSourceId\\": true,\\n \\"monitorSourceName\\": \\"zabbix\\",\\n \\"eventTime\\": \\"2020-01-01 18:30:00\\",\\n \\"eventJson\\": \\"{}\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query the Recent Alert List ',
+ 'requestParamsDescription' => '{'."\n"
+ .'"monitorSourceId" : 1000'."\n"
+ .'}',
+ 'responseParamsDescription' => '{'."\n"
+ .'"requestId": "xxxxxx",'."\n"
+ .'"data": \\['."\n"
+ .'{'."\n"
+ .'"monitorSourceId": false,'."\n"
+ .'"monitorSourceName": "zabbix",'."\n"
+ .'"eventTime": "2020-01-01 18:30:00",'."\n"
+ .'"eventJson": "{}"'."\n"
+ .'}'."\n"
+ .']'."\n"
+ .'}',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-16T01:59:34.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListSourceEventsForMonitorSource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'ListSubscriptionServiceGroups' => [
+ 'summary' => 'This operation lists incident collaboration groups.',
+ 'path' => '/problem/serviceGroup/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp2C8J2M'],
],
'parameters' => [
[
@@ -19511,121 +14130,101 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request Body.',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-CDE61E59A2E9',
+ 'serviceIds' => [
+ 'description' => 'Service list.',
+ 'items' => ['description' => 'Service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12313', 'required' => false, 'title' => ''],
'required' => false,
- 'title' => '幂等校验token',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '89f51d2e-5527-4f6c-a6c6-4411b5496e9f'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '89f51d2e-5527-4f6c-a6c6-4411b5496e9f'],
'data' => [
- 'additionalProperties' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'configDescription' => [
- 'title' => '配置描述',
- 'type' => 'string',
- 'description' => '',
- 'example' => '',
- ],
- 'configCode' => [
- 'title' => '配置code',
- 'type' => 'string',
- 'example' => 'PROBLEM_REASON_DISASTER',
- 'description' => '',
- ],
- 'parentCode' => [
- 'title' => '配置父code',
- 'type' => 'string',
- 'description' => '',
- 'example' => 'PROBLEM_REASON',
- ],
- 'configKey' => [
- 'title' => 'key (用于前后端值传递)',
- 'type' => 'string',
- 'example' => '2',
- 'description' => '',
- ],
- 'configValue' => [
- 'title' => 'value (用于前端展示)',
- 'type' => 'string',
- 'example' => '',
- 'description' => '',
- ],
- 'requirement' => [
- 'title' => '是否必选',
- 'type' => 'boolean',
- 'description' => '',
- 'example' => 'true',
- ],
- ],
- 'description' => 'object',
+ 'description' => 'Returned data.',
+ 'items' => [
+ 'description' => 'Service group list.',
+ 'properties' => [
+ 'serviceId' => ['description' => 'Primary key.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123113'],
+ 'serviceName' => ['description' => 'Service group name.', 'type' => 'string', 'title' => '', 'example' => '服务A'],
+ 'serviceGroupDescription' => ['description' => 'Service group description.', 'type' => 'string', 'title' => '', 'example' => '服务描述'],
],
- 'description' => 'array',
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'description' => 'data',
- 'type' => 'object',
- ],
- 'requestId' => [
- 'description' => 'requestId',
- 'example' => 'uuid',
- 'title' => 'requestId',
- 'type' => 'string',
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"data\\": {\\n \\"key\\": [\\n {\\n \\"configDescription\\": \\"产品设计\\",\\n \\"configCode\\": \\"PROBLEM_REASON_DISASTER\\",\\n \\"parentCode\\": \\"PROBLEM_REASON\\",\\n \\"configKey\\": \\"2\\",\\n \\"configValue\\": \\"产品设计\\",\\n \\"requirement\\": true\\n }\\n ]\\n },\\n \\"requestId\\": \\"uuid\\"\\n}","errorExample":""},{"type":"xml","example":"<ListConfigsResponse>\\n <data>\\n <PROBLEM_INJECTION_MODE>\\n <code>PROBLEM_INJECTION_CODE_RELEASE</code>\\n <parentCode>PROBLEM_INJECTION_MODE</parentCode>\\n <name>代码发布</name>\\n <require>0</require>\\n <id>29</id>\\n <value>代码发布</value>\\n <key>1</key>\\n </PROBLEM_INJECTION_MODE>\\n </data>\\n</ListConfigsResponse>","errorExample":""}]',
- ],
- 'ListDictionaries' => [
- 'summary' => '字典列表',
- 'path' => '/dict/list',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ServiceGroupNotExisted', 'errorMessage' => 'The service group does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"89f51d2e-5527-4f6c-a6c6-4411b5496e9f\\",\\n \\"data\\": [\\n {\\n \\"serviceId\\": 123113,\\n \\"serviceName\\": \\"服务A\\",\\n \\"serviceGroupDescription\\": \\"服务描述\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'List of fault collaboration groups',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSubscriptionServiceGroups'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListSubscriptionServiceGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListSubscriptions' => [
+ 'summary' => 'Lists notification subscriptions.',
+ 'path' => '/notify/subscription/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempLJVP1W',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp2C8J2M'],
],
'parameters' => [
[
@@ -19633,93 +14232,176 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
- 'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'description' => 'Request body.',
+ 'properties' => [
+ 'pageNumber' => ['description' => 'Page number for pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ 'pageSize' => ['description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'required' => false],
+ 'subscriptionTitle' => ['description' => 'Notification subscription name.', 'type' => 'string', 'example' => 'newTitle', 'title' => '', 'required' => false],
+ 'scope' => ['description' => 'Subscription scope type:'."\n"
+ ."\n"
+ .'- ALL: All resources.'."\n"
+ ."\n"
+ .'- SERVICE: Service.'."\n"
+ ."\n"
+ .'- ROUTERULE: Routing rule.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'SERVICE'],
+ 'scopeObject' => ['description' => 'Name of the subscription scope object.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'TestName'],
+ 'notifyObjectType' => ['description' => 'Notification recipient type:'."\n"
+ ."\n"
+ .'- SERVICEGROUP: Service group.'."\n"
+ ."\n"
+ .'- USER: Individual user.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'SERVICE'],
+ 'notifyObject' => ['description' => 'Notification recipient name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test'],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11', 'title' => '', 'required' => false],
+ 'notFilterScopeObjectDeleted' => ['title' => 'Do not filter deleted subscription scope objects (when true, deleted objects are also included in the results)', 'description' => 'Whether to filter out deleted scope objects.', 'type' => 'boolean', 'required' => false, 'example' => ''],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
+ 'requestId' => ['title' => 'id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88'],
'data' => [
- 'additionalProperties' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'type' => 'string',
- 'example' => 'SMS',
- 'description' => '',
+ 'description' => 'Subscription details.',
+ 'items' => [
+ 'description' => 'Subscription details.',
+ 'properties' => [
+ 'subscriptionId' => ['description' => 'Subscription ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'subscriptionTitle' => ['description' => 'Notification subscription name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'scope' => ['description' => '- 0: All resources.'."\n"
+ ."\n"
+ .'- 1: Service.'."\n"
+ ."\n"
+ .'- 2: Routing rule.', 'type' => 'integer', 'format' => 'int64', 'example' => 'SERVICE', 'title' => ''],
+ 'notifyObjectType' => ['description' => '- 0: Service group.'."\n"
+ ."\n"
+ .'- 1: Individual user.', 'type' => 'integer', 'format' => 'int64', 'example' => 'USER', 'title' => ''],
+ 'expiredType' => ['description' => 'Validity period type:'."\n"
+ ."\n"
+ .'- LONG\\_TERM: Long term.'."\n"
+ ."\n"
+ .'- SHORT\\_TERM: Short term.', 'type' => 'string', 'example' => 'LONG_TERM', 'title' => ''],
+ 'startTime' => ['description' => 'Start time of validity period.', 'type' => 'string', 'title' => '', 'example' => '2020-05-09 10:10:10'],
+ 'endTime' => ['description' => 'End time of validity period.', 'type' => 'string', 'title' => '', 'example' => '2022-05-09 10:10:10'],
+ 'status' => ['description' => '- 1: Enabled.'."\n"
+ ."\n"
+ .'- 0: Disabled.', 'type' => 'string', 'example' => 'ENABLE', 'title' => ''],
+ 'scopeObjectList' => [
+ 'description' => 'List of subscription scope objects.',
+ 'items' => [
+ 'properties' => [
+ 'id' => ['description' => 'ID primary key.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'scope' => ['description' => 'Subscription scope type:'."\n"
+ ."\n"
+ .'- ALL: All resources.'."\n"
+ ."\n"
+ .'- SERVICE: Service.'."\n"
+ ."\n"
+ .'- ROUTERULE: Routing rule.', 'type' => 'integer', 'format' => 'int64', 'example' => 'SERVICE', 'title' => ''],
+ 'scopeObjectId' => ['description' => 'Primary key ID of the associated scope object table.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'scopeObject' => ['description' => 'Name of the subscription scope object.', 'type' => 'string', 'example' => '阿里云服务', 'title' => ''],
+ 'isValid' => ['description' => 'Whether the scope object is valid.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ ],
+ 'type' => 'object',
+ 'description' => 'List of subscription scope objects.',
+ 'title' => '',
+ 'example' => '',
],
- 'description' => [
- 'type' => 'string',
- 'description' => '',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'notifyObjectList' => [
+ 'description' => 'List of notification recipients.',
+ 'items' => [
+ 'description' => 'List of notification recipients.',
+ 'properties' => [
+ 'id' => ['description' => 'ID primary key.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'notifyObjectType' => ['description' => 'Notification recipient type:'."\n"
+ ."\n"
+ .'- SERVICEGROUP: Service group.'."\n"
+ ."\n"
+ .'- USER: Individual user.', 'type' => 'integer', 'format' => 'int64', 'example' => 'USER', 'title' => ''],
+ 'notifyObjectId' => ['description' => 'Associated primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'name' => ['description' => 'Notification recipient name.', 'type' => 'string', 'example' => '张珊', 'title' => ''],
+ 'isValid' => ['description' => 'Indicates whether the object is valid.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
'example' => '',
],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'description' => 'object',
],
- 'description' => 'array',
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'description' => 'data',
- 'type' => 'object',
- ],
- 'requestId' => [
- 'description' => 'id of the request'."\n",
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'type' => 'string',
+ 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
+ 'totalCount' => ['description' => 'A parameter for paging.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'pageNumber' => ['description' => 'Page number for pagination.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"data\\": {\\n \\"key\\": [\\n {\\n \\"code\\": \\"SMS\\",\\n \\"description\\": \\"短信\\"\\n }\\n ]\\n },\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDictionariesResponse>\\n <data>\\n <incidentLevel>\\n <code>P1</code>\\n <desc>P1</desc>\\n </incidentLevel>\\n <incidentLevel>\\n <code>P2</code>\\n <desc>P2</desc>\\n </incidentLevel>\\n <incidentLevel>\\n <code>P3</code>\\n <desc>P3</desc>\\n </incidentLevel>\\n <incidentLevel>\\n <code>P4</code>\\n <desc>P4</desc>\\n </incidentLevel>\\n <incidentEffection>\\n <code>LOW</code>\\n <desc>低</desc>\\n </incidentEffection>\\n <incidentEffection>\\n <code>HIGH</code>\\n <desc>高</desc>\\n </incidentEffection>\\n <channel>\\n <code>SMS</code>\\n <desc>短信</desc>\\n </channel>\\n <channel>\\n <code>EMAIL</code>\\n <desc>邮件</desc>\\n </channel>\\n <channel>\\n <code>PHONE</code>\\n <desc>电话</desc>\\n </channel>\\n <channel>\\n <code>WEIXIN_GROUP</code>\\n <desc>企微群</desc>\\n </channel>\\n <channel>\\n <code>DING_GROUP</code>\\n <desc>钉钉群</desc>\\n </channel>\\n <operation>\\n <code>CONTAIN</code>\\n <desc>包含</desc>\\n </operation>\\n <operation>\\n <code>NOT_CONTAIN</code>\\n <desc>不包含</desc>\\n </operation>\\n <operation>\\n <code>EQUALS</code>\\n <desc>等于</desc>\\n </operation>\\n <operation>\\n <code>NOT_EQUALS</code>\\n <desc>不等于</desc>\\n </operation>\\n <problemNotifyType>\\n <code>PROBLEM_NOTIFY</code>\\n <desc>故障通告</desc>\\n </problemNotifyType>\\n <problemNotifyType>\\n <code>PROBLEM_UPDATE</code>\\n <desc>故障更新</desc>\\n </problemNotifyType>\\n <problemNotifyType>\\n <code>PROBLEM_UPGRADE</code>\\n <desc>故障升级</desc>\\n </problemNotifyType>\\n <problemNotifyType>\\n <code>PROBLEM_DEGRADE</code>\\n <desc>故障降级</desc>\\n </problemNotifyType>\\n <problemNotifyType>\\n <code>PROBLEM_RECOVER</code>\\n <desc>故障恢复</desc>\\n </problemNotifyType>\\n <problemNotifyType>\\n <code>PROBLEM_REISSUE</code>\\n <desc>故障补发</desc>\\n </problemNotifyType>\\n <problemNotifyType>\\n <code>PROBLEM_CANCEL</code>\\n <desc>故障取消</desc>\\n </problemNotifyType>\\n <UserQueryFields>\\n <code>USERNAME</code>\\n <desc>人员姓名</desc>\\n </UserQueryFields>\\n <UserQueryFields>\\n <code>PHONE</code>\\n <desc>人员手机号</desc>\\n </UserQueryFields>\\n <UserQueryFields>\\n <code>RAM_ID</code>\\n <desc>RAM账号ID</desc>\\n </UserQueryFields>\\n <incidentStatus>\\n <code>ASSIGNED</code>\\n <desc>已分派</desc>\\n </incidentStatus>\\n <incidentStatus>\\n <code>RESPONDED</code>\\n <desc>已响应</desc>\\n </incidentStatus>\\n <incidentStatus>\\n <code>FINISHED</code>\\n <desc>已完结</desc>\\n </incidentStatus>\\n </data>\\n</ListDictionariesResponse>","errorExample":""}]',
- ],
- 'ListMonitorSources' => [
- 'summary' => 'ListMonitorSources',
- 'path' => '/monitorSource/list',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": [\\n {\\n \\"subscriptionId\\": 10,\\n \\"subscriptionTitle\\": \\"test\\",\\n \\"scope\\": 0,\\n \\"notifyObjectType\\": 0,\\n \\"expiredType\\": \\"LONG_TERM\\",\\n \\"startTime\\": \\"2020-05-09 10:10:10\\",\\n \\"endTime\\": \\"2022-05-09 10:10:10\\",\\n \\"status\\": \\"ENABLE\\",\\n \\"scopeObjectList\\": [\\n {\\n \\"id\\": 10,\\n \\"scope\\": 0,\\n \\"scopeObjectId\\": 10,\\n \\"scopeObject\\": \\"阿里云服务\\",\\n \\"isValid\\": 0\\n }\\n ],\\n \\"notifyObjectList\\": [\\n {\\n \\"id\\": 10,\\n \\"notifyObjectType\\": 0,\\n \\"notifyObjectId\\": 10,\\n \\"name\\": \\"张珊\\",\\n \\"isValid\\": 0\\n }\\n ]\\n }\\n ],\\n \\"totalCount\\": 100,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","type":"json"}]',
+ 'title' => 'Notifications Subscription List',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-07T11:46:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListSubscriptions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSubscriptions'],
+ ],
+ ],
+ ],
+ 'ListTrendForSourceEvent' => [
+ 'summary' => 'Query trend statistics for alert sources.',
+ 'path' => '/events/querySourceEventTrend',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempBHVB81',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempIFJI1O'],
],
'parameters' => [
[
@@ -19729,94 +14411,472 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'xxxx', 'title' => '', 'required' => false],
+ 'instanceId' => ['description' => 'Alert or event ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => '', 'required' => false],
+ 'instanceType' => ['description' => 'Type', 'type' => 'string', 'example' => 'INCIDENT', 'title' => '', 'required' => false],
+ 'startTime' => ['description' => 'Start time', 'type' => 'string', 'example' => '2020-10-10 00:00:00', 'title' => '', 'required' => false],
+ 'endTime' => ['description' => 'End time', 'type' => 'string', 'example' => '2020-10-10 23:59:59', 'title' => '', 'required' => false],
+ 'timeUnit' => ['description' => 'Time unit in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Schema of Response',
'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
'data' => [
- 'description' => 'data',
+ 'description' => 'Statistics list',
'items' => [
+ 'description' => 'Statistics data',
'properties' => [
- 'monitorSourceId' => [
- 'description' => '',
- 'example' => '12',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'monitorSourceName' => [
- 'description' => '',
- 'example' => 'Zabbix',
- 'type' => 'string',
- ],
- 'fieldKeys' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => 'payload.content',
- 'type' => 'string',
- ],
- 'type' => 'array',
- ],
+ 'maxSustainTime' => ['description' => 'Maximum sustain duration', 'type' => 'integer', 'format' => 'int64', 'example' => '10920312312312', 'title' => ''],
+ 'convergenceRate' => ['description' => 'Convergence rate', 'type' => 'string', 'example' => '90.90%', 'title' => ''],
+ 'sourceEventsStatMap' => ['description' => 'Statistics grouped by monitoring source', 'type' => 'object', 'title' => '', 'example' => '{ "Grafana": [ { "evenTime": "2021-11-15 14:29:59", "eventCount": 4, "monitorSourceName": "Grafana", "monitorSourceCounts": null, "sustainTime": 15646 }, { "evenTime": "2021-11-15 14:30:36", "eventCount": 7, "monitorSourceName": "Grafana", "monitorSourceCounts": null, "sustainTime": 52638 } ] }'],
+ 'skipDay' => ['description' => 'Indicates whether the period spans multiple days', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'unit' => ['description' => 'Time unit', 'type' => 'string', 'title' => '', 'example' => '1000'],
],
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
'type' => 'array',
- ],
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'type' => 'string',
+ 'example' => '',
],
],
+ 'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"data\\": [\\n {\\n \\"monitorSourceId\\": 12,\\n \\"monitorSourceName\\": \\"Zabbix\\",\\n \\"fieldKeys\\": [\\n \\"payload.content\\"\\n ]\\n }\\n ],\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","errorExample":""},{"type":"xml","example":"<ListMonitorSourcesResponse>\\n <monitorSourceId>1</monitorSourceId>\\n <fieldKeys>payload.content</fieldKeys>\\n <fieldKeys>payload.summary</fieldKeys>\\n <fieldKeys>payload.testarr[].a</fieldKeys>\\n <fieldKeys>payload.testarr[].b</fieldKeys>\\n <fieldKeys>payload.title</fieldKeys>\\n <monitorSourceName>zabbix</monitorSourceName>\\n</ListMonitorSourcesResponse>\\n<ListMonitorSourcesResponse>\\n <monitorSourceId>9</monitorSourceId>\\n <fieldKeys>payload.testarr[].a</fieldKeys>\\n <fieldKeys>payload.testarr[].b</fieldKeys>\\n <fieldKeys>payload.title</fieldKeys>\\n <monitorSourceName>网易云</monitorSourceName>\\n</ListMonitorSourcesResponse>\\n<ListMonitorSourcesResponse>\\n <monitorSourceId>8</monitorSourceId>\\n <fieldKeys>payload.content</fieldKeys>\\n <fieldKeys>payload.summary</fieldKeys>\\n <fieldKeys>payload.title</fieldKeys>\\n <monitorSourceName>腾讯云</monitorSourceName>\\n</ListMonitorSourcesResponse>","errorExample":""}]',
- ],
- 'CreateTenantApplication' => [
- 'summary' => '云钉协同创建移动应用',
- 'path' => '/mobileApp/create',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxxx\\",\\n \\"data\\": [\\n {\\n \\"maxSustainTime\\": 10920312312312,\\n \\"convergenceRate\\": \\"90.90%\\",\\n \\"sourceEventsStatMap\\": {\\n \\"Grafana\\": [\\n {\\n \\"evenTime\\": \\"2021-11-15 14:29:59\\",\\n \\"eventCount\\": 4,\\n \\"monitorSourceName\\": \\"Grafana\\",\\n \\"monitorSourceCounts\\": null,\\n \\"sustainTime\\": 15646\\n },\\n {\\n \\"evenTime\\": \\"2021-11-15 14:30:36\\",\\n \\"eventCount\\": 7,\\n \\"monitorSourceName\\": \\"Grafana\\",\\n \\"monitorSourceCounts\\": null,\\n \\"sustainTime\\": 52638\\n }\\n ]\\n },\\n \\"skipDay\\": true,\\n \\"unit\\": \\"1000\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query alerting source trend statistics ',
+ 'requestParamsDescription' => '{"instanceId":78958441,"instanceType":"ALERT","clientToken":"82af9e74-6592-435d-aa06-345562cdd37c"}',
+ 'responseParamsDescription' => '{'."\n"
+ .'"requestId": "gdgsdgsggsdg",'."\n"
+ .'"data": {'."\n"
+ .'"maxSustainTime": 3619249886,'."\n"
+ .'"convergenceRate": "98.57%",'."\n"
+ .'"unit": "hour",'."\n"
+ .'"startTime": "2021-11-29 20:03:15",'."\n"
+ .'"endTime": "2022-01-10 17:24:05",'."\n"
+ .'"skipDay": true,'."\n"
+ .'"sourceEventsStatMap": {'."\n"
+ .'"Grafana": \\['."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-07 17:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-07 18:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-07 19:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-07 20:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-07 21:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-07 22:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-07 23:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 00:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 01:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 02:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 03:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 04:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 05:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 06:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 07:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 08:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 09:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 10:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 11:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 12:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 13:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 14:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 15:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 16:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 17:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 18:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 19:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 20:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 21:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 22:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-08 23:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 00:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 01:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 02:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 03:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 04:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 05:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 06:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 07:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 08:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 09:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 10:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 11:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 12:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 13:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 14:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 15:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 16:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 17:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 18:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 19:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 20:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 21:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 22:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-09 23:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 00:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 01:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 02:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 03:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 04:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 05:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 06:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 07:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 08:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 09:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 10:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 11:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 12:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 13:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 14:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 15:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 16:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"evenTime": "2022-01-10 17:00:00",'."\n"
+ .'"eventCount": 0,'."\n"
+ .'"monitorSourceName": "Grafana"'."\n"
+ .'}'."\n"
+ .']'."\n"
+ .'}'."\n"
+ .'}'."\n"
+ .'}',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListTrendForSourceEvent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'ListUserSerivceGroups' => [
+ 'summary' => 'User preview',
+ 'path' => '/user/preview/detail',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempU4CBQS',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempCICFVA'],
],
'parameters' => [
[
@@ -19824,105 +14884,107 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'channel' => [
- 'description' => '',
- 'example' => 'DINGDING',
- 'required' => true,
- 'title' => '应用协同渠道',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
- 'required' => true,
- 'title' => '幂等标识',
- 'type' => 'string',
- ],
+ 'userId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''],
+ 'clientToken' => ['title' => 'clientToken', 'description' => 'Idempotency token.', 'type' => 'string', 'required' => false, 'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef729f'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'id of the req',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'title' => 'id of the req',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef7291'],
'data' => [
- 'description' => 'data',
+ 'description' => 'Response data.',
'properties' => [
- 'openUrl' => [
- 'description' => '',
- 'example' => 'http://xxxx',
- 'title' => '开通url',
- 'type' => 'string',
- ],
- 'progress' => [
- 'description' => '',
- 'example' => 'OPENED 已开通 OPENING 开通中',
- 'title' => '开通进度状态',
- 'type' => 'string',
+ 'ramId' => ['description' => 'RAM user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '321', 'title' => ''],
+ 'userId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '321', 'title' => ''],
+ 'username' => ['description' => 'Nickname.', 'type' => 'string', 'example' => '马先生', 'title' => ''],
+ 'phone' => ['description' => 'Phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''],
+ 'email' => ['description' => 'Email address.', 'type' => 'string', 'example' => '12121****@163.com', 'title' => ''],
+ 'serviceGroups' => [
+ 'description' => 'Service groups that the user belongs to.',
+ 'items' => [
+ 'description' => 'Service group.',
+ 'properties' => [
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'serviceGroupName' => ['description' => 'Service group name.', 'type' => 'string', 'example' => '测试组', 'title' => ''],
+ 'serviceGroupDescription' => ['description' => 'Service group description.', 'type' => 'string', 'example' => '这是一个服务组描述', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
],
- 'title' => 'data',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'TenantAppAlreadyExisit',
- 'errorMessage' => 'App is opened.',
- ],
+ 404 => [
+ ['errorCode' => 'UserTypeNotExisted', 'errorMessage' => 'The user type does not exist.', 'description' => 'User type is not existed'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"openUrl\\": \\"http://xxxx\\",\\n \\"progress\\": \\"OPENED\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateTenantApplicationResponse>\\n <requestId>10REQUES-AC5C-4B59-BE11-378F117A6A88</requestId>\\n <data>\\n <openUrl>http://xxxx</openUrl>\\n <progress>OPENED </progress>\\n </data>\\n</CreateTenantApplicationResponse>","errorExample":""}]',
- ],
- 'GetTenantApplication' => [
- 'summary' => '云钉协同移动应用详情',
- 'path' => '/mobileApp/detail',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2b63cdef-7ac3-4892-a76d-0f3389ef7291\\",\\n \\"data\\": {\\n \\"ramId\\": 321,\\n \\"userId\\": 321,\\n \\"username\\": \\"马先生\\",\\n \\"phone\\": \\"1390000****\\",\\n \\"email\\": \\"12121****@163.com\\",\\n \\"serviceGroups\\": [\\n {\\n \\"serviceGroupId\\": 123,\\n \\"serviceGroupName\\": \\"测试组\\",\\n \\"serviceGroupDescription\\": \\"这是一个服务组描述\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'User Preview',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListUserSerivceGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserSerivceGroups'],
+ ],
],
+ ],
+ 'ListUsers' => [
+ 'summary' => 'User List.',
+ 'path' => '/user/list',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempU4CBQS',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempT8ZOYV'],
],
'parameters' => [
[
@@ -19930,203 +14992,215 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
- 'required' => true,
- 'title' => '幂等标识',
- 'type' => 'string',
- ],
+ 'username' => ['description' => 'User name.', 'type' => 'string', 'example' => '张先生', 'title' => '', 'required' => false],
+ 'phone' => ['description' => 'Mobile phone number.', 'type' => 'string', 'example' => '1887879****', 'title' => '', 'required' => false],
+ 'ramId' => ['title' => 'ramID', 'description' => 'RAM user ID.', 'type' => 'string', 'example' => '1344383', 'required' => false],
+ 'scene' => ['description' => '- ALL\\_USERS: All users.'."\n"
+ ."\n"
+ .'- USER\\_LIST: User list.', 'type' => 'integer', 'format' => 'int64', 'example' => 'USER_LIST', 'title' => '', 'required' => false],
+ 'clientToken' => ['title' => 'clientToken', 'description' => 'Idempotency token.', 'type' => 'string', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81', 'required' => false],
+ 'pageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'pageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => '', 'required' => false],
+ 'synergyChannel' => ['description' => 'Mobile app channel.', 'type' => 'string', 'example' => 'DINGDING', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
+ 'requestId' => ['title' => 'id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81'],
'data' => [
- 'description' => 'data',
- 'properties' => [
- 'corporationId' => [
- 'description' => '',
- 'example' => 'ding81913c*',
- 'title' => '企业id',
- 'type' => 'string',
- ],
- 'bizId' => [
- 'description' => '',
- 'example' => '7356',
- 'title' => '业务id',
- 'type' => 'string',
- ],
- 'progress' => [
- 'description' => '',
- 'example' => 'NOT_OPEN',
- 'title' => '进度',
- 'type' => 'string',
- ],
- 'channel' => [
- 'description' => '',
- 'example' => 'DINGDING',
- 'title' => '云钉协同渠道',
- 'type' => 'string',
- ],
- 'originalCorpId' => [
- 'type' => 'string',
+ 'description' => 'Returned results.',
+ 'items' => [
+ 'description' => 'User.',
+ 'properties' => [
+ 'userId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'],
+ 'ramId' => ['description' => 'RAM user ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '53624523'],
+ 'username' => ['description' => 'Username.', 'type' => 'string', 'title' => '', 'example' => '张先生'],
+ 'phone' => ['description' => 'Mobile phone number.', 'type' => 'string', 'title' => '', 'example' => '1887879****'],
+ 'email' => ['description' => 'Mailbox.', 'type' => 'string', 'title' => '', 'example' => '2345****@qq.com'],
+ 'isEditableUser' => ['description' => 'Whether the user is editable.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'true'],
+ 'accountType' => ['description' => 'RAM account type:'."\n"
+ ."\n"
+ .'- 0: Alibaba Cloud account.'."\n"
+ ."\n"
+ .'- 1: RAM user.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'appAccount' => ['description' => 'Application account.', 'type' => 'string', 'example' => '23456tre', 'title' => ''],
+ 'synergyChannel' => ['description' => 'Mobile app collaboration channel.', 'type' => 'string', 'example' => 'DINGDING', 'title' => ''],
+ 'isRelated' => ['description' => 'Whether associated:'."\n"
+ ."\n"
+ .'- RELATED: Associated.'."\n"
+ ."\n"
+ .'- NOT\\_RELATED: Not associated.', 'type' => 'string', 'example' => 'RELATED', 'title' => ''],
+ 'isOperation' => ['title' => 'Operable (delete, disassociate): 1 for yes, 0 for no', 'description' => 'Whether the user can be operated on (for example, deleted or disassociated):'."\n"
+ ."\n"
+ .'- 1: Yes.'."\n"
+ ."\n"
+ .'- 0: No.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'isRam' => ['title' => 'Primary account: 1 for yes, 0 for no', 'description' => 'Whether the user is an Alibaba Cloud account:'."\n"
+ ."\n"
+ .'- 1: Yes.'."\n"
+ ."\n"
+ .'- 0: No.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'roleIdList' => [
+ 'description' => 'Role ID list.',
+ 'title' => 'Role ID List',
+ 'type' => 'array',
+ 'items' => ['description' => 'List of role IDs.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''],
+ 'example' => '',
+ ],
+ 'roleNameList' => [
+ 'description' => 'Role name list.',
+ 'title' => 'Role Name List',
+ 'type' => 'array',
+ 'items' => ['description' => 'List of role names.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'example' => '',
+ ],
+ 'isActive' => ['title' => 'Account Activation Status (1: Activated, 0: Not Activated)', 'description' => 'Whether the account is activated:'."\n"
+ ."\n"
+ .'- 1: Activated.'."\n"
+ ."\n"
+ .'- 0: Not activated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'gmtCreate' => ['description' => 'Creation time.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'gmtActive' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
'title' => 'data',
- 'type' => 'object',
- ],
- 'requestId' => [
- 'description' => 'id of the request',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'title' => 'id of the request',
- 'type' => 'string',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'totalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'pageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\",\\n \\"data\\": [\\n {\\n \\"userId\\": 1234,\\n \\"ramId\\": 53624523,\\n \\"username\\": \\"张先生\\",\\n \\"phone\\": \\"1887879****\\",\\n \\"email\\": \\"2345****@qq.com\\",\\n \\"isEditableUser\\": 0,\\n \\"accountType\\": 1,\\n \\"appAccount\\": \\"23456tre\\",\\n \\"synergyChannel\\": \\"DINGDING\\",\\n \\"isRelated\\": \\"RELATED\\",\\n \\"isOperation\\": 1,\\n \\"isRam\\": 1,\\n \\"roleIdList\\": [\\n 0\\n ],\\n \\"roleNameList\\": [\\n \\"\\"\\n ],\\n \\"isActive\\": 1,\\n \\"gmtCreate\\": \\"\\",\\n \\"gmtActive\\": \\"\\"\\n }\\n ],\\n \\"totalCount\\": 100,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","type":"json"}]',
+ 'title' => 'User List ',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-15T11:46:18.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-04-13T12:01:54.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"data\\": {\\n \\"corporationId\\": \\"ding81913c*\\",\\n \\"bizId\\": \\"7356\\",\\n \\"progress\\": \\"NOT_OPEN\\",\\n \\"channel\\": \\"DINGDING\\",\\n \\"originalCorpId\\": \\"\\"\\n },\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","errorExample":""},{"type":"xml","example":"<GetTenantApplicationResponse>\\n <data>\\n <corporationId>ding81913c*</corporationId>\\n <bizId>7356</bizId>\\n <progress>NOT_OPEN</progress>\\n <channel>DINGDING</channel>\\n </data>\\n <requestId>10REQUES-AC5C-4B59-BE11-378F117A6A88</requestId>\\n</GetTenantApplicationResponse>","errorExample":""}]',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsers'],
+ ],
+ ],
],
'PushMonitor' => [
- 'summary' => '监控数据接入API',
+ 'summary' => 'Pushes and stores business monitoring data.',
'path' => '/api/monitor/push/{apiKey}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'Anonymous' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempW81V8D',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempW81V8D'],
],
'parameters' => [
[
'name' => 'apiKey',
'in' => 'path',
- 'schema' => [
- 'description' => '',
- 'example' => 'dfb2e51a58e64152a0eef7a232308006',
- 'required' => true,
- 'title' => '集成接入的apiKey',
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'API key for integration.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dfb2e51a58e64152a0eef7a232308006'],
],
[
'name' => 'body',
'in' => 'body',
- 'schema' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'title' => '推送的数据内容',
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'Data to push.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2022-12-16 09:52:34.164 ConsumeMessageThread_13 INFO LOGGER_SPM 订单创建|Y|10'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'description' => 'Response object.',
'properties' => [
- 'data' => [
- 'description' => '',
- 'example' => 'null',
- 'type' => 'any',
- ],
- 'requestId' => [
- 'description' => '',
- 'example' => '5A30D240-1821-0246-B580-AB1468657AD2',
- 'type' => 'string',
- ],
+ 'data' => ['description' => 'Response data. Returns null on success.', 'type' => 'any', 'example' => 'null', 'title' => ''],
+ 'requestId' => ['description' => 'Unique ID for the request.', 'type' => 'string', 'example' => '5A30D240-1821-0246-B580-AB1468657AC2', 'title' => ''],
],
'title' => '{@link Result}',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidTag.Mismatch',
- 'errorMessage' => 'The specified Tag.n.Key and Tag.n.Value are not match.',
- ],
- [
- 'errorCode' => 'InvalidTagCount',
- 'errorMessage' => 'The specified tags are beyond the permitted range.',
- ],
+ ['errorCode' => 'InvalidTag.Mismatch', 'errorMessage' => 'The specified Tag.n.Key and Tag.n.Value are not match.', 'description' => ''],
+ ['errorCode' => 'InvalidTagCount', 'errorMessage' => 'The specified tags are beyond the permitted range.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'InvalidInstanceChargeType.NotFound',
- 'errorMessage' => 'The InstanceChargeType does not exist in our records',
- ],
- [
- 'errorCode' => 'InvalidInternetChargeType.ValueNotSupported',
- 'errorMessage' => 'The specified InternetChargeType is not valid',
- ],
+ ['errorCode' => 'InvalidInstanceChargeType.NotFound', 'errorMessage' => 'The InstanceChargeType does not exist in our records', 'description' => ''],
+ ['errorCode' => 'InvalidInternetChargeType.ValueNotSupported', 'errorMessage' => 'The specified InternetChargeType is not valid', 'description' => ''],
],
],
'staticInfo' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"data\\": \\"null\\",\\n \\"requestId\\": \\"5A30D240-1821-0246-B580-AB1468657AC2\\"\\n}","errorExample":""},{"type":"xml","example":"<PushMonitorResponse>\\n <data>null</data>\\n <requestId>5A30D240-1821-0246-B580-AB1468657AD2</requestId>\\n</PushMonitorResponse>","errorExample":""}]',
- ],
- 'ListEscalationPlanServices' => [
- 'summary' => '获取已选中的服务对象',
- 'path' => '/escalationPlan/services',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"null\\",\\n \\"requestId\\": \\"5A30D240-1821-0246-B580-AB1468657AC2\\"\\n}","type":"json"}]',
+ 'title' => 'API Integration ',
+ 'extraInfo' => '<props="china">Publish only on the China site</props>',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'RecoverProblem' => [
+ 'summary' => 'Fault recovery.',
+ 'path' => '/problem/recovery',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgempZB7ZAW'],
],
'parameters' => [
[
@@ -20136,17 +15210,22 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'clientToken' => [
- 'description' => 'clientToken',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
+ 'problemId' => ['description' => 'Problem ID.', 'example' => '123', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'recoveryTime' => ['description' => 'Recovery time.', 'example' => '2020-02-01 00:00:00', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'problemNotifyType' => ['description' => 'Notification type'."\n"
+ ."\n"
+ .'- PROBLEM_NOTIFY: Problem notification.'."\n"
+ .'- PROBLEM_UPDATE: Problem update.'."\n"
+ .'- PROBLEM_UPGRADE: Problem upgrade.'."\n"
+ .'- PROBLEM_DEGRADE: Problem downgrade.'."\n"
+ .'- PROBLEM_RECOVER: Problem recovery.'."\n"
+ .'- PROBLEM_REISSUE: Problem reissue.'."\n"
+ .'- PROBLEM_CANCEL: Problem cancellation.', 'example' => 'PROBLEM_UPDATE', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -20155,74 +15234,63 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'data',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'scope' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'title' => '范围类型',
- 'type' => 'string',
- ],
- 'scopeObjectId' => [
- 'description' => '',
- 'example' => '23',
- 'format' => 'int64',
- 'title' => '范围对象id',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => 'data',
- 'type' => 'array',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'EBC39DEF-C95B-46F8-9AE3-204F0B0A706D', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\",\\n \\"data\\": [\\n {\\n \\"scope\\": \\"SERVICE\\",\\n \\"scopeObjectId\\": 23\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListEscalationPlanServicesResponse>\\n <requestId>A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST</requestId>\\n <data>\\n <scope>SERVICE</scope>\\n <scopeObjectId>23</scopeObjectId>\\n </data>\\n</ListEscalationPlanServicesResponse>","errorExample":""}]',
- ],
- 'CreateEscalationPlan' => [
- 'summary' => '创建升级计划',
- 'path' => '/escalationPlan/create',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ProblemStatusError', 'errorMessage' => 'The problem status is abnormal.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"EBC39DEF-C95B-46F8-9AE3-204F0B0A706D\\"\\n}","type":"json"}]',
+ 'title' => 'Fault recovery',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:RecoverProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecoverProblem'],
+ ],
],
+ ],
+ 'RefreshIntegrationConfigKey' => [
+ 'summary' => 'Purge the Integration key. ',
+ 'path' => '/integrationConfig/refreshKey',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempGUN0ZL',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempBHVB81'],
],
'parameters' => [
[
@@ -20232,187 +15300,13 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'escalationPlanName' => [
- 'description' => '',
- 'example' => 'name123',
- 'required' => true,
- 'title' => '升级计划名称',
- 'type' => 'string',
- ],
- 'escalationPlanDescription' => [
- 'description' => '',
- 'example' => 'desc2322424',
- 'required' => true,
- 'title' => '升级计划描述',
- 'type' => 'string',
- ],
- 'escalationPlanScopeObjects' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'scopeObjectId' => [
- 'description' => '',
- 'example' => '23433',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '范围对象id',
- 'type' => 'integer',
- ],
- 'scope' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'required' => false,
- 'title' => '范围对象类型',
- 'type' => 'string',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '升级计划范围对象列表',
- 'type' => 'array',
- ],
- 'escalationPlanRules' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'escalationPlanConditions' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'level' => [
- 'description' => '',
- 'example' => 'P1',
- 'required' => true,
- 'title' => '事件等级',
- 'type' => 'string',
- ],
- 'effection' => [
- 'description' => '',
- 'example' => 'LOW',
- 'required' => true,
- 'title' => '影响等级',
- 'type' => 'string',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '升级条件',
- 'type' => 'array',
- ],
- 'escalationPlanStrategies' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'noticeTime' => [
- 'description' => '',
- 'example' => '40',
- 'required' => true,
- 'title' => '通知时间',
- 'type' => 'string',
- ],
- 'noticeObjects' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '[23,345]',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'required' => true,
- 'title' => '升级通知对象id列表',
- 'type' => 'array',
- ],
- 'noticeChannels' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '["SMS","PHONE"]',
- 'required' => true,
- 'type' => 'string',
- ],
- 'required' => true,
- 'title' => '升级通知策略',
- 'type' => 'array',
- ],
- 'enableWebhook' => [
- 'description' => '',
- 'example' => 'true',
- 'required' => true,
- 'title' => '是否支持群通知',
- 'type' => 'boolean',
- ],
- 'serviceGroupIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '434',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'required' => false,
- 'title' => '服务组id',
- 'type' => 'array',
- ],
- 'escalationPlanType' => [
- 'title' => '升级类型',
- 'type' => 'string',
- ],
- 'noticeRoleList' => [
- 'title' => '通知角色列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '升级策略',
- 'type' => 'array',
- ],
- 'escalationPlanType' => [
- 'description' => '',
- 'example' => 'UN_FINISH',
- 'required' => true,
- 'title' => '升级类型(废弃)',
- 'type' => 'string',
- ],
- ],
- 'required' => true,
- 'type' => 'object',
- ],
- 'required' => true,
- 'title' => '升级计划规则列表',
- 'type' => 'array',
- ],
- 'clientToken' => [
- 'description' => 'clientToken',
- 'example' => '6b404f14-77d1-4b53-a1a1-30a58bREQUEST',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
- 'isGlobal' => [
- 'title' => '是否是全局策略',
- 'type' => 'boolean',
- ],
+ 'integrationConfigId' => ['description' => 'Integration configuration ID. ', 'example' => '102', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotency identity. ', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -20421,84 +15315,72 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'title' => 'Id of the request', 'type' => 'string'],
'data' => [
'description' => 'data',
'properties' => [
- 'escalationPlanId' => [
- 'description' => '',
- 'example' => '234532',
- 'format' => 'int64',
- 'title' => '升级计划id',
- 'type' => 'integer',
- ],
+ 'key' => ['description' => 'Integration key. ', 'example' => '859FA6A2-AC5C-4B09-BE23-986F887H6A232', 'title' => '', 'type' => 'string'],
],
- 'title' => 'data',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'EscalationPlanRuleNull',
- 'errorMessage' => 'Escalation plan rule can not be null.',
- ],
- [
- 'errorCode' => 'EscalationPlanServiceNull',
- 'errorMessage' => 'Escalation plan service can not be nulll',
- ],
- [
- 'errorCode' => 'EscalationPlanAlreadyExisted',
- 'errorMessage' => 'The escalation plan already exists.',
- ],
- [
- 'errorCode' => 'EscalationPlanServiceAleardyRelated',
- 'errorMessage' => 'The specified service is already related.',
- ],
+ 403 => [
+ ['errorCode' => 'IntegationConfigNotDisable', 'errorMessage' => 'The specified integration config is not disabled.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'IntegationConfigNotExists', 'errorMessage' => 'The specified integration config does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC21925D\\",\\n \\"data\\": {\\n \\"escalationPlanId\\": 234532\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateEscalationPlanResponse>\\n <requestId>A5A1FEAE-9C47-011C-9C73-A376BC21925D</requestId>\\n <data>\\n <escalationPlanId>234532</escalationPlanId>\\n </data>\\n</CreateEscalationPlanResponse>","errorExample":""}]',
- ],
- 'DeleteEscalationPlan' => [
- 'summary' => '删除升级计划',
- 'path' => '/escalationPlan/delete',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"data\\": {\\n \\"key\\": \\"859FA6A2-AC5C-4B09-BE23-986F887H6A232\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Purge Integration key ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'gemp:RefreshIntegrationConfigKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshIntegrationConfigKey'],
+ ],
],
+ ],
+ 'RemoveIntegrationConfig' => [
+ 'summary' => 'Removes an integration configuration.',
+ 'path' => '/integrationConfig/remove',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempGUN0ZL',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempSLACC7'],
],
'parameters' => [
[
@@ -20506,87 +15388,86 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'title' => 'A short description of struct',
+ 'description' => 'The request body.',
+ 'type' => 'object',
'properties' => [
- 'escalationPlanId' => [
- 'description' => '',
- 'example' => '234534',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '升级计划ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
+ 'integrationConfigId' => ['description' => 'The ID of the integration configuration.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '103', 'title' => ''],
+ 'clientToken' => ['description' => 'The idempotency token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9'],
],
'required' => false,
- 'title' => 'A short description of struct',
- 'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
- 'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- ],
'title' => 'Schema of Response',
+ 'description' => 'The response structure.',
'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88'],
+ ],
+ 'example' => '',
],
],
],
'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'EscalationPlanNotExists',
- 'errorMessage' => 'The specified escalation plan does not exist.',
- ],
+ 400 => [
+ ['errorCode' => 'IntegrationConfigExistsRouteRule', 'errorMessage' => 'integration config exists routeRule.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'IntegationConfigNotIntegrated', 'errorMessage' => 'The specified integration config is not integrated.', 'description' => ''],
+ ['errorCode' => 'IntegationConfigAlreadyDisable', 'errorMessage' => 'The specified integration config is already disabled.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'IntegationConfigNotExists', 'errorMessage' => 'The specified integration config does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC21925D\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEscalationPlanResponse>\\n <requestId>A5A1FEAE-9C47-011C-9C73-A376BC21925D</requestId>\\n</DeleteEscalationPlanResponse>","errorExample":""}]',
- ],
- 'DisableEscalationPlan' => [
- 'summary' => '禁用升级计划',
- 'path' => '/escalationPlan/disable',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","type":"json"}]',
+ 'title' => 'Disassociate integration configuration ',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-07T11:35:47.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:RemoveIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveIntegrationConfig'],
+ ],
],
+ ],
+ 'RemoveProblemServiceGroup' => [
+ 'summary' => 'You can remove the Incident Response Collaboration Group.',
+ 'path' => '/problem/removeServiceGroup',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempGUN0ZL',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1XQ9JR'],
],
'parameters' => [
[
@@ -20594,93 +15475,79 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'escalationPlanId' => [
- 'description' => '',
- 'example' => '234534',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '升级计划ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
+ 'problemId' => ['description' => 'Problem ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '13123'],
+ 'serviceGroupIds' => [
+ 'description' => 'Response groups.',
+ 'items' => ['description' => 'Emergency coordination group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '应急协同组ID', 'required' => false, 'title' => ''],
'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '5AD6E6BC-2582-4E0E-832D-52CB1B922253'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'EscalationPlanAlreadyDisable',
- 'errorMessage' => 'The escalation plan is already disabled.',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"5AD6E6BC-2582-4E0E-832D-52CB1B922253\\"\\n}","type":"json"}]',
+ 'title' => 'Remove the fault emergency collaboration group',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:RemoveProblemServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 404 => [
- [
- 'errorCode' => 'EscalationPlanNotExists',
- 'errorMessage' => 'The specified escalation plan does not exist.',
- ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveProblemServiceGroup'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC21925D\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableEscalationPlanResponse>\\n <requestId>A5A1FEAE-9C47-011C-9C73-A376BC21925D</requestId>\\n</DisableEscalationPlanResponse>","errorExample":""}]',
],
- 'EnableEscalationPlan' => [
- 'summary' => '启用升级计划',
- 'path' => '/escalationPlan/enable',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ReplayProblem' => [
+ 'summary' => 'Incident postmortem.',
+ 'path' => '/problem/replay',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempGUN0ZL',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZB7ZAW'],
],
'parameters' => [
[
@@ -20690,25 +15557,14 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'escalationPlanId' => [
- 'description' => '',
- 'example' => '234534',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '升级计划ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
+ 'problemId' => ['description' => 'Incident ID', 'example' => '123', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'replayDutyUserId' => ['description' => 'Owner ID of the postmortem', 'example' => '3123', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency token', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3212', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -20717,384 +15573,154 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'B81E84B5-8FD1-45F3-969A-B5067AADCFFF', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EscalationPlanAlreadyEnable',
- 'errorMessage' => 'The escalation plan is already enabled.',
- ],
+ ['errorCode' => 'ProblemStatusError', 'errorMessage' => 'The problem status is abnormal.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'EscalationPlanNotExists',
- 'errorMessage' => 'The specified escalation plan does not exist.',
- ],
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC21925D\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableEscalationPlanResponse>\\n <requestId>A5A1FEAE-9C47-011C-9C73-A376BC21925D</requestId>\\n</EnableEscalationPlanResponse>","errorExample":""}]',
- ],
- 'GetEscalationPlan' => [
- 'summary' => '升级计划详情',
- 'path' => '/escalationPlan/detail',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B81E84B5-8FD1-45F3-969A-B5067AADCFFF\\"\\n}","type":"json"}]',
+ 'title' => 'Incident postmortem',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:ReplayProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReplayProblem'],
+ ],
],
+ ],
+ 'RespondIncident' => [
+ 'summary' => 'Responds to an incident.',
+ 'path' => '/incident/response',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempGUN0ZL',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempHBPHMV'],
],
'parameters' => [
[
- 'name' => 'body',
+ 'name' => 'Body',
'in' => 'body',
- 'style' => 'json',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'escalationPlanId' => [
- 'description' => '',
- 'example' => '345',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '升级计划id',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
+ 'incidentIds' => [
+ 'description' => 'Array of incident IDs.',
+ 'items' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12312', 'title' => ''],
'required' => false,
- 'title' => '幂等标识',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'clientToken' => ['description' => 'Idempotency check.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A221'],
],
- 'required' => false,
- 'title' => 'A short description of struct',
+ 'required' => true,
+ 'title' => '',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'data',
- 'properties' => [
- 'escalationPlanId' => [
- 'description' => '',
- 'example' => '2345',
- 'format' => 'int64',
- 'title' => '升级计划id',
- 'type' => 'integer',
- ],
- 'escalationPlanName' => [
- 'description' => '',
- 'example' => '升级计划234',
- 'title' => '升级计划名称',
- 'type' => 'string',
- ],
- 'escalationPlanDescription' => [
- 'description' => '',
- 'example' => '描述1234',
- 'title' => '升级计划描述',
- 'type' => 'string',
- ],
- 'escalationPlanScopeObjects' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'scopeObjectId' => [
- 'description' => '',
- 'example' => '234',
- 'format' => 'int64',
- 'title' => '范围对象id',
- 'type' => 'integer',
- ],
- 'scope' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'title' => '范围对象类型',
- 'type' => 'string',
- ],
- 'scopeObjectName' => [
- 'description' => '',
- 'example' => 'xx服务',
- 'title' => '范围对象名称',
- 'type' => 'string',
- ],
- 'escalationPlanScopeObjects' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '服务删除字段 1正常 0删除',
- 'type' => 'integer',
- ],
- 'scopeObjectDeletedType' => [
- 'description' => '',
- 'format' => 'int32',
- 'title' => '服务删除字段 1正常 0删除',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '升级计划范围对象列表',
- 'type' => 'array',
- ],
- 'escalationPlanRules' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'escalationPlanRuleId' => [
- 'description' => '',
- 'example' => '345',
- 'format' => 'int64',
- 'title' => '升级计划id',
- 'type' => 'integer',
- ],
- 'escalationPlanConditions' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'level' => [
- 'description' => '',
- 'example' => 'P1',
- 'title' => '事件等级',
- 'type' => 'string',
- ],
- 'effection' => [
- 'description' => '',
- 'example' => 'LOW',
- 'title' => '影响等级',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '升级计划条件',
- 'type' => 'array',
- ],
- 'escalationPlanStrategies' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'noticeTime' => [
- 'description' => '',
- 'example' => '40',
- 'format' => 'int64',
- 'title' => '通知时间',
- 'type' => 'integer',
- ],
- 'escalationPlanType' => [
- 'description' => '',
- 'example' => 'UN_ACKNOWLEDGE',
- 'title' => '升级计划类型',
- 'type' => 'string',
- ],
- 'noticeObjectList' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'noticeObjectId' => [
- 'description' => '',
- 'example' => '234',
- 'format' => 'int64',
- 'title' => '通知对象id',
- 'type' => 'integer',
- ],
- 'noticeObjectName' => [
- 'description' => '',
- 'example' => '张老三',
- 'title' => '通知对象名称',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '通知对象列表',
- 'type' => 'array',
- ],
- 'noticeChannels' => [
- 'description' => '',
- 'example' => 'SMS',
- 'title' => '通知对象渠道',
- 'type' => 'string',
- ],
- 'enableWebhook' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '是否支持群通知',
- 'type' => 'boolean',
- ],
- 'serviceGroups' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '343',
- 'format' => 'int64',
- 'title' => '服务组id',
- 'type' => 'integer',
- ],
- 'serviceGroupName' => [
- 'description' => '',
- 'example' => 'VCD是',
- 'title' => '服务组名称',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '服务组列表',
- 'type' => 'array',
- ],
- 'noticeObjects' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'noticeRoleList' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'noticeRoleObjectList' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'name' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '升级计划策略',
- 'type' => 'array',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '升级计划规则列表',
- 'type' => 'array',
- ],
- 'createTime' => [
- 'description' => '',
- 'example' => '2021-09-09 09:09:09',
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'isGlobal' => [
- 'title' => '是否是全局策略',
- 'type' => 'boolean',
- 'default' => 'false',
- ],
- ],
- 'title' => 'data',
- 'type' => 'object',
- ],
+ 'requestId' => ['title' => 'requestId', 'description' => 'Request ID.', 'type' => 'string', 'example' => '062E6568-E505-49D6-8DD0-8F11283EB0AB'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IncidentStatusInvalid', 'errorMessage' => 'The incident status is invalid.', 'description' => ''],
+ ['errorCode' => 'IncidentUpdateInvalid', 'errorMessage' => 'The incident update is invalid.', 'description' => ''],
+ ],
404 => [
- [
- 'errorCode' => 'EscalationPlanNotExists',
- 'errorMessage' => 'The specified escalation plan does not exist.',
- ],
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\",\\n \\"data\\": {\\n \\"escalationPlanId\\": 2345,\\n \\"escalationPlanName\\": \\"升级计划234\\",\\n \\"escalationPlanDescription\\": \\"描述1234\\",\\n \\"escalationPlanScopeObjects\\": [\\n {\\n \\"scopeObjectId\\": 234,\\n \\"scope\\": \\"SERVICE\\",\\n \\"scopeObjectName\\": \\"xx服务\\",\\n \\"escalationPlanScopeObjects\\": 1,\\n \\"scopeObjectDeletedType\\": 1\\n }\\n ],\\n \\"escalationPlanRules\\": [\\n {\\n \\"escalationPlanRuleId\\": 345,\\n \\"escalationPlanConditions\\": [\\n {\\n \\"level\\": \\"P1\\",\\n \\"effection\\": \\"LOW\\"\\n }\\n ],\\n \\"escalationPlanStrategies\\": [\\n {\\n \\"noticeTime\\": 40,\\n \\"escalationPlanType\\": \\"UN_ACKNOWLEDGE\\",\\n \\"noticeObjectList\\": [\\n {\\n \\"noticeObjectId\\": 234,\\n \\"noticeObjectName\\": \\"张老三\\"\\n }\\n ],\\n \\"noticeChannels\\": \\"SMS\\",\\n \\"enableWebhook\\": true,\\n \\"serviceGroups\\": [\\n {\\n \\"id\\": 343,\\n \\"serviceGroupName\\": \\"VCD是\\"\\n }\\n ],\\n \\"noticeObjects\\": [\\n 111\\n ],\\n \\"noticeRoleList\\": [\\n 222\\n ],\\n \\"noticeRoleObjectList\\": [\\n {\\n \\"id\\": 111,\\n \\"name\\": \\"XX服务组\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"createTime\\": \\"2021-09-09 09:09:09\\",\\n \\"isGlobal\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetEscalationPlanResponse>\\n <requestId>A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST</requestId>\\n <data>\\n <escalationPlanId>2345</escalationPlanId>\\n <escalationPlanName>升级计划234</escalationPlanName>\\n <escalationPlanDescription>描述1234</escalationPlanDescription>\\n <escalationPlanScopeObjects>\\n <scopeObjectId>234</scopeObjectId>\\n <scope>SERVICE</scope>\\n <scopeObjectName>xx服务</scopeObjectName>\\n </escalationPlanScopeObjects>\\n <escalationPlanRules>\\n <escalationPlanRuleId>345</escalationPlanRuleId>\\n <escalationPlanType>UN_ACKNOWLEDGE</escalationPlanType>\\n <escalationPlanConditions>\\n <level>P1</level>\\n <effection>LOW</effection>\\n </escalationPlanConditions>\\n <escalationPlanStrategies>\\n <noticeTime>40</noticeTime>\\n <noticeObjects>43</noticeObjects>\\n <noticeChannels>SMS</noticeChannels>\\n </escalationPlanStrategies>\\n </escalationPlanRules>\\n <createTime>2021-09-09 09:09:09</createTime>\\n </data>\\n</GetEscalationPlanResponse>","errorExample":""}]',
- ],
- 'ListEscalationPlans' => [
- 'summary' => '升级计划列表添加服务删除字段',
- 'path' => '/escalationPlan/list',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"062E6568-E505-49D6-8DD0-8F11283EB0AB\\"\\n}","type":"json"}]',
+ 'title' => 'Management event response',
+ 'changeSet' => [
+ ['createdAt' => '2022-08-10T09:29:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:RespondIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RespondIncident'],
+ ],
],
+ ],
+ 'RevokeProblemRecovery' => [
+ 'summary' => 'Fault revocation and recovery.',
+ 'path' => '/problem/revoke',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempW7HVUW',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempLC8226'],
],
'parameters' => [
[
@@ -21104,53 +15730,22 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'escalationPlanName' => [
- 'description' => '',
- 'example' => 'xxx',
- 'required' => false,
- 'title' => '升级计划名',
- 'type' => 'string',
- ],
- 'serviceName' => [
- 'description' => '',
- 'example' => 'ssxx',
- 'required' => false,
- 'title' => '服务名称',
- 'type' => 'string',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => 'pageNumber',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'required' => false,
- 'title' => 'pageSize',
- 'type' => 'integer',
- ],
- 'isGlobal' => [
- 'type' => 'boolean',
- ],
- 'status' => [
- 'type' => 'string',
- ],
+ 'problemId' => ['description' => 'Fault ID.', 'example' => '1231', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'problemNotifyType' => ['description' => 'Notification type:'."\n"
+ ."\n"
+ .'- PROBLEM_NOTIFY: Fault notification.'."\n"
+ .'- PROBLEM_UPDATE: Fault update.'."\n"
+ .'- PROBLEM_UPGRADE: Fault upgrade.'."\n"
+ .'- PROBLEM_DEGRADE: Fault downgrade.'."\n"
+ .'- PROBLEM_RECOVER: Fault recovery.'."\n"
+ .'- PROBLEM_REISSUE: Fault reissue.'."\n"
+ .'- PROBLEM_CANCEL: Fault cancellation.', 'example' => 'PROBLEM_UPGRADE', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'clientToken' => ['description' => 'Idempotency validation.', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2EF', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -21159,147 +15754,130 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'data',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'escalationPlanId' => [
- 'description' => '',
- 'example' => '43',
- 'format' => 'int64',
- 'title' => '升级计划id',
- 'type' => 'integer',
- ],
- 'escalationPlanName' => [
- 'description' => '',
- 'example' => '升级计划2345',
- 'title' => '升级计划名称',
- 'type' => 'string',
- ],
- 'escalationPlanScopeObjects' => [
- 'description' => '',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'scopeObjectId' => [
- 'description' => '',
- 'example' => '23',
- 'format' => 'int64',
- 'title' => '范围对象id(服务id)',
- 'type' => 'integer',
- ],
- 'scopeObjectName' => [
- 'description' => '',
- 'example' => '某服务1',
- 'title' => '范围对象名称',
- 'type' => 'string',
- ],
- 'scope' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'title' => '范围对象类型',
- 'type' => 'string',
- ],
- 'scopeObjectDeletedType' => [
- 'title' => '服务是否删除 1正常 0删除',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '升级计划范围对象',
- 'type' => 'array',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'ENABLE',
- 'title' => '启用ENABLE 禁用DISABLE',
- 'type' => 'string',
- ],
- 'modifyTime' => [
- 'description' => '',
- 'example' => '2021-09-09 09:09:09',
- 'title' => '修改时间',
- 'type' => 'string',
- ],
- 'isGlobal' => [
- 'title' => '是否是全局策略',
- 'type' => 'boolean',
- 'default' => 'false',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => 'data',
- 'type' => 'array',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '878',
- 'format' => 'int64',
- 'title' => '总条数',
- 'type' => 'integer',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'title' => '分页参数',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '分页参数',
- 'type' => 'integer',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\",\\n \\"data\\": [\\n {\\n \\"escalationPlanId\\": 43,\\n \\"escalationPlanName\\": \\"升级计划2345\\",\\n \\"escalationPlanScopeObjects\\": [\\n {\\n \\"scopeObjectId\\": 23,\\n \\"scopeObjectName\\": \\"服务1\\",\\n \\"scope\\": \\"SERVICE\\",\\n \\"scopeObjectDeletedType\\": 1\\n }\\n ],\\n \\"status\\": \\"ENABLE\\",\\n \\"modifyTime\\": \\"2021-09-09 09:09:09\\",\\n \\"isGlobal\\": true\\n }\\n ],\\n \\"totalCount\\": 878,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListEscalationPlansResponse>\\n <requestId>A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST</requestId>\\n <data>\\n <escalationPlanId>43</escalationPlanId>\\n <escalationPlanName>升级计划2345</escalationPlanName>\\n <escalationPlanScopeObjects>\\n <scopeObjectId>23</scopeObjectId>\\n <scopeObjectName>某服务1</scopeObjectName>\\n </escalationPlanScopeObjects>\\n <status>ENABLE</status>\\n <modifyTime>2021-09-09 09:09:09</modifyTime>\\n </data>\\n <totalCount>878</totalCount>\\n <pageNumber>1</pageNumber>\\n <pageSize>10</pageSize>\\n</ListEscalationPlansResponse>","errorExample":""}]',
- ],
- 'UpdateEscalationPlan' => [
- 'summary' => '更新升级计划',
- 'path' => '/escalationPlan/update',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ProblemStatusError', 'errorMessage' => 'The problem status is abnormal.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","type":"json"}]',
+ 'title' => 'Fault revocation and recovery',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:RevokeProblemRecovery',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeProblemRecovery'],
+ ],
],
+ ],
+ 'UnbindUser' => [
+ 'summary' => 'Unbinds a user.',
+ 'path' => '/user/unbind',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgemp1Z9RF2'],
+ ],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response ',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request ', 'type' => 'string', 'description' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 401 => [
+ ['errorCode' => 'UnbindUserFail', 'errorMessage' => 'The specified user does not exist.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'UnbindUserFail', 'errorMessage' => 'Not find userId.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'UnbindUserFail', 'errorMessage' => 'Mobile app not opened.', 'description' => ''],
+ ],
+ ],
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UnbindUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\"\\n}","type":"json"}]',
+ 'title' => 'UnbindUser',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindUser'],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'UpdateEscalationPlan' => [
+ 'summary' => 'Update the escalation plan.',
+ 'path' => '/escalationPlan/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempGUN0ZL',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempGUN0ZL'],
],
'parameters' => [
[
@@ -21309,213 +15887,124 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'escalationPlanId' => [
- 'description' => '',
- 'example' => '433',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '升级计划id',
- 'type' => 'integer',
- ],
- 'escalationPlanName' => [
- 'description' => '',
- 'example' => 'xxx',
- 'required' => false,
- 'title' => '升级计划名称',
- 'type' => 'string',
- ],
- 'escalationPlanDescription' => [
- 'description' => '',
- 'example' => 'xxxx',
- 'required' => false,
- 'title' => '升级计划描述',
- 'type' => 'string',
- ],
+ 'escalationPlanId' => ['description' => 'The ID of the escalation plan.', 'example' => '433', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'escalationPlanName' => ['description' => 'The name of the escalation plan.', 'example' => '服务1升级', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'escalationPlanDescription' => ['description' => 'Escalation plan description.', 'example' => '升级版本', 'required' => false, 'title' => '', 'type' => 'string'],
'escalationPlanScopeObjects' => [
- 'description' => '',
+ 'description' => 'List of associated scopes (services).',
'items' => [
'description' => 'object',
'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '87',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '主键',
- 'type' => 'integer',
- ],
- 'scopeObjectId' => [
- 'description' => '',
- 'example' => '234',
- 'format' => 'int64',
- 'required' => true,
- 'title' => '范围对象id',
- 'type' => 'integer',
- ],
- 'scope' => [
- 'description' => '',
- 'example' => 'SERVICE',
- 'required' => false,
- 'title' => '范围对象类型',
- 'type' => 'string',
- ],
+ 'id' => ['description' => 'Primary key.', 'example' => '87', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'scopeObjectId' => ['description' => 'Scope object ID.', 'example' => '234', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'],
+ 'scope' => ['description' => 'Scope object type.', 'example' => 'SERVICE', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
- 'title' => '关联范围列表(服务)',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
'escalationPlanRules' => [
- 'description' => '',
+ 'description' => 'The rules of the escalation plan.',
'items' => [
'description' => 'object',
'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '872',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '主键',
- 'type' => 'integer',
- ],
- 'escalationPlanType' => [
- 'description' => '',
- 'example' => 'UN_ACKNOWLEDGE',
- 'required' => false,
- 'title' => 'UN_ACKNOWLEDGE 未响应 UN_FINISH 未完结(废弃)',
- 'type' => 'string',
- ],
+ 'id' => ['description' => 'Primary key. ', 'example' => '872', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'escalationPlanType' => ['description' => '- UN_ACKNOWLEDGE: No response. '."\n"
+ .'- UN_FINISH: Not completed (deprecated).', 'example' => 'UN_ACKNOWLEDGE', 'required' => false, 'title' => '', 'type' => 'string'],
'escalationPlanConditions' => [
- 'description' => '',
+ 'description' => 'The list of escalation plan conditions.',
'items' => [
'description' => 'object',
'properties' => [
- 'level' => [
- 'description' => 'P1 P2 P3 P4',
- 'example' => 'P1',
- 'required' => false,
- 'title' => 'P1 P2 P3 P4',
- 'type' => 'string',
- ],
- 'effection' => [
- 'description' => 'LOW HIGH',
- 'example' => 'LOW',
- 'required' => false,
- 'title' => 'LOW HIGH',
- 'type' => 'string',
- ],
+ 'level' => ['description' => 'P1 P2 P3 P4', 'example' => 'P1', 'required' => false, 'title' => 'P1 P2 P3 P4', 'type' => 'string'],
+ 'effection' => ['description' => 'LOW HIGH', 'example' => 'LOW', 'required' => false, 'title' => 'LOW HIGH', 'type' => 'string'],
],
'required' => false,
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
- 'title' => '升级计划条件列表',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
'escalationPlanStrategies' => [
- 'description' => '',
+ 'description' => 'List of escalation policies. ',
'items' => [
'description' => 'object',
'properties' => [
- 'noticeTime' => [
- 'description' => '',
- 'example' => '30',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '通知时间',
- 'type' => 'integer',
- ],
+ 'noticeTime' => ['description' => 'Notification time.', 'example' => '30', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
'noticeObjects' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '678',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'description' => 'Notification object ID. ',
+ 'items' => ['description' => 'Notification object ID.', 'example' => '678', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
'required' => false,
- 'title' => '通知对象id',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
'noticeChannels' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => 'SMS',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'description' => 'Notification Channels.',
+ 'items' => ['description' => 'List of notification channels.', 'example' => 'SMS', 'required' => false, 'type' => 'string', 'title' => ''],
'required' => false,
- 'title' => '通知渠道',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
'serviceGroupIds' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '232',
- 'format' => 'int64',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'description' => 'Service group IDs.',
+ 'items' => ['description' => 'Service group IDs.', 'example' => '232', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
'required' => false,
- 'title' => '服务组id',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
- 'enableWebhook' => [
- 'description' => '',
- 'example' => 'true',
- 'required' => false,
- 'title' => '是否支持群通知',
- 'type' => 'boolean',
- ],
- 'escalationPlanType' => [
- 'title' => 'UN_ACKNOWLEDGE 未响应 UN_FINISH 未完结',
- 'type' => 'string',
- 'example' => 'UN_ACKNOWLEDGE',
- ],
+ 'enableWebhook' => ['description' => 'Indicates whether webhook is enabled.', 'example' => 'true', 'required' => false, 'title' => '', 'type' => 'boolean'],
+ 'escalationPlanType' => ['description' => '- UN_ACKNOWLEDGE: No response. '."\n"
+ .'- UN_FINISH: Not completed.', 'title' => 'UN_ACKNOWLEDGE No Response UN_FINISH Not Completed', 'type' => 'string', 'example' => 'UN_ACKNOWLEDGE', 'required' => false],
'noticeRoleList' => [
- 'title' => '通知角色列表',
+ 'description' => 'List of role IDs.',
+ 'title' => 'Notification Role List',
'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'items' => ['description' => 'List of role IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '124wqqqqddf', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
],
],
'required' => false,
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
- 'title' => '升级策略列表',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
],
'required' => false,
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
- 'title' => '升级计划规则',
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
],
- 'clientToken' => [
- 'description' => 'clientToken',
- 'example' => '6b404f14-77d1-4b53-a1a1-30a58bbcfc57',
- 'required' => false,
- 'title' => 'clientToken',
- 'type' => 'string',
- ],
- 'isGlobal' => [
- 'title' => '是否是全局策略',
- 'type' => 'boolean',
- ],
+ 'clientToken' => ['description' => 'clientToken', 'example' => '6b404f14-77d1-4b53-a1a1-30a58bbcfc57', 'required' => false, 'title' => 'clientToken', 'type' => 'string'],
+ 'isGlobal' => ['description' => 'Indicates whether the policy is global.', 'title' => 'Is Global Policy', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -21524,76 +16013,69 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'EscalationPlanRuleNull',
- 'errorMessage' => 'Escalation plan rule can not be null.',
- ],
- [
- 'errorCode' => 'EscalationPlanServiceNull',
- 'errorMessage' => 'Escalation plan service can not be nulll',
- ],
- [
- 'errorCode' => 'EscalationPlanAlreadyExisted',
- 'errorMessage' => 'The escalation plan already exists.',
- ],
- [
- 'errorCode' => 'EscalationPlanServiceAleardyRelated',
- 'errorMessage' => 'The specified service is already related.',
- ],
+ ['errorCode' => 'EscalationPlanRuleNull', 'errorMessage' => 'Escalation plan rule can not be null.', 'description' => ''],
+ ['errorCode' => 'EscalationPlanServiceNull', 'errorMessage' => 'Escalation plan service can not be nulll', 'description' => ''],
+ ['errorCode' => 'EscalationPlanAlreadyExisted', 'errorMessage' => 'The escalation plan already exists.', 'description' => ''],
+ ['errorCode' => 'EscalationPlanServiceAleardyRelated', 'errorMessage' => 'The specified service is already related.', 'description' => ''],
],
404 => [
- [
- 'errorCode' => 'EscalationPlanNotExists',
- 'errorMessage' => 'The specified escalation plan does not exist.',
- ],
+ ['errorCode' => 'EscalationPlanNotExists', 'errorMessage' => 'The specified escalation plan does not exist.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateEscalationPlanResponse>\\n <requestId>A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST</requestId>\\n</UpdateEscalationPlanResponse>","errorExample":""}]',
- ],
- 'CreateRichText' => [
- 'summary' => '创建富文本',
- 'path' => '/rich/create',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\"\\n}","type":"json"}]',
+ 'title' => 'Update Escalation Plan',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-03-03T03:18:03.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateEscalationPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEscalationPlan'],
+ ],
],
+ ],
+ 'UpdateIncident' => [
+ 'summary' => 'Updates an incident.',
+ 'path' => '/incident/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempHBPHMV',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempKAIUZH'],
],
'parameters' => [
[
@@ -21601,113 +16083,105 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'body',
- 'properties' => [
- 'instanceId' => [
- 'description' => '',
- 'example' => '12221',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '资源id',
- 'type' => 'integer',
- ],
- 'instanceType' => [
- 'description' => '',
- 'example' => 'INCIDENT 事件 ALERT告警 PROBLEM故障',
- 'required' => false,
- 'title' => '资源类型',
- 'type' => 'string',
- ],
- 'richText' => [
- 'description' => '',
- 'example' => '这是一个富文本',
- 'required' => false,
- 'title' => '文本内容',
- 'type' => 'string',
- ],
+ 'description' => 'Request body.',
+ 'properties' => [
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12312', 'title' => ''],
+ 'incidentLevel' => ['description' => 'Incident level, from highest to lowest:'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'string', 'example' => 'P1', 'title' => '', 'required' => false],
+ 'effect' => ['description' => 'Impact level:'."\n"
+ ."\n"
+ .'- HIGH: High impact.'."\n"
+ ."\n"
+ .'- LOW: Low impact.', 'type' => 'string', 'example' => 'LOW', 'title' => '', 'required' => false],
+ 'incidentTitle' => ['description' => 'Incident title.', 'type' => 'string', 'example' => '事件标题', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A123'],
],
'required' => false,
- 'title' => 'body',
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9'],
'data' => [
- 'description' => 'data',
+ 'description' => 'Returned data.',
'properties' => [
- 'instanceId' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'title' => '资源id',
- 'type' => 'integer',
- ],
- 'instanceType' => [
- 'description' => '',
- 'example' => '0 事件 1告警 2 故障',
- 'format' => 'int64',
- 'title' => '资源类型',
- 'type' => 'integer',
- ],
- 'richText' => [
- 'description' => '',
- 'example' => '这是一个富文本',
- 'title' => '富文本内容',
- 'type' => 'string',
- ],
+ 'incidentId' => ['description' => 'Incident ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2312'],
],
- 'title' => 'data',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"instanceId\\": 140080050,\\n \\"instanceType\\": 0,\\n \\"richText\\": \\"这是一个富文本\\"\\n }\\n}","type":"json"}]',
- ],
- 'GetRichText' => [
- 'summary' => '查询富文本',
- 'path' => '/rich/detail',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IncidentUpdateInvalid', 'errorMessage' => 'The incident update is invalid.', 'description' => ''],
+ ['errorCode' => 'IncidentStatusInvalid', 'errorMessage' => 'The incident status is invalid.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'IncidentNotExtisted', 'errorMessage' => 'The incident does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"incidentId\\": 2312\\n }\\n}","type":"json"}]',
+ 'title' => 'Update management event',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIncident'],
+ ],
],
+ ],
+ 'UpdateIntegrationConfig' => [
+ 'summary' => 'Integration configuration update.',
+ 'path' => '/integrationConfig/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp71I60H',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempBHVB81'],
],
'parameters' => [
[
@@ -21717,32 +16191,14 @@
'schema' => [
'description' => 'A short description of struct',
'properties' => [
- 'richTextId' => [
- 'description' => '',
- 'example' => '12221才',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '资源id',
- 'type' => 'integer',
- ],
- 'instanceId' => [
- 'description' => '',
- 'example' => 'INCIDENT 事件 ALERT告警 PROBLEM故障',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '资源类型',
- 'type' => 'integer',
- ],
- 'instanceType' => [
- 'description' => '',
- 'example' => 'INCIDENT',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'integrationConfigId' => ['description' => 'Integration configuration ID.', 'example' => '103', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''],
+ 'accessKey' => ['description' => 'accessKey', 'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'clientToken' => ['description' => 'Idempotent ID.', 'example' => '601FA6A2-AC5C-4B59-BE11-378F987A6A98', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
@@ -21751,82 +16207,63 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'data',
- 'properties' => [
- 'instanceId' => [
- 'description' => '',
- 'example' => '123123',
- 'format' => 'int64',
- 'title' => '资源id',
- 'type' => 'integer',
- ],
- 'richText' => [
- 'description' => '',
- 'example' => '这是一个富文本',
- 'title' => '富文本内容',
- 'type' => 'string',
- ],
- 'instanceType' => [
- 'description' => '',
- 'example' => '0 事件 1告警 2 故障',
- 'format' => 'int64',
- 'title' => '资源类型',
- 'type' => 'integer',
- ],
- ],
- 'title' => 'data',
- 'type' => 'object',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4AA343E4-AB98-56D9-B699-D932902BA3EC\\",\\n \\"data\\": {\\n \\"instanceId\\": 140080050,\\n \\"richText\\": \\"这是一个富文本\\",\\n \\"instanceType\\": 0\\n }\\n}","type":"json"}]',
- 'requestParamsDescription' => '{'."\n"
- .' "richTextId" : 111111,'."\n"
- .' "instanceId" : 111111111,'."\n"
- .' "instanceType" : "INCIDENT"'."\n"
- .'}',
- ],
- 'UpdateRichText' => [
- 'summary' => '更新富文本',
- 'path' => '/rich/update',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'IntegationConfigNotDisable', 'errorMessage' => 'The specified integration config is not disabled.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'IntegationConfigNotExists', 'errorMessage' => 'The specified integration config does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","type":"json"}]',
+ 'title' => 'Integration Configuration Update',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIntegrationConfig'],
+ ],
],
+ ],
+ 'UpdateProblem' => [
+ 'summary' => 'Updates problem details.',
+ 'path' => '/problem/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempW15CG1',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZVI8H5'],
],
'parameters' => [
[
@@ -21834,105 +16271,106 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'richTextId' => [
- 'description' => '',
- 'example' => '123112313',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '富文本id',
- 'type' => 'integer',
- ],
- 'instanceId' => [
- 'description' => '',
- 'example' => '123123',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '资源id',
- 'type' => 'integer',
- ],
- 'instanceType' => [
- 'description' => '',
- 'example' => 'INCIDENT 事件 ALERT告警 PROBLEM故障',
- 'required' => false,
- 'title' => '资源类型',
- 'type' => 'string',
- ],
- 'richText' => [
- 'description' => '',
- 'example' => '这是一个富文本',
+ 'problemId' => ['description' => 'Problem ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '213432'],
+ 'problemName' => ['description' => 'Problem name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '故障2'],
+ 'level' => ['description' => 'Problem level.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'P1'],
+ 'relatedServiceId' => ['description' => 'Associated service.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '123'],
+ 'progressSummary' => ['description' => 'Progress summary.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '进展摘要xxxx'],
+ 'preliminaryReason' => ['description' => 'Preliminary cause.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '原因是服务宕机'],
+ 'mainHandlerId' => ['description' => 'Main handler.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '678'],
+ 'feedback' => ['description' => 'Public feedback.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '影响恶劣'],
+ 'serviceGroupIds' => [
+ 'description' => 'Emergency response group.',
+ 'items' => ['description' => 'Emergency response group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '102', 'required' => false, 'title' => ''],
'required' => false,
- 'title' => '文本内容',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'progressSummaryRichTextId' => ['description' => 'Rich text field ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '23232', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'data',
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '12',
- 'format' => 'int64',
- 'title' => '富文本id',
- 'type' => 'integer',
- ],
- ],
- 'title' => 'data',
- 'type' => 'object',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1021A12E-4BDF-5EC6-8251-6E998A3C360B\\",\\n \\"data\\": {\\n \\"id\\": 132971028\\n }\\n}","type":"json"}]',
- ],
- 'ListIncidentDetailEscalationPlans' => [
- 'summary' => '事件详情升级策略',
- 'path' => '/incident/detail/escalation',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","type":"json"}]',
+ 'title' => 'Update incident details',
+ 'requestParamsDescription' => '{'."\n"
+ .'"problemId": 213432,'."\n"
+ .'"problemName": "Problem 2",'."\n"
+ .'"level": "P1",'."\n"
+ .'"relatedServiceId": 123,'."\n"
+ .'"progressSummary": "Progress summary xxxx",'."\n"
+ .'"preliminaryReason": "Service down",'."\n"
+ .'"mainHandlerId": 678,'."\n"
+ .'"feedback": "Severe impact",'."\n"
+ .'"serviceGroupIds": \\[102]'."\n"
+ .'}',
+ 'responseParamsDescription' => '{'."\n"
+ .'"requestId": "c26f36de-1ec8-496a-a828-880676c5ef81"'."\n"
+ .'}',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProblem'],
+ ],
],
+ ],
+ 'UpdateProblemEffectionService' => [
+ 'summary' => 'Update a service-impacting fault.',
+ 'path' => '/problem/process/effectionService/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREgempZB7ZAW'],
],
'parameters' => [
[
@@ -21940,464 +16378,102 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
- 'properties' => [
- 'incidentId' => [
- 'description' => '',
- 'example' => '2311',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '事件ID',
- 'type' => 'integer',
- ],
- 'clientToken' => [
- 'description' => '',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
+ 'description' => 'Request body parameters.',
+ 'properties' => [
+ 'serviceId' => ['description' => 'The ID of the associated service.', 'type' => 'integer', 'format' => 'int64', 'example' => '33', 'title' => '', 'required' => false],
+ 'level' => ['description' => 'The impact level, in descending order:'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'string', 'example' => 'P1', 'title' => '', 'required' => false],
+ 'status' => ['description' => 'The impact status:'."\n"
+ ."\n"
+ .'- 0: Not recovered.'."\n"
+ ."\n"
+ .'- 1: Recovered.', 'type' => 'string', 'example' => '·', 'title' => '', 'required' => false],
+ 'description' => ['description' => 'The impact description.', 'type' => 'string', 'example' => 'xxxx大厦', 'title' => '', 'required' => false],
+ 'picUrl' => [
+ 'description' => 'The image URLs.',
+ 'items' => ['description' => 'The image key.', 'type' => 'string', 'required' => false, 'example' => 'problem/xxxxxxxx-a2c8-40b9-9162-08a6c2e338e2', 'title' => ''],
'required' => false,
- 'title' => '幂等校验',
- 'type' => 'string',
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'problemId' => ['description' => 'The problem ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '190000000', 'title' => '', 'required' => false],
+ 'effectionServiceId' => ['description' => 'The impact service ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '103'],
+ 'clientToken' => ['title' => 'clientToken', 'description' => 'The idempotency token.', 'type' => 'string', 'required' => false, 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'data',
- 'properties' => [
- 'escalationPlanId' => [
- 'description' => '',
- 'example' => '312123',
- 'format' => 'int64',
- 'title' => '升级策略ID',
- 'type' => 'integer',
- ],
- 'escalationPlanName' => [
- 'description' => '',
- 'example' => '升级策略A',
- 'title' => '升级策略名称',
- 'type' => 'string',
- ],
- 'unFinishEscalationPlan' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'escalationPlanType' => [
- 'description' => '',
- 'example' => 'UN_FINISH',
- 'title' => '升级策略类型 UN_ACKNOWLEDGE',
- 'type' => 'string',
- ],
- 'noticeTime' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'title' => '延迟时间',
- 'type' => 'integer',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'UPGRADE',
- 'title' => '规则触发状态',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'description' => '',
- 'example' => '1629872386027',
- 'format' => 'int64',
- 'title' => '开始时间',
- 'type' => 'integer',
- ],
- 'noticeChannels' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '渠道字符串 SMS',
- 'type' => 'string',
- ],
- 'title' => '分配渠道',
- 'type' => 'array',
- ],
- 'noticeObjectList' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'noticeObjectId' => [
- 'description' => '',
- 'example' => '2311',
- 'format' => 'int64',
- 'title' => '分配对象id',
- 'type' => 'integer',
- ],
- 'noticeObjectName' => [
- 'description' => '',
- 'example' => '小明',
- 'title' => '分配对象名称',
- 'type' => 'string',
- ],
- 'noticeObjectPhone' => [
- 'description' => '',
- 'example' => '130xxxxxxxx',
- 'title' => '手机号',
- 'type' => 'string',
- ],
- 'roleNameList' => [
- 'title' => '角色列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '用户信息',
- 'type' => 'array',
- ],
- 'serviceGroupList' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '123132',
- 'format' => 'int64',
- 'title' => '服务组id',
- 'type' => 'integer',
- ],
- 'name' => [
- 'description' => '',
- 'example' => '服务组A',
- 'title' => '服务组名称',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '消息群',
- 'type' => 'array',
- ],
- 'noticeRoleList' => [
- 'title' => '角色ID列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'noticeRoleObjectList' => [
- 'title' => '角色对象列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'name' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '未完结升级策略规则列表',
- 'type' => 'array',
- ],
- 'nuAcknowledgeEscalationPlan' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'escalationPlanType' => [
- 'description' => '',
- 'example' => 'UN_ACKNOWLEDGE',
- 'title' => '升级策略类型 UN_ACKNOWLEDGE',
- 'type' => 'string',
- ],
- 'noticeTime' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '延迟时间',
- 'type' => 'integer',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'UPGRADE',
- 'title' => '规则触发状态',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'description' => '',
- 'example' => '1629872386027',
- 'format' => 'int64',
- 'title' => '开始时间',
- 'type' => 'integer',
- ],
- 'noticeChannels' => [
- 'description' => '',
- 'items' => [
- 'description' => '',
- 'example' => '渠道字符串 SMS',
- 'type' => 'string',
- ],
- 'title' => '分配渠道',
- 'type' => 'array',
- ],
- 'noticeObjectList' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'noticeObjectId' => [
- 'description' => '',
- 'example' => '31231',
- 'format' => 'int64',
- 'title' => '分配对象id',
- 'type' => 'integer',
- ],
- 'noticeObjectName' => [
- 'description' => '',
- 'example' => '小华',
- 'title' => '分配对象名称',
- 'type' => 'string',
- ],
- 'noticeObjectPhone' => [
- 'description' => '',
- 'example' => '130xxxxxxxxx',
- 'title' => '分配对象手机号',
- 'type' => 'string',
- ],
- 'roleNameList' => [
- 'title' => '角色列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '用户信息',
- 'type' => 'array',
- ],
- 'serviceGroupList' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'title' => '服务组id',
- 'type' => 'integer',
- ],
- 'name' => [
- 'description' => '',
- 'example' => '服务组A',
- 'title' => '服务组名称',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '通知群',
- 'type' => 'array',
- ],
- 'noticeRoleList' => [
- 'title' => '角色ID列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- 'noticeRoleObjectList' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'name' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '未响应升级策略',
- 'type' => 'array',
- ],
- 'convergenceEscalationPlan' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'escalationPlanType' => [
- 'description' => '',
- 'example' => 'UN_ACKNOWLEDGE',
- 'title' => '升级策略类型 UN_ACKNOWLEDGE',
- 'type' => 'string',
- ],
- 'noticeTime' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'title' => '收敛目标值',
- 'type' => 'integer',
- ],
- 'status' => [
- 'description' => '',
- 'example' => 'UPGRADE',
- 'title' => '规则触发状态',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'description' => '',
- 'example' => '1629872386027',
- 'format' => 'int64',
- 'title' => '已收敛次数',
- 'type' => 'integer',
- ],
- 'noticeChannels' => [
- 'description' => '',
- 'items' => [
- 'example' => '渠道字符串 SMS',
- 'type' => 'string',
- ],
- 'title' => '分配渠道',
- 'type' => 'array',
- ],
- 'noticeObjectList' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'noticeObjectId' => [
- 'description' => '',
- 'example' => '31231',
- 'format' => 'int64',
- 'title' => '分配对象id',
- 'type' => 'integer',
- ],
- 'noticeObjectName' => [
- 'description' => '',
- 'example' => '小华',
- 'title' => '分配对象名称',
- 'type' => 'string',
- ],
- 'noticeObjectPhone' => [
- 'description' => '',
- 'example' => '130xxxxxxxxx',
- 'title' => '分配对象手机号',
- 'type' => 'string',
- ],
- 'roleNameList' => [
- 'title' => '角色列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '用户信息',
- 'type' => 'array',
- ],
- 'serviceGroupList' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'id' => [
- 'description' => '',
- 'example' => '1231',
- 'format' => 'int64',
- 'title' => '服务组id',
- 'type' => 'integer',
- ],
- 'name' => [
- 'description' => '',
- 'example' => '服务组A',
- 'title' => '服务组名称',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '通知群',
- 'type' => 'array',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '未响应升级策略',
- 'type' => 'array',
- ],
- ],
- 'title' => 'data',
- 'type' => 'object',
- ],
+ 'requestId' => ['title' => 'requestId', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ffbf594-e093-46ad-bdcd-df4d7097125a'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"escalationPlanId\\": 312123,\\n \\"escalationPlanName\\": \\"升级策略A\\",\\n \\"unFinishEscalationPlan\\": [\\n {\\n \\"escalationPlanType\\": \\"UN_FINISH\\",\\n \\"noticeTime\\": 10,\\n \\"status\\": \\"UPGRADE\\",\\n \\"startTime\\": 1629872386027,\\n \\"noticeChannels\\": [\\n \\"SMS\\"\\n ],\\n \\"noticeObjectList\\": [\\n {\\n \\"noticeObjectId\\": 2311,\\n \\"noticeObjectName\\": \\"马先生\\",\\n \\"noticeObjectPhone\\": \\"130xxxxxxxx\\",\\n \\"roleNameList\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"serviceGroupList\\": [\\n {\\n \\"id\\": 123132,\\n \\"name\\": \\"服务组A\\"\\n }\\n ],\\n \\"noticeRoleList\\": [\\n 0\\n ],\\n \\"noticeRoleObjectList\\": [\\n {\\n \\"id\\": 117,\\n \\"name\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"nuAcknowledgeEscalationPlan\\": [\\n {\\n \\"escalationPlanType\\": \\"UN_ACKNOWLEDGE\\",\\n \\"noticeTime\\": 10,\\n \\"status\\": \\"UPGRADE\\",\\n \\"startTime\\": 0,\\n \\"noticeChannels\\": [\\n \\"SMS\\"\\n ],\\n \\"noticeObjectList\\": [\\n {\\n \\"noticeObjectId\\": 31231,\\n \\"noticeObjectName\\": \\"马先生\\",\\n \\"noticeObjectPhone\\": \\"130xxxxxxxxx\\",\\n \\"roleNameList\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"serviceGroupList\\": [\\n {\\n \\"id\\": 1231,\\n \\"name\\": \\"服务组A\\"\\n }\\n ],\\n \\"noticeRoleList\\": [\\n 0\\n ],\\n \\"noticeRoleObjectList\\": [\\n {\\n \\"id\\": 100936,\\n \\"name\\": \\"通知对象名称A\\"\\n }\\n ]\\n }\\n ],\\n \\"convergenceEscalationPlan\\": [\\n {\\n \\"escalationPlanType\\": \\"UN_ACKNOWLEDGE\\",\\n \\"noticeTime\\": 10,\\n \\"status\\": \\"UPGRADE\\",\\n \\"startTime\\": 0,\\n \\"noticeChannels\\": [\\n \\"SMS\\"\\n ],\\n \\"noticeObjectList\\": [\\n {\\n \\"noticeObjectId\\": 31231,\\n \\"noticeObjectName\\": \\"马先生\\",\\n \\"noticeObjectPhone\\": \\"130xxxxxxxxx\\",\\n \\"roleNameList\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"serviceGroupList\\": [\\n {\\n \\"id\\": 1231,\\n \\"name\\": \\"服务组A\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListIncidentDetailEscalationPlansResponse>\\n <requestId>FD200FAE-E98F-496E-BFE6-4CE61E59A2E9</requestId>\\n <data>\\n <escalationPlanId>312123</escalationPlanId>\\n <escalationPlanName>升级策略A</escalationPlanName>\\n <unFinishEscalationPlan>\\n <escalationPlanType>UN_FINISH</escalationPlanType>\\n <noticeTime>10</noticeTime>\\n <status>UPGRADE</status>\\n <startTime>1629872386027</startTime>\\n <noticeChannels>渠道字符串 SMS</noticeChannels>\\n <noticeObjectList>\\n <noticeObjectId>2311</noticeObjectId>\\n <noticeObjectName>小明</noticeObjectName>\\n <noticeObjectPhone>130xxxxxxxx</noticeObjectPhone>\\n </noticeObjectList>\\n <serviceGroupList>\\n <id>123132</id>\\n <name>服务组A</name>\\n </serviceGroupList>\\n </unFinishEscalationPlan>\\n <nuAcknowledgeEscalationPlan>\\n <escalationPlanType>UN_ACKNOWLEDGE</escalationPlanType>\\n <noticeTime>10</noticeTime>\\n <status>UPGRADE</status>\\n <startTime>1629872386027</startTime>\\n <noticeChannels>渠道字符串 SMS</noticeChannels>\\n <noticeObjectList>\\n <noticeObjectId>31231</noticeObjectId>\\n <noticeObjectName>小华</noticeObjectName>\\n <noticeObjectPhone>130xxxxxxxxx</noticeObjectPhone>\\n </noticeObjectList>\\n <serviceGroupList>\\n <id>1231</id>\\n <name>服务组A</name>\\n </serviceGroupList>\\n </nuAcknowledgeEscalationPlan>\\n </data>\\n</ListIncidentDetailEscalationPlansResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{'."\n"
- .' "incidentId" : 2311,'."\n"
- .' "clientToken" : "FD200FAE-E98F-496E-BFE6-4CE61E59A2E9"'."\n"
- .'}',
- ],
- 'GetHomePageGuidance' => [
- 'summary' => '查询首页引导信息',
- 'path' => '/guidance/detail',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ffbf594-e093-46ad-bdcd-df4d7097125a\\"\\n}","type":"json"}]',
+ 'title' => 'Update the service impacted by an incident ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateProblemEffectionService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProblemEffectionService'],
+ ],
],
+ ],
+ 'UpdateProblemImprovement' => [
+ 'summary' => 'Updates the review and improvement details for a problem.',
+ 'path' => '/problem/improvement/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempVWXIZC',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZVI8H5'],
],
'parameters' => [
[
@@ -22405,116 +16481,93 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '',
- 'properties' => [
- 'clientToken' => [
- 'description' => '',
- 'example' => 'xxxxxx',
- 'required' => false,
- 'title' => '幂等号',
- 'type' => 'string',
- ],
+ 'description' => 'Request body.',
+ 'properties' => [
+ 'problemId' => ['description' => 'Problem ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '12312'],
+ 'problemReason' => ['description' => 'Problem reason.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '故障原因A'],
+ 'recentActivity' => ['description' => 'Recent activity lookup table (PROBLEM\\_RECENT\\_ACTIVITY).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2'],
+ 'injectionMode' => ['description' => 'Injection mode lookup table (PROBLEM\\_INJECTION\\_MODE).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1'],
+ 'recoveryMode' => ['description' => 'Recovery mode lookup table (PROBLEM\\_RECOVERY\\_MODE).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2'],
+ 'discoverSource' => ['description' => 'Discovery source lookup table (PROBLEM\\_DISCOVER\\_SOURCE).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'],
+ 'userReport' => ['description' => 'User report lookup table (PROBLEM\\_USER\\_REPORT).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'],
+ 'monitorSourceName' => ['description' => 'Monitoring source.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Zabbix'],
+ 'relationChanges' => ['description' => 'Associated changes.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '关联变更'],
+ 'dutyUserId' => ['description' => 'Problem owner ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1231'],
+ 'replayDutyUserId' => ['description' => 'Review owner ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1213'],
+ 'dutyDepartmentName' => ['description' => 'Department name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '服务组A'],
+ 'dutyDepartmentId' => ['description' => 'Department ID (service group ID).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '123123'],
+ 'remark' => ['description' => 'Remarks.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '备注'],
+ 'clientToken' => ['description' => 'Idempotency check.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3813'],
+ 'customProblemReason' => ['title' => 'Custom Failure Reason', 'description' => 'Problem reason.', 'type' => 'string', 'required' => false, 'example' => ''],
],
'required' => false,
- 'title' => '首页引导查询参数',
+ 'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'properties' => [
- 'serviceStatus' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '服务配置状态',
- 'type' => 'boolean',
- ],
- 'usersStatus' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '用户配置状态',
- 'type' => 'boolean',
- ],
- 'serviceGroupStatus' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '服务组配置状态',
- 'type' => 'boolean',
- ],
- 'notifySubscriptionStatus' => [
- 'description' => '',
- 'example' => 'true',
- 'title' => '通知订阅配置状态',
- 'type' => 'boolean',
- ],
- ],
- 'type' => 'object',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxx\\",\\n \\"data\\": {\\n \\"serviceStatus\\": true,\\n \\"usersStatus\\": true,\\n \\"serviceGroupStatus\\": true,\\n \\"notifySubscriptionStatus\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetHomePageGuidanceResponse>\\n <requestId>xxxxxx</requestId>\\n <data>\\n <serviceStatus>true</serviceStatus>\\n <usersStatus>true</usersStatus>\\n <serviceGroupStatus>true</serviceGroupStatus>\\n <notifySubscriptionStatus>true</notifySubscriptionStatus>\\n </data>\\n</GetHomePageGuidanceResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{'."\n"
- .' "pageNumber": 1,'."\n"
- .' "pageSize": 10,'."\n"
- .' "clientToken": "89b3ed86-e8d6-43b4-82a6-a711055806eb"'."\n"
- .'}',
- 'responseParamsDescription' => '{'."\n"
- .' '."\n"
- .' "requestId": "gdgsdgsggsdg",'."\n"
- .' "data": {'."\n"
- .' "serviceStatus": true,'."\n"
- .' "usersStatus": true,'."\n"
- .' "serviceGroupStatus": true,'."\n"
- .' "notifySubscriptionStatus": true'."\n"
- .' }'."\n"
- .'}',
- ],
- 'ListChartDataForServiceGroup' => [
- 'summary' => '统计图表数据-个人',
- 'path' => '/statistics/chartDataForServiceGroup/',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","type":"json"}]',
+ 'title' => 'Update the details of post-incident review improvements ',
+ 'changeSet' => [
+ ['createdAt' => '2022-06-14T12:26:25.000Z', 'description' => 'Request parameters changed'],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateProblemImprovement',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProblemImprovement'],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'UpdateProblemMeasure' => [
+ 'summary' => 'Updates an improvement measure for a problem.',
+ 'path' => '/problem/improvement/measure/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempTZ0FO2',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZVI8H5'],
],
'parameters' => [
[
@@ -22522,179 +16575,91 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
- 'properties' => [
- 'clientToken' => [
- 'description' => 'clientToken',
- 'example' => '23es23s32xas23',
- 'required' => false,
- 'type' => 'string',
- ],
- 'startTime' => [
- 'description' => '',
- 'example' => '2021-09-09',
- 'required' => false,
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'description' => '',
- 'example' => '2021-10-09',
- 'required' => false,
- 'title' => '结束时间',
- 'type' => 'string',
- ],
+ 'description' => 'The request body.',
+ 'properties' => [
+ 'type' => ['description' => 'The lookup table for the measure type. Example: PROBLEM\\_REPLAY\\_IMPROVEMENT.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '3'],
+ 'content' => ['description' => 'The content of the measure.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '措施内容'],
+ 'checkStandard' => ['description' => 'The acceptance criteria.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2'],
+ 'checkUserId' => ['description' => 'The ID of the user who performs the acceptance check.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '123'],
+ 'directorId' => ['description' => 'The ID of the owner.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '123'],
+ 'stalkerId' => ['description' => 'The ID of the tracker.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '123'],
+ 'planFinishTime' => ['description' => 'The planned completion time.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2021-01-21 00:00:00'],
+ 'measureId' => ['description' => 'The measure ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1231'],
+ 'status' => ['description' => 'The status. Valid values:'."\n"
+ ."\n"
+ .'- IMPROVED: The condition has improved.'."\n"
+ ."\n"
+ .'- UNIMPROVED: The condition has not improved.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'UNIMPROVED'],
+ 'clientToken' => ['description' => 'The idempotence token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812'],
+ 'problemId' => ['description' => 'The problem ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1233'],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '1231212',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'data',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'time' => [
- 'description' => '',
- 'example' => '2021-09-09',
- 'title' => '时间',
- 'type' => 'string',
- ],
- 'incidentCount' => [
- 'description' => '',
- 'example' => '32',
- 'format' => 'int64',
- 'title' => '时间总数',
- 'type' => 'integer',
- ],
- 'effectionLevel' => [
- 'description' => '',
- 'example' => '{"P1HIGH":32}',
- 'title' => '根据影响等级时间等级分组统计数量',
- 'type' => 'object',
- ],
- 'meanTimeToAcknowledge' => [
- 'description' => '',
- 'example' => '323',
- 'format' => 'int64',
- 'title' => '当日平均响应时间单位秒',
- 'type' => 'integer',
- ],
- 'meanTimeToRepair' => [
- 'description' => '',
- 'example' => '4343',
- 'format' => 'int64',
- 'title' => '当日平均完结时间单位秒',
- 'type' => 'integer',
- ],
- 'totalMeanTimeToAcknowledge' => [
- 'description' => '',
- 'example' => '3334',
- 'format' => 'int64',
- 'title' => '总平均响应时间',
- 'type' => 'integer',
- ],
- 'totalMeanTimeToRepair' => [
- 'description' => '',
- 'example' => '4343',
- 'format' => 'int64',
- 'title' => '总平均完结时间',
- 'type' => 'integer',
- ],
- 'escalationIncidentCount' => [
- 'description' => '',
- 'example' => '43',
- 'format' => 'int64',
- 'title' => '升级事件数',
- 'type' => 'integer',
- ],
- 'unAcknowledgedEscalationIncidentCount' => [
- 'description' => '',
- 'example' => '23',
- 'format' => 'int64',
- 'title' => '未响应升级事件数',
- 'type' => 'integer',
- ],
- 'unFinishEscalationIncidentCount' => [
- 'description' => '',
- 'example' => '23',
- 'format' => 'int64',
- 'title' => '未完结升级事件数',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => 'data',
- 'type' => 'array',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"1231212\\",\\n \\"data\\": [\\n {\\n \\"time\\": \\"2021-09-09\\",\\n \\"incidentCount\\": 32,\\n \\"effectionLevel\\": {\\n \\"P1HIGH\\": 32\\n },\\n \\"meanTimeToAcknowledge\\": 323,\\n \\"meanTimeToRepair\\": 4343,\\n \\"totalMeanTimeToAcknowledge\\": 3334,\\n \\"totalMeanTimeToRepair\\": 4343,\\n \\"escalationIncidentCount\\": 43,\\n \\"unAcknowledgedEscalationIncidentCount\\": 23,\\n \\"unFinishEscalationIncidentCount\\": 23\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListChartDataForServiceGroupResponse>\\n <requestId>1231212</requestId>\\n <data>\\n <time>2021-09-09</time>\\n <incidentCount>32</incidentCount>\\n <meanTimeToAcknowledge>323</meanTimeToAcknowledge>\\n <meanTimeToRepair>4343</meanTimeToRepair>\\n <totalMeanTimeToAcknowledge>3334</totalMeanTimeToAcknowledge>\\n <totalMeanTimeToRepair>4343</totalMeanTimeToRepair>\\n <escalationIncidentCount>43</escalationIncidentCount>\\n <unAcknowledgedEscalationIncidentCount>23</unAcknowledgedEscalationIncidentCount>\\n <unFinishEscalationIncidentCount>23</unFinishEscalationIncidentCount>\\n </data>\\n</ListChartDataForServiceGroupResponse>","errorExample":""}]',
- 'responseParamsDescription' => '{'."\n"
- .' "requestId": "1231212",'."\n"
- .' "data": ['."\n"
- .' {'."\n"
- .' "time": "2021-09-09",'."\n"
- .' "incidentCount": 32,'."\n"
- .' "meanTimeToAcknowledge": 323,'."\n"
- .' "meanTimeToRepair": 4343,'."\n"
- .' "totalMeanTimeToAcknowledge": 3334,'."\n"
- .' "totalMeanTimeToRepair": 4343,'."\n"
- .' "escalationIncidentCount": 43,'."\n"
- .' "unAcknowledgedEscalationIncidentCount": 23,'."\n"
- .' "unFinishEscalationIncidentCount": 23'."\n"
- .' }'."\n"
- .' ]'."\n"
- .'}',
- ],
- 'ListDataReportForUser' => [
- 'summary' => '查询用户事件统计报表',
- 'path' => '/statistics/listDataReportForUser',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ['errorCode' => 'ProblemMeasureNotExisted', 'errorMessage' => 'The problem measure does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","type":"json"}]',
+ 'title' => 'Update fault improvement measures ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateProblemMeasure',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProblemMeasure'],
+ ],
+ ],
+ ],
+ 'UpdateProblemNotice' => [
+ 'summary' => 'Update fault notification.',
+ 'path' => '/problem/notify',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp20VVML',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempLC8226'],
],
'parameters' => [
[
@@ -22702,42 +16667,24 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'body',
'properties' => [
- 'startTime' => [
- 'description' => '',
- 'example' => '2021-09-01',
- 'required' => false,
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'description' => '',
- 'example' => '2021-09-30',
- 'required' => false,
- 'title' => '结束时间',
- 'type' => 'string',
- ],
- 'pageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '当前页',
- 'type' => 'integer',
- ],
- 'pageSize' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '页大小',
- 'type' => 'integer',
- ],
+ 'problemNotifyType' => ['description' => 'Notification type:'."\n"
+ ."\n"
+ .'- PROBLEM_NOTIFY: Fault notification.'."\n"
+ .'- PROBLEM_UPDATE: Fault update.'."\n"
+ .'- PROBLEM_UPGRADE: Fault upgrade.'."\n"
+ .'- PROBLEM_DEGRADE: Fault downgrade.'."\n"
+ .'- PROBLEM_RECOVER: Fault recovery.'."\n"
+ .'- PROBLEM_REISSUE: Fault reissue.'."\n"
+ .'- PROBLEM_CANCEL: Fault cancellation.', 'example' => 'PROBLEM_NOTIFY', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'problemId' => ['description' => 'Fault ID.', 'example' => '1312', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'],
+ 'clientToken' => ['description' => 'Idempotency validation ID.', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812', 'required' => false, 'title' => '', 'type' => 'string'],
],
'required' => false,
- 'title' => 'A short description of struct',
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -22746,147 +16693,60 @@
'schema' => [
'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'userName' => [
- 'description' => '',
- 'example' => 'wy',
- 'title' => '用户名字',
- 'type' => 'string',
- ],
- 'escalationIncidentCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '升级事件数量',
- 'type' => 'integer',
- ],
- 'distributionIncidentCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '分配事件数量',
- 'type' => 'integer',
- ],
- 'finishIncidentNumber' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '完结事件数量',
- 'type' => 'integer',
- ],
- 'unAcknowledgedEscalationIncidentCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '未响应升级数',
- 'type' => 'integer',
- ],
- 'unFinishEscalationIncidentCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '未完结事件数',
- 'type' => 'integer',
- ],
- 'meanTimeToAcknowledge' => [
- 'description' => 'MRRA',
- 'example' => '3分50秒',
- 'title' => 'MRRA',
- 'type' => 'string',
- ],
- 'meanTimeToRepair' => [
- 'description' => 'MTTA',
- 'example' => '3分50秒',
- 'title' => 'MTTA',
- 'type' => 'string',
- ],
- 'unDistributionIncidentCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '非分配完结数',
- 'type' => 'integer',
- ],
- 'finishProportion' => [
- 'description' => '',
- 'example' => '20%',
- 'title' => '完结率',
- 'type' => 'string',
- ],
- 'userId' => [
- 'description' => '',
- 'example' => '1111',
- 'format' => 'int64',
- 'title' => '用户ID',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => '个人统计数据',
- 'type' => 'array',
- ],
- 'totalCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int64',
- 'title' => '总条数',
- 'type' => 'integer',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812', 'title' => 'Id of the request', 'type' => 'string'],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CAB6E15D-ECE8-54A4-87C3-D701862DD4A2\\",\\n \\"data\\": [\\n {\\n \\"userName\\": \\"wy\\",\\n \\"escalationIncidentCount\\": 100,\\n \\"distributionIncidentCount\\": 100,\\n \\"finishIncidentNumber\\": 100,\\n \\"unAcknowledgedEscalationIncidentCount\\": 100,\\n \\"unFinishEscalationIncidentCount\\": 100,\\n \\"meanTimeToAcknowledge\\": \\"3分50秒\\",\\n \\"meanTimeToRepair\\": \\"3分50秒\\",\\n \\"unDistributionIncidentCount\\": 100,\\n \\"finishProportion\\": \\"20%\\",\\n \\"userId\\": 1111\\n }\\n ],\\n \\"totalCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"<ListDataReportForUserResponse>\\n <data>\\n <userName>wy</userName>\\n <escalationIncidentCount>100</escalationIncidentCount>\\n <distributionIncidentCount>100</distributionIncidentCount>\\n <finishIncidentNumber>100</finishIncidentNumber>\\n <unAcknowledgedEscalationIncidentCount>100</unAcknowledgedEscalationIncidentCount>\\n <unFinishEscalationIncidentCount>100</unFinishEscalationIncidentCount>\\n <meanTimeToAcknowledge>3分50秒</meanTimeToAcknowledge>\\n <meanTimeToRepair>3分50秒</meanTimeToRepair>\\n <unDistributionIncidentCount>100</unDistributionIncidentCount>\\n <finishProportion>20%</finishProportion>\\n </data>\\n</ListDataReportForUserResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{'."\n"
- .' "pageNumber": 1,'."\n"
- .' "pageSize": 10,'."\n"
- .' "startTime": "2021-11-01",'."\n"
- .' "endTime": "2021-11-08",'."\n"
- .' "clientToken": "4b31b55b-32af-415a-b2fb-a88b4e066845"'."\n"
- .'}',
- ],
- 'ListChartDataForUser' => [
- 'summary' => '统计图表数据-个人',
- 'path' => '/statistics/chartDataForUser/',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","type":"json"}]',
+ 'title' => 'Update fault notification',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateProblemNotice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProblemNotice'],
+ ],
],
+ ],
+ 'UpdateProblemTimeline' => [
+ 'summary' => 'Updates a problem timeline.',
+ 'path' => '/problem/process/timeline/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempTZ0FO2',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempZB7ZAW'],
],
'parameters' => [
[
@@ -22894,184 +16754,82 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'clientToken' => [
- 'description' => 'clientToken',
- 'example' => '3232dsd32sd32gr',
- 'required' => false,
- 'type' => 'string',
- ],
- 'startTime' => [
- 'description' => '',
- 'example' => '2021-09-09',
- 'required' => false,
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'description' => '',
- 'example' => '2021-10-09',
- 'required' => false,
- 'title' => '结束时间',
- 'type' => 'string',
- ],
+ 'problemTimelineId' => ['description' => 'Timeline ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '3940'],
+ 'keyNode' => ['description' => 'Key node lookup table (PROBLEM\\_KEY\\_NODE).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'NodeTest'],
+ 'content' => ['description' => 'Node content.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '故障分析'],
+ 'time' => ['description' => 'Occurrence time.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2021-01-08 10:10:10'],
+ 'problemId' => ['description' => 'Problem ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '234'],
+ 'clientToken' => ['title' => 'clientToken', 'description' => 'Idempotency token.', 'type' => 'string', 'required' => false, 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81'],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => '1231212',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'description' => 'data',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'time' => [
- 'description' => '',
- 'example' => '2021-09-09',
- 'title' => '时间',
- 'type' => 'string',
- ],
- 'incidentCount' => [
- 'description' => '',
- 'example' => '32',
- 'format' => 'int64',
- 'title' => '时间总数',
- 'type' => 'integer',
- ],
- 'effectionLevel' => [
- 'description' => '',
- 'example' => '{"P1HIGH":32}',
- 'title' => '根据影响等级时间等级分组统计数量',
- 'type' => 'object',
- ],
- 'meanTimeToAcknowledge' => [
- 'description' => '',
- 'example' => '323',
- 'format' => 'int64',
- 'title' => '当日平均响应时间单位秒',
- 'type' => 'integer',
- ],
- 'meanTimeToRepair' => [
- 'description' => '',
- 'example' => '4343',
- 'format' => 'int64',
- 'title' => '当日平均完结时间单位秒',
- 'type' => 'integer',
- ],
- 'totalMeanTimeToAcknowledge' => [
- 'description' => '',
- 'example' => '3334',
- 'format' => 'int64',
- 'title' => '总平均响应时间',
- 'type' => 'integer',
- ],
- 'totalMeanTimeToRepair' => [
- 'description' => '',
- 'example' => '4343',
- 'format' => 'int64',
- 'title' => '总平均完结时间',
- 'type' => 'integer',
- ],
- 'escalationIncidentCount' => [
- 'description' => '',
- 'example' => '43',
- 'format' => 'int64',
- 'title' => '升级事件数',
- 'type' => 'integer',
- ],
- 'unAcknowledgedEscalationIncidentCount' => [
- 'description' => '',
- 'example' => '23',
- 'format' => 'int64',
- 'title' => '未响应升级事件数',
- 'type' => 'integer',
- ],
- 'unFinishEscalationIncidentCount' => [
- 'description' => '',
- 'example' => '23',
- 'format' => 'int64',
- 'title' => '未完结升级事件数',
- 'type' => 'integer',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => 'data',
- 'type' => 'array',
- ],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81', 'title' => ''],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"0F4AFF8E-DF59-5CA6-B184-9E5A2A14C8D6\\",\\n \\"data\\": [\\n {\\n \\"time\\": \\"2021-09-09\\",\\n \\"incidentCount\\": 32,\\n \\"effectionLevel\\": {\\n \\"P1HIGH\\": 32\\n },\\n \\"meanTimeToAcknowledge\\": 323,\\n \\"meanTimeToRepair\\": 4343,\\n \\"totalMeanTimeToAcknowledge\\": 3334,\\n \\"totalMeanTimeToRepair\\": 4343,\\n \\"escalationIncidentCount\\": 43,\\n \\"unAcknowledgedEscalationIncidentCount\\": 23,\\n \\"unFinishEscalationIncidentCount\\": 23\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListChartDataForUserResponse>\\n <requestId>1231212</requestId>\\n <data>\\n <time>2021-09-09</time>\\n <incidentCount>32</incidentCount>\\n <meanTimeToAcknowledge>323</meanTimeToAcknowledge>\\n <meanTimeToRepair>4343</meanTimeToRepair>\\n <totalMeanTimeToAcknowledge>3334</totalMeanTimeToAcknowledge>\\n <totalMeanTimeToRepair>4343</totalMeanTimeToRepair>\\n <escalationIncidentCount>43</escalationIncidentCount>\\n <unAcknowledgedEscalationIncidentCount>23</unAcknowledgedEscalationIncidentCount>\\n <unFinishEscalationIncidentCount>23</unFinishEscalationIncidentCount>\\n </data>\\n</ListChartDataForUserResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{'."\n"
- .' "clientToken" : "3232dsd32sd32gr",'."\n"
- .' "startTime" : "2021-09-09",'."\n"
- .' "endTime" : "2021-10-09"'."\n"
- .'}',
- 'responseParamsDescription' => '{'."\n"
- .' "requestId": "1231212",'."\n"
- .' "data": ['."\n"
- .' {'."\n"
- .' "time": "2021-09-09",'."\n"
- .' "incidentCount": 32,'."\n"
- .' "meanTimeToAcknowledge": 323,'."\n"
- .' "meanTimeToRepair": 4343,'."\n"
- .' "totalMeanTimeToAcknowledge": 3334,'."\n"
- .' "totalMeanTimeToRepair": 4343,'."\n"
- .' "escalationIncidentCount": 43,'."\n"
- .' "unAcknowledgedEscalationIncidentCount": 23,'."\n"
- .' "unFinishEscalationIncidentCount": 23'."\n"
- .' }'."\n"
- .' ]'."\n"
- .'}',
- ],
- 'GeneratePictureLink' => [
- 'summary' => '图片连接获取',
- 'path' => '/rich/oss/getPictureLink',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'ProblemTimelineNotExisted', 'errorMessage' => 'The problem timeline does not exist.', 'description' => ''],
+ ['errorCode' => 'ProblemNotExisted', 'errorMessage' => 'The problem does not exist.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","type":"json"}]',
+ 'title' => 'Update Fault Timeline ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateProblemTimeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProblemTimeline'],
+ ],
],
+ ],
+ 'UpdateRichText' => [
+ 'summary' => 'Updates a rich text.',
+ 'path' => '/rich/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempHBPHMV',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempW15CG1'],
],
'parameters' => [
[
@@ -23079,128 +16837,89 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => 'A short description of struct',
+ 'description' => 'Request body.',
'properties' => [
- 'keys' => [
- 'description' => 'keys',
- 'items' => [
- 'description' => 'oss key',
- 'example' => 'oss key',
- 'required' => false,
- 'type' => 'string',
- ],
- 'required' => false,
- 'title' => 'keys',
- 'type' => 'array',
- ],
- 'problemId' => [
- 'description' => '',
- 'example' => '50002020',
- 'format' => 'int64',
- 'required' => false,
- 'title' => '故障id',
- 'type' => 'integer',
- ],
+ 'richTextId' => ['description' => 'Rich text ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '140080050', 'title' => '', 'required' => false],
+ 'instanceId' => ['description' => 'Resource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '140080050', 'title' => '', 'required' => false],
+ 'instanceType' => ['description' => 'Resource type:'."\n"
+ ."\n"
+ .'- INCIDENT: event.'."\n"
+ ."\n"
+ .'- ALERT: alert.'."\n"
+ ."\n"
+ .'- PROBLEM: problem.', 'type' => 'string', 'example' => 'INCIDENT', 'title' => '', 'required' => false],
+ 'richText' => ['description' => 'Rich text content.', 'type' => 'string', 'example' => '这是一个富文本', 'title' => '', 'required' => false],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'example' => 'xxxxxx',
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1021A12E-4BDF-5EC6-8251-6E998A3C360B'],
'data' => [
- 'description' => 'data',
+ 'description' => 'Returned data.',
'properties' => [
- 'links' => [
- 'description' => 'array',
- 'items' => [
- 'description' => 'object',
- 'properties' => [
- 'key' => [
- 'description' => 'oss key',
- 'example' => 'problem/38b2a36d-484d-4242-b9cf-d243e53a82c6',
- 'title' => 'oss key',
- 'type' => 'string',
- ],
- 'link' => [
- 'description' => 'url',
- 'example' => 'http://gam-objects-bucket.oss-cn-shanghai.aliyuncs.com/problem/38b2a36d-484d-4242-b9cf-d243e53a82c6?Expires=1625662477&OSSAccessKeyId=LTAI5tEoRVPw8GMy1iLRCno7&Signature=1NFnt%2BnudD%2F%2BHVc31b6v5%2FFxoqg%3D',
- 'title' => 'url',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'title' => 'array',
- 'type' => 'array',
- ],
+ 'id' => ['description' => 'Rich text ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '132971028'],
],
+ 'title' => 'data',
'type' => 'object',
+ 'example' => '',
],
],
'title' => 'Schema of Response',
'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxx\\",\\n \\"data\\": {\\n \\"links\\": [\\n {\\n \\"key\\": \\"problem/38b2a36d-484d-4242-b9cf-d243e5*****\\",\\n \\"link\\": \\"http://*****-bucket.oss-cn-shanghai.aliyuncs.com/problem/38b2a36d-484d-4242-b9cf-d243e53a82c6?Expires=1625662477&OSSAccessKeyId=LTAI****************&Signature=1NFnt%2BnudD%2F%2BHVc31b6v5%2FF*****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GeneratePictureLinkResponse>\\n <requestId>xxxxxx</requestId>\\n <data>\\n <links>\\n <key>problem/38b2a36d-484d-4242-b9cf-d243e5*****</key>\\n <link>http://*****-bucket.oss-cn-shanghai.aliyuncs.com/problem/38b2a36d-484d-4242-b9cf-d243e53a82c6?Expires=1625662477&amp;OSSAccessKeyId=LTAI5tEoRVPw8GMy1i*****&amp;Signature=1NFnt%2BnudD%2F%2BHVc31b6v5%2FF*****</link>\\n </links>\\n </data>\\n</GeneratePictureLinkResponse>","errorExample":""}]',
- 'requestParamsDescription' => '{'."\n"
- .' "keys" : [ "oss key" ],'."\n"
- .' "problemId" : 50002020'."\n"
- .'}',
- 'responseParamsDescription' => '{'."\n"
- .' "requestId": "xxxxxx",'."\n"
- .' "data": {'."\n"
- .' "links": ['."\n"
- .' {'."\n"
- .' "key": "problem/38b2a36d-484d-4242-b9cf-d243e53a82c6",'."\n"
- .' "link": "http://gam-objects-bucket.oss-cn-shanghai.aliyuncs.com/problem/38b2a36d-484d-4242-b9cf-d243e53a82c6?Expires=1625662477&OSSAccessKeyId=LTAI5tEoRVPw8GMy1iLRCno7&Signature=1NFnt%2BnudD%2F%2BHVc31b6v5%2FFxoqg%3D"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' }'."\n"
- .'}',
- ],
- 'RemoveIntegrationConfig' => [
- 'summary' => '解除集成配置',
- 'path' => '/integrationConfig/remove',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1021A12E-4BDF-5EC6-8251-6E998A3C360B\\",\\n \\"data\\": {\\n \\"id\\": 132971028\\n }\\n}","type":"json"}]',
+ 'title' => 'Update rich text',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateRichText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRichText'],
+ ],
],
+ ],
+ 'UpdateRouteRule' => [
+ 'summary' => 'Update a routing rule.',
+ 'path' => '/routeRule/edit',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempSLACC7',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempLJVP1W'],
],
'parameters' => [
[
@@ -23208,102 +16927,237 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'integrationConfigId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => 'Request body.',
+ 'properties' => [
+ 'ruleName' => ['description' => 'Rule name.', 'type' => 'string', 'required' => true, 'example' => '规则名称', 'title' => ''],
+ 'relatedServiceId' => ['description' => 'Associated service ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '关联服务ID', 'title' => ''],
+ 'routeRuleId' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '规则ID', 'title' => ''],
+ 'routeType' => ['description' => 'Routing type:'."\n"
+ ."\n"
+ .'- INCIDENT: Trigger an incident.'."\n"
+ ."\n"
+ .'- ALERT: Trigger only an alert.', 'type' => 'string', 'required' => true, 'example' => 'ALERT', 'title' => ''],
+ 'incidentLevel' => ['description' => 'Incident level (from highest to lowest):'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'string', 'required' => true, 'example' => 'P1', 'title' => ''],
+ 'assignObjectId' => ['description' => 'Assignment object ID. This can be a service group ID or a user ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'assignObjectType' => ['description' => 'Assignment object type:'."\n"
+ ."\n"
+ .'- SERVICEGROUP: A service group.'."\n"
+ ."\n"
+ .'- USER: A single user.', 'type' => 'string', 'required' => true, 'example' => 'SERVICEGROUP', 'title' => ''],
+ 'effection' => ['description' => 'Impact level:'."\n"
+ ."\n"
+ .'- LOW: Low impact.'."\n"
+ ."\n"
+ .'- HIGH: High impact.', 'type' => 'string', 'required' => true, 'example' => 'LOW', 'title' => ''],
+ 'timeWindow' => ['description' => 'Time window.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
+ 'timeWindowUnit' => ['description' => 'Time window unit:'."\n"
+ ."\n"
+ .'- MINUTE: Minutes.'."\n"
+ ."\n"
+ .'- SECOND: Seconds.', 'type' => 'string', 'required' => true, 'example' => 'MINUTE', 'title' => ''],
+ 'matchCount' => ['description' => 'Number of matches.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''],
+ 'routeChildRules' => [
+ 'description' => 'Child rules.',
+ 'items' => [
+ 'description' => 'Child rule.',
+ 'properties' => [
+ 'childRouteRuleId' => ['description' => 'Child rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'conditions' => [
+ 'description' => 'Conditions.',
+ 'items' => [
+ 'description' => 'Condition.',
+ 'properties' => [
+ 'key' => ['description' => 'Condition key.', 'type' => 'string', 'required' => true, 'example' => 'payload.summary', 'title' => ''],
+ 'value' => ['description' => 'Matching value.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''],
+ 'operationSymbol' => ['description' => 'Operator.', 'type' => 'string', 'required' => true, 'example' => 'equals', 'title' => ''],
+ ],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'monitorSourceId' => ['description' => 'Monitoring source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'isValidChildRule' => ['description' => 'Specifies whether to delete the child rule.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''],
+ 'childConditionRelation' => ['description' => 'Child condition evaluation logic:'."\n"
+ ."\n"
+ .'- 0: AND.'."\n"
+ ."\n"
+ .'- 1: OR.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'problemLevel' => ['description' => 'Problem level (from highest to lowest):'."\n"
+ ."\n"
+ .'- P1'."\n"
+ ."\n"
+ .'- P2'."\n"
+ ."\n"
+ .'- P3'."\n"
+ ."\n"
+ .'- P4', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''],
+ ],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'notifyChannels' => [
+ 'description' => 'Notification channels.',
+ 'items' => ['description' => 'Notification channel.', 'type' => 'string', 'required' => true, 'example' => '[SMS,PHONE]', 'title' => ''],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
+ 'childRuleRelation' => ['title' => 'AND', 'description' => 'Child rule evaluation logic:'."\n"
+ ."\n"
+ .'- AND: All child rules must match.'."\n"
+ ."\n"
+ .'- OR: At least one child rule must match.', 'type' => 'string', 'example' => 'AND', 'required' => false],
+ 'problemLevelGroup' => [
+ 'description' => 'The severity level of the incident.',
+ 'additionalProperties' => [
+ 'description' => 'The severity level of the incident.',
+ 'type' => 'object',
+ 'properties' => [
+ 'childRuleRelation' => ['title' => 'Child Rule Relation, 0 for AND, 1 for OR ', 'description' => 'Child rule evaluation logic:'."\n"
+ ."\n"
+ .'- 0: AND.'."\n"
+ ."\n"
+ .'- 1: OR.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => ''],
+ 'matchCount' => ['title' => '抑制:命中次数', 'description' => 'Suppression: Number of matches.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ 'timeWindow' => ['title' => 'Suppression: Time Window ', 'description' => 'Suppression: Time window.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ 'timeWindowUnit' => ['title' => 'Suppression: Time Window Unit ', 'description' => 'Suppression: Time window unit.', 'type' => 'string', 'required' => false, 'example' => ''],
+ 'enableUpgrade' => ['title' => '升级:是否升级', 'description' => 'Upgrade: Enable upgrade.', 'type' => 'boolean', 'required' => false, 'example' => ''],
+ 'upgradeTimeWindow' => ['title' => '升级:时间窗口', 'description' => 'Upgrade: Time window.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
+ 'upgradeTimeWindowUnit' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'type' => 'object',
'required' => false,
- 'example' => '103',
+ 'title' => '',
+ 'example' => '',
],
- 'clientToken' => [
- 'title' => '幂等id',
- 'description' => '',
- 'type' => 'string',
+ 'coverageProblemLevels' => [
+ 'description' => 'Coverage type.',
+ 'title' => 'Fault level coverage ',
+ 'type' => 'array',
+ 'items' => ['description' => 'Coverage type.', 'type' => 'string', 'required' => false, 'example' => 'P1', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'problemEffectionServices' => [
+ 'description' => 'List of affected services.',
+ 'title' => '[parameters_body_schema_properties_routeChildRules_items_properties_childRouteRuleId_description]Child rule ID.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Affected service ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'convergenceFields' => [
+ 'description' => 'Convergence field collection.',
+ 'title' => '[parameters_body_schema_properties_routeChildRules_items_properties_conditions_type]array',
+ 'type' => 'array',
+ 'items' => ['description' => 'Collection of convergence fields.', 'type' => 'string', 'required' => false, 'example' => 'app', 'title' => ''],
'required' => false,
- 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
+ 'example' => '',
],
+ 'convergenceType' => ['title' => 'Convergence Type (0: Stream Rule Convergence, 1: Field Convergence) ', 'description' => 'Convergence type:'."\n"
+ ."\n"
+ .'- 0: Rule-based convergence.'."\n"
+ ."\n"
+ .'- 1: Field-based convergence.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
'required' => false,
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'title' => 'requestId',
- 'description' => '',
- 'type' => 'string',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- ],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
+ 'data' => ['description' => 'Result.', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', 'title' => ''],
],
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IntegrationConfigExistsRouteRule',
- 'errorMessage' => 'integration config exists routeRule.',
- ],
+ ['errorCode' => 'RouteRuleNameAlreadyExisted', 'errorMessage' => 'The rule name already exists.', 'description' => ''],
],
- 403 => [
- [
- 'errorCode' => 'IntegationConfigNotIntegrated',
- 'errorMessage' => 'The specified integration config is not integrated.',
- ],
- [
- 'errorCode' => 'IntegationConfigAlreadyDisable',
- 'errorMessage' => 'The specified integration config is already disabled.',
- ],
+ 404 => [
+ ['errorCode' => 'RouteRuleNotExisted', 'errorMessage' => 'The rule does not exist.', 'description' => ''],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": 0\\n}","type":"json"}]',
+ 'title' => 'Edit stream routing rules ',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-07T12:30:08.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'IntegationConfigNotExists',
- 'errorMessage' => 'The specified integration config does not exist.',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","type":"json"}]',
- ],
- 'ListByMonitorSourceId' => [
- 'summary' => '监控关联规则列表',
- 'path' => '/routeRule/listByMonitorSourceId',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRouteRule'],
+ ],
],
+ ],
+ 'UpdateService' => [
+ 'summary' => 'Updates a service.',
+ 'path' => '/services/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempBHVB81',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
'parameters' => [
[
@@ -23311,174 +17165,220 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '',
- 'type' => 'object',
+ 'description' => 'The request body.',
'properties' => [
- 'monitorSourceId' => [
- 'description' => '',
- 'type' => 'string',
+ 'serviceDescription' => ['description' => 'The description of the service.', 'type' => 'string', 'example' => '服务描述', 'title' => '', 'required' => false],
+ 'serviceName' => ['description' => 'The name of the service.', 'type' => 'string', 'example' => '服务A', 'title' => '', 'required' => false],
+ 'serviceId' => ['description' => 'The service ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10002000', 'title' => '', 'required' => false],
+ 'clientToken' => ['description' => 'The idempotence token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
+ 'escalationPlanId' => ['title' => 'Upgrade Policy ID', 'description' => 'The ID of the escalation policy.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '234534'],
+ 'serviceGroupIdList' => [
+ 'description' => 'The ID of the service group.',
+ 'title' => 'List of service group IDs',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the service group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''],
'required' => false,
- 'example' => '23469',
+ 'example' => '',
],
],
'required' => false,
+ 'title' => 'A short description of struct',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'title' => 'id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
- ],
- 'data' => [
- 'title' => 'data',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'title' => '用户id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '164769572',
- ],
- 'ruleName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'internal-alert-center-log',
- ],
- ],
- ],
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
+ 'data' => ['description' => 'The returned data.', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', 'title' => ''],
],
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": [\\n {\\n \\"id\\": 164769572,\\n \\"ruleName\\": \\"internal-alert-center-log\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListByMonitorSourceIdResponse>\\n <requestId>10REQUES-AC5C-4B59-BE11-378F117A6A88</requestId>\\n <data>\\n <id>123456</id>\\n <ruleName>监控1</ruleName>\\n </data>\\n</ListByMonitorSourceIdResponse>","errorExample":""}]',
- ],
- 'ListRouteRulesByService' => [
- 'summary' => '根据服务id查询流转规则',
- 'path' => '/routeRule/listByService',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'EditServiceFail', 'errorMessage' => 'Failed to edit the service.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'ServiceNotExisted', 'errorMessage' => 'The service does not exist.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": 0\\n}","type":"json"}]',
+ 'title' => 'Update Service',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:54.000Z', 'description' => 'Request parameters changed'],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateService'],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'UpdateServiceGroup' => [
+ 'summary' => 'Updates a service group.',
+ 'path' => '/services/group/modify',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempJRUU6V',
- ],
+ 'abilityTreeNodes' => ['FEATUREgemp1A354K'],
],
- 'parameters' => [],
- 'responses' => [
- 200 => [
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '4361a0e1-6747-4834-96ce-0c4840fd381A',
- ],
- 'data' => [
- 'description' => '',
+ 'description' => 'Request body.',
+ 'properties' => [
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'enableWebhook' => ['description' => 'Enable or disable the webhook:'."\n"
+ ."\n"
+ .'- DISABLE: Disable the webhook.'."\n"
+ ."\n"
+ .'- ENABLE: Enable the webhook.', 'type' => 'string', 'required' => true, 'example' => 'ENABLE', 'title' => ''],
+ 'webhookType' => ['description' => '- WEIXIN\\_GROUP: WeChat group.'."\n"
+ ."\n"
+ .'- DING\\_GROUP: DingTalk group.', 'type' => 'string', 'required' => true, 'example' => 'WEIXIN_GROUP', 'title' => ''],
+ 'webhookLink' => ['description' => 'Webhook URL.', 'type' => 'string', 'required' => true, 'example' => 'wwwwwww', 'title' => ''],
+ 'serviceGroupName' => ['description' => 'Service group name.', 'type' => 'string', 'required' => true, 'example' => '我的服务组', 'title' => ''],
+ 'serviceGroupDescription' => ['description' => 'Service group description.', 'type' => 'string', 'example' => '服务组描述', 'title' => '', 'required' => false],
+ 'userIds' => [
+ 'description' => 'Array of user IDs.',
+ 'items' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '55', 'title' => ''],
+ 'required' => true,
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
+ ],
+ 'monitorSourceTemplates' => [
+ 'description' => 'List of message templates.',
'items' => [
- 'description' => '',
- 'type' => 'object',
+ 'description' => 'List of message templates.',
'properties' => [
- 'id' => [
- 'title' => '规则id',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '60852564',
- ],
- 'ruleName' => [
- 'title' => '规则名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'templateId' => ['description' => 'Message template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', 'title' => '', 'required' => false],
+ 'monitorSourceId' => ['description' => 'Monitoring source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11111', 'title' => '', 'required' => false],
+ 'monitorSourceName' => ['description' => 'Monitoring source name.', 'type' => 'string', 'example' => 'zabbix', 'title' => '', 'required' => false],
+ 'templateContent' => ['description' => 'Template content.', 'type' => 'string', 'example' => '内容', 'title' => '', 'required' => false],
],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'totalCount' => [
- 'title' => '流转规则数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '103',
- ],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
],
+ 'required' => false,
+ 'title' => 'A short description of struct',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd381A\\",\\n \\"data\\": [\\n {\\n \\"id\\": 60852564,\\n \\"ruleName\\": \\"规则1\\"\\n }\\n ],\\n \\"totalCount\\": 103\\n}","errorExample":""},{"type":"xml","example":"<ListRouteRulesByServiceResponse>\\n <elapsedTime>0</elapsedTime>\\n <requestId>12121212121</requestId>\\n <success>true</success>\\n <errCode>200</errCode>\\n <errMessage/>\\n <data>\\n <id>160044070</id>\\n <tenantRamId>1344383</tenantRamId>\\n <ruleName>张2流转</ruleName>\\n <timeWindow>1</timeWindow>\\n <timeWindowUnit>0</timeWindowUnit>\\n <matchCount>1</matchCount>\\n <relServiceId>140000080</relServiceId>\\n <relServiceName/>\\n <isValid>1</isValid>\\n <enableStatus>1</enableStatus>\\n <routeType>0</routeType>\\n <incidentLevel>4</incidentLevel>\\n <assignWhoId>130030040</assignWhoId>\\n <assignWhoType>0</assignWhoType>\\n <effection>0</effection>\\n <creatorRamId>1344383</creatorRamId>\\n <gmtCreated>2022-05-25 16:31:29</gmtCreated>\\n <gmtModified>2022-05-25 16:31:29</gmtModified>\\n <notifyChannelStr/>\\n <subscriptionId/>\\n <createUserId>63</createUserId>\\n <childRuleRelation>0</childRuleRelation>\\n </data>\\n <total>1</total>\\n <pageNum>0</pageNum>\\n <pageSize>0</pageSize>\\n</ListRouteRulesByServiceResponse>","errorExample":""}]',
- ],
- 'GetTenantStatus' => [
- 'summary' => '查询租户开通运维事件中心的状态',
- 'path' => '/tenant/getTenantStatus',
- 'methods' => [
- 'post',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Response structure.',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43'],
+ ],
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ServiceGroupNotExisted', 'errorMessage' => 'The service group does not exist.', 'description' => ''],
+ ['errorCode' => 'EditServiceGroupFail', 'errorMessage' => 'Failed to edit the service group.', 'description' => ''],
+ ['errorCode' => 'ServiceGroupWebHookLinkAlreadyExisted', 'errorMessage' => 'The webhook link is already in use.', 'description' => ''],
+ ['errorCode' => 'ServiceGroupNameAlreadyExisted', 'errorMessage' => 'The service group name is already in use.', 'description' => ''],
+ ],
+ 405 => [
+ ['errorCode' => 'openFailed', 'errorMessage' => 'open Failed', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","type":"json"}]',
+ 'title' => 'Edit a service group ',
+ 'changeSet' => [
+ ['createdAt' => '2022-10-27T12:01:25.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-07-16T04:09:45.000Z', 'description' => 'Request parameters changed'],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceGroup'],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'UpdateServiceGroupScheduling' => [
+ 'summary' => 'Update the scheduling configuration for a service group.',
+ 'path' => '/services/group/scheduling/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempXF96RS',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempCICFVA'],
],
'parameters' => [
[
@@ -23486,326 +17386,330 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'object',
+ 'description' => 'Request body.',
'properties' => [
- 'tenantRamId' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '132649864',
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', 'title' => ''],
+ 'schedulingWay' => ['description' => 'Scheduling method:'."\n"
+ ."\n"
+ .'- FAST: Fast scheduling.'."\n"
+ ."\n"
+ .'- FINE: Fine-grained scheduling.', 'type' => 'string', 'required' => true, 'example' => 'FAST', 'title' => ''],
+ 'fastScheduling' => [
+ 'description' => 'Enables fast scheduling.',
+ 'example' => 'HOUR',
+ 'properties' => [
+ 'singleDuration' => ['description' => 'Shift duration per person.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => '', 'required' => false],
+ 'dutyPlan' => ['description' => 'Duty plan:'."\n"
+ ."\n"
+ .'- FAST\\_CHOICE: Fast selection.'."\n"
+ ."\n"
+ .'- CUSTOM: Custom.', 'type' => 'string', 'example' => 'FAST_CHOICE', 'title' => '', 'required' => false],
+ 'singleDurationUnit' => ['description' => 'Unit for shift duration per person:'."\n"
+ ."\n"
+ .'- HOUR: Hour.'."\n"
+ ."\n"
+ .'- DAY: Day.', 'type' => 'string', 'example' => 'DAY', 'title' => '', 'required' => false],
+ 'schedulingUsers' => [
+ 'description' => 'Users for fast rotation scheduling.',
+ 'items' => [
+ 'description' => 'User for fast rotation scheduling.',
+ 'properties' => [
+ 'schedulingUserId' => ['description' => 'User ID for rotation scheduling.', 'type' => 'integer', 'format' => 'int64', 'example' => '6666', 'title' => '', 'required' => false],
+ 'schedulingOrder' => ['description' => 'Scheduling order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ 'schedulingObjectType' => ['title' => 'Schedule Object Type ', 'description' => 'Scheduling task type.', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'schedulingUserIdList' => [
+ 'description' => 'List of users for scheduling.',
+ 'type' => 'array',
+ 'items' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'id' => ['description' => 'Fast scheduling ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'object',
+ ],
+ 'fineScheduling' => [
+ 'description' => 'Fine-grained scheduling configuration.',
+ 'properties' => [
+ 'period' => ['description' => 'Cycle period.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ 'periodUnit' => ['description' => 'Unit for cycle period:'."\n"
+ ."\n"
+ .'- HOUR: Hour.'."\n"
+ ."\n"
+ .'- DAY: Day.', 'type' => 'string', 'example' => 'DAY', 'title' => '', 'required' => false],
+ 'shiftType' => ['description' => 'Shift type:'."\n"
+ ."\n"
+ .'- MORNING\\_NIGHT: Morning and night shifts.'."\n"
+ ."\n"
+ .'- MORNING\\_NOON\\_NIGHT: Morning, noon, and night shifts.'."\n"
+ ."\n"
+ .'- CUSTOM: Custom.', 'type' => 'string', 'example' => 'MORNING_NIGHT', 'title' => '', 'required' => false],
+ 'schedulingFineShifts' => [
+ 'description' => 'Staff information for fine-grained scheduling shifts.',
+ 'items' => [
+ 'description' => 'Fine-grained scheduling.',
+ 'properties' => [
+ 'schedulingStartTime' => ['description' => 'Scheduling start time.', 'type' => 'string', 'example' => '2020-08-13', 'title' => '', 'required' => false],
+ 'schedulingEndTime' => ['description' => 'Scheduling end time.', 'type' => 'string', 'example' => '2020-10-13', 'title' => '', 'required' => false],
+ 'schedulingOrder' => ['description' => 'Scheduling order.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'shiftName' => ['description' => 'Shift name.', 'type' => 'string', 'example' => '早班', 'title' => '', 'required' => false],
+ 'skipOneDay' => ['description' => 'Whether the shift spans two days.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'],
+ 'schedulingUserId' => ['description' => 'User ID for scheduling.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '32'],
+ 'cycleOrder' => ['description' => 'Cycle order.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '123'],
+ 'schedulingObjectType' => ['title' => 'Scheduling Object Type', 'description' => 'Scheduling task type.', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'schedulingUserIdList' => [
+ 'description' => 'List of users for scheduling.',
+ 'title' => 'User IDs for multi-user scheduling ',
+ 'type' => 'array',
+ 'items' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'schedulingTemplateFineShifts' => [
+ 'description' => 'Fine-grained scheduling template.',
+ 'items' => [
+ 'description' => 'Fine-grained scheduling.',
+ 'properties' => [
+ 'schedulingStartTime' => ['description' => 'Scheduling start time.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2021-10-01 00:00:00'],
+ 'schedulingEndTime' => ['description' => 'Scheduling end time.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2021-11-01 00:00:00'],
+ 'schedulingOrder' => ['description' => 'Scheduling order.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
+ 'schedulingUserId' => ['description' => 'User ID for scheduling.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'],
+ 'shiftName' => ['description' => 'Shift name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '早班'],
+ 'skipOneDay' => ['description' => 'Whether the shift spans two days.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'],
+ 'schedulingObjectType' => ['title' => 'Scheduling object type ', 'description' => 'Scheduling type.', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'schedulingUserIdList' => [
+ 'description' => 'List of users for scheduling.',
+ 'title' => 'User IDs for multi-person scheduling',
+ 'type' => 'array',
+ 'items' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'id' => ['description' => 'Fine-grained scheduling ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
],
'required' => false,
+ 'title' => 'A short description of struct',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => ' 2E7566D1-9E4A-58FA-AEB1-179F86634256',
- ],
- 'data' => [
- 'type' => 'object',
- 'properties' => [
- 'tenantStatus' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'xxxxxxxxxx'],
],
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\" 2E7566D1-9E4A-58FA-AEB1-179F86634256\\",\\n \\"data\\": {\\n \\"tenantStatus\\": 1\\n }\\n}","type":"json"}]',
- 'responseParamsDescription' => '```'."\n"
- .'{'."\n"
- .' "data": {'."\n"
- .' "tenantStatus": 1'."\n"
- .' },'."\n"
- .' "requestId": "6F4514FD-6CE6-5133-B5D8-2B556FCED7A2"'."\n"
- .'}'."\n"
- .'```',
- ],
- 'BillingStatistics' => [
- 'summary' => '计费展示',
- 'path' => '/charging/details',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid. %s', 'description' => 'The specified parameter is not valid.'."\n"],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxxxxxxxx\\"\\n}","type":"json"}]',
+ 'title' => 'Modify the service group scheduling',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-26T13:01:21.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-09-10T01:53:17.000Z', 'description' => 'OpenAPI offline'],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateServiceGroupScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceGroupScheduling'],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'UpdateServiceGroupSpecialDayScheduling' => [
+ 'summary' => 'Updates service group scheduling for a specific date.',
+ 'path' => '/services/group/scheduling/updateSpecialDayScheduling',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempV73LIB',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempU4CBQS'],
],
- 'parameters' => [],
- 'responses' => [
- 200 => [
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'object',
+ 'description' => 'Request body.',
'properties' => [
- 'data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ruleCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'ruleCountFree' => [
- 'title' => '流转规则免费数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'subscriptionNotifyCount' => [
- 'title' => '通知订阅数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'subscriptionNotifyCountFree' => [
- 'title' => '通知订阅免费数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'escalationPlanCount' => [
- 'title' => '升级策略数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'escalationPlanCountFree' => [
- 'title' => '升级策略免费数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'hasScheduleServiceGroupCount' => [
- 'title' => '服务排班数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'hasScheduleServiceGroupCountFree' => [
- 'title' => '服务排班免费数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'appUserCount' => [
- 'title' => '云钉协同数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'appUserCountFree' => [
- 'title' => '云钉协同免费数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'eventReportApi' => [
- 'title' => '告警上报',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'eventReportApiFree' => [
- 'title' => '告警上报免费数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'smsSend' => [
- 'title' => '短信条数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'smsSendFree' => [
- 'title' => '短信免费条数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'voiceSend' => [
- 'title' => '电话数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'voiceSendFree' => [
- 'title' => '电话免费数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'emailSend' => [
- 'title' => '邮件数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'emailSendFree' => [
- 'title' => '邮件免费数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'imMsgSend' => [
- 'title' => '即时通讯数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'imMsgSendFree' => [
- 'title' => '即时通讯免费数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'type' => [
- 'title' => '系统控制下的查询状态 true开启查数据库 false关闭不查数据库',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'serviceGroupId' => ['description' => 'Service group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6666', 'title' => ''],
+ 'schedulingDate' => ['description' => 'Scheduling date.', 'type' => 'string', 'required' => true, 'example' => '2021-08-19', 'title' => ''],
+ 'schedulingSpecialDays' => [
+ 'description' => 'Scheduling information.',
+ 'items' => [
+ 'description' => 'Scheduling.',
+ 'properties' => [
+ 'schedulingStartTime' => ['description' => 'Scheduling start time.', 'type' => 'string', 'required' => true, 'example' => '2021-08-19 08:00:00', 'title' => ''],
+ 'schedulingEndTime' => ['description' => 'Scheduling end time.', 'type' => 'string', 'required' => true, 'example' => '2021-08-19 12:00:00', 'title' => ''],
+ 'schedulingUserId' => ['description' => 'Scheduling user.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '64', 'title' => ''],
+ 'schedulingOrder' => ['description' => 'The shift order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ 'schedulingObjectType' => ['title' => 'Scheduled Object Type', 'description' => 'Scheduling object type.', 'type' => 'string', 'required' => false, 'example' => ''],
+ 'schedulingUserIdList' => [
+ 'description' => 'List of scheduling members.',
+ 'title' => 'User IDs for multi-person scheduling ',
+ 'type' => 'array',
+ 'items' => ['description' => 'Scheduling member list.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4A83AF20-B471-5646-A2CA-2DC688A13013',
- ],
+ 'clientToken' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43', 'title' => '', 'required' => false],
],
+ 'required' => false,
+ 'title' => 'A short description of struct',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"ruleCount\\": 0,\\n \\"ruleCountFree\\": 0,\\n \\"subscriptionNotifyCount\\": 0,\\n \\"subscriptionNotifyCountFree\\": 0,\\n \\"escalationPlanCount\\": 0,\\n \\"escalationPlanCountFree\\": 0,\\n \\"hasScheduleServiceGroupCount\\": 0,\\n \\"hasScheduleServiceGroupCountFree\\": 0,\\n \\"appUserCount\\": 0,\\n \\"appUserCountFree\\": 0,\\n \\"eventReportApi\\": 0,\\n \\"eventReportApiFree\\": 0,\\n \\"smsSend\\": 0,\\n \\"smsSendFree\\": 0,\\n \\"voiceSend\\": 0,\\n \\"voiceSendFree\\": 0,\\n \\"emailSend\\": 0,\\n \\"emailSendFree\\": 0,\\n \\"imMsgSend\\": 0,\\n \\"imMsgSendFree\\": 0,\\n \\"type\\": true\\n },\\n \\"RequestId\\": \\"4A83AF20-B471-5646-A2CA-2DC688A13013\\"\\n}","type":"json"}]',
- ],
- 'DeleteServiceGroupScheduling' => [
- 'summary' => '删除排班',
- 'path' => '/services/group/scheduling/delete',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempUBXKF7',
- ],
- ],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'type' => 'object',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'xxxxxxxx'],
],
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 401 => [
- [
- 'errorCode' => 'DeleteServiceGroupSchedulingFail',
- 'errorMessage' => 'The service group has been associated with route rule. ',
- ],
+ 404 => [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified Resource is not found.', 'description' => 'The specified Resource is not found.'],
],
],
- 'responseDemo' => null,
- ],
- 'ListEscalationPlansByNoticeObject' => [
- 'summary' => '根据推送对象查询升级策略',
- 'path' => '/escalationPlan/listByNoticeObject',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxxxxxx\\"\\n}","type":"json"}]',
+ 'title' => 'Modify the service group scheduling for a specified date ',
+ 'changeSet' => [
+ ['createdAt' => '2022-12-26T13:01:21.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-09-10T01:53:17.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateServiceGroupSpecialDayScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceGroupSpecialDayScheduling'],
+ ],
],
+ ],
+ 'UpdateSubscription' => [
+ 'summary' => 'Updates a notification subscription.',
+ 'path' => '/notify/subscription/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempGUN0ZL',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempJPZI30'],
],
'parameters' => [
[
@@ -23813,177 +17717,292 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'noticeObjectId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'noticeObjectType' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'type' => 'object',
+ 'description' => 'The request body.',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
+ 'subscriptionId' => ['description' => 'The primary key.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '80002020', 'title' => ''],
+ 'subscriptionTitle' => ['description' => 'The name of the notification subscription.', 'type' => 'string', 'required' => true, 'example' => 'newSubs244', 'title' => ''],
+ 'scope' => ['description' => 'The type of the subscription scope.', 'type' => 'string', 'required' => true, 'example' => 'SERVICE', 'title' => ''],
+ 'notifyObjectType' => ['description' => 'The type of the notification recipient.', 'type' => 'string', 'required' => true, 'example' => 'USER', 'title' => ''],
+ 'expiredType' => ['description' => 'The validity period of the subscription.', 'type' => 'string', 'required' => true, 'example' => 'LONG_TERM', 'title' => ''],
+ 'period' => ['description' => 'The validity period of the subscription.', 'type' => 'string', 'example' => '20天', 'title' => '', 'required' => false],
+ 'scopeObjectList' => [
+ 'description' => 'The list of subscription scopes.',
+ 'items' => [
+ 'description' => 'The subscription scope object.',
+ 'properties' => [
+ 'id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ 'scopeObjectId' => ['description' => 'The ID of the subscription scope object.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ ],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
'type' => 'array',
+ 'example' => '',
+ ],
+ 'notifyObjectList' => [
+ 'description' => 'The list of notification recipients.',
'items' => [
+ 'description' => 'The notification recipient.',
+ 'properties' => [
+ 'id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
+ 'notifyObjectId' => ['description' => 'The ID of the notification recipient.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '19', 'title' => ''],
+ ],
+ 'required' => true,
'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'notifyStrategyList' => [
+ 'description' => 'The list of notification policies.',
+ 'items' => [
+ 'description' => 'The subscription behavior.',
'properties' => [
- 'escalationPlanId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'escalationPlanName' => [
- 'type' => 'string',
- ],
- 'escalationPlanScopeObjects' => [
- 'type' => 'array',
+ 'instanceType' => ['description' => 'The type of the subscription instance. Valid values:'."\n"
+ ."\n"
+ .'- INCIDENT: event'."\n"
+ ."\n"
+ .'- ALERT: alert'."\n"
+ ."\n"
+ .'- PROBLEM: problem', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'INCIDENT', 'title' => ''],
+ 'strategies' => [
+ 'description' => 'The notification policy.',
'items' => [
- 'type' => 'object',
+ 'description' => 'The subscription scope.',
'properties' => [
- 'scopeObjectId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'scopeObjectName' => [
- 'type' => 'string',
- ],
- 'scope' => [
- 'type' => 'string',
+ 'id' => ['title' => 'id', 'description' => 'The alert level.', 'type' => 'string', 'example' => '10', 'required' => false],
+ 'channels' => ['description' => 'Fault level.', 'type' => 'string', 'example' => 'SMS,WEIXIN_GROUP', 'title' => '', 'required' => false],
+ 'conditions' => [
+ 'description' => 'The impact degree.',
+ 'items' => [
+ 'description' => 'The privacy dataset.',
+ 'properties' => [
+ 'level' => ['description' => 'The level.', 'type' => 'string', 'example' => 'P1', 'title' => '', 'required' => false],
+ 'effection' => ['description' => 'The impact degree.', 'type' => 'string', 'example' => 'HIGH', 'title' => '', 'required' => false],
+ 'problemNotifyType' => ['description' => 'The problem notification type.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'PROBLEM_NOTIFY'],
+ 'action' => ['description' => 'The event action.', 'type' => 'string', 'example' => 'INCIDENT_TRIGGER', 'title' => '', 'required' => false],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'scopeObjectDeletedType' => [
- 'type' => 'integer',
- 'format' => 'int32',
+ 'periodChannel' => [
+ 'description' => 'The notification subscription channels for different time periods.',
+ 'properties' => [
+ 'workday' => ['description' => 'The notification subscription channels for workdays.', 'type' => 'string', 'example' => 'SMS,WEIXIN_GROUP', 'title' => '', 'required' => false],
+ 'nonWorkday' => ['description' => 'The notification subscription channels for non-workdays.', 'type' => 'string', 'example' => 'SMS,WEIXIN_GROUP', 'title' => '', 'required' => false],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
],
],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'status' => [
- 'type' => 'string',
- ],
- 'modifyTime' => [
- 'type' => 'string',
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
],
+ 'required' => true,
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
+ 'required' => true,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
+ 'startTime' => ['description' => 'The effective start time.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2021-04-04 10:10:11'],
+ 'endTime' => ['description' => 'The expiration time.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2022-05-09 10:10:23'],
],
+ 'required' => false,
+ 'title' => 'A short description of struct',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => null,
- ],
- 'UnbindUser' => [
- 'summary' => '解绑用户',
- 'path' => '/user/unbind',
- 'methods' => [
- 'post',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response structure.',
+ 'properties' => [
+ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81', 'title' => ''],
+ ],
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NotifySubsAlreadyExists', 'errorMessage' => 'The specified subscription already exists.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'NotifySubsNotExists', 'errorMessage' => 'The specified subscription does not exist.', 'description' => ''],
+ ],
],
- 'security' => [
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","type":"json"}]',
+ 'title' => 'Subscribe to Update Notifications',
+ 'changeSet' => [
+ ['createdAt' => '2021-07-16T04:09:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-07-16T04:09:37.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSubscription'],
+ ],
],
- 'produces' => [
- 'application/json',
+ ],
+ 'UpdateUser' => [
+ 'summary' => 'Updates user information.',
+ 'path' => '/user/update',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1Z9RF2',
+ 'abilityTreeNodes' => ['FEATUREgempT8ZOYV'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'Request body.',
+ 'properties' => [
+ 'ramId' => ['description' => 'RAM user ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '2243564'],
+ 'phone' => ['description' => 'Phone number.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '18887878****'],
+ 'username' => ['description' => 'Username.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '张珊'],
+ 'email' => ['description' => 'Mailbox.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '78799****@qq.com'],
+ 'userId' => ['description' => 'User ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111', 'title' => ''],
+ 'clientToken' => ['description' => 'Idempotency token.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81'],
+ 'roleIdList' => [
+ 'description' => 'User roles.',
+ 'title' => 'User roles',
+ 'type' => 'array',
+ 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => 'A short description of struct',
+ 'type' => 'object',
+ 'example' => '',
+ ],
],
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'type' => 'object',
+ 'description' => 'Response structure.',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81', 'title' => ''],
],
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
'errorCodes' => [
- 401 => [
- [
- 'errorCode' => 'UnbindUserFail',
- 'errorMessage' => 'The specified user does not exist.',
- ],
+ 400 => [
+ ['errorCode' => 'PhoneAlreadyExists', 'errorMessage' => 'The specified phone number already exists.', 'description' => ''],
],
- [
- [
- 'errorCode' => 'UnbindUserFail',
- 'errorMessage' => 'Not find userId.',
- ],
+ 404 => [
+ ['errorCode' => 'UserNotExists', 'errorMessage' => 'The specified user does not exist.', 'description' => ''],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","type":"json"}]',
+ 'title' => 'Update personnel information',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-13T12:01:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'UnbindUserFail',
- 'errorMessage' => 'Mobile app not opened.',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => null,
- ],
- 'ListRouteRulesByAssignWhoId' => [
- 'summary' => '获取指定分配对象的流转规则',
- 'path' => '/routeRule/listByAssignWhoId',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUser'],
+ ],
],
+ ],
+ 'UpdateUserGuideStatus' => [
+ 'summary' => 'Update the user guide status.',
+ 'path' => '/user/update/guide/status',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgempJRUU6V',
- ],
+ 'abilityTreeNodes' => ['FEATUREgempVWXIZC'],
],
'parameters' => [
[
@@ -23991,125 +18010,2816 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'type' => 'object',
+ 'description' => 'A short description of struct',
+ 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'properties' => [
- 'assignWhoId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'assignWhoType' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'clientToken' => ['description' => 'Idempotency validation.', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'required' => false, 'title' => '', 'type' => 'string'],
+ 'guideAction' => ['description' => '- INCIDENT_GUIDE: management event stream. '."\n"
+ .'- USER_GUIDE: User configuration. '."\n"
+ .'- SERVICE_GROUP_GUIDE: service group. '."\n"
+ .'- SERVICE_GUIDE: service. '."\n"
+ .'- MONITOR_GUIDE: Integration configuration. '."\n"
+ .'- ROUTE_RULE_GUIDE: stream routing rule. '."\n"
+ .'- NOTICE_GUIDE: Notifications subscription.', 'example' => 'SERVICE_GROUP_GUIDE', 'required' => false, 'title' => '', 'type' => 'string'],
],
+ 'required' => false,
+ 'title' => 'A short description of struct',
+ 'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'type' => 'object',
+ 'description' => 'Schema of Response',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'data' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ruleName' => [
- 'type' => 'string',
- ],
- 'id' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'tenantRamId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- ],
+ 'requestId' => ['description' => 'Id of the request', 'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9', 'title' => 'Id of the request', 'type' => 'string'],
],
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => null,
- ],
- 'ListServiceGroupsByUserId' => [
- 'summary' => '根据成员id查服务组',
- 'path' => '/services/group/listByUserId',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","type":"json"}]',
+ 'title' => 'Update the user guide status',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateUserGuideStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserGuideStatus'],
+ ],
],
+ ],
+ 'VerifyRouteRule' => [
+ 'summary' => 'Verifies a routing rule.',
+ 'path' => '/routeRule/verify',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREgemp1A354K',
+ 'abilityTreeNodes' => ['FEATUREgempLJVP1W'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The request body.',
+ 'properties' => [
+ 'routeRuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', 'title' => '', 'required' => false],
+ 'testSourceEvents' => [
+ 'description' => 'The content for the alert test.',
+ 'items' => [
+ 'description' => 'The content for the alert test.',
+ 'example' => '{}',
+ 'properties' => [
+ 'monitorSourceId' => ['description' => 'The ID of the monitoring source.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false],
+ 'monitorSourceName' => ['description' => 'The name of the monitoring source.', 'type' => 'string', 'example' => 'zabbix', 'title' => '', 'required' => false],
+ 'eventTime' => ['description' => 'The time when the alert occurred.', 'type' => 'string', 'example' => '2021-09-08 13:00:00', 'title' => '', 'required' => false],
+ 'eventJson' => ['description' => 'The format of the alert test content.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{}'],
+ ],
+ 'required' => false,
+ 'type' => 'object',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => 'A short description of struct',
+ 'type' => 'object',
+ 'example' => '',
+ ],
],
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'type' => 'object',
+ 'description' => 'The response structure.',
'properties' => [
- 'requestId' => [
- 'type' => 'string',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxxxx'],
'data' => [
- 'type' => 'object',
+ 'description' => 'The validation result.',
'properties' => [
- 'serviceGroupId' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ 'isValidRule' => ['description' => 'Indicates whether the validation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'routeType' => ['description' => 'The event or alert.', 'type' => 'string', 'example' => 'INCIDENT、ALERT', 'title' => ''],
+ 'notifySubscriptionNames' => [
+ 'description' => 'The name of the subscription.',
+ 'items' => [
+ 'description' => 'The notification subscription.',
+ 'example' => '我的订阅',
+ 'properties' => [
+ 'subscriptionId' => ['description' => 'The subscription ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '111111', 'title' => ''],
+ 'title' => ['description' => 'The subscription name.', 'type' => 'string', 'example' => '订阅名称', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
+ ],
+ 'escalationPlans' => [
+ 'description' => 'Upgrade policy name.',
+ 'items' => [
+ 'description' => 'The escalation plan.',
+ 'properties' => [
+ 'escalationPlanName' => ['description' => 'The name of the escalation plan.', 'type' => 'string', 'example' => '升级计划1', 'title' => ''],
+ 'escalationPlanId' => ['description' => 'The ID of the escalation plan.', 'type' => 'integer', 'format' => 'int64', 'example' => '111111', 'title' => ''],
+ ],
+ 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'isScheduled' => [
- 'type' => 'boolean',
+ 'routeRuleFailReason' => [
+ 'description' => 'The reason why the routing rule validation failed.',
+ 'items' => ['description' => 'The reason why the routing rule validation failed.', 'type' => 'string', 'example' => 'alertName不匹配', 'title' => ''],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
- 'serviceGroupName' => [
- 'type' => 'string',
+ 'monitorSourceIds' => [
+ 'description' => 'The IDs of the monitoring sources for which the validation failed.',
+ 'items' => ['description' => '1000', 'type' => 'integer', 'format' => 'int64', 'example' => '验证失败监控源ID', 'title' => ''],
+ 'title' => '',
+ 'type' => 'array',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'type' => 'object',
+ 'example' => '',
],
],
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxxxx\\",\\n \\"data\\": {\\n \\"isValidRule\\": true,\\n \\"routeType\\": \\"INCIDENT、ALERT\\",\\n \\"notifySubscriptionNames\\": [\\n {\\n \\"subscriptionId\\": 111111,\\n \\"title\\": \\"订阅名称\\"\\n }\\n ],\\n \\"escalationPlans\\": [\\n {\\n \\"escalationPlanName\\": \\"升级计划1\\",\\n \\"escalationPlanId\\": 111111\\n }\\n ],\\n \\"routeRuleFailReason\\": [\\n \\"alertName不匹配\\"\\n ],\\n \\"monitorSourceIds\\": [\\n 0\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Authenticate stream routing rule ',
+ 'requestParamsDescription' => '{'."\n"
+ .'"testSourceEvents": \\['."\n"
+ .'{'."\n"
+ .'"eventJson": "{\\n\\t\\\\"summary\\\\": \\\\"Cpu\\_util at 85.16% on machine 112.11.123.11\\\\",\\n\\t\\\\"priority\\\\": \\\\"P1\\\\",\\n\\t\\\\"name\\\\": \\\\"CPU Usage Exceeds Threshold Alert\\\\",\\n\\t\\\\"timestamp\\\\": \\\\"2021-07-17 T08:42:58.315+0000\\\\",\\n\\t\\\\"region\\\\": \\\\"shanghai\\\\",\\n\\t\\\\"source\\\\": \\\\"112.11.123.11\\\\",\\n\\t\\\\"application\\\\": \\\\"zheda/mozi\\\\",\\n\\t\\\\"group\\\\": \\\\"Online\\\\",\\n\\t\\\\"class\\\\": \\\\"Load\\\\",\\n\\t\\\\"details\\\\": {\\n\\t\\t\\\\"freeSpace\\\\": \\\\"1%\\\\",\\n\\t\\t\\\\"pingTime\\\\": \\\\"1500ms\\\\",\\n\\t\\t\\\\"loadAvg\\\\": \\\\"0.75\\\\"\\n\\t},\\n\\t\\\\"tags\\\\": \\\\"{}\\\\"\\n}",'."\n"
+ .'"eventTime": "2021-12-17 05:13:17",'."\n"
+ .'"monitorSourceId": 23463,'."\n"
+ .'"monitorSourceName": "Standard Integration"'."\n"
+ .'}'."\n"
+ .'],'."\n"
+ .'"routeRuleId": "160034020",'."\n"
+ .'"clientToken": "7e070585-ee11-450e-8827-db353faa3419"'."\n"
+ .'}',
+ 'responseParamsDescription' => '{'."\n"
+ .'"requestId": "gdgsdgsggsdg",'."\n"
+ .'"success": true,'."\n"
+ .'"errCode": 200,'."\n"
+ .'"errMessage": null,'."\n"
+ .'"data": {'."\n"
+ .'"routeRuleId": null,'."\n"
+ .'"isValidRule": false,'."\n"
+ .'"routeType": "INCIDENT",'."\n"
+ .'"routeRuleName": null,'."\n"
+ .'"assignToWhoName": null,'."\n"
+ .'"notifySubscriptions": \\['."\n"
+ .'{'."\n"
+ .'"subscriptionId": 80002030,'."\n"
+ .'"title": "\\[Test, Do Not Modify] All Services"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 100000010,'."\n"
+ .'"title": "safasefen"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 100000030,'."\n"
+ .'"title": "test2190830"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 100000040,'."\n"
+ .'"title": "test121"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 100000070,'."\n"
+ .'"title": "Yes"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 110000000,'."\n"
+ .'"title": "All Services - Personal - High Priority"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 110000010,'."\n"
+ .'"title": "111"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 110000030,'."\n"
+ .'"title": "Legacy Data Compatibility Test"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 110000090,'."\n"
+ .'"title": "Test Optimization Feature"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 120000000,'."\n"
+ .'"title": "Manager 1"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 120000030,'."\n"
+ .'"title": "Three-level Cascade -- All Services"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 120000070,'."\n"
+ .'"title": "341"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 130000000,'."\n"
+ .'"title": "All Services - Service Group"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 130000010,'."\n"
+ .'"title": "222"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 130000030,'."\n"
+ .'"title": "test0903"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 130000060,'."\n"
+ .'"title": "niidfads"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 130000070,'."\n"
+ .'"title": "e232"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 130000080,'."\n"
+ .'"title": "test0001"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 140000000,'."\n"
+ .'"title": "Boundary Value Test"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 140000010,'."\n"
+ .'"title": "Notification Subscription"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 140000020,'."\n"
+ .'"title": "\\[Do Not Modify Configuration!!!] \\[New] Notification Subscription - All"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 140000070,'."\n"
+ .'"title": "testyixia"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 150000000,'."\n"
+ .'"title": "24321"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 150000030,'."\n"
+ .'"title": "dscs"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 150000070,'."\n"
+ .'"title": "Steve v"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 150000090,'."\n"
+ .'"title": "121212"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 160000010,'."\n"
+ .'"title": "3333"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 160000030,'."\n"
+ .'"title": "wj Test Subscription"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 160000060,'."\n"
+ .'"title": "cdscds"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 160000070,'."\n"
+ .'"title": "testsd"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 170000000,'."\n"
+ .'"title": "Service -- Personal"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 170000010,'."\n"
+ .'"title": "4444444"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 170000020,'."\n"
+ .'"title": "Test 11"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 170000030,'."\n"
+ .'"title": "This is a test 0927"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 170000060,'."\n"
+ .'"title": "Jing Hua, the manipulator behind the notorious stock Rendong Holdings, recently received a 5 million fine from the CSRC. The penalty decision shows that this former prominent retail investor lost nearly 2.7 billion on Rendong Holdings and also reported to the CSRC"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 170000070,'."\n"
+ .'"title": "Eat"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 170000090,'."\n"
+ .'"title": "fafafa"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 180000000,'."\n"
+ .'"title": "aa1"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 180000010,'."\n"
+ .'"title": "3"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 180000030,'."\n"
+ .'"title": "sdds"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 180000040,'."\n"
+ .'"title": "4fy"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 180000050,'."\n"
+ .'"title": "cadscds"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 180000060,'."\n"
+ .'"title": "sdc"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 180000090,'."\n"
+ .'"title": "Speed"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 190000040,'."\n"
+ .'"title": "Custom Time Configuration Test"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 190000080,'."\n"
+ .'"title": "Legacy Data Compatibility"'."\n"
+ .'},'."\n"
+ .'{'."\n"
+ .'"subscriptionId": 190000090,'."\n"
+ .'"title": "DingTalk Test"'."\n"
+ .'}'."\n"
+ .'],'."\n"
+ .'"escalationPlans": \\[],'."\n"
+ .'"routeRuleFailReason": \\['."\n"
+ .'"No alert content matches this Zabbix rule"'."\n"
+ .'],'."\n"
+ .'"monitorSourceIds": \\['."\n"
+ .'23465'."\n"
+ .']'."\n"
+ .'}'."\n"
+ .'}',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'gemp:VerifyRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => null,
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyRouteRule'],
+ ],
+ ],
],
],
'endpoints' => [
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'gemp.cn-shanghai.aliyuncs.com', 'endpoint' => 'gemp.cn-shanghai.aliyuncs.com', 'vpc' => 'gemp-vpc.cn-shanghai.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AddRouteRuleFail', 'message' => 'Failed to add the rule.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AddServiceFail', 'message' => 'Failed to add the service.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'AddServiceGroupFail', 'message' => 'Failed to add the service group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ApprovedByOthers', 'message' => 'Approved by others', 'http_code' => 500, 'description' => ''],
+ ['code' => 'CreateIntegrationConfigFail', 'message' => 'Failed to create integration config.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'DateRangeOverflow', 'message' => 'DateRangeOverflow:30days', 'http_code' => 500, 'description' => ''],
+ ['code' => 'DeleteEnabledRuleFail', 'message' => 'Failed to delete the rule with the enabled status.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'DeleteRuleFail', 'message' => 'Failed to delete the rules.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'DeleteServiceFail', 'message' => 'Failed to delete the service.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'DeleteServiceGroupFail', 'message' => 'Failed to delete the service group.', 'http_code' => 400, 'description' => 'Failed to delete the service group.'],
+ ['code' => 'DeleteServiceGroupFail', 'message' => 'The service group has been associated with route rule.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'DeleteServiceGroupFail', 'message' => 'The service group has been associated with escalationPlan.', 'http_code' => 402, 'description' => ''],
+ ['code' => 'DeleteServiceGroupSchedulingFail', 'message' => 'The service group has been associated with route rule.', 'http_code' => 401, 'description' => ''],
+ ['code' => 'DeleteUserFail', 'message' => 'The user has been associated with escalationPlan.', 'http_code' => 401, 'description' => ''],
+ ['code' => 'DeleteUserFail', 'message' => 'The user has been associated with route rule.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'DeleteUserFail', 'message' => 'Users are scheduled.', 'http_code' => 402, 'description' => ''],
+ ['code' => 'DisableServiceGroupWebhookFail', 'message' => 'Failed to disable the service group webhook.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'DisableWebhookFailed', 'message' => 'Disabling webhook failed.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'DisableWebhookFailed', 'message' => 'Failed to disable webhook', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EditServiceFail', 'message' => 'Failed to edit the service.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EditServiceGroupFail', 'message' => 'Failed to edit the service group.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EffectionServiceAlreadyExisted', 'message' => 'EffectionService already exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EffectionServiceNotExisted', 'message' => 'EffectionService does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'EnableRouteRuleFail', 'message' => 'Failed to enable the rules.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EnableServiceGroupWebhookFail', 'message' => 'Failed to enable the service group webhook.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EscalationPlanAlreadyDisable', 'message' => 'The escalation plan is already disabled.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EscalationPlanAlreadyEnable', 'message' => 'The escalation plan is already enabled.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EscalationPlanAlreadyExisted', 'message' => 'The escalation plan already exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EscalationPlanNotExists', 'message' => 'The specified escalation plan does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'EscalationPlanRuleNull', 'message' => 'Escalation plan rule can not be null.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EscalationPlanServiceAleardyRelated', 'message' => 'The specified service is already related.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'EscalationPlanServiceNull', 'message' => 'Escalation plan service can not be nulll', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ExcelFileHeaderError', 'message' => 'Excel File Header Error', 'http_code' => 406, 'description' => ''],
+ ['code' => 'ExcelFileUrlError', 'message' => 'Excel File Url Error', 'http_code' => 405, 'description' => ''],
+ ['code' => 'IdentitySelectionError', 'message' => 'Identity selection error', 'http_code' => 402, 'description' => ''],
+ ['code' => 'IncidentNotExtisted', 'message' => 'The incident does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'IncidentStatusInvalid', 'message' => 'The incident status is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'IncidentUpdateInvalid', 'message' => 'The incident update is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'IncorrectInstanceStatus', 'message' => 'The current status of the resource does not support this operation.', 'http_code' => 403, 'description' => 'The current status of the resource does not support this operation.'],
+ ['code' => 'IntegationConfigAlreadyDisable', 'message' => 'The specified integration config is already disabled.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'IntegationConfigAlreadyEnable', 'message' => 'The specified integration config is already enabled.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'IntegationConfigAlreadyExists', 'message' => 'The specified integration config already exists.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'IntegationConfigAlreadyIntegrated', 'message' => 'The specified integration config is already integrated.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'IntegationConfigNotDisable', 'message' => 'The specified integration config is not disabled.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'IntegationConfigNotExists', 'message' => 'The specified integration config does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'IntegationConfigNotIntegrated', 'message' => 'The specified integration config is not integrated.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'IntegrationConfigExistsRouteRule', 'message' => 'integration config exists routeRule.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InternalError', 'message' => 'An internal server error occurred.', 'http_code' => 500, 'description' => 'Internal Server Error'],
+ ['code' => 'InvalidParameter', 'message' => 'The specified parameter is not valid. %s', 'http_code' => 400, 'description' => 'The specified parameter is not valid.'."\n"],
+ ['code' => 'MonitorSourceNotExists', 'message' => 'The specified monitor source does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'NoPermission', 'message' => 'The RAM user does not have permission.', 'http_code' => 403, 'description' => 'account have no permission'],
+ ['code' => 'NotifySubsAlreadyDisable', 'message' => 'The specified subscription is already disabled.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'NotifySubsAlreadyEnable', 'message' => 'The specified subscription is already enabled.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'NotifySubsAlreadyExists', 'message' => 'The specified subscription already exists.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'NotifySubsNotExists', 'message' => 'The specified subscription does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'openFailed', 'message' => 'open Failed', 'http_code' => 405, 'description' => ''],
+ ['code' => 'PhoneAlreadyExists', 'message' => 'The specified phone number already exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'PhoneAlreadyExists', 'message' => 'The specified user phone number already exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ProblemMeasureNotExisted', 'message' => 'The problem measure does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'ProblemNotExisted', 'message' => 'The problem does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'ProblemStatusError', 'message' => 'The problem status is abnormal.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ProblemTimelineNotExisted', 'message' => 'The problem timeline does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'RamUserNotActivated', 'message' => 'User not activated.', 'http_code' => 400, 'description' => 'User not activated'],
+ ['code' => 'ResourceEmpty', 'message' => 'The resource ID is empty.', 'http_code' => 403, 'description' => 'The resource ID is empty'],
+ ['code' => 'ResourceNotBelongToTenant', 'message' => 'The resource does not belong to the tenant.', 'http_code' => 403, 'description' => 'The resource does not belong to your tenant'],
+ ['code' => 'ResourceNotFound', 'message' => 'The specified Resource is not found.', 'http_code' => 404, 'description' => 'The specified Resource is not found.'],
+ ['code' => 'RouteRuleNameAlreadyExisted', 'message' => 'The rule name already exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'RouteRuleNotExisted', 'message' => 'The rule does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'RuleNameAlreadyExist', 'message' => 'The rule name already exists.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ServiceGroupNameAlreadyExisted', 'message' => 'The service group name is already in use.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ServiceGroupNotExisted', 'message' => 'The service group does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ServiceGroupWebHookLinkAlreadyExisted', 'message' => 'The webhook link is already in use.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ServiceNameAlreadyExisted', 'message' => 'The service name is already in use.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ServiceNotExisted', 'message' => 'The service does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'ServiceNotOpen', 'message' => 'The service is not activated.', 'http_code' => 403, 'description' => 'Service is not opened'],
+ ['code' => 'ServiceStoped', 'message' => 'The service is suspended. Please check whether the account has overdue payments.', 'http_code' => 400, 'description' => 'service is suspended, please check whether the account is in arrears'."\n"
+ ."\n"],
+ ['code' => 'ServiceStopped', 'message' => 'The service is suspended. Please check whether the account has overdue payments.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'StsTokenNoPermission', 'message' => 'STS token authentication failed.', 'http_code' => 403, 'description' => 'Sts token have not permission'],
+ ['code' => 'StsTokenNoWritePermission', 'message' => 'The STS token temporary account does not have write permission.', 'http_code' => 403, 'description' => 'Sts token have not write permission'],
+ ['code' => 'TenantIsNotExisted', 'message' => 'The specified tenant does not exist.', 'http_code' => 404, 'description' => 'The specified tenant does not exist.'],
+ ['code' => 'TimeFormatException', 'message' => 'The time format is invalid.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'TimelineFormatException', 'message' => 'The timeline format is invalid.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'UnbindUserFail', 'message' => 'The specified user does not exist.', 'http_code' => 401, 'description' => ''],
+ ['code' => 'UnbindUserFail', 'message' => 'Not find userId.', 'http_code' => 402, 'description' => ''],
+ ['code' => 'UnbindUserFail', 'message' => 'Mobile app not opened.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'UserAlreadyExists', 'message' => 'The specified user already exists.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'UserCountExcess', 'message' => 'Available users have run out, please upgrade to a higher version.', 'http_code' => 400, 'description' => 'Available users have run out, please upgrade to a higher version'],
+ ['code' => 'UserDoesNotExist', 'message' => 'user does not exist', 'http_code' => 401, 'description' => ''],
+ ['code' => 'UserNotAdded', 'message' => 'The user is not added to the system.', 'http_code' => 403, 'description' => 'The user did not added to system'],
+ ['code' => 'UserNotExists', 'message' => 'The specified user does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'UserTypeNotExisted', 'message' => 'The user type does not exist.', 'http_code' => 404, 'description' => 'User type is not existed'],
+ ['code' => 'WebhookAccessRestricts', 'message' => 'Traffic is restricted for webhook access.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'WebhookAddressFormatError', 'message' => 'The webhook address format is invalid.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'WebhookVerificationError', 'message' => 'A webhook verification error occurred.', 'http_code' => 403, 'description' => ''],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListDataReportForServiceGroup'],
+ ],
+ 'createdAt' => '2024-08-27T10:57:52.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateUser'],
+ ['description' => 'Response parameters changed', 'api' => 'GenerateProblemPictureUploadSign'],
+ ['description' => 'Response parameters changed', 'api' => 'GetUser'],
+ ['description' => 'Response parameters changed', 'api' => 'ListUsers'],
+ ],
+ 'createdAt' => '2024-08-15T11:47:03.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateEscalationPlan'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateService'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateUser'],
+ ['description' => 'Response parameters changed', 'api' => 'GetEscalationPlan'],
+ ['description' => 'Response parameters changed', 'api' => 'GetService'],
+ ['description' => 'Response parameters changed', 'api' => 'GetServiceGroup'],
+ ['description' => 'Response parameters changed', 'api' => 'GetUser'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListEscalationPlans'],
+ ['description' => 'Response parameters changed', 'api' => 'ListIncidentDetailEscalationPlans'],
+ ['description' => 'Response parameters changed', 'api' => 'ListIntegrationConfigs'],
+ ],
+ 'createdAt' => '2023-04-13T12:02:15.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'UpdateEscalationPlan'],
+ ],
+ 'createdAt' => '2023-03-24T08:25:16.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateEscalationPlan'],
+ ],
+ 'createdAt' => '2023-03-24T08:25:11.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateServiceGroupScheduling'],
+ ['description' => 'Response parameters changed', 'api' => 'GetServiceGroupScheduling'],
+ ['description' => 'Request parameters changed', 'api' => 'UpdateServiceGroupScheduling'],
+ ['description' => 'Request parameters changed', 'api' => 'UpdateServiceGroupSpecialDayScheduling'],
+ ],
+ 'createdAt' => '2022-12-26T13:01:51.000Z',
+ 'description' => '多人排班',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetProblem'],
+ ],
+ 'createdAt' => '2022-12-14T12:10:45.000Z',
+ 'description' => '故障触发源',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateRouteRule'],
+ ['description' => 'Response parameters changed', 'api' => 'GetRouteRule'],
+ ['description' => 'Request parameters changed', 'api' => 'UpdateRouteRule'],
+ ],
+ 'createdAt' => '2022-12-07T12:30:42.000Z',
+ 'description' => '故障等级定义',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateServiceGroup'],
+ ['description' => 'Response parameters changed', 'api' => 'ListIncidentDetailEscalationPlans'],
+ ['description' => 'Error codes changed', 'api' => 'UpdateServiceGroup'],
+ ],
+ 'createdAt' => '2022-10-27T12:01:45.000Z',
+ 'description' => '1',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetTenantApplication'],
+ ],
+ 'createdAt' => '2022-10-12T16:56:31.000Z',
+ 'description' => '成功',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListServiceGroups'],
+ ],
+ 'createdAt' => '2022-09-19T12:15:38.000Z',
+ 'description' => '1',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListIncidentDetailTimelines'],
+ ],
+ 'createdAt' => '2022-09-06T12:17:33.000Z',
+ 'description' => '1',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetIncident'],
+ ],
+ 'createdAt' => '2022-08-11T12:54:09.000Z',
+ 'description' => '11',
+ ],
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'gemp.cn-hangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListIncidents'],
+ ],
+ 'createdAt' => '2022-08-04T12:48:58.000Z',
+ 'description' => 'tt',
],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'gemp.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'BillingStatistics'],
+ ],
+ 'createdAt' => '2022-07-14T14:13:31.000Z',
+ 'description' => '22',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'BillingStatistics'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetTenantStatus'],
+ ],
+ 'createdAt' => '2022-07-14T13:13:19.000Z',
+ 'description' => 'q',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetProblemImprovement'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListAlerts'],
+ ['description' => 'Request parameters changed', 'api' => 'UpdateProblemImprovement'],
+ ],
+ 'createdAt' => '2022-06-14T12:28:41.000Z',
+ 'description' => '本次对报警列表进行了更新',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'ListByMonitorSourceId'],
+ ['description' => 'OpenAPI offline', 'api' => 'RemoveIntegrationConfig'],
+ ],
+ 'createdAt' => '2022-06-07T11:55:54.000Z',
+ 'description' => '移动应用集成支持解绑',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetEscalationPlan'],
+ ['description' => 'Response parameters changed', 'api' => 'GetRouteRule'],
+ ['description' => 'Response parameters changed', 'api' => 'ListAlerts'],
+ ['description' => 'Response parameters changed', 'api' => 'ListEscalationPlans'],
+ ['description' => 'Response parameters changed', 'api' => 'ListIncidentDetailTimelines'],
+ ['description' => 'Response parameters changed', 'api' => 'ListIncidents'],
+ ['description' => 'Response parameters changed', 'api' => 'ListIncidentTimelines'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListRouteRules'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListRouteRulesByService'],
+ ],
+ 'createdAt' => '2022-06-07T11:55:21.000Z',
+ 'description' => '本次变更内容为添加服务删除功能,及规则删除后的显示优化',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetSubscription'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListSubscriptions'],
+ ],
+ 'createdAt' => '2022-06-07T11:51:07.000Z',
+ 'description' => '新增Boolean参数,判断是否查询出已删除数据',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateRouteRule'],
+ ],
+ 'createdAt' => '2022-02-21T02:54:49.000Z',
+ 'description' => '创建流转规则api,字段类型变更',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateServiceGroup'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListChartDataForServiceGroup'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListChartDataForUser'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListDataReportForServiceGroup'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListDataReportForUser'],
+ ['description' => 'Request parameters changed', 'api' => 'ListIncidents'],
+ ['description' => 'Response parameters changed', 'api' => 'ListServiceGroups'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListSourceEventsForMonitorSource'],
+ ['description' => 'Request parameters changed', 'api' => 'UpdateServiceGroup'],
+ ],
+ 'createdAt' => '2021-11-18T05:34:59.000Z',
+ 'description' => '数据统计一期',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListAlerts'],
+ ['description' => 'Request parameters changed', 'api' => 'ListSourceEvents'],
+ ],
+ 'createdAt' => '2021-11-18T05:34:31.000Z',
+ 'description' => '查询告警增加时间范围筛选',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateSubscription'],
+ ['description' => 'OpenAPI offline', 'api' => 'DeleteServiceGroupUser'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetHomePageGuidance'],
+ ['description' => 'Response parameters changed', 'api' => 'GetProblem'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetServiceGroupPersonScheduling'],
+ ['description' => 'Response parameters changed', 'api' => 'GetSimilarIncidentStatistics'],
+ ['description' => 'Response parameters changed', 'api' => 'GetSubscription'],
+ ['description' => 'Response parameters changed', 'api' => 'GetUser'],
+ ['description' => 'Response parameters changed', 'api' => 'ListAlerts'],
+ ],
+ 'createdAt' => '2021-10-20T13:29:17.000Z',
+ 'description' => 'V1.4版本需求发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateIncident'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateRouteRule'],
+ ['description' => 'OpenAPI offline', 'api' => 'CreateServiceGroupScheduling'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateSubscription'],
+ ['description' => 'Response parameters changed', 'api' => 'GetServiceGroup'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetServiceGroupScheduling'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetServiceGroupSchedulingPreview'],
+ ['description' => 'OpenAPI offline', 'api' => 'GetServiceGroupSpecialPersonScheduling'],
+ ['description' => 'Response parameters changed', 'api' => 'GetSubscription'],
+ ['description' => 'OpenAPI offline', 'api' => 'ListIncidentDetailEscalationPlans'],
+ ],
+ 'createdAt' => '2021-09-10T01:54:44.000Z',
+ 'description' => 'V1.2 版本,功能包括排班管理、升级策略优化、通知订阅支持三级条件',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIncidentTimelines'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsers'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceGroupScheduling'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRouteRules'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSubscription'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProblemSubtotals'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEscalationPlanServices'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceStatistics'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRouteRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProblemTimeline'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableRouteRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTenantApplication'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateProblemPictureUploadSign'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeliverIncident'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEscalationPlan'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEscalationPlansByNoticeObject'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProblemEffectionService'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIncidents'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateService'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateService'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceGroupScheduling'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEvent'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProblemTimeLines'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckWebhook'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEscalationPlan'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEscalationPlans'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRouteRulesByService'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GeneratePictureLink'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIncident'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserGuideStatus'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEscalationPlan'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConfigs'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUser'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserSerivceGroups'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshIntegrationConfigKey'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIncidentSubtotal'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableIntegrationConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIntegrationConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRouteRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteServiceGroupUser'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProblem'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableRouteRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRouteRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUser'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProblemImprovement'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIncident'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetService'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FinishProblem'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSubscriptionServiceGroups'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProblemNotice'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceGroupMonitorSourceTemplates'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceGroupPersonScheduling'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationConfigTimelines'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRouteRulesByAssignWhoId'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIncidentListByIdList'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIncident'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSubscription'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHomePageGuidance'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntegrationConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProblemMeasure'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTenantStatus'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlerts'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProblemPreview'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRouteRule'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSubscription'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSubscription'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIncidentStatistics'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRichText'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProblemOperations'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceGroupSpecialPersonScheduling'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSourceEvents'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddProblemServiceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReplayProblem'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProblem'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProblem'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIncident'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServices'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProblemTimelines'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubscription'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSimilarIncidentStatistics'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProblemTimeline'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindUser'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelProblem'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRichText'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIntegrationConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIncidentDetailEscalationPlans'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProblemDetailOperations'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceGroupsByUserId'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIncidentSubtotals'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDictionaries'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConfirmIntegrationConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIncidentDetailTimelines'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableEscalationPlan'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableServiceGroupWebhook'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRichText'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSubscription'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateServiceGroupSpecialDayScheduling'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceGroupScheduling'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSubscriptions'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RespondIncident'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProblemMeasure'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteService'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserGuideStatus'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecoverProblem'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegrationConfigs'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUser'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProblemEffectionService'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteServiceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableServiceGroupWebhook'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveProblemServiceGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProblemEffectionService'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetServiceGroupSchedulingPreview'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BillingStatistics'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableEscalationPlan'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMonitorSources'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteServiceGroupScheduling'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEscalationPlan'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateProblemPictureLink'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProblems'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTenantApplication'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIntegrationConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveIntegrationConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIncidentSubtotalCount'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeProblemRecovery'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableIntegrationConfig'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProblemSubtotal'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProblem'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProblemImprovement'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GeneratePictureUploadSign'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProblemEffectionService'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProblemTimeline'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProblemMeasure'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListServiceGroups'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListByMonitorSourceId'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FinishIncident'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyRouteRule'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'GEMP',
+ 'productName' => 'Operations Incident Center',
+ 'ramCodes' => ['gemp'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'ListRouteRulesByAssignWhoId',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListRouteRulesByAssignWhoId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetServiceGroupPersonScheduling',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetServiceGroupPersonScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListIncidentDetailEscalationPlans',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIncidentDetailEscalationPlans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateIntegrationConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListProblemTimeLines',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListProblemTimeLines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnableRouteRule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:EnableRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetIntegrationConfig',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEscalationPlans',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListEscalationPlans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateServiceGroup',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListIntegrationConfigTimelines',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIntegrationConfigTimelines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteService',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataReportForServiceGroup',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListDataReportForServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateEscalationPlan',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateEscalationPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateProblem',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteProblemMeasure',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteProblemMeasure',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetUser',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateEscalationPlan',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateEscalationPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateProblemTimeline',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateProblemTimeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListIntegrationConfigs',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIntegrationConfigs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSubscription',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RefreshIntegrationConfigKey',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'gemp:RefreshIntegrationConfigKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListProblemDetailOperations',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListProblemDetailOperations',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListUserSerivceGroups',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListUserSerivceGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateProblemEffectionService',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateProblemEffectionService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteProblem',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteRouteRule',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateProblemEffectionService',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateProblemEffectionService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetServiceGroup',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListProblemOperations',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListProblemOperations',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListConfigs',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListConfigs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateProblemTimelines',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateProblemTimelines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListIncidents',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIncidents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListServices',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListServices',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetHomePageGuidance',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetHomePageGuidance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTenantStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetTenantStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetIncidentSubtotalCount',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetIncidentSubtotalCount',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListMonitorSources',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListMonitorSources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteServiceGroupScheduling',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteServiceGroupScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListProblemSubtotals',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListProblemSubtotals',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DisableRouteRule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:DisableRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateUser',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteEscalationPlan',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteEscalationPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetServiceGroupSpecialPersonScheduling',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetServiceGroupSpecialPersonScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateServiceGroupScheduling',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateServiceGroupScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteServiceGroupUser',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteServiceGroupUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateService',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetEscalationPlan',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetEscalationPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GeneratePictureLink',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GeneratePictureLink',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateProblem',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAlerts',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListAlerts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteServiceGroup',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateService',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateUserGuideStatus',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateUserGuideStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSourceEvents',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListSourceEvents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteUser',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListChartDataForUser',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListChartDataForUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListServiceGroupMonitorSourceTemplates',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListServiceGroupMonitorSourceTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'VerifyRouteRule',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'gemp:VerifyRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DisableSubscription',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:DisableSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RemoveProblemServiceGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:RemoveProblemServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListServiceGroupsByUserId',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListServiceGroupsByUserId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDictionaries',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListDictionaries',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelProblem',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:CancelProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListIncidentDetailTimelines',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIncidentDetailTimelines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DisableEscalationPlan',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:DisableEscalationPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRouteRule',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteProblemTimeline',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteProblemTimeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnableSubscription',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:EnableSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSubscriptions',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListSubscriptions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ConfirmIntegrationConfig',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'gemp:ConfirmIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRouteRules',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListRouteRules',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetResourceStatistics',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetResourceStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteIntegrationConfig',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnableServiceGroupWebhook',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:EnableServiceGroupWebhook',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRichText',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetRichText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RevokeProblemRecovery',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:RevokeProblemRecovery',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DisableServiceGroupWebhook',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:DisableServiceGroupWebhook',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateTenantApplication',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateTenantApplication',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateProblemMeasure',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateProblemMeasure',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListByMonitorSourceId',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListByMonitorSourceId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ReplayProblem',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:ReplayProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetProblemEffectionService',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetProblemEffectionService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RecoverProblem',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:RecoverProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListUsers',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateSubscription',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateProblemImprovement',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateProblemImprovement',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetEvent',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetEvent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateProblemMeasure',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateProblemMeasure',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnableEscalationPlan',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:EnableEscalationPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateIncident',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetProblem',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeliverIncident',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:DeliverIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateServiceGroup',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetServiceGroupScheduling',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetServiceGroupScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GenerateProblemPictureLink',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GenerateProblemPictureLink',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GenerateProblemPictureUploadSign',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GenerateProblemPictureUploadSign',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteIncident',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateRichText',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateRichText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTrendForSourceEvent',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListTrendForSourceEvent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetService',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetIncidentStatistics',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetIncidentStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetUserGuideStatus',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetUserGuideStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetIncidentListByIdList',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetIncidentListByIdList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateProblemTimeline',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateProblemTimeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSimilarIncidentStatistics',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetSimilarIncidentStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RemoveIntegrationConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:RemoveIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteProblemEffectionService',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteProblemEffectionService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateSubscription',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSubscriptionServiceGroups',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListSubscriptionServiceGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BillingStatistics',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'gemp:BillingStatistics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateProblemSubtotal',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateProblemSubtotal',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateRouteRule',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTenantApplication',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetTenantApplication',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FinishIncident',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:FinishIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GeneratePictureUploadSign',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'gemp:GeneratePictureUploadSign',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateServiceGroupScheduling',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateServiceGroupScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetIncident',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CheckWebhook',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'gemp:CheckWebhook',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DisableIntegrationConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:DisableIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateUser',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnableIntegrationConfig',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:EnableIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetServiceGroupSchedulingPreview',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetServiceGroupSchedulingPreview',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEscalationPlansByNoticeObject',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListEscalationPlansByNoticeObject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateServiceGroupSpecialDayScheduling',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateServiceGroupSpecialDayScheduling',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEscalationPlanServices',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListEscalationPlanServices',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateRouteRule',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateRouteRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateRichText',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateRichText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListIncidentTimelines',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIncidentTimelines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListServiceGroups',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListServiceGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteSubscription',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'gemp:DeleteSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetProblemPreview',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetProblemPreview',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRouteRulesByService',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListRouteRulesByService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataReportForUser',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListDataReportForUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FinishProblem',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:FinishProblem',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UnbindUser',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UnbindUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListProblems',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListProblems',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetProblemImprovement',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:GetProblemImprovement',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateIncidentSubtotal',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateIncidentSubtotal',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateProblemNotice',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:UpdateProblemNotice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateIntegrationConfig',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateIntegrationConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RespondIncident',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'gemp:RespondIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddProblemServiceGroup',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:AddProblemServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListChartDataForServiceGroup',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListChartDataForServiceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSourceEventsForMonitorSource',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListSourceEventsForMonitorSource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListIncidentSubtotals',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'gemp:ListIncidentSubtotals',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateIncident',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'gemp:CreateIncident',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'GEMP', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];