'1.0',
'info' => [
'style' => 'ROA',
'product' => 'GEMP',
'version' => '2021-04-13',
],
'directories' => [
[
'id' => 167154,
'title' => null,
'type' => 'directory',
'children' => [
'CreateIntegrationConfig',
'DisableIntegrationConfig',
'EnableIntegrationConfig',
'GetIntegrationConfig',
'ListIntegrationConfigs',
'ListIntegrationConfigTimelines',
'ConfirmIntegrationConfig',
'DeleteIntegrationConfig',
'UpdateIntegrationConfig',
'RefreshIntegrationConfigKey',
],
],
[
'id' => 167201,
'title' => null,
'type' => 'directory',
'children' => [
'GetUserGuideStatus',
'UpdateUserGuideStatus',
'CreateUser',
'DeleteUser',
'GetUser',
'ListUsers',
'UpdateUser',
'ListUserSerivceGroups',
],
],
[
'id' => 167134,
'title' => null,
'type' => 'directory',
'children' => [
'ListServiceGroupMonitorSourceTemplates',
'ListDataReportForServiceGroup',
'CheckWebhook',
'EnableServiceGroupWebhook',
'CreateServiceGroup',
'DeleteServiceGroup',
'DeleteServiceGroupUser',
'GetServiceGroup',
'ListServiceGroups',
'UpdateServiceGroup',
'DisableServiceGroupWebhook',
],
],
[
'id' => 198423,
'title' => null,
'type' => 'directory',
'children' => [
'GetServiceGroupSpecialPersonScheduling',
'GetServiceGroupSchedulingPreview',
'GetServiceGroupPersonScheduling',
'CreateServiceGroupScheduling',
'GetServiceGroupScheduling',
'UpdateServiceGroupSpecialDayScheduling',
'UpdateServiceGroupScheduling',
],
],
[
'id' => 167129,
'title' => null,
'type' => 'directory',
'children' => [
'CreateService',
'DeleteService',
'GetService',
'ListServices',
'UpdateService',
],
],
[
'id' => 167145,
'title' => null,
'type' => 'directory',
'children' => [
'CreateRouteRule',
'DeleteRouteRule',
'DisableRouteRule',
'EnableRouteRule',
'GetRouteRule',
'ListRouteRules',
'UpdateRouteRule',
'VerifyRouteRule',
],
],
[
'id' => 167149,
'title' => null,
'type' => 'directory',
'children' => [
'CreateSubscription',
'DeleteSubscription',
'EnableSubscription',
'UpdateSubscription',
'GetSubscription',
'DisableSubscription',
'ListSubscriptions',
],
],
[
'id' => 167189,
'title' => null,
'type' => 'directory',
'children' => [
'CreateIncidentSubtotal',
'ListIncidentSubtotals',
'GetIncidentListByIdList',
'DeleteIncident',
'CreateIncident',
'DeliverIncident',
'GetIncident',
'GetIncidentStatistics',
'FinishIncident',
'UpdateIncident',
'RespondIncident',
'ListIncidents',
'ListIncidentDetailTimelines',
'ListIncidentTimelines',
[
'id' => 198426,
'title' => null,
'type' => 'directory',
'children' => [
'GetIncidentSubtotalCount',
'GetSimilarIncidentStatistics',
],
],
],
],
[
'id' => 198425,
'title' => null,
'type' => 'directory',
'children' => [
'ListTrendForSourceEvent',
'ListSourceEventsForMonitorSource',
'ListSourceEvents',
'ListAlerts',
'GetEvent',
],
],
[
'id' => 167162,
'title' => null,
'type' => 'directory',
'children' => [
'GeneratePictureUploadSign',
'ListProblemDetailOperations',
'UpdateProblemImprovement',
'ListSubscriptionServiceGroups',
'CreateProblem',
'CreateProblemMeasure',
'CreateProblemSubtotal',
'CreateProblemTimeline',
'CreateProblemTimelines',
'AddProblemServiceGroup',
'UpdateProblem',
'UpdateProblemNotice',
'UpdateProblemTimeline',
'GenerateProblemPictureUploadSign',
'ListProblemOperations',
'ListProblems',
'ListProblemSubtotals',
'CancelProblem',
'FinishProblem',
'RecoverProblem',
'ReplayProblem',
'RevokeProblemRecovery',
'GenerateProblemPictureLink',
'UpdateProblemEffectionService',
'DeleteProblemEffectionService',
'UpdateProblemMeasure',
'DeleteProblem',
'GetProblem',
'GetProblemImprovement',
'DeleteProblemMeasure',
'DeleteProblemTimeline',
'ListProblemTimeLines',
'GetProblemEffectionService',
'GetProblemPreview',
'RemoveProblemServiceGroup',
'CreateProblemEffectionService',
],
],
[
'id' => 198424,
'title' => null,
'type' => 'directory',
'children' => [
'GetResourceStatistics',
'ListConfigs',
'ListDictionaries',
'ListMonitorSources',
],
],
[
'id' => 198422,
'title' => null,
'type' => 'directory',
'children' => [
'CreateTenantApplication',
'GetTenantApplication',
],
],
[
'id' => 177155,
'title' => null,
'type' => 'directory',
'children' => [
'PushMonitor',
],
],
[
'id' => 167181,
'title' => null,
'type' => 'directory',
'children' => [
'ListEscalationPlanServices',
'CreateEscalationPlan',
'DeleteEscalationPlan',
'DisableEscalationPlan',
'EnableEscalationPlan',
'GetEscalationPlan',
'ListEscalationPlans',
'UpdateEscalationPlan',
],
],
[
'id' => 167147,
'title' => null,
'type' => 'directory',
'children' => [
'CreateRichText',
'GetRichText',
'UpdateRichText',
],
],
[
'id' => 177100,
'title' => null,
'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',
'properties' => [
'monitorSourceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'required' => false,
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'integrationConfigId' => [
'description' => '',
'example' => '101',
'format' => 'int64',
'title' => '集成配置id',
'type' => 'integer',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'integrationConfigId' => [
'description' => '',
'example' => '12345703',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'required' => false,
'title' => '幂等id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'title' => 'requestId',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'integrationConfigId' => [
'description' => '',
'example' => '101',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'required' => false,
'title' => '幂等id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'integrationConfigId' => [
'description' => '',
'example' => '68',
'format' => 'int64',
'required' => false,
'title' => '集成配置id',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'required' => false,
'title' => '幂等id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'integrationConfigId' => [
'description' => '',
'example' => '101',
'format' => 'int64',
'title' => '集成配置id、',
'type' => 'integer',
],
'monitorSourceId' => [
'description' => '',
'example' => '65',
'format' => 'int64',
'title' => '监控源id',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'example' => 'Zabbix',
'title' => '监控源名称',
'type' => 'string',
],
'monitorSourceShortName' => [
'description' => '',
'example' => 'Zabbix',
'title' => '监控源简称',
'type' => 'string',
],
'accessKey' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'title' => '集成秘钥',
'type' => 'string',
],
'isReceivedEvent' => [
'description' => '',
'example' => 'True',
'title' => '是否接收报警',
'type' => 'boolean',
],
'status' => [
'description' => '',
'example' => 'INTEGRATED',
'title' => '集成配置状态,DISABLE 禁用,INTEGRATED 已集成,UNINTEGRATED未集成',
'type' => 'string',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'monitorSourceName' => [
'description' => '',
'example' => 'Zabbix',
'required' => false,
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'required' => false,
'title' => '幂等id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => '',
'properties' => [
'integrationConfigId' => [
'description' => '',
'example' => '1023',
'format' => 'int64',
'title' => '集成配置id',
'type' => 'integer',
],
'monitorSourceId' => [
'description' => '',
'example' => '87',
'format' => 'int64',
'title' => '监控源id',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'example' => 'Zabbix',
'title' => '监控源名城',
'type' => 'string',
],
'monitorSourceShortName' => [
'description' => '',
'example' => 'Zabbix',
'title' => '监控源简称',
'type' => 'string',
],
'isReceivedEvent' => [
'description' => '',
'example' => 'false',
'title' => '是否已接受报警',
'type' => 'boolean',
],
'status' => [
'description' => '',
'example' => 'NOT_INTEGRATED',
'title' => '集成配置状态',
'type' => 'string',
],
'monitorSourceType' => [
'title' => '0:非自定义监控源 1:自定义监控源',
'type' => 'integer',
'format' => 'int32',
],
],
'type' => 'object',
],
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'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' => [
'description' => 'A short description of struct',
'properties' => [
'integrationConfigId' => [
'description' => '',
'example' => '101',
'format' => 'int64',
'required' => false,
'title' => '集成配置id',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '分页参数',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'title' => '分页参数',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'required' => false,
'title' => '幂等参数',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'data' => [
'description' => 'data',
'items' => [
'description' => '',
'properties' => [
'title' => [
'description' => '',
'example' => '',
'title' => '主题',
'type' => 'string',
],
'description' => [
'description' => '',
'example' => '',
'title' => '描述',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2021-04-05 10:10:10',
'title' => '创建时间',
'type' => 'string',
],
],
'type' => 'object',
],
'type' => 'array',
],
'requestId' => [
'description' => 'requestId',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'title' => 'requestId',
'type' => 'string',
],
'totalCount' => [
'description' => 'totalCount',
'example' => '103',
'format' => 'int64',
'title' => 'totalCount',
'type' => 'integer',
],
'pageNumber' => [
'description' => 'pageNumber',
'example' => '1',
'format' => 'int64',
'title' => 'pageNumber',
'type' => 'integer',
],
'pageSize' => [
'description' => 'pageSize',
'example' => '10',
'format' => 'int64',
'title' => 'pageSize',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'integrationConfigId' => [
'description' => '',
'example' => '101',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'required' => false,
'title' => '幂等id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'integrationConfigId' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'required' => false,
'title' => '集成配置id',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'required' => false,
'title' => '幂等id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'integrationConfigId' => [
'description' => '',
'example' => '103',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'accessKey' => [
'description' => 'accessKey',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'required' => false,
'title' => '集成秘钥',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378F987A6A98',
'required' => false,
'title' => '幂等id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'integrationConfigId' => [
'description' => '',
'example' => '102',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'required' => false,
'title' => '幂等id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'key' => [
'description' => '',
'example' => '859FA6A2-AC5C-4B09-BE23-986F887H6A232',
'title' => '集成秘钥',
'type' => 'string',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'title' => '幂等校验',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'map',
'example' => '{ "data": { "monitorGuide": false, "userRamId": 1344371, "serviceGuide": false, "noticeGuide": false, "userGuide": true, "serviceGroupGuide": false, "routeRuleGuide": false, "incidentGuide": true }',
'title' => 'map',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'title' => '幂等校验',
'type' => 'string',
],
'guideAction' => [
'description' => '',
'example' => 'SERVICE_GROUP_GUIDE',
'required' => false,
'title' => 'INCIDENT_GUIDE 事件线 INCIDENT_GUIDE配置人员 USER_GUIDE 服务组 SERVICE_GROUP_GUIDE 服务 SERVICE_GUIDE 集成配置 MONITOR_GUIDE 流转规则 ROUTE_RULE_GUIDE 通知订阅 NOTICE_GUIDE',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n FD200FAE-E98F-496E-BFE6-4CE61E59A2E9\\n","errorExample":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'ramId' => [
'description' => '',
'example' => '4787654378343',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'phone' => [
'description' => '',
'example' => '188898989892',
'required' => false,
'type' => 'string',
],
'username' => [
'description' => '',
'example' => '',
'required' => false,
'type' => 'string',
],
'email' => [
'description' => '',
'example' => '5678@qq.com',
'required' => false,
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'required' => false,
'type' => 'string',
],
'roleIdList' => [
'title' => '角色ID列表',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'userId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'type' => 'integer',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'userId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '用户ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'title' => 'id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'userId' => [
'description' => '',
'example' => '63',
'format' => 'int64',
'required' => true,
'title' => '用户ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'properties' => [
'userId' => [
'description' => '',
'example' => '63',
'format' => 'int64',
'title' => '用户ID',
'type' => 'integer',
],
'ramId' => [
'description' => 'ramId',
'example' => '1344383',
'title' => 'ramId',
'type' => 'string',
],
'isEditableUser' => [
'description' => '',
'example' => 'true',
'title' => '是否可编辑',
'type' => 'boolean',
],
'accountType' => [
'description' => '',
'example' => 'SUB',
'title' => 'CUSTOMER:主账号,SUB:子账号',
'type' => 'string',
],
'email' => [
'description' => 'email',
'example' => '5678***@qq.com',
'title' => 'email',
'type' => 'string',
],
'username' => [
'description' => '',
'example' => '',
'title' => '用户昵称',
'type' => 'string',
],
'phone' => [
'description' => '',
'example' => '1390000****',
'title' => '用户手机号',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2021-09-09 09:09:09',
'title' => '创建时间',
'type' => 'string',
],
'isRelated' => [
'description' => '',
'example' => 'RELATE',
'title' => '是否关联',
'type' => 'string',
],
'serviceGroups' => [
'description' => '',
'items' => [
'properties' => [
'name' => [
'description' => '',
'example' => '山口组',
'title' => '服务组名称',
'type' => 'string',
],
'serviceGroupId' => [
'description' => '',
'example' => '10000',
'format' => 'int64',
'title' => '服务组ID',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '所属服务组',
'type' => 'array',
],
'roleIdList' => [
'title' => '角色ID列表',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
'roleNameList' => [
'title' => '角色名称列表',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'isActive' => [
'title' => '账号是否激活 1已激活 0未激活',
'type' => 'integer',
'format' => 'int64',
],
],
'title' => '用户',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'username' => [
'description' => '',
'example' => '张三',
'required' => false,
'title' => '人员名称',
'type' => 'string',
],
'phone' => [
'description' => '',
'example' => '1887879****',
'required' => false,
'title' => '人员手机号',
'type' => 'string',
],
'ramId' => [
'description' => '',
'example' => '1344383',
'required' => false,
'title' => 'ramID',
'type' => 'string',
],
'scene' => [
'description' => '',
'example' => 'USER_LIST',
'format' => 'int64',
'required' => false,
'title' => 'USER_LIST列表 ALL_USERS下拉',
'type' => 'integer',
],
'clientToken' => [
'description' => 'clientToken',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '分页参数',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'title' => '分页参数',
'type' => 'integer',
],
'synergyChannel' => [
'description' => '',
'example' => 'DINGDING',
'required' => false,
'title' => '移动应用协同渠道',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'title' => 'id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => '',
'properties' => [
'userId' => [
'description' => '',
'example' => '1234',
'format' => 'int64',
'title' => '用户id',
'type' => 'integer',
],
'ramId' => [
'description' => '',
'example' => '53624523',
'format' => 'int64',
'title' => '子账号ramId',
'type' => 'integer',
],
'username' => [
'description' => '',
'example' => '',
'title' => '用户名',
'type' => 'string',
],
'phone' => [
'description' => '',
'example' => '1390000****',
'title' => '手机',
'type' => 'string',
],
'email' => [
'description' => '',
'example' => '2345****@qq.com',
'title' => '邮箱',
'type' => 'string',
],
'isEditableUser' => [
'description' => '',
'example' => 'true',
'format' => 'int64',
'title' => '是否可编辑',
'type' => 'integer',
],
'accountType' => [
'description' => '',
'example' => 'SUB',
'format' => 'int64',
'title' => '账户类型',
'type' => 'integer',
],
'appAccount' => [
'description' => '',
'example' => '23456tre',
'title' => '移动应用账户',
'type' => 'string',
],
'synergyChannel' => [
'description' => '',
'example' => 'DINGDING',
'title' => '移动应用协同渠道',
'type' => 'string',
],
'isRelated' => [
'description' => '',
'example' => 'RELATED关联 NOT_RELATED 未关联',
'title' => '是否关联',
'type' => 'string',
],
'isOperation' => [
'title' => '是否可操作(删除,取消关联) 1可操作 0不可操作',
'type' => 'integer',
'format' => 'int32',
],
'isRam' => [
'title' => '是否是主账号 1是 0不是',
'type' => 'integer',
'format' => 'int32',
],
'roleIdList' => [
'title' => '角色ID列表',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
'roleNameList' => [
'title' => '角色名称列表',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'isActive' => [
'title' => '账号是否激活 1已激活 0未激活',
'type' => 'integer',
'format' => 'int64',
],
'gmtCreate' => [
'type' => 'string',
],
'gmtActive' => [
'type' => 'string',
],
],
'type' => 'object',
],
'title' => 'data',
'type' => 'array',
],
'totalCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '总条数',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '分页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '分页',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'ramId' => [
'description' => '',
'example' => '2243564',
'format' => 'int64',
'required' => false,
'title' => '用户ramId',
'type' => 'integer',
],
'phone' => [
'description' => '',
'example' => '18887878****',
'required' => false,
'title' => '手机号',
'type' => 'string',
],
'username' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '用户名',
'type' => 'string',
],
'email' => [
'description' => '',
'example' => '78799****@qq.com',
'required' => false,
'title' => '邮件',
'type' => 'string',
],
'userId' => [
'description' => '',
'example' => '111',
'format' => 'int64',
'required' => true,
'title' => '用户ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
'roleIdList' => [
'title' => '用户角色',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'userId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'required' => true,
'title' => '用户ID',
'type' => 'integer',
],
'clientToken' => [
'description' => 'clientToken',
'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef729f',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef7291',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'ramId' => [
'description' => '',
'example' => '321',
'format' => 'int64',
'title' => 'RAM子账号ID',
'type' => 'integer',
],
'userId' => [
'description' => '',
'example' => '321',
'format' => 'int64',
'title' => '用户ID',
'type' => 'integer',
],
'username' => [
'description' => '',
'example' => '小明',
'title' => '用户昵称',
'type' => 'string',
],
'phone' => [
'description' => '',
'example' => '1390000****',
'title' => '手机号',
'type' => 'string',
],
'email' => [
'description' => '',
'example' => '12121****@163.com',
'title' => '邮箱',
'type' => 'string',
],
'serviceGroups' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'title' => '服务组id',
'type' => 'integer',
],
'serviceGroupName' => [
'description' => '',
'example' => '服务组A',
'title' => '服务组名称',
'type' => 'string',
],
'serviceGroupDescription' => [
'description' => '',
'example' => '描述',
'title' => '服务组描述',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '人员所属服务组',
'type' => 'array',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'xxxx',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
'requestId' => [
'description' => '',
'example' => 'xxxxx',
'required' => false,
'title' => '请求ID',
'type' => 'string',
],
'serviceGroupId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'required' => false,
'title' => '服务组ID',
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxx',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'monitorSourceId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'title' => '监控源ID',
'type' => 'integer',
],
'templateId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'title' => '消息模版ID',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'example' => 'zabbix',
'title' => '监控报警源名字',
'type' => 'string',
],
'templateContent' => [
'description' => '',
'example' => '""',
'title' => '模板内容',
'type' => 'string',
],
'fields' => [
'description' => '',
'items' => [
'description' => '1',
'example' => '字段',
'type' => 'string',
],
'title' => '字段',
'type' => 'array',
],
],
'type' => 'object',
],
'title' => 'data',
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'extraInfo' => '"data":{'."\n"
.' "requestId":"550DB2BE-98DE-0368-A52C-8F6BC78CD113"'."\n"
.' }',
'requestParamsDescription' => '{"serviceGroupId":"180030020","clientToken":"ca65dca3-73d1-49a9-9020-04598f4c28ab"}',
],
'ListDataReportForServiceGroup' => [
'summary' => '查询服务组事件统计报表',
'path' => '/statistics/listDataReportForServiceGroup',
'methods' => [
'post',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'startTime' => [
'description' => '',
'example' => '2021-09-09',
'required' => false,
'title' => '开始时间',
'type' => 'string',
],
'endTime' => [
'description' => '',
'example' => '2021-09-30',
'required' => false,
'title' => '结束时间',
'type' => 'string',
],
'pageNumber' => [
'title' => '页码',
'type' => 'integer',
'format' => 'int64',
],
'pageSize' => [
'title' => '分页大小',
'type' => 'integer',
'format' => 'int64',
],
'serviceGroupName' => [
'description' => '',
'example' => 'A服务组',
'required' => false,
'title' => '服务组名称',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'serviceGroupName' => [
'description' => '',
'example' => '服务组',
'title' => '服务组名字',
'type' => 'string',
],
'incidentCount' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '事件数量',
'type' => 'integer',
],
'escalationIncidentCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '升级事件数量',
'type' => 'integer',
],
'unAcknowledgedEscalationIncidentCount' => [
'description' => '',
'example' => '200',
'format' => 'int64',
'title' => '未响应升级事件数量',
'type' => 'integer',
],
'unFinishEscalationIncidentCount' => [
'description' => '',
'example' => '200',
'format' => 'int64',
'title' => '未完成升级事件数量',
'type' => 'integer',
],
'serviceGroupId' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '服务组ID',
'type' => 'integer',
],
'meanTimeToAcknowledge' => [
'description' => 'MRRA',
'example' => '3分19秒',
'format' => 'int64',
'title' => 'MRRA',
'type' => 'integer',
],
'meanTimeToRepair' => [
'description' => 'MTTR',
'example' => '3分19秒',
'format' => 'int64',
'title' => 'MTTR',
'type' => 'integer',
],
'finishProportion' => [
'description' => '',
'example' => '19%',
'title' => '完结率',
'type' => 'string',
],
'finishIncidentCount' => [
'description' => '',
'example' => '111',
'format' => 'int64',
'title' => '事件完结数',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '统计数据',
'type' => 'array',
],
'pageSIze' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '页大小',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '当前页',
'type' => 'integer',
],
'totalCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '总数',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'requestParamsDescription' => '{'."\n"
.' "pageNumber": 1,'."\n"
.' "pageSize": 10,'."\n"
.' "startTime": "2021-11-02",'."\n"
.' "endTime": "2021-11-09",'."\n"
.' "clientToken": "ec1eba2b-cbd9-4daa-aa6e-d127a27989bc"'."\n"
.'}',
],
'CheckWebhook' => [
'summary' => '校验webhook地址',
'path' => '/services/check/webhook',
'methods' => [
'post',
],
'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' => [
'description' => 'A short description of struct',
'example' => 'body',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
'webhook' => [
'description' => '',
'example' => 'https://oapi.dingtalk.com/robot/send?access_token=XXX',
'required' => false,
'title' => 'webook地址',
'type' => 'string',
],
'webhookType' => [
'description' => '',
'example' => 'DING_GROUP',
'required' => false,
'title' => 'webhook地址类型 企业微信WEIXIN_GROUP 钉钉群 DING_GROUP 飞书 FEISHU_GROUP',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '服务组ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceGroupName' => [
'description' => '',
'example' => '冲上云霄',
'required' => true,
'title' => '服务小组名称',
'type' => 'string',
],
'userIds' => [
'description' => '',
'items' => [
'example' => '65',
'format' => 'int64',
'required' => true,
'type' => 'integer',
],
'required' => true,
'title' => '小组人员用户ID',
'type' => 'array',
],
'enableWebhook' => [
'description' => '',
'example' => 'ENABLE',
'required' => true,
'title' => 'ENABLE 启用 DISABLE 禁用',
'type' => 'string',
],
'webhookType' => [
'description' => '',
'example' => 'WEIXIN_GROUP',
'required' => true,
'title' => 'WEIXIN_GROUP微信 DING_GROUP钉钉 FEISHU_GROUP飞书',
'type' => 'string',
],
'serviceGroupDescription' => [
'description' => '',
'example' => '服务描述',
'required' => false,
'title' => '服务描述',
'type' => 'string',
],
'webhookLink' => [
'description' => 'webhooklink',
'example' => 'WWWWWWW',
'required' => true,
'title' => 'webhookLink',
'type' => 'string',
],
'monitorSourceTemplates' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'templateId' => [
'description' => '',
'example' => '111',
'format' => 'int64',
'required' => false,
'title' => '消息模版ID',
'type' => 'integer',
],
'monitorSourceId' => [
'description' => '',
'example' => '111',
'format' => 'int64',
'required' => false,
'title' => '监控源ID',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'example' => 'zabbix',
'required' => false,
'title' => '监控源名字',
'type' => 'string',
],
'templateContent' => [
'description' => '',
'example' => 'xx',
'required' => false,
'title' => '模板内容',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '监控源消息模版',
'type' => 'array',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'example' => '1',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'title' => '服务组ID',
'type' => 'integer',
],
],
'title' => '服务组ID',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'required' => false,
'title' => '服务组ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '66666',
'format' => 'int64',
'required' => false,
'title' => '服务组ID',
'type' => 'integer',
],
'oldUserId' => [
'description' => '',
'example' => '777777',
'format' => 'int64',
'required' => false,
'title' => '老的用户ID',
'type' => 'integer',
],
'newUserId' => [
'description' => '',
'example' => '88888',
'format' => 'int64',
'required' => false,
'title' => '新的用户',
'type' => 'integer',
],
'removeUser' => [
'description' => '',
'example' => 'true',
'required' => false,
'title' => '删除服务组成员',
'type' => 'boolean',
],
'clientToken' => [
'description' => '',
'example' => 'xxxxxx',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"\\n xxxxxx\\n","errorExample":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '2323232',
'format' => 'int64',
'required' => false,
'title' => '服务组ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => '请求ID',
'type' => 'string',
],
'data' => [
'description' => '',
'properties' => [
'updateTime' => [
'description' => '',
'example' => '2020-05-03 15:39:39',
'title' => '修改时间',
'type' => 'string',
],
'users' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'userId' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '用户ID',
'type' => 'integer',
],
'userName' => [
'description' => '',
'example' => 'jack',
'title' => '用户名字',
'type' => 'string',
],
'phone' => [
'description' => '',
'example' => '1390000****',
'title' => '手机号',
'type' => 'string',
],
'serviceGroupId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '服务组ID',
'type' => 'integer',
],
'roleNameList' => [
'title' => '角色列表',
'type' => 'array',
'items' => [
'title' => '角色名称',
'type' => 'string',
'example' => '测试',
],
],
],
'type' => 'object',
],
'title' => '用户ID',
'type' => 'array',
],
'serviceGroupDescription' => [
'description' => '',
'example' => '服务描述',
'title' => '服务组描述',
'type' => 'string',
],
'webhookLink' => [
'description' => '',
'example' => 'wwwwwww',
'title' => 'webhook 跳转地址',
'type' => 'string',
],
'webhookType' => [
'description' => '',
'example' => 'WEIXIN_GROUP',
'title' => 'WEIXIN_GROUP 微信 DING_GROUP 钉钉 FEISHU_GROUP飞书',
'type' => 'string',
],
'enableWebhook' => [
'description' => '',
'example' => 'ENABLE',
'title' => 'ENABLE 启用 DISABLE 禁用',
'type' => 'string',
],
'serviceGroupName' => [
'description' => '',
'example' => '冲上云霄',
'title' => '服务组名称',
'type' => 'string',
],
'serviceGroupId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'title' => '服务组ID',
'type' => 'integer',
],
'createTime' => [
'description' => '',
'example' => '2020-08-08 10:00:00',
'title' => '创建时间',
'type' => 'string',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'queryName' => [
'description' => '',
'example' => '王宇',
'required' => false,
'title' => '搜索名称',
'type' => 'string',
],
'queryType' => [
'description' => '',
'example' => 'USER',
'required' => false,
'title' => '搜索类型。USER用户 SERVICEGROUP服务组',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '当前页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'title' => '页大小',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
'isScheduled' => [
'description' => '',
'example' => 'false',
'required' => false,
'title' => '是否已经排班',
'type' => 'boolean',
],
'orderByScheduleStatus' => [
'description' => '',
'example' => 'false',
'required' => false,
'title' => '是否根据排班状态排序',
'type' => 'boolean',
],
'userId' => [
'description' => '',
'example' => '100000',
'format' => 'int64',
'required' => false,
'title' => '用户ID',
'type' => 'integer',
],
'serviceId' => [
'title' => '服务的查询',
'type' => 'integer',
'format' => 'int64',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'sssss',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '服务组ID',
'type' => 'integer',
],
'isScheduled' => [
'description' => '',
'example' => 'true',
'title' => '是否已经排班',
'type' => 'boolean',
],
'serviceGroupName' => [
'description' => '',
'example' => '服务组',
'title' => '服务组名字',
'type' => 'string',
],
'serviceGroupDescription' => [
'description' => '',
'example' => '服务描述',
'title' => '服务组描述',
'type' => 'string',
],
'updateTime' => [
'description' => '',
'example' => '2020-08-09 15:50:30',
'title' => '修改时间',
'type' => 'string',
],
'enableWebhook' => [
'description' => '',
'example' => 'ENABLE',
'title' => 'ENABLE 启用 DISABLE 禁用',
'type' => 'string',
],
'webhookType' => [
'description' => '',
'example' => 'WEIXIN_GROUP',
'title' => 'WEIXIN_GROUP微信DING_GROUP钉钉FEISHU_GROUP飞书',
'type' => 'string',
],
'webhookLink' => [
'description' => '',
'example' => 'wwwwwwwwww',
'title' => 'webhook 跳转地址',
'type' => 'string',
],
'users' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'userId' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '用户ID',
'type' => 'integer',
],
'userName' => [
'description' => '',
'example' => 'jack',
'title' => '用户名字',
'type' => 'string',
],
'serviceGroupId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '服务组ID',
'type' => 'integer',
],
'phone' => [
'description' => '',
'example' => '1390000****',
'title' => '手机号',
'type' => 'string',
],
'email' => [
'description' => '',
'example' => 'wy930***@163.com',
'title' => '邮箱',
'type' => 'string',
],
'isRelated' => [
'format' => 'int32',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '服务组用户列表',
'type' => 'array',
],
],
'type' => 'object',
],
'title' => '服务组列表',
'type' => 'array',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '当前页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '分页大小',
'type' => 'integer',
],
'totalCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '总条数',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '服务组ID',
'type' => 'integer',
],
'enableWebhook' => [
'description' => '',
'example' => 'ENABLE',
'required' => true,
'title' => 'ENABLE 启用 DISABLE 禁用',
'type' => 'string',
],
'webhookType' => [
'description' => '',
'example' => 'WEIXINGROUP',
'required' => true,
'title' => 'WEIXIN_GROUP微信DING_GROUP钉钉FEISHU_GROUP飞书',
'type' => 'string',
],
'webhookLink' => [
'description' => '',
'example' => 'wwwwwww',
'required' => true,
'title' => 'webhook跳转地址',
'type' => 'string',
],
'serviceGroupName' => [
'description' => '',
'example' => '冲上云霄',
'required' => true,
'title' => '服务组名字',
'type' => 'string',
],
'serviceGroupDescription' => [
'description' => '',
'example' => '飞车',
'required' => false,
'title' => '服务描述',
'type' => 'string',
],
'userIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '55',
'format' => 'int64',
'required' => true,
'type' => 'integer',
],
'required' => true,
'title' => '用户ID列表修改后的',
'type' => 'array',
],
'monitorSourceTemplates' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'templateId' => [
'description' => '',
'example' => '1111',
'format' => 'int64',
'required' => false,
'title' => '消息模版ID',
'type' => 'integer',
],
'monitorSourceId' => [
'description' => '',
'example' => '11111',
'format' => 'int64',
'required' => false,
'title' => '监控报警源Id',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'example' => 'zabbix',
'required' => false,
'title' => '监控报警源',
'type' => 'string',
],
'templateContent' => [
'description' => '',
'example' => 'xxxx',
'required' => false,
'title' => '消息模版内容',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '监控源模版列表',
'type' => 'array',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '服务组ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'userId' => [
'description' => '',
'example' => '66666',
'format' => 'int64',
'required' => true,
'title' => '用户ID',
'type' => 'integer',
],
'serviceGroupId' => [
'description' => '',
'example' => '77777',
'format' => 'int64',
'required' => false,
'title' => '服务组ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingStartTime' => [
'description' => '',
'example' => '2021-08-17 00:00:00',
'title' => '排班开始时间',
'type' => 'string',
],
'schedulingEndTime' => [
'description' => '',
'example' => '2021-08-17 12:00:00',
'title' => '排班结束时间',
'type' => 'string',
],
'schedulingDate' => [
'description' => '',
'example' => '2021-08-17',
'title' => '排班日期',
'type' => 'string',
],
'serviceGroupId' => [
'description' => '',
'example' => '8888',
'format' => 'int64',
'title' => '服务组id',
'type' => 'integer',
],
'serviceGroupName' => [
'description' => '',
'example' => '刘德华',
'title' => '服务组名字',
'type' => 'string',
],
'schedulingUserId' => [
'description' => '',
'example' => '111111',
'format' => 'int64',
'title' => '排班用户ID',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '人员排班信息',
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'requestParamsDescription' => '{'."\n"
.' "userId" : 66666,'."\n"
.' "serviceGroupId" : 77777,'."\n"
.' "clientToken" : "C4BE3837-1A13-413B-A225-2C88188E8A43",'."\n"
.' "startTime" : "2020-09-01 00:00:00",'."\n"
.' "endTime" : "2020-09-31 23:59:59"'."\n"
.'}'."\n",
],
'GetServiceGroupSchedulingPreview' => [
'summary' => '预览服务组排班',
'path' => '/services/group/scheduling/preview',
'methods' => [
'post',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '55555',
'format' => 'int64',
'required' => true,
'title' => '服务组ID',
'type' => 'integer',
],
'schedulingWay' => [
'description' => '',
'example' => 'FAST',
'required' => true,
'title' => '排班方式 FAST 快速排班 FINE 精细排班',
'type' => 'string',
],
'fastScheduling' => [
'description' => '',
'properties' => [
'singleDuration' => [
'description' => '',
'example' => '12',
'format' => 'int32',
'required' => false,
'title' => '每人排班时长',
'type' => 'integer',
],
'dutyPlan' => [
'description' => 'FAST_CHOICE',
'example' => 'FAST_CHOICE',
'required' => false,
'title' => '值班方案 dutyPlan FAST_CHOICE 快速选择 CUSTOM 自定义',
'type' => 'string',
],
'singleDurationUnit' => [
'description' => 'DAY',
'example' => 'DAY',
'required' => false,
'title' => '每人排班时长单位 HOUR 小时 DAY 天',
'type' => 'string',
],
'schedulingUsers' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingUserId' => [
'description' => '',
'example' => '122222',
'format' => 'int64',
'required' => false,
'title' => '轮班用户ID',
'type' => 'integer',
],
'schedulingOrder' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '排班顺序',
'type' => 'integer',
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '快速轮班用户',
'type' => 'array',
],
],
'required' => false,
'title' => '快速排班',
'type' => 'object',
],
'fineScheduling' => [
'description' => '',
'properties' => [
'period' => [
'description' => '',
'example' => '2',
'format' => 'int32',
'required' => false,
'title' => '循环周期',
'type' => 'integer',
],
'periodUnit' => [
'description' => '',
'example' => 'DAY',
'required' => false,
'title' => '循环周期单位 HOUR 小时 DAY 天',
'type' => 'string',
],
'shiftType' => [
'description' => '',
'example' => 'MORNING_NIGHT',
'required' => false,
'title' => '班次类型 MORNING_NIGHT 早晚班 MORNING_NOON_NIGHT 早中晚班 CUSTOM 自定义',
'type' => 'string',
],
'schedulingFineShifts' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingStartTime' => [
'description' => '',
'example' => '2020-08-13',
'required' => false,
'title' => '排班开始时间',
'type' => 'string',
],
'schedulingEndTime' => [
'description' => '',
'example' => '2020-10-13',
'required' => false,
'title' => '排班结束时间',
'type' => 'string',
],
'schedulingOrder' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '排班顺序',
'type' => 'integer',
],
'shiftName' => [
'description' => '',
'example' => '早班',
'required' => false,
'title' => '班次名称',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '精细排班班次人员信息',
'type' => 'array',
],
],
'required' => false,
'title' => '精细排',
'type' => 'object',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
'endTime' => [
'description' => '',
'example' => '2021-09-01 00:00:00',
'required' => false,
'title' => '排班结束时间',
'type' => 'string',
],
'startTime' => [
'description' => '',
'example' => '2021-11-01 00:00:00',
'required' => false,
'title' => '排班开始时间',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxxxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'title' => '服务组排班信息',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'userId' => [
'description' => '',
'example' => '66666',
'format' => 'int64',
'required' => false,
'title' => '用户ID',
'type' => 'integer',
],
'serviceGroupId' => [
'description' => '',
'example' => '77777',
'format' => 'int64',
'required' => false,
'title' => '服务组ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
'startTime' => [
'description' => '',
'example' => '2020-09-01 00:00:00',
'required' => false,
'title' => '排班开始时间',
'type' => 'string',
],
'endTime' => [
'description' => '',
'example' => '2020-09-31 00:00:00',
'required' => false,
'title' => '排班结束时间',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'title' => '排班日历',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'required' => true,
'title' => '服务组ID',
'type' => 'integer',
],
'schedulingWay' => [
'description' => '',
'example' => 'FAST',
'required' => true,
'title' => '排班方式 FAST 快速排班 FINE 精细排班',
'type' => 'string',
],
'fastScheduling' => [
'description' => '',
'example' => '12',
'properties' => [
'singleDuration' => [
'description' => '',
'example' => '12',
'format' => 'int32',
'required' => false,
'title' => '每人排班时长',
'type' => 'integer',
],
'dutyPlan' => [
'description' => '',
'example' => 'FAST_CHOICE',
'required' => false,
'title' => '值班方案 dutyPlan FAST_CHOICE 快速选择 CUSTOM 自定义',
'type' => 'string',
],
'singleDurationUnit' => [
'description' => '',
'example' => 'DAY',
'required' => false,
'title' => '每人排班时常单位 HOUR 小时 DAY 天',
'type' => 'string',
],
'schedulingUsers' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingUserId' => [
'description' => '',
'example' => '6666',
'format' => 'int64',
'required' => false,
'title' => '轮班用户ID',
'type' => 'integer',
],
'schedulingOrder' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '排班顺序',
'type' => 'integer',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'type' => 'string',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '快速轮班用户',
'type' => 'array',
],
],
'required' => false,
'title' => '快速排班',
'type' => 'object',
],
'fineScheduling' => [
'description' => '',
'properties' => [
'period' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '循环周期',
'type' => 'integer',
],
'periodUnit' => [
'description' => '',
'example' => 'DAY',
'required' => false,
'title' => '循环周期单位 HOUR 小时 DAY 天',
'type' => 'string',
],
'shiftType' => [
'description' => '',
'example' => 'MORNING_NIGHT',
'required' => false,
'title' => '班次类型 MORNING_NIGHT 早晚班 MORNING_NOON_NIGHT 早中晚班 CUSTOM 自定义',
'type' => 'string',
],
'schedulingFineShifts' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingStartTime' => [
'description' => '',
'example' => '2020-08-13',
'required' => false,
'title' => '排班开始时间',
'type' => 'string',
],
'schedulingEndTime' => [
'description' => '',
'example' => '2020-10-13',
'required' => false,
'title' => '排班结束时间',
'type' => 'string',
],
'schedulingOrder' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '排班顺序',
'type' => 'integer',
],
'skipOneDay' => [
'description' => '',
'example' => 'fasle',
'required' => false,
'title' => '是否跨天',
'type' => 'boolean',
],
'cycleOrder' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '循环次序',
'type' => 'integer',
],
'shiftName' => [
'description' => '',
'example' => '早班',
'required' => false,
'title' => '班次名称',
'type' => 'string',
],
'schedulingUserId' => [
'description' => '',
'example' => '11',
'format' => 'int64',
'required' => false,
'title' => '排班用户ID',
'type' => 'integer',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'type' => 'string',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '精细排班信息表',
'type' => 'array',
],
'schedulingTemplateFineShifts' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingStartTime' => [
'description' => '',
'example' => '2021-09-01 08:00:00',
'required' => false,
'title' => '排班开始时间',
'type' => 'string',
],
'schedulingEndTime' => [
'description' => '',
'example' => '2021-10-01 08:00:00',
'required' => false,
'title' => '排班结束时间',
'type' => 'string',
],
'schedulingOrder' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '排班顺序',
'type' => 'integer',
],
'schedulingUserId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '用户ID',
'type' => 'integer',
],
'schedulingUserName' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '用户名字',
'type' => 'string',
],
'skipOneDay' => [
'description' => '',
'example' => 'false',
'required' => false,
'title' => '是否跨天',
'type' => 'boolean',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'type' => 'string',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '精细排班模版',
'type' => 'array',
],
],
'required' => false,
'title' => '精细排班',
'type' => 'object',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxxxxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"xxxxxxxxxx\\"\\n}","errorExample":""},{"type":"xml","example":"\\n xxxxxxxxxx\\n","errorExample":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '9999',
'format' => 'int64',
'required' => true,
'title' => '服务组ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxxxxxxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'properties' => [
'schedulingWay' => [
'description' => '',
'example' => 'FINE',
'title' => '排班方式 FAST 快速排班 FINE 精细排班',
'type' => 'string',
],
'serviceGroupId' => [
'description' => '',
'example' => '99999',
'format' => 'int64',
'title' => '服务组ID',
'type' => 'integer',
],
'fastScheduling' => [
'description' => '',
'properties' => [
'singleDuration' => [
'description' => '',
'example' => '12',
'format' => 'int32',
'title' => '每人排班时长',
'type' => 'integer',
],
'dutyPlan' => [
'description' => '',
'example' => 'FAST_CHOICE',
'title' => '值班方案 dutyPlan FAST_CHOICE 快速选择 CUSTOM 自定义',
'type' => 'string',
],
'singleDurationUnit' => [
'description' => '',
'example' => 'DAY',
'title' => '每人排班时长单位 HOUR 小时 DAY 天',
'type' => 'string',
],
'schedulingUsers' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingUserId' => [
'description' => '',
'example' => '66666',
'format' => 'int64',
'title' => '轮班用户ID',
'type' => 'integer',
],
'schedulingOrder' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'title' => '排班顺序',
'type' => 'integer',
],
'schedulingUserName' => [
'description' => '',
'example' => '张杰',
'title' => '轮班用户名字',
'type' => 'string',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '快速轮班用户',
'type' => 'array',
],
'id' => [
'description' => '',
'example' => '2222',
'format' => 'int64',
'title' => '快速排班ID',
'type' => 'integer',
],
],
'title' => '快速排班',
'type' => 'object',
],
'fineScheduling' => [
'description' => '',
'properties' => [
'period' => [
'description' => '1',
'example' => '循环周期',
'format' => 'int32',
'title' => '1',
'type' => 'integer',
],
'id' => [
'description' => '1',
'example' => '精细排班ID',
'format' => 'int64',
'title' => '1',
'type' => 'integer',
],
'periodUnit' => [
'description' => '',
'example' => 'DAY',
'title' => '循环周期单位 HOUR 小时 DAY 天',
'type' => 'string',
],
'shiftType' => [
'description' => '',
'example' => 'MORNING_NIGHT',
'title' => '班次类型 MORNING_NIGHT 早晚班 MORNING_NOON_NIGHT 早中晚班 CUSTOM 自定义',
'type' => 'string',
],
'schedulingFineShifts' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingStartTime' => [
'description' => '',
'example' => '2020-08-13',
'title' => '排班开始时间',
'type' => 'string',
],
'schedulingEndTime' => [
'description' => '',
'example' => '2020-10-13',
'title' => '排班结束时间',
'type' => 'string',
],
'schedulingOrder' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'title' => '排班顺序',
'type' => 'integer',
],
'shiftName' => [
'description' => '',
'example' => '早班',
'title' => '班次名称',
'type' => 'string',
],
'cycleOrder' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '循环次序',
'type' => 'integer',
],
'schedulingUserId' => [
'description' => '',
'example' => '1111',
'format' => 'int64',
'title' => '排班用户ID',
'type' => 'integer',
],
'skipOneDay' => [
'description' => '',
'example' => 'false',
'title' => '是否跨天',
'type' => 'boolean',
],
'schedulingUserName' => [
'description' => '',
'example' => '刘德华',
'title' => '排班用户名字',
'type' => 'string',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
'schedulingObjectType' => [
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '精细排班班次人员信息',
'type' => 'array',
],
'schedulingTemplateFineShifts' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingStartTime' => [
'description' => '',
'example' => '2021-09-01 00:00:00',
'title' => '排班开始时间',
'type' => 'string',
],
'schedulingEndTime' => [
'description' => '',
'example' => '2021-10-01 00:00:00',
'title' => '排班结束时间',
'type' => 'string',
],
'schedulingOrder' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '排班顺序',
'type' => 'integer',
],
'schedulingUserId' => [
'description' => '',
'example' => '1',
'title' => '用户ID',
'type' => 'string',
],
'skipOneDay' => [
'description' => '',
'example' => 'true',
'title' => '是否跨天',
'type' => 'boolean',
],
'schedulingUserName' => [
'description' => '',
'example' => '',
'title' => '排班用户名字',
'type' => 'string',
],
'shiftName' => [
'description' => '',
'example' => '',
'title' => '班次名称',
'type' => 'string',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
'schedulingObjectType' => [
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '精细排班模版',
'type' => 'array',
],
],
'title' => '精细排班',
'type' => 'object',
],
'users' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'userId' => [
'description' => '',
'example' => '',
'format' => 'int64',
'title' => '用户ID',
'type' => 'integer',
],
'userName' => [
'description' => '',
'example' => '',
'title' => '用户名字',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '已经排班',
'type' => 'array',
],
],
'title' => '排班详情',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '6666',
'format' => 'int64',
'required' => true,
'title' => '服务组ID',
'type' => 'integer',
],
'schedulingDate' => [
'description' => '',
'example' => '2021-08-19',
'required' => true,
'title' => '排班日期',
'type' => 'string',
],
'schedulingSpecialDays' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingStartTime' => [
'description' => '',
'example' => '2021-08-19 08:00:00',
'required' => true,
'title' => '排班开始时间',
'type' => 'string',
],
'schedulingEndTime' => [
'description' => '',
'example' => '2021-08-19 12:00:00',
'required' => true,
'title' => '排班结束时间',
'type' => 'string',
],
'schedulingUserId' => [
'description' => '',
'example' => '64',
'format' => 'int64',
'required' => true,
'title' => '排班用户ID',
'type' => 'integer',
],
'schedulingOrder' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '班次顺序',
'type' => 'integer',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'type' => 'string',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '特殊排班信息',
'type' => 'array',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'required' => true,
'title' => '服务组ID',
'type' => 'integer',
],
'schedulingWay' => [
'description' => '',
'example' => 'FAST',
'required' => true,
'title' => '排班方式 FAST 快速排班 FINE 精细排班',
'type' => 'string',
],
'fastScheduling' => [
'description' => '',
'example' => 'HOUR',
'properties' => [
'singleDuration' => [
'description' => '',
'example' => '12',
'format' => 'int32',
'required' => false,
'title' => '每人排班时长',
'type' => 'integer',
],
'dutyPlan' => [
'description' => '',
'example' => 'FAST_CHOICE',
'required' => false,
'title' => '值班方案 dutyPlan FAST_CHOICE 快速选择 CUSTOM 自定义',
'type' => 'string',
],
'singleDurationUnit' => [
'description' => '',
'example' => 'DAY',
'required' => false,
'title' => '每人排班时长单位 HOUR 小时 DAY 天',
'type' => 'string',
],
'schedulingUsers' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingUserId' => [
'description' => '',
'example' => '6666',
'format' => 'int64',
'required' => false,
'title' => '轮班用户ID',
'type' => 'integer',
],
'schedulingOrder' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '排班顺序',
'type' => 'integer',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'type' => 'string',
],
'schedulingUserIdList' => [
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '快速轮班用户',
'type' => 'array',
],
'id' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '快速排班ID',
'type' => 'integer',
],
],
'required' => false,
'title' => '快速排班',
'type' => 'object',
],
'fineScheduling' => [
'description' => '',
'properties' => [
'period' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '循环周期',
'type' => 'integer',
],
'periodUnit' => [
'description' => '',
'example' => 'DAY',
'required' => false,
'title' => '循环周期单位 HOUR 小时 DAY 天',
'type' => 'string',
],
'shiftType' => [
'description' => '',
'example' => 'MORNING_NIGHT',
'required' => false,
'title' => '班次类型 MORNING_NIGHT 早晚班 MORNING_NOON_NIGHT 早中晚班 CUSTOM 自定义',
'type' => 'string',
],
'schedulingFineShifts' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingStartTime' => [
'description' => '',
'example' => '2020-08-13',
'required' => false,
'title' => '排班开始时间',
'type' => 'string',
],
'schedulingEndTime' => [
'description' => '',
'example' => '2020-10-13',
'required' => false,
'title' => '排班结束时间',
'type' => 'string',
],
'schedulingOrder' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '排班顺序',
'type' => 'integer',
],
'shiftName' => [
'description' => '',
'example' => '早班',
'required' => false,
'title' => '班次名称',
'type' => 'string',
],
'skipOneDay' => [
'description' => '',
'example' => 'true',
'required' => false,
'title' => '是否跨天',
'type' => 'boolean',
],
'schedulingUserId' => [
'description' => '',
'example' => '32',
'format' => 'int64',
'required' => false,
'title' => '排班用户ID',
'type' => 'integer',
],
'cycleOrder' => [
'description' => '',
'example' => '123',
'format' => 'int32',
'required' => false,
'title' => '轮训次序',
'type' => 'integer',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'type' => 'string',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '精细排班班次人员信息',
'type' => 'array',
],
'schedulingTemplateFineShifts' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'schedulingStartTime' => [
'description' => '',
'example' => '2021-10-01 00:00:00',
'required' => false,
'title' => '排班开始时间',
'type' => 'string',
],
'schedulingEndTime' => [
'description' => '',
'example' => '2021-11-01 00:00:00',
'required' => false,
'title' => '排班结束时间',
'type' => 'string',
],
'schedulingOrder' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '排班顺序',
'type' => 'integer',
],
'schedulingUserId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '排班用户ID',
'type' => 'integer',
],
'shiftName' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '班次名称',
'type' => 'string',
],
'skipOneDay' => [
'description' => '',
'example' => 'false',
'required' => false,
'title' => '是否跨天',
'type' => 'boolean',
],
'schedulingObjectType' => [
'title' => '排班对象类型',
'type' => 'string',
],
'schedulingUserIdList' => [
'title' => '多人排班时,人员Id',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '精细排班模版',
'type' => 'array',
],
'id' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '精细排班ID',
'type' => 'integer',
],
],
'required' => false,
'title' => '精细排班',
'type' => 'object',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxxxxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceDescription' => [
'description' => '',
'example' => '服务描述',
'required' => false,
'title' => '服务描述',
'type' => 'string',
],
'serviceName' => [
'description' => '',
'example' => '服务名称',
'required' => true,
'title' => '服务名称',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
'escalationPlanId' => [
'title' => '升级策略ID',
'type' => 'integer',
'format' => 'int64',
],
'serviceGroupIdList' => [
'title' => '服务组ID列表',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'example' => '1',
'properties' => [
'serviceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '服务ID',
'type' => 'integer',
],
],
'title' => '服务ID',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceId' => [
'description' => '',
'example' => '10002000',
'format' => 'int64',
'required' => false,
'title' => '服务ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '服务ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'properties' => [
'serviceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '服务ID',
'type' => 'integer',
],
'serviceName' => [
'description' => '',
'example' => '',
'title' => '服务名字',
'type' => 'string',
],
'serviceDescription' => [
'description' => '',
'example' => '',
'title' => '服务描述',
'type' => 'string',
],
'updateTime' => [
'description' => '',
'example' => '2020-03-08 12:53:53',
'title' => '修改时间',
'type' => 'string',
],
'serviceGroupIdList' => [
'title' => '服务组ID列表',
'type' => 'array',
'items' => [
'title' => '服务组ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
'default' => '1',
],
'minItems' => 0,
],
'escalationPlanId' => [
'title' => '升级策略ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
],
'title' => '服务详情',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceName' => [
'description' => '',
'example' => '冲上云霄',
'required' => false,
'title' => '服务名称',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '当前页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => true,
'title' => '页大小',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'items' => [
'properties' => [
'serviceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '服务ID',
'type' => 'integer',
],
'serviceName' => [
'description' => '',
'example' => '冲上云霄',
'title' => '服务名字',
'type' => 'string',
],
'serviceDescription' => [
'description' => '',
'example' => '服务描述',
'title' => '服务描述',
'type' => 'string',
],
'updateTime' => [
'description' => '',
'example' => '2020-09-08 14:30:30',
'title' => '修改时间',
'type' => 'string',
],
'isValid' => [
'format' => 'int32',
'type' => 'integer',
],
'escalationPlanName' => [
'title' => '升级策略名称',
'type' => 'string',
],
'escalationPlanId' => [
'title' => '升级策略ID',
'type' => 'integer',
'format' => 'int64',
],
'serviceGroupIdList' => [
'title' => '服务组ID列表',
'type' => 'array',
'items' => [
'title' => '服务组ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
'default' => '1',
],
],
],
'type' => 'object',
],
'type' => 'array',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '当前页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '页大小',
'type' => 'integer',
],
'totalCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '总条数',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceDescription' => [
'description' => '',
'example' => '服务描述',
'required' => false,
'title' => '服务描述',
'type' => 'string',
],
'serviceName' => [
'description' => '',
'example' => '服务名字',
'required' => false,
'title' => '服务名字',
'type' => 'string',
],
'serviceId' => [
'description' => '',
'example' => '10002000',
'format' => 'int64',
'required' => false,
'title' => '服务ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
'escalationPlanId' => [
'title' => '升级策略ID',
'type' => 'integer',
'format' => 'int64',
],
'serviceGroupIdList' => [
'title' => '服务组ID列表',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'example' => 'null',
'format' => 'int64',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => '代表创建时间的资源属性字段',
'properties' => [
'ruleName' => [
'description' => '',
'example' => '这是一个规则',
'format' => 'byte',
'required' => true,
'title' => '规则名称',
'type' => 'string',
],
'enableStatus' => [
'description' => '',
'example' => 'false',
'required' => false,
'title' => '启用状态',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'required' => true,
'title' => '关联服务ID',
'type' => 'integer',
],
'routeType' => [
'description' => '',
'example' => 'INCIDENT',
'required' => true,
'title' => '路由类型:INCIDENT 触发事件 ALERT仅触发报警',
'type' => 'string',
],
'incidentLevel' => [
'description' => '',
'example' => 'P1',
'required' => true,
'title' => '事件级别 P1 P2 P3 P4',
'type' => 'string',
],
'assignObjectId' => [
'description' => '',
'example' => '65',
'format' => 'int64',
'required' => true,
'title' => '事件分派对象ID(服务组ID 或用户ID)',
'type' => 'integer',
],
'assignObjectType' => [
'description' => '',
'example' => 'SERVICEGROUP',
'required' => true,
'title' => '事件分派对象类型 SERVICEGROUP服务组 USER 单个用户',
'type' => 'string',
],
'effection' => [
'description' => '',
'example' => 'LOW',
'required' => true,
'title' => '影响程度 LOW-一般 HIGH-严重',
'type' => 'string',
],
'timeWindow' => [
'description' => '',
'example' => '2',
'format' => 'int64',
'required' => true,
'title' => '时间窗口',
'type' => 'integer',
],
'matchCount' => [
'description' => '',
'example' => '3',
'format' => 'int32',
'required' => true,
'title' => '命中次数',
'type' => 'integer',
],
'timeWindowUnit' => [
'description' => '',
'example' => 'MINUTE',
'required' => true,
'title' => '时间窗口单位 MINUTE 分钟 SECOND 秒',
'type' => 'string',
],
'routeChildRules' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'monitorSourceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '监控源ID',
'type' => 'integer',
],
'conditions' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'key' => [
'description' => '',
'example' => 'payload.summary',
'required' => true,
'title' => '字段名称',
'type' => 'string',
],
'value' => [
'description' => '',
'example' => '123',
'required' => true,
'title' => '字段值',
'type' => 'string',
],
'operationSymbol' => [
'description' => '',
'example' => 'equals',
'required' => true,
'title' => '操作符号:notContain 不包含;contain 包含;equals 等于;notEquals 不等于;',
'type' => 'string',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '条件',
'type' => 'array',
],
'childConditionRelation' => [
'description' => '',
'example' => '0',
'format' => 'int64',
'required' => false,
'title' => '0-与,1-或',
'type' => 'integer',
],
'problemLevel' => [
'title' => '故障级别',
'type' => 'string',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '子规则',
'type' => 'array',
],
'notifyChannels' => [
'description' => '',
'items' => [
'description' => '',
'example' => '[SMS,PHONE]',
'required' => true,
'type' => 'string',
],
'required' => true,
'title' => '通知渠道。 SMS 短信 EMAIL 邮件 PHONE电话 WEIXIN_GROUP 企微群 DING_GROUP钉钉群',
'type' => 'array',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
'childRuleRelation' => [
'description' => '',
'example' => 'AND',
'required' => true,
'title' => '子规则关系AND,OR',
'type' => 'string',
],
'problemLevelGroup' => [
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'childRuleRelation' => [
'title' => '子规则关系,0与,1或',
'type' => 'integer',
'format' => 'int32',
],
'matchCount' => [
'title' => '抑制:命中次数',
'type' => 'integer',
'format' => 'int64',
],
'timeWindow' => [
'title' => '抑制:时间窗口',
'type' => 'integer',
'format' => 'int64',
],
'timeWindowUnit' => [
'title' => '抑制:时间窗口单位',
'type' => 'string',
],
'enableUpgrade' => [
'title' => '升级:是否升级',
'type' => 'boolean',
],
'upgradeTimeWindow' => [
'title' => '升级:时间窗口',
'type' => 'integer',
'format' => 'int64',
],
'upgradeTimeWindowUnit' => [
'title' => '升级:时间窗口单位',
'type' => 'string',
],
],
],
],
'coverageProblemLevels' => [
'title' => '故障等级覆盖',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'problemEffectionServices' => [
'title' => '故障影响服务',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
'convergenceFields' => [
'title' => '收敛字段集合',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'convergenceType' => [
'title' => '收敛类型(0:流转规则收敛,1:字段收敛)',
'type' => 'integer',
'format' => 'int32',
],
],
'required' => false,
'title' => '创建规则参数',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => '',
'example' => '请求ID',
'title' => '请求',
'type' => 'string',
],
'data' => [
'description' => '',
'example' => '65',
'properties' => [
'routeRuleId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'title' => '规则ID',
'type' => 'integer',
],
],
'title' => '结果',
'type' => 'object',
],
],
'title' => '响应参数',
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'routeRuleId' => [
'description' => '',
'example' => '10000',
'format' => 'int64',
'required' => true,
'title' => '规则ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'format' => 'int64',
'title' => '请求ID',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'routeRuleId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '请求ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => true,
'title' => '请求ID',
'type' => 'string',
],
'data' => [
'description' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'example' => 'null',
'format' => 'int64',
'title' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'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',
'properties' => [
'routeRuleId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '规则ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => true,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'properties' => [
'requestId' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => '请求ID',
'type' => 'string',
],
'data' => [
'description' => '',
'example' => 'null',
'format' => 'int32',
'type' => 'integer',
],
],
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'routeRuleId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '规则ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => '',
'example' => '6B9347ED-FD93-42B4-B9A4-7282962F5D6A',
'title' => '请求ID',
'type' => 'string',
],
'data' => [
'description' => '',
'properties' => [
'routeRuleId' => [
'description' => '',
'example' => '180000000',
'format' => 'int64',
'title' => '规则ID',
'type' => 'integer',
],
'ruleName' => [
'description' => '',
'example' => '规则1',
'title' => '流转规则名字',
'type' => 'string',
],
'timeWindow' => [
'description' => '',
'example' => '3',
'format' => 'int32',
'title' => '时间窗口',
'type' => 'integer',
],
'relatedServiceName' => [
'description' => '',
'example' => '冲上云霄',
'title' => '关联服务名称',
'type' => 'string',
],
'enableStatus' => [
'description' => '',
'example' => 'DISABLE',
'title' => '是否启用 DISABLE禁用 ENABLE 启用',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'title' => '关联服务ID',
'type' => 'integer',
],
'routeType' => [
'description' => '',
'example' => 'INCIDENT',
'title' => '路由类型:INCIDENT 触发事件 ALERT 仅触发报警',
'type' => 'string',
],
'incidentLevel' => [
'description' => '',
'example' => 'P1',
'title' => '事件级别 P1 P2 P3 P4',
'type' => 'string',
],
'assignObjectId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'title' => '事件分派对象ID(服务组ID 或用户ID)',
'type' => 'integer',
],
'assignObjectType' => [
'description' => '',
'example' => 'SERVICEGROUP',
'title' => '事件分派对象类型 SERVICEGROUP 服务组 USER 单个用户',
'type' => 'string',
],
'effection' => [
'description' => '',
'example' => 'LOW',
'title' => '影响程度 LOW一般 HIGH-严重',
'type' => 'string',
],
'matchCount' => [
'description' => '',
'example' => '3',
'format' => 'int64',
'title' => '命中次数',
'type' => 'integer',
],
'childRuleRelation' => [
'description' => '',
'example' => 'AND、OR',
'title' => '子规则关系,0与,1或',
'type' => 'string',
],
'eventRouteChildRules' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'childRouteRuleId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'title' => '子规则ID',
'type' => 'integer',
],
'isValidChildRule' => [
'description' => '',
'example' => 'false',
'title' => '是否有效得规则true有效 false无效',
'type' => 'boolean',
],
'parentRuleId' => [
'description' => '',
'example' => '1800',
'format' => 'int64',
'title' => '规则ID',
'type' => 'integer',
],
'monitorSourceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '监控源ID',
'type' => 'integer',
],
'monitorIntegrationConfigId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '集成配置ID',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'example' => 'zabbix',
'title' => '监控源名称',
'type' => 'string',
],
'childConditionRelation' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '子条件计算关系,0-与,1-或',
'type' => 'integer',
],
'conditions' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'key' => [
'description' => '',
'example' => 'alarmName',
'title' => '条件可以',
'type' => 'string',
],
'value' => [
'description' => '',
'example' => 'Zabbix server',
'title' => '匹配值',
'type' => 'string',
],
'operationSymbol' => [
'description' => '',
'example' => 'contain',
'title' => '操作符',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '条件',
'type' => 'array',
],
'problemLevel' => [
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '子规则',
'type' => 'array',
],
'createTime' => [
'description' => '',
'example' => '2020-09-08 15:30:30',
'title' => '创建时间',
'type' => 'string',
],
'updateTime' => [
'description' => '',
'example' => '2020-09-08 15:30:30',
'title' => '修改时间',
'type' => 'string',
],
'notifyChannels' => [
'description' => '',
'items' => [
'description' => '',
'example' => '[SMS,PHONE]',
'type' => 'string',
],
'title' => '通知渠道',
'type' => 'array',
],
'notifyChannelNames' => [
'description' => '',
'items' => [
'description' => '',
'example' => '[短信,电话]',
'type' => 'string',
],
'title' => '通知渠道名称',
'type' => 'array',
],
'assignObjectName' => [
'description' => '',
'example' => '刘德华',
'title' => '通知对象名称',
'type' => 'string',
],
'relServiceDeleteType' => [
'description' => '',
'format' => 'int32',
'title' => '服务删除字段',
'type' => 'integer',
],
'problemLevelGroup' => [
'additionalProperties' => [
'type' => 'object',
'properties' => [
'childRuleRelation' => [
'title' => '子规则关系,0与,1或',
'type' => 'integer',
'format' => 'int32',
],
'matchCount' => [
'title' => '抑制:命中次数',
'type' => 'integer',
'format' => 'int64',
],
'timeWindow' => [
'title' => '抑制:时间窗口',
'type' => 'integer',
'format' => 'int64',
],
'timeWindowUnit' => [
'title' => '抑制:时间窗口单位',
'type' => 'string',
],
'enableUpgrade' => [
'title' => '升级:是否升级',
'type' => 'boolean',
],
'upgradeTimeWindow' => [
'title' => '升级:时间窗口',
'type' => 'integer',
'format' => 'int64',
],
'upgradeTimeWindowUnit' => [
'title' => '升级:时间窗口单位',
'type' => 'string',
],
],
],
'type' => 'object',
],
'coverageProblemLevels' => [
'description' => '',
'items' => [
'type' => 'string',
],
'title' => '故障等级覆盖',
'type' => 'array',
],
'problemEffectionServices' => [
'description' => '',
'items' => [
'format' => 'int64',
'type' => 'integer',
],
'title' => '故障影响服务',
'type' => 'array',
],
'convergenceFields' => [
'title' => '收敛字段集合',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'convergenceType' => [
'title' => '收敛类型(0:流转规则收敛,1:字段收敛)',
'type' => 'integer',
'format' => 'int32',
],
],
'title' => '规则详情',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'requestParamsDescription' => '{'."\n"
.' "routeRuleId" : 1,'."\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' => [
'description' => '',
'properties' => [
'ruleName' => [
'description' => '',
'example' => '规则名字',
'format' => 'byte',
'required' => false,
'title' => '规则名称',
'type' => 'string',
],
'serviceName' => [
'description' => '',
'example' => '冲上云霄',
'format' => 'byte',
'required' => false,
'title' => '服务名称',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '第几页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'required' => false,
'title' => '页的大小',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
'routeType' => [
'description' => '',
'example' => '0',
'format' => 'int64',
'required' => false,
'title' => '路由类型:0触发事件 1仅触发报警 r',
'type' => 'integer',
],
'notFilterRouteRuleDeleted' => [
'required' => false,
'title' => '不过滤已删除流转规则(为true时,已删除过滤对象也会查到)',
'type' => 'boolean',
],
],
'required' => false,
'title' => '规则列表查询入参数',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => '',
'example' => 'C4BE3837-1A13B-A225-2C88188E8A43',
'title' => '请求ID',
'type' => 'string',
],
'data' => [
'description' => '',
'items' => [
'properties' => [
'routeRuleId' => [
'description' => '',
'example' => '10000',
'format' => 'int64',
'title' => '规则ID',
'type' => 'integer',
],
'tenantRamId' => [
'description' => '',
'example' => '1344383',
'format' => 'int64',
'title' => '租户ID',
'type' => 'integer',
],
'ruleName' => [
'description' => '',
'example' => '规则名字',
'title' => '规则名称',
'type' => 'string',
],
'relatedServiceName' => [
'description' => '',
'example' => '关联服务名字',
'title' => '服务名称',
'type' => 'string',
],
'timeWindow' => [
'description' => '',
'example' => '时间窗口',
'format' => 'int64',
'title' => '时间窗口',
'type' => 'integer',
],
'matchCount' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '命中次数',
'type' => 'integer',
],
'timeWindowUnit' => [
'description' => '',
'example' => 'MINUTE',
'format' => 'int64',
'title' => '时间窗口单位 MINUTE 分钟 SECOND 秒',
'type' => 'integer',
],
'relatedServiceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '关联服务ID',
'type' => 'integer',
],
'routeType' => [
'description' => '',
'example' => 'INCIDENT',
'title' => '路由类型:INCIDENT 触发事件 ALERT 仅触发报警',
'type' => 'string',
],
'incidentLevel' => [
'description' => '',
'example' => 'P1',
'title' => '事件级别 P1 P2 P3 P4',
'type' => 'string',
],
'assignObjectId' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '事件分派对象ID(服务组ID 或用户ID)',
'type' => 'integer',
],
'assignObjectType' => [
'description' => '',
'example' => 'SERVICEGROUP',
'title' => '事件分派对象类型 SERVICEGROUP 服务组 USER 单个用户',
'type' => 'string',
],
'effection' => [
'description' => '',
'example' => 'LOW',
'title' => '影响程度 LOW-一般 HIGH-严重',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2020-03-05 15:53:55',
'title' => '创建时间',
'type' => 'string',
],
'updateTime' => [
'description' => '',
'example' => '2020-03-05 15:53:55',
'title' => '修改时间',
'type' => 'string',
],
'enableStatus' => [
'description' => '',
'example' => 'DISABLE',
'title' => '是否启用 DISABLE禁用. ENABLE 启用',
'type' => 'string',
],
'monitorSourceNames' => [
'description' => '',
'example' => 'zabbix',
'title' => '监控源名称',
'type' => 'string',
],
'relServiceDeleteType' => [
'description' => '',
'format' => 'int32',
'title' => '服务删除字段',
'type' => 'integer',
],
'isValid' => [
'description' => '',
'format' => 'int32',
'title' => '是否有效 0无效 1有效',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '规则列表',
'type' => 'array',
],
'totalCount' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '总条数',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '第几页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '分页大小',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'body',
'properties' => [
'ruleName' => [
'description' => '',
'example' => '规则1',
'required' => true,
'title' => '规则名称',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '关联服务ID',
'type' => 'integer',
],
'routeRuleId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '规则ID',
'type' => 'integer',
],
'routeType' => [
'description' => '',
'example' => 'ALERT',
'required' => true,
'title' => '路由类型:INCIDENT 触发事件 ALERT 仅触发报警',
'type' => 'string',
],
'incidentLevel' => [
'description' => '',
'example' => 'P1',
'required' => true,
'title' => '事件级别 1-P1 2-P2 3-P3 4-P4',
'type' => 'string',
],
'assignObjectId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '事件分派对象ID(服务组ID 或用户ID)',
'type' => 'integer',
],
'assignObjectType' => [
'description' => '',
'example' => 'SERVICEGROUP',
'required' => true,
'title' => '事件分派对象类型 SERVICEGROUP服务组 USER 单个用户',
'type' => 'string',
],
'effection' => [
'description' => '',
'example' => 'LOW',
'required' => true,
'title' => '影响程度 LOW-一般 HIGH-严重',
'type' => 'string',
],
'timeWindow' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'required' => true,
'title' => '时间窗口',
'type' => 'integer',
],
'timeWindowUnit' => [
'description' => '',
'example' => 'MINUTE',
'required' => true,
'title' => '时间窗口单位 MINUTE 分钟 SECOND 秒',
'type' => 'string',
],
'matchCount' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => true,
'title' => '命中次数',
'type' => 'integer',
],
'routeChildRules' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'childRouteRuleId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '子规则ID 不填表示新增',
'type' => 'integer',
],
'conditions' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'key' => [
'description' => '',
'example' => 'payload.summary',
'required' => true,
'title' => '字段',
'type' => 'string',
],
'value' => [
'description' => '',
'example' => '123',
'required' => true,
'title' => '字段取值',
'type' => 'string',
],
'operationSymbol' => [
'description' => '',
'example' => 'equals',
'required' => true,
'title' => '操作符',
'type' => 'string',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '条件',
'type' => 'array',
],
'monitorSourceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '监控源ID',
'type' => 'integer',
],
'isValidChildRule' => [
'description' => '',
'example' => 'false',
'required' => true,
'title' => 'true 删除子规则 false编辑子规则',
'type' => 'boolean',
],
'childConditionRelation' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '子条件计算关系',
'type' => 'integer',
],
'problemLevel' => [
'type' => 'string',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '子规则',
'type' => 'array',
],
'notifyChannels' => [
'description' => '',
'items' => [
'description' => '',
'example' => '[SMS,PHONE]',
'required' => true,
'type' => 'string',
],
'required' => true,
'title' => '通知渠道 SMS 短信 EMAIL 邮件 PHONE 电话 WEIXIN_GROUP 企微群 DING_GROUP 钉钉群',
'type' => 'array',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
'childRuleRelation' => [
'description' => '',
'example' => 'AND',
'required' => false,
'title' => 'AND',
'type' => 'string',
],
'problemLevelGroup' => [
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'childRuleRelation' => [
'title' => '子规则关系,0与,1或',
'type' => 'integer',
'format' => 'int32',
],
'matchCount' => [
'title' => '抑制:命中次数',
'type' => 'integer',
'format' => 'int64',
],
'timeWindow' => [
'title' => '抑制:时间窗口',
'type' => 'integer',
'format' => 'int64',
],
'timeWindowUnit' => [
'title' => '抑制:时间窗口单位',
'type' => 'string',
],
'enableUpgrade' => [
'title' => '升级:是否升级',
'type' => 'boolean',
],
'upgradeTimeWindow' => [
'title' => '升级:时间窗口',
'type' => 'integer',
'format' => 'int64',
],
'upgradeTimeWindowUnit' => [
'type' => 'string',
],
],
],
],
'coverageProblemLevels' => [
'title' => '故障等级覆盖',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'problemEffectionServices' => [
'title' => '故障影响服务',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
'convergenceFields' => [
'title' => '收敛字段集合',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'convergenceType' => [
'title' => '收敛类型(0:流转规则收敛,1:字段收敛)',
'type' => 'integer',
'format' => 'int32',
],
],
'required' => false,
'title' => '编辑流转规则入参',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => '请求ID',
'type' => 'string',
],
'data' => [
'description' => '',
'example' => 'null',
'format' => 'int64',
'type' => 'integer',
],
],
'title' => '响应',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'routeRuleId' => [
'description' => '',
'example' => '1111',
'format' => 'int64',
'required' => false,
'title' => '规则id',
'type' => 'integer',
],
'testSourceEvents' => [
'description' => '',
'items' => [
'description' => '',
'example' => '{}',
'properties' => [
'monitorSourceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '监控告警源ID',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'example' => 'zabbix',
'required' => false,
'title' => '监控告警源名称',
'type' => 'string',
],
'eventTime' => [
'description' => '',
'example' => '2021-09-08 13:00:00',
'required' => false,
'title' => '告警上报时间',
'type' => 'string',
],
'eventJson' => [
'description' => '',
'example' => '{}',
'required' => false,
'title' => '告警内容',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '测试告警',
'type' => 'array',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'properties' => [
'isValidRule' => [
'description' => '',
'example' => 'true',
'title' => '验证是否成功',
'type' => 'boolean',
],
'routeType' => [
'description' => '',
'example' => 'INCIDENT、ALERT',
'title' => '事件或者报警',
'type' => 'string',
],
'notifySubscriptionNames' => [
'description' => '',
'items' => [
'description' => '',
'example' => '',
'properties' => [
'subscriptionId' => [
'description' => '',
'example' => '111111',
'format' => 'int64',
'title' => '订阅ID',
'type' => 'integer',
],
'title' => [
'description' => '',
'example' => '订阅名称',
'title' => '订阅名称',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '订阅名称',
'type' => 'array',
],
'escalationPlans' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'escalationPlanName' => [
'description' => '',
'example' => '升级计划1',
'title' => '升级计划名称',
'type' => 'string',
],
'escalationPlanId' => [
'description' => '',
'example' => '111111',
'format' => 'int64',
'title' => '升级计划ID',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '升级策略名称',
'type' => 'array',
],
'routeRuleFailReason' => [
'description' => '',
'items' => [
'description' => '',
'example' => '',
'type' => 'string',
],
'title' => '流转规则验证失败的原因',
'type' => 'array',
],
'monitorSourceIds' => [
'description' => '',
'items' => [
'description' => '1000',
'example' => '验证失败监控源ID',
'format' => 'int64',
'type' => 'integer',
],
'title' => '验证失败监控源ID',
'type' => 'array',
],
],
'title' => '验证结果',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'subscriptionTitle' => [
'description' => '',
'example' => 'testSubscription',
'required' => true,
'title' => '通知订阅名称',
'type' => 'string',
],
'scope' => [
'description' => '',
'example' => 'SERVICE',
'format' => 'int64',
'required' => true,
'title' => '订阅范围类型',
'type' => 'integer',
],
'notifyObjectType' => [
'description' => '',
'example' => 'USER',
'format' => 'int64',
'required' => true,
'title' => '通知对象类型',
'type' => 'integer',
],
'expiredType' => [
'description' => '',
'example' => 'LONG_TERM',
'format' => 'int64',
'required' => true,
'title' => '订阅时效',
'type' => 'integer',
],
'period' => [
'description' => '',
'example' => '1个月',
'required' => false,
'title' => '时间段',
'type' => 'string',
],
'scopeObjectList' => [
'description' => '',
'items' => [
'description' => 'Object',
'properties' => [
'scopeObjectId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '订阅范围对象id',
'type' => 'integer',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '订阅范围列表',
'type' => 'array',
],
'notifyObjectList' => [
'description' => '',
'items' => [
'description' => 'Object',
'properties' => [
'notifyObjectId' => [
'description' => '',
'example' => '2',
'format' => 'int64',
'required' => true,
'title' => '通知对象id',
'type' => 'integer',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '通知对象列表',
'type' => 'array',
],
'notifyStrategyList' => [
'description' => '',
'items' => [
'description' => 'Object',
'properties' => [
'instanceType' => [
'description' => '',
'example' => 'INCIDENT',
'format' => 'int64',
'required' => true,
'title' => '订阅实例类型,事件、报警、故障',
'type' => 'integer',
],
'strategies' => [
'description' => '',
'items' => [
'description' => 'Object',
'properties' => [
'conditions' => [
'description' => '',
'items' => [
'description' => 'Object',
'properties' => [
'effection' => [
'description' => '',
'example' => 'HIGH',
'required' => false,
'title' => '影响范围',
'type' => 'string',
],
'problemNotifyType' => [
'description' => '',
'example' => 'PROBLEM_UPDATE',
'required' => false,
'title' => '故障通知类型',
'type' => 'string',
],
'level' => [
'description' => '',
'example' => 'P1',
'required' => false,
'title' => '等级',
'type' => 'string',
],
'action' => [
'description' => '',
'example' => 'INCIDENT_TRIGGER',
'required' => false,
'title' => '时间动作',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '通知策略条件',
'type' => 'array',
],
],
'required' => false,
'type' => 'object',
],
'required' => true,
'title' => '条件。json格式,包含多个条件,比如级别、影响程度 kv格式',
'type' => 'array',
],
'channels' => [
'description' => '',
'example' => 'SMS,PHONE',
'required' => true,
'title' => '渠道,多个逗号分隔',
'type' => 'string',
],
'periodChannel' => [
'description' => '',
'properties' => [
'workday' => [
'description' => '',
'example' => 'SMS,PHONE',
'required' => false,
'title' => '工作时段',
'type' => 'string',
],
'nonWorkday' => [
'description' => '',
'example' => 'SMS,PHONE',
'required' => false,
'title' => '非工作时段',
'type' => 'string',
],
],
'required' => false,
'title' => '分时段渠道',
'type' => 'object',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '通知策略列表',
'type' => 'array',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
'required' => false,
'title' => '幂等参数',
'type' => 'string',
],
'startTime' => [
'description' => '',
'example' => '2021-02-03 10:10:10',
'required' => false,
'title' => '开始时间',
'type' => 'string',
],
'endTime' => [
'description' => '',
'example' => '2021-11-03 10:10:10',
'required' => false,
'title' => '结束时间',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'request id',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'title' => 'request id',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'subscriptionId' => [
'description' => '',
'example' => '101',
'format' => 'int64',
'title' => '订阅id',
'type' => 'integer',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'subscriptionId' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'title' => 'requestId',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"c26f36de-1ec8-496a-a828-880676c5ef81\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7C56D225-7C34-40BB-9624-C8BA449260E6\\n","errorExample":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'subscriptionId' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'subscriptionId' => [
'description' => '',
'example' => '80002020',
'format' => 'int64',
'required' => true,
'title' => '主键',
'type' => 'integer',
],
'subscriptionTitle' => [
'description' => '',
'example' => 'newSubs244',
'required' => true,
'title' => '通知订阅名称',
'type' => 'string',
],
'scope' => [
'description' => '',
'example' => 'SERVICE',
'required' => true,
'title' => '订阅范围类型',
'type' => 'string',
],
'notifyObjectType' => [
'description' => '',
'example' => 'USER',
'required' => true,
'title' => '通知对象类型',
'type' => 'string',
],
'expiredType' => [
'description' => '',
'example' => 'LONG_TERM',
'required' => true,
'title' => '订阅时效',
'type' => 'string',
],
'period' => [
'description' => '',
'example' => '1个月',
'required' => false,
'title' => '时间段字符串',
'type' => 'string',
],
'scopeObjectList' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'id' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '主键id',
'type' => 'integer',
],
'scopeObjectId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '订阅范围对象id',
'type' => 'integer',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '订阅范围列表',
'type' => 'array',
],
'notifyObjectList' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'id' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'title' => '主键id',
'type' => 'integer',
],
'notifyObjectId' => [
'description' => '',
'example' => '19',
'format' => 'int64',
'required' => true,
'title' => '通知对象id',
'type' => 'integer',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '通知对象列表',
'type' => 'array',
],
'notifyStrategyList' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'instanceType' => [
'description' => '',
'example' => 'INCIDENT',
'format' => 'int64',
'required' => true,
'title' => '订阅实例类型,事件、报警、故障',
'type' => 'integer',
],
'strategies' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'id' => [
'description' => '',
'example' => '10',
'required' => false,
'title' => 'id',
'type' => 'string',
],
'channels' => [
'description' => '',
'example' => 'SMS,WEIXIN_GROUP',
'required' => false,
'title' => '故障等级',
'type' => 'string',
],
'conditions' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'level' => [
'description' => '',
'example' => 'P1',
'required' => false,
'title' => '等级',
'type' => 'string',
],
'effection' => [
'description' => '',
'example' => 'HIGH',
'required' => false,
'title' => '影响程度',
'type' => 'string',
],
'problemNotifyType' => [
'description' => '',
'example' => 'PROBLEM_NOTIFY',
'required' => false,
'title' => '故障通知类型',
'type' => 'string',
],
'action' => [
'description' => '',
'example' => 'INCIDENT_TRIGGER',
'required' => false,
'title' => '事件动作',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '影响程度',
'type' => 'array',
],
'periodChannel' => [
'description' => '',
'properties' => [
'workday' => [
'description' => '',
'example' => 'SMS,WEIXIN_GROUP',
'required' => false,
'title' => '工作时间',
'type' => 'string',
],
'nonWorkday' => [
'description' => '',
'example' => 'SMS,WEIXIN_GROUP',
'required' => false,
'title' => '非工作时间',
'type' => 'string',
],
],
'required' => false,
'title' => '分时段通知渠道',
'type' => 'object',
],
],
'required' => false,
'type' => 'object',
],
'required' => true,
'title' => '通知策略',
'type' => 'array',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '通知策略列表',
'type' => 'array',
],
'startTime' => [
'description' => '',
'example' => '2021-04-04 10:10:11',
'required' => false,
'title' => '开始时间',
'type' => 'string',
],
'endTime' => [
'description' => '',
'example' => '2022-05-09 10:10:23',
'required' => false,
'title' => '结束时间',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'subscriptionId' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'notFilterScopeObjectDeleted' => [
'title' => '不过滤已删除订阅范围对象(为true时,已删除过滤对象也会查到)',
'type' => 'boolean',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'type' => 'string',
],
'data' => [
'description' => 'Object',
'properties' => [
'subscriptionId' => [
'description' => '',
'example' => '68',
'format' => 'int64',
'type' => 'integer',
],
'subscriptionTitle' => [
'description' => '',
'example' => 'newTitle',
'title' => '通知订阅名称',
'type' => 'string',
],
'scope' => [
'description' => '',
'example' => 'SERVICE',
'title' => '0 全部 1服务 2 流转规则',
'type' => 'string',
],
'notifyObjectType' => [
'description' => '',
'example' => 'USER',
'title' => '0服务组 1个人',
'type' => 'string',
],
'expiredType' => [
'description' => '',
'example' => 'LONG_TERM',
'title' => '有效期类型 0 长期 1短期',
'type' => 'string',
],
'period' => [
'description' => '',
'example' => '1个月',
'title' => '时间段字符串',
'type' => 'string',
],
'startTime' => [
'description' => '',
'example' => '2020-05-9 10:10:10',
'title' => '时效开始时间',
'type' => 'string',
],
'endTime' => [
'description' => '',
'example' => '2021-08-9 10:10:10',
'title' => '时效结束时间',
'type' => 'string',
],
'status' => [
'description' => '',
'example' => 'ENABLE',
'title' => '1 启用 0禁用',
'type' => 'string',
],
'scopeObjectList' => [
'description' => 'Array',
'items' => [
'description' => 'Object',
'properties' => [
'id' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => 'id主键',
'type' => 'integer',
],
'scope' => [
'description' => '',
'example' => 'SERVICE',
'title' => '订阅范围类型 0 全部 1服务 2 流转规则',
'type' => 'string',
],
'scopeObjectId' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '订阅范围对象关联表主键id',
'type' => 'integer',
],
'scopeObject' => [
'description' => '',
'example' => '',
'title' => '订阅范围对象名称',
'type' => 'string',
],
'isValid' => [
'title' => '是否有效 0无效 1有效',
'type' => 'integer',
'format' => 'int64',
],
],
'type' => 'object',
],
'type' => 'array',
],
'notifyObjectList' => [
'description' => '',
'items' => [
'description' => 'Object',
'properties' => [
'id' => [
'description' => '',
'example' => '23',
'format' => 'int64',
'title' => 'id主键',
'type' => 'integer',
],
'notifyObjectType' => [
'description' => '',
'example' => 'USER',
'format' => 'int64',
'title' => '通知对象类型0服务组 1个人',
'type' => 'integer',
],
'notifyObjectId' => [
'description' => '',
'example' => '19',
'format' => 'int64',
'title' => '关联主键id',
'type' => 'integer',
],
'name' => [
'description' => '',
'example' => 'TestName',
'title' => '通知对象名',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '通知对象列表',
'type' => 'array',
],
'notifyStrategyList' => [
'description' => '',
'items' => [
'description' => 'Object'."\n",
'properties' => [
'instanceType' => [
'description' => '',
'example' => 'INCIDENT',
'format' => 'int64',
'title' => '订阅实例类型,0事件、1报警、2故障',
'type' => 'integer',
],
'strategies' => [
'description' => '',
'items' => [
'description' => 'Object',
'properties' => [
'id' => [
'description' => '',
'example' => '12',
'format' => 'int64',
'title' => '策略主键',
'type' => 'integer',
],
'channels' => [
'description' => '',
'example' => 'SMS',
'title' => '通知渠道',
'type' => 'string',
],
'conditions' => [
'description' => '',
'items' => [
'description' => 'Object',
'properties' => [
'effection' => [
'description' => '',
'example' => 'HIGH',
'title' => '影响范围',
'type' => 'string',
],
'problemNotifyType' => [
'description' => '',
'example' => 'PROBLEM_NOTIFY',
'title' => '故障通知类型',
'type' => 'string',
],
'level' => [
'description' => '',
'example' => 'P1',
'title' => '等级',
'type' => 'string',
],
'action' => [
'description' => '',
'example' => 'INCIDENT_TRIGGER',
'title' => '事件动作',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '条件',
'type' => 'array',
],
'periodChannel' => [
'description' => '',
'properties' => [
'workday' => [
'description' => '',
'example' => 'DINGDING',
'title' => '工作时间',
'type' => 'string',
],
'nonWorkday' => [
'description' => '',
'example' => 'DINGDING',
'title' => '非工作时间',
'type' => 'string',
],
],
'title' => '分时间段渠道',
'type' => 'object',
],
],
'type' => 'object',
],
'title' => '策略',
'type' => 'array',
],
],
'type' => 'object',
],
'title' => '通知策略列表',
'type' => 'array',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'subscriptionId' => [
'description' => '',
'example' => '89',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '第几页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'required' => false,
'title' => '一页几条',
'type' => 'integer',
],
'subscriptionTitle' => [
'description' => '',
'example' => 'newTitle',
'required' => false,
'title' => '通知订阅名',
'type' => 'string',
],
'scope' => [
'description' => '',
'example' => 'SERVICE',
'required' => false,
'title' => '订阅范围类型 0全部1服务2流转规则',
'type' => 'string',
],
'scopeObject' => [
'description' => '',
'example' => 'TestName',
'required' => false,
'title' => '订阅范围对象名称',
'type' => 'string',
],
'notifyObjectType' => [
'description' => '',
'example' => 'SERVICE',
'required' => false,
'title' => '通知对象类型notifyWhoType:0服务组 1个人',
'type' => 'string',
],
'notifyObject' => [
'description' => '',
'example' => 'test',
'required' => false,
'title' => '通知对象名',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
'required' => false,
'title' => '幂等参数',
'type' => 'string',
],
'notFilterScopeObjectDeleted' => [
'title' => '不过滤已删除订阅范围对象(为true时,已删除过滤对象也会查到)',
'type' => 'boolean',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'title' => 'id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => 'object',
'properties' => [
'subscriptionId' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '订阅id',
'type' => 'integer',
],
'subscriptionTitle' => [
'description' => '',
'example' => 'test',
'title' => '通知订阅名称',
'type' => 'string',
],
'scope' => [
'description' => '',
'example' => 'SERVICE',
'format' => 'int64',
'title' => '0 全部 1服务 2 流转规则',
'type' => 'integer',
],
'notifyObjectType' => [
'description' => '',
'example' => 'USER',
'format' => 'int64',
'title' => '0服务组 1个人',
'type' => 'integer',
],
'expiredType' => [
'description' => '',
'example' => 'LONG_TERM',
'title' => '有效期类型 0 长期 1短期',
'type' => 'string',
],
'startTime' => [
'description' => '',
'example' => '2020-05-09 10:10:10',
'title' => '时效开始时间',
'type' => 'string',
],
'endTime' => [
'description' => '',
'example' => '2022-05-09 10:10:10',
'title' => '时效结束时间',
'type' => 'string',
],
'status' => [
'description' => '',
'example' => 'ENABLE',
'title' => 'ENABLE 启用 DISABLE禁用',
'type' => 'string',
],
'scopeObjectList' => [
'description' => '',
'items' => [
'properties' => [
'id' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => 'id主键',
'type' => 'integer',
],
'scope' => [
'description' => '',
'example' => 'SERVICE',
'format' => 'int64',
'title' => '订阅范围类型 ALL全部 SERVICE服务 ROUTETULE流转规则',
'type' => 'integer',
],
'scopeObjectId' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '订阅范围对象关联表主键id',
'type' => 'integer',
],
'scopeObject' => [
'description' => '',
'example' => '阿里云服务',
'title' => '订阅范围对象名称',
'type' => 'string',
],
'isValid' => [
'type' => 'integer',
'format' => 'int64',
],
],
'type' => 'object',
],
'title' => '订阅范围列表',
'type' => 'array',
],
'notifyObjectList' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'id' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => 'id主键',
'type' => 'integer',
],
'notifyObjectType' => [
'description' => '',
'example' => 'USER',
'format' => 'int64',
'title' => '通知对象类型0服务组 1个人',
'type' => 'integer',
],
'notifyObjectId' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '关联主键id',
'type' => 'integer',
],
'name' => [
'description' => '',
'example' => '张珊',
'title' => '通知对象名',
'type' => 'string',
],
'isValid' => [
'type' => 'integer',
'format' => 'int64',
],
],
'type' => 'object',
],
'title' => '通知对象列表',
'type' => 'array',
],
],
'type' => 'object',
],
'type' => 'array',
],
'totalCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '分页参数',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '分页参数',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '分页参数',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'required' => true,
'title' => '事件id',
'type' => 'integer',
],
'description' => [
'description' => '',
'example' => '描述',
'required' => false,
'title' => '描述',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'title' => '幂等校验Id',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'requestId',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'subtotalId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'title' => '小计Id',
'type' => 'integer',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '3123',
'format' => 'int64',
'required' => false,
'title' => '事件ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE62E59A2E9',
'required' => false,
'title' => '幂等校验',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => 'object',
'properties' => [
'description' => [
'description' => '',
'example' => '',
'title' => '描述',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2021-06-23 00:00:00',
'title' => '创建时间',
'type' => 'string',
],
'createUserName' => [
'description' => '',
'example' => '',
'title' => '操作人',
'type' => 'string',
],
'createUserPhone' => [
'description' => '',
'example' => '130****1111',
'title' => '操作人手机号',
'type' => 'string',
],
'createUserId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'title' => '操作人Id',
'type' => 'integer',
],
],
'type' => 'object',
],
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'body',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'type' => 'string',
],
'incidentIdList' => [
'description' => '',
'items' => [
'example' => '1122',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'type' => 'array',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => '',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '3213',
'format' => 'int64',
'type' => 'integer',
],
'routeRuleId' => [
'description' => '',
'example' => '10000',
'format' => 'int64',
'type' => 'integer',
],
'routeRuleName' => [
'description' => '',
'example' => '',
'type' => 'string',
],
'incidentStatus' => [
'description' => '',
'example' => 'FINISHE',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '',
'example' => '213123',
'format' => 'int64',
'type' => 'integer',
],
'relatedServiceName' => [
'description' => '',
'example' => '',
'type' => 'string',
],
'effect' => [
'description' => '',
'example' => 'LOW',
'type' => 'string',
],
'assignUserId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'type' => 'integer',
],
'assignUserName' => [
'description' => '',
'example' => '',
'type' => 'string',
],
'assignUserPhone' => [
'description' => '',
'example' => '139****1111',
'type' => 'string',
],
'incidentTitle' => [
'description' => '',
'example' => '',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2010-03-09 15:53:45',
'type' => 'string',
],
'isManual' => [
'description' => '',
'example' => 'true',
'type' => 'boolean',
],
'isUpgrade' => [
'description' => '',
'example' => 'true',
'type' => 'boolean',
],
'incidentDescription' => [
'description' => '',
'example' => '',
'type' => 'string',
],
'problemId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'type' => 'integer',
],
'durationTime' => [
'description' => '',
'example' => '3000000',
'type' => 'string',
],
'notifyChannels' => [
'description' => '',
'items' => [
'description' => '',
'example' => '[SMS,PHONE]',
'type' => 'string',
],
'type' => 'array',
],
'relatedServiceGroupName' => [
'description' => '',
'example' => '',
'type' => 'string',
],
'relatedServiceGroupId' => [
'description' => '',
'example' => '13000',
'format' => 'int64',
'type' => 'integer',
],
'relServiceDeleteType' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'relRouteRuleDeleteType' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'assignToWhoIsValid' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'relServiceGroupIsValid' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'defaultAssignToWhoName' => [
'description' => '',
'example' => '',
'type' => 'string',
],
'relatedServiceDescription' => [
'description' => '',
'example' => '',
'type' => 'string',
],
'incidentLevel' => [
'description' => '',
'example' => 'P4',
'type' => 'string',
],
'incidentNumber' => [
'description' => '',
'example' => 'I13002001',
'type' => 'string',
],
'problemNumber' => [
'description' => '',
'example' => 'P1231231',
'type' => 'string',
],
'defaultAssignToWho' => [
'description' => '',
'example' => '1212',
'format' => 'int32',
'type' => 'integer',
],
'defaultAssignToWhoIsValid' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
],
'type' => 'object',
],
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'body',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'title' => '幂等校验',
'type' => 'string',
],
'incidentId' => [
'description' => '',
'example' => '12321',
'format' => 'int64',
'required' => false,
'title' => '事件Id',
'type' => 'integer',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'incidentLevel' => [
'description' => '',
'example' => 'P1',
'required' => false,
'title' => 'P1 事件级别 P1 P2 P3 P4',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef729f',
'required' => false,
'title' => '幂等UUID',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'required' => false,
'title' => '关联服务ID',
'type' => 'integer',
],
'effect' => [
'description' => '',
'example' => 'LOW',
'required' => false,
'title' => '影响等级 高:HIGH 低 LOW',
'type' => 'string',
],
'incidentTitle' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '事件标题',
'type' => 'string',
],
'assignUserId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'required' => false,
'title' => '分派的用户ID',
'type' => 'integer',
],
'incidentDescription' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '事件描述',
'type' => 'string',
],
'channels' => [
'description' => '',
'items' => [
'description' => '',
'example' => 'SMS',
'required' => false,
'type' => 'string',
],
'required' => false,
'title' => '通知渠道 SMS 短信 EMAIL 邮件 PHONE 电话 WEIXIN_GROUP企微群 DING_GROUP 钉钉群',
'type' => 'array',
],
'serviceGroupId' => [
'description' => '12000',
'example' => '12312',
'format' => 'int64',
'required' => false,
'title' => '服务组Id',
'type' => 'integer',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'data' => [
'description' => 'Id of the request',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '',
'format' => 'int64',
'title' => '事件主健Id',
'type' => 'integer',
],
],
'title' => 'Id of the request',
'type' => 'object',
],
'requestId' => [
'description' => 'requestId',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'requestId',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '1223212',
'format' => 'int64',
'required' => false,
'title' => '事件ID',
'type' => 'integer',
],
'assignUserId' => [
'description' => '',
'example' => '212321',
'format' => 'int64',
'required' => false,
'title' => '转交用户ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61CS9A221',
'required' => false,
'title' => '幂等校验id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2FS',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'body',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '32113',
'format' => 'int64',
'required' => false,
'title' => '事件ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef729f',
'required' => false,
'title' => '幂等校验',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => '2b63cdef-7ac3-4892-a76d-0f3389ef7291',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '3213',
'format' => 'int64',
'title' => '事件Id',
'type' => 'integer',
],
'routeRuleId' => [
'description' => '',
'example' => '3123',
'format' => 'int64',
'title' => '流转规则ID',
'type' => 'integer',
],
'routeRuleName' => [
'description' => '',
'example' => '流转规则A',
'title' => '流转规则名称',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '',
'example' => '312312',
'format' => 'int64',
'title' => '关联服务ID',
'type' => 'integer',
],
'relatedServiceName' => [
'description' => '',
'example' => '服务A',
'title' => '关联服务名称',
'type' => 'string',
],
'relatedServiceDescription' => [
'description' => '',
'example' => '关联服务描述',
'title' => '关联服务描述',
'type' => 'string',
],
'incidentStatus' => [
'description' => '',
'example' => 'FINISHE',
'title' => '事件状态 ASSIGNED已分派 RESPONDED已响应 FINISHED已完结',
'type' => 'string',
],
'incidentLevel' => [
'description' => '',
'example' => 'P4',
'title' => '事件级别 P1 P2 P3 P4',
'type' => 'string',
],
'effect' => [
'description' => '',
'example' => 'LOW',
'title' => 'HIGH 影响等级 高:HIGH 低 LOW',
'type' => 'string',
],
'assignUserId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'title' => '分派的用户ID',
'type' => 'integer',
],
'assignUserName' => [
'description' => '',
'example' => '小明',
'title' => '分派的用户姓名 (用户表获取)',
'type' => 'string',
],
'assignUserPhone' => [
'description' => '',
'example' => '1390000****',
'title' => '分派的用户手机号',
'type' => 'string',
],
'incidentNumber' => [
'description' => '',
'example' => 'I3443831000000016247759753663894',
'title' => '事件编号',
'type' => 'string',
],
'incidentTitle' => [
'description' => '',
'example' => '事件标题',
'title' => '事件标题',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2020-01-10 00:00:00',
'title' => '创建时间',
'type' => 'string',
],
'isManual' => [
'description' => '',
'example' => 'true',
'title' => '事件来源 是:手动 否:自动',
'type' => 'boolean',
],
'isUpgrade' => [
'description' => '',
'example' => 'true',
'title' => '是否升级 是 否',
'type' => 'boolean',
],
'incidentDescription' => [
'description' => '',
'example' => '事件描述',
'title' => '事件描述',
'type' => 'string',
],
'problemId' => [
'description' => '',
'example' => '232113',
'format' => 'int64',
'title' => '故障Id',
'type' => 'integer',
],
'problemNumber' => [
'description' => '',
'example' => '3332113231453321',
'title' => '故障编号',
'type' => 'string',
],
'durationTime' => [
'description' => '',
'example' => '3000000',
'format' => 'int64',
'title' => '持续时间',
'type' => 'integer',
],
'notifyChannels' => [
'description' => '',
'example' => '1 短信 2 邮件 3 电话 4 企微群 5 钉钉群 6飞书 7 群通知 8 slack',
'items' => [
'description' => '',
'example' => 'WEBHOOK',
'type' => 'string',
],
'title' => '通知渠道',
'type' => 'array',
],
'relatedServiceGroupName' => [
'description' => '',
'example' => '服务组A',
'title' => '关联服务组名称',
'type' => 'string',
],
'relatedServiceGroupId' => [
'description' => '',
'example' => '13000',
'format' => 'int64',
'title' => '关联服服务id',
'type' => 'integer',
],
'relServiceDeleteType' => [
'description' => '',
'format' => 'int32',
'title' => '服务删除字段',
'type' => 'integer',
],
'relRouteRuleDeleteType' => [
'description' => '',
'format' => 'int32',
'title' => '规则删除字段',
'type' => 'integer',
],
'assignToWhoIsValid' => [
'description' => '',
'format' => 'int32',
'title' => '分派的用户是否生效,1生效,0失效',
'type' => 'integer',
],
'relServiceGroupIsValid' => [
'description' => '',
'format' => 'int32',
'title' => '关联服务组是否生效,1生效,0失效',
'type' => 'integer',
],
'defaultAssignToWhoName' => [
'description' => '',
'title' => '默认分配人名称',
'type' => 'string',
],
'defaultAssignToWho' => [
'description' => '',
'format' => 'int32',
'title' => '默认分配人id',
'type' => 'integer',
],
'defaultAssignToWhoIsValid' => [
'description' => '',
'format' => 'int32',
'title' => '默认分配人删除状态 1正常 0删除',
'type' => 'integer',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'title' => '幂等校验Id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'object',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'myResponse' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'title' => '我的 待响应',
'type' => 'integer',
],
'myFinish' => [
'description' => '',
'example' => '11',
'format' => 'int32',
'title' => '我的 完结',
'type' => 'integer',
],
'allResponse' => [
'description' => '',
'example' => '12',
'format' => 'int32',
'title' => '所有 待响应',
'type' => 'integer',
],
'allFinish' => [
'description' => '',
'example' => '113',
'format' => 'int32',
'title' => '所有 完结',
'type' => 'integer',
],
],
'type' => 'object',
],
],
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => '',
'properties' => [
'incidentIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '12321',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => true,
'title' => '事件ID数组',
'type' => 'array',
],
'incidentFinishReason' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '完结原因',
'type' => 'integer',
],
'incidentFinishReasonDescription' => [
'description' => '',
'example' => '原因描述',
'required' => false,
'title' => '原因描述',
'type' => 'string',
],
'incidentFinishSolution' => [
'description' => '',
'example' => '3',
'format' => 'int32',
'required' => false,
'title' => '解决方案',
'type' => 'integer',
],
'incidentFinishSolutionDescription' => [
'description' => '',
'example' => '解决方案描述',
'required' => false,
'title' => '解决方案描述',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2DC',
'required' => false,
'title' => '幂等校验Id',
'type' => 'string',
],
],
'required' => true,
'title' => 'body参数',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'requestId',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'IncidentUpdateInvalid',
'errorMessage' => 'The incident update is invalid.',
],
],
404 => [
[
'errorCode' => 'IncidentNotExtisted',
'errorMessage' => 'The incident does not exist.',
],
],
],
'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":""}]',
'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' => [
'description' => 'body',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'required' => true,
'title' => '事件Id',
'type' => 'integer',
],
'incidentLevel' => [
'description' => '',
'example' => 'P1',
'required' => false,
'title' => '级别',
'type' => 'string',
],
'effect' => [
'description' => '',
'example' => 'LOW',
'required' => false,
'title' => '影响程度',
'type' => 'string',
],
'incidentTitle' => [
'description' => '',
'example' => '事件标题',
'required' => false,
'title' => '事件标题',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A123',
'required' => false,
'title' => '幂等校验Id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '2312',
'format' => 'int64',
'title' => '事件id',
'type' => 'integer',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => '',
'properties' => [
'incidentIds' => [
'description' => '影响程度',
'items' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'title' => '事件ID数组',
'type' => 'array',
],
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A221',
'required' => false,
'title' => '幂等校验Id',
'type' => 'string',
],
],
'required' => true,
'title' => 'body参数',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => '062E6568-E505-49D6-8DD0-8F11283EB0AB',
'title' => 'requestId',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'incidentLevel' => [
'description' => '',
'example' => 'P1',
'required' => false,
'title' => '事件级别 P1 P2 P3 P4',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'required' => false,
'title' => '行',
'type' => 'integer',
],
'effect' => [
'description' => '',
'example' => 'LOW',
'required' => false,
'title' => '影响等级 高:HIGH 低 LOW',
'type' => 'string',
],
'relationServiceId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'required' => false,
'title' => '关联服务ID',
'type' => 'integer',
],
'incidentStatus' => [
'description' => '',
'example' => 'ASSIGNED',
'required' => false,
'title' => '事件状态 ASSIGNED已分派 RESPONDED已响应 FINISHED已完结',
'type' => 'string',
],
'me' => [
'description' => '',
'example' => 'true',
'format' => 'int32',
'required' => false,
'title' => '是否自己 1是 0不是',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E1',
'required' => false,
'title' => '幂等校验id',
'type' => 'string',
],
'createStartTime' => [
'description' => '',
'example' => '2021-11-01 00:00:00',
'required' => false,
'title' => '创建开始时间',
'type' => 'string',
],
'createEndTime' => [
'description' => '',
'example' => '2021-11-10 00:00:00',
'required' => false,
'title' => '创建结束时间',
'type' => 'string',
],
'ruleName' => [
'description' => '',
'example' => 'sa',
'required' => false,
'title' => '流转规则名字',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'requestId',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => 'IncidentItemType',
'properties' => [
'incidentId' => [
'description' => '修改时间',
'example' => '12321',
'format' => 'int64',
'type' => 'integer',
],
'routeRuleId' => [
'description' => '关联的服务ID',
'example' => '123',
'format' => 'int64',
'title' => '流转规则ID',
'type' => 'integer',
],
'routeRuleName' => [
'description' => '',
'example' => '',
'title' => '流转规则',
'type' => 'string',
],
'incidentStatus' => [
'description' => '关联流转规则ID',
'example' => 'RESPONDED',
'title' => '事件状态 0已分派 1已响应 2已完结',
'type' => 'string',
],
'incidentLevel' => [
'description' => '影响程度',
'example' => 'P4',
'title' => '事件级别 P1 P2 P3 P4',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '事件状态',
'example' => '213123',
'format' => 'int64',
'title' => '关联服务ID',
'type' => 'integer',
],
'relatedServiceName' => [
'description' => '',
'example' => '',
'title' => '关联服务名称',
'type' => 'string',
],
'effect' => [
'description' => '时间指派人ID',
'example' => 'HIGH',
'title' => '影响等级 高:HIGH 低 LOW',
'type' => 'string',
],
'assignUserId' => [
'description' => '代表创建时间的资源属性字段',
'example' => '21312',
'format' => 'int64',
'title' => '分派的用户ID',
'type' => 'integer',
],
'assignUserName' => [
'description' => '代表资源一级ID的资源属性字段',
'example' => '',
'readOnly' => true,
'title' => '分派的用户姓名',
'type' => 'string',
],
'assignUserPhone' => [
'description' => '',
'example' => '1390000****',
'title' => '分派人手机号',
'type' => 'string',
],
'incidentTitle' => [
'description' => '事件内容',
'example' => '',
'title' => '事件标题',
'type' => 'string',
],
'createTime' => [
'description' => '事件级别',
'example' => '2020-10-1 00:00:00',
'title' => '创建时间',
'type' => 'string',
],
'isManual' => [
'description' => '',
'example' => 'true',
'title' => '事件来源 是=手动 否=自动',
'type' => 'boolean',
],
'incidentNumber' => [
'description' => '',
'example' => 'I3000021',
'title' => '事件编号',
'type' => 'string',
],
'relServiceDeleteType' => [
'description' => '',
'format' => 'int32',
'title' => '服务删除字段 1正常 0删除',
'type' => 'integer',
],
'relRouteRuleDeleteType' => [
'description' => '',
'format' => 'int32',
'title' => '规则删除字段 1正常 0删除',
'type' => 'integer',
],
'assignToWhoIsValid' => [
'description' => '',
'format' => 'int64',
'title' => '分派的用户是否生效,1生效,0失效',
'type' => 'integer',
],
],
'title' => 'IncidentItemType',
'type' => 'object',
],
'type' => 'array',
],
'totalCount' => [
'description' => '',
'example' => '60',
'format' => 'int32',
'title' => '总数',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'title' => '页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'title' => '行',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'required' => false,
'title' => '事件ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'title' => '幂等校验',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'title' => '行',
'type' => 'integer',
],
'idSort' => [
'title' => 'id排序方式(desc 倒序,asc 正序)',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => 'object',
'properties' => [
'title' => [
'description' => '',
'example' => '',
'title' => '主题',
'type' => 'string',
],
'description' => [
'description' => '',
'example' => '',
'title' => '描述',
'type' => 'string',
],
'remark' => [
'description' => '',
'example' => '',
'title' => '备注',
'type' => 'string',
],
'relatedServiceName' => [
'description' => '',
'example' => '',
'title' => '服务名称',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '',
'title' => '创建时间',
'type' => 'string',
],
'incidentId' => [
'description' => '',
'example' => '',
'format' => 'int64',
'title' => '事件Id',
'type' => 'integer',
],
'action' => [
'description' => '',
'example' => 'INCIDENT_ADD',
'title' => '事件action',
'type' => 'string',
],
'snapshotData' => [
'description' => '',
'example' => '',
'title' => '快照数据',
'type' => 'string',
],
'relRouteRuleDeleteType' => [
'title' => '规则删除字段 1正常 0删除或者无规则',
'type' => 'integer',
'format' => 'int32',
],
],
'type' => 'object',
],
'type' => 'array',
],
'totalCount' => [
'description' => '',
'example' => '',
'format' => 'int32',
'title' => '总数',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'title' => '幂等校验Id',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'title' => '行',
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => 'object',
'properties' => [
'title' => [
'description' => '',
'example' => '',
'title' => '动态',
'type' => 'string',
],
'description' => [
'description' => '',
'example' => '',
'format' => 'int64',
'title' => '描述',
'type' => 'integer',
],
'remark' => [
'description' => '',
'example' => '',
'title' => '备注',
'type' => 'string',
],
'relatedServiceName' => [
'description' => '',
'example' => '',
'title' => '服务名称',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2021-06-23 00:00:00',
'title' => '创建时间',
'type' => 'string',
],
'incidentTitle' => [
'description' => '',
'example' => '',
'title' => '事件标题',
'type' => 'string',
],
'action' => [
'description' => '',
'example' => 'INCIDENT_ADD',
'title' => '动态类型 触发新增 INCIDENT_ADD 响应 INCIDENT_RESPONSE 转交 INCIDENT_DELIVER 变更 INCIDENT_UPDATE 添加小计 INCIDENT_ADD_SUBTOTAL 完结 INCIDENT_FINISH 分配 INCIDENT_ASSIGN 升级 INCIDENT_UPGRAD',
'type' => 'string',
],
'incidentId' => [
'description' => '',
'example' => '3321',
'format' => 'int64',
'title' => '事件Id',
'type' => 'integer',
],
'incidentNumber' => [
'description' => '',
'example' => 'I13002001',
'title' => '事件编号',
'type' => 'string',
],
'snapshotData' => [
'description' => '',
'example' => '',
'title' => '动态快照数据',
'type' => 'string',
],
'relRouteRuleDeleteType' => [
'title' => '规则删除字段',
'type' => 'integer',
'format' => 'int32',
],
],
'type' => 'object',
],
'type' => 'array',
],
'totalCount' => [
'description' => '',
'example' => '132',
'format' => 'int32',
'title' => '总数',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'incidentIds' => [
'description' => '',
'items' => [
'example' => '6754',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => true,
'title' => '事件id列表',
'type' => 'array',
],
'clientToken' => [
'description' => '',
'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
'required' => false,
'title' => '幂等标识',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'data' => [
'description' => 'data',
'properties' => [
'subtotalCount' => [
'description' => 'map',
'example' => '{12:12}',
'title' => 'map',
'type' => 'object',
],
'requestId' => [
'description' => 'id of the request',
'example' => '24343424234',
'title' => 'id of the request',
'type' => 'string',
],
],
'title' => 'data',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '32',
'format' => 'int64',
'required' => true,
'title' => '事件id',
'type' => 'integer',
],
'incidentTitle' => [
'description' => '',
'example' => 'xxx事件',
'required' => true,
'title' => '事件标题',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2021-09-09 09:09:09',
'required' => true,
'title' => '触发时间',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '',
'example' => '23',
'format' => 'int64',
'required' => true,
'title' => '关联服务id',
'type' => 'integer',
],
'events' => [
'description' => '',
'items' => [
'example' => 'xxx',
'required' => true,
'type' => 'string',
],
'required' => true,
'title' => '事件告警内容',
'type' => 'array',
],
'clientToken' => [
'description' => '',
'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
'required' => false,
'title' => '幂等标识',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
'title' => 'id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'topFiveIncidents' => [
'description' => 'topFiveIncidents',
'items' => [
'description' => 'object',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '32',
'format' => 'int64',
'title' => '事件id',
'type' => 'integer',
],
'incidentNumber' => [
'description' => '',
'example' => 'I34324',
'title' => '事件编号',
'type' => 'string',
],
'incidentTitle' => [
'description' => '',
'example' => 'xxx事件',
'title' => '事件标题',
'type' => 'string',
],
'relatedRouteRuleId' => [
'description' => '',
'example' => '4343',
'format' => 'int64',
'title' => '流转规则id',
'type' => 'integer',
],
'relatedRouteRuleName' => [
'description' => '',
'example' => 'xxx',
'title' => '流转规则名称',
'type' => 'string',
],
'finishReason' => [
'description' => '',
'example' => '2',
'format' => 'int64',
'title' => '触发原因',
'type' => 'integer',
],
'finishReasonDescription' => [
'description' => '',
'example' => 'xxxx原因',
'title' => '触发原因描述',
'type' => 'string',
],
'incidentFinishSolution' => [
'description' => '',
'example' => '5',
'format' => 'int64',
'title' => '解决方案',
'type' => 'integer',
],
'finishSolutionDescription' => [
'description' => '',
'example' => 'xxx方案',
'title' => '解决方案描述',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2021-09-09 09:09:09',
'title' => '触发时间',
'type' => 'string',
],
'assignUserId' => [
'description' => '',
'example' => '43',
'title' => '分派人id',
'type' => 'string',
],
'assignUserName' => [
'description' => '',
'example' => '张老三',
'title' => '分派人',
'type' => 'string',
],
'durationTime' => [
'description' => '',
'example' => '6787678767',
'format' => 'int64',
'title' => '持续时间',
'type' => 'integer',
],
'similarScore' => [
'description' => '',
'example' => '1992.21',
'title' => '相似度',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => 'topFiveIncidents',
'type' => 'array',
],
'countInSixMonths' => [
'description' => '',
'example' => '43',
'format' => 'int64',
'title' => '6月内相似事件数量',
'type' => 'integer',
],
'countInSevenDays' => [
'description' => '',
'example' => '8',
'format' => 'int64',
'title' => '7天内相似事件数量',
'type' => 'integer',
],
'dailySimilarIncidents' => [
'description' => '',
'example' => '{}',
'items' => [
'description' => 'object',
'properties' => [
'date' => [
'description' => '',
'example' => '2021-03-07',
'title' => '日期',
'type' => 'string',
],
'commitment' => [
'description' => '',
'example' => '0',
'format' => 'int64',
'title' => '数量',
'type' => 'integer',
],
'month' => [
'description' => '',
'example' => '2',
'format' => 'int64',
'title' => '月份',
'type' => 'integer',
],
'week' => [
'description' => '',
'example' => '1',
'title' => '周',
'type' => 'string',
],
'day' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '星期几',
'type' => 'integer',
],
'similarIncidents' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '5435',
'format' => 'int64',
'title' => '事件id',
'type' => 'integer',
],
'incidentNumber' => [
'description' => '',
'example' => 'I234432',
'title' => '事件编号',
'type' => 'string',
],
'incidentTitle' => [
'description' => '',
'example' => '线性代数发多少',
'title' => '事件名称',
'type' => 'string',
],
'relatedRouteRuleId' => [
'description' => '',
'example' => '334',
'format' => 'int64',
'title' => '流转规则id',
'type' => 'integer',
],
'relatedRouteRuleName' => [
'description' => '',
'example' => 'xxx规则',
'title' => '流转规则名称',
'type' => 'string',
],
'finishReason' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '触发原因',
'type' => 'integer',
],
'finishReasonDescription' => [
'description' => '',
'example' => 'xx原因',
'title' => '触发原因描述',
'type' => 'string',
],
'incidentFinishSolution' => [
'description' => '',
'example' => '5',
'format' => 'int64',
'title' => '解决方案',
'type' => 'integer',
],
'finishSolutionDescription' => [
'description' => '',
'example' => 'xxx方案',
'title' => '解决方案描述',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2021-09-09 09:09:09',
'title' => '触发时间',
'type' => 'string',
],
'assignUserName' => [
'description' => '',
'example' => '张老三',
'title' => '分派人',
'type' => 'string',
],
'assignUserId' => [
'description' => '',
'example' => '433',
'format' => 'int64',
'title' => '分派人id',
'type' => 'integer',
],
'durationTime' => [
'description' => '',
'example' => '6789765678',
'format' => 'int64',
'title' => '持续时间',
'type' => 'integer',
],
'similarScore' => [
'description' => '',
'example' => '1003.567',
'title' => '相似度',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '相似事件列表',
'type' => 'array',
],
],
'type' => 'object',
],
'title' => '根据日期分类',
'type' => 'array',
],
'requestId' => [
'description' => 'id of the request',
'example' => 'uyihg6789',
'title' => 'id of the request',
'type' => 'string',
],
],
'title' => 'data',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'requestId' => [
'description' => '',
'example' => 'xxxx',
'required' => false,
'title' => '请求ID',
'type' => 'string',
],
'instanceId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'required' => false,
'title' => '报警ID',
'type' => 'integer',
],
'instanceType' => [
'description' => '',
'example' => 'INCIDENT',
'required' => false,
'title' => '类型',
'type' => 'string',
],
'startTime' => [
'description' => '',
'example' => '2020-10-10 00:00:00',
'required' => false,
'title' => '开始时间',
'type' => 'string',
],
'endTime' => [
'description' => '',
'example' => '2020-10-10 23:59:59',
'required' => false,
'title' => '结束时间',
'type' => 'string',
],
'timeUnit' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'required' => false,
'title' => '时间单位毫秒',
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'maxSustainTime' => [
'description' => '',
'example' => '10920312312312',
'format' => 'int64',
'title' => '最大持续时长',
'type' => 'integer',
],
'convergenceRate' => [
'description' => '',
'example' => '90.90%',
'title' => '收敛率',
'type' => 'string',
],
'sourceEventsStatMap' => [
'description' => '',
'example' => '{ "Grafana": [ { "evenTime": "2021-11-15 14:29:59", "eventCount": 4, "monitorSourceName": "Grafana", "monitorSourceCounts": null, "sustainTime": 15646 }, { "evenTime": "2021-11-15 14:30:36", "eventCount": 7, "monitorSourceName": "Grafana", "monitorSourceCounts": null, "sustainTime": 52638 } ] }',
'title' => '按监控源分组统计数据',
'type' => 'object',
],
'skipDay' => [
'description' => '',
'example' => 'true',
'title' => '是否跨天',
'type' => 'boolean',
],
'unit' => [
'description' => '',
'example' => '1000',
'title' => '时间单位',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '统计列表',
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'requestParamsDescription' => '{"instanceId":78958441,"instanceType":"ALERT","clientToken":"82af9e74-6592-435d-aa06-345562cdd37c"}',
],
'ListSourceEventsForMonitorSource' => [
'summary' => '查询监控员最近10次告警',
'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' => [
'description' => 'A short description of struct',
'properties' => [
'monitorSourceId' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'required' => false,
'title' => '监控源ID',
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'items' => [
'properties' => [
'monitorSourceId' => [
'description' => '',
'example' => '1000',
'title' => '监控源ID',
'type' => 'boolean',
],
'monitorSourceName' => [
'description' => '',
'example' => 'zabbix',
'title' => '监控源名称',
'type' => 'string',
],
'eventTime' => [
'description' => '',
'example' => '2020-01-01 18:30:00',
'title' => '告警上报时间',
'type' => 'string',
],
'eventJson' => [
'description' => '',
'example' => '{}',
'title' => '告警内容',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '告警列表',
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'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' => [
'description' => 'A short description of struct',
'properties' => [
'instanceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '报警或者事件ID',
'type' => 'integer',
],
'instanceType' => [
'description' => '',
'example' => 'INCIDENT',
'required' => true,
'title' => 'INCIDENT 事件、ALERT 报警、PROBLEM 故障',
'type' => 'string',
],
'startRowKey' => [
'description' => '',
'example' => '9223370410626682599-1344383-78954515-1-0a6e01a1701447fd9ef18b079edd2c6d',
'required' => false,
'title' => 'startRowKey 用来查询下一页的数据',
'type' => 'string',
],
'stopRowKey' => [
'description' => '',
'example' => '9223370410626682599-1344383-78954515-1-0a6e01a1701447fd9ef18b079edd2c6d',
'required' => false,
'title' => 'stopRowKey 用来查询上一页的数据',
'type' => 'string',
],
'pageSize' => [
'description' => '',
'example' => '20',
'format' => 'int64',
'required' => false,
'title' => '页大小',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '当前页',
'type' => 'integer',
],
'startTime' => [
'description' => '2020-09-10 13:00:00',
'example' => '2020-10-01 00:00:00',
'required' => false,
'title' => '开始时间',
'type' => 'string',
],
'endTime' => [
'description' => '2020-09-18 13:00:00',
'example' => '2020-10-01 23:59:59',
'required' => false,
'title' => '结束时间',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => '请求ID',
'type' => 'string',
],
'totalCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '总条数',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '当前页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '20',
'format' => 'int64',
'title' => '页大小',
'type' => 'integer',
],
'data' => [
'description' => '',
'items' => [
'properties' => [
'routeRuleId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '规则ID',
'type' => 'integer',
],
'instanceType' => [
'description' => '',
'example' => 'INCIDENT',
'title' => 'INCIDENT 事件、ALERT 报警、PROBLEM 故障',
'type' => 'string',
],
'instanceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '关联对象ID',
'type' => 'integer',
],
'monitorSourceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '监控告警源ID',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'example' => 'zabbix',
'title' => '监控告警源名称',
'type' => 'string',
],
'eventTime' => [
'description' => '',
'example' => '2020-09-08 15:53:34',
'title' => '告警上报时间',
'type' => 'string',
],
'tenantRamId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '租户ID',
'type' => 'integer',
],
'eventJson' => [
'description' => '',
'example' => '""',
'title' => '告警内容json',
'type' => 'string',
],
],
'type' => 'object',
],
'type' => 'array',
],
'lastRowKey' => [
'description' => 'lastRowKey',
'example' => '9223370412331485036-1344383-9967-1-8d729a1b176f493ca3be643b391d5ced',
'title' => 'lastRowKey',
'type' => 'string',
],
'firstRowKey' => [
'description' => 'firstRowKey',
'example' => '9223370412331485032-1344383-9967-1-08be8b08ef30441390072f3bfba71c94',
'title' => 'firstRowKey',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'alertLevel' => [
'description' => '',
'example' => 'P1',
'required' => false,
'title' => '报警等级 P1 P2 P3 P4',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '服务id',
'type' => 'integer',
],
'alertName' => [
'description' => '',
'example' => '报警',
'required' => false,
'title' => '报警名称',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '当前页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'title' => '页大小',
'type' => 'integer',
],
'alertSourceName' => [
'description' => '',
'example' => '流转规则A',
'required' => false,
'title' => '报警来源',
'type' => 'string',
],
'startTime' => [
'description' => '2020-09-10 13:00:00',
'example' => '2020-10-01 00:00:00',
'required' => false,
'title' => '开始时间',
'type' => 'string',
],
'endTime' => [
'description' => '2020-09-10 21:00:00',
'example' => '2020-10-01 23:59:59',
'required' => false,
'title' => '结束时间',
'type' => 'string',
],
'ruleName' => [
'description' => '',
'example' => 'zabbix',
'required' => false,
'title' => '流转规则名字',
'type' => 'string',
],
'monitorSourceId' => [
'required' => false,
'title' => '原始信息来源id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => '请求ID',
'type' => 'string',
],
'data' => [
'description' => '',
'items' => [
'properties' => [
'alertId' => [
'description' => '',
'example' => '20000',
'format' => 'int64',
'title' => '报警ID',
'type' => 'integer',
],
'createTime' => [
'description' => '',
'example' => '2020-03-05 15:53:55',
'title' => '创建时间',
'type' => 'string',
],
'relatedServiceName' => [
'description' => '',
'example' => '服务A',
'title' => '关联服务名称',
'type' => 'string',
],
'alertLevel' => [
'description' => '',
'example' => 'P1',
'title' => '告警优先级 1,2,3,4 对应 p1,p2,p3,p4',
'type' => 'string',
],
'title' => [
'description' => '',
'example' => '报警',
'title' => '报警标题',
'type' => 'string',
],
'sourceEventCount' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '收敛量',
'type' => 'integer',
],
'alertSourceName' => [
'description' => '',
'example' => 'zabbix',
'title' => '报警源',
'type' => 'string',
],
'firstEventTime' => [
'description' => '',
'example' => '2021-09-08 18:30:00',
'title' => '第一次告警上报时间',
'type' => 'string',
],
'routeRuleId' => [
'description' => '',
'example' => '10000',
'format' => 'int64',
'title' => '关联流转规则ID',
'type' => 'integer',
],
'alertNumber' => [
'description' => '',
'example' => 'A123123123',
'title' => '报警编号',
'type' => 'string',
],
'routeRuleName' => [
'description' => '',
'example' => '流转规则',
'title' => '流转规则名字',
'type' => 'string',
],
'relServiceDeleteType' => [
'description' => '',
'format' => 'int32',
'title' => '服务删除字段 1正常 0删除',
'type' => 'integer',
],
'routeRuleDeleteType' => [
'description' => '',
'format' => 'int32',
'title' => '规则删除字段 1正常 0删除',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'title' => '原始数据名称',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '报警列表',
'type' => 'array',
],
'totalCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '总条数',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'title' => '当前页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'title' => '页的大小',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'monitorSourceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '监控源ID不能为空',
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'XXXXXXXXXXXX',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'properties' => [
'monitorSourceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '告警源ID',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'example' => 'zabbix',
'title' => '告警源名称',
'type' => 'string',
],
'eventTime' => [
'description' => '',
'example' => '2002-09-08 15:30:35',
'title' => '告警上报时间',
'type' => 'string',
],
'eventJson' => [
'description' => '',
'example' => '“”',
'title' => '告警内容',
'type' => 'string',
],
],
'title' => '告警',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'instanceId' => [
'description' => '',
'example' => '123123',
'format' => 'int64',
'required' => false,
'title' => '资源id',
'type' => 'integer',
],
'instanceType' => [
'description' => '',
'example' => 'INCIDENT 事件 ALERT告警 PROBLEM故障',
'required' => false,
'title' => '资源类型',
'type' => 'string',
],
'files' => [
'description' => '',
'items' => [
'properties' => [
'fileName' => [
'description' => '',
'example' => '文件A',
'required' => false,
'title' => '文件名称',
'type' => 'string',
],
'fileType' => [
'description' => '',
'example' => 'JPG',
'required' => false,
'title' => '文件类型',
'type' => 'string',
],
'fileSize' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'required' => false,
'title' => '文件大小',
'type' => 'integer',
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '文件',
'type' => 'array',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'bucketName' => [
'description' => 'oss bucket name',
'example' => 'gam-objects-bucket',
'title' => 'oss bucket name',
'type' => 'string',
],
'policy' => [
'description' => 'policy',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19',
'title' => 'policy',
'type' => 'string',
],
'signature' => [
'description' => 'signature',
'example' => 'SHqvIkwUNQd8Hervklir2K8U+ts=',
'title' => 'signature',
'type' => 'string',
],
'accessKeyId' => [
'description' => 'accessKeyId',
'example' => 'LTAI1tEoRVPw8GMy1iLRCno7',
'title' => 'accessKeyId',
'type' => 'string',
],
'url' => [
'description' => 'url',
'example' => 'https://gam-objects-bucket.oss-cn-shanghai.aliyuncs.com',
'title' => 'url',
'type' => 'string',
],
'files' => [
'description' => 'files',
'items' => [
'properties' => [
'fileName' => [
'description' => '',
'example' => '文件A',
'title' => '文件名称',
'type' => 'string',
],
'fileType' => [
'description' => '',
'example' => 'JPG',
'title' => '文件类型',
'type' => 'string',
],
'fileSize' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '文件大小',
'type' => 'integer',
],
'key' => [
'description' => 'oss key',
'example' => 'problem/25a2316c-b08d-41a5-9f41-b3185d529277',
'title' => 'oss key',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => 'files',
'type' => 'array',
],
],
'title' => 'data',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'title' => '幂等校验',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'required' => false,
'title' => '行',
'type' => 'integer',
],
'createTimeSort' => [
'description' => '',
'example' => 'desc,asc',
'required' => false,
'title' => '时间排序',
'type' => 'string',
],
'problemId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '故障id',
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'requestId',
'type' => 'string',
],
'totalCount' => [
'description' => '',
'example' => '210',
'format' => 'int32',
'title' => '总数',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'title' => '页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'title' => '行',
'type' => 'integer',
],
'data' => [
'description' => 'data',
'items' => [
'properties' => [
'title' => [
'description' => '',
'example' => '动态标题',
'title' => '动态标题',
'type' => 'string',
],
'description' => [
'description' => '',
'example' => '描述',
'title' => '描述',
'type' => 'string',
],
'relatedServiceName' => [
'description' => '',
'example' => '服务A',
'title' => '服务',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2021-01-23 00:00:00',
'title' => '创建时间',
'type' => 'string',
],
'remark' => [
'description' => '',
'example' => '备注',
'title' => '备注',
'type' => 'string',
],
'action' => [
'description' => '',
'example' => 'PROBLEM_CANCEL',
'title' => '升级 PROBLEM_UPGRADE 撤销 PROBLEM_REVOKE 恢复 PROBLEM_RESTORE 复盘 PROBLEM_IN_REVIEW 完结 PROBLEM_REOPENED 取消 PROBLEM_CANCEL 更新故障通告 PROBLEM_UPDATE_NOTIFY 添加故障小计 PROBLEM_ADD_SUBTOTAL 更新故障 PROBLEM_UPDATE',
'type' => 'string',
],
'snapshotData' => [
'description' => '',
'example' => '{“userName”:"小明"}',
'title' => '快照数据',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => 'data',
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'requestParamsDescription' => '{'."\n"
.' "clientToken" : "FD200FAE-E98F-496E-BFE6-4CE61E59A2E9",'."\n"
.' "pageNumber" : 1,'."\n"
.' "pageSize" : 10,'."\n"
.' "createTimeSort" : "desc,asc",'."\n"
.' "problemId" : 1'."\n"
.'}',
],
'UpdateProblemImprovement' => [
'summary' => '改进分析更新',
'path' => '/problem/improvement/update',
'methods' => [
'post',
],
'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' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'required' => false,
'title' => '故障ID',
'type' => 'integer',
],
'problemReason' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '故障原因',
'type' => 'string',
],
'recentActivity' => [
'description' => '',
'example' => '2',
'required' => false,
'title' => '最近活动 码表:PROBLEM_RECENT_ACTIVITY',
'type' => 'string',
],
'injectionMode' => [
'description' => '',
'example' => '1',
'required' => false,
'title' => '注入方式 码表:PROBLEM_INJECTION_MODE',
'type' => 'string',
],
'recoveryMode' => [
'description' => '',
'example' => '2',
'required' => false,
'title' => '恢复方式 码表:PROBLEM_RECOVERY_MODE',
'type' => 'string',
],
'discoverSource' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '发现来源 码表:PROBLEM_DISCOVER_SOURCE',
'type' => 'integer',
],
'userReport' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'title' => '用户上报 码表:PROBLEM_USER_REPORT',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'example' => 'Zabbix',
'required' => false,
'title' => '监控源',
'type' => 'string',
],
'relationChanges' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '关联变更',
'type' => 'string',
],
'dutyUserId' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'required' => false,
'title' => '故障责任人id',
'type' => 'integer',
],
'replayDutyUserId' => [
'description' => '',
'example' => '1213',
'format' => 'int64',
'required' => false,
'title' => '复盘负责人id',
'type' => 'integer',
],
'dutyDepartmentName' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '故障责任部门',
'type' => 'string',
],
'dutyDepartmentId' => [
'description' => '',
'example' => '123123',
'format' => 'int64',
'required' => false,
'title' => '故障责任部门ID',
'type' => 'integer',
],
'remark' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '备注',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3813',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
'customProblemReason' => [
'title' => '自定义故障原因',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '12313',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'title' => '服务列表',
'type' => 'array',
],
'clientToken' => [
'description' => '',
'example' => '89f51d2e-5527-4f6c-a6c6-4411b5496e9f',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '89f51d2e-5527-4f6c-a6c6-4411b5496e9f',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => 'object',
'properties' => [
'serviceId' => [
'description' => '',
'example' => '123113',
'format' => 'int64',
'title' => '主键',
'type' => 'integer',
],
'serviceName' => [
'description' => '',
'example' => '',
'title' => '服务组名称',
'type' => 'string',
],
'serviceGroupDescription' => [
'description' => '',
'example' => '',
'title' => '服务组描述',
'type' => 'string',
],
],
'type' => 'object',
],
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'problemName' => [
'description' => '',
'example' => '故障A',
'required' => false,
'title' => '故障名称',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => 'E789D869-DB13-4913-BAA8-A1F56F94B94D',
'required' => false,
'title' => '幂等校验Id',
'type' => 'string',
],
'problemStatus' => [
'description' => '',
'example' => 'HANDLING',
'required' => false,
'title' => '故障状态 HANDLING 处理中 RECOVERED 已恢复 REPLAYING 复盘中 REPLAYED 已复盘 CANCEL 已取消',
'type' => 'string',
],
'problemLevel' => [
'description' => '',
'example' => 'P2',
'required' => false,
'title' => '故障等级 1=P1 2=P2 3=P3 4=P4',
'type' => 'string',
],
'progressSummary' => [
'description' => '',
'example' => '进展摘要',
'required' => false,
'title' => '进展摘要',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '',
'example' => '123122',
'format' => 'int64',
'required' => false,
'title' => '所属服务',
'type' => 'integer',
],
'mainHandlerId' => [
'description' => '',
'example' => '32121',
'format' => 'int64',
'required' => false,
'title' => '主要处理人',
'type' => 'integer',
],
'preliminaryReason' => [
'description' => '',
'example' => '初步原因',
'required' => false,
'title' => '初步原因',
'type' => 'string',
],
'discoverTime' => [
'description' => '',
'example' => '2020-10-02 00:00:00',
'required' => false,
'title' => '发现时间 (XXXX-XX-XX 00:00:00)',
'type' => 'string',
],
'recoveryTime' => [
'description' => '',
'example' => '2020-10-02 00:00:00',
'required' => false,
'title' => '恢复时间',
'type' => 'string',
],
'affectServiceIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '1232231',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'title' => '影响服务列表',
'type' => 'array',
],
'serviceGroupIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '213121',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'title' => '应急协同组',
'type' => 'array',
],
'incidentId' => [
'description' => '',
'example' => '123221',
'format' => 'int64',
'required' => false,
'title' => '事件id',
'type' => 'integer',
],
'problemNotifyType' => [
'description' => '',
'example' => 'PROBLEM_NOTIFY',
'required' => false,
'title' => '通告类型',
'type' => 'string',
],
'progressSummaryRichTextId' => [
'description' => '',
'example' => '343',
'format' => 'int64',
'required' => false,
'title' => '进展摘要富文本id',
'type' => 'integer',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'E789D869-DB13-4933-BAA8-A1F56F94B94D',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'problemId' => [
'description' => '',
'example' => '321331',
'format' => 'int64',
'title' => '故障Id',
'type' => 'integer',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'type' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '措施类型',
'type' => 'integer',
],
'problemId' => [
'description' => '',
'example' => '23',
'format' => 'int64',
'required' => true,
'title' => '故障Id',
'type' => 'integer',
],
'content' => [
'description' => '',
'example' => '措施内容',
'required' => false,
'title' => '措施内容',
'type' => 'string',
],
'checkStandard' => [
'description' => '',
'example' => '标准',
'required' => false,
'title' => '验收标准',
'type' => 'string',
],
'checkUserId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'required' => false,
'title' => '验收人id',
'type' => 'integer',
],
'planFinishTime' => [
'description' => '',
'example' => '2020-01-23 00:00:00',
'required' => false,
'title' => '计划完成时间',
'type' => 'string',
],
'directorId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'required' => false,
'title' => '负责人id',
'type' => 'integer',
],
'stalkerId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'required' => false,
'title' => '跟踪人id',
'type' => 'integer',
],
'status' => [
'description' => '',
'example' => 'IMPROVED',
'required' => false,
'title' => '状态 IMPROVED 改进 2 未改进UNIMPROVED',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'measureId' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'title' => '故障措施Id',
'type' => 'integer',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'required' => true,
'title' => '故障Id',
'type' => 'integer',
],
'description' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '小计文本',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3814',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd381A',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'object',
'properties' => [
'subtotalId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'title' => '小计id',
'type' => 'integer',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '102',
'format' => 'int64',
'required' => true,
'title' => '故障id',
'type' => 'integer',
],
'keyNode' => [
'description' => '',
'example' => 'NodeTest',
'required' => false,
'title' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
'type' => 'string',
],
'content' => [
'description' => '',
'example' => 'test123',
'required' => false,
'title' => '节点内容',
'type' => 'string',
],
'time' => [
'description' => '',
'example' => '2021-06-06 12:11:22',
'required' => false,
'title' => '发生时间',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'title' => 'id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'problemTimelineId' => [
'description' => '',
'example' => '102',
'format' => 'int64',
'title' => '故障事件线id',
'type' => 'integer',
],
],
'title' => 'Object',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '423',
'format' => 'int64',
'required' => true,
'title' => '故障id',
'type' => 'integer',
],
'timelineNodes' => [
'description' => '',
'example' => '2018-01-01 18:01,谁做了什么事情\\n2018-01-01 18:01,谁做了什么事情\\n2018-01-01 18:01,谁做了什么事情',
'required' => false,
'title' => '时间线节点',
'type' => 'string',
],
'clientToken' => [
'description' => 'clientToken',
'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'problemTimelineIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '435',
'format' => 'int64',
'type' => 'integer',
],
'type' => 'array',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'title' => '故障ID',
'type' => 'integer',
],
'serviceGroupIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '应急协同组ID',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'title' => '应急协同组',
'type' => 'array',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '5AD6E6BC-2582-4E0E-832D-52CB1B922253',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"5AD6E6BC-2582-4E0E-832D-52CB1B922253\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5AD6E6BC-2582-4E0E-832D-52CB1B922253\\n","errorExample":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '213432',
'format' => 'int64',
'required' => false,
'title' => '故障ID',
'type' => 'integer',
],
'problemName' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '故障名',
'type' => 'string',
],
'level' => [
'description' => '',
'example' => 'P1',
'required' => false,
'title' => '故障等级',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'required' => false,
'title' => '所属服务',
'type' => 'integer',
],
'progressSummary' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '进展摘要',
'type' => 'string',
],
'preliminaryReason' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '初步原因',
'type' => 'string',
],
'mainHandlerId' => [
'description' => '',
'example' => '678',
'format' => 'int64',
'required' => false,
'title' => '主要处理人',
'type' => 'integer',
],
'feedback' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '舆情反馈',
'type' => 'string',
],
'serviceGroupIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '102',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'title' => '应急协同组',
'type' => 'array',
],
'progressSummaryRichTextId' => [
'description' => '',
'example' => '23232',
'format' => 'int64',
'required' => false,
'title' => '进展摘要富文本id',
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'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',
'properties' => [
'problemNotifyType' => [
'description' => '',
'example' => 'PROBLEM_NOTIFY',
'required' => false,
'title' => '通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE: 故障补发 PROBLEM_CANCEL:故障取消',
'type' => 'string',
],
'problemId' => [
'description' => '',
'example' => '1312',
'format' => 'int64',
'required' => false,
'title' => '故障Id',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'required' => false,
'title' => '幂等校验Id',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemTimelineId' => [
'description' => '',
'example' => '3940',
'format' => 'int64',
'required' => false,
'title' => '时间节点id',
'type' => 'integer',
],
'keyNode' => [
'description' => '',
'example' => 'NodeTest',
'required' => false,
'title' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
'type' => 'string',
],
'content' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '节点内容',
'type' => 'string',
],
'time' => [
'description' => '',
'example' => '2021-01-08 10:10:10',
'required' => false,
'title' => '发生时间',
'type' => 'string',
],
'problemId' => [
'description' => '',
'example' => '234',
'format' => 'int64',
'required' => false,
'title' => '故障id',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => ' id of the request',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'fileName' => [
'description' => '',
'example' => 'test',
'required' => false,
'title' => '文件名',
'type' => 'string',
],
'fileType' => [
'description' => '',
'example' => 'png',
'required' => false,
'title' => '文件类型',
'type' => 'string',
],
'fileSize' => [
'description' => '',
'example' => '1000',
'format' => 'int64',
'required' => false,
'title' => '文件大小KB',
'type' => 'integer',
],
'problemId' => [
'description' => '',
'example' => '67876',
'format' => 'int64',
'required' => false,
'title' => '故障id',
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd',
'title' => 'requestId',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'bucketName' => [
'description' => 'oss bucket name',
'example' => 'xxxx-xxxx-xxxx',
'title' => 'oss bucket name',
'type' => 'string',
],
'key' => [
'description' => 'oss key',
'example' => 'problem/xxxxxxxxxxxxxxxx1-b3185d529277',
'title' => 'oss key',
'type' => 'string',
],
'policy' => [
'description' => 'policy',
'example' => 'eyJleHBpcmF0a0p0IjoiMjAyMS0wNy0xM1QwNDowOTo0NS4yODJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInByb2JsZW0iXV19',
'title' => 'policy',
'type' => 'string',
],
'signature' => [
'description' => 'signature',
'example' => 'SHqvIkwUNQd0o0rvklir2K8U+ts=',
'title' => 'signature',
'type' => 'string',
],
'url' => [
'description' => 'url',
'example' => 'https://xxx-xxx-bucket.oss-cn-shanghai.aliyuncs.com',
'title' => 'url',
'type' => 'string',
],
'accessKeyId' => [
'description' => 'ossaccessKeyId',
'example' => 'XXXXXXXH8GMy1iLRCno7',
'title' => 'ossaccessKeyId',
'type' => 'string',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'ListProblemOperations' => [
'summary' => '查询故障7天内动态',
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'title' => '页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'required' => false,
'title' => '行',
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'Id of the request',
'type' => 'string',
],
'totalCount' => [
'description' => '',
'example' => '132',
'format' => 'int32',
'title' => '总数',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'title' => '页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'title' => '行',
'type' => 'integer',
],
'data' => [
'description' => 'data',
'items' => [
'properties' => [
'title' => [
'description' => '',
'example' => '动态标题',
'title' => '动态标题',
'type' => 'string',
],
'description' => [
'description' => '',
'example' => '描述',
'title' => '描述',
'type' => 'string',
],
'relatedServiceName' => [
'description' => '',
'example' => '服务名称',
'title' => '服务名称',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2021-01-23 00:00:00',
'title' => '创建时间',
'type' => 'string',
],
'action' => [
'description' => '',
'example' => 'PROBLEM_CANCEL',
'title' => '升级 PROBLEM_UPGRADE 撤销 PROBLEM_REVOKE 恢复 PROBLEM_RESTORE 复盘 PROBLEM_IN_REVIEW 完结 PROBLEM_REOPENED 取消 PROBLEM_CANCEL 更新故障通告 PROBLEM_UPDATE_NOTIFY 添加故障小计 PROBLEM_ADD_SUBTOTAL 更新故障 PROBLEM_UPDATE',
'type' => 'string',
],
'problemId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'title' => '故障Id',
'type' => 'integer',
],
'problemName' => [
'description' => '',
'example' => '这是一个故障',
'title' => '故障名称',
'type' => 'string',
],
'problemNumber' => [
'description' => '',
'example' => 'P1231231',
'title' => '故障编号',
'type' => 'string',
],
'snapshotData' => [
'description' => '',
'example' => '{“userName”:"小明"}',
'title' => '快照数据',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => 'data',
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'queryType' => [
'description' => '',
'example' => 'RESPONSIBLE',
'required' => false,
'title' => 'RESPONSIBLE 我负责的 PARTICIPATED 我参与的 ALL 全部',
'type' => 'string',
],
'problemStatus' => [
'description' => '',
'example' => 'HANDLING',
'required' => false,
'title' => '故障状态 HANDLING 处理中 RECOVERED 已恢复 REPLAYING 复盘中 REPLAYED 已复盘 CANCEL 已取消',
'type' => 'string',
],
'problemLevel' => [
'description' => '',
'example' => 'P2',
'required' => false,
'title' => '故障等级 1=P1 2=P2 3=P3 4=P4',
'type' => 'string',
],
'affectServiceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '影响服务ID',
'type' => 'integer',
],
'serviceGroupId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '应急协同组',
'type' => 'integer',
],
'mainHandlerId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '主要处理人',
'type' => 'integer',
],
'repeaterId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '复盘负责人',
'type' => 'integer',
],
'discoveryStartTime' => [
'description' => '',
'example' => '2020-03-05 15:50:59',
'required' => false,
'title' => '发现开始时间',
'type' => 'string',
],
'discoveryEndTime' => [
'description' => '',
'example' => '2020-03-05 15:50:59',
'required' => false,
'title' => '发现结束时间',
'type' => 'string',
],
'restoreEndTime' => [
'description' => '',
'example' => '2020-03-05 15:50:59',
'required' => false,
'title' => '恢复结束时间',
'type' => 'string',
],
'restoreStartTime' => [
'description' => '',
'example' => '2020-03-05 15:50:59',
'required' => false,
'title' => '恢复开始时间',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '当前页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'title' => '页大小',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'items' => [
'properties' => [
'problemId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '故障id',
'type' => 'integer',
],
'isManual' => [
'description' => '',
'example' => 'true',
'title' => '是否手动',
'type' => 'boolean',
],
'isUpgrade' => [
'description' => '',
'example' => 'true',
'title' => '是否升级',
'type' => 'boolean',
],
'incidentId' => [
'description' => '',
'example' => '10000',
'format' => 'int64',
'title' => '事件ID',
'type' => 'integer',
],
'createTime' => [
'description' => '',
'example' => '2020-09-08 15:59:59',
'title' => '创建时间',
'type' => 'string',
],
'updateTime' => [
'description' => '',
'example' => '2020-09-08 15:59:59',
'title' => '修改时间',
'type' => 'string',
],
'problemNumber' => [
'description' => '',
'example' => 'P34438300000001116258132229577472',
'title' => '故障编号',
'type' => 'string',
],
'problemName' => [
'description' => '',
'example' => '故障',
'title' => '故障名称',
'type' => 'string',
],
'problemStatus' => [
'description' => '',
'example' => 'HANDLING',
'title' => '故障状态 HANDLING 处理中 RECOVERED 已恢复 REPLAYING 复盘中 REPLAYED 已复盘 CANCEL 已取消',
'type' => 'string',
],
'problemLevel' => [
'description' => '',
'example' => 'P1',
'title' => '故障等级 1=P1 2=P2 3=P3 4=P4',
'type' => 'string',
],
'discoverTime' => [
'description' => '',
'example' => '2020-09-08 15:59:59',
'title' => '发现时间',
'type' => 'string',
],
'recoveryTime' => [
'description' => '',
'example' => '2020-09-08 15:59:59',
'title' => '恢复时间',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '',
'example' => '1',
'title' => '关联服务ID',
'type' => 'string',
],
'serviceName' => [
'description' => '',
'example' => '服务1',
'title' => '关联服务名称',
'type' => 'string',
],
'affectServices' => [
'description' => '',
'items' => [
'properties' => [
'serviceId' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '影响服务ID',
'type' => 'integer',
],
'serviceDescription' => [
'description' => '',
'example' => '服务描述',
'title' => '服务描述',
'type' => 'string',
],
'serviceName' => [
'description' => '',
'example' => '冲上云霄',
'title' => '服务名字',
'type' => 'string',
],
'updateTime' => [
'description' => '',
'example' => '2020-09-08 15:59:59',
'title' => '修改时间',
'type' => 'string',
],
],
'type' => 'object',
],
'type' => 'array',
],
'mainHandlerId' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '主要处理人ID',
'type' => 'integer',
],
'mainHandlerName' => [
'description' => '',
'example' => '王宇',
'title' => '主要处理人名称',
'type' => 'string',
],
'cancelTime' => [
'description' => '',
'example' => '2020-09-08 15:59:59',
'title' => '取消时间',
'type' => 'string',
],
'finishTime' => [
'description' => '',
'example' => '2020-09-08 15:59:59',
'title' => '完结时间',
'type' => 'string',
],
'replayTime' => [
'description' => '',
'example' => '2020-09-08 15:59:59',
'title' => '复盘时间',
'type' => 'string',
],
'serviceDeletedType' => [
'title' => '服务删除字段',
'type' => 'integer',
'format' => 'int32',
],
'mainHandlerIsValid' => [
'type' => 'integer',
'format' => 'int64',
],
],
'type' => 'object',
],
'type' => 'array',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '当前页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '页大小',
'type' => 'integer',
],
'totalCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '总条数',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'required' => false,
'title' => '故障Id',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '4361a0e1-6747-4834-96ce-0c4840fdB812',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '4361a0e1-6747-4834-96ce-0S4840fd3812',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => 'object',
'properties' => [
'description' => [
'description' => '',
'example' => '',
'title' => '描述',
'type' => 'string',
],
'createTime' => [
'description' => '',
'example' => '2020-10-02 00:00:00',
'title' => '创建时间',
'type' => 'string',
],
'createRamName' => [
'description' => '',
'example' => '',
'title' => '操作人',
'type' => 'string',
],
'createUserPhone' => [
'description' => '',
'example' => '130****11111',
'title' => '操作人手机号',
'type' => 'string',
],
'createUserId' => [
'description' => '',
'example' => '123123',
'format' => 'int64',
'title' => '人员id',
'type' => 'integer',
],
],
'type' => 'object',
],
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '312',
'format' => 'int64',
'required' => false,
'title' => '故障id',
'type' => 'integer',
],
'cancelReasonDescription' => [
'description' => '',
'example' => '原因描述',
'required' => false,
'title' => '取消原因描述',
'type' => 'string',
],
'cancelReason' => [
'description' => '',
'example' => '取消原因',
'format' => 'int64',
'required' => false,
'title' => '取消原因',
'type' => 'integer',
],
'problemNotifyType' => [
'description' => '',
'example' => 'PROBLEM_NOTIFY',
'format' => 'int64',
'required' => false,
'title' => 'PROBLEM_NOTIFY 通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE: 故障补发 PROBLEM_CANCEL:故障取消',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'B81E84B5-8FD1-45F3-969A-B5067AADCFFF',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '3123',
'format' => 'int64',
'required' => false,
'title' => '故障Id',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '6338F42D-ED0B-442C-932C-657300AFB4BB',
'required' => false,
'title' => '幂等校验',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '6338F42D-ED0B-442C-932C-657300AFB4BB',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'required' => false,
'title' => '故障ID',
'type' => 'integer',
],
'recoveryTime' => [
'description' => '',
'example' => '2020-02-01 00:00:00',
'required' => false,
'title' => '恢复时间',
'type' => 'string',
],
'problemNotifyType' => [
'description' => '',
'example' => 'PROBLEM_UPDATE',
'required' => false,
'title' => '通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE: 故障补发 PROBLEM_CANCEL:故障取消',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'EBC39DEF-C95B-46F8-9AE3-204F0B0A706D',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'required' => false,
'title' => '故障ID',
'type' => 'integer',
],
'replayDutyUserId' => [
'description' => '',
'example' => '3123',
'format' => 'int64',
'required' => false,
'title' => '复盘负责人ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3212',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'B81E84B5-8FD1-45F3-969A-B5067AADCFFF',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'required' => false,
'title' => '故障ID',
'type' => 'integer',
],
'problemNotifyType' => [
'description' => '',
'example' => 'PROBLEM_UPGRADE',
'required' => false,
'title' => '通告类型 PROBLEM_NOTIFY:故障通告 PROBLEM_UPDATE:故障更新 PROBLEM_UPGRADE:故障升级 PROBLEM_DEGRADE:故障降级 PROBLEM_RECOVER:故障恢复 PROBLEM_REISSUE: 故障补发 PROBLEM_CANCEL:故障取消',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2EF',
'required' => false,
'title' => '幂等校验Id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'GenerateProblemPictureLink' => [
'summary' => '获取图片下载url',
'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' => [
'description' => 'A short description of struct',
'properties' => [
'keys' => [
'description' => 'oss key',
'items' => [
'description' => 'keys',
'example' => 'problem/38b2a7893-484d-8989-b9cf-d243e53a82c6',
'required' => false,
'type' => 'string',
],
'required' => false,
'title' => 'oss key',
'type' => 'array',
],
'problemId' => [
'description' => '',
'example' => '50002021',
'required' => false,
'title' => '故障id',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => 'c26f36de-1ec8-496a-a828-88067879ef81',
'title' => 'requestId',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'links' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'key' => [
'description' => 'oss key',
'example' => 'problem/xxxxxxxxxx-484d-4242-b9cf-xxxxxxxxxx',
'title' => 'oss key',
'type' => 'string',
],
'link' => [
'description' => '',
'example' => 'http://xxxx-xxxx-bucket.oss-cn-xxxx.aliyuncs.com/pxxxx/38xxxxd-4789-4242-b9cfxxxxxxxxc6?Expires=1xxxxxxxxxx7&OSSAccessKeyId=xxxxxxxxxxxxxx7&Signature=xxxxxxxxxxxxxxxxxxxxxx',
'title' => '图片链接',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '图片链接列表',
'type' => 'array',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceId' => [
'description' => '',
'example' => '33',
'format' => 'int64',
'required' => false,
'title' => '关联服务id',
'type' => 'integer',
],
'level' => [
'description' => '',
'example' => 'P1',
'required' => false,
'title' => '影响等级',
'type' => 'string',
],
'status' => [
'description' => '',
'example' => 'UN_RECOVERED',
'required' => false,
'title' => '影响状态 UN_RECOVERED 未恢复 RECOVERED已恢复',
'type' => 'string',
],
'description' => [
'description' => '',
'example' => '乐嘉国际大厦',
'required' => false,
'title' => '影响描述',
'type' => 'string',
],
'picUrl' => [
'description' => '',
'items' => [
'description' => '',
'example' => 'problem/xxxxxxxx-a2c8-40b9-9162-08a6c2e338e2',
'required' => false,
'type' => 'string',
],
'required' => false,
'title' => '图片地址',
'type' => 'array',
],
'problemId' => [
'description' => '',
'example' => '190000000',
'format' => 'int64',
'required' => false,
'title' => '故障id',
'type' => 'integer',
],
'effectionServiceId' => [
'description' => '',
'example' => '103',
'format' => 'int64',
'required' => false,
'title' => '影响服务id',
'type' => 'integer',
],
'clientToken' => [
'description' => 'clientToken',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => 'ffbf594-e093-46ad-bdcd-df4d7097125a',
'title' => 'requestId',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'effectionServiceId' => [
'description' => '',
'example' => '567',
'format' => 'int64',
'required' => false,
'title' => '影响服务ID',
'type' => 'integer',
],
'problemId' => [
'description' => '',
'example' => '876',
'format' => 'int64',
'required' => false,
'title' => '故障id',
'type' => 'integer',
],
'clientToken' => [
'description' => 'clientToken',
'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'type' => [
'description' => '',
'example' => '3',
'format' => 'int32',
'required' => false,
'title' => '措施类型 码表 PROBLEM_REPLAY_IMPROVEMENT',
'type' => 'integer',
],
'content' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '措施内容',
'type' => 'string',
],
'checkStandard' => [
'description' => '',
'example' => '2',
'required' => false,
'title' => '验收标准',
'type' => 'string',
],
'checkUserId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'required' => false,
'title' => '验收人id',
'type' => 'integer',
],
'directorId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'required' => false,
'title' => '负责人id',
'type' => 'integer',
],
'stalkerId' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'required' => false,
'title' => '跟踪人id',
'type' => 'integer',
],
'planFinishTime' => [
'description' => '',
'example' => '2021-01-21 00:00:00',
'required' => false,
'title' => '计划完成时间',
'type' => 'string',
],
'measureId' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'required' => false,
'title' => '措施Id',
'type' => 'integer',
],
'status' => [
'description' => '',
'example' => 'UNIMPROVED',
'required' => false,
'title' => '状态 IMPROVED 改进 2 未改进UNIMPROVED',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
'problemId' => [
'description' => '',
'example' => '1233',
'format' => 'int64',
'required' => false,
'title' => '故障Id',
'type' => 'integer',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'required' => false,
'title' => '故障Id',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'required' => false,
'title' => '幂等校验',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'problemId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => '故障ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'data' => [
'description' => '',
'properties' => [
'problemId' => [
'description' => 'ID',
'example' => '1',
'format' => 'int64',
'required' => true,
'title' => 'ID',
'type' => 'integer',
'enum' => [
'Success',
'Fail',
'Cancel',
],
],
'createTime' => [
'description' => '',
'example' => '2010-03-09 15:53:45',
'title' => '创建时间',
'type' => 'string',
],
'incidentNumber' => [
'description' => '',
'example' => 'I3443835000012016260833157948165',
'title' => '事件编号',
'type' => 'string',
],
'incidentId' => [
'description' => '',
'example' => '130000032',
'format' => 'int64',
'title' => '事件id',
'type' => 'integer',
],
'problemNumber' => [
'description' => '',
'example' => 'P34438300010030116260833538987481',
'title' => '故障编号',
'type' => 'string',
],
'problemName' => [
'description' => '',
'example' => '故障',
'title' => '故障名称',
'type' => 'string',
],
'problemStatus' => [
'description' => '',
'example' => 'HANDLING',
'format' => 'int32',
'title' => '故障状态 HANDLING 处理中 RECOVERED 已恢复 REPLAYING 复盘中 REPLAYED 已复盘 CANCEL 已取消',
'type' => 'integer',
],
'problemLevel' => [
'description' => '',
'example' => 'P1',
'format' => 'int32',
'title' => '故障等级 P1 P2 P3 P4',
'type' => 'integer',
],
'discoverTime' => [
'description' => '',
'example' => '2010-03-09 15:53:45',
'title' => '发现时间',
'type' => 'string',
],
'recoveryTime' => [
'description' => '',
'example' => '2010-03-09 15:53:45',
'title' => '恢复时间',
'type' => 'string',
],
'relatedServiceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '关联服务ID',
'type' => 'integer',
],
'serviceName' => [
'description' => '',
'example' => '服务',
'title' => '关联服务 名称',
'type' => 'string',
],
'progressSummary' => [
'description' => '',
'example' => '摘要',
'title' => '进展摘要',
'type' => 'string',
],
'preliminaryReason' => [
'description' => '',
'example' => '原因',
'title' => '初步原因',
'type' => 'string',
],
'mainHandler' => [
'description' => '',
'example' => '王宇',
'format' => 'int64',
'title' => '主要处理人',
'type' => 'integer',
],
'mainHandlerId' => [
'description' => '',
'example' => '2000',
'format' => 'int64',
'title' => '主要处理人ID',
'type' => 'integer',
],
'mainHandlerPhone' => [
'description' => '',
'example' => '1308987****',
'title' => '主要处理人手机号',
'type' => 'string',
],
'feedback' => [
'description' => '',
'example' => 'feedback',
'title' => '舆情反馈',
'type' => 'string',
],
'cancelReasonDescription' => [
'description' => '',
'example' => '理由',
'title' => '取消原因描述',
'type' => 'string',
],
'cancelReason' => [
'description' => '',
'example' => '取消理由',
'format' => 'int64',
'title' => '取消原因',
'type' => 'integer',
],
'durationTime' => [
'description' => '',
'example' => '300000',
'format' => 'int64',
'title' => '持续时间',
'type' => 'integer',
],
'progressSummaryRichTextId' => [
'description' => '',
'example' => '1231231',
'format' => 'int64',
'title' => '进展摘要富文本id',
'type' => 'integer',
],
'handingProblemOperateLogs' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'operator' => [
'description' => '',
'example' => '王宇',
'title' => '操作人',
'type' => 'string',
],
'userId' => [
'description' => '',
'example' => '233',
'format' => 'int64',
'title' => '用户id',
'type' => 'integer',
],
'actionName' => [
'description' => '',
'example' => '取消故障',
'title' => '动作名称',
'type' => 'string',
],
'actionTime' => [
'description' => '',
'example' => '2010-03-09 15:53:45',
'title' => '操作时间',
'type' => 'string',
],
'userIsValid' => [
'format' => 'int64',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '处理中故障操作日志',
'type' => 'array',
],
'restoredProblemOperateLogs' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'operator' => [
'description' => '',
'example' => '王宇',
'title' => '操作人',
'type' => 'string',
],
'userId' => [
'description' => '',
'example' => '3232',
'format' => 'int64',
'title' => '用户id',
'type' => 'integer',
],
'actionName' => [
'description' => '',
'example' => '恢复故障',
'title' => '动作名称',
'type' => 'string',
],
'actionTime' => [
'description' => '',
'example' => '2020-08-08 15:39:39',
'title' => '操作时间',
'type' => 'string',
],
'userIsValid' => [
'format' => 'int64',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '已恢复故障操作日志',
'type' => 'array',
],
'replayingProblemOperateLogs' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'operator' => [
'description' => '',
'example' => '刘杰',
'title' => '操作人',
'type' => 'string',
],
'userId' => [
'description' => '',
'example' => '用户id',
'format' => 'int64',
'title' => '用户id',
'type' => 'integer',
],
'actionName' => [
'description' => '',
'example' => '复盘故障',
'title' => '动作名称',
'type' => 'string',
],
'actionTime' => [
'description' => '',
'example' => '2020-08-08 15:39:39',
'title' => '操作时间',
'type' => 'string',
],
'userIsValid' => [
'format' => 'int64',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '复盘中故障操作日志',
'type' => 'array',
],
'replayProblemOperateLogs' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'operator' => [
'description' => '',
'example' => '周宇凡',
'title' => '操作人',
'type' => 'string',
],
'userId' => [
'description' => '',
'example' => '2323',
'format' => 'int64',
'title' => '用户id',
'type' => 'integer',
],
'actionName' => [
'description' => '',
'example' => '复盘故障',
'title' => '动作名称',
'type' => 'string',
],
'actionTime' => [
'description' => '',
'example' => '2020-08-08 15:39:39',
'title' => '操作时间',
'type' => 'string',
],
'userIsValid' => [
'format' => 'int64',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '已复盘故障操作日志',
'type' => 'array',
],
'effectionServices' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'effectionServiceId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '服务ID',
'type' => 'integer',
],
'effectionLevel' => [
'description' => '',
'example' => 'P1',
'format' => 'int64',
'title' => '影响等级 P1 . P2 P3 P4',
'type' => 'integer',
],
'effectionStatus' => [
'description' => '',
'example' => 'RESTORED',
'format' => 'int32',
'title' => '影响服务状态 RECOVERED 已经恢复 ,UN_RECOVERED 未恢复',
'type' => 'integer',
],
'description' => [
'description' => '',
'example' => '描述',
'title' => '影响描述',
'type' => 'string',
],
'serviceName' => [
'description' => '',
'example' => '购物车',
'title' => '服务名称',
'type' => 'string',
],
'serviceDeleteType' => [
'description' => '',
'format' => 'int32',
'title' => '服务删除字段 1正常 0删除',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '影响服务',
'type' => 'array',
],
'coordinationGroups' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'serviceGroupId' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '服务组ID',
'type' => 'integer',
],
'serviceGroupName' => [
'description' => '',
'example' => '清扫大队',
'title' => '服务组名字',
'type' => 'string',
],
'isValid' => [
'format' => 'int64',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '应急协同组',
'type' => 'array',
],
'timelines' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'keyNode' => [
'description' => '',
'example' => '1,2,3,4,5,7,6,8,9,10',
'title' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '故障操作时间线',
'type' => 'array',
],
'cancelProblemOperateLogs' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'operator' => [
'description' => '',
'example' => '王宇',
'title' => '操作人',
'type' => 'string',
],
'actionName' => [
'description' => '',
'example' => '取消故障',
'title' => '动作名称',
'type' => 'string',
],
'actionTime' => [
'description' => '',
'example' => '2020-09-08 15:38:38',
'title' => '操作时间',
'type' => 'string',
],
'userId' => [
'description' => '',
'example' => '66666',
'format' => 'int64',
'title' => '用户ID',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '已取消故障操作日志',
'type' => 'array',
],
'serviceDeleteType' => [
'description' => 'serviceDeleteType',
'format' => 'int32',
'title' => 'serviceDeleteType',
'type' => 'integer',
],
'mainHandlerIsValid' => [
'description' => '',
'format' => 'int64',
'title' => '主要处理人生效状态,1生效,0失效',
'type' => 'integer',
],
'isRuleTrigger' => [
'title' => '是否规则触发 1 是 0不是',
'type' => 'boolean',
],
],
'title' => '详情',
'type' => 'object',
],
'requestId' => [
'description' => '',
'example' => 'C4BE3837-1A13-41VB-A225-2C88188E8A43',
'title' => '请求ID',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '312312',
'required' => false,
'title' => '故障ID',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3811',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'problemId' => [
'description' => '',
'example' => '231231',
'title' => '故障ID',
'type' => 'string',
],
'problemReason' => [
'description' => '',
'example' => '',
'title' => '故障原因',
'type' => 'string',
],
'recentActivity' => [
'description' => '',
'example' => '2',
'title' => '最近活动 码表:PROBLEM_RECENT_ACTIVITY',
'type' => 'string',
],
'injectionMode' => [
'description' => '',
'example' => '3',
'title' => '注入方式 码表:PROBLEM_INJECTION_MODE',
'type' => 'string',
],
'recoveryMode' => [
'description' => '',
'example' => '2',
'title' => '恢复方式 码表:PROBLEM_RECOVERY_MODE',
'type' => 'string',
],
'discoverSource' => [
'description' => '',
'example' => '1',
'title' => '发现来源 码表:PROBLEM_DISCOVER_SOURCE',
'type' => 'string',
],
'userReport' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '用户上报 码表:PROBLEM_USER_REPORT',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'example' => 'Zabbix',
'title' => '监控源',
'type' => 'string',
],
'relationChanges' => [
'description' => '',
'example' => '',
'title' => '关联变更',
'type' => 'string',
],
'dutyUserId' => [
'description' => '',
'example' => '231',
'format' => 'int64',
'title' => '故障责任人id',
'type' => 'integer',
],
'replayDutyUserId' => [
'description' => '',
'example' => '23123',
'format' => 'int64',
'title' => '复盘负责人id',
'type' => 'integer',
],
'replayDutyUserPhone' => [
'description' => '',
'example' => '1308787****',
'title' => '复盘负责人手机号',
'type' => 'string',
],
'dutyDepartmentId' => [
'description' => '',
'example' => '12312',
'title' => '故障责任部门',
'type' => 'string',
],
'dutyUserName' => [
'description' => '',
'example' => '',
'title' => '故障责任人名称',
'type' => 'string',
],
'dutyUserPhone' => [
'description' => '',
'example' => '13098898****',
'title' => '故障责任人手机号',
'type' => 'string',
],
'replayDutyUserName' => [
'description' => '',
'example' => '',
'title' => '复盘负责人名称',
'type' => 'string',
],
'remark' => [
'description' => '',
'example' => '',
'title' => '备注',
'type' => 'string',
],
'isManual' => [
'description' => '',
'example' => 'true',
'title' => '是否手动',
'type' => 'boolean',
],
'dutyDepartmentName' => [
'description' => '',
'example' => '',
'title' => '故障责任部门名称',
'type' => 'string',
],
'measureList' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'measureId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'title' => '改进措施id 用于删除或更新',
'type' => 'integer',
],
'type' => [
'description' => '',
'example' => '2',
'format' => 'int64',
'title' => '措施类型',
'type' => 'integer',
],
'content' => [
'description' => '',
'example' => '',
'title' => '措施内容',
'type' => 'string',
],
'checkStandard' => [
'description' => '',
'example' => '',
'title' => '验收标准',
'type' => 'string',
],
'checkUserId' => [
'description' => '',
'example' => '12',
'format' => 'int64',
'title' => '验收人id',
'type' => 'integer',
],
'checkUserName' => [
'description' => '',
'example' => '',
'title' => '验收人名称',
'type' => 'string',
],
'directorName' => [
'description' => '',
'example' => '',
'title' => '负责人名称',
'type' => 'string',
],
'stalkerName' => [
'description' => '',
'example' => '',
'title' => '跟踪人名称',
'type' => 'string',
],
'planFinishTime' => [
'description' => '',
'example' => '2021-05-01 00:00:00',
'title' => '计划完成时间',
'type' => 'string',
],
'directorId' => [
'description' => '',
'example' => '212',
'format' => 'int64',
'title' => '负责人id',
'type' => 'integer',
],
'stalkerId' => [
'description' => '',
'example' => '3121',
'format' => 'int64',
'title' => '跟踪人id',
'type' => 'integer',
],
'status' => [
'description' => '',
'example' => 'UNIMPROVED',
'title' => 'UNIMPROVED 状态 IMPROVED 改进 2 未改进UNIMPROVED',
'type' => 'string',
],
'checkUserIsValid' => [
'title' => '验收人是否失效,0失效1生效',
'type' => 'integer',
'format' => 'int32',
],
'directorIsValid' => [
'title' => '负责人是否失效,0失效1生效',
'type' => 'integer',
'format' => 'int32',
],
'stalkerIsValid' => [
'title' => '跟踪人是否失效,0失效1生效',
'type' => 'integer',
'format' => 'int32',
],
],
'type' => 'object',
],
'title' => '改进措施列表',
'type' => 'array',
],
'customProblemReason' => [
'title' => '自定义故障原因',
'type' => 'string',
],
'replayDutyUserIsValid' => [
'title' => '复盘负责人生效状态,0失效1生效',
'type' => 'integer',
'format' => 'int64',
],
'dutyUserIsValid' => [
'title' => '故障责任人生效状态,0失效1生效',
'type' => 'integer',
'format' => 'int64',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'measureId' => [
'description' => '',
'example' => '1213',
'format' => 'int64',
'required' => false,
'title' => '故障改成措施id',
'type' => 'integer',
],
'problemId' => [
'description' => '',
'example' => '2131',
'required' => false,
'title' => '故障Id',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemTimelineId' => [
'description' => '',
'example' => '11',
'format' => 'int64',
'required' => false,
'title' => 'ID',
'type' => 'integer',
],
'problemId' => [
'description' => '',
'example' => '102',
'format' => 'int64',
'required' => false,
'title' => '故障id',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '10002010',
'format' => 'int64',
'required' => false,
'title' => '故障ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'C4BE3837-1A13-413B-A225-2C88188E8A43',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'createTime' => [
'description' => '',
'example' => '2020-08-08 15:38:38',
'title' => '创建时间',
'type' => 'string',
],
'keyNode' => [
'description' => '',
'example' => 'PROBLEM_INJECTION,PROBLEM_HAPPEN',
'title' => '关键节点 码表:PROBLEM_KEY_NODE (逗号分隔)',
'type' => 'string',
],
'content' => [
'description' => '',
'example' => '内容',
'title' => '内容',
'type' => 'string',
],
'isKey' => [
'description' => '',
'example' => 'true',
'title' => '是否是关键字 true是 false不是 默认 false',
'type' => 'boolean',
],
'updateTime' => [
'description' => '',
'example' => '2020-08-08 15:38:38',
'title' => '修改时间',
'type' => 'string',
],
'time' => [
'description' => '',
'example' => '2020-08-08 15:38:38',
'title' => '展示时间',
'type' => 'string',
],
'problemTimelineId' => [
'description' => '',
'example' => '10000',
'format' => 'int64',
'title' => '时间线id',
'type' => 'integer',
],
'usersInContent' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'userId' => [
'description' => '',
'example' => '232',
'format' => 'int64',
'title' => '用户id',
'type' => 'integer',
],
'username' => [
'description' => '',
'example' => '张老萨',
'title' => '用户名',
'type' => 'string',
],
'isValid' => [
'type' => 'integer',
'format' => 'int64',
],
],
'type' => 'object',
],
'title' => '内容中的用户信息',
'type' => 'array',
],
],
'type' => 'object',
],
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'effectionServiceId' => [
'description' => '',
'example' => '9',
'format' => 'int64',
'required' => false,
'title' => 'id主键',
'type' => 'integer',
],
'problemId' => [
'description' => '',
'example' => '46',
'format' => 'int64',
'required' => false,
'title' => '故障id',
'type' => 'integer',
],
'clientToken' => [
'description' => 'clientToken',
'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => 'e2d4306a-bf4d-4345-9ae6-158223c85dbd',
'title' => 'requestId',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'effectionServiceId' => [
'description' => '',
'example' => '6442430',
'format' => 'int64',
'title' => '影响服务id',
'type' => 'integer',
],
'serviceName' => [
'description' => '',
'example' => '哈哈',
'title' => '服务名称',
'type' => 'string',
],
'serviceId' => [
'description' => '',
'example' => '170000000',
'format' => 'int64',
'title' => '服务id',
'type' => 'integer',
],
'level' => [
'description' => '',
'example' => 'P2',
'format' => 'int64',
'title' => '影响等级',
'type' => 'integer',
],
'status' => [
'description' => '',
'example' => 'UN_RECOVERED',
'format' => 'int64',
'title' => '影响状态 0 未恢复 1已恢复',
'type' => 'integer',
],
'description' => [
'description' => '',
'example' => 'ew',
'title' => '影响描述',
'type' => 'string',
],
'picUrl' => [
'description' => '',
'items' => [
'description' => '',
'example' => '[ "problem/axxxxxx2-1xxxx4565-be92-f44ae2xxxxx", "problem/7xxxxxxe314-49998-b9e7-399e78b41fbd", "problem/xxxxx-f40d-4611-0978-1d1f719a929a" ]',
'type' => 'string',
],
'title' => '图片链接',
'type' => 'array',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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',
'properties' => [
'problemId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'required' => false,
'title' => '故障id',
'type' => 'integer',
],
'problemNotifyType' => [
'description' => '',
'example' => 'PROBLEM_NOTIFY',
'required' => false,
'title' => '通告类型',
'type' => 'string',
],
'problemLevel' => [
'description' => '',
'example' => 'P2',
'required' => false,
'title' => '故障等级',
'type' => 'string',
],
'effectServiceIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'title' => '影响服务',
'type' => 'array',
],
'relatedServiceId' => [
'description' => '',
'example' => '21312',
'format' => 'int64',
'required' => false,
'title' => '所属服务',
'type' => 'integer',
],
'incidentId' => [
'description' => '',
'example' => '213123',
'format' => 'int64',
'required' => false,
'title' => '事件Id',
'type' => 'integer',
],
'serviceGroupIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '12313',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'title' => '应急协同组',
'type' => 'array',
],
'clientToken' => [
'description' => '',
'example' => '4361a0e1-6747-4834-96ce-0c4840f13812',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'requestId',
'example' => '4361a0e1-6747-4834-96ce-0c2840fd3812',
'title' => 'requestId',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'problem' => [
'description' => 'object',
'properties' => [
'problemName' => [
'description' => '',
'example' => '',
'title' => '故障名称',
'type' => 'string',
],
'problemStatus' => [
'description' => '',
'example' => 'HANDLING',
'title' => '故障状态 1 处理中 2已恢复 3复盘中 4已复盘 5已取消',
'type' => 'string',
],
'problemLevel' => [
'description' => '',
'example' => 'P2',
'title' => '故障等级 1=P1 2=P2 3=P3 4=P4',
'type' => 'string',
],
'discoverTime' => [
'description' => '',
'example' => '2021-02-21 00:00:00',
'title' => '发现时间',
'type' => 'string',
],
'recoveryTime' => [
'description' => '',
'example' => '2021-02-21 00:00:00',
'title' => '恢复时间',
'type' => 'string',
],
'serviceName' => [
'description' => '',
'example' => '',
'title' => '关联服务 名称',
'type' => 'string',
],
'progressSummary' => [
'description' => '',
'example' => '',
'title' => '进展摘要',
'type' => 'string',
],
'preliminaryReason' => [
'description' => '',
'example' => '',
'title' => '初步原因',
'type' => 'string',
],
'mainHandlerName' => [
'description' => '',
'example' => '',
'title' => '主要处理人',
'type' => 'string',
],
'mainHandlerId' => [
'description' => '',
'example' => '231',
'title' => '主要处理人Id',
'type' => 'string',
],
'isManual' => [
'description' => '',
'example' => 'true',
'title' => '是否手动',
'type' => 'boolean',
],
'isUpgrade' => [
'description' => '',
'example' => 'true',
'title' => '是否升级',
'type' => 'boolean',
],
'problemId' => [
'description' => '',
'example' => '123123',
'format' => 'int64',
'title' => '故障Id',
'type' => 'integer',
],
'relatedServiceId' => [
'description' => '',
'example' => '213123',
'format' => 'int64',
'title' => '关联服务ID',
'type' => 'integer',
],
'createTime' => [
'description' => '',
'example' => '2021-02-21 00:00:00',
'title' => '创建时间',
'type' => 'string',
],
'progressSummaryRichTextId' => [
'description' => '',
'example' => '12312',
'format' => 'int64',
'title' => '富文本id',
'type' => 'integer',
],
'coordinationGroups' => [
'description' => '',
'items' => [
'properties' => [
'serviceGroupName' => [
'description' => '',
'example' => '',
'title' => '服务组名称',
'type' => 'string',
],
'serviceGroupId' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'title' => '服务Id',
'type' => 'integer',
],
'serviceGroupDescription' => [
'description' => '',
'example' => '',
'title' => '服务组Maison',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '应急协同组',
'type' => 'array',
],
'effectionServices' => [
'description' => '',
'items' => [
'properties' => [
'serviceName' => [
'description' => '',
'example' => '',
'title' => '影响服务名称',
'type' => 'string',
],
'serviceId' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'title' => '影响服务Id',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '影响服务',
'type' => 'array',
],
],
'type' => 'object',
],
'voice' => [
'description' => '',
'properties' => [
'count' => [
'description' => '',
'example' => '12',
'format' => 'int64',
'title' => '数量',
'type' => 'integer',
],
'users' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'username' => [
'description' => '',
'example' => '',
'title' => '用户',
'type' => 'string',
],
],
'type' => 'object',
],
'type' => 'array',
],
],
'title' => '语音',
'type' => 'object',
],
'mail' => [
'description' => '',
'properties' => [
'count' => [
'description' => '',
'example' => '123',
'format' => 'int64',
'title' => '数量',
'type' => 'integer',
],
'users' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'username' => [
'description' => '',
'example' => '',
'title' => '用户名称',
'type' => 'string',
],
],
'type' => 'object',
],
'type' => 'array',
],
],
'title' => '邮箱',
'type' => 'object',
],
'sms' => [
'description' => '',
'properties' => [
'count' => [
'description' => '',
'example' => '12',
'format' => 'int64',
'title' => '数量',
'type' => 'integer',
],
'users' => [
'description' => '',
'items' => [
'description' => '',
'properties' => [
'username' => [
'description' => '',
'example' => '',
'title' => '用户名称',
'type' => 'string',
],
],
'type' => 'object',
],
'type' => 'array',
],
],
'title' => '短信',
'type' => 'object',
],
'webhook' => [
'description' => 'webhook',
'properties' => [
'count' => [
'description' => '',
'example' => '32',
'format' => 'int64',
'title' => '数量',
'type' => 'integer',
],
'serviceGroups' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'serviceName' => [
'description' => '',
'example' => '',
'title' => '服务名称',
'type' => 'string',
],
],
'type' => 'object',
],
'type' => 'array',
],
],
'title' => 'webhook',
'type' => 'object',
],
'upBeforeData' => [
'description' => '',
'example' => '',
'title' => '升级前数据',
'type' => 'string',
],
'upAfterData' => [
'description' => '',
'example' => '',
'title' => '升级后数据',
'type' => 'string',
],
'deBeforeData' => [
'description' => '',
'example' => '',
'title' => '降级前数据',
'type' => 'string',
],
'deAfterData' => [
'description' => '',
'example' => '',
'title' => '降级后数据',
'type' => 'string',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'problemId' => [
'description' => '',
'example' => '13123',
'format' => 'int64',
'required' => false,
'title' => '故障ID',
'type' => 'integer',
],
'serviceGroupIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '应急协同组ID',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'title' => '应急协同组',
'type' => 'array',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '5AD6E6BC-2582-4E0E-832D-52CB1B922253',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"5AD6E6BC-2582-4E0E-832D-52CB1B922253\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5AD6E6BC-2582-4E0E-832D-52CB1B922253\\n","errorExample":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'serviceId' => [
'description' => '',
'example' => '170000000',
'format' => 'int64',
'required' => false,
'title' => '影响服务id',
'type' => 'integer',
],
'level' => [
'description' => '',
'example' => 'P2',
'required' => false,
'title' => '影响等级',
'type' => 'string',
],
'status' => [
'description' => '',
'example' => 'UN_RECOVERED',
'required' => false,
'title' => '影响状态 0 未恢复 1已恢复',
'type' => 'string',
],
'description' => [
'description' => '',
'example' => 'erdwcdc',
'required' => false,
'title' => '影响描述',
'type' => 'string',
],
'pictureUrl' => [
'description' => '',
'items' => [
'description' => '',
'example' => 'problem/xxxxxxxssxxxa2c8-40b9-9162-08a6c2e338e2',
'required' => false,
'type' => 'string',
],
'required' => false,
'title' => '图片地址',
'type' => 'array',
],
'problemId' => [
'description' => '',
'example' => '150000000',
'format' => 'int64',
'required' => true,
'title' => '故障id',
'type' => 'integer',
],
'clientToken' => [
'description' => 'clientToken',
'example' => 'e0b6735e-1a04-4d6b-a625-d2350612492c',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the request',
'example' => 'c26f36de-1ec8-496a-a828-880676c5ef81',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'effectionServiceId' => [
'description' => '',
'example' => '6442430',
'format' => 'int64',
'title' => '影响服务id',
'type' => 'integer',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'body',
'example' => 'body',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'title' => '幂等校验',
'type' => 'string',
],
],
'required' => false,
'title' => 'body',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'incidentCount' => [
'description' => '',
'example' => '1331',
'format' => 'int32',
'title' => '事件总数',
'type' => 'integer',
],
'alertCount' => [
'description' => '',
'example' => '123',
'format' => 'int32',
'title' => '报警总数',
'type' => 'integer',
],
'problemCount' => [
'description' => '',
'example' => '221',
'format' => 'int32',
'title' => '故障总数',
'type' => 'integer',
],
'integrationCount' => [
'description' => '',
'example' => '2211',
'format' => 'int32',
'title' => '集成总数',
'type' => 'integer',
],
],
'title' => 'data',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-CDE61E59A2E9',
'required' => false,
'title' => '幂等校验token',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'data' => [
'additionalProperties' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'configDescription' => [
'title' => '配置描述',
'type' => 'string',
'description' => '',
'example' => '',
],
'configCode' => [
'title' => '配置code',
'type' => 'string',
'example' => 'PROBLEM_REASON_DISASTER',
'description' => '',
],
'parentCode' => [
'title' => '配置父code',
'type' => 'string',
'description' => '',
'example' => 'PROBLEM_REASON',
],
'configKey' => [
'title' => 'key (用于前后端值传递)',
'type' => 'string',
'example' => '2',
'description' => '',
],
'configValue' => [
'title' => 'value (用于前端展示)',
'type' => 'string',
'example' => '',
'description' => '',
],
'requirement' => [
'title' => '是否必选',
'type' => 'boolean',
'description' => '',
'example' => 'true',
],
],
'description' => 'object',
],
'description' => 'array',
],
'description' => 'data',
'type' => 'object',
],
'requestId' => [
'description' => 'requestId',
'example' => 'uuid',
'title' => 'requestId',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378F887A6A11',
'required' => false,
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'data' => [
'additionalProperties' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'code' => [
'type' => 'string',
'example' => 'SMS',
'description' => '',
],
'description' => [
'type' => 'string',
'description' => '',
'example' => '',
],
],
'description' => 'object',
],
'description' => 'array',
],
'description' => 'data',
'type' => 'object',
],
'requestId' => [
'description' => 'id of the request'."\n",
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'ListMonitorSources' => [
'summary' => 'ListMonitorSources',
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => '',
'example' => '601FA6A2-AC5C-4B59-BE11-378FTOKENA11',
'required' => false,
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'data' => [
'description' => 'data',
'items' => [
'properties' => [
'monitorSourceId' => [
'description' => '',
'example' => '12',
'format' => 'int64',
'type' => 'integer',
],
'monitorSourceName' => [
'description' => '',
'example' => 'Zabbix',
'type' => 'string',
],
'fieldKeys' => [
'description' => '',
'items' => [
'description' => '',
'example' => 'payload.content',
'type' => 'string',
],
'type' => 'array',
],
],
'type' => 'object',
],
'type' => 'array',
],
'requestId' => [
'description' => 'id of the request',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'channel' => [
'description' => '',
'example' => 'DINGDING',
'required' => true,
'title' => '应用协同渠道',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
'required' => true,
'title' => '幂等标识',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'id of the req',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'title' => 'id of the req',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'openUrl' => [
'description' => '',
'example' => 'http://xxxx',
'title' => '开通url',
'type' => 'string',
],
'progress' => [
'description' => '',
'example' => 'OPENED 已开通 OPENING 开通中',
'title' => '开通进度状态',
'type' => 'string',
],
],
'title' => 'data',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => '',
'example' => '7C56D225-7C34-40BB-9624-C8BA449260E6',
'required' => true,
'title' => '幂等标识',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'data' => [
'description' => 'data',
'properties' => [
'corporationId' => [
'description' => '',
'example' => 'ding81913c*',
'title' => '企业id',
'type' => 'string',
],
'bizId' => [
'description' => '',
'example' => '7356',
'title' => '业务id',
'type' => 'string',
],
'progress' => [
'description' => '',
'example' => 'NOT_OPEN',
'title' => '进度',
'type' => 'string',
],
'channel' => [
'description' => '',
'example' => 'DINGDING',
'title' => '云钉协同渠道',
'type' => 'string',
],
'originalCorpId' => [
'type' => 'string',
],
],
'title' => 'data',
'type' => 'object',
],
'requestId' => [
'description' => 'id of the request',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'title' => 'id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'PushMonitor' => [
'summary' => '监控数据接入API',
'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' => [
'description' => '',
'example' => 'dfb2e51a58e64152a0eef7a232308006',
'required' => true,
'title' => '集成接入的apiKey',
'type' => 'string',
],
],
[
'name' => 'body',
'in' => 'body',
'schema' => [
'description' => '',
'example' => '',
'required' => false,
'title' => '推送的数据内容',
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'properties' => [
'data' => [
'description' => '',
'example' => 'null',
'type' => 'any',
],
'requestId' => [
'description' => '',
'example' => '5A30D240-1821-0246-B580-AB1468657AD2',
'type' => 'string',
],
],
'title' => '{@link Result}',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => 'clientToken',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => 'object',
'properties' => [
'scope' => [
'description' => '',
'example' => 'SERVICE',
'title' => '范围类型',
'type' => 'string',
],
'scopeObjectId' => [
'description' => '',
'example' => '23',
'format' => 'int64',
'title' => '范围对象id',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => 'data',
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'escalationPlanName' => [
'description' => '',
'example' => 'name123',
'required' => true,
'title' => '升级计划名称',
'type' => 'string',
],
'escalationPlanDescription' => [
'description' => '',
'example' => 'desc2322424',
'required' => true,
'title' => '升级计划描述',
'type' => 'string',
],
'escalationPlanScopeObjects' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'scopeObjectId' => [
'description' => '',
'example' => '23433',
'format' => 'int64',
'required' => true,
'title' => '范围对象id',
'type' => 'integer',
],
'scope' => [
'description' => '',
'example' => 'SERVICE',
'required' => false,
'title' => '范围对象类型',
'type' => 'string',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '升级计划范围对象列表',
'type' => 'array',
],
'escalationPlanRules' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'escalationPlanConditions' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'level' => [
'description' => '',
'example' => 'P1',
'required' => true,
'title' => '事件等级',
'type' => 'string',
],
'effection' => [
'description' => '',
'example' => 'LOW',
'required' => true,
'title' => '影响等级',
'type' => 'string',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '升级条件',
'type' => 'array',
],
'escalationPlanStrategies' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'noticeTime' => [
'description' => '',
'example' => '40',
'required' => true,
'title' => '通知时间',
'type' => 'string',
],
'noticeObjects' => [
'description' => '',
'items' => [
'description' => '',
'example' => '[23,345]',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => true,
'title' => '升级通知对象id列表',
'type' => 'array',
],
'noticeChannels' => [
'description' => '',
'items' => [
'description' => '',
'example' => '["SMS","PHONE"]',
'required' => true,
'type' => 'string',
],
'required' => true,
'title' => '升级通知策略',
'type' => 'array',
],
'enableWebhook' => [
'description' => '',
'example' => 'true',
'required' => true,
'title' => '是否支持群通知',
'type' => 'boolean',
],
'serviceGroupIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '434',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'title' => '服务组id',
'type' => 'array',
],
'escalationPlanType' => [
'title' => '升级类型',
'type' => 'string',
],
'noticeRoleList' => [
'title' => '通知角色列表',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '升级策略',
'type' => 'array',
],
'escalationPlanType' => [
'description' => '',
'example' => 'UN_FINISH',
'required' => true,
'title' => '升级类型(废弃)',
'type' => 'string',
],
],
'required' => true,
'type' => 'object',
],
'required' => true,
'title' => '升级计划规则列表',
'type' => 'array',
],
'clientToken' => [
'description' => 'clientToken',
'example' => '6b404f14-77d1-4b53-a1a1-30a58bREQUEST',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
'isGlobal' => [
'title' => '是否是全局策略',
'type' => 'boolean',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'escalationPlanId' => [
'description' => '',
'example' => '234532',
'format' => 'int64',
'title' => '升级计划id',
'type' => 'integer',
],
],
'title' => 'data',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'escalationPlanId' => [
'description' => '',
'example' => '234534',
'format' => 'int64',
'required' => true,
'title' => '升级计划ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'escalationPlanId' => [
'description' => '',
'example' => '234534',
'format' => 'int64',
'required' => true,
'title' => '升级计划ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'escalationPlanId' => [
'description' => '',
'example' => '234534',
'format' => 'int64',
'required' => true,
'title' => '升级计划ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC21925D',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'escalationPlanId' => [
'description' => '',
'example' => '345',
'format' => 'int64',
'required' => true,
'title' => '升级计划id',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
'required' => false,
'title' => '幂等标识',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'escalationPlanId' => [
'description' => '',
'example' => '2345',
'format' => 'int64',
'title' => '升级计划id',
'type' => 'integer',
],
'escalationPlanName' => [
'description' => '',
'example' => '升级计划234',
'title' => '升级计划名称',
'type' => 'string',
],
'escalationPlanDescription' => [
'description' => '',
'example' => '描述1234',
'title' => '升级计划描述',
'type' => 'string',
],
'escalationPlanScopeObjects' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'scopeObjectId' => [
'description' => '',
'example' => '234',
'format' => 'int64',
'title' => '范围对象id',
'type' => 'integer',
],
'scope' => [
'description' => '',
'example' => 'SERVICE',
'title' => '范围对象类型',
'type' => 'string',
],
'scopeObjectName' => [
'description' => '',
'example' => 'xx服务',
'title' => '范围对象名称',
'type' => 'string',
],
'escalationPlanScopeObjects' => [
'description' => '',
'format' => 'int32',
'title' => '服务删除字段 1正常 0删除',
'type' => 'integer',
],
'scopeObjectDeletedType' => [
'description' => '',
'format' => 'int32',
'title' => '服务删除字段 1正常 0删除',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '升级计划范围对象列表',
'type' => 'array',
],
'escalationPlanRules' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'escalationPlanRuleId' => [
'description' => '',
'example' => '345',
'format' => 'int64',
'title' => '升级计划id',
'type' => 'integer',
],
'escalationPlanConditions' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'level' => [
'description' => '',
'example' => 'P1',
'title' => '事件等级',
'type' => 'string',
],
'effection' => [
'description' => '',
'example' => 'LOW',
'title' => '影响等级',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '升级计划条件',
'type' => 'array',
],
'escalationPlanStrategies' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'noticeTime' => [
'description' => '',
'example' => '40',
'format' => 'int64',
'title' => '通知时间',
'type' => 'integer',
],
'escalationPlanType' => [
'description' => '',
'example' => 'UN_ACKNOWLEDGE',
'title' => '升级计划类型',
'type' => 'string',
],
'noticeObjectList' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'noticeObjectId' => [
'description' => '',
'example' => '234',
'format' => 'int64',
'title' => '通知对象id',
'type' => 'integer',
],
'noticeObjectName' => [
'description' => '',
'example' => '张老三',
'title' => '通知对象名称',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '通知对象列表',
'type' => 'array',
],
'noticeChannels' => [
'description' => '',
'example' => 'SMS',
'title' => '通知对象渠道',
'type' => 'string',
],
'enableWebhook' => [
'description' => '',
'example' => 'true',
'title' => '是否支持群通知',
'type' => 'boolean',
],
'serviceGroups' => [
'description' => '',
'items' => [
'properties' => [
'id' => [
'description' => '',
'example' => '343',
'format' => 'int64',
'title' => '服务组id',
'type' => 'integer',
],
'serviceGroupName' => [
'description' => '',
'example' => 'VCD是',
'title' => '服务组名称',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '服务组列表',
'type' => 'array',
],
'noticeObjects' => [
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
'noticeRoleList' => [
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
'noticeRoleObjectList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'id' => [
'type' => 'integer',
'format' => 'int64',
],
'name' => [
'type' => 'string',
],
],
],
],
],
'type' => 'object',
],
'title' => '升级计划策略',
'type' => 'array',
],
],
'type' => 'object',
],
'title' => '升级计划规则列表',
'type' => 'array',
],
'createTime' => [
'description' => '',
'example' => '2021-09-09 09:09:09',
'title' => '创建时间',
'type' => 'string',
],
'isGlobal' => [
'title' => '是否是全局策略',
'type' => 'boolean',
'default' => 'false',
],
],
'title' => 'data',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'escalationPlanName' => [
'description' => '',
'example' => 'xxx',
'required' => false,
'title' => '升级计划名',
'type' => 'string',
],
'serviceName' => [
'description' => '',
'example' => 'ssxx',
'required' => false,
'title' => '服务名称',
'type' => 'string',
],
'clientToken' => [
'description' => '',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => 'pageNumber',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'required' => false,
'title' => 'pageSize',
'type' => 'integer',
],
'isGlobal' => [
'type' => 'boolean',
],
'status' => [
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => 'object',
'properties' => [
'escalationPlanId' => [
'description' => '',
'example' => '43',
'format' => 'int64',
'title' => '升级计划id',
'type' => 'integer',
],
'escalationPlanName' => [
'description' => '',
'example' => '升级计划2345',
'title' => '升级计划名称',
'type' => 'string',
],
'escalationPlanScopeObjects' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'scopeObjectId' => [
'description' => '',
'example' => '23',
'format' => 'int64',
'title' => '范围对象id(服务id)',
'type' => 'integer',
],
'scopeObjectName' => [
'description' => '',
'example' => '某服务1',
'title' => '范围对象名称',
'type' => 'string',
],
'scope' => [
'description' => '',
'example' => 'SERVICE',
'title' => '范围对象类型',
'type' => 'string',
],
'scopeObjectDeletedType' => [
'title' => '服务是否删除 1正常 0删除',
'type' => 'integer',
'format' => 'int32',
],
],
'type' => 'object',
],
'title' => '升级计划范围对象',
'type' => 'array',
],
'status' => [
'description' => '',
'example' => 'ENABLE',
'title' => '启用ENABLE 禁用DISABLE',
'type' => 'string',
],
'modifyTime' => [
'description' => '',
'example' => '2021-09-09 09:09:09',
'title' => '修改时间',
'type' => 'string',
],
'isGlobal' => [
'title' => '是否是全局策略',
'type' => 'boolean',
'default' => 'false',
],
],
'type' => 'object',
],
'title' => 'data',
'type' => 'array',
],
'totalCount' => [
'description' => '',
'example' => '878',
'format' => 'int64',
'title' => '总条数',
'type' => 'integer',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'title' => '分页参数',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '分页参数',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'escalationPlanId' => [
'description' => '',
'example' => '433',
'format' => 'int64',
'required' => true,
'title' => '升级计划id',
'type' => 'integer',
],
'escalationPlanName' => [
'description' => '',
'example' => 'xxx',
'required' => false,
'title' => '升级计划名称',
'type' => 'string',
],
'escalationPlanDescription' => [
'description' => '',
'example' => 'xxxx',
'required' => false,
'title' => '升级计划描述',
'type' => 'string',
],
'escalationPlanScopeObjects' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'id' => [
'description' => '',
'example' => '87',
'format' => 'int64',
'required' => true,
'title' => '主键',
'type' => 'integer',
],
'scopeObjectId' => [
'description' => '',
'example' => '234',
'format' => 'int64',
'required' => true,
'title' => '范围对象id',
'type' => 'integer',
],
'scope' => [
'description' => '',
'example' => 'SERVICE',
'required' => false,
'title' => '范围对象类型',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '关联范围列表(服务)',
'type' => 'array',
],
'escalationPlanRules' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'id' => [
'description' => '',
'example' => '872',
'format' => 'int64',
'required' => false,
'title' => '主键',
'type' => 'integer',
],
'escalationPlanType' => [
'description' => '',
'example' => 'UN_ACKNOWLEDGE',
'required' => false,
'title' => 'UN_ACKNOWLEDGE 未响应 UN_FINISH 未完结(废弃)',
'type' => 'string',
],
'escalationPlanConditions' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'level' => [
'description' => 'P1 P2 P3 P4',
'example' => 'P1',
'required' => false,
'title' => 'P1 P2 P3 P4',
'type' => 'string',
],
'effection' => [
'description' => 'LOW HIGH',
'example' => 'LOW',
'required' => false,
'title' => 'LOW HIGH',
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '升级计划条件列表',
'type' => 'array',
],
'escalationPlanStrategies' => [
'description' => '',
'items' => [
'description' => 'object',
'properties' => [
'noticeTime' => [
'description' => '',
'example' => '30',
'format' => 'int64',
'required' => false,
'title' => '通知时间',
'type' => 'integer',
],
'noticeObjects' => [
'description' => '',
'items' => [
'description' => '',
'example' => '678',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'title' => '通知对象id',
'type' => 'array',
],
'noticeChannels' => [
'description' => '',
'items' => [
'description' => '',
'example' => 'SMS',
'required' => false,
'type' => 'string',
],
'required' => false,
'title' => '通知渠道',
'type' => 'array',
],
'serviceGroupIds' => [
'description' => '',
'items' => [
'description' => '',
'example' => '232',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'required' => false,
'title' => '服务组id',
'type' => 'array',
],
'enableWebhook' => [
'description' => '',
'example' => 'true',
'required' => false,
'title' => '是否支持群通知',
'type' => 'boolean',
],
'escalationPlanType' => [
'title' => 'UN_ACKNOWLEDGE 未响应 UN_FINISH 未完结',
'type' => 'string',
'example' => 'UN_ACKNOWLEDGE',
],
'noticeRoleList' => [
'title' => '通知角色列表',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '升级策略列表',
'type' => 'array',
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'title' => '升级计划规则',
'type' => 'array',
],
'clientToken' => [
'description' => 'clientToken',
'example' => '6b404f14-77d1-4b53-a1a1-30a58bbcfc57',
'required' => false,
'title' => 'clientToken',
'type' => 'string',
],
'isGlobal' => [
'title' => '是否是全局策略',
'type' => 'boolean',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'A5A1FEAE-9C47-011C-9C73-A376BC2REQUEST',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
],
'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' => [
'description' => 'body',
'properties' => [
'instanceId' => [
'description' => '',
'example' => '12221',
'format' => 'int64',
'required' => false,
'title' => '资源id',
'type' => 'integer',
],
'instanceType' => [
'description' => '',
'example' => 'INCIDENT 事件 ALERT告警 PROBLEM故障',
'required' => false,
'title' => '资源类型',
'type' => 'string',
],
'richText' => [
'description' => '',
'example' => '这是一个富文本',
'required' => false,
'title' => '文本内容',
'type' => 'string',
],
],
'required' => false,
'title' => 'body',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'instanceId' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'title' => '资源id',
'type' => 'integer',
],
'instanceType' => [
'description' => '',
'example' => '0 事件 1告警 2 故障',
'format' => 'int64',
'title' => '资源类型',
'type' => 'integer',
],
'richText' => [
'description' => '',
'example' => '这是一个富文本',
'title' => '富文本内容',
'type' => 'string',
],
],
'title' => 'data',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"10REQUES-AC5C-4B59-BE11-378F117A6A88\\",\\n \\"data\\": {\\n \\"instanceId\\": 140080050,\\n \\"instanceType\\": 0,\\n \\"richText\\": \\"这是一个富文本\\"\\n }\\n}","type":"json"}]',
],
'GetRichText' => [
'summary' => '查询富文本',
'path' => '/rich/detail',
'methods' => [
'post',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'richTextId' => [
'description' => '',
'example' => '12221才',
'format' => 'int64',
'required' => false,
'title' => '资源id',
'type' => 'integer',
],
'instanceId' => [
'description' => '',
'example' => 'INCIDENT 事件 ALERT告警 PROBLEM故障',
'format' => 'int64',
'required' => false,
'title' => '资源类型',
'type' => 'integer',
],
'instanceType' => [
'description' => '',
'example' => 'INCIDENT',
'required' => false,
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd3812',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'instanceId' => [
'description' => '',
'example' => '123123',
'format' => 'int64',
'title' => '资源id',
'type' => 'integer',
],
'richText' => [
'description' => '',
'example' => '这是一个富文本',
'title' => '富文本内容',
'type' => 'string',
],
'instanceType' => [
'description' => '',
'example' => '0 事件 1告警 2 故障',
'format' => 'int64',
'title' => '资源类型',
'type' => 'integer',
],
],
'title' => 'data',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4AA343E4-AB98-56D9-B699-D932902BA3EC\\",\\n \\"data\\": {\\n \\"instanceId\\": 140080050,\\n \\"richText\\": \\"这是一个富文本\\",\\n \\"instanceType\\": 0\\n }\\n}","type":"json"}]',
'requestParamsDescription' => '{'."\n"
.' "richTextId" : 111111,'."\n"
.' "instanceId" : 111111111,'."\n"
.' "instanceType" : "INCIDENT"'."\n"
.'}',
],
'UpdateRichText' => [
'summary' => '更新富文本',
'path' => '/rich/update',
'methods' => [
'post',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'richTextId' => [
'description' => '',
'example' => '123112313',
'format' => 'int64',
'required' => false,
'title' => '富文本id',
'type' => 'integer',
],
'instanceId' => [
'description' => '',
'example' => '123123',
'format' => 'int64',
'required' => false,
'title' => '资源id',
'type' => 'integer',
],
'instanceType' => [
'description' => '',
'example' => 'INCIDENT 事件 ALERT告警 PROBLEM故障',
'required' => false,
'title' => '资源类型',
'type' => 'string',
],
'richText' => [
'description' => '',
'example' => '这是一个富文本',
'required' => false,
'title' => '文本内容',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'id' => [
'description' => '',
'example' => '12',
'format' => 'int64',
'title' => '富文本id',
'type' => 'integer',
],
],
'title' => 'data',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1021A12E-4BDF-5EC6-8251-6E998A3C360B\\",\\n \\"data\\": {\\n \\"id\\": 132971028\\n }\\n}","type":"json"}]',
],
'ListIncidentDetailEscalationPlans' => [
'summary' => '事件详情升级策略',
'path' => '/incident/detail/escalation',
'methods' => [
'post',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'incidentId' => [
'description' => '',
'example' => '2311',
'format' => 'int64',
'required' => false,
'title' => '事件ID',
'type' => 'integer',
],
'clientToken' => [
'description' => '',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'required' => false,
'title' => '幂等校验',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'FD200FAE-E98F-496E-BFE6-4CE61E59A2E9',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'escalationPlanId' => [
'description' => '',
'example' => '312123',
'format' => 'int64',
'title' => '升级策略ID',
'type' => 'integer',
],
'escalationPlanName' => [
'description' => '',
'example' => '升级策略A',
'title' => '升级策略名称',
'type' => 'string',
],
'unFinishEscalationPlan' => [
'description' => '',
'items' => [
'properties' => [
'escalationPlanType' => [
'description' => '',
'example' => 'UN_FINISH',
'title' => '升级策略类型 UN_ACKNOWLEDGE',
'type' => 'string',
],
'noticeTime' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'title' => '延迟时间',
'type' => 'integer',
],
'status' => [
'description' => '',
'example' => 'UPGRADE',
'title' => '规则触发状态',
'type' => 'string',
],
'startTime' => [
'description' => '',
'example' => '1629872386027',
'format' => 'int64',
'title' => '开始时间',
'type' => 'integer',
],
'noticeChannels' => [
'description' => '',
'items' => [
'description' => '',
'example' => '渠道字符串 SMS',
'type' => 'string',
],
'title' => '分配渠道',
'type' => 'array',
],
'noticeObjectList' => [
'description' => '',
'items' => [
'properties' => [
'noticeObjectId' => [
'description' => '',
'example' => '2311',
'format' => 'int64',
'title' => '分配对象id',
'type' => 'integer',
],
'noticeObjectName' => [
'description' => '',
'example' => '小明',
'title' => '分配对象名称',
'type' => 'string',
],
'noticeObjectPhone' => [
'description' => '',
'example' => '130xxxxxxxx',
'title' => '手机号',
'type' => 'string',
],
'roleNameList' => [
'title' => '角色列表',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
'type' => 'object',
],
'title' => '用户信息',
'type' => 'array',
],
'serviceGroupList' => [
'description' => '',
'items' => [
'properties' => [
'id' => [
'description' => '',
'example' => '123132',
'format' => 'int64',
'title' => '服务组id',
'type' => 'integer',
],
'name' => [
'description' => '',
'example' => '服务组A',
'title' => '服务组名称',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '消息群',
'type' => 'array',
],
'noticeRoleList' => [
'title' => '角色ID列表',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
'noticeRoleObjectList' => [
'title' => '角色对象列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'id' => [
'type' => 'integer',
'format' => 'int64',
],
'name' => [
'type' => 'string',
],
],
],
],
],
'type' => 'object',
],
'title' => '未完结升级策略规则列表',
'type' => 'array',
],
'nuAcknowledgeEscalationPlan' => [
'description' => '',
'items' => [
'properties' => [
'escalationPlanType' => [
'description' => '',
'example' => 'UN_ACKNOWLEDGE',
'title' => '升级策略类型 UN_ACKNOWLEDGE',
'type' => 'string',
],
'noticeTime' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '延迟时间',
'type' => 'integer',
],
'status' => [
'description' => '',
'example' => 'UPGRADE',
'title' => '规则触发状态',
'type' => 'string',
],
'startTime' => [
'description' => '',
'example' => '1629872386027',
'format' => 'int64',
'title' => '开始时间',
'type' => 'integer',
],
'noticeChannels' => [
'description' => '',
'items' => [
'description' => '',
'example' => '渠道字符串 SMS',
'type' => 'string',
],
'title' => '分配渠道',
'type' => 'array',
],
'noticeObjectList' => [
'description' => '',
'items' => [
'properties' => [
'noticeObjectId' => [
'description' => '',
'example' => '31231',
'format' => 'int64',
'title' => '分配对象id',
'type' => 'integer',
],
'noticeObjectName' => [
'description' => '',
'example' => '小华',
'title' => '分配对象名称',
'type' => 'string',
],
'noticeObjectPhone' => [
'description' => '',
'example' => '130xxxxxxxxx',
'title' => '分配对象手机号',
'type' => 'string',
],
'roleNameList' => [
'title' => '角色列表',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
'type' => 'object',
],
'title' => '用户信息',
'type' => 'array',
],
'serviceGroupList' => [
'description' => '',
'items' => [
'properties' => [
'id' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'title' => '服务组id',
'type' => 'integer',
],
'name' => [
'description' => '',
'example' => '服务组A',
'title' => '服务组名称',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '通知群',
'type' => 'array',
],
'noticeRoleList' => [
'title' => '角色ID列表',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
],
'noticeRoleObjectList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'id' => [
'type' => 'integer',
'format' => 'int64',
],
'name' => [
'type' => 'string',
],
],
],
],
],
'type' => 'object',
],
'title' => '未响应升级策略',
'type' => 'array',
],
'convergenceEscalationPlan' => [
'description' => '',
'items' => [
'properties' => [
'escalationPlanType' => [
'description' => '',
'example' => 'UN_ACKNOWLEDGE',
'title' => '升级策略类型 UN_ACKNOWLEDGE',
'type' => 'string',
],
'noticeTime' => [
'description' => '',
'example' => '10',
'format' => 'int64',
'title' => '收敛目标值',
'type' => 'integer',
],
'status' => [
'description' => '',
'example' => 'UPGRADE',
'title' => '规则触发状态',
'type' => 'string',
],
'startTime' => [
'description' => '',
'example' => '1629872386027',
'format' => 'int64',
'title' => '已收敛次数',
'type' => 'integer',
],
'noticeChannels' => [
'description' => '',
'items' => [
'example' => '渠道字符串 SMS',
'type' => 'string',
],
'title' => '分配渠道',
'type' => 'array',
],
'noticeObjectList' => [
'description' => '',
'items' => [
'properties' => [
'noticeObjectId' => [
'description' => '',
'example' => '31231',
'format' => 'int64',
'title' => '分配对象id',
'type' => 'integer',
],
'noticeObjectName' => [
'description' => '',
'example' => '小华',
'title' => '分配对象名称',
'type' => 'string',
],
'noticeObjectPhone' => [
'description' => '',
'example' => '130xxxxxxxxx',
'title' => '分配对象手机号',
'type' => 'string',
],
'roleNameList' => [
'title' => '角色列表',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
'type' => 'object',
],
'title' => '用户信息',
'type' => 'array',
],
'serviceGroupList' => [
'description' => '',
'items' => [
'properties' => [
'id' => [
'description' => '',
'example' => '1231',
'format' => 'int64',
'title' => '服务组id',
'type' => 'integer',
],
'name' => [
'description' => '',
'example' => '服务组A',
'title' => '服务组名称',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => '通知群',
'type' => 'array',
],
],
'type' => 'object',
],
'title' => '未响应升级策略',
'type' => 'array',
],
],
'title' => 'data',
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'requestParamsDescription' => '{'."\n"
.' "incidentId" : 2311,'."\n"
.' "clientToken" : "FD200FAE-E98F-496E-BFE6-4CE61E59A2E9"'."\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' => [
'description' => '',
'properties' => [
'clientToken' => [
'description' => '',
'example' => 'xxxxxx',
'required' => false,
'title' => '幂等号',
'type' => 'string',
],
],
'required' => false,
'title' => '首页引导查询参数',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'properties' => [
'serviceStatus' => [
'description' => '',
'example' => 'true',
'title' => '服务配置状态',
'type' => 'boolean',
],
'usersStatus' => [
'description' => '',
'example' => 'true',
'title' => '用户配置状态',
'type' => 'boolean',
],
'serviceGroupStatus' => [
'description' => '',
'example' => 'true',
'title' => '服务组配置状态',
'type' => 'boolean',
],
'notifySubscriptionStatus' => [
'description' => '',
'example' => 'true',
'title' => '通知订阅配置状态',
'type' => 'boolean',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'requestParamsDescription' => '{'."\n"
.' "pageNumber": 1,'."\n"
.' "pageSize": 10,'."\n"
.' "clientToken": "89b3ed86-e8d6-43b4-82a6-a711055806eb"'."\n"
.'}',
'responseParamsDescription' => '{'."\n"
.' '."\n"
.' "requestId": "gdgsdgsggsdg",'."\n"
.' "data": {'."\n"
.' "serviceStatus": true,'."\n"
.' "usersStatus": true,'."\n"
.' "serviceGroupStatus": true,'."\n"
.' "notifySubscriptionStatus": true'."\n"
.' }'."\n"
.'}',
],
'ListChartDataForServiceGroup' => [
'summary' => '统计图表数据-个人',
'path' => '/statistics/chartDataForServiceGroup/',
'methods' => [
'post',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => 'clientToken',
'example' => '23es23s32xas23',
'required' => false,
'type' => 'string',
],
'startTime' => [
'description' => '',
'example' => '2021-09-09',
'required' => false,
'title' => '开始时间',
'type' => 'string',
],
'endTime' => [
'description' => '',
'example' => '2021-10-09',
'required' => false,
'title' => '结束时间',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '1231212',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => 'object',
'properties' => [
'time' => [
'description' => '',
'example' => '2021-09-09',
'title' => '时间',
'type' => 'string',
],
'incidentCount' => [
'description' => '',
'example' => '32',
'format' => 'int64',
'title' => '时间总数',
'type' => 'integer',
],
'effectionLevel' => [
'description' => '',
'example' => '{"P1HIGH":32}',
'title' => '根据影响等级时间等级分组统计数量',
'type' => 'object',
],
'meanTimeToAcknowledge' => [
'description' => '',
'example' => '323',
'format' => 'int64',
'title' => '当日平均响应时间单位秒',
'type' => 'integer',
],
'meanTimeToRepair' => [
'description' => '',
'example' => '4343',
'format' => 'int64',
'title' => '当日平均完结时间单位秒',
'type' => 'integer',
],
'totalMeanTimeToAcknowledge' => [
'description' => '',
'example' => '3334',
'format' => 'int64',
'title' => '总平均响应时间',
'type' => 'integer',
],
'totalMeanTimeToRepair' => [
'description' => '',
'example' => '4343',
'format' => 'int64',
'title' => '总平均完结时间',
'type' => 'integer',
],
'escalationIncidentCount' => [
'description' => '',
'example' => '43',
'format' => 'int64',
'title' => '升级事件数',
'type' => 'integer',
],
'unAcknowledgedEscalationIncidentCount' => [
'description' => '',
'example' => '23',
'format' => 'int64',
'title' => '未响应升级事件数',
'type' => 'integer',
],
'unFinishEscalationIncidentCount' => [
'description' => '',
'example' => '23',
'format' => 'int64',
'title' => '未完结升级事件数',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => 'data',
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'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' => [
'description' => 'A short description of struct',
'properties' => [
'startTime' => [
'description' => '',
'example' => '2021-09-01',
'required' => false,
'title' => '开始时间',
'type' => 'string',
],
'endTime' => [
'description' => '',
'example' => '2021-09-30',
'required' => false,
'title' => '结束时间',
'type' => 'string',
],
'pageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int64',
'required' => false,
'title' => '当前页',
'type' => 'integer',
],
'pageSize' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'required' => false,
'title' => '页大小',
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxx',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => '',
'items' => [
'properties' => [
'userName' => [
'description' => '',
'example' => 'wy',
'title' => '用户名字',
'type' => 'string',
],
'escalationIncidentCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '升级事件数量',
'type' => 'integer',
],
'distributionIncidentCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '分配事件数量',
'type' => 'integer',
],
'finishIncidentNumber' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '完结事件数量',
'type' => 'integer',
],
'unAcknowledgedEscalationIncidentCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '未响应升级数',
'type' => 'integer',
],
'unFinishEscalationIncidentCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '未完结事件数',
'type' => 'integer',
],
'meanTimeToAcknowledge' => [
'description' => 'MRRA',
'example' => '3分50秒',
'title' => 'MRRA',
'type' => 'string',
],
'meanTimeToRepair' => [
'description' => 'MTTA',
'example' => '3分50秒',
'title' => 'MTTA',
'type' => 'string',
],
'unDistributionIncidentCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '非分配完结数',
'type' => 'integer',
],
'finishProportion' => [
'description' => '',
'example' => '20%',
'title' => '完结率',
'type' => 'string',
],
'userId' => [
'description' => '',
'example' => '1111',
'format' => 'int64',
'title' => '用户ID',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => '个人统计数据',
'type' => 'array',
],
'totalCount' => [
'description' => '',
'example' => '100',
'format' => 'int64',
'title' => '总条数',
'type' => 'integer',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'requestParamsDescription' => '{'."\n"
.' "pageNumber": 1,'."\n"
.' "pageSize": 10,'."\n"
.' "startTime": "2021-11-01",'."\n"
.' "endTime": "2021-11-08",'."\n"
.' "clientToken": "4b31b55b-32af-415a-b2fb-a88b4e066845"'."\n"
.'}',
],
'ListChartDataForUser' => [
'summary' => '统计图表数据-个人',
'path' => '/statistics/chartDataForUser/',
'methods' => [
'post',
],
'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' => [
'description' => 'A short description of struct',
'properties' => [
'clientToken' => [
'description' => 'clientToken',
'example' => '3232dsd32sd32gr',
'required' => false,
'type' => 'string',
],
'startTime' => [
'description' => '',
'example' => '2021-09-09',
'required' => false,
'title' => '开始时间',
'type' => 'string',
],
'endTime' => [
'description' => '',
'example' => '2021-10-09',
'required' => false,
'title' => '结束时间',
'type' => 'string',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => '1231212',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'items' => [
'description' => 'object',
'properties' => [
'time' => [
'description' => '',
'example' => '2021-09-09',
'title' => '时间',
'type' => 'string',
],
'incidentCount' => [
'description' => '',
'example' => '32',
'format' => 'int64',
'title' => '时间总数',
'type' => 'integer',
],
'effectionLevel' => [
'description' => '',
'example' => '{"P1HIGH":32}',
'title' => '根据影响等级时间等级分组统计数量',
'type' => 'object',
],
'meanTimeToAcknowledge' => [
'description' => '',
'example' => '323',
'format' => 'int64',
'title' => '当日平均响应时间单位秒',
'type' => 'integer',
],
'meanTimeToRepair' => [
'description' => '',
'example' => '4343',
'format' => 'int64',
'title' => '当日平均完结时间单位秒',
'type' => 'integer',
],
'totalMeanTimeToAcknowledge' => [
'description' => '',
'example' => '3334',
'format' => 'int64',
'title' => '总平均响应时间',
'type' => 'integer',
],
'totalMeanTimeToRepair' => [
'description' => '',
'example' => '4343',
'format' => 'int64',
'title' => '总平均完结时间',
'type' => 'integer',
],
'escalationIncidentCount' => [
'description' => '',
'example' => '43',
'format' => 'int64',
'title' => '升级事件数',
'type' => 'integer',
],
'unAcknowledgedEscalationIncidentCount' => [
'description' => '',
'example' => '23',
'format' => 'int64',
'title' => '未响应升级事件数',
'type' => 'integer',
],
'unFinishEscalationIncidentCount' => [
'description' => '',
'example' => '23',
'format' => 'int64',
'title' => '未完结升级事件数',
'type' => 'integer',
],
],
'type' => 'object',
],
'title' => 'data',
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'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' => [
'description' => 'A short description of struct',
'properties' => [
'keys' => [
'description' => 'keys',
'items' => [
'description' => 'oss key',
'example' => 'oss key',
'required' => false,
'type' => 'string',
],
'required' => false,
'title' => 'keys',
'type' => 'array',
],
'problemId' => [
'description' => '',
'example' => '50002020',
'format' => 'int64',
'required' => false,
'title' => '故障id',
'type' => 'integer',
],
],
'required' => false,
'title' => 'A short description of struct',
'type' => 'object',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'requestId' => [
'description' => 'Id of the request',
'example' => 'xxxxxx',
'title' => 'Id of the request',
'type' => 'string',
],
'data' => [
'description' => 'data',
'properties' => [
'links' => [
'description' => 'array',
'items' => [
'description' => 'object',
'properties' => [
'key' => [
'description' => 'oss key',
'example' => 'problem/38b2a36d-484d-4242-b9cf-d243e53a82c6',
'title' => 'oss key',
'type' => 'string',
],
'link' => [
'description' => 'url',
'example' => 'http://gam-objects-bucket.oss-cn-shanghai.aliyuncs.com/problem/38b2a36d-484d-4242-b9cf-d243e53a82c6?Expires=1625662477&OSSAccessKeyId=LTAI5tEoRVPw8GMy1iLRCno7&Signature=1NFnt%2BnudD%2F%2BHVc31b6v5%2FFxoqg%3D',
'title' => 'url',
'type' => 'string',
],
],
'type' => 'object',
],
'title' => 'array',
'type' => 'array',
],
],
'type' => 'object',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":""}]',
'requestParamsDescription' => '{'."\n"
.' "keys" : [ "oss key" ],'."\n"
.' "problemId" : 50002020'."\n"
.'}',
'responseParamsDescription' => '{'."\n"
.' "requestId": "xxxxxx",'."\n"
.' "data": {'."\n"
.' "links": ['."\n"
.' {'."\n"
.' "key": "problem/38b2a36d-484d-4242-b9cf-d243e53a82c6",'."\n"
.' "link": "http://gam-objects-bucket.oss-cn-shanghai.aliyuncs.com/problem/38b2a36d-484d-4242-b9cf-d243e53a82c6?Expires=1625662477&OSSAccessKeyId=LTAI5tEoRVPw8GMy1iLRCno7&Signature=1NFnt%2BnudD%2F%2BHVc31b6v5%2FFxoqg%3D"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}',
],
'RemoveIntegrationConfig' => [
'summary' => '解除集成配置',
'path' => '/integrationConfig/remove',
'methods' => [
'post',
],
'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' => '',
'type' => 'object',
'properties' => [
'integrationConfigId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '103',
],
'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' => '',
'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"}]',
],
'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' => '',
'type' => 'object',
'properties' => [
'monitorSourceId' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '10REQUES-AC5C-4B59-BE11-378F117A6A88',
],
'data' => [
'title' => 'data',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'id' => [
'title' => '用户id',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '164769572',
],
'ruleName' => [
'description' => '',
'type' => 'string',
'example' => 'internal-alert-center-log',
],
],
],
],
],
],
],
],
'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":""}]',
],
'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' => '',
'type' => 'object',
'properties' => [
'requestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '4361a0e1-6747-4834-96ce-0c4840fd381A',
],
'data' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'id' => [
'title' => '规则id',
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '60852564',
],
'ruleName' => [
'title' => '规则名称',
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
'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":""}]',
],
'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' => '',
'type' => 'object',
'properties' => [
'tenantRamId' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => ' 2E7566D1-9E4A-58FA-AEB1-179F86634256',
],
'data' => [
'type' => 'object',
'properties' => [
'tenantStatus' => [
'description' => '',
'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"}]',
'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' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
'RequestId' => [
'description' => '',
'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"}]',
],
'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' => null,
],
'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' => null,
],
'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' => null,
],
'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' => null,
],
'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' => null,
],
],
'endpoints' => [
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'gemp.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'gemp.cn-shanghai.aliyuncs.com',
],
],
];