'1.0',
'info' => [
'style' => 'ROA',
'product' => 'GEMP',
'version' => '2021-04-13',
],
'directories' => [
[
'id' => 167154,
'title' => '集成配置',
'type' => 'directory',
'children' => [
'CreateIntegrationConfig',
'DisableIntegrationConfig',
'EnableIntegrationConfig',
'GetIntegrationConfig',
'ListIntegrationConfigs',
'ListIntegrationConfigTimelines',
'ConfirmIntegrationConfig',
'DeleteIntegrationConfig',
'UpdateIntegrationConfig',
'RefreshIntegrationConfigKey',
],
],
[
'id' => 167201,
'title' => '人员',
'type' => 'directory',
'children' => [
'GetUserGuideStatus',
'UpdateUserGuideStatus',
'CreateUser',
'DeleteUser',
'GetUser',
'ListUsers',
'UpdateUser',
'ListUserSerivceGroups',
],
],
[
'id' => 167134,
'title' => '服务组',
'type' => 'directory',
'children' => [
'ListServiceGroupMonitorSourceTemplates',
'ListDataReportForServiceGroup',
'CheckWebhook',
'EnableServiceGroupWebhook',
'CreateServiceGroup',
'DeleteServiceGroup',
'DeleteServiceGroupUser',
'GetServiceGroup',
'ListServiceGroups',
'UpdateServiceGroup',
'DisableServiceGroupWebhook',
],
],
[
'id' => 198423,
'title' => '排班',
'type' => 'directory',
'children' => [
'GetServiceGroupSpecialPersonScheduling',
'GetServiceGroupSchedulingPreview',
'GetServiceGroupPersonScheduling',
'CreateServiceGroupScheduling',
'GetServiceGroupScheduling',
'UpdateServiceGroupSpecialDayScheduling',
'UpdateServiceGroupScheduling',
],
],
[
'id' => 167129,
'title' => '服务',
'type' => 'directory',
'children' => [
'CreateService',
'DeleteService',
'GetService',
'ListServices',
'UpdateService',
],
],
[
'id' => 167145,
'title' => '流转规则',
'type' => 'directory',
'children' => [
'CreateRouteRule',
'DeleteRouteRule',
'DisableRouteRule',
'EnableRouteRule',
'GetRouteRule',
'ListRouteRules',
'UpdateRouteRule',
'VerifyRouteRule',
],
],
[
'id' => 167149,
'title' => '通知订阅',
'type' => 'directory',
'children' => [
'CreateSubscription',
'DeleteSubscription',
'EnableSubscription',
'UpdateSubscription',
'GetSubscription',
'DisableSubscription',
'ListSubscriptions',
],
],
[
'id' => 167189,
'title' => '事件',
'type' => 'directory',
'children' => [
'CreateIncidentSubtotal',
'ListIncidentSubtotals',
'GetIncidentListByIdList',
'DeleteIncident',
'CreateIncident',
'DeliverIncident',
'GetIncident',
'GetIncidentStatistics',
'FinishIncident',
'UpdateIncident',
'RespondIncident',
'ListIncidents',
'ListIncidentDetailTimelines',
'ListIncidentTimelines',
[
'id' => 198426,
'title' => '相似事件',
'type' => 'directory',
'children' => [
'GetIncidentSubtotalCount',
'GetSimilarIncidentStatistics',
],
],
],
],
[
'id' => 198425,
'title' => '报警',
'type' => 'directory',
'children' => [
'ListTrendForSourceEvent',
'ListSourceEventsForMonitorSource',
'ListSourceEvents',
'ListAlerts',
'GetEvent',
],
],
[
'id' => 167162,
'title' => '故障',
'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',
],
],
[
'id' => 198424,
'title' => '全局配置',
'type' => 'directory',
'children' => [
'GetResourceStatistics',
'ListConfigs',
'ListDictionaries',
'ListMonitorSources',
],
],
[
'id' => 198422,
'title' => '移动应用',
'type' => 'directory',
'children' => [
'CreateTenantApplication',
'GetTenantApplication',
],
],
[
'id' => 177155,
'title' => '业务监控',
'type' => 'directory',
'children' => [
'PushMonitor',
],
],
[
'id' => 167181,
'title' => '升级计划',
'type' => 'directory',
'children' => [
'ListEscalationPlanServices',
'CreateEscalationPlan',
'DeleteEscalationPlan',
'DisableEscalationPlan',
'EnableEscalationPlan',
'GetEscalationPlan',
'ListEscalationPlans',
'UpdateEscalationPlan',
],
],
[
'id' => 167147,
'title' => '富文本',
'type' => 'directory',
'children' => [
'CreateRichText',
'GetRichText',
'UpdateRichText',
],
],
[
'id' => 177100,
'title' => '其他',
'type' => 'directory',
'children' => [
'ListIncidentDetailEscalationPlans',
'GetHomePageGuidance',
'ListChartDataForServiceGroup',
'ListDataReportForUser',
'ListChartDataForUser',
'GeneratePictureLink',
'RemoveIntegrationConfig',
'ListByMonitorSourceId',
'ListRouteRulesByService',
'GetTenantStatus',
'BillingStatistics',
'DeleteServiceGroupScheduling',
'ListEscalationPlansByNoticeObject',
'UnbindUser',
'ListRouteRulesByAssignWhoId',
'ListServiceGroupsByUserId',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateIntegrationConfig' => [
'summary' => '创建集成配置。',
'path' => '/integrationConfig/create',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempBHVB81',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'monitorSourceId' => [
'description' => '监控源ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '23469',
],
'clientToken' => [
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'title' => '集成配置id',
'description' => '集成配置ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '101',
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'IntegationConfigAlreadyExists',
'errorMessage' => 'The specified integration config already exists.',
],
[
'errorCode' => 'CreateIntegrationConfigFail',
'errorMessage' => 'Failed to create integration config.',
],
],
[
[
'errorCode' => 'MonitorSourceNotExists',
'errorMessage' => 'The specified monitor source does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\",\\n \\"data\\": {\\n \\"integrationConfigId\\": 101\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 12345703\\n \\n E0FACD07-6BC4-4384-819D-B1523BD5EB85\\n","errorExample":""}]',
'title' => '创建集成配置',
],
'DisableIntegrationConfig' => [
'summary' => '禁用集成配置。',
'path' => '/integrationConfig/disable',
'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' => [
'FEATUREgempSLACC7',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'description' => '集成配置id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12345703',
],
'clientToken' => [
'title' => '幂等id',
'description' => '幂等标识',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => 'requestId',
'type' => 'string',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'IntegationConfigNotIntegrated',
'errorMessage' => 'The specified integration config is not integrated.',
],
[
'errorCode' => 'IntegationConfigAlreadyDisable',
'errorMessage' => 'The specified integration config is already disabled.',
],
],
[
[
'errorCode' => 'IntegationConfigNotExists',
'errorMessage' => 'The specified integration config does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9B77C7A5-DFBC-4CEF-A710-C802EA9EA8EE\\n","errorExample":""}]',
'title' => '禁用集成配置',
],
'EnableIntegrationConfig' => [
'summary' => '启用集成配置。',
'path' => '/integrationConfig/enable',
'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' => [
'FEATUREgempBHVB81',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'description' => '集成配置ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '197667760',
],
'clientToken' => [
'title' => '幂等id',
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'IntegationConfigNotIntegrated',
'errorMessage' => 'The specified integration config is not integrated.',
],
[
'errorCode' => 'IntegationConfigAlreadyEnable',
'errorMessage' => 'The specified integration config is already enabled.',
],
],
[
[
'errorCode' => 'IntegationConfigNotExists',
'errorMessage' => 'The specified integration config does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 953F7437-1A7E-41A5-BAD9-086E20E579F8\\n","errorExample":""}]',
'title' => '启用集成配置',
],
'GetIntegrationConfig' => [
'summary' => '集成配置详情 。',
'path' => '/integrationConfig/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' => [
'FEATUREgempBHVB81',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'title' => '集成配置id',
'description' => '集成配置ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '68',
],
'clientToken' => [
'title' => '幂等id',
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
'data' => [
'description' => '集成配置。',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'title' => '集成配置id、',
'description' => '集成配置ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '101',
],
'monitorSourceId' => [
'title' => '监控源id',
'description' => '监控源ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '65',
],
'monitorSourceName' => [
'title' => '监控源名称',
'description' => '监控源名称。',
'type' => 'string',
'example' => 'Zabbix',
],
'monitorSourceShortName' => [
'title' => '监控源简称',
'description' => '监控源简称。',
'type' => 'string',
'example' => 'Zabbix',
],
'accessKey' => [
'title' => '集成秘钥',
'description' => '集成密钥。',
'type' => 'string',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
'isReceivedEvent' => [
'title' => '是否接收报警',
'description' => '是否接收报警。',
'type' => 'boolean',
'example' => 'True',
],
'status' => [
'title' => '集成配置状态,DISABLE 禁用,INTEGRATED 已集成,UNINTEGRATED未集成',
'description' => '集成配置状态:'."\n"
.'- DISABLE 禁用。'."\n"
.'- INTEGRATED 已集成。'."\n"
.'- UNINTEGRATED未集成。',
'type' => 'string',
'example' => 'INTEGRATED',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'IntegationConfigNotExists',
'errorMessage' => 'The specified integration config does not exist.',
],
],
],
'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":"\\n 601FA6A2-AC5C-4B59-BE11-378F887A6A11\\n \\n 101\\n 65\\n Zabbix\\n Zabbix\\n 601FA6A2-AC5C-4B59-BE11-378F887A6A11\\n true\\n INTEGRATED\\n \\n","errorExample":""}]',
'title' => '集成配置详情',
],
'ListIntegrationConfigs' => [
'summary' => '集成配置列表。',
'path' => '/integrationConfig/list',
'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' => [
'FEATUREgempBHVB81',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'monitorSourceName' => [
'description' => '监控源名称',
'type' => 'string',
'required' => false,
'example' => 'Zabbix',
],
'clientToken' => [
'title' => '幂等id',
'description' => '幂等标识',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'type' => 'string',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
'data' => [
'description' => 'data',
'type' => 'array',
'items' => [
'description' => '集成配置',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'title' => '集成配置id',
'description' => '集成配置id',
'type' => 'integer',
'format' => 'int64',
'example' => '1023',
],
'monitorSourceId' => [
'title' => '监控源id',
'description' => '监控源id',
'type' => 'integer',
'format' => 'int64',
'example' => '87',
],
'monitorSourceName' => [
'title' => '监控源名城',
'description' => '监控源名城',
'type' => 'string',
'example' => 'Zabbix',
],
'monitorSourceShortName' => [
'title' => '监控源简称',
'description' => '监控源简称',
'type' => 'string',
'example' => 'Zabbix',
],
'isReceivedEvent' => [
'title' => '是否已接受报警',
'description' => '是否已接受报警',
'type' => 'boolean',
'example' => 'false',
],
'status' => [
'title' => '集成配置状态',
'description' => '集成配置状态',
'type' => 'string',
'example' => 'NOT_INTEGRATED',
],
'monitorSourceType' => [
'title' => '0:非自定义监控源 1:自定义监控源',
'description' => '0:非自定义监控源 1:自定义监控源',
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
],
],
],
'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":"\\n 601FA6A2-AC5C-4B59-BE11-378F887A6A11\\n \\n 1023\\n 87\\n Zabbix\\n Zabbix\\n false\\n NOT_INTEGRATED\\n \\n","errorExample":""}]',
'title' => '集成配置列表',
'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',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempBHVB81',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'title' => '集成配置id',
'description' => '集成配置ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '101',
],
'pageNumber' => [
'title' => '分页参数',
'description' => '分页参数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '分页参数',
'description' => '分页参数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
'clientToken' => [
'title' => '幂等参数',
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'data' => [
'description' => '响应数据。',
'type' => 'array',
'items' => [
'description' => '时间线节点。',
'type' => 'object',
'properties' => [
'title' => [
'title' => '主题',
'description' => '主题。',
'type' => 'string',
'example' => '时间线标题',
],
'description' => [
'title' => '描述',
'description' => '描述。',
'type' => 'string',
'example' => '描述xxxxx',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-04-05 10:10:10',
],
],
],
],
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
'totalCount' => [
'title' => 'totalCount',
'description' => '总记录数。',
'type' => 'integer',
'format' => 'int64',
'example' => '103',
],
'pageNumber' => [
'title' => 'pageNumber',
'description' => '页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'pageSize' => [
'title' => 'pageSize',
'description' => '页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'IntegationConfigNotExists',
'errorMessage' => 'The specified integration config does not exist.',
],
],
],
'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":"\\n \\n 时间线标题\\n 描述xxxxx\\n 2021-04-05 10:10:10\\n \\n 601FA6A2-AC5C-4B59-BE11-378F887A6A11\\n 103\\n 1\\n 10\\n","errorExample":""}]',
'title' => '集成配置操作日志',
],
'ConfirmIntegrationConfig' => [
'summary' => '确认集成配置。',
'path' => '/integrationConfig/confirm',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempRI7VNP',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'description' => '集成配置ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '101',
],
'clientToken' => [
'title' => '幂等id',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'IntegationConfigAlreadyIntegrated',
'errorMessage' => 'The specified integration config is already integrated.',
],
],
[
[
'errorCode' => 'IntegationConfigNotExists',
'errorMessage' => 'The specified integration config does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ADAB577F-5192-4301-B7C8-BE7B0FDB255E\\n","errorExample":""}]',
'title' => '确认集成配置',
],
'DeleteIntegrationConfig' => [
'summary' => '删除集成配置。',
'path' => '/integrationConfig/delete',
'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' => [
'FEATUREgempSLACC7',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'title' => '集成配置id',
'description' => '集成配置ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '100',
],
'clientToken' => [
'title' => '幂等id',
'description' => '幂等ID。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'IntegationConfigNotExists',
'errorMessage' => 'The specified integration config does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"601FA6A2-AC5C-4B59-BE11-378F887A6A11\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 601FA6A2-AC5C-4B59-BE11-378F887A6A11\\n","errorExample":""}]',
'title' => '删除集成配置',
],
'UpdateIntegrationConfig' => [
'summary' => '集成配置更新。',
'path' => '/integrationConfig/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' => [
'FEATUREgempBHVB81',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'description' => '集成配置ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '103',
],
'accessKey' => [
'title' => '集成秘钥',
'description' => '密钥。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
'clientToken' => [
'title' => '幂等id',
'description' => '幂等ID。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378F987A6A98',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'IntegationConfigNotDisable',
'errorMessage' => 'The specified integration config is not disabled.',
],
],
[
[
'errorCode' => 'IntegationConfigNotExists',
'errorMessage' => 'The specified integration config does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CE900955-A6DD-4923-9F53-6283B9D0D32A\\n","errorExample":""}]',
'title' => '集成配置更新',
],
'RefreshIntegrationConfigKey' => [
'summary' => '刷新集成key。',
'path' => '/integrationConfig/refreshKey',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempBHVB81',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'description' => '集成配置ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '102',
],
'clientToken' => [
'title' => '幂等id',
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
'data' => [
'description' => '集成配置。',
'type' => 'object',
'properties' => [
'key' => [
'title' => '集成秘钥',
'description' => '集成密钥。',
'type' => 'string',
'example' => '859FA6A2-AC5C-4B09-BE23-986F887H6A232',
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'IntegationConfigNotDisable',
'errorMessage' => 'The specified integration config is not disabled.',
],
],
[
[
'errorCode' => 'IntegationConfigNotExists',
'errorMessage' => 'The specified integration config does not exist.',
],
],
],
'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":"\\n 601FA6A2-AC5C-4B59-BE11-378F887A6A11\\n \\n 859FA6A2-AC5C-4B09-BE23-986F887H6A232\\n \\n","errorExample":""}]',
'title' => '刷新集成key',
],
'GetUserGuideStatus' => [
'summary' => '获取用户引导状态。',
'path' => '/user/guide/status',
'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' => [
'FEATUREgempVWXIZC',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等校验',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'data' => [
'title' => 'map',
'description' => '状态信息。',
'type' => 'object',
'example' => '{ "data": { "monitorGuide": false, "userRamId": 1344371, "serviceGuide": false, "noticeGuide": false, "userGuide": true, "serviceGroupGuide": false, "routeRuleGuide": false, "incidentGuide": true }',
],
],
],
],
],
'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":"\\n \\n false\\n 1344371\\n false\\n false\\n true\\n false\\n false\\n true\\n \\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n","errorExample":""}]',
'title' => '获取用户引导状态',
],
'UpdateUserGuideStatus' => [
'summary' => '更新用户引导状态。',
'path' => '/user/update/guide/status',
'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' => [
'FEATUREgempVWXIZC',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求body。',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等校验',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'guideAction' => [
'title' => 'INCIDENT_GUIDE 事件线 INCIDENT_GUIDE配置人员 USER_GUIDE 服务组 SERVICE_GROUP_GUIDE 服务 SERVICE_GUIDE 集成配置 MONITOR_GUIDE 流转规则 ROUTE_RULE_GUIDE 通知订阅 NOTICE_GUIDE',
'description' => '- INCIDENT_GUIDE:事件线。'."\n"
.'- USER_GUIDE :配置人员。'."\n"
.'- SERVICE_GROUP_GUIDE :服务组。'."\n"
.'- SERVICE_GUIDE :服务。'."\n"
.'- MONITOR_GUIDE :集成配置。'."\n"
.'- ROUTE_RULE_GUIDE :流转规则。'."\n"
.'- NOTICE_GUIDE:通知订阅。',
'type' => 'string',
'required' => false,
'example' => 'SERVICE_GROUP_GUIDE',
],
],
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n","errorExample":""}]',
'title' => '更新用户引导状态',
],
'CreateUser' => [
'summary' => '创建人员。',
'path' => '/user/create',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempT8ZOYV',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'ramId' => [
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '4787654378343',
],
'phone' => [
'description' => '手机号。',
'type' => 'string',
'required' => false,
'example' => '1888898****',
],
'username' => [
'description' => '用户名称。',
'type' => 'string',
'required' => false,
'example' => '张先生',
],
'email' => [
'description' => '邮箱。',
'type' => 'string',
'required' => false,
'example' => '12121****@qq.com',
],
'clientToken' => [
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
'roleIdList' => [
'title' => '角色ID列表',
'description' => '角色ID列表。',
'type' => 'array',
'items' => [
'description' => '用户角色。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'userId' => [
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
],
],
'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',
],
],
[
[
'errorCode' => 'UserAlreadyExists',
'errorMessage' => 'The specified user already exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\",\\n \\"data\\": {\\n \\"userId\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n c26f36de-1ec8-496a-a828-880676c5ef81\\n \\n 1\\n \\n","errorExample":""}]',
'title' => '创建人员',
],
'DeleteUser' => [
'summary' => '删除用户。',
'path' => '/user/delete',
'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',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DeleteUserFail ',
'errorMessage' => 'The user has been associated with route rule.',
],
],
[
[
'errorCode' => 'DeleteUserFail ',
'errorMessage' => 'The user has been associated with escalationPlan.',
],
],
[
[
'errorCode' => 'DeleteUserFail ',
'errorMessage' => 'Users are scheduled.',
],
],
404 => [
[
'errorCode' => 'UserNotExists',
'errorMessage' => 'The specified user does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"\\n c26f36de-1ec8-496a-a828-880676c5ef81\\n","errorExample":""}]',
'title' => '删除用户',
],
'GetUser' => [
'summary' => '查看用户详情。',
'path' => '/user/getUser',
'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' => [
'FEATUREgempT8ZOYV',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '63',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
'data' => [
'title' => '用户',
'description' => '用户。',
'type' => 'object',
'properties' => [
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '63',
],
'ramId' => [
'title' => 'ramId',
'description' => 'RAM用户ID。',
'type' => 'string',
'example' => '1344383',
],
'isEditableUser' => [
'title' => '是否可编辑',
'description' => '是否当前用户。',
'type' => 'boolean',
'example' => 'true',
],
'accountType' => [
'title' => 'CUSTOMER:主账号,SUB:子账号',
'description' => 'RAM账号类型:'."\n"
."\n"
.'- 0:主账号。'."\n"
.'- 1:子账号。',
'type' => 'string',
'example' => '1',
],
'email' => [
'title' => 'email',
'description' => '邮箱。',
'type' => 'string',
'example' => '5678***@qq.com',
],
'username' => [
'title' => '用户昵称',
'description' => '用户昵称。',
'type' => 'string',
'example' => '马先生',
],
'phone' => [
'title' => '用户手机号',
'description' => '手机号码。',
'type' => 'string',
'example' => '1390000****',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-09-09 09:09:09',
],
'isRelated' => [
'title' => '是否关联',
'description' => '是否关联。',
'type' => 'string',
'example' => 'RELATE',
],
'serviceGroups' => [
'title' => '所属服务组',
'description' => '所属服务组。',
'type' => 'array',
'items' => [
'description' => '所属服务组。',
'type' => 'object',
'properties' => [
'name' => [
'title' => '服务组名称',
'description' => '服务组名称。',
'type' => 'string',
'example' => '研发组',
],
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10000',
],
],
],
],
'roleIdList' => [
'title' => '角色ID列表',
'description' => '角色ID列表。',
'type' => 'array',
'items' => [
'description' => '角色ID列表。',
'type' => 'integer',
'format' => 'int64',
],
],
'roleNameList' => [
'title' => '角色名称列表',
'description' => '角色名称列表。',
'type' => 'array',
'items' => [
'description' => '角色名称列表。',
'type' => 'string',
],
],
'isActive' => [
'title' => '账号是否激活 1已激活 0未激活',
'description' => '账号是否激活:'."\n"
."\n"
.'- 1:已激活。'."\n"
.'- 0:未激活。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'UserNotExists',
'errorMessage' => 'The specified user does not exist.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'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":"\\n c26f36de-1ec8-496a-a828-880676c5ef81\\n \\n 63\\n 1344383\\n true\\n SUB\\n 5678***@qq.com\\n 张珊\\n 1390000****\\n \\n","errorExample":""}]',
'title' => '查看用户详情',
],
'ListUsers' => [
'summary' => '用户列表。',
'path' => '/user/list',
'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' => [
'FEATUREgempT8ZOYV',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'username' => [
'title' => '人员名称',
'description' => '人员名称。',
'type' => 'string',
'required' => false,
'example' => '张先生',
],
'phone' => [
'title' => '人员手机号',
'description' => '人员手机号。',
'type' => 'string',
'required' => false,
'example' => '1887879****',
],
'ramId' => [
'title' => 'ramID',
'description' => 'RAM账号ID。',
'type' => 'string',
'required' => false,
'example' => '1344383',
],
'scene' => [
'title' => 'USER_LIST列表 ALL_USERS下拉',
'description' => '- 下拉场景:ALL_USERS。'."\n"
.'- 用户列表场景:USER_LIST。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => 'USER_LIST',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
'pageNumber' => [
'title' => '分页参数',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '分页参数',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
'synergyChannel' => [
'title' => '移动应用协同渠道',
'description' => '移动应用渠道。',
'type' => 'string',
'required' => false,
'example' => 'DINGDING',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
'data' => [
'title' => 'data',
'description' => '返回结果。',
'type' => 'array',
'items' => [
'description' => '人员。',
'type' => 'object',
'properties' => [
'userId' => [
'title' => '用户id',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1234',
],
'ramId' => [
'title' => '子账号ramId',
'description' => 'RAM子账号ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '53624523',
],
'username' => [
'title' => '用户名',
'description' => '用户名。',
'type' => 'string',
'example' => '张先生',
],
'phone' => [
'title' => '手机',
'description' => '手机号码。',
'type' => 'string',
'example' => '1887879****',
],
'email' => [
'title' => '邮箱',
'description' => '邮箱。',
'type' => 'string',
'example' => '2345****@qq.com',
],
'isEditableUser' => [
'title' => '是否可编辑',
'description' => '是否可编辑。',
'type' => 'integer',
'format' => 'int64',
'example' => 'true',
],
'accountType' => [
'title' => '账户类型',
'description' => 'RAM账号类型:'."\n"
."\n"
.'- 0:主账号。'."\n"
.'- 1:子账号。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'appAccount' => [
'title' => '移动应用账户',
'description' => '移动应用账户。',
'type' => 'string',
'example' => '23456tre',
],
'synergyChannel' => [
'title' => '移动应用协同渠道',
'description' => '移动应用协同渠道。',
'type' => 'string',
'example' => 'DINGDING',
],
'isRelated' => [
'title' => '是否关联',
'description' => '是否关联:'."\n"
."\n"
.'- RELATED:关联。'."\n"
.'- NOT_RELATED:未关联。',
'type' => 'string',
'example' => 'RELATED',
],
'isOperation' => [
'title' => '是否可操作(删除,取消关联) 1可操作 0不可操作',
'description' => '是否可操作(删除,取消关联):'."\n"
."\n"
.'- 1:可操作。'."\n"
.'- 0:不可操作。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'isRam' => [
'title' => '是否是主账号 1是 0不是',
'description' => '是否是主账号:'."\n"
."\n"
.'- 1:是。 '."\n"
.'- 0:不是。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'roleIdList' => [
'title' => '角色ID列表',
'description' => '角色ID列表。',
'type' => 'array',
'items' => [
'description' => '角色ID列表。',
'type' => 'integer',
'format' => 'int64',
],
],
'roleNameList' => [
'title' => '角色名称列表',
'description' => '角色名称列表。',
'type' => 'array',
'items' => [
'description' => '角色名称列表。',
'type' => 'string',
],
],
'isActive' => [
'title' => '账号是否激活 1已激活 0未激活',
'description' => '账号是否激活:'."\n"
."\n"
.'- 1:已激活。'."\n"
.'- 0:未激活。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'gmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
],
'gmtActive' => [
'type' => 'string',
],
],
],
],
'totalCount' => [
'title' => '总条数',
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'pageNumber' => [
'title' => '分页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'pageSize' => [
'title' => '分页',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
'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":"\\n c26f36de-1ec8-496a-a828-880676c5ef81\\n \\n 1234\\n 53624523\\n 张珊\\n 1390000****\\n 2345****@qq.com\\n 23456tre\\n DINGDING\\n RELATED关联 NOT_RELATED 未关联\\n \\n 100\\n 1\\n 10\\n","errorExample":""}]',
'title' => '用户列表',
],
'UpdateUser' => [
'summary' => '人员信息更新。',
'path' => '/user/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' => [
'FEATUREgempT8ZOYV',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'ramId' => [
'title' => '用户ramId',
'description' => 'RAM用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2243564',
],
'phone' => [
'title' => '手机号',
'description' => '手机号。',
'type' => 'string',
'required' => false,
'example' => '18887878****',
],
'username' => [
'title' => '用户名',
'description' => '用户名。',
'type' => 'string',
'required' => false,
'example' => '张珊',
],
'email' => [
'title' => '邮件',
'description' => '邮箱。',
'type' => 'string',
'required' => false,
'example' => '78799****@qq.com',
],
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '111',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
'roleIdList' => [
'title' => '用户角色',
'description' => '用户角色',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'PhoneAlreadyExists',
'errorMessage' => 'The specified phone number already exists.',
],
],
404 => [
[
'errorCode' => 'UserNotExists',
'errorMessage' => 'The specified user does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"\\n c26f36de-1ec8-496a-a828-880676c5ef81\\n","errorExample":""}]',
'title' => '人员信息更新',
],
'ListUserSerivceGroups' => [
'summary' => '用户预览 。',
'path' => '/user/preview/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' => [
'FEATUREgempCICFVA',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '123',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等ID。',
'type' => 'string',
'required' => false,
'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef729f',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef7291',
],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'ramId' => [
'title' => 'RAM子账号ID',
'description' => 'RAM子账号ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '321',
],
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '321',
],
'username' => [
'title' => '用户昵称',
'description' => '用户昵称。',
'type' => 'string',
'example' => '马先生',
],
'phone' => [
'title' => '手机号',
'description' => '手机号。',
'type' => 'string',
'example' => '1390000****',
],
'email' => [
'title' => '邮箱',
'description' => '邮箱。',
'type' => 'string',
'example' => '12121****@163.com',
],
'serviceGroups' => [
'title' => '人员所属服务组',
'description' => '人员所属服务组。',
'type' => 'array',
'items' => [
'description' => '服务组。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组id',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
'serviceGroupName' => [
'title' => '服务组名称',
'description' => '服务组名称。',
'type' => 'string',
'example' => '测试组',
],
'serviceGroupDescription' => [
'title' => '服务组描述',
'description' => '服务组描述。',
'type' => 'string',
'example' => '这是一个服务组描述',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'UserTypeNotExisted',
'errorMessage' => 'The user type does not exist.',
],
],
],
'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":"\\n 2b63cdef-7ac3-4892-a76d-0f3389ef7291\\n \\n 321\\n 321\\n 小明\\n 1390000****\\n 12121****@163.com\\n \\n 123\\n 服务组A\\n 描述\\n \\n \\n","errorExample":""}]',
'title' => '用户预览',
],
'ListServiceGroupMonitorSourceTemplates' => [
'summary' => '查询服务组消息模板列表。',
'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' => [
'FEATUREgempE3KJ0U',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'xxxx',
],
'requestId' => [
'title' => '请求ID',
'description' => '请求ID。',
'type' => 'string',
'required' => false,
'example' => 'xxxxx',
],
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1000',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'xxxx',
],
'data' => [
'title' => 'data',
'description' => '模板列表。',
'type' => 'array',
'items' => [
'description' => '模板列表。',
'type' => 'object',
'properties' => [
'monitorSourceId' => [
'title' => '监控源ID',
'description' => '监控源ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'templateId' => [
'title' => '消息模版ID',
'description' => '消息模板ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'monitorSourceName' => [
'title' => '监控报警源名字',
'description' => '监控报警源名字。',
'type' => 'string',
'example' => 'zabbix',
],
'templateContent' => [
'title' => '模板内容',
'description' => '模板内容。',
'type' => 'string',
'example' => '""',
],
'fields' => [
'title' => '字段',
'description' => '字段。',
'type' => 'array',
'items' => [
'description' => '字段。',
'type' => 'string',
'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":"\\n \\n 1000\\n 1000\\n zabbix\\n \\n","errorExample":""}]',
'title' => '查询服务组消息模板列表',
'requestParamsDescription' => '{"serviceGroupId":"180030020"}',
'responseParamsDescription' => '{'."\n"
.' '."\n"
.' "requestId": "gdgsdgsggsdg",'."\n"
.' "data": ['."\n"
.' {'."\n"
.' "templateId": 3645786,'."\n"
.' "monitorSourceId": 23463,'."\n"
.' "monitorSourceName": "标准集成",'."\n"
.' "templateContent": "暂无",'."\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": "告警时间:${startsAt}\\\\n告警对象:${labels.instance}\\\\n告警名称:${labels.alertname}\\\\n告警内容:${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": "告警内容:${content}",'."\n"
.' "fields": ['."\n"
.' "notifyActionType",'."\n"
.' "hostName",'."\n"
.' "hostState",'."\n"
.' "content"'."\n"
.' ]'."\n"
.' },'."\n"
.' {'."\n"
.' "templateId": 3645785,'."\n"
.' "monitorSourceId": 23468,'."\n"
.' "monitorSourceName": "阿里云云监控",'."\n"
.' "templateContent": "告警结束时间:${timestamp}\\\\n告警对象:${dimensions}\\\\n告警名称:${alertName}\\\\n告警级别:${triggerLevel}\\\\n告警内容:当前值 ${curValue} 地域:${regionId} 应用组名:${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}\\\\n告警对象:${project}\\\\n告警名称:${alert_name}\\\\n告警级别:${severity}\\\\n告警内容:日志库:${logstore} 触发数据:${fire_results_as_kv} 地域:${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": "告警内容:${content}",'."\n"
.' "fields": ['."\n"
.' "content"'."\n"
.' ]'."\n"
.' },'."\n"
.' {'."\n"
.' "templateId": null,'."\n"
.' "monitorSourceId": 23472,'."\n"
.' "monitorSourceName": "腾讯云云监控",'."\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": "华为云云监控",'."\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": "告警内容:${subject}",'."\n"
.' "fields": ['."\n"
.' "subject"'."\n"
.' ]'."\n"
.' },'."\n"
.' {'."\n"
.' "templateId": 3645796,'."\n"
.' "monitorSourceId": 23475,'."\n"
.' "monitorSourceName": "SkyWalking",'."\n"
.' "templateContent": "告警内容:${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": "告警名称:${ruleName}\\\\n告警内容:面板id:${panelId} 仪表盘id:${dashboardId} 指标:${evalMatches.metric} 当前值:${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": "阿里云Prometheus",'."\n"
.' "templateContent": "告警内容:${content}",'."\n"
.' "fields": ['."\n"
.' "content"'."\n"
.' ]'."\n"
.' },'."\n"
.' {'."\n"
.' "templateId": 3645789,'."\n"
.' "monitorSourceId": 23480,'."\n"
.' "monitorSourceName": "阿里云旧版SLS",'."\n"
.' "templateContent": "告警时间:${FireTime}\\\\n告警对象:${Project}\\\\n告警名称:${AlertDisplayName}\\\\n告警内容:仪表盘:${Dashboard} 触发表达式:${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": "听云",'."\n"
.' "templateContent": "告警时间:${beginTime}\\\\n告警对象:${targetName}\\\\n告警级别:${eventPriority}\\\\n告警内容:${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": "监控宝",'."\n"
.' "templateContent": "告警时间:${fault_time}\\\\n告警对象:${task_summary}\\\\n告警名称:${task_name}\\\\n告警级别:${message_type}\\\\n告警内容:${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": "京东云云监控",'."\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": "Grafana8",'."\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": "邮件集成",'."\n"
.' "templateContent": null,'."\n"
.' "fields": ['."\n"
.' "FromAddress",'."\n"
.' "SendTo",'."\n"
.' "Subject",'."\n"
.' "MessageBody"'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.'}',
'extraInfo' => '"data":{'."\n"
.' "requestId":"550DB2BE-98DE-0368-A52C-8F6BC78CD113"'."\n"
.' }',
],
'ListDataReportForServiceGroup' => [
'summary' => '分页查询服务组统计数据 。',
'path' => '/statistics/listDataReportForServiceGroup',
'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' => [
'FEATUREgemp20VVML',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'startTime' => [
'title' => '开始时间',
'description' => '开始时间。',
'type' => 'string',
'required' => false,
'example' => '2021-09-09',
],
'endTime' => [
'title' => '结束时间',
'description' => '结束时间。',
'type' => 'string',
'required' => false,
'example' => '2024-10-22',
],
'pageNumber' => [
'title' => '页码',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '分页大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
'serviceGroupName' => [
'title' => '服务组名称',
'description' => '服务组名称。',
'type' => 'string',
'required' => false,
'example' => 'A服务组',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '8D0F6435-162E-5088-84A1-4178C0F209CD',
],
'data' => [
'title' => '统计数据',
'description' => '统计数据。',
'type' => 'array',
'items' => [
'description' => '统计数据。',
'type' => 'object',
'properties' => [
'serviceGroupName' => [
'title' => '服务组名字',
'description' => '服务组名称。',
'type' => 'string',
'example' => '标准集成服务组',
],
'incidentCount' => [
'title' => '事件数量',
'description' => '事件数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'escalationIncidentCount' => [
'title' => '升级事件数量',
'description' => '升级事件数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'unAcknowledgedEscalationIncidentCount' => [
'title' => '未响应升级事件数量',
'description' => '未响应升级事件数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'unFinishEscalationIncidentCount' => [
'title' => '未完成升级事件数量',
'description' => '未完成升级事件数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '103419260',
],
'meanTimeToAcknowledge' => [
'title' => 'MRRA',
'description' => '当日平均响应时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '3分19秒',
],
'meanTimeToRepair' => [
'title' => 'MTTR',
'description' => '当日平均完结时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '3分19秒',
],
'finishProportion' => [
'title' => '完结率',
'description' => '完结率。',
'type' => 'string',
'example' => '0%',
],
'finishIncidentCount' => [
'title' => '事件完结数',
'description' => '事件完结数。',
'type' => 'integer',
'format' => 'int64',
'example' => '111',
],
],
],
],
'pageSIze' => [
'title' => '页大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'pageNumber' => [
'title' => '当前页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'totalCount' => [
'title' => '总数',
'description' => '总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
'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":"\\n xxxxxxx\\n \\n 服务组\\n 1\\n 100\\n 200\\n 200\\n 100\\n 19%\\n \\n","errorExample":""}]',
'title' => '查询服务组事件统计报表',
'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": "gdgsdgsggsdg",'."\n"
.' "data": ['."\n"
.' {'."\n"
.' "meanTimeToAcknowledge": "66天37分钟50秒",'."\n"
.' "meanTimeToRepair": "20小时20分钟48秒",'."\n"
.' "finishProportion": "17.65%",'."\n"
.' "serviceGroupName": "吃饭群(钉钉群)",'."\n"
.' "incidentCount": 34,'."\n"
.' "finishIncidentCount": 6,'."\n"
.' "escalationIncidentCount": 21,'."\n"
.' "unAcknowledgedEscalationIncidentCount": 20,'."\n"
.' "unFinishEscalationIncidentCount": 21,'."\n"
.' "serviceGroupId": 32'."\n"
.' },'."\n"
.' {'."\n"
.' "meanTimeToAcknowledge": "66天37分钟50秒",'."\n"
.' "meanTimeToRepair": "20小时20分钟48秒",'."\n"
.' "finishProportion": "25.00%",'."\n"
.' "serviceGroupName": "国庆企业",'."\n"
.' "incidentCount": 24,'."\n"
.' "finishIncidentCount": 6,'."\n"
.' "escalationIncidentCount": 11,'."\n"
.' "unAcknowledgedEscalationIncidentCount": 10,'."\n"
.' "unFinishEscalationIncidentCount": 11,'."\n"
.' "serviceGroupId": 180020080'."\n"
.' },'."\n"
.' {'."\n"
.' "meanTimeToAcknowledge": "66天37分钟50秒",'."\n"
.' "meanTimeToRepair": "20小时20分钟48秒",'."\n"
.' "finishProportion": "25.00%",'."\n"
.' "serviceGroupName": "【日常】胡江平的测试服务组",'."\n"
.' "incidentCount": 24,'."\n"
.' "finishIncidentCount": 6,'."\n"
.' "escalationIncidentCount": 11,'."\n"
.' "unAcknowledgedEscalationIncidentCount": 10,'."\n"
.' "unFinishEscalationIncidentCount": 11,'."\n"
.' "serviceGroupId": 170020030'."\n"
.' },'."\n"
.' {'."\n"
.' "meanTimeToAcknowledge": "66天37分钟50秒",'."\n"
.' "meanTimeToRepair": "20小时20分钟48秒",'."\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天37分钟50秒",'."\n"
.' "meanTimeToRepair": "11天33分钟35秒",'."\n"
.' "finishProportion": "9.09%",'."\n"
.' "serviceGroupName": "飞书群",'."\n"
.' "incidentCount": 11,'."\n"
.' "finishIncidentCount": 1,'."\n"
.' "escalationIncidentCount": 10,'."\n"
.' "unAcknowledgedEscalationIncidentCount": 10,'."\n"
.' "unFinishEscalationIncidentCount": 10,'."\n"
.' "serviceGroupId": 130000010'."\n"
.' },'."\n"
.' {'."\n"
.' "meanTimeToAcknowledge": "66天37分钟50秒",'."\n"
.' "meanTimeToRepair": "11天33分钟35秒",'."\n"
.' "finishProportion": "9.09%",'."\n"
.' "serviceGroupName": "精细排班",'."\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": "新增服务组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": "卡片服务组测试【勿动】",'."\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": "这是一个服务组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"
.'}',
],
'CheckWebhook' => [
'summary' => '校验webhook地址有效性。',
'path' => '/services/check/webhook',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempU4CBQS',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'webhook' => [
'title' => 'webook地址',
'description' => 'webook地址。',
'type' => 'string',
'required' => false,
'example' => 'https://oapi.dingtalk.com/robot/send?access_token=XXX',
],
'webhookType' => [
'title' => 'webhook地址类型 企业微信WEIXIN_GROUP 钉钉群 DING_GROUP 飞书 FEISHU_GROUP',
'description' => 'webhook地址类型:'."\n"
.'- 企业微信:WEIXIN_GROUP。'."\n"
.'- 钉钉群:DING_GROUP。'."\n"
.'- 飞书群:FEISHU_GROUP。',
'type' => 'string',
'required' => false,
'example' => 'DING_GROUP',
],
],
'required' => false,
'example' => 'body',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
],
],
],
'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.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n","errorExample":""}]',
'title' => '校验webhook',
],
'EnableServiceGroupWebhook' => [
'summary' => '启用服务组的webhook。',
'path' => '/services/group/enableWebhook',
'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' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求body。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'EnableServiceGroupWebhookFail',
'errorMessage' => 'Failed to enable the service group webhook.',
],
[
'errorCode' => 'ServiceGroupNotExisted',
'errorMessage' => 'The service group does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n","errorExample":""}]',
'title' => '启用服务组的webhook',
],
'CreateServiceGroup' => [
'summary' => '创建服务组。',
'path' => '/services/group/insert',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceGroupName' => [
'title' => '服务小组名称',
'description' => '服务组名称。',
'type' => 'string',
'required' => true,
'example' => '我的服务组',
],
'userIds' => [
'title' => '小组人员用户ID',
'description' => '用户ID。',
'type' => 'array',
'items' => [
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '65',
],
'required' => true,
],
'enableWebhook' => [
'title' => 'ENABLE 启用 DISABLE 禁用',
'description' => '是否开启webhook:'."\n"
.'- DISABLE:关闭。'."\n"
.'- ENABLE:开启。',
'type' => 'string',
'required' => true,
'example' => 'ENABLE',
],
'webhookType' => [
'title' => 'WEIXIN_GROUP微信 DING_GROUP钉钉 FEISHU_GROUP飞书',
'description' => 'webhookType:'."\n"
."\n"
.'- WEIXIN_GROUP:微信。'."\n"
.'- DING_GROUP:钉钉。'."\n"
.'- FEISHU_GROUP:飞书。',
'type' => 'string',
'required' => true,
'example' => 'DING_GROUP',
],
'serviceGroupDescription' => [
'title' => '服务描述',
'description' => '服务描述。',
'type' => 'string',
'required' => false,
'example' => '这个是一个服务描述',
],
'webhookLink' => [
'title' => 'webhookLink',
'description' => 'webhook地址。',
'type' => 'string',
'required' => true,
'example' => 'https://oapi.ding****.com/robot/send?access_token=****',
],
'monitorSourceTemplates' => [
'title' => '监控源消息模版',
'description' => '监控源消息模版。',
'type' => 'array',
'items' => [
'description' => '监控源消息模版。',
'type' => 'object',
'properties' => [
'templateId' => [
'title' => '消息模版ID',
'description' => '消息模版ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '111',
],
'monitorSourceId' => [
'title' => '监控源ID',
'description' => '监控源ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '111',
],
'monitorSourceName' => [
'title' => '监控源名字',
'description' => '监控源名称。',
'type' => 'string',
'required' => false,
'example' => 'zabbix',
],
'templateContent' => [
'title' => '模板内容',
'description' => '模版内容。',
'type' => 'string',
'required' => false,
'example' => 'xx',
],
],
'required' => false,
],
'required' => false,
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
],
'example' => '1',
],
],
],
],
],
'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.',
],
],
405 => [
[
'errorCode' => 'openFailed',
'errorMessage' => 'open Failed',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": {\\n \\"serviceGroupId\\": 1000\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n \\n 1000\\n \\n","errorExample":""}]',
'title' => '创建服务组',
],
'DeleteServiceGroup' => [
'summary' => '删除服务组。',
'path' => '/services/group/delete',
'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' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求body。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1000',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DeleteServiceGroupFail',
'errorMessage' => 'Failed to delete the service group.',
],
[
'errorCode' => 'ServiceGroupNotExisted',
'errorMessage' => 'The service group does not exist.',
],
],
[
[
'errorCode' => 'ServiceGroupNotExisted',
'errorMessage' => 'The service group does not exist.',
],
],
[
[
'errorCode' => 'DeleteServiceGroupFail',
'errorMessage' => 'The service group has been associated with escalationPlan.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n","errorExample":""}]',
'title' => '删除服务组',
],
'DeleteServiceGroupUser' => [
'summary' => '删除服务组人员。',
'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',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '66666',
],
'oldUserId' => [
'title' => '老的用户ID',
'description' => '老的用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '777777',
],
'newUserId' => [
'title' => '新的用户',
'description' => '新的用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '88888',
],
'removeUser' => [
'title' => '删除服务组成员',
'description' => '删除服务组成员。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'xxxxxx',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'xxxxxx',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"\\n xxxxxx\\n","errorExample":""}]',
'title' => '删除服务组人员',
],
'GetServiceGroup' => [
'summary' => '查看服务组详情。',
'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' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求body。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2323232',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => '请求ID',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'updateTime' => [
'title' => '修改时间',
'description' => '修改时间。',
'type' => 'string',
'example' => '2020-05-03 15:39:39',
],
'users' => [
'title' => '用户ID',
'description' => '用户ID数组。',
'type' => 'array',
'items' => [
'description' => '用户ID。',
'type' => 'object',
'properties' => [
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'userName' => [
'title' => '用户名字',
'description' => '用户名称。',
'type' => 'string',
'example' => 'jack',
],
'phone' => [
'title' => '手机号',
'description' => '手机号。',
'type' => 'string',
'example' => '1390000****',
],
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'roleNameList' => [
'title' => '角色列表',
'description' => '角色列表。',
'type' => 'array',
'items' => [
'title' => '角色名称',
'description' => '角色名称。',
'type' => 'string',
'example' => '测试',
],
],
],
],
],
'serviceGroupDescription' => [
'title' => '服务组描述',
'description' => '服务组描述。',
'type' => 'string',
'example' => '服务描述',
],
'webhookLink' => [
'title' => 'webhook 跳转地址',
'description' => 'webhook地址。',
'type' => 'string',
'example' => 'wwwwwww',
],
'webhookType' => [
'title' => 'WEIXIN_GROUP 微信 DING_GROUP 钉钉 FEISHU_GROUP飞书',
'description' => 'webhook类型:'."\n"
."\n"
.'- WEIXIN_GROUP:企微群。'."\n"
.'- DING_GROUP:钉钉群。',
'type' => 'string',
'example' => 'WEIXIN_GROUP',
],
'enableWebhook' => [
'title' => 'ENABLE 启用 DISABLE 禁用',
'description' => '- ENABLE:启用。'."\n"
.'- DISABLE:禁用。',
'type' => 'string',
'example' => 'ENABLE',
],
'serviceGroupName' => [
'title' => '服务组名称',
'description' => '服务组名称。',
'type' => 'string',
'example' => '冲上云霄',
],
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-08-08 10:00:00',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ServiceGroupNotExisted',
'errorMessage' => 'The service group does not exist.',
],
],
],
'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":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n \\n 2020-05-03 15:39:39\\n \\n 10\\n jack\\n 1390000****\\n 1\\n \\n 服务描述\\n wwwwwww\\n WEIXIN_GROUP\\n ENABLE\\n 冲上云霄\\n 1000\\n 2020-08-08 10:00:00\\n \\n","errorExample":""}]',
'title' => '查看服务组详情',
],
'ListServiceGroups' => [
'summary' => '查询服务组列表。',
'path' => '/services/group/list',
'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' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'queryName' => [
'title' => '搜索名称',
'description' => '搜索名称。',
'type' => 'string',
'required' => false,
'example' => '王先生',
],
'queryType' => [
'title' => '搜索类型。USER用户 SERVICEGROUP服务组',
'description' => '搜索类型:'."\n"
.'- USER:用户。'."\n"
.'- SERVICEGROUP:服务组。',
'type' => 'string',
'required' => false,
'example' => 'USER',
],
'pageNumber' => [
'title' => '当前页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '页大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'isScheduled' => [
'title' => '是否已经排班',
'description' => '是否排过班。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'orderByScheduleStatus' => [
'title' => '是否根据排班状态排序',
'description' => '订单状态排序。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '100000',
],
'serviceId' => [
'title' => '服务的查询',
'description' => '服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '33',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'sssss',
],
'data' => [
'title' => '服务组列表',
'description' => '服务组列表。',
'type' => 'array',
'items' => [
'description' => '服务组列表。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'isScheduled' => [
'title' => '是否已经排班',
'description' => '是否已经排班。',
'type' => 'boolean',
'example' => 'true',
],
'serviceGroupName' => [
'title' => '服务组名字',
'description' => '服务组名字。',
'type' => 'string',
'example' => '我的服务组',
],
'serviceGroupDescription' => [
'title' => '服务组描述',
'description' => '服务组描述。',
'type' => 'string',
'example' => '服务组描述',
],
'updateTime' => [
'title' => '修改时间',
'description' => '修改时间。',
'type' => 'string',
'example' => '2020-08-09 15:50:30',
],
'enableWebhook' => [
'title' => 'ENABLE 启用 DISABLE 禁用',
'description' => '- ENABLE:启用。'."\n"
.'- DISABLE:禁用。',
'type' => 'string',
'example' => 'ENABLE',
],
'webhookType' => [
'title' => 'WEIXIN_GROUP微信DING_GROUP钉钉FEISHU_GROUP飞书',
'description' => '- WEIXIN_GROUP:微信群。'."\n"
.'- DING_GROUP:钉钉群。',
'type' => 'string',
'example' => 'WEIXIN_GROUP',
],
'webhookLink' => [
'title' => 'webhook 跳转地址',
'description' => 'webhook地址。',
'type' => 'string',
'example' => 'wwwwwwwwww',
],
'users' => [
'title' => '服务组用户列表',
'description' => '服务组用户列表。',
'type' => 'array',
'items' => [
'description' => '用户。',
'type' => 'object',
'properties' => [
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'userName' => [
'title' => '用户名字',
'description' => '用户名称。',
'type' => 'string',
'example' => 'jack',
],
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'phone' => [
'title' => '手机号',
'description' => '手机号。',
'type' => 'string',
'example' => '1390000****',
],
'email' => [
'title' => '邮箱',
'description' => '邮箱。',
'type' => 'string',
'example' => 'wy930***@163.com',
],
'isRelated' => [
'description' => '用户是否关联了移动APP:'."\n"
.'- 1:是。'."\n"
.'- 0:否。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
],
],
'pageNumber' => [
'title' => '当前页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'pageSize' => [
'title' => '分页大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'totalCount' => [
'title' => '总条数',
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
'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":"\\n sssss\\n \\n 1\\n true\\n 我的服务组\\n 服务组描述\\n 2020-08-09 15:50:30\\n ENABLE\\n WEIXIN_GROUP\\n wwwwwwwwww\\n \\n 10\\n jack\\n 1\\n 1390000****\\n wy930***@163.com\\n \\n \\n 1\\n 10\\n 100\\n","errorExample":""}]',
'title' => '查询服务组列表',
],
'UpdateServiceGroup' => [
'summary' => '服务组编辑。',
'path' => '/services/group/modify',
'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' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'enableWebhook' => [
'title' => 'ENABLE 启用 DISABLE 禁用',
'description' => '是否开启webhook:'."\n"
.'- DISABLE:关闭。'."\n"
.'- ENABLE:开启。',
'type' => 'string',
'required' => true,
'example' => 'ENABLE',
],
'webhookType' => [
'title' => 'WEIXIN_GROUP微信DING_GROUP钉钉FEISHU_GROUP飞书',
'description' => '- WEIXIN_GROUP:微信群。'."\n"
.'- DING_GROUP:钉群。',
'type' => 'string',
'required' => true,
'example' => 'WEIXIN_GROUP',
],
'webhookLink' => [
'title' => 'webhook跳转地址',
'description' => 'webhook地址。',
'type' => 'string',
'required' => true,
'example' => 'wwwwwww',
],
'serviceGroupName' => [
'title' => '服务组名字',
'description' => '服务组名字。',
'type' => 'string',
'required' => true,
'example' => '我的服务组',
],
'serviceGroupDescription' => [
'title' => '服务描述',
'description' => '服务组描述。',
'type' => 'string',
'required' => false,
'example' => '服务组描述',
],
'userIds' => [
'title' => '用户ID列表修改后的',
'description' => '用户ID数组。',
'type' => 'array',
'items' => [
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '55',
],
'required' => true,
],
'monitorSourceTemplates' => [
'title' => '监控源模版列表',
'description' => '消息模版列表。',
'type' => 'array',
'items' => [
'description' => '消息模版列表。',
'type' => 'object',
'properties' => [
'templateId' => [
'title' => '消息模版ID',
'description' => '消息模版ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1111',
],
'monitorSourceId' => [
'title' => '监控报警源Id',
'description' => '监控源ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '11111',
],
'monitorSourceName' => [
'title' => '监控报警源',
'description' => '监控源名字。',
'type' => 'string',
'required' => false,
'example' => 'zabbix',
],
'templateContent' => [
'title' => '消息模版内容',
'description' => '模版内容。',
'type' => 'string',
'required' => false,
'example' => '内容',
],
],
'required' => false,
],
'required' => false,
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
],
],
],
'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.',
],
],
405 => [
[
'errorCode' => 'openFailed',
'errorMessage' => 'open Failed',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n","errorExample":""}]',
'title' => '服务组编辑',
],
'DisableServiceGroupWebhook' => [
'summary' => '禁用服务组的webhook。',
'path' => '/services/group/disableWebhook',
'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' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DisableWebhookFailed',
'errorMessage' => 'Disabling webhook failed.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n","errorExample":""}]',
'title' => '禁用服务组的webhook',
],
'GetServiceGroupSpecialPersonScheduling' => [
'summary' => '查询指定人员的服务组排班。',
'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' => [
'FEATUREgempUBXKF7',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '66666',
],
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '77777',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'xxxxxx',
],
'data' => [
'title' => '人员排班信息',
'description' => '人员排班信息。',
'type' => 'array',
'items' => [
'description' => '排班信息。',
'type' => 'object',
'properties' => [
'schedulingStartTime' => [
'title' => '排班开始时间',
'description' => '排班开始时间。',
'type' => 'string',
'example' => '2021-08-17 00:00:00',
],
'schedulingEndTime' => [
'title' => '排班结束时间',
'description' => '排班结束时间。',
'type' => 'string',
'example' => '2021-08-17 12:00:00',
],
'schedulingDate' => [
'title' => '排班日期',
'description' => '排班日期。',
'type' => 'string',
'example' => '2021-08-17',
],
'serviceGroupId' => [
'title' => '服务组id',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '8888',
],
'serviceGroupName' => [
'title' => '服务组名字',
'description' => '服务组名称。',
'type' => 'string',
'example' => '雪豹突击队',
],
'schedulingUserId' => [
'title' => '排班用户ID',
'description' => '排班用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '111111',
],
],
],
],
],
],
],
],
'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":"\\n xxxxxx\\n \\n 2021-08-17 00:00:00\\n 2021-08-17 12:00:00\\n 2021-08-17\\n 8888\\n 雪豹突击队\\n 111111\\n \\n","errorExample":""}]',
'title' => '查询指定人员的服务组排班',
'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",
'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": "雪豹突击队",'."\n"
.' "schedulingUserId": 111111'."\n"
.' }'."\n"
.' ]'."\n"
.'}',
],
'GetServiceGroupSchedulingPreview' => [
'summary' => '预览服务组排班。',
'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' => [
'FEATUREgempUBXKF7',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '55555',
],
'schedulingWay' => [
'title' => '排班方式 FAST 快速排班 FINE 精细排班',
'description' => '排班方式:'."\n"
.'- FAST:快速排班。'."\n"
.'- FINE:精细排班。',
'type' => 'string',
'required' => true,
'example' => 'FAST',
],
'fastScheduling' => [
'title' => '快速排班',
'description' => '快速排班。',
'type' => 'object',
'properties' => [
'singleDuration' => [
'title' => '每人排班时长',
'description' => '每人排班时长。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '12',
],
'dutyPlan' => [
'title' => '值班方案 dutyPlan FAST_CHOICE 快速选择 CUSTOM 自定义',
'description' => '值班方案:'."\n"
.'- FAST_CHOICE:快速选择。'."\n"
.'- CUSTOM:自定义。',
'type' => 'string',
'required' => false,
'example' => 'FAST_CHOICE',
],
'singleDurationUnit' => [
'title' => '每人排班时长单位 HOUR 小时 DAY 天',
'description' => '排班时长单位:'."\n"
.'- HOUR:小时。'."\n"
.'- DAY:天。',
'type' => 'string',
'required' => false,
'example' => 'DAY',
],
'schedulingUsers' => [
'title' => '快速轮班用户',
'description' => '快速轮班用户。',
'type' => 'array',
'items' => [
'description' => '快速轮班用户。',
'type' => 'object',
'properties' => [
'schedulingUserId' => [
'title' => '轮班用户ID',
'description' => '轮班用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '122222',
],
'schedulingOrder' => [
'title' => '排班顺序',
'description' => '排班顺序。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'fineScheduling' => [
'title' => '精细排',
'description' => '精细排班。',
'type' => 'object',
'properties' => [
'period' => [
'title' => '循环周期',
'description' => '循环周期。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
'periodUnit' => [
'title' => '循环周期单位 HOUR 小时 DAY 天',
'description' => '循环周期单位:'."\n"
.'- HOUR:小时。'."\n"
.'- DAY:天。',
'type' => 'string',
'required' => false,
'example' => 'DAY',
],
'shiftType' => [
'title' => '班次类型 MORNING_NIGHT 早晚班 MORNING_NOON_NIGHT 早中晚班 CUSTOM 自定义',
'description' => '班次类型:'."\n"
.'- MORNING_NIGHT:早晚班。 '."\n"
.'- MORNING_NOON_NIGHT:早中晚班。 '."\n"
.'- CUSTOM:自定义。',
'type' => 'string',
'required' => false,
'example' => 'MORNING_NIGHT',
],
'schedulingFineShifts' => [
'title' => '精细排班班次人员信息',
'description' => '精细排班班次人员信息。',
'type' => 'array',
'items' => [
'description' => '精细排班班次人员信息。',
'type' => 'object',
'properties' => [
'schedulingStartTime' => [
'title' => '排班开始时间',
'description' => '排班开始时间。',
'type' => 'string',
'required' => false,
'example' => '2020-08-13',
],
'schedulingEndTime' => [
'title' => '排班结束时间',
'description' => '排班结束时间。',
'type' => 'string',
'required' => false,
'example' => '2020-10-13',
],
'schedulingOrder' => [
'title' => '排班顺序',
'description' => '排班顺序。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'shiftName' => [
'title' => '班次名称',
'description' => '班次名称。',
'type' => 'string',
'required' => false,
'example' => '早班',
],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'endTime' => [
'title' => '排班结束时间',
'description' => '预览值班开始时间。',
'type' => 'string',
'required' => false,
'example' => '2021-09-01 00:00:00',
],
'startTime' => [
'title' => '排班开始时间',
'description' => '预览值班结束时间。',
'type' => 'string',
'required' => false,
'example' => '2021-11-01 00:00:00',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '85C203BF-D1A6-562C-AAEC-5EAB9D2756CF',
],
'data' => [
'title' => '服务组排班信息',
'description' => '服务组日期。',
'type' => 'object',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter is not valid. %s',
],
],
],
'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":"\\n xxxxxxxxx\\n","errorExample":""}]',
'title' => '预览服务组排班',
],
'GetServiceGroupPersonScheduling' => [
'summary' => '查询某用户服务组排班。',
'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' => [
'FEATUREgempCICFVA',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '66666',
],
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '77777',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'startTime' => [
'title' => '排班开始时间',
'description' => '排班开始时间。',
'type' => 'string',
'required' => false,
'example' => '2020-09-01 00:00:00',
],
'endTime' => [
'title' => '排班结束时间',
'description' => '排班结束时间。',
'type' => 'string',
'required' => false,
'example' => '2020-09-31 00:00:00',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'xxxxx',
],
'data' => [
'title' => '排班日历',
'description' => '排班日历。',
'type' => 'object',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxx\\",\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n xxxxx\\n","errorExample":""}]',
'title' => '查询某用户服务组排班',
],
'CreateServiceGroupScheduling' => [
'summary' => '新增服务组排班。',
'path' => '/services/group/scheduling/save',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempUBXKF7',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1000',
],
'schedulingWay' => [
'title' => '排班方式 FAST 快速排班 FINE 精细排班',
'description' => '排班方式:'."\n"
."\n"
.'- FAST:快速排班。'."\n"
.'- FINE:精细排班。',
'type' => 'string',
'required' => true,
'example' => 'FAST',
],
'fastScheduling' => [
'title' => '快速排班',
'description' => '快速排班。',
'type' => 'object',
'properties' => [
'singleDuration' => [
'title' => '每人排班时长',
'description' => '每人排班时长。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '12',
],
'dutyPlan' => [
'title' => '值班方案 dutyPlan FAST_CHOICE 快速选择 CUSTOM 自定义',
'description' => '值班方案:'."\n"
."\n"
.'- FAST_CHOICE:快速选择。'."\n"
.'- CUSTOM:自定义。',
'type' => 'string',
'required' => false,
'example' => 'FAST_CHOICE',
],
'singleDurationUnit' => [
'title' => '每人排班时常单位 HOUR 小时 DAY 天',
'description' => '排班时长单位:'."\n"
."\n"
.'- HOUR:小时。'."\n"
.'- DAY:天。',
'type' => 'string',
'required' => false,
'example' => 'DAY',
],
'schedulingUsers' => [
'title' => '快速轮班用户',
'description' => '快速轮班用户。',
'type' => 'array',
'items' => [
'description' => '快速轮班用户。',
'type' => 'object',
'properties' => [
'schedulingUserId' => [
'title' => '轮班用户ID',
'description' => '轮班用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '6666',
],
'schedulingOrder' => [
'title' => '排班顺序',
'description' => '排班顺序。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'description' => '排班类型:'."\n"
."\n"
.'- 0:单人排班。'."\n"
.'- 1:多人排班。',
'type' => 'string',
'required' => false,
'example' => '1',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'description' => '多人排班时,人员ID。',
'type' => 'array',
'items' => [
'description' => '人员ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
'example' => '12',
],
'fineScheduling' => [
'title' => '精细排班',
'description' => '精细排班。',
'type' => 'object',
'properties' => [
'period' => [
'title' => '循环周期',
'description' => '循环周期。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'periodUnit' => [
'title' => '循环周期单位 HOUR 小时 DAY 天',
'description' => '循环周期单位:'."\n"
."\n"
.'- HOUR:小时。'."\n"
.'- DAY:天 。',
'type' => 'string',
'required' => false,
'example' => 'DAY',
],
'shiftType' => [
'title' => '班次类型 MORNING_NIGHT 早晚班 MORNING_NOON_NIGHT 早中晚班 CUSTOM 自定义',
'description' => '班次类型:'."\n"
."\n"
.'- MORNING_NIGHT:早晚班。 '."\n"
.'- MORNING_NOON_NIGHT:早中晚班。 '."\n"
.'- CUSTOM:自定义。',
'type' => 'string',
'required' => false,
'example' => 'MORNING_NIGHT',
],
'schedulingFineShifts' => [
'title' => '精细排班信息表',
'description' => '精细排班班次人员信息。',
'type' => 'array',
'items' => [
'description' => '班次信息。',
'type' => 'object',
'properties' => [
'schedulingStartTime' => [
'title' => '排班开始时间',
'description' => '排班开始时间。',
'type' => 'string',
'required' => false,
'example' => '2020-08-13',
],
'schedulingEndTime' => [
'title' => '排班结束时间',
'description' => '排班结束时间。',
'type' => 'string',
'required' => false,
'example' => '2020-10-13',
],
'schedulingOrder' => [
'title' => '排班顺序',
'description' => '排班顺序。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'skipOneDay' => [
'title' => '是否跨天',
'description' => '是否跨天:'."\n"
."\n"
.'- true:是。'."\n"
.'- false:否。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'cycleOrder' => [
'title' => '循环次序',
'description' => '循环次序。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'shiftName' => [
'title' => '班次名称',
'description' => '班次名称。',
'type' => 'string',
'required' => false,
'example' => '早班',
],
'schedulingUserId' => [
'title' => '排班用户ID',
'description' => '排班用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '11',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'description' => '排班对象类型。',
'type' => 'string',
'required' => false,
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'description' => '多人排班时,人员ID。',
'type' => 'array',
'items' => [
'description' => '多人排班时,人员ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
'schedulingTemplateFineShifts' => [
'title' => '精细排班模版',
'description' => '精细排班模版。',
'type' => 'array',
'items' => [
'description' => '精细排班模版。',
'type' => 'object',
'properties' => [
'schedulingStartTime' => [
'title' => '排班开始时间',
'description' => '排班开始时间。',
'type' => 'string',
'required' => false,
'example' => '2021-09-01 08:00:00',
],
'schedulingEndTime' => [
'title' => '排班结束时间',
'description' => '排班结束时间。',
'type' => 'string',
'required' => false,
'example' => '2021-10-01 08:00:00',
],
'schedulingOrder' => [
'title' => '排班顺序',
'description' => '排班顺序。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'schedulingUserId' => [
'title' => '用户ID',
'description' => '排班用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'schedulingUserName' => [
'title' => '用户名字',
'description' => '排班用户名字。',
'type' => 'string',
'required' => false,
'example' => '刘先生',
],
'skipOneDay' => [
'title' => '是否跨天',
'description' => '是否跨天。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'description' => '排班对象类型。',
'type' => 'string',
'required' => false,
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'description' => '多人排班时,人员ID。',
'type' => 'array',
'items' => [
'description' => '多人排班时,人员ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'xxxxxxxxxx',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"\\n xxxxxxxxxx\\n","errorExample":""}]',
'title' => '新增服务组排班',
],
'GetServiceGroupScheduling' => [
'summary' => '查询服务组排班详情。',
'path' => '/services/group/scheduling/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' => [
'FEATUREgempCICFVA',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '9999',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'xxxxxxxxxxxx',
],
'data' => [
'title' => '排班详情',
'description' => '排班详情。',
'type' => 'object',
'properties' => [
'schedulingWay' => [
'title' => '排班方式 FAST 快速排班 FINE 精细排班',
'description' => '排班方式:'."\n"
.'- FAST:快速排班。'."\n"
.'- FINE:精细排班。',
'type' => 'string',
'example' => 'FINE',
],
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '99999',
],
'fastScheduling' => [
'title' => '快速排班',
'description' => '快速排班。',
'type' => 'object',
'properties' => [
'singleDuration' => [
'title' => '每人排班时长',
'description' => '每人排班时长。',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'dutyPlan' => [
'title' => '值班方案 dutyPlan FAST_CHOICE 快速选择 CUSTOM 自定义',
'description' => '值班方案:'."\n"
.'- FAST_CHOICE:快速选择。'."\n"
.'- CUSTOM:自定义。',
'type' => 'string',
'example' => 'FAST_CHOICE',
],
'singleDurationUnit' => [
'title' => '每人排班时长单位 HOUR 小时 DAY 天',
'description' => '每人排班时长单位:'."\n"
.'- HOUR:小时。'."\n"
.'- DAY:天。',
'type' => 'string',
'example' => 'DAY',
],
'schedulingUsers' => [
'title' => '快速轮班用户',
'description' => '快速轮班用户。',
'type' => 'array',
'items' => [
'description' => '快速排班用户。',
'type' => 'object',
'properties' => [
'schedulingUserId' => [
'title' => '轮班用户ID',
'description' => '轮班用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '66666',
],
'schedulingOrder' => [
'title' => '排班顺序',
'description' => '排班顺序。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'schedulingUserName' => [
'title' => '轮班用户名字',
'description' => '轮班用户名字。',
'type' => 'string',
'example' => '张先生',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'description' => '多人排班时,人员ID。',
'type' => 'array',
'items' => [
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '66666',
],
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'description' => '排班对象类型。',
'type' => 'string',
'example' => 'single',
],
],
],
],
'id' => [
'title' => '快速排班ID',
'description' => '快速排班ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '2222',
],
],
],
'fineScheduling' => [
'title' => '精细排班',
'description' => '精细排班。',
'type' => 'object',
'properties' => [
'period' => [
'title' => '1',
'description' => '循环周期。',
'type' => 'integer',
'format' => 'int32',
'example' => '循环周期',
],
'id' => [
'title' => '1',
'description' => '精细排班ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '精细排班ID',
],
'periodUnit' => [
'title' => '循环周期单位 HOUR 小时 DAY 天',
'description' => '循环周期单位:'."\n"
.'- HOUR:小时。'."\n"
.'- DAY:天。',
'type' => 'string',
'example' => 'DAY',
],
'shiftType' => [
'title' => '班次类型 MORNING_NIGHT 早晚班 MORNING_NOON_NIGHT 早中晚班 CUSTOM 自定义',
'description' => '班次类型:'."\n"
.'- MORNING_NIGHT:早晚班。'."\n"
.'- MORNING_NOON_NIGHT:早中晚班。'."\n"
.'- CUSTOM:自定义。',
'type' => 'string',
'example' => 'MORNING_NIGHT',
],
'schedulingFineShifts' => [
'title' => '精细排班班次人员信息',
'description' => '精细排班班次人员信息。',
'type' => 'array',
'items' => [
'description' => '精细排班。',
'type' => 'object',
'properties' => [
'schedulingStartTime' => [
'title' => '排班开始时间',
'description' => '排班开始时间。',
'type' => 'string',
'example' => '2020-08-13',
],
'schedulingEndTime' => [
'title' => '排班结束时间',
'description' => '排班结束时间。',
'type' => 'string',
'example' => '2020-10-13',
],
'schedulingOrder' => [
'title' => '排班顺序',
'description' => '排班顺序。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'shiftName' => [
'title' => '班次名称',
'description' => '班次名称。',
'type' => 'string',
'example' => '早班',
],
'cycleOrder' => [
'title' => '循环次序',
'description' => '循环次序。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'schedulingUserId' => [
'title' => '排班用户ID',
'description' => '排班用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1111',
],
'skipOneDay' => [
'title' => '是否跨天',
'description' => '是否跨天。',
'type' => 'boolean',
'example' => 'false',
],
'schedulingUserName' => [
'title' => '排班用户名字',
'description' => '排班用户名字。',
'type' => 'string',
'example' => '刘德华',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'description' => '多人排班时,人员ID。',
'type' => 'array',
'items' => [
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '66666',
],
],
'schedulingObjectType' => [
'description' => '任务调度类型。',
'type' => 'string',
'example' => 'single',
],
],
],
],
'schedulingTemplateFineShifts' => [
'title' => '精细排班模版',
'description' => '精细排班模版。',
'type' => 'array',
'items' => [
'description' => '精细排班模版。',
'type' => 'object',
'properties' => [
'schedulingStartTime' => [
'title' => '排班开始时间',
'description' => '排班开始时间。',
'type' => 'string',
'example' => '2021-09-01 00:00:00',
],
'schedulingEndTime' => [
'title' => '排班结束时间',
'description' => '排班结束时间。',
'type' => 'string',
'example' => '2021-10-01 00:00:00',
],
'schedulingOrder' => [
'title' => '排班顺序',
'description' => '排班顺序。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'schedulingUserId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'string',
'example' => '1',
],
'skipOneDay' => [
'title' => '是否跨天',
'description' => '是否跨天。',
'type' => 'boolean',
'example' => 'true',
],
'schedulingUserName' => [
'title' => '排班用户名字',
'description' => '排班用户名字。',
'type' => 'string',
'example' => '刘德华',
],
'shiftName' => [
'title' => '班次名称',
'description' => '班次名称。',
'type' => 'string',
'example' => '早班',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'description' => '多人排班时,人员ID。',
'type' => 'array',
'items' => [
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '66666',
],
],
'schedulingObjectType' => [
'description' => '任务调度类型。',
'type' => 'string',
'example' => 'single',
],
],
],
],
],
],
'users' => [
'title' => '已经排班',
'description' => '已经排班。',
'type' => 'array',
'items' => [
'description' => '已经排班用户。',
'type' => 'object',
'properties' => [
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '66666',
],
'userName' => [
'title' => '用户名字',
'description' => '用户名称。',
'type' => 'string',
'example' => '用户名字',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ResourceNotFound',
'errorMessage' => 'The specified Resource is not found.',
],
],
],
'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":"\\n xxxxxxxxxxxx\\n \\n FINE\\n 99999\\n \\n 12\\n FAST_CHOICE\\n DAY\\n \\n 66666\\n 1\\n 张杰\\n \\n 2222\\n \\n \\n DAY\\n MORNING_NIGHT\\n \\n 2020-08-13\\n 2020-10-13\\n 1\\n 早班\\n 1\\n 1111\\n false\\n 刘德华\\n \\n \\n 2021-09-01 00:00:00\\n 2021-10-01 00:00:00\\n 1\\n 1\\n true\\n 刘德华\\n 早班\\n \\n \\n \\n 用户名字\\n \\n \\n","errorExample":""}]',
'title' => '查询服务组排班详情',
],
'UpdateServiceGroupSpecialDayScheduling' => [
'summary' => '修改指定日期的服务组排班。',
'path' => '/services/group/scheduling/updateSpecialDayScheduling',
'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' => [
'FEATUREgempU4CBQS',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '6666',
],
'schedulingDate' => [
'title' => '排班日期',
'description' => '排班日期。',
'type' => 'string',
'required' => true,
'example' => '2021-08-19',
],
'schedulingSpecialDays' => [
'title' => '特殊排班信息',
'description' => '排班信息。',
'type' => 'array',
'items' => [
'description' => '排班。',
'type' => 'object',
'properties' => [
'schedulingStartTime' => [
'title' => '排班开始时间',
'description' => '排班开始时间。',
'type' => 'string',
'required' => true,
'example' => '2021-08-19 08:00:00',
],
'schedulingEndTime' => [
'title' => '排班结束时间',
'description' => '排班结束时间。',
'type' => 'string',
'required' => true,
'example' => '2021-08-19 12:00:00',
],
'schedulingUserId' => [
'title' => '排班用户ID',
'description' => '排班用户。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '64',
],
'schedulingOrder' => [
'title' => '班次顺序',
'description' => '班次顺序。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'description' => '排班对象类型。',
'type' => 'string',
'required' => false,
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'description' => '排班成员列表。',
'type' => 'array',
'items' => [
'description' => '排班成员列表。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
'required' => false,
],
],
'required' => true,
],
'required' => true,
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'xxxxxxxx',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ResourceNotFound',
'errorMessage' => 'The specified Resource is not found.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"\\n xxxxxxxx\\n","errorExample":""}]',
'title' => '修改指定日期的服务组排班',
],
'UpdateServiceGroupScheduling' => [
'summary' => '修改服务组排班。',
'path' => '/services/group/scheduling/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' => [
'FEATUREgempCICFVA',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1000',
],
'schedulingWay' => [
'title' => '排班方式 FAST 快速排班 FINE 精细排班',
'description' => '排班方式:'."\n"
.'- FAST:快速排班。'."\n"
.'- FINE:精细排班。',
'type' => 'string',
'required' => true,
'example' => 'FAST',
],
'fastScheduling' => [
'title' => '快速排班',
'description' => '快速排班。',
'type' => 'object',
'properties' => [
'singleDuration' => [
'title' => '每人排班时长',
'description' => '每人排班时长。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '12',
],
'dutyPlan' => [
'title' => '值班方案 dutyPlan FAST_CHOICE 快速选择 CUSTOM 自定义',
'description' => '值班方案:'."\n"
.'- FAST_CHOICE:快速选择。'."\n"
.'- CUSTOM:自定义。',
'type' => 'string',
'required' => false,
'example' => 'FAST_CHOICE',
],
'singleDurationUnit' => [
'title' => '每人排班时长单位 HOUR 小时 DAY 天',
'description' => '每人排班时长单位:'."\n"
.'- HOUR:小时。'."\n"
.'- DAY:天。',
'type' => 'string',
'required' => false,
'example' => 'DAY',
],
'schedulingUsers' => [
'title' => '快速轮班用户',
'description' => '快速轮班用户。',
'type' => 'array',
'items' => [
'description' => '快速轮班用户。',
'type' => 'object',
'properties' => [
'schedulingUserId' => [
'title' => '轮班用户ID',
'description' => '轮班用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '6666',
],
'schedulingOrder' => [
'title' => '排班顺序',
'description' => '排班顺序。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'description' => '任务调度类型。',
'type' => 'string',
'required' => false,
'example' => '1',
],
'schedulingUserIdList' => [
'description' => '调度用户列表。',
'type' => 'array',
'items' => [
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
'id' => [
'title' => '快速排班ID',
'description' => '快速排班ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
'required' => false,
'example' => 'HOUR',
],
'fineScheduling' => [
'title' => '精细排班',
'description' => '精细排班。',
'type' => 'object',
'properties' => [
'period' => [
'title' => '循环周期',
'description' => '循环周期。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'periodUnit' => [
'title' => '循环周期单位 HOUR 小时 DAY 天',
'description' => '循环周期单位:'."\n"
.'- HOUR:小时。'."\n"
.'- DAY:天。',
'type' => 'string',
'required' => false,
'example' => 'DAY',
],
'shiftType' => [
'title' => '班次类型 MORNING_NIGHT 早晚班 MORNING_NOON_NIGHT 早中晚班 CUSTOM 自定义',
'description' => '班次类型:'."\n"
.'- MORNING_NIGHT:早晚班。'."\n"
.'- MORNING_NOON_NIGHT:早中晚班。'."\n"
.'- CUSTOM:自定义。',
'type' => 'string',
'required' => false,
'example' => 'MORNING_NIGHT',
],
'schedulingFineShifts' => [
'title' => '精细排班班次人员信息',
'description' => '精细排班班次人员信息。',
'type' => 'array',
'items' => [
'description' => '精细排班。',
'type' => 'object',
'properties' => [
'schedulingStartTime' => [
'title' => '排班开始时间',
'description' => '排班开始时间。',
'type' => 'string',
'required' => false,
'example' => '2020-08-13',
],
'schedulingEndTime' => [
'title' => '排班结束时间',
'description' => '排班结束时间。',
'type' => 'string',
'required' => false,
'example' => '2020-10-13',
],
'schedulingOrder' => [
'title' => '排班顺序',
'description' => '排班顺序。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'shiftName' => [
'title' => '班次名称',
'description' => '班次名称。',
'type' => 'string',
'required' => false,
'example' => '早班',
],
'skipOneDay' => [
'title' => '是否跨天',
'description' => '是否跨天。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'schedulingUserId' => [
'title' => '排班用户ID',
'description' => '排班用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '32',
],
'cycleOrder' => [
'title' => '轮训次序',
'description' => '排班顺序。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '123',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'description' => '调度任务类型。',
'type' => 'string',
'required' => false,
'example' => '1',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'description' => '用户调度列表。',
'type' => 'array',
'items' => [
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
'schedulingTemplateFineShifts' => [
'title' => '精细排班模版',
'description' => '精细排班模版。',
'type' => 'array',
'items' => [
'description' => '精细排班。',
'type' => 'object',
'properties' => [
'schedulingStartTime' => [
'title' => '排班开始时间',
'description' => '排班开始时间。',
'type' => 'string',
'required' => false,
'example' => '2021-10-01 00:00:00',
],
'schedulingEndTime' => [
'title' => '排班结束时间',
'description' => '排班结束时间。',
'type' => 'string',
'required' => false,
'example' => '2021-11-01 00:00:00',
],
'schedulingOrder' => [
'title' => '排班顺序',
'description' => '排班顺序。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'schedulingUserId' => [
'title' => '排班用户ID',
'description' => '排班用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'shiftName' => [
'title' => '班次名称',
'description' => '班次名称。',
'type' => 'string',
'required' => false,
'example' => '早班',
],
'skipOneDay' => [
'title' => '是否跨天',
'description' => '是否跨天。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'description' => '调度类型。',
'type' => 'string',
'required' => false,
'example' => '1',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'description' => '调度用户列表。',
'type' => 'array',
'items' => [
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
'id' => [
'title' => '精细排班ID',
'description' => '精细排班ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
'required' => false,
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'xxxxxxxxxx',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter is not valid. %s',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"\\n xxxxxxxxxx\\n","errorExample":""}]',
'title' => '修改服务组排班',
],
'CreateService' => [
'summary' => '创建服务。',
'path' => '/services/save',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceDescription' => [
'title' => '服务描述',
'description' => '服务描述。',
'type' => 'string',
'required' => false,
'example' => '服务描述',
],
'serviceName' => [
'title' => '服务名称',
'description' => '服务名字。',
'type' => 'string',
'required' => true,
'example' => '服务名字',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'escalationPlanId' => [
'title' => '升级策略ID',
'description' => '升级策略ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '345',
],
'serviceGroupIdList' => [
'title' => '服务组ID列表',
'description' => '服务组ID。',
'type' => 'array',
'items' => [
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'title' => '服务ID',
'description' => '服务ID。',
'type' => 'object',
'properties' => [
'serviceId' => [
'title' => '服务ID',
'description' => '服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
'example' => '1',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AddServiceFail',
'errorMessage' => 'Failed to add the service.',
],
[
'errorCode' => 'ServiceNameAlreadyExisted',
'errorMessage' => 'The service name is already in use.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": {\\n \\"serviceId\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n \\n 1\\n \\n","errorExample":""}]',
'title' => '创建服务',
],
'DeleteService' => [
'summary' => '删除服务。',
'path' => '/services/delete',
'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' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceId' => [
'title' => '服务ID',
'description' => '服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10002000',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DeleteServiceFail',
'errorMessage' => 'Failed to delete the service.',
],
],
404 => [
[
'errorCode' => 'ServiceNotExisted',
'errorMessage' => 'The service does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n","errorExample":""}]',
'title' => '删除服务',
],
'GetService' => [
'summary' => '查询服务详情。',
'path' => '/services/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' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceId' => [
'title' => '服务ID',
'description' => '服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'title' => '服务详情',
'description' => '服务详情。',
'type' => 'object',
'properties' => [
'serviceId' => [
'title' => '服务ID',
'description' => '服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'serviceName' => [
'title' => '服务名字',
'description' => '服务名字。',
'type' => 'string',
'example' => '保洁服务',
],
'serviceDescription' => [
'title' => '服务描述',
'description' => '服务描述。',
'type' => 'string',
'example' => '服务描述',
],
'updateTime' => [
'title' => '修改时间',
'description' => '修改时间。',
'type' => 'string',
'example' => '2020-03-08 12:53:53',
],
'serviceGroupIdList' => [
'title' => '服务组ID列表',
'description' => '服务组ID列表。',
'type' => 'array',
'items' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
'default' => '1',
],
'minItems' => 0,
],
'escalationPlanId' => [
'title' => '升级策略ID',
'description' => '升级策略ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ServiceNotExisted',
'errorMessage' => 'The service does not exist.',
],
],
],
'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":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n \\n 1\\n 保洁服务\\n 服务描述\\n 2020-03-08 12:53:53\\n \\n","errorExample":""}]',
'title' => '查询服务详情',
],
'ListServices' => [
'summary' => '查看服务列表。',
'path' => '/services/list',
'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' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'serviceName' => [
'title' => '服务名称',
'description' => '服务名称',
'type' => 'string',
'required' => false,
'example' => '购物车',
],
'pageNumber' => [
'title' => '当前页',
'description' => '当前页',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'pageSize' => [
'title' => '页大小',
'description' => '页大小',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'description' => '服务列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'serviceId' => [
'title' => '服务ID',
'description' => '服务ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'serviceName' => [
'title' => '服务名字',
'description' => '服务名字',
'type' => 'string',
'example' => '购物车',
],
'serviceDescription' => [
'title' => '服务描述',
'description' => '服务描述',
'type' => 'string',
'example' => '服务描述',
],
'updateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '2020-09-08 14:30:30',
],
'isValid' => [
'description' => '是否合法',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'escalationPlanName' => [
'title' => '升级策略名称',
'description' => '升级策略名称',
'type' => 'string',
],
'escalationPlanId' => [
'title' => '升级策略ID',
'description' => '升级策略ID',
'type' => 'integer',
'format' => 'int64',
],
'serviceGroupIdList' => [
'title' => '服务组ID列表',
'description' => '服务组ID列表',
'type' => 'array',
'items' => [
'title' => '服务组ID',
'description' => '服务组ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
'default' => '1',
],
],
],
],
],
'pageNumber' => [
'title' => '当前页',
'description' => '当前页',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'pageSize' => [
'title' => '页大小',
'description' => '页大小',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'totalCount' => [
'title' => '总条数',
'description' => '总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
'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":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n \\n 1\\n 购物车\\n 服务描述\\n 2020-09-08 14:30:30\\n \\n 1\\n 10\\n 100\\n","errorExample":""}]',
'title' => '查看服务列表',
],
'UpdateService' => [
'summary' => '更新服务。',
'path' => '/services/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' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceDescription' => [
'title' => '服务描述',
'description' => '服务描述。',
'type' => 'string',
'required' => false,
'example' => '服务描述',
],
'serviceName' => [
'title' => '服务名字',
'description' => '服务名称。',
'type' => 'string',
'required' => false,
'example' => '服务A',
],
'serviceId' => [
'title' => '服务ID',
'description' => '服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10002000',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'escalationPlanId' => [
'title' => '升级策略ID',
'description' => '升级策略ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '234534',
],
'serviceGroupIdList' => [
'title' => '服务组ID列表',
'description' => '服务组ID。',
'type' => 'array',
'items' => [
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'description' => '返回结果。',
'type' => 'integer',
'format' => 'int64',
'example' => 'null',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'EditServiceFail',
'errorMessage' => 'Failed to edit the service.',
],
],
404 => [
[
'errorCode' => 'ServiceNotExisted',
'errorMessage' => 'The service does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": 0\\n}","errorExample":""},{"type":"xml","example":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n","errorExample":""}]',
'title' => '更新服务',
],
'CreateRouteRule' => [
'summary' => '创建流转规则。',
'path' => '/routeRule/save',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempLJVP1W',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '创建规则参数',
'description' => '创建流转规则参数。',
'type' => 'object',
'properties' => [
'ruleName' => [
'title' => '规则名称',
'description' => '流转规则名称。',
'type' => 'string',
'required' => true,
'example' => '规则名称',
],
'enableStatus' => [
'title' => '启用状态',
'description' => '是否启用:'."\n"
.'- disable:禁用。'."\n"
.'- enable:启用。',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
'relatedServiceId' => [
'title' => '关联服务ID',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '100',
],
'routeType' => [
'title' => '路由类型:INCIDENT 触发事件 ALERT仅触发报警',
'description' => '路由类型:'."\n"
.'- INCIDENT:触发事件。'."\n"
.'- ALERT:仅触发报警。',
'type' => 'string',
'required' => true,
'example' => 'INCIDENT',
],
'incidentLevel' => [
'title' => '事件级别 P1 P2 P3 P4',
'description' => '事件级别:P1、P2、P3、P4递减。',
'type' => 'string',
'required' => true,
'example' => 'P1',
],
'assignObjectId' => [
'title' => '事件分派对象ID(服务组ID 或用户ID)',
'description' => '事件分派对象ID(服务组ID 或用户ID)。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '65',
],
'assignObjectType' => [
'title' => '事件分派对象类型 SERVICEGROUP服务组 USER 单个用户',
'description' => '事件分派对象类型:'."\n"
.'- SERVICEGROUP:服务组。'."\n"
.'- USER:单个用户。',
'type' => 'string',
'required' => true,
'example' => 'SERVICEGROUP',
],
'effection' => [
'title' => '影响程度 LOW-一般 HIGH-严重',
'description' => '影响程度:'."\n"
.'- LOW:一般。'."\n"
.'- HIGH:严重。',
'type' => 'string',
'required' => true,
'example' => 'LOW',
],
'timeWindow' => [
'title' => '时间窗口',
'description' => '时间窗口。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '2',
],
'matchCount' => [
'title' => '命中次数',
'description' => '命中次数。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '3',
],
'timeWindowUnit' => [
'title' => '时间窗口单位 MINUTE 分钟 SECOND 秒',
'description' => '时间窗口单位:'."\n"
.'- MINUTE:分钟。'."\n"
.'- SECOND:秒。',
'type' => 'string',
'required' => true,
'example' => 'MINUTE',
],
'routeChildRules' => [
'title' => '子规则',
'description' => '子规则数组。',
'type' => 'array',
'items' => [
'description' => '子规则。',
'type' => 'object',
'properties' => [
'monitorSourceId' => [
'title' => '监控源ID',
'description' => '监控源ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'conditions' => [
'title' => '条件',
'description' => '匹配条件列表。',
'type' => 'array',
'items' => [
'description' => '条件。',
'type' => 'object',
'properties' => [
'key' => [
'title' => '字段名称',
'description' => '匹配key。',
'type' => 'string',
'required' => true,
'example' => 'payload.summary',
],
'value' => [
'title' => '字段值',
'description' => '匹配value。',
'type' => 'string',
'required' => true,
'example' => '123',
],
'operationSymbol' => [
'title' => '操作符号:notContain 不包含;contain 包含;equals 等于;notEquals 不等于;',
'description' => '操作符。',
'type' => 'string',
'required' => true,
'example' => 'equals',
],
],
'required' => true,
],
'required' => true,
],
'childConditionRelation' => [
'title' => '0-与,1-或',
'description' => '- 0:与。'."\n"
.'- 1:或。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
'problemLevel' => [
'title' => '故障级别',
'description' => '故障级别:P1、P2、P3、P4递降。',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
],
'required' => true,
],
'required' => true,
],
'notifyChannels' => [
'title' => '通知渠道。 SMS 短信 EMAIL 邮件 PHONE电话 WEIXIN_GROUP 企微群 DING_GROUP钉钉群',
'description' => '通知渠道列表。',
'type' => 'array',
'items' => [
'description' => '通知渠道:'."\n"
.'- SMS:短信。'."\n"
.'- PHONE:语音。'."\n"
.'- EMAIL:邮件。'."\n"
.'- WEBHOOK:群通知。',
'type' => 'string',
'required' => true,
'example' => '[SMS,PHONE]',
],
'required' => true,
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'childRuleRelation' => [
'title' => '子规则关系AND,OR',
'description' => '子规则关系:'."\n"
.'- AND:与。'."\n"
.'- OR:或。',
'type' => 'string',
'required' => true,
'example' => 'AND',
],
'problemLevelGroup' => [
'description' => '故障等级组。',
'type' => 'object',
'required' => false,
'additionalProperties' => [
'type' => 'object',
'properties' => [
'childRuleRelation' => [
'title' => '子规则关系,0与,1或',
'description' => '子规则关系:'."\n"
.'- 0:与。'."\n"
.'- 1:或。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'matchCount' => [
'title' => '抑制:命中次数',
'description' => '抑制:命中次数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'timeWindow' => [
'title' => '抑制:时间窗口',
'description' => '抑制:时间窗口。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '5',
],
'timeWindowUnit' => [
'title' => '抑制:时间窗口单位',
'description' => '抑制:时间窗口单位。',
'type' => 'string',
'required' => false,
'example' => 'M',
],
'enableUpgrade' => [
'title' => '升级:是否升级',
'description' => '升级:是否升级。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'upgradeTimeWindow' => [
'title' => '升级:时间窗口',
'description' => '升级:时间窗口。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '5',
],
'upgradeTimeWindowUnit' => [
'title' => '升级:时间窗口单位',
'description' => '升级:时间窗口单位。',
'type' => 'string',
'required' => false,
'example' => 'M',
],
],
'description' => '故障等级。',
],
],
'coverageProblemLevels' => [
'title' => '故障等级覆盖',
'description' => '故障等级覆盖。',
'type' => 'array',
'items' => [
'description' => '故障等级类型。',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
'required' => false,
],
'problemEffectionServices' => [
'title' => '故障影响服务',
'description' => '故障影响服务。',
'type' => 'array',
'items' => [
'description' => '影响服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'required' => false,
],
'convergenceFields' => [
'title' => '收敛字段集合',
'description' => '收敛字段集合。',
'type' => 'array',
'items' => [
'description' => '收敛字段集合。',
'type' => 'string',
'required' => false,
'example' => 'app',
],
'required' => false,
],
'convergenceType' => [
'title' => '收敛类型(0:流转规则收敛,1:字段收敛)',
'description' => '收敛类型:'."\n"
.'- 0:流转规则收敛。'."\n"
.'- 1:字段收敛。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '响应参数',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => '请求',
'description' => '请求ID。',
'type' => 'string',
'example' => '请求ID',
],
'data' => [
'title' => '结果',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'routeRuleId' => [
'title' => '规则ID',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
],
'example' => '65',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AddRouteRuleFail',
'errorMessage' => 'Failed to add the rule.',
],
[
'errorCode' => 'RouteRuleNameAlreadyExisted',
'errorMessage' => 'The rule name already exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"请求ID\\",\\n \\"data\\": {\\n \\"routeRuleId\\": 1000\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 请求ID\\n \\n 1000\\n \\n","errorExample":""}]',
'title' => '创建流转规则',
],
'DeleteRouteRule' => [
'summary' => '删除流转规则。',
'path' => '/routeRule/delete',
'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' => [
'FEATUREgempLJVP1W',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'routeRuleId' => [
'title' => '规则ID',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10000',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => '请求ID',
'description' => '请求ID。',
'type' => 'integer',
'format' => 'int64',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DeleteEnabledRuleFail',
'errorMessage' => 'Failed to delete the rule with the enabled status.',
],
[
'errorCode' => 'DeleteRuleFail',
'errorMessage' => 'Failed to delete the rules.',
],
],
404 => [
[
'errorCode' => 'RouteRuleNotExisted',
'errorMessage' => 'The rule does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": 0\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => ' 删除流转规则',
],
'DisableRouteRule' => [
'summary' => '禁用规则。',
'path' => '/routeRule/disable',
'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' => [
'FEATUREgempLJVP1W',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求body。',
'type' => 'object',
'properties' => [
'routeRuleId' => [
'title' => '请求ID',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => '请求ID',
'description' => '请求ID。',
'type' => 'string',
'required' => true,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'title' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'description' => '返回数据。',
'type' => 'integer',
'format' => 'int64',
'example' => 'null',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'RouteRuleNotExisted',
'errorMessage' => 'The rule does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": 0\\n}","errorExample":""},{"type":"xml","example":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n","errorExample":""}]',
'title' => '禁用规则',
'requestParamsDescription' => "\n",
],
'EnableRouteRule' => [
'summary' => '启用规则。',
'path' => '/routeRule/enable',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempLJVP1W',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'routeRuleId' => [
'title' => '规则ID',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => true,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => '请求ID',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'description' => '返回数据。',
'type' => 'integer',
'format' => 'int32',
'example' => 'null',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'EnableRouteRuleFail',
'errorMessage' => 'Failed to enable the rules.',
],
],
404 => [
[
'errorCode' => 'RouteRuleNotExisted',
'errorMessage' => 'The rule does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": 0\\n}","errorExample":""},{"type":"xml","example":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n","errorExample":""}]',
'title' => '启用规则',
],
'GetRouteRule' => [
'summary' => '查看规则详情。',
'path' => '/routeRule/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' => [
'FEATUREgempJRUU6V',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'routeRuleId' => [
'title' => '规则ID',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => '请求ID',
'description' => '请求ID。',
'type' => 'string',
'example' => '6B9347ED-FD93-42B4-B9A4-7282962F5D6A',
],
'data' => [
'title' => '规则详情',
'description' => '规则详情。',
'type' => 'object',
'properties' => [
'routeRuleId' => [
'title' => '规则ID',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '180000000',
],
'ruleName' => [
'title' => '流转规则名字',
'description' => '流转规则名字。',
'type' => 'string',
'example' => '规则1',
],
'timeWindow' => [
'title' => '时间窗口',
'description' => '时间窗口。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'relatedServiceName' => [
'title' => '关联服务名称',
'description' => '关联服务名称。',
'type' => 'string',
'example' => '冲上云霄',
],
'enableStatus' => [
'title' => '是否启用 DISABLE禁用 ENABLE 启用',
'description' => '是否启用:'."\n"
."\n"
.'- disable:禁用。'."\n"
.'- enable:启用。',
'type' => 'string',
'example' => 'disable',
],
'relatedServiceId' => [
'title' => '关联服务ID',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'routeType' => [
'title' => '路由类型:INCIDENT 触发事件 ALERT 仅触发报警',
'description' => '路由类型:'."\n"
."\n"
.'- INCIDENT:触发事件。'."\n"
.'- ALERT:仅触发报警。',
'type' => 'string',
'example' => 'INCIDENT',
],
'incidentLevel' => [
'title' => '事件级别 P1 P2 P3 P4',
'description' => '事件级别递降:'."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'string',
'example' => 'P1',
],
'assignObjectId' => [
'title' => '事件分派对象ID(服务组ID 或用户ID)',
'description' => '事件分派对象ID(服务组ID或用户ID)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'assignObjectType' => [
'title' => '事件分派对象类型 SERVICEGROUP 服务组 USER 单个用户',
'description' => '事件分派对象类型:'."\n"
.'- SERVICEGROUP:服务组。'."\n"
.'- USER:单个用户。',
'type' => 'string',
'example' => 'SERVICEGROUP',
],
'effection' => [
'title' => '影响程度 LOW一般 HIGH-严重',
'description' => '影响程度:'."\n"
.'- LOW:一般。'."\n"
.'- HIGH:严重。',
'type' => 'string',
'example' => 'LOW',
],
'matchCount' => [
'title' => '命中次数',
'description' => '命中次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'childRuleRelation' => [
'title' => '子规则关系,0与,1或',
'description' => '子规则关系:'."\n"
.'- AND:与。'."\n"
.'- OR:或。',
'type' => 'string',
'example' => 'AND、OR',
],
'eventRouteChildRules' => [
'title' => '子规则',
'description' => '子规则。',
'type' => 'array',
'items' => [
'description' => '子规则。',
'type' => 'object',
'properties' => [
'childRouteRuleId' => [
'title' => '子规则ID',
'description' => '子规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'isValidChildRule' => [
'title' => '是否有效得规则true有效 false无效',
'description' => '规则是否有效:'."\n"
.'- true:有效。'."\n"
.'- false:无效。',
'type' => 'boolean',
'example' => 'false',
],
'parentRuleId' => [
'title' => '规则ID',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1800',
],
'monitorSourceId' => [
'title' => '监控源ID',
'description' => '监控源ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'monitorIntegrationConfigId' => [
'title' => '集成配置ID',
'description' => '集成配置ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'monitorSourceName' => [
'title' => '监控源名称',
'description' => '监控源名称。',
'type' => 'string',
'example' => 'zabbix',
],
'childConditionRelation' => [
'title' => '子条件计算关系,0-与,1-或',
'description' => '子条件计算关系:'."\n"
.'- 0:与。'."\n"
.'- 1:或。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'conditions' => [
'title' => '条件',
'description' => '匹配条件。',
'type' => 'array',
'items' => [
'description' => '条件。',
'type' => 'object',
'properties' => [
'key' => [
'title' => '条件可以',
'description' => '条件key。',
'type' => 'string',
'example' => 'alarmName',
],
'value' => [
'title' => '匹配值',
'description' => '匹配值。',
'type' => 'string',
'example' => 'Zabbix server',
],
'operationSymbol' => [
'title' => '操作符',
'description' => '操作符。',
'type' => 'string',
'example' => 'contain',
],
],
],
],
'problemLevel' => [
'description' => '故障等级。',
'type' => 'string',
'example' => '1',
],
],
],
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-09-08 15:30:30',
],
'updateTime' => [
'title' => '修改时间',
'description' => '修改时间。',
'type' => 'string',
'example' => '2020-09-08 15:30:30',
],
'notifyChannels' => [
'title' => '通知渠道',
'description' => '通知渠道。',
'type' => 'array',
'items' => [
'description' => '通知渠道。',
'type' => 'string',
'example' => '[SMS,PHONE]',
],
],
'notifyChannelNames' => [
'title' => '通知渠道名称',
'description' => '通知渠道名称。',
'type' => 'array',
'items' => [
'description' => '通知渠道名称。',
'type' => 'string',
'example' => '[短信,电话]',
],
],
'assignObjectName' => [
'title' => '通知对象名称',
'description' => '通知对象名称。',
'type' => 'string',
'example' => '刘先生',
],
'relServiceDeleteType' => [
'title' => '服务删除字段',
'description' => '服务删除字段。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'problemLevelGroup' => [
'description' => '故障等级组。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'childRuleRelation' => [
'title' => '子规则关系,0与,1或',
'description' => '子规则。',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'matchCount' => [
'title' => '抑制:命中次数',
'description' => '数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '11',
],
'timeWindow' => [
'title' => '抑制:时间窗口',
'description' => '时间窗口。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'timeWindowUnit' => [
'title' => '抑制:时间窗口单位',
'description' => '时间单元。',
'type' => 'string',
'example' => '1',
],
'enableUpgrade' => [
'title' => '升级:是否升级',
'description' => '是否开启。',
'type' => 'boolean',
'example' => 'true',
],
'upgradeTimeWindow' => [
'title' => '升级:时间窗口',
'description' => '时间窗口。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'upgradeTimeWindowUnit' => [
'title' => '升级:时间窗口单位',
'description' => '服务单元。',
'type' => 'string',
'example' => '1',
],
],
'description' => '服务组。',
],
],
'coverageProblemLevels' => [
'title' => '故障等级覆盖',
'description' => '故障等级覆盖。',
'type' => 'array',
'items' => [
'description' => '故障等级。',
'type' => 'string',
'example' => '1',
],
],
'problemEffectionServices' => [
'title' => '故障影响服务',
'description' => '故障影响服务。',
'type' => 'array',
'items' => [
'description' => '故障关联服务。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
'convergenceFields' => [
'title' => '收敛字段集合',
'description' => '收敛字段集合。',
'type' => 'array',
'items' => [
'description' => '收敛字段名称。',
'type' => 'string',
'example' => 'name',
],
],
'convergenceType' => [
'title' => '收敛类型(0:流转规则收敛,1:字段收敛)',
'description' => '收敛类型:'."\n"
.'- 0:流转规则收敛。'."\n"
.'- 1:字段收敛。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'RouteRuleNotExisted',
'errorMessage' => 'The rule does not exist.',
],
],
],
'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":"\\n 6B9347ED-FD93-42B4-B9A4-7282962F5D6A\\n \\n 180000000\\n 我的订阅\\n 规则1\\n 3\\n 冲上云霄\\n DISABLE\\n 1000\\n INCIDENT\\n P1\\n 1000\\n SERVICEGROUP\\n LOW\\n 3\\n \\n 1000\\n false\\n 1800\\n 1\\n 1\\n zabbix\\n \\n alarmName\\n Zabbix server\\n contain\\n \\n \\n 2020-09-08 15:30:30\\n 2020-09-08 15:30:30\\n [SMS,PHONE]\\n [短信,电话]\\n 刘德华\\n \\n","errorExample":""}]',
'title' => '查看规则详情',
'requestParamsDescription' => '{'."\n"
.' "routeRuleId" : 1,'."\n"
.' "}',
'responseParamsDescription' => '{'."\n"
.' "requestId": "6B9347ED-FD93-42B4-B9A4-7282962F5D6A",'."\n"
.' "data": {'."\n"
.' "routeRuleId": 180000000,'."\n"
.' "subscriptionName": "我的订阅",'."\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"
.' "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"
.' "[短信,电话]"'."\n"
.' ],'."\n"
.' "assignObjectName": "刘德华"'."\n"
.' }'."\n"
.'}',
],
'ListRouteRules' => [
'summary' => '查询规则列表。',
'path' => '/routeRule/list',
'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' => [
'FEATUREgempJRUU6V',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '规则列表查询入参数',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'ruleName' => [
'title' => '规则名称',
'description' => '规则名称。',
'type' => 'string',
'format' => 'byte',
'required' => false,
'example' => '规则',
],
'serviceName' => [
'title' => '服务名称',
'description' => '服务名称。',
'type' => 'string',
'format' => 'byte',
'required' => false,
'example' => '服务',
],
'pageNumber' => [
'title' => '第几页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '页的大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'routeType' => [
'title' => '路由类型:0触发事件 1仅触发报警 r',
'description' => '路由类型:'."\n"
.'- 0:触发事件。'."\n"
.'- 1:仅触发报警。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
'notFilterRouteRuleDeleted' => [
'title' => '不过滤已删除流转规则(为true时,已删除过滤对象也会查到)',
'description' => '不过滤已删除流转规则。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => '请求ID',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13B-A225-2C88188E8A43',
],
'data' => [
'title' => '规则列表',
'description' => '规则列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'routeRuleId' => [
'title' => '规则ID',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10000',
],
'tenantRamId' => [
'title' => '租户ID',
'description' => '租户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1344383',
],
'ruleName' => [
'title' => '规则名称',
'description' => '规则名称。',
'type' => 'string',
'example' => '规则名字',
],
'relatedServiceName' => [
'title' => '服务名称',
'description' => '服务名称。',
'type' => 'string',
'example' => '关联服务名字',
],
'timeWindow' => [
'title' => '时间窗口',
'description' => '时间窗口。',
'type' => 'integer',
'format' => 'int64',
'example' => '时间窗口',
],
'matchCount' => [
'title' => '命中次数',
'description' => '命中次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'timeWindowUnit' => [
'title' => '时间窗口单位 MINUTE 分钟 SECOND 秒',
'description' => '时间单位:'."\n"
.'- MINUTE:分钟。'."\n"
.'- SECOND:秒。',
'type' => 'integer',
'format' => 'int64',
'example' => 'MINUTE',
],
'relatedServiceId' => [
'title' => '关联服务ID',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'routeType' => [
'title' => '路由类型:INCIDENT 触发事件 ALERT 仅触发报警',
'description' => '路由类型:'."\n"
.'- INCIDENT:触发事件。'."\n"
.'- ALERT:仅触发报警。',
'type' => 'string',
'example' => 'INCIDENT',
],
'incidentLevel' => [
'title' => '事件级别 P1 P2 P3 P4',
'description' => '事件级别递减:'."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'string',
'example' => 'P1',
],
'assignObjectId' => [
'title' => '事件分派对象ID(服务组ID 或用户ID)',
'description' => '事件分派对象ID:(服务组ID或用户ID)。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'assignObjectType' => [
'title' => '事件分派对象类型 SERVICEGROUP 服务组 USER 单个用户',
'description' => '事件分派对象类型:'."\n"
.'- SERVICEGROUP:服务组。'."\n"
.'- USER:单个用户。',
'type' => 'string',
'example' => 'SERVICEGROUP',
],
'effection' => [
'title' => '影响程度 LOW-一般 HIGH-严重',
'description' => '影响程度:'."\n"
."\n"
.'- LOW:一般。 '."\n"
.'- HIGH:严重。',
'type' => 'string',
'example' => 'LOW',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-03-05 15:53:55',
],
'updateTime' => [
'title' => '修改时间',
'description' => '修改时间。',
'type' => 'string',
'example' => '2020-03-05 15:53:55',
],
'enableStatus' => [
'title' => '是否启用 DISABLE禁用. ENABLE 启用',
'description' => '是否启用:'."\n"
."\n"
.'- DISABLE-禁用 '."\n"
.'- ENABLE-启用',
'type' => 'string',
'example' => 'DISABLE',
],
'monitorSourceNames' => [
'title' => '监控源名称',
'description' => '监控源名称。',
'type' => 'string',
'example' => 'zabbix',
],
'relServiceDeleteType' => [
'title' => '服务删除字段',
'description' => '服务删除字段。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'isValid' => [
'title' => '是否有效 0无效 1有效',
'description' => '是否有效:'."\n"
."\n"
.'- 0:无效。'."\n"
.'- 1:有效。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'totalCount' => [
'title' => '总条数',
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'pageNumber' => [
'title' => '第几页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'pageSize' => [
'title' => '分页大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
'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":"\\n C4BE3837-1A13B-A225-2C88188E8A43\\n \\n 10000\\n 1344383\\n 规则名字\\n 关联服务名字\\n 10\\n 1\\n INCIDENT\\n P1\\n 10\\n SERVICEGROUP\\n LOW\\n 2020-03-05 15:53:55\\n 2020-03-05 15:53:55\\n DISABLE\\n zabbix\\n \\n 10\\n 1\\n 10\\n","errorExample":""}]',
'title' => '查询规则列表',
],
'UpdateRouteRule' => [
'summary' => '编辑流转规则。',
'path' => '/routeRule/edit',
'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' => [
'FEATUREgempLJVP1W',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '编辑流转规则入参',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'ruleName' => [
'title' => '规则名称',
'description' => '规则名称。',
'type' => 'string',
'required' => true,
'example' => '规则名称',
],
'relatedServiceId' => [
'title' => '关联服务ID',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '关联服务ID',
],
'routeRuleId' => [
'title' => '规则ID',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '规则ID',
],
'routeType' => [
'title' => '路由类型:INCIDENT 触发事件 ALERT 仅触发报警',
'description' => '路由类型:'."\n"
.'- INCIDENT:触发事件。'."\n"
.'- ALERT:仅触发报警。',
'type' => 'string',
'required' => true,
'example' => 'ALERT',
],
'incidentLevel' => [
'title' => '事件级别 1-P1 2-P2 3-P3 4-P4',
'description' => '事件级别递降:'."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'string',
'required' => true,
'example' => 'P1',
],
'assignObjectId' => [
'title' => '事件分派对象ID(服务组ID 或用户ID)',
'description' => '事件分派对象ID(服务组ID或用户ID)。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'assignObjectType' => [
'title' => '事件分派对象类型 SERVICEGROUP服务组 USER 单个用户',
'description' => '事件分派对象类型:'."\n"
.'- SERVICEGROUP:服务组。'."\n"
.'- USER:单个用户。',
'type' => 'string',
'required' => true,
'example' => 'SERVICEGROUP',
],
'effection' => [
'title' => '影响程度 LOW-一般 HIGH-严重',
'description' => '影响程度:'."\n"
.'- LOW:一般。'."\n"
.'- HIGH:严重。',
'type' => 'string',
'required' => true,
'example' => 'LOW',
],
'timeWindow' => [
'title' => '时间窗口',
'description' => '时间窗口。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
'timeWindowUnit' => [
'title' => '时间窗口单位 MINUTE 分钟 SECOND 秒',
'description' => '时间窗口单位:'."\n"
.'- MINUTE:分钟。'."\n"
.'- SECOND:秒。',
'type' => 'string',
'required' => true,
'example' => 'MINUTE',
],
'matchCount' => [
'title' => '命中次数',
'description' => '命中次数。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10',
],
'routeChildRules' => [
'title' => '子规则',
'description' => '子规则。',
'type' => 'array',
'items' => [
'description' => '子规则。',
'type' => 'object',
'properties' => [
'childRouteRuleId' => [
'title' => '子规则ID 不填表示新增',
'description' => '子规则ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'conditions' => [
'title' => '条件',
'description' => '条件。',
'type' => 'array',
'items' => [
'description' => '条件。',
'type' => 'object',
'properties' => [
'key' => [
'title' => '字段',
'description' => '条件key。',
'type' => 'string',
'required' => true,
'example' => 'payload.summary',
],
'value' => [
'title' => '字段取值',
'description' => '匹配值。',
'type' => 'string',
'required' => true,
'example' => '123',
],
'operationSymbol' => [
'title' => '操作符',
'description' => '操作符。',
'type' => 'string',
'required' => true,
'example' => 'equals',
],
],
'required' => true,
],
'required' => true,
],
'monitorSourceId' => [
'title' => '监控源ID',
'description' => '监控源ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'isValidChildRule' => [
'title' => 'true 删除子规则 false编辑子规则',
'description' => '是否删除子规则。',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
'childConditionRelation' => [
'title' => '子条件计算关系',
'description' => '子条件计算关系:'."\n"
.'- 0:与。'."\n"
.'- 1:或。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'problemLevel' => [
'description' => '故障级别递降:'."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'string',
'required' => false,
],
],
'required' => true,
],
'required' => true,
],
'notifyChannels' => [
'title' => '通知渠道 SMS 短信 EMAIL 邮件 PHONE 电话 WEIXIN_GROUP 企微群 DING_GROUP 钉钉群',
'description' => '通知渠道。',
'type' => 'array',
'items' => [
'description' => '通知渠道。',
'type' => 'string',
'required' => true,
'example' => '[SMS,PHONE]',
],
'required' => true,
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'childRuleRelation' => [
'title' => 'AND',
'description' => '子规则关系:'."\n"
.'- AND:与。'."\n"
.'- OR:或。',
'type' => 'string',
'required' => false,
'example' => 'AND',
],
'problemLevelGroup' => [
'description' => '故障等级。',
'type' => 'object',
'required' => false,
'additionalProperties' => [
'type' => 'object',
'properties' => [
'childRuleRelation' => [
'title' => '子规则关系,0与,1或',
'description' => '子规则关系:'."\n"
.'- 0:与。'."\n"
.'- 1:或。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
'matchCount' => [
'title' => '抑制:命中次数',
'description' => '抑制:命中次数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
'timeWindow' => [
'title' => '抑制:时间窗口',
'description' => '抑制:时间窗口。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
'timeWindowUnit' => [
'title' => '抑制:时间窗口单位',
'description' => '抑制:时间窗口单位。',
'type' => 'string',
'required' => false,
],
'enableUpgrade' => [
'title' => '升级:是否升级',
'description' => '升级:是否升级。',
'type' => 'boolean',
'required' => false,
],
'upgradeTimeWindow' => [
'title' => '升级:时间窗口',
'description' => '升级:时间窗口。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
'upgradeTimeWindowUnit' => [
'type' => 'string',
'required' => false,
],
],
'description' => '故障等级。',
],
],
'coverageProblemLevels' => [
'title' => '故障等级覆盖',
'description' => 'coverage类型。',
'type' => 'array',
'items' => [
'description' => 'coverage类型。',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
'required' => false,
],
'problemEffectionServices' => [
'title' => '故障影响服务',
'description' => '影响服务列表。',
'type' => 'array',
'items' => [
'description' => '影响服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'required' => false,
],
'convergenceFields' => [
'title' => '收敛字段集合',
'description' => '收敛字段集合。',
'type' => 'array',
'items' => [
'description' => '收敛字段集合。',
'type' => 'string',
'required' => false,
'example' => 'app',
],
'required' => false,
],
'convergenceType' => [
'title' => '收敛类型(0:流转规则收敛,1:字段收敛)',
'description' => '收敛类型:'."\n"
.'- 0:流转规则收敛。'."\n"
.'- 1:字段收敛。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '响应',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => '请求ID',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'description' => '返回结果。',
'type' => 'integer',
'format' => 'int64',
'example' => 'null',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'RouteRuleNameAlreadyExisted',
'errorMessage' => 'The rule name already exists.',
],
],
404 => [
[
'errorCode' => 'RouteRuleNotExisted',
'errorMessage' => 'The rule does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"C4BE3837-1A13-413B-A225-2C88188E8A43\\",\\n \\"data\\": 0\\n}","errorExample":""},{"type":"xml","example":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n","errorExample":""}]',
'title' => '编辑流转规则',
],
'VerifyRouteRule' => [
'summary' => '验证流转规则。',
'path' => '/routeRule/verify',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempLJVP1W',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求body。',
'type' => 'object',
'properties' => [
'routeRuleId' => [
'title' => '规则id',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1111',
],
'testSourceEvents' => [
'title' => '测试告警',
'description' => '告警测试内容。',
'type' => 'array',
'items' => [
'description' => '告警测试内容。',
'type' => 'object',
'properties' => [
'monitorSourceId' => [
'title' => '监控告警源ID',
'description' => '监控源ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'monitorSourceName' => [
'title' => '监控告警源名称',
'description' => '监控源名称。',
'type' => 'string',
'required' => false,
'example' => 'zabbix',
],
'eventTime' => [
'title' => '告警上报时间',
'description' => '告警时间。',
'type' => 'string',
'required' => false,
'example' => '2021-09-08 13:00:00',
],
'eventJson' => [
'title' => '告警内容',
'description' => '告警测试内容格式。',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
'required' => false,
'example' => '{}',
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'xxxxxx',
],
'data' => [
'title' => '验证结果',
'description' => '验证结果。',
'type' => 'object',
'properties' => [
'isValidRule' => [
'title' => '验证是否成功',
'description' => '验证是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'routeType' => [
'title' => '事件或者报警',
'description' => '事件或者报警。',
'type' => 'string',
'example' => 'INCIDENT、ALERT',
],
'notifySubscriptionNames' => [
'title' => '订阅名称',
'description' => '订阅名称。',
'type' => 'array',
'items' => [
'description' => '通知订阅。',
'type' => 'object',
'properties' => [
'subscriptionId' => [
'title' => '订阅ID',
'description' => '订阅ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '111111',
],
'title' => [
'title' => '订阅名称',
'description' => '订阅名称。',
'type' => 'string',
'example' => '订阅名称',
],
],
'example' => '我的订阅',
],
],
'escalationPlans' => [
'title' => '升级策略名称',
'description' => '升级策略名称。',
'type' => 'array',
'items' => [
'description' => '升级计划。',
'type' => 'object',
'properties' => [
'escalationPlanName' => [
'title' => '升级计划名称',
'description' => '升级计划名称。',
'type' => 'string',
'example' => '升级计划1',
],
'escalationPlanId' => [
'title' => '升级计划ID',
'description' => '升级计划ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '111111',
],
],
],
],
'routeRuleFailReason' => [
'title' => '流转规则验证失败的原因',
'description' => '流转规则验证失败的原因。',
'type' => 'array',
'items' => [
'description' => '流转规则验证失败的原因。',
'type' => 'string',
'example' => 'alertName不匹配',
],
],
'monitorSourceIds' => [
'title' => '验证失败监控源ID',
'description' => '验证失败监控源ID。',
'type' => 'array',
'items' => [
'description' => '1000',
'type' => 'integer',
'format' => 'int64',
'example' => '验证失败监控源ID',
],
],
],
],
],
],
],
],
'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":"\\n xxxxxx\\n \\n true\\n INCIDENT、ALERT\\n 我的订阅\\n 升级策略1\\n alertName不匹配\\n \\n","errorExample":""}]',
'title' => '验证流转规则',
'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 使用超额预警\\",\\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\\": \\"线上\\",\\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": "标准集成"'."\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": "【测试,勿动】全部服务"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 100000010,'."\n"
.' "title": "撒发色分"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 100000030,'."\n"
.' "title": "ceshi2190830"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 100000040,'."\n"
.' "title": "test121"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 100000070,'."\n"
.' "title": "是"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 110000000,'."\n"
.' "title": "全部服务-个人-优先级高"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 110000010,'."\n"
.' "title": "111"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 110000030,'."\n"
.' "title": "老数据兼容测试"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 110000090,'."\n"
.' "title": "测试优化功能"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 120000000,'."\n"
.' "title": "经1"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 120000030,'."\n"
.' "title": "三级级联--全部服务"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 120000070,'."\n"
.' "title": "341"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 130000000,'."\n"
.' "title": "全部服务-服务组"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 130000010,'."\n"
.' "title": "222"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 130000030,'."\n"
.' "title": "ceshi0903"'."\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": "边界值测试"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 140000010,'."\n"
.' "title": "通知订阅啊"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 140000020,'."\n"
.' "title": "【不要乱动配置!!!】【新】通知订阅-全部"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 140000070,'."\n"
.' "title": "ceshiyixzia"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 150000000,'."\n"
.' "title": "24321"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 150000030,'."\n"
.' "title": "dscs"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 150000070,'."\n"
.' "title": "史蒂夫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测试订阅"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 160000060,'."\n"
.' "title": "cdscds"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 160000070,'."\n"
.' "title": "ceshisd"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 170000000,'."\n"
.' "title": "服务--个人"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 170000010,'."\n"
.' "title": "4444444"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 170000020,'."\n"
.' "title": "测试11"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 170000030,'."\n"
.' "title": "这是一个测试0927"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 170000060,'."\n"
.' "title": "妖股仁东控股的背后操盘方景华,近日收到证监会的500万罚单。相关处罚决定书显示,这名昔日牛散在仁东控股上巨亏了近27亿,还向证监"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 170000070,'."\n"
.' "title": "吃"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 170000090,'."\n"
.' "title": "发发发"'."\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": "速度"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 190000040,'."\n"
.' "title": "时间自定义配置测试"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 190000080,'."\n"
.' "title": "老数据兼容"'."\n"
.' },'."\n"
.' {'."\n"
.' "subscriptionId": 190000090,'."\n"
.' "title": "当钉测试"'."\n"
.' }'."\n"
.' ],'."\n"
.' "escalationPlans": [],'."\n"
.' "routeRuleFailReason": ['."\n"
.' "无告警内容匹配 Zabbix这条规则"'."\n"
.' ],'."\n"
.' "monitorSourceIds": ['."\n"
.' 23465'."\n"
.' ]'."\n"
.' }'."\n"
.'}',
],
'CreateSubscription' => [
'summary' => '创建通知订阅。',
'path' => '/notify/subscription/create',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempJPZI30',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'subscriptionTitle' => [
'title' => '通知订阅名称',
'description' => '通知订阅名称。',
'type' => 'string',
'required' => true,
'example' => 'testSubscription',
],
'scope' => [
'title' => '订阅范围类型',
'description' => '订阅范围类型。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => 'SERVICE',
],
'notifyObjectType' => [
'title' => '通知对象类型',
'description' => '通知对象类型。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => 'USER',
],
'expiredType' => [
'title' => '订阅时效',
'description' => '订阅时效。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => 'LONG_TERM',
],
'period' => [
'title' => '时间段',
'description' => '短期时间段。',
'type' => 'string',
'required' => false,
'example' => '20天',
],
'scopeObjectList' => [
'title' => '订阅范围列表',
'description' => '订阅范围列表。',
'type' => 'array',
'items' => [
'description' => '订阅范围对象。',
'type' => 'object',
'properties' => [
'scopeObjectId' => [
'title' => '订阅范围对象id',
'description' => '订阅范围对象ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
],
'required' => true,
],
'required' => true,
],
'notifyObjectList' => [
'title' => '通知对象列表',
'description' => '通知对象列表。',
'type' => 'array',
'items' => [
'description' => '通知对象。',
'type' => 'object',
'properties' => [
'notifyObjectId' => [
'title' => '通知对象id',
'description' => '通知对象ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '2',
],
],
'required' => true,
],
'required' => true,
],
'notifyStrategyList' => [
'title' => '通知策略列表',
'description' => '通知策略列表。',
'type' => 'array',
'items' => [
'description' => '订阅范围类型。',
'type' => 'object',
'properties' => [
'instanceType' => [
'title' => '订阅实例类型,事件、报警、故障',
'description' => '订阅实例类型:'."\n"
.'- INCIDENT:事件。'."\n"
.'- ALERT:报警。'."\n"
.'- PROBLEM:故障。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => 'INCIDENT',
],
'strategies' => [
'title' => '条件。json格式,包含多个条件,比如级别、影响程度 kv格式',
'description' => '条件。json格式,包含多个条件,如级别、影响程度、kv格式。',
'type' => 'array',
'items' => [
'description' => '订阅范围。',
'type' => 'object',
'properties' => [
'conditions' => [
'title' => '通知策略条件',
'description' => '通知策略条件。',
'type' => 'array',
'items' => [
'description' => '订阅范围。',
'type' => 'object',
'properties' => [
'effection' => [
'title' => '影响范围',
'description' => '影响范围。',
'type' => 'string',
'required' => false,
'example' => 'HIGH',
],
'problemNotifyType' => [
'title' => '故障通知类型',
'description' => '故障通知类型。',
'type' => 'string',
'required' => false,
'example' => 'PROBLEM_UPDATE',
],
'level' => [
'title' => '等级',
'description' => '等级。',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
'action' => [
'title' => '时间动作',
'description' => '动作。',
'type' => 'string',
'required' => false,
'example' => 'INCIDENT_TRIGGER',
],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'required' => true,
],
'channels' => [
'title' => '渠道,多个逗号分隔',
'description' => '渠道,多个逗号分隔。',
'type' => 'string',
'required' => true,
'example' => 'SMS,PHONE',
],
'periodChannel' => [
'title' => '分时段渠道',
'description' => '分时段通知订阅渠道。',
'type' => 'object',
'properties' => [
'workday' => [
'title' => '工作时段',
'description' => '工作日通知订阅渠道。',
'type' => 'string',
'required' => false,
'example' => 'SMS,PHONE',
],
'nonWorkday' => [
'title' => '非工作时段',
'description' => '非工作日通知订阅渠道。',
'type' => 'string',
'required' => false,
'example' => 'SMS,PHONE',
],
],
'required' => false,
],
],
'required' => true,
],
'required' => true,
],
'clientToken' => [
'title' => '幂等参数',
'description' => '幂等参数。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
],
'startTime' => [
'title' => '开始时间',
'description' => '生效开始时间。',
'type' => 'string',
'required' => false,
'example' => '2021-02-03 10:10:10',
],
'endTime' => [
'title' => '结束时间',
'description' => '失效时间。',
'type' => 'string',
'required' => false,
'example' => '2021-11-03 10:10:10',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'request id',
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
'data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'subscriptionId' => [
'title' => '订阅id',
'description' => '订阅ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '101',
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'NotifySubsAlreadyExists',
'errorMessage' => 'The specified subscription already exists.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"subscriptionId\\": 101\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 70002030\\n \\n 366D5476-734A-4DA5-963E-9724F87470BC\\n","errorExample":""}]',
'title' => '创建通知订阅',
],
'DeleteSubscription' => [
'summary' => '删除通知订阅。',
'path' => '/notify/subscription/delete',
'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' => [
'FEATUREgempJPZI30',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'subscriptionId' => [
'description' => '订阅ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7C56D225-7C34-40BB-9624-C8BA449260E6\\n","errorExample":""}]',
'title' => '删除通知订阅',
],
'EnableSubscription' => [
'summary' => '启用通知订阅 。',
'path' => '/notify/subscription/enable',
'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' => [
'FEATUREgempJPZI30',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'subscriptionId' => [
'description' => '订阅ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'NotifySubsAlreadyEnable',
'errorMessage' => 'The specified subscription is already enabled.',
],
],
[
[
'errorCode' => 'NotifySubsNotExists',
'errorMessage' => 'The specified subscription does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7C56D225-7C34-40BB-9624-C8BA449260E6\\n","errorExample":""}]',
'title' => '启用通知订阅',
],
'UpdateSubscription' => [
'summary' => '更新通知订阅。',
'path' => '/notify/subscription/update',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempJPZI30',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'subscriptionId' => [
'title' => '主键',
'description' => '主键。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '80002020',
],
'subscriptionTitle' => [
'title' => '通知订阅名称',
'description' => '通知订阅名称。',
'type' => 'string',
'required' => true,
'example' => 'newSubs244',
],
'scope' => [
'title' => '订阅范围类型',
'description' => '订阅范围类型。',
'type' => 'string',
'required' => true,
'example' => 'SERVICE',
],
'notifyObjectType' => [
'title' => '通知对象类型',
'description' => '通知对象类型。',
'type' => 'string',
'required' => true,
'example' => 'USER',
],
'expiredType' => [
'title' => '订阅时效',
'description' => '订阅时效。',
'type' => 'string',
'required' => true,
'example' => 'LONG_TERM',
],
'period' => [
'title' => '时间段字符串',
'description' => '订阅时效。',
'type' => 'string',
'required' => false,
'example' => '20天',
],
'scopeObjectList' => [
'title' => '订阅范围列表',
'description' => '订阅范围列表。',
'type' => 'array',
'items' => [
'description' => '订阅范围对象。',
'type' => 'object',
'properties' => [
'id' => [
'title' => '主键id',
'description' => '主键ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'scopeObjectId' => [
'title' => '订阅范围对象id',
'description' => '订阅范围对象ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
],
'required' => true,
],
'required' => true,
],
'notifyObjectList' => [
'title' => '通知对象列表',
'description' => '通知对象列表。',
'type' => 'array',
'items' => [
'description' => '通知对象。',
'type' => 'object',
'properties' => [
'id' => [
'title' => '主键id',
'description' => '主键ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
'notifyObjectId' => [
'title' => '通知对象id',
'description' => '通知对象ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '19',
],
],
'required' => true,
],
'required' => true,
],
'notifyStrategyList' => [
'title' => '通知策略列表',
'description' => '通知策略列表。',
'type' => 'array',
'items' => [
'description' => '订阅行为。',
'type' => 'object',
'properties' => [
'instanceType' => [
'title' => '订阅实例类型,事件、报警、故障',
'description' => '订阅实例类型:'."\n"
."\n"
.'- INCIDENT:事件。'."\n"
.'- ALERT:报警。'."\n"
.'- PROBLEM:故障。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => 'INCIDENT',
],
'strategies' => [
'title' => '通知策略',
'description' => '通知策略。',
'type' => 'array',
'items' => [
'description' => '订阅范围。',
'type' => 'object',
'properties' => [
'id' => [
'title' => 'id',
'description' => '报警等级。',
'type' => 'string',
'required' => false,
'example' => '10',
],
'channels' => [
'title' => '故障等级',
'description' => '故障等级。',
'type' => 'string',
'required' => false,
'example' => 'SMS,WEIXIN_GROUP',
],
'conditions' => [
'title' => '影响程度',
'description' => '影响程度。',
'type' => 'array',
'items' => [
'description' => '隐私数据集。',
'type' => 'object',
'properties' => [
'level' => [
'title' => '等级',
'description' => '等级。',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
'effection' => [
'title' => '影响程度',
'description' => '影响程度。',
'type' => 'string',
'required' => false,
'example' => 'HIGH',
],
'problemNotifyType' => [
'title' => '故障通知类型',
'description' => '故障通知类型。',
'type' => 'string',
'required' => false,
'example' => 'PROBLEM_NOTIFY',
],
'action' => [
'title' => '事件动作',
'description' => '事件动作。',
'type' => 'string',
'required' => false,
'example' => 'INCIDENT_TRIGGER',
],
],
'required' => false,
],
'required' => false,
],
'periodChannel' => [
'title' => '分时段通知渠道',
'description' => '分时段通知订阅渠道。',
'type' => 'object',
'properties' => [
'workday' => [
'title' => '工作时间',
'description' => '工作日通知订阅渠道。',
'type' => 'string',
'required' => false,
'example' => 'SMS,WEIXIN_GROUP',
],
'nonWorkday' => [
'title' => '非工作时间',
'description' => '非工作日通知订阅渠道。',
'type' => 'string',
'required' => false,
'example' => 'SMS,WEIXIN_GROUP',
],
],
'required' => false,
],
],
'required' => false,
],
'required' => true,
],
],
'required' => true,
],
'required' => true,
],
'startTime' => [
'title' => '开始时间',
'description' => '生效开始时间。',
'type' => 'string',
'required' => false,
'example' => '2021-04-04 10:10:11',
],
'endTime' => [
'title' => '结束时间',
'description' => '失效时间。',
'type' => 'string',
'required' => false,
'example' => '2022-05-09 10:10:23',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'NotifySubsAlreadyExists',
'errorMessage' => 'The specified subscription already exists.',
],
],
[
[
'errorCode' => 'NotifySubsNotExists',
'errorMessage' => 'The specified subscription does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7C56D225-7C34-40BB-9624-C8BA449260E6\\n","errorExample":""}]',
'title' => '更新通知订阅',
],
'GetSubscription' => [
'summary' => '通知订阅详情。',
'path' => '/notify/subscription/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' => [
'FEATUREgemp2C8J2M',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'subscriptionId' => [
'description' => '订阅ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
'notFilterScopeObjectDeleted' => [
'title' => '不过滤已删除订阅范围对象(为true时,已删除过滤对象也会查到)',
'description' => '是否过滤删除选项。',
'type' => 'boolean',
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
'data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'subscriptionId' => [
'description' => '订阅ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '68',
],
'subscriptionTitle' => [
'title' => '通知订阅名称',
'description' => '通知订阅名称。',
'type' => 'string',
'example' => 'newTitle',
],
'scope' => [
'title' => '0 全部 1服务 2 流转规则',
'description' => '订阅范围类型:'."\n"
.'- ALL:全部。'."\n"
.'- SERVICE:服务。'."\n"
.'- ROUTERULE:流转规则。',
'type' => 'string',
'example' => 'SERVICE',
],
'notifyObjectType' => [
'title' => '0服务组 1个人',
'description' => '- SERVICEGROUP:服务组。'."\n"
.'- USER:个人。',
'type' => 'string',
'example' => 'USER',
],
'expiredType' => [
'title' => '有效期类型 0 长期 1短期',
'description' => '有效期类型:'."\n"
.'- LONG_TERM:长期。'."\n"
.'- SHORT_TERM:短期。',
'type' => 'string',
'example' => 'LONG_TERM',
],
'period' => [
'title' => '时间段字符串',
'description' => '时间段字符串。',
'type' => 'string',
'example' => '1个月',
],
'startTime' => [
'title' => '时效开始时间',
'description' => '时效开始时间。',
'type' => 'string',
'example' => '2020-05-09 10:10:10',
],
'endTime' => [
'title' => '时效结束时间',
'description' => '时效结束时间。',
'type' => 'string',
'example' => '2021-08-09 10:10:10',
],
'status' => [
'title' => '1 启用 0禁用',
'description' => '- ENABLE:启用。'."\n"
.'- DISABLE:禁用。',
'type' => 'string',
'example' => 'ENABLE',
],
'scopeObjectList' => [
'description' => '订阅范围列表。',
'type' => 'array',
'items' => [
'description' => '订阅范围列表。',
'type' => 'object',
'properties' => [
'id' => [
'title' => 'id主键',
'description' => 'ID主键。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'scope' => [
'title' => '订阅范围类型 0 全部 1服务 2 流转规则',
'description' => '订阅范围类型:'."\n"
.'- ALL:全部。'."\n"
.'- SERVICE:服务。'."\n"
.'- ROUTERULE:流转规则。',
'type' => 'string',
'example' => 'SERVICE',
],
'scopeObjectId' => [
'title' => '订阅范围对象关联表主键id',
'description' => '订阅范围对象关联表主键ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'scopeObject' => [
'title' => '订阅范围对象名称',
'description' => '订阅范围对象名称。',
'type' => 'string',
'example' => '阿里云',
],
'isValid' => [
'title' => '是否有效 0无效 1有效',
'description' => '是否有效:'."\n"
.'- 0:无效。'."\n"
.'- 1:有效。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
'notifyObjectList' => [
'title' => '通知对象列表',
'description' => '通知对象列表。',
'type' => 'array',
'items' => [
'description' => '通知对象列表。',
'type' => 'object',
'properties' => [
'id' => [
'title' => 'id主键',
'description' => 'ID主键。',
'type' => 'integer',
'format' => 'int64',
'example' => '23',
],
'notifyObjectType' => [
'title' => '通知对象类型0服务组 1个人',
'description' => '通知对象类型:'."\n"
.'- SERVICEGROUP:服务组。'."\n"
.'- USER:个人。',
'type' => 'integer',
'format' => 'int64',
'example' => 'USER',
],
'notifyObjectId' => [
'title' => '关联主键id',
'description' => '关联主键ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '19',
],
'name' => [
'title' => '通知对象名',
'description' => '通知对象名称。',
'type' => 'string',
'example' => 'TestName',
],
],
],
],
'notifyStrategyList' => [
'title' => '通知策略列表',
'description' => '通知策略列表。',
'type' => 'array',
'items' => [
'description' => '通知订阅列表。',
'type' => 'object',
'properties' => [
'instanceType' => [
'title' => '订阅实例类型,0事件、1报警、2故障',
'description' => '订阅实例类型:'."\n"
.'- INCIDENT:事件。'."\n"
.'- ALERT:报警。'."\n"
.'- PROBLEM:故障。',
'type' => 'integer',
'format' => 'int64',
'example' => 'INCIDENT',
],
'strategies' => [
'title' => '策略',
'description' => '策略。',
'type' => 'array',
'items' => [
'description' => '策略。',
'type' => 'object',
'properties' => [
'id' => [
'title' => '策略主键',
'description' => '策略主键。',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
'channels' => [
'title' => '通知渠道',
'description' => '通知渠道。',
'type' => 'string',
'example' => 'SMS',
],
'conditions' => [
'title' => '条件',
'description' => '条件。',
'type' => 'array',
'items' => [
'description' => '订阅条件。',
'type' => 'object',
'properties' => [
'effection' => [
'title' => '影响范围',
'description' => '影响范围。',
'type' => 'string',
'example' => 'HIGH',
],
'problemNotifyType' => [
'title' => '故障通知类型',
'description' => '故障通知类型。',
'type' => 'string',
'example' => 'PROBLEM_NOTIFY',
],
'level' => [
'title' => '等级',
'description' => '等级。',
'type' => 'string',
'example' => 'P1',
],
'action' => [
'title' => '事件动作',
'description' => '时间动作。',
'type' => 'string',
'example' => 'INCIDENT_TRIGGER',
],
],
],
],
'periodChannel' => [
'title' => '分时间段渠道',
'description' => '分时间段渠道。',
'type' => 'object',
'properties' => [
'workday' => [
'title' => '工作时间',
'description' => '工作时间。',
'type' => 'string',
'example' => 'DINGDING',
],
'nonWorkday' => [
'title' => '非工作时间',
'description' => '非工作时间。',
'type' => 'string',
'example' => 'DINGDING',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotifySubsNotExists',
'errorMessage' => 'The specified subscription does not exist.',
],
],
],
'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":"\\n 10REQUES-AC5C-4B59-BE11-378F117A6A88\\n \\n 68\\n newTitle\\n SERVICE\\n USER\\n LONG_TERM\\n 1个月\\n 2020-05-9 10:10:10\\n 2021-08-9 10:10:10\\n ENABLE\\n \\n 10\\n SERVICE\\n 10\\n 阿里云\\n \\n \\n 23\\n 19\\n TestName\\n \\n \\n \\n 12\\n SMS\\n \\n HIGH\\n PROBLEM_NOTIFY\\n P1\\n INCIDENT_TRIGGER\\n \\n \\n DINGDING\\n DINGDING\\n \\n \\n \\n \\n","errorExample":""}]',
'title' => '通知订阅详情',
],
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'subscriptionId' => [
'description' => '订阅ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '89',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
],
],
],
],
'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":"\\n 7C56D225-7C34-40BB-9624-C8BA449260E6\\n","errorExample":""}]',
'title' => '禁用通知订阅',
],
'ListSubscriptions' => [
'summary' => '通知订阅列表。',
'path' => '/notify/subscription/list',
'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' => [
'FEATUREgemp2C8J2M',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'pageNumber' => [
'title' => '第几页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '一页几条',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'subscriptionTitle' => [
'title' => '通知订阅名',
'description' => '通知订阅名。',
'type' => 'string',
'required' => false,
'example' => 'newTitle',
],
'scope' => [
'title' => '订阅范围类型 0全部1服务2流转规则',
'description' => '订阅范围类型:'."\n"
.'- ALL:全部。'."\n"
.'- SERVICE:服务。'."\n"
.'- ROUTERULE:流转规则。',
'type' => 'string',
'required' => false,
'example' => 'SERVICE',
],
'scopeObject' => [
'title' => '订阅范围对象名称',
'description' => '订阅范围对象名称。',
'type' => 'string',
'required' => false,
'example' => 'TestName',
],
'notifyObjectType' => [
'title' => '通知对象类型notifyWhoType:0服务组 1个人',
'description' => '通知对象类型:'."\n"
.'- SERVICEGROUP:服务组。'."\n"
.'- USER:个人。',
'type' => 'string',
'required' => false,
'example' => 'SERVICE',
],
'notifyObject' => [
'title' => '通知对象名',
'description' => '通知对象名。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'clientToken' => [
'title' => '幂等参数',
'description' => '幂等参数。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
],
'notFilterScopeObjectDeleted' => [
'title' => '不过滤已删除订阅范围对象(为true时,已删除过滤对象也会查到)',
'description' => '是否过滤删除选项。',
'type' => 'boolean',
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
'data' => [
'description' => '订阅详情。',
'type' => 'array',
'items' => [
'description' => '订阅详情。',
'type' => 'object',
'properties' => [
'subscriptionId' => [
'title' => '订阅id',
'description' => '订阅ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'subscriptionTitle' => [
'title' => '通知订阅名称',
'description' => '通知订阅名称。',
'type' => 'string',
'example' => 'test',
],
'scope' => [
'title' => '0 全部 1服务 2 流转规则',
'description' => '- 0:全部。'."\n"
.'- 1:服务。'."\n"
.'- 2:流转规则。',
'type' => 'integer',
'format' => 'int64',
'example' => 'SERVICE',
],
'notifyObjectType' => [
'title' => '0服务组 1个人',
'description' => '- 0:服务组。'."\n"
.'- 1:个人。',
'type' => 'integer',
'format' => 'int64',
'example' => 'USER',
],
'expiredType' => [
'title' => '有效期类型 0 长期 1短期',
'description' => '有效期类型:'."\n"
.'- LONG_TERM:长期。'."\n"
.'- SHORT_TERM:短期。',
'type' => 'string',
'example' => 'LONG_TERM',
],
'startTime' => [
'title' => '时效开始时间',
'description' => '时效开始时间。',
'type' => 'string',
'example' => '2020-05-09 10:10:10',
],
'endTime' => [
'title' => '时效结束时间',
'description' => '时效结束时间。',
'type' => 'string',
'example' => '2022-05-09 10:10:10',
],
'status' => [
'title' => 'ENABLE 启用 DISABLE禁用',
'description' => '- 1:启用。'."\n"
.'- 0:禁用。',
'type' => 'string',
'example' => 'ENABLE',
],
'scopeObjectList' => [
'title' => '订阅范围列表',
'description' => '订阅范围列表。',
'type' => 'array',
'items' => [
'description' => '订阅范围列表。',
'type' => 'object',
'properties' => [
'id' => [
'title' => 'id主键',
'description' => 'ID主键。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'scope' => [
'title' => '订阅范围类型 ALL全部 SERVICE服务 ROUTETULE流转规则',
'description' => '订阅范围类型:'."\n"
.'- ALL:全部。'."\n"
.'- SERVICE:服务。'."\n"
.'- ROUTERULE:流转规则。',
'type' => 'integer',
'format' => 'int64',
'example' => 'SERVICE',
],
'scopeObjectId' => [
'title' => '订阅范围对象关联表主键id',
'description' => '订阅范围对象关联表主键ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'scopeObject' => [
'title' => '订阅范围对象名称',
'description' => '订阅范围对象名称。',
'type' => 'string',
'example' => '阿里云服务',
],
'isValid' => [
'description' => '是否有效。',
'type' => 'integer',
'format' => 'int64',
],
],
],
],
'notifyObjectList' => [
'title' => '通知对象列表',
'description' => '通知对象列表。',
'type' => 'array',
'items' => [
'description' => '通知对象列表。',
'type' => 'object',
'properties' => [
'id' => [
'title' => 'id主键',
'description' => 'ID主键。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'notifyObjectType' => [
'title' => '通知对象类型0服务组 1个人',
'description' => '通知对象类型:'."\n"
.'- SERVICEGROUP:服务组。'."\n"
.'- USER:个人。',
'type' => 'integer',
'format' => 'int64',
'example' => 'USER',
],
'notifyObjectId' => [
'title' => '关联主键id',
'description' => '关联主键ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'name' => [
'title' => '通知对象名',
'description' => '通知对象名。',
'type' => 'string',
'example' => '张珊',
],
'isValid' => [
'description' => '是否有效。',
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
'totalCount' => [
'title' => '分页参数',
'description' => '分页参数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'pageNumber' => [
'title' => '分页参数',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'pageSize' => [
'title' => '分页参数',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
'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":"\\n 10REQUES-AC5C-4B59-BE11-378F117A6A88\\n \\n 10\\n test\\n LONG_TERM\\n 2020-05-09 10:10:10\\n 2022-05-09 10:10:10\\n ENABLE\\n \\n 10\\n 10\\n 阿里云服务\\n \\n \\n 10\\n 10\\n 张珊\\n \\n \\n 100\\n 1\\n 10\\n","errorExample":""}]',
'title' => '通知订阅列表',
],
'CreateIncidentSubtotal' => [
'summary' => '事件新增小计。',
'path' => '/incident/save/subtotal',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempHBPHMV',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '12312',
],
'description' => [
'title' => '描述',
'description' => '描述。',
'type' => 'string',
'required' => false,
'example' => '描述',
],
'clientToken' => [
'title' => '幂等校验Id',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'data' => [
'type' => 'object',
'properties' => [
'subtotalId' => [
'title' => '小计Id',
'description' => '小计ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
],
],
],
],
],
],
'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.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"subtotalId\\": 123\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n \\n 123\\n \\n","errorExample":""}]',
'title' => '事件新增小计',
],
'ListIncidentSubtotals' => [
'summary' => '查询事件小计。',
'path' => '/incident/list/subtotal',
'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' => [
'FEATUREgempZF76LB',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件ID',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '3123',
],
'clientToken' => [
'title' => '幂等校验',
'description' => '幂等校验token。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE62E59A2E9',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'description' => [
'title' => '描述',
'description' => '描述。',
'type' => 'string',
'example' => '小计描述',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-06-23 00:00:00',
],
'createUserName' => [
'title' => '操作人',
'description' => '操作人。',
'type' => 'string',
'example' => '小明',
],
'createUserPhone' => [
'title' => '操作人手机号',
'description' => '操作人手机号。',
'type' => 'string',
'example' => '130****1111',
],
'createUserId' => [
'title' => '操作人Id',
'description' => '操作人ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12312',
],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'IncidentNotExtisted',
'errorMessage' => 'The incident does not exist.',
],
],
],
'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":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n \\n 小计描述\\n 2021-06-23 00:00:00\\n 小明\\n 130****1111\\n \\n","errorExample":""}]',
'title' => '查询事件小计',
],
'GetIncidentListByIdList' => [
'summary' => '根据事件Id查询事件详情。',
'path' => '/incident/getIncidentListByIdList',
'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' => [
'FEATUREgempJ0ENN8',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'clientToken' => [
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'incidentIdList' => [
'description' => '事件ID列表。',
'type' => 'array',
'items' => [
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1122',
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'type' => 'array',
'items' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'incidentId' => [
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '3213',
],
'routeRuleId' => [
'description' => '流转规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10000',
],
'routeRuleName' => [
'description' => '流转规则名称。',
'type' => 'string',
'example' => '规则A',
],
'incidentStatus' => [
'description' => '事件状态:0(已分派)、1(已响应)、2(已完结)。',
'type' => 'string',
'example' => 'FINISHE',
],
'relatedServiceId' => [
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '213123',
],
'relatedServiceName' => [
'description' => '关联服务名称。',
'type' => 'string',
'example' => '服务A',
],
'effect' => [
'description' => '影响等级:HIGH(高) 、LOW(低)。',
'type' => 'string',
'example' => 'LOW',
],
'assignUserId' => [
'description' => '分派的用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12312',
],
'assignUserName' => [
'description' => '分派的用户姓名 (用户表获取)。',
'type' => 'string',
'example' => '小明',
],
'assignUserPhone' => [
'description' => '分派的用户手机号。',
'type' => 'string',
'example' => '139****1111',
],
'incidentTitle' => [
'description' => '事件标题。',
'type' => 'string',
'example' => '事件标题',
],
'createTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2010-03-09 15:53:45',
],
'isManual' => [
'description' => '事件来源:是(手动)、 否(自动)。',
'type' => 'boolean',
'example' => 'true',
],
'isUpgrade' => [
'description' => '是否升级',
'type' => 'boolean',
'example' => 'true',
],
'incidentDescription' => [
'description' => '事件描述。',
'type' => 'string',
'example' => '事件描述',
],
'problemId' => [
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12312',
],
'durationTime' => [
'description' => '持续时间。',
'type' => 'string',
'example' => '3000000',
],
'notifyChannels' => [
'type' => 'array',
'items' => [
'description' => '通知渠道。',
'type' => 'string',
'example' => '[SMS,PHONE]',
],
],
'relatedServiceGroupName' => [
'description' => '关联服务组名称。',
'type' => 'string',
'example' => '服务组A',
],
'relatedServiceGroupId' => [
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '13000',
],
'relServiceDeleteType' => [
'description' => '服务删除字段。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'relRouteRuleDeleteType' => [
'description' => '规则删除字段。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'assignToWhoIsValid' => [
'description' => '分派的用户是否生效:1(生效)、0(失效)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'relServiceGroupIsValid' => [
'description' => '关联服务组是否生效:1(生效)、0(失效)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'defaultAssignToWhoName' => [
'description' => '默认分配人名称。',
'type' => 'string',
'example' => '小明',
],
'relatedServiceDescription' => [
'description' => '关联服务描述。',
'type' => 'string',
'example' => '关联服务描述',
],
'incidentLevel' => [
'description' => '事件级别:P1、P2、P3、P4递减。',
'type' => 'string',
'example' => 'P4',
],
'incidentNumber' => [
'description' => '事件编号。',
'type' => 'string',
'example' => 'I13002001',
],
'problemNumber' => [
'description' => '故障编号。',
'type' => 'string',
'example' => 'P1231231',
],
'defaultAssignToWho' => [
'description' => '默认分配人ID。',
'type' => 'integer',
'format' => 'int32',
'example' => '1212',
],
'defaultAssignToWhoIsValid' => [
'description' => '默认分配人删除状态。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'IncidentNotExtisted',
'errorMessage' => 'The incident does not exist.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'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":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n \\n 3213\\n 10000\\n 规则A\\n FINISHE\\n 213123\\n 服务A\\n LOW\\n 12312\\n 小明\\n 139****1111\\n 事件标题\\n 2010-03-09 15:53:45\\n true\\n true\\n 事件描述\\n 12312\\n 3000000\\n [SMS,PHONE]\\n 服务组A\\n 13000\\n 1\\n 1\\n 1\\n 1\\n 小明\\n 关联服务描述\\n P4\\n I13002001\\n P1231231\\n 1212\\n 1\\n \\n","errorExample":""}]',
'title' => '根据事件ID查询事件详情',
],
'DeleteIncident' => [
'summary' => '删除事件。',
'path' => '/incident/delete',
'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' => [
'FEATUREgempKAIUZH',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等校验',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'incidentId' => [
'title' => '事件Id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12321',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
],
],
],
'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.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n","errorExample":""}]',
'title' => '删除事件',
],
'CreateIncident' => [
'summary' => '手动新增事件。',
'path' => '/incident/manualSave',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempKAIUZH',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'body',
'type' => 'object',
'properties' => [
'incidentLevel' => [
'title' => 'P1 事件级别 P1 P2 P3 P4',
'description' => '事件级别:P1,P2,P3,P4',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
'clientToken' => [
'title' => '幂等UUID',
'description' => '幂等校验token',
'type' => 'string',
'required' => false,
'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef729f',
],
'relatedServiceId' => [
'title' => '关联服务ID',
'description' => '服务id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12312',
],
'effect' => [
'title' => '影响等级 高:HIGH 低 LOW',
'description' => '影响等级:HIGH,LOW',
'type' => 'string',
'required' => false,
'example' => 'LOW',
],
'incidentTitle' => [
'title' => '事件标题',
'description' => '事件标题',
'type' => 'string',
'required' => false,
'example' => '事件标题A',
],
'assignUserId' => [
'title' => '分派的用户ID',
'description' => '分配对象id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12312',
],
'incidentDescription' => [
'title' => '事件描述',
'description' => '事件描述',
'type' => 'string',
'required' => false,
'example' => '事件描述B',
],
'channels' => [
'title' => '通知渠道 SMS 短信 EMAIL 邮件 PHONE 电话 WEIXIN_GROUP企微群 DING_GROUP 钉钉群',
'description' => '通知渠道 '."\n"
.'SMS(短信)EMAIL(邮件) '."\n"
.'PHONE(电话)WEIXIN_GROUP(企微群)DING_GROUP(钉钉群)WEBHOOK(群通知)',
'type' => 'array',
'items' => [
'description' => '通知渠道',
'type' => 'string',
'required' => false,
'example' => 'SMS',
],
'required' => false,
],
'serviceGroupId' => [
'title' => '服务组Id',
'description' => '12000',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '服务组id',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'data' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件主健Id',
'description' => '事件主健Id',
'type' => 'integer',
'format' => 'int64',
'example' => '事件Id',
],
],
],
'requestId' => [
'title' => 'requestId',
'description' => 'requestId',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ResourceNotFound',
'errorMessage' => 'The specified Resource is not found.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"data\\": {\\n \\"incidentId\\": 0\\n },\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 218\\n \\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n","errorExample":""}]',
'title' => '手动新增事件',
],
'DeliverIncident' => [
'summary' => '事件转交。',
'path' => '/incident/deliver',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body参数。',
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件ID',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1223212',
],
'assignUserId' => [
'title' => '转交用户ID',
'description' => '转交用户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '212321',
],
'clientToken' => [
'title' => '幂等校验id',
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61CS9A221',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2FS',
],
],
],
],
],
'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.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2FS\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n","errorExample":""}]',
'title' => '事件转交',
],
'GetIncident' => [
'summary' => '事件详情。',
'path' => '/incident/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' => [
'FEATUREgempJ0ENN8',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件ID',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '32113',
],
'clientToken' => [
'title' => '幂等校验',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef729f',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef7291',
],
'data' => [
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件Id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '3213',
],
'routeRuleId' => [
'title' => '流转规则ID',
'description' => '流转规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '3123',
],
'routeRuleName' => [
'title' => '流转规则名称',
'description' => '流转规则名称。',
'type' => 'string',
'example' => '流转规则A',
],
'relatedServiceId' => [
'title' => '关联服务ID',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '312312',
],
'relatedServiceName' => [
'title' => '关联服务名称',
'description' => '关联服务名称。',
'type' => 'string',
'example' => '服务A',
],
'relatedServiceDescription' => [
'title' => '关联服务描述',
'description' => '关联服务描述。',
'type' => 'string',
'example' => '关联服务描述',
],
'incidentStatus' => [
'title' => '事件状态 ASSIGNED已分派 RESPONDED已响应 FINISHED已完结',
'description' => '事件状态:ASSIGNED(已分派)、RESPONDED(已响应)、FINISHED(已完结)。',
'type' => 'string',
'example' => 'FINISHE',
],
'incidentLevel' => [
'title' => '事件级别 P1 P2 P3 P4',
'description' => '事件级别:P1、P2、P3、P4递减。',
'type' => 'string',
'example' => 'P4',
],
'effect' => [
'title' => 'HIGH 影响等级 高:HIGH 低 LOW',
'description' => '影响等级:高(HIGH) 、低(LOW)。',
'type' => 'string',
'example' => 'LOW',
],
'assignUserId' => [
'title' => '分派的用户ID',
'description' => '分派的用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12312',
],
'assignUserName' => [
'title' => '分派的用户姓名 (用户表获取)',
'description' => '分派的用户姓名(用户表获取)。',
'type' => 'string',
'example' => '小明',
],
'assignUserPhone' => [
'title' => '分派的用户手机号',
'description' => '分派的用户手机号。',
'type' => 'string',
'example' => '1390000****',
],
'incidentNumber' => [
'title' => '事件编号',
'description' => '事件编号。',
'type' => 'string',
'example' => 'I3443831000000016247759753663894',
],
'incidentTitle' => [
'title' => '事件标题',
'description' => '事件标题。',
'type' => 'string',
'example' => '事件标题',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-01-10 00:00:00',
],
'isManual' => [
'title' => '事件来源 是:手动 否:自动',
'description' => '事件来源:是(手动)、 否(自动)。',
'type' => 'boolean',
'example' => 'true',
],
'isUpgrade' => [
'title' => '是否升级 是 否',
'description' => '是否升级。',
'type' => 'boolean',
'example' => 'true',
],
'incidentDescription' => [
'title' => '事件描述',
'description' => '事件描述。',
'type' => 'string',
'example' => '事件描述',
],
'problemId' => [
'title' => '故障Id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '232113',
],
'problemNumber' => [
'title' => '故障编号',
'description' => '故障编号。',
'type' => 'string',
'example' => '3332113231453321',
],
'durationTime' => [
'title' => '持续时间',
'description' => '持续时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '3000000',
],
'notifyChannels' => [
'title' => '通知渠道',
'description' => '通知渠道。',
'type' => 'array',
'items' => [
'type' => 'string',
'example' => 'WEBHOOK',
],
'example' => '1 短信 2 邮件 3 电话 4 企微群 5 钉钉群 6飞书 7 群通知 8 slack',
],
'relatedServiceGroupName' => [
'title' => '关联服务组名称',
'description' => '关联服务组名称。',
'type' => 'string',
'example' => '服务组A',
],
'relatedServiceGroupId' => [
'title' => '关联服服务id',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '13000',
],
'relServiceDeleteType' => [
'title' => '服务删除字段',
'description' => '服务删除字段。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'relRouteRuleDeleteType' => [
'title' => '规则删除字段',
'description' => '规则删除字段。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'assignToWhoIsValid' => [
'title' => '分派的用户是否生效,1生效,0失效',
'description' => '分派的用户是否生效:1(生效)、0(失效)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'relServiceGroupIsValid' => [
'title' => '关联服务组是否生效,1生效,0失效',
'description' => '关联服务组是否生效:1(生效)、0(失效)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'defaultAssignToWhoName' => [
'title' => '默认分配人名称',
'description' => '默认分配人名称。',
'type' => 'string',
'example' => '小明',
],
'defaultAssignToWho' => [
'title' => '默认分配人id',
'description' => '默认分配人ID。',
'type' => 'integer',
'format' => 'int32',
'example' => '1212',
],
'defaultAssignToWhoIsValid' => [
'title' => '默认分配人删除状态 1正常 0删除',
'description' => '默认分配人删除状态:1(正常)、 0(删除)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'IncidentNotExtisted',
'errorMessage' => 'The incident does not exist.',
],
],
],
'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":"\\n 2b63cdef-7ac3-4892-a76d-0f3389ef7291\\n \\n 3213\\n 3123\\n 流转规则A\\n 312312\\n 服务A\\n 关联服务描述\\n FINISHE\\n P4\\n LOW\\n 12312\\n 小明\\n 1390000****\\n I3443831000000016247759753663894\\n 事件标题\\n 2020-01-10 00:00:00\\n true\\n true\\n 事件描述\\n 232113\\n 3332113231453321\\n 3000000\\n \\n","errorExample":""}]',
'title' => '事件详情',
],
'GetIncidentStatistics' => [
'summary' => '事件统计。',
'path' => '/incident/count',
'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' => [
'FEATUREgempJ0ENN8',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '结构简短描述。',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等校验Id',
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'data' => [
'type' => 'object',
'properties' => [
'myResponse' => [
'title' => '我的 待响应',
'description' => '我的待响应。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'myFinish' => [
'title' => '我的 完结',
'description' => '我的完结。',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'allResponse' => [
'title' => '所有 待响应',
'description' => '所有待响应。',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'allFinish' => [
'title' => '所有 完结',
'description' => '所有完结。',
'type' => 'integer',
'format' => 'int32',
'example' => '113',
],
],
],
],
],
],
],
'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":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n \\n 1\\n 11\\n 12\\n 113\\n \\n","errorExample":""}]',
'title' => '事件统计',
],
'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',
],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'flat',
'schema' => [
'title' => 'body参数',
'description' => 'Body参数。',
'type' => 'object',
'properties' => [
'incidentIds' => [
'title' => '事件ID数组',
'description' => '事件ID,最多传10个。',
'type' => 'array',
'items' => [
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12321',
],
'required' => true,
],
'incidentFinishReason' => [
'title' => '完结原因',
'description' => '事件完结原因。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'incidentFinishReasonDescription' => [
'title' => '原因描述',
'description' => '事件完结原因描述。',
'type' => 'string',
'required' => false,
'example' => '原因',
],
'incidentFinishSolution' => [
'title' => '解决方案',
'description' => '解决方案。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3',
],
'incidentFinishSolutionDescription' => [
'title' => '解决方案描述',
'description' => '解决方案描述。',
'type' => 'string',
'required' => false,
'example' => '原因',
],
'clientToken' => [
'title' => '幂等校验Id',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2DC',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IncidentUpdateInvalid',
'errorMessage' => 'The incident update is invalid.',
],
],
404 => [
[
'errorCode' => 'IncidentNotExtisted',
'errorMessage' => 'The incident does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n \\n","errorExample":""}]',
'title' => '完成事件',
'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',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempKAIUZH',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件Id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '12312',
],
'incidentLevel' => [
'title' => '级别',
'description' => '事件级别递降:'."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
'effect' => [
'title' => '影响程度',
'description' => '影响等级:'."\n"
.'- HIGH:高。'."\n"
.'- LOW:低。',
'type' => 'string',
'required' => false,
'example' => 'LOW',
],
'incidentTitle' => [
'title' => '事件标题',
'description' => '事件标题。',
'type' => 'string',
'required' => false,
'example' => '事件标题',
],
'clientToken' => [
'title' => '幂等校验Id',
'description' => '幂等校验token。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A123',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '2312',
],
],
],
],
],
],
],
'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.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\",\\n \\"data\\": {\\n \\"incidentId\\": 2312\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n \\n 2312\\n \\n","errorExample":""}]',
'title' => '更新事件',
],
'RespondIncident' => [
'summary' => '事件响应。',
'path' => '/incident/response',
'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' => [
'FEATUREgempHBPHMV',
],
],
'parameters' => [
[
'name' => 'Body',
'in' => 'body',
'style' => 'flat',
'schema' => [
'title' => 'body参数',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'incidentIds' => [
'title' => '事件ID数组',
'description' => '事件ID数组。',
'type' => 'array',
'items' => [
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12312',
],
'required' => false,
],
'clientToken' => [
'title' => '幂等校验Id',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A221',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => '062E6568-E505-49D6-8DD0-8F11283EB0AB',
],
],
],
],
],
'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.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"062E6568-E505-49D6-8DD0-8F11283EB0AB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 062E6568-E505-49D6-8DD0-8F11283EB0AB\\n \\n 12312\\n \\n","errorExample":""}]',
'title' => '事件响应',
],
'ListIncidents' => [
'summary' => '事件列表。',
'path' => '/incident/list',
'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' => [
'FEATUREgempZF76LB',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求body。',
'type' => 'object',
'properties' => [
'incidentLevel' => [
'title' => '事件级别 P1 P2 P3 P4',
'description' => '事件级别递降:'."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
'pageNumber' => [
'title' => '页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '行',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'effect' => [
'title' => '影响等级 高:HIGH 低 LOW',
'description' => '影响等级:'."\n"
.'- HIGH:高。'."\n"
.'- LOW:低。',
'type' => 'string',
'required' => false,
'example' => 'LOW',
],
'relationServiceId' => [
'title' => '关联服务ID',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12312',
],
'incidentStatus' => [
'title' => '事件状态 ASSIGNED已分派 RESPONDED已响应 FINISHED已完结',
'description' => '事件状态:'."\n"
.'- ASSIGNED:已分派。'."\n"
.'- RESPONDED:已响应。'."\n"
.'- FINISHED:已完结。',
'type' => 'string',
'required' => false,
'example' => 'ASSIGNED',
],
'me' => [
'title' => '是否自己 1是 0不是',
'description' => '是否是自己:1(是)、0(否)。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'clientToken' => [
'title' => '幂等校验id',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E1',
],
'createStartTime' => [
'title' => '创建开始时间',
'description' => '创建开始时间。',
'type' => 'string',
'required' => false,
'example' => '2021-11-01 00:00:00',
],
'createEndTime' => [
'title' => '创建结束时间',
'description' => '创建结束时间。',
'type' => 'string',
'required' => false,
'example' => '2021-11-10 00:00:00',
],
'ruleName' => [
'title' => '流转规则名字',
'description' => '流转规则名称。',
'type' => 'string',
'required' => false,
'example' => 'sa',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'data' => [
'type' => 'array',
'items' => [
'title' => 'IncidentItemType',
'description' => '事件类型。',
'type' => 'object',
'properties' => [
'incidentId' => [
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12321',
],
'routeRuleId' => [
'title' => '流转规则ID',
'description' => '流转规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
'routeRuleName' => [
'title' => '流转规则',
'description' => '流转规则名称。',
'type' => 'string',
'example' => '规则A',
],
'incidentStatus' => [
'title' => '事件状态 0已分派 1已响应 2已完结',
'description' => '事件状态:0(已分派)、1(已响应)、2(已完结)。',
'type' => 'string',
'example' => '0',
],
'incidentLevel' => [
'title' => '事件级别 P1 P2 P3 P4',
'description' => '事件级别:P1、P2、P3、P4递减。',
'type' => 'string',
'example' => 'P4',
],
'relatedServiceId' => [
'title' => '关联服务ID',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '213123',
],
'relatedServiceName' => [
'title' => '关联服务名称',
'description' => '关联服务名称',
'type' => 'string',
'example' => '服务A',
],
'effect' => [
'title' => '影响等级 高:HIGH 低 LOW',
'description' => '影响等级:HIGH 、LOW。',
'type' => 'string',
'example' => 'HIGH',
],
'assignUserId' => [
'title' => '分派的用户ID',
'description' => '分派的用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '21312',
],
'assignUserName' => [
'title' => '分派的用户姓名',
'description' => '分派的用户姓名。',
'type' => 'string',
'example' => '小明',
'readOnly' => true,
],
'assignUserPhone' => [
'title' => '分派人手机号',
'description' => '分派人手机号。',
'type' => 'string',
'example' => '1390000****',
],
'incidentTitle' => [
'title' => '事件标题',
'description' => '事件标题。',
'type' => 'string',
'example' => '事件A',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-10-1 00:00:00',
],
'isManual' => [
'title' => '事件来源 是=手动 否=自动',
'description' => '事件来源:是(手动)、 否(自动)。',
'type' => 'boolean',
'example' => 'true',
],
'incidentNumber' => [
'title' => '事件编号',
'description' => '事件编号。',
'type' => 'string',
'example' => 'I3000021',
],
'relServiceDeleteType' => [
'title' => '服务删除字段 1正常 0删除',
'description' => '服务删除字段:1(正常)、0(删除)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'relRouteRuleDeleteType' => [
'title' => '规则删除字段 1正常 0删除',
'description' => '规则删除字段:1(正常)、0(删除)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'assignToWhoIsValid' => [
'title' => '分派的用户是否生效,1生效,0失效',
'description' => '分派的用户是否生效:1(生效)、0(失效)。',
'type' => 'integer',
'format' => 'int64',
'example' => '008',
],
],
],
],
'totalCount' => [
'title' => '总数',
'description' => '总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'pageNumber' => [
'title' => '页',
'description' => '页。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'pageSize' => [
'title' => '行',
'description' => '行。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'UserNotAdded',
'errorMessage' => 'The user is not added to the system.',
],
],
],
'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":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n \\n 12321\\n 123\\n 规则A\\n RESPONDED\\n P4\\n 213123\\n 服务A\\n HIGH\\n 21312\\n 小明\\n 1390000****\\n 事件A\\n 2020-10-1 00:00:00\\n true\\n I3000021\\n \\n 60\\n 1\\n 10\\n","errorExample":""}]',
'title' => '事件列表',
],
'ListIncidentDetailTimelines' => [
'summary' => '事件详情动态。',
'path' => '/incident/detail/timeline',
'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' => [
'FEATUREgempJ0ENN8',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件ID',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
'clientToken' => [
'title' => '幂等校验',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'pageNumber' => [
'title' => '页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '行',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
'idSort' => [
'title' => 'id排序方式(desc 倒序,asc 正序)',
'description' => '排序。',
'type' => 'string',
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'title' => [
'title' => '主题',
'description' => '主题。',
'type' => 'string',
'example' => '标题',
],
'description' => [
'title' => '描述',
'description' => '描述。',
'type' => 'string',
'example' => '描述',
],
'remark' => [
'title' => '备注',
'description' => '备注。',
'type' => 'string',
'example' => '备注A',
],
'relatedServiceName' => [
'title' => '服务名称',
'description' => '服务名称。',
'type' => 'string',
'example' => '服务A',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '创建时间',
],
'incidentId' => [
'title' => '事件Id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '事件Id',
],
'action' => [
'title' => '事件action',
'description' => '- INCIDENT_ADD:触发新增。'."\n"
.'- INCIDENT_RESPONSE:响应。'."\n"
.'- INCIDENT_DELIVER:转交。'."\n"
.'- INCIDENT_UPDATE:变更。'."\n"
.'- INCIDENT_ADD_SUBTOTAL:添加小计。'."\n"
.'- INCIDENT_FINISH:完结。'."\n"
.'- INCIDENT_ASSIGN:分配。'."\n"
.'- INCIDENT_UPGRADE:升级。',
'type' => 'string',
'example' => 'INCIDENT_ADD',
],
'snapshotData' => [
'title' => '快照数据',
'description' => '快照数据。',
'type' => 'string',
'example' => '{"userName":"小明"}',
],
'relRouteRuleDeleteType' => [
'title' => '规则删除字段 1正常 0删除或者无规则',
'description' => '规则删除字段:'."\n"
.'- 1:正常。'."\n"
.'- 0:删除或无规则。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'totalCount' => [
'title' => '总数',
'description' => '总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'pageNumber' => [
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'pageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'IncidentNotExtisted',
'errorMessage' => 'The incident does not exist.',
],
],
],
'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":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n \\n 标题\\n 描述\\n 服务A\\n 创建时间\\n \\n","errorExample":""}]',
'title' => '事件详情动态',
],
'ListIncidentTimelines' => [
'summary' => '事件动态。',
'path' => '/incident/timeline',
'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' => [
'FEATUREgempZF76LB',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等校验Id',
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'pageNumber' => [
'title' => '页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '行',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '数据内容。',
'type' => 'object',
'properties' => [
'title' => [
'title' => '动态',
'description' => '动态。',
'type' => 'string',
'example' => '标题',
],
'description' => [
'title' => '描述',
'description' => '描述。',
'type' => 'integer',
'format' => 'int64',
'example' => '描述',
],
'remark' => [
'title' => '备注',
'description' => '备注。',
'type' => 'string',
'example' => '备注A',
],
'relatedServiceName' => [
'title' => '服务名称',
'description' => '服务名称。',
'type' => 'string',
'example' => '服务A',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-06-23 00:00:00',
],
'incidentTitle' => [
'title' => '事件标题',
'description' => '事件标题。',
'type' => 'string',
'example' => '事件标题',
],
'action' => [
'title' => '动态类型 触发新增 INCIDENT_ADD 响应 INCIDENT_RESPONSE 转交 INCIDENT_DELIVER 变更 INCIDENT_UPDATE 添加小计 INCIDENT_ADD_SUBTOTAL 完结 INCIDENT_FINISH 分配 INCIDENT_ASSIGN 升级 INCIDENT_UPGRAD',
'description' => '动态类型:'."\n"
.'- 触发新增:INCIDENT_ADD。 '."\n"
.'- 响应:INCIDENT_RESPONSE。'."\n"
.'- 转交:INCIDENT_DELIVER。'."\n"
.'- 变更:INCIDENT_UPDATE。 '."\n"
.'- 添加小计:INCIDENT_ADD_SUBTOTAL。'."\n"
.'- 完结:INCIDENT_FINISH。 '."\n"
.'- 分配:INCIDENT_ASSIGN。 '."\n"
.'- 升级:INCIDENT_UPGRAD。',
'type' => 'string',
'example' => 'INCIDENT_ADD',
],
'incidentId' => [
'title' => '事件Id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '3321',
],
'incidentNumber' => [
'title' => '事件编号',
'description' => '事件编号。',
'type' => 'string',
'example' => 'I13002001',
],
'snapshotData' => [
'title' => '动态快照数据',
'description' => '动态快照数据。',
'type' => 'string',
'example' => '{"userName":"小明"}',
],
'relRouteRuleDeleteType' => [
'title' => '规则删除字段',
'description' => '规则删除字段。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'totalCount' => [
'title' => '总数',
'description' => '总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '132',
],
'pageNumber' => [
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'pageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'IncidentNotExtisted',
'errorMessage' => 'The incident does not exist.',
],
],
],
'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":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n \\n 标题\\n 服务A\\n 2021-06-23 00:00:00\\n 事件标题\\n INCIDENTRESPONSE\\n \\n","errorExample":""}]',
'title' => '事件动态',
],
'GetIncidentSubtotalCount' => [
'summary' => '获取相似事件相关小计数量。',
'path' => '/incident/subtotal/count',
'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' => [
'FEATUREgemp71I60H',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'incidentIds' => [
'title' => '事件id列表',
'description' => '事件id列表',
'type' => 'array',
'items' => [
'description' => '事件ID列表',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '6754',
],
'required' => true,
],
'clientToken' => [
'title' => '幂等标识',
'description' => '幂等标识',
'type' => 'string',
'required' => false,
'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'data' => [
'title' => 'data',
'description' => 'data',
'type' => 'object',
'properties' => [
'subtotalCount' => [
'title' => 'map',
'description' => 'map',
'type' => 'object',
'example' => '{12:12}',
],
'requestId' => [
'title' => 'id of the request',
'description' => 'id of the request',
'type' => 'string',
'example' => '24343424234',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"data\\": {\\n \\"subtotalCount\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"requestId\\": \\"24343424234\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n <193594331>2193594331>\\n \\n \\n","errorExample":""}]',
'title' => '获取相似事件相关小计数量',
],
'GetSimilarIncidentStatistics' => [
'summary' => '相似事件列表。',
'path' => '/incident/similarIncident/statistics',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '32',
],
'incidentTitle' => [
'title' => '事件标题',
'description' => '事件标题。',
'type' => 'string',
'required' => true,
'example' => '测试事件A',
],
'createTime' => [
'title' => '触发时间',
'description' => '触发时间。',
'type' => 'string',
'required' => true,
'example' => '2021-09-09 09:09:09',
],
'relatedServiceId' => [
'title' => '关联服务id',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '233116754',
],
'events' => [
'title' => '事件告警内容',
'description' => '事件告警内容。',
'type' => 'array',
'items' => [
'description' => '事件内容。',
'type' => 'string',
'required' => true,
'example' => 'xxx',
],
'required' => true,
],
'clientToken' => [
'title' => '幂等标识',
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
],
'data' => [
'title' => 'data',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'topFiveIncidents' => [
'title' => 'topFiveIncidents',
'description' => 'topFiveIncidents',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '32',
],
'incidentNumber' => [
'title' => '事件编号',
'description' => '事件编号。',
'type' => 'string',
'example' => 'I34324',
],
'incidentTitle' => [
'title' => '事件标题',
'description' => '事件标题。',
'type' => 'string',
'example' => '测试事件标题',
],
'relatedRouteRuleId' => [
'title' => '流转规则id',
'description' => '流转规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '4343',
],
'relatedRouteRuleName' => [
'title' => '流转规则名称',
'description' => '流转规则名称。',
'type' => 'string',
'example' => 'xxx',
],
'finishReason' => [
'title' => '触发原因',
'description' => '触发原因。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'finishReasonDescription' => [
'title' => '触发原因描述',
'description' => '触发原因描述。',
'type' => 'string',
'example' => '处罚原因描述测试',
],
'incidentFinishSolution' => [
'title' => '解决方案',
'description' => '解决方案。',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'finishSolutionDescription' => [
'title' => '解决方案描述',
'description' => '解决方案描述。',
'type' => 'string',
'example' => '测试方案',
],
'createTime' => [
'title' => '触发时间',
'description' => '触发时间。',
'type' => 'string',
'example' => '2021-09-09 09:09:09',
],
'assignUserId' => [
'title' => '分派人id',
'description' => '分派人ID。',
'type' => 'string',
'example' => '43',
],
'assignUserName' => [
'title' => '分派人',
'description' => '分派人。',
'type' => 'string',
'example' => '马先生',
],
'durationTime' => [
'title' => '持续时间',
'description' => '持续时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '6787678767',
],
'similarScore' => [
'title' => '相似度',
'description' => '相似度。',
'type' => 'string',
'example' => '1992.21',
],
],
],
],
'countInSixMonths' => [
'title' => '6月内相似事件数量',
'description' => '6月内相似事件数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '43',
],
'countInSevenDays' => [
'title' => '7天内相似事件数量',
'description' => '7天内相似事件数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '8',
],
'dailySimilarIncidents' => [
'title' => '根据日期分类',
'description' => '根据日期分类。',
'type' => 'array',
'items' => [
'description' => 'object',
'type' => 'object',
'properties' => [
'date' => [
'title' => '日期',
'description' => '日期。',
'type' => 'string',
'example' => '2021-03-07',
],
'commitment' => [
'title' => '数量',
'description' => '数量',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'month' => [
'title' => '月份',
'description' => '月份。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'week' => [
'title' => '周',
'description' => '周。',
'type' => 'string',
'example' => '1',
],
'day' => [
'title' => '星期几',
'description' => '星期几。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'similarIncidents' => [
'title' => '相似事件列表',
'description' => '相似事件列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '5435',
],
'incidentNumber' => [
'title' => '事件编号',
'description' => '事件编号。',
'type' => 'string',
'example' => 'I234432',
],
'incidentTitle' => [
'title' => '事件名称',
'description' => '事件名称。',
'type' => 'string',
'example' => '事件A',
],
'relatedRouteRuleId' => [
'title' => '流转规则id',
'description' => '流转规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '334',
],
'relatedRouteRuleName' => [
'title' => '流转规则名称',
'description' => '流转规则名称。',
'type' => 'string',
'example' => '测试规则A',
],
'finishReason' => [
'title' => '触发原因',
'description' => '触发原因。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'finishReasonDescription' => [
'title' => '触发原因描述',
'description' => '触发原因描述。',
'type' => 'string',
'example' => '测试原因B',
],
'incidentFinishSolution' => [
'title' => '解决方案',
'description' => '解决方案。',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'finishSolutionDescription' => [
'title' => '解决方案描述',
'description' => '解决方案描述。',
'type' => 'string',
'example' => '测试方案A',
],
'createTime' => [
'title' => '触发时间',
'description' => '触发时间。',
'type' => 'string',
'example' => '2021-09-09 09:09:09',
],
'assignUserName' => [
'title' => '分派人',
'description' => '分派人。',
'type' => 'string',
'example' => '马先生',
],
'assignUserId' => [
'title' => '分派人id',
'description' => '分派人ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '433',
],
'durationTime' => [
'title' => '持续时间',
'description' => '持续时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '6789765678',
],
'similarScore' => [
'title' => '相似度',
'description' => '相似度。',
'type' => 'string',
'example' => '1003.567',
],
],
],
],
],
],
'example' => '{}',
],
'requestId' => [
'title' => 'id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
],
],
],
],
],
],
],
'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":"\\n 7C56D225-7C34-40BB-9624-C8BA449260E6\\n \\n \\n 32\\n I34324\\n xxx事件\\n 4343\\n xxx\\n 2\\n xxxx原因\\n 5\\n xxx方案\\n 2021-09-09 09:09:09\\n 43\\n 张老三\\n 6787678767\\n 1992.21\\n \\n 43\\n 8\\n \\n 2021-03-07\\n 0\\n 2\\n 1\\n 1\\n \\n 5435\\n I234432\\n 线性代数发多少\\n 334\\n xxx规则\\n 1\\n xx原因\\n 5\\n xxx方案\\n 2021-09-09 09:09:09\\n 张老三\\n 433\\n 6789765678\\n 1003.567\\n \\n \\n uyihg6789\\n \\n","errorExample":""}]',
'title' => '相似事件列表',
],
'ListTrendForSourceEvent' => [
'summary' => '查询告警源趋势统计数据。',
'path' => '/events/querySourceEventTrend',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => '请求ID',
'description' => '请求ID',
'type' => 'string',
'required' => false,
'example' => 'xxxx',
],
'instanceId' => [
'title' => '报警ID',
'description' => '报警或者事件ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1000',
],
'instanceType' => [
'title' => '类型',
'description' => '类型',
'type' => 'string',
'required' => false,
'example' => 'INCIDENT',
],
'startTime' => [
'title' => '开始时间',
'description' => '开始时间',
'type' => 'string',
'required' => false,
'example' => '2020-10-10 00:00:00',
],
'endTime' => [
'title' => '结束时间',
'description' => '结束时间',
'type' => 'string',
'required' => false,
'example' => '2020-10-10 23:59:59',
],
'timeUnit' => [
'title' => '时间单位毫秒',
'description' => '时间单位毫秒',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1000',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'xxxxx',
],
'data' => [
'title' => '统计列表',
'description' => '统计列表',
'type' => 'array',
'items' => [
'description' => '统计数据',
'type' => 'object',
'properties' => [
'maxSustainTime' => [
'title' => '最大持续时长',
'description' => '最大持续时长',
'type' => 'integer',
'format' => 'int64',
'example' => '10920312312312',
],
'convergenceRate' => [
'title' => '收敛率',
'description' => '收敛率',
'type' => 'string',
'example' => '90.90%',
],
'sourceEventsStatMap' => [
'title' => '按监控源分组统计数据',
'description' => '按监控源分组统计数据',
'type' => 'object',
'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' => [
'title' => '是否跨天',
'description' => '是否跨天',
'type' => 'boolean',
'example' => 'true',
],
'unit' => [
'title' => '时间单位',
'description' => '时间单位',
'type' => 'string',
'example' => '1000',
],
],
],
],
],
],
],
],
'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":"\\n xxxxx\\n \\n 10920312312312\\n 90.90%\\n \\n","errorExample":""}]',
'title' => '查询告警源趋势统计数据',
'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": "小时",'."\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"
.'}',
],
'ListSourceEventsForMonitorSource' => [
'summary' => '查询最近告警列表。',
'path' => '/events/queryLastestEvents',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'monitorSourceId' => [
'title' => '监控源ID',
'description' => '监控源ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1000',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'xxxxxx',
],
'data' => [
'title' => '告警列表',
'description' => '告警列表。',
'type' => 'array',
'items' => [
'description' => '告警列表。',
'type' => 'object',
'properties' => [
'monitorSourceId' => [
'title' => '监控源ID',
'description' => '监控源ID。',
'type' => 'boolean',
'example' => '1000',
],
'monitorSourceName' => [
'title' => '监控源名称',
'description' => '监控源名称。',
'type' => 'string',
'example' => 'zabbix',
],
'eventTime' => [
'title' => '告警上报时间',
'description' => '告警上报时间。',
'type' => 'string',
'example' => '2020-01-01 18:30:00',
],
'eventJson' => [
'title' => '告警内容',
'description' => '告警内容。',
'type' => 'string',
'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":"\\n xxxxxx\\n \\n false\\n zabbix\\n 2020-01-01 18:30:00\\n {}\\n \\n","errorExample":""}]',
'title' => '查询最近告警列表',
'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',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempW81V8D',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'instanceId' => [
'title' => '报警或者事件ID',
'description' => '报警或者事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'instanceType' => [
'title' => 'INCIDENT 事件、ALERT 报警、PROBLEM 故障',
'description' => '类型:'."\n"
.'- INCIDENT:事件。'."\n"
.'- ALERT:报警。'."\n"
.'- PROBLEM:故障。',
'type' => 'string',
'required' => true,
'example' => 'INCIDENT',
],
'startRowKey' => [
'title' => 'startRowKey 用来查询下一页的数据',
'description' => '起始密钥。',
'type' => 'string',
'required' => false,
'example' => '9223370410626682599-1344383-78954515-1-0a6e01a1701447fd9ef18b079edd2c6d',
],
'stopRowKey' => [
'title' => 'stopRowKey 用来查询上一页的数据',
'description' => '终止密钥。',
'type' => 'string',
'required' => false,
'example' => '9223370410626682599-1344383-78954515-1-0a6e01a1701447fd9ef18b079edd2c6d',
],
'pageSize' => [
'title' => '页大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'pageNumber' => [
'title' => '当前页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'startTime' => [
'title' => '开始时间',
'description' => '开始时间。',
'type' => 'string',
'required' => false,
'example' => '2020-09-10 13:00:00',
],
'endTime' => [
'title' => '结束时间',
'description' => '结束时间。',
'type' => 'string',
'required' => false,
'example' => '2020-09-18 13:00:00',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => '请求ID',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'totalCount' => [
'title' => '总条数',
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'pageNumber' => [
'title' => '当前页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'pageSize' => [
'title' => '页大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'data' => [
'description' => '当前页。',
'type' => 'array',
'items' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'routeRuleId' => [
'title' => '规则ID',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'instanceType' => [
'title' => 'INCIDENT 事件、ALERT 报警、PROBLEM 故障',
'description' => '类型:'."\n"
.'- INCIDENT:事件。'."\n"
.'- ALERT:报警。'."\n"
.'- PROBLEM:故障。',
'type' => 'string',
'example' => 'INCIDENT',
],
'instanceId' => [
'title' => '关联对象ID',
'description' => '关联对象ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'monitorSourceId' => [
'title' => '监控告警源ID',
'description' => '监控告警源ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'monitorSourceName' => [
'title' => '监控告警源名称',
'description' => '监控告警源名称。',
'type' => 'string',
'example' => 'zabbix',
],
'eventTime' => [
'title' => '告警上报时间',
'description' => '告警上报时间。',
'type' => 'string',
'example' => '2020-09-08 15:53:34',
],
'tenantRamId' => [
'title' => '租户ID',
'description' => '租户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'eventJson' => [
'title' => '告警内容json',
'description' => '告警内容格式。',
'type' => 'string',
'example' => '""',
],
],
],
],
'lastRowKey' => [
'title' => 'lastRowKey',
'description' => '最后一行键。',
'type' => 'string',
'example' => '9223370412331485036-1344383-9967-1-8d729a1b176f493ca3be643b391d5ced',
],
'firstRowKey' => [
'title' => 'firstRowKey',
'description' => '第一行键。',
'type' => 'string',
'example' => '9223370412331485032-1344383-9967-1-08be8b08ef30441390072f3bfba71c94',
],
],
],
],
],
'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":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n 100\\n 1\\n 20\\n \\n 1\\n INCIDENT\\n 1\\n 1\\n zabbix\\n 2020-09-08 15:53:34\\n 1\\n \\"\\"\\n \\n 9223370412331485036-1344383-9967-1-8d729a1b176f493ca3be643b391d5ced\\n 9223370412331485032-1344383-9967-1-08be8b08ef30441390072f3bfba71c94\\n","errorExample":""}]',
'title' => '查询原始告警列表',
],
'ListAlerts' => [
'summary' => '报警列表查询。',
'path' => '/alerts/list',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'alertLevel' => [
'title' => '报警等级 P1 P2 P3 P4',
'description' => '报警等级。',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
'relatedServiceId' => [
'title' => '服务id',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'alertName' => [
'title' => '报警名称',
'description' => '报警名称。',
'type' => 'string',
'required' => false,
'example' => '报警',
],
'pageNumber' => [
'title' => '当前页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '页大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
'alertSourceName' => [
'title' => '报警来源',
'description' => '报警来源。',
'type' => 'string',
'required' => false,
'example' => '流转规则A',
],
'startTime' => [
'title' => '开始时间',
'description' => '开始时间。',
'type' => 'string',
'required' => false,
'example' => '2020-09-10 13:00:00',
],
'endTime' => [
'title' => '结束时间',
'description' => '结束时间。',
'type' => 'string',
'required' => false,
'example' => '2020-09-10 21:00:00',
],
'ruleName' => [
'title' => '流转规则名字',
'description' => '报警规则名称。',
'type' => 'string',
'required' => false,
'example' => '规则名称',
],
'monitorSourceId' => [
'title' => '原始信息来源id',
'description' => '监控源ID。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => '请求ID',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'title' => '报警列表',
'description' => '报警列表。',
'type' => 'array',
'items' => [
'description' => '报警列表。',
'type' => 'object',
'properties' => [
'alertId' => [
'title' => '报警ID',
'description' => '报警ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '20000',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-03-05 15:53:55',
],
'relatedServiceName' => [
'title' => '关联服务名称',
'description' => '关联服务名称。',
'type' => 'string',
'example' => '冲上云霄',
],
'alertLevel' => [
'title' => '告警优先级 1,2,3,4 对应 p1,p2,p3,p4',
'description' => '告警优先级递降:'."\n"
."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'string',
'example' => 'P1',
],
'title' => [
'title' => '报警标题',
'description' => '报警标题。',
'type' => 'string',
'example' => '报警',
],
'sourceEventCount' => [
'title' => '收敛量',
'description' => '收敛量。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'alertSourceName' => [
'title' => '报警源',
'description' => '报警源。',
'type' => 'string',
'example' => '流转规则A',
],
'firstEventTime' => [
'title' => '第一次告警上报时间',
'description' => '第一次告警上报时间。',
'type' => 'string',
'example' => '2021-09-08 18:30:00',
],
'routeRuleId' => [
'title' => '关联流转规则ID',
'description' => '关联流转规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10000',
],
'alertNumber' => [
'title' => '报警编号',
'description' => '报警编号。',
'type' => 'string',
'example' => 'A123123123',
],
'routeRuleName' => [
'title' => '流转规则名字',
'description' => '流转规则名字。',
'type' => 'string',
'example' => '流转规则',
],
'relServiceDeleteType' => [
'title' => '服务删除字段 1正常 0删除',
'description' => '服务删除字段:'."\n"
."\n"
.'- 1:正常。'."\n"
.'- 0:删除。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'routeRuleDeleteType' => [
'title' => '规则删除字段 1正常 0删除',
'description' => '规则删除字段:'."\n"
."\n"
.'- 1:正常。'."\n"
.'- 0:删除。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'monitorSourceName' => [
'title' => '原始数据名称',
'description' => '原始数据名称。',
'type' => 'string',
'example' => 'name',
],
],
],
],
'totalCount' => [
'title' => '总条数',
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'pageNumber' => [
'title' => '当前页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'pageSize' => [
'title' => '页的大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
'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":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n \\n 20000\\n 2020-03-05 15:53:55\\n 冲上云霄\\n P1\\n 报警\\n 10\\n 流转规则A\\n 10000\\n 2021-09-08 18:30:00\\n \\n 100\\n 1\\n 10\\n","errorExample":""}]',
'title' => '报警列表查询',
],
'GetEvent' => [
'summary' => '查询最近一次告警 。',
'path' => '/events/getLastTimeEvent',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'monitorSourceId' => [
'title' => '监控源ID不能为空',
'description' => '监控源ID不能为空。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'XXXXXXXXXXXX',
],
'data' => [
'title' => '告警',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'monitorSourceId' => [
'title' => '告警源ID',
'description' => '告警源ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'monitorSourceName' => [
'title' => '告警源名称',
'description' => '告警源名称。',
'type' => 'string',
'example' => 'zabbix',
],
'eventTime' => [
'title' => '告警上报时间',
'description' => '告警上报时间。',
'type' => 'string',
'example' => '2002-09-08 15:30:35',
],
'eventJson' => [
'title' => '告警内容',
'description' => '告警内容。',
'type' => 'string',
'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":"\\n XXXXXXXXXXXX\\n \\n 1\\n zabbix\\n 2002-09-08 15:30:35\\n “”\\n \\n","errorExample":""}]',
'title' => '查询最近一次告警',
],
'GeneratePictureUploadSign' => [
'summary' => '生成图片上传签名信息。',
'path' => '/rich/oss/generatePostPolicy',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempHBPHMV',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '参数说明。',
'type' => 'object',
'properties' => [
'instanceId' => [
'title' => '资源id',
'description' => '资源ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123123',
],
'instanceType' => [
'title' => '资源类型',
'description' => '资源类型:'."\n"
.'- INCIDENT:事件图片。'."\n"
.'- ALERT:告警图片。'."\n"
.'- PROBLEM:故障图片。',
'type' => 'string',
'required' => false,
'example' => 'INCIDENT',
],
'files' => [
'title' => '文件',
'description' => '图片文件列表。',
'type' => 'array',
'items' => [
'description' => '图片文件列表。',
'type' => 'object',
'properties' => [
'fileName' => [
'title' => '文件名称',
'description' => '图片名称。',
'type' => 'string',
'required' => false,
'example' => '文件',
],
'fileType' => [
'title' => '文件类型',
'description' => '支持以下图片类型:'."\n"
.'- JPEG'."\n"
.'- PNG'."\n"
.'- GIF',
'type' => 'string',
'required' => false,
'example' => 'JPG',
],
'fileSize' => [
'title' => '文件大小',
'description' => '文件大小单位(byte)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '100',
],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd',
],
'data' => [
'title' => 'data',
'description' => '数据内容。',
'type' => 'object',
'properties' => [
'bucketName' => [
'title' => 'oss bucket name',
'description' => 'OSS Bucket名称。',
'type' => 'string',
'example' => 'gam-objects-bucket',
],
'policy' => [
'title' => 'policy',
'description' => '策略名称。',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19',
],
'signature' => [
'title' => 'signature',
'description' => '签名。',
'type' => 'string',
'example' => 'SHqvIkwUNQd8Hervklir*****',
],
'accessKeyId' => [
'title' => 'accessKeyId',
'description' => 'Access Key ID。',
'type' => 'string',
'example' => 'LTAI****************',
],
'url' => [
'title' => 'url',
'description' => 'Bucket地址。',
'type' => 'string',
'example' => 'https://*****-bucket.oss-cn-shanghai.aliyuncs.com',
],
'files' => [
'title' => 'files',
'description' => '图片列表。',
'type' => 'array',
'items' => [
'description' => '图片列表。',
'type' => 'object',
'properties' => [
'fileName' => [
'title' => '文件名称',
'description' => '图片名称。',
'type' => 'string',
'example' => '文件A',
],
'fileType' => [
'title' => '文件类型',
'description' => '图片类型。',
'type' => 'string',
'example' => 'JPG',
],
'fileSize' => [
'title' => '文件大小',
'description' => '图片大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'key' => [
'title' => 'oss key',
'description' => '图片唯一标识。',
'type' => 'string',
'example' => 'problem/25a2316c-b08d-41a5-9f41-*****',
],
],
],
],
],
],
],
],
],
],
'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":"\\n e2d4306a-bf4d-4345-9ae6-158223c85dbd\\n \\n gam-objects-bucket\\n eyJleHBpcmF0aW9uIjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19\\n SHqvIkwUNQd8Hervklir*****\\n LTAI1tEoRVPw8GMy1iLRC*****\\n https://*****-bucket.oss-cn-shanghai.aliyuncs.com\\n \\n 文件A\\n JPG\\n 100\\n problem/25a2316c-b08d-41a5-9f41-*****\\n \\n \\n","errorExample":""}]',
'title' => '生成图片上传签名信息',
],
'ListProblemDetailOperations' => [
'summary' => '故障详情动态。',
'path' => '/problem/detail/operations',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等校验',
'description' => '幂等校验',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'pageNumber' => [
'title' => '页',
'description' => '页',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '行',
'description' => '行',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
'createTimeSort' => [
'title' => '时间排序',
'description' => '时间排序',
'type' => 'string',
'required' => false,
'example' => 'desc',
],
'problemId' => [
'title' => '故障id',
'description' => '故障id',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => 'requestId',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'totalCount' => [
'title' => '总数',
'description' => '总数',
'type' => 'integer',
'format' => 'int32',
'example' => '210',
],
'pageNumber' => [
'title' => '页',
'description' => '页',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'pageSize' => [
'title' => '行',
'description' => '行',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'data' => [
'title' => 'data',
'description' => 'data',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'title' => [
'title' => '动态标题',
'description' => '动态标题',
'type' => 'string',
'example' => '动态标题',
],
'description' => [
'title' => '描述',
'description' => '描述',
'type' => 'string',
'example' => '描述',
],
'relatedServiceName' => [
'title' => '服务',
'description' => '服务',
'type' => 'string',
'example' => '服务A',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '2021-01-23 00:00:00',
],
'remark' => [
'title' => '备注',
'description' => '备注',
'type' => 'string',
'example' => '备注',
],
'action' => [
'title' => '升级 PROBLEM_UPGRADE 撤销 PROBLEM_REVOKE 恢复 PROBLEM_RESTORE 复盘 PROBLEM_IN_REVIEW 完结 PROBLEM_REOPENED 取消 PROBLEM_CANCEL 更新故障通告 PROBLEM_UPDATE_NOTIFY 添加故障小计 PROBLEM_ADD_SUBTOTAL 更新故障 PROBLEM_UPDATE',
'description' => '升级 PROBLEM_UPGRADE 撤销 PROBLEM_REVOKE 恢复 PROBLEM_RESTORE 复盘 PROBLEM_IN_REVIEW 完结 PROBLEM_REOPENED 取消 PROBLEM_CANCEL 更新故障通告 PROBLEM_UPDATE_NOTIFY 添加故障小计 PROBLEM_ADD_SUBTOTAL 更新故障 PROBLEM_UPDATE',
'type' => 'string',
'example' => 'PROBLEM_CANCEL',
],
'snapshotData' => [
'title' => '快照数据',
'description' => '快照数据',
'type' => 'string',
'example' => '{“userName”:"小明"}',
],
],
],
],
],
],
],
],
'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":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n 210\\n 1\\n 10\\n \\n 动态标题\\n 描述\\n 服务A\\n 2021-01-23 00:00:00\\n 备注\\n PROBLEM_CANCEL\\n {“userName”:\\"小明\\"}\\n \\n","errorExample":""}]',
'title' => '故障详情动态',
'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": "动态标题",'."\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"
.'}',
],
'UpdateProblemImprovement' => [
'summary' => '更新故障复盘改进详情。',
'path' => '/problem/improvement/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' => [
'FEATUREgempZVI8H5',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障ID',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12312',
],
'problemReason' => [
'title' => '故障原因',
'description' => '故障原因。',
'type' => 'string',
'required' => false,
'example' => '故障原因A',
],
'recentActivity' => [
'title' => '最近活动 码表:PROBLEM_RECENT_ACTIVITY',
'description' => '最近活动码表:(PROBLEM_RECENT_ACTIVITY)。',
'type' => 'string',
'required' => false,
'example' => '2',
],
'injectionMode' => [
'title' => '注入方式 码表:PROBLEM_INJECTION_MODE',
'description' => '注入方式码表:(PROBLEM_INJECTION_MODE)。',
'type' => 'string',
'required' => false,
'example' => '1',
],
'recoveryMode' => [
'title' => '恢复方式 码表:PROBLEM_RECOVERY_MODE',
'description' => '恢复方式码表:(PROBLEM_RECOVERY_MODE)。',
'type' => 'string',
'required' => false,
'example' => '2',
],
'discoverSource' => [
'title' => '发现来源 码表:PROBLEM_DISCOVER_SOURCE',
'description' => '发现来源码表:(PROBLEM_DISCOVER_SOURCE)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'userReport' => [
'title' => '用户上报 码表:PROBLEM_USER_REPORT',
'description' => '用户上报码表:(PROBLEM_USER_REPORT)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
'monitorSourceName' => [
'title' => '监控源',
'description' => '监控源。',
'type' => 'string',
'required' => false,
'example' => 'Zabbix',
],
'relationChanges' => [
'title' => '关联变更',
'description' => '关联变更。',
'type' => 'string',
'required' => false,
'example' => '关联变更',
],
'dutyUserId' => [
'title' => '故障责任人id',
'description' => '故障责任人ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1231',
],
'replayDutyUserId' => [
'title' => '复盘负责人id',
'description' => '复盘负责人ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1213',
],
'dutyDepartmentName' => [
'title' => '故障责任部门',
'description' => '部门名称。',
'type' => 'string',
'required' => false,
'example' => '服务组A',
],
'dutyDepartmentId' => [
'title' => '故障责任部门ID',
'description' => '部门ID(服务组ID)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123123',
],
'remark' => [
'title' => '备注',
'description' => '备注。',
'type' => 'string',
'required' => false,
'example' => '备注',
],
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3813',
],
'customProblemReason' => [
'title' => '自定义故障原因',
'description' => '故障原因。',
'type' => 'string',
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4361a0e1-6747-4834-96ce-0c4840fd3812\\n","errorExample":""}]',
'title' => '更新故障复盘改进详情',
],
'ListSubscriptionServiceGroups' => [
'summary' => '故障协同组列表。',
'path' => '/problem/serviceGroup/list',
'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' => [
'FEATUREgemp2C8J2M',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceIds' => [
'title' => '服务列表',
'description' => '服务列表。',
'type' => 'array',
'items' => [
'description' => '服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12313',
],
'required' => false,
],
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => '89f51d2e-5527-4f6c-a6c6-4411b5496e9f',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '89f51d2e-5527-4f6c-a6c6-4411b5496e9f',
],
'data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '服务组列表。',
'type' => 'object',
'properties' => [
'serviceId' => [
'title' => '主键',
'description' => '主键。',
'type' => 'integer',
'format' => 'int64',
'example' => '123113',
],
'serviceName' => [
'title' => '服务组名称',
'description' => '服务组名称。',
'type' => 'string',
'example' => '服务A',
],
'serviceGroupDescription' => [
'title' => '服务组描述',
'description' => '服务组描述。',
'type' => 'string',
'example' => '服务描述',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ServiceGroupNotExisted',
'errorMessage' => 'The service group does not exist.',
],
],
],
'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":"\\n 89f51d2e-5527-4f6c-a6c6-4411b5496e9f\\n \\n 123113\\n 服务A\\n 服务描述\\n \\n","errorExample":""}]',
'title' => '故障协同组列表',
],
'CreateProblem' => [
'summary' => '新增故障。',
'path' => '/problem/upgrade',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempZB7ZAW',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemName' => [
'title' => '故障名称',
'description' => '故障名称。',
'type' => 'string',
'required' => false,
'example' => '故障A',
],
'clientToken' => [
'title' => '幂等校验Id',
'description' => '幂等校验token。',
'type' => 'string',
'required' => false,
'example' => 'E789D869-DB13-4913-BAA8-A1F56F94B94D',
],
'problemStatus' => [
'title' => '故障状态 HANDLING 处理中 RECOVERED 已恢复 REPLAYING 复盘中 REPLAYED 已复盘 CANCEL 已取消',
'description' => '故障状态:'."\n"
.'- HANDLING:处理中。'."\n"
.'- RECOVERED:已恢复。'."\n"
.' - REPLAYING:复盘中。 '."\n"
.'- REPLAYED:已复盘。 '."\n"
.'- CANCEL:已取消。',
'type' => 'string',
'required' => false,
'example' => 'HANDLING',
],
'problemLevel' => [
'title' => '故障等级 1=P1 2=P2 3=P3 4=P4',
'description' => '故障等级递降:'."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'string',
'required' => false,
'example' => 'P2',
],
'progressSummary' => [
'title' => '进展摘要',
'description' => '进展摘要。',
'type' => 'string',
'required' => false,
'example' => '进展摘要',
],
'relatedServiceId' => [
'title' => '所属服务',
'description' => '服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123122',
],
'mainHandlerId' => [
'title' => '主要处理人',
'description' => '主要处理人。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '32121',
],
'preliminaryReason' => [
'title' => '初步原因',
'description' => '初步原因。',
'type' => 'string',
'required' => false,
'example' => '初步原因',
],
'discoverTime' => [
'title' => '发现时间 (XXXX-XX-XX 00:00:00)',
'description' => '发现时间。',
'type' => 'string',
'required' => false,
'example' => '2020-10-02 00:00:00',
],
'recoveryTime' => [
'title' => '恢复时间',
'description' => '恢复时间。',
'type' => 'string',
'required' => false,
'example' => '2020-10-02 00:00:00',
],
'affectServiceIds' => [
'title' => '影响服务列表',
'description' => '影响服务列表。',
'type' => 'array',
'items' => [
'description' => '影响服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1232231',
],
'required' => false,
],
'serviceGroupIds' => [
'title' => '应急协同组',
'description' => '应急协同组。',
'type' => 'array',
'items' => [
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '213121',
],
'required' => false,
],
'incidentId' => [
'title' => '事件id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123221',
],
'problemNotifyType' => [
'title' => '通告类型',
'description' => '通告类型。',
'type' => 'string',
'required' => false,
'example' => 'PROBLEM_NOTIFY',
],
'progressSummaryRichTextId' => [
'title' => '进展摘要富文本id',
'description' => '进展描述富文本ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '343',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'E789D869-DB13-4933-BAA8-A1F56F94B94D',
],
'data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障Id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '321331',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'IncidentNotExtisted',
'errorMessage' => 'The incident does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"E789D869-DB13-4933-BAA8-A1F56F94B94D\\",\\n \\"data\\": {\\n \\"problemId\\": 321331\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n E789D869-DB13-4933-BAA8-A1F56F94B94D\\n \\n 321331\\n \\n","errorExample":""}]',
'title' => '故障升级',
],
'CreateProblemMeasure' => [
'summary' => '创建故障改进措施。',
'path' => '/problem/improvement/measure/save',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempLC8226',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'type' => [
'title' => '措施类型',
'description' => '措施类型。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'problemId' => [
'title' => '故障Id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23',
],
'content' => [
'title' => '措施内容',
'description' => '措施内容。',
'type' => 'string',
'required' => false,
'example' => '措施内容',
],
'checkStandard' => [
'title' => '验收标准',
'description' => '验收标准。',
'type' => 'string',
'required' => false,
'example' => '标准',
],
'checkUserId' => [
'title' => '验收人id',
'description' => '验收人ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
'planFinishTime' => [
'title' => '计划完成时间',
'description' => '计划完成时间。',
'type' => 'string',
'required' => false,
'example' => '2020-01-23 00:00:00',
],
'directorId' => [
'title' => '负责人id',
'description' => '负责人ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
'stalkerId' => [
'title' => '跟踪人id',
'description' => '跟踪人ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
'status' => [
'title' => '状态 IMPROVED 改进 2 未改进UNIMPROVED',
'description' => '状态:'."\n"
.'- IMPROVED:改进。'."\n"
.'- UNIMPROVED:未改进。',
'type' => 'string',
'required' => false,
'example' => 'IMPROVED',
],
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等校验token。',
'type' => 'string',
'required' => false,
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'measureId' => [
'title' => '故障措施Id',
'description' => '故障措施ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1231',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\",\\n \\"data\\": {\\n \\"measureId\\": 1231\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4361a0e1-6747-4834-96ce-0c4840fd3812\\n \\n 1231\\n \\n","errorExample":""}]',
'title' => '创建故障改进措施',
],
'CreateProblemSubtotal' => [
'summary' => '故障新增备注小计。',
'path' => '/problem/save/subtotal',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempZB7ZAW',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障Id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1231',
],
'description' => [
'title' => '小计文本',
'description' => '小计文本。',
'type' => 'string',
'required' => false,
'example' => '描述',
],
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等校验token。',
'type' => 'string',
'required' => false,
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3814',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd381A',
],
'data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'subtotalId' => [
'title' => '小计id',
'description' => '小计ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd381A\\",\\n \\"data\\": {\\n \\"subtotalId\\": 123\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4361a0e1-6747-4834-96ce-0c4840fd381A\\n \\n 123\\n \\n","errorExample":""}]',
'title' => '故障新增备注小计',
],
'CreateProblemTimeline' => [
'summary' => '创建故障时间线节点。',
'path' => '/problem/process/timeline/create',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempZVI8H5',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障id',
'description' => '故障id',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '102',
],
'keyNode' => [
'title' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
'description' => '关键节点码表:PROBLEM_KEY_NODE',
'type' => 'string',
'required' => false,
'example' => 'PROBLEM_KEY_NODE',
],
'content' => [
'title' => '节点内容',
'description' => '节点内容',
'type' => 'string',
'required' => false,
'example' => '时间线内容XXXX',
],
'time' => [
'title' => '发生时间',
'description' => '发生时间',
'type' => 'string',
'required' => false,
'example' => '2021-06-06 12:11:22',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等标识',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'id of the request',
'description' => 'id of the request',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
'data' => [
'title' => 'Object',
'description' => 'data',
'type' => 'object',
'properties' => [
'problemTimelineId' => [
'title' => '故障事件线id',
'description' => '故障时间线id',
'type' => 'integer',
'format' => 'int64',
'example' => '102',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"problemTimelineId\\": 102\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 10REQUES-AC5C-4B59-BE11-378F117A6A88\\n \\n 102\\n \\n","errorExample":""}]',
'title' => '创建故障时间线节点',
],
'CreateProblemTimelines' => [
'summary' => '批量创建时间节点。',
'path' => '/problem/process/timeline/batchCreate',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempLC8226',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '423',
],
'timelineNodes' => [
'title' => '时间线节点',
'description' => '时间线节点。',
'type' => 'string',
'required' => false,
'example' => '2018-01-01 18:01,谁做了什么事情\\n2018-01-01 18:01,谁做了什么事情\\n2018-01-01 18:01,谁做了什么事情',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
'data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'problemTimelineIds' => [
'description' => '时间线ID列表。',
'type' => 'array',
'items' => [
'description' => '时间线ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '435',
],
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'TimelineFormatException',
'errorMessage' => 'The timeline format is invalid.',
],
[
'errorCode' => 'TimeFormatException',
'errorMessage' => 'The time format is invalid.',
],
],
[
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"problemTimelineIds\\": [\\n 435\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 435\\n \\n","errorExample":""}]',
'title' => '批量创建时间节点',
],
'AddProblemServiceGroup' => [
'summary' => '新增故障应急协同组。',
'path' => '/problem/addServiceGroup',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempZVI8H5',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障ID',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
'serviceGroupIds' => [
'title' => '应急协同组',
'description' => '应急协同组。',
'type' => 'array',
'items' => [
'description' => '应急协同组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '应急协同组ID',
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '5AD6E6BC-2582-4E0E-832D-52CB1B922253',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"5AD6E6BC-2582-4E0E-832D-52CB1B922253\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5AD6E6BC-2582-4E0E-832D-52CB1B922253\\n","errorExample":""}]',
'title' => '新增故障应急协同组',
],
'UpdateProblem' => [
'summary' => '更新故障详情。',
'path' => '/problem/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' => [
'FEATUREgempZVI8H5',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障ID',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '213432',
],
'problemName' => [
'title' => '故障名',
'description' => '故障名称。',
'type' => 'string',
'required' => false,
'example' => '故障2',
],
'level' => [
'title' => '故障等级',
'description' => '故障等级。',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
'relatedServiceId' => [
'title' => '所属服务',
'description' => '关联服务。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
'progressSummary' => [
'title' => '进展摘要',
'description' => '进展摘要。',
'type' => 'string',
'required' => false,
'example' => '进展摘要xxxx',
],
'preliminaryReason' => [
'title' => '初步原因',
'description' => '初步原因。',
'type' => 'string',
'required' => false,
'example' => '原因是服务宕机',
],
'mainHandlerId' => [
'title' => '主要处理人',
'description' => '主要处理人。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '678',
],
'feedback' => [
'title' => '舆情反馈',
'description' => '舆情反馈。',
'type' => 'string',
'required' => false,
'example' => '影响恶劣',
],
'serviceGroupIds' => [
'title' => '应急协同组',
'description' => '应急协同组。',
'type' => 'array',
'items' => [
'description' => '应急协同组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '102',
],
'required' => false,
],
'progressSummaryRichTextId' => [
'title' => '进展摘要富文本id',
'description' => '富文本字段ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '23232',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
],
],
],
],
'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":"\\n c26f36de-1ec8-496a-a828-880676c5ef81\\n","errorExample":""}]',
'title' => '更新故障详情',
'requestParamsDescription' => '{'."\n"
.' "problemId" : 213432,'."\n"
.' "problemName" : "故障2",'."\n"
.' "level" : "P1",'."\n"
.' "relatedServiceId" : 123,'."\n"
.' "progressSummary" : "进展摘要xxxx",'."\n"
.' "preliminaryReason" : "原因是服务宕机",'."\n"
.' "mainHandlerId" : 678,'."\n"
.' "feedback" : "影响恶劣",'."\n"
.' "serviceGroupIds" : [ 102 ]'."\n"
.'}',
'responseParamsDescription' => '{'."\n"
.' "requestId": "c26f36de-1ec8-496a-a828-880676c5ef81"'."\n"
.'}',
],
'UpdateProblemNotice' => [
'summary' => '更新故障通告。',
'path' => '/problem/notify',
'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' => [
'FEATUREgempLC8226',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemNotifyType' => [
'title' => '通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE: 故障补发 PROBLEM_CANCEL:故障取消',
'description' => '通告类型:'."\n"
."\n"
.'- PROBLEM_NOTIFY:故障通告。'."\n"
.'- PROBLEM_UPDATE:故障更新。'."\n"
.'- PROBLEM_UPGRADE:故障升级。'."\n"
.'- PROBLEM_DEGRADE:故障降级。'."\n"
.'- PROBLEM_RECOVER:故障恢复。'."\n"
.'- PROBLEM_REISSUE: 故障补发。'."\n"
.'- PROBLEM_CANCEL:故障取消。',
'type' => 'string',
'required' => false,
'example' => 'PROBLEM_NOTIFY',
],
'problemId' => [
'title' => '故障Id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1312',
],
'clientToken' => [
'title' => '幂等校验Id',
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4361a0e1-6747-4834-96ce-0c4840fd3812\\n","errorExample":""}]',
'title' => '更新故障通告',
],
'UpdateProblemTimeline' => [
'summary' => '更新故障时间线。',
'path' => '/problem/process/timeline/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' => [
'FEATUREgempZB7ZAW',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemTimelineId' => [
'title' => '时间节点id',
'description' => '时间线ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '3940',
],
'keyNode' => [
'title' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
'description' => '关键节点码表(PROBLEM_KEY_NODE)。',
'type' => 'string',
'required' => false,
'example' => 'NodeTest',
],
'content' => [
'title' => '节点内容',
'description' => '节点内容。',
'type' => 'string',
'required' => false,
'example' => '故障分析',
],
'time' => [
'title' => '发生时间',
'description' => '发生时间。',
'type' => 'string',
'required' => false,
'example' => '2021-01-08 10:10:10',
],
'problemId' => [
'title' => '故障id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '234',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemTimelineNotExisted',
'errorMessage' => 'The problem timeline does not exist.',
],
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"\\n c26f36de-1ec8-496a-a828-880676c5ef81\\n","errorExample":""}]',
'title' => '更新故障时间线',
],
'GenerateProblemPictureUploadSign' => [
'summary' => '故障图片上传获取签名信息。',
'path' => '/problem/process/oss/generatePostPolicy',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgemp4EPB1U',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'fileName' => [
'title' => '文件名',
'description' => '文件名。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'fileType' => [
'title' => '文件类型',
'description' => '文件类型。',
'type' => 'string',
'required' => false,
'example' => 'png',
],
'fileSize' => [
'title' => '文件大小KB',
'description' => '文件大小单位(KB)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1000',
],
'problemId' => [
'title' => '故障id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '67876',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd',
],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'bucketName' => [
'title' => 'oss bucket name',
'description' => 'OSS bucket 名称。',
'type' => 'string',
'example' => 'xxxx-xxxx-xxxx',
],
'key' => [
'title' => 'oss key',
'description' => 'OSS密钥。',
'type' => 'string',
'example' => 'problem/xxxxxxxxxxxxxxxx1-b3185d529277',
],
'policy' => [
'title' => 'policy',
'description' => '策略。',
'type' => 'string',
'example' => 'eyJleHBpcmF0a0p0IjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19',
],
'signature' => [
'title' => 'signature',
'description' => '签名。',
'type' => 'string',
'example' => 'SHqvIkwUNQd0o0rvklir2K8U+ts=',
],
'url' => [
'title' => 'url',
'description' => 'OSS链接。',
'type' => 'string',
'example' => 'https://xxx-xxx-bucket.oss-cn-shanghai.aliyuncs.com',
],
'accessKeyId' => [
'title' => 'ossaccessKeyId',
'description' => '访问密钥(AK) ID。',
'type' => 'string',
'example' => 'XXXXXXXH8GMy1iLRCno7',
],
],
],
],
],
],
],
'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":"\\n e2d4306a-bf4d-4345-9ae6-158223c85dbd\\n \\n xxxx-xxxx-xxxx\\n problem/xxxxxxxxxxxxxxxx1-b3185d529277\\n eyJleHBpcmF0a0p0IjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19\\n SHqvIkwUNQd0o0rvklir2K8U+ts=\\n https://xxx-xxx-bucket.oss-cn-shanghai.aliyuncs.com\\n XXXXXXXH8GMy1iLRCno7\\n \\n","errorExample":""}]',
'title' => '故障图片上传获取签名信息',
],
'ListProblemOperations' => [
'summary' => '故障动态列表。',
'path' => '/problem/operations',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等校验token。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'pageNumber' => [
'title' => '页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '行',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'totalCount' => [
'title' => '总数',
'description' => '总条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '132',
],
'pageNumber' => [
'title' => '页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'pageSize' => [
'title' => '行',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'data' => [
'title' => 'data',
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '故障列表。',
'type' => 'object',
'properties' => [
'title' => [
'title' => '动态标题',
'description' => '动态标题。',
'type' => 'string',
'example' => '动态标题',
],
'description' => [
'title' => '描述',
'description' => '描述。',
'type' => 'string',
'example' => '描述',
],
'relatedServiceName' => [
'title' => '服务名称',
'description' => '服务名称。',
'type' => 'string',
'example' => '服务名称',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-01-23 00:00:00',
],
'action' => [
'title' => '升级 PROBLEM_UPGRADE 撤销 PROBLEM_REVOKE 恢复 PROBLEM_RESTORE 复盘 PROBLEM_IN_REVIEW 完结 PROBLEM_REOPENED 取消 PROBLEM_CANCEL 更新故障通告 PROBLEM_UPDATE_NOTIFY 添加故障小计 PROBLEM_ADD_SUBTOTAL 更新故障 PROBLEM_UPDATE',
'description' => '- PROBLEM_UPGRADE:升级。'."\n"
.'- PROBLEM_REVOKE :撤销。'."\n"
.'- PROBLEM_RESTORE:恢复。 '."\n"
.'- PROBLEM_IN_REVIEW:复盘。'."\n"
.'- PROBLEM_REOPENED:完结。'."\n"
.'- PROBLEM_CANCEL:取消。'."\n"
.'- PROBLEM_UPDATE_NOTIFY:更新故障通告。 '."\n"
.'- PROBLEM_ADD_SUBTOTAL:添加故障小计。'."\n"
.'- PROBLEM_UPDATE:更新故障。',
'type' => 'string',
'example' => 'PROBLEM_CANCEL',
],
'problemId' => [
'title' => '故障Id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12312',
],
'problemName' => [
'title' => '故障名称',
'description' => '故障名称。',
'type' => 'string',
'example' => '这是一个故障',
],
'problemNumber' => [
'title' => '故障编号',
'description' => '故障编号。',
'type' => 'string',
'example' => 'P1231231',
],
'snapshotData' => [
'title' => '快照数据',
'description' => '快照数据。',
'type' => 'string',
'example' => '{“userName”:"小明"}',
],
],
],
],
],
],
],
],
'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":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n 132\\n 1\\n 10\\n \\n 动态标题\\n 描述\\n 服务名称\\n 2021-01-23 00:00:00\\n PROBLEM_CANCEL\\n 12312\\n 这是一个故障\\n \\n","errorExample":""}]',
'title' => '故障动态',
],
'ListProblems' => [
'summary' => '查询故障列表。',
'path' => '/problem/listProblems',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'queryType' => [
'title' => 'RESPONSIBLE 我负责的 PARTICIPATED 我参与的 ALL 全部',
'description' => '- RESPONSIBLE:我负责的。'."\n"
.'- PARTICIPATED:我参与的。'."\n"
.'- ALL:全部。',
'type' => 'string',
'required' => false,
'example' => 'RESPONSIBLE',
],
'problemStatus' => [
'title' => '故障状态 HANDLING 处理中 RECOVERED 已恢复 REPLAYING 复盘中 REPLAYED 已复盘 CANCEL 已取消',
'description' => '故障状态:'."\n"
."\n"
.'- HANDLING:处理中。'."\n"
.'- RECOVERED:已恢复。'."\n"
.'- REPLAYING:复盘中。 '."\n"
.'- REPLAYED:已复盘。 '."\n"
.'- CANCEL:已取消。',
'type' => 'string',
'required' => false,
'example' => 'HANDLING',
],
'problemLevel' => [
'title' => '故障等级 1=P1 2=P2 3=P3 4=P4',
'description' => '故障等级递降:'."\n"
."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'string',
'required' => false,
'example' => 'P2',
],
'affectServiceId' => [
'title' => '影响服务ID',
'description' => '影响服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'serviceGroupId' => [
'title' => '应急协同组',
'description' => '应急协同组。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'mainHandlerId' => [
'title' => '主要处理人',
'description' => '主要处理人。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'repeaterId' => [
'title' => '复盘负责人',
'description' => '复盘负责人。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'discoveryStartTime' => [
'title' => '发现开始时间',
'description' => '发现开始时间。',
'type' => 'string',
'required' => false,
'example' => '2020-03-05 15:50:59',
],
'discoveryEndTime' => [
'title' => '发现结束时间',
'description' => '发现结束时间。',
'type' => 'string',
'required' => false,
'example' => '2020-03-05 15:50:59',
],
'restoreEndTime' => [
'title' => '恢复结束时间',
'description' => '恢复结束时间。',
'type' => 'string',
'required' => false,
'example' => '2020-03-05 15:50:59',
],
'restoreStartTime' => [
'title' => '恢复开始时间',
'description' => '恢复开始时间。',
'type' => 'string',
'required' => false,
'example' => '2020-03-05 15:50:59',
],
'pageNumber' => [
'title' => '当前页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '页大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等校验token。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'description' => '故障列表。',
'type' => 'array',
'items' => [
'description' => '故障列表。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'isManual' => [
'title' => '是否手动',
'description' => '是否手动。',
'type' => 'boolean',
'example' => 'true',
],
'isUpgrade' => [
'title' => '是否升级',
'description' => '是否升级。',
'type' => 'boolean',
'example' => 'true',
],
'incidentId' => [
'title' => '事件ID',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '10000',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-09-08 15:59:59',
],
'updateTime' => [
'title' => '修改时间',
'description' => '修改时间。',
'type' => 'string',
'example' => '2020-09-08 15:59:59',
],
'problemNumber' => [
'title' => '故障编号',
'description' => '故障编号。',
'type' => 'string',
'example' => 'P34438300000001116258132229577472',
],
'problemName' => [
'title' => '故障名称',
'description' => '故障名称。',
'type' => 'string',
'example' => '故障',
],
'problemStatus' => [
'title' => '故障状态 HANDLING 处理中 RECOVERED 已恢复 REPLAYING 复盘中 REPLAYED 已复盘 CANCEL 已取消',
'description' => '故障状态:'."\n"
."\n"
.'- HANDLING:处理中。 '."\n"
.'- RECOVERED:已恢复。 '."\n"
.'- REPLAYING:复盘中。 '."\n"
.'- REPLAYED:已复盘。'."\n"
.'- CANCEL:已取消。',
'type' => 'string',
'example' => 'HANDLING',
],
'problemLevel' => [
'title' => '故障等级 1=P1 2=P2 3=P3 4=P4',
'description' => '故障等级递降:'."\n"
."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'string',
'example' => 'P1',
],
'discoverTime' => [
'title' => '发现时间',
'description' => '发现时间。',
'type' => 'string',
'example' => '2020-09-08 15:59:59',
],
'recoveryTime' => [
'title' => '恢复时间',
'description' => '恢复时间。',
'type' => 'string',
'example' => '2020-09-08 15:59:59',
],
'relatedServiceId' => [
'title' => '关联服务ID',
'description' => '关联服务ID。',
'type' => 'string',
'example' => '1',
],
'serviceName' => [
'title' => '关联服务名称',
'description' => '关联服务名称。',
'type' => 'string',
'example' => '服务1',
],
'affectServices' => [
'description' => '影响服务。',
'type' => 'array',
'items' => [
'description' => '影响服务。',
'type' => 'object',
'properties' => [
'serviceId' => [
'title' => '影响服务ID',
'description' => '影响服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'serviceDescription' => [
'title' => '服务描述',
'description' => '服务描述。',
'type' => 'string',
'example' => '服务描述',
],
'serviceName' => [
'title' => '服务名字',
'description' => '服务名字。',
'type' => 'string',
'example' => '冲上云霄',
],
'updateTime' => [
'title' => '修改时间',
'description' => '修改时间。',
'type' => 'string',
'example' => '2020-09-08 15:59:59',
],
],
],
],
'mainHandlerId' => [
'title' => '主要处理人ID',
'description' => '主要处理人ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'mainHandlerName' => [
'title' => '主要处理人名称',
'description' => '主要处理人名称。',
'type' => 'string',
'example' => '王宇',
],
'cancelTime' => [
'title' => '取消时间',
'description' => '取消时间。',
'type' => 'string',
'example' => '2020-09-08 15:59:59',
],
'finishTime' => [
'title' => '完结时间',
'description' => '完结时间。',
'type' => 'string',
'example' => '2020-09-08 15:59:59',
],
'replayTime' => [
'title' => '复盘时间',
'description' => '复盘时间。',
'type' => 'string',
'example' => '2020-09-08 15:59:59',
],
'serviceDeletedType' => [
'title' => '服务删除字段',
'description' => '服务删除字段。',
'type' => 'integer',
'format' => 'int32',
],
'mainHandlerIsValid' => [
'description' => '主要处理人ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
'pageNumber' => [
'title' => '当前页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'pageSize' => [
'title' => '页大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'totalCount' => [
'title' => '总条数',
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
'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":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n \\n 1\\n true\\n true\\n 10000\\n 2020-09-08 15:59:59\\n 2020-09-08 15:59:59\\n P34438300000001116258132229577472\\n 故障\\n HANDLING\\n P1\\n 2020-09-08 15:59:59\\n 2020-09-08 15:59:59\\n 1\\n 服务1\\n \\n 100\\n 服务描述\\n 冲上云霄\\n 2020-09-08 15:59:59\\n \\n 100\\n 王宇\\n 2020-09-08 15:59:59\\n 2020-09-08 15:59:59\\n 2020-09-08 15:59:59\\n \\n 1\\n 10\\n 100\\n","errorExample":""}]',
'title' => '查询故障列表',
],
'ListProblemSubtotals' => [
'summary' => '故障小计列表。',
'path' => '/problem/list/subtotal',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障Id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1231',
],
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等校验token。',
'type' => 'string',
'required' => false,
'example' => '4361a0e1-6747-4834-96ce-0c4840fdB812',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '4361a0e1-6747-4834-96ce-0S4840fd3812',
],
'data' => [
'description' => '响应数据。',
'type' => 'array',
'items' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'description' => [
'title' => '描述',
'description' => '描述。',
'type' => 'string',
'example' => '小计内容',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-10-02 00:00:00',
],
'createRamName' => [
'title' => '操作人',
'description' => '操作人。',
'type' => 'string',
'example' => '小明',
],
'createUserPhone' => [
'title' => '操作人手机号',
'description' => '操作人手机号。',
'type' => 'string',
'example' => '130****1111',
],
'createUserId' => [
'title' => '人员id',
'description' => '人员ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '123123',
],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'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":"\\n 4361a0e1-6747-4834-96ce-0S4840fd3812\\n \\n 小计内容\\n 2020-10-02 00:00:00\\n 小明\\n 130****11111\\n \\n","errorExample":""}]',
'title' => '故障小计列表',
],
'CancelProblem' => [
'summary' => '故障取消。',
'path' => '/problem/cancel',
'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' => [
'FEATUREgempWLQJXL',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '312',
],
'cancelReasonDescription' => [
'title' => '取消原因描述',
'description' => '取消原因描述。',
'type' => 'string',
'required' => false,
'example' => '原因描述',
],
'cancelReason' => [
'title' => '取消原因',
'description' => '取消原因。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '取消原因',
],
'problemNotifyType' => [
'title' => 'PROBLEM_NOTIFY 通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE: 故障补发 PROBLEM_CANCEL:故障取消',
'description' => '- PROBLEM_NOTIFY 通告类型。'."\n"
.'- PROBLEM_NOTIFY:故障通告。'."\n"
.'- PROBLEM_UPDATE:故障更新。'."\n"
.'- PROBLEM_UPGRADE:故障升级。'."\n"
.'- PROBLEM_DEGRADE:故障降级。'."\n"
.'- PROBLEM_RECOVER:故障恢复。'."\n"
.'- PROBLEM_REISSUE: 故障补发。 '."\n"
.'- PROBLEM_CANCEL:故障取消。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => 'PROBLEM_NOTIFY',
],
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等Token。',
'type' => 'string',
'required' => false,
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'B81E84B5-8FD1-45F3-969A-B5067AADCFFF',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ProblemStatusError',
'errorMessage' => 'The problem status is abnormal.',
],
],
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"B81E84B5-8FD1-45F3-969A-B5067AADCFFF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B81E84B5-8FD1-45F3-969A-B5067AADCFFF\\n","errorExample":""}]',
'title' => '故障取消',
],
'FinishProblem' => [
'summary' => '故障完结。',
'path' => '/problem/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' => [
'FEATUREgempZB7ZAW',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body参数。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障Id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '3123',
],
'clientToken' => [
'title' => '幂等校验',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => '6338F42D-ED0B-442C-932C-657300AFB4BB',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '6338F42D-ED0B-442C-932C-657300AFB4BB',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ProblemStatusError',
'errorMessage' => 'The problem status is abnormal.',
],
],
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"6338F42D-ED0B-442C-932C-657300AFB4BB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 6338F42D-ED0B-442C-932C-657300AFB4BB\\n","errorExample":""}]',
'title' => '故障完结',
],
'RecoverProblem' => [
'summary' => '故障恢复。',
'path' => '/problem/recovery',
'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' => [
'FEATUREgempZB7ZAW',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障ID',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
'recoveryTime' => [
'title' => '恢复时间',
'description' => '恢复时间。',
'type' => 'string',
'required' => false,
'example' => '2020-02-01 00:00:00',
],
'problemNotifyType' => [
'title' => '通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE: 故障补发 PROBLEM_CANCEL:故障取消',
'description' => '通告类型 '."\n"
."\n"
.'- PROBLEM_NOTIFY:故障通告。'."\n"
.'- PROBLEM_UPDATE:故障更新。'."\n"
.'- PROBLEM_UPGRADE:故障升级。'."\n"
.'- PROBLEM_DEGRADE:故障降级。'."\n"
.'- PROBLEM_RECOVER:故障恢复。'."\n"
.'- PROBLEM_REISSUE: 故障补发。'."\n"
.'- PROBLEM_CANCEL:故障取消。',
'type' => 'string',
'required' => false,
'example' => 'PROBLEM_UPDATE',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'EBC39DEF-C95B-46F8-9AE3-204F0B0A706D',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ProblemStatusError',
'errorMessage' => 'The problem status is abnormal.',
],
],
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"EBC39DEF-C95B-46F8-9AE3-204F0B0A706D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EBC39DEF-C95B-46F8-9AE3-204F0B0A706D\\n","errorExample":""}]',
'title' => '故障恢复',
],
'ReplayProblem' => [
'summary' => '故障复盘。',
'path' => '/problem/replay',
'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' => [
'FEATUREgempZB7ZAW',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障ID',
'description' => '故障ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
'replayDutyUserId' => [
'title' => '复盘负责人ID',
'description' => '复盘负责人ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '3123',
],
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等token',
'type' => 'string',
'required' => false,
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3212',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'B81E84B5-8FD1-45F3-969A-B5067AADCFFF',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ProblemStatusError',
'errorMessage' => 'The problem status is abnormal.',
],
],
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"B81E84B5-8FD1-45F3-969A-B5067AADCFFF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B81E84B5-8FD1-45F3-969A-B5067AADCFFF\\n","errorExample":""}]',
'title' => '故障复盘',
],
'RevokeProblemRecovery' => [
'summary' => '故障撤销恢复 。',
'path' => '/problem/revoke',
'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' => [
'FEATUREgempLC8226',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障ID',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1231',
],
'problemNotifyType' => [
'title' => '通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE: 故障补发 PROBLEM_CANCEL:故障取消',
'description' => '通告类型:'."\n"
."\n"
.'- PROBLEM_NOTIFY:故障通告。'."\n"
.'- PROBLEM_UPDATE:故障更新。'."\n"
.'- PROBLEM_UPGRADE:故障升级。'."\n"
.'- PROBLEM_DEGRADE:故障降级。'."\n"
.'- PROBLEM_RECOVER:故障恢复。'."\n"
.'- PROBLEM_REISSUE: 故障补发。'."\n"
.'- PROBLEM_CANCEL:故障取消。',
'type' => 'string',
'required' => false,
'example' => 'PROBLEM_UPGRADE',
],
'clientToken' => [
'title' => '幂等校验Id',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2EF',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ProblemStatusError',
'errorMessage' => 'The problem status is abnormal.',
],
],
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n","errorExample":""}]',
'title' => '故障撤销恢复',
],
'GenerateProblemPictureLink' => [
'summary' => '获取故障图片链接。',
'path' => '/problem/process/oss/getPresignedLink',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempZB7ZAW',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'keys' => [
'title' => 'oss key',
'description' => 'OSS密钥。',
'type' => 'array',
'items' => [
'description' => '密钥。',
'type' => 'string',
'required' => false,
'example' => 'problem/38b2a7893-484d-8989-b9cf-d243e53a82c6',
],
'required' => false,
],
'problemId' => [
'title' => '故障id',
'description' => '故障ID。',
'type' => 'string',
'required' => false,
'example' => '50002021',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => 'c26f36de-1ec8-496a-a828-88067879ef81',
],
'data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'links' => [
'title' => '图片链接列表',
'description' => '图片链接列表。',
'type' => 'array',
'items' => [
'description' => '链接。',
'type' => 'object',
'properties' => [
'key' => [
'title' => 'oss key',
'description' => 'OSS密钥。',
'type' => 'string',
'example' => 'problem/xxxxxxxxxx-484d-4242-b9cf-xxxxxxxxxx',
],
'link' => [
'title' => '图片链接',
'description' => '图片链接。',
'type' => 'string',
'example' => 'http://xxxx-xxxx-bucket.oss-cn-xxxx.aliyuncs.com/pxxxx/38xxxxd-4789-4242-b9cfxxxxxxxxc6?Expires=1xxxxxxxxxx7&OSSAccessKeyId=xxxxxxxxxxxxxx7&Signature=xxxxxxxxxxxxxxxxxxxxxx',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'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":"\\n c26f36de-1ec8-496a-a828-88067879ef81\\n \\n \\n problem/xxxxxxxxxx-484d-4242-b9cf-xxxxxxxxxx\\n http://xxxx-xxxx-bucket.oss-cn-xxxx.aliyuncs.com/pxxxx/38xxxxd-4789-4242-b9cfxxxxxxxxc6?Expires=1xxxxxxxxxx7&OSSAccessKeyId=xxxxxxxxxxxxxx7&Signature=xxxxxxxxxxxxxxxxxxxxxx\\n \\n \\n","errorExample":""}]',
'title' => '获取故障图片链接',
],
'UpdateProblemEffectionService' => [
'summary' => '更新故障影响服务。',
'path' => '/problem/process/effectionService/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' => [
'FEATUREgempZB7ZAW',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body参数。',
'type' => 'object',
'properties' => [
'serviceId' => [
'title' => '关联服务id',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '33',
],
'level' => [
'title' => '影响等级',
'description' => '影响等级递降:'."\n"
."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
'status' => [
'title' => '影响状态 UN_RECOVERED 未恢复 RECOVERED已恢复',
'description' => '影响状态:'."\n"
.'- 0:未恢复。'."\n"
.'- 1:已恢复。',
'type' => 'string',
'required' => false,
'example' => '·',
],
'description' => [
'title' => '影响描述',
'description' => '影响描述。',
'type' => 'string',
'required' => false,
'example' => 'xxxx大厦',
],
'picUrl' => [
'title' => '图片地址',
'description' => '图片地址。',
'type' => 'array',
'items' => [
'description' => '图片key。',
'type' => 'string',
'required' => false,
'example' => 'problem/xxxxxxxx-a2c8-40b9-9162-08a6c2e338e2',
],
'required' => false,
],
'problemId' => [
'title' => '故障id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '190000000',
],
'effectionServiceId' => [
'title' => '影响服务id',
'description' => '影响服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '103',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => 'ffbf594-e093-46ad-bdcd-df4d7097125a',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"ffbf594-e093-46ad-bdcd-df4d7097125a\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ffbf594-e093-46ad-bdcd-df4d7097125a\\n","errorExample":""}]',
'title' => '更新故障影响服务',
],
'DeleteProblemEffectionService' => [
'summary' => '删除影响服务。',
'path' => '/problem/process/effectionService/delete',
'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' => [
'FEATUREgempIOV4BX',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'effectionServiceId' => [
'title' => '影响服务ID',
'description' => '影响服务ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '567',
],
'problemId' => [
'title' => '故障id',
'description' => '故障id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '876',
],
'clientToken' => [
'title' => 'clientToken',
'description' => 'clientToken',
'type' => 'string',
'required' => false,
'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"e0b6735e-1a04-4d6b-a625-d2350612492c\\"\\n}","errorExample":""},{"type":"xml","example":"\\n e0b6735e-1a04-4d6b-a625-d2350612492c\\n","errorExample":""}]',
'title' => '删除影响服务',
],
'UpdateProblemMeasure' => [
'summary' => '更新故障改进措施。',
'path' => '/problem/improvement/measure/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' => [
'FEATUREgempZVI8H5',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'type' => [
'title' => '措施类型 码表 PROBLEM_REPLAY_IMPROVEMENT',
'description' => '措施类型码表:(PROBLEM_REPLAY_IMPROVEMENT)。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3',
],
'content' => [
'title' => '措施内容',
'description' => '措施内容。',
'type' => 'string',
'required' => false,
'example' => '措施内容',
],
'checkStandard' => [
'title' => '验收标准',
'description' => '验收标准。',
'type' => 'string',
'required' => false,
'example' => '2',
],
'checkUserId' => [
'title' => '验收人id',
'description' => '验收人ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
'directorId' => [
'title' => '负责人id',
'description' => '负责人ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
'stalkerId' => [
'title' => '跟踪人id',
'description' => '跟踪人ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
'planFinishTime' => [
'title' => '计划完成时间',
'description' => '计划完成时间。',
'type' => 'string',
'required' => false,
'example' => '2021-01-21 00:00:00',
],
'measureId' => [
'title' => '措施Id',
'description' => '措施ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1231',
],
'status' => [
'title' => '状态 IMPROVED 改进 2 未改进UNIMPROVED',
'description' => '状态:'."\n"
."\n"
.'- IMPROVED:改进。'."\n"
.'- UNIMPROVED:未改进。',
'type' => 'string',
'required' => false,
'example' => 'UNIMPROVED',
],
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等校验token。',
'type' => 'string',
'required' => false,
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
'problemId' => [
'title' => '故障Id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1233',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
[
'errorCode' => 'ProblemMeasureNotExisted',
'errorMessage' => 'The problem measure does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4361a0e1-6747-4834-96ce-0c4840fd3812\\n","errorExample":""}]',
'title' => '更新故障改进措施',
],
'DeleteProblem' => [
'summary' => '删除故障。',
'path' => '/problem/delete',
'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' => [
'FEATUREgempZVI8H5',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障Id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1231',
],
'clientToken' => [
'title' => '幂等校验',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4361a0e1-6747-4834-96ce-0c4840fd3812\\n","errorExample":""}]',
'title' => '删除故障',
],
'GetProblem' => [
'summary' => '故障详情。',
'path' => '/problem/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' => [
'FEATUREgempUCUJK5',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障ID',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
'clientToken' => [
'title' => '幂等号',
'description' => '幂等校验。',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'data' => [
'title' => '详情',
'description' => '详情。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => 'ID',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
'enum' => [
'Success',
'Fail',
'Cancel',
],
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2010-03-09 15:53:45',
],
'incidentNumber' => [
'title' => '事件编号',
'description' => '事件编号。',
'type' => 'string',
'example' => 'I3443835000012016260833157948165',
],
'incidentId' => [
'title' => '事件id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '130000032',
],
'problemNumber' => [
'title' => '故障编号',
'description' => '故障编号。',
'type' => 'string',
'example' => 'P34438300010030116260833538987481',
],
'problemName' => [
'title' => '故障名称',
'description' => '故障名称。',
'type' => 'string',
'example' => '故障',
],
'problemStatus' => [
'title' => '故障状态 HANDLING 处理中 RECOVERED 已恢复 REPLAYING 复盘中 REPLAYED 已复盘 CANCEL 已取消',
'description' => '故障状态 :'."\n"
.'- HANDLING:处理中。 '."\n"
.'- RECOVERED:已恢复。'."\n"
.'- REPLAYING:复盘中。'."\n"
.'- REPLAYED:已复盘。'."\n"
.'- CANCEL:已取消。',
'type' => 'integer',
'format' => 'int32',
'example' => 'HANDLING',
],
'problemLevel' => [
'title' => '故障等级 P1 P2 P3 P4',
'description' => '故障等级递降:'."\n"
."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'integer',
'format' => 'int32',
'example' => 'P1',
],
'discoverTime' => [
'title' => '发现时间',
'description' => '发现时间。',
'type' => 'string',
'example' => '2010-03-09 15:53:45',
],
'recoveryTime' => [
'title' => '恢复时间',
'description' => '恢复时间。',
'type' => 'string',
'example' => '2010-03-09 15:53:45',
],
'relatedServiceId' => [
'title' => '关联服务ID',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'serviceName' => [
'title' => '关联服务 名称',
'description' => '关联服务名称。',
'type' => 'string',
'example' => '服务',
],
'progressSummary' => [
'title' => '进展摘要',
'description' => '进展摘要。',
'type' => 'string',
'example' => '进展摘要',
],
'preliminaryReason' => [
'title' => '初步原因',
'description' => '初步原因。',
'type' => 'string',
'example' => '初步原因',
],
'mainHandler' => [
'title' => '主要处理人',
'description' => '主要处理人。',
'type' => 'integer',
'format' => 'int64',
'example' => '小王',
],
'mainHandlerId' => [
'title' => '主要处理人ID',
'description' => '主要处理人ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '2000',
],
'mainHandlerPhone' => [
'title' => '主要处理人手机号',
'description' => '主要处理人手机号。',
'type' => 'string',
'example' => '1308987****',
],
'feedback' => [
'title' => '舆情反馈',
'description' => '舆情反馈。',
'type' => 'string',
'example' => 'feedback',
],
'cancelReasonDescription' => [
'title' => '取消原因描述',
'description' => '取消原因描述。',
'type' => 'string',
'example' => '取消原因描述',
],
'cancelReason' => [
'title' => '取消原因',
'description' => '取消原因。',
'type' => 'integer',
'format' => 'int64',
'example' => '37',
],
'durationTime' => [
'title' => '持续时间',
'description' => '持续时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '300000',
],
'progressSummaryRichTextId' => [
'title' => '进展摘要富文本id',
'description' => '进展摘要富文本ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1231231',
],
'handingProblemOperateLogs' => [
'title' => '处理中故障操作日志',
'description' => '处理中故障操作日志。',
'type' => 'array',
'items' => [
'description' => '处理中故障操作日志。',
'type' => 'object',
'properties' => [
'operator' => [
'title' => '操作人',
'description' => '操作人。',
'type' => 'string',
'example' => '小王',
],
'userId' => [
'title' => '用户id',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '233',
],
'actionName' => [
'title' => '动作名称',
'description' => '动作名称。',
'type' => 'string',
'example' => '取消故障',
],
'actionTime' => [
'title' => '操作时间',
'description' => '操作名称。',
'type' => 'string',
'example' => '2010-03-09 15:53:45',
],
'userIsValid' => [
'description' => '用户是否合法。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
'restoredProblemOperateLogs' => [
'title' => '已恢复故障操作日志',
'description' => '已恢复故障操作日志。',
'type' => 'array',
'items' => [
'description' => '已恢复故障操作日志。',
'type' => 'object',
'properties' => [
'operator' => [
'title' => '操作人',
'description' => '操作人。',
'type' => 'string',
'example' => '小王',
],
'userId' => [
'title' => '用户id',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '3232',
],
'actionName' => [
'title' => '动作名称',
'description' => '动作名称。',
'type' => 'string',
'example' => '恢复故障',
],
'actionTime' => [
'title' => '操作时间',
'description' => '操作名称。',
'type' => 'string',
'example' => '2020-08-08 15:39:39',
],
'userIsValid' => [
'description' => '用户是否合法。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
'replayingProblemOperateLogs' => [
'title' => '复盘中故障操作日志',
'description' => '复盘中故障操作日志。',
'type' => 'array',
'items' => [
'description' => '复盘中故障操作日志。',
'type' => 'object',
'properties' => [
'operator' => [
'title' => '操作人',
'description' => '操作人。',
'type' => 'string',
'example' => '小杰',
],
'userId' => [
'title' => '用户id',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '用户id',
],
'actionName' => [
'title' => '动作名称',
'description' => '动作名称。',
'type' => 'string',
'example' => '复盘故障',
],
'actionTime' => [
'title' => '操作时间',
'description' => '操作名称。',
'type' => 'string',
'example' => '2020-08-08 15:39:39',
],
'userIsValid' => [
'description' => '用户是否合法。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
'replayProblemOperateLogs' => [
'title' => '已复盘故障操作日志',
'description' => '已复盘故障操作日志。',
'type' => 'array',
'items' => [
'description' => '已复盘故障操作日志。',
'type' => 'object',
'properties' => [
'operator' => [
'title' => '操作人',
'description' => '操作人。',
'type' => 'string',
'example' => '小王',
],
'userId' => [
'title' => '用户id',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '2323',
],
'actionName' => [
'title' => '动作名称',
'description' => '动作名称。',
'type' => 'string',
'example' => '复盘故障',
],
'actionTime' => [
'title' => '操作时间',
'description' => '操作名称。',
'type' => 'string',
'example' => '2020-08-08 15:39:39',
],
'userIsValid' => [
'description' => '用户是否合法。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
'effectionServices' => [
'title' => '影响服务',
'description' => '影响服务。',
'type' => 'array',
'items' => [
'description' => '影响服务。',
'type' => 'object',
'properties' => [
'effectionServiceId' => [
'title' => '服务ID',
'description' => '服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'effectionLevel' => [
'title' => '影响等级 P1 . P2 P3 P4',
'description' => '影响等级递降:'."\n"
."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'integer',
'format' => 'int64',
'example' => 'P1',
],
'effectionStatus' => [
'title' => '影响服务状态 RECOVERED 已经恢复 ,UN_RECOVERED 未恢复',
'description' => '影响服务状态:'."\n"
."\n"
.'- RECOVERED:已经恢复。'."\n"
.'- UN_RECOVERED:未恢复。',
'type' => 'integer',
'format' => 'int32',
'example' => 'RESTORED',
],
'description' => [
'title' => '影响描述',
'description' => '影响描述。',
'type' => 'string',
'example' => '描述',
],
'serviceName' => [
'title' => '服务名称',
'description' => '服务名称。',
'type' => 'string',
'example' => '购物车',
],
'serviceDeleteType' => [
'title' => '服务删除字段 1正常 0删除',
'description' => '服务删除字段:'."\n"
.'- 1:正常。'."\n"
.'- 0:删除。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'coordinationGroups' => [
'title' => '应急协同组',
'description' => '应急协同组。',
'type' => 'array',
'items' => [
'description' => '应急协同组。',
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'title' => '服务组ID',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'serviceGroupName' => [
'title' => '服务组名字',
'description' => '服务组名字。',
'type' => 'string',
'example' => '冲上云霄',
],
'isValid' => [
'description' => '是否合法。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
'timelines' => [
'title' => '故障操作时间线',
'description' => '故障操作时间线。',
'type' => 'array',
'items' => [
'description' => '故障操作时间线。',
'type' => 'object',
'properties' => [
'keyNode' => [
'title' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
'description' => '关键节点码表(PROBLEM_KEY_NODE)。',
'type' => 'string',
'example' => '1,2,3,4,5,7,6,8,9,10',
],
],
],
],
'cancelProblemOperateLogs' => [
'title' => '已取消故障操作日志',
'description' => '已取消故障操作日志。',
'type' => 'array',
'items' => [
'description' => '已取消故障操作日志。',
'type' => 'object',
'properties' => [
'operator' => [
'title' => '操作人',
'description' => '操作人。',
'type' => 'string',
'example' => '小王',
],
'actionName' => [
'title' => '动作名称',
'description' => '动作名称。',
'type' => 'string',
'example' => '取消故障',
],
'actionTime' => [
'title' => '操作时间',
'description' => '操作时间。',
'type' => 'string',
'example' => '2020-09-08 15:38:38',
],
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '66666',
],
],
],
],
'serviceDeleteType' => [
'title' => 'serviceDeleteType',
'description' => '服务删除类型:'."\n"
."\n"
.'- 1:手动删除。'."\n"
.'- 2:自动删除。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'mainHandlerIsValid' => [
'title' => '主要处理人生效状态,1生效,0失效',
'description' => '主要处理人生效状态:'."\n"
.'- 0:失效。'."\n"
.'- 1:生效。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'isRuleTrigger' => [
'title' => '是否规则触发 1 是 0不是',
'description' => '是否规则触发:'."\n"
.'- 0:不是。'."\n"
.'- 1:是。',
'type' => 'boolean',
'example' => '1',
],
],
],
'requestId' => [
'title' => '请求ID',
'description' => '请求ID。',
'type' => 'string',
'example' => 'C4BE3837-1A13-41VB-A225-2C88188E8A43',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'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":"\\n \\n 1\\n 2010-03-09 15:53:45\\n I3443835000012016260833157948165\\n 130000032\\n P34438300010030116260833538987481\\n 故障\\n 2010-03-09 15:53:45\\n 2010-03-09 15:53:45\\n 1\\n 服务\\n 进展摘要\\n 初步原因\\n 2000\\n feedback\\n 取消原因描述\\n \\n 小王\\n 取消故障\\n 2010-03-09 15:53:45\\n \\n \\n 小王\\n 恢复故障\\n 2020-08-08 15:39:39\\n \\n \\n 小杰\\n 复盘故障\\n 2020-08-08 15:39:39\\n \\n \\n 小王\\n 复盘故障\\n 2020-08-08 15:39:39\\n \\n \\n 1\\n 描述\\n 购物车\\n \\n \\n 1\\n 冲上云霄\\n \\n \\n 1,2,3,4,5,7,6,8,9,10\\n \\n \\n 小王\\n 取消故障\\n 2020-09-08 15:38:38\\n \\n \\n C4BE3837-1A13-41VB-A225-2C88188E8A43\\n","errorExample":""}]',
'title' => '故障详情',
],
'GetProblemImprovement' => [
'summary' => '故障复盘改进详情 。',
'path' => '/problem/improvement/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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障ID',
'description' => '故障ID。',
'type' => 'string',
'required' => false,
'example' => '312312',
],
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等校验token。',
'type' => 'string',
'required' => false,
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3811',
],
'data' => [
'description' => '故障影响记录。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障ID',
'description' => '故障ID。',
'type' => 'string',
'example' => '231231',
],
'problemReason' => [
'title' => '故障原因',
'description' => '故障原因。',
'type' => 'string',
'example' => '故障的原因',
],
'recentActivity' => [
'title' => '最近活动 码表:PROBLEM_RECENT_ACTIVITY',
'description' => '最近活动码表(PROBLEM_RECENT_ACTIVITY)。',
'type' => 'string',
'example' => '2',
],
'injectionMode' => [
'title' => '注入方式 码表:PROBLEM_INJECTION_MODE',
'description' => '注入方式码表(PROBLEM_INJECTION_MODE)。',
'type' => 'string',
'example' => '3',
],
'recoveryMode' => [
'title' => '恢复方式 码表:PROBLEM_RECOVERY_MODE',
'description' => '恢复方式码表:(PROBLEM_RECOVERY_MODE)。',
'type' => 'string',
'example' => '2',
],
'discoverSource' => [
'title' => '发现来源 码表:PROBLEM_DISCOVER_SOURCE',
'description' => '发现来源码表:(PROBLEM_DISCOVER_SOURCE)。',
'type' => 'string',
'example' => '1',
],
'userReport' => [
'title' => '用户上报 码表:PROBLEM_USER_REPORT',
'description' => '用户上报码表:(PROBLEM_USER_REPORT)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'monitorSourceName' => [
'title' => '监控源',
'description' => '监控源名称。',
'type' => 'string',
'example' => 'Zabbix',
],
'relationChanges' => [
'title' => '关联变更',
'description' => '关联变更。',
'type' => 'string',
'example' => '关联变更',
],
'dutyUserId' => [
'title' => '故障责任人id',
'description' => '故障责任人ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '231',
],
'replayDutyUserId' => [
'title' => '复盘负责人id',
'description' => '复盘负责人ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '23123',
],
'replayDutyUserPhone' => [
'title' => '复盘负责人手机号',
'description' => '复盘负责人手机号。',
'type' => 'string',
'example' => '1308787****',
],
'dutyDepartmentId' => [
'title' => '故障责任部门',
'description' => '故障责任部门。',
'type' => 'string',
'example' => '12312',
],
'dutyUserName' => [
'title' => '故障责任人名称',
'description' => '故障责任人名称。',
'type' => 'string',
'example' => '小明',
],
'dutyUserPhone' => [
'title' => '故障责任人手机号',
'description' => '故障责任人手机号。',
'type' => 'string',
'example' => '13098898****',
],
'replayDutyUserName' => [
'title' => '复盘负责人名称',
'description' => '复盘负责人名称。',
'type' => 'string',
'example' => '小花',
],
'remark' => [
'title' => '备注',
'description' => '备注。',
'type' => 'string',
'example' => '备注',
],
'isManual' => [
'title' => '是否手动',
'description' => '是否手动。',
'type' => 'boolean',
'example' => 'true',
],
'dutyDepartmentName' => [
'title' => '故障责任部门名称',
'description' => '故障责任部门名称。',
'type' => 'string',
'example' => '服务组B',
],
'measureList' => [
'title' => '改进措施列表',
'description' => '改进措施列表。',
'type' => 'array',
'items' => [
'description' => '改进措施列表。',
'type' => 'object',
'properties' => [
'measureId' => [
'title' => '改进措施id 用于删除或更新',
'description' => '改进措施ID用于删除或更新。',
'type' => 'integer',
'format' => 'int64',
'example' => '12312',
],
'type' => [
'title' => '措施类型',
'description' => '措施类型码表(PROBLEM_REPLAY_IMPROVEMENT)。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'content' => [
'title' => '措施内容',
'description' => '措施内容。',
'type' => 'string',
'example' => '内容A',
],
'checkStandard' => [
'title' => '验收标准',
'description' => '验收标准。',
'type' => 'string',
'example' => '验收标准A',
],
'checkUserId' => [
'title' => '验收人id',
'description' => '验收人ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
'checkUserName' => [
'title' => '验收人名称',
'description' => '验收人名称。',
'type' => 'string',
'example' => '小军',
],
'directorName' => [
'title' => '负责人名称',
'description' => '负责人名称。',
'type' => 'string',
'example' => '小张',
],
'stalkerName' => [
'title' => '跟踪人名称',
'description' => '跟踪人名称。',
'type' => 'string',
'example' => '小李',
],
'planFinishTime' => [
'title' => '计划完成时间',
'description' => '计划完成时间。',
'type' => 'string',
'example' => '2021-05-01 00:00:00',
],
'directorId' => [
'title' => '负责人id',
'description' => '负责人ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '212',
],
'stalkerId' => [
'title' => '跟踪人id',
'description' => '跟踪人ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '3121',
],
'status' => [
'title' => 'UNIMPROVED 状态 IMPROVED 改进 2 未改进UNIMPROVED',
'description' => '状态:'."\n"
."\n"
.'- IMPROVED:改进。'."\n"
.'- UNIMPROVED:未改进。',
'type' => 'string',
'example' => 'UNIMPROVED',
],
'checkUserIsValid' => [
'title' => '验收人是否失效,0失效1生效',
'description' => '验收人是否失效:'."\n"
.'- 0:失效。'."\n"
.'- 1:生效。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'directorIsValid' => [
'title' => '负责人是否失效,0失效1生效',
'description' => '负责人是否失效:'."\n"
.'- 0:失效。'."\n"
.'- 1:生效。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'stalkerIsValid' => [
'title' => '跟踪人是否失效,0失效1生效',
'description' => '跟踪人是否失效:'."\n"
.'- 0:失效。'."\n"
.'- 1:生效。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'customProblemReason' => [
'title' => '自定义故障原因',
'description' => '自定义故障原因。',
'type' => 'string',
'example' => '1',
],
'replayDutyUserIsValid' => [
'title' => '复盘负责人生效状态,0失效1生效',
'description' => '复盘负责人生效状态:'."\n"
.'- 0:失效。'."\n"
.'- 1:生效。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'dutyUserIsValid' => [
'title' => '故障责任人生效状态,0失效1生效',
'description' => '故障责任人生效状态:'."\n"
.'- 0:失效。'."\n"
.'- 1:生效。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'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":"\\n 4361a0e1-6747-4834-96ce-0c4840fd3811\\n \\n 231231\\n 故障的原因\\n 2\\n 3\\n 2\\n 1\\n 1\\n Zabbix\\n 关联变更\\n 231\\n 23123\\n 12312\\n 小明\\n 小花\\n 备注\\n true\\n 服务组B\\n \\n 12312\\n 2\\n 内容A\\n 验收标准A\\n 12\\n 小军\\n 小张\\n 小李\\n 2021-05-01 00:00:00\\n 212\\n 3121\\n UNIMPROVED\\n \\n \\n","errorExample":""}]',
'title' => '故障复盘改进详情',
],
'DeleteProblemMeasure' => [
'summary' => '删除故障改进措施。',
'path' => '/problem/improvement/measure/delete',
'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' => [
'FEATUREgempZB7ZAW',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'measureId' => [
'title' => '故障改成措施id',
'description' => '故障改成措施ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1213',
],
'problemId' => [
'title' => '故障Id',
'description' => '故障ID。',
'type' => 'string',
'required' => false,
'example' => '2131',
],
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等校验token。',
'type' => 'string',
'required' => false,
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"4361a0e1-6747-4834-96ce-0c4840fd3812\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4361a0e1-6747-4834-96ce-0c4840fd3812\\n","errorExample":""}]',
'title' => '删除故障改进措施',
],
'DeleteProblemTimeline' => [
'summary' => '删除故障事件线节点。',
'path' => '/problem/process/timeline/delete',
'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' => [
'FEATUREgemp65LXE3',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemTimelineId' => [
'title' => 'ID',
'description' => '时间线ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '11',
],
'problemId' => [
'title' => '故障id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '102',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 10REQUES-AC5C-4B59-BE11-378F117A6A88\\n","errorExample":""}]',
'title' => '删除故障事件线节点',
],
'ListProblemTimeLines' => [
'summary' => '查询故障时间线列表 。',
'path' => '/problem/detail/timeLines',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障ID',
'description' => '故障ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10002010',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等号',
'type' => 'string',
'required' => false,
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
],
'data' => [
'description' => '故障时间线列表',
'type' => 'array',
'items' => [
'description' => 'object',
'type' => 'object',
'properties' => [
'createTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '2020-08-08 15:38:38',
],
'keyNode' => [
'title' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
'description' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
'type' => 'string',
'example' => 'PROBLEM_INJECTION,PROBLEM_HAPPEN',
],
'content' => [
'title' => '内容',
'description' => '内容',
'type' => 'string',
'example' => '内容',
],
'isKey' => [
'title' => '是否是关键字 true是 false不是 默认 false',
'description' => '是否是关键字 true是 false不是 默认 false',
'type' => 'boolean',
'example' => 'true',
],
'updateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '2020-08-08 15:38:38',
],
'time' => [
'title' => '展示时间',
'description' => '展示时间',
'type' => 'string',
'example' => '2020-08-08 15:38:38',
],
'problemTimelineId' => [
'title' => '时间线id',
'description' => '时间线id',
'type' => 'integer',
'format' => 'int64',
'example' => '10000',
],
'usersInContent' => [
'title' => '内容中的用户信息',
'description' => '内容中的用户信息',
'type' => 'array',
'items' => [
'description' => 'object',
'type' => 'object',
'properties' => [
'userId' => [
'title' => '用户id',
'description' => '用户id',
'type' => 'integer',
'format' => 'int64',
'example' => '232',
],
'username' => [
'title' => '用户名',
'description' => '用户名',
'type' => 'string',
'example' => '张老萨',
],
'isValid' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'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":"\\n C4BE3837-1A13-413B-A225-2C88188E8A43\\n \\n 2020-08-08 15:38:38\\n 1,2,3\\n 内容\\n true\\n 2020-08-08 15:38:38\\n \\n 10000\\n \\n","errorExample":""}]',
'title' => '查询故障时间线列表',
],
'GetProblemEffectionService' => [
'summary' => '故障影响服务详情。',
'path' => '/problem/process/effectionService/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' => [
'FEATUREgempLC8226',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'effectionServiceId' => [
'title' => 'id主键',
'description' => 'ID主键。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '9',
],
'problemId' => [
'title' => '故障id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '46',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd',
],
'data' => [
'description' => '查询结果。',
'type' => 'object',
'properties' => [
'effectionServiceId' => [
'title' => '影响服务id',
'description' => '影响服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '6442430',
],
'serviceName' => [
'title' => '服务名称',
'description' => '服务名称。',
'type' => 'string',
'example' => '哈哈',
],
'serviceId' => [
'title' => '服务id',
'description' => '服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '170000000',
],
'level' => [
'title' => '影响等级',
'description' => '影响等级。',
'type' => 'integer',
'format' => 'int64',
'example' => 'P2',
],
'status' => [
'title' => '影响状态 0 未恢复 1已恢复',
'description' => '影响状态:'."\n"
.'- 0:未恢复。'."\n"
.'- 1:已恢复。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'description' => [
'title' => '影响描述',
'description' => '影响描述。',
'type' => 'string',
'example' => 'ew',
],
'picUrl' => [
'title' => '图片链接',
'description' => '图片链接。',
'type' => 'array',
'items' => [
'description' => '图片key。',
'type' => 'string',
'example' => '[ "problem/axxxxxx2-1xxxx4565-be92-f44ae2xxxxx", "problem/7xxxxxxe314-49998-b9e7-399e78b41fbd", "problem/xxxxx-f40d-4611-0978-1d1f719a929a" ]',
],
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'EffectionServiceNotExisted',
'errorMessage' => 'EffectionService does not exist.',
],
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'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":"\\n e2d4306a-bf4d-4345-9ae6-158223c85dbd\\n \\n 6442430\\n 哈哈\\n 170000000\\n ew\\n [ \\"problem/axxxxxx2-1xxxx4565-be92-f44ae2xxxxx\\", \\"problem/7xxxxxxe314-49998-b9e7-399e78b41fbd\\", \\"problem/xxxxx-f40d-4611-0978-1d1f719a929a\\" ]\\n \\n","errorExample":""}]',
'title' => '故障影响服务详情',
],
'GetProblemPreview' => [
'summary' => '获取故障通知预览。',
'path' => '/problem/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' => [
'FEATUREgempLC8226',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12312',
],
'problemNotifyType' => [
'title' => '通告类型',
'description' => '通告类型:'."\n"
."\n"
.'- PROBLEM_NOTIFY:故障通告。'."\n"
.'- PROBLEM_UPDATE:故障更新。'."\n"
.'- PROBLEM_UPGRADE:故障升级。'."\n"
.'- PROBLEM_DEGRADE:故障降级。'."\n"
.'- PROBLEM_RECOVER:故障恢复。'."\n"
.'- PROBLEM_REISSUE:故障补发。'."\n"
.'- PROBLEM_CANCEL:故障取消。',
'type' => 'string',
'required' => false,
'example' => 'PROBLEM_NOTIFY',
],
'problemLevel' => [
'title' => '故障等级',
'description' => '故障等级。',
'type' => 'string',
'required' => false,
'example' => 'P2',
],
'effectServiceIds' => [
'title' => '影响服务',
'description' => '影响服务。',
'type' => 'array',
'items' => [
'description' => '影响服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1231',
],
'required' => false,
],
'relatedServiceId' => [
'title' => '所属服务',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '21312',
],
'incidentId' => [
'title' => '事件Id',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '213123',
],
'serviceGroupIds' => [
'title' => '应急协同组',
'description' => '协同组ID。',
'type' => 'array',
'items' => [
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12313',
],
'required' => false,
],
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等Token。',
'type' => 'string',
'required' => false,
'example' => '4361a0e1-6747-4834-96ce-0c4840f13812',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => '4361a0e1-6747-4834-96ce-0c2840fd3812',
],
'data' => [
'description' => '降级规则。',
'type' => 'object',
'properties' => [
'problem' => [
'description' => '关联故障。',
'type' => 'object',
'properties' => [
'problemName' => [
'title' => '故障名称',
'description' => '故障名称。',
'type' => 'string',
'example' => '故障名称',
],
'problemStatus' => [
'title' => '故障状态 1 处理中 2已恢复 3复盘中 4已复盘 5已取消',
'description' => '故障状态:'."\n"
."\n"
.'- HANDLING:处理中。'."\n"
.'- RECOVERED:已恢复。'."\n"
.'- REPLAYING:复盘中。'."\n"
.'- REPLAYED:已复盘。'."\n"
.'- CANCEL:已取消。',
'type' => 'string',
'example' => 'HANDLING',
],
'problemLevel' => [
'title' => '故障等级 1=P1 2=P2 3=P3 4=P4',
'description' => '故障等级递降:'."\n"
."\n"
.'- P1'."\n"
.'- P2'."\n"
.'- P3'."\n"
.'- P4',
'type' => 'string',
'example' => 'P2',
],
'discoverTime' => [
'title' => '发现时间',
'description' => '发现时间。',
'type' => 'string',
'example' => '2021-02-21 00:00:00',
],
'recoveryTime' => [
'title' => '恢复时间',
'description' => '恢复时间。',
'type' => 'string',
'example' => '2021-02-21 00:00:00',
],
'serviceName' => [
'title' => '关联服务 名称',
'description' => '关联服务名称。',
'type' => 'string',
'example' => '服务A',
],
'progressSummary' => [
'title' => '进展摘要',
'description' => '进展摘要。',
'type' => 'string',
'example' => '摘要123',
],
'preliminaryReason' => [
'title' => '初步原因',
'description' => '初步原因。',
'type' => 'string',
'example' => '原因A',
],
'mainHandlerName' => [
'title' => '主要处理人',
'description' => '主要处理人。',
'type' => 'string',
'example' => '小明',
],
'mainHandlerId' => [
'title' => '主要处理人Id',
'description' => '主要处理人ID。',
'type' => 'string',
'example' => '231',
],
'isManual' => [
'title' => '是否手动',
'description' => '是否手动。',
'type' => 'boolean',
'example' => 'true',
],
'isUpgrade' => [
'title' => '是否升级',
'description' => '是否升级。',
'type' => 'boolean',
'example' => 'true',
],
'problemId' => [
'title' => '故障Id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '123123',
],
'relatedServiceId' => [
'title' => '关联服务ID',
'description' => '关联服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '213123',
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-02-21 00:00:00',
],
'progressSummaryRichTextId' => [
'title' => '富文本id',
'description' => '富文本ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12312',
],
'coordinationGroups' => [
'title' => '应急协同组',
'description' => '应急协同组。',
'type' => 'array',
'items' => [
'description' => '应急协同组。',
'type' => 'object',
'properties' => [
'serviceGroupName' => [
'title' => '服务组名称',
'description' => '服务组名称。',
'type' => 'string',
'example' => '服务组A',
],
'serviceGroupId' => [
'title' => '服务Id',
'description' => '服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1231',
],
'serviceGroupDescription' => [
'title' => '服务组Maison',
'description' => '服务组描述。',
'type' => 'string',
'example' => '服务组描述',
],
],
],
],
'effectionServices' => [
'title' => '影响服务',
'description' => '影响服务。',
'type' => 'array',
'items' => [
'description' => '影响服务。',
'type' => 'object',
'properties' => [
'serviceName' => [
'title' => '影响服务名称',
'description' => '影响服务名称。',
'type' => 'string',
'example' => '服务B',
],
'serviceId' => [
'title' => '影响服务Id',
'description' => '影响服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1231',
],
],
],
],
],
],
'voice' => [
'title' => '语音',
'description' => '语音。',
'type' => 'object',
'properties' => [
'count' => [
'title' => '数量',
'description' => '数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
'users' => [
'description' => '用户组。',
'type' => 'array',
'items' => [
'description' => '用户。',
'type' => 'object',
'properties' => [
'username' => [
'title' => '用户',
'description' => '用户。',
'type' => 'string',
'example' => '用户名称',
],
],
],
],
],
],
'mail' => [
'title' => '邮箱',
'description' => '邮箱。',
'type' => 'object',
'properties' => [
'count' => [
'title' => '数量',
'description' => '数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
'users' => [
'description' => '用户组。',
'type' => 'array',
'items' => [
'description' => '用户。',
'type' => 'object',
'properties' => [
'username' => [
'title' => '用户名称',
'description' => '用户名称。',
'type' => 'string',
'example' => '用户名称',
],
],
],
],
],
],
'sms' => [
'title' => '短信',
'description' => '短信。',
'type' => 'object',
'properties' => [
'count' => [
'title' => '数量',
'description' => '数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
'users' => [
'description' => '用户组。',
'type' => 'array',
'items' => [
'description' => '用户。',
'type' => 'object',
'properties' => [
'username' => [
'title' => '用户名称',
'description' => '用户名称。',
'type' => 'string',
'example' => '用户名称',
],
],
],
],
],
],
'webhook' => [
'title' => 'webhook',
'description' => 'webhook。',
'type' => 'object',
'properties' => [
'count' => [
'title' => '数量',
'description' => '数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '32',
],
'serviceGroups' => [
'description' => '服务组。',
'type' => 'array',
'items' => [
'description' => '服务组名称。',
'type' => 'object',
'properties' => [
'serviceName' => [
'title' => '服务名称',
'description' => '服务名称。',
'type' => 'string',
'example' => '服务名称',
],
],
],
],
],
],
'upBeforeData' => [
'title' => '升级前数据',
'description' => '升级前数据。',
'type' => 'string',
'example' => '最新升级前等级',
],
'upAfterData' => [
'title' => '升级后数据',
'description' => '升级后数据。',
'type' => 'string',
'example' => '最新升级后等级',
],
'deBeforeData' => [
'title' => '降级前数据',
'description' => '降级前数据。',
'type' => 'string',
'example' => '最新降级前等级',
],
'deAfterData' => [
'title' => '降级后数据',
'description' => '降级后数据。',
'type' => 'string',
'example' => '最新降级后等级',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'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":"\\n 4361a0e1-6747-4834-96ce-0c2840fd3812\\n \\n \\n 故障名称\\n HANDLING\\n P2\\n 2021-02-21 00:00:00\\n 2021-02-21 00:00:00\\n 服务A\\n 摘要123\\n 原因A\\n 小明\\n 231\\n true\\n true\\n 123123\\n 213123\\n 2021-02-21 00:00:00\\n \\n 服务组A\\n 1231\\n 服务组描述\\n \\n \\n 服务B\\n 1231\\n \\n \\n \\n 12\\n \\n 用户名称\\n \\n \\n \\n 123\\n \\n 用户名称\\n \\n \\n \\n 12\\n \\n 用户名称\\n \\n \\n \\n 32\\n \\n 服务名称\\n \\n \\n 最新升级前等级\\n 最新升级后等级\\n 最新降级前等级\\n 最新降级后等级\\n \\n","errorExample":""}]',
'title' => '获取故障通知预览',
],
'RemoveProblemServiceGroup' => [
'summary' => '移除故障应急协同组。',
'path' => '/problem/removeServiceGroup',
'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' => [
'FEATUREgemp1XQ9JR',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'problemId' => [
'title' => '故障ID',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '13123',
],
'serviceGroupIds' => [
'title' => '应急协同组',
'description' => '应急协同组。',
'type' => 'array',
'items' => [
'description' => '应急协同组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '应急协同组ID',
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '5AD6E6BC-2582-4E0E-832D-52CB1B922253',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"5AD6E6BC-2582-4E0E-832D-52CB1B922253\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5AD6E6BC-2582-4E0E-832D-52CB1B922253\\n","errorExample":""}]',
'title' => '移除故障应急协同组',
],
'CreateProblemEffectionService' => [
'summary' => '创建影响服务。',
'path' => '/problem/process/effectionService/create',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempZVI8H5',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'serviceId' => [
'title' => '影响服务id',
'description' => '影响服务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '185647232',
],
'level' => [
'title' => '影响等级',
'description' => '影响等级。',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
'status' => [
'title' => '影响状态 0 未恢复 1已恢复',
'description' => '影响状态:'."\n"
.'- 0:未恢复。'."\n"
.'- 1:已恢复。',
'type' => 'string',
'required' => false,
'example' => '0',
],
'description' => [
'title' => '影响描述',
'description' => '影响描述。',
'type' => 'string',
'required' => false,
'example' => '这是一个影响描述。',
],
'pictureUrl' => [
'title' => '图片地址',
'description' => '图片地址。',
'type' => 'array',
'items' => [
'description' => '图片key。',
'type' => 'string',
'required' => false,
'example' => 'problem/xxxxxxxssxxxa2c8-40b9-9162-08a6c2e338e2',
],
'required' => false,
],
'problemId' => [
'title' => '故障id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '164327640',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
],
'data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'effectionServiceId' => [
'title' => '影响服务id',
'description' => '影响服务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '125647350',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'EffectionServiceAlreadyExisted',
'errorMessage' => 'EffectionService already exists.',
],
],
404 => [
[
'errorCode' => 'ProblemNotExisted',
'errorMessage' => 'The problem does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\",\\n \\"data\\": {\\n \\"effectionServiceId\\": 125647350\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n c26f36de-1ec8-496a-a828-880676c5ef81\\n \\n 6442430\\n \\n","errorExample":""}]',
'title' => '创建影响服务',
],
'GetResourceStatistics' => [
'summary' => '获取资源统计。',
'path' => '/config/resource/count',
'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' => [
'FEATUREgemp20VVML',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'body',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等校验',
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
'required' => false,
'example' => 'body',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'data' => [
'title' => 'data',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'incidentCount' => [
'title' => '事件总数',
'description' => '事件总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1331',
],
'alertCount' => [
'title' => '报警总数',
'description' => '报警总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '123',
],
'problemCount' => [
'title' => '故障总数',
'description' => '故障总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '221',
],
'integrationCount' => [
'title' => '集成总数',
'description' => '集成总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2211',
],
],
],
],
],
],
],
'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":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n \\n 1331\\n 123\\n 221\\n 2211\\n \\n","errorExample":""}]',
'title' => '获取资源统计',
],
'ListConfigs' => [
'summary' => '获取全部动态码表配置项。',
'path' => '/config/all',
'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' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等校验token',
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-CDE61E59A2E9',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'data' => [
'description' => '数据列表。',
'type' => 'object',
'additionalProperties' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'configDescription' => [
'title' => '配置描述',
'type' => 'string',
'description' => '配置类型。',
'example' => '产品设计',
],
'configCode' => [
'title' => '配置code',
'type' => 'string',
'example' => 'PROBLEM_REASON_DISASTER',
'description' => '配置Code。',
],
'parentCode' => [
'title' => '配置父code',
'type' => 'string',
'description' => '父配置Code。',
'example' => 'PROBLEM_REASON',
],
'configKey' => [
'title' => 'key (用于前后端值传递)',
'type' => 'string',
'example' => '2',
'description' => '配置key项。',
],
'configValue' => [
'title' => 'value (用于前端展示)',
'type' => 'string',
'example' => '产品设计',
'description' => '配置key对应的value值。',
],
'requirement' => [
'title' => '是否必选',
'type' => 'boolean',
'description' => '是否必选。'."\n"
.'- true:是。'."\n"
.'- false:否。',
'example' => 'true',
],
],
],
'description' => '数据列表。',
],
],
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => 'uuid',
],
],
],
],
],
'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":"\\n \\n \\n PROBLEM_INJECTION_CODE_RELEASE\\n PROBLEM_INJECTION_MODE\\n 代码发布\\n 0\\n 29\\n 代码发布\\n 1\\n \\n \\n","errorExample":""}]',
'title' => '码表配置',
],
'ListDictionaries' => [
'summary' => '枚举字典接口。',
'path' => '/dict/list',
'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' => [
'FEATUREgempLJVP1W',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'clientToken' => [
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'data' => [
'description' => '返回结果。',
'type' => 'object',
'additionalProperties' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
'example' => 'SMS',
'description' => '码值。',
],
'description' => [
'type' => 'string',
'description' => '注释。',
'example' => '短信',
],
],
],
'description' => '返回结果。',
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
],
],
],
],
'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":"\\n \\n \\n P1\\n P1\\n \\n \\n P2\\n P2\\n \\n \\n P3\\n P3\\n \\n \\n P4\\n P4\\n \\n \\n LOW\\n 低\\n \\n \\n HIGH\\n 高\\n \\n \\n SMS\\n 短信\\n \\n \\n EMAIL\\n 邮件\\n \\n \\n PHONE\\n 电话\\n \\n \\n WEIXIN_GROUP\\n 企微群\\n \\n \\n DING_GROUP\\n 钉钉群\\n \\n \\n CONTAIN\\n 包含\\n \\n \\n NOT_CONTAIN\\n 不包含\\n \\n \\n EQUALS\\n 等于\\n \\n \\n NOT_EQUALS\\n 不等于\\n \\n \\n PROBLEM_NOTIFY\\n 故障通告\\n \\n \\n PROBLEM_UPDATE\\n 故障更新\\n \\n \\n PROBLEM_UPGRADE\\n 故障升级\\n \\n \\n PROBLEM_DEGRADE\\n 故障降级\\n \\n \\n PROBLEM_RECOVER\\n 故障恢复\\n \\n \\n PROBLEM_REISSUE\\n 故障补发\\n \\n \\n PROBLEM_CANCEL\\n 故障取消\\n \\n \\n USERNAME\\n 人员姓名\\n \\n \\n PHONE\\n 人员手机号\\n \\n \\n RAM_ID\\n RAM账号ID\\n \\n \\n ASSIGNED\\n 已分派\\n \\n \\n RESPONDED\\n 已响应\\n \\n \\n FINISHED\\n 已完结\\n \\n \\n","errorExample":""}]',
'title' => '枚举字典接口',
],
'ListMonitorSources' => [
'summary' => '监控源列表。',
'path' => '/monitorSource/list',
'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' => [
'FEATUREgempBHVB81',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'clientToken' => [
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'monitorSourceId' => [
'description' => '监控源ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
'monitorSourceName' => [
'description' => '监控源名称。',
'type' => 'string',
'example' => 'Zabbix',
],
'fieldKeys' => [
'description' => '监控源字段列表。',
'type' => 'array',
'items' => [
'description' => '监控源字段。',
'type' => 'string',
'example' => 'payload.content',
],
],
],
],
],
'requestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
],
],
],
],
'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":"\\n 1\\n payload.content\\n payload.summary\\n payload.testarr[].a\\n payload.testarr[].b\\n payload.title\\n zabbix\\n\\n\\n 9\\n payload.testarr[].a\\n payload.testarr[].b\\n payload.title\\n 网易云\\n\\n\\n 8\\n payload.content\\n payload.summary\\n payload.title\\n 腾讯云\\n","errorExample":""}]',
'title' => '监控源列表',
],
'CreateTenantApplication' => [
'summary' => '创建移动应用。',
'path' => '/mobileApp/create',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempU4CBQS',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'channel' => [
'title' => '应用协同渠道',
'description' => '应用协同渠道。',
'type' => 'string',
'required' => true,
'example' => 'DINGDING',
],
'clientToken' => [
'title' => '幂等标识',
'description' => '幂等标识。',
'type' => 'string',
'required' => true,
'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'id of the req',
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
'data' => [
'title' => 'data',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'openUrl' => [
'title' => '开通url',
'description' => '开通URL。',
'type' => 'string',
'example' => 'http://xxxx',
],
'progress' => [
'title' => '开通进度状态',
'description' => '开通进度状态。'."\n"
.'- OPENED:已开通。'."\n"
.'- OPENING:开通中。',
'type' => 'string',
'example' => 'OPENED',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'TenantAppAlreadyExisit',
'errorMessage' => 'App is opened.',
],
],
],
'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":"\\n 10REQUES-AC5C-4B59-BE11-378F117A6A88\\n \\n http://xxxx\\n \\n \\n","errorExample":""}]',
'title' => '创建移动应用',
],
'GetTenantApplication' => [
'summary' => '移动应用详情。',
'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' => [
'FEATUREgempU4CBQS',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求body。',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等标识',
'description' => '幂等标识。',
'type' => 'string',
'required' => true,
'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'data' => [
'title' => 'data',
'description' => '集成配置。',
'type' => 'object',
'properties' => [
'corporationId' => [
'title' => '企业id',
'description' => '企业ID。',
'type' => 'string',
'example' => 'ding81913c*',
],
'bizId' => [
'title' => '业务id',
'description' => '业务ID。',
'type' => 'string',
'example' => '7356',
],
'progress' => [
'title' => '进度',
'description' => '进度。',
'type' => 'string',
'example' => 'NOT_OPEN',
],
'channel' => [
'title' => '云钉协同渠道',
'description' => '云钉协同渠道。',
'type' => 'string',
'example' => 'DINGDING',
],
'originalCorpId' => [
'description' => '租户ID。',
'type' => 'string',
],
],
],
'requestId' => [
'title' => 'id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
],
],
],
],
'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":"\\n \\n ding81913c*\\n 7356\\n \\n DINGDING\\n \\n 10REQUES-AC5C-4B59-BE11-378F117A6A88\\n","errorExample":""}]',
'title' => '移动应用详情',
],
'PushMonitor' => [
'summary' => '业务监控数据推送,业务监控数据保存。',
'path' => '/api/monitor/push/{apiKey}',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'Anonymous' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempW81V8D',
],
],
'parameters' => [
[
'name' => 'apiKey',
'in' => 'path',
'schema' => [
'title' => '集成接入的apiKey',
'description' => '集成接入的API 密钥。',
'type' => 'string',
'required' => true,
'example' => 'dfb2e51a58e64152a0eef7a232308006',
],
],
[
'name' => 'body',
'in' => 'body',
'schema' => [
'title' => '推送的数据内容',
'description' => '推送的数据内容。',
'type' => 'string',
'required' => false,
'example' => '2022-12-16 09:52:34.164 ConsumeMessageThread_13 INFO LOGGER_SPM 订单创建|Y|10',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '{@link Result}',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'data' => [
'description' => '返回结果,正常返回null。',
'type' => 'any',
'example' => 'null',
],
'requestId' => [
'description' => '每个请求的唯一ID。',
'type' => 'string',
'example' => '5A30D240-1821-0246-B580-AB1468657AC2',
],
],
],
],
],
'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.',
],
],
404 => [
[
'errorCode' => 'InvalidInstanceChargeType.NotFound',
'errorMessage' => 'The InstanceChargeType does not exist in our records',
],
[
'errorCode' => 'InvalidInternetChargeType.ValueNotSupported',
'errorMessage' => 'The specified InternetChargeType is not valid',
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"data\\": \\"null\\",\\n \\"requestId\\": \\"5A30D240-1821-0246-B580-AB1468657AC2\\"\\n}","errorExample":""},{"type":"xml","example":"\\n null\\n 5A30D240-1821-0246-B580-AB1468657AD2\\n","errorExample":""}]',
'title' => 'API集成',
'extraInfo' => '只发布国内站'."\n",
],
'ListEscalationPlanServices' => [
'summary' => '升级计划范围对象(服务)已选择的列表。',
'path' => '/escalationPlan/services',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => 'clientToken',
'description' => 'clientToken',
'type' => 'string',
'required' => false,
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
],
'data' => [
'title' => 'data',
'description' => 'data',
'type' => 'array',
'items' => [
'description' => 'object',
'type' => 'object',
'properties' => [
'scope' => [
'title' => '范围类型',
'description' => '范围类型',
'type' => 'string',
'example' => 'SERVICE',
],
'scopeObjectId' => [
'title' => '范围对象id',
'description' => '范围对象id',
'type' => 'integer',
'format' => 'int64',
'example' => '23',
],
],
],
],
],
],
],
],
'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":"\\n A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\n \\n SERVICE\\n 23\\n \\n","errorExample":""}]',
'title' => '升级计划范围对象已选择的列表',
],
'CreateEscalationPlan' => [
'summary' => '创建升级计划。',
'path' => '/escalationPlan/create',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempGUN0ZL',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求结构体。',
'type' => 'object',
'properties' => [
'escalationPlanName' => [
'title' => '升级计划名称',
'description' => '升级计划名称。',
'type' => 'string',
'required' => true,
'example' => 'name123',
],
'escalationPlanDescription' => [
'title' => '升级计划描述',
'description' => '升级计划描述。',
'type' => 'string',
'required' => true,
'example' => 'desc2322424',
],
'escalationPlanScopeObjects' => [
'title' => '升级计划范围对象列表',
'description' => '升级计划范围对象列表。',
'type' => 'array',
'items' => [
'description' => '请求结构。',
'type' => 'object',
'properties' => [
'scopeObjectId' => [
'title' => '范围对象id',
'description' => '范围对象ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23433',
],
'scope' => [
'title' => '范围对象类型',
'description' => '范围对象类型。',
'type' => 'string',
'required' => false,
'example' => 'SERVICE',
],
],
'required' => true,
],
'required' => true,
],
'escalationPlanRules' => [
'title' => '升级计划规则列表',
'description' => '升级计划规则列表。',
'type' => 'array',
'items' => [
'description' => '请求结构。',
'type' => 'object',
'properties' => [
'escalationPlanConditions' => [
'title' => '升级条件',
'description' => '升级条件。',
'type' => 'array',
'items' => [
'description' => '请求结构。',
'type' => 'object',
'properties' => [
'level' => [
'title' => '事件等级',
'description' => '事件等级。取值:P1~P4,P1为最高优先级,P4最低。',
'type' => 'string',
'required' => true,
'example' => 'P1',
],
'effection' => [
'title' => '影响等级',
'description' => '影响等级。取值:'."\n"
."\n"
.'- HIGH:高'."\n"
.'- LOW:低',
'type' => 'string',
'required' => true,
'example' => 'LOW',
],
],
'required' => true,
],
'required' => true,
],
'escalationPlanStrategies' => [
'title' => '升级策略',
'description' => '升级策略。',
'type' => 'array',
'items' => [
'description' => '请求结构。',
'type' => 'object',
'properties' => [
'noticeTime' => [
'title' => '通知时间',
'description' => '通知时间。',
'type' => 'string',
'required' => true,
'example' => '40',
],
'noticeObjects' => [
'title' => '升级通知对象id列表',
'description' => '升级通知对象ID列表。',
'type' => 'array',
'items' => [
'description' => '通知对象。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '23',
],
'required' => true,
],
'noticeChannels' => [
'title' => '升级通知策略',
'description' => '升级通知策略。',
'type' => 'array',
'items' => [
'description' => '通知渠道列表。',
'type' => 'string',
'required' => true,
'example' => '["SMS","PHONE"]',
],
'required' => true,
],
'enableWebhook' => [
'title' => '是否支持群通知',
'description' => '是否webhook。'."\n"
."\n"
.'- true:是'."\n"
.'- false:否',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
'serviceGroupIds' => [
'title' => '服务组id',
'description' => '服务组ID。',
'type' => 'array',
'items' => [
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '434',
],
'required' => false,
],
'escalationPlanType' => [
'title' => '升级类型',
'description' => '升级类型。',
'type' => 'string',
'required' => false,
'example' => 'UN_FINISH',
],
'noticeRoleList' => [
'title' => '通知角色列表',
'description' => '通知角色列表。',
'type' => 'array',
'items' => [
'description' => '角色列表。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10asqwqwwqwq',
],
'required' => false,
],
],
'required' => true,
],
'required' => true,
],
'escalationPlanType' => [
'title' => '升级类型(废弃)',
'description' => '升级类型(废弃,此参数可不填)。',
'type' => 'string',
'required' => false,
'example' => 'UN_FINISH',
],
],
'required' => true,
],
'required' => true,
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => '6b404f14-****-4b53-a1a1-30a58bREQUEST',
],
'isGlobal' => [
'title' => '是否是全局策略',
'description' => '是否是全局策略。'."\n"
.'- true:是'."\n"
.'- false:否',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D',
],
'data' => [
'title' => 'data',
'description' => '数据列表。',
'type' => 'object',
'properties' => [
'escalationPlanId' => [
'title' => '升级计划id',
'description' => '升级计划ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '234532',
],
],
],
],
],
],
],
'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.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC21925D\\",\\n \\"data\\": {\\n \\"escalationPlanId\\": 234532\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A5A1FEAE-9C47-011C-9C73-A376BC21925D\\n \\n 234532\\n \\n","errorExample":""}]',
'title' => '创建升级计划',
],
'DeleteEscalationPlan' => [
'summary' => '删除升级计划。',
'path' => '/escalationPlan/delete',
'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' => [
'FEATUREgempGUN0ZL',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求体参数。',
'type' => 'object',
'properties' => [
'escalationPlanId' => [
'title' => '升级计划ID',
'description' => '升级计划ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '234534',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => 'A5A1****-9C47-011C-9C73-A376BC2REQUEST',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'EscalationPlanNotExists',
'errorMessage' => 'The specified escalation plan does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC21925D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5A1FEAE-9C47-011C-9C73-A376BC21925D\\n","errorExample":""}]',
'title' => '删除升级计划',
],
'DisableEscalationPlan' => [
'summary' => '禁用升级计划。',
'path' => '/escalationPlan/disable',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求体参数。',
'type' => 'object',
'properties' => [
'escalationPlanId' => [
'title' => '升级计划ID',
'description' => '升级计划ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '234534',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'EscalationPlanAlreadyDisable',
'errorMessage' => 'The escalation plan is already disabled.',
],
],
404 => [
[
'errorCode' => 'EscalationPlanNotExists',
'errorMessage' => 'The specified escalation plan does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC21925D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5A1FEAE-9C47-011C-9C73-A376BC21925D\\n","errorExample":""}]',
'title' => '禁用升级计划',
],
'EnableEscalationPlan' => [
'summary' => '启用升级计划。',
'path' => '/escalationPlan/enable',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求体参数。',
'type' => 'object',
'properties' => [
'escalationPlanId' => [
'title' => '升级计划ID',
'description' => '升级计划ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '234534',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'EscalationPlanAlreadyEnable',
'errorMessage' => 'The escalation plan is already enabled.',
],
],
404 => [
[
'errorCode' => 'EscalationPlanNotExists',
'errorMessage' => 'The specified escalation plan does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC21925D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5A1FEAE-9C47-011C-9C73-A376BC21925D\\n","errorExample":""}]',
'title' => '启用升级计划',
],
'GetEscalationPlan' => [
'summary' => '获取指定动态码表的详细信息。',
'path' => '/escalationPlan/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' => [
'FEATUREgempGUN0ZL',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'escalationPlanId' => [
'title' => '升级计划id',
'description' => '升级计划id',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '345',
],
'clientToken' => [
'title' => '幂等标识',
'description' => '幂等标识',
'type' => 'string',
'required' => false,
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
],
'data' => [
'title' => 'data',
'description' => 'data',
'type' => 'object',
'properties' => [
'escalationPlanId' => [
'title' => '升级计划id',
'description' => '升级计划id',
'type' => 'integer',
'format' => 'int64',
'example' => '2345',
],
'escalationPlanName' => [
'title' => '升级计划名称',
'description' => '升级计划名称',
'type' => 'string',
'example' => '升级计划234',
],
'escalationPlanDescription' => [
'title' => '升级计划描述',
'description' => '升级计划描述',
'type' => 'string',
'example' => '描述1234',
],
'escalationPlanScopeObjects' => [
'title' => '升级计划范围对象列表',
'description' => '升级计划范围对象列表',
'type' => 'array',
'items' => [
'description' => 'object',
'type' => 'object',
'properties' => [
'scopeObjectId' => [
'title' => '范围对象id',
'description' => '范围对象id',
'type' => 'integer',
'format' => 'int64',
'example' => '234',
],
'scope' => [
'title' => '范围对象类型',
'description' => '范围对象类型',
'type' => 'string',
'example' => 'SERVICE',
],
'scopeObjectName' => [
'title' => '范围对象名称',
'description' => '范围对象名称',
'type' => 'string',
'example' => 'xx服务',
],
'escalationPlanScopeObjects' => [
'title' => '服务删除字段 1正常 0删除',
'description' => '服务删除字段 1正常 0删除',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'scopeObjectDeletedType' => [
'title' => '服务删除字段 1正常 0删除',
'description' => '服务删除字段 1正常 0删除',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'escalationPlanRules' => [
'title' => '升级计划规则列表',
'description' => '升级计划规则列表',
'type' => 'array',
'items' => [
'description' => 'object',
'type' => 'object',
'properties' => [
'escalationPlanRuleId' => [
'title' => '升级计划id',
'description' => '升级计划id',
'type' => 'integer',
'format' => 'int64',
'example' => '345',
],
'escalationPlanConditions' => [
'title' => '升级计划条件',
'description' => '升级计划条件',
'type' => 'array',
'items' => [
'description' => 'object',
'type' => 'object',
'properties' => [
'level' => [
'title' => '事件等级',
'description' => '事件等级',
'type' => 'string',
'example' => 'P1',
],
'effection' => [
'title' => '影响等级',
'description' => '影响等级',
'type' => 'string',
'example' => 'LOW',
],
],
],
],
'escalationPlanStrategies' => [
'title' => '升级计划策略',
'description' => '升级计划策略',
'type' => 'array',
'items' => [
'description' => 'object',
'type' => 'object',
'properties' => [
'noticeTime' => [
'title' => '通知时间',
'description' => '通知时间',
'type' => 'integer',
'format' => 'int64',
'example' => '40',
],
'escalationPlanType' => [
'title' => '升级计划类型',
'description' => '升级计划类型',
'type' => 'string',
'example' => 'UN_ACKNOWLEDGE',
],
'noticeObjectList' => [
'title' => '通知对象列表',
'description' => '通知对象列表',
'type' => 'array',
'items' => [
'description' => 'object',
'type' => 'object',
'properties' => [
'noticeObjectId' => [
'title' => '通知对象id',
'description' => '通知对象id',
'type' => 'integer',
'format' => 'int64',
'example' => '234',
],
'noticeObjectName' => [
'title' => '通知对象名称',
'description' => '通知对象名称',
'type' => 'string',
'example' => '张老三',
],
],
],
],
'noticeChannels' => [
'title' => '通知对象渠道',
'description' => '通知对象渠道',
'type' => 'string',
'example' => 'SMS',
],
'enableWebhook' => [
'title' => '是否支持群通知',
'description' => '是否支持群通知',
'type' => 'boolean',
'example' => 'true',
],
'serviceGroups' => [
'title' => '服务组列表',
'description' => '服务组列表',
'type' => 'array',
'items' => [
'description' => '服务组内容',
'type' => 'object',
'properties' => [
'id' => [
'title' => '服务组id',
'description' => '服务组id',
'type' => 'integer',
'format' => 'int64',
'example' => '343',
],
'serviceGroupName' => [
'title' => '服务组名称',
'description' => '服务组名称',
'type' => 'string',
'example' => 'VCD是',
],
],
],
],
'noticeObjects' => [
'description' => '通知对象',
'type' => 'array',
'items' => [
'description' => '通知对象id',
'type' => 'integer',
'format' => 'int64',
'example' => '111',
],
],
'noticeRoleList' => [
'description' => '角色ID列表',
'type' => 'array',
'items' => [
'description' => '角色ID列表',
'type' => 'integer',
'format' => 'int64',
'example' => '222',
],
],
'noticeRoleObjectList' => [
'description' => '角色对象列表',
'type' => 'array',
'items' => [
'description' => '角色对象列表',
'type' => 'object',
'properties' => [
'id' => [
'description' => '通知对象的ID',
'type' => 'integer',
'format' => 'int64',
'example' => '111',
],
'name' => [
'description' => '通知对象的名称',
'type' => 'string',
'example' => 'XX服务组',
],
],
],
],
],
],
],
],
],
],
'createTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '2021-09-09 09:09:09',
],
'isGlobal' => [
'title' => '是否是全局策略',
'description' => '是否是全局策略'."\n"
.' true:是'."\n"
.' false:否',
'type' => 'boolean',
'example' => 'true',
'default' => 'false',
],
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'EscalationPlanNotExists',
'errorMessage' => 'The specified escalation plan does not exist.',
],
],
],
'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":"\\n A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\n \\n 2345\\n 升级计划234\\n 描述1234\\n \\n 234\\n SERVICE\\n xx服务\\n \\n \\n 345\\n UN_ACKNOWLEDGE\\n \\n P1\\n LOW\\n \\n \\n 40\\n 43\\n SMS\\n \\n \\n 2021-09-09 09:09:09\\n \\n","errorExample":""}]',
'title' => '升级计划详情',
],
'ListEscalationPlans' => [
'summary' => '升级计划列表。',
'path' => '/escalationPlan/list',
'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' => [
'FEATUREgempW7HVUW',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求体。',
'type' => 'object',
'properties' => [
'escalationPlanName' => [
'title' => '升级计划名',
'description' => '升级计划名。',
'type' => 'string',
'required' => false,
'example' => 'xxx',
],
'serviceName' => [
'title' => '服务名称',
'description' => '服务名称。',
'type' => 'string',
'required' => false,
'example' => 'ssxx',
],
'clientToken' => [
'title' => 'clientToken',
'description' => '幂等标识。',
'type' => 'string',
'required' => false,
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
],
'pageNumber' => [
'title' => 'pageNumber',
'description' => '分页参数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => 'pageSize',
'description' => '分页参数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
'isGlobal' => [
'description' => '是否是全局策略。',
'type' => 'boolean',
'required' => false,
],
'status' => [
'description' => '影响状态,取值:'."\n"
."\n"
.'- 0:未恢复'."\n"
.'- 1:已恢复',
'type' => 'string',
'required' => false,
'example' => '0',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
],
'data' => [
'title' => 'data',
'description' => 'data',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'escalationPlanId' => [
'title' => '升级计划id',
'description' => '升级计划ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '43',
],
'escalationPlanName' => [
'title' => '升级计划名称',
'description' => '升级计划名称。',
'type' => 'string',
'example' => '升级计划2345',
],
'escalationPlanScopeObjects' => [
'title' => '升级计划范围对象',
'description' => '升级计划范围对象。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'scopeObjectId' => [
'title' => '范围对象id(服务id)',
'description' => '范围对象ID(服务ID)。',
'type' => 'integer',
'format' => 'int64',
'example' => '23',
],
'scopeObjectName' => [
'title' => '范围对象名称',
'description' => '范围对象名称。',
'type' => 'string',
'example' => '服务1',
],
'scope' => [
'title' => '范围对象类型',
'description' => '范围对象类型。',
'type' => 'string',
'example' => 'SERVICE',
],
'scopeObjectDeletedType' => [
'title' => '服务是否删除 1正常 0删除',
'description' => '服务是否删除,取值:'."\n"
."\n"
.'- 1:正常'."\n"
.'- 0:删除',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'status' => [
'title' => '启用ENABLE 禁用DISABLE',
'description' => '影响状态,取值:'."\n"
."\n"
.'- ENABLE:启用'."\n"
.'- DISABLE:禁用',
'type' => 'string',
'example' => 'ENABLE',
],
'modifyTime' => [
'title' => '修改时间',
'description' => '修改时间。',
'type' => 'string',
'example' => '2021-09-09 09:09:09',
],
'isGlobal' => [
'title' => '是否是全局策略',
'description' => '是否是全局策略。',
'type' => 'boolean',
'default' => 'false',
],
],
],
],
'totalCount' => [
'title' => '总条数',
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '878',
],
'pageNumber' => [
'title' => '分页参数',
'description' => '当前页。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'pageSize' => [
'title' => '分页参数',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
'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":"\\n A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\n \\n 43\\n 升级计划2345\\n \\n 23\\n 某服务1\\n \\n ENABLE\\n 2021-09-09 09:09:09\\n \\n 878\\n 1\\n 10\\n","errorExample":""}]',
'title' => '升级计划列表',
],
'UpdateEscalationPlan' => [
'summary' => '更新升级计划。',
'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',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求体参数。',
'type' => 'object',
'properties' => [
'escalationPlanId' => [
'title' => '升级计划id',
'description' => '升级计划ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '433',
],
'escalationPlanName' => [
'title' => '升级计划名称',
'description' => '升级计划名称。',
'type' => 'string',
'required' => false,
'example' => '服务1升级',
],
'escalationPlanDescription' => [
'title' => '升级计划描述',
'description' => '升级计划描述。',
'type' => 'string',
'required' => false,
'example' => '升级版本',
],
'escalationPlanScopeObjects' => [
'title' => '关联范围列表(服务)',
'description' => '关联范围列表(服务)。',
'type' => 'array',
'items' => [
'description' => '请求参数。',
'type' => 'object',
'properties' => [
'id' => [
'title' => '主键',
'description' => '主键。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '87',
],
'scopeObjectId' => [
'title' => '范围对象id',
'description' => '范围对象ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '234',
],
'scope' => [
'title' => '范围对象类型',
'description' => '范围对象类型。',
'type' => 'string',
'required' => false,
'example' => 'SERVICE',
],
],
'required' => false,
],
'required' => false,
],
'escalationPlanRules' => [
'title' => '升级计划规则',
'description' => '升级计划规则。',
'type' => 'array',
'items' => [
'description' => '请求参数。',
'type' => 'object',
'properties' => [
'id' => [
'title' => '主键',
'description' => '主键。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '872',
],
'escalationPlanType' => [
'title' => 'UN_ACKNOWLEDGE 未响应 UN_FINISH 未完结(废弃)',
'description' => '- UN_ACKNOWLEDGE:未响应。'."\n"
.'- UN_FINISH:未完结(废弃)。',
'type' => 'string',
'required' => false,
'example' => 'UN_ACKNOWLEDGE',
],
'escalationPlanConditions' => [
'title' => '升级计划条件列表',
'description' => '升级计划条件列表。',
'type' => 'array',
'items' => [
'description' => '请求参数。',
'type' => 'object',
'properties' => [
'level' => [
'title' => 'P1 P2 P3 P4',
'description' => '级别P1、P2、P3、P4逐渐递减。',
'type' => 'string',
'required' => false,
'example' => 'P1',
],
'effection' => [
'title' => 'LOW HIGH',
'description' => '影响程度,取值:'."\n"
."\n"
.'- LOW:低。'."\n"
.'- HIGH:高。',
'type' => 'string',
'required' => false,
'example' => 'LOW',
],
],
'required' => false,
],
'required' => false,
],
'escalationPlanStrategies' => [
'title' => '升级策略列表',
'description' => '升级策略列表。',
'type' => 'array',
'items' => [
'description' => '请求参数。',
'type' => 'object',
'properties' => [
'noticeTime' => [
'title' => '通知时间',
'description' => '通知时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '30',
],
'noticeObjects' => [
'title' => '通知对象id',
'description' => '通知对象ID。',
'type' => 'array',
'items' => [
'description' => '通知对象ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '678',
],
'required' => false,
],
'noticeChannels' => [
'title' => '通知渠道',
'description' => '通知渠道。',
'type' => 'array',
'items' => [
'description' => '通知渠道列表。',
'type' => 'string',
'required' => false,
'example' => 'SMS',
],
'required' => false,
],
'serviceGroupIds' => [
'title' => '服务组id',
'description' => '服务组ID。',
'type' => 'array',
'items' => [
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '232',
],
'required' => false,
],
'enableWebhook' => [
'title' => '是否支持群通知',
'description' => '是否是webhook。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'escalationPlanType' => [
'title' => 'UN_ACKNOWLEDGE 未响应 UN_FINISH 未完结',
'description' => '- UN_ACKNOWLEDGE:未响应。'."\n"
.'- UN_FINISH:未完结。',
'type' => 'string',
'required' => false,
'example' => 'UN_ACKNOWLEDGE',
],
'noticeRoleList' => [
'title' => '通知角色列表',
'description' => '角色ID列表。',
'type' => 'array',
'items' => [
'description' => '角色ID列表。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '124wqqqqddf',
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
'clientToken' => [
'title' => 'clientToken',
'description' => '客户端令牌值。',
'type' => 'string',
'required' => false,
'example' => '6b404f14-77d1-4b53-a1a1-30a58bbcfc57',
],
'isGlobal' => [
'title' => '是否是全局策略',
'description' => '是否是全局策略。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
],
],
],
],
],
'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.',
],
],
404 => [
[
'errorCode' => 'EscalationPlanNotExists',
'errorMessage' => 'The specified escalation plan does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST\\n","errorExample":""}]',
'title' => '更新升级计划',
],
'CreateRichText' => [
'summary' => '创建富文本。',
'path' => '/rich/create',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempHBPHMV',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'body',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'instanceId' => [
'title' => '资源id',
'description' => '资源ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '140080050'."\n",
],
'instanceType' => [
'title' => '资源类型',
'description' => '资源类型:'."\n"
.'- INCIDENT:事件。'."\n"
.'- ALERT:告警。'."\n"
.'- PROBLEM:故障。',
'type' => 'string',
'required' => false,
'example' => 'INCIDENT',
],
'richText' => [
'title' => '文本内容',
'description' => '富文本内容。',
'type' => 'string',
'required' => false,
'example' => '这是一个富文本',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
'data' => [
'title' => 'data',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'instanceId' => [
'title' => '资源id',
'description' => '资源ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '140080050'."\n",
],
'instanceType' => [
'title' => '资源类型',
'description' => '资源类型:'."\n"
.'- 0:事件。'."\n"
.'- 1:告警。'."\n"
.'- 2:故障。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'richText' => [
'title' => '富文本内容',
'description' => '富文本内容。',
'type' => 'string',
'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"}]',
'title' => '创建富文本',
],
'GetRichText' => [
'summary' => '获取富文本信息。',
'path' => '/rich/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' => [
'FEATUREgemp71I60H',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'richTextId' => [
'title' => '资源id',
'description' => '富文本ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '140080050',
],
'instanceId' => [
'title' => '资源类型',
'description' => '资源ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '140080050',
],
'instanceType' => [
'description' => '资源类型:'."\n"
.'- INCIDENT:事件。'."\n"
.'- ALERT:告警。'."\n"
.'- PROBLEM:故障。',
'type' => 'string',
'required' => false,
'example' => 'INCIDENT',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '4AA343E4-AB98-56D9-B699-D932902BA3EC',
],
'data' => [
'title' => 'data',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'instanceId' => [
'title' => '资源id',
'description' => '资源ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '140080050',
],
'richText' => [
'title' => '富文本内容',
'description' => '富文本内容。',
'type' => 'string',
'example' => '这是一个富文本',
],
'instanceType' => [
'title' => '资源类型',
'description' => '资源类型:'."\n"
.'- 0:事件。'."\n"
.'- 1:告警。'."\n"
.'- 2:故障。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
],
],
],
],
'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' => '获取富文本信息',
'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"
.'}',
],
'UpdateRichText' => [
'summary' => '更新富文本。',
'path' => '/rich/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' => [
'FEATUREgempW15CG1',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'richTextId' => [
'title' => '富文本id',
'description' => '富文本ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '140080050',
],
'instanceId' => [
'title' => '资源id',
'description' => '资源ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '140080050',
],
'instanceType' => [
'title' => '资源类型',
'description' => '资源类型:'."\n"
.'- INCIDENT:事件。'."\n"
.'- ALERT:告警。'."\n"
.'- PROBLEM:故障。',
'type' => 'string',
'required' => false,
'example' => 'INCIDENT',
],
'richText' => [
'title' => '文本内容',
'description' => '富文本内容。',
'type' => 'string',
'required' => false,
'example' => '这是一个富文本',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '1021A12E-4BDF-5EC6-8251-6E998A3C360B',
],
'data' => [
'title' => 'data',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'id' => [
'title' => '富文本id',
'description' => '富文本ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '132971028',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1021A12E-4BDF-5EC6-8251-6E998A3C360B\\",\\n \\"data\\": {\\n \\"id\\": 132971028\\n }\\n}","type":"json"}]',
'title' => '更新富文本',
],
'ListIncidentDetailEscalationPlans' => [
'summary' => '事件关联的升级计划列表。',
'path' => '/incident/detail/escalation',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'incidentId' => [
'title' => '事件ID',
'description' => '事件ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2311',
],
'clientToken' => [
'title' => '幂等校验',
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
'data' => [
'title' => 'data',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'escalationPlanId' => [
'title' => '升级策略ID',
'description' => '升级策略ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '312123',
],
'escalationPlanName' => [
'title' => '升级策略名称',
'description' => '升级策略名称。',
'type' => 'string',
'example' => '升级策略A',
],
'unFinishEscalationPlan' => [
'title' => '未完结升级策略规则列表',
'description' => '未完结升级策略规则列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'escalationPlanType' => [
'title' => '升级策略类型 UN_ACKNOWLEDGE',
'description' => '升级策略类型:'."\n"
.'- UN_ACKNOWLEDGE:未响应。'."\n"
.'- UN_FINISH:未完结。',
'type' => 'string',
'example' => 'UN_FINISH',
],
'noticeTime' => [
'title' => '延迟时间',
'description' => '延迟时间(分钟)。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'status' => [
'title' => '规则触发状态',
'description' => '规则触发状态。',
'type' => 'string',
'example' => 'UPGRADE',
],
'startTime' => [
'title' => '开始时间',
'description' => '开始时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1629872386027',
],
'noticeChannels' => [
'title' => '分配渠道',
'description' => '通知渠道。',
'type' => 'array',
'items' => [
'description' => '- SMS:短信。'."\n"
.'- PONE:电话。',
'type' => 'string',
'example' => 'SMS',
],
],
'noticeObjectList' => [
'title' => '用户信息',
'description' => '用户信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'noticeObjectId' => [
'title' => '分配对象id',
'description' => '分配对象ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '2311',
],
'noticeObjectName' => [
'title' => '分配对象名称',
'description' => '分配对象名称。',
'type' => 'string',
'example' => '马先生',
],
'noticeObjectPhone' => [
'title' => '手机号',
'description' => '手机号码。',
'type' => 'string',
'example' => '130xxxxxxxx',
],
'roleNameList' => [
'title' => '角色列表',
'description' => '角色列表。',
'type' => 'array',
'items' => [
'description' => '角色名称。',
'type' => 'string',
],
],
],
],
],
'serviceGroupList' => [
'title' => '消息群',
'description' => '服务组列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'id' => [
'title' => '服务组id',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '123132',
],
'name' => [
'title' => '服务组名称',
'description' => '服务组名称。',
'type' => 'string',
'example' => '服务组A',
],
],
],
],
'noticeRoleList' => [
'title' => '角色ID列表',
'description' => '角色ID列表。',
'type' => 'array',
'items' => [
'description' => '角色列表。',
'type' => 'integer',
'format' => 'int64',
],
],
'noticeRoleObjectList' => [
'title' => '角色对象列表',
'description' => '角色对象列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'id' => [
'description' => '通知对象的ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '117',
],
'name' => [
'description' => '通知对象的名称。',
'type' => 'string',
],
],
],
],
],
],
],
'nuAcknowledgeEscalationPlan' => [
'title' => '未响应升级策略',
'description' => '未响应升级策略。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'escalationPlanType' => [
'title' => '升级策略类型 UN_ACKNOWLEDGE',
'description' => '升级策略类型:'."\n"
.'- UN_ACKNOWLEDGE:未响应。'."\n"
.'- UN_FINISH:未完结。',
'type' => 'string',
'example' => 'UN_ACKNOWLEDGE',
],
'noticeTime' => [
'title' => '延迟时间',
'description' => '延迟时间(分钟)。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'status' => [
'title' => '规则触发状态',
'description' => '规则触发状态。',
'type' => 'string',
'example' => 'UPGRADE',
],
'startTime' => [
'title' => '开始时间',
'description' => '开始时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '2021-09-09',
],
'noticeChannels' => [
'title' => '分配渠道',
'description' => '分配渠道。',
'type' => 'array',
'items' => [
'description' => '分配渠道。',
'type' => 'string',
'example' => 'SMS',
],
],
'noticeObjectList' => [
'title' => '用户信息',
'description' => '用户信息。',
'type' => 'array',
'items' => [
'description' => '通知列表。',
'type' => 'object',
'properties' => [
'noticeObjectId' => [
'title' => '分配对象id',
'description' => '分配对象ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '31231',
],
'noticeObjectName' => [
'title' => '分配对象名称',
'description' => '分配对象名称。',
'type' => 'string',
'example' => '马先生',
],
'noticeObjectPhone' => [
'title' => '分配对象手机号',
'description' => '分配对象手机号。',
'type' => 'string',
'example' => '130xxxxxxxxx',
],
'roleNameList' => [
'title' => '角色列表',
'description' => '角色列表。',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
],
],
'serviceGroupList' => [
'title' => '通知群',
'description' => '服务组列表。',
'type' => 'array',
'items' => [
'description' => '服务组列表。',
'type' => 'object',
'properties' => [
'id' => [
'title' => '服务组id',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1231',
],
'name' => [
'title' => '服务组名称',
'description' => '服务组名称。',
'type' => 'string',
'example' => '服务组A',
],
],
],
],
'noticeRoleList' => [
'title' => '角色ID列表',
'description' => '角色ID列表。',
'type' => 'array',
'items' => [
'description' => '角色ID列表。',
'type' => 'integer',
'format' => 'int64',
],
],
'noticeRoleObjectList' => [
'description' => '角色对象列表。',
'type' => 'array',
'items' => [
'description' => '角色对象列表。',
'type' => 'object',
'properties' => [
'id' => [
'description' => '角色对象ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '100936',
],
'name' => [
'description' => '通知对象名称。',
'type' => 'string',
'example' => '通知对象名称A',
],
],
],
],
],
],
],
'convergenceEscalationPlan' => [
'title' => '未响应升级策略',
'description' => '未响应升级策略。',
'type' => 'array',
'items' => [
'description' => '升级计划。',
'type' => 'object',
'properties' => [
'escalationPlanType' => [
'title' => '升级策略类型 UN_ACKNOWLEDGE',
'description' => '升级策略类型:'."\n"
.'- UN_ACKNOWLEDGE:未响应。'."\n"
.'- UN_FINISH:未完结。',
'type' => 'string',
'example' => 'UN_ACKNOWLEDGE',
],
'noticeTime' => [
'title' => '收敛目标值',
'description' => '收敛目标值。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'status' => [
'title' => '规则触发状态',
'description' => '规则触发状态。',
'type' => 'string',
'example' => 'UPGRADE',
],
'startTime' => [
'title' => '已收敛次数',
'description' => '开始时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '2021-09-09',
],
'noticeChannels' => [
'title' => '分配渠道',
'description' => '分配渠道。',
'type' => 'array',
'items' => [
'description' => '通知渠道。',
'type' => 'string',
'example' => 'SMS',
],
],
'noticeObjectList' => [
'title' => '用户信息',
'description' => '用户信息。',
'type' => 'array',
'items' => [
'description' => '通知对象列表。',
'type' => 'object',
'properties' => [
'noticeObjectId' => [
'title' => '分配对象id',
'description' => '分配对象ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '31231',
],
'noticeObjectName' => [
'title' => '分配对象名称',
'description' => '分配对象名称。',
'type' => 'string',
'example' => '马先生',
],
'noticeObjectPhone' => [
'title' => '分配对象手机号',
'description' => '分配对象手机号。',
'type' => 'string',
'example' => '130xxxxxxxxx',
],
'roleNameList' => [
'title' => '角色列表',
'description' => '角色列表。',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
],
],
'serviceGroupList' => [
'title' => '通知群',
'description' => '服务组列表。',
'type' => 'array',
'items' => [
'description' => '服务组列表。',
'type' => 'object',
'properties' => [
'id' => [
'title' => '服务组id',
'description' => '服务组ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1231',
],
'name' => [
'title' => '服务组名称',
'description' => '服务组名称。',
'type' => 'string',
'example' => '服务组A',
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n \\n 312123\\n 升级策略A\\n \\n UN_FINISH\\n 10\\n UPGRADE\\n 1629872386027\\n 渠道字符串 SMS\\n \\n 2311\\n 小明\\n 130xxxxxxxx\\n \\n \\n 123132\\n 服务组A\\n \\n \\n \\n UN_ACKNOWLEDGE\\n 10\\n UPGRADE\\n 1629872386027\\n 渠道字符串 SMS\\n \\n 31231\\n 小华\\n 130xxxxxxxxx\\n \\n \\n 1231\\n 服务组A\\n \\n \\n \\n","errorExample":""}]',
'title' => '事件关联的升级计划列表',
'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": "升级策略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"
.' }'."\n"
.' ],'."\n"
.' "serviceGroupList": ['."\n"
.' {'."\n"
.' "id": 123132,'."\n"
.' "name": "服务组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": "小华",'."\n"
.' "noticeObjectPhone": "130xxxxxxxxx"'."\n"
.' }'."\n"
.' ],'."\n"
.' "serviceGroupList": ['."\n"
.' {'."\n"
.' "id": 1231,'."\n"
.' "name": "服务组A"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}',
],
'GetHomePageGuidance' => [
'summary' => '查询首页配置引导。',
'path' => '/guidance/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' => [
'FEATUREgempVWXIZC',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => '首页引导查询参数',
'description' => '首页引导查询参数。',
'type' => 'object',
'properties' => [
'clientToken' => [
'title' => '幂等号',
'description' => '幂等号。',
'type' => 'string',
'required' => false,
'example' => '7564AA8A-7F49-594E-8E33-F43EB3875116',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'xxxxxx',
],
'data' => [
'description' => '首页引导配置信息。',
'type' => 'object',
'properties' => [
'serviceStatus' => [
'title' => '服务配置状态',
'description' => '服务配置状态。',
'type' => 'boolean',
'example' => 'true',
],
'usersStatus' => [
'title' => '用户配置状态',
'description' => '用户配置状态。',
'type' => 'boolean',
'example' => 'true',
],
'serviceGroupStatus' => [
'title' => '服务组配置状态',
'description' => '服务组配置状态。',
'type' => 'boolean',
'example' => 'true',
],
'notifySubscriptionStatus' => [
'title' => '通知订阅配置状态',
'description' => '通知订阅配置状态。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'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":"\\n xxxxxx\\n \\n true\\n true\\n true\\n true\\n \\n","errorExample":""}]',
'title' => '查询首页配置引导',
'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"
.'```',
],
'ListChartDataForServiceGroup' => [
'summary' => '数据报表图表数据接口(服务组)。',
'path' => '/statistics/chartDataForServiceGroup/',
'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' => [
'FEATUREgempTZ0FO2',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => 'A short description of struct',
'type' => 'object',
'properties' => [
'clientToken' => [
'description' => 'clientToken',
'type' => 'string',
'required' => false,
'example' => '23es23s32xas23',
],
'startTime' => [
'title' => '开始时间',
'description' => '开始时间',
'type' => 'string',
'required' => false,
'example' => '2021-09-09',
],
'endTime' => [
'title' => '结束时间',
'description' => '结束时间',
'type' => 'string',
'required' => false,
'example' => '2021-10-09',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '1231212',
],
'data' => [
'title' => 'data',
'description' => 'data',
'type' => 'array',
'items' => [
'description' => 'object',
'type' => 'object',
'properties' => [
'time' => [
'title' => '时间',
'description' => '时间',
'type' => 'string',
'example' => '2021-09-09',
],
'incidentCount' => [
'title' => '时间总数',
'description' => '时间总数',
'type' => 'integer',
'format' => 'int64',
'example' => '32',
],
'effectionLevel' => [
'title' => '根据影响等级时间等级分组统计数量',
'description' => '根据影响等级时间等级分组统计数量',
'type' => 'object',
'example' => '{"P1HIGH":32}',
],
'meanTimeToAcknowledge' => [
'title' => '当日平均响应时间单位秒',
'description' => '当日平均响应时间单位秒',
'type' => 'integer',
'format' => 'int64',
'example' => '323',
],
'meanTimeToRepair' => [
'title' => '当日平均完结时间单位秒',
'description' => '当日平均完结时间单位秒',
'type' => 'integer',
'format' => 'int64',
'example' => '4343',
],
'totalMeanTimeToAcknowledge' => [
'title' => '总平均响应时间',
'description' => '总平均响应时间',
'type' => 'integer',
'format' => 'int64',
'example' => '3334',
],
'totalMeanTimeToRepair' => [
'title' => '总平均完结时间',
'description' => '总平均完结时间',
'type' => 'integer',
'format' => 'int64',
'example' => '4343',
],
'escalationIncidentCount' => [
'title' => '升级事件数',
'description' => '升级事件数',
'type' => 'integer',
'format' => 'int64',
'example' => '43',
],
'unAcknowledgedEscalationIncidentCount' => [
'title' => '未响应升级事件数',
'description' => '未响应升级事件数',
'type' => 'integer',
'format' => 'int64',
'example' => '23',
],
'unFinishEscalationIncidentCount' => [
'title' => '未完结升级事件数',
'description' => '未完结升级事件数',
'type' => 'integer',
'format' => 'int64',
'example' => '23',
],
],
],
],
],
],
],
],
'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":"\\n 1231212\\n \\n \\n 32\\n 323\\n 4343\\n 3334\\n 4343\\n 43\\n 23\\n 23\\n \\n","errorExample":""}]',
'title' => '数据报表图表数据接口(服务组)',
'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',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgemp20VVML',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'startTime' => [
'title' => '开始时间',
'description' => '开始时间。',
'type' => 'string',
'required' => false,
'example' => '2021-09-01',
],
'endTime' => [
'title' => '结束时间',
'description' => '结束时间。',
'type' => 'string',
'required' => false,
'example' => '2021-09-30',
],
'pageNumber' => [
'title' => '当前页',
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'pageSize' => [
'title' => '页大小',
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'CAB6E15D-ECE8-54A4-87C3-D701862DD4A2',
],
'data' => [
'title' => '个人统计数据',
'description' => '个人统计数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'userName' => [
'title' => '用户名字',
'description' => '用户名字。',
'type' => 'string',
'example' => 'wy',
],
'escalationIncidentCount' => [
'title' => '升级事件数量',
'description' => '升级事件数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'distributionIncidentCount' => [
'title' => '分配事件数量',
'description' => '分配事件数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'finishIncidentNumber' => [
'title' => '完结事件数量',
'description' => '完结事件数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'unAcknowledgedEscalationIncidentCount' => [
'title' => '未响应升级数',
'description' => '未响应升级数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'unFinishEscalationIncidentCount' => [
'title' => '未完结事件数',
'description' => '未完结事件数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'meanTimeToAcknowledge' => [
'title' => 'MRRA',
'description' => '事件平均接手响应时间。',
'type' => 'string',
'example' => '3分50秒',
],
'meanTimeToRepair' => [
'title' => 'MTTA',
'description' => '事件平均完结时间。',
'type' => 'string',
'example' => '3分50秒',
],
'unDistributionIncidentCount' => [
'title' => '非分配完结数',
'description' => '非分配完结数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'finishProportion' => [
'title' => '完结率',
'description' => '完结率。',
'type' => 'string',
'example' => '20%',
],
'userId' => [
'title' => '用户ID',
'description' => '用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1111',
],
],
],
],
'totalCount' => [
'title' => '总条数',
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
'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":"\\n \\n wy\\n 100\\n 100\\n 100\\n 100\\n 100\\n 3分50秒\\n 3分50秒\\n 100\\n 20%\\n \\n","errorExample":""}]',
'title' => '查询个人事件统计数据',
'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": "主账号",'."\n"
.' "userId": 171628425,'."\n"
.' "finishIncidentNumber": 0,'."\n"
.' "unDistributionIncidentCount": 0'."\n"
.' }'."\n"
.' ],'."\n"
.' "requestId": "63667D16-6C2A-51DB-8A6A-280F1D6F251A",'."\n"
.' "totalCount": 1'."\n"
.'}'."\n"
.'```',
],
'ListChartDataForUser' => [
'summary' => '数据报表图表数据接口(人员)。',
'path' => '/statistics/chartDataForUser/',
'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' => [
'FEATUREgempTZ0FO2',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'clientToken' => [
'description' => '幂等校验ID。',
'type' => 'string',
'required' => false,
'example' => '3232dsd32sd32gr',
],
'startTime' => [
'title' => '开始时间',
'description' => '开始时间。',
'type' => 'string',
'required' => false,
'example' => '2021-09-09',
],
'endTime' => [
'title' => '结束时间',
'description' => '结束时间。',
'type' => 'string',
'required' => false,
'example' => '2021-10-09',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '0F4AFF8E-DF59-5CA6-B184-9E5A2A14C8D6',
],
'data' => [
'title' => 'data',
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '数据内容。',
'type' => 'object',
'properties' => [
'time' => [
'title' => '时间',
'description' => '时间。',
'type' => 'string',
'example' => '2021-09-09',
],
'incidentCount' => [
'title' => '时间总数',
'description' => '时间总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '32',
],
'effectionLevel' => [
'title' => '根据影响等级时间等级分组统计数量',
'description' => '根据影响等级时间等级分组统计数量。',
'type' => 'object',
'example' => '{"P1HIGH":32}',
],
'meanTimeToAcknowledge' => [
'title' => '当日平均响应时间单位秒',
'description' => '当日平均响应时间单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '323',
],
'meanTimeToRepair' => [
'title' => '当日平均完结时间单位秒',
'description' => '当日平均完结时间单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '4343',
],
'totalMeanTimeToAcknowledge' => [
'title' => '总平均响应时间',
'description' => '总平均响应时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '3334',
],
'totalMeanTimeToRepair' => [
'title' => '总平均完结时间',
'description' => '总平均完结时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '4343',
],
'escalationIncidentCount' => [
'title' => '升级事件数',
'description' => '升级事件数。',
'type' => 'integer',
'format' => 'int64',
'example' => '43',
],
'unAcknowledgedEscalationIncidentCount' => [
'title' => '未响应升级事件数',
'description' => '未响应升级事件数。',
'type' => 'integer',
'format' => 'int64',
'example' => '23',
],
'unFinishEscalationIncidentCount' => [
'title' => '未完结升级事件数',
'description' => '未完结升级事件数。',
'type' => 'integer',
'format' => 'int64',
'example' => '23',
],
],
],
],
],
],
],
],
'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":"\\n 1231212\\n \\n \\n 32\\n 323\\n 4343\\n 3334\\n 4343\\n 43\\n 23\\n 23\\n \\n","errorExample":""}]',
'title' => '数据报表图表数据接口(人员)',
'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',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempHBPHMV',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '参数描述。',
'type' => 'object',
'properties' => [
'keys' => [
'title' => 'keys',
'description' => '参数关键字。',
'type' => 'array',
'items' => [
'description' => '对象存储key。',
'type' => 'string',
'required' => false,
'example' => 'oss key',
],
'required' => false,
],
'problemId' => [
'title' => '故障id',
'description' => '故障ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '50002020',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应描述。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => 'xxxxxx',
],
'data' => [
'description' => '数据内容。',
'type' => 'object',
'properties' => [
'links' => [
'title' => 'array',
'description' => '图片列表。',
'type' => 'array',
'items' => [
'description' => '图片列表。',
'type' => 'object',
'properties' => [
'key' => [
'title' => 'oss key',
'description' => '图片唯一标识。',
'type' => 'string',
'example' => 'problem/38b2a36d-484d-4242-b9cf-d243e5*****',
],
'link' => [
'title' => 'url',
'description' => 'OSS Bucket地址。',
'type' => 'string',
'example' => 'http://*****-bucket.oss-cn-shanghai.aliyuncs.com/problem/38b2a36d-484d-4242-b9cf-d243e53a82c6?Expires=1625662477&OSSAccessKeyId=LTAI****************&Signature=1NFnt%2BnudD%2F%2BHVc31b6v5%2FF*****',
],
],
],
],
],
],
],
],
],
],
'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":"\\n xxxxxx\\n \\n \\n problem/38b2a36d-484d-4242-b9cf-d243e5*****\\n http://*****-bucket.oss-cn-shanghai.aliyuncs.com/problem/38b2a36d-484d-4242-b9cf-d243e53a82c6?Expires=1625662477&OSSAccessKeyId=LTAI5tEoRVPw8GMy1i*****&Signature=1NFnt%2BnudD%2F%2BHVc31b6v5%2FF*****\\n \\n \\n","errorExample":""}]',
'title' => '生成图片链接',
'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"
.'}',
],
'RemoveIntegrationConfig' => [
'summary' => '解除集成配置。',
'path' => '/integrationConfig/remove',
'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' => [
'FEATUREgempSLACC7',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'description' => '集成配置ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '103',
],
'clientToken' => [
'title' => '幂等id',
'description' => '幂等ID。',
'type' => 'string',
'required' => false,
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'requestId',
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IntegrationConfigExistsRouteRule',
'errorMessage' => 'integration config exists routeRule.',
],
],
403 => [
[
'errorCode' => 'IntegationConfigNotIntegrated',
'errorMessage' => 'The specified integration config is not integrated.',
],
[
'errorCode' => 'IntegationConfigAlreadyDisable',
'errorMessage' => 'The specified integration config is already disabled.',
],
],
[
[
'errorCode' => 'IntegationConfigNotExists',
'errorMessage' => 'The specified integration config does not exist.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\"\\n}","type":"json"}]',
'title' => '解除集成配置',
],
'ListByMonitorSourceId' => [
'summary' => '监控关联规则列表',
'path' => '/routeRule/listByMonitorSourceId',
'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' => [
'FEATUREgempBHVB81',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'title' => 'A short description of struct',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'monitorSourceId' => [
'description' => '监控源ID。',
'type' => 'string',
'required' => false,
'example' => '23469',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
'data' => [
'title' => 'data',
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'id' => [
'title' => '用户id',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '164769572',
],
'ruleName' => [
'description' => '规则名称。',
'type' => 'string',
'example' => 'internal-alert-center-log',
],
],
],
],
],
],
],
],
'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":"\\n 10REQUES-AC5C-4B59-BE11-378F117A6A88\\n \\n 123456\\n 监控1\\n \\n","errorExample":""}]',
'title' => '监控关联规则列表',
],
'ListRouteRulesByService' => [
'summary' => '根据服务id查询流转规则',
'path' => '/routeRule/listByService',
'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' => [
'FEATUREgempJRUU6V',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd381A',
],
'data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '规则列表。',
'type' => 'object',
'properties' => [
'id' => [
'title' => '规则id',
'description' => '规则ID。',
'type' => 'integer',
'format' => 'int32',
'example' => '60852564',
],
'ruleName' => [
'title' => '规则名称',
'description' => '规则名称。',
'type' => 'string',
'example' => '规则1',
],
],
],
],
'totalCount' => [
'title' => '流转规则数量',
'description' => '流转规则数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '103',
],
],
],
],
],
'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":"\\n 0\\n 12121212121\\n true\\n 200\\n \\n \\n 160044070\\n 1344383\\n 张2流转\\n 1\\n 0\\n 1\\n 140000080\\n \\n 1\\n 1\\n 0\\n 4\\n 130030040\\n 0\\n 0\\n 1344383\\n 2022-05-25 16:31:29\\n 2022-05-25 16:31:29\\n \\n \\n 63\\n 0\\n \\n 1\\n 0\\n 0\\n","errorExample":""}]',
'title' => '根据服务id查询流转规则',
],
'GetTenantStatus' => [
'summary' => '查询租户开通运维事件中心的状态',
'path' => '/tenant/getTenantStatus',
'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' => [
'FEATUREgempXF96RS',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'tenantRamId' => [
'description' => '租户ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '132649864',
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应结构。',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => ' 2E7566D1-9E4A-58FA-AEB1-179F86634256',
],
'data' => [
'type' => 'object',
'properties' => [
'tenantStatus' => [
'description' => '租户状态:'."\n"
.'- 0:已启用。'."\n"
.'- 1:未启用。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\" 2E7566D1-9E4A-58FA-AEB1-179F86634256\\",\\n \\"data\\": {\\n \\"tenantStatus\\": 1\\n }\\n}","type":"json"}]',
'title' => '查询租户开通运维事件中心的状态',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "data": {'."\n"
.' "tenantStatus": 1'."\n"
.' },'."\n"
.' "requestId": "6F4514FD-6CE6-5133-B5D8-2B556FCED7A2"'."\n"
.'}'."\n"
.'```',
],
'BillingStatistics' => [
'summary' => '计费展示',
'path' => '/charging/details',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'consumes' => [
'application/json',
],
'produces' => [
'application/json',
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREgempV73LIB',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'description' => '响应结构。',
'type' => 'object',
'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' => '系统控制下的查询状态:'."\n"
.'- true:开启查数据库。'."\n"
.'- false:关闭不查数据库。',
'type' => 'boolean',
'example' => 'true',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4A83AF20-B471-5646-A2CA-2DC688A13013',
],
],
],
],
],
'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' => '计费展示',
],
'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',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'type' => 'string',
],
],
],
],
],
'errorCodes' => [
401 => [
[
'errorCode' => 'DeleteServiceGroupSchedulingFail',
'errorMessage' => 'The service group has been associated with route rule. ',
],
],
],
'responseDemo' => '',
],
'ListEscalationPlansByNoticeObject' => [
'summary' => '根据推送对象查询升级策略',
'path' => '/escalationPlan/listByNoticeObject',
'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' => [
'FEATUREgempGUN0ZL',
],
],
'parameters' => [
[
'name' => 'body',
'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',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'escalationPlanId' => [
'type' => 'integer',
'format' => 'int64',
],
'escalationPlanName' => [
'type' => 'string',
],
'escalationPlanScopeObjects' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'scopeObjectId' => [
'type' => 'integer',
'format' => 'int64',
],
'scopeObjectName' => [
'type' => 'string',
],
'scope' => [
'type' => 'string',
],
'scopeObjectDeletedType' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
'status' => [
'type' => 'string',
],
'modifyTime' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'responseDemo' => '',
],
'UnbindUser' => [
'summary' => '解绑用户',
'path' => '/user/unbind',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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',
],
],
],
],
],
'errorCodes' => [
401 => [
[
'errorCode' => 'UnbindUserFail',
'errorMessage' => 'The specified user does not exist.',
],
],
[
[
'errorCode' => 'UnbindUserFail',
'errorMessage' => 'Not find userId.',
],
],
[
[
'errorCode' => 'UnbindUserFail',
'errorMessage' => 'Mobile app not opened.',
],
],
],
'responseDemo' => '',
],
'ListRouteRulesByAssignWhoId' => [
'summary' => '获取指定分配对象的流转规则',
'path' => '/routeRule/listByAssignWhoId',
'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' => [
'FEATUREgempJRUU6V',
],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'assignWhoId' => [
'type' => 'integer',
'format' => 'int64',
],
'assignWhoType' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'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',
],
],
],
],
],
],
],
],
'responseDemo' => '',
],
'ListServiceGroupsByUserId' => [
'summary' => '根据成员id查服务组',
'path' => '/services/group/listByUserId',
'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' => [
'FEATUREgemp1A354K',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'requestId' => [
'type' => 'string',
],
'data' => [
'type' => 'object',
'properties' => [
'serviceGroupId' => [
'type' => 'integer',
'format' => 'int64',
],
'isScheduled' => [
'type' => 'boolean',
],
'serviceGroupName' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '',
],
],
'endpoints' => [
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'gemp.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'gemp.cn-shanghai.aliyuncs.com',
],
],
];