'1.0',
'info' => ['style' => 'RPC', 'product' => 'Cms', 'version' => '2018-03-08'],
'directories' => [
[
'id' => 59537,
'title' => '云产品时序指标类监控数据',
'type' => 'directory',
'children' => ['QueryMetricLast', 'QueryMetricMeta', 'QueryMetricList'],
],
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
'children' => [
'AccessKeyGet', 'AddMyGroupInstances', 'CreateAlarm', 'CreateMonitoringTemplate', 'CreateMyGroups', 'CreateTask', 'DeleteAlarm', 'DeleteCustomMetric', 'DeleteMetricRuleTargets', 'DeleteMetricRules', 'DeleteMyGroupInstances', 'DeleteMyGroups', 'DeleteTasks', 'DescribeAlarmHistory', 'DescribeAlarms', 'DescribeAlarmsForResources', 'DescribeAlertHistoryList', 'DescribeContact', 'DescribeISPAreaCity', 'DescribeMetricRuleList',
'DescribeTaskDetail', 'DescribeTasks', 'DisableAlarm', 'EnableAlarm', 'GetContacts', 'GetMonitoringTemplate', 'GetMyGroups', 'ListAlarm', 'ListAlarmHistory', 'ListContactGroup', 'ListEventRules', 'ListMyGroupInstances', 'ListMyGroups', 'ModifyTask', 'NodeList', 'NodeProcessCreate', 'NodeProcesses', 'NodeStatusList', 'NodeUninstall', 'PutCustomMetric',
'PutEvent', 'PutEventRule', 'PutEventTargets', 'PutMetricRuleTargets', 'PutResourceMetricRule', 'QueryCustomMetricList', 'QueryMetricData', 'QueryMetricTop', 'QueryProjectMeta', 'QueryStaticsAvailability', 'QueryStaticsResponseTime', 'QuerySystemEventCount', 'QuerySystemEventDemo', 'QueryTaskConfig', 'QueryTaskMonitorData', 'TaskConfigList', 'UpdateAlarm', 'UpdateMonitoringTemplate', 'GetLogColumnTranslateResult', 'GetLineSplitResult',
'DeleteHybridDoubleWrite', 'CreateHybridDoubleWrite', 'DescribeHybridDoubleWrite',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'QueryMetricLast' => [
'summary' => '查询指定监控对象的最新监控数据。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Project',
'in' => 'query',
'schema' => ['description' => '名字空间,表明监控数据所属产品,如 “acs_ecs_dashboard”,“acs_rds_dashboard”等 。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard'],
],
[
'name' => 'Metric',
'in' => 'query',
'schema' => ['description' => '监控项名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CPUUtilization'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '时间间隔。单位:秒。', 'type' => 'string', 'required' => false, 'example' => '60'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,可以传入距离 1970 年 1 月 1 日 0 点的毫秒数,也可以传入format时间格式数据,如2015-10-20 00:00:00。 ', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:00:00'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间。可以传入距离1970年1月1日0点的毫秒数,也可以传入format时间格式数据,如2015-10-2000:00:00。', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:10:00'],
],
[
'name' => 'Dimensions',
'in' => 'query',
'schema' => ['description' => '指定资源的监控维度。'."\n"
."\n"
.'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。'."\n"
."\n"
.'> 单次请求最多支持批量查询50个实例。'."\n"
."\n\n"
."\n\n", 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"XXX"}]'],
],
[
'name' => 'Cursor',
'in' => 'query',
'schema' => ['description' => '下一页数据,为空代表没有下一页。', 'type' => 'string', 'required' => false, 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0'],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => '分页参数。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'Length',
'in' => 'query',
'schema' => ['description' => '每次查询大小,用于分页查询。', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
[
'name' => 'Express',
'in' => 'query',
'schema' => ['description' => '对查出的现有结果进行时时计算的表达式,例如` {"groupby":["instanceId"]}`', 'type' => 'string', 'required' => false, 'example' => '{\\"groupby\\":[\\"userId\\",\\"instanceId\\"]}'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Cursor' => ['description' => '下一页数据,为空代表没有下一页。', 'type' => 'string', 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********'],
'RequestId' => ['description' => '请求的ID,用于定位日志,排查问题。', 'type' => 'string', 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3'],
'Success' => ['description' => '用于标识本次调用是否成功。', 'type' => 'string', 'example' => 'true'],
'Datapoints' => ['description' => '监控数据列表。', 'type' => 'string', 'example' => '[{\\"timestamp\\":1618368900000,\\"Average\\":95.8291666666667,\\"Minimum\\":65.48,\\"Maximum\\":100.0},{\\"timestamp\\":1618368960000,\\"Average\\":95.8683333333333,\\"Minimum\\":67.84,\\"Maximum\\":100.0}]'],
'Code' => ['description' => '状态码,200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Success'],
'Period' => ['description' => '时间间隔。单位:秒。', 'type' => 'string', 'example' => '60'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cursor\\": \\"v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********\\",\\n \\"RequestId\\": \\"021472A6-25E3-4094-8D00-BA4B6A5486C3\\",\\n \\"Success\\": \\"true\\",\\n \\"Datapoints\\": \\"[{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368900000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8291666666667,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":65.48,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368960000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8683333333333,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":67.84,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Period\\": \\"60\\"\\n}","type":"json"}]',
'title' => '查询指定监控对象最新监控数据',
],
'QueryMetricMeta' => [
'summary' => '查询云监控开放的时序类监控项的监控项描述。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Project',
'in' => 'query',
'schema' => ['description' => '指标所属的Project,按等于匹配。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'acs_ecs_dashboard'],
],
[
'name' => 'Labels',
'in' => 'query',
'schema' => ['description' => '根据标签过滤,格式`[{"name":"标签名","value":"标签值"},{"name":"标签名","value":"标签值"}] `。'."\n"
.'已有的标签name说明: '."\n"
."\n"
.'- MetricCategory:监控项分类的描述 '."\n"
.'- alertEnable:是否需要报警 '."\n"
.'- alertUnit:建议的报警单位 '."\n"
.'- unitFactor:单位转换系数 '."\n"
.'- minAlertPeriod:最小报警周期 '."\n"
.'- productCategory:产品类型分类 ', 'type' => 'string', 'required' => false, 'example' => '[{\\"name\\":\\"alertUnit\\",\\"value\\":\\"%\\"}]'],
],
[
'name' => 'Metric',
'in' => 'query',
'schema' => ['description' => '指标名,按等于匹配。', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页参数,默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大数量,默认30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => ['description' => '错误码消息。', 'type' => 'string', 'example' => 'Success'],
'RequestId' => ['description' => '用于跟踪。', 'type' => 'string', 'example' => '0CCE0AF0-053C-4B13-A583-DC9A85785D49'],
'Success' => ['description' => '用于标识本次调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '状态码,200为成功,非200为失败。', 'type' => 'string', 'example' => '200'],
'Resources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Resource' => [
'description' => '返回的metric meta列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => ['description' => '监控项的描述。', 'type' => 'string', 'example' => 'ECS.CPUUtilization'],
'Labels' => ['description' => ' 监控项的标签,是一个json的string`[{"name":"标签名","value":"标签的值"}]`,可以是多个,name可以重复。'."\n"
.'已有的标签name说明: '."\n"
."\n"
.'- metricCategory:指标分类 '."\n"
.'- alertEnable:是否可以报警 '."\n"
.'- alertUnit:报警单位 '."\n"
.'- unitFactor:单位转换系数 '."\n"
.'- minAlertPeriod:最小报警周期 '."\n"
.'- productCategory:产品 ', 'type' => 'string', 'example' => '[{\\"name\\":\\"alertUnit\\",\\"value\\":\\"%\\"},{\\"name\\":\\"alertDefault\\",\\"value\\":\\"80\\"},{\\"name\\":\\"minAlertPeriod\\",\\"value\\":\\"60\\"},{\\"name\\":\\"metricCategory\\",\\"value\\":\\"instanceId\\"},{\\"name\\":\\"is_alarm\\",\\"value\\":\\"true\\"}]"'],
'Unit' => ['description' => '监控项的单位。', 'type' => 'string', 'example' => '%'],
'Dimensions' => ['description' => '监控项的Dimensions,多级用英文逗号分隔,例如:userId,instanceId', 'type' => 'string', 'example' => 'instanceId'],
'Metric' => ['description' => '监控项名称。', 'type' => 'string', 'example' => 'CPUUtilization'],
'Project' => ['description' => '监控项的Project名称,用于查询监控数据。', 'type' => 'string', 'example' => 'acs_ecs_dashboard'],
'Periods' => ['description' => '监控项的所有统计周期,多个用英文逗号分隔:15,60,900', 'type' => 'string', 'example' => '60,300'],
'Statistics' => ['description' => '统计方法,多个用英文逗号分隔,例如:Maximum,Minimum,Average', 'type' => 'string', 'example' => 'Average,Minimum,Maximum'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"RequestId\\": \\"0CCE0AF0-053C-4B13-A583-DC9A85785D49\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"200\\",\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Description\\": \\"ECS.CPUUtilization\\",\\n \\"Labels\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"alertUnit\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"%\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"alertDefault\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"80\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"minAlertPeriod\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"60\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"metricCategory\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"is_alarm\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\"}]\\\\\\"\\",\\n \\"Unit\\": \\"%\\",\\n \\"Dimensions\\": \\"instanceId\\",\\n \\"Metric\\": \\"CPUUtilization\\",\\n \\"Project\\": \\"acs_ecs_dashboard\\",\\n \\"Periods\\": \\"60,300\\",\\n \\"Statistics\\": \\"Average,Minimum,Maximum\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t60498C25-B5AE-48CD-B03D-207011F21E8A\\r\\n\\t200\\r\\n\\ttrue\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tAverage\\r\\n\\t\\t\\t[{"name":"minAlertPeriod","value":"60"},{"name":"metricCategory","value":"role"},{"name":"is_alarm","value":"true"}]\\r\\n\\t\\t\\tActiveApplications\\r\\n\\t\\t\\tclusterId,role\\r\\n\\t\\t\\tacs_hbase\\r\\n\\t\\t\\t30,300\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tAverage\\r\\n\\t\\t\\t[{"name":"minAlertPeriod","value":"60"},{"name":"metricCategory","value":"role"},{"name":"is_alarm","value":"true"}]\\r\\n\\t\\t\\tActiveApplications\\r\\n\\t\\t\\tclusterId,role\\r\\n\\t\\t\\tacs_emr\\r\\n\\t\\t\\t30,300,3600\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t端口当前活跃连接数\\r\\n\\t\\t\\tAverage,Minimum,Maximum\\r\\n\\t\\t\\t[{"name":"alertUnit","value":"Count"},{"name":"minAlertPeriod","value":"60"},{"name":"metricCategory","value":"port"},{"name":"is_alarm","value":"true"}]\\r\\n\\t\\t\\tActiveConnection\\r\\n\\t\\t\\tinstanceId,port,protocol\\r\\n\\t\\t\\tacs_slb_dashboard\\r\\n\\t\\t\\t60,300\\r\\n\\t\\t\\tCount\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t高防IP活跃并发连接\\r\\n\\t\\t\\tMaximum\\r\\n\\t\\t\\t[{"name":"alertUnit","value":"count"},{"name":"minAlertPeriod","value":"60"}]\\r\\n\\t\\t\\tActiveConnection\\r\\n\\t\\t\\tinstanceId,ip\\r\\n\\t\\t\\tacs_ddos\\r\\n\\t\\t\\t30,60,300\\r\\n\\t\\t\\tcount\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t活跃消息数\\r\\n\\t\\t\\tAverage,Minimum,Maximum\\r\\n\\t\\t\\t[{"name":"alertUnit","value":"Count"},{"name":"minAlertPeriod","value":"300"},{"name":"metricCategory","value":"queue"},{"name":"is_alarm","value":"true"}]\\r\\n\\t\\t\\tActiveMessages\\r\\n\\t\\t\\tregion,queue\\r\\n\\t\\t\\tacs_mns_new\\r\\n\\t\\t\\t300\\r\\n\\t\\t\\tCount\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":"\\n\\n{\\n\\"RequestId\\": \\"60498C25-B5AE-48CD-B03D-207011F21E8A\\",\\n\\"ErrorCode\\": 200,\\n\\"Success\\": true,\\n\\"Resources\\": {\\n\\"Resource\\": [\\n{\\n\\"Description\\": \\"\\",\\n\\"Statistics\\": \\"Average\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"role\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Metric\\": \\"ActiveApplications\\",\\n\\"Dimensions\\": \\"clusterId,role\\",\\n\\"Project\\": \\"acs_hbase\\",\\n\\"Periods\\": \\"30,300\\"\\n},\\n{\\n\\"Description\\": \\"\\",\\n\\"Statistics\\": \\"Average\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"role\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Metric\\": \\"ActiveApplications\\",\\n\\"Dimensions\\": \\"clusterId,role\\",\\n\\"Project\\": \\"acs_emr\\",\\n\\"Periods\\": \\"30,300,3600\\"\\n},\\n{\\n\\"Description\\": \\"端口当前活跃连接数\\",\\n\\"Statistics\\": \\"Average,Minimum,Maximum\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"Count\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"port\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Metric\\": \\"ActiveConnection\\",\\n\\"Dimensions\\": \\"instanceId,port,protocol\\",\\n\\"Project\\": \\"acs_slb_dashboard\\",\\n\\"Periods\\": \\"60,300\\",\\n\\"Unit\\": \\"Count\\"\\n},\\n{\\n\\"Description\\": \\"高防IP活跃并发连接\\",\\n\\"Statistics\\": \\"Maximum\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"count\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"}]\\",\\n\\"Metric\\": \\"ActiveConnection\\",\\n\\"Dimensions\\": \\"instanceId,ip\\",\\n\\"Project\\": \\"acs_ddos\\",\\n\\"Periods\\": \\"30,60,300\\",\\n\\"Unit\\": \\"count\\"\\n},\\n{\\n\\"Description\\": \\"活跃消息数\\",\\n\\"Statistics\\": \\"Average,Minimum,Maximum\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"Count\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"300\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"queue\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Metric\\": \\"ActiveMessages\\",\\n\\"Dimensions\\": \\"region,queue\\",\\n\\"Project\\": \\"acs_mns_new\\",\\n\\"Periods\\": \\"300\\",\\n\\"Unit\\": \\"Count\\"\\n}\\n]\\n}\\n}"}]',
'title' => '查询开放的时序类监控项的监控项描述',
'description' => '通常配合查询监控项接口QueryMetricMeta和查询监控数据接口QueryProjectMeta/QueryMetricLast 一起使用。 '."\n"
.'##请求类型 '."\n"
.'POST|GET '."\n"
.' ',
],
'QueryMetricList' => [
'summary' => '查询一段时间内指定产品实例的监控数据。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Project',
'in' => 'query',
'schema' => ['description' => '监控项的project,用于查询监控数据。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard'],
],
[
'name' => 'Metric',
'in' => 'query',
'schema' => ['description' => '监控项名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_idle'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '时间间隔。单位:秒。', 'type' => 'string', 'required' => false, 'example' => '60'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,可以传入距离1970年1月1日0点的毫秒数,也可以传入format时间格式数据,如2015-10-20 00:00:00。 ', 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:00:00'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间。支持的格式:Unix时间戳:从1970年1月1日开始所经过的毫秒数。Format格式:YYYY-MM-DDThh:mm:ssZ。 说明 StartTime和EndTime之间的间隔小于等于31天。', 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:10:00'],
],
[
'name' => 'Dimensions',
'in' => 'query',
'schema' => ['description' => '指定资源的监控维度。'."\n"
."\n"
.'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId": "i-abcdefgh123456"}]'],
],
[
'name' => 'Cursor',
'in' => 'query',
'schema' => ['description' => '下一页数据,为空代表没有下一页。', 'type' => 'string', 'required' => false, 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0'],
],
[
'name' => 'Length',
'in' => 'query',
'schema' => ['description' => '每次查询大小,用于分页查询。', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
[
'name' => 'Express',
'in' => 'query',
'schema' => ['description' => '对查询出的现有结果进行实时计算的表达式。目前仅支持groupby,类似数据库的groupby语句。', 'type' => 'string', 'required' => false, 'example' => '{\\"groupby\\":[\\"instanceId\\"]}'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Cursor' => ['description' => '下一页数据,为空代表没有下一页。', 'type' => 'string', 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0'],
'RequestId' => ['description' => '请求的ID,用于定位日志,排查问题。', 'type' => 'string', 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42'],
'Success' => ['description' => '用于标识本次调用是否成功。', 'type' => 'string', 'example' => 'true'],
'Datapoints' => ['description' => '监控数据列表。', 'type' => 'string', 'example' => '[{"timestamp":1548777660000,"userId":"123","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]'],
'Code' => ['description' => '状态码,正常为"200"。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Success'],
'Period' => ['description' => '时间间隔。单位:秒。', 'type' => 'string', 'example' => '60'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cursor\\": \\"v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0\\",\\n \\"RequestId\\": \\"3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42\\",\\n \\"Success\\": \\"true\\",\\n \\"Datapoints\\": \\"[{\\\\\\"timestamp\\\\\\":1548777660000,\\\\\\"userId\\\\\\":\\\\\\"123\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-abc\\\\\\",\\\\\\"Minimum\\\\\\":9.92,\\\\\\"Average\\\\\\":9.92,\\\\\\"Maximum\\\\\\":9.92}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Period\\": \\"60\\"\\n}","type":"json"}]',
'title' => '查询产品实例监控数据',
],
'AccessKeyGet' => [
'summary' => 'AccessKeyGet',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SecretKey' => ['type' => 'string'],
'AccessKey' => ['type' => 'string'],
'ErrorMessage' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'ErrorCode' => ['type' => 'integer', 'format' => 'int32'],
'Success' => ['type' => 'boolean'],
'UserId' => ['type' => 'integer', 'format' => 'int64'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'AddMyGroupInstances' => [
'summary' => '添加个人分组内的资源实例',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '个人应用分组id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '93958859'],
],
[
'name' => 'Instances',
'in' => 'query',
'schema' => ['description' => '应用分组的实例信息。', 'type' => 'string', 'required' => false, 'example' => '[{\\"instanceId\\":\\"f1c10843-a18f-11eb-b20e-f23797f49c09\\",\\"instanceName\\":\\"lvaccess-dahua-l2en6bwv1h9kx4r9-64fcd8cb6b-l975v\\",\\"category\\":\\"K8S_POD\\",\\"regionId\\":\\"cn-hangzhou\\"}]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Success'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8C397B67-530C-5074-8E5D-0076C6E3AA78'],
'Success' => ['description' => '操作是否成功。取值:true:成功。false:失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '请求失败状态码,200为成功,非200为失败', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => '%s'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => '%s'],
],
409 => [
['errorCode' => 'ResourceConflict', 'errorMessage' => '%s'],
['errorCode' => 'ResourceExist', 'errorMessage' => '%s'],
],
412 => [
['errorCode' => 'ResourcesOverLimit', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => '%s'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"RequestId\\": \\"8C397B67-530C-5074-8E5D-0076C6E3AA78\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200\\n}","type":"json"}]',
'title' => '添加个人分组内的资源实例',
],
'CreateAlarm' => [
'summary' => '创建报警规则。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '报警规则名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abc'],
],
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '产品名称,参考各产品对应的project,例如acs_ecs_dashboard, acs_rds_dashboard等 。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard'],
],
[
'name' => 'MetricName',
'in' => 'query',
'schema' => ['description' => '相应产品对应的监控项名称,参考各产品metric定义。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CPUUtilization'],
],
[
'name' => 'Dimensions',
'in' => 'query',
'schema' => ['description' => '报警规则对应实例列表,为json array对应的string,例如`[{“instanceId”:”name1”},{“instanceId”:”name2”}]`。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"instanceId":"i-2zecrzcri3d6fhd2ff7j "}]'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '查询指标的周期,必须与定义的metric一致,默认300,单位为秒 。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'default' => '300'],
],
[
'name' => 'Statistics',
'in' => 'query',
'schema' => ['description' => '统计方法,必须与定义的metric一致,例如Average。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Average'],
],
[
'name' => 'ComparisonOperator',
'in' => 'query',
'schema' => ['description' => '报警比较符,只能为以下几种`<=,<,>,>=,==,!=`', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '>'],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => '报警阈值,目前只开放数值类型功能。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '90'],
],
[
'name' => 'EvaluationCount',
'in' => 'query',
'schema' => ['description' => '连续探测几次都满足阈值条件时报警,默认3次。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'default' => '3'],
],
[
'name' => 'ContactGroups',
'in' => 'query',
'schema' => ['description' => '报警规则通知的联系组,必须在控制台上已创建,为json array对应的string,例如`[“联系组1”,”联系组2”]`。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["cms测试组"]'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '报警生效时间的开始时间,默认0,代表0点。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '报警生效时间的结束时间,默认24,代表24点。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24', 'default' => '24'],
],
[
'name' => 'SilenceTime',
'in' => 'query',
'schema' => ['description' => '一直处于报警状态的通知沉默周期,默认86400,单位s,最小1小时。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'default' => '86400'],
],
[
'name' => 'NotifyType',
'in' => 'query',
'schema' => ['description' => '通知类型,为0是旺旺+邮件,为1是旺旺+邮件+短信。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Webhook',
'in' => 'query',
'schema' => ['description' => '回调函数,只支持公网地址,回调参数请参考[使用报警回调](~~60714~~)。', 'type' => 'string', 'required' => false, 'example' => 'http://www.net.cn/example_callback.htm'],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => '是否需要检查Webhook可用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求失败状态码,200为成功,非200为失败。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求失败的提示信息。', 'type' => 'string', 'example' => 'Success'],
'Data' => ['description' => '返回的报警规则id。', 'type' => 'string', 'example' => '0c4af0f1-a864-468b-bed3-15c7deff75ee'],
'RequestId' => ['description' => '请求的uuid,便于查询日志。', 'type' => 'string', 'example' => '910ABE4E-DC9D-4231-9DC0-C96835553327'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": \\"0c4af0f1-a864-468b-bed3-15c7deff75ee\\",\\n \\"RequestId\\": \\"910ABE4E-DC9D-4231-9DC0-C96835553327\\",\\n \\"Success\\": true\\n}","errorExample":"{\\n \\"Data\\": \\"0c4af0f1-a864-468b-bed3-15c7deff75ee\\", \\n \\"RequestId\\": \\"910ABE4E-DC9D-4231-9DC0-C96835553327\\", \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\"\\n}"},{"type":"xml","example":"\\n 576fbae7-2fd1-411a-ae13-6f09f4fafdde\\n 58C699ED-84BE-44D5-B55F-84AFE73932AB\\n true\\n 200\\n","errorExample":"\\n 576fbae7-2fd1-411a-ae13-6f09f4fafdde\\n 58C699ED-84BE-44D5-B55F-84AFE73932AB\\n true\\n 200\\n"}]',
'title' => '创建报警规则',
'description' => '可以为某一个实例创建报警规则,也可以为多个实例同时创建报警规则。',
],
'CreateMonitoringTemplate' => [
'summary' => '创建监控模板',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '监视模板名称。', 'type' => 'string', 'required' => true, 'example' => 'Monitor_Template'],
],
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '模板命名空间,语义同metric master对外开放的命名空间。', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard'."\n"],
],
[
'name' => 'AlertTemplatesJson',
'in' => 'query',
'schema' => ['description' => '报警模版。', 'type' => 'string', 'required' => true, 'example' => '{"rds":[{"displayName":"rds_rule_1111","category":"rds","namespace":"acs_rds_dashboard","metricName":"CpuUsage","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"99","times":3},"warn":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"98","times":3}}}],"ecs":[{"displayName":"ecs_rule1111","category":"ecs","namespace":"acs_ecs_dashboard","metricName":"cpu_total","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"99","times":5}}},{"displayName":"ecs_rule2222","category":"ecs","namespace":"acs_ecs_dashboard","metricName":"cpu_idle","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"9999","times":3},"warn":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"89","times":4}}}],"mongodb":[{"displayName":"mongodb11","category":"mongodb","namespace":"acs_mongodb","metricName":"CPUUtilization","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"11111","times":3}}}],"mongodb_cluster":[{"displayName":"mongodb_cluster_t1","category":"mongodb_cluster","namespace":"acs_mongodb","metricName":"ShardingQPS","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"9999999","times":3}}}]}'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '监视模板描述。', 'type' => 'string', 'required' => false, 'example' => 'description'],
],
[
'name' => 'SystemEventTemplates',
'in' => 'query',
'schema' => ['description' => '系统事件模板。', 'type' => 'string', 'required' => false, 'example' => '[{"alertName":"WAF_Event","description":"WAF_Event","eventPattern":{"eventType":["*"],"levelList":["*"],"nameList":["*"],"product":"waf"},"fcParameterList":[],"mnsParameterList":[],"notifyLevel":3,"slsParameterList":[],"webhookParameterList":[]}]'],
],
[
'name' => 'ProcessMonitorTemplates',
'in' => 'query',
'schema' => ['description' => '进程监控模板。', 'type' => 'string', 'required' => false, 'example' => '[{"alert":{"comparisonOperator":"LessThanThreshold","escalationsLevel":"critical","silenceTime":0,"statistics":"Average","templateAlert":false,"threshold":"2","times":1},"matchExpress":{"filterRelation":"and","filters":[{"function":"all","name":"name","value":"*"}]},"processName":"FineBI"}]'],
],
[
'name' => 'HostAvailabilityTemplate',
'in' => 'query',
'schema' => ['description' => '可用性监控模板。', 'type' => 'string', 'required' => false, 'example' => '[{"alert":{"escalationList":[{"aggregate":"Value","metric":"TelnetStatus","operator":">","times":3,"value":"400"},{"aggregate":"Average","metric":"TelnetLatency","operator":">","times":3,"value":"500"}],"notifyType":1,"silenceTime":86400},"taskName":"telnet","taskOption":{"method":"HEAD","negative":true,"resposeCharset":"utf-8","uri":"telnet://xxx.com"},"taskType":"TELNET"},{"alert":{"escalationList":[{"aggregate":"Value","metric":"TelnetStatus","operator":">","times":3,"value":"400"},{"aggregate":"Average","metric":"TelnetLatency","operator":">","times":3,"value":"500"}],"notifyType":1,"silenceTime":86400},"taskName":"bbbbbbbbbb","taskOption":{"method":"HEAD","negative":true,"resposeCharset":"utf-8","uri":"telnet://xxx.com"},"taskType":"TELNET"}]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'InstanceIds is mandatory for this action.'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '78B915FD-01CA-5E38-8C4F-D3DC82598CE0'],
'ErrorCode' => ['description' => '错误码,200为成功,其他为失败', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
'Id' => ['description' => '监视模板id。', 'type' => 'integer', 'format' => 'int64', 'example' => '2224623'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
409 => [
['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.'],
['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => '%s'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"InstanceIds is mandatory for this action.\\",\\n \\"RequestId\\": \\"78B915FD-01CA-5E38-8C4F-D3DC82598CE0\\",\\n \\"ErrorCode\\": 200,\\n \\"Success\\": true,\\n \\"Id\\": 2224623\\n}","type":"json"}]',
'title' => '创建监视模板',
],
'CreateMyGroups' => [
'summary' => '创建个人应用分组',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => '应用分组类型。取值:'."\n"
.'- custom:自建的应用分组。'."\n"
.'- ehpc_cluster:从EHPC集群同步的应用分组。', 'type' => 'string', 'required' => false, 'example' => 'custom'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '应用分组名称。', 'type' => 'string', 'required' => false, 'example' => 'monitor_group_2018_metric_ruleioaw'],
],
[
'name' => 'ServiceId',
'in' => 'query',
'schema' => ['description' => 'ServiceId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '49****'],
],
[
'name' => 'BindUrl',
'in' => 'query',
'schema' => ['description' => '回调地址。', 'type' => 'string', 'required' => false, 'example' => 'https://aliyun.com'],
],
[
'name' => 'ContactGroups',
'in' => 'query',
'schema' => ['description' => '报警联系组。', 'type' => 'string', 'required' => false, 'example' => '[]'],
],
[
'name' => 'Options',
'in' => 'query',
'schema' => ['description' => '高级设置。', 'type' => 'string', 'required' => false, 'example' => '[]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified resource is not found.'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3A57FF18-32F1-5A95-97E0-8CD905DF417A'],
'GroupId' => ['description' => '应用分组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '239811740'],
'ErrorCode' => ['description' => '错误码,200为成功,其他失败 ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
409 => [
['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.'],
['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.'],
],
412 => [
['errorCode' => 'ResourcesOverLimit', 'errorMessage' => 'Resources over limit.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3A57FF18-32F1-5A95-97E0-8CD905DF417A\\",\\n \\"GroupId\\": 239811740,\\n \\"ErrorCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '创建个人应用分组',
],
'CreateTask' => [
'summary' => '创建站点监控专业版任务。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Address',
'in' => 'query',
'schema' => ['description' => '监控的地址,如 http://www.aliyun.com', 'type' => 'string', 'required' => true, 'example' => 'http://www.aliyun.com'],
],
[
'name' => 'TaskType',
'in' => 'query',
'schema' => ['description' => '1.http'."\n"
.'2.ping'."\n"
.'3.tcp'."\n"
.'4.udp'."\n"
.'5.dns'."\n"
.'6.smtp'."\n"
.'7.pop3'."\n"
.'8.ftp', 'type' => 'string', 'required' => true, 'example' => '1'],
],
[
'name' => 'TaskName',
'in' => 'query',
'schema' => ['description' => '监控的任务名4-50位中英文字符', 'type' => 'string', 'required' => true, 'example' => 'aliyunTest'],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => ['description' => '探测频率,取值范围1、5、15,单位是分钟', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'IspCity',
'in' => 'query',
'schema' => ['description' => '探针的信息,需要从DescribeISPAreaCity 接口获得', 'type' => 'string', 'required' => true, 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]'],
],
[
'name' => 'Options',
'in' => 'query',
'schema' => ['description' => '监控对应协议的高级扩展选项', 'type' => 'string', 'required' => false, 'example' => '{"http_method":"get","header":"xx=bb","cookie":"test=aa","time_out":30000,"match_rule":0,"response_content":"aa"}'],
],
[
'name' => 'AlertRule',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'AlertIds',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'caller',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'IntervalUnit',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'string'],
'RequestId' => ['description' => '请求Id,用于排查问题', 'type' => 'string', 'example' => 'a4e6f550-7eac-4a13-b11f-6742aa2d42d1'],
'Success' => ['description' => '是否成功', 'type' => 'string', 'example' => 'true'],
'Code' => ['description' => '状态吗', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '错误或者成功的信息', 'type' => 'string', 'example' => 'successfull'],
'AlertRule' => ['type' => 'string'],
'CreateResultList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Contact' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskId' => ['type' => 'string'],
'TaskName' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'],
],
406 => [
['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
600 => [
['errorCode' => 'IllegalAddress', 'errorMessage' => 'Illegal HTTP address'],
],
605 => [
['errorCode' => 'OperationError', 'errorMessage' => 'Operation failed'],
],
615 => [
['errorCode' => 'TaskNotExists', 'errorMessage' => 'Task does not exist'],
],
650 => [
['errorCode' => 'OperatorInvalid', 'errorMessage' => 'Operator invalid'],
['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Operator City invalid'],
],
655 => [
['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Operator City invalid'],
],
660 => [
['errorCode' => 'NameRepeat', 'errorMessage' => 'Task name repeat'],
],
680 => [
['errorCode' => 'CreateAlarmError', 'errorMessage' => 'Create alarm error'],
],
695 => [
['errorCode' => 'NameNotExists', 'errorMessage' => 'Task name not exists'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successfull\\",\\n \\"RequestId\\": \\"a4e6f550-7eac-4a13-b11f-6742aa2d42d1\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":"{\\n \\"Message\\": \\"请求失败\\",\\n \\"Success\\": false,\\n \\"Code\\": \\"500\\"\\n}"},{"type":"xml","example":"","errorExample":""}]',
'title' => '创建站点监控专业版任务',
'description' => '用于创建一个站点监控任务',
],
'DeleteAlarm' => [
'summary' => '删除已创建的报警规则。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '报警规则的id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求失败状态码,200为成功,非200为失败', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求失败的提示信息', 'type' => 'string', 'example' => 'Success'],
'RequestId' => ['description' => '请求的uuid,便于查询日志', 'type' => 'string', 'example' => 'A9371CD8-369D-49FA-BED9-35050A0DC6A2'],
'Success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A9371CD8-369D-49FA-BED9-35050A0DC6A2\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n A9371CD8-369D-49FA-BED9-35050A0DC6A2\\n true\\n 200\\n","errorExample":"{\\n \\"RequestId\\": \\" A9371CD8-369D-49FA-BED9-35050A0DC6A2\\", \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\"\\n}"}]',
'title' => '删除监控告警',
],
'DeleteCustomMetric' => [
'summary' => 'DeleteCustomMetric',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'MetricName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Md5',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'UUID',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['type' => 'string'],
'Message' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Result' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'DeleteMetricRuleTargets' => [
'summary' => 'DeleteMetricRuleTargets',
'methods' => ['post', 'get', 'delete', 'put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'TargetIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'required' => false,
'maxItems' => 5,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['type' => 'string'],
'Message' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
'FailIds' => [
'type' => 'object',
'properties' => [
'TargetIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TargetId' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed because of an unknown error, exception or failure.'],
],
],
'responseDemo' => '',
],
'DeleteMetricRules' => [
'summary' => 'DeleteMetricRules',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'required' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['type' => 'string'],
'Message' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.'],
],
[
['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
429 => [
['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'DeleteMyGroupInstances' => [
'summary' => 'deletemygroupinstances',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '个人分组id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '239847992'],
],
[
'name' => 'InstanceIdList',
'in' => 'query',
'schema' => ['description' => '需要删除的实例ID列表', 'type' => 'string', 'required' => false, 'example' => '[]'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '需要删除的实例ID', 'type' => 'string', 'required' => false, 'example' => 'i-m5e0k0bexac8tykr****'],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => ['description' => '分类', 'type' => 'string', 'required' => true, 'example' => 'ecs'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'InvalidAuthorization'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0857B44C-315F-5E40-AA6A-48096D1EB508'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '错误码。200为成功,其他失败', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"InvalidAuthorization\\",\\n \\"RequestId\\": \\"0857B44C-315F-5E40-AA6A-48096D1EB508\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200\\n}","type":"json"}]',
'title' => '删除个人分组内的资源实例',
],
'DeleteMyGroups' => [
'summary' => '删除个人应用分组',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '应用分组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '174549092'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Success'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '107F0464-38F4-57F2-B1E0-237382F0FD72'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '状态码,200为成功,非200为失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Group' => [
'description' => '分组信息。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '应用分组类型。取值:'."\n"
.'- custom:自建的应用分组。'."\n"
.'- ehpc_cluster:从EHPC集群同步的应用分组。', 'type' => 'string', 'example' => 'custom'],
'GroupName' => ['description' => '应用分组名称。', 'type' => 'string', 'example' => 'ECS_test'],
'GroupId' => ['description' => '应用分组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '15055766'],
'BindUrls' => ['description' => '绑定URL', 'type' => 'string', 'example' => 'ehpc://i-dadfasdf/Login'],
'ServiceId' => ['description' => 'ServiceId', 'type' => 'string', 'example' => '1349'],
'ContactGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactGroup' => [
'description' => '报警联系人组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '报警联系人的姓名。', 'type' => 'string', 'example' => 'xiaoming'],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
409 => [
['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"RequestId\\": \\"107F0464-38F4-57F2-B1E0-237382F0FD72\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"Group\\": {\\n \\"Type\\": \\"custom\\",\\n \\"GroupName\\": \\"ECS_test\\",\\n \\"GroupId\\": 15055766,\\n \\"BindUrls\\": \\"ehpc://i-dadfasdf/Login\\",\\n \\"ServiceId\\": \\"1349\\",\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Name\\": \\"xiaoming\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '删除个人应用分组',
],
'DeleteTasks' => [
'summary' => '批量删除站点监控的任务。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'TaskIds',
'in' => 'query',
'schema' => ['description' => '站点监控的任务Id,任务的唯一标识', 'type' => 'string', 'required' => true, 'example' => '["2b5e6f7d-108f-4117-85fb-b202ba033468"]', 'docRequired' => true],
],
[
'name' => 'IsDeleteAlarms',
'in' => 'query',
'schema' => ['description' => '是否删除任务关联的报警规则,默认值为1。'."\n"
."\n"
.'1:同时删除报警规则'."\n"
.'0:不删除报警规则,只删除任务'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '错误码消息', 'type' => 'string', 'example' => '请求成功'],
'Data' => ['description' => '返回信息'."\n", 'type' => 'string', 'example' => '{"count":1}'],
'RequestId' => ['description' => '请求Id,用于排查问题', 'type' => 'string', 'example' => 'a4e6f550-7eac-4a13-b11f-6742aa2d42d1'],
'Success' => ['description' => '用于标识本次调用是否成功', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'],
],
[
['errorCode' => 'TaskNotExists', 'errorMessage' => 'Task not exist'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Data\\": \\"{\\\\\\"count\\\\\\":1}\\",\\n \\"RequestId\\": \\"a4e6f550-7eac-4a13-b11f-6742aa2d42d1\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '批量删除任务',
'description' => '删除一个指定的站点监控任务',
],
'DescribeAlarmHistory' => [
'summary' => 'DescribeAlarmHistory',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AlertName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'MetricName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'State',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false],
],
[
'name' => 'OnlyCount',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['type' => 'string'],
'Message' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Total' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
'AlarmHistoryList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AlarmHistory' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['type' => 'integer', 'format' => 'int32'],
'MetricName' => ['type' => 'string'],
'EvaluationCount' => ['type' => 'integer', 'format' => 'int32'],
'State' => ['type' => 'string'],
'UserId' => ['type' => 'string'],
'PreLevel' => ['type' => 'string'],
'Namespace' => ['type' => 'string'],
'AlertName' => ['type' => 'string'],
'Webhooks' => ['type' => 'string'],
'RuleName' => ['type' => 'string'],
'LastTime' => ['type' => 'integer', 'format' => 'int64'],
'Value' => ['type' => 'string'],
'Expression' => ['type' => 'string'],
'GroupId' => ['type' => 'string'],
'AlertTime' => ['type' => 'integer', 'format' => 'int64'],
'InstanceName' => ['type' => 'string'],
'Dimensions' => ['type' => 'string'],
'Level' => ['type' => 'string'],
'Id' => ['type' => 'string'],
'Contacts' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Contact' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
'ContactALIIMs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactALIIM' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
'ContactMails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactMail' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
'ContactSmses' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactSms' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
'ContactGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactGroup' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
204 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
206 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
406 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
409 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError ', 'errorMessage' => 'The request processing has failed due to some unknown error. '],
],
503 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
],
'responseDemo' => '',
],
'DescribeAlarms' => [
'summary' => 'DescribeAlarms',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'GroupBy',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'MetricName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'EnableState',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false],
],
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'AlertState',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Names',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'NameKeyword',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
'Code' => ['type' => 'integer', 'format' => 'int32'],
'Message' => ['type' => 'string'],
'TraceId' => ['type' => 'string'],
'Total' => ['type' => 'string'],
'Datapoints' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Alarm' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['type' => 'string'],
'MetricName' => ['type' => 'string'],
'EffectiveInterval' => ['type' => 'string'],
'NoEffectiveInterval' => ['type' => 'string'],
'ComparisonOperator' => ['type' => 'string'],
'Subject' => ['type' => 'string'],
'Dimensions' => ['type' => 'string'],
'Name' => ['type' => 'string'],
'Resources' => ['type' => 'string'],
'Threshold' => ['type' => 'string'],
'SilenceTime' => ['type' => 'string'],
'RuleType' => ['type' => 'string'],
'EvaluationCount' => ['type' => 'string'],
'Webhook' => ['type' => 'string'],
'State' => ['type' => 'string'],
'ContactGroups' => ['type' => 'string'],
'Namespace' => ['type' => 'string'],
'Period' => ['type' => 'string'],
'RuleName' => ['type' => 'string'],
'Uuid' => ['type' => 'string'],
'GroupId' => ['type' => 'string'],
'GroupName' => ['type' => 'string'],
'Level' => ['type' => 'string'],
'Enable' => ['type' => 'boolean'],
'Statistics' => ['type' => 'string'],
'Escalations' => [
'type' => 'object',
'properties' => [
'Info' => [
'type' => 'object',
'properties' => [
'ComparisonOperator' => ['type' => 'string'],
'PreCondition' => ['type' => 'string'],
'Times' => ['type' => 'string'],
'Threshold' => ['type' => 'string'],
'HistoryDataRange' => ['type' => 'string'],
'Statistics' => ['type' => 'string'],
'AlertSensitivity' => ['type' => 'string'],
],
],
'Warn' => [
'type' => 'object',
'properties' => [
'ComparisonOperator' => ['type' => 'string'],
'PreCondition' => ['type' => 'string'],
'Times' => ['type' => 'string'],
'Threshold' => ['type' => 'string'],
'HistoryDataRange' => ['type' => 'string'],
'Statistics' => ['type' => 'string'],
'AlertSensitivity' => ['type' => 'string'],
],
],
'Critical' => [
'type' => 'object',
'properties' => [
'ComparisonOperator' => ['type' => 'string'],
'PreCondition' => ['type' => 'string'],
'Times' => ['type' => 'string'],
'Threshold' => ['type' => 'string'],
'HistoryDataRange' => ['type' => 'string'],
'Statistics' => ['type' => 'string'],
'AlertSensitivity' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
206 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s'],
],
[
['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.'],
],
[
['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.'],
],
[
['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
406 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
409 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
429 => [
['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
503 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
],
'responseDemo' => '',
],
'DescribeAlarmsForResources' => [
'summary' => 'describealarmsforresources',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'MetricName',
'in' => 'query',
'schema' => ['description' => '云产品的监控项名称。', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization'],
],
[
'name' => 'EnableState',
'in' => 'query',
'schema' => ['description' => '报警规则的启用状态。取值:-true:启用。-false:禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '监控项的数据命名空间。', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组ID。', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => '分页页码。 '."\n"
."\n"
.'默认值:1 。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示记录条数。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
[
'name' => 'AlertState',
'in' => 'query',
'schema' => ['description' => '报警规则状态。取值:'."\n"
.'- OK:正常。'."\n"
.'- ALARM:报警。'."\n"
.'- INSUFFICIENT_DATA:无数据。', 'type' => 'string', 'required' => false, 'example' => 'OK'],
],
[
'name' => 'Dimensions',
'in' => 'query',
'schema' => ['description' => '维度Map,用于查询指定资源的监控数据。', 'type' => 'string', 'required' => true, 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', 'type' => 'string', 'example' => '50D4CFE1-01E5-4543-939C-18BC01E3EC1C'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
'Dimensions' => ['description' => '维度Map,用于查询指定资源的监控数据。', 'type' => 'string', 'example' => '{\\"instanceId\\":\\"i-bp1cqhiw1za2****\\"}'],
'Code' => ['description' => '状态码。'."\n"
."\n"
.'>200表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'TraceId' => ['description' => '调用链ID。', 'type' => 'string', 'example' => 'f1b83c3b-b6ea-4a4e-9087-b5752e7da052'],
'Total' => ['description' => '总记录数。', 'type' => 'string', 'example' => '22'],
'Datapoints' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Alarm' => [
'description' => '报警规则对象的数组。',
'type' => 'array',
'items' => [
'description' => '报警规则对象。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '告警规则显示名称。', 'type' => 'string', 'example' => '磁盘使用率'],
'SilenceTime' => ['description' => '通道沉默时间。单位:秒。', 'type' => 'string', 'example' => '3600'],
'MetricName' => ['description' => '监控项名称', 'type' => 'string', 'example' => 'CPUUtilization'],
'EvaluationCount' => ['description' => '连续探测几次都满足阈值条件时报警。', 'type' => 'string', 'example' => '3'],
'Webhook' => ['description' => '报警发生时回调指定的URL地址。', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=54df4b27524b232ac4f745d14a099a63555826c71fe108b2233b1c1cca51e5cb'],
'State' => ['description' => '报警状态。', 'type' => 'string', 'example' => 'OK'],
'ContactGroups' => ['description' => '报警联系人组。', 'type' => 'string', 'example' => 'Server'],
'Namespace' => ['description' => '云产品的命名空间。', 'type' => 'string', 'example' => 'platform-acs-fc-metrics'],
'NoEffectiveInterval' => ['description' => '报警规则不生效时间段。', 'type' => 'string', 'example' => '00:00-05:30'],
'EffectiveInterval' => ['description' => '报警规则的生效时间段。', 'type' => 'string', 'example' => '0:00-23:59'],
'Period' => ['description' => '监控数据的统计周期。', 'type' => 'string', 'example' => '60'],
'ComparisonOperator' => ['description' => 'Info级别阈值比较符。取值:'."\n"
."\n"
.'- GreaterThanOrEqualToThreshold:大于等于。'."\n"
.'- GreaterThanThreshold:大于。'."\n"
.'- LessThanOrEqualToThreshold:小于等于。'."\n"
.'- LessThanThreshold:小于。'."\n"
.'- NotEqualToThreshold:不等。'."\n"
.'- GreaterThanYesterday:同比昨天时间上涨。'."\n"
.'- LessThanYesterday:同比昨天时间下降。'."\n"
.'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n"
.'- LessThanLastWeek:同比上周同一时间下降。'."\n"
.'- GreaterThanLastPeriod:环比上周期上涨。'."\n"
.'- LessThanLastPeriod:环比上周期下降。', 'type' => 'string', 'example' => 'GreaterThanThreshold'],
'Uuid' => ['description' => '报警UUID。', 'type' => 'string', 'example' => 'abb18b9fc4ca45468a94763f24ddf898'],
'GroupName' => ['description' => '应用分组名称。', 'type' => 'string', 'example' => 'edgeah-3ce900a3617747dcbd49cd7ff752b32a-iot-1wdrsc-ReplicaSet-lvmonitor-gf9bs0jt0dwdjlad-d6f999676'],
'GroupId' => ['description' => '应用分组ID。', 'type' => 'string', 'example' => '239757988'],
'Subject' => ['description' => '告警标题', 'type' => 'string', 'example' => 'Alibaba Cloud'],
'Name' => ['description' => '报警名称。', 'type' => 'string', 'example' => 'Ecs_Mem_Utilization'],
'Threshold' => ['description' => '报警阈值。', 'type' => 'string', 'example' => '85'],
'Level' => ['description' => '报警级别。取值:'."\n"
.'- CRITICAL:严重。'."\n"
.'- WARN:警告。'."\n"
.'- INFO:信息。', 'type' => 'string', 'example' => 'CRITICAL'],
'Resources' => ['description' => '资源。', 'type' => 'string', 'example' => '[{\\"instanceId\\":\\"rmq-cn-o493nio5v0i\\",\\"userId\\":\\"1493622401794734\\"}]'],
'Statistics' => ['description' => 'Critical级别报警统计方法。'."\n"
."\n"
.'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n"
."\n"
.'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', 'type' => 'string', 'example' => 'Average'],
'Enable' => ['description' => '报警的启用状态。取值:'."\n"
."\n"
.'- true:启用。'."\n"
."\n"
.'- false:禁用。', 'type' => 'boolean', 'example' => 'true'],
'Escalations' => [
'description' => '告警升级配置。',
'type' => 'object',
'properties' => [
'Info' => [
'description' => 'Info级别告警。',
'type' => 'object',
'properties' => [
'ComparisonOperator' => ['description' => 'Info级别阈值比较符。取值:'."\n"
."\n"
.'- GreaterThanOrEqualToThreshold:大于等于。'."\n"
.'- GreaterThanThreshold:大于。'."\n"
.'- LessThanOrEqualToThreshold:小于等于。'."\n"
.'- LessThanThreshold:小于。'."\n"
.'- NotEqualToThreshold:不等于。'."\n"
.'- EqualToThreshold:等于。'."\n"
.'- GreaterThanYesterday:同比昨天时间上涨。'."\n"
.'- LessThanYesterday:同比昨天时间下降。'."\n"
.'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n"
.'- LessThanLastWeek:同比上周同一时间下降。'."\n"
.'- GreaterThanLastPeriod:环比上周期上涨。'."\n"
.'- LessThanLastPeriod:环比上周期下降。'."\n"
."\n"
.'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', 'type' => 'string', 'example' => 'GreaterThanThreshold'],
'Times' => ['description' => '发出报警通知需要达到报警条件的次数。', 'type' => 'string', 'example' => '3'],
'Threshold' => ['description' => 'Info级别的阈值。', 'type' => 'string', 'example' => '99'],
'Statistics' => ['description' => '报警统计方法。', 'type' => 'string', 'example' => 'Average'],
],
],
'Warn' => [
'description' => 'warn级别告警。',
'type' => 'object',
'properties' => [
'ComparisonOperator' => ['description' => 'Warn级别阈值的比较符。取值:'."\n"
."\n"
.'- GreaterThanOrEqualToThreshold:大于等于。'."\n"
.'- GreaterThanThreshold:大于。'."\n"
.'- LessThanOrEqualToThreshold:小于等于。'."\n"
.'- LessThanThreshold:小于。'."\n"
.'- NotEqualToThreshold:不等于。'."\n"
.'- GreaterThanYesterday:同比昨天时间上涨。'."\n"
.'- LessThanYesterday:同比昨天时间下降。'."\n"
.'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n"
.'- LessThanLastWeek:同比上周同一时间下降。'."\n"
.'- GreaterThanLastPeriod:环比上周期上涨。'."\n"
.'- LessThanLastPeriod:环比上周期下降。', 'type' => 'string', 'example' => 'LessThanOrEqualToThreshold'],
'Times' => ['description' => '发出报警通知需要达到报警条件的次数。', 'type' => 'string', 'example' => '3'],
'Threshold' => ['description' => 'warn级别的阈值。', 'type' => 'string', 'example' => '100'],
'Statistics' => ['description' => '报警统计方法。', 'type' => 'string', 'example' => 'Average'],
],
],
'Critical' => [
'description' => 'Critical级别的告警。',
'type' => 'object',
'properties' => [
'ComparisonOperator' => ['description' => '阈值比较符。取值:'."\n"
."\n"
.'- GreaterThanOrEqualToThreshold:大于等于。'."\n"
.'- GreaterThanThreshold:大于。'."\n"
.'- LessThanOrEqualToThreshold:小于等于。'."\n"
.'- LessThanThreshold:小于。'."\n"
.'- NotEqualToThreshold:不等于。'."\n"
.'- GreaterThanYesterday:同比昨天时间上涨。'."\n"
.'- LessThanYesterday:同比昨天时间下降。'."\n"
.'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n"
.'- LessThanLastWeek:同比上周同一时间下降。'."\n"
.'- GreaterThanLastPeriod:环比上周期上涨。'."\n"
.'- LessThanLastPeriod:环比上周期下降。', 'type' => 'string', 'example' => 'LessThanThreshold'],
'Times' => ['description' => '发出报警通知需要达到报警条件的次数。', 'type' => 'string', 'example' => '3'],
'Threshold' => ['description' => 'Critical级别的阈值。', 'type' => 'string', 'example' => '90'],
'Statistics' => ['description' => '报警统计方法。', 'type' => 'string', 'example' => 'Average'],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.'],
],
403 => [
['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50D4CFE1-01E5-4543-939C-18BC01E3EC1C\\",\\n \\"Success\\": true,\\n \\"Dimensions\\": \\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp1cqhiw1za2****\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"TraceId\\": \\"f1b83c3b-b6ea-4a4e-9087-b5752e7da052\\",\\n \\"Total\\": \\"22\\",\\n \\"Datapoints\\": {\\n \\"Alarm\\": [\\n {\\n \\"DisplayName\\": \\"磁盘使用率\\",\\n \\"SilenceTime\\": \\"3600\\",\\n \\"MetricName\\": \\"CPUUtilization\\",\\n \\"EvaluationCount\\": \\"3\\",\\n \\"Webhook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=54df4b27524b232ac4f745d14a099a63555826c71fe108b2233b1c1cca51e5cb\\",\\n \\"State\\": \\"OK\\",\\n \\"ContactGroups\\": \\"Server\\",\\n \\"Namespace\\": \\"platform-acs-fc-metrics\\",\\n \\"NoEffectiveInterval\\": \\"00:00-05:30\\",\\n \\"EffectiveInterval\\": \\"0:00-23:59\\",\\n \\"Period\\": \\"60\\",\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Uuid\\": \\"abb18b9fc4ca45468a94763f24ddf898\\",\\n \\"GroupName\\": \\"edgeah-3ce900a3617747dcbd49cd7ff752b32a-iot-1wdrsc-ReplicaSet-lvmonitor-gf9bs0jt0dwdjlad-d6f999676\\",\\n \\"GroupId\\": \\"239757988\\",\\n \\"Subject\\": \\"Alibaba Cloud\\",\\n \\"Name\\": \\"Ecs_Mem_Utilization\\",\\n \\"Threshold\\": \\"85\\",\\n \\"Level\\": \\"CRITICAL\\",\\n \\"Resources\\": \\"[{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rmq-cn-o493nio5v0i\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1493622401794734\\\\\\\\\\\\\\"}]\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Enable\\": true,\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"99\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"LessThanOrEqualToThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"100\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"LessThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取资源警报',
],
'DescribeAlertHistoryList' => [
'summary' => '查询报警历史详情',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AlertName',
'in' => 'query',
'schema' => ['description' => '报警名称。', 'type' => 'string', 'required' => false, 'example' => 'HighErrorRate'],
],
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['description' => '报警规则名称。', 'type' => 'string', 'required' => false, 'example' => 'ECS_Rule'],
],
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '命名空间。', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard'],
],
[
'name' => 'MetricName',
'in' => 'query',
'schema' => ['description' => '监控项名称。', 'type' => 'string', 'required' => false, 'example' => 'cpu_total'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组id。', 'type' => 'string', 'required' => false, 'example' => '35235226'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '通道沉默状态。取值:'."\n"
.'- 2(默认值):通道沉默。'."\n"
.'- 0:报警或恢复。'."\n"
.'- 1:失效期。', 'type' => 'string', 'required' => false, 'example' => '2'],
],
[
'name' => 'State',
'in' => 'query',
'schema' => ['description' => '报警状态。取值:'."\n"
.'- ALARM(默认值):报警状态。'."\n"
.'- OK:正常状态。', 'type' => 'string', 'required' => false, 'example' => 'ok'],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => ['description' => '时间排序。取值:true(默认值):表示时间倒序。false:表示时间正序。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'OnlyCount',
'in' => 'query',
'schema' => ['description' => '报警阈值是否满足条件。取值:-true:满足条件。-false:不满足条件。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询报警的开始时间。', 'type' => 'string', 'required' => false, 'example' => '1552209685596'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询报警的结束时间。', 'type' => 'string', 'required' => false, 'example' => '1640608200000'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => '页码。'."\n"
."\n"
.'默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'RequestId' => ['description' => '请求Id,用于排查问题', 'type' => 'string', 'example' => 'C3C69FBE-2262-541F-A409-C52F380BAE63'],
'Total' => ['description' => '总记录条数。', 'type' => 'string', 'example' => '2'],
'Success' => ['description' => '操作是否成功。true表示成功,false表示失败。', 'type' => 'boolean', 'example' => 'true'],
'AlarmHistoryList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AlarmHistory' => [
'description' => '告警历史列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '报警状态。', 'type' => 'integer', 'format' => 'int32', 'example' => 'stopped'],
'MetricName' => ['description' => '监控项名称', 'type' => 'string', 'example' => 'cpu_total'],
'EvaluationCount' => ['description' => '连续探测几次都满足阈值条件时报警。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'State' => ['description' => '报警状态。', 'type' => 'string', 'example' => 'Finished'],
'UserId' => ['description' => '用户id', 'type' => 'string', 'example' => 'xxxxxx'],
'PreLevel' => ['description' => '上次告警级别', 'type' => 'string', 'example' => 'NORMAL'],
'Namespace' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'acs_vpc_eip'],
'AlertName' => ['description' => '告警名称。', 'type' => 'string', 'example' => '测评内测-数据库慢调用-低'],
'Webhooks' => ['description' => '报警发生时,回调的URL地址', 'type' => 'string', 'example' => '[\\"https://oapi.dingtalk.com/robot/send?access_token=cca17c14bbc6b81b35fdc7caa19fdda531b659eee2969cc35a6362e3b2d10c13\\"]'],
'RuleName' => ['description' => '报警规则名称。', 'type' => 'string', 'example' => 'ecs 5分钟tcp连接数超过80%'],
'LastTime' => ['description' => '报警持续时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744597658'],
'Value' => ['description' => '报警模板的标签值。', 'type' => 'string', 'example' => 'Server=tes-rds.infra.uat.altium365.com.cn%3BDatabase=tenant_directory%3BUid=ciiva%3BPwd=ZJJ6xvd!WeUjaVjvHWLU%3BAutoEnlist=False%3BSSLMode=None%3B'],
'Expression' => ['description' => '表达式。', 'type' => 'string', 'example' => '1'],
'GroupId' => ['description' => '分组ID。', 'type' => 'string', 'example' => '239765677'],
'AlertTime' => ['description' => '发生报警的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1552209685596'],
'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'prd-sflocalizationapi-5855fd9d6d-8hhx9'],
'Dimensions' => ['description' => '维度。', 'type' => 'string', 'example' => '{\\"instanceId\\":\\"i-wz9fovee1h4jv7igaz8i\\"}'],
'Level' => ['description' => '报警级别。', 'type' => 'string', 'example' => 'NORMAL'],
'Id' => ['description' => '报警ID。', 'type' => 'string', 'example' => '3393FD4A10BD5723CD0DCFB4B25AC79928735672'],
'Contacts' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Contact' => [
'description' => '联系人列表',
'type' => 'array',
'items' => ['description' => '联系人', 'type' => 'string', 'example' => '185xxxx0307'],
],
],
],
'ContactALIIMs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactALIIM' => [
'description' => '阿里旺旺的联系人列表',
'type' => 'array',
'items' => ['description' => '联系人的阿里旺旺', 'type' => 'string', 'example' => 'seller001'],
],
],
],
'ContactMails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactMail' => [
'description' => '邮箱的联系人列表',
'type' => 'array',
'items' => ['description' => '联系人的邮箱', 'type' => 'string', 'example' => 'xxx@xxx.com'],
],
],
],
'ContactSmses' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactSms' => [
'description' => '短信的联系人列表',
'type' => 'array',
'items' => ['description' => '联系人的手机号', 'type' => 'string', 'example' => '185xxxx0307'],
],
],
],
'ContactGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactGroup' => [
'description' => '报警联系人组的列表。',
'type' => 'array',
'items' => ['description' => '报警联系人组。', 'type' => 'string', 'example' => '开发运维报警组'],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
204 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
206 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
406 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
409 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError ', 'errorMessage' => 'The request processing has failed due to some unknown error. '],
],
503 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C3C69FBE-2262-541F-A409-C52F380BAE63\\",\\n \\"Total\\": \\"2\\",\\n \\"Success\\": true,\\n \\"AlarmHistoryList\\": {\\n \\"AlarmHistory\\": [\\n {\\n \\"Status\\": 0,\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EvaluationCount\\": 3,\\n \\"State\\": \\"Finished\\",\\n \\"UserId\\": \\"xxxxxx\\",\\n \\"PreLevel\\": \\"NORMAL\\",\\n \\"Namespace\\": \\"acs_vpc_eip\\",\\n \\"AlertName\\": \\"测评内测-数据库慢调用-低\\",\\n \\"Webhooks\\": \\"[\\\\\\\\\\\\\\"https://oapi.dingtalk.com/robot/send?access_token=cca17c14bbc6b81b35fdc7caa19fdda531b659eee2969cc35a6362e3b2d10c13\\\\\\\\\\\\\\"]\\",\\n \\"RuleName\\": \\"ecs 5分钟tcp连接数超过80%\\",\\n \\"LastTime\\": 1744597658,\\n \\"Value\\": \\"Server=tes-rds.infra.uat.altium365.com.cn%3BDatabase=tenant_directory%3BUid=ciiva%3BPwd=ZJJ6xvd!WeUjaVjvHWLU%3BAutoEnlist=False%3BSSLMode=None%3B\\",\\n \\"Expression\\": \\"1\\",\\n \\"GroupId\\": \\"239765677\\",\\n \\"AlertTime\\": 1552209685596,\\n \\"InstanceName\\": \\"prd-sflocalizationapi-5855fd9d6d-8hhx9\\",\\n \\"Dimensions\\": \\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-wz9fovee1h4jv7igaz8i\\\\\\\\\\\\\\"}\\",\\n \\"Level\\": \\"NORMAL\\",\\n \\"Id\\": \\"3393FD4A10BD5723CD0DCFB4B25AC79928735672\\",\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n \\"185xxxx0307\\"\\n ]\\n },\\n \\"ContactALIIMs\\": {\\n \\"ContactALIIM\\": [\\n \\"seller001\\"\\n ]\\n },\\n \\"ContactMails\\": {\\n \\"ContactMail\\": [\\n \\"xxx@xxx.com\\"\\n ]\\n },\\n \\"ContactSmses\\": {\\n \\"ContactSms\\": [\\n \\"185xxxx0307\\"\\n ]\\n },\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"开发运维报警组\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询报警历史详情',
],
'DescribeContact' => [
'summary' => '描述联系人',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ContactName',
'in' => 'query',
'schema' => ['description' => '报警联系人姓名。', 'type' => 'string', 'required' => true, 'example' => 'SCRM报警群'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'RequestId' => ['description' => '请求Id,用于排查问题', 'type' => 'string', 'example' => '325232CF-6F24-513B-A55C-49B2071F72A3'],
'Success' => ['description' => '操作是否成功。取值:true:成功。false:失败。', 'type' => 'boolean', 'example' => 'true'],
'Datapoints' => [
'description' => '监控数据列表。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '报警联系人姓名。', 'type' => 'string', 'example' => 'hostName'],
'Channels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Channel' => [
'description' => '报警推送渠道。',
'type' => 'array',
'items' => [
'description' => '订阅渠道。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '订阅类型', 'type' => 'string', 'example' => 'SMS'],
'Value' => ['description' => '值。', 'type' => 'string', 'example' => 'SMS'],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.'],
],
403 => [
['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.'],
],
[
['errorCode' => 'InvalidAction', 'errorMessage' => 'The specified GroupName does not exist.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"325232CF-6F24-513B-A55C-49B2071F72A3\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": {\\n \\"Name\\": \\"hostName\\",\\n \\"Channels\\": {\\n \\"Channel\\": [\\n {\\n \\"Type\\": \\"SMS\\",\\n \\"Value\\": \\"SMS\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '获取联系人信息',
],
'DescribeISPAreaCity' => [
'summary' => '获取站点监控的探测点。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Isp',
'in' => 'query',
'schema' => ['description' => 'ISP名称或者Id', 'type' => 'string', 'required' => false, 'example' => '阿里巴巴'],
],
[
'name' => 'City',
'in' => 'query',
'schema' => ['description' => '过滤出对应城市的探测点:如:杭州', 'type' => 'string', 'required' => false, 'example' => '北京'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '错误码消息', 'type' => 'string', 'example' => 'successful'],
'Data' => ['description' => '返回信息', 'type' => 'string', 'example' => '[{\\"area\\":\\"华北\\",\\"areaCode\\":\\"159\\",\\"city\\":\\"呼和浩特市\\",\\"cityCode\\":\\"676\\",\\"cityIspCode\\":{\\"city\\":\\"676\\",\\"isp\\":\\"465\\"},\\"country\\":\\"中国\\",\\"countryCode\\":\\"629\\",\\"discard_count\\":0,\\"healthy\\":100,\\"idc_probe_count\\":2,\\"isp\\":\\"阿里巴巴\\",\\"ispCode\\":\\"465\\",\\"luyoubao_probe_count\\":0,\\"push_count\\":91093,\\"region\\":\\"内蒙古自治区\\",\\"regionCode\\":\\"87\\",\\"reportHealthy\\":100,\\"report_count\\":91136,\\"timestamp\\":1544609400716,\\"total_probe_count\\":2,\\"win_probe_count\\":0}]'],
'RequestId' => ['description' => '请求Id,用于排查问题', 'type' => 'string', 'example' => '84C8BA48-7FD3-46F8-AEE3-E24657C22289'],
'Success' => ['description' => '用于标识本次调用是否成功', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"area\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"华北\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"areaCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"159\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"呼和浩特市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"676\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityIspCode\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"676\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"country\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"中国\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"countryCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"629\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"discard_count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"healthy\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"idc_probe_count\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"阿里巴巴\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"luyoubao_probe_count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"push_count\\\\\\\\\\\\\\":91093,\\\\\\\\\\\\\\"region\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"内蒙古自治区\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"regionCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"87\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"reportHealthy\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"report_count\\\\\\\\\\\\\\":91136,\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1544609400716,\\\\\\\\\\\\\\"total_probe_count\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"win_probe_count\\\\\\\\\\\\\\":0}]\\",\\n \\"RequestId\\": \\"84C8BA48-7FD3-46F8-AEE3-E24657C22289\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取探测点列表',
'description' => '查询站点监控支持的探测点',
],
'DescribeMetricRuleList' => [
'summary' => '查询报警规则列表',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'MetricName',
'in' => 'query',
'schema' => ['description' => '监控项名称。', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization'],
],
[
'name' => 'EnableState',
'in' => 'query',
'schema' => ['description' => '报警规则的启用状态。取值:'."\n"
.'- true:启用。'."\n"
.'- false:禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '云产品的命名空间。', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard'],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => '页码。'."\n"
."\n"
.'起始值:1。默认值:1。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示记录条数。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
[
'name' => 'AlertState',
'in' => 'query',
'schema' => ['description' => '报警规则状态。取值:'."\n"
.'- OK:正常。'."\n"
.'- ALARM:报警。'."\n"
.'- INSUFFICIENT_DATA:无数据。', 'type' => 'string', 'required' => false, 'example' => 'OK'],
],
[
'name' => 'Dimensions',
'in' => 'query',
'schema' => ['description' => '报警规则维度。', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]'],
],
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['description' => '报警规则名称。'."\n"
."\n"
.'该参数支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'ECS_CPU_Alarm'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组id。', 'type' => 'string', 'required' => false, 'example' => 'group-1234567890'],
],
[
'name' => 'RuleIds',
'in' => 'query',
'schema' => ['description' => '报警规则id列表。', 'type' => 'string', 'required' => false, 'example' => 'rule-1234567890,rule-2345678901'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'RequestId' => ['description' => '请求Id,用于排查问题', 'type' => 'string', 'example' => '386C6712-335F-5054-930A-CC92B851ECBA'],
'Total' => ['description' => '总记录条数。', 'type' => 'string', 'example' => '96'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
'Alarms' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Alarm' => [
'description' => '报警规则对象的数组。',
'type' => 'array',
'items' => [
'description' => '报警规则对象。',
'type' => 'object',
'properties' => [
'SilenceTime' => ['description' => '通知静默时间', 'type' => 'string', 'example' => '3600'],
'MetricName' => ['description' => '监控项名称。', 'type' => 'string', 'example' => 'Availability'],
'Webhook' => ['description' => '报警发生回调时指定的URL地址。', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=54df4b27524b232ac4f745d14a099a63555826c71fe108b2233b1c1cca51e5cb'],
'ContactGroups' => ['description' => '报警联系人组。', 'type' => 'string', 'example' => 'test_monitor'],
'SourceType' => ['description' => '告警来源类型。', 'type' => 'string', 'example' => 'ecs'],
'Namespace' => ['description' => '云产品的命名空间。', 'type' => 'string', 'example' => 'acs_ecs_dashboard'],
'MailSubject' => ['description' => '邮件主题。', 'type' => 'string', 'example' => 'ECS CPU excessive usage rate'],
'NoEffectiveInterval' => ['description' => '报警不生效的时间段。', 'type' => 'string', 'example' => '00:00-05:30'],
'EffectiveInterval' => ['description' => '报警规则的生效时间段。', 'type' => 'string', 'example' => '10:00-18:59'],
'RuleName' => ['description' => '报警规则名称。', 'type' => 'string', 'example' => 'DefaultEventRule'],
'AlertState' => ['description' => '报警规则状态。取值:'."\n"
."\n"
.'- OK:正常。'."\n"
."\n"
.'- ALARM:报警。'."\n"
."\n"
.'- INSUFFICIENT_DATA:无数据。', 'type' => 'string', 'example' => 'OK'],
'Period' => ['description' => '监控数据的统计周期。'."\n"
.'单位:秒。', 'type' => 'string', 'example' => '60'],
'RuleId' => ['description' => '报警规则ID。', 'type' => 'string', 'example' => 'rule-1234567890'],
'GroupName' => ['description' => '告警组名称。', 'type' => 'string', 'example' => 'ops_group'],
'GroupId' => ['description' => '告警组 ID。', 'type' => 'string', 'example' => 'group-1234567890'],
'Dimensions' => ['description' => '资源维度信息。', 'type' => 'string', 'example' => '{\'instanceId\': \'ts-2ze34h60m9pv0ck3v\'}'],
'EnableState' => ['description' => '报警规则的启用状态。取值:'."\n"
."\n"
.'- true:启用。'."\n"
."\n"
.'- false:禁用。', 'type' => 'boolean', 'example' => 'true'],
'Resources' => ['description' => '资源名称', 'type' => 'string', 'example' => '[{\\"instanceId\\": \\"i-bp17raa25u0rbg9xreti\\"}]'],
'Escalations' => [
'description' => '告警升级策略对象。',
'type' => 'object',
'properties' => [
'Info' => [
'description' => 'Info级别对象。',
'type' => 'object',
'properties' => [
'ComparisonOperator' => ['description' => 'Info级别阈值比较符。取值:'."\n"
."\n"
.'- GreaterThanOrEqualToThreshold:大于等于。'."\n"
.'- GreaterThanThreshold:大于。'."\n"
.'- LessThanOrEqualToThreshold:小于等于。'."\n"
.'- LessThanThreshold:小于。'."\n"
.'- NotEqualToThreshold:不等于。'."\n"
.'- EqualToThreshold:等于。'."\n"
.'- GreaterThanYesterday:同比昨天时间上涨。'."\n"
.'- LessThanYesterday:同比昨天时间下降。'."\n"
.'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n"
.'- LessThanLastWeek:同比上周同一时间下降。'."\n"
.'- GreaterThanLastPeriod:环比上周期上涨。'."\n"
.'- LessThanLastPeriod:环比上周期下降。'."\n"
."\n"
.'N的取值范围:1~50。'."\n"
."\n"
.'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', 'type' => 'string', 'example' => 'GreaterThanThreshold'],
'Times' => ['description' => '发出报警通知需要达到报警条件的次数。', 'type' => 'string', 'example' => '3'],
'Threshold' => ['description' => '报警阈值。'."\n"
.' ', 'type' => 'string', 'example' => '80'],
'Statistics' => ['description' => 'Info级别报警统计方法。'."\n"
."\n"
.'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n"
."\n"
.'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', 'type' => 'string', 'example' => 'Average'],
],
],
'Warn' => [
'description' => 'Warn级别对象。',
'type' => 'object',
'properties' => [
'ComparisonOperator' => ['description' => 'Warn级别阈值比较符。取值:'."\n"
."\n"
.'- GreaterThanOrEqualToThreshold:大于等于。'."\n"
.'- GreaterThanThreshold:大于。'."\n"
.'- LessThanOrEqualToThreshold:小于等于。'."\n"
.'- LessThanThreshold:小于。'."\n"
.'- NotEqualToThreshold:不等。'."\n"
.'- GreaterThanYesterday:同比昨天时间上涨。'."\n"
.'- LessThanYesterday:同比昨天时间下降。'."\n"
.'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n"
.'- LessThanLastWeek:同比上周同一时间下降。'."\n"
.'- GreaterThanLastPeriod:环比上周期上涨。'."\n"
.'- LessThanLastPeriod:环比上周期下降。', 'type' => 'string', 'example' => 'NotEqualToThreshold'],
'Times' => ['description' => '发出报警通知需要达到报警条件的次数。', 'type' => 'string', 'example' => '3'],
'Threshold' => ['description' => '报警阈值。', 'type' => 'string', 'example' => '70'],
'Statistics' => ['description' => 'Warn级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。'."\n"
."\n"
.'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。', 'type' => 'string', 'example' => 'Average'],
],
],
'Critical' => [
'description' => 'Critical级别对象。',
'type' => 'object',
'properties' => [
'ComparisonOperator' => ['description' => 'Critical级别阈值比较符。取值:'."\n"
."\n"
.'- GreaterThanOrEqualToThreshold:大于等于。'."\n"
.'- GreaterThanThreshold:大于。'."\n"
.'- LessThanOrEqualToThreshold:小于等于。'."\n"
.'- LessThanThreshold:小于。'."\n"
.'- NotEqualToThreshold:不等。'."\n"
.'- GreaterThanYesterday:同比昨天时间上涨。'."\n"
.'- LessThanYesterday:同比昨天时间下降。'."\n"
.'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n"
.'- LessThanLastWeek:同比上周同一时间下降。'."\n"
.'- GreaterThanLastPeriod:环比上周期上涨。'."\n"
.'- LessThanLastPeriod:环比上周期下降。', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold'],
'Times' => ['description' => '发出报警通知需要达到报警条件的次数。', 'type' => 'string', 'example' => '3'],
'Threshold' => ['description' => '报警阈值。', 'type' => 'string', 'example' => '85'],
'Statistics' => ['description' => 'Critical级别报警统计方法。'."\n"
."\n"
.'N的取值范围:1~50。'."\n"
."\n"
.'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n"
."\n"
.'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', 'type' => 'string', 'example' => 'Average'],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.'],
],
403 => [
['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"386C6712-335F-5054-930A-CC92B851ECBA\\",\\n \\"Total\\": \\"96\\",\\n \\"Success\\": true,\\n \\"Alarms\\": {\\n \\"Alarm\\": [\\n {\\n \\"SilenceTime\\": \\"3600\\",\\n \\"MetricName\\": \\"Availability\\",\\n \\"Webhook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=54df4b27524b232ac4f745d14a099a63555826c71fe108b2233b1c1cca51e5cb\\",\\n \\"ContactGroups\\": \\"test_monitor\\",\\n \\"SourceType\\": \\"ecs\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"MailSubject\\": \\"ECS CPU excessive usage rate\\",\\n \\"NoEffectiveInterval\\": \\"00:00-05:30\\",\\n \\"EffectiveInterval\\": \\"10:00-18:59\\",\\n \\"RuleName\\": \\"DefaultEventRule\\",\\n \\"AlertState\\": \\"OK\\",\\n \\"Period\\": \\"60\\",\\n \\"RuleId\\": \\"rule-1234567890\\",\\n \\"GroupName\\": \\"ops_group\\",\\n \\"GroupId\\": \\"group-1234567890\\",\\n \\"Dimensions\\": \\"{\'instanceId\': \'ts-2ze34h60m9pv0ck3v\'}\\",\\n \\"EnableState\\": true,\\n \\"Resources\\": \\"[{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"i-bp17raa25u0rbg9xreti\\\\\\\\\\\\\\"}]\\",\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"80\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"NotEqualToThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"70\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"85\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询报警规则列表',
],
'DescribeTaskDetail' => [
'summary' => '查询指定任务的配置详情。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '站点监控的任务Id,任务的唯一标识', 'type' => 'string', 'required' => true, 'example' => '339e0d96-2505-425f-a5c6-22e2c12f8fee', 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '错误码消息', 'type' => 'string', 'example' => '请求成功'],
'Data' => ['description' => '返回信息', 'type' => 'string', 'example' => '{\\"taskType\\":1,\\"address\\":\\"http://www.aliyun.com\\",\\"taskState\\":1,\\"ispCity\\":[{\\"city\\":\\"杭州市\\",\\"ispCode\\":\\"465\\",\\"cityCode\\":\\"546\\",\\"isp\\":\\"阿里巴巴\\",\\"citySpell\\":\\"hang2zhou1shi4\\",\\"ispSpell\\":\\"a1li3ba1ba1\\"},{\\"city\\":\\"青岛市\\",\\"ispCode\\":\\"465\\",\\"cityCode\\":\\"572\\",\\"isp\\":\\"阿里巴巴\\",\\"citySpell\\":\\"qing1dao3shi4\\",\\"ispSpell\\":\\"a1li3ba1ba1\\"},{\\"city\\":\\"北京市\\",\\"ispCode\\":\\"465\\",\\"cityCode\\":\\"738\\",\\"isp\\":\\"阿里巴巴\\",\\"citySpell\\":\\"bei3jing1shi4\\",\\"ispSpell\\":\\"a1li3ba1ba1\\"}],\\"alarms\\":[],\\"options\\":{\\"http_method\\":\\"get\\",\\"time_out\\":30000},\\"taskName\\":\\"江米测试2\\",\\"interval\\":1,\\"taskTypeName\\":\\"Http\\",\\"taskId\\":\\"339e0d96-2505-425f-a5c6-22e2c12f8fee\\"}"'],
'RequestId' => ['description' => '请求Id,用于排查问题', 'type' => 'string', 'example' => 'a4e6f550-7eac-4a13-b11f-6742aa2d42d1'],
'Success' => ['description' => '用于标识本次调用是否成功', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
615 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'Task Id does not exist'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Data\\": \\"{\\\\\\\\\\\\\\"taskType\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"address\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://www.aliyun.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskState\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"ispCity\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"杭州市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"546\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"阿里巴巴\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"citySpell\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"hang2zhou1shi4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispSpell\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"a1li3ba1ba1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"青岛市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"572\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"阿里巴巴\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"citySpell\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"qing1dao3shi4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispSpell\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"a1li3ba1ba1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"北京市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"738\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"阿里巴巴\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"citySpell\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bei3jing1shi4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispSpell\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"a1li3ba1ba1\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"alarms\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"options\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"http_method\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"get\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"time_out\\\\\\\\\\\\\\":30000},\\\\\\\\\\\\\\"taskName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"江米测试2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"interval\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"taskTypeName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Http\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"339e0d96-2505-425f-a5c6-22e2c12f8fee\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"RequestId\\": \\"a4e6f550-7eac-4a13-b11f-6742aa2d42d1\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '查询任务详情',
'description' => '查询指定任务的配置详情',
],
'DescribeTasks' => [
'summary' => '查询站点监控的任务列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '站点监控的任务Id,任务的唯一标识', 'type' => 'string', 'required' => false, 'example' => '18b0c27f-bab3-441d-a747-9cdcaa8bbac8'],
],
[
'name' => 'TaskType',
'in' => 'query',
'schema' => ['description' => '任务的类型,取值分别为1-8,各个值代表的如下 1.HTTP 2.PING 3.TCP 4.UDP 5.DNS 6.SMTP 7.POP3 8.FTP', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => ['description' => '要搜索的关键词,模糊查询监控监控点名称和地址', 'type' => 'string', 'required' => false, 'example' => '阿里云'],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => '页码,默认值为1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示记录条数,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '返回信息', 'type' => 'string', 'example' => '[{\\"shared\\":false,\\"taskType\\":1,\\"address\\":\\"http://www.aliyunq.com\\",\\"taskState\\":1,\\"createTime\\":\\"2018-04-01 16:46:53\\",\\"options\\":{\\"http_method\\":\\"get\\",\\"match_rule\\":0,\\"time_out\\":30000},\\"taskName\\":\\"站点监控demo\\",\\"interval\\":1,\\"taskTypeName\\":\\"Http\\",\\"taskId\\":\\"18b0c27f-bab3-441d-a747-9cdcaa8bbac8\\",\\"ts\\":\\"2018-12-12 15:55:12\\"}]'],
'RequestId' => ['description' => '请求Id,用于排查问题', 'type' => 'string', 'example' => '6A46B8E4-D39E-4DB5-B422-231410654E8E'],
'Success' => ['description' => '用于标识本次调用是否成功', 'type' => 'string', 'example' => 'true'],
'Code' => ['description' => '状态码', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '错误码消息', 'type' => 'string', 'example' => '请求成功'],
'PageSize' => ['description' => '分页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageNumber' => ['description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '14'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"shared\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"taskType\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"address\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://www.aliyunq.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskState\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"createTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2018-04-01 16:46:53\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"options\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"http_method\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"get\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"match_rule\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"time_out\\\\\\\\\\\\\\":30000},\\\\\\\\\\\\\\"taskName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"站点监控demo\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"interval\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"taskTypeName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Http\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"18b0c27f-bab3-441d-a747-9cdcaa8bbac8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ts\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2018-12-12 15:55:12\\\\\\\\\\\\\\"}]\\",\\n \\"RequestId\\": \\"6A46B8E4-D39E-4DB5-B422-231410654E8E\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 14\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '查询指定任务对应的信息',
'description' => '查询所有站点监控任务',
],
'DisableAlarm' => [
'summary' => '禁用报警规则。报警规则停止后,将停止探测关联实例的监控项数据。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '报警规则的id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求失败状态码,200为成功,非200为失败。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求失败的提示信息。', 'type' => 'string', 'example' => 'Success'],
'RequestId' => ['description' => '请求的uuid,便于查询日志。', 'type' => 'string', 'example' => 'DEF01F10-E747-42FE-9152-85CB43B1B552'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"DEF01F10-E747-42FE-9152-85CB43B1B552\\",\\n \\"Success\\": true\\n}","errorExample":"{\\n \\"RequestId\\": \\"DEF01F10-E747-42FE-9152-85CB43B1B552\\", \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\"\\n}"},{"type":"xml","example":"\\n CF9F20A2-D4CF-4FA0-B8A3-1F4C151B3C91\\n true\\n 200\\n","errorExample":"\\n CF9F20A2-D4CF-4FA0-B8A3-1F4C151B3C91\\n true\\n 200\\n"}]',
'title' => '禁用报警规则',
'description' => '报警规则停止后,将停止探测关联实例的监控项数据。',
],
'EnableAlarm' => [
'summary' => '启动报警规则。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '报警规则的id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求失败状态码,200为成功,非200为失败', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求失败的提示信息', 'type' => 'string', 'example' => 'Success'],
'RequestId' => ['description' => '请求的uuid,便于查询日志', 'type' => 'string', 'example' => '1C5E0E5D-76D5-469C-9FA8-D74799B24860'],
'Success' => ['description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"1C5E0E5D-76D5-469C-9FA8-D74799B24860\\",\\n \\"Success\\": true\\n}","errorExample":"{\\n \\"RequestId\\": \\"1C5E0E5D-76D5-469C-9FA8-D74799B24860\\", \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\"\\n}"},{"type":"xml","example":"\\n 1B77FA9C-4E5A-4DF9-82CB-0E898C9FDA2F\\n true\\n 200\\n","errorExample":"\\n 1B77FA9C-4E5A-4DF9-82CB-0E898C9FDA2F\\n true\\n 200\\n"}]',
'title' => '启用报警规则',
'description' => '当您的报警规则处于停止状态时,可以使用此接口启用报警规则。',
],
'GetContacts' => [
'summary' => '获取联系人',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '报警联系人组名称。', 'type' => 'string', 'required' => true, 'example' => 'rabb'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'http状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'RequestId' => ['description' => '请求Id,用于排查问题', 'type' => 'string', 'example' => 'FF66C10B-AA35-58FD-BD30-8CE1B275BA44'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
.'* true:成功。'."\n"
.'* false:失败。', 'type' => 'boolean', 'example' => 'true'],
'Datapoints' => [
'description' => '数据点。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'rabb'],
'Contacts' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Contact' => [
'description' => '联系人列表',
'type' => 'array',
'items' => ['description' => '联系人。', 'type' => 'string', 'example' => '188xxxx7155'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.'],
],
403 => [
['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"FF66C10B-AA35-58FD-BD30-8CE1B275BA44\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": {\\n \\"Name\\": \\"rabb\\",\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n \\"188xxxx7155\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '获取联系人',
],
'GetMonitoringTemplate' => [
'summary' => '获取监视模板',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '监控模板名称。', 'type' => 'string', 'required' => false, 'example' => 'ft20180308_templateNameFail'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '监控模板ID。', 'type' => 'string', 'required' => false, 'example' => '2203505'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'InstanceIds is mandatory for this action.'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '578B4400-4EF1-5A73-90A1-2EDE29B781AD'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '状态码,200为成功,非200为失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Resource' => [
'description' => '模版资源信息',
'type' => 'object',
'properties' => [
'Description' => ['description' => '模板描述。', 'type' => 'string', 'example' => 'ECS模板'],
'SystemEventTemplates' => ['description' => '系统事件模板。', 'type' => 'string', 'example' => '[{"alertName":"WAF_Event","description":"WAF_Event","eventPattern":{"eventType":["*"],"levelList":["*"],"nameList":["*"],"product":"waf"},"fcParameterList":[],"mnsParameterList":[],"notifyLevel":3,"slsParameterList":[],"webhookParameterList":[]}]'],
'AlertTemplatesJson' => ['description' => '报警模版。', 'type' => 'string', 'example' => '{"rds":[{"displayName":"rds_rule_1111","category":"rds","namespace":"acs_rds_dashboard","metricName":"CpuUsage","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"99","times":3},"warn":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"98","times":3}}}],"ecs":[{"displayName":"ecs_rule1111","category":"ecs","namespace":"acs_ecs_dashboard","metricName":"cpu_total","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"99","times":5}}},{"displayName":"ecs_rule2222","category":"ecs","namespace":"acs_ecs_dashboard","metricName":"cpu_idle","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"9999","times":3},"warn":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"89","times":4}}}],"mongodb":[{"displayName":"mongodb11","category":"mongodb","namespace":"acs_mongodb","metricName":"CPUUtilization","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"11111","times":3}}}],"mongodb_cluster":[{"displayName":"mongodb_cluster_t1","category":"mongodb_cluster","namespace":"acs_mongodb","metricName":"ShardingQPS","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"9999999","times":3}}}]}'],
'Namespace' => ['description' => '模板命名空间,语义同metric master对外开放的命名空间。', 'type' => 'string', 'example' => 'acs_ecs_dashboard'],
'ProcessMonitorTemplates' => ['description' => '进程监控模板', 'type' => 'string', 'example' => '[{"alert":{"comparisonOperator":"LessThanThreshold","escalationsLevel":"critical","silenceTime":0,"statistics":"Average","templateAlert":false,"threshold":"2","times":1},"matchExpress":{"filterRelation":"and","filters":[{"function":"all","name":"name","value":"*"}]},"processName":"FineBI"}]'],
'HostAvailabilityTemplate' => ['description' => '可用性监控模板', 'type' => 'string', 'example' => '[{"alert":{"escalationList":[{"aggregate":"Value","metric":"TelnetStatus","operator":">","times":3,"value":"400"},{"aggregate":"Average","metric":"TelnetLatency","operator":">","times":3,"value":"500"}],"notifyType":1,"silenceTime":86400},"taskName":"telnet","taskOption":{"method":"HEAD","negative":true,"resposeCharset":"utf-8","uri":"telnet://xxx.com"},"taskType":"TELNET"},{"alert":{"escalationList":[{"aggregate":"Value","metric":"TelnetStatus","operator":">","times":3,"value":"400"},{"aggregate":"Average","metric":"TelnetLatency","operator":">","times":3,"value":"500"}],"notifyType":1,"silenceTime":86400},"taskName":"bbbbbbbbbb","taskOption":{"method":"HEAD","negative":true,"resposeCharset":"utf-8","uri":"telnet://xxx.com"},"taskType":"TELNET"}]'],
'RestVersion' => ['description' => '数据版本号', 'type' => 'string', 'example' => '1'],
'Name' => ['description' => '模版名称', 'type' => 'string', 'example' => 'ECS_Template1'],
'Id' => ['description' => '模版ID', 'type' => 'string', 'example' => '123'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"InstanceIds is mandatory for this action.\\",\\n \\"RequestId\\": \\"578B4400-4EF1-5A73-90A1-2EDE29B781AD\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"Resource\\": {\\n \\"Description\\": \\"ECS模板\\",\\n \\"SystemEventTemplates\\": \\"[{\\\\\\"alertName\\\\\\":\\\\\\"WAF_Event\\\\\\",\\\\\\"description\\\\\\":\\\\\\"WAF_Event\\\\\\",\\\\\\"eventPattern\\\\\\":{\\\\\\"eventType\\\\\\":[\\\\\\"*\\\\\\"],\\\\\\"levelList\\\\\\":[\\\\\\"*\\\\\\"],\\\\\\"nameList\\\\\\":[\\\\\\"*\\\\\\"],\\\\\\"product\\\\\\":\\\\\\"waf\\\\\\"},\\\\\\"fcParameterList\\\\\\":[],\\\\\\"mnsParameterList\\\\\\":[],\\\\\\"notifyLevel\\\\\\":3,\\\\\\"slsParameterList\\\\\\":[],\\\\\\"webhookParameterList\\\\\\":[]}]\\",\\n \\"AlertTemplatesJson\\": \\"{\\\\\\"rds\\\\\\":[{\\\\\\"displayName\\\\\\":\\\\\\"rds_rule_1111\\\\\\",\\\\\\"category\\\\\\":\\\\\\"rds\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"acs_rds_dashboard\\\\\\",\\\\\\"metricName\\\\\\":\\\\\\"CpuUsage\\\\\\",\\\\\\"selector\\\\\\":{},\\\\\\"escalations\\\\\\":{\\\\\\"critical\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"99\\\\\\",\\\\\\"times\\\\\\":3},\\\\\\"warn\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"98\\\\\\",\\\\\\"times\\\\\\":3}}}],\\\\\\"ecs\\\\\\":[{\\\\\\"displayName\\\\\\":\\\\\\"ecs_rule1111\\\\\\",\\\\\\"category\\\\\\":\\\\\\"ecs\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"acs_ecs_dashboard\\\\\\",\\\\\\"metricName\\\\\\":\\\\\\"cpu_total\\\\\\",\\\\\\"selector\\\\\\":{},\\\\\\"escalations\\\\\\":{\\\\\\"critical\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"99\\\\\\",\\\\\\"times\\\\\\":5}}},{\\\\\\"displayName\\\\\\":\\\\\\"ecs_rule2222\\\\\\",\\\\\\"category\\\\\\":\\\\\\"ecs\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"acs_ecs_dashboard\\\\\\",\\\\\\"metricName\\\\\\":\\\\\\"cpu_idle\\\\\\",\\\\\\"selector\\\\\\":{},\\\\\\"escalations\\\\\\":{\\\\\\"critical\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"9999\\\\\\",\\\\\\"times\\\\\\":3},\\\\\\"warn\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"89\\\\\\",\\\\\\"times\\\\\\":4}}}],\\\\\\"mongodb\\\\\\":[{\\\\\\"displayName\\\\\\":\\\\\\"mongodb11\\\\\\",\\\\\\"category\\\\\\":\\\\\\"mongodb\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"acs_mongodb\\\\\\",\\\\\\"metricName\\\\\\":\\\\\\"CPUUtilization\\\\\\",\\\\\\"selector\\\\\\":{},\\\\\\"escalations\\\\\\":{\\\\\\"critical\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"11111\\\\\\",\\\\\\"times\\\\\\":3}}}],\\\\\\"mongodb_cluster\\\\\\":[{\\\\\\"displayName\\\\\\":\\\\\\"mongodb_cluster_t1\\\\\\",\\\\\\"category\\\\\\":\\\\\\"mongodb_cluster\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"acs_mongodb\\\\\\",\\\\\\"metricName\\\\\\":\\\\\\"ShardingQPS\\\\\\",\\\\\\"selector\\\\\\":{},\\\\\\"escalations\\\\\\":{\\\\\\"critical\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"9999999\\\\\\",\\\\\\"times\\\\\\":3}}}]}\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"ProcessMonitorTemplates\\": \\"[{\\\\\\"alert\\\\\\":{\\\\\\"comparisonOperator\\\\\\":\\\\\\"LessThanThreshold\\\\\\",\\\\\\"escalationsLevel\\\\\\":\\\\\\"critical\\\\\\",\\\\\\"silenceTime\\\\\\":0,\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"templateAlert\\\\\\":false,\\\\\\"threshold\\\\\\":\\\\\\"2\\\\\\",\\\\\\"times\\\\\\":1},\\\\\\"matchExpress\\\\\\":{\\\\\\"filterRelation\\\\\\":\\\\\\"and\\\\\\",\\\\\\"filters\\\\\\":[{\\\\\\"function\\\\\\":\\\\\\"all\\\\\\",\\\\\\"name\\\\\\":\\\\\\"name\\\\\\",\\\\\\"value\\\\\\":\\\\\\"*\\\\\\"}]},\\\\\\"processName\\\\\\":\\\\\\"FineBI\\\\\\"}]\\",\\n \\"HostAvailabilityTemplate\\": \\"[{\\\\\\"alert\\\\\\":{\\\\\\"escalationList\\\\\\":[{\\\\\\"aggregate\\\\\\":\\\\\\"Value\\\\\\",\\\\\\"metric\\\\\\":\\\\\\"TelnetStatus\\\\\\",\\\\\\"operator\\\\\\":\\\\\\">\\\\\\",\\\\\\"times\\\\\\":3,\\\\\\"value\\\\\\":\\\\\\"400\\\\\\"},{\\\\\\"aggregate\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"metric\\\\\\":\\\\\\"TelnetLatency\\\\\\",\\\\\\"operator\\\\\\":\\\\\\">\\\\\\",\\\\\\"times\\\\\\":3,\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"}],\\\\\\"notifyType\\\\\\":1,\\\\\\"silenceTime\\\\\\":86400},\\\\\\"taskName\\\\\\":\\\\\\"telnet\\\\\\",\\\\\\"taskOption\\\\\\":{\\\\\\"method\\\\\\":\\\\\\"HEAD\\\\\\",\\\\\\"negative\\\\\\":true,\\\\\\"resposeCharset\\\\\\":\\\\\\"utf-8\\\\\\",\\\\\\"uri\\\\\\":\\\\\\"telnet://xxx.com\\\\\\"},\\\\\\"taskType\\\\\\":\\\\\\"TELNET\\\\\\"},{\\\\\\"alert\\\\\\":{\\\\\\"escalationList\\\\\\":[{\\\\\\"aggregate\\\\\\":\\\\\\"Value\\\\\\",\\\\\\"metric\\\\\\":\\\\\\"TelnetStatus\\\\\\",\\\\\\"operator\\\\\\":\\\\\\">\\\\\\",\\\\\\"times\\\\\\":3,\\\\\\"value\\\\\\":\\\\\\"400\\\\\\"},{\\\\\\"aggregate\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"metric\\\\\\":\\\\\\"TelnetLatency\\\\\\",\\\\\\"operator\\\\\\":\\\\\\">\\\\\\",\\\\\\"times\\\\\\":3,\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"}],\\\\\\"notifyType\\\\\\":1,\\\\\\"silenceTime\\\\\\":86400},\\\\\\"taskName\\\\\\":\\\\\\"bbbbbbbbbb\\\\\\",\\\\\\"taskOption\\\\\\":{\\\\\\"method\\\\\\":\\\\\\"HEAD\\\\\\",\\\\\\"negative\\\\\\":true,\\\\\\"resposeCharset\\\\\\":\\\\\\"utf-8\\\\\\",\\\\\\"uri\\\\\\":\\\\\\"telnet://xxx.com\\\\\\"},\\\\\\"taskType\\\\\\":\\\\\\"TELNET\\\\\\"}]\\",\\n \\"RestVersion\\": \\"1\\",\\n \\"Name\\": \\"ECS_Template1\\",\\n \\"Id\\": \\"123\\"\\n }\\n}","type":"json"}]',
'title' => '获取监视模板',
],
'GetMyGroups' => [
'summary' => '获取个人应用分组',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '应用分组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '239765766'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => '应用分组类型。取值:'."\n"
.'- custom:自建的应用分组。'."\n"
.'- ehpc_cluster:从EHPC集群同步的应用分组。', 'type' => 'string', 'required' => false, 'example' => 'custom'],
],
[
'name' => 'SelectContactGroups',
'in' => 'query',
'schema' => ['description' => '是否返回报警联系组。取值:-true:是。-false(默认值):否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'i-hp3hl3cx1pbahzy8****'],
],
[
'name' => 'BindUrl',
'in' => 'query',
'schema' => ['description' => '绑定URL', 'type' => 'string', 'required' => false, 'example' => 'ehpc://i-dadfasdf/Login'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '应用分组名称。', 'type' => 'string', 'required' => false, 'example' => 'abc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Success'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ECA294F7-7408-5069-B260-4896967D5131'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '错误码。200为成功,其他失败', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Group' => [
'description' => '应用分组信息。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '应用分组类型。取值:'."\n"
.'- custom:自建的应用分组。'."\n"
.'- ehpc_cluster:从EHPC集群同步的应用分组。', 'type' => 'string', 'example' => 'custom'],
'BindUrl' => ['description' => '绑定URL', 'type' => 'string', 'example' => 'ehpc://i-dadfasdf/Login'],
'GroupName' => ['description' => '应用分组名称。', 'type' => 'string', 'example' => 'ECS_test'],
'GroupId' => ['description' => '应用分组id。', 'type' => 'integer', 'format' => 'int64', 'example' => '58789173'],
'ServiceId' => ['description' => 'ServiceId', 'type' => 'integer', 'format' => 'int64', 'example' => 'eds'],
'ContactGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactGroup' => [
'description' => '报警联系人组。',
'type' => 'array',
'items' => [
'description' => '报警联系人组。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '报警联系人的姓名。', 'type' => 'string', 'example' => 'name'],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
['errorCode' => 'UniqueResult', 'errorMessage' => 'The query condition does not return the only result.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"RequestId\\": \\"ECA294F7-7408-5069-B260-4896967D5131\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"Group\\": {\\n \\"Type\\": \\"custom\\",\\n \\"BindUrl\\": \\"ehpc://i-dadfasdf/Login\\",\\n \\"GroupName\\": \\"ECS_test\\",\\n \\"GroupId\\": 58789173,\\n \\"ServiceId\\": 0,\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Name\\": \\"name\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '获取个人应用分组',
],
'ListAlarm' => [
'summary' => '查询指定或全部报警规则设置。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '报警规则的id。', 'type' => 'string', 'required' => false, 'example' => 'i-2ze3w55tr2rcpejpcfap_72071739-396b-497d-849c-59a73de44bcf'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '报警规则名称,支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => '报警测试'],
],
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '产品名称,参考各产品对应的project,例如 acs_ecs_dashboard, acs_rds_dashboard等 。', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard'],
],
[
'name' => 'Dimension',
'in' => 'query',
'schema' => ['description' => '规则关联的实例信息,为json object对应的字符串,例如{"instanceId":"name1"}。可以查询用于查询关联该实例的所有规则,应用该字段时必须指定Namespace。', 'type' => 'string', 'required' => false, 'example' => '{"instanceId":"XXX"}'],
],
[
'name' => 'State',
'in' => 'query',
'schema' => ['description' => '报警规则状态, ALARM, INSUFFICIENT_DATA,OK', 'type' => 'string', 'required' => false, 'example' => 'ok'],
],
[
'name' => 'IsEnable',
'in' => 'query',
'schema' => ['description' => 'true为启用,false为禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码,默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页记录数,默认值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一页,为空代表没有下一页。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'RequestId' => ['description' => '请求的uuid,便于查询日志。', 'type' => 'string', 'example' => 'EFD27F56-5799-4CE8-B625-56DF3332331C'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '请求失败状态码,200为成功,非200为失败。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求失败的提示信息。', 'type' => 'string', 'example' => 'Success'],
'Total' => ['description' => '符合条件数据总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '27'],
'AlarmList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Alarm' => [
'description' => '报警规则详情列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SilenceTime' => ['description' => '一直处于报警的沉默周期,单位为秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '86400'],
'MetricName' => ['description' => '报警规则对应的监控项。', 'type' => 'string', 'example' => 'CPUUtilization'],
'EvaluationCount' => ['description' => '连续探测几次都满足阈值条件时报警,默认3次。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'Webhook' => ['description' => '回调函数,只支持公网地址,回调参数请参考[使用报警回调](~~60714~~)。', 'type' => 'string', 'example' => 'null'],
'State' => ['description' => '报警规则的状态,有一个实例报警就是ALARM,所有都没数据是INSUFFICIENT_DATA,其它情况为OK。', 'type' => 'string', 'example' => 'ok'],
'ContactGroups' => ['description' => '通知的联系组,为json array对应的string,如`[“联系组1”,”联系组2”]`。', 'type' => 'string', 'example' => '["test4nudou"]'],
'Namespace' => ['description' => '报警规则对应的产品。', 'type' => 'string', 'example' => 'acs_ecs_dashboard'],
'Period' => ['description' => '查询指标的周期,单位为秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '300'],
'EndTime' => ['description' => '生效时间的结束时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '24'],
'ComparisonOperator' => ['description' => '比较符', 'type' => 'string', 'example' => '>'],
'StartTime' => ['description' => '生效时间的开始时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'NotifyType' => ['description' => '通知类型,值为0是旺旺+邮件,值为1是旺旺+邮件+短信。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Dimensions' => ['description' => '报警规则关联的实例列表,为json array对应的字符串,例如`[{"instanceId":"name1"},{"instanceId":"name2"}]`。', 'type' => 'string', 'example' => '["{\\"instanceId\\":\\" i-abcdefgh123456\\"}"]'],
'Name' => ['description' => '报警规则名称。', 'type' => 'string', 'example' => '报警测试'],
'Threshold' => ['description' => '阈值', 'type' => 'string', 'example' => '90'],
'Id' => ['description' => '报警规则id。', 'type' => 'string', 'example' => 'i-2ze3w55tr2rcpejpcfap_72071739-396b-497d-849c-59a73de44bcf'],
'Enable' => ['description' => '该规则是否启用,true为启动。', 'type' => 'boolean', 'example' => 'true'],
'Statistics' => ['description' => '统计方法,例如Average、Maximum、Minimum。', 'type' => 'string', 'example' => 'Average'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": 2,\\n \\"RequestId\\": \\"EFD27F56-5799-4CE8-B625-56DF3332331C\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Total\\": 27,\\n \\"AlarmList\\": {\\n \\"Alarm\\": [\\n {\\n \\"SilenceTime\\": 86400,\\n \\"MetricName\\": \\"CPUUtilization\\",\\n \\"EvaluationCount\\": 3,\\n \\"Webhook\\": \\"null\\",\\n \\"State\\": \\"ok\\",\\n \\"ContactGroups\\": \\"[\\\\\\"test4nudou\\\\\\"]\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Period\\": 300,\\n \\"EndTime\\": 24,\\n \\"ComparisonOperator\\": \\">\\",\\n \\"StartTime\\": 0,\\n \\"NotifyType\\": 0,\\n \\"Dimensions\\": \\"[\\\\\\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\" i-abcdefgh123456\\\\\\\\\\\\\\"}\\\\\\"]\\",\\n \\"Name\\": \\"报警测试\\",\\n \\"Threshold\\": \\"90\\",\\n \\"Id\\": \\"i-2ze3w55tr2rcpejpcfap_72071739-396b-497d-849c-59a73de44bcf\\",\\n \\"Enable\\": true,\\n \\"Statistics\\": \\"Average\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"NextToken\\": 2, \\n \\"RequestId\\": \\"EFD27F56-5799-4CE8-B625-56DF3332331C\\", \\n \\"AlarmList\\": {\\n \\"Alarm\\": [\\n {\\n \\"Period\\": 300, \\n \\"Statistics\\": \\"Average\\", \\n \\"Name\\": \\"ecs_cpu_total\\", \\n \\"MetricName\\": \\"cpu_total\\", \\n \\"State\\": \\"OK\\", \\n \\"Threshold\\": \\"90\\", \\n \\"Enable\\": true, \\n \\"SilenceTime\\": 86400, \\n \\"NotifyType\\": 1, \\n \\"Dimensions\\": \\"[\\\\\\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\" i-abcdefgh123456\\\\\\\\\\\\\\"}\\\\\\"]\\", \\n \\"Namespace\\": \\"acs_ecs_dashboard\\", \\n \\"ContactGroups\\": \\"[\\\\\\"test4nudou\\\\\\"]\\", \\n \\"Id\\": \\"putNewAlarm_group_e8da18b9-bc95-4edf-a8bf-159eb6c8286b\\", \\n \\"EndTime\\": 24, \\n \\"StartTime\\": 0, \\n \\"ComparisonOperator\\": \\">=\\"\\n }, \\n {\\n \\"Period\\": 300, \\n \\"Statistics\\": \\"Average\\", \\n \\"Name\\": \\"ecs_diskusage_utilization\\", \\n \\"MetricName\\": \\"diskusage_utilization\\", \\n \\"State\\": \\"OK\\", \\n \\"Threshold\\": \\"90\\", \\n \\"Enable\\": true, \\n \\"SilenceTime\\": 86400, \\n \\"NotifyType\\": 1, \\n \\"Dimensions\\": \\"[\\\\\\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\" i-abcdefgh123456\\\\\\\\\\\\\\"}\\\\\\"]\\", \\n \\"Namespace\\": \\"acs_ecs_dashboard\\", \\n \\"ContactGroups\\": \\"[\\\\\\"test4nudou\\\\\\"]\\", \\n \\"Id\\": \\"putNewAlarm_group_3233eba5-0dd4-4e80-a5d5-7399dec3d7cc\\", \\n \\"EndTime\\": 24, \\n \\"StartTime\\": 0, \\n \\"ComparisonOperator\\": \\">=\\"\\n }\\n ]\\n }, \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\", \\n \\"Total\\": 27\\n}"},{"type":"xml","example":"\\n 2\\n CC2CDD2B-4EA5-43CD-BEE3-758E93C36B7F\\n \\n \\n 300\\n Average\\n ecs_cpu_total\\n cpu_total\\n OK\\n 90\\n true\\n 86400\\n 1\\n [\\"{\\\\\\"instanceId\\\\\\":\\\\\\" i-abcdefgh123456\\\\\\"}\\"]\\n acs_ecs_dashboard\\n [\\"test4nudou\\"]\\n putNewAlarm_group_e8da18b9-bc95-4edf-a8bf-159eb6c8286b\\n 24\\n 0\\n >=\\n \\n \\n 300\\n Average\\n ecs_diskusage_utilization\\n diskusage_utilization\\n OK\\n 90\\n true\\n 86400\\n 1\\n [\\"{\\\\\\"instanceId\\\\\\":\\\\\\" i-abcdefgh123456\\\\\\"}\\"]\\n acs_ecs_dashboard\\n [\\"test4nudou\\"]\\n putNewAlarm_group_3233eba5-0dd4-4e80-a5d5-7399dec3d7cc\\n 24\\n 0\\n >=\\n \\n \\n true\\n 200\\n 27","errorExample":"\\n 2\\n CC2CDD2B-4EA5-43CD-BEE3-758E93C36B7F\\n \\n \\n 300\\n Average\\n ecs_cpu_total\\n cpu_total\\n OK\\n 90\\n true\\n 86400\\n 1\\n [\\"{\\\\\\"instanceId\\\\\\":\\\\\\" i-abcdefgh123456\\\\\\"}\\"]\\n acs_ecs_dashboard\\n [\\"test4nudou\\"]\\n putNewAlarm_group_e8da18b9-bc95-4edf-a8bf-159eb6c8286b\\n 24\\n 0\\n >=\\n \\n \\n 300\\n Average\\n ecs_diskusage_utilization\\n diskusage_utilization\\n OK\\n 90\\n true\\n 86400\\n 1\\n [\\"{\\\\\\"instanceId\\\\\\":\\\\\\" i-abcdefgh123456\\\\\\"}\\"]\\n acs_ecs_dashboard\\n [\\"test4nudou\\"]\\n putNewAlarm_group_3233eba5-0dd4-4e80-a5d5-7399dec3d7cc\\n 24\\n 0\\n >=\\n \\n \\n true\\n 200\\n 27"}]',
'title' => '查询指定或全部报警规则设置',
],
'ListAlarmHistory' => [
'summary' => '查询指定或全部报警规则设置历史。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '报警规则的id。', 'type' => 'string', 'required' => false, 'example' => '1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed'],
],
[
'name' => 'Size',
'in' => 'query',
'schema' => ['description' => '每页记录数,默认值:100。 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询数据开始时间,默认24小时前,可以输入long型时间,也可以输入yyyy-MM-dd HH:mm:ss类型时间 ', 'type' => 'string', 'required' => false, 'example' => '1548913091223'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询数据结束时间,默认当前时间,可以输入long型时间,也可以输入yyyy-MM-dd HH:mm:ss类型时间', 'type' => 'string', 'required' => false, 'example' => '1548927491223'],
],
[
'name' => 'Cursor',
'in' => 'query',
'schema' => ['description' => '查询数据的起始位置,为空则按时间查询前100条', 'type' => 'string', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求失败状态码,200为成功,非200为失败。 ', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求失败的提示信息。', 'type' => 'string', 'example' => 'Success'],
'Cursor' => ['description' => '下一页数据,为空代表没有下一页。', 'type' => 'string', 'example' => '1'],
'RequestId' => ['description' => '请求的uuid,便于查询日志。', 'type' => 'string', 'example' => '1DBBCE29-0F69-435C-B65C-53D1011D1D72'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'AlarmHistoryList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AlarmHistory' => [
'description' => '报警历史详情列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '通知发送状态,0为已通知用户,1为不在生效期未通知,2为处于报警沉默期未通知。 ', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'MetricName' => ['description' => '监控项名称。', 'type' => 'string', 'example' => 'CPUUtilization'],
'EvaluationCount' => ['description' => '连续探测几次都满足阈值条件时报警。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'State' => ['description' => '报警规则状态,有OK,ALARM,INSUFFICIENT_DATA三种状态。 ', 'type' => 'string', 'example' => 'ALARM'],
'ContactGroups' => ['description' => '发出的报警通知的通知对象,json array对应的字符串,例如`[“联系组1”:”联系组2”]`,只有通知状态为0才有该字段。 ', 'type' => 'string', 'example' => '["DB组"]'],
'Namespace' => ['description' => '产品的名称。', 'type' => 'string', 'example' => 'acs_ecs_dashboard'],
'Dimension' => ['description' => '报警规则对应实例,为json object对应的字符串,例如{“instance”:”name1”}。', 'type' => 'string', 'example' => '{"instanceId":"XXX"}'],
'LastTime' => ['description' => '报警持续时间,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2851651669'],
'Value' => ['description' => '报警的当前值。', 'type' => 'string', 'example' => '84401454'],
'AlarmTime' => ['description' => '报警发生的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1548926982000'],
'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'test-demo'],
'Name' => ['description' => '报警规则的名称。', 'type' => 'string', 'example' => '报警测试'],
'Id' => ['description' => '报警规则的id。', 'type' => 'string', 'example' => '1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Cursor\\": \\"1\\",\\n \\"RequestId\\": \\"1DBBCE29-0F69-435C-B65C-53D1011D1D72\\",\\n \\"Success\\": true,\\n \\"AlarmHistoryList\\": {\\n \\"AlarmHistory\\": [\\n {\\n \\"Status\\": 2,\\n \\"MetricName\\": \\"CPUUtilization\\",\\n \\"EvaluationCount\\": 3,\\n \\"State\\": \\"ALARM\\",\\n \\"ContactGroups\\": \\"[\\\\\\"DB组\\\\\\"]\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Dimension\\": \\"{\\\\\\"instanceId\\\\\\":\\\\\\"XXX\\\\\\"}\\",\\n \\"LastTime\\": 2851651669,\\n \\"Value\\": \\"84401454\\",\\n \\"AlarmTime\\": 1548926982000,\\n \\"InstanceName\\": \\"test-demo\\",\\n \\"Name\\": \\"报警测试\\",\\n \\"Id\\": \\"1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"AlarmHistoryList\\": {\\n \\"AlarmHistory\\": [\\n {\\n \\"Status\\": 2, \\n \\"Value\\": \\"{\\\\\\"Maximum\\\\\\":301,\\\\\\"Minimum\\\\\\":301}\\", \\n \\"MetricName\\": \\"http.status_groupbyinstanceid#60\\", \\n \\"State\\": \\"ALARM\\", \\n \\"LastTime\\": 122088, \\n \\"AlarmTime\\": 1489568222088, \\n \\"Namespace\\": \\"acs_sitemonitor\\", \\n \\"ContactGroups\\": \\"null\\", \\n \\"Id\\": \\"1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\", \\n \\"EvaluationCount\\": 3\\n }, \\n {\\n \\"Status\\": 0, \\n \\"Value\\": \\"{\\\\\\"Maximum\\\\\\":301,\\\\\\"Minimum\\\\\\":301}\\", \\n \\"MetricName\\": \\"http.status_groupbyinstanceid#60\\", \\n \\"State\\": \\"ALARM\\", \\n \\"LastTime\\": 62078, \\n \\"AlarmTime\\": 1489568162078, \\n \\"Namespace\\": \\"acs_sitemonitor\\", \\n \\"ContactGroups\\": \\"[\\\\\\"云账号报警联系人\\\\\\"]\\", \\n \\"Id\\": \\"1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\", \\n \\"EvaluationCount\\": 3\\n }\\n ]\\n }, \\n \\"RequestId\\": \\"1DBBCE29-0F69-435C-B65C-53D1011D1D72\\", \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\"\\n}"},{"type":"xml","example":"\\n \\n \\n 2\\n {\\"Maximum\\":301,\\"Minimum\\":301}\\n http.status_groupbyinstanceid#60\\n ALARM\\n 122088\\n 1489568222088\\n acs_sitemonitor\\n null\\n 1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\n 3\\n \\n \\n 0\\n {\\"Maximum\\":301,\\"Minimum\\":301}\\n http.status_groupbyinstanceid#60\\n ALARM\\n 62078\\n 1489568162078\\n acs_sitemonitor\\n [\\"云账号报警联系人\\"]\\n 1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\n 3\\n \\n \\n 7E7A6173-EC07-43A1-ABBF-1F05EBB4C2BB\\n true\\n 200\\n","errorExample":"\\n \\n \\n 2\\n {\\"Maximum\\":301,\\"Minimum\\":301}\\n http.status_groupbyinstanceid#60\\n ALARM\\n 122088\\n 1489568222088\\n acs_sitemonitor\\n null\\n 1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\n 3\\n \\n \\n 0\\n {\\"Maximum\\":301,\\"Minimum\\":301}\\n http.status_groupbyinstanceid#60\\n ALARM\\n 62078\\n 1489568162078\\n acs_sitemonitor\\n [\\"云账号报警联系人\\"]\\n 1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\n 3\\n \\n \\n 7E7A6173-EC07-43A1-ABBF-1F05EBB4C2BB\\n true\\n 200\\n"}]',
'title' => '查询报警历史',
],
'ListContactGroup' => [
'summary' => '查询云账号下对应的报警规则联系人组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一页,为空代表无数据', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'RequestId' => ['description' => '请求Id,用于排查问题', 'type' => 'string', 'example' => 'D3D03B0A-CF1A-4DAB-BF0D-D4B6ACD5677A'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'Total' => ['description' => '符合条件数据总数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'ContactGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactGroup' => [
'description' => '报警联系人组的列表。',
'type' => 'array',
'items' => ['description' => '报警联系人组。', 'type' => 'string', 'example' => '云账号报警联系人'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => 'Internal Server Error'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
503 => [
['errorCode' => '%s', 'errorMessage' => 'Service Unavailable'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": 2,\\n \\"RequestId\\": \\"D3D03B0A-CF1A-4DAB-BF0D-D4B6ACD5677A\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Total\\": 2,\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"云账号报警联系人\\"\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询云账号下对应的报警规则联系人组',
],
'ListEventRules' => [
'summary' => '获取事件规则列表',
'methods' => ['post', 'get', 'put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'NamePrefix',
'in' => 'query',
'schema' => ['description' => '事件报警规则前缀。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => '页码。'."\n"
."\n"
.'起始值:1。默认值:1。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的记录条数。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组id。', 'type' => 'string', 'required' => false, 'example' => '239933048'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一页,为空代表没有下一页。', 'type' => 'string', 'example' => '2'],
'CurrentPage' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求Id,用于排查问题', 'type' => 'string', 'example' => 'fd54aeca-cfb1-4900-a417-3d30de11cbb9'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'Total' => ['description' => '符合条件数据总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '101'],
'Datapoints' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'EventRule' => [
'description' => '事件规则的列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EventType' => ['description' => '事件类型。', 'type' => 'string', 'example' => 'Exception'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'helloworld'],
'GroupId' => ['description' => '分组ID。', 'type' => 'string', 'example' => '239677374'],
'Name' => ['description' => '事件报警规则名称。', 'type' => 'string', 'example' => 'test'],
'State' => ['description' => '事件报警规则状态。取值:'."\n"
."\n"
.'- ENABLED:启用。'."\n"
."\n"
.'- DISABLED:禁用。', 'type' => 'string', 'example' => 'disabled'],
'EventPattern' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'EventPattern' => [
'description' => '事件报警规则模式的列表。',
'type' => 'array',
'items' => [
'description' => '事件报警规则模式。',
'type' => 'object',
'properties' => [
'Product' => ['description' => '产品名称', 'type' => 'string', 'example' => 'RDS'],
'EventTypeList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'EventTypeList' => [
'description' => '事件报警类型的列表。',
'type' => 'array',
'items' => ['description' => '事件报警类型。', 'type' => 'string', 'example' => 'Alert'],
],
],
],
'LevelList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LevelList' => [
'description' => '事件报警规则级别的列表。',
'type' => 'array',
'items' => ['description' => '事件的等级。取值:'."\n"
."\n"
.'- CRITICAL:严重。'."\n"
."\n"
.'- WARN:警告。'."\n"
."\n"
.'- INFO:信息。', 'type' => 'string', 'example' => 'CRITICAL'],
],
],
],
'StatusList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'StatusList' => [
'description' => '事件状态的列表。',
'type' => 'array',
'items' => ['description' => '事件状态。', 'type' => 'string', 'example' => '[]'],
],
],
],
'NameList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'NameList' => [
'description' => '事件名称列表。',
'type' => 'array',
'items' => ['description' => '事件名称。', 'type' => 'string', 'example' => 'Instance:LiveMigrationAcrossDDH'],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'ResourceNotFound'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"2\\",\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"fd54aeca-cfb1-4900-a417-3d30de11cbb9\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Total\\": 101,\\n \\"Datapoints\\": {\\n \\"EventRule\\": [\\n {\\n \\"EventType\\": \\"Exception\\",\\n \\"Description\\": \\"helloworld\\",\\n \\"GroupId\\": \\"239677374\\",\\n \\"Name\\": \\"test\\",\\n \\"State\\": \\"disabled\\",\\n \\"EventPattern\\": {\\n \\"EventPattern\\": [\\n {\\n \\"Product\\": \\"RDS\\",\\n \\"EventTypeList\\": {\\n \\"EventTypeList\\": [\\n \\"Alert\\"\\n ]\\n },\\n \\"LevelList\\": {\\n \\"LevelList\\": [\\n \\"CRITICAL\\"\\n ]\\n },\\n \\"StatusList\\": {\\n \\"StatusList\\": [\\n \\"[]\\"\\n ]\\n },\\n \\"NameList\\": {\\n \\"NameList\\": [\\n \\"Instance:LiveMigrationAcrossDDH\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取事件规则列表',
],
'ListMyGroupInstances' => [
'summary' => '列出我的组实例',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Total',
'in' => 'query',
'schema' => ['description' => '总记录条数。', 'type' => 'boolean', 'required' => false, 'example' => '100'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '应用分组id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '4728420'],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => ['description' => '分类', 'type' => 'string', 'required' => false, 'example' => 'ecs'],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => ['description' => '搜索关键字。', 'type' => 'string', 'required' => false, 'example' => 'aliyun'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '实例ID列表', 'type' => 'string', 'required' => false, 'example' => 'i-hp3dunahluwajv6f****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1B43E02C-8794-5E8A-9F8C-3874DF7AF03F'],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'InstanceIds is mandatory for this action.'],
'Success' => ['description' => '操作是否成功。true表示成功,false表示失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '请求失败状态码,200为成功,非200为失败', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页显示记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'Resources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Resource' => [
'description' => '资源列表',
'type' => 'array',
'items' => [
'description' => '资源对象',
'type' => 'object',
'properties' => [
'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => 'teacher-redis-online'],
'AliUid' => ['description' => '阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Category' => ['description' => '分类', 'type' => 'string', 'example' => 'ecs'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-bp1e012cy94o85355'],
'Id' => ['description' => '资源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'RegionId' => ['description' => '实例对应的地域。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B43E02C-8794-5E8A-9F8C-3874DF7AF03F\\",\\n \\"ErrorMessage\\": \\"InstanceIds is mandatory for this action.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"InstanceName\\": \\"teacher-redis-online\\",\\n \\"AliUid\\": 123,\\n \\"Category\\": \\"ecs\\",\\n \\"InstanceId\\": \\"rm-bp1e012cy94o85355\\",\\n \\"Id\\": 123,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '列出我的组实例',
],
'ListMyGroups' => [
'summary' => '列举个人应用分组',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => '应用分组类型。取值:'."\n"
.'- custom:自建的应用分组。'."\n"
.'- ehpc_cluster:从EHPC集群同步的应用分组。', 'type' => 'string', 'required' => false, 'example' => 'custom'],
],
[
'name' => 'SelectContactGroups',
'in' => 'query',
'schema' => ['description' => '是否返回报警联系组。取值:-true:是。-false(默认值):否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => ['description' => '搜索关键字。', 'type' => 'string', 'required' => false, 'example' => 'abc'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => false, 'example' => 'i-m5e0k0bexac8tykr****'],
],
[
'name' => 'BindUrls',
'in' => 'query',
'schema' => ['description' => '绑定URL', 'type' => 'string', 'required' => false, 'example' => 'ehpc://i-dadfasdf/Login'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '应用分组名称。', 'type' => 'string', 'required' => false, 'example' => 'fc_monitor_group_2018_ctNameFail'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '996A6748-2F6F-561F-971A-BB5928B24F3C'],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'InstanceIds is mandatory for this action.'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '错误码。200为成功,其他失败', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页显示记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Total' => ['description' => '总记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'Resources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Resource' => [
'description' => '个人应用分组列表',
'type' => 'array',
'items' => [
'description' => '个人应用分组列表',
'type' => 'object',
'properties' => [
'Type' => ['description' => '应用分组类型。取值:'."\n"
.'- custom:自建的应用分组。'."\n"
.'- ehpc_cluster:从EHPC集群同步的应用分组。', 'type' => 'string', 'example' => 'custom'],
'BindUrl' => ['description' => '绑定URL', 'type' => 'string', 'example' => 'ehpc://i-dadfasdf/Login'],
'GroupId' => ['description' => '应用分组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '236889260'],
'GroupName' => ['description' => '应用分组名称。', 'type' => 'string', 'example' => 'monitor_group_2018_metric_rulebemd'],
'BindUrls' => ['description' => '绑定URL', 'type' => 'string', 'example' => '["ehpc://i-dadfasdf/Login"]'],
'ServiceId' => ['description' => 'ServiceId', 'type' => 'string', 'example' => 'service-9b7395c020ae4e16825d'],
'GmtCreate' => ['description' => '创建应用分组的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '2017-08-09 16:09:41'],
'GmtModified' => ['description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2017-08-09 16:09:41'],
'ContactGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactGroup' => [
'description' => '报警联系人组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '报警联系组的名称。', 'type' => 'string', 'example' => 'contact_group_01'],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"996A6748-2F6F-561F-971A-BB5928B24F3C\\",\\n \\"ErrorMessage\\": \\"InstanceIds is mandatory for this action.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Type\\": \\"custom\\",\\n \\"BindUrl\\": \\"ehpc://i-dadfasdf/Login\\",\\n \\"GroupId\\": 236889260,\\n \\"GroupName\\": \\"monitor_group_2018_metric_rulebemd\\",\\n \\"BindUrls\\": \\"[\\\\\\"ehpc://i-dadfasdf/Login\\\\\\"]\\",\\n \\"ServiceId\\": \\"service-9b7395c020ae4e16825d\\",\\n \\"GmtCreate\\": 0,\\n \\"GmtModified\\": 0,\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Name\\": \\"contact_group_01\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '列举个人应用分组',
],
'ModifyTask' => [
'summary' => '修改站点监控的探测任务。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Address',
'in' => 'query',
'schema' => ['description' => '地址', 'type' => 'string', 'required' => false, 'example' => 'http://www.******'],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '任务id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8f880e3d-d924-47ab-84d2-fa1a72e24211'],
],
[
'name' => 'TaskName',
'in' => 'query',
'schema' => ['description' => '任务名称。', 'type' => 'string', 'required' => false, 'example' => 'aliyunTest'],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => ['description' => '探测频率,单位是分钟, 取值范围1、5、15,默认值为1', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'IspCity',
'in' => 'query',
'schema' => ['description' => '探针的信息,需要从DescribeISPAreaCity 接口获得', 'type' => 'string', 'required' => false, 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]'],
],
[
'name' => 'Options',
'in' => 'query',
'schema' => ['description' => '监控对应协议的高级扩展选项', 'type' => 'string', 'required' => false, 'example' => '{\\"dns_type\\":\\"A\\",\\"expect_value\\":\\"171.222.205.250\\",\\"match_rule\\":\\"DNS_IN\\"}'],
],
[
'name' => 'AlertRule',
'in' => 'query',
'schema' => ['description' => '创建/修改任务的时候同时设置报警规则,格式为jsonArray,例如'."\n"
.'\\[{"alarmActions":["xxx"],"metricName":"Availability","expression":"$Availability<96"}]'."\n"
."\n"
.'alarmActions:对应的报警联系组 '."\n"
."\n"
.'metricName:对应的监控项,可以取值为Availability(可用探测点百分比), AvailableNumber(可用探测点数)', 'type' => 'string', 'required' => false, 'example' => '[]'],
],
[
'name' => 'AlertIds',
'in' => 'query',
'schema' => ['description' => '直接关联已经存在等报警规则, 这里直接写报警规则Id,多个用规则用逗号分割', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'caller',
'in' => 'query',
'schema' => ['description' => '记录调用api的产品方,默认为云监控,您无需填写该参数。', 'type' => 'string', 'required' => false, 'example' => 'cms'],
],
[
'name' => 'IntervalUnit',
'in' => 'query',
'schema' => ['description' => '监控频率的单位。该参数需要与Interval配合使用,例如:该参数设置为ms,Interval最小设置为15000(15秒)。取值: s:秒。ms:毫秒。说明 您必须开通秒级监控,才能使用该参数。关于如何开通秒级监控,请参见开通企业云监控。', 'type' => 'string', 'required' => false, 'example' => 'ms'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。'."\n"
."\n"
.'>200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回消息。', 'type' => 'string', 'example' => 'The request has failed due to a temporary failure of the server.'],
'Data' => ['description' => '返回信息', 'type' => 'string', 'example' => '[]'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F3F87581-3656-5805-975B-3003699091AE'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'],
],
406 => [
['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
600 => [
['errorCode' => 'IllegalAddress', 'errorMessage' => 'Illegal HTTP address'],
],
605 => [
['errorCode' => 'OperationError', 'errorMessage' => 'Operation failed'],
],
615 => [
['errorCode' => 'TaskNotExists', 'errorMessage' => 'Task does not exist'],
],
650 => [
['errorCode' => 'OperatorInvalid', 'errorMessage' => 'Operator invalid'],
['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Operator City invalid'],
],
655 => [
['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Operator City invalid'],
],
660 => [
['errorCode' => 'NameRepeat', 'errorMessage' => 'Task name repeat'],
],
680 => [
['errorCode' => 'CreateAlarmError', 'errorMessage' => 'Create alarm error'],
],
695 => [
['errorCode' => 'NameNotExists', 'errorMessage' => 'Task name not exists'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"F3F87581-3656-5805-975B-3003699091AE\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
'title' => '修改任务',
],
'NodeList' => [
'summary' => 'NodeList',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'KeyWord',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
[
'name' => 'HostName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'SerialNumbers',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'InstanceRegionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'ErrorCode' => ['type' => 'integer', 'format' => 'int32'],
'Success' => ['type' => 'boolean'],
'PageTotal' => ['type' => 'integer', 'format' => 'int32'],
'PageNumber' => ['type' => 'integer', 'format' => 'int32'],
'PageSize' => ['type' => 'integer', 'format' => 'int32'],
'Total' => ['type' => 'integer', 'format' => 'int32'],
'Nodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Node' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SerialNumber' => ['type' => 'string'],
'NatIp' => ['type' => 'string'],
'HostName' => ['type' => 'string'],
'AliUid' => ['type' => 'integer', 'format' => 'int64'],
'NetworkType' => ['type' => 'string'],
'InstanceId' => ['type' => 'string'],
'AliyunHost' => ['type' => 'boolean'],
'EipAddress' => ['type' => 'string'],
'IpGroup' => ['type' => 'string'],
'EipId' => ['type' => 'string'],
'TianjimonVersion' => ['type' => 'string'],
'Region' => ['type' => 'string'],
'InstanceTypeFamily' => ['type' => 'string'],
'OperatingSystem' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'NodeProcessCreate' => [
'summary' => 'NodeProcessCreate',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ProcessName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'ProcessUser',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Command',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string'],
'ErrorMessage' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
'ErrorCode' => ['type' => 'integer', 'format' => 'int32'],
'Id' => ['type' => 'integer', 'format' => 'int64'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'NodeProcesses' => [
'summary' => 'NodeProcesses',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string'],
'ErrorMessage' => ['type' => 'string'],
'ErrorCode' => ['type' => 'integer', 'format' => 'int32'],
'Success' => ['type' => 'boolean'],
'NodeProcesses' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'NodeProcess' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ProcessName' => ['type' => 'string'],
'Command' => ['type' => 'string'],
'ProcessUser' => ['type' => 'string'],
'InstanceId' => ['type' => 'string'],
'Name' => ['type' => 'string'],
'Id' => ['type' => 'integer', 'format' => 'int64'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'NodeStatusList' => [
'summary' => '批量查询云监控插件状态。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '实例id。 例如:i-22jja5c2l,多个id使用英文逗号分隔', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'i-abcdefgh123456,i-abcdefgh123457'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的唯一ID用于定位错误', 'type' => 'string', 'example' => '1BB8FE8E-9BBE-490F-82EC-BF70FB849D55'],
'ErrorMessage' => ['description' => '错误提示', 'type' => 'string', 'example' => 'InstanceIds is mandatory for this action.'],
'ErrorCode' => ['description' => '错误码,200为成功,其他为失败', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Success' => ['description' => '本次操是否成功,等价于errorCode200', 'type' => 'boolean', 'example' => 'true'],
'NodeStatusList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'NodeStatus' => [
'description' => 'Node状态的列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '参考NodeStatus Agent运行状态', 'type' => 'string', 'example' => 'running'],
'InstanceId' => ['description' => '实例id', 'type' => 'string', 'example' => 'i-abcdefgh123456'],
'AutoInstall' => ['description' => '是否可以使用安装接口自动安装', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1BB8FE8E-9BBE-490F-82EC-BF70FB849D55\\",\\n \\"ErrorMessage\\": \\"InstanceIds is mandatory for this action.\\",\\n \\"ErrorCode\\": 200,\\n \\"Success\\": true,\\n \\"NodeStatusList\\": {\\n \\"NodeStatus\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"InstanceId\\": \\"i-abcdefgh123456\\",\\n \\"AutoInstall\\": true\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"NodeStatusList\\": {\\n \\"NodeStatus\\": [\\n {\\n \\"Status\\": \\"running\\", \\n \\"InstanceId\\": \\" i-abcdefgh123456\\", \\n \\"AutoInstall\\": true\\n }, \\n {\\n \\"Status\\": \\"uninstalled\\", \\n \\"InstanceId\\": \\" i-abcdefgh123457\\", \\n \\"AutoInstall\\": true\\n }\\n ]\\n }, \\n \\"ErrorCode\\": 200, \\n \\"Success\\": true\\n}"},{"type":"xml","example":"\\n \\n \\n running\\n i-abcdefgh123456\\n true\\n \\n \\n uninstalled\\n i-abcdefgh123457\\n true\\n \\n \\n true\\n 200\\n","errorExample":"\\n \\n \\n running\\n i-abcdefgh123456\\n true\\n \\n \\n uninstalled\\n i-abcdefgh123457\\n true\\n \\n \\n true\\n 200\\n"}]',
'title' => '批量查询云监控插件状态',
],
'NodeUninstall' => [
'summary' => 'NodeUninstall',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string'],
'ErrorMessage' => ['type' => 'string'],
'ErrorCode' => ['type' => 'integer', 'format' => 'int32'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
412 => [
['errorCode' => 'AgentStateError', 'errorMessage' => 'Expected agent running state is stopped.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'PutCustomMetric' => [
'summary' => 'PutCustomMetric',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'MetricList',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['type' => 'string'],
'Message' => ['type' => 'string'],
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'PutEvent' => [
'summary' => 'PutEvent',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'EventInfo',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['type' => 'string'],
'Message' => ['type' => 'string'],
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'PutEventRule' => [
'summary' => '创建或修改事件的报警规则',
'methods' => ['post', 'get', 'put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '事件报警规则名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DBS_EVENT_RULE'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组id。', 'type' => 'string', 'required' => false, 'example' => '240992827'],
],
[
'name' => 'EventType',
'in' => 'query',
'schema' => [
'description' => '事件报警规则的类型。取值:'."\n"
."\n"
.'- SYSTEM:系统事件。'."\n"
.'- CUSTOM:自定义事件。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SYSTEM' => 'SYSTEM', 'CUSTOM' => 'CUSTOM'],
'example' => 'SYSTEM',
'default' => 'SYSTEM',
'enum' => ['SYSTEM', 'BUSSINESS'],
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '事件报警规则描述。', 'type' => 'string', 'required' => false, 'example' => '事件报警测试'],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'description' => '事件报警规则的状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Enable',
'default' => 'ENABLED',
'enum' => ['ENABLED', 'DISABLED'],
],
],
[
'name' => 'EventPattern',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '事件报警规则的模式的列表。',
'type' => 'array',
'items' => [
'description' => '事件报警规则的模式。',
'type' => 'object',
'properties' => [
'EventTypeList' => [
'description' => '事件报警类型的列表。',
'type' => 'array',
'items' => ['description' => '事件报警规则的类型。', 'type' => 'string', 'required' => false, 'example' => 'Alert'],
'required' => false,
'maxItems' => 5,
],
'StatusList' => [
'description' => '事件报警规则的状态的列表。',
'type' => 'array',
'items' => ['description' => '事件报警规则的状态。', 'type' => 'string', 'required' => false, 'example' => '[]'],
'required' => false,
'maxItems' => 5,
],
'Product' => ['description' => '产品。', 'type' => 'string', 'required' => false, 'example' => 'ECS'],
'LevelList' => [
'description' => '事件报警规则的等级的列表。',
'type' => 'array',
'items' => ['description' => '事件报警规则的等级。', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL'],
'required' => false,
'maxItems' => 5,
],
'NameList' => [
'description' => '事件报警规则的名称的列表。',
'type' => 'array',
'items' => ['description' => '事件报警规则的名称。', 'type' => 'string', 'required' => false, 'example' => 'Agent_Status_Stopped'],
'required' => false,
'maxItems' => 50,
],
],
'required' => false,
],
'required' => true,
'maxItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回消息。', 'type' => 'string', 'example' => 'successful'],
'Data' => ['description' => '返回的数据', 'type' => 'string', 'example' => '100'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0B47C47B-E68A-4429-BB23-370E91889C7D'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"100\\",\\n \\"RequestId\\": \\"0B47C47B-E68A-4429-BB23-370E91889C7D\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '创建或修改事件的报警规则',
],
'PutEventTargets' => [
'summary' => '设置事件目标',
'methods' => ['post', 'get', 'put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['description' => '报警规则的名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DBS_EVENT_RULE'],
],
[
'name' => 'FcParameters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '函数参数列表。',
'type' => 'array',
'items' => [
'description' => '函数的参数。',
'type' => 'object',
'properties' => [
'FunctionName' => ['description' => '函数名称。', 'type' => 'string', 'required' => false, 'example' => 'fcTest1'],
'Region' => ['description' => '函数对应的地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'required' => false, 'example' => 'service1'],
'Id' => ['description' => '实体ID', 'type' => 'string', 'required' => false, 'example' => '1911729'],
],
'required' => false,
],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'ContactParameters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '报警联系组参数列表。',
'type' => 'array',
'items' => [
'description' => '报警联系组的参数。',
'type' => 'object',
'properties' => [
'ContactGroupName' => ['description' => '报警联系人组名称。', 'type' => 'string', 'required' => false, 'example' => '云账号报警联系人'],
'Id' => ['description' => 'ID。', 'type' => 'string', 'required' => false, 'example' => '933247bf-bded-4ad8-8653-403efad16cfd'],
'Level' => ['description' => '报警级别。', 'type' => 'string', 'required' => false, 'example' => 'NORMAL'],
],
'required' => false,
],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'MnsParameters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'Mns参数列表',
'type' => 'array',
'items' => [
'description' => '轻量消息队列(原 MNS)通知。',
'type' => 'object',
'properties' => [
'Region' => ['description' => '地域id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
'Queue' => ['description' => '消息队列。', 'type' => 'string', 'required' => false, 'example' => 'testQueue'],
'Id' => ['description' => 'ID', 'type' => 'string', 'required' => false, 'example' => '933247bf-bded-4ad8-8653-403efad16cfd'],
],
'required' => false,
],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'WebhookParameters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'URL回调参数列表。',
'type' => 'array',
'items' => [
'description' => 'URL回调参数。',
'type' => 'object',
'properties' => [
'Protocol' => ['description' => '协议类型。', 'type' => 'string', 'required' => false, 'example' => 'https'],
'Url' => ['description' => '回调的URL。', 'type' => 'string', 'required' => false, 'example' => 'http://alert.xxxxxxx.com:8080/callback'],
'Method' => ['description' => 'HTTP回调的请求方法。'."\n"
."\n"
.'支持GET和POST。', 'type' => 'string', 'required' => false, 'example' => 'POST'],
'Id' => ['description' => 'ID。', 'type' => 'string', 'required' => false, 'example' => '933247bf-bded-4ad8-8653-403efad16cfd'],
],
'required' => false,
],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'SlsParameters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '日志服务(SLS)参数列表。',
'type' => 'array',
'items' => [
'description' => '日志服务(SLS)参数。',
'type' => 'object',
'properties' => [
'LogStore' => ['description' => '日志服务对应的日志库。', 'type' => 'string', 'required' => false, 'example' => 'logstore_test'],
'Region' => ['description' => '日志服务对应的地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
'Project' => ['description' => '日志服务对应的project。', 'type' => 'string', 'required' => false, 'example' => 'sls-rdscustom-event'],
'Id' => ['description' => 'ID。', 'type' => 'string', 'required' => false, 'example' => '933247bf-bded-4ad8-8653-403efad16cfd'],
],
'required' => false,
],
'required' => false,
'maxItems' => 5,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的唯一标识,用于后续错误排查使用。', 'type' => 'string', 'example' => '84AC6F0B-7945-466A-AA44-99BB5A561F86'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。'."\n", 'type' => 'boolean', 'example' => 'true'],
'ParameterCount' => ['description' => '参数个数。', 'type' => 'string', 'example' => '132'],
'FailedParameterCount' => ['description' => '错误参数数量统计。', 'type' => 'string', 'example' => '2'],
'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回消息。', 'type' => 'string', 'example' => 'successful'],
'ContactParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactParameter' => [
'description' => '报警联系人组参数列表。',
'type' => 'array',
'items' => [
'description' => '报警联系人组参数。',
'type' => 'object',
'properties' => [
'ContactGroupName' => ['description' => '报警联系人组的名称。', 'type' => 'string', 'example' => '云账号报警联系人'],
'Id' => ['description' => '编号。', 'type' => 'integer', 'format' => 'int32', 'example' => 'ca66c5ae-8e46-445c-8ca9-7ccf10a0e183'],
'Level' => ['description' => '报警级别。', 'type' => 'string', 'example' => 'CRITICAL'],
],
],
],
],
],
'MnsParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MnsParameter' => [
'description' => 'Mns参数列表',
'type' => 'array',
'items' => [
'description' => 'Mns参数',
'type' => 'object',
'properties' => [
'Queue' => ['description' => '轻量消息队列(原 MNS)的名称。', 'type' => 'string', 'example' => 'spotmax-spot-interruption-notice'],
'Id' => ['description' => '编号。', 'type' => 'integer', 'format' => 'int32', 'example' => '91ace627-ed2c-4a35-8cd8-3a52b149c47e'],
'Region' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
],
],
'FcParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FcParameter' => [
'description' => '函数服务参数列表。',
'type' => 'array',
'items' => [
'description' => '函数服务参数。',
'type' => 'object',
'properties' => [
'ServiceName' => ['description' => '函数服务的服务名称。', 'type' => 'string', 'example' => 'esign-production-dba'],
'FunctionName' => ['description' => '函数名称。', 'type' => 'string', 'example' => 'cdn_waf'],
'Id' => ['description' => '编号。', 'type' => 'integer', 'format' => 'int32', 'example' => '933247bf-bded-4ad8-8653-403efad16cfd'],
'Region' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
],
],
'FailedContactParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactParameter' => [
'description' => '失败报警联系人组参数列表。',
'type' => 'array',
'items' => [
'description' => '失败报警联系人组参数。',
'type' => 'object',
'properties' => [
'ContactGroupName' => ['description' => '报警联系人组的名称。', 'type' => 'string', 'example' => '云账号报警联系人'],
'Id' => ['description' => '编码。', 'type' => 'integer', 'format' => 'int32', 'example' => '933247bf-bded-4ad8-8653-403efad16cfd'],
'Level' => ['description' => '报警级别。', 'type' => 'string', 'example' => 'CRITICAL'],
],
],
],
],
],
'FailedMnsParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MnsParameter' => [
'description' => '失败Mns参数列表。',
'type' => 'array',
'items' => [
'description' => '失败Mns参数。',
'type' => 'object',
'properties' => [
'Queue' => ['description' => '轻量消息队列(原 MNS)的名称。', 'type' => 'string', 'example' => 'spotmax-spot-interruption-notice'],
'Id' => ['description' => '编码。', 'type' => 'integer', 'format' => 'int32', 'example' => 'bc2cbb0f-c96b-45b7-81a1-b2356c232b79'],
'Region' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
],
],
'FailedFcParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FcParameter' => [
'description' => '失败函数服务参数列表。',
'type' => 'array',
'items' => [
'description' => '失败函数服务参数。',
'type' => 'object',
'properties' => [
'ServiceName' => ['description' => '函数服务的服务名称。', 'type' => 'string', 'example' => 'esign-production-dba'],
'FunctionName' => ['description' => '函数名称。', 'type' => 'string', 'example' => 'dba-alert-severity'],
'Id' => ['description' => '编码ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '98c049b7-f8f5-4001-ac4c-be21fd6d38e6'],
'Region' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
],
],
'FailedSlsParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FailedSlsParameter' => [
'description' => '失败SLS参数列表。',
'type' => 'array',
'items' => [
'description' => '失败SLS参数。',
'type' => 'object',
'properties' => [
'Project' => ['description' => '日志服务对应的项目。', 'type' => 'string', 'example' => 'acs_disk'],
'LogStore' => ['description' => '日志服务对应的日志库。', 'type' => 'string', 'example' => 'alb_access_log'],
'Id' => ['description' => '编码。', 'type' => 'string', 'example' => 'be96c43d-b680-4ac5-aa21-1465e477e98f'],
'Region' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84AC6F0B-7945-466A-AA44-99BB5A561F86\\",\\n \\"Success\\": true,\\n \\"ParameterCount\\": \\"132\\",\\n \\"FailedParameterCount\\": \\"2\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"ContactParameters\\": {\\n \\"ContactParameter\\": [\\n {\\n \\"ContactGroupName\\": \\"云账号报警联系人\\",\\n \\"Id\\": 0,\\n \\"Level\\": \\"CRITICAL\\"\\n }\\n ]\\n },\\n \\"MnsParameters\\": {\\n \\"MnsParameter\\": [\\n {\\n \\"Queue\\": \\"spotmax-spot-interruption-notice\\",\\n \\"Id\\": 0,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"FcParameters\\": {\\n \\"FcParameter\\": [\\n {\\n \\"ServiceName\\": \\"esign-production-dba\\",\\n \\"FunctionName\\": \\"cdn_waf\\",\\n \\"Id\\": 0,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"FailedContactParameters\\": {\\n \\"ContactParameter\\": [\\n {\\n \\"ContactGroupName\\": \\"云账号报警联系人\\",\\n \\"Id\\": 0,\\n \\"Level\\": \\"CRITICAL\\"\\n }\\n ]\\n },\\n \\"FailedMnsParameters\\": {\\n \\"MnsParameter\\": [\\n {\\n \\"Queue\\": \\"spotmax-spot-interruption-notice\\",\\n \\"Id\\": 0,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"FailedFcParameters\\": {\\n \\"FcParameter\\": [\\n {\\n \\"ServiceName\\": \\"esign-production-dba\\",\\n \\"FunctionName\\": \\"dba-alert-severity\\",\\n \\"Id\\": 0,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"FailedSlsParameters\\": {\\n \\"FailedSlsParameter\\": [\\n {\\n \\"Project\\": \\"acs_disk\\",\\n \\"LogStore\\": \\"alb_access_log\\",\\n \\"Id\\": \\"be96c43d-b680-4ac5-aa21-1465e477e98f\\",\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '设置事件目标',
],
'PutMetricRuleTargets' => [
'summary' => 'PutMetricRuleTargets',
'methods' => ['post', 'get', 'put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'Actions',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Targets',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['type' => 'string', 'required' => false],
'Arn' => ['type' => 'string', 'required' => false],
'Level' => ['type' => 'string'],
],
],
'required' => true,
'maxItems' => 5,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['type' => 'string'],
'Message' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
'FailData' => [
'type' => 'object',
'properties' => [
'Targets' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Target' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['type' => 'string'],
'Arn' => ['type' => 'string'],
'Level' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
200 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'PutResourceMetricRule' => [
'summary' => 'PutResourceMetricRule',
'methods' => ['post', 'get', 'put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'MetricName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'Resources',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'ContactGroups',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true],
],
[
'name' => 'Webhook',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'EffectiveInterval',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'NoEffectiveInterval',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'SilenceTime',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '86400'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'default' => '300'],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'EmailSubject',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Escalations.Critical.Statistics',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Escalations.Critical.ComparisonOperator',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Escalations.Critical.Threshold',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Escalations.Critical.Times',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
],
[
'name' => 'Escalations.Warn.Statistics',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Escalations.Warn.ComparisonOperator',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Escalations.Warn.Threshold',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Escalations.Warn.Times',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
],
[
'name' => 'Escalations.Info.Statistics',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Escalations.Info.ComparisonOperator',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Escalations.Info.Threshold',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Escalations.Info.Times',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['type' => 'string'],
'Message' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
204 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
206 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
406 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
499 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
503 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
],
'responseDemo' => '',
],
'QueryCustomMetricList' => [
'summary' => '查询自定义指标列表',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '应用分组id。', 'type' => 'string', 'required' => true, 'example' => '24232'],
],
[
'name' => 'MetricName',
'in' => 'query',
'schema' => ['description' => '监控项的名称。', 'type' => 'string', 'required' => false, 'example' => 'GPUUtilization'],
],
[
'name' => 'Dimension',
'in' => 'query',
'schema' => ['description' => '维度过滤条件,例如k1=v1&k2=v2。', 'type' => 'string', 'required' => false, 'example' => 'sampleName1=value1&sampleName2=value2'],
],
[
'name' => 'Md5',
'in' => 'query',
'schema' => ['description' => 'project + groupId + metricName + dimension 唯一值', 'type' => 'string', 'required' => false, 'example' => '97c25982d9745a231276bff27469****'],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['description' => '分页页码。 默认值:1 。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'Size',
'in' => 'query',
'schema' => ['description' => '分页大小。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Success'],
'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '109C8095-6FAD-4DBB-B013-6ED18CE4C0B1'],
'Result' => ['description' => '自定义监控数据列表。', 'type' => 'string', 'example' => '{\\"data\\":[],\\"param\\":{\\"metric\\":\\"{\\\\\\"groupId\\\\\\":242135xxx,\\\\\\"project\\\\\\":\\\\\\"acs_customMetric_1672753017899xxx\\\\\\",\\\\\\"status\\\\\\":1}\\",\\"service\\":\\"metric-center.aliyun-inc.com\\"}}'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"109C8095-6FAD-4DBB-B013-6ED18CE4C0B1\\",\\n \\"Result\\": \\"{\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"param\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"metric\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"groupId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":242135xxx,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"project\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"acs_customMetric_1672753017899xxx\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"service\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"metric-center.aliyun-inc.com\\\\\\\\\\\\\\"}}\\"\\n}","type":"json"}]',
'title' => '查询自定义指标列表',
],
'QueryMetricData' => [
'summary' => 'QueryMetricData',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Project',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'Metric',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Dimensions',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Express',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Length',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['type' => 'string'],
'Message' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Datapoints' => ['type' => 'string'],
'Period' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'QueryMetricTop' => [
'summary' => 'QueryMetricTop',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Period',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Project',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'Metric',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Dimensions',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Orderby',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'OrderDesc',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Length',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Express',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['type' => 'string'],
'Message' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Datapoints' => ['type' => 'string'],
'Period' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'QueryProjectMeta' => [
'summary' => '查询云监控支持的时序类监控项产品列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Labels',
'in' => 'query',
'schema' => ['description' => ' 根据标签过滤,格式为`[{"name":"标签名","value":"标签值"},{"name":"标签名","value":"标签值"}]`。'."\n"
.'支持的标签名包括product、groupFlag。'."\n"
.'product 标签值为产品英文名称。 '."\n"
.'groupFlag含义为该产品是否支持应用分组,标签值为true或false 。', 'type' => 'string', 'required' => false, 'example' => '[{\\"name\\":\\"product\\",\\"value\\":\\"MongoDB\\"]'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页参数,默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大数量,默认30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => ['description' => '错误码消息。', 'type' => 'string', 'example' => 'Success'],
'RequestId' => ['description' => '用于跟踪。', 'type' => 'string', 'example' => 'D3DBF9F5-7C4D-4A67-B869-097C069C481D'],
'Success' => ['description' => '用于标识本次调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '错误码200成功。', 'type' => 'string', 'example' => '200'],
'Resources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Resource' => [
'description' => 'ProjectMeta列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Project' => ['description' => '监控项的Project,用于查询监控数据。', 'type' => 'string', 'example' => 'acs_mongodb'],
'Description' => ['description' => '监控项的描述。', 'type' => 'string', 'example' => 'ApsaraDB for MongoDB'],
'Labels' => ['description' => '`[{"name":"标签名","value":"标签值"},{"name":"标签名","value":"标签值"}]`'."\n"
."\n"
.'支持的标签名包括product、groupFlag。'."\n"
."\n"
.'product 标签值为产品英文名称。'."\n"
."\n"
.'groupFlag含义为该产品是否支持应用分组,标签值为true或false。', 'type' => 'string', 'example' => '[{\\"name\\":\\"product\\",\\"value\\":\\"MongoDB\\"]'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"RequestId\\": \\"D3DBF9F5-7C4D-4A67-B869-097C069C481D\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"200\\",\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Project\\": \\"acs_mongodb\\",\\n \\"Description\\": \\"ApsaraDB for MongoDB\\",\\n \\"Labels\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"product\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"MongoDB\\\\\\\\\\\\\\"]\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\tD3DBF9F5-7C4D-4A67-B869-097C069C481D\\n\\t200\\n\\ttrue\\n\\t\\n\\t\\t\\n\\t\\t\\tAnalyticDB\\n\\t\\t\\t[{"name":"product","value":"ADS"},{"name":"groupFlag","value":"true"}]\\n\\t\\t\\tacs_ads\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tAPI Gateway\\n\\t\\t\\t[{"name":"product","value":"APIGateway"},{"name":"groupFlag","value":"true"}]\\n\\t\\t\\tacs_apigateway_dashboard\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tInternet Shared Bandwidth\\n\\t\\t\\t[{"name":"product","value":"InternetSharedBandwidth"},{"name":"groupFlag","value":"true"}]\\n\\t\\t\\tacs_bandwidth_package\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCDN\\n\\t\\t\\t[{"name":"product","value":"CDN"},{"name":"groupFlag","value":"true"}]\\n\\t\\t\\tacs_cdn\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCloud Enterprise Network\\n\\t\\t\\t[{"name":"product","value":"CEN"},{"name":"groupFlag","value":"false"}]\\n\\t\\t\\tacs_cen\\n\\t\\t\\n\\t\\n\\t\\n","errorExample":"\\n{\\n\\"RequestId\\": \\"D3DBF9F5-7C4D-4A67-B869-097C069C481D\\",\\n\\"ErrorCode\\": 200,\\n\\"Success\\": true,\\n\\"Resources\\": {\\n\\"Resource\\": [\\n{\\n\\"Description\\": \\"AnalyticDB\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"product\\\\\\",\\\\\\"value\\\\\\":\\\\\\"ADS\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"groupFlag\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Project\\": \\"acs_ads\\"\\n},\\n{\\n\\"Description\\": \\"API Gateway\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"product\\\\\\",\\\\\\"value\\\\\\":\\\\\\"APIGateway\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"groupFlag\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Project\\": \\"acs_apigateway_dashboard\\"\\n},\\n{\\n\\"Description\\": \\"Internet Shared Bandwidth\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"product\\\\\\",\\\\\\"value\\\\\\":\\\\\\"InternetSharedBandwidth\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"groupFlag\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Project\\": \\"acs_bandwidth_package\\"\\n},\\n{\\n\\"Description\\": \\"CDN\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"product\\\\\\",\\\\\\"value\\\\\\":\\\\\\"CDN\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"groupFlag\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Project\\": \\"acs_cdn\\"\\n},\\n{\\n\\"Description\\": \\"Cloud Enterprise Network\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"product\\\\\\",\\\\\\"value\\\\\\":\\\\\\"CEN\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"groupFlag\\\\\\",\\\\\\"value\\\\\\":\\\\\\"false\\\\\\"}]\\",\\n\\"Project\\": \\"acs_cen\\"\\n}\\n]\\n}\\n}"}]',
'title' => '查询时序类监控项产品列表',
'description' => '通常配合查询监控项接口QueryMetricMeta和查询监控数据接口QueryMetricList/QueryMetricLast 一起使用。'."\n"
.'##请求类型 '."\n"
.'POST|GET '."\n"
.' ',
],
'QueryStaticsAvailability' => [
'summary' => '查询静态可用性',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '可用性监控任务ID。', 'type' => 'string', 'required' => true, 'example' => '123'],
],
[
'name' => 'TimeRange',
'in' => 'query',
'schema' => ['description' => '统计周期。', 'type' => 'string', 'required' => false, 'example' => '1440'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。'."\n"
.'>200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Success'],
'Data' => ['description' => '返回的可用性指标数据。', 'type' => 'string', 'example' => '[]'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
'title' => '查询静态可用性',
],
'QueryStaticsResponseTime' => [
'summary' => '查询静态响应时间',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '任务id。', 'type' => 'string', 'required' => true, 'example' => '123'],
],
[
'name' => 'TimeRange',
'in' => 'query',
'schema' => ['description' => '响应时间范围。', 'type' => 'string', 'required' => false, 'example' => '1440'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。'."\n"
.'>200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.'],
'Data' => ['description' => '返回信息。', 'type' => 'string', 'example' => '[]'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
'title' => '查询静态响应时间',
],
'QuerySystemEventCount' => [
'summary' => 'QuerySystemEventCount',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'QueryJson',
'in' => 'query',
'schema' => ['description' => '查询条件', 'type' => 'string', 'required' => false, 'example' => '{\\"timeEnd\\":1745461671353,\\"timeStart\\":1745375271353,\\"level\\":\\"WARN\\"}'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。'."\n"
."\n"
.'>200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => '( (userId:5024495213896020) ) and ( (level:WARN) )'],
'Data' => ['description' => '返回数据。', 'type' => 'string', 'example' => '[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954****","taskId":"49f7b317-7645-4cc9-94fd-ea42e522****","timestamp":1551581760000}]'],
'RequestId' => ['description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', 'type' => 'string', 'example' => '282127F4-2F58-5DE6-88CE-B71BDD085E8B'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"( (userId:5024495213896020) ) and ( (level:WARN) )\\",\\n \\"Data\\": \\"[{\\\\\\"Maximum\\\\\\":247,\\\\\\"Mimimum\\\\\\":61,\\\\\\"Average\\\\\\":154,\\\\\\"userId\\\\\\":\\\\\\"127067667954****\\\\\\",\\\\\\"taskId\\\\\\":\\\\\\"49f7b317-7645-4cc9-94fd-ea42e522****\\\\\\",\\\\\\"timestamp\\\\\\":1551581760000}]\\",\\n \\"RequestId\\": \\"282127F4-2F58-5DE6-88CE-B71BDD085E8B\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
'title' => '查询系统事件计数',
],
'QuerySystemEventDemo' => [
'summary' => '查询系统事件演示',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Product',
'in' => 'query',
'schema' => ['description' => '事件的云服务名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ECS'],
],
[
'name' => 'EventName',
'in' => 'query',
'schema' => ['description' => '事件名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent_Status_Stopped'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。说明 200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful'],
'Data' => ['description' => '返回的数据。', 'type' => 'string', 'example' => '{"count":1}'],
'RequestId' => ['description' => '请求的ID,用于定位日志,排查问题。', 'type' => 'string', 'example' => '90117AC0-01F8-562C-B8F3-17E4D81743AC'],
'Success' => ['description' => '是否成功,取值: '."\n"
.'- `true`:成功'."\n"
.'- `false`:失败', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"{\\\\\\"count\\\\\\":1}\\",\\n \\"RequestId\\": \\"90117AC0-01F8-562C-B8F3-17E4D81743AC\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
'title' => '查询系统事件演示',
],
'QueryTaskConfig' => [
'summary' => '查询任务配置',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '请求失败状态码,200为成功,非200为失败。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The request has failed due to a temporary failure of the server.'],
'Data' => ['description' => '返回的数据。', 'type' => 'string', 'example' => '[]'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '68192f5d-0d45-4b98-9724-892813f86c71'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。'."\n", 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"68192f5d-0d45-4b98-9724-892813f86c71\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
'title' => '查询任务配置',
],
'QueryTaskMonitorData' => [
'summary' => 'QueryTaskMonitorData',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'metricName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Cursor',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'Length',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Cursor' => ['type' => 'string'],
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'string'],
'Code' => ['type' => 'string'],
'Message' => ['type' => 'string'],
'TraceId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '',
],
'TaskConfigList' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '应用分组id。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '92****'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '监控任务id。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123****'],
],
[
'name' => 'TaskName',
'in' => 'query',
'schema' => ['description' => '任务名称。', 'type' => 'string', 'required' => false, 'example' => 'task2'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'MissingInstanceId'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BF120AD5-7D14-5EF6-8118-E3C2BCF849E1'],
'ErrorCode' => ['description' => '请求失败状态码,200为成功,非200为失败', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
'PageTotal' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页显示记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Total' => ['description' => '总记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'TaskList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'NodeTaskConfig' => [
'description' => '任务配置信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskType' => ['description' => '监控任务类型。', 'type' => 'string', 'example' => 'PING'],
'JsonData' => ['description' => '配置信息。', 'type' => 'string', 'example' => '[]'],
'GroupName' => ['description' => '应用分组名称。', 'type' => 'string', 'example' => 'test-monitor-group-1758247893736-modified'],
'GroupId' => ['description' => '应用分组ID。'."\n"
."\n"
.'关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。', 'type' => 'integer', 'format' => 'int64', 'example' => '123******'],
'TaskName' => ['description' => '监控任务名称。'."\n"
."\n"
.'关于如何获取监控任务ID,请参见[DescribeHybridMonitorTaskList](~~428624~~)。', 'type' => 'string', 'example' => 'ft-task-20190101N***'],
'Disabled' => ['description' => '监控任务是否禁用。取值:'."\n"
.'- true:禁用。'."\n"
."\n"
.'- false:启用。', 'type' => 'boolean', 'example' => 'true'],
'AlertConfig' => ['description' => '报警配置。', 'type' => 'string', 'example' => '[]'],
'TaskScope' => ['description' => '任务的探测范围。', 'type' => 'string', 'example' => '*'],
'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123***'],
'InstanceList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'String' => [
'description' => '实例列表。',
'type' => 'array',
'items' => ['description' => '实例列表。', 'type' => 'string', 'example' => 'i-x12er****'],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"MissingInstanceId\\",\\n \\"RequestId\\": \\"BF120AD5-7D14-5EF6-8118-E3C2BCF849E1\\",\\n \\"ErrorCode\\": 200,\\n \\"Success\\": true,\\n \\"PageTotal\\": 50,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"TaskList\\": {\\n \\"NodeTaskConfig\\": [\\n {\\n \\"TaskType\\": \\"PING\\",\\n \\"JsonData\\": \\"[]\\",\\n \\"GroupName\\": \\"test-monitor-group-1758247893736-modified\\",\\n \\"GroupId\\": 0,\\n \\"TaskName\\": \\"ft-task-20190101N***\\",\\n \\"Disabled\\": true,\\n \\"AlertConfig\\": \\"[]\\",\\n \\"TaskScope\\": \\"*\\",\\n \\"Id\\": 0,\\n \\"InstanceList\\": {\\n \\"String\\": [\\n \\"i-x12er****\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '列举监控任务配置',
'summary' => '查询站点监控的配置列表',
],
'UpdateAlarm' => [
'summary' => '修改已创建的报警规则。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '报警规则名称。', 'type' => 'string', 'required' => false, 'example' => 'test_modify'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '报警规则的Id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '查询指标的周期,必须与定义的metric一致,默认300,单位为秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'],
],
[
'name' => 'Statistics',
'in' => 'query',
'schema' => ['description' => '修改后的值。', 'type' => 'string', 'required' => false, 'example' => 'Average'],
],
[
'name' => 'ComparisonOperator',
'in' => 'query',
'schema' => ['description' => '报警比较符,只能为以下几种`<=,<,>,>=,==,!=`', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '>'],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => '报警阈值,目前只开放数值类型功能。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '40'],
],
[
'name' => 'ContactGroups',
'in' => 'query',
'schema' => ['description' => '报警规则通知的联系组,必须在控制台上已创建,为json array对应的string,例如`[“联系组1”,”联系组2”]`。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["联系组"]'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '报警生效时间的开始时间,默认0,代表0点。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '报警生效时间的结束时间,默认24,代表24点。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24'],
],
[
'name' => 'SilenceTime',
'in' => 'query',
'schema' => ['description' => '一直处于报警状态的通知沉默周期,默认86400,单位s,最小1小时。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400'],
],
[
'name' => 'EvaluationCount',
'in' => 'query',
'schema' => ['description' => '连续探测几次都满足阈值条件时报警,默认3次。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
[
'name' => 'NotifyType',
'in' => 'query',
'schema' => ['description' => '通知类型,为0是旺旺+邮件,为1是旺旺+邮件+短信。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Webhook',
'in' => 'query',
'schema' => ['description' => '回调函数,只支持公网地址,回调参数请参考[使用报警回调](~~60714~~)。', 'type' => 'string', 'required' => false, 'example' => 'http://www.net.cn/example_callback.htm'],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => '是否需要检查Webhook可用。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求失败的提示信息。', 'type' => 'string', 'example' => 'Success'],
'RequestId' => ['description' => '请求的uuid,便于查询日志。', 'type' => 'string', 'example' => '945B9183-95C0-44FF-B30C-9ED37D44F6DC'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
403 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
],
[
['errorCode' => '%s', 'errorMessage' => '%s'],
],
500 => [
['errorCode' => '%s', 'errorMessage' => '%s'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"945B9183-95C0-44FF-B30C-9ED37D44F6DC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n C08FADC4-CFDB-42F7-B9B8-0ED5391CD084\\r\\n true\\r\\n 200\\r\\n","errorExample":""}]',
'title' => '修改已创建的报警规则',
],
'UpdateMonitoringTemplate' => [
'summary' => '更新监视模板',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '模板名称。', 'type' => 'string', 'required' => false, 'example' => '常用基础模板'],
],
[
'name' => 'AlertTemplatesJson',
'in' => 'query',
'schema' => ['description' => '报警模版。', 'type' => 'string', 'required' => true, 'example' => '{"rds":[{"displayName":"rds_rule_1111","category":"rds","namespace":"acs_rds_dashboard","metricName":"CpuUsage","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"99","times":3},"warn":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"98","times":3}}}],"ecs":[{"displayName":"ecs_rule1111","category":"ecs","namespace":"acs_ecs_dashboard","metricName":"cpu_total","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"99","times":5}}},{"displayName":"ecs_rule2222","category":"ecs","namespace":"acs_ecs_dashboard","metricName":"cpu_idle","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"9999","times":3},"warn":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"89","times":4}}}],"mongodb":[{"displayName":"mongodb11","category":"mongodb","namespace":"acs_mongodb","metricName":"CPUUtilization","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"11111","times":3}}}],"mongodb_cluster":[{"displayName":"mongodb_cluster_t1","category":"mongodb_cluster","namespace":"acs_mongodb","metricName":"ShardingQPS","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"9999999","times":3}}}]}'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '模板描述。', 'type' => 'string', 'required' => false, 'example' => 'Description'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '模板ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1097583'],
],
[
'name' => 'RestVersion',
'in' => 'query',
'schema' => ['description' => '数据版本号。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9'],
],
[
'name' => 'SystemEventTemplates',
'in' => 'query',
'schema' => ['description' => '系统事件模板。', 'type' => 'string', 'required' => false, 'example' => '[{"alertName":"WAF_Event","description":"WAF_Event","eventPattern":{"eventType":["*"],"levelList":["*"],"nameList":["*"],"product":"waf"},"fcParameterList":[],"mnsParameterList":[],"notifyLevel":3,"slsParameterList":[],"webhookParameterList":[]}]'],
],
[
'name' => 'ProcessMonitorTemplates',
'in' => 'query',
'schema' => ['description' => '进程监控模板。', 'type' => 'string', 'required' => false, 'example' => '[{"alert":{"comparisonOperator":"LessThanThreshold","escalationsLevel":"critical","silenceTime":0,"statistics":"Average","templateAlert":false,"threshold":"2","times":1},"matchExpress":{"filterRelation":"and","filters":[{"function":"all","name":"name","value":"*"}]},"processName":"FineBI"}]'],
],
[
'name' => 'HostAvailabilityTemplate',
'in' => 'query',
'schema' => ['description' => '可用性监控模板。', 'type' => 'string', 'required' => false, 'example' => '[{"alert":{"escalationList":[{"aggregate":"Value","metric":"TelnetStatus","operator":">","times":3,"value":"400"},{"aggregate":"Average","metric":"TelnetLatency","operator":">","times":3,"value":"500"}],"notifyType":1,"silenceTime":86400},"taskName":"telnet","taskOption":{"method":"HEAD","negative":true,"resposeCharset":"utf-8","uri":"telnet://xxx.com"},"taskType":"TELNET"},{"alert":{"escalationList":[{"aggregate":"Value","metric":"TelnetStatus","operator":">","times":3,"value":"400"},{"aggregate":"Average","metric":"TelnetLatency","operator":">","times":3,"value":"500"}],"notifyType":1,"silenceTime":86400},"taskName":"bbbbbbbbbb","taskOption":{"method":"HEAD","negative":true,"resposeCharset":"utf-8","uri":"telnet://xxx.com"},"taskType":"TELNET"}]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Success'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '987CC16C-D1E4-5EB1-A1CD-27906161EFFA'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '错误码,200为成功,其他失败 ', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.'],
],
403 => [
['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
409 => [
['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"RequestId\\": \\"987CC16C-D1E4-5EB1-A1CD-27906161EFFA\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200\\n}","type":"json"}]',
'title' => '更新监视模板',
],
'GetLogColumnTranslateResult' => [
'summary' => '获取日期提取结果的翻译',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'ColumnValue',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'TranslateConfig',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'type' => 'string'],
'Resource' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
'ErrorCode' => ['type' => 'integer', 'format' => 'int64'],
'Code' => ['type' => 'integer', 'format' => 'int64'],
'ErrorMessage' => ['type' => 'string'],
'Message' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'],
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s'],
],
403 => [
['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
429 => [
['errorCode' => 'ResourceOverLimit', 'errorMessage' => 'The resource has exceeded the limit. %s'],
],
],
],
'GetLineSplitResult' => [
'summary' => '获取行切分结果',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'SplitType',
'in' => 'query',
'schema' => ['title' => '切分类型', 'type' => 'string', 'example' => 'simple|regex'],
],
[
'name' => 'Line',
'in' => 'query',
'schema' => ['title' => '需要提取的行', 'type' => 'string'],
],
[
'name' => 'Prefix',
'in' => 'query',
'schema' => ['title' => '已经完成提取的部分', 'type' => 'string'],
],
[
'name' => 'SelectContent',
'in' => 'query',
'schema' => ['title' => '提取的内容', 'type' => 'string'],
],
[
'name' => 'Regex',
'in' => 'query',
'schema' => ['title' => '提取完成的正则表达式', 'type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'type' => 'string'],
'Success' => ['type' => 'boolean'],
'ErrorCode' => ['type' => 'integer', 'format' => 'int64'],
'Code' => ['type' => 'integer', 'format' => 'int64'],
'ErrorMessage' => ['type' => 'string'],
'Resource' => [
'type' => 'object',
'properties' => [
'StartSplitSymbol' => ['type' => 'string'],
'EndSplitSymbol' => ['type' => 'string'],
'StartSplitSymbolIndex' => ['type' => 'integer', 'format' => 'int64'],
'Regex' => ['type' => 'string'],
'AdditionalRegex' => ['type' => 'string'],
'RegexSplitResult' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.'],
['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s'],
],
403 => [
['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied'],
],
[
['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.'],
],
429 => [
['errorCode' => 'ResourceOverLimit', 'errorMessage' => 'The resource has exceeded the limit. %s'],
],
],
],
'DeleteHybridDoubleWrite' => [
'summary' => '调用DeleteHybridDoubleWrite接口删除企业云监控数据的双写任务。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'SourceUserId',
'in' => 'query',
'schema' => ['description' => '双写的源用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12706766********'],
],
[
'name' => 'SourceNamespace',
'in' => 'query',
'schema' => ['description' => '双写的源指标仓库。', 'type' => 'string', 'required' => true, 'example' => 'test-source'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6F815BDC-9063-5417-BA88-E1BBD84BAA1E'],
'Code' => ['description' => '状态码。'."\n"
.'>200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.'],
],
403 => [
['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'InvalidAuthorization.'],
['errorCode' => 'NotAuthSLR', 'errorMessage' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.'],
],
[
['errorCode' => 'NotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F815BDC-9063-5417-BA88-E1BBD84BAA1E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除企业云监控数据的双写任务',
'description' => '请确保您已提交工单,获取该API的使用权限。',
],
'CreateHybridDoubleWrite' => [
'summary' => '调用CreateHybridDoubleWrite接口创建企业云监控数据的双写任务。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'query',
'schema' => ['description' => '双写的目标指标仓库。', 'type' => 'string', 'required' => true, 'example' => 'test-target'],
],
[
'name' => 'SourceUserId',
'in' => 'query',
'schema' => ['description' => '双写的源用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12706766********'],
],
[
'name' => 'SourceNamespace',
'in' => 'query',
'schema' => ['description' => '双写的源指标仓库。', 'type' => 'string', 'required' => true, 'example' => 'test-source'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '双写的目标用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12706766********'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FAAC3C5D-00BF-543A-9E08-FAAC3C5D'],
'Code' => ['description' => '状态码。'."\n"
."\n"
.'> 200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.'],
],
403 => [
['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'InvalidAuthorization.'],
['errorCode' => 'NotAuthSLR', 'errorMessage' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.'],
],
[
['errorCode' => 'NotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAAC3C5D-00BF-543A-9E08-FAAC3C5D\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '创建企业云监控数据的双写任务',
'description' => '请确保您已提交工单,获取该API的使用权限。',
],
'DescribeHybridDoubleWrite' => [
'summary' => '调用DescribeHybridDoubleWrite接口查询从指定账号写出的指标仓库。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'SourceNamespace',
'in' => 'query',
'schema' => ['description' => '双写的源指标仓库。', 'type' => 'string', 'required' => false, 'example' => 'test-source'],
],
[
'name' => 'SourceUserId',
'in' => 'query',
'schema' => ['description' => '双写的源指标仓库的账号。', 'type' => 'string', 'required' => false, 'example' => '12706766**********'],
],
[
'name' => 'TargetUserId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'TargetNamespace',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F'],
'Code' => ['description' => '状态码。'."\n"
."\n"
.'>200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Success'],
'Success' => ['description' => '操作是否成功。取值:'."\n"
.'* true:成功。'."\n"
.'* false:失败。', 'type' => 'string', 'example' => 'true'],
'Result' => [
'description' => '从指定账号写出的目标指标仓库。',
'type' => 'array',
'items' => [
'description' => '从指定账号写出的目标指标仓库。',
'type' => 'object',
'properties' => [
'UserId' => ['description' => '双写的目标用户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '11234766**********'],
'Namespace' => ['description' => '双写的目标指标仓库。', 'type' => 'string', 'example' => 'test-target'],
'SourceUserId' => ['description' => '双写的源用户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12706766**********'],
'SourceNamespace' => ['description' => '双写的源指标仓库。', 'type' => 'string', 'example' => 'test-source'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => '%s is missing or invalid.'],
],
403 => [
['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'InvalidAuthorization.'],
['errorCode' => 'NotAuthSLR', 'errorMessage' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.'],
],
[
['errorCode' => 'NotFound', 'errorMessage' => 'The specified resource is not found.'],
],
500 => [
['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7985D471-3FA8-4EE9-8F4B-45C19DF3D36F\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Success\\": \\"true\\",\\n \\"Result\\": [\\n {\\n \\"UserId\\": 0,\\n \\"Namespace\\": \\"test-target\\",\\n \\"SourceUserId\\": 0,\\n \\"SourceNamespace\\": \\"test-source\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询从指定账号写出的指标仓库',
],
],
'endpoints' => [
['regionId' => 'cn-qingdao', 'endpoint' => 'metrics.cn-qingdao.aliyuncs.com'],
['regionId' => 'cn-beijing', 'endpoint' => 'metrics.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-zhangjiakou', 'endpoint' => 'metrics.cn-zhangjiakou.aliyuncs.com'],
['regionId' => 'cn-zhengzhou-jva', 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com'],
['regionId' => 'cn-huhehaote', 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-nanjing', 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com'],
['regionId' => 'cn-fuzhou', 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com'],
['regionId' => 'cn-heyuan', 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com'],
['regionId' => 'cn-guangzhou', 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com'],
['regionId' => 'cn-wuhan-lr', 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com'],
['regionId' => 'cn-zhongwei', 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com'],
['regionId' => 'ap-northeast-1', 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com'],
['regionId' => 'ap-northeast-2', 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-2', 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com'],
['regionId' => 'ap-southeast-3', 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'endpoint' => 'metrics.ap-southeast-5.aliyuncs.com'],
['regionId' => 'ap-southeast-6', 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com'],
['regionId' => 'ap-southeast-7', 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com'],
['regionId' => 'ap-southeast-8', 'endpoint' => 'metrics.ap-southeast-8.aliyuncs.com'],
['regionId' => 'us-east-1', 'endpoint' => 'metrics.us-east-1.aliyuncs.com'],
['regionId' => 'us-west-1', 'endpoint' => 'metrics.us-west-1.aliyuncs.com'],
['regionId' => 'us-southeast-1', 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com'],
['regionId' => 'eu-west-1', 'endpoint' => 'metrics.eu-west-1.aliyuncs.com'],
['regionId' => 'eu-west-2', 'endpoint' => 'metrics.eu-west-2.aliyuncs.com'],
['regionId' => 'na-south-1', 'endpoint' => 'metrics.na-south-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'endpoint' => 'metrics.eu-central-1.aliyuncs.com'],
['regionId' => 'ap-south-1', 'endpoint' => 'metrics.ap-south-1.aliyuncs.com'],
['regionId' => 'me-east-1', 'endpoint' => 'metrics.me-east-1.aliyuncs.com'],
['regionId' => 'me-central-1', 'endpoint' => 'metrics.me-central-1.aliyuncs.com'],
['regionId' => 'cn-hangzhou-finance', 'endpoint' => 'metrics.cn-hangzhou-finance.aliyuncs.com'],
['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com'],
['regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com'],
['regionId' => 'cn-beijing-finance-1', 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com'],
['regionId' => 'cn-heyuan-acdr-1', 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com'],
['regionId' => 'cn-north-2-gov-1', 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com'],
['regionId' => 'cn-wulanchabu-gic-1', 'endpoint' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com'],
],
];