diff options
Diffstat (limited to 'data/en_us/cms/2019-01-01/api-docs.php')
| -rw-r--r-- | data/en_us/cms/2019-01-01/api-docs.php | 55024 |
1 files changed, 22355 insertions, 32669 deletions
diff --git a/data/en_us/cms/2019-01-01/api-docs.php b/data/en_us/cms/2019-01-01/api-docs.php index 9ec4475..eca5157 100644 --- a/data/en_us/cms/2019-01-01/api-docs.php +++ b/data/en_us/cms/2019-01-01/api-docs.php @@ -1,325 +1,119 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Cms', - 'version' => '2019-01-01', - ], + 'info' => ['style' => 'RPC', 'product' => 'Cms', 'version' => '2019-01-01'], 'directories' => [ [ - 'id' => 184857, - 'title' => 'Application groups', - 'type' => 'directory', 'children' => [ [ - 'id' => 59483, - 'title' => 'Manage application groups', + 'children' => ['CreateMonitorGroup', 'ModifyMonitorGroup', 'DeleteMonitorGroup', 'DescribeMonitorGroups', 'CreateMonitorGroupInstances', 'ModifyMonitorGroupInstances', 'DescribeMonitorGroupInstances', 'DescribeMonitorGroupDynamicRules', 'DescribeMonitorGroupInstanceAttribute', 'DeleteMonitorGroupDynamicRule', 'DeleteMonitorGroupInstances', 'DescribeMonitorGroupCategories', 'PutMonitorGroupDynamicRule', 'CreateGroupMonitoringAgentProcess', 'ModifyGroupMonitoringAgentProcess', 'DeleteGroupMonitoringAgentProcess', 'DescribeGroupMonitoringAgentProcess', 'CreateMonitorGroupNotifyPolicy', 'DeleteMonitorGroupNotifyPolicy', 'DescribeMonitorGroupNotifyPolicyList'], 'type' => 'directory', - 'children' => [ - 'CreateMonitorGroup', - 'ModifyMonitorGroup', - 'DeleteMonitorGroup', - 'DescribeMonitorGroups', - 'CreateMonitorGroupInstances', - 'ModifyMonitorGroupInstances', - 'DescribeMonitorGroupInstances', - 'DescribeMonitorGroupDynamicRules', - 'DescribeMonitorGroupInstanceAttribute', - 'DeleteMonitorGroupDynamicRule', - 'DeleteMonitorGroupInstances', - 'DescribeMonitorGroupCategories', - 'PutMonitorGroupDynamicRule', - 'CreateGroupMonitoringAgentProcess', - 'ModifyGroupMonitoringAgentProcess', - 'DeleteGroupMonitoringAgentProcess', - 'DescribeGroupMonitoringAgentProcess', - 'CreateMonitorGroupNotifyPolicy', - 'DeleteMonitorGroupNotifyPolicy', - 'DescribeMonitorGroupNotifyPolicyList', - ], - ], - [ - 'id' => 59517, - 'title' => 'Label', + 'title' => 'Manage application groups', + ], + [ + 'children' => ['CreateDynamicTagGroup', 'DeleteDynamicTagGroup', 'DescribeTagValueList', 'DescribeTagKeyList', 'DescribeProductResourceTagKeyList', 'DescribeDynamicTagRuleList'], 'type' => 'directory', - 'children' => [ - 'AddTags', - 'CreateDynamicTagGroup', - 'DeleteDynamicTagGroup', - 'DescribeTagValueList', - 'DescribeTagKeyList', - 'DescribeProductResourceTagKeyList', - 'DescribeDynamicTagRuleList', - 'RemoveTags', - ], + 'title' => 'Tags', ], [ - 'id' => 59436, - 'title' => 'Availability monitoring', + 'children' => ['CreateHostAvailability', 'DeleteHostAvailability', 'EnableHostAvailability', 'DisableHostAvailability', 'ModifyHostAvailability', 'DescribeUnhealthyHostAvailability', 'DescribeHostAvailabilityList'], 'type' => 'directory', - 'children' => [ - 'CreateHostAvailability', - 'DeleteHostAvailability', - 'EnableHostAvailability', - 'DisableHostAvailability', - 'ModifyHostAvailability', - 'DescribeUnhealthyHostAvailability', - 'DescribeHostAvailabilityList', - ], + 'title' => 'Availability monitoring', ], ], + 'type' => 'directory', + 'title' => 'Application group', ], [ - 'id' => 59416, - 'title' => 'Host monitoring', + 'children' => ['InstallMonitoringAgent', 'DescribeMonitoringAgentHosts', 'DescribeMonitoringAgentAccessKey', 'DescribeMonitoringAgentConfig', 'DescribeMonitoringAgentStatuses', 'ModifyHostInfo', 'DescribeMonitoringConfig', 'PutMonitoringConfig', 'UninstallMonitoringAgent', 'CreateMonitoringAgentProcess', 'CreateMonitorAgentProcess', 'DescribeMonitoringAgentProcesses', 'DeleteMonitoringAgentProcess'], 'type' => 'directory', - 'children' => [ - 'InstallMonitoringAgent', - 'DescribeMonitoringAgentHosts', - 'DescribeMonitoringAgentAccessKey', - 'DescribeMonitoringAgentConfig', - 'DescribeMonitoringAgentStatuses', - 'ModifyHostInfo', - 'DescribeMonitoringConfig', - 'PutMonitoringConfig', - 'UninstallMonitoringAgent', - 'CreateMonitoringAgentProcess', - 'CreateMonitorAgentProcess', - 'DescribeMonitoringAgentProcesses', - 'DeleteMonitoringAgentProcess', - ], + 'title' => 'Host monitoring', ], [ - 'id' => 184858, - 'title' => 'Event center', - 'type' => 'directory', 'children' => [ [ - 'id' => 59447, - 'title' => 'System events', + 'children' => ['DescribeSystemEventHistogram', 'DescribeSystemEventMetaList', 'DescribeSystemEventAttribute', 'DescribeSystemEventCount', 'DescribeMonitorResourceQuotaAttribute', 'SendDryRunSystemEvent'], 'type' => 'directory', - 'children' => [ - 'DescribeSystemEventHistogram', - 'DescribeSystemEventMetaList', - 'DescribeSystemEventAttribute', - 'DescribeSystemEventCount', - 'DescribeMonitorResourceQuotaAttribute', - 'SendDryRunSystemEvent', - ], + 'title' => 'System events', ], [ - 'id' => 59478, - 'title' => 'Custom events', + 'children' => ['DescribeCustomEventCount', 'DescribeCustomEventHistogram', 'DescribeCustomEventAttribute', 'PutCustomEvent'], 'type' => 'directory', - 'children' => [ - 'DescribeCustomEventCount', - 'DescribeCustomEventHistogram', - 'DescribeCustomEventAttribute', - 'PutCustomEvent', - ], + 'title' => 'Custom events', ], ], + 'type' => 'directory', + 'title' => 'Event center', ], [ - 'id' => 59473, - 'title' => 'Custom monitoring', + 'children' => ['PutCustomMetric', 'PutCustomMetricRule', 'DescribeCustomMetricList', 'DeleteCustomMetric'], 'type' => 'directory', - 'children' => [ - 'PutCustomMetric', - 'PutCustomMetricRule', - 'DescribeCustomMetricList', - 'DeleteCustomMetric', - ], + 'title' => 'Custom monitoring', ], [ - 'id' => 59526, - 'title' => 'Log monitoring', + 'children' => ['PutLogMonitor', 'DeleteLogMonitor', 'DescribeLogMonitorList', 'DescribeLogMonitorAttribute'], 'type' => 'directory', - 'children' => [ - 'PutLogMonitor', - 'DeleteLogMonitor', - 'DescribeLogMonitorList', - 'DescribeLogMonitorAttribute', - ], + 'title' => 'Log monitoring', ], [ - 'id' => 184946, - 'title' => 'Site monitoring', + 'children' => ['CreateMonitorGroupByResourceGroupId', 'CreateInstantSiteMonitor', 'BatchCreateInstantSiteMonitor', 'DeleteSiteMonitors', 'DisableSiteMonitors', 'ModifySiteMonitor', 'EnableSiteMonitors', 'DescribeSiteMonitorQuota', 'DescribeSiteMonitorAttribute', 'DescribeSiteMonitorISPCityList', 'DescribeSiteMonitorData', 'DescribeSiteMonitorStatistics', 'DescribeSiteMonitorList', 'DescribeSiteMonitorLog'], 'type' => 'directory', - 'children' => [ - 'CreateMonitorGroupByResourceGroupId', - 'CreateSiteMonitor', - 'CreateInstantSiteMonitor', - 'BatchCreateInstantSiteMonitor', - 'DeleteSiteMonitors', - 'DisableSiteMonitors', - 'ModifySiteMonitor', - 'EnableSiteMonitors', - 'DescribeSiteMonitorQuota', - 'DescribeSiteMonitorAttribute', - 'DescribeSiteMonitorISPCityList', - 'DescribeSiteMonitorData', - 'DescribeSiteMonitorStatistics', - 'DescribeSiteMonitorList', - 'DescribeSiteMonitorLog', - ], + 'title' => 'Site monitoring', ], [ - 'id' => 59386, - 'title' => 'Cloud products', + 'children' => ['DescribeMetricData', 'DescribeProjectMeta', 'DeleteExporterOutput', 'DeleteExporterRule', 'DescribeExporterOutputList', 'DescribeExporterRuleList', 'PutExporterOutput', 'PutExporterRule'], 'type' => 'directory', - 'children' => [ - 'DescribeMetricLast', - 'DescribeMetricList', - 'DescribeMetricData', - 'DescribeMetricMetaList', - 'DescribeProjectMeta', - 'DeleteExporterOutput', - 'DeleteExporterRule', - 'DescribeExporterOutputList', - 'DescribeExporterRuleList', - 'DescribeMetricTop', - 'PutExporterOutput', - 'PutExporterRule', - ], + 'title' => 'Cloud service monitoring', ], [ - 'id' => 184862, - 'title' => 'Alert service', - 'type' => 'directory', 'children' => [ [ - 'id' => 184895, - 'title' => 'Alert history', + 'children' => ['DescribeAlertHistoryList', 'DescribeAlertLogCount', 'DescribeAlertLogList', 'DescribeAlertLogHistogram'], 'type' => 'directory', - 'children' => [ - 'DescribeAlertHistoryList', - 'DescribeAlertLogCount', - 'DescribeAlertLogList', - 'DescribeAlertLogHistogram', - ], + 'title' => 'Alert history', ], [ - 'id' => 184896, - 'title' => 'Initiative alert list', + 'children' => ['DescribeProductsOfActiveMetricRule', 'DescribeActiveMetricRuleList', 'EnableActiveMetricRule', 'DisableActiveMetricRule'], 'type' => 'directory', - 'children' => [ - 'DescribeProductsOfActiveMetricRule', - 'DescribeActiveMetricRuleList', - 'EnableActiveMetricRule', - 'DisableActiveMetricRule', - ], + 'title' => 'One-click alert', ], [ - 'id' => 59454, + 'children' => ['CreateMetricRuleTemplate', 'DeleteMetricRuleTemplate', 'ModifyMetricRuleTemplate', 'DescribeMetricRuleTemplateAttribute', 'DescribeMetricRuleTemplateList', 'ApplyMetricRuleTemplate'], + 'type' => 'directory', 'title' => 'Alert templates', + ], + [ + 'children' => ['DescribeMetricRuleList', 'CreateGroupMetricRules', 'CreateMetricRuleResources', 'DeleteMetricRuleTargets', 'DeleteMetricRules', 'DeleteMetricRuleResources', 'EnableMetricRules', 'DisableMetricRules', 'DescribeMetricRuleTargets', 'DescribeMetricRuleCount', 'DescribeAlertingMetricRuleResources', 'PutMetricRuleTargets', 'PutResourceMetricRule', 'PutResourceMetricRules', 'PutGroupMetricRule'], 'type' => 'directory', - 'children' => [ - 'CreateMetricRuleTemplate', - 'DeleteMetricRuleTemplate', - 'ModifyMetricRuleTemplate', - 'DescribeMetricRuleTemplateAttribute', - 'DescribeMetricRuleTemplateList', - 'ApplyMetricRuleTemplate', - ], + 'title' => 'Threshold alert rules', ], [ - 'id' => 59396, - 'title' => 'Threshold-triggered alert rules', + 'children' => ['DeleteEventRuleTargets', 'DeleteEventRules', 'EnableEventRules', 'DisableEventRules', 'DescribeEventRuleAttribute', 'DescribeEventRuleList', 'DescribeEventRuleTargetList', 'PutEventRuleTargets', 'PutEventRule', 'PutCustomEventRule'], 'type' => 'directory', - 'children' => [ - 'DescribeMetricRuleList', - 'CreateGroupMetricRules', - 'CreateMetricRuleResources', - 'DeleteMetricRuleTargets', - 'DeleteMetricRules', - 'DeleteMetricRuleResources', - 'EnableMetricRules', - 'DisableMetricRules', - 'DescribeMetricRuleTargets', - 'DescribeMetricRuleCount', - 'DescribeAlertingMetricRuleResources', - 'PutMetricRuleTargets', - 'PutResourceMetricRule', - 'PutResourceMetricRules', - 'PutGroupMetricRule', - ], - ], - [ - 'id' => 59461, 'title' => 'Event-triggered alert rules', + ], + [ + 'children' => ['CreateMetricRuleBlackList', 'ModifyMetricRuleBlackList', 'DeleteMetricRuleBlackList', 'DescribeMetricRuleBlackList', 'EnableMetricRuleBlackList'], 'type' => 'directory', - 'children' => [ - 'DeleteEventRuleTargets', - 'DeleteEventRules', - 'EnableEventRules', - 'DisableEventRules', - 'DescribeEventRuleAttribute', - 'DescribeEventRuleList', - 'DescribeEventRuleTargetList', - 'PutEventRuleTargets', - 'PutEventRule', - 'PutCustomEventRule', - ], - ], - [ - 'id' => 184863, - 'title' => 'Alert blacklists', - 'type' => 'directory', - 'children' => [ - 'CreateMetricRuleBlackList', - 'ModifyMetricRuleBlackList', - 'DeleteMetricRuleBlackList', - 'DescribeMetricRuleBlackList', - 'EnableMetricRuleBlackList', - ], + 'title' => 'Alert blacklist', ], [ - 'id' => 59428, - 'title' => 'Alert contacts', + 'children' => ['DescribeContactListByContactGroup', 'DescribeContactGroupList', 'DescribeContactList', 'PutContact', 'PutContactGroup'], 'type' => 'directory', - 'children' => [ - 'DeleteContactGroup', - 'DeleteContact', - 'DescribeContactListByContactGroup', - 'DescribeContactGroupList', - 'DescribeContactList', - 'PutContact', - 'PutContactGroup', - ], + 'title' => 'Alert contacts', ], ], + 'type' => 'directory', + 'title' => 'Alert service', ], [ - 'id' => 166246, - 'title' => 'Hybrid cloud monitoring', + 'children' => ['CreateHybridMonitorNamespace', 'ModifyHybridMonitorNamespace', 'DeleteHybridMonitorNamespace', 'DescribeHybridMonitorNamespaceList', 'CreateHybridMonitorTask', 'ModifyHybridMonitorTask', 'DeleteHybridMonitorTask', 'DescribeHybridMonitorTaskList', 'PutHybridMonitorMetricData', 'DescribeHybridMonitorDataList', 'CreateHybridMonitorSLSGroup', 'ModifyHybridMonitorSLSGroup', 'DeleteHybridMonitorSLSGroup', 'DescribeHybridMonitorSLSGroup', 'Cursor', 'BatchExport'], 'type' => 'directory', - 'children' => [ - 'CreateHybridMonitorNamespace', - 'ModifyHybridMonitorNamespace', - 'DeleteHybridMonitorNamespace', - 'DescribeHybridMonitorNamespaceList', - 'CreateHybridMonitorTask', - 'ModifyHybridMonitorTask', - 'DeleteHybridMonitorTask', - 'DescribeHybridMonitorTaskList', - 'PutHybridMonitorMetricData', - 'DescribeHybridMonitorDataList', - 'CreateHybridMonitorSLSGroup', - 'ModifyHybridMonitorSLSGroup', - 'DeleteHybridMonitorSLSGroup', - 'DescribeHybridMonitorSLSGroup', - 'Cursor', - 'BatchExport', - ], + 'title' => 'Hybrid Cloud monitoring', ], [ - 'id' => 313480, - 'title' => null, + 'children' => ['DescribeSyntheticProbeList', 'AddTags', 'BatchCreateOnceSiteMonitor', 'CreateSiteMonitor', 'DeleteContact', 'DeleteContactGroup', 'DescribeMetricLast', 'DescribeMetricList', 'DescribeMetricMetaList', 'DescribeMetricTop', 'DescribeSiteInstantMonitorLog', 'RemoveTags'], 'type' => 'directory', - 'children' => [ - 'DescribeSyntheticProbeList', - ], + 'title' => 'Others', ], ], 'components' => [ @@ -327,199 +121,137 @@ 'Dimension' => [ 'title' => 'Dimension', 'description' => 'The dimension information of the metric.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Label' => [ - 'title' => 'Dimension label', - 'description' => 'The name of the metric dimension.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'instanceId', - 'backendName' => 'label', - ], - 'Value' => [ - 'title' => 'Dimension value', - 'description' => 'The value of the metric dimension.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'i-dferwret*****', - 'backendName' => 'value', - ], + 'Label' => ['title' => 'Dimension label', 'description' => 'The name of the metric dimension.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'instanceId', 'backendName' => 'label'], + 'Value' => ['title' => 'Dimension value', 'description' => 'The value of the metric dimension.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'i-dferwret*****', 'backendName' => 'value'], ], + 'example' => '', ], 'Matcher' => [ 'title' => 'mathcer', 'description' => 'The dimension of the metric.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => 'value', - 'description' => 'The value of the metric dimension.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'instanceId', - 'backendName' => 'value', - ], - 'Label' => [ - 'title' => 'label', - 'description' => 'The name of the metric dimension.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'i-fewrewr*****', - 'backendName' => 'label', - ], - 'Operator' => [ - 'title' => 'operator', - 'description' => 'The matching mode of the metric dimension. Only EQUALS is supported. Default value: EQUALS.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'EQUALS', - 'backendName' => 'operator', - ], + 'Value' => ['title' => 'value', 'description' => 'The value of the metric dimension.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'instanceId', 'backendName' => 'value'], + 'Label' => ['title' => 'label', 'description' => 'The name of the metric dimension.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'i-fewrewr*****', 'backendName' => 'label'], + 'Operator' => ['title' => 'operator', 'description' => 'The matching mode of the metric dimension. Only EQUALS is supported. Default value: EQUALS.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'EQUALS', 'backendName' => 'operator'], ], + 'example' => '', ], 'MetricStat' => [ - 'title' => '', + 'title' => '查询数据点', 'description' => 'The data queried by BatchExport.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Namespace' => [ - 'title' => 'namespace', - 'description' => 'The namespace of the cloud service.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - 'backendName' => 'namespace', - ], - 'Metric' => [ - 'title' => 'metric', - 'description' => 'The metric that is used to monitor the cloud service.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'cpu_idle', - 'backendName' => 'metric', - ], - 'Period' => [ - 'title' => 'period', - 'description' => 'The time interval based on which the metric value is measured.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'backendName' => 'period', - ], - 'Timestamp' => [ - 'title' => 'timestamp', - 'description' => 'The timestamp of the monitoring data. Unit: milliseconds.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1641454680000', - 'backendName' => 'timestamp', - ], + 'Namespace' => ['title' => 'namespace', 'description' => 'The namespace of the cloud service.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'backendName' => 'namespace'], + 'Metric' => ['title' => 'metric', 'description' => 'The metric that is used to monitor the cloud service.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cpu_idle', 'backendName' => 'metric'], + 'Period' => ['title' => 'period', 'description' => 'The time interval based on which the metric value is measured.'."\n" + ."\n" + .'Unit: seconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'backendName' => 'period'], + 'Timestamp' => ['title' => 'timestamp', 'description' => 'The timestamp of the monitoring data. Unit: milliseconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1641454680000', 'backendName' => 'timestamp'], 'Dimensions' => [ 'title' => 'dimensions', 'description' => 'The dimension information that is used to identify the monitored object (instance).'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The dimension information that is used to identify the monitored object (instance).'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Dimension', - ], + 'items' => ['description' => 'The dimension information that is used to identify the monitored object (instance).'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/Dimension', 'title' => '', 'example' => ''], 'backendName' => 'dimensions', 'itemName' => 'Dimension', + 'example' => '', ], 'Associated' => [ 'title' => 'associated', 'description' => 'The additional information about the monitored object (instance).'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The additional information about the monitored object (instance).'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '{"group":"test****", "name":"Alice"}', - ], + 'additionalProperties' => ['description' => 'The additional information about the monitored object (instance).'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '{"group":"test****", "name":"Alice"}', 'title' => ''], 'backendName' => 'associated', + 'example' => '', ], 'Measurements' => [ 'title' => 'measurements', 'description' => 'The measured value of the metric. The parameter contains multiple values by default.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The measured value of the metric. The parameter contains multiple values by default.'."\n", - 'visibility' => 'public', - 'type' => 'any', - 'example' => '{"Average":60,"Maximum":85}', - ], + 'additionalProperties' => ['description' => 'The measured value of the metric. The parameter contains multiple values by default.'."\n", 'visibility' => 'Public', 'type' => 'any', 'example' => '{"Average":60,"Maximum":85}', 'title' => ''], 'backendName' => 'measurements', + 'example' => '', ], - 'LogTime' => [ - 'title' => 'logTime', - 'description' => 'The recorded time of the monitoring data. Unit: milliseconds. For non-raw data (aggregated data), the value of LogTime is NULL.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683686550073', - 'backendName' => 'logTime', - ], + 'LogTime' => ['title' => 'logTime', 'description' => 'The recorded time of the monitoring data. Unit: milliseconds. For non-raw data (aggregated data), the value of LogTime is NULL.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1683686550073', 'backendName' => 'logTime'], ], + 'example' => '', ], ], ], 'apis' => [ - 'CreateMonitorGroup' => [ - 'summary' => 'Creates an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddTags' => [ + 'summary' => 'The AddTags operation attaches tags to specified application groups.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupName', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', + 'description' => 'A list of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n" + ."\n" + .'The value of N can be from 1 to 3. The tag key must be 1 to 64 characters in length.'."\n" + ."\n" + .'Enter a new tag key or use an existing tag key from Cloud Monitor. For information about how to obtain tag keys, see [DescribeTagKeyList](~~2513189~~).'."\n" + ."\n" + .'> The tag key cannot start with `aliyun` or `acs:`. The `Tag.N.Key` and `Tag.N.Value` parameters must be specified together.', 'type' => 'string', 'required' => true, 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n" + ."\n" + .'The value of N can be from 1 to 3. The tag value must be 1 to 64 characters in length.'."\n" + ."\n" + .'Enter a new tag value or use an existing tag value from Cloud Monitor. For information about how to obtain tag values, see [DescribeTagValueList](~~2513188~~).'."\n" + ."\n" + .'> The tag value cannot start with `aliyun` or `acs:`. The `Tag.N.Key` and `Tag.N.Value` parameters must be specified together.', 'type' => 'string', 'required' => true, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'ECS_Group', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ContactGroups', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The alert contact group. The alert notifications of the application group are sent to the alert contacts that belong to the alert contact group.'."\n" + 'description' => 'The IDs of the application groups.'."\n" ."\n" - .'> An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~PutContact~~) and [PutContactGroup](~~PutContactGroup~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Alert_Group', + .'The value of N can be from 1 to 20.'."\n" + ."\n" + .'For information about how to obtain application group IDs, see [DescribeMonitorGroups](~~2513168~~).', + 'type' => 'array', + 'items' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '7301****', 'title' => ''], + 'required' => true, + 'example' => '7301****', + 'maxItems' => 20, + 'title' => '', ], ], ], @@ -528,298 +260,146 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '83C89BA6-ABD4-4398-A175-83E86C47A001', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DAE4B115-3847-5438-8709-423627F0A3A3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], - ], - [ - [ - 'errorCode' => 'InvalidClientTokenId', - 'errorMessage' => 'not allow this operation.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], - ], - 412 => [ - [ - 'errorCode' => 'ResourcesOverLimit', - 'errorMessage' => 'Resources over limit.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"83C89BA6-ABD4-4398-A175-83E86C47A001\\",\\n \\"GroupId\\": 1234567,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitorGroupResponse>\\n\\t<RequestId>83C89BA6-ABD4-4398-A175-83E86C47A001</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n\\t<GroupId>1234567</GroupId>\\n</CreateMonitorGroupResponse>\\t","errorExample":""}]', - 'title' => 'CreateMonitorGroup', - 'description' => 'In this example, an application group named `ECS_Group` is created.'."\n", - 'requestParamsDescription' => ' ', + 'title' => 'AddTags', + 'description' => 'This topic provides an example of how to attach a tag to the application group `7301****`. In this example, the tag key is `key1` and the tag value is `value1`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~315526~~).', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyMonitorGroup' => [ - 'summary' => '修改应用分组', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-08-28T10:00:57.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTags'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:AddTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"DAE4B115-3847-5438-8709-423627F0A3A3\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ApplyMetricRuleTemplate' => [ + 'summary' => 'Applies an alert template to an application group to generate alert rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'SilenceTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The mute for. Unit: seconds. Default value: 86400.'."\n" + ."\n" + .'> When monitoring data continuously exceeds the alert rule threshold, only one alert notification is sent within each mute period.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '86400', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs_group', - ], + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For information about how to obtain the application group ID, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'ContactGroups', + 'name' => 'TemplateIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert groups that can receive alert notifications for the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alarm_ecs_group', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C85A2870-5DF4-4269-BC50-ECB5E4591A80', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + 'schema' => ['description' => 'The ID of the alert template.'."\n" + ."\n" + .'For information about how to obtain the alert template ID, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '700****', 'title' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + 'name' => 'EnableStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the alert effective period. Valid values: 00 to 23, which indicates 00:00 to 23:00.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '00', 'title' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + 'name' => 'EnableEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the alert effective period. Valid values: 00 to 23, which indicates 00:59 to 23:59.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '23', 'title' => ''], ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + [ + 'name' => 'NotifyLevel', + 'in' => 'query', + 'schema' => ['description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'<props="china">- 2: phone call + text message + mailbox + TradeManager + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- 3: text message + mailbox + TradeManager + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- 4: TradeManager + DingTalk chatbot.</props>'."\n" + ."\n\n" + .'<props="intl">4: TradeManager + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="partner">4: TradeManager + DingTalk chatbot.</props>', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + 'name' => 'ApplyMode', + 'in' => 'query', + 'schema' => ['description' => 'The mode in which the alert template is applied. Valid values:'."\n" + ."\n" + .'- GROUP_INSTANCE_FIRST: application group instances take priority. When the alert template is applied, instances in the application group take priority. If an instance does not exist in the application group, the rule in the template is ignored.'."\n" + ."\n" + .'- ALARM_TEMPLATE_FIRST: alert template instances take priority. When the alert template is applied, alert rules are created regardless of whether the instances exist in the application group.', 'type' => 'string', 'required' => false, 'example' => 'GROUP_INSTANCE_FIRST', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"C85A2870-5DF4-4269-BC50-ECB5E4591A80\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ModifyMonitorGroup', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteMonitorGroup' => [ - 'summary' => 'Deletes an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => ['description' => 'The callback URL to which a POST request is sent when an alert is triggered.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'AppendMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The policy for applying the template. Valid values:'."\n" + ."\n" + .'- all: deletes all rules that were created from alert templates for the selected group, and then creates new alert rules based on the template (default value).'."\n" + ."\n" + .'- append: deletes the rules that were created from this alert template for the selected group, and then creates new alert rules based on the current template.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], ], ], 'responses' => [ @@ -827,729 +407,285 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CA35B3AE-4FFD-4A33-AE67-67EF68711EFA', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Group' => [ - 'description' => 'The deleted application group.'."\n", + 'Code' => ['description' => 'The status code.'."\n" + .'>The value 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3F897F3C-020A-4993-95B4-63ABB84F83E6', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resource' => [ + 'description' => 'The resources affected by the alert rules.', 'type' => 'object', 'properties' => [ - 'GroupName' => [ - 'description' => 'The name of the application group.', - 'type' => 'string', - 'example' => 'ECS_test', - ], - 'ContactGroups' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroup' => [ - 'description' => 'The alert groups that receive alert notifications for the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the alert group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - ], - ], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'AlertResults' => [ + 'description' => 'The details of the generated alert rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the generated alert rules.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'alert rule is creating, please wait a few minutes.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'test123', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - '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' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - [ - 'errorCode' => 'InvalidClientTokenId', - 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"CA35B3AE-4FFD-4A33-AE67-67EF68711EFA\\",\\n \\"Success\\": true,\\n \\"Group\\": {\\n \\"GroupName\\": \\"ECS_test\\",\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Name\\": \\"ECS_Group\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteMonitorGroup>\\n\\t\\t<Group>\\n\\t\\t\\t<GroupName>ECS_test</GroupName>\\n\\t\\t\\t<ContactGroups>\\n\\t\\t\\t\\t<ContactGroup>\\n\\t\\t\\t\\t\\t<Name>ECS_Group</Name>\\n\\t\\t\\t\\t</ContactGroup>\\n\\t\\t\\t</ContactGroups>\\n\\t\\t</Group>\\n\\t\\t<RequestId>EFB8C3EC-3460-4EC9-8603-A9FE9D0A6C2C</RequestId>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</DeleteMonitorGroup>","errorExample":""}]', - 'title' => 'DeleteMonitorGroup', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3F897F3C-020A-4993-95B4-63ABB84F83E6\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"GroupId\\": 123456,\\n \\"AlertResults\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"alert rule is creating, please wait a few minutes.\\",\\n \\"Success\\": true,\\n \\"RuleName\\": \\"test123\\",\\n \\"RuleId\\": \\"applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Apply an alert template to an application group', + 'description' => 'This topic provides an example on how to apply the alert template `700****` to the application group `123456`. The ID of the generated alert rule is `applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****`, and the name is `test123`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitorGroups' => [ - 'summary' => 'Queries application groups.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-02-27T07:25:21.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyMetricRuleTemplate'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'SelectContactGroups', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to include the alert contact groups in the response. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Pages start from page 1. Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - ], - [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used for the search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID. This parameter is used to query the application group to which the specified instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-abcdefgh12****', - ], - ], - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testGroup124', - ], - ], - [ - 'name' => 'IncludeTemplateHistory', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to include the historical alert templates that are applied to the application group in the response. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the application group. Valid values:'."\n" - ."\n" - .'* custom: a self-managed application group'."\n" - .'* ehpc_cluster: an application group that is synchronized from an E-HPC cluster'."\n" - .'* kubernetes: an application group that is synchronized from an ACK cluster'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'custom', - 'enum' => [ - 'custom', - 'ehpc_cluster', - 'kubernetes', - 'tag', - 'aone_group', - 'resMgr', - 'ess', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:ApplyMetricRuleTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MetricRuleTemplate', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], ], ], ], + ], + ], + 'BatchCreateInstantSiteMonitor' => [ + 'summary' => 'You can call the BatchCreateInstantSiteMonitor operation to create a batch of site monitoring tasks.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DynamicTagRuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the tag rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', - ], - ], - [ - 'name' => 'GroupFounderTagKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tag key that is created for the application group by using the tag rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GroupKey1', - ], - ], - [ - 'name' => 'GroupFounderTagValue', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tag value that is created for the application group by using the tag rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GroupValue1', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group. Separate multiple application group IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '92****', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'Tag', + 'name' => 'TaskList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags of the application group.'."\n", + 'description' => 'The list of site monitoring tasks.'."\n" + ."\n" + .'> You must create at least one site monitoring task. The `Address`, `TaskName`, and `TaskType` parameters are required.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The list of site monitoring tasks.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the application group. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tagKey1', - ], - 'Value' => [ - 'description' => 'The tag value of the application group. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tagValue1', - ], + 'Address' => ['description' => 'The URL or IP address of the site monitoring task.'."\n" + ."\n" + .'> You must create at least one site monitoring task. The `Address`, `TaskName`, and `TaskType` parameters are required.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], + 'IspCities' => ['description' => 'The information about the detection points. If you leave this parameter empty, the system randomly selects three detection points.'."\n" + ."\n" + .'The value must be a `JSONArray`. For example, `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]` corresponds to Beijing, Hangzhou, and Qingdao.'."\n" + ."\n" + .'For more information about how to obtain detection point information, see [DescribeSiteMonitorISPCityList](~~115045~~).', 'type' => 'string', 'required' => false, 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', 'title' => ''], + 'OptionsJson' => ['description' => 'The advanced extension options for the protocol type of the site monitoring task. Different protocol types correspond to different extension options.', 'type' => 'string', 'required' => false, 'example' => '{"time_out":5000}', 'title' => ''], + 'TaskName' => ['description' => 'The name of the site monitoring task.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'The value must be 4 to 100 characters in length and can contain English letters, numbers, underscores (\\_), and Chinese characters.'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'The name of the site monitoring task.'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="partner">'."\n" + ."\n" + .'The name must be 4 to 100 characters in length and can contain letters, digits, and underscores (\\_).'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'> You must create at least one site monitoring task. The `Address`, `TaskName`, and `TaskType` parameters are required.', 'type' => 'string', 'required' => false, 'example' => 'HangZhou_ECS1', 'title' => ''], + 'TaskType' => ['description' => 'The protocol type of the monitoring task.'."\n" + ."\n" + .'Valid values: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.'."\n" + ."\n" + .'> You must create at least one site monitoring task. The `Address`, `TaskName`, and `TaskType` parameters are required.', 'type' => 'string', 'required' => false, 'example' => 'HTTP', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, - 'maxItems' => 5, - ], - ], - [ - 'name' => 'Types', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the application group. Valid values:'."\n" - ."\n" - .'* custom: a self-managed application group'."\n" - .'* ehpc_cluster: an application group that is synchronized from an Elastic High Performance Computing (E-HPC) cluster'."\n" - .'* kubernetes: an application group that is synchronized from a Container Service for Kubernetes (ACK) cluster'."\n" - .'* tag: an application group that is automatically created by using tags'."\n" - .'* resMgr: an application group that is created by using resource groups'."\n" - .'* ess: an application group that is synchronized from Auto Scaling (ESS)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'custom', + 'required' => true, + 'maxItems' => 200, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'description' => 'The results returned.'."\n", + 'title' => '', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F02B299A-D374-4595-9F55-7534D604F132', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Resources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Resource' => [ - 'description' => 'The resources that are associated with the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resources that are associated with the application group.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the application group. Valid values:'."\n" - ."\n" - .'* custom: a self-managed application group'."\n" - .'* ehpc_cluster: an application group that is synchronized from an E-HPC cluster'."\n" - .'* kubernetes: an application group that is synchronized from an ACK cluster'."\n", - 'type' => 'string', - 'example' => 'custom', - ], - 'GroupFounderTagValue' => [ - 'description' => 'The tag value that is created for the application group by using the tag rule.'."\n", - 'type' => 'string', - 'example' => 'GroupValue1', - ], - 'BindUrl' => [ - 'description' => 'The URL of the ACK cluster from which the application group is synchronized.'."\n", - 'type' => 'string', - 'example' => 'https://aliyun.com', - ], - 'GroupName' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', - 'example' => 'test123', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'ServiceId' => [ - 'description' => 'The ID of the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'example' => '49****', - ], - 'DynamicTagRuleId' => [ - 'description' => 'The ID of the tag rule.'."\n", - 'type' => 'string', - 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', - ], - 'GmtCreate' => [ - 'description' => 'The timestamp when the application group was created. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1603181891000', - ], - 'GroupFounderTagKey' => [ - 'description' => 'The tag key that is created for the application group by using the tag rule.'."\n", - 'type' => 'string', - 'example' => 'GroupKey1', - ], - 'GmtModified' => [ - 'description' => 'The timestamp when the application group was modified. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1603181891000', - ], - 'ContactGroups' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroup' => [ - 'description' => 'The alert contact groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - ], - ], - ], - ], - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'description' => 'The tags that are attached to the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the application group.'."\n", - 'type' => 'string', - 'example' => 'tagKey1', - ], - 'Value' => [ - 'description' => 'The tag value of the application group.'."\n", - 'type' => 'string', - 'example' => 'tagValue1', - ], - ], - ], - ], - ], - ], - 'TemplateIds' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TemplateId' => [ - 'description' => 'The ID of the template.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert templates that are applied to the application group.'."\n", - 'type' => 'string', - 'example' => '92****', - ], - ], - ], - ], - 'ResourceGroupId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'rg-aek2hopjh*******', - ], - 'TemplateInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TemplateInfo' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EffectTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'TemplateId' => [ - 'type' => 'string', - ], - 'Ver' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7AE72720-2C96-5446-9F2B-308C7CEDFF1A'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The information about the site monitoring tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the site monitoring tasks.', + 'type' => 'object', + 'properties' => [ + 'TaskName' => ['description' => 'The name of the site monitoring task.', 'type' => 'string', 'example' => 'HangZhou_ECS1', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the site monitoring task.', 'type' => 'string', 'example' => '679fbe4f-b80b-4706-91b2-5427b43e****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '[{"taskName": "HangZhou_ECS1", "taskId": "679fbe4f-b80b-4706-91b2-5427b43e****"}]', + 'title' => '', ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => ''], ], - [ - [ - '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.', - ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 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', - ], + ['errorCode' => 'ResourceOverLimit', 'errorMessage' => 'The resource has exceeded the limit. %s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F02B299A-D374-4595-9F55-7534D604F132\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Total\\": 10,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Type\\": \\"custom\\",\\n \\"GroupFounderTagValue\\": \\"GroupValue1\\",\\n \\"BindUrl\\": \\"https://aliyun.com\\",\\n \\"GroupName\\": \\"test123\\",\\n \\"GroupId\\": 12345,\\n \\"ServiceId\\": \\"49****\\",\\n \\"DynamicTagRuleId\\": \\"6b882d9a-5117-42e2-9d0c-4749a0c6****\\",\\n \\"GmtCreate\\": 1603181891000,\\n \\"GroupFounderTagKey\\": \\"GroupKey1\\",\\n \\"GmtModified\\": 1603181891000,\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Name\\": \\"CloudMonitor\\"\\n }\\n ]\\n },\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tagKey1\\",\\n \\"Value\\": \\"tagValue1\\"\\n }\\n ]\\n },\\n \\"TemplateIds\\": {\\n \\"TemplateId\\": [\\n \\"92****\\"\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-aek2hopjh*******\\",\\n \\"TemplateInfos\\": {\\n \\"TemplateInfo\\": [\\n {\\n \\"EffectTime\\": 1603181891000,\\n \\"TemplateId\\": \\"123***\\",\\n \\"Ver\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitorGroupsResponse>\\n <RequestId>F02B299A-D374-4595-9F55-7534D604F132</RequestId>\\n <PageSize>30</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>2</Total>\\n <Resources>\\n <Resource>\\n <GroupName>testGroup124</GroupName>\\n <ContactGroups>\\n <ContactGroup>\\n <Name>CloudMonitor</Name>\\n </ContactGroup>\\n </ContactGroups>\\n <Type>custom</Type>\\n <GmtCreate>1603181891000</GmtCreate>\\n <GmtModified>1603181891000</GmtModified>\\n <GroupFounderTagKey>1204</GroupFounderTagKey>\\n <GroupFounderTagValue>001</GroupFounderTagValue>\\n <TemplateIds>\\n <TemplateId>92****</TemplateId>\\n </TemplateIds>\\n <Tags>\\n <Tag>\\n <Value>tagKey1</Value>\\n <Key>tagValue1</Key>\\n </Tag>\\n </Tags>\\n <GroupId>7301****</GroupId>\\n </Resource>\\n <Resource>\\n <GroupName>test123</GroupName>\\n <ContactGroups>\\n <ContactGroup>\\n <Name>CloudMonitor</Name>\\n </ContactGroup>\\n </ContactGroups>\\n <Type>tag</Type>\\n <GmtCreate>1603181891000</GmtCreate>\\n <DynamicTagRuleId>6b882d9a-5117-42e2-9d0c-4749a0c6****</DynamicTagRuleId>\\n <GmtModified>1603181891000</GmtModified>\\n <GroupFounderTagKey>GroupKey1</GroupFounderTagKey>\\n <GroupFounderTagValue>GroupValue1</GroupFounderTagValue>\\n <TemplateIds>\\n </TemplateIds>\\n <Tags>\\n </Tags>\\n <GroupId>92****</GroupId>\\n </Resource>\\n </Resources>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeMonitorGroupsResponse>","errorExample":""}]', - 'title' => 'DescribeMonitorGroups', - 'description' => 'This topic provides an example of how to query the application groups of the current account. The response shows that the current account has two application groups: `testGroup124` and `test123`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'BatchCreateInstantSiteMonitor', + 'description' => 'This topic provides an example of how to create a site monitoring task named `HangZhou_ECS1`. The task uses the `HTTP` protocol to monitor `https://www.aliyun.com`. The response shows that the task is successfully created with the name `HangZhou_ECS1` and the ID `679fbe4f-b80b-4706-91b2-5427b43e****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateMonitorGroupInstances' => [ - 'summary' => 'Adds resources to an application group.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-07-22T08:20:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-21T06:24:11.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreateInstantSiteMonitor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:BatchCreateInstantSiteMonitor', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7AE72720-2C96-5446-9F2B-308C7CEDFF1A\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"TaskName\\": \\"HangZhou_ECS1\\",\\n \\"TaskId\\": \\"679fbe4f-b80b-4706-91b2-5427b43e****\\"\\n }\\n ],\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + ], + 'BatchCreateOnceSiteMonitor' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '3607****', - ], - ], - [ - 'name' => 'Instances', + 'name' => 'TaskList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The instances that you want to add to the application group.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'InstanceName' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-instance-ecs', - ], - 'Category' => [ - 'description' => 'The abbreviation of the Alibaba Cloud service name.'."\n" - ."\n" - .'To obtain the abbreviation of an Alibaba Cloud service name, call the [DescribeProjectMeta](~~114916~~) operation. The `metricCategory` tag in the `Labels` response parameter indicates the abbreviation of the Alibaba Cloud service name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'i-2ze26xj5wwy12****', - ], - 'RegionId' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => ' cn-hangzhou', - ], + 'Address' => ['type' => 'string'], + 'IspCities' => ['type' => 'string'], + 'OptionsJson' => ['type' => 'string'], + 'TaskName' => ['type' => 'string'], + 'TaskType' => ['type' => 'string'], ], - 'required' => false, ], 'required' => true, - 'maxItems' => 2000, + 'maxItems' => 200, + 'minItems' => 1, ], ], ], @@ -1558,1408 +694,1289 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1BC69FEB-56CD-4555-A0E2-02536A24A946', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], + 'Data' => ['type' => 'string'], + 'Code' => ['type' => 'string'], ], - 'description' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => ''], ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], - ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], - ], - [ - [ - 'errorCode' => 'InvalidClientTokenId', - 'errorMessage' => 'not allow this operation.', - ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => '%s', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => '%s', - ], - ], - 412 => [ - [ - 'errorCode' => 'ResourcesOverLimit', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceOverLimit', 'errorMessage' => 'The resource has exceeded the limit. %s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"1BC69FEB-56CD-4555-A0E2-02536A24A946\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitorGroupInstancesResponse>\\n <RequestId>1BC69FEB-56CD-4555-A0E2-02536A24A946</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</CreateMonitorGroupInstancesResponse>","errorExample":""}]', - 'title' => 'CreateMonitorGroupInstances', - 'description' => 'You can add a maximum of 1,000 instances to an application group at a time. You can add a maximum of 3,000 instances of an Alibaba Cloud service to an application group. The total number of instances that you can add to an application group is unlimited.'."\n" - ."\n" - .'In this example, an Elastic Compute Service (ECS) instance in the `China (Hangzhou)` region is added to the `3607****` application group. The instance ID is `i-2ze26xj5wwy12****` and the instance name is `test-instance-ecs`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyMonitorGroupInstances' => [ - 'summary' => '修改应用分组中的资源', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-04-15T12:04:08.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\"\\n}","type":"json"}]', + ], + 'BatchExport' => [ + 'summary' => 'Calls the BatchExport operation to export monitoring data defined in the Cursor operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => 'The data namespace of the cloud service.'."\n" + ."\n" + .'For information about how to obtain the data namespace of a cloud service, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> This parameter must be the same as the request parameter `Namespace` in the Cursor operation.', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'Instances', - 'in' => 'query', - 'style' => 'repeatList', + 'name' => 'Metric', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the metric of the cloud service.'."\n" + ."\n" + .'For information about how to obtain the name of a metric of a cloud service, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> This parameter must be the same as the request parameter `Metric` in the Cursor operation.', 'type' => 'string', 'required' => true, 'example' => 'cpu_idle', 'title' => ''], + ], + [ + 'name' => 'Cursor', + 'in' => 'formData', + 'schema' => ['description' => 'When you call this operation in a loop to export data, you must specify the value of `Cursor`. You can obtain the value of `Cursor` by using the following methods:'."\n" + ."\n" + .'- When you call this operation for the first time, you must first call the Cursor operation to obtain the value of `Cursor`. For more information, see [Cursor](~~2330730~~).'."\n" + ."\n" + .'- When you call this operation again, you can obtain the value of `Cursor` from the response of the last call.'."\n", 'type' => 'string', 'required' => true, 'example' => 'eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****', 'title' => ''], + ], + [ + 'name' => 'Length', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of data entries to return each time.'."\n" + ."\n" + .'Valid values: 1 to 10000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'Measurements', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The measurements that are used to customize the returned data. By default, all measurements are returned.'."\n" + ."\n" + .'For example, the metric `cpu_idle` of the cloud service `acs_ecs_dashboard` has three measurement columns: `Average`, `Maximum`, and `Minimum`. If you only need to return the `Average` and `Maximum` columns, set this parameter to the array `["Average", "Maximum"]`.'."\n" + ."\n" + .'For information about how to obtain the measurements of a metric of a cloud service, see the `statistics` column of [Appendix 1: Metrics](~~163515~~).', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceName' => [ - 'description' => 'The name of the instance. Valid values of N: 1 to 2000.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HostName', - ], - 'Category' => [ - 'description' => 'The abbreviation of the name of the service to which the instances to be added to the application group belong. Valid values:'."\n" - ."\n" - .'* ECS: Elastic Compute Service (ECS) instances provided by Alibaba Cloud and hosts not provided by Alibaba Cloud'."\n" - ."\n" - .'* RDS: ApsaraDB for RDS'."\n" - ."\n" - .'* ADS: AnalyticDB'."\n" - ."\n" - .'* SLB: Server Load Balancer (SLB)'."\n" - ."\n" - .'* VPC: Virtual Private Cloud (VPC)'."\n" - ."\n" - .'* APIGATEWAY: API Gateway'."\n" - ."\n" - .'* CDN: Alibaba Cloud Content Delivery Network (CDN)'."\n" - ."\n" - .'* CS: Container Service for Swarm'."\n" - ."\n" - .'* DCDN: Dynamic Route for CDN'."\n" - ."\n" - .'* DDoS: Anti-DDoS Pro'."\n" - ."\n" - .'* EIP: Elastic IP Address (EIP)'."\n" - ."\n" - .'* ELASTICSEARCH: Elasticsearch'."\n" - ."\n" - .'* EMR: E-MapReduce'."\n" - ."\n" - .'* ESS: Auto Scaling'."\n" - ."\n" - .'* HBASE: ApsaraDB for Hbase'."\n" - ."\n" - .'* IOT_EDGE: IoT Edge'."\n" - ."\n" - .'* K8S_POD: pods in Container Service for Kubernetes'."\n" - ."\n" - .'* KVSTORE_SHARDING: ApsaraDB for Redis of the cluster architecture'."\n" - ."\n" - .'* KVSTORE_SPLITRW: ApsaraDB for Redis of the read/write splitting architecture'."\n" - ."\n" - .'* KVSTORE_STANDARD: ApsaraDB for Redis of the standard architecture'."\n" - ."\n" - .'* MEMCACHE: ApsaraDB for Memcache'."\n" - ."\n" - .'* MNS: Message Service (MNS)'."\n" - ."\n" - .'* MONGODB: ApsaraDB for MongoDB of the replica set architecture'."\n" - ."\n" - .'* MONGODB_CLUSTER: ApsaraDB for MongoDB of the cluster architecture'."\n" - ."\n" - .'* MONGODB_SHARDING: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" - ."\n" - .'* MQ_TOPIC: MNS topics'."\n" - ."\n" - .'* OCS: ApsaraDB for Memcache of earlier versions'."\n" - ."\n" - .'* OPENSEARCH: Open Search'."\n" - ."\n" - .'* OSS: Object Storage Service (OSS)'."\n" - ."\n" - .'* POLARDB: PolarDB'."\n" - ."\n" - .'* PETADATA: HybridDB for MySQL'."\n" - ."\n" - .'* SCDN: Secure Content Delivery Network (SCDN)'."\n" - ."\n" - .'* SHAREBANDWIDTHPACKAGES: EIP Bandwidth Plan'."\n" - ."\n" - .'* SLS: Log Service'."\n" - ."\n" - .'* VPN: VPN Gateway'."\n" - ."\n" - .' Valid values of N: 1 to 2000.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance. Valid values of N: 1 to 2000.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'i-a2d5q7pm12****', - ], - 'RegionId' => [ - 'description' => 'The ID of the region where the instance resides. Valid values of N: 1 to 2000.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 2000, + 'items' => ['description' => 'The column name of the measurement.', 'type' => 'string', 'required' => false, 'example' => 'Maximum', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'FEC7EDB3-9B08-4AC0-A42A-329F5D14B95A', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: successful'."\n" + ."\n" + .'- false: failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '251402CD-305C-1617-808E-D8C11FC8138D', 'title' => ''], + 'Cursor' => ['description' => 'The cursor that is used to call this operation again.'."\n" + ."\n" + .'> If the returned result is `null`, the monitoring data has been exported.', 'type' => 'string', 'example' => 'v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***', 'title' => ''], + 'Length' => ['description' => 'The number of data entries returned for this call.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'Anchor' => ['description' => 'The timestamp when the backend requested the data. A larger timestamp indicates that the exported data is closer to the current time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1678781819000', 'title' => ''], + 'HasNext' => ['description' => 'Indicates whether the data has been exported. Valid values:'."\n" + ."\n" + .'- true: Some data has not been exported.'."\n" + .'- false: All data has been exported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DataResults' => [ + 'description' => 'The data returned by this call.', + 'type' => 'array', + 'items' => ['description' => 'The exported data. The details are as follows:'."\n" + .'- Namespace: the data namespace of the cloud service. Example: `acs_ecs_dashboard`.'."\n" + .'- Metric: the name of the metric of the cloud service. Example: `cpu_idle`.'."\n" + .'- Timestamp: the timestamp of the monitoring data. Unit: milliseconds. Example: 1641454680000.'."\n" + .'- Period: the statistical period of the monitoring data. Unit: seconds. Example: 60.'."\n" + .'- Dimensions: the Dimension information that is used to identify the monitored object (instance). Example: `[{"Label":"userId", "Value":""20654616023382****"}, {"Label":"InstanceId", "Value":""i-2ze2d6j5uhg20x4****"}]`.'."\n" + .'- Associated: the additional information about the monitored object (instance), such as tag information. The value is a collection of key:value pairs. Example: `{"group":"test****", "name":"Alice"}`.'."\n" + .'- Measurements: the measurements of the metric (multi-value mode by default). Example: `{"Average":60,"Maximum":85}`.'."\n" + .'- LogTime: the record time of the monitoring data. Unit: milliseconds. For non-raw data (aggregated data), `LogTime` is empty (NULL).', '$ref' => '#/components/schemas/MetricStat', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Parameter invalid.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - '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.', - ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => '%s', - ], - ], - 412 => [ - [ - 'errorCode' => 'ResourcesOverLimit', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Exports the monitoring data defined in Cursor', + 'description' => '### Prerequisites'."\n" + .'Make sure that you have called the [Cursor](~~2330730~~) operation to obtain the initial `Cursor`.'."\n" + .'### Usage notes'."\n" + .'This topic provides an example to show how to export the monitoring data of an initial `Cursor` of the metric `cpu_idle` of the cloud service `acs_ecs_dashboard`. A maximum of 1,000 data entries are returned per call.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchExport'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:BatchExport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEC7EDB3-9B08-4AC0-A42A-329F5D14B95A\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyMonitorGroupInstancesResponse>\\n <RequestId>02977C39-9E74-430A-B35B-04CFBF0E7F64</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</ModifyMonitorGroupInstancesResponse>","errorExample":""}]', - 'title' => 'ModifyMonitorGroupInstances', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"RequestId\\": \\"251402CD-305C-1617-808E-D8C11FC8138D\\",\\n \\"Cursor\\": \\"v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***\\",\\n \\"Length\\": 1000,\\n \\"Anchor\\": 1678781819000,\\n \\"HasNext\\": true,\\n \\"DataResults\\": [\\n {\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Metric\\": \\"cpu_idle\\",\\n \\"Period\\": 60,\\n \\"Timestamp\\": 1641454680000,\\n \\"Dimensions\\": [\\n {\\n \\"Label\\": \\"instanceId\\",\\n \\"Value\\": \\"i-dferwret*****\\"\\n }\\n ],\\n \\"Associated\\": {\\n \\"key\\": \\"{\\\\\\"group\\\\\\":\\\\\\"test****\\\\\\", \\\\\\"name\\\\\\":\\\\\\"Alice\\\\\\"}\\"\\n },\\n \\"Measurements\\": {\\n \\"key\\": \\"{\\\\\\"Average\\\\\\":60,\\\\\\"Maximum\\\\\\":85}\\"\\n },\\n \\"LogTime\\": 1683686550073\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeMonitorGroupInstances' => [ - 'summary' => 'Queries the resources in an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateDynamicTagGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'TagKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The tag key of the resource.'."\n" + ."\n" + .'For more information about how to query the tag keys of resources, see [DescribeTagKeyList](~~145558~~).', 'type' => 'string', 'required' => true, 'example' => 'ecs_instance', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'ContactGroupList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'description' => 'The alert contact groups. The value of N can be from 1 to 100. Alert notifications for the application group are sent to the alert contacts in these alert contact groups.'."\n" + ."\n" + .'An alert contact group can contain one or more alert contacts. For more information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For more information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).', + 'type' => 'array', + 'items' => ['description' => 'The alert contact groups. The value of N can be from 1 to 100. Alert notifications for the application group are sent to the alert contacts in these alert contact groups.'."\n" + ."\n" + .'An alert contact group can contain one or more alert contacts. For more information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For more information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ECS_Group', 'title' => ''], + 'required' => true, + 'docRequired' => true, + 'example' => 'ECS_Group', + 'maxItems' => 10, + 'title' => '', ], ], [ - 'name' => 'GroupId', + 'name' => 'MatchExpress', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The match expressions that are used to create an application group from tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The match expressions that are used to create an application group from tags. The value of N can be from 1 to 3.', + 'type' => 'object', + 'properties' => [ + 'TagValueMatchFunction' => ['description' => 'The method that is used to match the values of resource tags. The value of N is 1. Valid values:'."\n" + ."\n" + .'- contains: includes.'."\n" + ."\n" + .'- startWith: prefix.'."\n" + ."\n" + .'- endWith: suffix.'."\n" + ."\n" + .'- notContains: does not include.'."\n" + ."\n" + .'- equals: equals.'."\n" + ."\n" + .'- all: all.'."\n" + ."\n" + .'> You must specify both the `MatchExpress.N.TagValueMatchFunction` and `MatchExpress.N.TagValue` parameters.', 'type' => 'string', 'required' => false, 'example' => 'contains', 'title' => ''], + 'TagValue' => ['description' => 'The value of the resource tag. The value of N is 1.'."\n" + ."\n" + .'> You must specify both the `MatchExpress.N.TagValueMatchFunction` and `MatchExpress.N.TagValue` parameters.', 'type' => 'string', 'required' => false, 'example' => 'instance', 'title' => ''], + 'TagName' => ['description' => 'The key of the tag that is used to create the group. If multiple resources have this tag key, the resources that meet the filter conditions are added to the same group based on the same key-value pair.', 'type' => 'string', 'required' => false, 'example' => 'appname', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '12345', + 'maxItems' => 4, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Category', + 'name' => 'TagRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the cloud service name. Valid values of N: 1 to 200.'."\n" - ."\n" - .'> For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The ID of the region to which the tag belongs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'EnableSubscribeEvent', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword used to search for instances. Fuzzy search based on instance names is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 's1', - ], + 'schema' => ['description' => 'Specifies whether to automatically subscribe to event notifications for the application group. When a critical or warning event occurs on a resource in the application group, CloudMonitor sends an alert notification. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + ."\n" + .'- false (default): disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'InstanceIds', + 'name' => 'EnableInstallAgent', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to automatically install the CloudMonitor agent for the application group. CloudMonitor automatically installs the agent on the hosts in the application group. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + ."\n" + .'- false (default): disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'MatchExpressFilterRelation', 'in' => 'query', + 'schema' => ['description' => 'The relationship between the conditional expressions for the tag values. Valid values:'."\n" + ."\n" + .'- and (default)'."\n" + ."\n" + .'- or', 'type' => 'string', 'required' => false, 'default' => 'and', 'example' => 'and', 'title' => ''], + ], + [ + 'name' => 'TemplateIdList', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The instance ID. You can query multiple instances by specifying multiple IDs.'."\n", - 'type' => 'string', + 'description' => 'The ID of the alert template.'."\n" + ."\n" + .'For more information about how to query the IDs of alert templates, see [DescribeMetricRuleTemplateList](~~114982~~).', + 'type' => 'array', + 'items' => ['description' => 'The ID of the alert template.'."\n" + ."\n" + .'For more information about how to query the IDs of alert templates, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'string', 'required' => false, 'example' => '70****', 'title' => ''], 'required' => false, - 'example' => 'i-x1234568', + 'example' => '85****', + 'maxItems' => 10, + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '97F2A410-9412-499C-9AD1-76EF7EC02DF2', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Resources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Resource' => [ - 'description' => 'The information about the resources in the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Category' => [ - 'description' => 'The abbreviation of the service name.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'i-2ze3w55tr2r****', - ], - 'InstanceName' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'hostIP', - ], - 'Id' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'RegionId' => [ - 'description' => 'The ID of the region where the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '84AC6F0B-7945-466A-AA44-99BB5A561F86', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The ID of the tag matching rule.', 'type' => 'string', 'example' => '2534dc0a-e3e5-4ae1-a2fc-75ef166c****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - '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', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'ResourceOverLimit', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"97F2A410-9412-499C-9AD1-76EF7EC02DF2\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Category\\": \\"ecs\\",\\n \\"InstanceId\\": \\"i-bp12g4xbl4i0brkn****\\",\\n \\"InstanceName\\": \\"test-s1\\",\\n \\"Id\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<PageNumber>1</PageNumber>\\n<PageSize>30</PageSize>\\n<RequestId>7670220A-0725-42EE-9252-8200C4F810D9</RequestId>\\n<Success>true</Success>\\n<Code>200</Code>\\n<Total>1</Total>\\n<Resources>\\n <Resource>\\n <Category>ECS</Category>\\n <InstanceId>i-2ze3w55tr2rcpejp****</InstanceId>\\n <RegionId>cn-beijing</RegionId>\\n <InstanceName>dynamic_group_1</InstanceName>\\n </Resource>\\n</Resources>","errorExample":""}]', - 'title' => 'DescribeMonitorGroupInstances', - 'requestParamsDescription' => ' ', + 'title' => 'CreateDynamicTagGroup', + 'summary' => 'You can call the CreateDynamicTagGroup operation to automatically create application groups using tags.', + 'description' => 'This operation supports the following Alibaba Cloud services: Elastic Compute Service (ECS), ApsaraDB RDS, and Server Load Balancer (SLB).'."\n" + ."\n" + .'This topic provides an example of how to automatically create an application group for resources that have the `ecs_instance` tag key. The alert contact group for the application group is `ECS_Group`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitorGroupDynamicRules' => [ - 'summary' => 'Queries the dynamic rules of an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2023-03-15T03:17:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-13T10:09:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-09-24T08:25:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-24T08:25:15.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDynamicTagGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateDynamicTagGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"84AC6F0B-7945-466A-AA44-99BB5A561F86\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"2534dc0a-e3e5-4ae1-a2fc-75ef166c****\\"\\n}","type":"json"}]', + ], + 'CreateGroupMetricRules' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For information about how to obtain the application group ID, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '3607****', 'title' => ''], + ], + [ + 'name' => 'GroupMetricRules', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', + 'description' => 'The list of metric-based alert rules for the application group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The metric-based alert rule for the application group.', + 'type' => 'object', + 'properties' => [ + 'Escalations.Info.Threshold' => ['description' => 'The threshold for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + 'MetricName' => ['description' => 'The name of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the metric name, see [DescribeMetricMetaList](~~98846~~) or [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_total', 'title' => ''], + 'Escalations.Warn.Threshold' => ['description' => 'The threshold for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The effective period of the alert rule. Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => '05:31-23:59', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'The time period during which the alert rule is ineffective. Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => '00:00-05:30', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => true, 'example' => '456789', 'title' => ''], + 'Escalations.Critical.Times' => ['description' => 'The number of times that the monitoring metric must reach the alert threshold before a Critical-level alert notification is sent.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Settings for at least one of the alert severity levels Critical, Warn (warning), or Info must be specified. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Dimensions' => ['description' => 'The monitoring dimensions of the specified resource.'."\n" + ."\n" + .'The value is a collection of `key:value` pairs, such as `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"i-m5e1qg6uo38rztr4****"}]', 'title' => ''], + 'Escalations.Critical.Threshold' => ['description' => 'The threshold that triggers Critical-level alert notifications.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + 'Escalations.Critical.Statistics' => ['description' => 'The statistical method for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The valid values of this parameter are determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the valid values, see [Cloud service monitoring](~~163515~~).'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Warn.ComparisonOperator' => ['description' => 'The comparison operator for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold. '."\n" + .'- GreaterThanThreshold: greater than the threshold. '."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold. '."\n" + .'- LessThanThreshold: less than the threshold. '."\n" + .'- NotEqualToThreshold: not equal to the threshold. '."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday. '."\n" + .'- LessThanYesterday: less than the value at the same time yesterday. '."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week. '."\n" + .'- LessThanLastWeek: less than the value at the same time last week. '."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period. '."\n" + .'- LessThanLastPeriod: less than the value in the last period. '."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Info.Times' => ['description' => 'The number of times that the monitoring metric must reach the alert threshold before an Info-level alert notification is sent.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Settings for at least one of the alert severity levels Critical, Warn (warning), or Info must be specified. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'SilenceTime' => ['description' => 'The mute period of the alert notification. Valid values of N: 1 to 200.'."\n" + ."\n" + .'Unit: seconds. Default value: 86400. Minimum value: 3600.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL to which an alert notification is sent. Valid values of N: 1 to 200.'."\n" + ."\n" + .'Specify a publicly accessible URL. CloudMonitor sends a POST request to push alert information to this URL. Only the HTTP protocol is supported.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the namespace of an Alibaba Cloud service, see [DescribeMetricMetaList](~~98846~~) or [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'EmailSubject' => ['description' => 'The subject of the alert notification email.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => 'ECS instance', 'title' => ''], + 'Period' => ['description' => 'The reporting period of monitoring data.'."\n" + ."\n" + .'Valid values of N: 1 to 200. '."\n" + ."\n" + .'The value of `Period` must be 60 or a multiple of 60. Unit: seconds. Default value: 300.', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => true, 'example' => 'ECS_Rule1', 'title' => ''], + 'Escalations.Info.Statistics' => ['description' => 'The statistical method for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The valid values of this parameter are determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the valid values, see [Cloud service monitoring](~~163515~~).'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Warn.Times' => ['description' => 'The number of times that the monitoring metric must reach the alert threshold before a Warn-level alert notification is sent.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Settings for at least one of the alert severity levels Critical, Warn (warning), or Info must be specified. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Escalations.Info.ComparisonOperator' => ['description' => 'The comparison operator for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold. '."\n" + .'- GreaterThanThreshold: greater than the threshold. '."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold. '."\n" + .'- LessThanThreshold: less than the threshold. '."\n" + .'- NotEqualToThreshold: not equal to the threshold. '."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday. '."\n" + .'- LessThanYesterday: less than the value at the same time yesterday. '."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week. '."\n" + .'- LessThanLastWeek: less than the value at the same time last week. '."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period. '."\n" + .'- LessThanLastPeriod: less than the value in the last period. '."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Interval' => ['description' => 'The detection period of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'Unit: seconds. The default value is the minimum reporting frequency of the metric.'."\n" + ."\n" + .'> Keep the detection period of the alert rule consistent with the data reporting period. If the detection period is shorter than the data reporting period, alerts may not be triggered due to insufficient data.', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + 'Category' => ['description' => 'The abbreviation of the Alibaba Cloud service name.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the abbreviation, see the `metricCategory` tag in the `Labels` response parameter of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'ECS', 'title' => ''], + 'Escalations.Critical.ComparisonOperator' => ['description' => 'The comparison operator for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold. '."\n" + .'- GreaterThanThreshold: greater than the threshold. '."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold. '."\n" + .'- LessThanThreshold: less than the threshold. '."\n" + .'- NotEqualToThreshold: not equal to the threshold. '."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday. '."\n" + .'- LessThanYesterday: less than the value at the same time yesterday. '."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week. '."\n" + .'- LessThanLastWeek: less than the value at the same time last week. '."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period. '."\n" + .'- LessThanLastPeriod: less than the value in the last period. '."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Warn.Statistics' => ['description' => 'The statistical method for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The valid values of this parameter are determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the valid values, see [Cloud service monitoring](~~163515~~).'."\n" + ."\n" + .'> Set at least one of the alert severity levels Critical, Warn, or Info. For each specified alert severity level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'NoDataPolicy' => ['description' => 'The processing method when no monitoring data is found. Valid values:'."\n" + .'- KEEP_LAST_STATE (default): No action is performed.'."\n" + .'- INSUFFICIENT_DATA: An alert whose content is "Insufficient Data" is triggered.'."\n" + .'- OK: The status is considered normal.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => 'KEEP_LAST_STATE', 'title' => ''], + 'ContactGroups' => ['description' => 'The alert contact group.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the alert contact group, see [DescribeContactGroupList](~~114922~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS_Group', 'title' => ''], + 'Labels' => [ + 'description' => 'The tag keys of the alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag keys of the alert rule.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key of the alert rule. The tag is included in alert notifications.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value of the alert rule. The tag is included in alert notifications.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', + ], + 'Options' => ['description' => 'The advanced settings.'."\n" + ."\n" + .'Format: {"key1":"value1","key2":"value2"}. For example, {"NotSendOK":true} specifies whether to send an alert recovery notification. The key is NotSendOK, and the value is true (do not send) or false (send, which is the default).', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "NotSendOK": true'."\n" + .'}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2170B94A-1576-4D65-900E-2093037CDAF3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resource' => [ + 'Code' => ['description' => 'The status code.'."\n" + .'>A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'- true: The operation is successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Resource' => [ - 'description' => 'The resources that are associated with the application group.'."\n", + 'AlertResult' => [ + 'description' => 'The list of alert rules.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Category' => [ - 'description' => 'The type of the cloud service to which the dynamic rule belongs. Valid values:'."\n" - ."\n" - .'* ecs: Elastic Compute Service (ECS)'."\n" - .'* rds: ApsaraDB RDS'."\n" - .'* slb: Server Load Balancer (SLB)'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'FilterRelation' => [ - 'description' => 'The filter condition. Valid values:'."\n" - ."\n" - .'* and: queries the instances that meet all alert rules.'."\n" - .'* or: queries the instances that meet any alert rule.'."\n", - 'type' => 'string', - 'example' => 'and', - ], - 'Filters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Filter' => [ - 'description' => 'The dynamic rules of the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The value of the dynamic rule.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Function' => [ - 'description' => 'The method that is used to filter the instances. Valid values:'."\n" - ."\n" - .'* contains: contains'."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n", - 'type' => 'string', - 'example' => 'contains', - ], - 'Name' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'hostName', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code of the newly created alert rule.'."\n" + .'>A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message of the newly created alert rule.', 'type' => 'string', 'example' => 'Metric not found.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the alert rule is created. Valid values:'."\n" + ."\n" + .'- true: The alert rule is created.'."\n" + ."\n" + .'- false: The alert rule failed to be created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RuleName' => ['description' => 'The name of the newly created alert rule.', 'type' => 'string', 'example' => 'ECS_Rule1', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the newly created alert rule.', 'type' => 'string', 'example' => '456789', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', - ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + 412 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => '500', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"2170B94A-1576-4D65-900E-2093037CDAF3\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"Resource\\": [\\n {\\n \\"Category\\": \\"ecs\\",\\n \\"FilterRelation\\": \\"and\\",\\n \\"Filters\\": {\\n \\"Filter\\": [\\n {\\n \\"Value\\": \\"1\\",\\n \\"Function\\": \\"contains\\",\\n \\"Name\\": \\"hostName\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitorGroupDynamicRulesResponse>\\r\\n\\t<RequestId>38D0A8B4-7231-4E3E-A39F-D8CE3E242AC7</RequestId>\\r\\n\\t<Resource>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<FilterRelation>and</FilterRelation>\\r\\n\\t\\t\\t<Filters>\\r\\n\\t\\t\\t\\t<Filter>\\r\\n\\t\\t\\t\\t\\t<Function>contains</Function>\\r\\n\\t\\t\\t\\t\\t<Value>1</Value>\\r\\n\\t\\t\\t\\t\\t<Name>hostName</Name>\\r\\n\\t\\t\\t\\t</Filter>\\r\\n\\t\\t\\t</Filters>\\r\\n\\t\\t\\t<Category>ecs</Category>\\r\\n\\t\\t</Resource>\\r\\n\\t</Resource>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMonitorGroupDynamicRulesResponse>","errorExample":""}]', - 'title' => 'DescribeMonitorGroupDynamicRules', - 'requestParamsDescription' => ' ', + 'title' => 'Create alert rules in batches for a specified application group', + 'summary' => 'Creates alert rules in batches for a specified application group by calling the CreateGroupMetricRules operation.', + 'description' => 'This topic provides an example on how to create an alert rule for the monitoring metric `cpu_total` of Elastic Computing Service (ECS) in the application group `123456`. The alert rule ID is `456789`, the alert rule name is `ECS_Rule1`, the alert severity is `Critical`, the statistical method is `Average`, the comparison operator is `GreaterThanOrEqualToThreshold`, the threshold is `90`, and the retry count is `3`. The response shows that the alert rule `ECS_Rule1` is created.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitorGroupInstanceAttribute' => [ - 'summary' => 'Queries the details of the resources in an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2023-12-13T07:02:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupMetricRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateGroupMetricRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'GroupMetricRule', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D\\",\\n \\"Success\\": true,\\n \\"Resources\\": {\\n \\"AlertResult\\": [\\n {\\n \\"Code\\": 200,\\n \\"Message\\": \\"Metric not found.\\",\\n \\"Success\\": true,\\n \\"RuleName\\": \\"ECS_Rule1\\",\\n \\"RuleId\\": \\"456789\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'CreateGroupMonitoringAgentProcess' => [ + 'summary' => 'Creates a process monitoring task for an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For more information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => true, 'example' => '3607****', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'ProcessName', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Valid values: 1 to 1000000000.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The process name.', 'type' => 'string', 'required' => true, 'example' => 'Process_Java', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'MatchExpressFilterRelation', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Valid values: 1 to 1000000000.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The logical operator used between conditional expressions that are used to match instances. Valid values:'."\n" + ."\n" + .'- all'."\n" + ."\n" + .'- and'."\n" + ."\n" + .'- or', 'type' => 'string', 'required' => false, 'example' => 'and', 'title' => ''], ], [ - 'name' => 'Total', + 'name' => 'MatchExpress', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to return the total number of resources in the specified application group. Valid values:'."\n" + 'description' => 'The expressions used to match instances.'."\n" ."\n" - .'* true (default)'."\n" - .'* false'."\n", - 'type' => 'boolean', + .'Valid values of N: 1 to 3.', + 'type' => 'array', + 'items' => [ + 'description' => 'The expression used to match instances.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The keyword used to match the instance name.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => false, 'example' => 'portalHost', 'title' => ''], + 'Name' => ['description' => 'The criteria based on which the instances are matched.'."\n" + ."\n" + .'Valid values of N: 1 to 3.'."\n" + ."\n" + .'> Set the value to name. The value name indicates that the instances are matched based on the instance name.', 'type' => 'string', 'required' => false, 'example' => 'name1', 'title' => ''], + 'Function' => ['description' => 'The matching condition. Valid values:'."\n" + ."\n" + .'- all (default value): matches all'."\n" + ."\n" + .'- startWith: starts with a prefix'."\n" + ."\n" + .'- endWith: ends with a suffix'."\n" + ."\n" + .'- contains: contains'."\n" + ."\n" + .'- notContains: does not contain'."\n" + ."\n" + .'- equals: equals'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => false, 'example' => 'startWith', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'true', + 'maxItems' => 3, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Category', + 'name' => 'AlertConfig', 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The abbreviation of the cloud service name.'."\n" + 'description' => 'The alert rule configurations.'."\n" ."\n" - .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~2513265~~) operation.', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], - ], - [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used to search for resources.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'portal', - ], - ], - [ - 'name' => 'InstanceIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource ID. Separate multiple resource IDs with commas (,). You can query the details about a maximum of 20 resources at a time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-m5e0k0bexac8tykr****', + .'Valid values of N: 1 to 3.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert rule configuration.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => ['description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day.'."\n" + ."\n" + .'Valid values of N: 1 to 3.'."\n" + ."\n" + .'> Only one alert notification is sent during a mute period even if the metric value exceeds the alert threshold during consecutive checks.', 'type' => 'string', 'required' => false, 'default' => '86400', 'example' => '86400', 'title' => ''], + 'ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => true, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], + 'Times' => ['description' => 'The number of times for which the threshold can be consecutively exceeded. Default value: 3.'."\n" + ."\n" + .'Valid values of N: 1 to 3.'."\n" + ."\n" + .'> A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'EscalationsLevel' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- critical (default)'."\n" + ."\n" + .'- warn'."\n" + ."\n" + .'- info'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => true, 'example' => 'warn', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The period of time during which the alert rule is effective.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => false, 'example' => '07:00-22:59', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '00:00-05:30', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.'."\n" + ."\n" + .'Valid values of N: 1 to 3.', 'type' => 'string', 'required' => true, 'example' => '5', 'title' => ''], + 'Statistics' => ['description' => 'The statistical aggregation method that is used to calculate the metric values.'."\n" + ."\n" + .'Valid values of N: 1 to 3.'."\n" + ."\n" + .'> Set the value to Average.', 'type' => 'string', 'required' => true, 'example' => 'Average', 'title' => ''], + 'TargetList' => [ + 'description' => 'The alert triggers.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert trigger.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the resource for which alerts are triggered.'."\n" + ."\n" + .'For more information about how to obtain the ID of a resource for which alerts are triggered, see [DescribeMetricRuleTargets](~~121592~~).', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.'."\n" + ."\n" + .'For more information about how to query the ARN of a resource, see [DescribeMetricRuleTargets](~~121592~~).'."\n" + ."\n" + .'Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:'."\n" + ."\n" + .'- {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).'."\n" + ."\n" + .'- {userId}: the ID of the Alibaba Cloud account.'."\n" + ."\n" + .'- {regionId}: the region ID of the SMQ queue or topic.'."\n" + ."\n" + .'- {Resource type}: the type of the resource that triggers the alert. Valid values:'."\n" + ."\n" + .' - **queues**'."\n" + ."\n" + .' - **topics**'."\n" + ."\n" + .'- {Resource name}: the resource name.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + ."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'required' => false, 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .'- CRITICAL', 'type' => 'string', 'required' => false, 'example' => '["INFO", "WARN", "CRITICAL"]', 'title' => ''], + 'JsonParams' => ['description' => 'The parameters of the alert callback. The parameters are in the JSON format.', 'type' => 'string', 'required' => false, 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 3, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9FB8EA79-7279-4482-8D6D-3D28EEDD871A', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Resources' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '718FEA81-64C3-4F23-8F90-0531F7489FC1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true: The call is successful.'."\n" + ."\n" + .'- false: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resource' => [ + 'description' => 'The group process information.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'Resource' => [ - 'description' => 'The resources that are associated with the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceName' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'hostName', - ], - 'Dimension' => [ - 'description' => 'The dimensions of the resource that is associated with the application group.'."\n", - 'type' => 'string', - 'example' => '{"instanceId":"i-m5e0k0bexac8tykr****"}', - ], - 'Category' => [ - 'description' => 'The name of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'i-m5e0k0bexac8tykr****', - ], - 'NetworkType' => [ - 'description' => 'The network type.'."\n", - 'type' => 'string', - 'example' => 'vpc', - ], - 'Desc' => [ - 'description' => 'The resource description.'."\n", - 'type' => 'string', - 'example' => 'desc_test', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'description' => 'The tag of the resource.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'instanceNetworkType', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'VPC', - ], - ], - ], - ], - ], - ], - 'Region' => [ - 'description' => 'The region.'."\n", - 'type' => 'object', - 'properties' => [ - 'AvailabilityZone' => [ - 'description' => 'The zone.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-f', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - 'Vpc' => [ - 'description' => 'The VPC description.'."\n", - 'type' => 'object', - 'properties' => [ - 'VswitchInstanceId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-2ze36seq79n992****', - ], - 'VpcInstanceId' => [ - 'description' => 'The VPC ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-2zew7etgiceg21****', - ], - ], - ], - ], - ], - ], + 'GroupProcessId' => ['description' => 'The ID of the group process.', 'type' => 'string', 'example' => '7F2B0024-4F21-48B9-A764-211CEC48****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - '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.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - '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.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FB8EA79-7279-4482-8D6D-3D28EEDD871A\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"Total\\": 12,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"InstanceName\\": \\"hostName\\",\\n \\"Dimension\\": \\"{\\\\\\"instanceId\\\\\\":\\\\\\"i-m5e0k0bexac8tykr****\\\\\\"}\\",\\n \\"Category\\": \\"ecs\\",\\n \\"InstanceId\\": \\"i-m5e0k0bexac8tykr****\\",\\n \\"NetworkType\\": \\"vpc\\",\\n \\"Desc\\": \\"desc_test\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"instanceNetworkType\\",\\n \\"Value\\": \\"VPC\\"\\n }\\n ]\\n },\\n \\"Region\\": {\\n \\"AvailabilityZone\\": \\"cn-hangzhou-f\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n },\\n \\"Vpc\\": {\\n \\"VswitchInstanceId\\": \\"vsw-2ze36seq79n992****\\",\\n \\"VpcInstanceId\\": \\"vpc-2zew7etgiceg21****\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitorGroupInstanceAttributeResponse>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<PageSize>30</PageSize>\\r\\n\\t<RequestId>7DB8DA3D-EDA6-46F8-9222-70C52416AE7D</RequestId>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Total>1</Total>\\r\\n\\t<Resources>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<Vpc>\\r\\n\\t\\t\\t\\t<VswitchInstanceId>vsw-2ze36seq79n992****</VswitchInstanceId>\\r\\n\\t\\t\\t\\t<VpcInstanceId>vpc-2zew7etgiceg21****</VpcInstanceId>\\r\\n\\t\\t\\t</Vpc>\\r\\n\\t\\t\\t<Tags>\\r\\n\\t\\t\\t\\t<Tag>\\r\\n\\t\\t\\t\\t\\t<Value>12345</Value>\\r\\n\\t\\t\\t\\t\\t<Key>aliUid</Key>\\r\\n\\t\\t\\t\\t</Tag>\\r\\n\\t\\t\\t\\t<Tag>\\r\\n\\t\\t\\t\\t\\t<Value>26842</Value>\\r\\n\\t\\t\\t\\t\\t<Key>bid</Key>\\r\\n\\t\\t\\t\\t</Tag>\\r\\n\\t\\t\\t</Tags>\\r\\n\\t\\t\\t<NetworkType>VPC</NetworkType>\\r\\n\\t\\t\\t<Category>RDS</Category>\\r\\n\\t\\t\\t<Region>\\r\\n\\t\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t\\t<AvailabilityZone>cn-hangzhou-MAZ8(f,g)</AvailabilityZone>\\r\\n\\t\\t\\t</Region>\\r\\n\\t\\t\\t<AliUid>127067667954****</AliUid>\\r\\n\\t\\t\\t<InstanceId>i-m5e0k0bexac8tykr****</InstanceId>\\r\\n\\t\\t\\t<Dimension>{\\\\\\"userId\\\\\\":\\\\\\"127067667954****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"rm-bp179a8xfaz4i****\\\\\\"}</Dimension>\\r\\n\\t\\t\\t<Desc>test_name</Desc>\\r\\n\\t\\t\\t<InstanceName>test_name</InstanceName>\\r\\n\\t\\t</Resource>\\r\\n\\t</Resources>\\r\\n</DescribeMonitorGroupInstanceAttributeResponse>","errorExample":""}]', - 'title' => 'DescribeMonitorGroupInstanceAttribute', + 'title' => 'CreateGroupMonitoringAgentProcess', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMonitorGroupDynamicRule' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-03-20T02:25:55.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-05T04:05:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupMonitoringAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateGroupMonitoringAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'GroupMonitoringAgentProcess', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"718FEA81-64C3-4F23-8F90-0531F7489FC1\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"GroupProcessId\\": \\"7F2B0024-4F21-48B9-A764-211CEC48****\\"\\n }\\n}","type":"json"}]', + ], + 'CreateHostAvailability' => [ + 'summary' => 'Creates an availability monitoring task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The application group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'The service to which the rule applies. Valid values: ecs, rds, and slb.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The name of the availability monitoring task. The name must be 4 to 100 characters in length and can contain letters, digits, underscores (_), and Chinese characters.', 'type' => 'string', 'required' => true, 'example' => 'task1', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '56B4516A-EB44-4C66-8854-0393B35F636B', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], + [ + 'name' => 'TaskScope', + 'in' => 'query', + 'schema' => ['description' => 'The detection scope of the availability monitoring task. Valid values:'."\n" + ."\n" + .'- GROUP: uses all ECS instances in the current application group as detection probes.'."\n" + .'- GROUP_SPEC_INSTANCE: uses specified ECS instances in the current application group as detection probes. If you set this parameter to GROUP_SPEC_INSTANCE, you must also set InstanceList to specify the ECS instances that initiate detection.', 'type' => 'string', 'required' => false, 'default' => 'GROUP', 'example' => 'GROUP', 'title' => ''], ], - ], - 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => ['description' => 'The detection type of the availability monitoring task. Valid values:'."\n" + ."\n" + .'- PING'."\n" + .'- TELNET'."\n" + .'- HTTP', 'type' => 'string', 'required' => true, 'example' => 'HTTP', 'title' => ''], ], - 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + [ + 'name' => 'TaskOption.HttpURI', + 'in' => 'query', + 'schema' => ['description' => 'The URI for HTTP or Telnet detection.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com'."\n" + .'telnet://127.0.0.1:80', 'title' => ''], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + 'name' => 'TaskOption.TelnetOrPingHost', + 'in' => 'query', + 'schema' => ['description' => 'The domain name or address to detect.'."\n" + .'>If the detection type is PING, set this parameter.', 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com', 'title' => ''], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 'name' => 'TaskOption.HttpResponseCharset', + 'in' => 'query', + 'schema' => ['description' => 'The response character set for HTTP detection.'."\n" + ."\n" + .'> Only UTF-8 is supported.', 'type' => 'string', 'required' => false, 'example' => 'UTF-8', 'title' => ''], ], [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', - ], + 'name' => 'TaskOption.HttpPostContent', + 'in' => 'query', + 'schema' => ['description' => 'The POST content of the HTTP detection request.', 'type' => 'string', 'required' => false, 'example' => 'params1=paramsValue1', 'title' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + 'name' => 'TaskOption.HttpResponseMatchContent', + 'in' => 'query', + 'schema' => ['description' => 'The content to match in the response.', 'type' => 'string', 'required' => false, 'example' => 'ok', 'title' => ''], ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'TaskOption.HttpMethod', + 'in' => 'query', + 'schema' => ['description' => 'The method for the detection type. Valid values:'."\n" + ."\n" + .'- GET'."\n" + .'- POST'."\n" + .'- HEAD'."\n" + ."\n" + .'>If the detection type is HTTP, set this parameter.', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'TaskOption.HttpNegative', + 'in' => 'query', + 'schema' => ['description' => 'The alert rule for matching HTTP response content. Valid values:'."\n" + .'- true: An alert is triggered if the HTTP response content contains the specified alert rule content.'."\n" + .'- false: An alert is triggered if the HTTP response content does not contain the specified alert rule content.'."\n" + ."\n" + .'>This parameter takes effect only when the detection type is HTTP.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + [ + 'name' => 'TaskOption.HttpHeader', + 'in' => 'query', + 'schema' => ['description' => 'The header of the HTTP request. The format is `Parameter name:Parameter value`. Separate multiple parameters with line breaks. Example:'."\n" + .'```'."\n" + .'params1:value1'."\n" + .'params2:value2'."\n" + .'```', 'type' => 'string', 'required' => false, 'example' => 'token:testTokenValue', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + [ + 'name' => 'TaskOption.Interval', + 'in' => 'query', + 'schema' => ['description' => 'The detection frequency. Unit: seconds. Valid values: 15, 30, 60, 120, 300, 900, 1800, and 3600.'."\n" + ."\n" + .'> Only CloudMonitor agent 3.5.1 or later supports this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'AlertConfig.NotifyType', + 'in' => 'query', + 'schema' => ['description' => 'The alert notification type. Valid values:'."\n" + ."\n" + .'<props="china">- 2: phone call + text message + email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- 1: text message + email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- 0: email + DingTalk chatbot.</props>'."\n" + ."\n\n" + .'<props="intl">0: email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="partner">0: email + DingTalk chatbot.</props>', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"56B4516A-EB44-4C66-8854-0393B35F636B\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteMonitorGroupDynamicRuleResponse>\\n <RequestId>56B4516A-EB44-4C66-8854-0393B35F636B</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteMonitorGroupDynamicRuleResponse>","errorExample":""}]', - 'title' => 'DeleteMonitorGroupDynamicRule', - 'summary' => 'Deletes a rule that is used to dynamically add the instances of a service to an application group.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteMonitorGroupInstances' => [ - 'summary' => 'Removes instances from an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'AlertConfig.StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time when the alert takes effect. Valid values: 0 to 23.'."\n" + ."\n" + .'For example, if `AlertConfig.StartTime` is set to 0 and `AlertConfig.EndTime` is set to 22, the alert is effective from 00:00:00 to 22:00:00.'."\n" + ."\n" + .'>If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'AlertConfig.EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time when the alert takes effect. Valid values: 0 to 23.'."\n" + ."\n" + .'For example, if `AlertConfig.StartTime` is set to 0 and `AlertConfig.EndTime` is set to 22, the alert is effective from 00:00:00 to 22:00:00.'."\n" + ."\n" + .'>If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22', 'title' => ''], + ], + [ + 'name' => 'AlertConfig.SilenceTime', 'in' => 'query', + 'schema' => ['description' => 'The mute period. Unit: seconds. Default value: 86400 (1 day).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'title' => ''], + ], + [ + 'name' => 'AlertConfig.WebHook', + 'in' => 'query', + 'schema' => ['description' => 'The webhook address.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com/webhook.json', 'title' => ''], + ], + [ + 'name' => 'AlertConfigEscalationList', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'None.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric for the alert. Valid values of N: 1 to 21. Valid values:'."\n" + ."\n" + .'- HttpStatus: HTTP status code.'."\n" + .'- HttpLatency: HTTP latency.'."\n" + .'- TelnetStatus: Telnet status code.'."\n" + .'- TelnetLatency: Telnet latency.'."\n" + .'- PingLostRate: Ping packet loss rate.', 'type' => 'string', 'required' => true, 'example' => 'HttpStatus', 'title' => ''], + 'Value' => ['description' => 'The alert threshold. Valid values of N: 1 to 21.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + 'Times' => ['description' => 'The number of alert retries. Valid values of N: 1 to 21.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Operator' => ['description' => 'The comparison operator for the alert rule. Valid values of N: 1 to 21. Valid values:'."\n" + ."\n" + .'- `>`'."\n" + .'- `>=`'."\n" + .'- `<`'."\n" + .'- `<=`'."\n" + .'- `=`', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + 'Aggregate' => ['description' => 'The statistical method for the alert. Valid values of N: 1 to 21. The valid values vary based on the metric:'."\n" + ."\n" + .'- HttpStatus: Value.'."\n" + .'- HttpLatency: Average.'."\n" + .'- TelnetStatus: Value.'."\n" + .'- TelnetLatency: Average.'."\n" + .'- PingLostRate: Average.'."\n" + ."\n" + .'>The statistical method for status codes is the original value (Value). The statistical method for latency or packet loss rate is the average value (Average).', 'type' => 'string', 'required' => false, 'example' => 'Value', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '123456', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'InstanceIdList', + 'name' => 'InstanceList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The instances to be removed from the application group. Separate multiple instances with commas (,). You can remove a maximum of 20 instances from an application group at a time.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'i-a2d5q7pm3f912****,i-a2d5q7pm3f222****', + 'description' => 'The list of ECS instances that initiate detection. Valid values of N: 1 to 21.'."\n" + ."\n" + .'> Set this parameter when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.', + 'type' => 'array', + 'items' => ['description' => 'The list of ECS instances that initiate detection. Valid values of N: 1 to 21.'."\n" + ."\n" + .'> Set this parameter when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'required' => false, + 'example' => 'i-absdfkwl321****', + 'maxItems' => 1000, + 'title' => '', ], ], [ - 'name' => 'Category', + 'name' => 'AlertConfigTargetList', 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The abbreviation of the cloud service name.'."\n" - ."\n" - .'> For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', + 'description' => 'The alert trigger targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert trigger targets.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the alert trigger target.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The resource ARN. Format: `acs:{AbbreviatedCloudServiceName}:{regionId}:{userId}:/{ResourceType}/{ResourceName}/message`. Example: `acs:mns:ap-southeast-1:120886317861****:/queues/test123/message`. The following list describes the parameters:'."\n" + ."\n" + .'- {AbbreviatedCloudServiceName}: Only Simple Message Queue (formerly MNS) is supported.'."\n" + ."\n" + .'- {userId}: The Alibaba Cloud account ID.'."\n" + ."\n" + .'- {regionId}: The region where the Simple Message Queue (formerly MNS) queue or topic resides.'."\n" + ."\n" + .'- {ResourceType}: The type of the resource that accepts alerts. Valid values:'."\n" + ."\n" + .' - **queues**: queue.'."\n" + .' - **topics**: topic.'."\n" + ."\n" + .'- {ResourceName}: The resource name.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'required' => false, 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: information.'."\n" + .'- WARN: warning.'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'required' => false, 'example' => '["INFO", "WARN", "CRITICAL"]', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters of the alert callback.', 'type' => 'string', 'required' => false, 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -2968,2217 +1985,1819 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5351B0F2-26A9-4BC9-87FF-1B74034D12C3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'>200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the availability monitoring task.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => 'The parameter is invalid.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], + ], + 412 => [ + ['errorCode' => 'ResouceOverLimit', 'errorMessage' => 'The task over limit', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5351B0F2-26A9-4BC9-87FF-1B74034D12C3\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteMonitorGroupInstancesResponse>\\n <RequestId>C5C6924C-237E-40B2-9510-41BF8F671102</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteMonitorGroupInstancesResponse>","errorExample":""}]', - 'title' => 'DeleteMonitorGroupInstances', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"ACBDBB40-DFB6-4F4C-8957-51FFB233969C\\",\\n \\"TaskId\\": 12345,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create an availability monitoring task', + 'description' => 'This topic provides an example on how to create an availability monitoring task named `task1` with the detection type `HTTP` in the application group `123456`. Alert notifications are sent by email and DingTalk chatbot.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitorGroupCategories' => [ - 'summary' => 'Queries the cloud services to which the resources in an application group belong and the number of resources that belong to each cloud service in the application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-05T04:05:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-22T08:53:07.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHostAvailability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateHostAvailability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'HostAvailability', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + ], + 'CreateHybridMonitorNamespace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metric repository.'."\n" + ."\n" + .'Format: consists of lowercase letters, digits, and hyphens (-).', 'type' => 'string', 'required' => true, 'example' => 'aliyun', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the metric repository.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Alibaba Cloud product metric repository.', 'title' => ''], + ], + [ + 'name' => 'Spec', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', + 'description' => 'The data storage duration. Valid values:'."\n" + ."\n" + .'- cms.s1.large: storage duration of 15 days.'."\n" + .'- cms.s1.xlarge: storage duration of 32 days.'."\n" + .'- cms.s1.2xlarge: storage duration of 63 days.'."\n" + .'- cms.s1.3xlarge (default): storage duration of 93 days.'."\n" + .'- cms.s1.6xlarge: storage duration of 185 days.'."\n" + .'- cms.s1.12xlarge: storage duration of 376 days.'."\n" + ."\n" + .'For the pricing of different storage duration specifications, see the **Pricing** section in [monitoring dashboard](~~223532~~).', + 'enumValueTitles' => ['cms.s1.large' => 'cms.s1.large', 'cms.s1.2xlarge' => 'cms.s1.2xlarge', 'cms.s1.xlarge' => 'cms.s1.xlarge', 'cms.s1.6xlarge' => 'cms.s1.6xlarge', 'cms.s1.3xlarge' => 'cms.s1.3xlarge'], + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enum' => [], + 'example' => 'cms.s1.3xlarge', + 'title' => '', ], ], + [ + 'name' => 'NamespaceType', + 'in' => 'query', + 'schema' => ['description' => 'The storage solution for monitoring data. Valid values:'."\n" + ."\n" + .'- aliyun_prometheus: monitoring data is stored in Managed Service for Prometheus.'."\n" + ."\n" + .'> For more information about storage solutions for monitoring data, see [Storage solutions for Hybrid Cloud Monitoring data](~~2594921~~).', 'type' => 'string', 'required' => false, 'example' => 'aliyun_prometheus', 'title' => ''], + ], + [ + 'name' => 'NamespaceRegion', + 'in' => 'query', + 'schema' => ['description' => 'The region in which monitoring data is stored.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9E0347B0-EBC3-4769-A78D-D96F21C6BB52', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MonitorGroupCategories' => [ - 'description' => 'The cloud services to which the resources in the application group belong and the number of resources that belong to the cloud service.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'MonitorGroupCategory' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CategoryItem' => [ - 'description' => 'The cloud services to which the resources in the application group belong and the number of resources that belong to the cloud service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Count' => [ - 'description' => 'The number of resources that belong to the cloud service.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Category' => [ - 'description' => 'The abbreviation of the cloud service name.'."\n" - ."\n" - .'> For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Namespace.Existed', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3843D23A-FB9E-5DC8-BCCC-458768B79296', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Create a metric repository', + 'summary' => 'Calls the CreateHybridMonitorNamespace operation to create a metric repository.', + 'description' => '## Before you begin'."\n" + .'Make sure that you have activated Hybrid Cloud Monitoring. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" + ."\n" + .'## Operation description'."\n" + .'This topic provides an example on how to create a metric repository named `aliyun` with a data storage duration of `cms.s1.3xlarge`. The response indicates that the metric repository is created.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2023-11-21T10:00:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-27T07:31:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-03-29T07:11:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHybridMonitorNamespace'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateCustomNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"9E0347B0-EBC3-4769-A78D-D96F21C6BB52\\",\\n \\"Success\\": true,\\n \\"MonitorGroupCategories\\": {\\n \\"GroupId\\": 123456,\\n \\"MonitorGroupCategory\\": {\\n \\"CategoryItem\\": [\\n {\\n \\"Count\\": 1,\\n \\"Category\\": \\"ecs\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitorGroupCategoriesResponse>\\r\\n\\t<RequestId>B7C9F725-E743-4F2E-81A2-4CC19783DC42</RequestId>\\r\\n\\t<MonitorGroupCategories>\\r\\n\\t\\t<MonitorGroupCategory>\\r\\n\\t\\t\\t<CategoryItem>\\r\\n\\t\\t\\t\\t<Category>ECS</Category>\\r\\n\\t\\t\\t\\t<Count>39</Count>\\r\\n\\t\\t\\t</CategoryItem>\\r\\n\\t\\t</MonitorGroupCategory>\\r\\n\\t\\t<GroupId>123456</GroupId>\\r\\n\\t</MonitorGroupCategories>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMonitorGroupCategoriesResponse>","errorExample":""}]', - 'title' => 'DescribeMonitorGroupCategories', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Namespace.Existed\\",\\n \\"RequestId\\": \\"3843D23A-FB9E-5DC8-BCCC-458768B79296\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], - 'PutMonitorGroupDynamicRule' => [ - 'summary' => 'Creates or modifies an alert rule to dynamically add instances that meet the rule to an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateHybridMonitorSLSGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'SLSGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The name of the Logstore group.'."\n" + ."\n" + .'The name must be 2 to 32 characters in length and can contain uppercase letters, lowercase letters, digits, and underscores (_). The name must start with a letter.', 'type' => 'string', 'required' => true, 'example' => 'Logstore_test', 'title' => ''], ], [ - 'name' => 'GroupRules', + 'name' => 'SLSGroupDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the Logstore group.', 'type' => 'string', 'required' => false, 'example' => 'Logstore group of Alibaba Cloud products.', 'title' => ''], + ], + [ + 'name' => 'SLSGroupConfig', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'The configurations of the Logstore group.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'array', 'items' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'FilterRelation' => [ - 'description' => 'The logical operator used between conditional expressions in the alert rule. Valid values of N: 1 to 3. Valid values:'."\n" - ."\n" - .'* and: The instances that meet all the conditional expressions are automatically added to the application group.'."\n" - .'* or: The instances that meet one of the conditional expressions are automatically added to the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'and', - ], - 'Filters' => [ - 'description' => 'None.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The value to be matched with the specified field. Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'nginx', - ], - 'Name' => [ - 'description' => 'The name of the field based on which instances are filtered. Valid values of N: 1 to 3.'."\n" - ."\n" - .'Only hostnames are supported. Example: hostName.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hostName', - ], - 'Function' => [ - 'description' => 'The method that is used to filter instances. Valid values of N: 1 to 3. Valid values:'."\n" - ."\n" - .'* contains: contains'."\n" - .'* notContains: does not contain'."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'contains', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 10, - ], - 'Category' => [ - 'description' => 'The cloud service to which the alert rule is applied. Valid values of N: 1 to 3. Valid values:'."\n" - ."\n" - .'* ecs: Elastic Compute Service (ECS)'."\n" - .'* rds: ApsaraDB RDS'."\n" - .'* slb: Server Load Balancer (SLB)'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], + 'SLSRegion' => ['description' => 'The region.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + 'SLSProject' => ['description' => 'The project.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-project', 'title' => ''], + 'SLSLogstore' => ['description' => 'The Logstore.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'string', 'required' => true, 'example' => 'Logstore-ECS', 'title' => ''], + 'SLSUserId' => ['description' => 'The member ID.'."\n" + ."\n" + .'Valid values of N: 1 to 25.'."\n" + ."\n" + .'If you invoke this operation by using a management account, you can associate the Alibaba Cloud services of any member in the resource folder with Hybrid Cloud Monitoring through cloud native mode. You can use the resource folder to monitor the Alibaba Cloud services of multiple accounts.'."\n" + ."\n" + .'> If a member uses CloudMonitor for the first time, make sure that the member has been granted the authorization for the CloudMonitor service-linked role (AliyunServiceRoleForCloudMonitor). For more information, see [CloudMonitor service-linked role](~~170423~~).', 'type' => 'string', 'required' => false, 'example' => '120886317861****', 'title' => ''], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], 'required' => true, - 'maxItems' => 50, - ], - ], - [ - 'name' => 'IsAsync', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mode for creating the alert rule. Valid values:'."\n" - ."\n" - .'* true: creates asynchronously'."\n" - .'* false (default): creates synchronously'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'maxItems' => 30, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3E73F1AB-D195-438A-BCA7-2F4355789C58', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Duplicate.SLSGroup', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => ''], ], - [ - [ - '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' => '%s', - ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 412 => [ - [ - 'errorCode' => 'OverLimit', - 'errorMessage' => 'Matched instances count was over limit', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'Create a logstore group for SLS log metrics', + 'summary' => 'Creates a Logstore group for Hybrid Cloud Monitoring.', + 'description' => '### Before you begin'."\n" + .'Make sure that you have activated Simple Log Service (SLS) and created a project and a Logstore. For more information, see [Quick Start](~~54604~~).'."\n" + ."\n" + .'### Operation description'."\n" + .'This topic provides an example on how to create a Logstore group named `Logstore_test`. The region is `ap-southeast-1`, the project is `aliyun-project`, and the Logstore is `Logstore-ECS`. The response shows that the Logstore group is created.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-08-04T08:55:46.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHybridMonitorSLSGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateHybridMonitorSLSGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3E73F1AB-D195-438A-BCA7-2F4355789C58\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutMonitorGroupDynamicRuleResponse>\\n\\t<RequestId>3E73F1AB-D195-438A-BCA7-2F4355789C58</RequestId>\\n\\t<Success>true</Success>\\n\\t<Code>200</Code>\\n</PutMonitorGroupDynamicRuleResponse>\\t","errorExample":""}]', - 'title' => 'PutMonitorGroupDynamicRule', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Duplicate.SLSGroup\\",\\n \\"RequestId\\": \\"66683237-7126-50F8-BBF8-D67ACC919A17\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], - 'CreateGroupMonitoringAgentProcess' => [ - 'summary' => 'Creates a process monitoring task for an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateHybridMonitorTask' => [ + 'summary' => 'Creates a monitoring task for Alibaba Cloud services or Simple Log Service (SLS) logs in Hybrid Cloud Monitoring.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'For information about how to obtain the namespace name, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'aliyun', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the monitoring task.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '阿里云产品数据接入任务。', 'title' => ''], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the monitoring task.'."\n" + ."\n" + .'- If `TaskType` is set to `aliyun_fc`, enter the name of the data import task for the Alibaba Cloud service.'."\n" + .'- If `TaskType` is set to `aliyun_sls`, enter the metric name for SLS logs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aliyun_task', 'title' => ''], + ], + [ + 'name' => 'TaskType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the application group.'."\n" + 'description' => 'The type of the monitoring task. Valid values:'."\n" ."\n" - .'For more information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", + .'- aliyun_fc: a data import task for Alibaba Cloud services.'."\n" + .'- aliyun_sls: a metric for SLS logs.', + 'enumValueTitles' => ['aliyun_fc' => 'aliyun_fc', 'aliyun_sls' => 'aliyun_sls'], 'type' => 'string', 'required' => true, - 'example' => '123456', + 'docRequired' => true, + 'example' => 'aliyun_fc', + 'title' => '', ], ], [ - 'name' => 'ProcessName', + 'name' => 'CollectTargetType', 'in' => 'query', - 'schema' => [ - 'description' => 'The process name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The type of the collection target for monitoring data.'."\n" + .'- If `TaskType` is set to `aliyun_fc`, enter `aliyun_fc`.'."\n" + .'- If `TaskType` is set to `aliyun_sls`, enter the name of the Logstore group for SLS logs.', 'type' => 'string', 'required' => true, 'example' => 'aliyun_fc', 'title' => ''], ], [ - 'name' => 'MatchExpressFilterRelation', + 'name' => 'CollectInterval', 'in' => 'query', 'schema' => [ - 'description' => 'The logical operator used between conditional expressions that are used to match instances. Valid values:'."\n" + 'description' => 'The collection period of the metric. Valid values:'."\n" + ."\n" + .'- 15'."\n" + .'- 60 (default)'."\n" + ."\n" + .'Unit: seconds.'."\n" ."\n" - .'* all'."\n" - .'* and'."\n" - .'* or'."\n", + .'> This parameter is required only when `TaskType` is set to `aliyun_sls`.', + 'enumValueTitles' => [15 => '15', 60 => '60'], 'type' => 'string', 'required' => false, - 'example' => 'and', + 'example' => '60', + 'title' => '', ], ], [ - 'name' => 'MatchExpress', + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The application group ID.'."\n" + ."\n" + .'For information about how to obtain the application group ID, see [DescribeMonitorGroups](~~115032~~).'."\n" + ."\n" + .'> This parameter is required only when `TaskType` is set to `aliyun_sls`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '3607****', 'title' => ''], + ], + [ + 'name' => 'YARMConfig', + 'in' => 'query', + 'schema' => ['description' => 'The configuration file of the Alibaba Cloud service that is connected to Hybrid Cloud Monitoring.'."\n" + ."\n" + .'- namespace: the namespace of the Alibaba Cloud service. For information about how to query the namespace of an Alibaba Cloud service, see [DescribeMetricMetaList](~~98846~~).'."\n" + .'- metric_list: the metrics of the Alibaba Cloud service. For information about how to query the metrics of an Alibaba Cloud service, see [DescribeMetricMetaList](~~98846~~).'."\n" + ."\n" + .'The following example shows the configuration file:'."\n" + ."\n" + .'```'."\n" + .'products:'."\n" + .'- namespace: acs_ecs_dashboard'."\n" + .' metric_info:'."\n" + .' - metric_list:'."\n" + .' - cpu_total'."\n" + .' - cpu_idle'."\n" + .' - diskusage_utilization'."\n" + .' - CPUUtilization'."\n" + .' - DiskReadBPS'."\n" + .' - InternetOut'."\n" + .' - IntranetOut'."\n" + .' - cpu_system'."\n" + .'- namespace: acs_rds_dashboard'."\n" + .' metric_info:'."\n" + .' - metric_list:'."\n" + .' - MySQL_QPS'."\n" + .' - MySQL_TPS'."\n" + .'```'."\n" + .'> This parameter is required only when `TaskType` is set to `aliyun_fc`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total', 'title' => ''], + ], + [ + 'name' => 'TargetUserId', + 'in' => 'query', + 'schema' => ['description' => 'The member ID.'."\n" + ."\n" + .'When you invoke this operation by using a management account, you can use cloud native mode to connect Alibaba Cloud services of any member in the resource folder to Hybrid Cloud Monitoring. This allows you to implement cross-account unified monitoring of Alibaba Cloud services through the resource folder. Go to **Settings** to configure this feature in the CloudMonitor console.'."\n" + ."\n" + .'> This parameter is required only when `TaskType` is set to `aliyun_fc`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '120886317861****', 'title' => ''], + ], + [ + 'name' => 'AttachLabels', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The expressions used to match instances.'."\n" + 'description' => 'The labels of the metric.'."\n" ."\n" - .'Valid values of N: 1 to 3.'."\n", + .'> This parameter is required only when `TaskType` is set to `aliyun_sls`.', 'type' => 'array', 'items' => [ - 'description' => 'The expression used to match instances.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'description' => 'The keyword used to match the instance name.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'portalHost', - ], - 'Name' => [ - 'description' => 'The criteria based on which the instances are matched.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n" - ."\n" - .'> Set the value to name. The value name indicates that the instances are matched based on the instance name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name1', - ], - 'Function' => [ - 'description' => 'The matching condition. Valid values:'."\n" - ."\n" - .'* all (default value): matches all'."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n" - .'* contains: contains'."\n" - .'* notContains: does not contain'."\n" - .'* equals: equals'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'startWith', - ], + 'Value' => ['description' => 'The label value of the metric.', 'type' => 'string', 'required' => false, 'example' => 'testValue', 'title' => ''], + 'Name' => ['description' => 'The label key of the metric.', 'type' => 'string', 'required' => false, 'example' => 'app_service', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 3, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AlertConfig', + 'name' => 'TargetUserIdList', + 'in' => 'query', + 'schema' => ['description' => 'The member IDs. Separate multiple member IDs with commas (,).'."\n" + ."\n" + .'> This parameter is required only when you call this operation by using a management account.', 'type' => 'string', 'required' => false, 'example' => '120886317861****', 'title' => ''], + ], + [ + 'name' => 'SLSProcessConfig', 'in' => 'query', 'style' => 'flat', 'schema' => [ - 'description' => 'The alert rule configurations.'."\n" + 'description' => 'The SLS log configuration.'."\n" ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert rule configuration.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'object', - 'properties' => [ - 'SilenceTime' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n" - ."\n" - .'> Only one alert notification is sent during a mute period even if the metric value exceeds the alert threshold during consecutive checks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '86400', - 'default' => '86400', - ], - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Webhook' => [ - 'description' => 'The callback URL.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.aliyun.com', - ], - 'Times' => [ - 'description' => 'The number of times for which the threshold can be consecutively exceeded. Default value: 3.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n" - ."\n" - .'> A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'EscalationsLevel' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* critical (default)'."\n" - .'* warn'."\n" - .'* info'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'warn', + .'> This parameter is required only when `TaskType` is set to `aliyun_sls`.', + 'type' => 'object', + 'properties' => [ + 'Filter' => [ + 'description' => 'The filter conditions for parameters in SLS logs.', + 'type' => 'object', + 'properties' => [ + 'Relation' => [ + 'description' => 'The relationship between multiple filter conditions. Valid values:'."\n" + ."\n" + .'- and (default): Logs are processed only when all filter conditions are met.'."\n" + .'- or: Logs are processed when any filter condition is met.', + 'enumValueTitles' => ['or' => 'or', 'and' => 'and'], + 'type' => 'string', + 'required' => false, + 'example' => 'and', + 'title' => '', + ], + 'Filters' => [ + 'description' => 'The list of filter conditions for parameters in SLS logs.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the parameter to filter in SLS logs.', 'type' => 'string', 'required' => false, 'example' => 'code', 'title' => ''], + 'Operator' => [ + 'description' => 'The filter method for parameter values in SLS logs. Valid values:'."\n" + .'- `contain`: contains.'."\n" + .'- `notContain`: does not contain.'."\n" + .'- `>`: greater than.'."\n" + .'- `<`: less than.'."\n" + .'- `=`: equal to.'."\n" + .'- `!=`: not equal to.'."\n" + .'- `>=`: greater than or equal to.'."\n" + .'- `<=`: less than or equal to.', + 'type' => 'string', + 'enum' => ['>', '>=', '=', '<=', '<', '!=', 'contain', 'notContain'], + 'required' => false, + 'example' => '=', + 'title' => '', + ], + 'Value' => ['description' => 'The filter value of the parameter in SLS logs.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], - 'EffectiveInterval' => [ - 'description' => 'The period of time during which the alert rule is effective.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Statistics' => [ + 'description' => 'The statistical method for SLS logs.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the parameter for SLS log statistics.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'Function' => ['description' => 'Aggregates log data within the statistical period based on the selected statistical method. Valid values:'."\n" + .'- count: counts the number of occurrences.'."\n" + .'- sum: calculates the sum.'."\n" + .'- avg: calculates the average.'."\n" + .'- max: returns the maximum value.'."\n" + .'- min: returns the minimum value.'."\n" + .'- value: samples within the period.'."\n" + .'- countps: calculates the per-second average of the count for the specified field within the statistical period.'."\n" + .'- sumps: calculates the per-second average of the sum for the specified field within the statistical period.'."\n" + .'- distinct: calculates the number of occurrences of the specified field after deduplication within the statistical period.'."\n" + .'- distribution: calculates the number of occurrences of field values within a specified range.'."\n" + .'- percentile: calculates the distribution value of field values, such as P50.', 'type' => 'string', 'required' => false, 'example' => 'count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the SLS log statistical result.', 'type' => 'string', 'minLength' => 0, 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', 'required' => false, 'example' => 'level_count', 'title' => ''], + 'Parameter1' => ['description' => 'The statistical value of SLS logs.'."\n" + ."\n" + .'- If `Function` is set to `distribution`, this parameter specifies the lower limit of the statistical range. For example, to count the number of 2XX HTTP status codes, set this parameter to 200.'."\n" + ."\n" + .'- If `Function` is set to `percentile`, this parameter specifies the percentile of the statistical distribution. For example, 0.5 indicates P50.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], + 'Parameter2' => ['description' => 'The statistical value of SLS logs.'."\n" + ."\n" + .'> This parameter is required only when `Function` is set to `distribution`. This parameter specifies the upper limit of the statistical range. For example, to count the number of 2XX HTTP status codes, set this parameter to 299.', 'type' => 'string', 'required' => false, 'example' => '299', 'title' => ''], + ], 'required' => false, - 'example' => '00:00-23:59', + 'title' => '', + 'example' => '', ], - 'NoEffectiveInterval' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'GroupBy' => [ + 'description' => 'Aggregates data by spatial dimension, which is equivalent to Group By in SQL.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the parameter for SLS log statistics.', 'type' => 'string', 'required' => false, 'example' => 'code', 'title' => ''], + 'Alias' => ['description' => 'The alias of the SLS log statistical result.', 'type' => 'string', 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', 'required' => false, 'example' => 'ApiResult', 'title' => ''], + ], 'required' => false, - 'example' => '00:00-23:59', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5', - ], - 'Statistics' => [ - 'description' => 'The statistical aggregation method that is used to calculate the metric values.'."\n" - ."\n" - .'Valid values of N: 1 to 3.'."\n" - ."\n" - .'> Set the value to Average.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Average', + 'title' => '', + 'example' => '', ], - 'TargetList' => [ - 'description' => 'The alert triggers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert trigger.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n" - ."\n" - .'For more information about how to obtain the ID of a resource for which alerts are triggered, see [DescribeMetricRuleTargets](~~121592~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.'."\n" - ."\n" - .'For more information about how to query the ARN of a resource, see [DescribeMetricRuleTargets](~~121592~~).'."\n" - ."\n" - .'Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:'."\n" - ."\n" - .'* {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).'."\n" - ."\n" - .'* {userId}: the ID of the Alibaba Cloud account.'."\n" - ."\n" - .'* {regionId}: the region ID of the SMQ queue or topic.'."\n" - ."\n" - .'* {Resource type}: the type of the resource that triggers the alert. Valid values:'."\n" - ."\n" - .' * **queues**'."\n" - .' * **topics**'."\n" - ."\n" - .'* {Resource name}: the resource name.'."\n" - ."\n" - .' * If the resource type is **queues**, the resource name is the queue name.'."\n" - .' * If the resource type is **topics**, the resource name is the topic name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - 'required' => false, + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Express' => [ + 'description' => 'The arithmetic operation result of the extended field for SLS log statistical results.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Express' => ['description' => 'The arithmetic operation result of the extended field for SLS log statistical results.', 'type' => 'string', 'required' => false, 'example' => 'success_count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the arithmetic operation result of the extended field for SLS log statistical results.', 'type' => 'string', 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', 'required' => false, 'example' => 'SuccRate', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => true, - 'maxItems' => 3, + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'CloudAccessId', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The list of primary account IDs of other cloud providers that are connected to CloudMonitor.', + 'type' => 'array', + 'items' => ['description' => 'The primary account ID of another cloud provider that is connected to CloudMonitor.', 'type' => 'string', 'required' => false, 'example' => 'n5n9ik1b****', 'title' => ''], + 'required' => false, + 'maxItems' => 50, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3F6150F9-45C7-43F9-9578-A58B2E726C90', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid values:'."\n" - ."\n" - .'* true: The call is successful.'."\n" - .'* false: The call fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resource' => [ - 'description' => 'The group process information.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupProcessId' => [ - 'description' => 'The ID of the group process.'."\n", - 'type' => 'string', - 'example' => '7F2B0024-4F21-48B9-A764-211CEC48****', - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'yamlConfigFail', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '28CEA2E0-3E90-51B2-A7E8-B1ED75534E49', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'TaskId' => ['description' => 'The monitoring task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '36****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"yamlConfigFail\\",\\n \\"RequestId\\": \\"28CEA2E0-3E90-51B2-A7E8-B1ED75534E49\\",\\n \\"Success\\": \\"true\\",\\n \\"TaskId\\": 0\\n}","type":"json"}]', + 'title' => 'Create a monitoring task', + 'description' => '## Operation description'."\n" + .'- Before calling this operation, make sure that Hybrid Cloud Monitoring is activated.'."\n" + .'- To create a metric for SLS logs, make sure that SLS is activated and that a project and a Logstore are created.'."\n" + .'- Depending on the value of `TaskType`, some parameters are required. For example, if `TaskType` is set to `aliyun_fc`, you must configure `YARMConfig`. If `TaskType` is set to `aliyun_sls`, you must configure parameters such as `CollectInterval`.'."\n" + .'- For cross-account operations, specify `TargetUserId` or `TargetUserIdList` to connect resources of other members to Hybrid Cloud Monitoring.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2023-12-21T08:28:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-27T07:31:04.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-09T09:38:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-09T02:41:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-09T02:41:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHybridMonitorTask'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateHybridMonitorTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"718FEA81-64C3-4F23-8F90-0531F7489FC1\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"GroupProcessId\\": \\"7F2B0024-4F21-48B9-A764-211CEC48****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateGroupMonitoringAgentProcessResponse>\\n <Code>200</Code>\\n <RequestId>718FEA81-64C3-4F23-8F90-0531F7489FC1</RequestId>\\n <Success>true</Success>\\n <Resource>\\n <GroupProcessId>7F2B0024-4F21-48B9-A764-211CEC48****</GroupProcessId>\\n </Resource>\\n</CreateGroupMonitoringAgentProcessResponse>","errorExample":""}]', - 'title' => 'CreateGroupMonitoringAgentProcess', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ModifyGroupMonitoringAgentProcess' => [ - 'summary' => '修改应用分组内的进程监控', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateInstantSiteMonitor' => [ + 'summary' => 'Creates a one-time site monitoring task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Address', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the process monitoring task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '92E3065F-0980-4E31-9AA0-BA6****', - ], + 'schema' => ['description' => 'The URL or IP address of the monitoring node.', 'type' => 'string', 'required' => true, 'example' => 'http://www.aliyun.com', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '6780****', - ], + 'schema' => ['description' => 'The type of the monitoring node.'."\n" + .'Valid values: HTTP, PING, TCP, UDP, and DNS.', 'type' => 'string', 'required' => true, 'example' => 'HTTP', 'title' => ''], ], [ - 'name' => 'MatchExpressFilterRelation', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'The logical operator used between conditional expressions that are used to match instances. Valid values:'."\n" - ."\n" - .'* all'."\n" - .'* and'."\n" - .'* or'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'and', - ], + 'schema' => ['description' => 'The name of the monitoring node.'."\n" + ."\n" + .'<props="china">The name must be 4 to 100 characters in length and can contain letters, digits, underscores (_), and Chinese characters.</props>'."\n" + ."\n\n" + .'<props="intl">The name must be 4 to 100 characters in length and can contain letters, digits, and underscores (_).</props>'."\n" + ."\n" + .'<props="partner">The name must be 4 to 100 characters in length and can contain letters, digits, and underscores (_).</props>', 'type' => 'string', 'required' => true, 'example' => 'task1', 'title' => ''], ], [ - 'name' => 'AlertConfig', + 'name' => 'IspCities', + 'in' => 'query', + 'schema' => ['description' => 'The detection point information. If this parameter is left empty, the system randomly selects three detection points.'."\n" + ."\n" + .'The value is in `JSONArray` format. Example: [{"city":"546","isp":"465", "type":"IDC"},{"city":"572","isp":"465", "type":"LASTMILE"},{"city":"738","isp":"465"}], which correspond to Beijing, Hangzhou, and Qingdao respectively.'."\n" + ."\n" + .'The type parameter specifies the detection point type. When AgentGroup is set to PC, valid values are IDC and LASTMILE. IDC indicates detection points with deployment in data centers. LASTMILE indicates detection points with deployment in end-user homes that use fixed-line networks. The type parameter is an optional options. Default value: IDC. When AgentGroup is set to MOBILE, this parameter does not need to be specified.'."\n" + ."\n" + .'For information about how to obtain detection point information, see [DescribeSiteMonitorISPCityList](~~115045~~).'."\n" + ."\n" + .'> You must specify either `IspCities` or `RandomIspCity`.', 'type' => 'string', 'required' => false, 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', 'title' => ''], + ], + [ + 'name' => 'OptionsJson', + 'in' => 'query', + 'schema' => ['description' => 'The advanced extension options for the protocol type of the monitoring node. Different protocol types correspond to different extension options.', 'type' => 'string', 'required' => false, 'example' => '{"time_out":5000}', 'title' => ''], + ], + [ + 'name' => 'RandomIspCity', + 'in' => 'query', + 'schema' => ['description' => 'The number of detection points.'."\n" + ."\n" + .'> - You must specify either `IspCities` or `RandomIspCity`.- If you configure the Settings for the `RandomIspCity` parameter, the `IspCities` parameter automatically becomes invalid.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AgentGroup', 'in' => 'query', - 'style' => 'flat', 'schema' => [ - 'description' => 'The alert rule configurations.', - 'type' => 'array', - 'items' => [ - 'description' => 'The alert rule configurations.', - 'type' => 'object', - 'properties' => [ - 'SilenceTime' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met. Valid values of N: 1 to 200.'."\n" - ."\n" - .'Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day.'."\n" - ."\n" - .'> Only one alert notification is sent during a mute period even if the metric value exceeds the alert threshold during consecutive checks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '86400', - ], - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values of N: 1 to 200. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold.'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday.'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Webhook' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.aliyun.com', - ], - 'Times' => [ - 'description' => 'The number of times for which the threshold can be consecutively exceeded. Valid values of N: 1 to 200. Default value: 3.'."\n" - ."\n" - .'> A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3', - ], - 'EscalationsLevel' => [ - 'description' => 'The level of the alert. Valid values of N: 1 to 200. Valid values:'."\n" - ."\n" - .'* critical (default value): critical'."\n" - .'* warn: warning'."\n" - .'* info: information'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'warn', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is effective. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-22:59', - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is ineffective. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '23:00-23:59', - ], - 'Threshold' => [ - 'description' => 'The alert threshold. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5', - ], - 'Statistics' => [ - 'description' => 'The statistical aggregation method that is used to calculate the metric values. Valid values of N: 1 to 200.'."\n" - ."\n" - .'> Set the value to Average.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'TargetList' => [ - 'description' => 'The alert trigger.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert trigger.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n" - ."\n" - .'For information about how to obtain the ID of a resource for which alerts are triggered, see [DescribeMetricRuleTargets](~~121592~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.'."\n" - ."\n" - .'For information about how to obtain the ARN of a resource, see [DescribeMetricRuleTargets](~~121592~~).'."\n" - ."\n" - .'Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:'."\n" - ."\n" - .'- {Service name abbreviation}: the abbreviation of the service name. Valid value: mns.'."\n" - .'- {userId}: the ID of the Alibaba Cloud account.'."\n" - .'- {regionId}: the region ID of the message queue or topic.'."\n" - .'- {Resource type}: the type of the resource for which alerts are triggered. Valid values: '."\n" - .' - **queues** '."\n" - .' - **topics** '."\n" - .'- {Resourcename}: the name of the resource. '."\n" - .' - If the resource type is set to **queues**, the resource name is the name of the message queue. '."\n" - .' - If the resource type is set to **topics**, the resource name is the name of the topic.`', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The level of the alert. Valid values:'."\n" - ."\n" - .'* INFO: information'."\n" - .'* WARN: warning'."\n" - .'* CRITICAL: critical'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 3, + 'description' => 'The type of detection point. Valid values: PC and MOBILE. PC indicates fixed-line network detection points. MOBILE indicates mobile terminal detection points. Default value: PC.', + 'type' => 'string', + 'enum' => ['PC', 'MOBILE'], + 'required' => false, + 'example' => 'PC', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'N/A.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + .'* true: Successful.'."\n" + .'* false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'CreateResultList' => [ + 'description' => 'The result list of the one-time site monitoring node.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result list of the one-time site monitoring node.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The monitoring node ID.', 'type' => 'string', 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', 'title' => ''], + 'TaskName' => ['description' => 'The monitoring node name.', 'type' => 'string', 'example' => 'task1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalAddress', 'errorMessage' => 'Illegal HTTP address', 'description' => ''], + ['errorCode' => 'OperationError', 'errorMessage' => 'Operation failed', 'description' => ''], + ['errorCode' => 'TaskNotExists', 'errorMessage' => 'Task does not exist', 'description' => ''], + ['errorCode' => 'OperatorInvalid', 'errorMessage' => 'Operator invalid', 'description' => ''], + ['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Operator City invalid', 'description' => ''], + ['errorCode' => 'NameRepeat', 'errorMessage' => 'Task name repeat', 'description' => ''], + ['errorCode' => 'CreateAlarmError', 'errorMessage' => 'Create alarm error', 'description' => ''], + ['errorCode' => 'NameNotExists', 'errorMessage' => 'Task name not exists', 'description' => ''], + ['errorCode' => 'Illegal Task Name', 'errorMessage' => 'The task name of the sitemonitor task is illegal.', 'description' => 'Site monitoring task name is illegal.'], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'Forbidden', 'errorMessage' => '%s', 'description' => ''], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"7985D471-3FA8-4EE9-8F4B-45C19DF3D36F\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyGroupMonitoringAgentProcess>\\n\\t\\t<RequestId>7985D471-3FA8-4EE9-8F4B-45C19DF3D36F</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</ModifyGroupMonitoringAgentProcess>","errorExample":""}]', - 'title' => 'ModifyGroupMonitoringAgentProcess', - 'requestParamsDescription' => ' ', + 'title' => 'Create a one-time site monitoring task', + 'description' => 'Only Alibaba Cloud accounts that have activated Network Analysis and Monitoring can create one-time site monitoring tasks.'."\n" + ."\n" + .'This topic provides an example of how to create a one-time site monitoring task. The task name is `task1`, the monitored address is `http://www.China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China China.', + 'requestParamsDescription' => '## Advanced metric description for TaskType'."\n" + ."\n" + .'The following tables describe how to configure the Settings for the advanced parameters for HTTP, PING, TCP, UDP, and DNS in `TaskType`.'."\n" + ."\n" + .'- HTTP'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|http_method |String |The HTTP request method. Valid values: GET, POST, and HEAD. Default value: GET. |'."\n" + .'|header |String |Custom HTTP headers separated by line breaks (\\n).<br>Each header line must conform to the HTTP protocol (key-value pairs separated by a colon). |'."\n" + .'|cookie |String |The cookie, which follows the standard HTTP request format. |'."\n" + .'|request_content |String |The request content. Two formats are supported: JSON and form. If this parameter is not specified, the request does not contain a body. |'."\n" + .'|response_content |String |The expected response content. During monitoring, the first 64 bytes returned by the HTTP server are checked. |'."\n" + .'|match_rule |String |0: The monitoring succeeds if the response does not contain response_content.<br>1: The monitoring succeeds if the response contains response_content. |'."\n" + .'|username |String |If a username is provided, a BasicAuth header is included in the HTTP request. |'."\n" + .'|password |String |The HTTP request authentication password. |'."\n" + .'|time_out |int |The timeout period. Unit: milliseconds. Default value: 30000. |'."\n" + .'|max_redirect |int |The maximum number of redirects. The default value is 5 for ECS probes and 2 for carrier detection points.<br>To disable redirects, set this parameter to 0.<br>Valid values: 0 to 50. |'."\n" + ."\n" + .' '."\n" + .'- PING'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|failure_rate |int |If the PING failure rate exceeds this value, the monitoring is failed and returns 610 (PingAllFail) or 615 (PingPartialFail).<br>Default value: 0.1. |'."\n" + .'|ping_num |int |The number of PING attempts. Default value: 20.<br>Valid values: 1 to 100. |'."\n" + ."\n" + .'- TCP or UDP'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |The port of the TCP or UDP server. |'."\n" + .'|request_content |string |The request content. When request_format is set to hex, the request_content value is in hexadecimal compact format. |'."\n" + .'|request_format |string |When request_format is set to other values, request_content is sent to the TCP or UDP server as a plain character string. |'."\n" + .'|response_content |string |The response content. If the content returned by the TCP or UDP server does not contain response_content, the monitoring is failed.<br>When response_format is set to hex, the response_content value is in hexadecimal compact format.<br>When response_content is set to other values, response_content is a plain character string. |'."\n" + ."\n" + .'- DNS'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|dns_server |string |The DNS server address, which can be a domain name or IP address. |'."\n" + .'|dns_type |string |The DNS query type. Valid values: A, NS, CNAME, MX, TXT, and ANY. |'."\n" + .'|expect_value |string |The list of expected values separated by whitespace. |'."\n" + .'|match_rule |string |The relationship between the expected value list and the DNS list. If the specified relationship is not met, the monitoring is failed. <br>Empty string or IN_DNS: The expected value list is a subset of the DNS list. <br>DNS_IN: The DNS list is a subset of the expected value list. <br>EQUAL: The DNS list is equal to the expected value list. <br>ANY: The DNS list and the expected value list have a non-empty intersection. |', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteGroupMonitoringAgentProcess' => [ - 'summary' => 'Deletes a process monitoring task for an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-08-22T03:53:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-07T12:32:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-07T08:50:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-29T08:05:31.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-22T09:29:55.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-12-01T09:58:37.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstantSiteMonitor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateInstantSiteMonitor', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"68192f5d-0d45-4b98-9724-892813f86c71\\",\\n \\"Success\\": \\"true\\",\\n \\"CreateResultList\\": [\\n {\\n \\"TaskId\\": \\"2c8dbdf9-a3ab-46a1-85a4-f094965e****\\",\\n \\"TaskName\\": \\"task1\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateMetricRuleBlackList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the blacklist policy.', 'type' => 'string', 'required' => true, 'example' => 'Blacklist-01', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For more information about the namespaces of different cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => ['description' => 'The category of the cloud service. For example, ApsaraDB for Redis includes the following categories: ApsaraDB for Redis (standard architecture), ApsaraDB for Redis (cluster architecture), and ApsaraDB for Redis (read/write splitting architecture). In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + ], + [ + 'name' => 'ScopeType', + 'in' => 'query', + 'schema' => ['description' => 'The effective scope of the blacklist policy. Valid values:'."\n" + ."\n" + .'- USER (default): The blacklist policy takes effect only for the current Alibaba Cloud account.'."\n" + ."\n" + .'- GROUP: The blacklist policy takes effect only for the specified application group. For information about how to query the IDs of application groups, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'example' => 'USER', 'title' => ''], + ], + [ + 'name' => 'ScopeValue', 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group. The value of this parameter is a JSON array.'."\n" + ."\n" + .'> This parameter must be specified when `ScopeType` is set to `GROUP`.', 'type' => 'string', 'required' => false, 'example' => '["67****","78****"]', 'title' => ''], + ], + [ + 'name' => 'EnableStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The timestamp when the blacklist policy starts to take effect.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1640237400000', 'title' => ''], + ], + [ + 'name' => 'EnableEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The timestamp when the blacklist policy expires.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1640608200000', 'title' => ''], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => ['description' => 'The time range within which the blacklist policy is effective.'."\n" + ."\n" + .'- If you do not configure this parameter, the blacklist policy is permanently effective.'."\n" + ."\n" + .'- If you configure this parameter, the blacklist policy is effective only within the specified time range. Examples:'."\n" + ."\n" + .' - `03:00-04:59`: The blacklist policy is effective from 03:00 to 05:00 local time. 05:00 local time is excluded.'."\n" + ."\n" + .' - `03:00-04:59 UTC+0700`: The blacklist policy is effective from 03:00 to 05:00 (UTC+7). 05:00 (UTC+7) is excluded.', 'type' => 'string', 'required' => false, 'example' => '03:00-04:59', 'title' => ''], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the instances that belong to the specified cloud service.', + 'type' => 'array', + 'items' => ['description' => 'The IDs of the instances that belong to the specified cloud service.'."\n" + ."\n" + .'Valid values of N: 1 to 100.', 'type' => 'string', 'required' => false, 'example' => '{"instanceId":"i-bp1ew0zfkjblsuwx****"}', 'title' => ''], 'required' => true, - 'example' => '123456', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Id', + 'name' => 'Metrics', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the process monitoring task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '48F83746-C817-478C-9B06-7158F56B****', + 'description' => 'The metrics of the instance.'."\n" + ."\n" + .'- If you do not configure this parameter, the blacklist policy applies to all metrics of the specified cloud service.'."\n" + ."\n" + .'- If you configure this parameter, the blacklist policy applies only to the current metric.', + 'type' => 'array', + 'items' => [ + 'description' => 'None', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name.'."\n" + ."\n" + .'Valid values of N: 1 to 10.', 'type' => 'string', 'required' => true, 'example' => 'disk_utilization', 'title' => ''], + 'Resource' => ['description' => 'The extended dimension of the instance. For example, `{"device":"C:"}` specifies that the blacklist policy is applied to all C disks of the specified Elastic Compute Service (ECS) instance.'."\n" + ."\n" + .'Valid values of N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => '{"device":"C:"}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3F6150F9-45C7-43F9-9578-A58B2E726C90', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request has failed due to a temporary failure of the server.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5C637FA3-3959-3352-8BE6-78CE2ED2D33D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The ID of the blacklist policy.', 'type' => 'string', 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'CreateMetricRuleBlackList', + 'summary' => 'Creates a blacklist policy.', + 'description' => '### Background information'."\n" + ."\n" + .'- CloudMonitor blocks alert notifications based on the blacklist policies that take effect. To block alert notifications when the value of a metric that belongs to a cloud service reaches the threshold that you specified, add the metric to a blacklist policy.'."\n" + ."\n" + .'- CloudMonitor allows you to create blacklist policies only based on threshold metrics. You cannot create blacklist policies based on system events. For more information about the cloud services and the thresholds of the metrics that are supported by CloudMonitor, see [Appendix 1: Metrics](~~163515~~).', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2023-04-23T03:09:37.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetricRuleBlackList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMetricRuleBlackList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"3F6150F9-45C7-43F9-9578-A58B2E726C90\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteGroupMonitoringAgentProcessResponse>\\n\\t\\t<RequestId>7985D471-3FA8-4EE9-8F4B-45C19DF3D36F</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</DeleteGroupMonitoringAgentProcessResponse>","errorExample":""}]', - 'title' => 'DeleteGroupMonitoringAgentProcess', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"RequestId\\": \\"5C637FA3-3959-3352-8BE6-78CE2ED2D33D\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"93514c96-ceb8-47d8-8ee3-93b6d98b****\\"\\n}","type":"json"}]', ], - 'DescribeGroupMonitoringAgentProcess' => [ - 'summary' => 'Queries the process monitoring tasks for an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateMetricRuleResources' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'ProcessName', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The process name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sshd', - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'i-2ze3w55tr2rcpejpcfap_59c96b85-0339-4f35-ba66-ae4e34d3****', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Overwrite', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to overwrite. Valid values:'."\n" + ."\n" + .'- true: overwrites. The resources submitted this time overwrite the previously associated resources. That is, full modification is performed.'."\n" + ."\n" + .'- false: does not overwrite. The resources submitted this time do not overwrite the previously associated resources (the associated resources are the historical associated resources plus the resources submitted this time). That is, incremental modification is performed.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Resources', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '30', - ], + 'schema' => ['description' => 'The associated resources. The value is in the JSON array format.'."\n" + .'> A maximum of 100 resource instances can be added at a time, and an alert rule can be associated with a maximum of 3,000 instances.'."\n" + .'>', 'type' => 'string', 'required' => true, 'example' => '[{"instanceId":"i-a2d5q7pm3f9yr29e****"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status codes.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'PageNumber' => [ - 'description' => 'The page number. Default value: 1'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'string', - 'example' => '28', - ], - 'Processes' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Process' => [ - 'description' => 'The process monitoring tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The process monitoring task.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProcessName' => [ - 'description' => 'The process name.'."\n", - 'type' => 'string', - 'example' => 'sshd', - ], - 'MatchExpressFilterRelation' => [ - 'description' => 'The logical operator used between conditional expressions that are used to match instances. Valid values:'."\n" - ."\n" - .'* all'."\n" - .'* and'."\n" - .'* or'."\n", - 'type' => 'string', - 'example' => 'and', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'Id' => [ - 'description' => 'The ID of the process monitoring task.'."\n", - 'type' => 'string', - 'example' => '3F6150F9-45C7-43F9-9578-A58B2E72****', - ], - 'MatchExpress' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MatchExpress' => [ - 'description' => 'The matching conditions.'."\n" - ."\n" - .'> Only the instances that meet the conditional expressions are monitored by the process monitoring task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The keyword used to match the instance name.'."\n", - 'type' => 'string', - 'example' => 'portalHost', - ], - 'Name' => [ - 'description' => 'The criteria based on which the instances are matched.'."\n" - ."\n" - .'> Set the value to `name`. The value name indicates that the instances are matched based on the instance name.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'Function' => [ - 'description' => 'The matching condition. Valid values:'."\n" - ."\n" - .'* all (default): matches all'."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n" - .'* contains: contains'."\n" - .'* notContains: excludes'."\n" - .'* equals: equals'."\n" - ."\n" - .'> The matched instances are monitored by the process monitoring task.'."\n", - 'type' => 'string', - 'example' => 'all', - ], - ], - ], - ], - ], - ], - 'AlertConfig' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AlertConfig' => [ - 'description' => 'The alert rule configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert rule configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday.'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'SilenceTime' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day.'."\n" - ."\n" - .'> Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.'."\n", - 'type' => 'string', - 'example' => '86400', - ], - 'Webhook' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.'."\n", - 'type' => 'string', - 'example' => 'http://www.aliyun.com', - ], - 'Times' => [ - 'description' => 'The number of times for which the threshold can be consecutively exceeded.'."\n" - ."\n" - .'> A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'EscalationsLevel' => [ - 'description' => 'The level of the alert. Valid values:'."\n" - ."\n" - .'* critical'."\n" - .'* warn'."\n" - .'* Info'."\n", - 'type' => 'string', - 'example' => 'warn', - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is ineffective.'."\n", - 'type' => 'string', - 'example' => '00:00-23:59', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is effective.'."\n", - 'type' => 'string', - 'example' => '00:00-23:59', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '5', - ], - 'Statistics' => [ - 'description' => 'The method used to calculate metric values that trigger alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - 'TargetList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Target' => [ - 'description' => 'The resources for which alerts are triggered.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource for which alerts are triggered.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Format: acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message. Example: acs:mns:cn-hangzhou:120886317861\\*\\*\\*\\*:/queues/test123/message. Fields:'."\n" - ."\n" - .'* {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).'."\n" - ."\n" - .'* {userId}: the ID of the Alibaba Cloud account.'."\n" - ."\n" - .'* {regionId}: the region ID of the SMQ queue or topic.'."\n" - ."\n" - .'* {Resource type}: the type of the resource for which alerts are triggered. Valid values:'."\n" - ."\n" - .' * **queues**'."\n" - .' * **topics**'."\n" - ."\n" - .'* {Resource name}: the resource name.'."\n" - ."\n" - .' * If the resource type is **queues**, the resource name is the queue name.'."\n" - .' * If the resource type is **topics**, the resource name is the topic name.'."\n", - 'type' => 'string', - 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'example' => 'CRITICAL', - ], - 'JsonParmas' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + .'> The value 200 indicates success.'."\n" + .'>', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0671A721-0D7A-4F11-BB77-2416325D65AB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. The value true indicates success, and the value false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7985D471-3FA8-4EE9-8F4B-45C19DF3D36F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"Total\\": \\"28\\",\\n \\"Processes\\": {\\n \\"Process\\": [\\n {\\n \\"ProcessName\\": \\"sshd\\",\\n \\"MatchExpressFilterRelation\\": \\"and\\",\\n \\"GroupId\\": \\"12345\\",\\n \\"Id\\": \\"3F6150F9-45C7-43F9-9578-A58B2E72****\\",\\n \\"MatchExpress\\": {\\n \\"MatchExpress\\": [\\n {\\n \\"Value\\": \\"portalHost\\",\\n \\"Name\\": \\"name\\",\\n \\"Function\\": \\"all\\"\\n }\\n ]\\n },\\n \\"AlertConfig\\": {\\n \\"AlertConfig\\": [\\n {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"SilenceTime\\": \\"86400\\",\\n \\"Webhook\\": \\"http://www.aliyun.com\\",\\n \\"Times\\": \\"3\\",\\n \\"EscalationsLevel\\": \\"warn\\",\\n \\"NoEffectiveInterval\\": \\"00:00-23:59\\",\\n \\"EffectiveInterval\\": \\"00:00-23:59\\",\\n \\"Threshold\\": \\"5\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"TargetList\\": {\\n \\"Target\\": [\\n {\\n \\"Id\\": \\"123\\",\\n \\"Arn\\": \\"acs:mns:cn-hangzhou:120886317861****:/queues/test/message\\",\\n \\"Level\\": \\"CRITICAL\\",\\n \\"JsonParmas\\": \\"{\\\\\\"customField1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"customField2\\\\\\":\\\\\\"$.name\\\\\\"}\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeGroupMonitoringAgentProcess>\\r\\n\\t\\t<RequestId>7985D471-3FA8-4EE9-8F4B-45C19DF3D36F</RequestId>\\r\\n\\t\\t<PageSize>10</PageSize>\\r\\n\\t\\t<PageNumber>1</PageNumber>\\r\\n\\t\\t<Total>28</Total>\\r\\n\\t\\t<Processes>\\r\\n\\t\\t\\t<Process>\\r\\n\\t\\t\\t\\t<ProcessName>sshd</ProcessName>\\r\\n\\t\\t\\t\\t<MatchExpressFilterRelation>and</MatchExpressFilterRelation>\\r\\n\\t\\t\\t\\t<Id>3F6150F9-45C7-43F9-9578-A58B2E72****</Id>\\r\\n\\t\\t\\t\\t<GroupId>12345</GroupId>\\r\\n\\t\\t\\t</Process>\\r\\n\\t\\t\\t<Process>\\r\\n\\t\\t\\t\\t<AlertConfig>\\r\\n\\t\\t\\t\\t\\t<AlertConfig>\\r\\n\\t\\t\\t\\t\\t\\t<Function>all</Function>\\r\\n\\t\\t\\t\\t\\t\\t<Value>portalHost</Value>\\r\\n\\t\\t\\t\\t\\t\\t<Name>name</Name>\\r\\n\\t\\t\\t\\t\\t</AlertConfig>\\r\\n\\t\\t\\t\\t\\t<AlertConfig>\\r\\n\\t\\t\\t\\t\\t\\t<NoEffectiveInterval>00:00-23:59</NoEffectiveInterval>\\r\\n\\t\\t\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Webhook>http://www.aliyun.com</Webhook>\\r\\n\\t\\t\\t\\t\\t\\t<EffectiveInterval>00:00-23:59</EffectiveInterval>\\r\\n\\t\\t\\t\\t\\t\\t<EscalationsLevel>warn</EscalationsLevel>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>5</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertConfig>\\r\\n\\t\\t\\t\\t</AlertConfig>\\r\\n\\t\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t\\t\\t<Function>all</Function>\\r\\n\\t\\t\\t\\t\\t\\t<Value>portalHost</Value>\\r\\n\\t\\t\\t\\t\\t\\t<Name>name</Name>\\r\\n\\t\\t\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t\\t\\t<NoEffectiveInterval>00:00-23:59</NoEffectiveInterval>\\r\\n\\t\\t\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Webhook>http://www.aliyun.com</Webhook>\\r\\n\\t\\t\\t\\t\\t\\t<EffectiveInterval>00:00-23:59</EffectiveInterval>\\r\\n\\t\\t\\t\\t\\t\\t<EscalationsLevel>warn</EscalationsLevel>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>5</Threshold>\\r\\n\\t\\t\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t</Process>\\r\\n\\t\\t</Processes>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeGroupMonitoringAgentProcess>\\r\\n","errorExample":""}]', - 'title' => 'DescribeGroupMonitoringAgentProcess', - 'description' => 'You can create a process monitoring task to monitor all or the specified Elastic Compute Service (ECS) instances in an application group and configure alert rules for the process monitoring task.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateMonitorGroupNotifyPolicy' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Create a resource associated with an alert rule', + 'summary' => 'Calls the CreateMetricRuleResources operation to create a resource associated with an alert rule.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetricRuleResources'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMetricRuleResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0671A721-0D7A-4F11-BB77-2416325D65AB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateMetricRuleTemplate' => [ + 'summary' => 'Creates an alert template.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PolicyType', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The policy type. Valid value: PauseNotify.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PauseNotify', - 'enum' => [ - 'PauseNotify', - ], - ], + 'schema' => ['description' => 'The name of the alert template.', 'type' => 'string', 'required' => true, 'example' => 'Template1', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7301****', - ], + 'schema' => ['description' => 'The description of the alert template.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Template1', 'title' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the validity period for the policy.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1622949300000', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'AlertTemplates', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The end time of the validity period for the policy.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1623208500000', + 'description' => 'The details of the alert template.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert template.', + 'type' => 'object', + 'properties' => [ + 'Escalations.Info.Threshold' => ['description' => 'The threshold for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the name of a metric, see [DescribeMetricMetaList](~~98846~~) or [Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_total', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The callback URL must be accessible over the Internet. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.', 'type' => 'string', 'required' => false, 'example' => 'http://ww.aliyun.com', 'title' => ''], + 'Escalations.Warn.Threshold' => ['description' => 'The threshold for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'Period' => ['description' => 'The aggregation period of monitoring data. Unit: seconds.'."\n" + ."\n" + .'The default value is the minimum aggregation period. Generally, you do not need to specify the minimum aggregation period.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => true, 'example' => 'ECS_Rule1', 'title' => ''], + 'Escalations.Critical.Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Selector' => ['description' => 'The dimension of the alert. It is an extended field.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For example, an alert template is applied to an application group, this parameter is set to `{"disk":"/"}`, and the MetricName parameter is set to `DiskUtilization`. In this case, the generated alert rule is applied to the root disk partition (`"/"`) of all instances in the application group to which the alert template is applied.'."\n" + ."\n" + .'> For more information about the values of extended fields, see [DescribeMetricRuleTemplateAttribute](~~114979~~).', 'type' => 'string', 'required' => false, 'example' => '{"disk":"/"}', 'title' => ''], + 'Escalations.Info.Statistics' => ['description' => 'The statistical method for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Warn.Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Escalations.Info.ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Category' => ['description' => 'The abbreviation of the cloud service name.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + 'Escalations.Critical.Threshold' => ['description' => 'The threshold for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + 'Escalations.Critical.Statistics' => ['description' => 'The statistical method for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Critical.ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Warn.ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Info.Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Escalations.Warn.Statistics' => ['description' => 'The statistical method for the Warn-level alert.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '13356BCA-3EC3-4748-A771-2064DA69AEF1', - ], - 'Result' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9763ED1A-4D09-41BF-851E-310421750204', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The ID of the alert template.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidClientTokenId', 'errorMessage' => 'not allow this operation.', 'description' => 'No permission'], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], + ], + 412 => [ + ['errorCode' => 'ResourcesOverLimit', 'errorMessage' => 'Resources over limit.', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error. ', - ], + ['errorCode' => 'InternalFailure', 'errorMessage' => '%s', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"13356BCA-3EC3-4748-A771-2064DA69AEF1\\",\\n \\"Result\\": 1,\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitorGroupNotifyPolicyResponse>\\n\\t\\t<RequestId>13356BCA-3EC3-4748-A771-2064DA69AEF1</RequestId>\\n\\t\\t<Result>1</Result>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</CreateMonitorGroupNotifyPolicyResponse>","errorExample":""}]', - 'title' => 'CreateMonitorGroupNotifyPolicy', - 'summary' => 'Creates a policy to pause alert notifications for an application group.', - 'description' => 'If the policy is valid, no alert notifications are sent for the application group.'."\n" - ."\n" - .'This topic describes how to create a `PauseNotify` policy to pause alert notifications for the `7301****` application group. The StartTime parameter is set to `1622949300000` and the EndTime parameter is set to `1623208500000`. This indicates that the policy is valid from `2021-06-06 11:15:00 UTC+8` to `2021-06-09 11:15:00 UTC+8`.'."\n", + 'title' => 'CreateMetricRuleTemplate', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMonitorGroupNotifyPolicy' => [ - 'summary' => 'Deletes a policy that is used to pause alert notifications for an application group.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-12T07:07:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetricRuleTemplate'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMetricRuleTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"9763ED1A-4D09-41BF-851E-310421750204\\",\\n \\"Success\\": true,\\n \\"Id\\": 12345\\n}","type":"json"}]', + ], + 'CreateMonitorAgentProcess' => [ + 'summary' => 'Creates a task to monitor a process.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PolicyType', + 'name' => 'ProcessName', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the policy.'."\n" - ."\n" - .'Valid value: PauseNotify.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PauseNotify', - 'enum' => [ - 'PauseNotify', - ], - ], + 'schema' => ['description' => 'The process name.', 'type' => 'string', 'required' => true, 'example' => 'AliYunDun', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6780****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-2ze2d6j5uhg20x47****', 'title' => ''], + ], + [ + 'name' => 'ProcessUser', + 'in' => 'query', + 'schema' => ['description' => 'The user who launches the process.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7AF834D-D38B-4A46-920B-FE974EB7E135', - ], - 'Result' => [ - 'description' => 'The number of affected rows.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '971CC023-5A96-452A-BB7C-2483F948BCFD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The process ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error. ', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"B7AF834D-D38B-4A46-920B-FE974EB7E135\\",\\n \\"Result\\": 1,\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteMonitorGroupNotifyPolicyResponse>\\n <Result>1</Result>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteMonitorGroupNotifyPolicyResponse>","errorExample":""}]', - 'title' => 'DeleteMonitorGroupNotifyPolicy', + 'title' => 'CreateMonitorAgentProcess', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitorGroupNotifyPolicyList' => [ - 'summary' => 'Queries the policies that are used to pause alert notifications for an application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMonitorAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"971CC023-5A96-452A-BB7C-2483F948BCFD\\",\\n \\"Success\\": true,\\n \\"Id\\": 123456\\n}","type":"json"}]', + ], + 'CreateMonitorGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PolicyType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the policy.'."\n" - ."\n" - .'Valid value: PauseNotify.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PauseNotify', - 'enum' => [ - 'PauseNotify', - ], - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => true, 'example' => 'ECS_Group', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'ContactGroups', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6780****', - ], + 'schema' => ['description' => 'The alert contact group. The alert notifications of the application group are sent to the alert contacts that belong to the alert contact group.'."\n" + ."\n" + .'> An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~PutContact~~) and [PutContactGroup](~~PutContactGroup~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS_Alert_Group', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6072F026-C441-41A6-B114-35A1E8F8FDD3', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'NotifyPolicyList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NotifyPolicy' => [ - 'description' => 'The returned policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1551761781273', - ], - 'Type' => [ - 'description' => 'The policy type.'."\n", - 'type' => 'string', - 'example' => 'PauseNotify', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1551761781273', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '6780****', - ], - 'Id' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'string', - 'example' => '123****', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '83C89BA6-ABD4-4398-A175-83E86C47A001', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidClientTokenId', 'errorMessage' => 'not allow this operation.', 'description' => 'No permission'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], + ], + 412 => [ + ['errorCode' => 'ResourcesOverLimit', 'errorMessage' => 'Resources over limit.', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error. ', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"6072F026-C441-41A6-B114-35A1E8F8FDD3\\",\\n \\"Total\\": 11,\\n \\"Success\\": \\"true\\",\\n \\"NotifyPolicyList\\": {\\n \\"NotifyPolicy\\": [\\n {\\n \\"EndTime\\": 1551761781273,\\n \\"Type\\": \\"PauseNotify\\",\\n \\"StartTime\\": 1551761781273,\\n \\"GroupId\\": \\"6780****\\",\\n \\"Id\\": \\"123****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitorGroupNotifyPolicyListResponse>\\n <NotifyPolicyList>\\n <NotifyPolicy>\\n <Type>PauseNotify</Type>\\n <EndTime>1551763581273</EndTime>\\n <Id>123****</Id>\\n <StartTime>1551761781273</StartTime>\\n <GroupId>6780****</GroupId>\\n </NotifyPolicy>\\n </NotifyPolicyList>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Total>1</Total>\\n</DescribeMonitorGroupNotifyPolicyListResponse>","errorExample":""}]', - 'title' => 'DescribeMonitorGroupNotifyPolicyList', + 'title' => 'CreateMonitorGroup', + 'summary' => 'Creates an application group.', + 'description' => 'In this example, an application group named `ECS_Group` is created.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddTags' => [ - 'summary' => 'Adds tags to an application group.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-12T07:07:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMonitorGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"83C89BA6-ABD4-4398-A175-83E86C47A001\\",\\n \\"GroupId\\": 1234567,\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateMonitorGroupByResourceGroupId' => [ + 'summary' => 'Creates an application group by using a resource group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Tag', + 'name' => 'EnableSubscribeEvent', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n" - ."\n" - .'Valid values of N: 1 to 3. A tag key can be 1 to 64 characters in length.'."\n" - ."\n" - .'You can create a tag key or specify an existing tag key. For more information about how to obtain a tag key, see [DescribeTagKeyList](~~2513189~~).'."\n" - ."\n" - .'> The tag key cannot start with `aliyun` or `acs:`. The tag key (`Tag.N.Key`) and tag value (`Tag.N.Value`) must be specified at the same time.', - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n" - ."\n" - .'Valid values of N: 1 to 3. A tag value can be 1 to 64 characters in length.'."\n" - ."\n" - .'You can create a tag value or specify an existing tag value. For more information about how to obtain a tag value, see [DescribeTagValueList](~~2513188~~).'."\n" - ."\n" - .'> The tag value cannot start with `aliyun` or `acs:`. The tag key (`Tag.N.Key`) and tag value (`Tag.N.Value`) must be specified at the same time.', - 'type' => 'string', - 'required' => true, - 'example' => 'value1', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => true, - 'maxItems' => 5, - ], + 'schema' => ['description' => 'Specifies whether the application group automatically subscribes to event notifications. If events whose severity level is critical or warning occur on resources in an application group, CloudMonitor sends alert notifications. Valid values:'."\n" + ."\n" + .'- true: The application group automatically subscribes to event notifications.'."\n" + ."\n" + .'- false (default): The application group does not automatically subscribe to event notifications.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'GroupIds', + 'name' => 'EnableInstallAgent', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the CloudMonitor agent is automatically installed for the application group. CloudMonitor determines whether to automatically install the CloudMonitor agent for the hosts in an application group based on the value of this parameter. Valid values:'."\n" + ."\n" + .'- true: The CloudMonitor agent is automatically installed.'."\n" + ."\n" + .'- false (default): The CloudMonitor agent is not automatically installed.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region where the resource group resides.'."\n" + ."\n" + .'For information about how to obtain the ID of the region where a resource group resides, see [GetResourceGroup](~~158866~~).', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group.'."\n" + ."\n" + .'For information about how to obtain the ID of a resource group, see [ListResourceGroups](~~158855~~).', 'type' => 'string', 'required' => true, 'example' => 'rg-acfmw3ty5y7****', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.'."\n" + ."\n" + .'For information about how to obtain the name of a resource group, see [ListResourceGroups](~~158855~~).', 'type' => 'string', 'required' => true, 'example' => 'CloudMonitor', 'title' => ''], + ], + [ + 'name' => 'ContactGroupList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'Valid values of N: 1 to 20.'."\n" + 'description' => 'The alert contact groups. The alert notifications of the application group are sent to the alert contacts that belong to the specified alert contact groups.'."\n" ."\n" - .'For information about how to query the IDs of application groups, see [DescribeMonitorGroups](~~2513168~~).', + .'An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - ], + 'items' => ['description' => 'The alert contact group. The alert notifications of the application group are sent to the alert contacts that belong to the specified alert contact groups.'."\n" + ."\n" + .'An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS_Group', 'title' => ''], 'required' => true, - 'example' => '7301****', + 'example' => 'ECS_Group', 'maxItems' => 20, + 'title' => '', ], ], ], @@ -5187,492 +3806,359 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DAE4B115-3847-5438-8709-423627F0A3A3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '784CAB3C-F613-5BCE-8469-6DCB29B18A20', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '3607****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 4092 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'ResourceGroupId already create group', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"DAE4B115-3847-5438-8709-423627F0A3A3\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddTagsResponse>\\r\\n\\t<RequestId>DAE4B115-3847-5438-8709-423627F0A3A3</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</AddTagsResponse>\\t","errorExample":""}]', - 'title' => 'AddTags', - 'description' => 'This topic provides an example on how to add a tag to an application group whose ID is `7301****`. In this example, the key of the tag is `key1` and the value of the tag is `value1`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~315526~~).', + 'title' => 'CreateMonitorGroupByResourceGroupId', + 'description' => 'This topic provides an example on how to create an application group by using the resource group `CloudMonitor` and the alert contact group `ECS_Group`. The region ID of the resource group is `cn-hangzhou`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDynamicTagGroup' => [ - 'summary' => 'Creates an application group based on the tags of cloud resources.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2021-10-25T07:45:36.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroupByResourceGroupId'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMonitorGroupByResourceGroupId', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"784CAB3C-F613-5BCE-8469-6DCB29B18A20\\",\\n \\"Success\\": true,\\n \\"Id\\": 0\\n}","type":"json"}]', + ], + 'CreateMonitorGroupInstances' => [ + 'summary' => 'Adds resources to an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TagKey', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The tag keys of the cloud resources.'."\n" - ."\n" - .'For more information about how to obtain tag keys, see [DescribeTagKeyList](~~145558~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs_instance', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3607****', 'title' => ''], ], [ - 'name' => 'ContactGroupList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The alert contact groups. Valid values of N: 1 to 100. The alert notifications of the application group are sent to the alert contacts that belong to the specified alert contact groups.'."\n" - ."\n" - .'An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ECS_Group', - ], - 'required' => true, - 'docRequired' => true, - 'example' => 'ECS_Group', - 'maxItems' => 10, - ], - ], - [ - 'name' => 'MatchExpress', + 'name' => 'Instances', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The conditional expressions used to create an application group based on the tag.'."\n", + 'description' => 'The instances that you want to add to the application group.', 'type' => 'array', 'items' => [ - 'description' => 'The conditional expressions used to create an application group based on the tag. Valid values of N: 1 to 3.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'TagValueMatchFunction' => [ - 'description' => 'The method that is used to match the tag values of the cloud resources. Set the value of N to 1. Valid values:'."\n" - ."\n" - .'* contains: contains'."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n" - .'* notContains: does not contain'."\n" - .'* equals: equals'."\n" - .'* all: matches all'."\n" - ."\n" - .'> If you set the `MatchExpress.N.TagValueMatchFunction` parameter, you must also set the `MatchExpress.N.TagValue` parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'contains', - ], - 'TagValue' => [ - 'description' => 'The tag values of the cloud resources. Set the value of N to 1.'."\n" - ."\n" - .'> If you set the `MatchExpress.N.TagValueMatchFunction` parameter, you must also set the `MatchExpress.N.TagValue` parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'instance', - ], - 'TagName' => [ - 'description' => 'The keys of the tags that are used to create the application group. If a specified key is attached to multiple resources, the resources that have the same key-value pair are added to the same group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'appname', - ], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'required' => true, 'example' => 'test-instance-ecs', 'title' => ''], + 'Category' => ['description' => 'The abbreviation of the Alibaba Cloud service name.'."\n" + ."\n" + .'To obtain the abbreviation of an Alibaba Cloud service name, call the [DescribeProjectMeta](~~114916~~) operation. The `metricCategory` tag in the `Labels` response parameter indicates the abbreviation of the Alibaba Cloud service name.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-2ze26xj5wwy12****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'example' => ' cn-hangzhou', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, - 'maxItems' => 3, - ], - ], - [ - 'name' => 'TagRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region to which the tags belong.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'EnableSubscribeEvent', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the application group automatically subscribes to event notifications. If events whose severity level is critical or warning occur on resources in an application group, CloudMonitor sends alert notifications. Valid values:'."\n" - ."\n" - .'* true: The application group automatically subscribes to event notifications.'."\n" - .'* false (default value): The application group does not automatically subscribe to event notifications.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'EnableInstallAgent', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the CloudMonitor agent is automatically installed for the application group. CloudMonitor determines whether to automatically install the CloudMonitor agent for the hosts in an application group based on the value of this parameter. Valid values:'."\n" - ."\n" - .'* true: The CloudMonitor agent is automatically installed.'."\n" - .'* false (default value): The CloudMonitor agent is not automatically installed.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'MatchExpressFilterRelation', - 'in' => 'query', - 'schema' => [ - 'description' => 'The relationship between the conditional expressions for the tag values of the cloud resources. Valid values:'."\n" - ."\n" - .'* and (default)'."\n" - .'* or'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'and', - 'default' => 'and', - ], - ], - [ - 'name' => 'TemplateIdList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the alert templates.'."\n" - ."\n" - .'For more information about how to query alert template IDs, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '70****', - ], - 'required' => false, - 'example' => '85****', - 'maxItems' => 10, + 'maxItems' => 2000, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '84AC6F0B-7945-466A-AA44-99BB5A561F86', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid values:'."\n" - ."\n" - .'* true: The call is successful.'."\n" - .'* false: The call fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'The ID of the tag matching rule.'."\n", - 'type' => 'string', - 'example' => '2534dc0a-e3e5-4ae1-a2fc-75ef166c****', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1BC69FEB-56CD-4555-A0E2-02536A24A946', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidClientTokenId', 'errorMessage' => 'not allow this operation.', 'description' => 'No permission'], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => '%s', 'description' => ''], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => '%s', 'description' => ''], + ], + 412 => [ + ['errorCode' => 'ResourcesOverLimit', 'errorMessage' => '%s', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'ResourceOverLimit', - 'errorMessage' => '%s', - ], + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"84AC6F0B-7945-466A-AA44-99BB5A561F86\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"2534dc0a-e3e5-4ae1-a2fc-75ef166c****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDynamicTagGroupResponse>\\r\\n\\t<RequestId>84AC6F0B-7945-466A-AA44-99BB5A561F86</RequestId>\\r\\n\\t<Id>2534dc0a-e3e5-4ae1-a2fc-75ef166c****</Id>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</CreateDynamicTagGroupResponse>\\t","errorExample":""}]', - 'title' => 'CreateDynamicTagGroup', - 'description' => 'This operation is available for Elastic Compute Service (ECS), ApsaraDB RDS, and Server Load Balancer (SLB).'."\n" + 'title' => 'CreateMonitorGroupInstances', + 'description' => 'You can add a maximum of 1,000 instances to an application group at a time. You can add a maximum of 3,000 instances of an Alibaba Cloud service to an application group. The total number of instances that you can add to an application group is unlimited.'."\n" ."\n" - .'This topic provides an example to show how to create an application group for resources whose tag key is `ecs_instance`. In this example, the alert contact group of the application group is `ECS_Group`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + .'In this example, an Elastic Compute Service (ECS) instance in the `China (Hangzhou)` region is added to the `3607****` application group. The instance ID is `i-2ze26xj5wwy12****` and the instance name is `test-instance-ecs`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteDynamicTagGroup' => [ - 'summary' => 'Deletes a tag rule.', - 'methods' => [ - 'post', - 'get', - 'put', + 'changeSet' => [ + ['createdAt' => '2025-02-12T07:07:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroupInstances'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMonitorGroupInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"1BC69FEB-56CD-4555-A0E2-02536A24A946\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateMonitorGroupNotifyPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'DynamicTagRuleId', + 'name' => 'PolicyType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the tag rule.'."\n" - ."\n" - .'For information about how to obtain the ID of a tag rule, see [DescribeDynamicTagRuleList](~~150126~~).'."\n", + 'description' => 'The type of the pause notification. Currently, only PauseNotify is supported.', 'type' => 'string', 'required' => true, - 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', + 'enum' => ['PauseNotify'], + 'example' => 'PauseNotify', + 'title' => '', ], ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The application group ID.', 'type' => 'string', 'required' => true, 'example' => '7301****', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start timestamp for pausing notifications.'."\n" + ."\n" + .'The value is a UNIX timestamp, which represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1622949300000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end timestamp for pausing notifications.'."\n" + ."\n" + .'The value is a UNIX timestamp, which represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1623208500000', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '08AAE67E-77B5-485B-9C79-D7C8C059150A', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '13356BCA-3EC3-4748-A771-2064DA69AEF1', 'title' => ''], + 'Result' => ['description' => 'The number of entries returned for the creation result.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. ', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"08AAE67E-77B5-485B-9C79-D7C8C059150A\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteDynamicTagGroupResponse>\\n <RequestId>08AAE67E-77B5-485B-9C79-D7C8C059150A</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteDynamicTagGroupResponse>","errorExample":""}]', - 'title' => 'DeleteDynamicTagGroup', + 'title' => 'Create a pause alert notification policy for an application group', + 'summary' => 'Calls the CreateMonitorGroupNotifyPolicy operation to create a pause alert notification policy for an application group.', + 'description' => 'During the effective period of the policy, no alert notifications are sent for any alerts triggered within the application group.'."\n" + .' '."\n" + .'This topic provides an example on how to create a pause alert notification policy named `PauseNotify` for the application group `7301****`. The application group pauses alert notifications during the period from `1622949300000` to `1623208500000` (UTC+8 `2021-06-06 11:15:00` to `2021-06-09 11:15:00`).', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'extraInfo' => ' ', - ], - 'DescribeTagValueList' => [ - 'summary' => 'Queries the tag values corresponding to a specified tag key.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroupNotifyPolicy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMonitorGroupNotifyPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"13356BCA-3EC3-4748-A771-2064DA69AEF1\\",\\n \\"Result\\": 1,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'CreateMonitoringAgentProcess' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'ProcessName', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the process.', 'type' => 'string', 'required' => false, 'example' => 'java', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Valid values: 1 to 100. Default value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '100', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => ' i-2ze51wjtwox01r8g****', 'title' => ''], ], [ - 'name' => 'TagKey', + 'name' => 'ProcessUser', 'in' => 'query', - 'schema' => [ - 'description' => 'The tag key.'."\n" - ."\n" - .'For more information about how to obtain a tag key, see [DescribeTagKeyList](~~145558~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tagKey1', - ], + 'schema' => ['description' => 'The user who launches the process.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], ], ], 'responses' => [ @@ -5680,249 +4166,141 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B04B8CF3-4489-432D-83BA-6F128E4F2295', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TagValues' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagValue' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The queried tag values.'."\n", - 'type' => 'string', - 'example' => '["tagValue1", "tagValue2"]', - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0DFCB47D-E7E1-4CBE-A381-8339F7B300EF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The process ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"B04B8CF3-4489-432D-83BA-6F128E4F2295\\",\\n \\"Success\\": true,\\n \\"TagValues\\": {\\n \\"TagValue\\": [\\n \\"si-65d55ff37d6c4b4ea3b3\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeTagValueList', - 'description' => 'This topic provides an example of how to query the tag values corresponding to `tagKey1`. The return results are `tagValue1` and `tagValue2`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'CreateMonitoringAgentProcess', + 'summary' => 'Creates a task to monitor a process.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeTagKeyList' => [ - 'summary' => 'Queries tag keys.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitoringAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateMonitoringAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"0DFCB47D-E7E1-4CBE-A381-8339F7B300EF\\",\\n \\"Success\\": true,\\n \\"Id\\": 12345\\n}","type":"json"}]', + ], + 'CreateSiteMonitor' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'Address', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The URL or IP address to monitor.', 'type' => 'string', 'required' => true, 'example' => 'https://www.aliyun.com', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '100', - ], + 'schema' => ['description' => 'The type of monitoring task.'."\n" + ."\n" + .'Valid protocols include HTTP(S), PING, TCP, UDP, DNS, SMTP, POP3, FTP, and WEBSOCKET.', 'type' => 'string', 'required' => true, 'example' => 'HTTP', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Specified parameter PageSize is not valid.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B04B8CF3-4489-432D-83BA-6F128E5F2293', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TagKeys' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagKey' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The queried tag keys.'."\n", - 'type' => 'string', - 'example' => 'tagKey1', - ], - ], - ], - ], - ], - 'description' => '', - ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the monitoring task.'."\n" + ."\n" + .'The name must be 4 to 100 characters long and can contain letters, digits, underscores (\\_), and Chinese characters.', 'type' => 'string', 'required' => true, 'example' => 'HanZhou_ECS1', 'title' => ''], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The monitoring frequency in minutes.'."\n" + ."\n" + .'Valid values: 1, 5, 15, 30, and 60.'."\n" + ."\n" + .'Default: 1.', 'type' => 'string', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + 'name' => 'IspCities', + 'in' => 'query', + 'schema' => ['description' => 'The detection points. If you do not specify this parameter, the system randomly selects three detection points from different Internet Service Providers (ISPs).'."\n" + ."\n" + .'The value must be a JSON array. Example: `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`. The values correspond to Beijing, Hangzhou, and Qingdao.'."\n" + ."\n" + .'For more information, see [DescribeSiteMonitorISPCityList](~~115045~~).', 'type' => 'string', 'required' => false, 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', 'title' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + 'name' => 'OptionsJson', + 'in' => 'query', + 'schema' => ['description' => 'The advanced options for the specified protocol. The available options vary based on the protocol type.', 'type' => 'string', 'required' => false, 'example' => '{"time_out":5000}', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + 'name' => 'AlertIds', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'For more information, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => 'SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Specified parameter PageSize is not valid.\\",\\n \\"RequestId\\": \\"B04B8CF3-4489-432D-83BA-6F128E5F2293\\",\\n \\"Success\\": true,\\n \\"TagKeys\\": {\\n \\"TagKey\\": [\\n \\"t0et07752s_\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeTagKeyList', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeProductResourceTagKeyList' => [ - 'summary' => 'Queries the keys of all tags that are attached to cloud resources in a region.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'AgentGroup', + 'in' => 'query', + 'schema' => ['description' => 'The group of detection points for the network probe task. \\`PC\\` indicates detection points on PCs. \\`MOBILE\\` indicates detection points on mobile devices. \\`FC\\` indicates detection points in a VPC. The default value is \\`PC\\`.', 'type' => 'string', 'required' => false, 'example' => 'PC', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'NextToken', + 'name' => 'CustomSchedule', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dbc2826f237e****', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The custom detection schedule. Specify a time period and the days of the week for detection.', 'type' => 'string', 'example' => '{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'VpcConfig', + 'in' => 'query', + 'schema' => ['description' => 'The network information required to create a network probe task in a VPC. This must be a JSON object that contains the \\`vpcId\\`, \\`vswitchId\\`, \\`securityGroupId\\`, and \\`region\\` fields.', 'type' => 'string', 'required' => false, 'example' => '{"vpcId": "vpc-xxxxxx", "vswitchId": "vsw-xxxxxx", "securityGroupId": "sg-xxxxxx", "region": "cn-beijing"}', 'title' => ''], ], ], 'responses' => [ @@ -5930,471 +4308,386 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The request processing has failed due to some unknown error.', - ], - 'NextToken' => [ - 'description' => 'The pagination token. If more entries are to be returned on the next page, a pagination token is returned.'."\n" - ."\n" - .'> If the value of this parameter is not null, more entries are to be returned on the next page. You can use the returned pagination token as a request parameter to retrieve a new page of results. If the value of this parameter is null, all the entries have been returned.'."\n", - 'type' => 'string', - 'example' => 'dbc2826f237e****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '945ACAA9-89F2-4A62-8913-076FDEDAA8DB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code of the operation.'."\n" + ."\n" + .'> A value of \\`200\\` indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The results of the monitoring task.', + 'type' => 'object', + 'properties' => [ + 'AttachAlertResult' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => 'The results of associating the alert rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result for a single alert rule association.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code for the association operation.'."\n" + ."\n" + .'> A value of \\`200\\` indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned for the association operation.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID for the association operation.', 'type' => 'string', 'example' => '5dd33455-4f65-4b0c-9200-33d66f3f340b', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the alert rule was successfully associated. Valid values:'."\n" + ."\n" + .'- true: The association was successful.'."\n" + ."\n" + .'- false: The association failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'TagKeys' => [ + 'CreateResultList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'TagKey' => [ - 'description' => '', + 'CreateResultList' => [ + 'description' => 'A list of results for each created task.'."\n" + ."\n" + .'This is returned only if the task creation is successful.', 'type' => 'array', 'items' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'tagKey1', + 'description' => 'The result for a single created task.'."\n" + ."\n" + .'This is returned only if the task creation is successful.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The ID of the created monitoring task.', 'type' => 'string', 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', 'title' => ''], + 'TaskName' => ['description' => 'The name of the created monitoring task.', 'type' => 'string', 'example' => 'HanZhou_ECS1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'description' => 'N/A.', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalAddress', 'errorMessage' => 'Illegal HTTP address', 'description' => ''], + ['errorCode' => 'OperationError', 'errorMessage' => 'Operation failed', 'description' => ''], + ['errorCode' => 'TaskNotExists', 'errorMessage' => 'Task does not exist', 'description' => ''], + ['errorCode' => 'OperatorInvalid', 'errorMessage' => 'Operator invalid', 'description' => ''], + ['errorCode' => 'NameRepeat', 'errorMessage' => 'Task name repeat', 'description' => ''], + ['errorCode' => 'CreateAlarmError', 'errorMessage' => 'Create alarm error', 'description' => ''], + ['errorCode' => 'NameNotExists', 'errorMessage' => 'Task name not exists', 'description' => ''], + ['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Invalid Isp.', 'description' => 'Invalid Isp'], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'RestrictedUser', 'errorMessage' => 'The user\'s operation is restricted, please register NAAM product code', 'description' => ''], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'CreateSiteMonitor', + 'summary' => 'Creates a site monitoring task.', + 'description' => 'This topic describes how to create a site monitoring task. The example creates a task named `HanZhou_ECS1` to monitor the URL `https://www.aliyun.com` over `HTTPS`.', + 'requestParamsDescription' => 'The following tables describe the advanced parameters for the HTTP(S), PING, TCP, UDP, DNS, WEBSOCKET, SMTP, POP3, and FTP task types.'."\n" + ."\n" + .'- HTTP(S)'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ---------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| http_method | String | The HTTP or HTTPS request method. Valid values: GET, POST, and HEAD. Default: GET. |'."\n" + .'| header | String | The custom HTTP header. Separate multiple headers with line feeds (\\n).<br>Each header must be in `key:value` format and follow the HTTP protocol. |'."\n" + .'| cookie | String | The cookie, formatted as a standard HTTP request cookie. |'."\n" + .'| request_content | String | The request content, in JSON or form format. If you do not specify this parameter, the request body is empty. |'."\n" + .'| response_content | String | The expected response content. The system checks the first 64 bytes of the server\'s response. |'."\n" + .'| match_rule | String | 0: The probe is successful if the response does not contain the response_content value.<br>1: The probe is successful if the response contains the response_content value. |'."\n" + .'| username | String | The username for Basic authentication. If specified, a `BasicAuth` header is included in the HTTP request. |'."\n" + .'| password | String | The password for Basic authentication. |'."\n" + .'| time_out | int | The timeout period in milliseconds. Default: 5000. |'."\n" + .'| max_redirect | int | The maximum number of redirects. Default: 5 for ECS detection points and 2 for carrier detection points.<br>Set to 0 to disable redirects.<br>Valid values: 0 to 50. |'."\n" + ."\n" + .'- PING'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------ | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| failure_rate | Text | The failure rate threshold. If the ping failure rate exceeds this value, the probe fails and returns error code 610 (PingAllFail) or 615 (PingPartialFail).<br>Default: 0.1. |'."\n" + .'| ping_num | int | The number of ping packets to send. Default: 10.<br>Valid values: 1 to 100. |'."\n" + ."\n" + .'- DNS'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| dns_server | string | The address of the DNS server. This can be a domain name or an IP address. |'."\n" + .'| dns_type | string | The DNS query type. Valid values: A, NS, CNAME, MX, TXT, ANY, and AAAA. |'."\n" + .'| expect_value | string | A space-separated list of expected values. |'."\n" + .'| match_rule | string | The matching rule between the expected values and the DNS query results. The probe fails if this rule is not met.<br>\\`IN_DNS` or empty string: The expected values must be a subset of the DNS results.<br>\\`DNS_IN`: The DNS results must be a subset of the expected values.<br>\\`EQUAL`: The DNS results must be identical to the expected values.<br>\\`ANY`: The DNS results and the expected values must have at least one value in common. |'."\n" + ."\n" + .'- FTP'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| --------- | ------ | ---------------------------------------------------------------------- |'."\n" + .'| port | int | The FTP server port. Default: 21 for FTP and 990 for FTPS. |'."\n" + .'| username | string | The username for FTP login. If not specified, anonymous login is used. |'."\n" + .'| password | string | The password for FTP login. |'."\n" + ."\n" + .'- POP3 or SMTP'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| --------- | ------ | ----------------------------------------------------------------------------- |'."\n" + .'| port | int | The server port. Default: 110 for POP3, 995 for POP3S, and 25 for SMTP. |'."\n" + .'| username | string | The username for POP3 or SMTP login. Both username and password are required. |'."\n" + .'| password | string | The password for POP3 or SMTP login. Both username and password are required. |'."\n" + ."\n" + .'- TCP or UDP'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| ---------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| port | int | The TCP or UDP server port. |'."\n" + .'| request_content | string | The request content. If `request_format` is `hex`, this value must be in compact hexadecimal format. |'."\n" + .'| request_format | string | The format of the request content. If this is not `hex`, the `request_content` is sent as a regular string. |'."\n" + .'| response_content | string | The expected response content. The probe fails if the server response does not contain this value.<br>If `request_format` is `hex`, this value must be in compact hexadecimal format.<br>Otherwise, it is treated as a regular string. |'."\n" + ."\n" + .'- WEBSOCKET'."\n" + ."\n" + .'| Parameter | Type | Description |'."\n" + .'| --------------- | ------- | ----------------------------------------------------------------------------------------- |'."\n" + .'| request_content | string | The message content to send. |'."\n" + .'| empty_message | boolean | Specifies whether an empty message or no message from the server is considered a success. |', + 'changeSet' => [ + ['createdAt' => '2025-09-11T05:58:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-13T09:00:16.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-09T12:32:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-04T02:58:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-19T07:10:45.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-12-27T07:31:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-22T09:29:55.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-11-02T03:20:17.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSiteMonitor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:CreateSiteMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"NextToken\\": \\"dbc2826f237e****\\",\\n \\"RequestId\\": \\"945ACAA9-89F2-4A62-8913-076FDEDAA8DB\\",\\n \\"Success\\": true,\\n \\"TagKeys\\": {\\n \\"TagKey\\": [\\n \\"tag_******\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeProductResourceTagKeyList', - 'description' => '> If a tag is attached to multiple cloud resources in the region, the key of the tag is returned only once.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"68192f5d-0d45-4b98-9724-892813f86c71\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"AttachAlertResult\\": {\\n \\"Contact\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"5dd33455-4f65-4b0c-9200-33d66f3f340b\\",\\n \\"Success\\": \\"true\\",\\n \\"RuleId\\": \\"SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent\\"\\n }\\n ]\\n }\\n },\\n \\"CreateResultList\\": {\\n \\"CreateResultList\\": [\\n {\\n \\"TaskId\\": \\"2c8dbdf9-a3ab-46a1-85a4-f094965e****\\",\\n \\"TaskName\\": \\"HanZhou_ECS1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'extraInfo' => "\n" + ."\n\n", ], - 'DescribeDynamicTagRuleList' => [ - 'summary' => 'Queries tag rules.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'Cursor' => [ + 'summary' => 'Calls the Cursor operation to define the scope of monitoring data to be exported, and returns the Cursor value used for the initial call to the BatchExport operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TagRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region to which the tags belong.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => ['description' => 'The data namespace of the cloud service.'."\n" + ."\n" + .'For information about how to obtain the data namespace of a cloud service, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'TagKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tag key.'."\n" - ."\n" - .'For more information about how to obtain a tag key, see [DescribeTagKeyList](~~145558~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tagkey1', - ], + 'name' => 'Metric', + 'in' => 'formData', + 'schema' => ['description' => 'The metric name of the cloud service.'."\n" + ."\n" + .'For information about how to obtain the metric name of a cloud service, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_idle', 'title' => ''], ], [ - 'name' => 'TagValue', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tag value.'."\n" - ."\n" - .'For more information about how to obtain a tag value, see [DescribeTagKeyList](~~145557~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], + 'name' => 'Period', + 'in' => 'formData', + 'schema' => ['description' => 'The statistical period of the metric.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'> The statistical period of a metric is typically 60 seconds. For special values, see the `Period` parameter in [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '60', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'The value is in the YYYY-MM-DDThh:mm:ssZ format. For example, 2023-01-01T00:00:00Z indicates 00:00:00 on January 1, 2023 (GMT).'."\n" + ."\n" + .'> The time to live (TTL) of monitoring data varies based on the statistical granularity in CloudMonitor. Configure a proper time range based on the TTL of the data that corresponds to the `Period` parameter.', 'type' => 'string', 'required' => true, 'example' => '1641627000000', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Minimum value: 1. Default value: 30.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'> - Unix timestamp: the number of milliseconds that have elapsed since 00:00:00 on January 1, 1970. The value is in the YYYY-MM-DDThh:mm:ssZ format. For example, 2023-01-01T00:00:00Z indicates 00:00:00 on January 1, 2023 (GMT).'."\n" + .'- If you do not specify an end time, the end time is unlimited. You do not need to specify this parameter when you export data in real time.'."\n" + .'- The time to live (TTL) of monitoring data varies based on the statistical granularity in CloudMonitor. Configure a proper time range based on the TTL of the data that corresponds to the `Period` parameter.', 'type' => 'string', 'required' => false, 'example' => '1641645000000', 'title' => ''], ], [ - 'name' => 'DynamicTagRuleId', - 'in' => 'query', + 'name' => 'Matchers', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the tag rule.'."\n", - 'type' => 'string', + 'description' => 'The dimension information of the metric.', + 'type' => 'array', + 'items' => ['description' => 'The dimension information of the metric.', '$ref' => '#/components/schemas/Matcher', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, - 'example' => '004155fa-15ba-466d-b61a-***********', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0D50523D-8D59-4A61-B58E-E2286ECFB3A9', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TagGroupList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagGroup' => [ - 'description' => 'The tag rules of application groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of adding instances that meet the tag rule to the application group. Valid values:'."\n" - ."\n" - .'* `RUNNING`'."\n" - .'* `FINISH`'."\n", - 'type' => 'string', - 'example' => 'FINISH', - ], - 'MatchExpressFilterRelation' => [ - 'description' => 'The logical operator that is used between conditional expressions. Valid values:'."\n" - ."\n" - .'* `and`'."\n" - .'* `or`'."\n" - ."\n" - .'> Only one logical operator can be used in a request.'."\n", - 'type' => 'string', - 'example' => 'or', - ], - 'RegionId' => [ - 'description' => 'The ID of the region to which the tags belong.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'TagKey' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'tagkey1', - ], - 'DynamicTagRuleId' => [ - 'description' => 'The ID of the tag rule.'."\n", - 'type' => 'string', - 'example' => '1536df65-a719-429d-8813-73cc40d7****', - ], - 'MatchExpress' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MatchExpress' => [ - 'description' => 'The conditional expressions used to create an application group based on the tag.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TagValue' => [ - 'description' => 'The tag value.'."\n" - ."\n" - .'The `TagValue` and `TagValueMatchFunction` parameters must be used in pairs.'."\n", - 'type' => 'string', - 'example' => '*', - ], - 'TagValueMatchFunction' => [ - 'description' => 'The method that is used to match tag values. Valid values:'."\n" - ."\n" - .'* all: includes all'."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n" - .'* contains: contains'."\n" - .'* notContains: does not contain'."\n" - .'* equals: equals'."\n", - 'type' => 'string', - 'example' => 'all', - ], - 'TagKey' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'azone-version', - ], - ], - ], - ], - ], - ], - 'TemplateIdList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TemplateIdList' => [ - 'description' => 'The IDs of the alert templates.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '71****', - ], - ], - ], - ], - 'ContactGroupList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroupList' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - ], - ], - ], - 'TagValueBlacklist' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagValueBlacklist' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Cursor' => ['description' => 'The Cursor that is used as an input parameter to export data in the [BatchExport](~~2329847~~) operation.'."\n" + ."\n", 'type' => 'string', 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call is successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true: The call is successful.'."\n" + ."\n" + .'- false: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '915C2D7A-E6A4-17C3-8E13-4DBDD61E7919', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Defines the scope of monitoring data to be exported', + 'description' => '### Prerequisites'."\n" + .'Make sure that Enterprise CloudMonitor is activated. For more information, see [Activate Enterprise CloudMonitor](~~250773~~).'."\n" + ."\n" + .'### Background information'."\n" + .'First, call this operation to obtain the initial Cursor. Then, call the [BatchExport](~~2329847~~) operation to export monitoring data.'."\n" + .'### Usage notes'."\n" + .'This topic provides an example to describe how to define the scope to export data of the `cpu_idle` metric of the `acs_ecs_dashboard` cloud service every 60 seconds in the time range from `1641627000000` (2022-01-08 15:30:00) to `1641645000000` (2022-01-08 20:30:00). The returned result shows the `Cursor` information.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Cursor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:Cursor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0D50523D-8D59-4A61-B58E-E2286ECFB3A9\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageSize\\": \\"30\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Total\\": 2,\\n \\"TagGroupList\\": {\\n \\"TagGroup\\": [\\n {\\n \\"Status\\": \\"FINISH\\",\\n \\"MatchExpressFilterRelation\\": \\"or\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"TagKey\\": \\"tagkey1\\",\\n \\"DynamicTagRuleId\\": \\"1536df65-a719-429d-8813-73cc40d7****\\",\\n \\"MatchExpress\\": {\\n \\"MatchExpress\\": [\\n {\\n \\"TagValue\\": \\"*\\",\\n \\"TagValueMatchFunction\\": \\"all\\",\\n \\"TagKey\\": \\"azone-version\\"\\n }\\n ]\\n },\\n \\"TemplateIdList\\": {\\n \\"TemplateIdList\\": [\\n \\"71****\\"\\n ]\\n },\\n \\"ContactGroupList\\": {\\n \\"ContactGroupList\\": [\\n \\"CloudMonitor\\"\\n ]\\n },\\n \\"TagValueBlacklist\\": {\\n \\"TagValueBlacklist\\": [\\n \\"test、offline\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDynamicTagRuleListResponse>\\r\\n\\t<PageSize>30</PageSize>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<Total>2</Total>\\r\\n\\t<TagGroupList>\\r\\n\\t\\t<TagGroup>\\r\\n\\t\\t\\t<Status>FINISH</Status>\\r\\n\\t\\t\\t<ContactGroupList>\\r\\n\\t\\t\\t\\t<ContactGroupList>CloudMonitor</ContactGroupList>\\r\\n\\t\\t\\t</ContactGroupList>\\r\\n\\t\\t\\t<MatchExpressFilterRelation>or</MatchExpressFilterRelation>\\r\\n\\t\\t\\t<DynamicTagRuleId>1536df65-a719-429d-8813-73cc40d7****</DynamicTagRuleId>\\r\\n\\t\\t\\t<TemplateIdList>\\r\\n\\t\\t\\t\\t<TemplateIdList>71****</TemplateIdList>\\r\\n\\t\\t\\t</TemplateIdList>\\r\\n\\t\\t\\t<TagKey>tagkey1</TagKey>\\r\\n\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t\\t<TagValue>*</TagValue>\\r\\n\\t\\t\\t\\t\\t<TagValueMatchFunction>all</TagValueMatchFunction>\\r\\n\\t\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t</TagGroup>\\r\\n\\t\\t<TagGroup>\\r\\n\\t\\t\\t<Status>FINISH</Status>\\r\\n\\t\\t\\t<ContactGroupList>\\r\\n\\t\\t\\t\\t<ContactGroupList>CloudMonitor</ContactGroupList>\\r\\n\\t\\t\\t</ContactGroupList>\\r\\n\\t\\t\\t<MatchExpressFilterRelation>or</MatchExpressFilterRelation>\\r\\n\\t\\t\\t<DynamicTagRuleId>56e8cebb-b3d7-4a91-9880-78a8c84f****</DynamicTagRuleId>\\r\\n\\t\\t\\t<TemplateIdList>\\r\\n\\t\\t\\t\\t<TemplateIdList>71****</TemplateIdList>\\r\\n\\t\\t\\t</TemplateIdList>\\r\\n\\t\\t\\t<TagKey>tagkey1</TagKey>\\r\\n\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t\\t<TagValue>*</TagValue>\\r\\n\\t\\t\\t\\t\\t<TagValueMatchFunction>all</TagValueMatchFunction>\\r\\n\\t\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t</TagGroup>\\r\\n\\t</TagGroupList>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeDynamicTagRuleListResponse>\\t","errorExample":""}]', - 'title' => 'DescribeDynamicTagRuleList', - 'description' => 'This topic provides an example to show how to query tag rules that are related to `tagkey1`. The sample responses indicate that two tag rules are found. The rule IDs are `1536df65-a719-429d-8813-73cc40d7****` and `56e8cebb-b3d7-4a91-9880-78a8c84f****`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Cursor\\": \\"v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"RequestId\\": \\"915C2D7A-E6A4-17C3-8E13-4DBDD61E7919\\"\\n}","type":"json"}]', ], - 'RemoveTags' => [ - 'summary' => 'Deletes tags.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteContact' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n" - ."\n" - .'> The tag key (`Tag.N.Key`) and tag value (`Tag.N.Value`) must be specified at the same time.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Key1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n" - ."\n" - .'> The tag key (`Tag.N.Key`) and tag value (`Tag.N.Value`) must be specified at the same time.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Value1', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'GroupIds', + 'name' => 'ContactName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the application groups.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - ], - 'required' => true, - 'example' => '12345', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'John Doe', 'title' => ''], ], ], 'responses' => [ @@ -6402,480 +4695,259 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Illegal parameters.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '195390D2-69D0-4D9E-81AA-A7F5BC1B91EB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tag' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tags' => [ - 'description' => 'The deleted tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tag1', - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50D4CFE1-01E5-4543-939C-18BC01E3EC1C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ContactNotExists', 'errorMessage' => 'ContactName does not exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Illegal parameters.\\",\\n \\"RequestId\\": \\"195390D2-69D0-4D9E-81AA-A7F5BC1B91EB\\",\\n \\"Success\\": true,\\n \\"Tag\\": {\\n \\"Tags\\": [\\n \\"tag1\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RemoveTagsResponse>\\n\\t\\t<RequestId>E15C718E-067E-49D0-86F7-BC7242230091</RequestId>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</RemoveTagsResponse>","errorExample":""}]', - 'title' => 'RemoveTags', + 'title' => 'Delete an alert contact', + 'summary' => 'Deletes an alert contact.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateHostAvailability' => [ - 'summary' => 'Creates an availability monitoring task.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-12T07:07:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContact'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteContact', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"50D4CFE1-01E5-4543-939C-18BC01E3EC1C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteContactGroup' => [ + 'summary' => 'Calls the DeleteContactGroup operation to delete an alert contact group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'ContactGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'My alert group', 'title' => ''], ], - [ - 'name' => 'TaskName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the availability monitoring task. The name must be 4 to 100 characters in length, and can contain letters, digits, and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'task1', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F722BE59-2400-4A64-9C1A-AD886AED9A69', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'TaskScope', - 'in' => 'query', - 'schema' => [ - 'description' => 'The range of instances that are monitored by the availability monitoring task. Valid values:'."\n" - ."\n" - .'* GROUP: All ECS instances in the application group are monitored.'."\n" - .'* GROUP_SPEC_INSTANCE: Specified ECS instances in the application group are monitored. The TaskScope parameter must be used in combination with the InstanceList parameter. The InstanceList parameter specifies the ECS instances to be monitored.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GROUP', - 'default' => 'GROUP', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The monitoring type of the availability monitoring task. Valid values:'."\n" - ."\n" - .'* PING'."\n" - .'* TELNET'."\n" - .'* HTTP'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HTTP', - ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], [ - 'name' => 'TaskOption.HttpURI', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URI that you want to monitor. This parameter is required if the TaskType parameter is set to HTTP or Telnet.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], + ['errorCode' => 'ContactNotExists', 'errorMessage' => 'ContactGroupName Not Exists', 'description' => ''], ], - [ - 'name' => 'TaskOption.TelnetOrPingHost', - 'in' => 'query', - 'schema' => [ - 'description' => 'The domain name or IP address that you want to monitor.'."\n" - ."\n" - .'> This parameter is required if the TaskType parameter is set to PING.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - [ - 'name' => 'TaskOption.HttpResponseCharset', - 'in' => 'query', - 'schema' => [ - 'description' => 'The character set that is used in the HTTP response.'."\n" - ."\n" - .'> Only UTF-8 is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'UTF-8', + ], + 'title' => 'Delete an alert contact group', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContactGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteContactGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F722BE59-2400-4A64-9C1A-AD886AED9A69\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteCustomMetric' => [ + 'summary' => 'Deletes the reported monitoring data of a metric.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TaskOption.HttpPostContent', - 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the HTTP POST request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'params1=paramsValue1', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'TaskOption.HttpResponseMatchContent', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The response to the HTTP request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ok', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'example' => '3607****', 'title' => ''], ], [ - 'name' => 'TaskOption.HttpMethod', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP request method. Valid values:'."\n" - ."\n" - .'* GET'."\n" - .'* POST'."\n" - .'* HEAD'."\n" - ."\n" - .'> This parameter must be specified when TaskType is set to HTTP.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], + 'schema' => ['description' => 'The name of the metric.', 'type' => 'string', 'required' => true, 'example' => 'AdvanceCredit', 'title' => ''], ], [ - 'name' => 'TaskOption.HttpNegative', + 'name' => 'Md5', 'in' => 'query', - 'schema' => [ - 'description' => 'The method to trigger an alert. The alert can be triggered based on whether the specified alert rule is included in the response body. Valid values:'."\n" - ."\n" - .'* true: If the HTTP response body includes the alert rule, an alert is triggered.'."\n" - .'* false: If the HTTP response does not include the alert rule, an alert is triggered.'."\n" - ."\n" - .'> This parameter must be specified when TaskType is set to HTTP.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The MD5 value of the HTTP request body. The MD5 value is a 128-bit hash value used to verify the uniqueness of the reported monitoring data.'."\n" + ."\n" + .'> `Md5` is returned when you query the reported monitoring data of a metric.', 'type' => 'string', 'required' => false, 'example' => '38796C8CFFEB8F89BB2A626C7BD7****', 'title' => ''], ], [ - 'name' => 'TaskOption.HttpHeader', + 'name' => 'UUID', 'in' => 'query', - 'schema' => [ - 'description' => 'The header of the HTTP request. Format: `Parameter name:Parameter value`. Separate multiple parameters with carriage return characters. Example:'."\n" - ."\n" - .' params1:value1'."\n" - .' params2:value2'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'token:testTokenValue', - ], + 'schema' => ['description' => 'The ID of the request for reporting monitoring data.'."\n" + ."\n" + .'> `UUID` is returned when you query the reported monitoring data of a metric. We recommend that you specify the `Md5` parameter.', 'type' => 'string', 'required' => false, 'example' => '5497633c-66c5-4eae-abaa-89db5adb****', 'title' => ''], ], - [ - 'name' => 'TaskOption.Interval', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The interval at which detection requests are sent. Unit: seconds. Valid values: 15, 30, 60, 120, 300, 900, 1800, and 3600.'."\n" - ."\n" - .'> This parameter is available only for the CloudMonitor agent V3.5.1 or later.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'AlertConfig.NotifyType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert notification methods. Valid values:'."\n" - ."\n" - .'0: Alert notifications are sent by using emails and DingTalk chatbots.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - 'name' => 'AlertConfig.StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range during which the alert rule is effective. Valid values: 0 to 23.'."\n" - ."\n" - .'For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.'."\n" - ."\n" - .'> Alert notifications are sent based on the specified threshold only if the alert rule is effective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - 'name' => 'AlertConfig.EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range during which the alert rule is effective. Valid values: 0 to 23.'."\n" - ."\n" - .'For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.'."\n" - ."\n" - .'> Alert notifications are sent based on the specified threshold only if the alert rule is effective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '22', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - 'name' => 'AlertConfig.SilenceTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400. The default value indicates one day.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], + 500 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - [ - 'name' => 'AlertConfig.WebHook', - 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com/webhook.json', - ], + ], + 'title' => 'DeleteCustomMetric', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-23T06:11:10.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomMetric'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'AlertConfigEscalationList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'None'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric for which the alert feature is enabled. Valid values of N: 1 to 21. Valid values:'."\n" - ."\n" - .'* HttpStatus: HTTP status code'."\n" - .'* HttpLatency: HTTP response time'."\n" - .'* TelnetStatus: Telnet status code'."\n" - .'* TelnetLatency: Telnet response time'."\n" - .'* PingLostRate: Ping packet loss rate'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HttpStatus', - ], - 'Value' => [ - 'description' => 'The alert threshold. Valid values of N: 1 to 21.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered. Valid values of N: 1 to 21.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Operator' => [ - 'description' => 'The comparison operator that is used in the alert rule. Valid values of N: 1 to 21. Valid values:'."\n" - ."\n" - .'* `>`'."\n" - .'* `>=`'."\n" - .'* `<`'."\n" - .'* `<=`'."\n" - .'* `=`'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], - 'Aggregate' => [ - 'description' => 'The method used to calculate the metric values that trigger alerts. Valid values of N: 1 to 21. Valid values:'."\n" - ."\n" - .'* HttpStatus: Value'."\n" - .'* HttpLatency: Average'."\n" - .'* TelnetStatus: Value'."\n" - .'* TelnetLatency: Average'."\n" - .'* PingLostRate: Average'."\n" - ."\n" - .'> The value Value indicates the original value and is used for metrics such as status codes. The value Average indicates the average value and is used for metrics such as the latency and packet loss rate.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Value', - ], - ], - 'required' => false, + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteCustomMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => true, - 'maxItems' => 10, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0\\"\\n}","type":"json"}]', + ], + 'DeleteDynamicTagGroup' => [ + 'summary' => 'Deletes a tag rule.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'InstanceList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ECS instances that are monitored. Valid values of N: 1 to 21.'."\n" - ."\n" - .'> This parameter must be specified when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ECS instances that are monitored. Valid values of N: 1 to 21.'."\n" - ."\n" - .'> This parameter must be specified when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'required' => false, - 'example' => 'i-absdfkwl321****', - 'maxItems' => 1000, - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'AlertConfigTargetList', + 'name' => 'DynamicTagRuleId', 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => 'The resources for which alerts are triggered.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource for which alerts are triggered.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:'."\n" - ."\n" - .'* {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).'."\n" - ."\n" - .'* {userId}: the ID of the Alibaba Cloud account.'."\n" - ."\n" - .'* {regionId}: the region ID of the SMQ queue or topic.'."\n" - ."\n" - .'* {Resource type}: the type of the resource for which alerts are triggered. Valid values:'."\n" - ."\n" - .' * **queues**'."\n" - .' * **topics**'."\n" - ."\n" - .'* {Resource name}: the resource name.'."\n" - ."\n" - .' * If the resource type is **queues**, the resource name is the queue name.'."\n" - .' * If the resource type is **topics**, the resource name is the topic name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the tag rule.'."\n" + ."\n" + .'For information about how to obtain the ID of a tag rule, see [DescribeDynamicTagRuleList](~~150126~~).', 'type' => 'string', 'required' => true, 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', 'title' => ''], ], ], 'responses' => [ @@ -6883,129 +4955,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', - ], - 'TaskId' => [ - 'description' => 'The ID of the availability monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '08AAE67E-77B5-485B-9C79-D7C8C059150A', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Parameter invalid.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], - ], - 412 => [ - [ - 'errorCode' => 'ResouceOverLimit', - 'errorMessage' => 'The task over limit', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"ACBDBB40-DFB6-4F4C-8957-51FFB233969C\\",\\n \\"TaskId\\": 12345,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateHostAvailabilityResponse>\\n\\t<TaskId>12345</TaskId>\\n\\t<RequestId>CDA78493-F10F-485F-98AD-B4C0B40AB225</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</CreateHostAvailabilityResponse>","errorExample":""}]', - 'title' => 'CreateHostAvailability', - 'description' => 'This topic provides an example on how to create an availability monitoring task named `task1` in an application group named `123456`. The TaskType parameter of the task is set to `HTTP`. After you start the task, the system sends alerts by using the specified email address and DingTalk chatbot.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DeleteDynamicTagGroup', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteHostAvailability' => [ - 'summary' => 'Deletes availability monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDynamicTagGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteDynamicTagGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"08AAE67E-77B5-485B-9C79-D7C8C059150A\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteEventRuleTargets' => [ + 'summary' => 'Deletes the push channels of an event-triggered alert rule.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the event-triggered alert rule.'."\n" + ."\n" + .'For information about how to obtain the name of an event-triggered alert rule, see [DescribeEventRuleList](~~114996~~).', 'type' => 'string', 'required' => true, 'example' => 'testRule', 'title' => ''], + ], + [ + 'name' => 'Ids', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The task ID. Valid values of N: 1 to 20.'."\n", + 'description' => 'The IDs of event-triggered alert rules.', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'example' => '1191346', - ], + 'items' => ['description' => 'The ID of the event-triggered alert rule.', 'type' => 'string', 'required' => false, 'example' => 'testRuleId', 'title' => ''], 'required' => true, - 'example' => '12456', 'maxItems' => 20, + 'example' => '1', + 'title' => '', ], ], ], @@ -7014,103 +5052,82 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '57C782E6-B235-4842-AD2B-DB94961761EB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successfull', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => '142989D9-CC52-54D0-928D-2C9B1D9F051C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`'."\n" + ."\n" + .'- `false`', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - ], - [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DeleteEventRuleTargets', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventRuleTargets'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteEventRuleTargets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"57C782E6-B235-4842-AD2B-DB94961761EB\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteHostAvailability', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successfull\\",\\n \\"RequestId\\": \\"142989D9-CC52-54D0-928D-2C9B1D9F051C\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'EnableHostAvailability' => [ - 'summary' => 'Enables availability monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteEventRules' => [ + 'summary' => 'Deletes one or more event-triggered alert rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'RuleNames', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the availability monitoring task. Valid values of N: 1 to 20.'."\n", + 'description' => 'The names of the event-triggered alert rules to delete.', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], + 'items' => ['description' => 'The name of an event-triggered alert rule to delete.', 'type' => 'string', 'required' => false, 'example' => 'lq-test', 'title' => ''], 'required' => true, - 'example' => '123456', + 'example' => 'rule1', 'maxItems' => 20, + 'title' => '', ], ], ], @@ -7119,117 +5136,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use this ID to query logs.', 'type' => 'string', 'example' => '45231A42-5A09-5AFF-953C-A5B3D4ED8925', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => '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.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DeleteEventRules', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteEventRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"ACBDBB40-DFB6-4F4C-8957-51FFB233969C\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'EnableHostAvailability', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"45231A42-5A09-5AFF-953C-A5B3D4ED8925\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'extraInfo' => ' ', ], - 'DisableHostAvailability' => [ - 'summary' => 'Disables availability monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteExporterOutput' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DestName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of the availability monitoring task. Valid values of N: 1 to 20.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'required' => true, - 'example' => '12345', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The name of the destination configuration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testName', 'title' => ''], ], ], 'responses' => [ @@ -7237,593 +5208,253 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates success. Other values indicate failure.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2DECF751-7AFA-43BB-8C63-2B6B07E51AE1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: '."\n" + .'- `true`: success'."\n" + .'- `false`: failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"ACBDBB40-DFB6-4F4C-8957-51FFB233969C\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DisableHostAvailability', + 'title' => 'Delete a monitoring data export configuration', + 'summary' => 'Calls the DeleteExporterOutput operation to delete a monitoring data export configuration.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyHostAvailability' => [ - 'summary' => 'Modifies an availability monitoring task.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-09-21T02:01:45.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExporterOutput'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteExporterOutput', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"2DECF751-7AFA-43BB-8C63-2B6B07E51AE1\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteExporterRule' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the availability monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the availability monitoring task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'task2', - ], - ], - [ - 'name' => 'TaskScope', - 'in' => 'query', - 'schema' => [ - 'description' => 'The range of instances that are monitored by the availability monitoring task. Valid values:'."\n" - ."\n" - .'* GROUP: All ECS instances in the application group are monitored.'."\n" - .'* GROUP_SPEC_INSTANCE: Specified ECS instances in the application group are monitored. The TaskScope parameter must be used in combination with the InstanceList parameter. The InstanceList parameter specifies the ECS instances to be monitored.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GROUP', - 'default' => 'GROUP', - ], - ], - [ - 'name' => 'TaskOption.HttpURI', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URI that you want to monitor. This parameter is required if the TaskType parameter is set to HTTP or Telnet.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], - ], - [ - 'name' => 'TaskOption.TelnetOrPingHost', - 'in' => 'query', - 'schema' => [ - 'description' => 'The domain name or IP address that you want to monitor.'."\n" - ."\n" - .'> This parameter is required if the TaskType parameter is set to PING. For more information about how to set the TaskType parameter, see [CreateHostAvailability](~~115317~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com', - ], - ], - [ - 'name' => 'TaskOption.HttpResponseCharset', - 'in' => 'query', - 'schema' => [ - 'description' => 'The character set that is used in the HTTP response.'."\n" - ."\n" - .'> Only UTF-8 is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'UTF-8', - ], - ], - [ - 'name' => 'TaskOption.HttpPostContent', - 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the HTTP POST request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'params1=value1', - ], - ], - [ - 'name' => 'TaskOption.HttpResponseMatchContent', - 'in' => 'query', - 'schema' => [ - 'description' => 'The response to the HTTP request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ok', - ], - ], - [ - 'name' => 'TaskOption.HttpMethod', - 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP request method. Valid values:'."\n" - ."\n" - .'* GET'."\n" - .'* POST'."\n" - .'* HEAD'."\n" - ."\n" - .'> This parameter must be specified when TaskType is set to HTTP. For more information about how to configure the TaskType parameter, see [CreateHostAvailability](~~115317~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], - ], - [ - 'name' => 'TaskOption.HttpNegative', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The method to trigger an alert. The alert can be triggered based on whether the specified alert rule is included in the response body. Valid values:'."\n" - ."\n" - .'* true: If the HTTP response body includes the alert rule, an alert is triggered.'."\n" - .'* false: If the HTTP response does not include the alert rule, an alert is triggered.'."\n" - ."\n" - .'> This parameter must be specified when TaskType is set to HTTP. For more information about how to configure the TaskType parameter, see [CreateHostAvailability](~~115317~~).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The name of the export rules.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'myRuleName', 'title' => ''], ], - [ - 'name' => 'TaskOption.HttpHeader', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The header of the HTTP request. Format: `Parameter name:Parameter value`. Separate multiple parameters with carriage return characters. Example:'."\n" - ."\n" - .' params1:value1'."\n" - .' params2:value2'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'params1:value1', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success. Any other value indicates failure.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D023', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: '."\n" + .'- `true`: Successful.'."\n" + .'- `false`: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'TaskOption.Interval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which detection requests are sent. Unit: seconds. Valid values: 15, 30, 60, 120, 300, 900, 1800, and 3600.'."\n" - ."\n" - .'> This parameter is available only for the CloudMonitor agent V3.5.1 or later.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - 'name' => 'AlertConfig.NotifyType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert notification methods. Valid values:'."\n" - ."\n" - .'0: Alert notifications are sent by using emails and DingTalk chatbots.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - 'name' => 'AlertConfig.StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range during which the alert rule is effective. Valid values: 0 to 23.'."\n" - ."\n" - .'For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.'."\n" - ."\n" - .'> Alert notifications are sent based on the specified threshold only if the alert rule is effective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - [ - 'name' => 'AlertConfig.EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range during which the alert rule is effective. Valid values: 0 to 23.'."\n" - ."\n" - .'For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.'."\n" - ."\n" - .'> Alert notifications are sent based on the specified threshold only if the alert rule is effective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '22', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - [ - 'name' => 'AlertConfig.SilenceTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400. The default value indicates one day.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], + ], + 'title' => 'Delete export rules', + 'summary' => 'Invokes the DeleteExporterRule operation to delete export rules.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-08-30T08:14:43.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-10T10:46:10.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteExporterRule'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'AlertConfig.WebHook', - 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com/webhook.json', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteExporterRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"6A5F022D-AC7C-460E-94AE-B9E75083D023\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteGroupMonitoringAgentProcess' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AlertConfigEscalationList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The alert configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric for which the alert feature is enabled. Valid values of N: 1 to 21. Valid values:'."\n" - ."\n" - .'* HttpStatus: HTTP status code'."\n" - .'* HttpLatency: HTTP response time'."\n" - .'* TelnetStatus: Telnet status code'."\n" - .'* TelnetLatency: Telnet response time'."\n" - .'* PingLostRate: Ping packet loss rate'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HttpStatus', - ], - 'Value' => [ - 'description' => 'The alert threshold. Valid values of N: 1 to 21.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered. Valid values of N: 1 to 21.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Operator' => [ - 'description' => 'The comparison operator that is used in the alert rule. Valid values of N: 1 to 21. Valid values:'."\n" - ."\n" - .'* `>`'."\n" - .'* `>=`'."\n" - .'* `<`'."\n" - .'* `<=`'."\n" - .'* `=`'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], - 'Aggregate' => [ - 'description' => 'The method used to calculate the metric values that trigger alerts. Valid values of N: 1 to 21. The value of this parameter varies based on the metric. The following items show the correspondence between metrics and calculation methods:'."\n" - ."\n" - .'* HttpStatus: Value'."\n" - .'* HttpLatency: Average'."\n" - .'* TelnetStatus: Value'."\n" - .'* TelnetLatency: Average'."\n" - .'* PingLostRate: Average'."\n" - ."\n" - .'> The value Value indicates the original value and is used for metrics such as status codes. The value Average indicates the average value and is used for metrics such as the latency and packet loss rate.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Value', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 10, - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'InstanceList', + 'name' => 'GroupId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ECS instances that are monitored. Valid values of N: 1 to 21.'."\n" - ."\n" - .'> This parameter must be specified when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ECS instances that are monitored. Valid values of N: 1 to 21.'."\n" - ."\n" - .'> This parameter must be specified when `TaskScope` is set to `GROUP_SPEC_INSTANCE`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'required' => false, - 'example' => 'i-absdfkwl321****', - 'maxItems' => 1000, - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'AlertConfigTargetList', + 'name' => 'Id', 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => 'The information about the resources for which alerts are triggered.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the resource for which alerts are triggered.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.'."\n" - ."\n" - .'Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:'."\n" - ."\n" - .'* {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).'."\n" - ."\n" - .'* {userId}: the ID of the Alibaba Cloud account.'."\n" - ."\n" - .'* {regionId}: the region ID of the SMQ queue or topic.'."\n" - ."\n" - .'* {Resource type}: the type of the resource for which alerts are triggered. Valid values:'."\n" - ."\n" - .' * **queues**'."\n" - .' * **topics**'."\n" - ."\n" - .'* {Resource name}: the resource name.'."\n" - ."\n" - .' * If the resource type is **queues**, the resource name is the queue name.'."\n" - .' * If the resource type is **topics**, the resource name is the topic name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs:mns:cn-hangzhou:111:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the group process.', 'type' => 'string', 'required' => true, 'example' => '48F83746-C817-478C-9B06-7158F56B****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '16E815A3-47E1-4290-87F9-D5C99471FF45', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3F6150F9-45C7-43F9-9578-A58B2E726C90', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"16E815A3-47E1-4290-87F9-D5C99471FF45\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyHostAvailabilityResponse>\\n\\t\\t<RequestId>16E815A3-47E1-4290-87F9-D5C99471FF45</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</ModifyHostAvailabilityResponse>","errorExample":""}]', - 'title' => 'ModifyHostAvailability', - 'description' => 'This topic provides an example on how to change the name of an availability monitoring task named `12345` in an application group named `123456` to `task2`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Delete a group process monitoring task', + 'summary' => 'Deletes a group process monitoring task by calling the DeleteGroupMonitoringAgentProcess operation.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeUnhealthyHostAvailability' => [ - 'summary' => 'Queries unhealthy instances detected by availability monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupMonitoringAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteGroupMonitoringAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"3F6150F9-45C7-43F9-9578-A58B2E726C90\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteHostAvailability' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the availability monitoring task. Valid values of N: 1 to 20.'."\n", + 'description' => 'The IDs of the tasks.', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], + 'items' => ['description' => 'The ID of the task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12456', 'title' => ''], 'required' => true, - 'example' => '123456', + 'example' => '12456', 'maxItems' => 20, + 'title' => '', ], ], ], @@ -7832,1501 +5463,612 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'UnhealthyList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NodeTaskInstance' => [ - 'description' => 'The unhealthy instances that are detected by the specified availability monitoring tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the availability monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'InstanceList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'String' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The unhealthy instances that are detected by the availability monitoring task.'."\n", - 'type' => 'string', - 'example' => 'i-a34b581****', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '57C782E6-B235-4842-AD2B-DB94961761EB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. \\`true\\`: The operation was successful. \\`false\\`: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DeleteHostAvailability', + 'summary' => 'Deletes one or more availability monitoring jobs.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHostAvailability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteHostAvailability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'HostAvailability', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"ACBDBB40-DFB6-4F4C-8957-51FFB233969C\\",\\n \\"Success\\": true,\\n \\"UnhealthyList\\": {\\n \\"NodeTaskInstance\\": [\\n {\\n \\"Id\\": 0,\\n \\"InstanceList\\": {\\n \\"String\\": [\\n \\"i-*****\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeUnhealthyHostAvailability', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"57C782E6-B235-4842-AD2B-DB94961761EB\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'extraInfo' => ' ', ], - 'DescribeHostAvailabilityList' => [ - 'summary' => 'Queries availability monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteHybridMonitorNamespace' => [ + 'summary' => 'Deletes a namespace.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the availability monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456', - ], - ], - [ - 'name' => 'Ids', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the availability monitoring tasks. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456,345678', - ], - ], - [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the availability monitoring task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs_instance', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Minimum value: 1. Default value: 10'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'GroupId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => true, 'example' => 'aliyun', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4A288E86-45C3-4858-9DB0-6D85B10BD92A', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TaskList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NodeTaskConfig' => [ - 'description' => 'The details of the availability monitoring tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskType' => [ - 'description' => 'The task type. Valid values:'."\n" - ."\n" - .'* PING'."\n" - .'* TELNET'."\n" - .'* HTTP'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'GroupName' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', - 'example' => 'Group_ECS', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'TaskName' => [ - 'description' => 'The name of the availability monitoring task.'."\n", - 'type' => 'string', - 'example' => 'ecs_instance', - ], - 'Disabled' => [ - 'description' => 'Indicates whether the availability monitoring task is disabled. Valid values:'."\n" - ."\n" - .'* true: The availability monitoring task is disabled.'."\n" - .'* false: The availability monitoring task is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'TaskScope' => [ - 'description' => 'The range of instances that are monitored by the availability monitoring task. Valid values:'."\n" - ."\n" - .'* GROUP: All ECS instances in the application group are monitored.'."\n" - .'* GROUP_SPEC_INSTANCE: Specified ECS instances in the application group are monitored.'."\n", - 'type' => 'string', - 'example' => 'GROUP', - ], - 'Id' => [ - 'description' => 'The ID of the availability monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'Instances' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Instance' => [ - 'description' => 'The ECS instances that are monitored.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the ECS instance.'."\n", - 'type' => 'string', - 'example' => 'i-abcdefgh12****', - ], - ], - ], - ], - 'TaskOption' => [ - 'description' => 'The optional parameters of the availability monitoring task.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpMethod' => [ - 'description' => 'The HTTP request method. Valid values:'."\n" - ."\n" - .'* GET'."\n" - .'* POST'."\n" - .'* HEAD'."\n", - 'type' => 'string', - 'example' => 'GET', - ], - 'Interval' => [ - 'description' => 'The interval at which detection requests are sent. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'HttpURI' => [ - 'description' => 'The URI that you want to monitor. If the TaskType parameter is set to HTTP, this parameter is required.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com', - ], - 'TelnetOrPingHost' => [ - 'description' => 'The domain name or IP address that you want to monitor.'."\n", - 'type' => 'string', - 'example' => 'ssh.aliyun.com', - ], - 'HttpResponseCharset' => [ - 'description' => 'The character set that is used in the HTTP response.'."\n", - 'type' => 'string', - 'example' => 'UTF-8', - ], - 'HttpPostContent' => [ - 'description' => 'The content of the HTTP POST request.'."\n", - 'type' => 'string', - 'example' => 'params1=paramsValue1', - ], - 'HttpNegative' => [ - 'description' => 'The method to trigger an alert. The alert can be triggered based on whether the specified alert rule is included in the response body. Valid values:'."\n" - ."\n" - .'* true: If the HTTP response body includes the alert rule, an alert is triggered.'."\n" - .'* false: If the HTTP response does not include the alert rule, an alert is triggered.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpKeyword' => [ - 'description' => 'The response to the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - ], - ], - 'AlertConfig' => [ - 'description' => 'The configurations of the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'SilenceTime' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - ], - 'EndTime' => [ - 'description' => 'The end of the time period during which the alert rule is effective. Valid values: 0 to 23.'."\n" - ."\n" - .'For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.'."\n" - ."\n" - .'> Alert notifications are sent based on the specified threshold only if the alert rule is effective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '22', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time period during which the alert rule is effective. Valid values: 0 to 23.'."\n" - ."\n" - .'For example, if the `AlertConfig.StartTime` parameter is set to 0 and the `AlertConfig.EndTime` parameter is set to 22, the alert rule is effective from 00:00:00 to 22:00:00.'."\n" - ."\n" - .'> Alert notifications are sent based on the specified threshold only if the alert rule is effective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'WebHook' => [ - 'description' => 'The callback URL.'."\n" - ."\n" - .'CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com', - ], - 'NotifyType' => [ - 'description' => 'The alert notification methods. Valid values:'."\n" - ."\n" - .'* 2: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* 1: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* 0: Alert notifications are sent by using emails and DingTalk chatbots.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'EscalationList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'escalationList' => [ - 'description' => 'The trigger conditions of the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '400', - ], - 'MetricName' => [ - 'description' => 'The name of the metric. Valid values:'."\n" - ."\n" - .'* HttpStatus'."\n" - .'* HttpLatency'."\n" - .'* TelnetStatus'."\n" - .'* TelnetLatency'."\n" - .'* PingLostRate'."\n", - 'type' => 'string', - 'example' => 'HttpStatus', - ], - 'Operator' => [ - 'description' => 'The comparison operator that is used in the alert rule. Valid values:'."\n" - ."\n" - .'* `>`'."\n" - .'* `>=`'."\n" - .'* `<`'."\n" - .'* `<=`'."\n" - .'* `=`'."\n", - 'type' => 'string', - 'example' => '=', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value is measured before an alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Aggregate' => [ - 'description' => 'The method used to calculate metric values that trigger alerts. Valid values:'."\n" - ."\n" - .'* Value: the value of the HTTP status code'."\n" - .'* Average: the average HTTP response time'."\n" - .'* Value: the value of the Telnet status code'."\n" - .'* TelnetLatency: the average Telnet response time'."\n" - .'* Average: the average Ping packet loss rate'."\n", - 'type' => 'string', - 'example' => 'Value', - ], - ], - ], - ], - ], - ], - 'TargetList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Target' => [ - 'description' => 'The monitored resources.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource that triggers the alert.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the function.'."\n" - ."\n" - .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields:'."\n" - ."\n" - .'* Service: the service code'."\n" - .'* Region: the region ID'."\n" - .'* Account: the ID of the Alibaba Cloud account'."\n" - .'* ResourceType: the resource type'."\n" - .'* ResourceId: the resource ID.'."\n", - 'type' => 'string', - 'example' => 'acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'example' => 'INFO', - ], - 'JsonParams' => [ - 'description' => 'The JSON-formatted parameters of the alert callback.'."\n", - 'type' => 'string', - 'example' => '{"key1":"value1"}', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Namespace.NotFound', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3843D23A-FB9E-5DC8-BCCC-458768B79296', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DeleteHybridMonitorNamespace', + 'description' => '> If a metric import task is created for metrics in a namespace, you cannot delete the namespace unless you delete the task first.'."\n" + ."\n" + .'This topic provides an example on how to delete a namespace named `aliyun`. The response shows that the namespace is deleted.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-03-29T07:11:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHybridMonitorNamespace'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteCustomNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"4A288E86-45C3-4858-9DB0-6D85B10BD92A\\",\\n \\"Total\\": 1,\\n \\"Success\\": true,\\n \\"TaskList\\": {\\n \\"NodeTaskConfig\\": [\\n {\\n \\"TaskType\\": \\"HTTP\\",\\n \\"GroupName\\": \\"Group_ECS\\",\\n \\"GroupId\\": 12345,\\n \\"TaskName\\": \\"ecs_instance\\",\\n \\"Disabled\\": false,\\n \\"TaskScope\\": \\"GROUP\\",\\n \\"Id\\": 123456,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n \\"i-abcdefgh12****\\"\\n ]\\n },\\n \\"TaskOption\\": {\\n \\"HttpMethod\\": \\"GET\\",\\n \\"Interval\\": 60,\\n \\"HttpURI\\": \\"https://www.aliyun.com\\",\\n \\"TelnetOrPingHost\\": \\"ssh.aliyun.com\\",\\n \\"HttpResponseCharset\\": \\"UTF-8\\",\\n \\"HttpPostContent\\": \\"params1=paramsValue1\\",\\n \\"HttpNegative\\": true,\\n \\"HttpKeyword\\": \\"OK\\"\\n },\\n \\"AlertConfig\\": {\\n \\"SilenceTime\\": 86400,\\n \\"EndTime\\": 22,\\n \\"StartTime\\": 0,\\n \\"WebHook\\": \\"https://www.aliyun.com\\",\\n \\"NotifyType\\": 1,\\n \\"EscalationList\\": {\\n \\"escalationList\\": [\\n {\\n \\"Value\\": \\"400\\",\\n \\"MetricName\\": \\"HttpStatus\\",\\n \\"Operator\\": \\"=\\",\\n \\"Times\\": \\"3\\",\\n \\"Aggregate\\": \\"Value\\"\\n }\\n ]\\n },\\n \\"TargetList\\": {\\n \\"Target\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Arn\\": \\"acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages\\",\\n \\"Level\\": \\"INFO\\",\\n \\"JsonParams\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"}\\"\\n }\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeHostAvailabilityListResponse>\\r\\n\\t<RequestId>4A288E86-45C3-4858-9DB0-6D85B10BD92A</RequestId>\\r\\n\\t<Total>1</Total>\\r\\n\\t<TaskList>\\r\\n\\t\\t<NodeTaskConfig>\\r\\n\\t\\t\\t<GroupName>Group_ECS</GroupName>\\r\\n\\t\\t\\t<TaskOption>\\r\\n\\t\\t\\t\\t<HttpURI>https://aliyun.com</HttpURI>\\r\\n\\t\\t\\t\\t<HttpMethod>GET</HttpMethod>\\r\\n\\t\\t\\t</TaskOption>\\r\\n\\t\\t\\t<AlertConfig>\\r\\n\\t\\t\\t\\t<NotifyType>1</NotifyType>\\r\\n\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t<EndTime>22</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>0</StartTime>\\r\\n\\t\\t\\t\\t<EscalationList>\\r\\n\\t\\t\\t\\t\\t<escalationList>\\r\\n\\t\\t\\t\\t\\t\\t<Operator>=</Operator>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>HttpStatus</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Value>400</Value>\\r\\n\\t\\t\\t\\t\\t\\t<Aggregate>Value</Aggregate>\\r\\n\\t\\t\\t\\t\\t</escalationList>\\r\\n\\t\\t\\t\\t\\t<escalationList>\\r\\n\\t\\t\\t\\t\\t\\t<Operator>=</Operator>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>HttpLatency</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Value>500</Value>\\r\\n\\t\\t\\t\\t\\t\\t<Aggregate>Average</Aggregate>\\r\\n\\t\\t\\t\\t\\t</escalationList>\\r\\n\\t\\t\\t\\t</EscalationList>\\r\\n\\t\\t\\t</AlertConfig>\\r\\n\\t\\t\\t<TaskName>ecs_instance</TaskName>\\r\\n\\t\\t\\t<TaskScope>GROUP</TaskScope>\\r\\n\\t\\t\\t<TaskType>HTTP</TaskType>\\r\\n\\t\\t\\t<Id>123456</Id>\\r\\n\\t\\t\\t<Disabled>false</Disabled>\\r\\n\\t\\t\\t<GroupId>12345</GroupId>\\r\\n\\t\\t</NodeTaskConfig>\\r\\n\\t</TaskList>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeHostAvailabilityListResponse>\\t","errorExample":""}]', - 'title' => 'DescribeHostAvailabilityList', - 'description' => 'This topic provides an example to show how to query all the availability monitoring tasks of your Alibaba Cloud account. The sample responses indicate that the account has one availability monitoring task named `ecs_instance`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Namespace.NotFound\\",\\n \\"RequestId\\": \\"3843D23A-FB9E-5DC8-BCCC-458768B79296\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], - 'InstallMonitoringAgent' => [ - 'summary' => 'InstallMonitoringAgent', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteHybridMonitorSLSGroup' => [ + 'summary' => 'Deletes a Logstore group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Force', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to install the CloudMonitor agent. Valid values:'."\n" - ."\n" - .'* true (default value): yes'."\n" - .'* false: no'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - ], - [ - 'name' => 'InstanceIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the ECS instances.'."\n" - ."\n" - .'Valid values of N: 1 to 10.'."\n" - ."\n" - .'> You must specify either the `InstallCommand` or the `InstanceIds` parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-m5e0k0bexac8tykr****', - ], - 'required' => false, - 'example' => 'i-m5e0k0bexac8tykr****', - 'maxItems' => 10, - ], - ], - [ - 'name' => 'InstallCommand', + 'name' => 'SLSGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to install the CloudMonitor agent on all ECS instances that belong to the current Alibaba Cloud account. Valid values:'."\n" - ."\n" - .'* `onlyInstallNotHasAgent`: installs the latest version of the CloudMonitor agent only on ECS instances on which the agent is not installed.'."\n" - .'* `onlyUpgradeAgent`: upgrades the CloudMonitor agent to the latest version only for ECS instances on which an earlier version of the agent is installed.'."\n" - .'* `installAndUpgrade`: installs the latest version of the CloudMonitor agent on ECS instances on which the agent is not installed, and upgrades the CloudMonitor agent to the latest version for ECS instances on which an earlier version of the agent is installed.'."\n" - ."\n" - .'> If you set the InstallCommand parameter, the `InstanceIds` parameter does not take effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'onlyInstallNotHasAgent', - ], + 'schema' => ['description' => 'The name of the Logstore group.'."\n" + ."\n" + .'For information about how to obtain the name of a Logstore group, see [DescribeHybridMonitorSLSGroup](~~429526~~).', 'type' => 'string', 'required' => true, 'example' => 'Logstore_test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0BDAF8A8-04DC-5F0C-90E4-724D42C41945', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'RESOURCE_NOT_FOUND', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '85198BFF-1DE6-556E-B6A4-C77C51C62B8D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Parameter invalid.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 412 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DeleteHybridMonitorSLSGroup', + 'description' => 'This topic provides an example on how to delete a Logstore group named `Logstore_test`. The response shows that the Logstore group is deleted.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHybridMonitorSLSGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteHybridMonitorSLSGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"0BDAF8A8-04DC-5F0C-90E4-724D42C41945\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<InstallMonitoringAgentResponse>\\r\\n\\t<RequestId>0BDAF8A8-04DC-5F0C-90E4-724D42C41945</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</InstallMonitoringAgentResponse>","errorExample":""}]', - 'title' => 'InstallMonitoringAgent', - 'description' => '## Prerequisites'."\n" - ."\n" - .'The Cloud Assistant client is installed on an ECS instance. For more information about how to install the Cloud Assistant client, see [Overview](~~64601~~).'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"RESOURCE_NOT_FOUND\\",\\n \\"RequestId\\": \\"85198BFF-1DE6-556E-B6A4-C77C51C62B8D\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], - 'DescribeMonitoringAgentHosts' => [ - 'summary' => 'Queries all hosts within the current Alibaba Cloud account, including hosts on which the CloudMonitor agent is installed and uninstalled.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteHybridMonitorTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'KeyWord', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used in fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'host1', - ], - ], - [ - 'name' => 'HostName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the host.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hostNam1', - ], - ], - [ - 'name' => 'InstanceIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-a3d1q1pm2f9yr29e****', - ], - ], - [ - 'name' => 'SerialNumbers', - 'in' => 'query', - 'schema' => [ - 'description' => 'The serial number of the host.'."\n" - ."\n" - .'After the CloudMonitor agent is installed on a host, a globally unique serial number is generated. A host that is not provided by Alibaba Cloud has a serial number instead of an instance ID.'."\n" - ."\n" - .'> This parameter can be used to accurately search for a monitored host.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a1ab31a3-1234-40f2-9e95-c8caa8f0****', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values:'."\n" - ."\n" - .'* 10'."\n" - .'* 20'."\n" - .'* 50'."\n" - .'* 100'."\n" - ."\n" - .'> Although Alibaba Cloud does not limit the maximum value of this parameter, we recommend that you do not set it to an excessively large value. If you set it to an excessively large value, a timeout error may occur.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'InstanceRegionId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the metric import task.'."\n" + ."\n" + .'For information about how to obtain the ID of a metric import task, see [DescribeHybridMonitorTaskList](~~428624~~).'."\n" + ."\n" + .'> This parameter is required only if you call this operation to delete metrics for the logs that are imported from Log Service. In this case, the `TaskType` parameter is set to `aliyun_sls`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '36****', 'title' => ''], ], [ - 'name' => 'AliyunHost', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query Elastic Compute Service (ECS) instances that are provided by Alibaba Cloud or to query hosts that are not provided by Alibaba Cloud. Valid values:'."\n" - ."\n" - .'* true (default value): queries all the ECS instances that are provided by Alibaba Cloud.'."\n" - .'* false: queries all the hosts that are not provided by Alibaba Cloud.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'Status', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the hosts that you want to query. Valid values:'."\n" - ."\n" - .'* Running: queries the hosts that are running.'."\n" - .'* Stopped: queries the hosts that are stopped, are not installed, or fail to be installed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'The name can contain uppercase letters, lowercase letters, digits, and hyphens (-).'."\n" + ."\n" + .'> This parameter is required only if you call this operation to delete metric import tasks for Alibaba Cloud services. In this case, the `TaskType` parameter is set to `aliyun_fc`.', 'type' => 'string', 'required' => false, 'example' => 'aliyun', 'title' => ''], ], [ - 'name' => 'SysomStatus', + 'name' => 'TargetUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of SysOM. Valid values:'."\n" - ."\n" - .'* installing: SysOM is being installed.'."\n" - .'* running: SysOM is running.'."\n" - .'* stopped: SysOM is stopped.'."\n" - .'* uninstalling: SysOM is being uninstalled.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'running', - ], + 'schema' => ['description' => 'The ID of the member account.'."\n" + ."\n" + .'> This parameter is required only if you use a management account to call this operation to query metric import tasks that belong to a member in a resource directory. In this case, the `TaskType` parameter is set to `aliyun_fc`.', 'type' => 'string', 'required' => false, 'example' => '120886317861****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The result of the request.'."\n", + 'description' => 'None', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid values:'."\n" - ."\n" - .'* true: The call is successful.'."\n" - .'* false: The call fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageTotal' => [ - 'description' => 'The total number of returned pages.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Hosts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Host' => [ - 'description' => 'The information about the hosts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The host.'."\n", - 'type' => 'object', - 'properties' => [ - 'SerialNumber' => [ - 'description' => 'The serial number of the host. A host that is not provided by Alibaba Cloud has a serial number instead of an instance ID.'."\n" - ."\n" - .'> This parameter can be used to accurately search for a monitored host.'."\n", - 'type' => 'string', - 'example' => 'x12335-6cc8-4a22-9f21-1a00a719****', - ], - 'NatIp' => [ - 'description' => 'The IP address of the Network Address Translation (NAT) gateway.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'HostName' => [ - 'description' => 'The name of the host.'."\n", - 'type' => 'string', - 'example' => 'hostIP', - ], - 'AliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103201326074****', - ], - 'NetworkType' => [ - 'description' => 'The network type.'."\n", - 'type' => 'string', - 'example' => 'vpc', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'i-a2d5q7pm3f9yr212****', - ], - 'isAliyunHost' => [ - 'description' => 'Indicates whether the host is provided by Alibaba Cloud. Valid values:'."\n" - ."\n" - .'* true: The host is provided by Alibaba Cloud.'."\n" - .'* false: The host is not provided by Alibaba Cloud.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EipAddress' => [ - 'description' => 'The elastic IP address (EIP) of the host.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'AgentVersion' => [ - 'description' => 'The version of the CloudMonitor agent.'."\n", - 'type' => 'string', - 'example' => '3.4.6', - ], - 'IpGroup' => [ - 'description' => 'The IP address of the host.'."\n" - ."\n" - .'> Multiple IP addresses are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'EipId' => [ - 'description' => 'The ID of the EIP.'."\n", - 'type' => 'string', - 'example' => 'eip-bp16i16k9gcezyfrp****', - ], - 'Region' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'InstanceTypeFamily' => [ - 'description' => 'The type of the ECS instance.'."\n", - 'type' => 'string', - 'example' => 'ecs.n4', - ], - 'OperatingSystem' => [ - 'description' => 'The operating system.'."\n", - 'type' => 'string', - 'example' => 'Linux', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D6B8103F-7BAD-5FEB-945F-71D991AB8834', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DeleteHybridMonitorTask', + 'summary' => 'Deletes a metric import task for Alibaba Cloud services or a metric for the logs that are imported from Log Service.', + 'description' => 'This topic provides an example on how to delete a metric import task whose ID is `36****`. The returned result indicates that the metric import task is deleted.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-08-09T02:57:10.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHybridMonitorTask'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteHybridMonitorTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageTotal\\": 50,\\n \\"Total\\": 10,\\n \\"Hosts\\": {\\n \\"Host\\": [\\n {\\n \\"SerialNumber\\": \\"x12335-6cc8-4a22-9f21-1a00a719****\\",\\n \\"NatIp\\": \\"192.168.XX.XX\\",\\n \\"HostName\\": \\"hostIP\\",\\n \\"AliUid\\": 0,\\n \\"NetworkType\\": \\"vpc\\",\\n \\"InstanceId\\": \\"i-a2d5q7pm3f9yr212****\\",\\n \\"isAliyunHost\\": true,\\n \\"EipAddress\\": \\"192.168.XX.XX\\",\\n \\"AgentVersion\\": \\"3.4.6\\",\\n \\"IpGroup\\": \\"192.168.XX.XX\\",\\n \\"EipId\\": \\"eip-bp16i16k9gcezyfrp****\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"InstanceTypeFamily\\": \\"ecs.n4\\",\\n \\"OperatingSystem\\": \\"Linux\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitoringAgentHostsResponse>\\r\\n\\t\\t<Hosts>\\r\\n\\t\\t\\t<Host>\\r\\n\\t\\t\\t\\t<OperatingSystem>Windows</OperatingSystem>\\r\\n\\t\\t\\t\\t<SerialNumber>f0a434f2-632b-4588-95e6-202d4396****</SerialNumber>\\r\\n\\t\\t\\t\\t<isAliyunHost>true</isAliyunHost>\\r\\n\\t\\t\\t\\t<InstanceId>i-uf6hm9lnlzsarrc7****</InstanceId>\\r\\n\\t\\t\\t\\t<AgentVersion>3.4.6</AgentVersion>\\r\\n\\t\\t\\t\\t<NetworkType>vpc</NetworkType>\\r\\n\\t\\t\\t\\t<InstanceTypeFamily>ecs.g6</InstanceTypeFamily>\\r\\n\\t\\t\\t\\t<Region>cn-shanghai</Region>\\r\\n\\t\\t\\t\\t<IpGroup>192.168.XX.XX,192.168.XX.XX</IpGroup>\\r\\n\\t\\t\\t\\t<HostName>iZlzsarrc78****</HostName>\\r\\n\\t\\t\\t\\t<AliUid>103201326074****</AliUid>\\r\\n\\t\\t\\t</Host>\\r\\n\\t\\t\\t<Host>\\r\\n\\t\\t\\t\\t<OperatingSystem>Linux</OperatingSystem>\\r\\n\\t\\t\\t\\t<SerialNumber>9c336dc5-1802-4db0-b7a0-2d46ad4f****</SerialNumber>\\r\\n\\t\\t\\t\\t<isAliyunHost>true</isAliyunHost>\\r\\n\\t\\t\\t\\t<InstanceId>i-uf6hn19s56zumk9w****</InstanceId>\\r\\n\\t\\t\\t\\t<AgentVersion>3.4.4</AgentVersion>\\r\\n\\t\\t\\t\\t<NetworkType>vpc</NetworkType>\\r\\n\\t\\t\\t\\t<InstanceTypeFamily>ecs.g5</InstanceTypeFamily>\\r\\n\\t\\t\\t\\t<Region>cn-shanghai</Region>\\r\\n\\t\\t\\t\\t<IpGroup>192.168.XX.XX,192.168.XX.XX</IpGroup>\\r\\n\\t\\t\\t\\t<HostName>launch-advisor-2019****</HostName>\\r\\n\\t\\t\\t\\t<AliUid>103201326074****</AliUid>\\r\\n\\t\\t\\t</Host>\\r\\n\\t\\t</Hosts>\\r\\n\\t\\t<PageSize>100</PageSize>\\r\\n\\t\\t<PageNumber>1</PageNumber>\\r\\n\\t\\t<PageTotal>1</PageTotal>\\r\\n\\t\\t<Total>5</Total>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeMonitoringAgentHostsResponse>","errorExample":""}]', - 'title' => 'DescribeMonitoringAgentHosts', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"D6B8103F-7BAD-5FEB-945F-71D991AB8834\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], - 'DescribeMonitoringAgentAccessKey' => [ - 'summary' => 'Queries the AccessKey ID and AccessKey secret that are required to install the CloudMonitor agent on a third-party host.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteLogMonitor' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'systemTags' => ['operationType' => 'delete', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'LogId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the log monitoring metric.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessKey' => [ - 'description' => 'The AccessKey ID that is required to install the agent.'."\n", - 'type' => 'string', - 'example' => 'E7A27f9****', - ], - 'SecretKey' => [ - 'description' => 'The AccessKey secret that is required to install the agent.'."\n", - 'type' => 'string', - 'example' => 'sBjNOUhLylrxMX-Xv1****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C0F655E9-D793-51E6-BD78-CABBCCFC1047', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'metric not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '42BFFC2B-5E4D-4FDE-BCC6-E91EE33C5967', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessKey\\": \\"E7A27f9****\\",\\n \\"SecretKey\\": \\"sBjNOUhLylrxMX-Xv1****\\",\\n \\"RequestId\\": \\"C0F655E9-D793-51E6-BD78-CABBCCFC1047\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitoringAgentAccessKeyResponse>\\n <SecretKey>sBjNOUhLylrxMX-Xv1****</SecretKey>\\n <RequestId>C0F655E9-D793-51E6-BD78-CABBCCFC1047</RequestId>\\n <AccessKey>E7A27f9****</AccessKey>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeMonitoringAgentAccessKeyResponse>","errorExample":""}]', - 'title' => 'DescribeMonitoringAgentAccessKey', + 'title' => 'DeleteLogMonitor', + 'summary' => 'Deletes a log monitoring metric.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitoringAgentConfig' => [ - 'summary' => 'Queries the configurations of the CloudMonitor agent.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLogMonitor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteLogMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"metric not exist.\\",\\n \\"RequestId\\": \\"42BFFC2B-5E4D-4FDE-BCC6-E91EE33C5967\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteMetricRuleBlackList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert blacklist policy. Separate multiple IDs with commas (,). You can specify up to 50 IDs.'."\n" + ."\n" + .'For information about how to obtain the ID of an alert blacklist policy, see [DescribeMetricRuleBlackList](~~457257~~).'."\n" + ."\n" + .'> This parameter also supports JSON Array format, for example: `["a9ad2ac2-3ed9-11ed-b878-0242ac12****","5cb8a9a4-198f-4651-a353-f8b28788****"]`.', 'type' => 'string', 'required' => true, 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'EnableActiveAlert' => [ - 'description' => 'The cloud services for which proactive alerting is enabled.'."\n", - 'type' => 'string', - 'example' => 'redis,rds,ecs', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E9F4FA2A-54BE-4EF9-9D1D-1A0B1DC86B8D', - ], - 'AutoInstall' => [ - 'description' => 'Indicates whether the CloudMonitor agent is automatically installed on existing Elastic Compute Service (ECS) instances. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableInstallAgentNewECS' => [ - 'description' => 'Indicates whether the CloudMonitor agent is automatically installed on newly purchased ECS instances. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'>200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B88D233C-A004-3AB8-AD9C-30CBDD4440C5', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Count' => ['description' => 'The number of alert blacklist policies that were successfully deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is not valid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'The Request is not authorization.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"EnableActiveAlert\\": \\"redis,rds,ecs\\",\\n \\"RequestId\\": \\"E9F4FA2A-54BE-4EF9-9D1D-1A0B1DC86B8D\\",\\n \\"AutoInstall\\": true,\\n \\"Success\\": true,\\n \\"EnableInstallAgentNewECS\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitoringAgentConfigResponse>\\r\\n\\t<AutoInstall>true</AutoInstall>\\r\\n\\t<EnableActiveAlert></EnableActiveAlert>\\r\\n\\t<EnableInstallAgentNewECS>true</EnableInstallAgentNewECS>\\r\\n\\t<RequestId>B4EB0F95-3181-4E8F-B32E-8C3734E8F88E</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMonitoringAgentConfigResponse>","errorExample":""}]', - 'title' => 'DescribeMonitoringAgentConfig', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeMonitoringAgentStatuses' => [ - 'summary' => 'Queries the status of the CloudMonitor agent.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Delete alert blacklist policies', + 'summary' => 'Calls the DeleteMetricRuleBlackList operation to delete alert blacklist policies.', + 'requestParamsDescription' => 'For information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleBlackList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMetricRuleBlackList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"B88D233C-A004-3AB8-AD9C-30CBDD4440C5\\",\\n \\"Success\\": true,\\n \\"Count\\": 1\\n}","type":"json"}]', + ], + 'DeleteMetricRuleResources' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceIds', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance IDs. Separate multiple instance IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'i-hp3dunahluwajv6f****', - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rr-bp18017n6iolv****', 'title' => ''], ], [ - 'name' => 'HostAvailabilityTaskId', + 'name' => 'Resources', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the availability monitoring task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '126****', - ], + 'schema' => ['description' => 'The resources that are associated with the alert rule.', 'type' => 'string', 'required' => true, 'example' => '[{"instanceId":"i-uf6hm9lnlzsarrc7****"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The results returned.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NodeStatusList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NodeStatus' => [ - 'description' => 'The host status information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the CloudMonitor agent. Valid values:'."\n" - ."\n" - .'* running: The CloudMonitor agent is running.'."\n" - .'* stopped: The CloudMonitor agent is stopped.'."\n" - .'* installing: The CloudMonitor agent is being installed.'."\n" - .'* install_faild: The CloudMonitor agent fails to be installed.'."\n" - .'* abnormal: The CloudMonitor agent is not properly installed.'."\n" - .'* not_installed: The CloudMonitor agent is not installed.'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'i-hp3dunahluwajv6f****', - ], - 'AutoInstall' => [ - 'description' => 'Indicates whether the CloudMonitor agent is automatically installed. Valid values:'."\n" - ."\n" - .'* true: The CloudMonitor agent is automatically installed.'."\n" - .'* false: The CloudMonitor agent is not automatically installed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'OsMonitorStatus' => [ - 'description' => 'The status of SysOM. Valid values:'."\n" - ."\n" - .'* installing: SysOM is being installed.'."\n" - .'* running: SysOM is running.'."\n" - .'* stopped: SysOM is stopped.'."\n" - .'* uninstalling: SysOM is being uninstalled.'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'OsMonitorErrorCode' => [ - 'description' => 'The error status of SysOM. Valid values:'."\n" - ."\n" - .'* `install_fail`: SysOM fails to be installed or an unknown error occurs.'."\n" - .'* `install_assist_invalid`: SysOM fails to be installed because the status of Cloud Assistant is invalid.'."\n" - .'* `install_assist_command_fail`: SysOM fails to be installed because the installation command fails to run.'."\n" - .'* `uninstall_fail`: SysOM fails to be uninstalled or an unknown error occurs.'."\n" - .'* `uninstall_assist_invalid`: SysOM fails to be uninstalled because the status of Cloud Assistant is invalid.'."\n" - .'* `uninstall_assist_command_fail`: SysOM fails to be uninstalled because the uninstallation command fails to run.'."\n", - 'type' => 'string', - 'example' => 'install_fail', - ], - 'OsMonitorErrorDetail' => [ - 'description' => 'The details of the execution error. Valid values:'."\n" - ."\n" - .'* `Command.ErrorCode.Fail.Downlaod.REGIN_ID`: Failed to obtain the region ID.'."\n" - .'* `Command.ErrorCode.Fail.Downlaod.SYSAK`: Failed to download the .rpm package of System Analyse Kit (SysAK).'."\n" - .'* `Command.ErrorCode.Fail.Downlaod.CMON_FILE`: Failed to download the CMON file.'."\n" - .'* `Command.ErrorCode.Fail.Downlaod.BTF`: Failed to start SysAK because the BTF file is not found.'."\n" - .'* `Command.ErrorCode.Fail.Start.SYSAK`: Failed to start SysAK due to an unknown error.'."\n", - 'type' => 'string', - 'example' => 'Command.ErrorCode.Fail.Downlaod.REGIN_ID', - ], - 'OsMonitorVersion' => [ - 'description' => 'The SysOM version.'."\n", - 'type' => 'string', - 'example' => '1.3.0-12', - ], - 'OsMonitorConfig' => [ - 'description' => 'Indicates whether the SysAK monitoring feature is enabled.`` Valid values:'."\n" - ."\n" - .'* `true`: The SysAK monitoring feature is enabled.'."\n" - .'* `false`: the SysAK monitoring feature is disabled.'."\n", - 'type' => 'string', - 'example' => '{"sysak":true}', - ], - 'AgentInstallErrorCode' => [ - 'description' => 'The error code returned when the CloudMonitor agent is installed. Valid values:'."\n" - ."\n" - .'* Common.Timeout: The installation timed out.'."\n" - .'* Common.SLR: The service-linked role for CloudMonitor is unauthorized.'."\n" - .'* Common.OS: The operating system is not supported.'."\n" - .'* Assist.Invalid: Cloud Assistant is not running.'."\n" - .'* Assist.Invoke: An error occurred when the installation program is started.'."\n" - .'* Assist.Execute: An error occurred when the installation program is running.'."\n", - 'type' => 'string', - ], - 'LoongCollectorVersion' => [ - 'type' => 'string', - ], - 'LoongCollectorStatus' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The alert does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D8A35882-90C6-4F03-BBEB-153C180398EA', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F\\",\\n \\"Success\\": true,\\n \\"NodeStatusList\\": {\\n \\"NodeStatus\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"InstanceId\\": \\"i-hp3dunahluwajv6f****\\",\\n \\"AutoInstall\\": true,\\n \\"OsMonitorStatus\\": \\"running\\",\\n \\"OsMonitorErrorCode\\": \\"install_fail\\",\\n \\"OsMonitorErrorDetail\\": \\"Command.ErrorCode.Fail.Downlaod.REGIN_ID\\",\\n \\"OsMonitorVersion\\": \\"1.3.0-12\\",\\n \\"OsMonitorConfig\\": \\"{\\\\\\"sysak\\\\\\":true}\\",\\n \\"AgentInstallErrorCode\\": \\"Assist.Invalid\\",\\n \\"LoongCollectorVersion\\": \\"0.1.0\\",\\n \\"LoongCollectorStatus\\": \\"running\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitoringAgentStatusesResponse>\\n\\t<RequestId>6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F</RequestId>\\n\\t<NodeStatusList>\\n\\t\\t<NodeStatus>\\n\\t\\t\\t<Status>running</Status>\\n\\t\\t\\t<AutoInstall>true</AutoInstall>\\n\\t\\t\\t<InstanceId>i-hp3dunahluwajv6f****</InstanceId>\\n\\t\\t</NodeStatus>\\n\\t</NodeStatusList>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DescribeMonitoringAgentStatusesResponse>\\t","errorExample":""}]', - 'title' => 'DescribeMonitoringAgentStatuses', - 'description' => 'This topic describes how to query the status of the CloudMonitor agent that is installed on the `i-hp3dunahluwajv6f****` instance. The result indicates that the CloudMonitor agent is in the `running` state.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DeleteMetricRuleResources', + 'summary' => 'Disassociates resources from an alert rule.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyHostInfo' => [ - 'summary' => '修改非阿里云的主机显示信息', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleResources'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMetricRuleResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The alert does not exist.\\",\\n \\"RequestId\\": \\"D8A35882-90C6-4F03-BBEB-153C180398EA\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteMetricRuleTargets' => [ + 'summary' => 'Delete the push channels of an alert rule.', + 'methods' => ['post', 'get', 'delete', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance. Only hosts not on Alibaba Cloud are supported.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'host-R_NSWNV****', - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ruleId-xxxxxx', 'title' => ''], ], [ - 'name' => 'HostName', + 'name' => 'TargetIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the host.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'portalHost', + 'description' => 'The resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'The resource ID. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => true, + 'example' => '12345', + 'maxItems' => 5, + 'title' => '', ], ], ], @@ -9335,209 +6077,197 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EBB5215C-44AB-4000-A2D7-48634FDC4F04', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'\\*\\*'."\n" + ."\n" + .'**Description** The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FailIds' => [ + 'description' => 'The IDs of the resources that failed to be deleted.', + 'type' => 'object', + 'properties' => [ + 'TargetIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TargetId' => [ + 'description' => 'The IDs of the resources that failed to be deleted.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource that failed to be deleted.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed because of an unknown error, exception or failure.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"EBB5215C-44AB-4000-A2D7-48634FDC4F04\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyHostInfo>\\n\\t\\t<RequestId>EBB5215C-44AB-4000-A2D7-48634FDC4F04</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</ModifyHostInfo>","errorExample":""}]', - 'title' => 'ModifyHostInfo', - 'description' => '****', + 'title' => 'DeleteMetricRuleTargets', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitoringConfig' => [ - 'summary' => 'Queries the global configurations of the CloudMonitor agent.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleTargets'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMetricRuleTargets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"786E92D2-AC66-4250-B76F-F1E2FCDDBA1C\\",\\n \\"Success\\": true,\\n \\"FailIds\\": {\\n \\"TargetIds\\": {\\n \\"TargetId\\": [\\n \\"1\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'DeleteMetricRuleTemplate' => [ + 'summary' => 'Deletes an alert rule template.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule template.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123****', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F35654DB-0C9D-4FB3-903F-479BA7663061', - ], - 'AutoInstall' => [ - 'description' => 'Indicates whether the CloudMonitor agent is automatically installed on existing Elastic Compute Service (ECS) instances. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableInstallAgentNewECS' => [ - 'description' => 'Indicates whether the CloudMonitor agent is automatically installed on new ECS instances. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7B63F8CF-D48D-4608-A402-04FB5B2B4B6A', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resource' => [ + 'description' => 'The template information.', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '123****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is not valid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'The Request is not authorization.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F35654DB-0C9D-4FB3-903F-479BA7663061\\",\\n \\"AutoInstall\\": false,\\n \\"Success\\": true,\\n \\"EnableInstallAgentNewECS\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitoringConfigResponse>\\r\\n\\t<AutoInstall>false</AutoInstall>\\r\\n\\t<EnableInstallAgentNewECS>true</EnableInstallAgentNewECS>\\r\\n\\t<RequestId>BA76F154-DE3F-442C-94D3-895E7ABC1BDE</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMonitoringConfigResponse>","errorExample":""}]', - 'title' => 'DescribeMonitoringConfig', + 'title' => 'Delete an alert rule template', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutMonitoringConfig' => [ - 'summary' => 'Configures global settings for the CloudMonitor agent.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleTemplate'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMetricRuleTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"7B63F8CF-D48D-4608-A402-04FB5B2B4B6A\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"TemplateId\\": \\"123****\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteMetricRules' => [ + 'summary' => 'The DeleteMetricRules operation deletes one or more alert rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'AutoInstall', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'EnableInstallAgentNewECS', + 'name' => 'Id', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to automatically install the CloudMonitor agent on new ECS instances. Valid values:'."\n" - ."\n" - .'* true (default): The CloudMonitor agent is automatically installed on new ECS instances.'."\n" - .'* false: The CloudMonitor agent is not automatically installed on new ECS instances.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'description' => 'The IDs of the alert rules to delete.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the alert rule to delete.', 'type' => 'string', 'required' => false, 'example' => 'c3b2804a297444d0aa7bfd4fb0e4a01b', 'title' => ''], + 'required' => true, + 'example' => 'ab05733c97b7ce239fb1b53393dc1697c7e12****', + 'maxItems' => 100, + 'title' => '', ], ], ], @@ -9546,93 +6276,85 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Specified parameter EnableInstallAgentNewECS is not valid.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '109C8095-6FAD-4DBB-B013-6ED18CE4C0B1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '09B3A484-1A2B-5743-BB6B-D796416F2677', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is not valid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'The Request is not authorization.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], + ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternetServerError', 'errorMessage' => 'InternetServerError', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DeleteMetricRules', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMetricRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Specified parameter EnableInstallAgentNewECS is not valid.\\",\\n \\"RequestId\\": \\"109C8095-6FAD-4DBB-B013-6ED18CE4C0B1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutMonitoringConfigResponse>\\n <RequestId>109C8095-6FAD-4DBB-B013-6ED18CE4C0B1</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</PutMonitoringConfigResponse>","errorExample":""}]', - 'title' => 'PutMonitoringConfig', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"09B3A484-1A2B-5743-BB6B-D796416F2677\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'extraInfo' => ' ', ], - 'UninstallMonitoringAgent' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteMonitorGroup' => [ + 'summary' => 'Deletes an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the host.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'host-****', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], ], 'responses' => [ @@ -9640,128 +6362,133 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successfully', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '466902B9-2842-40B0-B796-00FE772B6EF3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CA35B3AE-4FFD-4A33-AE67-67EF68711EFA', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Group' => [ + 'description' => 'The deleted application group.', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The name of the application group.', 'type' => 'string', 'example' => 'ECS_test', 'title' => ''], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => 'The alert groups that receive alert notifications for the application group.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the alert group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], - 412 => [ - [ - 'errorCode' => 'AgentStateError', - 'errorMessage' => 'Expected agent running state is stopped.', - ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ['errorCode' => 'InvalidClientTokenId', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successfully\\",\\n \\"RequestId\\": \\"466902B9-2842-40B0-B796-00FE772B6EF3\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UninstallMonitoringAgentResponse>\\n <RequestId>466902B9-2842-40B0-B796-00FE772B6EF3</RequestId>\\n <Code>200</Code>\\n <Message>Successfully</Message>\\n</UninstallMonitoringAgentResponse>","errorExample":""}]', - 'title' => 'UninstallMonitoringAgent', - 'summary' => 'Uninstalls the CloudMonitor agent from a third-party host.', - 'description' => '> This API operation is not applicable to Elastic Compute Service (ECS) instances. To uninstall the agent from an ECS instance, see [Install and uninstall the CloudMonitor agent](~~183482~~).'."\n", + 'title' => 'DeleteMonitorGroup', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateMonitoringAgentProcess' => [ - 'summary' => 'Creates a task to monitor a process.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMonitorGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"CA35B3AE-4FFD-4A33-AE67-67EF68711EFA\\",\\n \\"Success\\": true,\\n \\"Group\\": {\\n \\"GroupName\\": \\"ECS_test\\",\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Name\\": \\"ECS_Group\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'DeleteMonitorGroupDynamicRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ProcessName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the process.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'java', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => ' i-2ze51wjtwox01r8g****', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'ProcessUser', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'The user who launches the process.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'admin', - ], + 'schema' => ['description' => 'The service to which the rule applies. Valid values: ecs, rds, and slb.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecs', 'title' => ''], ], ], 'responses' => [ @@ -9769,126 +6496,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0DFCB47D-E7E1-4CBE-A381-8339F7B300EF', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'The process ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '56B4516A-EB44-4C66-8854-0393B35F636B', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"0DFCB47D-E7E1-4CBE-A381-8339F7B300EF\\",\\n \\"Success\\": true,\\n \\"Id\\": 12345\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitoringAgentProcessResponse>\\n <RequestId>0DFCB47D-E7E1-4CBE-A381-8339F7B300EF</RequestId>\\n <Id>171894</Id>\\n <Success>true</Success>\\n <Code>200</Code>\\n</CreateMonitoringAgentProcessResponse>","errorExample":""}]', - 'title' => 'CreateMonitoringAgentProcess', + 'title' => 'DeleteMonitorGroupDynamicRule', + 'summary' => 'Deletes a rule that is used to dynamically add the instances of a service to an application group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateMonitorAgentProcess' => [ - 'summary' => 'Creates a task to monitor a process.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroupDynamicRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMonitorGroupDynamicRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"56B4516A-EB44-4C66-8854-0393B35F636B\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteMonitorGroupInstances' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ProcessName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The process name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'AliYunDun', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'InstanceIdList', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'i-2ze2d6j5uhg20x47****', - ], + 'schema' => ['description' => 'The instances to be removed from the application group. Separate multiple instances with commas (,). You can remove a maximum of 20 instances from an application group at a time.', 'type' => 'string', 'required' => true, 'example' => 'i-a2d5q7pm3f912****,i-a2d5q7pm3f222****', 'title' => ''], ], [ - 'name' => 'ProcessUser', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'The user who launches the process.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'admin', - ], + 'schema' => ['description' => 'The abbreviation of the cloud service name.'."\n" + ."\n" + .'> For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], ], ], 'responses' => [ @@ -9896,279 +6605,202 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '971CC023-5A96-452A-BB7C-2483F948BCFD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'The process ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5351B0F2-26A9-4BC9-87FF-1B74034D12C3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"971CC023-5A96-452A-BB7C-2483F948BCFD\\",\\n \\"Success\\": true,\\n \\"Id\\": 123456\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitorAgentProcessResponse>\\n <RequestId>971CC023-5A96-452A-BB7C-2483F948BCFD</RequestId>\\n <Id>123456</Id>\\n <Success>true</Success>\\n <Code>200</Code>\\n</CreateMonitorAgentProcessResponse>","errorExample":""}]', - 'title' => 'CreateMonitorAgentProcess', + 'title' => 'DeleteMonitorGroupInstances', + 'summary' => 'Removes instances from an application group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitoringAgentProcesses' => [ - 'summary' => '查询指定资源的进程数列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroupInstances'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMonitorGroupInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MonitorGroupInstances', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5351B0F2-26A9-4BC9-87FF-1B74034D12C3\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteMonitorGroupNotifyPolicy' => [ + 'summary' => 'Deletes a policy that is used to pause alert notifications for an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'PolicyType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the instance.'."\n", + 'description' => 'The type of the policy.'."\n" + ."\n" + .'Valid value: PauseNotify.', 'type' => 'string', 'required' => true, - 'example' => 'i-hp3hl3cx1pbahzy8****', + 'enum' => ['PauseNotify'], + 'example' => 'PauseNotify', + 'title' => '', ], ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '6780****', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The value 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'C11C0E85-6862-4F25-8D66-D6A5E0882984', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NodeProcesses' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NodeProcess' => [ - 'description' => 'The information about the processes.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProcessName' => [ - 'description' => 'The name of the process.'."\n", - 'type' => 'string', - 'example' => 'Nginx', - ], - 'ProcessId' => [ - 'description' => 'The ID of the process.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234567', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '3619****', - ], - 'Command' => [ - 'description' => 'The command used to obtain the number of processes. Valid value: `number`.'."\n" - ."\n" - .'> The `number` command obtains the number of processes that match the condition.'."\n", - 'type' => 'string', - 'example' => 'number', - ], - 'ProcessUser' => [ - 'description' => 'The user who launched the process.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'i-hp3hl3cx1pbahzy8****', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B7AF834D-D38B-4A46-920B-FE974EB7E135', 'title' => ''], + 'Result' => ['description' => 'The number of affected rows.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. ', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"C11C0E85-6862-4F25-8D66-D6A5E0882984\\",\\n \\"Success\\": true,\\n \\"NodeProcesses\\": {\\n \\"NodeProcess\\": [\\n {\\n \\"ProcessName\\": \\"java\\",\\n \\"ProcessId\\": 4550102,\\n \\"GroupId\\": \\"239708487\\",\\n \\"Command\\": \\"/bin/sh\\",\\n \\"ProcessUser\\": \\"admin\\",\\n \\"InstanceId\\": \\"host-gdsmvinvmh6fu\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeMonitoringAgentProcesses', - 'description' => '> Before you call this operation, call the CreateMonitoringAgentProcess operation to create processes. For more information, see [CreateMonitoringAgentProcess](~~114951~~~).'."\n" - ."\n" - .'This topic provides an example of how to query the processes of the `i-hp3hl3cx1pbahzy8****` instance. The response indicates the details of the `NGINX` and `HTTP` processes.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DeleteMonitorGroupNotifyPolicy', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroupNotifyPolicy'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMonitorGroupNotifyPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"B7AF834D-D38B-4A46-920B-FE974EB7E135\\",\\n \\"Result\\": 1,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], 'DeleteMonitoringAgentProcess' => [ - 'summary' => 'Disables monitoring on a process.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Calls the DeleteMonitoringAgentProcess operation to delete the specified process monitoring from a specified host.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'i-KpVny6l****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-KpVny6l****', 'title' => ''], ], [ 'name' => 'ProcessName', 'in' => 'query', - 'schema' => [ - 'description' => 'The process name.'."\n" - ."\n" - .'> You must configure either `ProcessId` or `ProcessName`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http', - ], + 'schema' => ['description' => 'The process name.'."\n" + ."\n" + .'> You must specify either ProcessId or ProcessName.', 'type' => 'string', 'required' => false, 'example' => 'http', 'title' => ''], ], [ 'name' => 'ProcessId', 'in' => 'query', - 'schema' => [ - 'description' => 'The process ID.'."\n" - ."\n" - .'> You must configure either `ProcessId` or `ProcessName`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123****', - ], + 'schema' => ['description' => 'The process ID.'."\n" + ."\n" + .'> You must specify either ProcessId or ProcessName.', 'type' => 'string', 'required' => false, 'example' => '123****', 'title' => ''], ], ], 'responses' => [ @@ -10176,198 +6808,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '971CC023-5A96-452A-BB7C-2483F948BCFD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '971CC023-5A96-452A-BB7C-2483F948BCFD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"971CC023-5A96-452A-BB7C-2483F948BCFD\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteMonitoringAgentProcessResponse>\\n <RequestId>EBB5215C-44AB-4000-A2D7-48634FDC4F04</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteMonitoringAgentProcessResponse>","errorExample":""}]', - 'title' => 'DeleteMonitoringAgentProcess', + 'title' => 'Delete process monitoring from a specified host', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSystemEventHistogram' => [ - 'summary' => 'Queries the number of times a system event occurred during each interval within a period of time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitoringAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteMonitoringAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"971CC023-5A96-452A-BB7C-2483F948BCFD\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteSiteMonitors' => [ + 'summary' => 'Deletes site monitoring tasks by calling the DeleteSiteMonitors operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Product', - 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the service name.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the abbreviations of service names.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], - ], - [ - 'name' => 'EventType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The event type.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the types of system events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Exception', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The event name.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the names of system events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BucketIngressBandwidth', - ], - ], - [ - 'name' => 'Level', - 'in' => 'query', - 'schema' => [ - 'description' => 'The level of the event. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CRITICAL', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The event status.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the status of system events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'normal', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], - ], - [ - 'name' => 'SearchKeywords', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to search for the system event. Valid values:'."\n" - ."\n" - .'* If you want to search for the system event whose content contains a and b, set the value to `a and b`.'."\n" - .'* If you want to search for the system event whose content contains a or b, set the value to `a or b`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cms', - ], - ], - [ - 'name' => 'StartTime', + 'name' => 'TaskIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552209685596', - ], + 'schema' => ['description' => 'The IDs of the tasks to be deleted. Separate multiple task IDs with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '01adacc2-ece5-41b6-afa2-3143ab5d****,43bd1ead-514f-4524-813e-228ce091****', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'IsDeleteAlarms', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552220485596', - ], + 'schema' => ['description' => 'Specifies whether to delete the alert rules associated with the tasks. Valid values:'."\n" + ."\n" + .'- true (default): Deletes the alert rules.'."\n" + ."\n" + .'- false: Does not delete the alert rules.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -10375,690 +6897,895 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'SystemEventHistograms' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. If the request is successful, a success message is returned. If the request fails, the failure reason is returned, such as `TaskId not found`.', 'type' => 'string', 'example' => 'Request succeeded.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '123BCC5D-8B63-48EA-B747-9A8995BE7AA6', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. The value true indicates success. The value false indicates failure.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The number of affected rows.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'SystemEventHistogram' => [ - 'description' => 'The information about the number of times the system event occurred during each interval of a time period.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The end time.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552225753000', - ], - 'StartTime' => [ - 'description' => 'The start time.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552225770000', - ], - 'Count' => [ - 'description' => 'The number of times the system event occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - ], - ], - ], + 'count' => ['description' => 'The number of affected rows.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ['errorCode' => 'UnauthorizedTasks', 'errorMessage' => 'You are not permitted to operate the specified tasks.', 'description' => 'You are not permitted to operate the specified tasks.'], + ], + [ + ['errorCode' => '%s', 'errorMessage' => 'TaskId not found', 'description' => ''], + ['errorCode' => 'TaskNotExist', 'errorMessage' => 'The specified task does not exist.', 'description' => 'The specified task does not exist.'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"486029C9-53E1-44B4-85A8-16A571A043FD\\",\\n \\"Success\\": \\"true\\",\\n \\"SystemEventHistograms\\": {\\n \\"SystemEventHistogram\\": [\\n {\\n \\"EndTime\\": 1552225753000,\\n \\"StartTime\\": 1552225770000,\\n \\"Count\\": 2\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSystemEventHistogram>\\r\\n\\t\\t<RequestId>E38CA81A-A012-4C59-B694-42AAFBE27ED2</RequestId>\\r\\n\\t\\t<SystemEventHistograms>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671700000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671684000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671730000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671700000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671760000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671730000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671790000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671760000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671820000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671790000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671850000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671820000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671880000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671850000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671910000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671880000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671940000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671910000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671970000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671940000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672000000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671970000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672030000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672000000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672060000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672030000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672090000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672060000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672120000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672090000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672150000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672120000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672180000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672150000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672210000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672180000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672240000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672210000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672270000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672240000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672300000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672270000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672330000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672300000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672360000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672330000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672390000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672360000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672420000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672390000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672450000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672420000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672480000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672450000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672510000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672480000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672540000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672510000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672570000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672540000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672584000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672570000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t</SystemEventHistograms>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeSystemEventHistogram>\\r\\n","errorExample":""}]', - 'title' => 'DescribeSystemEventHistogram', + 'staticInfo' => [], + 'title' => 'Delete site monitoring tasks', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSystemEventMetaList' => [ - 'summary' => 'Queries the meta information about system events.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-04-01T07:22:22.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-12-27T07:31:03.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSiteMonitors'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:DeleteSiteMonitors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Request succeeded.\\",\\n \\"RequestId\\": \\"123BCC5D-8B63-48EA-B747-9A8995BE7AA6\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 0\\n }\\n}","type":"json"}]', + ], + 'DescribeActiveMetricRuleList' => [ + 'summary' => 'Queries initiative alert rules.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => ['description' => 'The abbreviation of the cloud service that supports initiative alert rules.'."\n" + ."\n" + .'For more information about how to obtain the name of a cloud service, see [DescribeProductsOfActiveMetricRule](~~114930~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecs', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A6582C8B-E67C-4A19-BC15-EAEFEBDC7995', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'description' => 'The details of the alert rules.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => ['description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'EvaluationCount' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], + 'State' => ['description' => 'Indicates whether the alert rule is enabled.', 'type' => 'string', 'example' => 'Enable', 'title' => ''], + 'ContactGroups' => ['description' => 'The alert contact group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'SystemDefault_acs_rds_dashboard_CpuUsage', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', 'title' => ''], + 'Period' => ['description' => 'The aggregation period of monitoring data.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '60', 'title' => ''], + 'ComparisonOperator' => ['description' => 'The comparison operator that is used in the alert rule. Valid values:'."\n" + ."\n" + .'- `>`'."\n" + ."\n" + .'- `<`'."\n" + ."\n" + .'- `>=`'."\n" + ."\n" + .'- `<=`'."\n" + ."\n" + .'- `=`'."\n" + ."\n" + .'- `=`', 'type' => 'string', 'example' => '>', 'title' => ''], + 'EndTime' => ['description' => 'The end of the time period during which the alert rule is effective.'."\n" + ."\n" + .'Unit: hours. For example, the value 23 indicates `23:59:59`.', 'type' => 'string', 'example' => '24', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time period during which the alert rule is effective.'."\n" + ."\n" + .'Unit: hours. For example, the value 00 indicates `00:00:00`.', 'type' => 'string', 'example' => '00', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" + ."\n" + .'- true: The alert rule is enabled.'."\n" + ."\n" + .'- false: The alert rule is disabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Data' => [ + 'AlertList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Resource' => [ - 'description' => 'The queried meta information.'."\n", + 'Alert' => [ + 'description' => 'The details of the alert rules. The result is in the same structure as that returned by the DescribeMetricRuleList operation.', 'type' => 'array', 'items' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the system event.'."\n", - 'type' => 'string', - 'example' => 'failed', - ], - 'EventType' => [ - 'description' => 'The type of the system event. Valid values:'."\n" - ."\n" - .'* StatusNotification: fault notifications'."\n" - .'* Exception: exceptions'."\n" - .'* Maintenance: O\\&M'."\n", - 'type' => 'string', - 'example' => 'Exception', - ], - 'Product' => [ - 'description' => 'The abbreviation of the service name.'."\n", - 'type' => 'string', - 'example' => 'ADS', - ], - 'NameDesc' => [ - 'description' => 'The description of the event name.'."\n", - 'type' => 'string', - 'example' => 'High query failure rate', - ], - 'NameDesc.En' => [ - 'description' => 'The description of the system event.'."\n", - 'type' => 'string', - 'example' => 'High query failure rate.', - ], - 'Name' => [ - 'description' => 'The name of the system event.'."\n", - 'type' => 'string', - 'example' => 'SelectFailureRate', - ], - 'StatusDesc' => [ - 'description' => 'The description of the event status.'."\n", - 'type' => 'string', - 'example' => 'Operation Failed', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'example' => 'INFO', + 'SilenceTime' => ['description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'MetricName' => ['description' => 'The name of the metric.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL.', 'type' => 'string', 'example' => 'http://www.aliyun.com', 'title' => ''], + 'ContactGroups' => ['description' => 'The alert contact group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The time period during which the alert rule is effective.', 'type' => 'string', 'example' => '00:00-23:59', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'The time period during which the alert rule is ineffective.', 'type' => 'string', 'example' => '00:00-06:00', 'title' => ''], + 'MailSubject' => ['description' => 'The subject of the alert notification email.', 'type' => 'string', 'example' => 'ECS_Bucket', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'myAlert', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'ruleIdxxxx', 'title' => ''], + 'Period' => ['description' => 'The aggregation period of monitoring data.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '60', 'title' => ''], + 'AlertState' => ['description' => 'The status of the alert rule. Valid values:'."\n" + ."\n" + .'- OK: The alert rule has no active alerts.'."\n" + ."\n" + .'- ALARM: The alert rule has active alerts.'."\n" + ."\n" + .'- INSUFFICIENT\\_DATA: No data is found.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Dimensions' => ['description' => 'The monitoring data of the specified resource.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'EnableState' => ['description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" + ."\n" + .'- true: The alert rule is enabled.'."\n" + ."\n" + .'- false: The alert rule is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resources' => ['description' => 'The resources that are associated with the alert rule.', 'type' => 'string', 'example' => '[{"resource":"_ALL"}]', 'title' => ''], + 'Escalations' => [ + 'description' => 'The conditions for triggering different levels of alerts.', + 'type' => 'object', + 'properties' => [ + 'Info' => [ + 'description' => 'The conditions for triggering Info-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', 'type' => 'string', 'example' => 'GreaterThanThreshold', 'title' => ''], + 'Times' => ['description' => 'The consecutive number of times'."\n" + ."\n" + .'for which the metric value meets the alert condition before an Info-level alert is triggered.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Info-level alerts.', 'type' => 'string', 'example' => '95', 'title' => ''], + 'Statistics' => ['description' => 'The statistical methods for Info-level alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Warn' => [ + 'description' => 'The conditions for triggering Warn-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', 'type' => 'string', 'example' => 'GreaterThanThreshold', 'title' => ''], + 'Times' => ['description' => 'The consecutive number of times'."\n" + ."\n" + .'for which the metric value meets the alert condition before a Warn-level alert is triggered.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Warn-level alerts.', 'type' => 'string', 'example' => '80', 'title' => ''], + 'Statistics' => ['description' => 'The statistical methods for Warn-level alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Critical' => [ + 'description' => 'The trigger condition for Critical-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', 'type' => 'string', 'example' => 'GreaterThanThreshold', 'title' => ''], + 'Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Critical-level alerts.', 'type' => 'string', 'example' => '99', 'title' => ''], + 'Statistics' => ['description' => 'The statistical methods for Critical-level alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"A6582C8B-E67C-4A19-BC15-EAEFEBDC7995\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Resource\\": [\\n {\\n \\"Status\\": \\"failed\\",\\n \\"EventType\\": \\"Exception\\",\\n \\"Product\\": \\"ADS\\",\\n \\"NameDesc\\": \\"查询失败率高\\",\\n \\"NameDesc.En\\": \\"High query failure rate.\\",\\n \\"Name\\": \\"SelectFailureRate\\",\\n \\"StatusDesc\\": \\"Operation Failed\\",\\n \\"Level\\": \\"INFO\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSystemEventMetaListResponse>\\r\\n\\t\\t<RequestId>46350DCE-3399-473B-875F-1340DC97186C</RequestId>\\r\\n\\t\\t<Message>success</Message>\\r\\n\\t\\t<Data>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Status>Failed</Status>\\r\\n\\t\\t\\t\\t<StatusDesc>OperationFailed</StatusDesc>\\r\\n\\t\\t\\t\\t<NameDesc>插入失败率10%</NameDesc>\\r\\n\\t\\t\\t\\t<NameDesc.En>InsertFailureRate</NameDesc.En>\\r\\n\\t\\t\\t\\t<EventType>Exception</EventType>\\r\\n\\t\\t\\t\\t<Product>ADS</Product>\\r\\n\\t\\t\\t\\t<Level>CRITICAL</Level>\\r\\n\\t\\t\\t\\t<Name>InsertFailureRate</Name>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Status>Failed</Status>\\r\\n\\t\\t\\t\\t<StatusDesc>OptionFailed</StatusDesc>\\r\\n\\t\\t\\t\\t<NameDesc>查询失败率10%</NameDesc>\\r\\n\\t\\t\\t\\t<NameDesc.En>SelectFailureRate</NameDesc.En>\\r\\n\\t\\t\\t\\t<EventType>Exception</EventType>\\r\\n\\t\\t\\t\\t<Product>ADS</Product>\\r\\n\\t\\t\\t\\t<Level>CRITICAL</Level>\\r\\n\\t\\t\\t\\t<Name>SelectFailureRate</Name>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Status>Failed</Status>\\r\\n\\t\\t\\t\\t<StatusDesc>Operation Failed</StatusDesc>\\r\\n\\t\\t\\t\\t<NameDesc>磁盘使用率80%</NameDesc>\\r\\n\\t\\t\\t\\t<NameDesc.En>StorageUsage</NameDesc.En>\\r\\n\\t\\t\\t\\t<EventType>Maintenance</EventType>\\r\\n\\t\\t\\t\\t<Product>ADS</Product>\\r\\n\\t\\t\\t\\t<Level>CRITICAL</Level>\\r\\n\\t\\t\\t\\t<Name>StorageUsage</Name>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Status>EightyPercentQuotaExceeded</Status>\\r\\n\\t\\t\\t\\t<StatusDesc>超过Quota 80%事件</StatusDesc>\\r\\n\\t\\t\\t\\t<NameDesc>超过Quota 80%事件</NameDesc>\\r\\n\\t\\t\\t\\t<NameDesc.En>EightyPercentQuotaExceeded:Route</NameDesc.En>\\r\\n\\t\\t\\t\\t<EventType>80%QuotaExceeded</EventType>\\r\\n\\t\\t\\t\\t<Product>CEN</Product>\\r\\n\\t\\t\\t\\t<Level>WARN</Level>\\r\\n\\t\\t\\t\\t<Name>EightyPercentQuotaExceeded:Route</Name>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Status>NinetyEightPercentQuotaExceeded</Status>\\r\\n\\t\\t\\t\\t<StatusDesc>超过Quota 98%事件</StatusDesc>\\r\\n\\t\\t\\t\\t<NameDesc>超过Quota 98%事件</NameDesc>\\r\\n\\t\\t\\t\\t<NameDesc.En>NinetyEightPercentQuotaExceeded:Route</NameDesc.En>\\r\\n\\t\\t\\t\\t<EventType>98%QuotaExceeded</EventType>\\r\\n\\t\\t\\t\\t<Product>CEN</Product>\\r\\n\\t\\t\\t\\t<Level>WARN</Level>\\r\\n\\t\\t\\t\\t<Name>NinetyEightPercentQuotaExceeded:Route</Name>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t</Data>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeSystemEventMetaListResponse>","errorExample":""}]', - 'title' => 'DescribeSystemEventMetaList', + 'title' => 'DescribeActiveMetricRuleList', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSystemEventAttribute' => [ - 'summary' => 'Queries the details of a system event.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveMetricRuleList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeActiveMetricRuleList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"F82E6667-7811-4BA0-842F-5B2DC42BBAAD\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": {\\n \\"Alarm\\": [\\n {\\n \\"SilenceTime\\": \\"86400\\",\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EvaluationCount\\": \\"3\\",\\n \\"Webhook\\": \\"https://www.aliyun.com\\",\\n \\"State\\": \\"Enable\\",\\n \\"ContactGroups\\": \\"ECS_Group\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"RuleName\\": \\"SystemDefault_acs_rds_dashboard_CpuUsage\\",\\n \\"RuleId\\": \\"a151cd6023eacee2f0978e03863cc1697c89508****\\",\\n \\"Period\\": \\"60\\",\\n \\"ComparisonOperator\\": \\">\\",\\n \\"EndTime\\": \\"24\\",\\n \\"StartTime\\": \\"00\\",\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Enable\\": \\"true\\"\\n }\\n ]\\n },\\n \\"AlertList\\": {\\n \\"Alert\\": [\\n {\\n \\"SilenceTime\\": \\"86400\\",\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Webhook\\": \\"http://www.aliyun.com\\",\\n \\"ContactGroups\\": \\"ECS_Group\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"EffectiveInterval\\": \\"00:00-23:59\\",\\n \\"NoEffectiveInterval\\": \\"00:00-06:00\\",\\n \\"MailSubject\\": \\"ECS_Bucket\\",\\n \\"RuleName\\": \\"myAlert\\",\\n \\"RuleId\\": \\"ruleIdxxxx\\",\\n \\"Period\\": \\"60\\",\\n \\"AlertState\\": \\"OK\\",\\n \\"Dimensions\\": \\"\\\\\\"\\\\\\"\\",\\n \\"EnableState\\": true,\\n \\"Resources\\": \\"[{\\\\\\"resource\\\\\\":\\\\\\"_ALL\\\\\\"}]\\",\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"95\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"80\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"99\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeAlertHistoryList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Product', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the service name.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the abbreviations of service names.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss', - ], + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => 'applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****', 'title' => ''], ], [ - 'name' => 'EventType', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the system event.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the types of system events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Exception', - ], + 'schema' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'For information about how to query the name of an alert rule, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS_Rule', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the system event.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the names of system events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BucketIngressBandwidth', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For information about how to query the namespace of a cloud service, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'Level', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The level of the system event. Valid values:'."\n" - ."\n" - .'* CRITICAL: critical'."\n" - .'* WARN: warning'."\n" - .'* INFO: information'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CRITICAL', - ], + 'schema' => ['description' => 'The metric that is used to monitor the cloud service.'."\n" + ."\n" + .'For information about how to query the name of a metric, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'example' => '7671****', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the system event.'."\n" - ."\n" - .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the statuses of system events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'normal', - ], + 'schema' => ['description' => 'Specifies whether alerts are muted. Valid values:'."\n" + ."\n" + .'- 2 (default value): Alerts are muted and are not triggered within the mute period, even if the condition specified in the alert rule is met.'."\n" + ."\n" + .'- 0: Alerts are triggered or cleared.'."\n" + ."\n" + .'- 1: The alert rule is ineffective.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'State', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12346', - ], + 'schema' => ['description' => 'The status of the alert. Valid values:'."\n" + ."\n" + .'- ALARM (default value): Alerts are triggered.'."\n" + ."\n" + .'- OK: No alerts are triggered.', 'type' => 'string', 'required' => false, 'example' => 'ALARM', 'title' => ''], ], [ - 'name' => 'SearchKeywords', + 'name' => 'Ascending', 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to search for the system event. Valid values:'."\n" - ."\n" - .'* If you want to search for the system event whose content contains a and b, set the value to `a and b`.'."\n" - .'* If you want to search for the system event whose content contains a or b, set the value to `a or b`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cms', - ], + 'schema' => ['description' => 'The order of alerts. Valid values:'."\n" + ."\n" + .'- true (default value): reverse chronological order'."\n" + ."\n" + .'- false: chronological order', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'The value must be a UNIX timestamp. It is the number of seconds that have elapsed since 00:00:00 UTC, January 1, 1970.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552199984949', - ], + 'schema' => ['description' => 'The start timestamp of the historical alerts that you want to query.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1640237400000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'The value must be a UNIX timestamp. It is the number of seconds that have elapsed since 00:00:00 UTC, January 1, 1970.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552221584949', - ], + 'schema' => ['description' => 'The end timestamp of the historical alerts that you want to query.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1640608200000', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n" - ."\n" - .'Valid values: 1 to 100000000.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Valid values: 1 to 100.'."\n" - ."\n" - .'Default value: 10'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message that is returned. If the call is successful, `success` is returned. If the call fails, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid values: True: The call is successful. false: The call fails.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'SystemEvents' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C3C69FBE-2262-541F-A409-C52F380BAE63', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AlarmHistoryList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'SystemEvent' => [ - 'description' => 'The details of the event.'."\n", + 'AlarmHistory' => [ + 'description' => 'The details of historical alerts.', 'type' => 'array', 'items' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the event.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - 'Time' => [ - 'description' => 'The time when the event occurred. The value is a timestamp.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552199984000', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'Product' => [ - 'description' => 'The abbreviation of the service name.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - 'InstanceName' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'instanceId1', - ], - 'ResourceId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'xxxxx-1', - ], - 'Name' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'example' => 'Agent_Status_Stopped', + 'Status' => ['description' => 'Indicates whether alerts are muted. Valid values:'."\n" + ."\n" + .'- 2 (default): Alerts are muted and are not triggered within the mute period, even if the condition specified in the alert rule is met.'."\n" + ."\n" + .'- 0: Alerts are triggered or cleared.'."\n" + ."\n" + .'- 1: The alert rule is ineffective.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'EvaluationCount' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'State' => ['description' => 'The alert status. Valid values:'."\n" + ."\n" + .'- ALARM: Alerts are triggered.'."\n" + ."\n" + .'- OK: No alerts are triggered.', 'type' => 'string', 'example' => 'ALARM', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'Webhooks' => ['description' => 'The callback URL.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'ECS_Rule', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****', 'title' => ''], + 'LastTime' => ['description' => 'The duration of the alert. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '360133', 'title' => ''], + 'Value' => ['description' => 'The threshold of the metric value to trigger or clear an alert.', 'type' => 'string', 'example' => '10.58', 'title' => ''], + 'Expression' => ['description' => 'The expression that is used to trigger alerts.', 'type' => 'string', 'example' => '$Average>=10', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '7671****', 'title' => ''], + 'AlertTime' => ['description' => 'The timestamp when the alert was triggered. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640586600000', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'i-bp1cqhiw1za2****', 'title' => ''], + 'Dimensions' => ['description' => 'The resources that are monitored.', 'type' => 'string', 'example' => '{\\"instanceId\\":\\"i-bp1cqhiw1za2****\\"}', 'title' => ''], + 'Level' => ['description' => 'The severity level and notification methods of the alert. Valid values:'."\n" + ."\n" + .'- P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: No alert is generated.', 'type' => 'string', 'example' => 'P4', 'title' => ''], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => 'The alert contacts that receive alert notifications.', + 'type' => 'array', + 'items' => ['description' => 'The alert contact that receives alert notifications.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Content' => [ - 'description' => 'The details of the event.'."\n", - 'type' => 'string', - 'example' => '[{"product":"CloudMonitor","content":"{\\"ipGroup\\":\\"112.126.XX.XX,10.163.XX.XX\\",\\"tianjimonVersion\\":\\"1.2.22\\"}","groupId":"176,177,178,179,180,692,120812,1663836,96,2028302","time":"1552209568000","resourceId":"acs:ecs:cn-beijing:173651113438****:instance/i-25k35****","level":"CRITICAL","status":"stopped","instanceName":"cmssiteprobebj-6","name":"Agent_Status_Stopped","regionId":"cn-beijing"}]', + 'ContactALIIMs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactALIIM' => [ + 'description' => 'The TradeManager IDs of the alert contacts.'."\n" + ."\n" + .'> This parameter is valid only on the China site (aliyun.com).', + 'type' => 'array', + 'items' => ['description' => 'The TradeManager ID of the alert contact.'."\n" + ."\n" + .'> This parameter is valid only on the China site (aliyun.com).', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Level' => [ - 'description' => 'The level of the event. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'example' => 'WARN', + 'ContactMails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactMail' => [ + 'description' => 'The email addresses of the alert contacts.', + 'type' => 'array', + 'items' => ['description' => 'The email address of the alert contact.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'ContactSmses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactSms' => [ + 'description' => 'The mobile numbers of the alert contacts.'."\n" + ."\n" + .'> This parameter is valid only on the China site (aliyun.com).', + 'type' => 'array', + 'items' => ['description' => 'The mobile number of the alert contact.'."\n" + ."\n" + .'> This parameter is valid only on the China site (aliyun.com).', 'type' => 'string', 'example' => '13900009999', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'string', - 'example' => 'b936efc9-f621-4e8a-a6eb-076be40e****', + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => 'The alert contact groups.', + 'type' => 'array', + 'items' => ['description' => 'The alert contact group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Parameter invalid.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError ', 'errorMessage' => 'The request processing has failed due to some unknown error. ', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"60912C8D-B340-4253-ADE7-61ACDFD25CFC\\",\\n \\"Success\\": \\"true\\",\\n \\"SystemEvents\\": {\\n \\"SystemEvent\\": [\\n {\\n \\"Status\\": \\"normal\\",\\n \\"Time\\": 1552199984000,\\n \\"GroupId\\": \\"12345\\",\\n \\"Product\\": \\"CloudMonitor\\",\\n \\"InstanceName\\": \\"instanceId1\\",\\n \\"ResourceId\\": \\"xxxxx-1\\",\\n \\"Name\\": \\"Agent_Status_Stopped\\",\\n \\"Content\\": \\"[{\\\\\\"product\\\\\\":\\\\\\"CloudMonitor\\\\\\",\\\\\\"content\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"ipGroup\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"112.126.XX.XX,10.163.XX.XX\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tianjimonVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.2.22\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"groupId\\\\\\":\\\\\\"176,177,178,179,180,692,120812,1663836,96,2028302\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1552209568000\\\\\\",\\\\\\"resourceId\\\\\\":\\\\\\"acs:ecs:cn-beijing:173651113438****:instance/i-25k35****\\\\\\",\\\\\\"level\\\\\\":\\\\\\"CRITICAL\\\\\\",\\\\\\"status\\\\\\":\\\\\\"stopped\\\\\\",\\\\\\"instanceName\\\\\\":\\\\\\"cmssiteprobebj-6\\\\\\",\\\\\\"name\\\\\\":\\\\\\"Agent_Status_Stopped\\\\\\",\\\\\\"regionId\\\\\\":\\\\\\"cn-beijing\\\\\\"}]\\",\\n \\"Level\\": \\"WARN\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Id\\": \\"b936efc9-f621-4e8a-a6eb-076be40e****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSystemEventAttribute>\\r\\n\\t\\t<SystemEvents>\\r\\n\\t\\t\\t<SystemEvent>\\r\\n\\t\\t\\t\\t<Status>normal</Status>\\r\\n\\t\\t\\t\\t<InstanceName>instanceId1</InstanceName>\\r\\n\\t\\t\\t\\t<ResourceId>xxxxx-1</ResourceId>\\r\\n\\t\\t\\t\\t<Content>[{\\\\\\"product\\\\\\":\\\\\\"CloudMonitor\\\\\\",\\\\\\"content\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"ipGroup\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"112.126.XX.XX,10.163.XX.XX\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tianjimonVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.2.22\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"groupId\\\\\\":\\\\\\"176,177,178,179,180,692,120812,1663836,96,2028302\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1552209568000\\\\\\",\\\\\\"resourceId\\\\\\":\\\\\\"acs:ecs:cn-beijing:173651113438****:instance/i-25k35****\\\\\\",\\\\\\"level\\\\\\":\\\\\\"CRITICAL\\\\\\",\\\\\\"status\\\\\\":\\\\\\"stopped\\\\\\",\\\\\\"instanceName\\\\\\":\\\\\\"cmssiteprobebj-6\\\\\\",\\\\\\"name\\\\\\":\\\\\\"Agent_Status_Stopped\\\\\\",\\\\\\"regionId\\\\\\":\\\\\\"cn-beijing\\\\\\"}]</Content>\\r\\n\\t\\t\\t\\t<Product>CloudMonitor</Product>\\r\\n\\t\\t\\t\\t<Level>WARN</Level>\\r\\n\\t\\t\\t\\t<Time>1552199984000</Time>\\r\\n\\t\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t\\t<Name>Agent_Status_Stopped</Name>\\r\\n\\t\\t\\t\\t<GroupId>12345</GroupId>\\r\\n\\t\\t\\t</SystemEvent>\\r\\n\\t\\t</SystemEvents>\\r\\n\\t\\t<Message>success</Message>\\r\\n\\t\\t<RequestId>60912C8D-B340-4253-ADE7-61ACDFD25CFC</RequestId>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeSystemEventAttribute>","errorExample":""}]', - 'title' => 'DescribeSystemEventAttribute', - 'requestParamsDescription' => ' ', + 'staticInfo' => [ + 'substitutions' => ['Cms::2019-01-01::DescribeAlertLogList'], + ], + 'title' => 'DescribeAlertHistoryList', + 'summary' => 'Queries historical alerts.', + 'description' => 'This API operation is no longer maintained. We recommend that you call the [DescribeAlertLogList](~~201087~~) operation.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSystemEventCount' => [ - 'summary' => 'Queries the number of times that a system event of a cloud service has occurred.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertHistoryList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeAlertHistoryList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"C3C69FBE-2262-541F-A409-C52F380BAE63\\",\\n \\"Total\\": \\"2\\",\\n \\"Success\\": true,\\n \\"AlarmHistoryList\\": {\\n \\"AlarmHistory\\": [\\n {\\n \\"Status\\": 2,\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EvaluationCount\\": 3,\\n \\"State\\": \\"ALARM\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Webhooks\\": \\"https://www.aliyun.com\\",\\n \\"RuleName\\": \\"ECS_Rule\\",\\n \\"RuleId\\": \\"applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****\\",\\n \\"LastTime\\": 360133,\\n \\"Value\\": \\"10.58\\",\\n \\"Expression\\": \\"$Average>=10\\",\\n \\"GroupId\\": \\"7671****\\",\\n \\"AlertTime\\": 1640586600000,\\n \\"InstanceName\\": \\"i-bp1cqhiw1za2****\\",\\n \\"Dimensions\\": \\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp1cqhiw1za2****\\\\\\\\\\\\\\"}\\",\\n \\"Level\\": \\"P4\\",\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n \\"Alice\\"\\n ]\\n },\\n \\"ContactALIIMs\\": {\\n \\"ContactALIIM\\": [\\n \\"username@example.com\\"\\n ]\\n },\\n \\"ContactMails\\": {\\n \\"ContactMail\\": [\\n \\"username@example.com\\"\\n ]\\n },\\n \\"ContactSmses\\": {\\n \\"ContactSms\\": [\\n \\"13900009999\\"\\n ]\\n },\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"ECS_Group\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeAlertLogCount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Product', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud service.'."\n" - ."\n" - .'You can call the DescribeSystemEventMetaList operation to obtain the value of the response parameter `Product`. The value of the Product parameter indicates the names of all cloud services in which the system events of your Alibaba Cloud account occurred. For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], + 'schema' => ['description' => 'The start timestamp of the alert logs to be queried.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'You can query only the alert logs within the last year. If the query time is longer than one year, the return value of the `AlertLogCount` parameter is empty.'."\n" + ."\n" + .'> The interval between the start time (StartTime) and end time (EndTime) must be less than or equal to 15 days. The start time and end time must be specified or left empty at the same time. If you do not specify the start time and end time, the alert logs within the last 15 minutes are queried by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1609988009694', 'title' => ''], ], [ - 'name' => 'EventType', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the system event.'."\n" - ."\n" - .'You can call the DescribeSystemEventMetaList operation to obtain the value of the response parameter `EventType`. The value of the EventType parameter indicates the types of system events that occurred for all cloud services in your Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'StatusNotification', - ], + 'schema' => ['description' => 'The end timestamp of the alert logs to be queried.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'You can query only the alert logs within the last year. If the query time is longer than one year, the return value of the `AlertLogCount` parameter is empty.'."\n" + ."\n" + .'> The interval between the start time (StartTime) and end time (EndTime) must be less than or equal to 15 days. The start time and end time must be specified or left empty at the same time. If you do not specify the start time and end time, the alert logs within the last 15 minutes are queried by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1610074409694', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the system event.'."\n" - ."\n" - .'You can call the DescribeSystemEventMetaList operation to obtain the value of the response parameter `Name`. The value of the Name parameter indicates the names of system events that occurred for all cloud services in your Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Instance:StateChange', - ], + 'schema' => ['description' => 'The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL. Valid values:'."\n" + ."\n" + .'- `product`: aggregates data by cloud service.'."\n" + ."\n" + .'- `level`: aggregates data by alert level.'."\n" + ."\n" + .'- `groupId`: aggregates data by application group.'."\n" + ."\n" + .'- `contactGroup`: aggregates data by alert contact group.'."\n" + ."\n" + .'- `product,metricName`: aggregates data both by cloud service and by metric.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Level', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The level of the system event. Valid values:'."\n" - ."\n" - .'* Critical'."\n" - .'* Warn'."\n" - .'* Info'."\n" - ."\n" - .'You can call the DescribeSystemEventMetaList operation to obtain the value of the response parameter `Level`. The value of the Level parameter indicates the levels of system events that occurred for all cloud services in your Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Info', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'SearchKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the system event.'."\n" - ."\n" - .'You can call the DescribeSystemEventMetaList operation to obtain the value of the response parameter `Status`. The value of the Status parameter indicates the status of system events that occurred for all cloud services in your Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], + 'schema' => ['description' => 'The keyword based on which the alert logs to be counted are searched.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'> For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '17285****', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '7301****', 'title' => ''], ], [ - 'name' => 'SearchKeywords', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to search for the system event. Valid values:'."\n" - ."\n" - .'* If you want to search for the system event whose content contains a and b, set the value to `a and b`.'."\n" - .'* If you want to search for the system event whose content contains a or b, set the value to `a or b`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], + 'schema' => ['description' => 'The abbreviation of the service name.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Level', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1635993541000', - ], + 'schema' => ['description' => 'The level and notification method of the alert. Valid values:'."\n" + ."\n" + .'- P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: No alert is generated.', 'type' => 'string', 'required' => false, 'example' => 'P4', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'SendStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1635993921000', - ], + 'schema' => ['description' => 'The status of the alert. Valid values:'."\n" + ."\n" + .'- 0: The alert is triggered or cleared.'."\n" + ."\n" + .'- 1: The alert is generated not during the effective period.'."\n" + ."\n" + .'- 2: The alert is muted and not triggered in a specified period.'."\n" + ."\n" + .'- 3: The host is restarting.'."\n" + ."\n" + .'- 4: Notifications are not sent for the alert.'."\n" + ."\n" + .'When the value of the SendStatus parameter is 0, the value P4 of the Level parameter indicates a triggered alert and the value OK indicates a cleared alert.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ContactGroup', + 'in' => 'query', + 'schema' => ['description' => 'The alert group.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Group', 'title' => ''], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metric.'."\n" + ."\n" + .'> For more information about the metrics of different cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + ], + [ + 'name' => 'LastMin', + 'in' => 'query', + 'schema' => ['description' => 'The statistical period of alert logs. Unit: minutes.', 'type' => 'string', 'required' => false, 'example' => '360', 'title' => ''], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => ['description' => 'The dimension based on which data is aggregated. This parameter is similar to the Group By clause of SQL statements. Valid values:'."\n" + ."\n" + .'- `product`: aggregates data by cloud service.'."\n" + ."\n" + .'- `level`: aggregates data by alert level.'."\n" + ."\n" + .'- `groupId`: aggregates data by application group.'."\n" + ."\n" + .'- `contactGroup`: aggregates data by alert group.'."\n" + ."\n" + .'- `product,metricName`: aggregates data both by cloud service and by metric.', 'type' => 'string', 'required' => true, 'example' => 'product', 'title' => ''], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the alert event. Valid values:'."\n" + ."\n" + .'- TRIGGERED: The alert is triggered.'."\n" + ."\n" + .'- RESOLVED: The alert is resolved.', 'type' => 'string', 'required' => false, 'example' => 'TRIGGERED', 'title' => ''], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'For more information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => 'bfae2ca5b4e07d2c7278772e***********', 'title' => ''], ], ], 'responses' => [ @@ -11066,1107 +7793,1226 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status codes.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C7A7B776-0ACE-5A93-9B07-DE8008D9CCDF', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'SystemEventCounts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SystemEventCount' => [ - 'description' => 'The details of the system event.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the system event.'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Time' => [ - 'description' => 'The time when the system event occurred. The value is a timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1635993751000', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '17285****', - ], - 'Product' => [ - 'description' => 'The name of the cloud service in which the system event occurred.'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], - 'InstanceName' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'ECS-test', - ], - 'Num' => [ - 'description' => 'The number of times that the system event has occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'ResourceId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'i-rj99xc6cptkk64ml****', - ], - 'Name' => [ - 'description' => 'The name of the system event.'."\n", - 'type' => 'string', - 'example' => 'Instance:StateChange', - ], - 'Content' => [ - 'description' => 'The description of the system event.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Level' => [ - 'description' => 'The level of the system event. Valid values:'."\n" - ."\n" - .'* Critical'."\n" - .'* Warn'."\n" - .'* Info'."\n", - 'type' => 'string', - 'example' => 'Info', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AlertLogCount' => [ + 'description' => 'The statistics of alert logs.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => ['description' => 'The number of alert logs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Logs' => [ + 'description' => 'The details about alert logs.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the dimension field based on which alert logs are aggregated.', 'type' => 'string', 'example' => 'product', 'title' => ''], + 'Value' => ['description' => 'The value of the dimension field based on which alert logs are aggregated.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"C7A7B776-0ACE-5A93-9B07-DE8008D9CCDF\\",\\n \\"Success\\": \\"true\\",\\n \\"SystemEventCounts\\": {\\n \\"SystemEventCount\\": [\\n {\\n \\"Status\\": \\"Normal\\",\\n \\"Time\\": 1635993751000,\\n \\"GroupId\\": \\"17285****\\",\\n \\"Product\\": \\"ECS\\",\\n \\"InstanceName\\": \\"ECS-test\\",\\n \\"Num\\": 3,\\n \\"ResourceId\\": \\"i-rj99xc6cptkk64ml****\\",\\n \\"Name\\": \\"Instance:StateChange\\",\\n \\"Content\\": \\"实例状态改变通知\\",\\n \\"Level\\": \\"Info\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSystemEventCountResponse>\\r\\n\\t<Message>success</Message>\\r\\n\\t<RequestId>C7A7B776-0ACE-5A93-9B07-DE8008D9CCDF</RequestId>\\r\\n\\t<SystemEventCounts>\\r\\n\\t\\t<SystemEventCount>\\r\\n\\t\\t\\t<Num>3</Num>\\r\\n\\t\\t\\t<Product>ECS</Product>\\r\\n\\t\\t\\t<Time>1635993751000</Time>\\r\\n\\t\\t\\t<Name>Instance:StateChange</Name>\\r\\n\\t\\t</SystemEventCount>\\r\\n\\t</SystemEventCounts>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeSystemEventCountResponse>\\t","errorExample":""}]', - 'title' => 'DescribeSystemEventCount', - 'description' => '### [](#)Background information'."\n" - ."\n" - .'You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the cloud services supported by CloudMonitor and their system events.'."\n" - ."\n" - .'### [](#)Description'."\n" + 'title' => 'DescribeAlertLogCount', + 'summary' => 'Queries the statistics of alert logs.', + 'description' => 'Queries the statistics of alert logs.'."\n" ."\n" - .'This topic provides an example on how to query the number of times that a system event of `Elastic Compute Service (ECS)` has occurred. The returned result shows that the specified system event has occurred three times.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + .'This topic provides an example on how to query the statistics of alert logs for Elastic Compute Service (ECS) based on the `product` dimension.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMonitorResourceQuotaAttribute' => [ - 'summary' => 'Queries the resource quotas of CloudMonitor.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-12-07T03:28:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-27T09:48:52.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertLogCount'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeAlertLogCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"1C4A3709-BF52-42EE-87B5-7435F0929585\\",\\n \\"Success\\": true,\\n \\"AlertLogCount\\": [\\n {\\n \\"Count\\": 1,\\n \\"Logs\\": [\\n {\\n \\"Name\\": \\"product\\",\\n \\"Value\\": \\"ECS\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAlertLogHistogram' => [ + 'summary' => 'Queries the number of alert logs that are generated during each interval within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ShowUsed', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return information about used quotas. Valid values:'."\n" - ."\n" - .'* true (default): yes'."\n" - .'* false: no'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => 'The start timestamp of the alert logs to be queried.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- You can query only the alert logs within the last year.'."\n" + ."\n" + .'- The interval between the start time (`StartTime`) and end time (`EndTime`) must be less than or equal to 15 days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1609988009694', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end timestamp of the alert logs to be queried.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- You can query only the alert logs within the last year.'."\n" + ."\n" + .'- The interval between the start time (`StartTime`) and end time (`EndTime`) must be less than or equal to 15 days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1609989009694', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => ['description' => 'The keyword that is used to query alert logs.', 'type' => 'string', 'required' => false, 'example' => 'alert', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '7301****', 'title' => ''], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => ['description' => 'The abbreviation of the Alibaba Cloud service name.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'> For more information about the namespaces of different cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => 'The severity level and notification methods of the alert. Valid values:'."\n" + ."\n" + .'- P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" + ."\n" + .'- OK: No alert is generated.', 'type' => 'string', 'required' => false, 'example' => 'P4', 'title' => ''], + ], + [ + 'name' => 'SendStatus', + 'in' => 'query', + 'schema' => ['description' => 'The alert status. Valid values:'."\n" + ."\n" + .'- 0: The alert is triggered or cleared.'."\n" + ."\n" + .'- 1: The alert is ineffective.'."\n" + ."\n" + .'- 2: The alert is muted and not triggered in a specified period.'."\n" + ."\n" + .'- 3: The host is restarting.'."\n" + ."\n" + .'- 4: No alert notification is sent.'."\n" + ."\n" + .'If the value of the SendStatus parameter is 0, the value P4 of the Level parameter indicates a triggered alert and the value OK indicates a cleared alert.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ContactGroup', + 'in' => 'query', + 'schema' => ['description' => 'The alert contact group.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Group', 'title' => ''], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The metric name.'."\n" + ."\n" + .'> For more information about the metrics of different cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + ], + [ + 'name' => 'LastMin', + 'in' => 'query', + 'schema' => ['description' => 'The statistical period of alert logs. Unit: minutes.', 'type' => 'string', 'required' => false, 'example' => '360', 'title' => ''], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => ['description' => 'The dimensions based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL. Valid values:'."\n" + ."\n" + .'- `product`: aggregates data by cloud service.'."\n" + ."\n" + .'- `level`: aggregates data by alert level.'."\n" + ."\n" + .'- `groupId`: aggregates data by application group.'."\n" + ."\n" + .'- `contactGroup`: aggregates data by alert contact group.'."\n" + ."\n" + .'- `product,metricName`: aggregates data both by cloud service and by metric.', 'type' => 'string', 'required' => false, 'example' => 'product', 'title' => ''], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the alert event. Valid values:'."\n" + ."\n" + .'- TRIGGERED: The alert is triggered.'."\n" + ."\n" + .'- RESOLVED: The alert is resolved.', 'type' => 'string', 'required' => false, 'example' => 'RESOLVED', 'title' => ''], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'For more information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => 'ae06917_75a8c43178ab66****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '31BC7201-00F2-47B2-B7B9-6A173076ACE', - ], - 'ResourceQuota' => [ - 'description' => 'The details about the resource quotas of CloudMonitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'SuitInfo' => [ - 'description' => 'The current edition of CloudMonitor. Valid values:'."\n" + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AlertLogHistogramList' => [ + 'description' => 'The number of alert logs that were generated during each interval of a time period.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'From' => ['description' => 'The start timestamp of the queried alert logs.'."\n" ."\n" - .'* free: Free Edition'."\n" - .'* pro: Pro Edition'."\n" - .'* cms_post: pay-as-you-go'."\n", - 'type' => 'string', - 'example' => 'pro', - ], - 'InstanceId' => [ - 'description' => 'The ID of the resource plan.'."\n", - 'type' => 'string', - 'example' => 'cms_edition-cn-n6w20rn****', - ], - 'ExpireTime' => [ - 'description' => 'The time when the resource plan expires.'."\n", - 'type' => 'string', - 'example' => '2021-02-28', - ], - 'SiteMonitorEcsProbe' => [ - 'description' => 'The details about the quota of ECS detection points for site monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of ECS detection points for site monitoring.'."\n" - ."\n" - .'> The value indicates the maximum number of ECS detection points that you can select for a site monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of ECS detection points for site monitoring in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of ECS detection points for site monitoring in your resource plan.'."\n" - ."\n" - .'> The value indicates the total number of ECS detection points that are used by existing site monitoring tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - 'SiteMonitorOperatorProbe' => [ - 'description' => 'The details about the quota of carrier detection points for site monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of carrier detection points for site monitoring.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of carrier detection points for site monitoring in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of carrier detection points for site monitoring in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - 'SiteMonitorTask' => [ - 'description' => 'The quota of site monitoring tasks.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of site monitoring tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of site monitoring tasks in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of site monitoring tasks in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - ], - ], - 'SiteMonitorBrowser' => [ - 'description' => 'The quota of browser detection tasks.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of browser detection tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of browser detection tasks in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of browser detection tasks in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - ], - ], - 'SiteMonitorMobile' => [ - 'description' => 'The quota of mobile detection tasks.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of mobile detection tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of mobile detection tasks in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of mobile detection tasks in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - ], - ], - 'CustomMonitor' => [ - 'description' => 'The details about the quota for custom monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of the time series for custom monitoring.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1200', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of the time series for custom monitoring in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of the time series for custom monitoring in your resource plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - ], - ], - 'EventMonitor' => [ - 'description' => 'The details about the quota for event monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of events that can be reported in event monitoring. The total quota is the value that is multiplied by 10,000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '55', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of events that can be reported in event monitoring in your resource plan. The total quota is the value that is multiplied by 10,000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of events that can be reported in event monitoring in your resource plan. The total quota is the value that is multiplied by 10,000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - 'LogMonitor' => [ - 'description' => 'The details about the quota for log monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of processed log data in log monitoring. Unit: MB/min.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '150', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of processed log data in log monitoring in your resource plan. Unit: MB/min.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '150', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of processed log data in log monitoring in your resource plan. Unit: MB/min.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - ], - ], - 'Api' => [ - 'description' => 'The details about the quota of API calls.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of API calls. Unit: 10,000 calls.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of API calls in your resource plan. Unit: 10,000 calls.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of API calls in your resource plan. Unit: calls.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9987', - ], - ], - ], - 'SMS' => [ - 'description' => 'The details about the quota of alert text messages.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of alert text messages. Unit: messages.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '550', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of alert text messages in your resource plan. Unit: messages.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of alert text messages in your resource plan. Unit: messages.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '38', - ], - ], - ], - 'Phone' => [ - 'description' => 'The details about the quota of alert phone calls.'."\n", - 'type' => 'object', - 'properties' => [ - 'QuotaLimit' => [ - 'description' => 'The total quota of alert phone calls. Unit: calls.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '550', - ], - 'QuotaPackage' => [ - 'description' => 'The quota of alert phone calls in your resource plan. Unit: calls.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'QuotaUsed' => [ - 'description' => 'The used quota of alert phone calls in your resource plan. Unit: calls.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - ], - ], - 'EnterpriseQuota' => [ - 'description' => 'The details about the quota of Hybrid Cloud Monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'SuitInfo' => [ - 'description' => 'The description of Hybrid Cloud Monitoring.'."\n", - 'type' => 'string', - 'example' => 'ENTERPRISE', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance monitored by Hybrid Cloud Monitoring.'."\n", - 'type' => 'string', - 'example' => 'cms_enterprise_public_cn-7mz27pd****', - ], - ], + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1610074791', 'title' => ''], + 'To' => ['description' => 'The end timestamp of the queried alert logs.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1610074800', 'title' => ''], + 'Count' => ['description' => 'The number of alert logs.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"31BC7201-00F2-47B2-B7B9-6A173076ACE\\",\\n \\"ResourceQuota\\": {\\n \\"SuitInfo\\": \\"pro\\",\\n \\"InstanceId\\": \\"cms_edition-cn-n6w20rn****\\",\\n \\"ExpireTime\\": \\"2021-02-28\\",\\n \\"SiteMonitorEcsProbe\\": {\\n \\"QuotaLimit\\": 5,\\n \\"QuotaPackage\\": 5,\\n \\"QuotaUsed\\": 20\\n },\\n \\"SiteMonitorOperatorProbe\\": {\\n \\"QuotaLimit\\": 5,\\n \\"QuotaPackage\\": 5,\\n \\"QuotaUsed\\": 0\\n },\\n \\"SiteMonitorTask\\": {\\n \\"QuotaLimit\\": 25,\\n \\"QuotaPackage\\": 20,\\n \\"QuotaUsed\\": 15\\n },\\n \\"SiteMonitorBrowser\\": {\\n \\"QuotaLimit\\": 50,\\n \\"QuotaPackage\\": 50,\\n \\"QuotaUsed\\": 15\\n },\\n \\"SiteMonitorMobile\\": {\\n \\"QuotaLimit\\": 50,\\n \\"QuotaPackage\\": 50,\\n \\"QuotaUsed\\": 15\\n },\\n \\"CustomMonitor\\": {\\n \\"QuotaLimit\\": 1200,\\n \\"QuotaPackage\\": 1000,\\n \\"QuotaUsed\\": 8\\n },\\n \\"EventMonitor\\": {\\n \\"QuotaLimit\\": 55,\\n \\"QuotaPackage\\": 50,\\n \\"QuotaUsed\\": 2\\n },\\n \\"LogMonitor\\": {\\n \\"QuotaLimit\\": 150,\\n \\"QuotaPackage\\": 150,\\n \\"QuotaUsed\\": 80\\n },\\n \\"Api\\": {\\n \\"QuotaLimit\\": 500,\\n \\"QuotaPackage\\": 500,\\n \\"QuotaUsed\\": 9987\\n },\\n \\"SMS\\": {\\n \\"QuotaLimit\\": 550,\\n \\"QuotaPackage\\": 500,\\n \\"QuotaUsed\\": 38\\n },\\n \\"Phone\\": {\\n \\"QuotaLimit\\": 550,\\n \\"QuotaPackage\\": 500,\\n \\"QuotaUsed\\": 100\\n },\\n \\"EnterpriseQuota\\": {\\n \\"SuitInfo\\": \\"ENTERPRISE\\",\\n \\"InstanceId\\": \\"cms_enterprise_public_cn-7mz27pd****\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitorResourceQuotaAttributeResponse>\\r\\n\\t<RequestId>1E1961C4-B340-45D7-8CC3-F7D0BF19F2E0</RequestId>\\r\\n\\t<ResourceQuota>\\r\\n\\t\\t<SiteMonitorOperatorProbe>\\r\\n\\t\\t\\t<QuotaUsed>0</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>5</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>5</QuotaLimit>\\r\\n\\t\\t</SiteMonitorOperatorProbe>\\r\\n\\t\\t<InstanceId>cms_edition-cn-n6w20rn****</InstanceId>\\r\\n\\t\\t<Phone>\\r\\n\\t\\t\\t<QuotaUsed>100</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>500</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>550</QuotaLimit>\\r\\n\\t\\t</Phone>\\r\\n\\t\\t<SuitInfo>pro</SuitInfo>\\r\\n\\t\\t<SiteMonitorTask>\\r\\n\\t\\t\\t<QuotaUsed>7</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>20</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>20</QuotaLimit>\\r\\n\\t\\t</SiteMonitorTask>\\r\\n\\t\\t<SMS>\\r\\n\\t\\t\\t<QuotaUsed>38</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>500</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>550</QuotaLimit>\\r\\n\\t\\t</SMS>\\r\\n\\t\\t<LogMonitor>\\r\\n\\t\\t\\t<QuotaUsed>0</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>50</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>50</QuotaLimit>\\r\\n\\t\\t</LogMonitor>\\r\\n\\t\\t<Api>\\r\\n\\t\\t\\t<QuotaUsed>9987</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>500</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>500</QuotaLimit>\\r\\n\\t\\t</Api>\\r\\n\\t\\t<ExpireTime>2021-02-28</ExpireTime>\\r\\n\\t\\t<SiteMonitorEcsProbe>\\r\\n\\t\\t\\t<QuotaUsed>20</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>5</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>5</QuotaLimit>\\r\\n\\t\\t</SiteMonitorEcsProbe>\\r\\n\\t\\t<CustomMonitor>\\r\\n\\t\\t\\t<QuotaUsed>8</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>1000</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>1200</QuotaLimit>\\r\\n\\t\\t</CustomMonitor>\\r\\n\\t\\t<EventMonitor>\\r\\n\\t\\t\\t<QuotaUsed>2</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>50</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>55</QuotaLimit>\\r\\n\\t\\t</EventMonitor>\\r\\n\\t</ResourceQuota>\\r\\n\\t<Code>200</Code>\\r\\n</DescribeMonitorResourceQuotaAttributeResponse>\\t","errorExample":""}]', - 'title' => 'DescribeMonitorResourceQuotaAttribute', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeAlertLogHistogram', + 'description' => 'This topic provides an example on how to query the number of alert logs for Elastic Compute Service (ECS) based on the `product` dimension.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SendDryRunSystemEvent' => [ - 'summary' => 'Debugs a system event of an Alibaba Cloud service.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-12-07T03:28:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-27T09:48:52.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertLogHistogram'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeAlertLogHistogram', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"1C4A3709-BF52-42EE-87B5-7435F0929585\\",\\n \\"Success\\": true,\\n \\"AlertLogHistogramList\\": [\\n {\\n \\"From\\": 1610074791,\\n \\"To\\": 1610074800,\\n \\"Count\\": 20\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAlertLogList' => [ + 'summary' => 'Queries the alert history by calling the DescribeAlertLogList operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Product', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud service.'."\n" - ."\n" - .'> For information about the Alibaba Cloud services that are supported by CloudMonitor, see [Supported cloud services and their system events](~~167388~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The beginning of the time range to query the alert history.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'You can query only the alert history within the last year. If the query time range exceeds one year, the return value of the `AlertLogList` parameter is empty.'."\n" + ."\n" + .'> The interval between the start time (`StartTime`) and end time (`EndTime`) must be less than or equal to 15 days. Both parameters must be specified or unspecified at the same time. If they are not specified, the alert history within the last 15 minutes is queried by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1609988009694', 'title' => ''], ], [ - 'name' => 'EventName', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the system event.'."\n" - ."\n" - .'> For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Agent_Status_Stopped', - ], + 'schema' => ['description' => 'The end of the time range to query the alert history.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'You can query only the alert history within the last year. If the query time range exceeds one year, the return value of the `AlertLogList` parameter is empty.'."\n" + ."\n" + .'> The interval between the start time (`StartTime`) and end time (`EndTime`) must be less than or equal to 15 days. Both parameters must be specified or unspecified at the same time. If they are not specified, the alert history within the last 15 minutes is queried by default.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1610074409694', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'EventContent', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the system event.'."\n" - ."\n" - .'> The value of this parameter is a JSON object. We recommend that you include the `product`, `resourceId`, and `regionId` fields in the JSON object.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"product":"CloudMonitor","resourceId":"acs:ecs:cn-hongkong:173651113438****:instance/{instanceId}","level":"CRITICAL","instanceName":"instanceName","regionId":"cn-hangzhou","name":"Agent_Status_Stopped","content":{"ipGroup":"0.0.0.0,0.0.0.1","tianjimonVersion":"1.2.11"},"status":"stopped"}', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - ], - 'description' => '', - ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => ['description' => 'The keyword used to query the alert history.', 'type' => 'string', 'required' => false, 'example' => 'alert', 'title' => ''], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '7301****', 'title' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'> For more information about the namespaces of cloud services, see [Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + 'name' => 'Product', + 'in' => 'query', + 'schema' => ['description' => 'The abbreviation of the cloud service name.'."\n" + ."\n" + .'For more information about how to obtain the abbreviation of a cloud service name, see [DescribeProductsOfActiveMetricRule](~~114930~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => 'The alert level and notification methods. Valid values:'."\n" + ."\n" + .'<props="china">- P2: phone calls, text messages, emails, and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="china">- P3: text messages, emails, and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="china">- P4: emails and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="china">- OK: no alerts.</props>'."\n" + ."\n" + .'<props="intl">- P4: emails and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="intl">- OK: no alerts.</props>'."\n" + ."\n" + .'<props="partner">- P4: emails and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="partner">- OK: no alerts.</props>', 'type' => 'string', 'required' => false, 'example' => 'P4', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"486029C9-53E1-44B4-85A8-16A571A043FD\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<SendDryRunSystemEventResponse>\\r\\n\\t<Message>success</Message>\\r\\n\\t<RequestId>590FB642-5FFE-4AE0-883B-E1323DD20541</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</SendDryRunSystemEventResponse>\\t","errorExample":""}]', - 'title' => 'SendDryRunSystemEvent', - 'description' => 'This operation is used to test whether a system event can be triggered as expected. You can call this operation to simulate a system event and check whether an expected response is returned after the system event triggers an alert.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeCustomEventCount' => [ - 'summary' => 'Queries the number of times that a custom event occurred within a period of time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'SendStatus', + 'in' => 'query', + 'schema' => ['description' => 'The alert status. Valid values:'."\n" + .'- 0: An alert is triggered or cleared.'."\n" + .'- 1: The current time is not within the effective period of the alert.'."\n" + .'- 2: The current time is within the channel silence period.'."\n" + .'- 3: The host is being restarted.'."\n" + .'- 4: No alerts are sent.'."\n" + ."\n" + .'<props="china">When the alert status is 0, an alert is triggered if Level is set to P2, P3, or P4; the alert is cleared if Level is set to OK.</props>'."\n" + .'<props="intl">When the alert status is 0, an alert is triggered if Level is set to P4; the alert is cleared if Level is set to OK.</props>'."\n" + .'<props="partner">When the alert status is 0, an alert is triggered if Level is set to P4; the alert is cleared if Level is set to OK.</props>', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'ContactGroup', 'in' => 'query', - 'schema' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BABEL_BUY', - ], + 'schema' => ['description' => 'The alert contact group.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Group', 'title' => ''], ], [ - 'name' => 'EventId', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'The name of the metric.'."\n" + ."\n" + .'>For more information about the metrics of cloud services, see [Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'IntranetInRate', 'title' => ''], ], [ - 'name' => 'SearchKeywords', + 'name' => 'LastMin', 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to search for the event.'."\n" - ."\n" - .'* If you need to query the custom event whose content contains a and b, set the value to a and b.'."\n" - .'* If you need to query the custom event whose content contains a or b, set the value to a or b.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cms', - ], + 'schema' => ['description' => 'The interval at which logs are obtained. Unit: minutes.', 'type' => 'string', 'required' => false, 'example' => '360', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'GroupBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552209685596', - ], + 'schema' => ['description' => 'The spatial dimension by which the data is aggregated, which is equivalent to Group By in SQL. Valid values:'."\n" + .'- `product`: aggregates data by cloud service.'."\n" + .'- `level`: aggregates data by alert level.'."\n" + .'- `groupId`: aggregates data by application group.'."\n" + .'- `contactGroup`: aggregates data by alert contact group.'."\n" + .'- `product,metricName`: aggregates data by cloud service and metric. ', 'type' => 'string', 'required' => false, 'example' => 'product', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552220485596', - ], + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'For more information about how to query the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'bc369e8_30f87e517ed2fc****', 'title' => ''], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the alert rule. Valid value: METRIC, which indicates a time series metric alert rule.', 'type' => 'string', 'required' => false, 'example' => 'METRIC', 'title' => ''], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => ['description' => 'The alert type. Valid values:'."\n" + ."\n" + .'- TRIGGERED: The alert is triggered.'."\n" + ."\n" + .'- RESOLVED: The alert is cleared.', 'type' => 'string', 'required' => false, 'example' => 'TRIGGERED', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CustomEventCounts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CustomEventCount' => [ - 'description' => 'The details of the custom event.'."\n", - 'type' => 'array', - 'items' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'AlertLogList' => [ + 'description' => 'The list of alert history entries.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The name of the metric.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'EventName' => ['description' => 'The name of the event.', 'type' => 'string', 'example' => 'IOHang', 'title' => ''], + 'Product' => ['description' => 'The cloud service identifier. Valid values:'."\n" + ."\n" + .'- For an Alibaba Cloud service, the value is the abbreviation of the cloud service name. Example: ECS.'."\n" + ."\n" + .'- For a non-Alibaba Cloud service, the value is in the format of `acs_Product keyword`. Example: acs_networkmonitor.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'BlackListUUID' => ['description' => 'The UUID of the matched alert blacklist.', 'type' => 'string', 'example' => '8410dbbd-7d30-41c5-94cb-****', 'title' => ''], + 'Message' => ['description' => 'The alert-related information, which is a JSON string.', 'type' => 'string', 'example' => '{"alertName":"e47aa0ac-4076-44db-a47d-d1083968****_Availability"}', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'LevelChange' => ['description' => 'The change of the alert level. Valid values:'."\n" + .'- `P4->OK`: The alert level changes from P4 to OK, which indicates that the alert is cleared.'."\n" + .'- `P4->P4`: indicates a P4-level alert.', 'type' => 'string', 'example' => 'P4->OK', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the resource.', 'type' => 'string', 'example' => 'i-m5e1qg6uo38rztr4****', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'CPU utilization', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'd582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime', 'title' => ''], + 'BlackListName' => ['description' => 'The name of the matched alert blacklist.', 'type' => 'string', 'example' => 'Black_Test', 'title' => ''], + 'GroupName' => ['description' => 'The name of the application group.', 'type' => 'string', 'example' => 'ECS_Instances', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '7301****', 'title' => ''], + 'AlertTime' => ['description' => 'The timestamp when the alert was triggered.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1610043776621', 'title' => ''], + 'InstanceName' => ['description' => 'The name of the resource.', 'type' => 'string', 'example' => 'portalHost', 'title' => ''], + 'BlackListDetail' => ['description' => 'The details of the matched alert blacklist.', 'type' => 'string', 'example' => '{"id":12****,"metricProject":"acs_ecs_dashboard","userId":173651113438****,"uuid":"8410dbbd-7d30-41c5-94cb-****","name":"alert-****","productCategory":"ecs","instances":[{"instanceId":"i-m5e1qg6uo38rztr4****"}],"metrics":null,"scopeType":"USER","scopeValue":"","startTime":"0001-01-01T00:00:00Z","endTime":"9999-12-31T23:59:59.999999999+08:00","effectiveTime":null,"isEnable":true,"status":1,"gmtCreate":"2021-11-02T16:35:59+08:00","gmtModified":"2021-11-02T16:35:59+08:00","loadTime":"2021-11-02T16:36:15.213072177+08:00"}', 'title' => ''], + 'Level' => ['description' => 'The alert level and notification methods. Valid values:'."\n" + ."\n" + .'<props="china">- P2: phone calls, text messages, emails, and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="china">- P3: text messages, emails, and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="china">- P4: emails and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="china">- OK: no alerts.</props>'."\n" + ."\n" + .'<props="intl">- P4: emails and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="intl">- OK: no alerts.</props>'."\n" + ."\n" + .'<props="partner">- P4: emails and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="partner">- OK: no alerts.</props>', 'type' => 'string', 'example' => 'P4', 'title' => ''], + 'SendStatus' => ['description' => 'The alert status. Valid values:'."\n" + .'- 0: An alert is triggered or cleared.'."\n" + .'- 1: The current time is not within the effective period of the alert.'."\n" + .'- 2: The current time is within the channel silence period.'."\n" + .'- 3: The host is being restarted.'."\n" + .'- 4: No alerts are sent.'."\n" + ."\n" + .'<props="china">When the alert status is 0, an alert is triggered if Level is set to P2, P3, or P4; the alert is cleared if Level is set to OK.</props>'."\n" + .'<props="intl">When the alert status is 0, an alert is triggered if Level is set to P4; the alert is cleared if Level is set to OK.</props>'."\n" + .'<props="partner">When the alert status is 0, an alert is triggered if Level is set to P4; the alert is cleared if Level is set to OK.</props>', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ExtendedInfo' => [ + 'description' => 'The extended information of the alert.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the extension field.', 'type' => 'string', 'example' => 'userId', 'title' => ''], + 'Value' => ['description' => 'The value of the extension field.', 'type' => 'string', 'example' => '100931896542****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Dimensions' => [ + 'description' => 'The dimensions of the resource for which the alert is triggered.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the alerting resource.', 'type' => 'string', 'example' => 'instanceId', 'title' => ''], + 'Value' => ['description' => 'The value of the alerting resource.', 'type' => 'string', 'example' => 'i-m5e1qg6uo38rztr4****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'WebhookList' => [ + 'description' => 'The list of URLs that are called back when the alert is triggered.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The status code returned for the alert callback.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'url' => ['description' => 'The URL that is called back when the alert is triggered.', 'type' => 'string', 'example' => 'https://www.aliyun.com/webhook.html', 'title' => ''], + 'message' => ['description' => 'The information returned for the alert callback.', 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DingdingWebhookList' => [ + 'description' => 'The list of webhook URLs of DingTalk chatbots for the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The list of webhook URLs of DingTalk chatbots for the alert contact.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ContactOnCallList' => [ + 'description' => 'The list of phone numbers of the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The list of phone numbers of the alert contact.'."\n" + ."\n" + .'> This parameter is applicable only to the China site.', 'type' => 'string', 'example' => '1368888****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ContactMailList' => [ + 'description' => 'The list of email addresses of the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The list of email addresses of the alert contact.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ContactGroups' => [ + 'description' => 'The list of alert contact groups.', + 'type' => 'array', + 'items' => ['description' => 'The alert contact group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ContactALIIWWList' => [ + 'description' => 'The list of Wangwang IDs of the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The list of Wangwang IDs of the alert contact.'."\n" + ."\n" + .'> This parameter is applicable only to the China site.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ContactSMSList' => [ + 'description' => 'The list of phone numbers that receive text messages of the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The list of phone numbers that receive text messages of the alert contact.'."\n" + ."\n" + .'> This parameter is applicable only to the China site.', 'type' => 'string', 'example' => '1368888****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ContactDingList' => [ + 'description' => 'The list of DingTalk accounts of the alert contact.', + 'type' => 'array', + 'items' => ['description' => 'The list of DingTalk accounts of the alert contact.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'SendDetail' => [ + 'description' => 'The details of the alert pushing result.', 'type' => 'object', 'properties' => [ - 'Time' => [ - 'description' => 'The time when the event occurred.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552267615000', - ], - 'Num' => [ - 'description' => 'The number of times that the custom event occurred.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'ResultCode' => ['description' => 'The pushing status of the alert information.'."\n" + ."\n" + .'- success: The alert was pushed.'."\n" + ."\n" + .'- error code: If a configuration error occurs and the pushing list is empty, an error code is displayed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ChannelResultList' => [ + 'description' => 'The list of alert pushing results by alert channel.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert pushing result by alert channel.', + 'type' => 'object', + 'properties' => [ + 'Channel' => ['description' => 'The alert pushing channel. Valid values:'."\n" + ."\n" + .'- MAIL: email.'."\n" + ."\n" + .'- SMS: text message.'."\n" + ."\n" + .'- WEBHOOK: alert callback.'."\n" + ."\n" + .'- SLS: Log Service.'."\n" + ."\n" + .'- ONCALL: phone call.'."\n" + ."\n" + .'- FC: Function Compute.'."\n" + ."\n" + .'- MNS: Message Service (MNS).', 'type' => 'string', 'example' => 'MAIL', 'title' => ''], + 'ResultList' => [ + 'description' => 'The list of alert information results that CloudMonitor sends to the alert channel.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert information result that CloudMonitor sends to the alert channel.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'- If `Channel` is set to `WEBHOOK`, the status code is 200 or 500.'."\n" + ."\n" + .'- If `Channel` is set to `MAIL`, `SMS`, `SLS`, `ONCALL`, `FC`, or `MNS`, this parameter is unavailable or empty.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID returned by calling another cloud service.', 'type' => 'string', 'example' => '0BDAF8A8-04DC-5F0C-90E4-724D42C4****', 'title' => ''], + 'Success' => ['description' => 'The result of calling the target.'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Detail' => ['description' => 'The details of the returned result.', 'type' => 'string', 'example' => '{ }', 'title' => ''], + 'notifyTargetList' => [ + 'description' => 'The list of channel notifications.', + 'type' => 'array', + 'items' => ['description' => 'The list of channel notifications.', 'type' => 'string', 'example' => 'MAIL', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Name' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'example' => 'BABEL_BUY', + ], + 'title' => '', + 'example' => '', + ], + 'Escalation' => [ + 'description' => 'The rule that triggers the alert.', + 'type' => 'object', + 'properties' => [ + 'Expression' => ['description' => 'The description of the rule that triggers the alert.'."\n" + ."\n" + .'> The body of the alert rule. An alert rule is triggered when the monitoring data meets the alert conditions.', 'type' => 'string', 'example' => '$Average<90', 'title' => ''], + 'Times' => ['description' => 'The number of times that the alert is retried.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Level' => ['description' => 'The alert level and notification methods. Valid values:'."\n" + ."\n" + .'<props="china">- P2: phone calls, text messages, emails, and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="china">- P3: text messages, emails, and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="china">- P4: emails and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="china">- OK: no alerts.</props>'."\n" + ."\n" + .'<props="intl">- P4: emails and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="intl">- OK: no alerts.</props>'."\n" + ."\n" + .'<props="partner">- P4: emails and DingTalk chatbots.</props>'."\n" + ."\n" + .'<props="partner">- OK: no alerts.</props>', 'type' => 'string', 'example' => 'P4', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SendResultList' => [ + 'description' => 'The list of alert sending results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of alert sending results.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The channel that sends the alert. Valid values:'."\n" + .'- MAIL: email.'."\n" + .'- ALIIM: Wangwang.'."\n" + .'- SMS: text message.'."\n" + .'- CALL: phone call.'."\n" + .'- DING: DingTalk chatbot.'."\n" + .'- Merged: alert combination.', 'type' => 'string', 'example' => 'MAIL', 'title' => ''], + 'Value' => [ + 'description' => 'The notification target that corresponds to the alert channel.', + 'type' => 'array', + 'items' => ['description' => 'The notification target that corresponds to the alert channel.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'LogId' => ['description' => 'The log ID.', 'type' => 'string', 'example' => '7510****::e8a472a0-46ae-4ac0-84b1-e46be368****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"60912C8D-B340-4253-ADE7-61ACDFD25CFC\\",\\n \\"Success\\": true,\\n \\"CustomEventCounts\\": {\\n \\"CustomEventCount\\": [\\n {\\n \\"Time\\": 1552267615000,\\n \\"Num\\": 20,\\n \\"Name\\": \\"BABEL_BUY\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomEventCount>\\n\\t\\t<CustomEventCounts>\\n\\t\\t\\t<CustomEventCount>\\n\\t\\t\\t\\t<Name>BABEL_BUY</Name>\\n\\t\\t\\t\\t<Time>1552267615000</Time>\\n\\t\\t\\t\\t<Num>20</Num>\\n\\t\\t\\t</CustomEventCount>\\n\\t\\t</CustomEventCounts>\\n\\t\\t<Message>success</Message>\\n\\t\\t<RequestId>38D3C270-6799-4461-AA55-7975352140C1</RequestId>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</DescribeCustomEventCount>","errorExample":""}]', - 'title' => 'DescribeCustomEventCount', - 'description' => '> This operation queries the number of times that a custom event occurred for each service.'."\n", - 'requestParamsDescription' => ' ', + 'title' => 'Queries the alert history', + 'description' => 'This operation can query the alert history only within the last year.'."\n" + ."\n" + .'This topic provides an example to show how to query the alert history of Elastic Compute Service (ECS) from the cloud service `product` dimension.', + 'requestParamsDescription' => ' For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeCustomEventHistogram' => [ - 'summary' => 'Queries the number of times that a custom event occurred during each interval within a period of time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-12-07T03:28:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-27T09:48:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-29T06:58:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-29T08:09:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-29T08:09:51.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertLogList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeAlertLogList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C4A3709-BF52-42EE-87B5-7435F0929585\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"AlertLogList\\": [\\n {\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EventName\\": \\"IOHang\\",\\n \\"Product\\": \\"ECS\\",\\n \\"BlackListUUID\\": \\"8410dbbd-7d30-41c5-94cb-****\\",\\n \\"Message\\": \\"{\\\\\\"alertName\\\\\\":\\\\\\"e47aa0ac-4076-44db-a47d-d1083968****_Availability\\\\\\"}\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"LevelChange\\": \\"P4->OK\\",\\n \\"InstanceId\\": \\"i-m5e1qg6uo38rztr4****\\",\\n \\"RuleName\\": \\"CPU utilization\\",\\n \\"RuleId\\": \\"d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime\\",\\n \\"BlackListName\\": \\"Black_Test\\",\\n \\"GroupName\\": \\"ECS_Instances\\",\\n \\"GroupId\\": \\"7301****\\",\\n \\"AlertTime\\": \\"1610043776621\\",\\n \\"InstanceName\\": \\"portalHost\\",\\n \\"BlackListDetail\\": \\"{\\\\\\"id\\\\\\":12****,\\\\\\"metricProject\\\\\\":\\\\\\"acs_ecs_dashboard\\\\\\",\\\\\\"userId\\\\\\":173651113438****,\\\\\\"uuid\\\\\\":\\\\\\"8410dbbd-7d30-41c5-94cb-****\\\\\\",\\\\\\"name\\\\\\":\\\\\\"alert-****\\\\\\",\\\\\\"productCategory\\\\\\":\\\\\\"ecs\\\\\\",\\\\\\"instances\\\\\\":[{\\\\\\"instanceId\\\\\\":\\\\\\"i-m5e1qg6uo38rztr4****\\\\\\"}],\\\\\\"metrics\\\\\\":null,\\\\\\"scopeType\\\\\\":\\\\\\"USER\\\\\\",\\\\\\"scopeValue\\\\\\":\\\\\\"\\\\\\",\\\\\\"startTime\\\\\\":\\\\\\"0001-01-01T00:00:00Z\\\\\\",\\\\\\"endTime\\\\\\":\\\\\\"9999-12-31T23:59:59.999999999+08:00\\\\\\",\\\\\\"effectiveTime\\\\\\":null,\\\\\\"isEnable\\\\\\":true,\\\\\\"status\\\\\\":1,\\\\\\"gmtCreate\\\\\\":\\\\\\"2021-11-02T16:35:59+08:00\\\\\\",\\\\\\"gmtModified\\\\\\":\\\\\\"2021-11-02T16:35:59+08:00\\\\\\",\\\\\\"loadTime\\\\\\":\\\\\\"2021-11-02T16:36:15.213072177+08:00\\\\\\"}\\",\\n \\"Level\\": \\"P4\\",\\n \\"SendStatus\\": \\"0\\",\\n \\"ExtendedInfo\\": [\\n {\\n \\"Name\\": \\"userId\\",\\n \\"Value\\": \\"100931896542****\\"\\n }\\n ],\\n \\"Dimensions\\": [\\n {\\n \\"Key\\": \\"instanceId\\",\\n \\"Value\\": \\"i-m5e1qg6uo38rztr4****\\"\\n }\\n ],\\n \\"WebhookList\\": [\\n {\\n \\"code\\": \\"200\\",\\n \\"url\\": \\"https://www.aliyun.com/webhook.html\\",\\n \\"message\\": \\"success\\"\\n }\\n ],\\n \\"DingdingWebhookList\\": [\\n \\"https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****\\"\\n ],\\n \\"ContactOnCallList\\": [\\n \\"1368888****\\"\\n ],\\n \\"ContactMailList\\": [\\n \\"username@example.com\\"\\n ],\\n \\"ContactGroups\\": [\\n \\"ECS_Group\\"\\n ],\\n \\"ContactALIIWWList\\": [\\n \\"Alice\\"\\n ],\\n \\"ContactSMSList\\": [\\n \\"1368888****\\"\\n ],\\n \\"ContactDingList\\": [\\n \\"CloudMonitor\\"\\n ],\\n \\"SendDetail\\": {\\n \\"ResultCode\\": \\"success\\",\\n \\"ChannelResultList\\": [\\n {\\n \\"Channel\\": \\"MAIL\\",\\n \\"ResultList\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0BDAF8A8-04DC-5F0C-90E4-724D42C4****\\",\\n \\"Success\\": true,\\n \\"Detail\\": \\"{ }\\",\\n \\"notifyTargetList\\": [\\n \\"MAIL\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"Escalation\\": {\\n \\"Expression\\": \\"$Average<90\\",\\n \\"Times\\": 1,\\n \\"Level\\": \\"P4\\"\\n },\\n \\"SendResultList\\": [\\n {\\n \\"Key\\": \\"MAIL\\",\\n \\"Value\\": [\\n \\"username@example.com\\"\\n ]\\n }\\n ],\\n \\"LogId\\": \\"7510****::e8a472a0-46ae-4ac0-84b1-e46be368****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAlertingMetricRuleResources' => [ + 'summary' => 'Queries the list of resources that are triggering alerts for a specified alert rule.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BucketIngressBandwidth', - ], + 'schema' => ['description' => 'The alert rule ID. For information about how to query alert rule IDs, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****', 'title' => ''], ], [ - 'name' => 'Level', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The severity level of the event. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CRITICAL', - ], + 'schema' => ['description' => 'The application group ID. For information about how to query application group IDs, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '7671****', 'title' => ''], ], [ - 'name' => 'EventId', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The page number. '."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'SearchKeywords', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to search for the event.'."\n" - ."\n" - .'* If you need to query the custom event whose content contains a and b, set the value to "a and b".'."\n" - .'* If you need to query the custom event whose content contains a or b, set the value to "a or b".'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cms', - ], + 'schema' => ['description' => 'The data namespace of the cloud service.'."\n" + ."\n" + .'For information about how to obtain the data namespace of a cloud service, see [Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_mns_new', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552209685596', - ], + 'schema' => ['description' => 'The dimension map used to query monitoring data for a specified resource.', 'type' => 'string', 'required' => false, 'example' => '{\\"userId\\":\\"120886317861****\\",\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\"}', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'AlertBeforeTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552220485596', - ], + 'schema' => ['description' => 'Queries alerts that occurred before this point in time. The value is a millisecond-level timestamp.', 'type' => 'string', 'required' => false, 'example' => '1698827400000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'EventHistograms' => [ + 'Code' => ['description' => 'The status code.'."\n" + .'>A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request processing has failed due to some unknown error.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0724011B-D9E0-4B2F-8C51-F17A894CC42C', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'EventHistogram' => [ - 'description' => 'The information about the number of times that the custom event occurred during each interval of the specified time period.'."\n", + 'Resource' => [ + 'description' => 'The list of resources associated with the alert rule.', 'type' => 'array', 'items' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => 'The end time.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552226750000', - ], - 'StartTime' => [ - 'description' => 'The start time.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552226740000', - ], - 'Count' => [ - 'description' => 'The information about the number of times that the custom event occurred during an interval of the specified time period.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'ActiveMessages', 'title' => ''], + 'RetryTimes' => ['description' => 'The number of alert retries.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'MetricValues' => ['description' => 'The metric values when the alert was triggered. The value is a JSON string.', 'type' => 'string', 'example' => '{\\"timestamp\\":1623727500000,\\"Sum\\":926,\\"value\\":463,\\"Maximum\\":463,\\"Minimum\\":463,\\"Average\\":463,\\"SampleCount\\":2,\\"userId\\":\\"120886317861****\\",\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\"}', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_mns_new', 'title' => ''], + 'RuleName' => ['description' => 'The alert rule name.', 'type' => 'string', 'example' => 'test123456789', 'title' => ''], + 'RuleId' => ['description' => 'The alert rule ID.', 'type' => 'string', 'example' => 'putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****', 'title' => ''], + 'ProductCategory' => ['description' => 'The cloud service type.', 'type' => 'string', 'example' => 'mns', 'title' => ''], + 'StartTime' => ['description' => 'The timestamp when the resource was associated with the alert rule.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1622427900000', 'title' => ''], + 'Resource' => ['description' => 'The resource that triggered the alert.', 'type' => 'string', 'example' => 'userId=120886317861****,region=cn-huhehaote,queue=test-0128', 'title' => ''], + 'LastModifyTime' => ['description' => 'The timestamp when the alert rule was last modified.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1622827900000', 'title' => ''], + 'GroupId' => ['description' => 'The application group ID.'."\n" + .'>If the alert rule is associated with a specified application group, this application group ID is displayed.', 'type' => 'string', 'example' => '7671****', 'title' => ''], + 'Dimensions' => ['description' => 'The dimension map used to query monitoring data for a specified resource.', 'type' => 'string', 'example' => '{\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\",\\"userId\\":\\"120886317861****\\"}', 'title' => ''], + 'LastAlertTime' => ['description' => 'The timestamp when the alert was last triggered.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1622427900000', 'title' => ''], + 'Level' => ['description' => 'The alert level and notification method. Valid values:'."\n" + ."\n" + .'<props="china">- 2: phone call + text message + email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- 3: text message + email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- 4: email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- OK: no alert.</props>'."\n" + ."\n" + .'<props="intl">- 4: email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="intl">- OK: no alert.</props>'."\n" + ."\n" + .'<props="partner">- 4: email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="partner">- OK: no alert.</props>', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for the alert.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" + ."\n" + .'- true: The alert rule is enabled.'."\n" + ."\n" + .'- false: The alert rule is disabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Escalation' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The rule that triggered the alert.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The threshold comparison operator. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to'."\n" + ."\n" + .'- GreaterThanThreshold: greater than'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to'."\n" + ."\n" + .'- LessThanThreshold: less than'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to'."\n" + ."\n" + .'- GreaterThanYesterday: increased compared with the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: decreased compared with the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: increased compared with the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: decreased compared with the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: increased compared with the previous period'."\n" + ."\n" + .'- LessThanLastPeriod: decreased compared with the previous period', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'PreCondition' => ['description' => 'The threshold comparison symbol. Valid values:'."\n" + ."\n" + .'- `>=`'."\n" + ."\n" + .'- `=`'."\n" + ."\n" + .'- `<=`'."\n" + ."\n" + .'- `>`'."\n" + ."\n" + .'- `<`'."\n" + ."\n" + .'- `!=`', 'type' => 'string', 'example' => '>=', 'title' => ''], + 'Expression' => ['description' => 'The description of the rule that triggered the alert.'."\n" + ."\n" + .'> This is the body of the alert rule. When monitoring data meets the alert condition, the alert rule is triggered.', 'type' => 'string', 'example' => '$Average>=10', 'title' => ''], + 'Times' => ['description' => 'The number of alert retries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Tag' => ['description' => 'This parameter is deprecated and can be ignored.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Level' => ['description' => 'The alert level and notification method. Valid values:'."\n" + ."\n" + .'<props="china">- 2: phone call + text message + email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- 3: text message + email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- 4: email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- OK: no alert.</props>'."\n" + ."\n" + .'<props="intl">- 4: email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="intl">- OK: no alert.</props>'."\n" + ."\n" + .'<props="partner">- 4: email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="partner">- OK: no alert.</props>', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'ExpressionListJoin' => ['description' => 'The relationship between multiple metrics. Valid values:'."\n" + ."\n" + .'- &&: An alert notification is sent only when all metrics meet the alert conditions.'."\n" + .'- ||: An alert notification is sent when any metric meets the alert conditions.', 'type' => 'string', 'example' => '&&', 'title' => ''], + 'ExpressionList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ExpressionList' => [ + 'description' => 'The description of the multi-metric alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The threshold comparison operator for the alert level. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to'."\n" + .'- GreaterThanThreshold: greater than'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to'."\n" + .'- LessThanThreshold: less than'."\n" + .'- NotEqualToThreshold: not equal to'."\n" + .'- GreaterThanYesterday: increased compared with the same time yesterday'."\n" + .'- LessThanYesterday: decreased compared with the same time yesterday'."\n" + .'- GreaterThanLastWeek: increased compared with the same time last week'."\n" + .'- LessThanLastWeek: decreased compared with the same time last week'."\n" + .'- GreaterThanLastPeriod: increased compared with the previous period'."\n" + .'- LessThanLastPeriod: decreased compared with the previous period', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'Period' => ['description' => 'The statistical period of the metric. Unit: seconds. The default value is the original reporting period of the metric.', 'type' => 'string', 'example' => '60', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for the alert level. Valid values:'."\n" + ."\n" + .'- Maximum: maximum value'."\n" + .'- Minimum: minimum value'."\n" + .'- Average: average value', 'type' => 'string', 'example' => 'Average', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '90', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ExpressionRaw' => ['description' => 'The alert condition created by using an expression. The following scenarios are supported but not limited to:'."\n" + ."\n" + .'- Set an alert blacklist for specific resources. For example, `$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50` specifies that no alert is triggered for instance `i-io8kfvcpp7x5****` even if its `Average` exceeds 50.'."\n" + .'- Set a special alert threshold for a specific instance in the rule. For example, `$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)` specifies that an alert is triggered for instance `i-io8kfvcpp7x5****` only when its `Average` exceeds 80, while an alert is triggered for other instances when their `Average` exceeds 50.'."\n" + .'- Limit the number of instances that exceed the threshold. For example, `count($Average > 20) > 3` specifies that an alert is triggered only when more than three instances in the alert rule have an `Average` greater than 20.', 'type' => 'string', 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"486029C9-53E1-44B4-85A8-16A571A043FD\\",\\n \\"Success\\": \\"true\\",\\n \\"EventHistograms\\": {\\n \\"EventHistogram\\": [\\n {\\n \\"EndTime\\": 1552226750000,\\n \\"StartTime\\": 1552226740000,\\n \\"Count\\": 3\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomEventHistogramResponse>\\r\\n\\t\\t<Message>success</Message>\\r\\n\\t\\t<RequestId>5977C7EE-E727-4EC4-B756-ECC8CB820CF4</RequestId>\\r\\n\\t\\t<EventHistograms>\\r\\n\\t\\t\\t<EventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1596000690000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1596000689000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</EventHistogram>\\r\\n\\t\\t\\t<EventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1596000720000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1596000690000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</EventHistogram>\\r\\n\\t\\t\\t<EventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1596000930000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1596000900000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</EventHistogram>\\r\\n\\t\\t\\t<EventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1596000960000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1596000930000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</EventHistogram>\\r\\n\\t\\t\\t<EventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1596000990000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1596000960000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</EventHistogram>\\r\\n\\t\\t</EventHistograms>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeCustomEventHistogramResponse>\\r\\n","errorExample":""}]', - 'title' => 'DescribeCustomEventHistogram', - 'requestParamsDescription' => ' ', + 'title' => 'Query resources with active alerts for a specified alert rule', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeCustomEventAttribute' => [ - 'summary' => 'Queries the details of a custom event.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-10-20T09:20:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-01T02:53:57.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertingMetricRuleResources'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeAlertingMetricRuleResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\": \\"0724011B-D9E0-4B2F-8C51-F17A894CC42C\\",\\n \\"Total\\": 2,\\n \\"Success\\": true,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"MetricName\\": \\"ActiveMessages\\",\\n \\"RetryTimes\\": \\"3\\",\\n \\"MetricValues\\": \\"{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1623727500000,\\\\\\\\\\\\\\"Sum\\\\\\\\\\\\\\":926,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":463,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":463,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":463,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":463,\\\\\\\\\\\\\\"SampleCount\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120886317861****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"region\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-huhehaote\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"queue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test-0128\\\\\\\\\\\\\\"}\\",\\n \\"Namespace\\": \\"acs_mns_new\\",\\n \\"RuleName\\": \\"test123456789\\",\\n \\"RuleId\\": \\"putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****\\",\\n \\"ProductCategory\\": \\"mns\\",\\n \\"StartTime\\": \\"1622427900000\\",\\n \\"Resource\\": \\"userId=120886317861****,region=cn-huhehaote,queue=test-0128\\",\\n \\"LastModifyTime\\": \\"1622827900000\\",\\n \\"GroupId\\": \\"7671****\\",\\n \\"Dimensions\\": \\"{\\\\\\\\\\\\\\"region\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-huhehaote\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"queue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test-0128\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120886317861****\\\\\\\\\\\\\\"}\\",\\n \\"LastAlertTime\\": \\"1622427900000\\",\\n \\"Level\\": 3,\\n \\"Threshold\\": \\"10\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Enable\\": \\"true\\",\\n \\"Escalation\\": {\\n \\"Resource\\": [\\n {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"PreCondition\\": \\">=\\",\\n \\"Expression\\": \\"$Average>=10\\",\\n \\"Times\\": 1,\\n \\"Tag\\": \\"无\\",\\n \\"Threshold\\": \\"10\\",\\n \\"Level\\": 3,\\n \\"ExpressionListJoin\\": \\"&&\\",\\n \\"ExpressionList\\": {\\n \\"ExpressionList\\": [\\n {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Period\\": \\"60\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Threshold\\": \\"90\\"\\n }\\n ]\\n },\\n \\"ExpressionRaw\\": \\"$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeContactGroupList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12174,101 +9020,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], - ], - [ - 'name' => 'EventId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123****', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123****', - ], - ], - [ - 'name' => 'SearchKeywords', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keywords that are used to search for the event.'."\n" - ."\n" - .'* If you need to query the custom event whose content contains a and b, set the value to a and b.'."\n" - .'* If you need to query the custom event whose content contains a or b, set the value to a or b.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cms', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552224365971', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1552227965971', - ], + 'schema' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '100', 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -12276,353 +9038,355 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'userId:173651113438**** and name:"BABEL_CHECK"', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', + 'Code' => ['description' => 'Status code. Note that 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '916EE694-03C2-47B6-85EE-5054E3C168D3', 'title' => ''], + 'Total' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => 'List of alarm contact groups.', + 'type' => 'array', + 'items' => ['description' => 'Alarm contact group.', 'type' => 'string', 'example' => '云账号报警联系人', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'CustomEvents' => [ + 'ContactGroupList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'CustomEvent' => [ - 'description' => 'The event details.'."\n", + 'ContactGroup' => [ + 'description' => 'List of alarm contact groups.', 'type' => 'array', 'items' => [ + 'description' => 'Alarm contact group.', 'type' => 'object', 'properties' => [ - 'Time' => [ - 'description' => 'The time when the event occurred.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'string', - 'example' => '1552199984000', - ], - 'Name' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'example' => 'BABEL_CHECK', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'Content' => [ - 'description' => 'The content of the event.'."\n", - 'type' => 'string', - 'example' => 'requestId:4975A6F3-19AC-4C01-BAD2-034DA07FEBB5, info:{"autoPay":false,"autoUseCoupon":false,"bid":"26842","buyerId":118935342242****,"commodities":[{"aliyunProduceCode":"cms","chargeType":"PREPAY","commodityCode":"cms_call_num","components":[{"componentCode":"phone_count","instanceProperty":[{"code":"phone_count","value":"500"}],"moduleAttrStatus":1}],"duration":6,"free":false,"orderParams":{"aliyunProduceCode":"cms"},"orderType":"BUY","prePayPostCharge":false,"pricingCycle":"Month","quantity":1,"refundSpecCode":"","renewChange":false,"specCode":"cms_call_num","specUpdate":false,"syncToSubscription":false,"upgradeInquireFinancialValue":true}],"fromApp":"commonbuy","orderParams":{"priceCheck":"true"},"payerId":118935342242****,"requestId":"ade3ad32-f58b-45d7-add4-ac542be3d8ec","skipChannel":false,"userId":118935342242****}', - ], - 'Id' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'string', - 'example' => '123', + 'Describe' => ['description' => 'Description information of the alarm contact group.', 'type' => 'string', 'example' => 'Devops-运维组', 'title' => ''], + 'UpdateTime' => ['description' => 'Update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-03-04T02:12:06Z', 'title' => ''], + 'CreateTime' => ['description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2023-06-07T03:52:30Z', 'title' => ''], + 'EnabledWeeklyReport' => ['description' => 'Indicates whether the weekly report function is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Name' => ['description' => 'Name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'EnableSubscribed' => ['description' => 'Indicates whether the weekly report subscription function is enabled. Values:'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => 'List of contacts.', + 'type' => 'array', + 'items' => ['description' => 'Contact.', 'type' => 'string', 'example' => '135xxxx8066', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 200 => [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"userId:173651113438**** and name:\\\\\\"BABEL_CHECK\\\\\\"\\",\\n \\"RequestId\\": \\"60912C8D-B340-4253-ADE7-61ACDFD25CFC\\",\\n \\"Success\\": \\"true\\",\\n \\"CustomEvents\\": {\\n \\"CustomEvent\\": [\\n {\\n \\"Time\\": \\"1552199984000\\",\\n \\"Name\\": \\"BABEL_CHECK\\",\\n \\"GroupId\\": \\"12345\\",\\n \\"Content\\": \\"requestId:4975A6F3-19AC-4C01-BAD2-034DA07FEBB5, info:{\\\\\\"autoPay\\\\\\":false,\\\\\\"autoUseCoupon\\\\\\":false,\\\\\\"bid\\\\\\":\\\\\\"26842\\\\\\",\\\\\\"buyerId\\\\\\":118935342242****,\\\\\\"commodities\\\\\\":[{\\\\\\"aliyunProduceCode\\\\\\":\\\\\\"cms\\\\\\",\\\\\\"chargeType\\\\\\":\\\\\\"PREPAY\\\\\\",\\\\\\"commodityCode\\\\\\":\\\\\\"cms_call_num\\\\\\",\\\\\\"components\\\\\\":[{\\\\\\"componentCode\\\\\\":\\\\\\"phone_count\\\\\\",\\\\\\"instanceProperty\\\\\\":[{\\\\\\"code\\\\\\":\\\\\\"phone_count\\\\\\",\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"}],\\\\\\"moduleAttrStatus\\\\\\":1}],\\\\\\"duration\\\\\\":6,\\\\\\"free\\\\\\":false,\\\\\\"orderParams\\\\\\":{\\\\\\"aliyunProduceCode\\\\\\":\\\\\\"cms\\\\\\"},\\\\\\"orderType\\\\\\":\\\\\\"BUY\\\\\\",\\\\\\"prePayPostCharge\\\\\\":false,\\\\\\"pricingCycle\\\\\\":\\\\\\"Month\\\\\\",\\\\\\"quantity\\\\\\":1,\\\\\\"refundSpecCode\\\\\\":\\\\\\"\\\\\\",\\\\\\"renewChange\\\\\\":false,\\\\\\"specCode\\\\\\":\\\\\\"cms_call_num\\\\\\",\\\\\\"specUpdate\\\\\\":false,\\\\\\"syncToSubscription\\\\\\":false,\\\\\\"upgradeInquireFinancialValue\\\\\\":true}],\\\\\\"fromApp\\\\\\":\\\\\\"commonbuy\\\\\\",\\\\\\"orderParams\\\\\\":{\\\\\\"priceCheck\\\\\\":\\\\\\"true\\\\\\"},\\\\\\"payerId\\\\\\":118935342242****,\\\\\\"requestId\\\\\\":\\\\\\"ade3ad32-f58b-45d7-add4-ac542be3d8ec\\\\\\",\\\\\\"skipChannel\\\\\\":false,\\\\\\"userId\\\\\\":118935342242****}\\",\\n \\"Id\\": \\"123\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomEventAttributeResponse>\\r\\n <Message>userId:173651113438**** and name:\\"BABEL_CHECK\\"</Message>\\r\\n <RequestId>194A3F1D-8EA6-4922-BBF2-5F213AC7B648</RequestId>\\r\\n <CustomEvents>\\r\\n <CustomEvent>\\r\\n <Name>BABEL_CHECK</Name>\\r\\n <Time>1553422490000</Time>\\r\\n <Id>E4407D77-72BA-4818-8644-39D119D7****</Id>\\r\\n <Content>requestId:BD524A26-A3DA-4133-A863-FF56B335797E, info:{\\"autoPay\\":false,\\"autoUseCoupon\\":false,\\"bid\\":\\"26842\\",\\"buyerId\\":118935342242****,\\"commodities\\":[{\\"aliyunProduceCode\\":\\"cms\\",\\"chargeType\\":\\"PREPAY\\",\\"commodityCode\\":\\"cms_edition\\",\\"components\\":[{\\"componentCode\\":\\"suggest_type\\",\\"instanceProperty\\":[{\\"code\\":\\"suggest_type\\",\\"value\\":\\"pro\\"}],\\"moduleAttrStatus\\":1},{\\"componentCode\\":\\"pay_type\\",\\"instanceProperty\\":[{\\"code\\":\\"pay_type\\",\\"value\\":\\"suggest\\"}],\\"moduleAttrStatus\\":1}],\\"duration\\":1,\\"free\\":false,\\"orderParams\\":{\\"aliyunProduceCode\\":\\"cms\\"},\\"orderType\\":\\"BUY\\",\\"prePayPostCharge\\":false,\\"pricingCycle\\":\\"Month\\",\\"quantity\\":1,\\"refundSpecCode\\":\\"\\",\\"renewChange\\":false,\\"specCode\\":\\"cms_edition\\",\\"specUpdate\\":false,\\"syncToSubscription\\":false,\\"upgradeInquireFinancialValue\\":true}],\\"fromApp\\":\\"commonbuy\\",\\"orderParams\\":{\\"priceCheck\\":\\"true\\"},\\"payerId\\":118935342242****,\\"requestId\\":\\"57d81d14-3c60-468e-b50a-1dfdb1594673\\",\\"skipChannel\\":false,\\"userId\\":118935342242****}</Content>\\r\\n <GroupId>12345</GroupId>\\r\\n </CustomEvent>\\r\\n <CustomEvent>\\r\\n <Name>BABEL_CHECK</Name>\\r\\n <Time>1553422498000</Time>\\r\\n <Id>D44FAC44-EB81-470A-909D-BD963FF9****</Id>\\r\\n <Content>requestId:14CC5306-0BAB-464F-B340-CF33AD306510, info:{\\"autoPay\\":false,\\"autoUseCoupon\\":false,\\"bid\\":\\"26842\\",\\"buyerId\\":118935342242****,\\"commodities\\":[{\\"aliyunProduceCode\\":\\"cms\\",\\"chargeType\\":\\"PREPAY\\",\\"commodityCode\\":\\"cms_smspackage\\",\\"components\\":[{\\"componentCode\\":\\"sms_count\\",\\"instanceProperty\\":[{\\"code\\":\\"sms_count\\",\\"value\\":\\"1000\\"}],\\"moduleAttrStatus\\":1}],\\"duration\\":6,\\"free\\":false,\\"orderParams\\":{\\"aliyunProduceCode\\":\\"cms\\"},\\"orderType\\":\\"BUY\\",\\"prePayPostCharge\\":false,\\"pricingCycle\\":\\"Month\\",\\"quantity\\":1,\\"refundSpecCode\\":\\"\\",\\"renewChange\\":false,\\"specCode\\":\\"cms_smspackage\\",\\"specUpdate\\":false,\\"syncToSubscription\\":false,\\"upgradeInquireFinancialValue\\":true}],\\"fromApp\\":\\"commonbuy\\",\\"orderParams\\":{\\"priceCheck\\":\\"true\\"},\\"payerId\\":118935342242****,\\"requestId\\":\\"64461412-31f2-4e52-a875-43bf1410bdf0\\",\\"skipChannel\\":false,\\"userId\\":118935342242****}</Content>\\r\\n <GroupId>12345</GroupId>\\r\\n </CustomEvent>\\r\\n <CustomEvent>\\r\\n <Name>BABEL_CHECK</Name>\\r\\n <Time>1553422506000</Time>\\r\\n <Id>3AF6FE15-4F6E-459A-96F6-45C74F765209</Id>\\r\\n <Content>requestId:4975A6F3-19AC-4C01-BAD2-034DA07FEBB5, info:{\\"autoPay\\":false,\\"autoUseCoupon\\":false,\\"bid\\":\\"26842\\",\\"buyerId\\":118935342242****,\\"commodities\\":[{\\"aliyunProduceCode\\":\\"cms\\",\\"chargeType\\":\\"PREPAY\\",\\"commodityCode\\":\\"cms_call_num\\",\\"components\\":[{\\"componentCode\\":\\"phone_count\\",\\"instanceProperty\\":[{\\"code\\":\\"phone_count\\",\\"value\\":\\"500\\"}],\\"moduleAttrStatus\\":1}],\\"duration\\":6,\\"free\\":false,\\"orderParams\\":{\\"aliyunProduceCode\\":\\"cms\\"},\\"orderType\\":\\"BUY\\",\\"prePayPostCharge\\":false,\\"pricingCycle\\":\\"Month\\",\\"quantity\\":1,\\"refundSpecCode\\":\\"\\",\\"renewChange\\":false,\\"specCode\\":\\"cms_call_num\\",\\"specUpdate\\":false,\\"syncToSubscription\\":false,\\"upgradeInquireFinancialValue\\":true}],\\"fromApp\\":\\"commonbuy\\",\\"orderParams\\":{\\"priceCheck\\":\\"true\\"},\\"payerId\\":118935342242****,\\"requestId\\":\\"ade3ad32-f58b-45d7-add4-ac542be3d8ec\\",\\"skipChannel\\":false,\\"userId\\":118935342242****}</Content>\\r\\n <GroupId>12345</GroupId>\\r\\n </CustomEvent>\\r\\n </CustomEvents>\\r\\n <Success>true</Success>\\r\\n <Code>200</Code>\\r\\n</DescribeCustomEventAttributeResponse>","errorExample":""}]', - 'title' => 'DescribeCustomEventAttribute', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'PutCustomEvent' => [ - 'summary' => 'Reports custom events.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query Alarm Contact Group List', + 'summary' => 'Call the DescribeContactGroupList interface to query the list of alarm contact groups.', + 'changeSet' => [ + ['createdAt' => '2022-01-11T10:15:57.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactGroupList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeContactGroupList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"916EE694-03C2-47B6-85EE-5054E3C168D3\\",\\n \\"Total\\": 22,\\n \\"Success\\": true,\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"云账号报警联系人\\"\\n ]\\n },\\n \\"ContactGroupList\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Describe\\": \\"Devops-运维组\\",\\n \\"UpdateTime\\": 0,\\n \\"CreateTime\\": 0,\\n \\"EnabledWeeklyReport\\": false,\\n \\"Name\\": \\"name\\",\\n \\"EnableSubscribed\\": false,\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n \\"135xxxx8066\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeContactList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'EventInfo', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The event details.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EventName' => [ - 'description' => 'The event name. Valid values of N: 1 to 50.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'myEvent', - ], - 'Time' => [ - 'description' => 'The time when the event occurred.'."\n" - ."\n" - .'Format: `yyyyMMddTHHmmss.SSSZ`.'."\n" - ."\n" - .'Valid values of N: 1 to 50.'."\n" - ."\n" - .'> You can also specify a UNIX timestamp. Example: 1552199984000. Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20171013T170923.456+0800', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group. Valid values of N: 1 to 50.'."\n" - ."\n" - .'Default value: 0. This value indicates that the event to be reported does not belong to any application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], - 'Content' => [ - 'description' => 'The event content. Valid values of N: 1 to 50.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'IOException', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '100', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The current page number.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'required' => false, 'example' => 'Alice', 'title' => ''], + ], + [ + 'name' => 'ChanelType', + 'in' => 'query', + 'schema' => ['description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'<props="china">- SMS: text message.</props>'."\n" + ."\n" + .'<props="china">- AliIM: TradeManager.</props>'."\n" + ."\n" + .'- Mail: email.'."\n" + ."\n" + .'- DingWebHook: DingTalk chatbot.', 'type' => 'string', 'required' => false, 'example' => 'Mail', 'title' => ''], + ], + [ + 'name' => 'ChanelValue', + 'in' => 'query', + 'schema' => ['description' => 'The value of the alert notification method.'."\n" + ."\n" + .'> This parameter is required only when `ChanelType` is set to `Mail`.', 'type' => 'string', 'required' => false, 'example' => 'Alice@example.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '131DD9C8-9A32-4428-AD2E-4E3013B6E3A7', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => 'The alert notification methods.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => ['description' => 'The timestamp when the alert contact was last updated.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552356159000', 'title' => ''], + 'Name' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the alert contact was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552356159000', 'title' => ''], + 'Lang' => ['description' => 'The language type of the alert. Valid values:'."\n" + .'- zh-cn: simplified Chinese.'."\n" + .'- en: English.', 'type' => 'string', 'example' => 'zh-cn', 'title' => ''], + 'Desc' => ['description' => 'The description.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => 'None.', + 'type' => 'array', + 'items' => ['description' => 'The alert contact groups.', 'type' => 'string', 'example' => '{ "ContactGroup": [ "ECS_Group", "Jim" ] }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Channels' => [ + 'description' => 'The alert notification methods.', + 'type' => 'object', + 'properties' => [ + 'Mail' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'Alice@example.com', 'title' => ''], + 'AliIM' => ['description' => 'The TradeManager name.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'DingWebHook' => ['description' => 'The webhook URL of the DingTalk chatbot.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****', 'title' => ''], + 'SMS' => ['description' => 'The mobile phone number.', 'type' => 'string', 'example' => '1333333****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ChannelsState' => [ + 'description' => 'The status of the alert channel.'."\n" + ."\n" + .'<props="china">Text messages, phone numbers, and email addresses must be activated before they can be used. When you add or modify an alert channel, the status is PENDING if the channel is not activated, and OK if the channel is activated.</props>'."\n" + ."\n" + .'<props="intl">Email addresses must be activated before they can be used. When you add or modify an alert channel, the status is PENDING if the channel is not activated, and OK if the channel is activated.</props>'."\n" + ."\n" + .'<props="partner">Email addresses must be activated before they can be used. When you add or modify an alert channel, the status is PENDING if the channel is not activated, and OK if the channel is activated.</props>.', + 'type' => 'object', + 'properties' => [ + 'Mail' => ['description' => 'The status of the email address. Valid values:'."\n" + .'- PENDING: The alert channel is not activated. Activate it before use.'."\n" + .'- OK: The alert channel is normal and alerts can be sent.', 'type' => 'string', 'example' => 'PENDING', 'title' => ''], + 'AliIM' => ['description' => 'The status of the TradeManager name is normal.'."\n" + ."\n" + .'Currently, only the value OK is supported. OK indicates that the TradeManager name is normal, the corresponding alert channel is normal, and alerts can be sent.'."\n" + ."\n" + .'> This parameter is applicable only to the China site.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'DingWebHook' => ['description' => 'The status of the DingTalk chatbot is normal.'."\n" + ."\n" + .'Currently, only the value OK is supported. OK indicates that the DingTalk chatbot is normal, the corresponding alert channel is normal, and alerts can be sent.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'SMS' => ['description' => 'The status of text messages. Valid values:'."\n" + .'- PENDING: The alert channel is not activated. Activate it before use.'."\n" + .'- OK: The alert channel is normal and alerts can be sent.'."\n" + ."\n" + .'> This parameter is applicable only to the China site.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"131DD9C8-9A32-4428-AD2E-4E3013B6E3A7\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>success</Message>\\n<RequestId>131DD9C8-9A32-4428-AD2E-4E3013B6E3A7</RequestId>\\n<Code>200</Code>","errorExample":""}]', - 'title' => 'PutCustomEvent', + 'title' => 'Query alert contacts', + 'summary' => 'Calls the DescribeContactList operation to query a list of alert contacts.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutCustomMetric' => [ - 'summary' => 'Reports monitoring data.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeContactList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83\\",\\n \\"Total\\": 15,\\n \\"Success\\": true,\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n {\\n \\"UpdateTime\\": 1552356159000,\\n \\"Name\\": \\"Alice\\",\\n \\"CreateTime\\": 1552356159000,\\n \\"Lang\\": \\"zh-cn\\",\\n \\"Desc\\": \\"ECS\\",\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"{ \\\\\\"ContactGroup\\\\\\": [ \\\\t\\\\\\"ECS_Group\\\\\\", \\\\\\"Jim\\\\\\" ] }\\"\\n ]\\n },\\n \\"Channels\\": {\\n \\"Mail\\": \\"Alice@example.com\\",\\n \\"AliIM\\": \\"Alice\\",\\n \\"DingWebHook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****\\",\\n \\"SMS\\": \\"1333333****\\"\\n },\\n \\"ChannelsState\\": {\\n \\"Mail\\": \\"PENDING\\",\\n \\"AliIM\\": \\"OK\\",\\n \\"DingWebHook\\": \\"OK\\",\\n \\"SMS\\": \\"OK\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeContactListByContactGroup' => [ + 'summary' => 'Queries the alert contacts in an alert contact group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'MetricList', + 'name' => 'ContactGroupName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The monitoring data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitoring data. Valid values of N: 1 to 21. Valid values:'."\n" - ."\n" - .'* 0: raw data'."\n" - .'* 1: aggregate data'."\n" - ."\n" - .'> We recommend that you report aggregate data in both the aggregation periods of 60 seconds and 300 seconds. Otherwise, you cannot query monitoring data in a time span that is more than seven days.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0', - ], - 'MetricName' => [ - 'description' => 'The metric name. Valid values of N: 1 to 21. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_total', - ], - 'Time' => [ - 'description' => 'The timestamp when the metric data is generated. Valid values of N: 1 to 21. The timestamp can be in one of the following formats:'."\n" - ."\n" - .'* A UTC timestamp in the YYYY-MM-DDThh:mm:ssZ format. Example: 20171012T132456.888+0800.'."\n" - .'* A UNIX timestamp of the LONG type. Example: 1508136760000.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1508136760000', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group. Valid values of N: 1 to 21.'."\n" - ."\n" - .'> If the metric does not belong to any application group, enter 0.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - 'Values' => [ - 'description' => 'The collection of metric values. Valid values of N: 1 to 21.'."\n" - ."\n" - .'> If the Type parameter is set to 0, the keys in this parameter must be set to the specified value. CloudMonitor aggregates raw data in each aggregation period to generate multiple statistical values, such as the maximum value, the count, and the total value.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"value":10.5}', - ], - 'Dimensions' => [ - 'description' => 'The dimensions based on which the resources are queried. Valid values of N: 1 to 21.'."\n" - ."\n" - .'Set this parameter to a collection of key-value pairs. Format: `{"Key":"Value"}`.'."\n" - ."\n" - .'The key or value must be 1 to 64 bytes in length. Excessive characters are truncated.'."\n" - ."\n" - .'The key or value can contain letters, digits, periods (.), hyphens (-), underscores (\\_), forward slashes (/), and backslashes (\\\\).'."\n" - ."\n" - .'> Dimensions must be formatted as a JSON string in a specified order.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"sampleName1":"value1","sampleName2":"value2"}', - ], - 'Period' => [ - 'description' => 'The aggregation period. Valid values of N: 1 to 21. Unit: seconds. Valid values: 60 and 300.'."\n" - ."\n" - .'> If the Type parameter is set to 1, the Period parameter is required.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CloudMonitor', 'title' => ''], ], ], 'responses' => [ @@ -12630,271 +9394,171 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The request has failed due to a temporary failure of the server.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The group is not exists.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => 'The alert contacts that receive alert notifications.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => ['description' => 'The time when the alert contact was modified.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552323252000', 'title' => ''], + 'Name' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the alert contact was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552314252000', 'title' => ''], + 'Desc' => ['description' => 'The description of the alert contact.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'Channels' => [ + 'description' => 'The alert notification methods.', + 'type' => 'object', + 'properties' => [ + 'Mail' => ['description' => 'The email address of the alert contact.', 'type' => 'string', 'example' => 'alice@example.com', 'title' => ''], + 'AliIM' => ['description' => 'The TradeManager ID of the alert contact.'."\n" + ."\n" + .'> This parameter can be returned only on the China site (aliyun.com).', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'DingWebHook' => ['description' => 'The webhook URL of the DingTalk chatbot.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****', 'title' => ''], + 'SMS' => ['description' => 'The mobile number of the alert contact.'."\n" + ."\n" + .'> This parameter can be returned only on the China site (aliyun.com).', 'type' => 'string', 'example' => '1333333****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"RequestId\\": \\"05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0\\"\\n}","errorExample":""},{"type":"xml","example":"<PutCustomMetricResponse>\\n\\t<RequestId>75D115CE-5DA8-4647-9073-8F72BB85B6F7</RequestId>\\n\\t<Message>success</Message>\\n\\t<Code>200</Code>\\n</PutCustomMetricResponse>","errorExample":""}]', - 'title' => 'PutCustomMetric', - 'description' => '> We recommend that you call the [PutHybridMonitorMetricData](~~383455~~) operation of Hybrid Cloud Monitoring to report monitoring data.'."\n", + 'title' => 'DescribeContactListByContactGroup', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutCustomMetricRule' => [ - 'summary' => 'Creates a custom alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactListByContactGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeContactListByContactGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The group is not exists.\\",\\n \\"RequestId\\": \\"06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83\\",\\n \\"Success\\": true,\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n {\\n \\"UpdateTime\\": 1552323252000,\\n \\"Name\\": \\"Alice\\",\\n \\"CreateTime\\": 1552314252000,\\n \\"Desc\\": \\"ECS\\",\\n \\"Channels\\": {\\n \\"Mail\\": \\"alice@example.com\\",\\n \\"AliIM\\": \\"Alice\\",\\n \\"DingWebHook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****\\",\\n \\"SMS\\": \\"1333333****\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeCustomEventAttribute' => [ + 'summary' => 'Queries a custom event.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group to which the custom monitoring data belongs.'."\n" - ."\n" - .'> The value 0 indicates that the reported custom monitoring data does not belong to an application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7378****', - ], - ], - [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'> You can specify an existing ID to modify the corresponding alert rule or specify a new ID to create an alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MyRuleId1', - ], - ], - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CpuUsage', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'> For more information about how to obtain the metric name, see [DescribeCustomMetricList](~~115005~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_total', - ], - ], - [ - 'name' => 'Resources', - 'in' => 'query', - 'schema' => [ - 'description' => 'The custom monitoring data to which the alert rule applies. The value includes the application group ID to which the custom monitoring data belongs and the dimension to which the metric belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '[{"groupId":7378****,"dimension":"instanceId=i-hp3543t5e4sudb3s****"}]', - ], - ], - [ - 'name' => 'ContactGroups', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert contact groups. Separate multiple alert contact groups with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Group', - ], - ], - [ - 'name' => 'Webhook', - 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], - ], - [ - 'name' => 'EffectiveInterval', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The period of time during which the alert rule is effective. Valid values: 00:00 to 23:59.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-23:59', - ], + 'schema' => ['description' => 'The event name.', 'type' => 'string', 'required' => false, 'example' => 'test123', 'title' => ''], ], [ - 'name' => 'SilenceTime', + 'name' => 'EventId', 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400, which is equivalent to one day.'."\n" - ."\n" - .'> Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - 'default' => '86400', - ], + 'schema' => ['description' => 'The event ID.', 'type' => 'string', 'required' => false, 'example' => '123****', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cycle that is used to aggregate custom monitoring data. Unit: seconds Set the value to an integral multiple of 60. The original reporting cycle of custom monitoring data is used by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '300', - 'default' => '300', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '123****', 'title' => ''], ], [ - 'name' => 'EmailSubject', - 'in' => 'query', - 'schema' => [ - 'description' => 'The subject of the alert notification email.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'Threshold', + 'name' => 'SearchKeywords', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '90', - ], + 'schema' => ['description' => 'The keywords that are used to search for the event.'."\n" + ."\n" + .'- If you need to query the custom event whose content contains a and b, set the value to a and b.'."\n" + ."\n" + .'- If you need to query the custom event whose content contains a or b, set the value to a or b.', 'type' => 'string', 'required' => false, 'example' => 'cms', 'title' => ''], ], [ - 'name' => 'Level', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CRITICAL', - ], + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552224365971', 'title' => ''], ], [ - 'name' => 'EvaluationCount', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552227965971', 'title' => ''], ], [ - 'name' => 'Statistics', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The method used to calculate the metric value based on which alerts are triggered.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Average', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ComparisonOperator', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* `>=`'."\n" - .'* `=`'."\n" - .'* `<=`'."\n" - .'* `>`'."\n" - .'* `<`'."\n" - .'* `!=`'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '>=', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], ], 'responses' => [ @@ -12902,186 +9566,142 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. If the request was successful, the return value is null. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'ComparisonOperator is mandatory for this action.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65D50468-ECEF-48F1-A6E1-D952E89D9432', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'userId:173651113438**** and name:"BABEL_CHECK"', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'CustomEvents' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomEvent' => [ + 'description' => 'The event details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => ['description' => 'The time when the event occurred.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'example' => '1552199984000', 'title' => ''], + 'Name' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'BABEL_CHECK', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Content' => ['description' => 'The content of the event.', 'type' => 'string', 'example' => 'requestId:4975A6F3-19AC-4C01-BAD2-034DA07FEBB5, info:{"autoPay":false,"autoUseCoupon":false,"bid":"26842","buyerId":118935342242****,"commodities":[{"aliyunProduceCode":"cms","chargeType":"PREPAY","commodityCode":"cms_call_num","components":[{"componentCode":"phone_count","instanceProperty":[{"code":"phone_count","value":"500"}],"moduleAttrStatus":1}],"duration":6,"free":false,"orderParams":{"aliyunProduceCode":"cms"},"orderType":"BUY","prePayPostCharge":false,"pricingCycle":"Month","quantity":1,"refundSpecCode":"","renewChange":false,"specCode":"cms_call_num","specUpdate":false,"syncToSubscription":false,"upgradeInquireFinancialValue":true}],"fromApp":"commonbuy","orderParams":{"priceCheck":"true"},"payerId":118935342242****,"requestId":"ade3ad32-f58b-45d7-add4-ac542be3d8ec","skipChannel":false,"userId":118935342242****}', 'title' => ''], + 'Id' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '123', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 499 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"ComparisonOperator is mandatory for this action.\\",\\n \\"RequestId\\": \\"65D50468-ECEF-48F1-A6E1-D952E89D9432\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutCustomMetricRuleResponse>\\n\\t<Message></Message>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</PutCustomMetricRuleResponse>","errorExample":""}]', - 'title' => 'PutCustomMetricRule', - 'description' => 'Before you call this operation, call the PutCustomMetric operation to report custom monitoring data. For more information, see [PutCustomMetric](~~115004~~).'."\n", + 'title' => 'DescribeCustomEventAttribute', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeCustomMetricList' => [ - 'summary' => 'Queries the reported monitoring data.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEventAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeCustomEventAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"userId:173651113438**** and name:\\\\\\"BABEL_CHECK\\\\\\"\\",\\n \\"RequestId\\": \\"60912C8D-B340-4253-ADE7-61ACDFD25CFC\\",\\n \\"Success\\": \\"true\\",\\n \\"CustomEvents\\": {\\n \\"CustomEvent\\": [\\n {\\n \\"Time\\": \\"1552199984000\\",\\n \\"Name\\": \\"BABEL_CHECK\\",\\n \\"GroupId\\": \\"12345\\",\\n \\"Content\\": \\"requestId:4975A6F3-19AC-4C01-BAD2-034DA07FEBB5, info:{\\\\\\"autoPay\\\\\\":false,\\\\\\"autoUseCoupon\\\\\\":false,\\\\\\"bid\\\\\\":\\\\\\"26842\\\\\\",\\\\\\"buyerId\\\\\\":118935342242****,\\\\\\"commodities\\\\\\":[{\\\\\\"aliyunProduceCode\\\\\\":\\\\\\"cms\\\\\\",\\\\\\"chargeType\\\\\\":\\\\\\"PREPAY\\\\\\",\\\\\\"commodityCode\\\\\\":\\\\\\"cms_call_num\\\\\\",\\\\\\"components\\\\\\":[{\\\\\\"componentCode\\\\\\":\\\\\\"phone_count\\\\\\",\\\\\\"instanceProperty\\\\\\":[{\\\\\\"code\\\\\\":\\\\\\"phone_count\\\\\\",\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"}],\\\\\\"moduleAttrStatus\\\\\\":1}],\\\\\\"duration\\\\\\":6,\\\\\\"free\\\\\\":false,\\\\\\"orderParams\\\\\\":{\\\\\\"aliyunProduceCode\\\\\\":\\\\\\"cms\\\\\\"},\\\\\\"orderType\\\\\\":\\\\\\"BUY\\\\\\",\\\\\\"prePayPostCharge\\\\\\":false,\\\\\\"pricingCycle\\\\\\":\\\\\\"Month\\\\\\",\\\\\\"quantity\\\\\\":1,\\\\\\"refundSpecCode\\\\\\":\\\\\\"\\\\\\",\\\\\\"renewChange\\\\\\":false,\\\\\\"specCode\\\\\\":\\\\\\"cms_call_num\\\\\\",\\\\\\"specUpdate\\\\\\":false,\\\\\\"syncToSubscription\\\\\\":false,\\\\\\"upgradeInquireFinancialValue\\\\\\":true}],\\\\\\"fromApp\\\\\\":\\\\\\"commonbuy\\\\\\",\\\\\\"orderParams\\\\\\":{\\\\\\"priceCheck\\\\\\":\\\\\\"true\\\\\\"},\\\\\\"payerId\\\\\\":118935342242****,\\\\\\"requestId\\\\\\":\\\\\\"ade3ad32-f58b-45d7-add4-ac542be3d8ec\\\\\\",\\\\\\"skipChannel\\\\\\":false,\\\\\\"userId\\\\\\":118935342242****}\\",\\n \\"Id\\": \\"123\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeCustomEventCount' => [ + 'summary' => 'Queries the number of times that a custom event occurred within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'For information about how to query the IDs of application groups, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7378****', - ], + 'schema' => ['description' => 'The event name.', 'type' => 'string', 'required' => false, 'example' => 'BABEL_BUY', 'title' => ''], ], [ - 'name' => 'MetricName', + 'name' => 'EventId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the custom metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], + 'schema' => ['description' => 'The event ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ - 'name' => 'Dimension', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The dimensions based on which the resources are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{sampleName1=value1&sampleName2=value2}', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'Md5', + 'name' => 'SearchKeywords', 'in' => 'query', - 'schema' => [ - 'description' => 'The MD5 value of the HTTP request body. The MD5 value is a 128-bit hash value used to verify the uniqueness of the reported monitoring data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '97c25982d9745a231276bff27469****', - ], + 'schema' => ['description' => 'The keywords that are used to search for the event.'."\n" + ."\n" + .'- If you need to query the custom event whose content contains a and b, set the value to a and b.'."\n" + ."\n" + .'- If you need to query the custom event whose content contains a or b, set the value to a or b.', 'type' => 'string', 'required' => false, 'example' => 'cms', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552209685596', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Pages start from page 1. Default value: 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552220485596', 'title' => ''], ], ], 'responses' => [ @@ -13089,136 +9709,147 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AF425E4-1DEA-54F2-910A-8117C9686140', - ], - 'Result' => [ - 'description' => 'The reported custom metrics that are found in the query.'."\n", - 'type' => 'string', - 'example' => '{\\"all\\":0,\\"size\\":10,\\"param\\":{\\"metric\\":\\"{\\\\\\"metricName\\\\\\":\\\\\\"cpu_total\\\\\\",\\\\\\"groupId\\\\\\":7378****,\\\\\\"project\\\\\\":\\\\\\"acs_customMetric_120886317861****\\\\\\",\\\\\\"dimension\\\\\\":\\\\\\"sampleName1=value1&sampleName2=value2\\\\\\",\\\\\\"status\\\\\\":1}\\",\\"service\\":\\"metric-center.aliyun-inc.com\\"},\\"page\\":1,\\"list\\":[]}', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CustomEventCounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomEventCount' => [ + 'description' => 'The details of the custom event.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => ['description' => 'The time when the event occurred.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552267615000', 'title' => ''], + 'Num' => ['description' => 'The number of times that the custom event occurred.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Name' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'BABEL_BUY', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1AF425E4-1DEA-54F2-910A-8117C9686140\\",\\n \\"Result\\": \\"{\\\\\\\\\\\\\\"all\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"size\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"param\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"metric\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"metricName\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"cpu_total\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"groupId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":7378****,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"project\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"acs_customMetric_120886317861****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"dimension\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"sampleName1=value1&sampleName2=value2\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"service\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"metric-center.aliyun-inc.com\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"page\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"list\\\\\\\\\\\\\\":[]}\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomMetricListResponse>\\r\\n\\t<Message>success</Message>\\r\\n\\t<RequestId>1AF425E4-1DEA-54F2-910A-8117C9686140</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Result>{\\\\\\"all\\\\\\":0,\\\\\\"size\\\\\\":10,\\\\\\"param\\\\\\":{\\\\\\"metric\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"metricName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cpu_total\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"groupId\\\\\\\\\\\\\\":7378****,\\\\\\\\\\\\\\"project\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"acs_customMetric_120886317861****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dimension\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sampleName1=value1&=value2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":1}\\\\\\",\\\\\\"service\\\\\\":\\\\\\"metric-center.aliyun-inc.com\\\\\\"},\\\\\\"page\\\\\\":1,\\\\\\"list\\\\\\":[]}</Result>\\r\\n</DescribeCustomMetricListResponse>\\t","errorExample":""}]', - 'title' => 'DescribeCustomMetricList', - 'description' => '> You can call the DescribeMetricList operation to query the metrics of cloud services. For more information, see [DescribeMetricList](~~51936~~).'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeCustomEventCount', + 'description' => '> This operation queries the number of times that a custom event occurred for each service.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteCustomMetric' => [ - 'summary' => 'Deletes the reported monitoring data of a metric.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEventCount'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeCustomEventCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"60912C8D-B340-4253-ADE7-61ACDFD25CFC\\",\\n \\"Success\\": true,\\n \\"CustomEventCounts\\": {\\n \\"CustomEventCount\\": [\\n {\\n \\"Time\\": 1552267615000,\\n \\"Num\\": 20,\\n \\"Name\\": \\"BABEL_BUY\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeCustomEventHistogram' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The event name.', 'type' => 'string', 'required' => false, 'example' => 'BucketIngressBandwidth', 'title' => ''], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => 'The severity level of the event. Valid values:'."\n" + ."\n" + .'- CRITICAL'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .'- INFO', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL', 'title' => ''], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => ['description' => 'The event ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3607****', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'MetricName', + 'name' => 'SearchKeywords', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'AdvanceCredit', - ], + 'schema' => ['description' => 'The keywords that are used to search for the event.'."\n" + ."\n" + .'- If you need to query the custom event whose content contains a and b, set the value to "a and b".'."\n" + ."\n" + .'- If you need to query the custom event whose content contains a or b, set the value to "a or b".', 'type' => 'string', 'required' => false, 'example' => 'cms', 'title' => ''], ], [ - 'name' => 'Md5', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The MD5 value of the HTTP request body. The MD5 value is a 128-bit hash value used to verify the uniqueness of the reported monitoring data.'."\n" - ."\n" - .'> `Md5` is returned when you query the reported monitoring data of a metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '38796C8CFFEB8F89BB2A626C7BD7****', - ], + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552209685596', 'title' => ''], ], [ - 'name' => 'UUID', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request for reporting monitoring data.'."\n" - ."\n" - .'> `UUID` is returned when you query the reported monitoring data of a metric. We recommend that you specify the `Md5` parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5497633c-66c5-4eae-abaa-89db5adb****', - ], + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552220485596', 'title' => ''], ], ], 'responses' => [ @@ -13226,315 +9857,137 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'EventHistograms' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventHistogram' => [ + 'description' => 'The information about the number of times that the custom event occurred during each interval of the specified time period.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552226750000', 'title' => ''], + 'StartTime' => ['description' => 'The start time.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552226740000', 'title' => ''], + 'Count' => ['description' => 'The information about the number of times that the custom event occurred during an interval of the specified time period.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomMetric>\\n\\t\\t<Message>success</Message>\\n\\t\\t<RequestId>05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0</RequestId>\\n\\t\\t<Code>200</Code>\\n</DeleteCustomMetric>","errorExample":""}]', - 'title' => 'DeleteCustomMetric', + 'title' => 'DescribeCustomEventHistogram', + 'summary' => 'Queries the number of times that a custom event occurred during each interval within a period of time.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutLogMonitor' => [ - 'summary' => 'Creates or modifies a log monitoring metric.', - 'methods' => [ - 'post', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEventHistogram'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeCustomEventHistogram', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"486029C9-53E1-44B4-85A8-16A571A043FD\\",\\n \\"Success\\": \\"true\\",\\n \\"EventHistograms\\": {\\n \\"EventHistogram\\": [\\n {\\n \\"EndTime\\": 1552226750000,\\n \\"StartTime\\": 1552226740000,\\n \\"Count\\": 3\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeCustomMetricList' => [ + 'summary' => 'Queries the reported monitoring data.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'LogId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the log monitoring metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '16****', - ], - ], - [ - 'name' => 'SlsRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region in which the Simple Log Service project resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'SlsProject', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Simple Log Service project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], - ], - [ - 'name' => 'SlsLogstore', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Simple Log Service Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. For more information about the metrics for cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_total', - ], - ], - [ - 'name' => 'MetricExpress', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extended field. The extended field allows you to perform basic operations on the aggregation results.'."\n" - ."\n" - .'For example, you have calculated TotalNumber and 5XXNumber by aggregating the data. TotalNumber indicates the total number of HTTP requests, and 5XXNumber indicates the number of HTTP requests whose status code is greater than 499. You can calculate the server error rate by adding the following formula to the extended field: 5XXNumber/TotalNumber\\*100.'."\n" - ."\n" - .'JSON format: {"extend":{"errorPercent":"5XXNumber/TotalNumber\\*100"}}. Description:'."\n" - ."\n" - .'* extend: required.'."\n" - .'* errorPercent: the alias of the field generated in the calculation result. You can specify the alias as needed.'."\n" - .'* 5XXNumber/TotalNumber\\*100: the calculation expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"extend":{"errorPercent":"5XXNumber/TotalNumber*100"}}', - ], - ], - [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7301****', - ], + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For information about how to query the IDs of application groups, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'example' => '7378****', 'title' => ''], ], [ - 'name' => 'ValueFilterRelation', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The logical operator that is used between log filter conditions. Valid values:'."\n" - ."\n" - .'* and'."\n" - .'* or'."\n" - ."\n" - .'> The ValueFilterRelation and `ValueFilter.N.Key` parameters must be used in pair.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'and', - ], + 'schema' => ['description' => 'The name of the custom metric.', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], ], [ - 'name' => 'Tumblingwindows', - 'in' => 'query', - 'schema' => [ - 'description' => 'The size of the tumbling window for calculation. Unit: seconds. CloudMonitor performs aggregation for each tumbling window.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60,300', - ], - ], - [ - 'name' => 'Unit', + 'name' => 'Dimension', 'in' => 'query', - 'schema' => [ - 'description' => 'The unit.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Percent', - ], + 'schema' => ['description' => 'The dimensions based on which the resources are queried.', 'type' => 'string', 'required' => false, 'example' => '{sampleName1=value1&sampleName2=value2}', 'title' => ''], ], [ - 'name' => 'Aggregates', + 'name' => 'Md5', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The aggregation logic.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FieldName' => [ - 'description' => 'The name of the field to be aggregated. Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sourceCount', - ], - 'Function' => [ - 'description' => 'The function that is used to aggregate log data within a statistical period. Valid values of N: 1 to 10. Valid values:'."\n" - ."\n" - .'* count: counts the number.'."\n" - .'* sum: calculates the total value.'."\n" - .'* avg: calculates the average value.'."\n" - .'* max: calculates the maximum value.'."\n" - .'* min: calculates the minimum value.'."\n" - .'* countps: calculates the number of values of the specified field divided by the total number of seconds within a statistical period.'."\n" - .'* sumps: calculates the sum of the values of the specified field divided by the total number of seconds within a statistical period.'."\n" - .'* distinct: calculates the number of unique values of the specified field within a statistical period.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'count', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregate function. Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Count', - ], - ], - 'required' => false, - 'description' => 'The aggregation logic.', - ], - 'required' => true, - 'maxItems' => 10, - ], + 'schema' => ['description' => 'The MD5 value of the HTTP request body. The MD5 value is a 128-bit hash value used to verify the uniqueness of the reported monitoring data.', 'type' => 'string', 'required' => false, 'example' => '97c25982d9745a231276bff27469****', 'title' => ''], ], [ - 'name' => 'Groupbys', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The dimension based on which the data is grouped. This parameter is equivalent to the GROUP BY clause in SQL statements. If no dimension is specified, all data is aggregated based on the aggregate function.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FieldName' => [ - 'description' => 'The name of the field that is specified as the dimension. Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu', - ], - 'Alias' => [ - 'description' => 'The alias of the dimension based on which the data is grouped. Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CPUUtilization', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 10, - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ValueFilter', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The condition that is used to filter logs. The ValueFilter and ValueFilterRelation parameters are used in pair. The filter condition is equivalent to the WHERE clause in SQL statements. If no filter condition is specified, all logs are processed. For example, logs contain the Level and Error fields. If you need to calculate the number of times that logs of the Error level appear every minute, you can set the filter condition to Level=Error and count the number of logs that meet this condition.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The name of the log field that is used for matching in the filter condition. Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'lh_source', - ], - 'Value' => [ - 'description' => 'The field value to be matched in the filter condition. Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Operator' => [ - 'description' => 'The method that is used to match the field value. Valid values of N: 1 to 10. Valid values:'."\n" - ."\n" - .'* `contain`: contains'."\n" - .'* `notContain`: does not contain'."\n" - .'* `>`: greater than'."\n" - .'* `<`: less than'."\n" - .'* `>=`: greater than or equal to'."\n" - .'* `<=`: less than or equal to'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'contain', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Pages start from page 1. Default value: 10.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -13542,461 +9995,337 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'* If the request was successful, `successful` is returned.'."\n" - .'* If the request failed, an error message is returned. Example: `alias of aggreate must be set value.`'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '91561287-0802-5F9C-9BDE-404C50D41B06', - ], - 'LogId' => [ - 'description' => 'The ID of the log monitoring metric.'."\n", - 'type' => 'string', - 'example' => '16****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AF425E4-1DEA-54F2-910A-8117C9686140', 'title' => ''], + 'Result' => ['description' => 'The reported custom metrics that are found in the query.', 'type' => 'string', 'example' => '{\\"all\\":0,\\"size\\":10,\\"param\\":{\\"metric\\":\\"{\\\\\\"metricName\\\\\\":\\\\\\"cpu_total\\\\\\",\\\\\\"groupId\\\\\\":7378****,\\\\\\"project\\\\\\":\\\\\\"acs_customMetric_120886317861****\\\\\\",\\\\\\"dimension\\\\\\":\\\\\\"sampleName1=value1&sampleName2=value2\\\\\\",\\\\\\"status\\\\\\":1}\\",\\"service\\":\\"metric-center.aliyun-inc.com\\"},\\"page\\":1,\\"list\\":[]}', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'LimitorError', - 'errorMessage' => 'Log monitor limit is not enough', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"91561287-0802-5F9C-9BDE-404C50D41B06\\",\\n \\"LogId\\": \\"16****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutLogMonitorResponse>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>91561287-0802-5F9C-9BDE-404C50D41B06</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<LogId>16****</LogId>\\r\\n\\t<Success>true</Success>\\r\\n</PutLogMonitorResponse>","errorExample":""}]', - 'title' => 'PutLogMonitor', - 'description' => 'In the example of this topic, the `cpu_total` log monitoring metric is created. The response shows that the log monitoring metric is created and the metric ID is `16****`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeCustomMetricList', + 'description' => '> You can call the DescribeMetricList operation to query the metrics of cloud services. For more information, see [DescribeMetricList](~~51936~~).', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteLogMonitor' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomMetricList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeCustomMetricList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1AF425E4-1DEA-54F2-910A-8117C9686140\\",\\n \\"Result\\": \\"{\\\\\\\\\\\\\\"all\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"size\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"param\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"metric\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"metricName\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"cpu_total\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"groupId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":7378****,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"project\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"acs_customMetric_120886317861****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"dimension\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"sampleName1=value1&sampleName2=value2\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"service\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"metric-center.aliyun-inc.com\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"page\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"list\\\\\\\\\\\\\\":[]}\\"\\n}","type":"json"}]', + ], + 'DescribeDynamicTagRuleList' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'LogId', + 'name' => 'TagRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the log monitoring metric.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'metric not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '42BFFC2B-5E4D-4FDE-BCC6-E91EE33C5967', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], - ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + 'schema' => ['description' => 'The region ID of the tag.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + 'name' => 'TagKey', + 'in' => 'query', + 'schema' => ['description' => 'The tag key.'."\n" + ."\n" + .'For more information about how to obtain a tag key, see [DescribeTagKeyList](~~145558~~).', 'type' => 'string', 'required' => false, 'example' => 'tagkey1', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"metric not exist.\\",\\n \\"RequestId\\": \\"42BFFC2B-5E4D-4FDE-BCC6-E91EE33C5967\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteLogMonitorResponse>\\n\\t\\t<RequestId>EBB5215C-44AB-4000-A2D7-48634FDC4F04</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</DeleteLogMonitorResponse>","errorExample":""}]', - 'title' => 'DeleteLogMonitor', - 'summary' => 'Deletes a log monitoring metric.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeLogMonitorList' => [ - 'summary' => 'Queries log monitoring metrics.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'TagValue', + 'in' => 'query', + 'schema' => ['description' => 'The tag value.'."\n" + ."\n" + .'For more information about how to obtain a tag value, see [DescribeTagValueList](~~145557~~).', 'type' => 'string', 'required' => false, 'example' => '*', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Start value: 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'SearchValue', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used to search for log monitoring metrics. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Start value: 1. Default value: 30.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'DynamicTagRuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '123456', - ], + 'schema' => ['description' => 'The ID of the dynamic tag rule.', 'type' => 'string', 'required' => false, 'example' => '004155fa-15ba-466d-b61a-***********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response that is returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '01E90080-4300-4FAA-B9AE-161956BC350D', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'LogMonitorList' => [ - 'description' => 'The log monitoring metrics.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ValueFilterRelation' => [ - 'description' => 'The logical operator that is used between log filter conditions. The ValueFilter and ValueFilterRelation parameters are used in pair. Valid values:'."\n" - ."\n" - .'* and'."\n" - .'* or'."\n", - 'type' => 'string', - 'example' => 'and', - ], - 'SlsLogstore' => [ - 'description' => 'The name of the Simple Log Service (SLS) Logstore.'."\n", - 'type' => 'string', - 'example' => 'testSlS****', - ], - 'MetricName' => [ - 'description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'LogId' => [ - 'description' => 'The ID of the log monitoring metric.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'SlsRegionId' => [ - 'description' => 'The ID of the region where the SLS Logstore resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'GmtCreate' => [ - 'description' => 'The time when the log monitoring metric was created.'."\n" - ."\n" - .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1577766395000', - ], - 'SlsProject' => [ - 'description' => 'The name of the SLS project.'."\n", - 'type' => 'string', - 'example' => 'sls-project-test****', - ], - 'ValueFilter' => [ - 'description' => 'The condition that is used to filter logs. The ValueFilter and ValueFilterRelation parameters are used in pair. The filter condition is equivalent to the WHERE clause in SQL statements. If no filter condition is specified, all logs are processed. For example, logs contain the Level and Error fields. If you need to calculate the number of times that logs of the Error level appear every minute, you can set the filter condition to Level=Error and count the number of logs that meet this condition.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The name of the log field used for matching in the filter condition.'."\n", - 'type' => 'string', - 'example' => 'hostName', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0D50523D-8D59-4A61-B58E-E2286ECFB3A9', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the operation was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries in the tag list.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'TagGroupList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagGroup' => [ + 'description' => 'The list of rules for the application groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The rule for the application group.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of tag sync to the application group.'."\n" + ."\n" + .'- `RUNNING`: The synchronization is in progress.'."\n" + ."\n" + .'- `FINISH`: The synchronization is complete.', 'type' => 'string', 'example' => 'FINISH', 'title' => ''], + 'MatchExpressFilterRelation' => ['description' => 'The relationship between conditional expressions. Valid values:'."\n" + ."\n" + .'- `and`'."\n" + ."\n" + .'- `or`'."\n" + ."\n" + .'> Only one combination of conditions is supported.', 'type' => 'string', 'example' => 'or', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the resource.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'tagkey1', 'title' => ''], + 'DynamicTagRuleId' => ['description' => 'The ID of the tag rule.', 'type' => 'string', 'example' => '1536df65-a719-429d-8813-73cc40d7****', 'title' => ''], + 'MatchExpress' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MatchExpress' => [ + 'description' => 'The matching expression used to create an application group from a tag.', + 'type' => 'array', + 'items' => [ + 'description' => 'The matching expression used to create an application group from a tag.', + 'type' => 'object', + 'properties' => [ + 'TagValue' => ['description' => 'The tag value.'."\n" + ."\n" + .'`TagValue` is used with `TagValueMatchFunction`.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'TagValueMatchFunction' => ['description' => 'The method used to match the tag value. Valid values:'."\n" + ."\n" + .'- all'."\n" + ."\n" + .'- startWith: prefix'."\n" + ."\n" + .'- endWith: suffix'."\n" + ."\n" + .'- contains'."\n" + ."\n" + .'- notContains'."\n" + ."\n" + .'- equals', 'type' => 'string', 'example' => 'all', 'title' => ''], + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'azone-version', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'Value' => [ - 'description' => 'The field value to be matched in the filter condition.'."\n", - 'type' => 'string', - 'example' => 'portal', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TemplateIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateIdList' => [ + 'description' => 'A list of alert template IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the alert template.', 'type' => 'string', 'example' => '71****', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'Operator' => [ - 'description' => 'The method that is used to match the field value. Valid values:'."\n" - ."\n" - .'* contain: contains'."\n" - .'* notContain: does not contain'."\n" - .'* `>`: greater than'."\n" - .'* `<`: less than'."\n" - .'* `>=`: greater than or equal to'."\n" - .'* `<=`: less than or equal to'."\n", - 'type' => 'string', - 'example' => 'contain', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ContactGroupList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroupList' => [ + 'description' => 'A list of alert contact groups.', + 'type' => 'array', + 'items' => ['description' => 'The alert contact group.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TagValueBlacklist' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagValueBlacklist' => [ + 'type' => 'array', + 'items' => ['description' => 'The value of a tag.', 'type' => 'string', 'example' => 'test、offline', 'title' => ''], + 'description' => 'The tag values that are not processed by the dynamic rule. When a user deletes a dynamic tag group, the tag values of the group are added to a blacklist. If a new resource is later added with a blacklisted tag value, a corresponding group is not created.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'description' => '', ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'description' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"01E90080-4300-4FAA-B9AE-161956BC350D\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 15,\\n \\"LogMonitorList\\": [\\n {\\n \\"ValueFilterRelation\\": \\"and\\",\\n \\"SlsLogstore\\": \\"testSlS****\\",\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"GroupId\\": 12345,\\n \\"LogId\\": 12345,\\n \\"SlsRegionId\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": 1577766395000,\\n \\"SlsProject\\": \\"sls-project-test****\\",\\n \\"ValueFilter\\": [\\n {\\n \\"Key\\": \\"hostName\\",\\n \\"Value\\": \\"portal\\",\\n \\"Operator\\": \\"contain\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeLogMonitorListResponse>\\r\\n\\t\\t<Message>successful</Message>\\r\\n\\t\\t<RequestId>C085617E-7A64-402E-877D-410E86174B0C</RequestId>\\r\\n\\t\\t<PageSize>10</PageSize>\\r\\n\\t\\t<Total>2</Total>\\r\\n\\t\\t<LogMonitorList>\\r\\n\\t\\t\\t<SlsProject>sls-project-test****</SlsProject>\\r\\n\\t\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t\\t<GmtCreate>1591175112000</GmtCreate>\\r\\n\\t\\t\\t<ValueFilterRelation>and</ValueFilterRelation>\\r\\n\\t\\t\\t<LogId>12345</LogId>\\r\\n\\t\\t\\t<SlsRegionId>cn-hangzhou</SlsRegionId>\\r\\n\\t\\t\\t<SlsLogstore>testSlS****</SlsLogstore>\\r\\n\\t\\t\\t<GroupId>12345</GroupId>\\r\\n\\t\\t</LogMonitorList>\\r\\n\\t\\t<LogMonitorList>\\r\\n\\t\\t\\t<SlsProject>sls-project-test****</SlsProject>\\r\\n\\t\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t\\t<GmtCreate>1586826787000</GmtCreate>\\r\\n\\t\\t\\t<ValueFilterRelation>and</ValueFilterRelation>\\r\\n\\t\\t\\t<ValueFilter>\\r\\n\\t\\t\\t\\t<Operator>=</Operator>\\r\\n\\t\\t\\t\\t<Value>1</Value>\\r\\n\\t\\t\\t\\t<Key>lh_source</Key>\\r\\n\\t\\t\\t</ValueFilter>\\r\\n\\t\\t\\t<LogId>12345</LogId>\\r\\n\\t\\t\\t<SlsRegionId>cn-hangzhou</SlsRegionId>\\r\\n\\t\\t\\t<SlsLogstore>internal-alert-history</SlsLogstore>\\r\\n\\t\\t\\t<GroupId>12345</GroupId>\\r\\n\\t\\t</LogMonitorList>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeLogMonitorListResponse>\\r\\n","errorExample":""}]', - 'title' => 'DescribeLogMonitorList', - 'requestParamsDescription' => ' ', + 'title' => 'DescribeDynamicTagRuleList', + 'summary' => 'Call the DescribeDynamicTagRuleList operation to query the rules for dynamic tags.', + 'description' => 'This topic provides an example of how to query the rules for the tag key `tagkey1`. The response shows that two rules are returned. The rule IDs are `1536df65-a719-429d-8813-73cc40d7****` and `56e8cebb-b3d7-4a91-9880-78a8c84f****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeLogMonitorAttribute' => [ - 'summary' => 'Queries the details of a log monitoring metric.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2024-03-13T08:11:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-14T08:13:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-11-04T05:58:44.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDynamicTagRuleList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeDynamicTagRuleList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0D50523D-8D59-4A61-B58E-E2286ECFB3A9\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageSize\\": \\"30\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Total\\": 2,\\n \\"TagGroupList\\": {\\n \\"TagGroup\\": [\\n {\\n \\"Status\\": \\"FINISH\\",\\n \\"MatchExpressFilterRelation\\": \\"or\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"TagKey\\": \\"tagkey1\\",\\n \\"DynamicTagRuleId\\": \\"1536df65-a719-429d-8813-73cc40d7****\\",\\n \\"MatchExpress\\": {\\n \\"MatchExpress\\": [\\n {\\n \\"TagValue\\": \\"*\\",\\n \\"TagValueMatchFunction\\": \\"all\\",\\n \\"TagKey\\": \\"azone-version\\"\\n }\\n ]\\n },\\n \\"TemplateIdList\\": {\\n \\"TemplateIdList\\": [\\n \\"71****\\"\\n ]\\n },\\n \\"ContactGroupList\\": {\\n \\"ContactGroupList\\": [\\n \\"CloudMonitor\\"\\n ]\\n },\\n \\"TagValueBlacklist\\": {\\n \\"TagValueBlacklist\\": [\\n \\"test、offline\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeEventRuleAttribute' => [ + 'summary' => 'Queries the details of a specified event-triggered alert rule by calling the DescribeEventRuleAttribute operation.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'MetricName', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. Exact match is supported.'."\n" - ."\n" - .'For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cpu_total', - ], + 'schema' => ['description' => 'The name of the event-triggered alert rule.'."\n" + ."\n" + .'For information about how to obtain the name of an event-triggered alert rule, see [DescribeEventRuleList](~~114996~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testRule', 'title' => ''], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => ['description' => 'The mute period.'."\n" + ."\n" + .'Unit: seconds. Default value: 86400 (1 day).'."\n" + ."\n" + .'> When monitoring data continuously exceeds the alert rule threshold, only one alert notification is sent within each mute period.', 'type' => 'string', 'required' => false, 'example' => '86400', 'title' => ''], ], ], 'responses' => [ @@ -14004,547 +10333,479 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C6718537-E673-4A58-8EE1-24B8B38C7AAE', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'LogMonitor' => [ - 'description' => 'The details of the log monitoring metric.'."\n", + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The alert does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9AA3F210-C03D-4C86-8DB6-21C84FF692A1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Result' => [ + 'description' => 'The details of the event-triggered alert rule.', 'type' => 'object', 'properties' => [ - 'ValueFilterRelation' => [ - 'description' => 'The logical operator that is used between log filter conditions. The ValueFilter and ValueFilterRelation parameters must be used in pair. Valid values:'."\n" - ."\n" - .'* and'."\n" - .'* or'."\n", - 'type' => 'string', - 'example' => 'and', - ], - 'SlsLogstore' => [ - 'description' => 'The name of the Simple Log Service Logstore.'."\n", - 'type' => 'string', - 'example' => 'test-logstore', - ], - 'MetricName' => [ - 'description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'LogId' => [ - 'description' => 'The ID of the log.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'MetricExpress' => [ - 'description' => 'The extended field. The extended field allows you to perform basic operations on the aggregation results.'."\n" - ."\n" - .'For example, if you have calculated TotalNumber and 5XXNumber by aggregating the data. TotalNumber indicates the total number of HTTP requests, and 5XXNumber indicates the number of HTTP requests whose status code is greater than 499. You can calculate the server error rate by adding the following formula to the extended field: 5XXNumber/TotalNumber\\*100.'."\n", - 'type' => 'string', - 'example' => '{"extend":{"errorPercent":"5XXNumber/TotalNumber*100"}}', - ], - 'SlsRegionId' => [ - 'description' => 'The ID of the region where the Simple Log Service (SLS) Logstore resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'GmtCreate' => [ - 'description' => 'The time when the metric was created.'."\n" - ."\n" - .'This value is a UNIX timestamp that represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1547431398000', - ], - 'SlsProject' => [ - 'description' => 'The name of the SLS project.'."\n", - 'type' => 'string', - 'example' => 'test-project', - ], - 'Aggregates' => [ - 'description' => 'The aggregation logic.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Max' => [ - 'description' => 'The maximum value.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Min' => [ - 'description' => 'The minimum value.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Function' => [ - 'description' => 'The function that is used to aggregate the monitoring data of logs within a statistical period. Valid values:'."\n" - ."\n" - .'* count: counts the number'."\n" - .'* sum: calculates the total value'."\n" - .'* avg: calculates the average value'."\n" - .'* max: calculates the maximum value'."\n" - .'* min: calculates the minimum value'."\n" - .'* countps: calculates the number of values of the specified field divided by the total number of seconds within a statistical period'."\n" - .'* sumps: calculates the sum of the values of the specified field divided by the total number of seconds within a statistical period'."\n" - .'* distinct: calculates the number of unique values of the specified field within a statistical period'."\n", - 'type' => 'string', - 'example' => 'count', - ], - 'Alias' => [ - 'description' => 'The alias of the field.'."\n", - 'type' => 'string', - 'example' => 'HostName', + 'EventType' => ['description' => 'The event type. Valid values:'."\n" + ."\n" + .'- SYSTEM: system event.'."\n" + ."\n" + .'- CUSTOM: custom event.', 'type' => 'string', 'example' => 'SYSTEM', 'title' => ''], + 'GroupId' => ['description' => 'The application group ID.', 'type' => 'string', 'example' => '3607****', 'title' => ''], + 'Name' => ['description' => 'The name of the event-triggered alert rule.', 'type' => 'string', 'example' => 'test_DefaultEventRule_7378****', 'title' => ''], + 'Description' => ['description' => 'The description of the event-triggered alert rule.', 'type' => 'string', 'example' => 'Default group event rule.', 'title' => ''], + 'State' => ['description' => 'The status of the event-triggered alert rule. Valid values:'."\n" + ."\n" + .'- ENABLED: enabled.'."\n" + ."\n" + .'- DISABLED: disabled.', 'type' => 'string', 'example' => 'ENABLED', 'title' => ''], + 'EventPattern' => [ + 'description' => 'The event pattern. Describes the trigger conditions of the event.', + 'type' => 'object', + 'properties' => [ + 'Product' => ['description' => 'The name of the cloud service.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + 'LevelList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LevelList' => [ + 'description' => 'The list of levels for the event-triggered alert rule.', + 'type' => 'array', + 'items' => ['description' => 'The level of the event-triggered alert rule. Valid values:'."\n" + ."\n" + .'- CRITICAL: critical.'."\n" + ."\n" + .'- WARN: warning.'."\n" + ."\n" + .'- INFO: information.', 'type' => 'string', 'example' => '["CRITICAL","WARN"] ', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'FieldName' => [ - 'description' => 'The name of the field in logs.'."\n", - 'type' => 'string', - 'example' => 'hostName', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'StatusList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StatusList' => [ + 'description' => 'The list of statuses for the event-triggered alert rule.', + 'type' => 'array', + 'items' => ['description' => 'The event status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'description' => '', - ], - ], - 'ValueFilter' => [ - 'description' => 'The condition that is used to filter logs. The ValueFilter and ValueFilterRelation parameters are used in pair. The filter condition is equivalent to the WHERE clause in SQL statements.'."\n" - ."\n" - .'If no filter condition is specified, all logs are processed. For example, logs contain the Level and Error fields. If you need to calculate the number of times that logs of the Error level appear every minute, you can set the filter condition to Level=Error and count the number of logs that meet this condition.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The name of the log field used for matching in the filter condition.'."\n", - 'type' => 'string', - 'example' => 'hostName', + 'NameList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NameList' => [ + 'description' => 'The list of names for the event-triggered alert rule.', + 'type' => 'array', + 'items' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'Agent_Status_Running', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'Value' => [ - 'description' => 'The field value to be matched in the filter condition.'."\n", - 'type' => 'string', - 'example' => 'portal', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EventTypeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventTypeList' => [ + 'description' => 'The list of types for the event-triggered alert rule.', + 'type' => 'array', + 'items' => ['description' => 'The type of the event-triggered alert rule.'."\n" + ."\n" + .'`*` indicates that the alert rule type is not restricted.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'Operator' => [ - 'description' => 'The method that is used to match the field value. Valid values:'."\n" + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SQLFilter' => ['description' => 'Filters logs by using SQL statements. An alert is triggered if the filter conditions are met.', 'type' => 'string', 'example' => 'ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222', 'title' => ''], + 'KeywordFilterObj' => [ + 'description' => 'The filter keyword.', + 'type' => 'object', + 'properties' => [ + 'Keywords' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'keyword' => [ + 'description' => 'The list of keywords that match the event.', + 'type' => 'array', + 'items' => ['description' => 'The keyword.', 'type' => 'string', 'example' => 'VMException', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Relation' => ['description' => 'The condition for multiple keywords. Valid values:'."\n" ."\n" - .'* `contain`: contains'."\n" - .'* `notContain`: does not contain'."\n" - .'* `>`: greater than'."\n" - .'* `<`: less than'."\n" - .'* `>=`: greater than or equal to'."\n" - .'* `<=`: less than or equal to'."\n", - 'type' => 'string', - 'example' => 'contain', + .'- OR: The relationship between multiple keywords is OR.'."\n" + .'- NOT: Does not contain the keyword. Matches all events that are not in the keyword list.', 'type' => 'string', 'example' => 'OR', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'description' => '', - ], - ], - 'Tumblingwindows' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The size of the tumbling window for calculation. Unit: seconds The system performs an aggregation for each tumbling window.'."\n", - 'type' => 'string', - 'example' => '60', ], - 'description' => '', - ], - 'Groupbys' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The dimension based on which the data is grouped. This parameter is equivalent to the GROUP BY clause in SQL statements. If no dimension is specified, all data is aggregated based on the aggregate function.'."\n", - 'type' => 'string', - 'example' => 'value', - ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"C6718537-E673-4A58-8EE1-24B8B38C7AAE\\",\\n \\"Success\\": true,\\n \\"LogMonitor\\": {\\n \\"ValueFilterRelation\\": \\"and\\",\\n \\"SlsLogstore\\": \\"logstore_******\\",\\n \\"MetricName\\": \\"cpu_total_******\\",\\n \\"GroupId\\": 0,\\n \\"LogId\\": 0,\\n \\"MetricExpress\\": \\"{}\\",\\n \\"SlsRegionId\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": 1678440033000,\\n \\"SlsProject\\": \\"project_******\\",\\n \\"Aggregates\\": [\\n {\\n \\"Max\\": \\"0\\",\\n \\"Min\\": \\"0\\",\\n \\"Function\\": \\"count\\",\\n \\"Alias\\": \\"alias_******\\",\\n \\"FieldName\\": \\"field_******\\"\\n }\\n ],\\n \\"ValueFilter\\": [\\n {\\n \\"Key\\": \\"key_******\\",\\n \\"Value\\": \\"value_******\\",\\n \\"Operator\\": \\"contain\\"\\n }\\n ],\\n \\"Tumblingwindows\\": [\\n \\"60\\"\\n ],\\n \\"Groupbys\\": [\\n \\"userId\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeLogMonitorAttribute', - 'requestParamsDescription' => ' ', + 'title' => 'Query the details of a specified event-triggered alert rule', + 'description' => 'This topic provides an example on how to query the details of the event-triggered alert rule `testRule`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateMonitorGroupByResourceGroupId' => [ - 'summary' => 'Creates an application group by using a resource group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2023-08-31T02:52:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-10T07:57:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-03-21T07:08:24.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEventRuleAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeEventRuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The alert does not exist.\\",\\n \\"RequestId\\": \\"9AA3F210-C03D-4C86-8DB6-21C84FF692A1\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"EventType\\": \\"SYSTEM\\",\\n \\"GroupId\\": \\"3607****\\",\\n \\"Name\\": \\"test_DefaultEventRule_7378****\\",\\n \\"Description\\": \\"Default group event rule.\\",\\n \\"State\\": \\"ENABLED\\",\\n \\"EventPattern\\": {\\n \\"Product\\": \\"CloudMonitor\\",\\n \\"LevelList\\": {\\n \\"LevelList\\": [\\n \\"[\\\\\\"CRITICAL\\\\\\",\\\\\\"WARN\\\\\\"] \\"\\n ]\\n },\\n \\"StatusList\\": {\\n \\"StatusList\\": [\\n \\"Running\\"\\n ]\\n },\\n \\"NameList\\": {\\n \\"NameList\\": [\\n \\"Agent_Status_Running\\"\\n ]\\n },\\n \\"EventTypeList\\": {\\n \\"EventTypeList\\": [\\n \\"*\\"\\n ]\\n },\\n \\"SQLFilter\\": \\"ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222\\",\\n \\"KeywordFilterObj\\": {\\n \\"Keywords\\": {\\n \\"keyword\\": [\\n \\"VMException\\"\\n ]\\n },\\n \\"Relation\\": \\"OR\\"\\n }\\n }\\n }\\n}","type":"json"}]', + ], + 'DescribeEventRuleList' => [ + 'summary' => 'Queries event-triggered alert rules.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'EnableSubscribeEvent', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the application group automatically subscribes to event notifications. If events whose severity level is critical or warning occur on resources in an application group, CloudMonitor sends alert notifications. Valid values:'."\n" - ."\n" - .'* true: The application group automatically subscribes to event notifications.'."\n" - .'* false (default): The application group does not automatically subscribe to event notifications.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'EnableInstallAgent', + 'name' => 'NamePrefix', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the CloudMonitor agent is automatically installed for the application group. CloudMonitor determines whether to automatically install the CloudMonitor agent for the hosts in an application group based on the value of this parameter. Valid values:'."\n" - ."\n" - .'* true: The CloudMonitor agent is automatically installed.'."\n" - .'* false (default): The CloudMonitor agent is not automatically installed.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The prefix in the name of the event-triggered alert rule.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region where the resource group resides.'."\n" - ."\n" - .'For information about how to obtain the ID of the region where a resource group resides, see [GetResourceGroup](~~158866~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group.'."\n" - ."\n" - .'For information about how to obtain the ID of a resource group, see [ListResourceGroups](~~158855~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rg-acfmw3ty5y7****', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Pages start from page 1. Default value: 10.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ResourceGroupName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n" - ."\n" - .'For information about how to obtain the name of a resource group, see [ListResourceGroups](~~158855~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CloudMonitor', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '7378****', 'title' => ''], ], [ - 'name' => 'ContactGroupList', + 'name' => 'IsEnable', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The alert contact groups. The alert notifications of the application group are sent to the alert contacts that belong to the specified alert contact groups.'."\n" - ."\n" - .'An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert contact group. The alert notifications of the application group are sent to the alert contacts that belong to the specified alert contact groups.'."\n" - ."\n" - .'An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~). For information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Group', - ], - 'required' => true, - 'example' => 'ECS_Group', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'Specifies whether to enable the event-triggered alert rule. Valid values:'."\n" + ."\n" + .'- true (default)'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The event-triggered alert rules.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '784CAB3C-F613-5BCE-8469-6DCB29B18A20', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3607****', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D0E6D82B-16B5-422A-8136-EE5BDC01E415', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '21', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EventRules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventRule' => [ + 'description' => 'The event-triggered alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EventType' => ['description' => 'The type of the event-triggered alert rule. Valid values:'."\n" + ."\n" + .'- SYSTEM: system event-triggered alert rule'."\n" + ."\n" + .'- CUSTOM: custom event-triggered alert rule', 'type' => 'string', 'example' => 'SYSTEM', 'title' => ''], + 'Description' => ['description' => 'The description of the event-triggered alert rule.', 'type' => 'string', 'example' => 'Default group event rule.', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '7378****', 'title' => ''], + 'Name' => ['description' => 'The name of the event-triggered alert rule.', 'type' => 'string', 'example' => 'test_DefaultEventRule_7378****', 'title' => ''], + 'State' => ['description' => 'The status of the event-triggered alert rule. Valid values:'."\n" + ."\n" + .'- ENABLED'."\n" + ."\n" + .'- DISABLED', 'type' => 'string', 'example' => 'ENABLED', 'title' => ''], + 'EventPattern' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventPattern' => [ + 'description' => 'The mode of the event-triggered alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Product' => ['description' => 'The abbreviation of the Alibaba Cloud service name.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + 'LevelList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LevelList' => [ + 'description' => 'The levels of the event-triggered alerts.', + 'type' => 'array', + 'items' => ['description' => 'The level of the event-triggered alert. Valid values:'."\n" + ."\n" + .'- CRITICAL'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .'- INFO', 'type' => 'string', 'example' => 'CRITICAL', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EventTypeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventTypeList' => [ + 'description' => 'The types of the event-triggered alert rules.', + 'type' => 'array', + 'items' => ['description' => 'The type of the event-triggered alert rule.'."\n" + ."\n" + .'`*` indicates all types of alert rules.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'NameList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NameList' => [ + 'description' => 'The event names.', + 'type' => 'array', + 'items' => ['description' => 'The event name.', 'type' => 'string', 'example' => '["Agent_Status_Stopped"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'CustomFilters' => ['description' => 'The custom filter conditions.', 'type' => 'string', 'example' => 'ECS123', 'title' => ''], + 'KeywordFilter' => [ + 'description' => 'The keyword for filtering.', + 'type' => 'object', + 'properties' => [ + 'Keywords' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Keywords' => [ + 'description' => 'The keywords that are used to match events.', + 'type' => 'array', + 'items' => ['description' => 'The keyword.', 'type' => 'string', 'example' => 'VMException', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Relation' => ['description' => 'The relationship between multiple keywords in a condition. Valid values:'."\n" + ."\n" + .'- OR: The relationship between keywords is OR.'."\n" + ."\n" + .'- NOT: The keyword is excluded. The value NOT indicates that all events that do not contain the keywords are matched.', 'type' => 'string', 'example' => 'OR', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SQLFilter' => ['description' => 'Indicates that logs are filtered based on the specified SQL statement. If the specified conditions are met, an alert is triggered.', 'type' => 'string', 'example' => 'ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SilenceTime' => ['description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met.', 'type' => 'integer', 'format' => 'int64', 'example' => '86400', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 4092 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'ResourceGroupId already create group', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"784CAB3C-F613-5BCE-8469-6DCB29B18A20\\",\\n \\"Success\\": true,\\n \\"Id\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitorGroupByResourceGroupIdResponse>\\n <RequestId>784CAB3C-F613-5BCE-8469-6DCB29B18A20</RequestId>\\n <Id>3607****</Id>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateMonitorGroupByResourceGroupIdResponse>","errorExample":""}]', - 'title' => 'CreateMonitorGroupByResourceGroupId', - 'description' => 'This topic provides an example on how to create an application group by using the resource group `CloudMonitor` and the alert contact group `ECS_Group`. The region ID of the resource group is `cn-hangzhou`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeEventRuleList', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateSiteMonitor' => [ - 'summary' => 'Creates a site monitoring task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2023-09-19T07:37:30.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-03T08:46:17.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-03T08:46:17.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-03T08:46:17.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEventRuleList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeEventRuleList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"D0E6D82B-16B5-422A-8136-EE5BDC01E415\\",\\n \\"Total\\": 21,\\n \\"Success\\": true,\\n \\"EventRules\\": {\\n \\"EventRule\\": [\\n {\\n \\"EventType\\": \\"SYSTEM\\",\\n \\"Description\\": \\"Default group event rule.\\",\\n \\"GroupId\\": \\"7378****\\",\\n \\"Name\\": \\"test_DefaultEventRule_7378****\\",\\n \\"State\\": \\"ENABLED\\",\\n \\"EventPattern\\": {\\n \\"EventPattern\\": [\\n {\\n \\"Product\\": \\"CloudMonitor\\",\\n \\"LevelList\\": {\\n \\"LevelList\\": [\\n \\"CRITICAL\\"\\n ]\\n },\\n \\"EventTypeList\\": {\\n \\"EventTypeList\\": [\\n \\"*\\"\\n ]\\n },\\n \\"NameList\\": {\\n \\"NameList\\": [\\n \\"[\\\\\\"Agent_Status_Stopped\\\\\\"]\\"\\n ]\\n },\\n \\"CustomFilters\\": \\"ECS123\\",\\n \\"KeywordFilter\\": {\\n \\"Keywords\\": {\\n \\"Keywords\\": [\\n \\"VMException\\"\\n ]\\n },\\n \\"Relation\\": \\"OR\\"\\n },\\n \\"SQLFilter\\": \\"ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222\\"\\n }\\n ]\\n },\\n \\"SilenceTime\\": 86400\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeEventRuleTargetList' => [ + 'summary' => 'Queries the list of event-triggered alert rules.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Address', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URL or IP address that is monitored by the task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://www.aliyun.com', - ], - ], - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol that is used by the site monitoring task.'."\n" - ."\n" - .'Valid values: HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3, FTP, and WEBSOCKET.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HTTPS', - ], - ], - [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the site monitoring task.'."\n" - ."\n" - .'The name must be 4 to 100 characters in length, and can contain letters, digits, and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HanZhou_ECS1', - ], - ], - [ - 'name' => 'Interval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which detection requests are sent.'."\n" - ."\n" - .'Valid values: 1, 5, 15, 30, and 60. Unit: minutes.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'IspCities', - 'in' => 'query', - 'schema' => [ - 'description' => 'The information of the detection points. If you leave this parameter empty, the system randomly selects three detection points.'."\n" - ."\n" - .'The value is a JSON array. Example: `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`. The values of the city field indicate Beijing, Hangzhou, and Qingdao.'."\n" - ."\n" - .'For information about how to obtain detection points, see [DescribeSiteMonitorISPCityList](~~115045~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', - ], - ], - [ - 'name' => 'OptionsJson', - 'in' => 'query', - 'schema' => [ - 'description' => 'The extended options of the protocol that is used by the site monitoring task. The options vary based on the protocol.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"time_out":5000}', - ], - ], - [ - 'name' => 'AlertIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'For more information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent', - ], - ], - [ - 'name' => 'AgentGroup', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'CustomSchedule', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The custom detection period. You can only select a time period from Monday to Sunday for detection.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}', - ], - ], - [ - 'name' => 'VpcConfig', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"vpcId": "vpc-xxxxxx", "vswitchId": "vsw-xxxxxx", "securityGroupId": "sg-xxxxxx", "region": "cn-beijing"}', - ], + 'schema' => ['description' => 'The name of the event-triggered alert rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testRule', 'title' => ''], ], ], 'responses' => [ @@ -14552,380 +10813,299 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '87170bc7-e28a-4c93-b9bf-90a1dbe84736', 'title' => ''], + 'ContactParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactParameter' => [ + 'description' => 'The notification method of the alert contact group.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContactGroupName' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'example' => 'Default alert notification group', 'title' => ''], + 'Level' => ['description' => 'The notification level. Valid values:'."\n" + ."\n" + .'<props="china">- 2: phone call, text message, DingTalk, and email.</props>'."\n" + ."\n" + .'<props="china">- 3: text message, DingTalk, and email.</props>'."\n" + ."\n" + .'<props="china">- 4: DingTalk and email.</props>'."\n" + ."\n" + .'<props="intl">4: DingTalk and email.</props>'."\n" + ."\n" + .'<props="partner">4: DingTalk and email.</props>.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the alert contact group notification method.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', + 'FcParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FCParameter' => [ + 'description' => 'The Function Compute notification method.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceName' => ['description' => 'The service name of Function Compute.', 'type' => 'string', 'example' => 'service1', 'title' => ''], + 'FunctionName' => ['description' => 'The function name.', 'type' => 'string', 'example' => 'fcTest1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN).'."\n" + ."\n" + .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:'."\n" + ."\n" + .'- Service: the code of the Alibaba Cloud service.'."\n" + ."\n" + .'- Region: the region ID.'."\n" + ."\n" + .'- Account: the Alibaba Cloud account ID.'."\n" + ."\n" + .'- ResourceType: the resource type.'."\n" + ."\n" + .'- ResourceId: the resource ID.', 'type' => 'string', 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the Function Compute notification method.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Region' => ['description' => 'The region of the Function Compute service.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', + 'MnsParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MnsParameter' => [ + 'description' => 'The Simple Message Queue (formerly MNS) notification method.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Queue' => ['description' => 'The name of the Simple Message Queue (formerly MNS) queue.', 'type' => 'string', 'example' => 'testQueue', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN).'."\n" + ."\n" + .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:'."\n" + ."\n" + .'- Service: the code of the Alibaba Cloud service.'."\n" + ."\n" + .'- Region: the region ID.'."\n" + ."\n" + .'- Account: the Alibaba Cloud account ID.'."\n" + ."\n" + .'- ResourceType: the resource type.'."\n" + ."\n" + .'- ResourceId: the resource ID.', 'type' => 'string', 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', 'title' => ''], + 'Region' => ['description' => 'The region of the Simple Message Queue (formerly MNS) service.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the Simple Message Queue (formerly MNS) notification method.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Topic' => ['description' => 'The topic of the Simple Message Queue (formerly MNS) service.', 'type' => 'string', 'example' => 'topic_sample', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', + 'WebhookParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'WebhookParameter' => [ + 'description' => 'The URL callback notification method.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => 'The callback URL.', 'type' => 'string', 'example' => 'http://www.aliyun.com', 'title' => ''], + 'Method' => ['description' => 'The HTTP request method for the callback. GET and POST methods are supported.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'Protocol' => ['description' => 'The protocol type.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the URL callback notification method.', 'type' => 'string', 'example' => '5', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Data' => [ - 'description' => 'The result of the site monitoring task.'."\n", + 'SlsParameters' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'AttachAlertResult' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Contact' => [ - 'description' => 'The result that is returned after you associate the existing alert rule with the site monitoring task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The result that is returned after you associate the existing alert rule with the site monitoring task.', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code that is returned after you associate the existing alert rule with the site monitoring task.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message that is returned after you associate the existing alert rule with the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request that was sent to associate the existing alert rule with the site monitoring task.'."\n", - 'type' => 'string', - 'example' => '5dd33455-4f65-4b0c-9200-33d66f3f340b', - ], - 'Success' => [ - 'description' => 'Indicates whether the existing alert rule was associated with the site monitoring task. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent', - ], - ], - ], + 'SlsParameter' => [ + 'description' => 'The Simple Log Service (SLS) notification method.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Project' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'project_test', 'title' => ''], + 'LogStore' => ['description' => 'The Logstore name.', 'type' => 'string', 'example' => 'logstore_test', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN).'."\n" + ."\n" + .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:'."\n" + ."\n" + .'- Service: the code of the Alibaba Cloud service.'."\n" + ."\n" + .'- Region: the region ID.'."\n" + ."\n" + .'- Account: the Alibaba Cloud account ID.'."\n" + ."\n" + .'- ResourceType: the resource type.'."\n" + ."\n" + .'- ResourceId: the resource ID.', 'type' => 'string', 'example' => 'acs:log:cn-hangzhou::project/cms-log-mo****/logstore/c***', 'title' => ''], + 'Region' => ['description' => 'The region of the project.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the Simple Log Service notification method.', 'type' => 'string', 'example' => '4', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'CreateResultList' => [ + 'OpenApiParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'CreateResultList' => [ - 'description' => 'The returned result.'."\n" - ."\n" - .'If a site monitoring task is created, the result is returned. If a site monitoring task fails to be created, no result is returned.'."\n", + 'OpenApiParameters' => [ + 'description' => 'The parameters of the callback API.', 'type' => 'array', 'items' => [ - 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', - ], - 'TaskName' => [ - 'description' => 'The name of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'HanZhou_ECS1', - ], + 'Action' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'PutLogs', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN).'."\n" + .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:'."\n" + .' - Service: the Alibaba Cloud service.'."\n" + .' - Region: the region ID.'."\n" + .' - Account: the Alibaba Cloud account ID.'."\n" + .' - ResourceType: the resource type.'."\n" + .' - ResourceId: the resource ID.', 'type' => 'string', 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the API callback notification method.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Product' => ['description' => 'The ID of the Alibaba Cloud service to which the API belongs.', 'type' => 'string', 'example' => 'log', 'title' => ''], + 'Region' => ['description' => 'The region of the resource.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Role' => ['description' => 'The role name.', 'type' => 'string', 'example' => 'MyRole', 'title' => ''], + 'Version' => ['description' => 'The API version.', 'type' => 'string', 'example' => '2019-01-01', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => 'N/A.', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'IllegalAddress', - 'errorMessage' => 'Illegal HTTP address', - ], - [ - 'errorCode' => 'OperationError', - 'errorMessage' => 'Operation failed', - ], - [ - 'errorCode' => 'TaskNotExists', - 'errorMessage' => 'Task does not exist', - ], - [ - 'errorCode' => 'OperatorInvalid', - 'errorMessage' => 'Operator invalid', - ], - [ - 'errorCode' => 'NameRepeat', - 'errorMessage' => 'Task name repeat', - ], - [ - 'errorCode' => 'CreateAlarmError', - 'errorMessage' => 'Create alarm error', - ], - [ - 'errorCode' => 'NameNotExists', - 'errorMessage' => 'Task name not exists', - ], - [ - 'errorCode' => 'OperatorCityInvalid', - 'errorMessage' => 'Invalid Isp.', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], - ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], - [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'RestrictedUser', - 'errorMessage' => 'The user\'s operation is restricted, please register NAAM product code', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"68192f5d-0d45-4b98-9724-892813f86c71\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"AttachAlertResult\\": {\\n \\"Contact\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"5dd33455-4f65-4b0c-9200-33d66f3f340b\\",\\n \\"Success\\": \\"true\\",\\n \\"RuleId\\": \\"SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent\\"\\n }\\n ]\\n }\\n },\\n \\"CreateResultList\\": {\\n \\"CreateResultList\\": [\\n {\\n \\"TaskId\\": \\"2c8dbdf9-a3ab-46a1-85a4-f094965e****\\",\\n \\"TaskName\\": \\"HanZhou_ECS1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateSiteMonitorResponse>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>68192f5d-0d45-4b98-9724-892813f86c71</RequestId>\\r\\n\\t<Data>\\r\\n\\t\\t<AttachAlertResult>\\r\\n\\t\\t\\t<Contact>\\r\\n\\t\\t\\t\\t<Message>successful</Message>\\r\\n\\t\\t\\t\\t<RequestId>5dd33455-4f65-4b0c-9200-33d66f3f340b</RequestId>\\r\\n\\t\\t\\t\\t<RuleId>SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent</RuleId>\\r\\n\\t\\t\\t\\t<Code>200</Code>\\r\\n\\t\\t\\t\\t<Success>true</Success>\\r\\n\\t\\t\\t</Contact>\\r\\n\\t\\t</AttachAlertResult>\\r\\n\\t</Data>\\r\\n\\t<Code>200</Code>\\r\\n\\t<CreateResultList>\\r\\n\\t\\t<CreateResultList>\\r\\n\\t\\t\\t<TaskId>2c8dbdf9-a3ab-46a1-85a4-f094965e****</TaskId>\\r\\n\\t\\t\\t<TaskName>HanZhou_ECS1</TaskName>\\r\\n\\t\\t</CreateResultList>\\r\\n\\t</CreateResultList>\\r\\n\\t<Success>true</Success>\\r\\n</CreateSiteMonitorResponse>","errorExample":""}]', - 'title' => 'CreateSiteMonitor', - 'description' => 'This topic provides an example on how to create a site monitoring task named `HanZhou_ECS1`. The URL that is monitored by the task is `https://www.aliyun.com` and the type of the task is `HTTPS`.'."\n", - 'requestParamsDescription' => 'The following tables describe the extended options of the HTTP, HTTPS, PING, TCP, UDP, DNS, WEBSOCKET, SMTP, POP3, and FTP protocols specified by the TaskType parameter.'."\n" - ."\n" - .'* HTTP or HTTPS'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|http\\_method|String|The HTTP or HTTPS request method. Valid values: GET, POST, and HEAD. Default value: GET.|'."\n" - .'|header|String|The custom HTTP headers that are separated by line feeds (\\\\n).Each header must comply with the HTTP protocol. Each header must be a key-value pair in which the key and value are separated by a colon (:).|'."\n" - .'|cookie|String|The HTTP cookie that is specified in compliance with the HTTP request standard.|'."\n" - .'|request\\_content|String|The content of the request. The content can be in the JSON or form format. If this parameter is not specified, the request body is empty.|'."\n" - .'|response\\_content|String|The expected content of the response. The first 64 bytes of the content returned by the HTTP server are checked during site monitoring.|'."\n" - .'|match\\_rule|String|0: The detection is successful if the response does not contain the content specified by the response\\_content parameter.1: The detection is successful if the response contains the content specified by the response\\_content parameter.|'."\n" - .'|username|String|If the username parameter is specified, the HTTP request contains the basic authentication header.|'."\n" - .'|password|String|The password that is used to authenticate the HTTP or HTTPS request.|'."\n" - .'|time\\_out|int|The timeout period. Unit: milliseconds. Default value: 5.|'."\n" - .'|max\\_redirect|int|The maximum number of redirections. The default value is 5 for a detection point that is running on an Elastic Compute Service (ECS) instance and 2 for a detection point that is provided by a carrier.To disable redirections, set the value to 0.Valid values: 0 to 50.|'."\n" - ."\n" - .'* PING'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|failure\\_rate|Text|If the rate of the failed pings exceeds the value of this parameter, the detection fails and the status code 610 or 615 is returned. The error message of the status code 610 is PingAllFail and the error message of the status code 615 is PingPartialFail.Default value: 0.1.|'."\n" - .'|ping\\_num|int|The number of times that the monitored address is pinged. Default value: 10.Valid values: 1 to 100.|'."\n" - ."\n" - .'* DNS'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|dns\\_server|string|The domain name or IP address of the Domain Name System (DNS) server.|'."\n" - .'|dns\\_type|string|The type of the DNS records to query. Valid values: A, NS, CNAME, MX, TXT, ANY, and AAAA.|'."\n" - .'|expect\\_value|string|The list of expected values. Separate the expected values with space characters.|'."\n" - .'|match\\_rule|string|The relationship between the list of expected values and the list of DNS results. If the two lists do not meet the specified relationship, the detection fails. Valid values:Empty string or IN\\_DNS: The list of expected values is a subset of the list of DNS results.DNS\\_IN: The list of DNS results is a subset of the list of expected values.EQUAL: The list of DNS results is the same as the list of expected values.ANY: The list of DNS results intersects with the list of expected values.|'."\n" - ."\n" - .'* FTP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the FTP server. If this parameter is not specified, the default value is used. The default port number is 21 for FTP and 990 for FTPS.|'."\n" - .'|username|string|The username that is used to log on to the FTP server. If this parameter is not specified, anonymous logon is used.|'."\n" - .'|password|string|The password that is used to log on to the FTP server.|'."\n" - ."\n" - .'* POP3 or SMTP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the POP3 or SMTP server. The default port number is 110 for POP3, 995 for POP3S, and 25 for SMTP.|'."\n" - .'|username|string|The username that is used to log on to the POP3 or SMTP server. The username and password that are used to log on to the POP3 or SMTP server are required.|'."\n" - .'|password|string|The password that is used to log on to the POP3 or SMTP server. The username and password that are used to log on to the POP3 or SMTP server are required.|'."\n" - ."\n" - .'* TCP or UDP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the TCP or UDP server.|'."\n" - .'|request\\_content|string|The content of the request. If the request\\_format parameter is set to hex, the value of the request\\_content parameter is parsed in the hexadecimal format.|'."\n" - .'|request\\_format|string|If the request\\_format parameter is set to another value, the value of the request\\_content parameter is sent to the TCP or UDP server as a regular string.|'."\n" - .'|response\\_content|string|The content of the response. If the response from the TCP or UDP server does not contain the content specified by the response\\_content parameter, the detection fails.If the response\\_format parameter is set to hex, the value of the response\\_content parameter is parsed in the hexadecimal format.If the response\\_format parameter is set to another value, the value of the response\\_content parameter is parsed as a regular string.|'."\n" - ."\n" - .'* WEBSOCKET'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|request\\_content|string|The message content.|'."\n" - .'|empty\\_message|boolean|Allows the server to return no message or an empty string.|', + 'title' => 'Query the notification channels of a specified event-triggered alert rule', + 'description' => 'This topic provides an example to query the details of the event-triggered alert rule `testRule`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', - 'extraInfo' => "\n" - ."\n\n", - ], - 'CreateInstantSiteMonitor' => [ - 'summary' => 'Creates an instant test task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-12-22T08:42:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-22T08:42:04.000Z', 'description' => 'Response parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEventRuleTargetList'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], - 'parameters' => [ - [ - 'name' => 'Address', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URL or IP address that you want to test.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'http://www.aliyun.com', - ], - ], - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the instant test task. Valid values: HTTP, PING, TCP, UDP, and DNS.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HTTP', - ], - ], + 'ramActions' => [ [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the instant test task.'."\n" - ."\n" - .'The name must be 4 to 100 characters in length, and can contain letters, digits, and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'task1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeEventRuleTargetList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"87170bc7-e28a-4c93-b9bf-90a1dbe84736\\",\\n \\"ContactParameters\\": {\\n \\"ContactParameter\\": [\\n {\\n \\"ContactGroupName\\": \\"Default alert notification group\\",\\n \\"Level\\": \\"3\\",\\n \\"Id\\": \\"1\\"\\n }\\n ]\\n },\\n \\"FcParameters\\": {\\n \\"FCParameter\\": [\\n {\\n \\"ServiceName\\": \\"service1\\",\\n \\"FunctionName\\": \\"fcTest1\\",\\n \\"Arn\\": \\"acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***\\",\\n \\"Id\\": \\"3\\",\\n \\"Region\\": \\"cn-qingdao\\"\\n }\\n ]\\n },\\n \\"MnsParameters\\": {\\n \\"MnsParameter\\": [\\n {\\n \\"Queue\\": \\"testQueue\\",\\n \\"Arn\\": \\"acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Id\\": \\"2\\",\\n \\"Topic\\": \\"topic_sample\\"\\n }\\n ]\\n },\\n \\"WebhookParameters\\": {\\n \\"WebhookParameter\\": [\\n {\\n \\"Url\\": \\"http://www.aliyun.com\\",\\n \\"Method\\": \\"GET\\",\\n \\"Protocol\\": \\"HTTP\\",\\n \\"Id\\": \\"5\\"\\n }\\n ]\\n },\\n \\"SlsParameters\\": {\\n \\"SlsParameter\\": [\\n {\\n \\"Project\\": \\"project_test\\",\\n \\"LogStore\\": \\"logstore_test\\",\\n \\"Arn\\": \\"acs:log:cn-hangzhou::project/cms-log-mo****/logstore/c***\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Id\\": \\"4\\"\\n }\\n ]\\n },\\n \\"OpenApiParameters\\": {\\n \\"OpenApiParameters\\": [\\n {\\n \\"Action\\": \\"PutLogs\\",\\n \\"Arn\\": \\"acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***\\",\\n \\"Id\\": \\"3\\",\\n \\"Product\\": \\"log\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Role\\": \\"MyRole\\",\\n \\"Version\\": \\"2019-01-01\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeExporterOutputList' => [ + 'summary' => 'Queries the list of monitoring data exports by calling the DescribeExporterOutputList operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IspCities', - 'in' => 'query', - 'schema' => [ - 'description' => 'The detection points. If you leave this parameter empty, the system randomly selects three detection points.'."\n" - ."\n" - .'The value is a `JSON array`. Example: {"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}. The values of the city field indicate Beijing, Hangzhou, and Qingdao.'."\n" - ."\n" - .'For information about how to obtain detection points, see [DescribeSiteMonitorISPCityList](~~115045~~).'."\n" - ."\n" - .'> You must specify one of the `IspCities` and `RandomIspCity` parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'OptionsJson', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended options of the protocol that is used by the instant test task. The options vary based on the protocol.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"time_out":5000}', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'RandomIspCity', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of detection points.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You must specify one of the `IspCities` and `RandomIspCity` parameters. If you specify the `RandomIspCity` parameter, the `IspCities` parameter automatically becomes invalid.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '0', - ], - ], - [ - 'name' => 'AgentGroup', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'enum' => [ - 'PC', - 'MOBILE', - ], - ], + 'schema' => ['description' => 'The number of records per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'default' => '1000', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -14933,427 +11113,127 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The error code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.', - 'type' => 'string', - 'example' => 'true', - ], - 'CreateResultList' => [ - 'description' => 'The results for creating the instant test task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the instant test task.', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the instant test task.'."\n", - 'type' => 'string', - 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', - ], - 'TaskName' => [ - 'description' => 'The name of the instant test task.'."\n", - 'type' => 'string', - 'example' => 'task1', + 'RequestId' => ['description' => 'The request ID.'."\n" + ."\n", 'type' => 'string', 'example' => '0E657631-CD6C-4C24-9637-98D000B9272C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values: '."\n" + .'- `true`: successful'."\n" + .'- `false`: failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call was successful. Other status codes indicate that the call failed.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'sucess', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'description' => 'The list of exported configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DestType' => ['description' => 'The type of the data export.'."\n" + ."\n" + .'> Only Log Service (SLS) is supported. More products will be supported in the future.', 'type' => 'string', 'example' => 'SLS', 'title' => ''], + 'CreateTime' => ['description' => 'The Unix timestamp when the export configuration was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1584016495498', 'title' => ''], + 'DestName' => ['description' => 'The name of the configuration.', 'type' => 'string', 'example' => 'exporterOut', 'title' => ''], + 'ConfigJson' => [ + 'description' => 'The monitoring output configuration.', + 'type' => 'object', + 'properties' => [ + 'ak' => ['description' => 'The AccessKey ID.', 'type' => 'string', 'example' => 'LTAIpY33********', 'title' => ''], + 'endpoint' => ['description' => 'The endpoint of the SLS data.', 'type' => 'string', 'example' => 'http://cn-qingdao-share.log.aliyuncs.com', 'title' => ''], + 'logstore' => ['description' => 'The Logstore.', 'type' => 'string', 'example' => 'monitorlogstore', 'title' => ''], + 'project' => ['description' => 'The SLS project.', 'type' => 'string', 'example' => 'exporter', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'IllegalAddress', - 'errorMessage' => 'Illegal HTTP address', - ], - [ - 'errorCode' => 'OperationError', - 'errorMessage' => 'Operation failed', - ], - [ - 'errorCode' => 'TaskNotExists', - 'errorMessage' => 'Task does not exist', - ], - [ - 'errorCode' => 'OperatorInvalid', - 'errorMessage' => 'Operator invalid', - ], - [ - 'errorCode' => 'OperatorCityInvalid', - 'errorMessage' => 'Operator City invalid', - ], - [ - 'errorCode' => 'NameRepeat', - 'errorMessage' => 'Task name repeat', - ], - [ - 'errorCode' => 'CreateAlarmError', - 'errorMessage' => 'Create alarm error', - ], - [ - 'errorCode' => 'NameNotExists', - 'errorMessage' => 'Task name not exists', - ], - [ - 'errorCode' => 'Illegal Task Name', - 'errorMessage' => 'The task name of the sitemonitor task is illegal.', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => '%s', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"68192f5d-0d45-4b98-9724-892813f86c71\\",\\n \\"Success\\": \\"true\\",\\n \\"CreateResultList\\": [\\n {\\n \\"TaskId\\": \\"2c8dbdf9-a3ab-46a1-85a4-f094965e****\\",\\n \\"TaskName\\": \\"task1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateInstantSiteMonitorResponse>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>68192f5d-0d45-4b98-9724-892813f86c71</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<CreateResultList>\\r\\n\\t\\t<TaskId>2c8dbdf9-a3ab-46a1-85a4-f094965e****</TaskId>\\r\\n\\t\\t<TaskName>task1</TaskName>\\r\\n\\t</CreateResultList>\\r\\n\\t<Success>true</Success>\\r\\n</CreateInstantSiteMonitorResponse>\\t","errorExample":""}]', - 'title' => 'CreateInstantSiteMonitor', - 'description' => 'You can create an instant test task only by using the Alibaba Cloud account that you used to enable Network Analysis and Monitoring. '."\n" - ."\n" - .'This topic provides an example to show how to create an instant test task. The name of the task is `task1`. The tested address is `http://www.aliyun.com`. The test type is `HTTP`. The number of detection points is `1`.', - 'requestParamsDescription' => '# Extended options of the TaskType parameter'."\n" - ."\n" - .'The following tables describe the extended options of the HTTP, PING, TCP, UDP, and DNS protocols specified by the `TaskType` parameter.'."\n" - ."\n" - .'* HTTP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|http\\_method|String|The HTTP request method. Valid values: GET, POST, and HEAD. Default value: GET.|'."\n" - .'|header|String|The custom HTTP headers that are separated by line feeds (\\\\n). Each header must comply with the HTTP protocol. Each header must be a key-value pair in which the key and value are separated by a colon (:).|'."\n" - .'|cookie|String|The HTTP cookie that is specified in compliance with the HTTP request standard.|'."\n" - .'|request\\_content|String|The content of the request. The content can be in the JSON or form format. If this parameter is not specified, the request body is empty.|'."\n" - .'|response\\_content|String|The expected content of the response. The first 64 bytes of the content returned by the HTTP server are checked during site monitoring.|'."\n" - .'|match\\_rule|String|0: The detection is successful if the response does not contain the content specified by the response\\_content parameter. 1: The detection is successful if the response contains the content specified by the response\\_content parameter.|'."\n" - .'|username|String|If the username parameter is specified, the HTTP request contains the basic authentication header.|'."\n" - .'|password|String|The password used to authenticate the HTTP request.|'."\n" - .'|time\\_out|int|The timeout period. Unit: milliseconds. Default value: 30000.|'."\n" - .'|max\\_redirect|int|The maximum number of redirections. The default value is 5 for a detection point that is running on an Elastic Compute Service (ECS) instance and 2 for a detection point that is provided by a carrier. To disable redirections, set the value to 0. Valid values: 0 to 50.|'."\n" - ."\n" - .'* PING'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|failure\\_rate|int|If the rate of the failed pings exceeds the value of this parameter, the detection fails and the status code 610 or 615 is returned. The error message of the status code 610 is PingAllFail and the error message of the status code 615 is PingPartialFail. Default value: 0.1.|'."\n" - .'|ping\\_num|int|The number of times that the monitored address is pinged. Default value: 20. Valid values: 1 to 100.|'."\n" - ."\n" - .'* TCP or UDP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the TCP or UDP server.|'."\n" - .'|request\\_content|string|The content of the request. If the request\\_format parameter is set to hex, the value of the request\\_content parameter is parsed in the hexadecimal format.|'."\n" - .'|request\\_format|string|If the request\\_format parameter is set to another value, the value of the request\\_content parameter is sent to the TCP or UDP server as a regular string.|'."\n" - .'|response\\_content|string|The content of the response. If the response from the TCP or UDP server does not contain the content specified by the response\\_content parameter, the detection fails. If the response\\_format parameter is set to hex, the value of the response\\_content parameter is parsed in the hexadecimal format. If the response\\_format parameter is set to another value, the value of the response\\_content parameter is parsed as a regular string.|'."\n" - ."\n" - .'* DNS'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|dns\\_server|string|The domain name or IP address of the Domain Name System (DNS) server.|'."\n" - .'|dns\\_type|string|The type of the DNS records to query. Valid values: A, NS, CNAME, MX, TXT, and ANY.|'."\n" - .'|expect\\_value|string|The list of expected values. Separate the expected values with space characters.|'."\n" - .'|match\\_rule|string|The relationship between the list of expected values and the list of DNS results. If the two lists do not meet the specified relationship, the detection fails. Valid values: Empty string or IN\\_DNS: The list of expected values is a subset of the list of DNS results. DNS\\_IN: The list of DNS results is a subset of the list of expected values. EQUAL: The list of DNS results is the same as the list of expected values. ANY: The list of DNS results intersects with the list of expected values.|', + 'title' => 'DescribeExporterOutputList', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'BatchCreateInstantSiteMonitor' => [ - 'summary' => 'Creates site monitoring tasks.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2023-08-30T08:14:42.000Z', 'description' => 'Response parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExporterOutputList'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'TaskList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The site monitoring tasks.'."\n" - ."\n" - .'> You must create at least one site monitoring task. You must specify all of the `Address`, `TaskName`, and `TaskType` parameters in each request.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Address' => [ - 'description' => 'The URL or IP address that is monitored by the task.'."\n" - ."\n" - .'> You must create at least one site monitoring task. You must specify all of the `Address`, `TaskName`, and `TaskType` parameters in each request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], - 'IspCities' => [ - 'description' => 'The detection points. If you leave this parameter empty, the system randomly selects three detection points.'."\n" - ."\n" - .'The value is a `JSON array`. Example: `{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}`. The values of the city field indicate Beijing, Hangzhou, and Qingdao.'."\n" - ."\n" - .'For information about how to obtain detection points, see [DescribeSiteMonitorISPCityList](~~115045~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', - ], - 'OptionsJson' => [ - 'description' => 'The extended options of the protocol that is used by the site monitoring task. The options vary based on the protocol.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"time_out":5000}', - ], - 'TaskName' => [ - 'description' => 'The name of the site monitoring task.'."\n" - ."\n" - .'The name must be 4 to 100 characters in length, and can contain letters, digits, and underscores (\\_).'."\n" - ."\n" - .'> You must create at least one site monitoring task. You must specify all of the `Address`, `TaskName`, and `TaskType` parameters in each request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HangZhou_ECS1', - ], - 'TaskType' => [ - 'description' => 'The type of the site monitoring task.'."\n" - ."\n" - .'Valid values: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.'."\n" - ."\n" - .'> You must create at least one site monitoring task. You must specify all of the `Address`, `TaskName`, and `TaskType` parameters in each request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 200, - 'minItems' => 1, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7AE72720-2C96-5446-9F2B-308C7CEDFF1A', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The information about the site monitoring task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskName' => [ - 'description' => 'The name of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'HangZhou_ECS1', - ], - 'TaskId' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => '679fbe4f-b80b-4706-91b2-5427b43e****', - ], - ], - ], - 'example' => '[{"taskName": "HangZhou_ECS1", "taskId": "679fbe4f-b80b-4706-91b2-5427b43e****"}]', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeExporterOutputList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'The parameter is missing or invalid. %s', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - ], - [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 429 => [ - [ - 'errorCode' => 'ResourceOverLimit', - 'errorMessage' => 'The resource has exceeded the limit. %s', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7AE72720-2C96-5446-9F2B-308C7CEDFF1A\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"TaskName\\": \\"HangZhou_ECS1\\",\\n \\"TaskId\\": \\"679fbe4f-b80b-4706-91b2-5427b43e****\\"\\n }\\n ],\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<BatchCreateInstantSiteMonitorResponse>\\n <RequestId>7AE72720-2C96-5446-9F2B-308C7CEDFF1A</RequestId>\\n <Message>successful</Message>\\n <Data>\\n <taskName>HangZhou_ECS1</taskName>\\n <taskId>679fbe4f-b80b-4706-91b2-5427b43e****</taskId>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</BatchCreateInstantSiteMonitorResponse>","errorExample":""}]', - 'title' => 'BatchCreateInstantSiteMonitor', - 'description' => 'This topic provides an example on how to create a site monitoring task named `HangZhou_ECS1`. The URL that is monitored by the task is `https://www.aliyun.com` and the type of the task is `HTTP`. The returned result shows that the site monitoring task is created. The name of the site monitoring task is `HangZhou_ECS1` and the task ID is `679fbe4f-b80b-4706-91b2-5427b43e****`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0E657631-CD6C-4C24-9637-98D000B9272C\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"sucess\\",\\n \\"PageNumber\\": 1,\\n \\"Total\\": 25,\\n \\"Datapoints\\": {\\n \\"Datapoint\\": [\\n {\\n \\"DestType\\": \\"SLS\\",\\n \\"CreateTime\\": 1584016495498,\\n \\"DestName\\": \\"exporterOut\\",\\n \\"ConfigJson\\": {\\n \\"ak\\": \\"LTAIpY33********\\",\\n \\"endpoint\\": \\"http://cn-qingdao-share.log.aliyuncs.com\\",\\n \\"logstore\\": \\"monitorlogstore\\",\\n \\"project\\": \\"exporter\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DeleteSiteMonitors' => [ - 'summary' => 'Deletes one or more site monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeExporterRuleList' => [ + 'summary' => 'Queries a list of data export rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TaskIds', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the site monitoring tasks that you want to delete. Separate multiple task IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '01adacc2-ece5-41b6-afa2-3143ab5d****,43bd1ead-514f-4524-813e-228ce091****', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'IsDeleteAlarms', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to delete the alert rules configured for the site monitoring tasks. Valid values:'."\n" - ."\n" - .'* true (default value)'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'default' => '1000', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -15361,3988 +11241,2326 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. If the call was successful, the value success is returned. If the call failed, an error message such as `TaskId not found` is returned.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '123BCC5D-8B63-48EA-B747-9A8995BE7AA6', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. The value true indicates success. The value false indicates failure.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The information about the site monitoring tasks that were deleted.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6BA047CA-8BC6-40BC-BC8F-FBECF35F1993', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: '."\n" + .'- `true`: Successful.'."\n" + .'- `false`: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success. Any other value indicates failure.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'Datapoints' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'count' => [ - 'description' => 'The number of the site monitoring tasks that were deleted.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'Datapoint' => [ + 'description' => 'The data point.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data point.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'CPUUtilization', 'title' => ''], + 'Describe' => ['description' => 'The description of the export rules.', 'type' => 'string', 'example' => 'export test', 'title' => ''], + 'TargetWindows' => ['description' => 'The time window for data export. Unit: seconds.'."\n" + ."\n" + .'> - If you need to export data from multiple windows, separate them with commas (,).'."\n" + .'- Exporting data with a granularity of less than 60 seconds is not supported.', 'type' => 'string', 'example' => 'rule_test', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the rule was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1667526533000', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Dimension' => ['description' => 'The dimension.', 'type' => 'string', 'example' => 'hotsName', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'RuleName' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'L121-寿险-全能保建议书系统_DefaultEventRule_10842827', 'title' => ''], + 'DstName' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DstName' => [ + 'description' => 'The destination name.', + 'type' => 'array', + 'items' => ['description' => 'The destination name.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - [ - 'errorCode' => 'UnauthorizedTasks', - 'errorMessage' => 'You are not permitted to operate the specified tasks.', - ], - ], - [ - [ - 'errorCode' => '%s', - 'errorMessage' => 'TaskId not found', - ], - [ - 'errorCode' => 'TaskNotExist', - 'errorMessage' => 'The specified task does not exist.', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"123BCC5D-8B63-48EA-B747-9A8995BE7AA6\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteSiteMonitorsResponse>\\n\\t\\t<Data>\\n\\t\\t\\t<count>0</count>\\n\\t\\t</Data>\\n\\t\\t<Message>请求成功</Message>\\n\\t\\t<RequestId>123BCC5D-8B63-48EA-B747-9A8995BE7AA6</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n<DeleteSiteMonitorsResponse>","errorExample":""}]', - 'title' => 'DeleteSiteMonitors', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DisableSiteMonitors' => [ - 'summary' => 'Disables site monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BA047CA-8BC6-40BC-BC8F-FBECF35F1993\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"Total\\": 1000,\\n \\"Datapoints\\": {\\n \\"Datapoint\\": [\\n {\\n \\"MetricName\\": \\"CPUUtilization\\",\\n \\"Describe\\": \\"export test\\",\\n \\"TargetWindows\\": \\"rule_test\\",\\n \\"CreateTime\\": 1667526533000,\\n \\"Enabled\\": true,\\n \\"Dimension\\": \\"hotsName\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"RuleName\\": \\"L121-寿险-全能保建议书系统_DefaultEventRule_10842827\\",\\n \\"DstName\\": {\\n \\"DstName\\": [\\n \\"[]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query data export rules', + 'changeSet' => [ + ['createdAt' => '2023-08-30T08:14:42.000Z', 'description' => 'Response parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExporterRuleList'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'TaskIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****,49f7b317-7645-4cc9-94fd-ea42e522****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3fcd12e7-d387-42ee-b77e-661c775bb17f', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The number of detection points that are affected by the site monitoring tasks.'."\n", - 'type' => 'object', - 'properties' => [ - 'count' => [ - 'description' => 'The number of detection points.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeExporterRuleList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - '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' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - [ - 'errorCode' => 'UnauthorizedTasks', - 'errorMessage' => 'You are not permitted to operate the specified tasks.', - ], - ], - [ - [ - 'errorCode' => 'TaskNotExist', - 'errorMessage' => 'The specified task does not exist.', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3fcd12e7-d387-42ee-b77e-661c775bb17f\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<DisableSiteMonitorsResponse>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>EC3F33C8-9149-493C-92A8-9B33A9DA951C</RequestId>\\r\\n\\t<Data>\\r\\n\\t\\t<count>0</count>\\r\\n\\t</Data>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DisableSiteMonitorsResponse>","errorExample":""}]', - 'title' => 'DisableSiteMonitors', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ModifySiteMonitor' => [ - 'summary' => 'Modifies a site monitoring task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeGroupMonitoringAgentProcess' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Address', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URL or IP address that is monitored by the task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.aliyun.com', - ], - ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', - ], - ], - [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the site monitoring task. The name must be 4 to 100 characters in length, and can contain letters, digits, and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HanZhou_ECS2', - ], - ], - [ - 'name' => 'Interval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which detection requests are sent. Valid values: 1, 5, and 15. Unit: minutes. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'IspCities', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The information of the detection points. The value is a JSON array. Example: `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`. The values of the `city` field indicate Beijing, Hangzhou, and Qingdao.'."\n" - ."\n" - .'> You can call the DescribeSiteMonitorISPCityList operation to query the detection points. For more information, see [DescribeSiteMonitorISPCityList](~~115045~~). If you leave this parameter empty, the system randomly selects three detection points.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'OptionsJson', + 'name' => 'ProcessName', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended options of the protocol that is used by the site monitoring task. The options vary based on the protocol.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"time_out":5000}', - ], + 'schema' => ['description' => 'The process name.', 'type' => 'string', 'required' => false, 'example' => 'sshd', 'title' => ''], ], [ - 'name' => 'AlertIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. You can call the DescribeMetricRuleList operation to query the IDs of existing alert rules in CloudMonitor. For more information, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '49f7c317-7645-4cc9-94fd-ea42e122****', - ], - ], - [ - 'name' => 'IntervalUnit', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The unit of the metric.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ms', - ], + 'schema' => ['description' => 'The page number. Default value: 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'CustomSchedule', + 'name' => 'PageSize', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The custom detection period. You can only select a time period from Monday to Sunday for detection.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The result of modifying the task.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status codes.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Default value: 1', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of returned entries.', 'type' => 'string', 'example' => '28', 'title' => ''], + 'Processes' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'count' => [ - 'description' => 'The number of site monitoring tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'Process' => [ + 'description' => 'The process monitoring tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The process monitoring task.', + 'type' => 'object', + 'properties' => [ + 'ProcessName' => ['description' => 'The process name.', 'type' => 'string', 'example' => 'sshd', 'title' => ''], + 'MatchExpressFilterRelation' => ['description' => 'The logical operator used between conditional expressions that are used to match instances. Valid values:'."\n" + ."\n" + .'- all'."\n" + ."\n" + .'- and'."\n" + ."\n" + .'- or', 'type' => 'string', 'example' => 'and', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Id' => ['description' => 'The ID of the process monitoring task.', 'type' => 'string', 'example' => '3F6150F9-45C7-43F9-9578-A58B2E72****', 'title' => ''], + 'MatchExpress' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MatchExpress' => [ + 'description' => 'The matching conditions.'."\n" + ."\n" + .'> Only the instances that meet the conditional expressions are monitored by the process monitoring task.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The keyword used to match the instance name.', 'type' => 'string', 'example' => 'portalHost', 'title' => ''], + 'Name' => ['description' => 'The criteria based on which the instances are matched.'."\n" + ."\n" + .'> Set the value to `name`. The value name indicates that the instances are matched based on the instance name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Function' => ['description' => 'The matching condition. Valid values:'."\n" + ."\n" + .'- all (default): matches all'."\n" + ."\n" + .'- startWith: starts with a prefix'."\n" + ."\n" + .'- endWith: ends with a suffix'."\n" + ."\n" + .'- contains: contains'."\n" + ."\n" + .'- notContains: excludes'."\n" + ."\n" + .'- equals: equals'."\n" + ."\n" + .'> The matched instances are monitored by the process monitoring task.', 'type' => 'string', 'example' => 'all', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'AlertConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlertConfig' => [ + 'description' => 'The alert rule configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert rule configuration.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday.'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'SilenceTime' => ['description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Minimum value: 3600, which is equivalent to one hour. Default value: 86400, which is equivalent to one day.'."\n" + ."\n" + .'> Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.', 'type' => 'string', 'example' => 'http://www.aliyun.com', 'title' => ''], + 'Times' => ['description' => 'The number of times for which the threshold can be consecutively exceeded.'."\n" + ."\n" + .'> A metric triggers an alert only after the metric value reaches the threshold consecutively for the specified times.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'EscalationsLevel' => ['description' => 'The level of the alert. Valid values:'."\n" + ."\n" + .'- critical'."\n" + ."\n" + .'- warn'."\n" + ."\n" + .'- Info', 'type' => 'string', 'example' => 'warn', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'The time period during which the alert rule is ineffective.', 'type' => 'string', 'example' => '00:00-23:59', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The time period during which the alert rule is effective.', 'type' => 'string', 'example' => '00:00-23:59', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'Statistics' => ['description' => 'The method used to calculate metric values that trigger alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + 'TargetList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => 'The resources for which alerts are triggered.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource for which alerts are triggered.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the resource for which alerts are triggered.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Format: acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message. Example: acs:mns:cn-hangzhou:120886317861\\*\\*\\*\\*:/queues/test123/message. Fields:'."\n" + ."\n" + .'- {Service name abbreviation}: the abbreviation of the service name. Set the value to Simple Message Queue (formerly MNS) (SMQ).'."\n" + ."\n" + .'- {userId}: the ID of the Alibaba Cloud account.'."\n" + ."\n" + .'- {regionId}: the region ID of the SMQ queue or topic.'."\n" + ."\n" + .'- {Resource type}: the type of the resource for which alerts are triggered. Valid values:'."\n" + ."\n" + .' - **queues**'."\n" + ."\n" + .' - **topics**'."\n" + ."\n" + .'- {Resource name}: the resource name.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + ."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .'- CRITICAL', 'type' => 'string', 'example' => 'CRITICAL', 'title' => ''], + 'JsonParmas' => ['description' => 'The parameters of the alert callback. The parameters are in the JSON format.', 'type' => 'string', 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => 'N/A', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'IllegalAddress', - 'errorMessage' => 'Illegal HTTP address', - ], - [ - 'errorCode' => 'OperationError', - 'errorMessage' => 'Operation failed', - ], - [ - 'errorCode' => 'TaskNotExists', - 'errorMessage' => 'Task does not exist', - ], - [ - 'errorCode' => 'OperatorInvalid', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'NameRepeat', - 'errorMessage' => 'Task name repeat', - ], - [ - 'errorCode' => 'CreateAlarmError', - 'errorMessage' => 'Create alarm error', - ], - [ - 'errorCode' => 'NameNotExists', - 'errorMessage' => 'Task name not exists', - ], - [ - 'errorCode' => 'OperatorCityInvalid', - 'errorMessage' => 'Invalid Isp.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], - ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], - ], - [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - [ - 'errorCode' => 'RestrictedUser', - 'errorMessage' => 'The user\'s operation is restricted, please register NAAM product code.', - ], - [ - 'errorCode' => 'UnauthorizedTasks', - 'errorMessage' => 'You are not permitted to operate the specified tasks.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'TaskNotExist', - 'errorMessage' => 'The specified task does not exist.', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternetServerError', - 'errorMessage' => 'System internal error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"68192f5d-0d45-4b98-9724-892813f86c71\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<ModifySiteMonitorResponse>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>32E77F32-B86E-4763-A0BB-0311581ABE67</RequestId>\\r\\n\\t<Data>\\r\\n\\t\\t<count>1</count>\\r\\n\\t</Data>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</ModifySiteMonitorResponse>","errorExample":""}]', - 'title' => 'ModifySiteMonitor', - 'description' => 'The number of site monitoring tasks.'."\n", - 'requestParamsDescription' => 'Site monitoring supports the following eight protocols. The following tables describe the extended options specified by the OptionsJson parameter for each protocol.'."\n" - ."\n" - .'* HTTP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|http\\_method|String|The HTTP request method. Valid values: GET, POST, and HEAD. Default value: GET.|'."\n" - .'|header|String|The custom HTTP headers that are separated by line feeds (\\\\n).Each header must comply with the HTTP protocol. Each header must be a key-value pair in which the key and value are separated by a colon (:).|'."\n" - .'|cookie|String|The HTTP cookie that is specified in compliance with the HTTP request standard.|'."\n" - .'|request\\_content|String|The content of the request. The content can be in the JSON or form format. If this parameter is not specified, the request body is empty.|'."\n" - .'|response\\_content|String|The expected content of the response. The first 64 bytes of the content returned by the HTTP server are checked during site monitoring.|'."\n" - .'|match\\_rule|String|The value 0 indicates that the detection is successful if the response does not contain the content specified by the response\\_content parameter.1: If the response contains the content specified by the response\\_content parameter, the detection is successful.|'."\n" - .'|username|String|If the username parameter is specified, the HTTP request contains the basic authentication header.|'."\n" - .'|password|String|The password used to authenticate the HTTP request.|'."\n" - .'|time\\_out|int|The timeout period. Unit: milliseconds. Default value: 5.|'."\n" - .'|max\\_redirect|int|The maximum number of redirections. The default value is 5 for a detection point that is running on an Elastic Compute Service (ECS) instance and 2 for a detection point that is provided by a carrier.To disable redirections, set the value to 0.Valid values: 0 to 50.|'."\n" - ."\n\n" - .'* PING'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|failure\\_rate|int|If the rate of the failed pings exceeds the value of this parameter, the detection fails and the status code 610 or 615 is returned. The error message of the status code 610 is PingAllFail and the error message of the status code 615 is PingPartialFail.Default value: 0.1.|'."\n" - .'|ping\\_num|int|The number of times that the monitored address is pinged. Default value: 20.Valid values: 1 to 100.|'."\n" - ."\n\n" - .'* DNS'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|dns\\_server|string|The domain name or IP address of the Domain Name System (DNS) server.|'."\n" - .'|dns\\_type|string|The type of the DNS records to query. Valid values: A, NS, CNAME, MX, TXT, and ANY.|'."\n" - .'|expect\\_value|string|The list of expected values. Separate the expected values with spaces.|'."\n" - .'|match\\_rule|string|The relationship between the list of expected values and the list of DNS results. If the two lists do not meet the specified relationship, the detection fails. Valid values:Empty string or IN\\_DNS: The list of expected values is a subset of the list of DNS results.DNS\\_IN: The list of DNS results is a subset of the list of expected values.EQUAL: The list of DNS results is the same as the list of expected values.ANY: The list of DNS results intersects with the list of expected values.|'."\n" - ."\n\n" - .'* FTP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the FTP server. If this parameter is not specified, the default value is used. The default port number is 21 for FTP and 990 for FTPS.|'."\n" - .'|username|string|The username that is used to log on to the FTP server. If this parameter is not specified, anonymous logon is used.|'."\n" - .'|password|string|The password that is used to log on to the FTP server.|'."\n" - ."\n\n" - .'* POP3/SMTP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the POP3 server. The default port number is 110 for POP3 and 995 for POP3S.|'."\n" - .'|username|string|The username used to log on to the POP3 or SMTP server.|'."\n" - .'|password|string|The password used to log on to the POP3 or SMTP server.|'."\n" - ."\n\n" - .'* TCP/UDP'."\n" - ."\n" - .'|Parameter|Type|Description|'."\n" - .'|---|---|---|'."\n" - .'|port|int|The port number of the TCP or UDP server.|'."\n" - .'|request\\_content|string|The content of the request. If the request\\_format parameter is set to hex, the value of the request\\_content parameter is parsed in the hexadecimal format.|'."\n" - .'|request\\_format|string|If the request\\_format parameter is set to another value, the value of the request\\_content parameter is sent to the TCP or UDP server as a regular string.|'."\n" - .'|response\\_content|string|The response content. If the response from the TCP or UDP server does not contain the content specified by the response\\_content parameter, the detection fails. If the response\\_format parameter is set to hex, the value of the response\\_format parameter is parsed in the hexadecimal format. If the response\\_format parameter is set to another value, the value of the response\\_content parameter is parsed as a regular string.|', + 'title' => 'DescribeGroupMonitoringAgentProcess', + 'summary' => 'Queries the process monitoring tasks for an application group.', + 'description' => 'You can create a process monitoring task to monitor all or the specified Elastic Compute Service (ECS) instances in an application group and configure alert rules for the process monitoring task.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'EnableSiteMonitors' => [ - 'summary' => 'Enables site monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'TaskIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****,49f7b317-7645-4cc9-94fd-ea42e522****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3fcd12e7-d387-42ee-b77e-661c775bb17f', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The number of detection points that are affected by the site monitoring tasks.'."\n", - 'type' => 'object', - 'properties' => [ - 'count' => [ - 'description' => 'The number of detection points.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupMonitoringAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeGroupMonitoringAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - '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' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - [ - 'errorCode' => 'RestrictedUser', - 'errorMessage' => 'The user\'s operation is restricted, please register NAAM product code.', - ], - [ - 'errorCode' => 'UnauthorizedTasks', - 'errorMessage' => 'You are not permitted to operate the specified tasks.', - ], - ], - [ - [ - 'errorCode' => 'TaskNotExist', - 'errorMessage' => 'The specified task does not exist.', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3fcd12e7-d387-42ee-b77e-661c775bb17f\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<DisableSiteMonitorsResponse>\\n\\t<Message>successful</Message>\\n\\t<RequestId>7AB49ADD-3276-4161-B9F9-8662CAA800D6</RequestId>\\n\\t<Data>\\n\\t\\t<count>0</count>\\n\\t</Data>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DisableSiteMonitorsResponse>","errorExample":""}]', - 'title' => 'EnableSiteMonitors', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7985D471-3FA8-4EE9-8F4B-45C19DF3D36F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"Total\\": \\"28\\",\\n \\"Processes\\": {\\n \\"Process\\": [\\n {\\n \\"ProcessName\\": \\"sshd\\",\\n \\"MatchExpressFilterRelation\\": \\"and\\",\\n \\"GroupId\\": \\"12345\\",\\n \\"Id\\": \\"3F6150F9-45C7-43F9-9578-A58B2E72****\\",\\n \\"MatchExpress\\": {\\n \\"MatchExpress\\": [\\n {\\n \\"Value\\": \\"portalHost\\",\\n \\"Name\\": \\"name\\",\\n \\"Function\\": \\"all\\"\\n }\\n ]\\n },\\n \\"AlertConfig\\": {\\n \\"AlertConfig\\": [\\n {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"SilenceTime\\": \\"86400\\",\\n \\"Webhook\\": \\"http://www.aliyun.com\\",\\n \\"Times\\": \\"3\\",\\n \\"EscalationsLevel\\": \\"warn\\",\\n \\"NoEffectiveInterval\\": \\"00:00-23:59\\",\\n \\"EffectiveInterval\\": \\"00:00-23:59\\",\\n \\"Threshold\\": \\"5\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"TargetList\\": {\\n \\"Target\\": [\\n {\\n \\"Id\\": \\"123\\",\\n \\"Arn\\": \\"acs:mns:cn-hangzhou:120886317861****:/queues/test/message\\",\\n \\"Level\\": \\"CRITICAL\\",\\n \\"JsonParmas\\": \\"{\\\\\\"customField1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"customField2\\\\\\":\\\\\\"$.name\\\\\\"}\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DescribeSiteMonitorQuota' => [ - 'summary' => 'Queries the quotas and version of site monitoring.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeHostAvailabilityList' => [ + 'summary' => 'Queries the list of availability monitoring tasks.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '26860260-76C6-404E-AB7A-EB98D36A6885', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The quota.'."\n", - 'type' => 'object', - 'properties' => [ - 'SiteMonitorOperatorQuotaQuota' => [ - 'description' => 'The quota of detection points that are not provided by Alibaba Cloud. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SecondMonitor' => [ - 'description' => 'Indicates whether second-level monitoring is enabled. Valid values:'."\n" - ."\n" - .'* true: Second-level monitoring is enabled.'."\n" - .'* false: Second-level monitoring is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'SiteMonitorQuotaTaskUsed' => [ - 'description' => 'The used quota of site monitoring tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'SiteMonitorTaskQuota' => [ - 'description' => 'The quota of site monitoring tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SiteMonitorVersion' => [ - 'description' => 'The version of site monitoring. Valid values:'."\n" - ."\n" - .'* V1'."\n" - .'* V2'."\n", - 'type' => 'string', - 'example' => 'V1', - ], - 'SiteMonitorIdcQuota' => [ - 'description' => 'The quota of detection points that are provided by Alibaba Cloud. Five detection points are provided for free.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the availability monitoring task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 'name' => 'Ids', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of multiple availability monitoring tasks. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '123456,345678', 'title' => ''], ], [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the availability monitoring task.', 'type' => 'string', 'required' => false, 'example' => 'ecs_instance', 'title' => ''], ], - ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"26860260-76C6-404E-AB7A-EB98D36A6885\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"SiteMonitorOperatorQuotaQuota\\": 0,\\n \\"SecondMonitor\\": false,\\n \\"SiteMonitorQuotaTaskUsed\\": 6,\\n \\"SiteMonitorTaskQuota\\": 10,\\n \\"SiteMonitorVersion\\": \\"V1\\",\\n \\"SiteMonitorIdcQuota\\": 5\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSiteMonitorQuotaResponse>\\n\\t\\t<Message>请求成功</Message>\\n\\t\\t<RequestId>C1359088-B0D3-4344-BA51-FB920425D836</RequestId>\\n\\t\\t<Data>\\n\\t\\t\\t<SiteMonitorVersion>V2</SiteMonitorVersion>\\n\\t\\t\\t<SiteMonitorQuotaTaskUsed>2</SiteMonitorQuotaTaskUsed>\\n\\t\\t\\t<SecondMonitor>false</SecondMonitor>\\n\\t\\t\\t<SiteMonitorOperatorQuotaQuota>0</SiteMonitorOperatorQuotaQuota>\\n\\t\\t\\t<SiteMonitorTaskQuota>100</SiteMonitorTaskQuota>\\n\\t\\t\\t<SiteMonitorIdcQuota>5</SiteMonitorIdcQuota>\\n\\t\\t</Data>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</DescribeSiteMonitorQuotaResponse>","errorExample":""}]', - 'title' => 'DescribeSiteMonitorQuota', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeSiteMonitorAttribute' => [ - 'summary' => 'Queries the details of a site monitoring task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc641dff-c19d-45f3-ad0a-818a0c4f****', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Minimum value: 1. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'IncludeAlert', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return the information of the alert rules that are configured for the site monitoring task. Valid values:'."\n" - ."\n" - .'* true: The system returns the information of the alert rules that are configured for the site monitoring task.'."\n" - .'* false (default): The system does not return the information of the alert rules that are configured for the site monitoring task.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'MetricRules' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4A288E86-45C3-4858-9DB0-6D85B10BD92A', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TaskList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'MetricRule' => [ - 'description' => 'The alert rules that are configured for the site monitoring task.', + 'NodeTaskConfig' => [ + 'description' => 'The list of availability monitoring tasks.', 'type' => 'array', 'items' => [ - 'description' => 'The alert rule that is configured for the site monitoring task.', + 'description' => 'The list of availability monitoring tasks.', 'type' => 'object', 'properties' => [ - 'ActionEnable' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'* true: The alert rule is enabled.'."\n" - .'* false: The alert rule is disabled.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'AlarmActions' => [ - 'description' => 'The alert contact group to which alert notifications are sent.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold in the alert rule. Valid values:'."\n" - ."\n" - .'* `>=`'."\n" - .'* `>`'."\n" - .'* `<=`'."\n" - .'* `<`'."\n" - .'* `=`'."\n" - .'* `!=`'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanYesterday', - ], - 'Dimensions' => [ - 'description' => 'The dimension of the alert rule.'."\n", - 'type' => 'string', - 'example' => '[{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }]', - ], - 'EvaluationCount' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Expression' => [ - 'description' => 'The expression that is used to trigger alerts.'."\n", - 'type' => 'string', - 'example' => '$Availability=30', - ], - 'Level' => [ - 'description' => 'The alert severity. Valid values:'."\n" - ."\n" - .'* 1: critical'."\n" - .'* 2: warning'."\n" - .'* 3: information'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'Availability', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'The value is in the following format: acs_service name.'."\n", - 'type' => 'string', - 'example' => 'acs_networkmonitor', - ], - 'OkActions' => [ - 'description' => 'The alert contact group that receives alert notifications.'."\n", - 'type' => 'string', - 'example' => '[ "CloudMonitor"]', - ], - 'Period' => [ - 'description' => 'The time interval. The value is the same as the interval at which metric data is reported. Unit: seconds.'."\n" - ."\n" - .'> If you specify a statistical period for the alert rule, data is queried based on the statistical period.'."\n", - 'type' => 'string', - 'example' => '15s', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'bf071ae_7b7aec3817b0fdf****', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'rule1', - ], - 'StateValue' => [ - 'description' => 'The alert status. Valid values:'."\n" - ."\n" - .'* OK: The alert rule has no active alerts.'."\n" - .'* ALARM: The alert rule has active alerts.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Statistics' => [ - 'description' => 'The statistical method of the alert rule. Valid values:'."\n" - ."\n" - .'* Availability: the percentage of available detection points'."\n" - .'* AvailableNumber: the number of available detection points'."\n" - .'* ErrorCodeMaximum: a status code for an alert'."\n" - .'* ErrorCodeMinimum: all status codes for a set of alerts'."\n" - .'* Average: response time'."\n", - 'type' => 'string', - 'example' => 'Availability', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '30', - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D17DF650-7EBD-54D0-903A-1D4E624D7402', - ], - 'SiteMonitors' => [ - 'description' => 'The details of the site monitoring task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Address' => [ - 'description' => 'The URL that is monitored by the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'https://aliyun.com', - ], - 'AgentGroup' => [ - 'description' => 'The type of the detection point. Default value: PC. Valid values:'."\n" - .'- PC'."\n" - .'- MOBILE', - 'type' => 'string', - 'example' => 'PC', - ], - 'CustomSchedule' => [ - 'description' => 'The custom detection cycle. You can specify only a time range within a week (from Monday to Sunday).', - 'type' => 'object', - 'properties' => [ - 'days' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'days' => [ - 'description' => 'The days in a week.', - 'type' => 'array', - 'items' => [ - 'description' => 'The days in a week.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - 'end_hour' => [ - 'description' => 'The end time of the detection. Unit: hours.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '18', - ], - 'start_hour' => [ - 'description' => 'The start time of the detection. Unit: hours.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'time_zone' => [ - 'description' => 'The time zone of the detection.', - 'type' => 'string', - 'example' => 'local', - ], - ], - ], - 'Interval' => [ - 'description' => 'The interval at which the site monitoring task is executed. Unit: minutes. Valid values: 1, 5, 15, 30, and 60.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'IspCities' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'IspCity' => [ - 'description' => 'The information of detection points. The information includes the carriers that provide the detection points and the cities where the detection points reside.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The detection point information.', - 'type' => 'object', - 'properties' => [ - 'City' => [ - 'description' => 'The city ID.'."\n", - 'type' => 'string', - 'example' => '738', - ], - 'CityName' => [ - 'description' => 'The city name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Isp' => [ - 'description' => 'The carrier ID.'."\n", - 'type' => 'string', - 'example' => '465', - ], - 'IspName' => [ - 'description' => 'The carrier name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Type' => [ - 'description' => 'The network type of the detection point. Valid values: IDC, LASTMILE, and MOBILE.', - 'type' => 'string', - 'example' => 'IDC', - ], - ], - ], - ], - ], - ], - 'OptionJson' => [ - 'description' => 'The extended options of the site monitoring task. The options vary based on the specified protocol. For more information, see [CreateSiteMonitor](~~115048~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'assertions' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'assertions' => [ - 'description' => 'The assertions.', - 'type' => 'array', - 'items' => [ - 'description' => 'The assertions.', - 'type' => 'object', - 'properties' => [ - 'operator' => [ - 'description' => 'The operator. Valid values:'."\n" - .'- contains: contains'."\n" - .'- doesNotContain: does not contain'."\n" - .'- matches: matches a regular expression'."\n" - .'- doesNotMatch: does not match a regular expression'."\n" - .'- is: equal to'."\n" - .'- isNot: not equal to'."\n" - .'- lessThan: less than'."\n" - .'- moreThan: greater than', - 'type' => 'string', - 'example' => 'lessThan', - ], - 'property' => [ - 'description' => 'The path to the assertion.'."\n" - .'- If the assertion type is body_json, the path is json path.'."\n" - .'- If the assertion type is body_xml, the path is xml path.', - 'type' => 'string', - 'example' => 'json path', - ], - 'target' => [ - 'description' => 'The value or character to which the condition of the assertion is compared.', - 'type' => 'string', - 'example' => '0', - ], - 'type' => [ - 'description' => 'The assertion type. Valid values:'."\n" - .'- response_time: checks whether the response time meets expectations.'."\n" - .'- status_code: checks whether the HTTP status code meets expectations.'."\n" - .'- header: checks whether the fields in the response header meet expectations.'."\n" - .'- body_text: check whether the content in the response body meets expectations by using text matching.'."\n" - .'- body_json: check whether the content in the response body meets expectations by using JSON parsing (JSONPath).'."\n" - .'- body_xml: check whether the content in the response body meets expectations by using XML parsing (XPath).', - 'type' => 'string', - 'example' => 'response_time', - ], - ], - ], - ], - ], - ], - 'attempts' => [ - 'description' => 'The number of retries after a DNS failure occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'auth_info' => [ - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'type' => 'string', - ], - 'username' => [ - 'type' => 'string', - ], - 'password' => [ - 'type' => 'string', - ], - 'use_cookie_session_key' => [ - 'type' => 'boolean', - ], - 'grant_type' => [ - 'type' => 'string', - ], - 'client_id' => [ - 'type' => 'string', - ], - 'client_secret' => [ - 'type' => 'string', - ], - 'scopes' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'scopes' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - 'token_url' => [ - 'type' => 'string', - ], - 'auth_style' => [ - 'type' => 'string', - ], - 'access_key_id' => [ - 'type' => 'string', - ], - 'access_key_secret' => [ - 'type' => 'string', - ], - 'region_id' => [ - 'type' => 'string', - ], - 'api_action' => [ - 'type' => 'string', - ], - 'api_version' => [ - 'type' => 'string', - ], - 'with_addon_resources' => [ - 'type' => 'boolean', - ], - 'service_name' => [ - 'type' => 'string', - ], - 'session_token' => [ - 'type' => 'string', - ], - ], - ], - 'blocked_url_list' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'blocked_url_list' => [ - 'description' => 'The blocked URLs. Wildcards are supported in paths.', - 'type' => 'array', - 'items' => [ - 'description' => 'The blocked URLs. Wildcards are supported in paths.', - 'type' => 'string', - 'example' => 'www.taobao.com/**', - ], - ], - ], - ], - 'browser_headers' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'browser_headers' => [ - 'description' => 'The custom headers. Format: {"key": "somekey", "value":"somevalue"}.', - 'type' => 'array', - 'items' => [ - 'description' => 'The custom headers. Format: {"key": "somekey", "value":"somevalue"}.', - 'type' => 'object', - 'example' => '{"key":"value"}', - ], - ], - ], - ], - 'browser_hosts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'browser_hosts' => [ - 'description' => 'The custom hosts. Format: {"key": "somekey", "value":"somevalue"}.', - 'type' => 'array', - 'items' => [ - 'description' => 'The custom hosts. Format: {"key": "somekey", "value":"somevalue"}.', - 'type' => 'string', - 'example' => '{"url":"www.taobao.com","ip":"127.0.0.1"}', - ], - ], - ], - ], - 'browser_info' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'browser_info' => [ - 'description' => 'The browser information.', - 'type' => 'array', - 'items' => [ - 'description' => 'The browser information.', - 'type' => 'object', - 'properties' => [ - 'browser' => [ - 'description' => 'The browser type.', - 'type' => 'string', - 'example' => 'Chrome', - ], - 'device' => [ - 'description' => 'The device type.', - 'type' => 'string', - 'example' => 'laptop', - ], - ], - ], - ], - ], - ], - 'browser_insecure' => [ - 'description' => 'Indicates whether certificate errors are ignored. Valid values:'."\n" - .'- false: Certificate errors are not ignored.'."\n" - .'- true: Certificate errors are ignored.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'browser_task_version' => [ - 'description' => 'The version of the browser test task. Valid values:'."\n" - .'- 1: browser test for a single page'."\n" - .'- 2: browser test for multiple pages', - 'type' => 'string', - 'example' => '1', - ], - 'cookie' => [ - 'description' => 'The cookie of the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'lang=en', - ], - 'diagnosis_mtr' => [ - 'description' => 'Indicates whether the automatic MTR diagnostics feature is enabled for a failed task. Valid values:'."\n" - .'- false: The automatic MTR diagnostics feature is disabled for a failed task.'."\n" - .'- true: The automatic MTR diagnostics feature is enabled for a failed task.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'diagnosis_ping' => [ - 'description' => 'Indicates whether the automatic ping latency detection feature is enabled for a failed task. Valid values:'."\n" - .'- false: The automatic ping latency detection feature is disabled for a failed task.'."\n" - .'- true: The automatic ping latency detection feature is enabled for a failed task.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'dns_hijack_whitelist' => [ - 'description' => 'The DNS hijack whitelist.', - 'type' => 'string', - 'example' => 'www.taobao.com:www.taobao.com.danuoyi.tbcache.com', - ], - 'dns_match_rule' => [ - 'description' => 'The relationship between the list of expected aliases or IP addresses and the list of DNS results. Valid values:'."\n" - ."\n" - .'* IN_DNS: The list of expected values is a subset of the list of DNS results.'."\n" - .'* DNS_IN: The list of DNS results is a subset of the list of expected values.'."\n" - .'* EQUAL: The list of DNS results is the same as the list of expected values.'."\n" - .'* ANY: The list of DNS results intersects with the list of expected values.'."\n", - 'type' => 'string', - 'example' => 'IN_DNS', - ], - 'dns_server' => [ - 'description' => 'The IP address of the DNS server.'."\n" + 'TaskType' => ['description' => 'The type of the task. Valid values:'."\n" ."\n" - .'> This parameter is returned only if the TaskType parameter is set to DNS.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'dns_type' => [ - 'description' => 'The type of the DNS record. This parameter is returned only if the TaskType parameter is set to DNS. Valid values:'."\n" + .'- PING'."\n" + .'- TELNET'."\n" + .'- HTTP', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'GroupName' => ['description' => 'The name of the application group.', 'type' => 'string', 'example' => 'Group_ECS', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'TaskName' => ['description' => 'The name of the availability monitoring task.', 'type' => 'string', 'example' => 'ecs_instance', 'title' => ''], + 'Disabled' => ['description' => 'Indicates whether the availability monitoring task is disabled. Valid values:'."\n" ."\n" - .'* A (default): a record that specifies an IP address related to the specified host name or domain name.'."\n" - .'* CNAME: a record that maps multiple domain names to a domain name.'."\n" - .'* NS: a record that specifies a DNS server used to parse domain names.'."\n" - .'* MX: a record that links domain names to the address of a mail server.'."\n" - .'* TXT: a record that stores the text information of host name or domain names. The text must be 1 to 512 bytes in length. The TXT record serves as a Sender Policy Framework (SPF) record to fight against spam.'."\n", - 'type' => 'string', - 'example' => 'A', - ], - 'empty_message' => [ - 'description' => 'Indicates whether the WebSocket task is allowed to return no response or return an empty response. Default value: false. Valid values: false and true.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'expect_exist_string' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'expect_exist_string' => [ - 'description' => 'The string that is expected to exist on the page.', - 'type' => 'array', - 'items' => [ - 'description' => 'The string that is expected to exist on the page.', - 'type' => 'string', - 'example' => 'expected string', - ], - ], - ], - ], - 'expect_non_exist_string' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'expect_non_exist_string' => [ - 'description' => 'The string that is not expected to exist on the page.', - 'type' => 'array', - 'items' => [ - 'description' => 'The string that is not expected to exist on the page.', - 'type' => 'string', - 'example' => 'unexpected string', - ], - ], - ], - ], - 'expect_value' => [ - 'description' => 'The domain name or alias to be parsed.'."\n" - ."\n" - .'> This parameter is returned only if the TaskType parameter is set to DNS.'."\n", - 'type' => 'string', - 'example' => 'dns_server', - ], - 'failure_rate' => [ - 'description' => 'The packet loss rate.'."\n" - ."\n" - .'> This parameter is returned only if the TaskType parameter is set to PING.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.4', - ], - 'header' => [ - 'description' => 'The header of the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'testKey:testValue', - ], - 'http_method' => [ - 'description' => 'The HTTP request method. Valid values:'."\n" + .'- true: The task is disabled.'."\n" ."\n" - .'* get'."\n" - .'* post'."\n" - .'* head'."\n", - 'type' => 'string', - 'example' => 'get', - ], - 'ip_network' => [ - 'description' => 'ip_network indicates the network type of the task. Valid values: v4, v6, and auto. Default value: v4.'."\n", - 'type' => 'string', - 'example' => 'v4', - 'enum' => [], - ], - 'isBase64Encode' => [ - 'description' => 'Indicates whether to perform Base64 decoding and then store the password. Valid values: true and false.', - 'type' => 'string', - 'example' => 'true', - ], - 'match_rule' => [ - 'description' => 'Indicates whether the alert rule is included. Valid values:'."\n" + .'- false: The task is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'TaskScope' => ['description' => 'The scope of the availability monitoring task. Valid values:'."\n" ."\n" - .'* 0: The alert rule is included.'."\n" - .'* 1: The alert rule is excluded.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'min_tls_version' => [ - 'description' => 'The minimum TLS version. By default, TLS 1.2 and later versions are supported. TLS 1.0 and 1.1 are disabled. If you still require TLS 1.0 or 1.1, you can change the configuration.', - 'type' => 'string', - 'example' => 'tlsv1.2', - ], - 'password' => [ - 'description' => 'The password of the SMTP, POP3, or FTP protocol.'."\n", - 'type' => 'string', - 'example' => '123****', - ], - 'ping_num' => [ - 'description' => 'The heartbeat of the PING protocol.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '29', - ], - 'ping_port' => [ - 'description' => 'The port number for TCP pings.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'ping_type' => [ - 'description' => 'The PING protocol type. Valid values:'."\n" - ."\n" - .'* icmp'."\n" - .'* tcp'."\n" - .'* udp'."\n", - 'type' => 'string', - 'example' => 'icmp,tcp,udp', - 'default' => 'icmp', - ], - 'port' => [ - 'description' => 'The port number of the TCP, UDP, SMTP, or POP3 protocol.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '110', - ], - 'protocol' => [ - 'description' => 'The protocol that is used to send the request.'."\n", - 'type' => 'string', - 'example' => 'TCP', - ], - 'quic_enabled' => [ - 'description' => 'Indicates whether the Quick UDP Internet Connections (QUIC) protocol is used for browser detection. Valid values: true false Default value: false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'quic_target' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'quic_target' => [ - 'description' => 'The sites for which the QUIC protocol is forcibly used.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The format is url:port for the sites for which the QUIC protocol is forcibly used. You can leave the port number empty. The default port number of 443.'."\n", - 'type' => 'string', - 'example' => 'www.taobao.com', - ], - ], - ], - ], - 'request_content' => [ - 'description' => 'The content of the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'aa=bb', - ], - 'request_format' => [ - 'description' => 'The format of the HTTP request. Valid values:'."\n" - ."\n" - .'* hex: hexadecimal'."\n" - .'* txt: text'."\n", - 'type' => 'string', - 'example' => 'txt', - ], - 'response_content' => [ - 'description' => 'The response to the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'txt', - ], - 'response_format' => [ - 'description' => 'The format of the HTTP response. Valid values:'."\n" - ."\n" - .'* hex: hexadecimal'."\n" - .'* txt: text'."\n", - 'type' => 'string', - 'example' => 'txt', - ], - 'retry_delay' => [ - 'description' => 'The number of retries for failed detections.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'screen_shot' => [ - 'description' => 'Indicates whether page screenshot is enabled.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'time_out' => [ - 'description' => 'The timeout period. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'traffic_hijack_element_blacklist' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'traffic_hijack_element_blacklist' => [ - 'description' => 'The traffic hijacking blacklist. When redirection occurs, if the URL of the resource loaded by the browser matches the expression in the blacklist, traffic hijacking is considered to have occurred.', - 'type' => 'array', - 'items' => [ - 'description' => 'The traffic hijacking blacklist. When redirection occurs, if the URL of the resource loaded by the browser matches the expression in the blacklist, traffic hijacking is considered to have occurred.', - 'type' => 'string', - 'example' => 'www.taobao.com', + .'- GROUP: All ECS instances in the current application group are used as detection points.'."\n" + .'- GROUP_SPEC_INSTANCE: Specified ECS instances in the current application group are used as detection points.', 'type' => 'string', 'example' => 'GROUP', 'title' => ''], + 'Id' => ['description' => 'The ID of the availability monitoring task.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'Instances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Instance' => [ + 'description' => 'The list of ECS instances that initiate detection.', + 'type' => 'array', + 'items' => ['description' => 'The list of ECS instances that initiate detection.', 'type' => 'string', 'example' => 'i-abcdefgh12****', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'traffic_hijack_element_count' => [ - 'description' => 'When redirection occurs, if the browser loads more than the specified number of resources, traffic hijacking is considered to have occurred. If you set the value to 0, no validation is performed. Default value: 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'traffic_hijack_element_whitelist' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'traffic_hijack_element_whitelist' => [ - 'description' => 'The traffic hijacking whitelist. When redirection occurs, if the URL of the resource loaded by the browser does not match any expression in the whitelist, traffic hijacking is considered to have occurred.', - 'type' => 'array', - 'items' => [ - 'description' => 'The traffic hijacking whitelist. When redirection occurs, if the URL of the resource loaded by the browser does not match any expression in the whitelist, traffic hijacking is considered to have occurred.', - 'type' => 'string', - 'example' => 'www.taobao.com', - ], + 'TaskOption' => [ + 'description' => 'The parameter options of the availability monitoring task.', + 'type' => 'object', + 'properties' => [ + 'HttpMethod' => ['description' => 'The HTTP method of the detection type. Valid values:'."\n" + ."\n" + .'- GET'."\n" + .'- POST'."\n" + .'- HEAD', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'Interval' => ['description' => 'The detection frequency. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'HttpURI' => ['description' => 'The URI for HTTP detection.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], + 'TelnetOrPingHost' => ['description' => 'The domain name or address to detect.', 'type' => 'string', 'example' => 'ssh.aliyun.com', 'title' => ''], + 'HttpResponseCharset' => ['description' => 'The response character set for HTTP detection.', 'type' => 'string', 'example' => 'UTF-8', 'title' => ''], + 'HttpPostContent' => ['description' => 'The POST content of the HTTP detection request.', 'type' => 'string', 'example' => 'params1=paramsValue1', 'title' => ''], + 'HttpNegative' => ['description' => 'The alert rule for matching HTTP response content. Valid values:'."\n" + .'- true: An alert is triggered if the HTTP response content contains the specified alert rule.'."\n" + .'- false: An alert is triggered if the HTTP response content does not contain the specified alert rule.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpKeyword' => ['description' => 'The keyword to match in the HTTP detection response content.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'username' => [ - 'description' => 'The username of the FTP, SMTP, or POP3 protocol.'."\n", - 'type' => 'string', - 'example' => 'testUser', - ], - 'waitTime_after_completion' => [ - 'description' => 'The additional waiting time after a page is opened in a browser test task.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'scroll_end' => [ - 'description' => 'Indicates whether to scroll to the bottom of the page after opening the page. This parameter is valid for a browser test task.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'host_binding' => [ - 'description' => 'The custom hosts for the HTTP test task. Format: ip1,ip2:address. You can specify values in multiple lines. Specify the A record or CNAME record that can be resolved by the domain name at the left of the colon. Separate multiple records with commas (,). Specify the domain name at the right of the colon.', - 'type' => 'string', - 'example' => '127.0.0.1:www.aliyun.com', - ], - 'host_binding_type' => [ - 'description' => 'The host binding type. Valid values: 0 and 1. 0 indicates random. 1 indicates polling.', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '0', - '1', - ], - 'example' => '0', - ], - 'hops' => [ - 'description' => 'The number of hops to perform traceroute diagnostics if the PING task fails.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'icmp_timeout_millis' => [ - 'description' => 'The timeout period of a PING task that uses ICMP. Unit: milliseconds.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3000', - ], - 'config_variables' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'config_variables' => [ - 'type' => 'array', - 'items' => [ + 'AlertConfig' => [ + 'description' => 'The alert rule configuration.', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => ['description' => 'The mute period. Unit: seconds. Default value: 86400.', 'type' => 'integer', 'format' => 'int32', 'example' => '86400', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the alert effective period. Valid values: 0 to 23.'."\n" + ."\n" + .'For example, if AlertConfig.StartTime is set to 0 and AlertConfig.EndTime is set to 22, the alert effective period is 00:00:00 to 22:00:00.'."\n" + ."\n" + .'>If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the alert effective period. Valid values: 0 to 23.'."\n" + ."\n" + .'For example, if AlertConfig.StartTime is set to 0 and AlertConfig.EndTime is set to 22, the alert effective period is 00:00:00 to 22:00:00.'."\n" + ."\n" + .'>If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'WebHook' => ['description' => 'The callback URL when an alert is triggered.'."\n" + ."\n" + .'CloudMonitor pushes alert information to this URL by using POST requests. Only the HTTP protocol is supported.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], + 'NotifyType' => ['description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'<props="china">- 2: Phone call + text message + email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- 1: Text message + email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- 0: Email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="intl">- 2: Email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="intl">- 1: Email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="intl">- 0: Email + DingTalk chatbot.</props>', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'EscalationList' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'name' => [ - 'type' => 'string', - ], - 'value' => [ - 'type' => 'string', - ], - 'secure' => [ - 'type' => 'boolean', + 'escalationList' => [ + 'description' => 'The conditions that trigger the alert.', + 'type' => 'array', + 'items' => [ + 'description' => 'The conditions that trigger the alert.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'MetricName' => ['description' => 'The metric for the alert. Valid values:'."\n" + ."\n" + .'- HttpStatus: HTTP status code.'."\n" + .'- HttpLatency: HTTP response time.'."\n" + .'- TelnetStatus: TELNET status code.'."\n" + .'- TelnetLatency: TELNET response time.'."\n" + .'- PingLostRate: PING packet loss rate.', 'type' => 'string', 'example' => 'HttpStatus', 'title' => ''], + 'Operator' => ['description' => 'The comparison operator for the alert rule. Valid values:'."\n" + ."\n" + .'- `>`'."\n" + .'- `>=`'."\n" + .'- `<`'."\n" + .'- `<=`'."\n" + .'- `=`', 'type' => 'string', 'example' => '=', 'title' => ''], + 'Times' => ['description' => 'The number of consecutive periods during which the threshold is exceeded before an alert is triggered.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Aggregate' => ['description' => 'The statistical method for the alert. The valid values vary based on the metric:'."\n" + ."\n" + .'- Value: The value of the HTTP status code.'."\n" + .'- Average: The average HTTP response time.'."\n" + .'- Value: The value of the TELNET status code.'."\n" + .'- TelnetLatency: The average TELNET response time.'."\n" + .'- Average: The average PING packet loss rate.', 'type' => 'string', 'example' => 'Value', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - ], - ], - 'steps' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'steps' => [ - 'type' => 'array', - 'items' => [ + 'TargetList' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'name' => [ - 'type' => 'string', - 'deprecated' => true, - ], - 'step_type' => [ - 'type' => 'string', - ], - 'url' => [ - 'type' => 'string', - ], - 'allow_failure' => [ - 'type' => 'boolean', - ], - 'is_critical' => [ - 'type' => 'boolean', - ], - 'wait_time_in_secs' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'extracted_variables' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'extracted_variables' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'type' => 'string', - ], - 'parser' => [ - 'type' => 'object', - 'properties' => [ - 'parser_type' => [ - 'type' => 'string', - ], - 'value' => [ - 'type' => 'string', - ], - ], - ], - 'field' => [ - 'type' => 'string', - ], - 'extracted_type' => [ - 'type' => 'string', - ], - ], - ], + 'Target' => [ + 'description' => 'The list of alert targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of alert targets.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the alert target.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN).'."\n" + ."\n" + .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:'."\n" + ."\n" + .'- Service: The code of the Alibaba Cloud service.'."\n" + ."\n" + .'- Region: The region ID.'."\n" + ."\n" + .'- Account: The Alibaba Cloud account ID.'."\n" + ."\n" + .'- ResourceType: The resource type.'."\n" + ."\n" + .'- ResourceId: The resource ID.', 'type' => 'string', 'example' => 'acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: Information.'."\n" + .'- WARN: Warning.'."\n" + .'- CRITICAL: Critical.', 'type' => 'string', 'example' => 'INFO', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters of the alert callback.', 'type' => 'string', 'example' => '{"key1":"value1"}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'option' => [ - 'type' => 'string', - ], - 'step_name' => [ - 'type' => 'string', - ], - 'use_generated_cookie' => [ - 'type' => 'boolean', - ], - 'auto_extract_cookie' => [ - 'type' => 'boolean', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'trace_region' => [ - 'type' => 'string', - ], - 'trace_type' => [ - 'type' => 'string', - ], - 'safe_link' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'enable_packet_capture' => [ - 'type' => 'boolean', - ], - 'use_private_crt' => [ - 'title' => '是否使用私有证书', - 'type' => 'boolean', - ], - 'private_crt_file_name' => [ - 'title' => '私有证书文件名', - 'type' => 'string', - 'example' => 'cert.pem', - ], - 'use_ssl' => [ - 'title' => '执行TCP任务时是否进行SSL连接', - 'type' => 'boolean', - ], - 'max_tls_version' => [ - 'title' => '最高TLS版本', - 'type' => 'string', - ], - 'server_name' => [ - 'title' => '服务器名称指示', - 'type' => 'string', - ], - 'supported_cipher_suits' => [ - 'title' => '支持的加密套件', - 'type' => 'string', - ], - ], - ], - 'TaskId' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'cc641dff-c19d-45f3-ad0a-818a0c4f****', - ], - 'TaskName' => [ - 'description' => 'The name of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'test123', - ], - 'TaskState' => [ - 'description' => 'The status of the site monitoring task. Valid values:'."\n" - ."\n" - .'* 1: The task is enabled.'."\n" - .'* 2: The task is disabled.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'TaskType' => [ - 'description' => 'The protocol that is used by the site monitoring task. Valid values: HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'VpcConfig' => [ - 'description' => 'The VPC configurations of the synthetic test task.', - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'description' => 'The region of the website for synthetic monitoring.', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'SecurityGroupId' => [ - 'description' => 'The ID of the security group.', - 'type' => 'string', - 'example' => 'sg-xxxxxx', - ], - 'VpcId' => [ - 'description' => 'The ID of the VPC used by the synthetic test task.', - 'type' => 'string', - 'example' => 'vpc-xxxxxx', - ], - 'VswitchId' => [ - 'description' => 'The ID of the vSwitch used by the synthetic test task.', - 'type' => 'string', - 'example' => 'vsw-xxxxxx', - ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'The parameter is missing or invalid. %s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], - ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], - ], - [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'Task Id does not exist', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"MetricRules\\": {\\n \\"MetricRule\\": [\\n {\\n \\"ActionEnable\\": \\"true\\",\\n \\"AlarmActions\\": \\"CloudMonitor\\",\\n \\"ComparisonOperator\\": \\"GreaterThanYesterday\\",\\n \\"Dimensions\\": \\"[{\\\\\\"taskId\\\\\\": \\\\\\"cc641dff-c19d-45f3-ad0a-818a0c4f****\\\\\\" }]\\",\\n \\"EvaluationCount\\": \\"3\\",\\n \\"Expression\\": \\"$Availability=30\\",\\n \\"Level\\": \\"2\\",\\n \\"MetricName\\": \\"Availability\\",\\n \\"Namespace\\": \\"acs_networkmonitor\\",\\n \\"OkActions\\": \\"[ \\\\\\"CloudMonitor\\\\\\"]\\",\\n \\"Period\\": \\"15s\\",\\n \\"RuleId\\": \\"bf071ae_7b7aec3817b0fdf****\\",\\n \\"RuleName\\": \\"rule1\\",\\n \\"StateValue\\": \\"OK\\",\\n \\"Statistics\\": \\"Availability\\",\\n \\"Threshold\\": \\"30\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D17DF650-7EBD-54D0-903A-1D4E624D7402\\",\\n \\"SiteMonitors\\": {\\n \\"Address\\": \\"https://aliyun.com\\",\\n \\"AgentGroup\\": \\"PC\\",\\n \\"CustomSchedule\\": {\\n \\"days\\": {\\n \\"days\\": [\\n 1\\n ]\\n },\\n \\"end_hour\\": 18,\\n \\"start_hour\\": 8,\\n \\"time_zone\\": \\"local\\"\\n },\\n \\"Interval\\": \\"1\\",\\n \\"IspCities\\": {\\n \\"IspCity\\": [\\n {\\n \\"City\\": \\"738\\",\\n \\"CityName\\": \\"北京市\\",\\n \\"Isp\\": \\"465\\",\\n \\"IspName\\": \\"阿里巴巴\\",\\n \\"Type\\": \\"IDC\\"\\n }\\n ]\\n },\\n \\"OptionJson\\": {\\n \\"assertions\\": {\\n \\"assertions\\": [\\n {\\n \\"operator\\": \\"lessThan\\",\\n \\"property\\": \\"json path\\",\\n \\"target\\": \\"0\\",\\n \\"type\\": \\"response_time\\"\\n }\\n ]\\n },\\n \\"attempts\\": 3,\\n \\"auth_info\\": {\\n \\"type\\": \\"basic\\",\\n \\"username\\": \\"test_username\\",\\n \\"password\\": \\"test_password\\",\\n \\"use_cookie_session_key\\": false,\\n \\"grant_type\\": \\"password\\",\\n \\"client_id\\": \\"client_id\\",\\n \\"client_secret\\": \\"client_secret\\",\\n \\"scopes\\": {\\n \\"scopes\\": [\\n \\"test_operation\\"\\n ]\\n },\\n \\"token_url\\": \\"https://www.example.com\\",\\n \\"auth_style\\": \\"ROA\\",\\n \\"access_key_id\\": \\"testAk\\",\\n \\"access_key_secret\\": \\"testSk\\",\\n \\"region_id\\": \\"cn-hangzhou\\",\\n \\"api_action\\": \\"example_api\\",\\n \\"api_version\\": \\"2019-01-01\\",\\n \\"with_addon_resources\\": false,\\n \\"service_name\\": \\"example_service_name\\",\\n \\"session_token\\": \\"example_token\\"\\n },\\n \\"blocked_url_list\\": {\\n \\"blocked_url_list\\": [\\n \\"www.taobao.com/**\\"\\n ]\\n },\\n \\"browser_headers\\": {\\n \\"browser_headers\\": [\\n {\\n \\"key\\": \\"value\\"\\n }\\n ]\\n },\\n \\"browser_hosts\\": {\\n \\"browser_hosts\\": [\\n \\"{\\\\\\"url\\\\\\":\\\\\\"www.taobao.com\\\\\\",\\\\\\"ip\\\\\\":\\\\\\"127.0.0.1\\\\\\"}\\"\\n ]\\n },\\n \\"browser_info\\": {\\n \\"browser_info\\": [\\n {\\n \\"browser\\": \\"Chrome\\",\\n \\"device\\": \\"laptop\\"\\n }\\n ]\\n },\\n \\"browser_insecure\\": false,\\n \\"browser_task_version\\": \\"1\\",\\n \\"cookie\\": \\"lang=en\\",\\n \\"diagnosis_mtr\\": false,\\n \\"diagnosis_ping\\": false,\\n \\"dns_hijack_whitelist\\": \\"www.taobao.com:www.taobao.com.danuoyi.tbcache.com\\",\\n \\"dns_match_rule\\": \\"IN_DNS\\",\\n \\"dns_server\\": \\"192.168.XX.XX\\",\\n \\"dns_type\\": \\"A\\",\\n \\"empty_message\\": false,\\n \\"expect_exist_string\\": {\\n \\"expect_exist_string\\": [\\n \\"expected string\\"\\n ]\\n },\\n \\"expect_non_exist_string\\": {\\n \\"expect_non_exist_string\\": [\\n \\"unexpected string\\"\\n ]\\n },\\n \\"expect_value\\": \\"dns_server\\",\\n \\"failure_rate\\": 0.4,\\n \\"header\\": \\"testKey:testValue\\",\\n \\"http_method\\": \\"get\\",\\n \\"ip_network\\": \\"v4\\",\\n \\"isBase64Encode\\": \\"false\\",\\n \\"match_rule\\": 1,\\n \\"min_tls_version\\": \\"tlsv1.2\\",\\n \\"password\\": \\"123****\\",\\n \\"ping_num\\": 29,\\n \\"ping_port\\": 80,\\n \\"ping_type\\": \\"icmp\\",\\n \\"port\\": 110,\\n \\"protocol\\": \\"TCP\\",\\n \\"quic_enabled\\": true,\\n \\"quic_target\\": {\\n \\"quic_target\\": [\\n \\"www.taobao.com\\"\\n ]\\n },\\n \\"request_content\\": \\"aa=bb\\",\\n \\"request_format\\": \\"txt\\",\\n \\"response_content\\": \\"txt\\",\\n \\"response_format\\": \\"txt\\",\\n \\"retry_delay\\": 0,\\n \\"screen_shot\\": false,\\n \\"strict_mode\\": false,\\n \\"time_out\\": 3,\\n \\"traffic_hijack_element_blacklist\\": {\\n \\"traffic_hijack_element_blacklist\\": [\\n \\"www.taobao.com\\"\\n ]\\n },\\n \\"traffic_hijack_element_count\\": 0,\\n \\"traffic_hijack_element_whitelist\\": {\\n \\"traffic_hijack_element_whitelist\\": [\\n \\"www.taobao.com\\"\\n ]\\n },\\n \\"username\\": \\"testUser\\",\\n \\"waitTime_after_completion\\": 3,\\n \\"scroll_end\\": false,\\n \\"host_binding\\": \\"127.0.0.1:www.aliyun.com\\",\\n \\"host_binding_type\\": 0,\\n \\"hops\\": 20,\\n \\"icmp_timeout_millis\\": 3000,\\n \\"config_variables\\": {\\n \\"config_variables\\": [\\n {\\n \\"name\\": \\"variable_name\\",\\n \\"value\\": \\"variable_value\\",\\n \\"secure\\": true\\n }\\n ]\\n },\\n \\"steps\\": {\\n \\"steps\\": [\\n {\\n \\"name\\": \\"step1\\",\\n \\"step_type\\": \\"http\\",\\n \\"url\\": \\"https://aliyun.com\\",\\n \\"allow_failure\\": true,\\n \\"is_critical\\": true,\\n \\"wait_time_in_secs\\": 5,\\n \\"extracted_variables\\": {\\n \\"extracted_variables\\": [\\n {\\n \\"name\\": \\"test_variable\\",\\n \\"parser\\": {\\n \\"parser_type\\": \\"0\\",\\n \\"value\\": \\"x.testkey.arrayvalue[0].innerkey\\"\\n },\\n \\"field\\": \\"request_id\\",\\n \\"extracted_type\\": \\"1\\"\\n }\\n ]\\n },\\n \\"option\\": \\"{\\\\\\"enable_operator_dns\\\\\\": true}\\",\\n \\"step_name\\": \\"step1\\",\\n \\"use_generated_cookie\\": true,\\n \\"auto_extract_cookie\\": true\\n }\\n ]\\n },\\n \\"trace_region\\": \\"cn-hangzhou\\",\\n \\"trace_type\\": \\"OpenTelemetry\\",\\n \\"safe_link\\": 0,\\n \\"enable_packet_capture\\": true,\\n \\"use_private_crt\\": true,\\n \\"private_crt_file_name\\": \\"cert.pem\\",\\n \\"use_ssl\\": true,\\n \\"max_tls_version\\": \\"tlsv1.3\\",\\n \\"server_name\\": \\"www.aliyun.com\\",\\n \\"supported_cipher_suits\\": \\"TLS_AES_256_GCM_SHA384\\"\\n },\\n \\"TaskId\\": \\"cc641dff-c19d-45f3-ad0a-818a0c4f****\\",\\n \\"TaskName\\": \\"test123\\",\\n \\"TaskState\\": \\"1\\",\\n \\"TaskType\\": \\"HTTP\\",\\n \\"VpcConfig\\": {\\n \\"Region\\": \\"cn-beijing\\",\\n \\"SecurityGroupId\\": \\"sg-xxxxxx\\",\\n \\"VpcId\\": \\"vpc-xxxxxx\\",\\n \\"VswitchId\\": \\"vsw-xxxxxx\\"\\n }\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeSiteMonitorAttributeResponse>\\r\\n\\t<MetricRules>\\r\\n\\t\\t<MetricRule>\\r\\n\\t\\t\\t<ComparisonOperator>GreaterThanYesterday</ComparisonOperator>\\r\\n\\t\\t\\t<RuleId>bf071ae_7b7aec3817b0fdf****</RuleId>\\r\\n\\t\\t\\t<Period>15s</Period>\\r\\n\\t\\t\\t<EvaluationCount>3</EvaluationCount>\\r\\n\\t\\t\\t<Dimensions>\\r\\n\\t\\t\\t\\t<taskId>cc641dff-c19d-45f3-ad0a-818a0c4f****</taskId>\\r\\n\\t\\t\\t</Dimensions>\\r\\n\\t\\t\\t<Statistics>Availability</Statistics>\\r\\n\\t\\t\\t<Namespace>acs_networkmonitor</Namespace>\\r\\n\\t\\t\\t<AlarmActions>CloudMonitor</AlarmActions>\\r\\n\\t\\t\\t<MetricName>Availability</MetricName>\\r\\n\\t\\t\\t<OkActions>CloudMonitor</OkActions>\\r\\n\\t\\t\\t<Expression>$Availability=30</Expression>\\r\\n\\t\\t\\t<ActionEnable>true</ActionEnable>\\r\\n\\t\\t\\t<StateValue>OK</StateValue>\\r\\n\\t\\t\\t<Level>2</Level>\\r\\n\\t\\t\\t<RuleName>rule1</RuleName>\\r\\n\\t\\t\\t<Threshold>30</Threshold>\\r\\n\\t\\t</MetricRule>\\r\\n\\t</MetricRules>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>D17DF650-7EBD-54D0-903A-1D4E624D7402</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n\\t<SiteMonitors>\\r\\n\\t\\t<OptionJson>\\r\\n\\t\\t\\t<time_out>30000</time_out>\\r\\n\\t\\t\\t<http_method>get</http_method>\\r\\n\\t\\t</OptionJson>\\r\\n\\t\\t<TaskId>cc641dff-c19d-45f3-ad0a-818a0c4f****</TaskId>\\r\\n\\t\\t<Address>https://aliyun.com</Address>\\r\\n\\t\\t<TaskName>test123</TaskName>\\r\\n\\t\\t<TaskType>HTTP</TaskType>\\r\\n\\t\\t<IspCities>\\r\\n\\t\\t\\t<IspCity>\\r\\n\\t\\t\\t\\t<IspName>阿里巴巴</IspName>\\r\\n\\t\\t\\t\\t<Isp>465</Isp>\\r\\n\\t\\t\\t\\t<CityName>北京市</CityName>\\r\\n\\t\\t\\t\\t<City>738</City>\\r\\n\\t\\t\\t</IspCity>\\r\\n\\t\\t</IspCities>\\r\\n\\t\\t<TaskState>1</TaskState>\\r\\n\\t\\t<Interval>1</Interval>\\r\\n\\t</SiteMonitors>\\r\\n</DescribeSiteMonitorAttributeResponse>\\t","errorExample":""}]', - 'title' => 'DescribeSiteMonitorAttribute', - 'description' => 'This topic provides an example on how to query the details of a site monitoring task whose ID is `cc641dff-c19d-45f3-ad0a-818a0c4f****`. The returned result indicates that the task name is `test123`, the URL that is monitored by the task is `https://aliyun.com`, and the name of the carrier is `Alibaba`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Query availability monitoring tasks', + 'description' => 'This topic provides an example on how to query the list of availability monitoring tasks for the current account. The response shows that the current account has one availability monitoring task record `ecs_instance`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSiteMonitorISPCityList' => [ - 'summary' => 'Queries the detection points that are provided by carriers.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHostAvailabilityList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeHostAvailabilityList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"4A288E86-45C3-4858-9DB0-6D85B10BD92A\\",\\n \\"Total\\": 1,\\n \\"Success\\": true,\\n \\"TaskList\\": {\\n \\"NodeTaskConfig\\": [\\n {\\n \\"TaskType\\": \\"HTTP\\",\\n \\"GroupName\\": \\"Group_ECS\\",\\n \\"GroupId\\": 12345,\\n \\"TaskName\\": \\"ecs_instance\\",\\n \\"Disabled\\": false,\\n \\"TaskScope\\": \\"GROUP\\",\\n \\"Id\\": 123456,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n \\"i-abcdefgh12****\\"\\n ]\\n },\\n \\"TaskOption\\": {\\n \\"HttpMethod\\": \\"GET\\",\\n \\"Interval\\": 60,\\n \\"HttpURI\\": \\"https://www.aliyun.com\\",\\n \\"TelnetOrPingHost\\": \\"ssh.aliyun.com\\",\\n \\"HttpResponseCharset\\": \\"UTF-8\\",\\n \\"HttpPostContent\\": \\"params1=paramsValue1\\",\\n \\"HttpNegative\\": true,\\n \\"HttpKeyword\\": \\"OK\\"\\n },\\n \\"AlertConfig\\": {\\n \\"SilenceTime\\": 86400,\\n \\"EndTime\\": 22,\\n \\"StartTime\\": 0,\\n \\"WebHook\\": \\"https://www.aliyun.com\\",\\n \\"NotifyType\\": 1,\\n \\"EscalationList\\": {\\n \\"escalationList\\": [\\n {\\n \\"Value\\": \\"400\\",\\n \\"MetricName\\": \\"HttpStatus\\",\\n \\"Operator\\": \\"=\\",\\n \\"Times\\": \\"3\\",\\n \\"Aggregate\\": \\"Value\\"\\n }\\n ]\\n },\\n \\"TargetList\\": {\\n \\"Target\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Arn\\": \\"acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages\\",\\n \\"Level\\": \\"INFO\\",\\n \\"JsonParams\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"}\\"\\n }\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeHybridMonitorDataList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Isp', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name or ID of the carrier.'."\n" - ."\n" - .'> Carrier names support fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'For more information about how to query the names of namespaces, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'default-aliyun', 'title' => ''], ], [ - 'name' => 'City', + 'name' => 'PromSQL', 'in' => 'query', - 'schema' => [ - 'description' => 'The name or ID of the city.'."\n" - ."\n" - .'> City names support fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The metric name.'."\n" + ."\n" + .'> PromQL statements are supported.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'AliyunEcs_cpu_total', 'title' => ''], ], [ - 'name' => 'IPV6', + 'name' => 'Start', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query IPv6 probes. Valid values:'."\n" - ."\n" - .'* true (default): IPv6 probes are queried.'."\n" - .'* false: IPv6 probes are not queried.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The start of the time range to query.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => false, 'example' => '1653804865', 'title' => ''], ], [ - 'name' => 'IPV4', + 'name' => 'End', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query IPv4 probes. Valid values:'."\n" - ."\n" - .'* true (default): IPv4 probes are queried.'."\n" - .'* false: IPv4 probes are not queried.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => false, 'example' => '1653805225', 'title' => ''], ], [ - 'name' => 'ViewAll', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return all detection points. Valid values:'."\n" - ."\n" - .'* true (default): returns all detection points.'."\n" - .'* false: returns only available detection points.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '60', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B35D7D84-547B-4E61-B909-48A1F8A0C756', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IspCityList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'IspCity' => [ - 'description' => 'The queried detection points.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried detection point.'."\n", - 'type' => 'object', - 'properties' => [ - 'CityName.en' => [ - 'description' => 'The city name.'."\n", - 'type' => 'string', - 'example' => 'Guiyang', - ], - 'IPV4ProbeCount' => [ - 'description' => 'The number of IPv4 probes.'."\n", - 'type' => 'string', - 'example' => '4', - ], - 'City' => [ - 'description' => 'The city ID.'."\n", - 'type' => 'string', - 'example' => '4', - ], - 'Isp' => [ - 'description' => 'The carrier ID.'."\n", - 'type' => 'string', - 'example' => '232', - ], - 'CityName.zh_CN' => [ - 'description' => 'The city name.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Region.zh_CN' => [ - 'description' => 'The name of the province.'."\n" - ."\n" - .'> This parameter can be returned only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '', - ], - 'IspName.zh_CN' => [ - 'description' => 'The carrier name.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Country.en' => [ - 'description' => 'The name of the country.'."\n", - 'type' => 'string', - 'example' => 'China', - ], - 'IPV6ProbeCount' => [ - 'description' => 'The number of IPv6 probes.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Region' => [ - 'description' => 'The province name.'."\n", - 'type' => 'string', - 'example' => '264', - ], - 'Country' => [ - 'description' => 'The country name.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '629', - ], - 'IspName.en' => [ - 'description' => 'The carrier name.'."\n", - 'type' => 'string', - 'example' => 'China-Unicom', - ], - 'Region.en' => [ - 'description' => 'The name of the province.'."\n", - 'type' => 'string', - 'example' => 'Guizhou', - ], - 'Country.zh_CN' => [ - 'description' => 'The name of the country.'."\n" - ."\n" - .'> This parameter can be returned only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '', + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'end timestamp must not be before start time.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C240412F-3F5F-50E2-ACEC-DE808EF9C4BE', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'TimeSeries' => [ + 'description' => 'The returned monitoring data.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'AliyunEcs_cpu_total', 'title' => ''], + 'Labels' => [ + 'description' => 'The tags of the time dimension.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'K' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'instanceId', 'title' => ''], + 'V' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'i-rj99xc6cptkk64ml****', 'title' => ''], ], - 'Area.zh_CN' => [ - 'description' => 'The area name.'."\n" + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Values' => [ + 'description' => 'The metric values that are collected at different timestamps.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'V' => ['description' => 'The metric value.', 'type' => 'string', 'example' => '0.13', 'title' => ''], + 'Ts' => ['description' => 'The timestamp that indicates the time when the metric value is collected.'."\n" ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Area.en' => [ - 'description' => 'The area name.'."\n", - 'type' => 'string', - 'example' => 'XiNan', - ], - 'IPPool' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'IPPool' => [ - 'description' => 'The IP address pool.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address pool.'."\n", - 'type' => 'string', - 'example' => '["192.68.XX.XX","192.68.XX.XX"]', - ], - ], - ], + .'Unit: seconds.', 'type' => 'string', 'example' => '1653804865', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'BadRequest', 'errorMessage' => 'Bad request.', 'description' => 'Error Parameter Request'], ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], - ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => '%s', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'DescribeHybridMonitorDataList', + 'summary' => 'Queries the monitoring data in a namespace.', + 'description' => '## [](#)Prerequisites'."\n" + ."\n" + .'Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" + ."\n" + .'## [](#)Limits'."\n" + ."\n" + .'The size of monitoring data that is returned in each call cannot exceed 1.5 MB. If the returned data reaches the upper limit, the query fails. You must reset the query conditions.'."\n" + ."\n" + .'## [](#)Operation description'."\n" + ."\n" + .'This topic provides an example to show how to query the monitoring data of the `AliyunEcs_cpu_total` metric in the `default-aliyun` namespace from `1653804865` (14:14:25 on May 29, 2022) to `1653805225` (14:20:25 on May 29, 2022).', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-05-30T06:45:26.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorDataList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:DescribeCustomMetricDataPoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"B35D7D84-547B-4E61-B909-48A1F8A0C756\\",\\n \\"Success\\": \\"true\\",\\n \\"IspCityList\\": {\\n \\"IspCity\\": [\\n {\\n \\"CityName.en\\": \\"Guiyang\\",\\n \\"IPV4ProbeCount\\": \\"4\\",\\n \\"City\\": \\"4\\",\\n \\"Isp\\": \\"232\\",\\n \\"CityName.zh_CN\\": \\"贵阳市\\",\\n \\"Region.zh_CN\\": \\"贵州省\\",\\n \\"IspName.zh_CN\\": \\"联通\\",\\n \\"Country.en\\": \\"China\\",\\n \\"IPV6ProbeCount\\": \\"3\\",\\n \\"Region\\": \\"264\\",\\n \\"Country\\": \\"629\\",\\n \\"IspName.en\\": \\"China-Unicom\\",\\n \\"Region.en\\": \\"Guizhou\\",\\n \\"Country.zh_CN\\": \\"中国\\",\\n \\"Area.zh_CN\\": \\"西南\\",\\n \\"Area.en\\": \\"XiNan\\",\\n \\"IPPool\\": {\\n \\"IPPool\\": [\\n \\"[\\\\\\"192.68.XX.XX\\\\\\",\\\\\\"192.68.XX.XX\\\\\\"]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSiteMonitorISPCityListResponse>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>B35D7D84-547B-4E61-B909-48A1F8A0C756</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n\\t<IspCityList>\\r\\n\\t\\t<IspCity>\\r\\n\\t\\t\\t<Country.zh_CN>中国</Country.zh_CN>\\r\\n\\t\\t\\t<Area.zh_CN>西南</Area.zh_CN>\\r\\n\\t\\t\\t<CityName.en>Guiyang</CityName.en>\\r\\n\\t\\t\\t<IPV4ProbeCount>4</IPV4ProbeCount>\\r\\n\\t\\t\\t<Isp>232</Isp>\\r\\n\\t\\t\\t<City>4</City>\\r\\n\\t\\t\\t<IspName.en>China-Unicom</IspName.en>\\r\\n\\t\\t\\t<Country.en>China</Country.en>\\r\\n\\t\\t\\t<IPV6ProbeCount>0</IPV6ProbeCount>\\r\\n\\t\\t\\t<CityName.zh_CN>贵阳市</CityName.zh_CN>\\r\\n\\t\\t\\t<Area.en>XiNan</Area.en>\\r\\n\\t\\t\\t<Region.zh_CN>贵州省</Region.zh_CN>\\r\\n\\t\\t\\t<APIProbeCount>0</APIProbeCount>\\r\\n\\t\\t\\t<Region>264</Region>\\r\\n\\t\\t\\t<Country>629</Country>\\r\\n\\t\\t\\t<IspName.zh_CN>联通</IspName.zh_CN>\\r\\n\\t\\t\\t<Region.en>Guizhou</Region.en>\\r\\n\\t\\t\\t<IPPool>\\r\\n\\t\\t\\t\\t<IPPool>192.168.XX.XX</IPPool>\\r\\n\\t\\t\\t\\t<IPPool>192.168.XX.XX</IPPool>\\r\\n\\t\\t\\t</IPPool>\\r\\n\\t\\t</IspCity>\\r\\n\\t</IspCityList>\\r\\n</DescribeSiteMonitorISPCityListResponse>","errorExample":""}]', - 'title' => 'DescribeSiteMonitorISPCityList', - 'description' => 'This topic provides an example on how to query the detection points that are provided by China Unicom in Guiyang.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"end timestamp must not be before start time.\\",\\n \\"RequestId\\": \\"C240412F-3F5F-50E2-ACEC-DE808EF9C4BE\\",\\n \\"Success\\": \\"true\\",\\n \\"TimeSeries\\": [\\n {\\n \\"MetricName\\": \\"AliyunEcs_cpu_total\\",\\n \\"Labels\\": [\\n {\\n \\"K\\": \\"instanceId\\",\\n \\"V\\": \\"i-rj99xc6cptkk64ml****\\"\\n }\\n ],\\n \\"Values\\": [\\n {\\n \\"V\\": \\"0.13\\",\\n \\"Ts\\": \\"1653804865\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeSiteMonitorData' => [ - 'summary' => 'Queries the fine-grained monitoring data of a site monitoring task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeHybridMonitorNamespaceList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****', - ], - ], - [ - 'name' => 'Type', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the monitored object whose monitoring data is to be queried. Valid values:'."\n" - ."\n" - .'* metric'."\n" - .'* event'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'metric', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Minimum value: 1. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'MetricName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. Valid values:'."\n" - ."\n" - .'* Availability'."\n" - .'* ResponseTime'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Availability', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query. The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1551579637000', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1551581437000', - ], + 'schema' => ['description' => 'The keyword for the search.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aliyun', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period. The value is an integral multiple of 60. Unit: seconds.'."\n" - ."\n" - .'> The default value equals the minimum interval at which detection requests are sent to the monitored address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'The name can contain uppercase letters, lowercase letters, digits, and hyphens (-).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aliyun-test', 'title' => ''], ], [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '49f7b317-7645-4cc9-94fd-ea42e5220930ea42e5220930ea42e522****', - ], - ], - [ - 'name' => 'Length', + 'name' => 'ShowTaskStatistic', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of data points to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'Specifies whether to display the configuration details of data import tasks for Alibaba Cloud services and the number of data import tasks for non-Alibaba Cloud services. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false (default)', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'No description is available.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The pagination token.'."\n", - 'type' => 'string', - 'example' => 'ea42e5220930ea42e522****', - ], - 'Data' => [ - 'description' => 'The monitoring data.'."\n", - 'type' => 'string', - 'example' => '[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954****","taskId":"49f7b317-7645-4cc9-94fd-ea42e522****","timestamp":1551581760000}]', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3febb181-0d98-4af9-8b04-7faf36b048b9', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1EC450A4-3221-5148-B77E-2827576CFE48', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter PageSize is not valid.', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DescribeHybridMonitorNamespace' => [ + 'description' => 'The details of the namespaces.', + 'type' => 'array', + 'items' => [ + 'description' => 'No description is available.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the namespace.', 'type' => 'string', 'example' => 'aliyun-test', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the namespace was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1652682744000', 'title' => ''], + 'Namespace' => ['description' => 'The name of the namespace.', 'type' => 'string', 'example' => 'aliyun-test', 'title' => ''], + 'IsDelete' => ['description' => 'Indicates whether the namespace is deleted. Valid values:'."\n" + ."\n" + .'- 0: The namespace is not deleted.'."\n" + ."\n" + .'- 1: The namespace is deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The namespace ID.', 'type' => 'string', 'example' => '3****', 'title' => ''], + 'ModifyTime' => ['description' => 'The timestamp when the namespace was last modified. Unit: milliseconds.', 'type' => 'string', 'example' => '1652682744000', 'title' => ''], + 'Detail' => [ + 'description' => 'The details of the data storage duration.', + 'type' => 'object', + 'properties' => [ + 'Spec' => ['description' => 'The data storage duration. Valid values:'."\n" + ."\n" + .'- cms.s1.large: 15 days.'."\n" + ."\n" + .'- cms.s1.xlarge: 32 days.'."\n" + ."\n" + .'- cms.s1.2xlarge: 63 days.'."\n" + ."\n" + .'- cms.s1.3xlarge: 93 days.'."\n" + ."\n" + .'- cms.s1.6xlarge: 185 days.'."\n" + ."\n" + .'- cms.s1.12xlarge: 376 days.', 'type' => 'string', 'example' => 'cms.s1.3xlarge', 'title' => ''], + 'NamespaceRegion' => ['description' => 'The region where the monitoring data is stored.'."\n" + ."\n" + .'> This parameter is returned if you set `NamespaceType` to `m_prom_user` when you create the namespace.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'SLSProject' => ['description' => 'The Simple Log Service (SLS) project where the monitoring data is stored.'."\n" + ."\n" + .'> This parameter is returned if you set `NamespaceType` to `m_prom_user` when you create the namespace.', 'type' => 'string', 'example' => 'cms-hybrid-120886317861****-cn-hangzhou-a83d', 'title' => ''], + 'PrometheusInstanceId' => ['description' => 'The Prometheus instance where the monitoring data is stored.'."\n" + ."\n" + .'> This parameter is returned if you set `NamespaceType` to `aliyun_prometheus` when you create the namespace.', 'type' => 'string', 'example' => 'rw-57******************7f', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'NotAliyunTaskNumber' => ['description' => 'The number of data import tasks for non-Alibaba Cloud services.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'AliyunProductMetricList' => [ + 'description' => 'The configuration details of data import tasks for Alibaba Cloud services.', + 'type' => 'array', + 'items' => [ + 'description' => 'No description is available.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['description' => 'The account that is used to create the namespace.', 'type' => 'integer', 'format' => 'int64', 'example' => '120886317861****', 'title' => ''], + 'NamespaceList' => [ + 'description' => 'The list of namespaces.', + 'type' => 'array', + 'items' => [ + 'description' => 'No description is available.', + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The data namespace of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'MetricList' => [ + 'description' => 'The list of metrics for the Alibaba Cloud service.', + 'type' => 'array', + 'items' => [ + 'description' => 'No description is available.', + 'type' => 'object', + 'properties' => [ + 'Period' => ['description' => 'The collection period of the metric.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], + 'List' => [ + 'description' => 'The list of metrics.', + 'type' => 'array', + 'items' => ['description' => 'The metric.', 'type' => 'string', 'example' => '["cpu_total"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'YAMLConfig' => ['description' => 'The configuration file for the Alibaba Cloud service that is connected to Hybrid Cloud Monitoring.'."\n" + ."\n" + .'- namespace: the namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'- metric\\_list: the metrics of the Alibaba Cloud service.'."\n" + ."\n" + .'- dimension: the resources of the Alibaba Cloud service that can be queried in Hybrid Cloud Monitoring. If this parameter is empty, all resources are monitored.', 'type' => 'string', 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: \'\'', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NamespaceType' => ['description' => 'The storage solution for monitoring data. Valid values:'."\n" + ."\n" + .'- m\\_prom\\_user: The monitoring data is stored in SLS.'."\n" + ."\n" + .'- m\\_prom\\_pool: The monitoring data is stored in the storage space provided by Cloud Monitor.'."\n" + ."\n" + .'- aliyun\\_prometheus: The monitoring data is stored in a Prometheus instance.', 'type' => 'string', 'example' => 'aliyun_prometheus', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], - ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => '%s', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'DescribeHybridMonitorNamespaceList', + 'summary' => 'Queries a list of namespaces and the details of their data sources.', + 'description' => 'This example shows how to query all namespaces that belong to the current account. The response indicates that only one namespace, `aliyun-test`, exists.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2025-05-27T06:45:50.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-11-21T10:00:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-25T07:24:00.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorNamespaceList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeCustomNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[{\\\\\\"Maximum\\\\\\":247,\\\\\\"Mimimum\\\\\\":61,\\\\\\"Average\\\\\\":154,\\\\\\"userId\\\\\\":\\\\\\"127067667954****\\\\\\",\\\\\\"taskId\\\\\\":\\\\\\"49f7b317-7645-4cc9-94fd-ea42e522****\\\\\\",\\\\\\"timestamp\\\\\\":1551581760000}]\\",\\n \\"NextToken\\": \\"ea42e5220930ea42e522****\\",\\n \\"RequestId\\": \\"3febb181-0d98-4af9-8b04-7faf36b048b9\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeSiteMonitorData>\\r\\n\\t\\t<Data>\\r\\n\\t\\t\\t<Over5totalTime>0</Over5totalTime>\\r\\n\\t\\t\\t<Error4XXRate>0</Error4XXRate>\\r\\n\\t\\t\\t<UnavailableNumber>0</UnavailableNumber>\\r\\n\\t\\t\\t<Over2totalTime>0</Over2totalTime>\\r\\n\\t\\t\\t<timestamp>1551581040000</timestamp>\\r\\n\\t\\t\\t<Over100FailureRate>0</Over100FailureRate>\\r\\n\\t\\t\\t<Over10FailureRate>0</Over10FailureRate>\\r\\n\\t\\t\\t<Availability>100</Availability>\\r\\n\\t\\t\\t<Over80FailureRate>0</Over80FailureRate>\\r\\n\\t\\t\\t<userId>123****</userId>\\r\\n\\t\\t\\t<AvailableNumber>2</AvailableNumber>\\r\\n\\t\\t\\t<Unavailability>0</Unavailability>\\r\\n\\t\\t\\t<ErrorCodeMaximum>0</ErrorCodeMaximum>\\r\\n\\t\\t\\t<Over10totalTime>0</Over10totalTime>\\r\\n\\t\\t\\t<taskId>49f7b317-7645-4cc9-94fd-1****</taskId>\\r\\n\\t\\t\\t<Over30FailureRate>0</Over30FailureRate>\\r\\n\\t\\t\\t<Error6XXRate>0</Error6XXRate>\\r\\n\\t\\t\\t<Over500NumberRate>0</Over500NumberRate>\\r\\n\\t\\t\\t<Over3totalTime>0</Over3totalTime>\\r\\n\\t\\t\\t<Over400NumberRate>0</Over400NumberRate>\\r\\n\\t\\t\\t<Error5XXRate>0</Error5XXRate>\\r\\n\\t\\t\\t<Error5XXNumber>0</Error5XXNumber>\\r\\n\\t\\t\\t<Over90FailureRate>0</Over90FailureRate>\\r\\n\\t\\t\\t<Error4XXNumber>0</Error4XXNumber>\\r\\n\\t\\t\\t<Over50FailureRate>0</Over50FailureRate>\\r\\n\\t\\t\\t<ErrorCodeMinimum>0</ErrorCodeMinimum>\\r\\n\\t\\t\\t<Error6XXNumber>0</Error6XXNumber>\\r\\n\\t\\t</Data>\\r\\n\\t\\t<Data>\\r\\n\\t\\t\\t<Over5totalTime>0</Over5totalTime>\\r\\n\\t\\t\\t<Error4XXRate>0</Error4XXRate>\\r\\n\\t\\t\\t<UnavailableNumber>0</UnavailableNumber>\\r\\n\\t\\t\\t<Over2totalTime>0</Over2totalTime>\\r\\n\\t\\t\\t<timestamp>1551581100000</timestamp>\\r\\n\\t\\t\\t<Over100FailureRate>0</Over100FailureRate>\\r\\n\\t\\t\\t<Over10FailureRate>0</Over10FailureRate>\\r\\n\\t\\t\\t<Availability>100</Availability>\\r\\n\\t\\t\\t<Over80FailureRate>0</Over80FailureRate>\\r\\n\\t\\t\\t<userId>12345</userId>\\r\\n\\t\\t\\t<AvailableNumber>2</AvailableNumber>\\r\\n\\t\\t\\t<Unavailability>0</Unavailability>\\r\\n\\t\\t\\t<ErrorCodeMaximum>0</ErrorCodeMaximum>\\r\\n\\t\\t\\t<Over10totalTime>0</Over10totalTime>\\r\\n\\t\\t\\t<taskId>49f7b317-7645-4cc9-94fd-1****</taskId>\\r\\n\\t\\t\\t<Over30FailureRate>0</Over30FailureRate>\\r\\n\\t\\t\\t<Error6XXRate>0</Error6XXRate>\\r\\n\\t\\t\\t<Over500NumberRate>0</Over500NumberRate>\\r\\n\\t\\t\\t<Over3totalTime>0</Over3totalTime>\\r\\n\\t\\t\\t<Over400NumberRate>0</Over400NumberRate>\\r\\n\\t\\t\\t<Error5XXRate>0</Error5XXRate>\\r\\n\\t\\t\\t<Error5XXNumber>0</Error5XXNumber>\\r\\n\\t\\t\\t<Over90FailureRate>0</Over90FailureRate>\\r\\n\\t\\t\\t<Error4XXNumber>0</Error4XXNumber>\\r\\n\\t\\t\\t<Over50FailureRate>0</Over50FailureRate>\\r\\n\\t\\t\\t<ErrorCodeMinimum>0</ErrorCodeMinimum>\\r\\n\\t\\t\\t<Error6XXNumber>0</Error6XXNumber>\\r\\n\\t\\t</Data>\\r\\n\\t\\t<RequestId>DBDEAC51-EA3C-4853-8F25-6B48D38A28A9</RequestId>\\r\\n\\t\\t<Success>true</Success>\\r\\n\\t\\t<Code>200</Code>\\r\\n</DescribeSiteMonitorData>","errorExample":""}]', - 'title' => 'DescribeSiteMonitorData', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The returned data contains a JSON string that may consist of several or all of the following parameters:'."\n" - ."\n" - .'* Error4XXRate: the percentage of detection results with 4XX status codes.'."\n" - .'* Error6XXRate: the percentage of detection results with 6XX status codes.'."\n" - .'* Error5XXRate: the percentage of detection results with 5XX status codes.'."\n" - .'* Error4XXNumber: the number of detection results with 4XX status codes.'."\n" - .'* Error5XXNumber: the number of detection results with 5XX status codes.'."\n" - .'* Error6XXNumber: the number of detection results with 6XX status codes.'."\n" - .'* Over5totalTime: the percentage of detection requests to which the response time exceeds 5,000 ms.'."\n" - .'* Over3totalTime: the percentage of detection requests to which the response time exceeds 3,000 ms.'."\n" - .'* Over2totalTime: the percentage of detection requests to which the response time exceeds 2,000 ms.'."\n" - .'* Over10FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 10%.'."\n" - .'* Over100FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 99%.'."\n" - .'* Over30FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 30%.'."\n" - .'* Over50FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 50%.'."\n" - .'* Over80FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 80%.'."\n" - .'* Over90FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 90%.'."\n" - .'* Over400NumberRate: the percentage of detection results with status codes that are greater than 400.'."\n" - .'* Over400NumberRate: the percentage of detection results with status codes that are greater than 500.'."\n" - .'* AvailableNumber: the number of available detection points.'."\n" - .'* UnavailableNumber: the number of unavailable detection points.'."\n" - .'* Availability: the availability rate.'."\n" - .'* Unavailability: the unavailability rate.'."\n" - .'* ErrorCodeMaximum: the maximum error code in the detection results that were returned in a specific period. Assume that five status codes are returned in a minute after detection requests are sent from five detection points. The status code in four detection results is 200 and that in one detection result is 404. In this case, the maximum error code is 404.'."\n" - .'* ErrorCodeMinimum: the minimum error code in the detection results returned in a monitoring period. Assume that five status codes are returned in a minute after detection requests are sent from five detection points. The status code in four detection results is 200 and that in one detection result is 404. In this case, the minimum error code is 200.'."\n" - ."\n" - .'> We recommend that you use the AvailableNumber, UnavailableNumber, Availability, Unavailability, ErrorCodeMaximum, or ErrorCodeMinimum metric, whose value is easy to calculate.'."\n", - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1EC450A4-3221-5148-B77E-2827576CFE48\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Specified parameter PageSize is not valid.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 1,\\n \\"DescribeHybridMonitorNamespace\\": [\\n {\\n \\"Description\\": \\"aliyun-test\\",\\n \\"CreateTime\\": \\"1652682744000\\",\\n \\"Namespace\\": \\"aliyun-test\\",\\n \\"IsDelete\\": 0,\\n \\"Id\\": \\"3****\\",\\n \\"ModifyTime\\": \\"1652682744000\\",\\n \\"Detail\\": {\\n \\"Spec\\": \\"cms.s1.3xlarge\\",\\n \\"NamespaceRegion\\": \\"cn-hangzhou\\",\\n \\"SLSProject\\": \\"cms-hybrid-120886317861****-cn-hangzhou-a83d\\",\\n \\"PrometheusInstanceId\\": \\"rw-57******************7f\\"\\n },\\n \\"NotAliyunTaskNumber\\": 0,\\n \\"AliyunProductMetricList\\": [\\n {\\n \\"UserId\\": 0,\\n \\"NamespaceList\\": [\\n {\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"MetricList\\": [\\n {\\n \\"Period\\": 60,\\n \\"List\\": [\\n \\"[\\\\\\"cpu_total\\\\\\"]\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"YAMLConfig\\": \\"products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: \'\'\\"\\n }\\n ],\\n \\"NamespaceType\\": \\"aliyun_prometheus\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeSiteMonitorStatistics' => [ - 'summary' => 'Queries the statistics of a specified metric for a specified site monitoring task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeHybridMonitorSLSGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task.'."\n" - ."\n" - .'For more information about how to obtain the ID of a site monitoring task, see [DescribeSiteMonitorList](~~115052~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ef4cdc8b-9dc7-43e7-810e-f950e56c****', - ], + 'schema' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => 'Logstore', 'title' => ''], ], [ - 'name' => 'TimeRange', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period.'."\n" - ."\n" - .'Unit: minutes. Default value: 1440 (one day). Maximum value: 43200 (30 days).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1440', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Minimum value: 1. Default value: 10.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'Unit: milliseconds. The default value is 1 hour ahead of the current time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1576142850527', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Minimum value: 1. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'MetricName', + 'name' => 'SLSGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. Valid values:'."\n" - ."\n" - .'* Availability'."\n" - .'* ErrorRate'."\n" - .'* ResponseTime'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Availability', - ], + 'schema' => ['description' => 'The name of the Logstore group.', 'type' => 'string', 'required' => false, 'example' => 'Logstore_test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Succcessful', - ], - 'Data' => [ - 'description' => 'The statistics.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3AD2724D-E317-4BFB-B422-D6691D071BE1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'NotFound.SLSGroup', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'List' => [ + 'description' => 'The list of Logstore groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSGroupName' => ['description' => 'The name of the Logstore group.', 'type' => 'string', 'format' => 'int64', 'example' => 'Logstore_test', 'title' => ''], + 'SLSGroupDescription' => ['description' => 'The description of the Logstore group.', 'type' => 'string', 'example' => 'Logstore group of Alibaba Cloud products.', 'title' => ''], + 'SLSGroupConfig' => [ + 'description' => 'The configuration information of the Logstore group.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSRegion' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'SLSProject' => ['description' => 'The Simple Log Service project.', 'type' => 'string', 'example' => 'aliyun-project', 'title' => ''], + 'SLSLogstore' => ['description' => 'The Logstore.', 'type' => 'string', 'example' => 'Logstore-aliyun-all', 'title' => ''], + 'SLSUserId' => ['description' => 'The member ID.'."\n" + ."\n" + .'> This parameter is returned only when you call this operation by using a management account.', 'type' => 'string', 'example' => '120886317861****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CreateTime' => ['description' => 'The timestamp when the Logstore group was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1652845630000', 'title' => ''], + 'UpdateTime' => ['description' => 'The timestamp when the Logstore group was last modified.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1652845630000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'The specified parameter is not valid.', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - [ - 'errorCode' => 'InvalidClientTokenId', - 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + 412 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'Query logstore group list', + 'summary' => 'Queries the list of Logstore groups by calling the DescribeHybridMonitorSLSGroup operation.', + 'description' => 'This topic provides an example of how to query all Logstore groups in the current account. The response shows that the current account has two Logstore groups: `Logstore_test` and `Logstore_aliyun`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-06-20T02:41:49.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorSLSGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeHybridMonitorSLSGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"100\\",\\n \\"RequestId\\": \\"3AD2724D-E317-4BFB-B422-D6691D071BE1\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeSiteMonitorStatisticsResponse>\\n\\t<Message>successful</Message>\\n\\t<RequestId>3AD2724D-E317-4BFB-B422-D6691D071BE1</RequestId>\\n\\t<Data>100</Data>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DescribeSiteMonitorStatisticsResponse>\\t","errorExample":""}]', - 'title' => 'DescribeSiteMonitorStatistics', - 'description' => 'This topic provides an example on how to query the statistics of the `Availability` metric for a site monitoring task whose ID is `ef4cdc8b-9dc7-43e7-810e-f950e56c****`. The result indicates that the availability rate of the site is `100%`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"NotFound.SLSGroup\\",\\n \\"RequestId\\": \\"66683237-7126-50F8-BBF8-D67ACC919A17\\",\\n \\"Success\\": \\"true\\",\\n \\"List\\": [\\n {\\n \\"SLSGroupName\\": \\"Logstore_test\\",\\n \\"SLSGroupDescription\\": \\"Logstore group of Alibaba Cloud products.\\",\\n \\"SLSGroupConfig\\": [\\n {\\n \\"SLSRegion\\": \\"cn-hangzhou\\",\\n \\"SLSProject\\": \\"aliyun-project\\",\\n \\"SLSLogstore\\": \\"Logstore-aliyun-all\\",\\n \\"SLSUserId\\": \\"120886317861****\\"\\n }\\n ],\\n \\"CreateTime\\": \\"1652845630000\\",\\n \\"UpdateTime\\": \\"1652845630000\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 2\\n}","type":"json"}]', ], - 'DescribeSiteMonitorList' => [ - 'summary' => 'Queries site monitoring tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeHybridMonitorTaskList' => [ + 'summary' => 'Queries metric import tasks.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a1ecd34a-8157-44d9-b060-14950837****', - ], + 'schema' => ['description' => 'The keyword that is used for the search.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'task', 'title' => ''], ], [ - 'name' => 'TaskType', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol that is used by the site monitoring task. Valid values: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - ], + 'schema' => ['description' => 'The ID of the metric import task.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '36****', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword to be matched.'."\n" - ."\n" - .'> You can search for tasks by name or address. Fuzzy search is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'site', - ], + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '3607****', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the namespace.'."\n" + ."\n" + .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aliyun', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Pages start from page 1. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'TaskState', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The task status. Valid values:'."\n" - ."\n" - .'* 1: The task is enabled.'."\n" - .'* 2: The task is disabled.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AgentGroup', + 'name' => 'IncludeAliyunTask', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the returned result includes metric import tasks for Alibaba Cloud services. Valid values:'."\n" + ."\n" + .'- true (default): The returned result includes metric import tasks for Alibaba Cloud services.'."\n" + ."\n" + .'- false: The returned result excludes metric import tasks for Alibaba Cloud services.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'TaskType', 'in' => 'query', 'schema' => [ - 'description' => 'Task network type. Valid values:'."\n" - ."\n" - .'- PC: Cable Network'."\n" + 'description' => 'The type of the metric import task. Valid values:'."\n" ."\n" - .'- MOBILE: Mobile Cellular Network'."\n" + .'- aliyun\\_fc: metric import tasks for Alibaba Cloud services'."\n" ."\n" - .'- FC: Alibaba Cloud VPC Network', + .'- aliyun\\_sls: metrics for logs imported from Log Service', + 'enumValueTitles' => ['aliyun_sls' => 'aliyun\\_sls'], 'type' => 'string', 'required' => false, - 'example' => 'PC', - 'enum' => [ - 'PC', - 'MOBILE', - 'FC', - ], + 'example' => 'aliyun_fc', + 'title' => '', ], ], + [ + 'name' => 'TargetUserId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the member account.'."\n" + ."\n" + .'> This parameter is required only if you use a management account to call this operation to delete the metric import tasks that belong to a member in a resource directory. In this case, the `TaskType` parameter is set to `aliyun_fc`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '120886317861****', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SiteMonitors' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SiteMonitor' => [ - 'description' => 'The site monitoring tasks that are returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskType' => [ - 'description' => 'The protocol that is used by the site monitoring task. Valid values: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.'."\n", - 'type' => 'string', - 'example' => 'TCP', - ], - 'UpdateTime' => [ - 'description' => 'The time when the site monitoring task was updated.'."\n", - 'type' => 'string', - 'example' => '2022-03-08 17:14:31', - ], - 'Interval' => [ - 'description' => 'The interval at which detection requests are sent. Unit: minutes.'."\n", - 'type' => 'string', - 'example' => '1', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '11145B76-566A-5D80-A8A3-FAD98D310079', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n" + ."\n" + .'- If the request was successful, the value `successful` is returned.'."\n" + ."\n" + .'- If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TaskList' => [ + 'description' => 'The metric import tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'None', + 'type' => 'object', + 'properties' => [ + 'YARMConfig' => ['description' => 'The configuration file of the Alibaba Cloud service that you want to monitor by using Hybrid Cloud Monitoring.'."\n" + ."\n" + .'- namespace: the namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'- metric\\_list: the metrics of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the metric import task was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1639382496000', 'title' => ''], + 'TaskName' => ['description' => 'The name of the metric import task.', 'type' => 'string', 'example' => 'aliyun_task', 'title' => ''], + 'Namespace' => ['description' => 'The namespace to which the host belongs.', 'type' => 'string', 'example' => 'aliyun', 'title' => ''], + 'UploadRegion' => ['description' => 'The region where the host resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'NetworkType' => ['description' => 'The network type of the host. Valid values:'."\n" + ."\n" + .'- `vpc`'."\n" + ."\n" + .'- `Internet`', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'CollectTimout' => ['description' => 'The timeout period during which the CloudMonitor agent collects host monitoring data. Valid values:'."\n" + ."\n" + .'- 0'."\n" + ."\n" + .'- 15'."\n" + ."\n" + .'- 30'."\n" + ."\n" + .'- 60'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'CollectTargetEndpoint' => ['description' => 'The URL of the destination from which the CloudMonitor agent collects host monitoring data.', 'type' => 'string', 'example' => 'http://localhost', 'title' => ''], + 'TaskType' => ['description' => 'The type of the metric import task. Valid values:'."\n" + ."\n" + .'- aliyun\\_fc: metric import tasks for Alibaba Cloud services'."\n" + ."\n" + .'- aliyun\\_sls: metrics for logs imported from Log Service', 'type' => 'string', 'example' => 'aliyun_sls', 'title' => ''], + 'MatchExpressRelation' => ['description' => 'The relationship between the conditions that are used to filter metric import tasks. Valid values:'."\n" + ."\n" + .'- or'."\n" + ."\n" + .'- and', 'type' => 'string', 'example' => 'or', 'title' => ''], + 'Description' => ['description' => 'The description of the metric import task.', 'type' => 'string', 'example' => 'aliyun', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '3607****', 'title' => ''], + 'CollectInterval' => ['description' => 'The interval at which the CloudMonitor agent collects host monitoring data. Valid values:'."\n" + ."\n" + .'- 15'."\n" + ."\n" + .'- 30'."\n" + ."\n" + .'- 60'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'TargetUserId' => ['description' => 'The ID of the member account.'."\n" + ."\n" + .'> This parameter is displayed only when you call this operation by using a management account.', 'type' => 'string', 'example' => '120886317861****', 'title' => ''], + 'CollectTargetPath' => ['description' => 'The relative path from which the CloudMonitor agent collects monitoring data.', 'type' => 'string', 'example' => '/metrics', 'title' => ''], + 'CollectTargetType' => ['description' => 'The type of the monitoring data. Valid values: Spring, Tomcat, Nginx, Tengine, JVM, Redis, and MySQL.', 'type' => 'string', 'example' => 'nginx', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the metric import task.', 'type' => 'string', 'example' => '36****', 'title' => ''], + 'AttachLabels' => [ + 'description' => 'The tags of the metric import task.', + 'type' => 'array', + 'items' => [ + 'description' => 'None', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''], ], - 'TaskState' => [ - 'description' => 'The task status. Valid values:'."\n" + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'MatchExpress' => [ + 'description' => 'The conditions that are used to match the instances in the application group.', + 'type' => 'array', + 'items' => [ + 'description' => 'None', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The keyword that corresponds to the instance name.', 'type' => 'string', 'example' => 'ECS_instance1', 'title' => ''], + 'Name' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Function' => ['description' => 'The method that is used to match the instance name. Valid values:'."\n" ."\n" - .'* 1: The task is enabled.'."\n" - .'* 2: The task is disabled.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CreateTime' => [ - 'description' => 'The time when the site monitoring task was created.'."\n", - 'type' => 'string', - 'example' => '2021-11-01 11:05:18', - ], - 'TaskName' => [ - 'description' => 'The name of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => '域名检测_example.com.cn', - ], - 'Address' => [ - 'description' => 'The URL or IP address that is monitored by the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'https://aliyun.com', - ], - 'TaskId' => [ - 'description' => 'The ID of the site monitoring task.'."\n", - 'type' => 'string', - 'example' => 'f5783760-1b39-4b6b-80e8-453d962a****', + .'- startWith: starts with a prefix'."\n" + ."\n" + .'- endWith: ends with a suffix'."\n" + ."\n" + .'- all: matches all'."\n" + ."\n" + .'- equals: equals'."\n" + ."\n" + .'- contains: contains'."\n" + ."\n" + .'- notContains: does not contain', 'type' => 'string', 'example' => 'all', 'title' => ''], ], - 'OptionsJson' => [ - 'description' => 'The extended options of the site monitoring task. The options vary based on the specified protocol. For more information, see [CreateSiteMonitor](~~115048~~).'."\n", + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Instances' => [ + 'description' => 'The instances where monitoring data is collected in batches.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-hp368focau7dp0hw****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ExtraInfo' => ['description' => 'The additional information of the instance.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'LogFilePath' => ['description' => 'The path where on-premises log data is stored. On-premises log data is stored in the specified path of the host where CloudMonitor is deployed.'."\n" + ."\n" + .'- Windows: The log path must start with a drive letter. Example: `C:\\UserData\\log\\*.Log`. You cannot specify wildcard characters in a log path.'."\n" + ."\n" + .'- Linux: The log path must start with a forward slash (/). Example: `/home/appdata/log/**/*.log`. In this example, `/**/` is used to match all files in the appdata directory.', 'type' => 'string', 'example' => 'C:\\UserData\\log\\*.Log', 'title' => ''], + 'LogSplit' => ['description' => 'The result that is returned after on-premises log data is split based on the specified matching mode.'."\n" + ."\n" + .'> The matching modes of on-premises log data include full regex mode, delimiter mode, and JSON mode.', 'type' => 'string', 'example' => '{"type": "regex","regex": "\\\\d+\\\\.\\\\d+\\\\.\\\\d+\\\\.\\\\d+\\\\s+(\\\\d+)\\\\s+\\\\S+\\\\s+\\\\[\\\\d+/\\\\S+/\\\\d+:\\\\d+:\\\\d+:\\\\d+\\\\s+\\\\+\\\\d+\\\\]\\\\s+(\\\\S+)\\\\s+\\\\S+\\\\s+/\\\\S+/\\\\S+/\\\\S+\\\\s+(\\\\d+)","columns": [{"name": "field1"},{"name": "filed2","translate": {"default": "-","mappings": [{"from": "(\\\\w+)","to": "$1x","type": "regex"}]}},{"name": "filed3","translate": {"default": "-","mappings": [{"from": "NumberRange(100,300)","to": "true","type": "function"}]}}]}', 'title' => ''], + 'LogProcess' => ['description' => 'The method that is used to aggregate on-premises log data.', 'type' => 'string', 'example' => '[{"metric": "metric1","filters": [{"column": "filed2","type": "include","values": ["222222"]}],"groupBys": [{"column": "filed3","name": "filed3"}],"calculates": [{"column": "field1","name": "avg","type": "avg"}]},{"metric": "metric2","filters": [{"column": "field1","type": "include","values": ["11111"]}],"groupBys": [{"column": "filed2","name": "filed2"}],"calculates": [{"column": "field1","name": "avg","type": "avg"}]}]', 'title' => ''], + 'LogSample' => ['description' => 'The sample on-premises log.', 'type' => 'string', 'example' => '{"logContent":"100.116.134.26 1119 - [13/Aug/2019:16:55:46 +0800] POST metrichub-cn-hongkong.aliyun.com /agent/metrics/putLines 200 0 \\"-\\" \\"127.0.0.1:7001\\" \\"Go-http-client/1.1\\" \\"-\\" \\"-\\" \\"0a98a21a15656865460656276e\\"","addData":{"field1":["1119","1119"],"filed2":["POSTx","POST"],"filed3":["true","200"]}}', 'title' => ''], + 'SLSProcess' => ['description' => 'The configurations of the logs that are imported from Log Service.', 'type' => 'string', 'example' => '{"express": [],"filter": {"filters": [{"key": "task_type","operator": "=","value": "1"}]},"groupby": [{"alias": "isp","key": "isp","sqlKey": "t.`isp`","valueKey": "isp"}],"interval": 60,"labels": [{"name": "__cms_app__","type": 0,"value": "sitemonitor"}],"statistics": [{"alias": "http_dns_time_avg","function": "avg","key": "http_dns_time"}]}', 'title' => ''], + 'SLSProcessConfig' => [ + 'description' => 'The configurations of the logs that are imported from Log Service.'."\n" + ."\n" + .'> This parameter is returned only if the `TaskType` parameter is set to `aliyun_sls`.', + 'type' => 'object', + 'properties' => [ + 'Filter' => [ + 'description' => 'The conditions that are used to filter logs imported from Log Service.', 'type' => 'object', 'properties' => [ - 'password' => [ - 'description' => 'The password of the SMTP, POP3, or FTP protocol.'."\n", - 'type' => 'string', - 'example' => '123****', - ], - 'request_format' => [ - 'description' => 'The format of the HTTP request. Valid values:'."\n" - ."\n" - .'* hex: hexadecimal'."\n" - .'* txt: text'."\n", - 'type' => 'string', - 'example' => 'hex', - ], - 'response_content' => [ - 'description' => 'The response to the HTTP request.'."\n" - ."\n" - .'* Hexadecimal format: If the request content is a byte string and cannot be represented in printable characters, you can convert the byte string to printable characters in the hexadecimal format. If you convert the byte string to printable characters in the hexadecimal format, one byte is converted to two hexadecimal characters. For example, (byte)1 is converted to `01` and (byte)27 is converted to `1B`. If the request content is a binary array in the Java format, for example, `{(byte)1, (byte)27}`, you can convert the binary array to `011b` or `011B`. Hexadecimal characters are not case-sensitive in site monitoring tasks. You can enter `011B` in the request content and set the request_format parameter to hex.'."\n" - .'* Text format: Common text refers to strings that consist of printable characters.'."\n", - 'type' => 'string', - 'example' => 'cf0f85', - ], - 'failure_rate' => [ - 'description' => 'The packet loss rate.'."\n" - ."\n" - .'> This parameter is returned only if the TaskType parameter is set to PING.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'time_out' => [ - 'description' => 'The timeout period. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3000', - ], - 'header' => [ - 'description' => 'The header of the HTTP request. An HTTP header is a key-value pair in which the key and the value are separated by a colon (:). The format is `key1:value1`. Each HTTP header occupies a line.'."\n", - 'type' => 'string', - 'example' => 'testKey:testValue', - ], - 'cookie' => [ - 'description' => 'The cookie of the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'lang=en', - ], - 'port' => [ - 'description' => 'The port number of the TCP, UDP, SMTP, or POP3 protocol.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'ping_num' => [ - 'description' => 'The number of hops for the PING protocol.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'authentication' => [ - 'description' => 'Indicates whether the security authentication feature is enabled. Valid values:'."\n" - ."\n" - .'* 0: The feature is enabled.'."\n" - .'* 1: The feature is disabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'Relation' => ['description' => 'The relationship between multiple filter conditions. Valid values:'."\n" + ."\n" + .'- and (default): Logs are processed only if all filter conditions are met.'."\n" + ."\n" + .'- or: Logs are processed if one of the filter conditions is met.', 'type' => 'string', 'example' => 'and', 'title' => ''], + 'Filters' => [ + 'description' => 'The conditions that are used to filter logs imported from Log Service.', + 'type' => 'array', + 'items' => [ + 'description' => 'The conditions that are used to filter logs imported from Log Service.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the key that is used to filter logs imported from Log Service.', 'type' => 'string', 'example' => 'host', 'title' => ''], + 'Operator' => ['description' => 'The method that is used to filter logs imported from Log Service. Valid values:'."\n" + ."\n" + .'- `contain`: contains'."\n" + ."\n" + .'- `notContain`: does not contain'."\n" + ."\n" + .'- `>`: greater than'."\n" + ."\n" + .'- `<`: less than'."\n" + ."\n" + .'- `=`: equal to'."\n" + ."\n" + .'- `! =`: not equal to'."\n" + ."\n" + .'- `>=`: greater than or equal to'."\n" + ."\n" + .'- `<=`: less than or equal to', 'type' => 'string', 'example' => '=', 'title' => ''], + 'Value' => ['description' => 'The value of the key that is used to filter logs imported from Log Service.', 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'http_method' => [ - 'description' => 'The HTTP request method. Valid values:'."\n" + ], + 'title' => '', + 'example' => '', + ], + 'Statistics' => [ + 'description' => 'The methods that are used to aggregate logs imported from Log Service.', + 'type' => 'array', + 'items' => [ + 'description' => 'The method that is used to aggregate logs imported from Log Service.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the key that is used to aggregate logs imported from Log Service.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Function' => ['description' => 'The function that is used to aggregate log data within a statistical period. Valid values:'."\n" ."\n" - .'* get'."\n" - .'* post'."\n" - .'* head'."\n", - 'type' => 'string', - 'example' => 'get', - ], - 'match_rule' => [ - 'description' => 'Indicates whether the alert rule is included. Valid values:'."\n" + .'- count: counts the number.'."\n" ."\n" - .'* 0: The alert rule is included.'."\n" - .'* 1: The alert rule is not included.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'dns_match_rule' => [ - 'description' => 'The relationship between the list of expected aliases or IP addresses and the list of DNS results. Valid values:'."\n" + .'- sum: calculates the total value.'."\n" ."\n" - .'* IN_DNS: The list of expected values is a subset of the list of DNS results.'."\n" - .'* DNS_IN: The list of DNS results is a subset of the list of expected values.'."\n" - .'* EQUAL: The list of DNS results is the same as the list of expected values.'."\n" - .'* ANY: The list of DNS results intersects with the list of expected values.'."\n", - 'type' => 'string', - 'example' => 'IN_DNS', - ], - 'request_content' => [ - 'description' => 'The content of the HTTP request.'."\n", - 'type' => 'string', - 'example' => 'cf0f85', - ], - 'username' => [ - 'description' => 'The username of the FTP, SMTP, or POP3 protocol.'."\n", - 'type' => 'string', - 'example' => 'testUser', - ], - 'response_format' => [ - 'description' => 'The format of the HTTP response. Valid values:'."\n" + .'- avg: calculates the average value.'."\n" ."\n" - .'* hex: hexadecimal'."\n" - .'* txt: text'."\n", - 'type' => 'string', - 'example' => 'hex', - ], - 'dns_type' => [ - 'description' => 'The type of the DNS record. This parameter is returned only if the TaskType parameter is set to DNS. Valid values:'."\n" + .'- max: calculates the maximum value.'."\n" ."\n" - .'* A (default): a record that specifies an IP address related to the specified host name or domain name.'."\n" - .'* CNAME: a record that maps multiple domain names to a domain name.'."\n" - .'* NS: a record that specifies a DNS server used to parse domain names.'."\n" - .'* MX: a record that links domain names to the address of a mail server.'."\n" - .'* TXT: a record that stores the text information of host name or domain names. The text must be 1 to 512 bytes in length. The TXT record serves as a Sender Policy Framework (SPF) record to fight against spam.'."\n" - .'* AAAA: a record that maps a domain name to the relevant IPv6 address.'."\n", - 'type' => 'string', - 'example' => 'A', - ], - 'dns_server' => [ - 'description' => 'The domain name or IP address of the DNS server.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'enable_operator_dns' => [ - 'description' => 'Indicates whether the DNS server of the carrier is used.'."\n" + .'- min: calculates the minimum value.'."\n" ."\n" - .'* true (default): The DNS server of the carrier is used.'."\n" - .'* false: The DNS server of the carrier is not used. The default DNS server or the specified DNS server is used.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'attempts' => [ - 'description' => 'The number of retries after a DNS failure occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'protocol' => [ - 'description' => 'The protocol type of DNS detection. Valid values:'."\n" + .'- value: collects samples within the statistical period.'."\n" ."\n" - .'* udp (default)'."\n" - .'* tcp'."\n" - .'* tcp-tls'."\n", - 'type' => 'string', - 'example' => 'udp', - ], - 'proxy_protocol' => [ - 'description' => 'Indicates whether the PROXY protocol is enabled. Valid values:'."\n" + .'- countps: calculates the average number of the specified field per second by using the following formula: Counted number of the specified field/Total number of seconds within the statistical period.'."\n" ."\n" - .'* false (default): The PROXY protocol is disabled.'."\n" - .'* true: The PROXY protocol is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'acceptable_response_code' => [ - 'description' => 'The acceptable status code.'."\n" + .'- sumps: calculates the average number of the specified field per second by using the following formula: Total value of the specified field/Total number of seconds within the statistical period.'."\n" ."\n" - .'> We recommend that you configure assertions.'."\n", - 'type' => 'string', - 'example' => '400', - ], - 'isBase64Encode' => [ - 'description' => 'Indicates whether the password is decoded by using the Base64 algorithm. Valid values:'."\n" + .'- distinct: counts the number of logs where the specified field appears within the statistical period.'."\n" ."\n" - .'* true: The password is decoded by using the Base64 algorithm.'."\n" - .'* false (default): The password is not decoded by using the Base64 algorithm.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'cert_verify' => [ - 'description' => 'Indicates whether the certificate is verified. Valid values:'."\n" + .'- distribution: counts the number of logs that meet a specified condition within the statistical period.'."\n" ."\n" - .'* false (default): The certificate is not verified.'."\n" - .'* true: The certificate is verified.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'unfollow_redirect' => [ - 'description' => 'Indicates whether redirects are followed if the status code 301 or 302 is returned. Valid values:'."\n" + .'- percentile: sorts the values of the specified field in ascending order, and then returns the value that is at the specified percentile within the statistical period. Example: P50.', 'type' => 'string', 'example' => 'count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the aggregation result.', 'type' => 'string', 'example' => 'level_count', 'title' => ''], + 'Parameter1' => ['description' => 'The value of the function that is used to aggregate logs imported from Log Service.'."\n" ."\n" - .'* true: Redirects are not followed.'."\n" - .'* false (default): Redirects are followed.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'diagnosis_mtr' => [ - 'description' => 'Indicates whether MTR is automatically used to diagnose network issues if a task fails. Valid values:'."\n" + .'- If the `Function` parameter is set to `distribution`, this parameter indicates the lower limit of the statistical interval. For example, 200 indicates that the number of HTTP requests whose status code is 2XX is calculated.'."\n" ."\n" - .'* false (default): MTR is not automatically used to diagnose network issues if a task fails.'."\n" - .'* true: MTR is automatically used to diagnose network issues if a task fails.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'diagnosis_ping' => [ - 'description' => 'Indicates whether ping requests are automatically sent to detect network latency if a detection task fails. Valid values:'."\n" + .'- If the `Function` parameter is set to `percentile`, this parameter specifies the percentile at which the expected value is. For example, 0.5 specifies P50.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Parameter2' => ['description' => 'The value of the function that is used to aggregate logs imported from Log Service.'."\n" ."\n" - .'* false (default): Ping requests are not automatically sent to detect network latency if a detection task fails.'."\n" - .'* true: Ping requests are automatically sent to detect network latency if a detection task fails.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'retry_delay' => [ - 'description' => 'The number of times a failed detection request is retried.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + .'> This parameter is returned only if the `Function` parameter is set to `distribution`. This parameter indicates the upper limit of the statistical interval. For example, 299 indicates that the number of HTTP requests whose status code is 2XX is calculated.', 'type' => 'string', 'example' => '299', 'title' => ''], ], - 'assertions' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'assertions' => [ - 'description' => 'The assertions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'property' => [ - 'description' => 'The parsing path of the assertion.'."\n" - ."\n" - .'* If the assertion type is `body_json`, the path is `json path`.'."\n" - .'* If the assertion type is `body_xml`, the path is `xml path`.'."\n", - 'type' => 'string', - 'example' => 'json path', - ], - 'type' => [ - 'description' => 'The assertion type. Valid values:'."\n" - ."\n" - .'* response_time: checks whether the response time meets expectations.'."\n" - .'* status_code: checks whether the HTTP status code meets expectations.'."\n" - .'* header: checks whether the fields in the response header meet expectations.'."\n" - .'* body_text: checks whether the content in the response body meets expectations by using text matching.'."\n" - .'* body_json: checks whether the content in the response body meets expectations by using JSON parsing (JSONPath).'."\n" - .'* body_xml: checks whether the content in the response body meets expectations by using XML parsing (XPath).'."\n", - 'type' => 'string', - 'example' => 'response_time', - ], - 'operator' => [ - 'description' => 'The comparison operator of the assertion. Valid values:'."\n" - ."\n" - .'* contains: contains'."\n" - .'* doesNotContain: does not contain'."\n" - .'* matches: matches regular expressions'."\n" - .'* doesNotMatch: does not match regular expressions'."\n" - .'* is: equal to a numeric value or matches a character'."\n" - .'* isNot: not equal to'."\n" - .'* lessThan: less than'."\n" - .'* moreThan: greater than'."\n", - 'type' => 'string', - 'example' => 'lessThan', - ], - 'target' => [ - 'description' => 'The numeric value or character used for matching.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - ], - ], - ], - ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'GroupBy' => [ + 'description' => 'The dimensions based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.', + 'type' => 'array', + 'items' => [ + 'description' => 'The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the key that is used to aggregate logs imported from Log Service.', 'type' => 'string', 'example' => 'code', 'title' => ''], + 'Alias' => ['description' => 'The alias of the aggregation result.', 'type' => 'string', 'example' => 'ApiResult', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'AgentGroup' => [ - 'description' => 'The detection point type. Valid values:'."\n" - ."\n" - .'* PC'."\n" - .'* MOBILE'."\n", - 'type' => 'string', - 'example' => 'PC', + 'Express' => [ + 'description' => 'The extended fields that indicate the results of basic operations that are performed on aggregation results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The extended field that indicates the result of basic operations that are performed on aggregation results.', + 'type' => 'object', + 'properties' => [ + 'Express' => ['description' => 'The extended field that indicates the result of basic operations that are performed on aggregation results.', 'type' => 'string', 'example' => 'success_count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the extended field that indicates the result of basic operations that are performed on aggregation results.', 'type' => 'string', 'example' => 'SuccRate', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'DescribeHybridMonitorTaskList', + 'description' => 'This topic provides an example on how to query all metric import tasks that belong to the current Alibaba Cloud account. The returned result indicates that the current account has only one metric import task. The metric import task is named `aliyun_task`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-07-20T10:29:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-09T09:38:01.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorTaskList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:DescribeHybridMonitorTaskList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"SiteMonitors\\": {\\n \\"SiteMonitor\\": [\\n {\\n \\"TaskType\\": \\"TCP\\",\\n \\"UpdateTime\\": \\"2022-03-08 17:14:31\\",\\n \\"Interval\\": \\"1\\",\\n \\"TaskState\\": \\"1\\",\\n \\"CreateTime\\": \\"2021-11-01 11:05:18\\",\\n \\"TaskName\\": \\"新的探测任务\\",\\n \\"Address\\": \\"https://aliyun.com\\",\\n \\"TaskId\\": \\"f5783760-1b39-4b6b-80e8-453d962a****\\",\\n \\"OptionsJson\\": {\\n \\"password\\": \\"123****\\",\\n \\"request_format\\": \\"hex\\",\\n \\"response_content\\": \\"cf0f85\\",\\n \\"failure_rate\\": 0.5,\\n \\"time_out\\": 3000,\\n \\"header\\": \\"testKey:testValue\\",\\n \\"cookie\\": \\"lang=en\\",\\n \\"port\\": 80,\\n \\"ping_num\\": 20,\\n \\"authentication\\": 1,\\n \\"http_method\\": \\"get\\",\\n \\"match_rule\\": 0,\\n \\"dns_match_rule\\": \\"IN_DNS\\",\\n \\"request_content\\": \\"cf0f85\\",\\n \\"username\\": \\"testUser\\",\\n \\"response_format\\": \\"hex\\",\\n \\"dns_type\\": \\"A\\",\\n \\"dns_server\\": \\"192.168.XX.XX\\",\\n \\"enable_operator_dns\\": true,\\n \\"attempts\\": 3,\\n \\"protocol\\": \\"udp\\",\\n \\"proxy_protocol\\": false,\\n \\"acceptable_response_code\\": \\"400\\",\\n \\"isBase64Encode\\": \\"false\\",\\n \\"cert_verify\\": false,\\n \\"unfollow_redirect\\": false,\\n \\"diagnosis_mtr\\": false,\\n \\"diagnosis_ping\\": false,\\n \\"retry_delay\\": 1,\\n \\"assertions\\": {\\n \\"assertions\\": [\\n {\\n \\"property\\": \\"json path\\",\\n \\"type\\": \\"response_time\\",\\n \\"operator\\": \\"lessThan\\",\\n \\"target\\": \\"1000\\"\\n }\\n ]\\n }\\n },\\n \\"AgentGroup\\": \\"PC\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSiteMonitorListResponse>\\r\\n\\t<TotalCount>1</TotalCount>\\r\\n\\t<RequestId>A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B</RequestId>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n\\t<SiteMonitors>\\r\\n\\t\\t<SiteMonitor>\\r\\n\\t\\t\\t<TaskId>f5783760-1b39-4b6b-80e8-453d962a****</TaskId>\\r\\n\\t\\t\\t<Address>https://aliyun.com</Address>\\r\\n\\t\\t\\t<EndTime></EndTime>\\r\\n\\t\\t\\t<TaskName>test123</TaskName>\\r\\n\\t\\t\\t<OptionsJson>\\r\\n\\t\\t\\t\\t<response_content></response_content>\\r\\n\\t\\t\\t\\t<request_format>hex</request_format>\\r\\n\\t\\t\\t\\t<response_format>hex</response_format>\\r\\n\\t\\t\\t\\t<request_content>cf0f85</request_content>\\r\\n\\t\\t\\t\\t<port>80</port>\\r\\n\\t\\t\\t</OptionsJson>\\r\\n\\t\\t\\t<TaskType>TCP</TaskType>\\r\\n\\t\\t\\t<CreateTime>2021-11-01 11:05:18</CreateTime>\\r\\n\\t\\t\\t<UpdateTime>2022-03-08 17:14:31</UpdateTime>\\r\\n\\t\\t\\t<TaskState>1</TaskState>\\r\\n\\t\\t\\t<Interval>1</Interval>\\r\\n\\t\\t</SiteMonitor>\\r\\n\\t</SiteMonitors>\\r\\n</DescribeSiteMonitorListResponse>\\t","errorExample":""}]', - 'title' => 'DescribeSiteMonitorList', - 'description' => 'This topic provides an example on how to query all the site monitoring tasks of your Alibaba Cloud account. In this example, the returned result indicates that the Alibaba Cloud account has one site monitoring task named `HanZhou_ECS2`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11145B76-566A-5D80-A8A3-FAD98D310079\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 1,\\n \\"TaskList\\": [\\n {\\n \\"YARMConfig\\": \\"products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total\\",\\n \\"CreateTime\\": \\"1639382496000\\",\\n \\"TaskName\\": \\"aliyun_task\\",\\n \\"Namespace\\": \\"aliyun\\",\\n \\"UploadRegion\\": \\"cn-hangzhou\\",\\n \\"NetworkType\\": \\"vpc\\",\\n \\"CollectTimout\\": 15,\\n \\"CollectTargetEndpoint\\": \\"http://localhost\\",\\n \\"TaskType\\": \\"aliyun_sls\\",\\n \\"MatchExpressRelation\\": \\"or\\",\\n \\"Description\\": \\"aliyun\\",\\n \\"GroupId\\": \\"3607****\\",\\n \\"CollectInterval\\": 60,\\n \\"TargetUserId\\": \\"120886317861****\\",\\n \\"CollectTargetPath\\": \\"/metrics\\",\\n \\"CollectTargetType\\": \\"nginx\\",\\n \\"TaskId\\": \\"36****\\",\\n \\"AttachLabels\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"MatchExpress\\": [\\n {\\n \\"Value\\": \\"ECS_instance1\\",\\n \\"Name\\": \\"name\\",\\n \\"Function\\": \\"all\\"\\n }\\n ],\\n \\"Instances\\": [\\n \\"i-hp368focau7dp0hw****\\"\\n ],\\n \\"ExtraInfo\\": \\"test\\",\\n \\"LogFilePath\\": \\"C:\\\\\\\\UserData\\\\\\\\log\\\\\\\\*.Log\\",\\n \\"LogSplit\\": \\"{\\\\\\"type\\\\\\": \\\\\\"regex\\\\\\",\\\\\\"regex\\\\\\": \\\\\\"\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\s+(\\\\\\\\\\\\\\\\d+)\\\\\\\\\\\\\\\\s+\\\\\\\\\\\\\\\\S+\\\\\\\\\\\\\\\\s+\\\\\\\\\\\\\\\\[\\\\\\\\\\\\\\\\d+/\\\\\\\\\\\\\\\\S+/\\\\\\\\\\\\\\\\d+:\\\\\\\\\\\\\\\\d+:\\\\\\\\\\\\\\\\d+:\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\s+\\\\\\\\\\\\\\\\+\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\]\\\\\\\\\\\\\\\\s+(\\\\\\\\\\\\\\\\S+)\\\\\\\\\\\\\\\\s+\\\\\\\\\\\\\\\\S+\\\\\\\\\\\\\\\\s+/\\\\\\\\\\\\\\\\S+/\\\\\\\\\\\\\\\\S+/\\\\\\\\\\\\\\\\S+\\\\\\\\\\\\\\\\s+(\\\\\\\\\\\\\\\\d+)\\\\\\",\\\\\\"columns\\\\\\": [{\\\\\\"name\\\\\\": \\\\\\"field1\\\\\\"},{\\\\\\"name\\\\\\": \\\\\\"filed2\\\\\\",\\\\\\"translate\\\\\\": {\\\\\\"default\\\\\\": \\\\\\"-\\\\\\",\\\\\\"mappings\\\\\\": [{\\\\\\"from\\\\\\": \\\\\\"(\\\\\\\\\\\\\\\\w+)\\\\\\",\\\\\\"to\\\\\\": \\\\\\"$1x\\\\\\",\\\\\\"type\\\\\\": \\\\\\"regex\\\\\\"}]}},{\\\\\\"name\\\\\\": \\\\\\"filed3\\\\\\",\\\\\\"translate\\\\\\": {\\\\\\"default\\\\\\": \\\\\\"-\\\\\\",\\\\\\"mappings\\\\\\": [{\\\\\\"from\\\\\\": \\\\\\"NumberRange(100,300)\\\\\\",\\\\\\"to\\\\\\": \\\\\\"true\\\\\\",\\\\\\"type\\\\\\": \\\\\\"function\\\\\\"}]}}]}\\",\\n \\"LogProcess\\": \\"[{\\\\\\"metric\\\\\\": \\\\\\"metric1\\\\\\",\\\\\\"filters\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"filed2\\\\\\",\\\\\\"type\\\\\\": \\\\\\"include\\\\\\",\\\\\\"values\\\\\\": [\\\\\\"222222\\\\\\"]}],\\\\\\"groupBys\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"filed3\\\\\\",\\\\\\"name\\\\\\": \\\\\\"filed3\\\\\\"}],\\\\\\"calculates\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"field1\\\\\\",\\\\\\"name\\\\\\": \\\\\\"avg\\\\\\",\\\\\\"type\\\\\\": \\\\\\"avg\\\\\\"}]},{\\\\\\"metric\\\\\\": \\\\\\"metric2\\\\\\",\\\\\\"filters\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"field1\\\\\\",\\\\\\"type\\\\\\": \\\\\\"include\\\\\\",\\\\\\"values\\\\\\": [\\\\\\"11111\\\\\\"]}],\\\\\\"groupBys\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"filed2\\\\\\",\\\\\\"name\\\\\\": \\\\\\"filed2\\\\\\"}],\\\\\\"calculates\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"field1\\\\\\",\\\\\\"name\\\\\\": \\\\\\"avg\\\\\\",\\\\\\"type\\\\\\": \\\\\\"avg\\\\\\"}]}]\\",\\n \\"LogSample\\": \\"{\\\\\\"logContent\\\\\\":\\\\\\"100.116.134.26 1119 - [13/Aug/2019:16:55:46 +0800] POST metrichub-cn-hongkong.aliyun.com /agent/metrics/putLines 200 0 \\\\\\\\\\\\\\"-\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"127.0.0.1:7001\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"Go-http-client/1.1\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"-\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"-\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"0a98a21a15656865460656276e\\\\\\\\\\\\\\"\\\\\\",\\\\\\"addData\\\\\\":{\\\\\\"field1\\\\\\":[\\\\\\"1119\\\\\\",\\\\\\"1119\\\\\\"],\\\\\\"filed2\\\\\\":[\\\\\\"POSTx\\\\\\",\\\\\\"POST\\\\\\"],\\\\\\"filed3\\\\\\":[\\\\\\"true\\\\\\",\\\\\\"200\\\\\\"]}}\\",\\n \\"SLSProcess\\": \\"{\\\\\\"express\\\\\\": [],\\\\\\"filter\\\\\\": {\\\\\\"filters\\\\\\": [{\\\\\\"key\\\\\\": \\\\\\"task_type\\\\\\",\\\\\\"operator\\\\\\": \\\\\\"=\\\\\\",\\\\\\"value\\\\\\": \\\\\\"1\\\\\\"}]},\\\\\\"groupby\\\\\\": [{\\\\\\"alias\\\\\\": \\\\\\"isp\\\\\\",\\\\\\"key\\\\\\": \\\\\\"isp\\\\\\",\\\\\\"sqlKey\\\\\\": \\\\\\"t.`isp`\\\\\\",\\\\\\"valueKey\\\\\\": \\\\\\"isp\\\\\\"}],\\\\\\"interval\\\\\\": 60,\\\\\\"labels\\\\\\": [{\\\\\\"name\\\\\\": \\\\\\"__cms_app__\\\\\\",\\\\\\"type\\\\\\": 0,\\\\\\"value\\\\\\": \\\\\\"sitemonitor\\\\\\"}],\\\\\\"statistics\\\\\\": [{\\\\\\"alias\\\\\\": \\\\\\"http_dns_time_avg\\\\\\",\\\\\\"function\\\\\\": \\\\\\"avg\\\\\\",\\\\\\"key\\\\\\": \\\\\\"http_dns_time\\\\\\"}]}\\",\\n \\"SLSProcessConfig\\": {\\n \\"Filter\\": {\\n \\"Relation\\": \\"and\\",\\n \\"Filters\\": [\\n {\\n \\"SLSKeyName\\": \\"host\\",\\n \\"Operator\\": \\"=\\",\\n \\"Value\\": \\"200\\"\\n }\\n ]\\n },\\n \\"Statistics\\": [\\n {\\n \\"SLSKeyName\\": \\"name\\",\\n \\"Function\\": \\"count\\",\\n \\"Alias\\": \\"level_count\\",\\n \\"Parameter1\\": \\"200\\",\\n \\"Parameter2\\": \\"299\\"\\n }\\n ],\\n \\"GroupBy\\": [\\n {\\n \\"SLSKeyName\\": \\"code\\",\\n \\"Alias\\": \\"ApiResult\\"\\n }\\n ],\\n \\"Express\\": [\\n {\\n \\"Express\\": \\"success_count\\",\\n \\"Alias\\": \\"SuccRate\\"\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeSiteMonitorLog' => [ - 'summary' => 'Queries the logs of one or more instant test tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeLogMonitorAttribute' => [ + 'summary' => 'Queries a Log Monitoring task.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskIds', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the instant test tasks. Separate multiple task IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'afa5c3ce-f944-4363-9edb-ce919a29****', - ], + 'schema' => ['description' => 'The name of the metric.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_total_******', 'title' => ''], ], - [ - 'name' => 'Isp', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The carrier identification code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '465', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates a successful request.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C6718537-E673-4A58-8EE1-24B8B38C7AAE', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'LogMonitor' => [ + 'description' => 'The details of the Log Monitoring task.', + 'type' => 'object', + 'properties' => [ + 'ValueFilterRelation' => ['description' => 'The logical operator for the filter conditions. This parameter is used with \\`ValueFilter\\`. Valid values:'."\n" + ."\n" + .'- and: The logical AND operator.'."\n" + ."\n" + .'- or: The logical OR operator.', 'type' => 'string', 'example' => 'and', 'title' => ''], + 'SlsLogstore' => ['description' => 'The name of the Simple Log Service Logstore.', 'type' => 'string', 'example' => 'logstore_******', 'title' => ''], + 'MetricName' => ['description' => 'The name of the metric.', 'type' => 'string', 'example' => 'cpu_total_******', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '123******', 'title' => ''], + 'LogId' => ['description' => 'The ID of the Log Monitoring task.', 'type' => 'integer', 'format' => 'int64', 'example' => '123******', 'title' => ''], + 'MetricExpress' => ['description' => 'The metric expression.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'SlsRegionId' => ['description' => 'The ID of the region where Simple Log Service resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the task was created.'."\n" + ."\n" + .'This value is a UNIX timestamp that represents the number of milliseconds that have elapsed since January 1, 1970.', 'type' => 'integer', 'format' => 'int64', 'example' => '1678440033000', 'title' => ''], + 'SlsProject' => ['description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'example' => 'project_******', 'title' => ''], + 'Aggregates' => [ + 'description' => 'The definitions of aggregations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Max' => ['description' => 'The maximum value.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Min' => ['description' => 'The minimum value.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Function' => ['description' => 'The function that is used to aggregate log data in a statistical period. Valid values:'."\n" + ."\n" + .'- count: Counts the number of logs.'."\n" + ."\n" + .'- sum: Calculates the sum of values in a field.'."\n" + ."\n" + .'- avg: Calculates the average of values in a field.'."\n" + ."\n" + .'- max: Selects the maximum value in a field.'."\n" + ."\n" + .'- min: Selects the minimum value in a field.'."\n" + ."\n" + .'- countps: Calculates the average number of logs that are generated per second in a statistical period.'."\n" + ."\n" + .'- sumps: Calculates the average sum of values in a field per second in a statistical period.'."\n" + ."\n" + .'- distinct: Counts the number of unique values in a field in a statistical period.', 'type' => 'string', 'example' => 'count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the field.', 'type' => 'string', 'example' => 'alias_******', 'title' => ''], + 'FieldName' => ['description' => 'The original name of the field in the log.', 'type' => 'string', 'example' => 'field_******', 'title' => ''], + ], + 'description' => 'The definition of an aggregation.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ValueFilter' => [ + 'description' => 'The filter conditions. This parameter is used with \\`ValueFilterRelation\\`. This parameter is equivalent to the \\`WHERE\\` clause in an SQL statement.'."\n" + ."\n" + .'If you do not specify this parameter, all data is processed. For example, if a log contains a \\`Level\\` field and you want to count the number of logs where the value of \\`Level\\` is \\`Error\\`, you can set the aggregation function to \\`count\\` and specify a filter condition where \\`Level\\` equals \\`Error\\`.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key.', 'type' => 'string', 'example' => 'key_******', 'title' => ''], + 'Value' => ['description' => 'The value.', 'type' => 'string', 'example' => 'value_******', 'title' => ''], + 'Operator' => ['description' => 'The operator that is used to match the field value. Valid values:'."\n" + ."\n" + .'- `contain`: contains.'."\n" + ."\n" + .'- `notContain`: does not contain.'."\n" + ."\n" + .'- `>`: greater than.'."\n" + ."\n" + .'- `<`: less than.'."\n" + ."\n" + .'- `>=`: greater than or equal to.'."\n" + ."\n" + .'- `<=`: less than or equal to.', 'type' => 'string', 'example' => 'contain', 'title' => ''], + ], + 'description' => 'The filter condition.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Tumblingwindows' => [ + 'type' => 'array', + 'items' => ['description' => 'The pre-aggregation window. Unit: seconds. Cloud Monitor aggregates data in the specified pre-aggregation window.', 'type' => 'string', 'example' => '60', 'title' => ''], + 'description' => 'The pre-aggregation window. Unit: seconds. Cloud Monitor aggregates data in the specified pre-aggregation window.', + 'title' => '', + 'example' => '', + ], + 'Groupbys' => [ + 'type' => 'array', + 'items' => ['description' => 'The \\`group by\\` definition', 'type' => 'string', 'example' => 'userId', 'title' => ''], + 'description' => 'The dimension based on which log data is aggregated. This parameter is equivalent to the \\`GROUP BY\\` clause in an SQL statement. You can specify a dimension to group monitoring data. If you do not specify this parameter, all monitoring data is aggregated based on the aggregation method.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'City', - 'in' => 'query', - 'schema' => [ - 'description' => 'The city identification code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '546', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'Only the `ProbeLog` metric is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ProbeLog', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query. The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The specified time range includes the end time and excludes the start time. The start time must be earlier than the end time.\\'."\n" - .' We recommend that you use UNIX timestamps to prevent time zone-related issues.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1638422474389', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Valid values:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format'."\n" - ."\n" - .'> We recommend that you use UNIX timestamps to prevent time zone-related issues.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1638422475687', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The token that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.``'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IWBjqMYSy0is7zSMGu16****', + ], + 'title' => 'DescribeLogMonitorAttribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogMonitorAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeLogMonitorAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"C6718537-E673-4A58-8EE1-24B8B38C7AAE\\",\\n \\"Success\\": true,\\n \\"LogMonitor\\": {\\n \\"ValueFilterRelation\\": \\"and\\",\\n \\"SlsLogstore\\": \\"logstore_******\\",\\n \\"MetricName\\": \\"cpu_total_******\\",\\n \\"GroupId\\": 0,\\n \\"LogId\\": 0,\\n \\"MetricExpress\\": \\"{}\\",\\n \\"SlsRegionId\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": 1678440033000,\\n \\"SlsProject\\": \\"project_******\\",\\n \\"Aggregates\\": [\\n {\\n \\"Max\\": \\"0\\",\\n \\"Min\\": \\"0\\",\\n \\"Function\\": \\"count\\",\\n \\"Alias\\": \\"alias_******\\",\\n \\"FieldName\\": \\"field_******\\"\\n }\\n ],\\n \\"ValueFilter\\": [\\n {\\n \\"Key\\": \\"key_******\\",\\n \\"Value\\": \\"value_******\\",\\n \\"Operator\\": \\"contain\\"\\n }\\n ],\\n \\"Tumblingwindows\\": [\\n \\"60\\"\\n ],\\n \\"Groupbys\\": [\\n \\"userId\\"\\n ]\\n }\\n}","type":"json"}]', + 'extraInfo' => ' ', + ], + 'DescribeLogMonitorList' => [ + 'summary' => 'Queries log monitoring metrics.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Length', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values: 1 to 1440.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'Filter', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The filter condition.'."\n" - ."\n" - .'You can specify a simple expression, for example, `TotalTime>100`. In this case, the operation returns only the data for instant test tasks whose total response time exceeds 100 milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TotalTime>100', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'BrowserInfo', + 'name' => 'PageSize', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Browser', + 'name' => 'SearchValue', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - ' Chrome' => ' Chrome', - 'Safari' => 'Safari', - 'Edge' => 'Edge', - 'Firefox' => 'Firefox', - ], - 'example' => 'Chrome', - ], + 'schema' => ['description' => 'The keyword that is used to search for log monitoring metrics. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Device', + 'name' => 'GroupId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'tablet' => 'tablet', - 'mobile' => 'mobile', - 'laptop' => 'laptop', - ], - 'example' => 'laptop', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'IWBjqMYSy0is7zSMGu16****', - ], - 'Data' => [ - 'description' => 'The logs of the instant test tasks.'."\n", - 'type' => 'string', - 'example' => '\\[{\\\\"redirectCount\\\\":0.0,\\\\"SSLConnectTime\\\\":0.0,\\\\"pingDetail\\\\":\\\\"\\\\",\\\\"HTTPConnectTime\\\\":0.0,\\\\"isp\\\\":\\\\"465\\\\",\\\\"errorCode\\\\":611,\\\\"ispCN\\\\":\\\\"Alibaba\\\\",\\\\"resolution\\\\":\\\\"\\\\",\\\\"areaEN\\\\":\\\\"HuaBei\\\\",\\\\"taskEndTimestamp\\\\":1638422475687,\\\\"targetIspEN\\\\":\\\\"\\\\",\\\\"TotalTime\\\\":1.0,\\\\"taskStartTimestamp\\\\":1638422474389,\\\\"countryCN\\\\":\\\\"China\\\\",\\\\"provinceEN\\\\":\\\\"Beijing\\\\",\\\\"countryEN\\\\":\\\\"China\\\\",\\\\"targetCityEN\\\\":\\\\"\\\\",\\\\"curlConnectTime\\\\":0.0,\\\\"ips\\\\":\\\\"\\\\",\\\\"route\\\\":\\\\"\\\\",\\\\"tcpConnectTime\\\\":0.0,\\\\"cityEN\\\\":\\\\"Beijing\\\\",\\\\"HTTPDownloadSpeed\\\\":0.0,\\\\"HTTPDownloadTime\\\\":0.0,\\\\"HTTPResponseCode\\\\":0.0,\\\\"areaCN\\\\":\\\\"North China\\\\",\\\\"city\\\\":\\\\"546\\\\",\\\\"expection\\\\":\\\\"\\\\",\\\\"suorceIp\\\\":\\\\"192.168.XX.XX \\\\",\\\\"ispEN\\\\":\\\\"Alibaba\\\\",\\\\"HTTPDNSTime\\\\":1.0,\\\\"targetIsp\\\\":\\\\"\\\\",\\\\"curlStarttransferTime\\\\":0.0,\\\\"provinceCN\\\\":\\\\"Beijing\\\\",\\\\"timestamp\\\\":1638422474000,\\\\"redirectTime\\\\":0.0,\\\\"targetCity\\\\":\\\\"\\\\", \\\\"expect\\\\":\\\\"\\\\",\\\\"HTTPDownloadSize\\\\":0.0,\\\\"localDns\\\\":\\\\"192.168.XX.XX\\\\",\\\\"cityCN\\\\":\\\\"Beijing\\\\",\\\\"taskId\\\\":\\\\"afa5c3ce-f944-4363-9edb-ce919a29\\*\\*\\*\\*\\\\"}]'."\n", - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '67F646FA-ED8A-58C2-B461-451DB52C8B14', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'**Description** The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '01E90080-4300-4FAA-B9AE-161956BC350D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'LogMonitorList' => [ + 'description' => 'The log monitoring metrics.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ValueFilterRelation' => ['description' => 'The logical operator that is used between log filter conditions. The ValueFilter and ValueFilterRelation parameters are used in pair. Valid values:'."\n" + ."\n" + .'- and'."\n" + ."\n" + .'- or', 'type' => 'string', 'example' => 'and', 'title' => ''], + 'SlsLogstore' => ['description' => 'The name of the Simple Log Service (SLS) Logstore.', 'type' => 'string', 'example' => 'testSlS****', 'title' => ''], + 'MetricName' => ['description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'LogId' => ['description' => 'The ID of the log monitoring metric.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'SlsRegionId' => ['description' => 'The ID of the region where the SLS Logstore resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the log monitoring metric was created.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1577766395000', 'title' => ''], + 'SlsProject' => ['description' => 'The name of the SLS project.', 'type' => 'string', 'example' => 'sls-project-test****', 'title' => ''], + 'ValueFilter' => [ + 'description' => 'The condition that is used to filter logs. The ValueFilter and ValueFilterRelation parameters are used in pair. The filter condition is equivalent to the WHERE clause in SQL statements. If no filter condition is specified, all logs are processed. For example, logs contain the Level and Error fields. If you need to calculate the number of times that logs of the Error level appear every minute, you can set the filter condition to Level=Error and count the number of logs that meet this condition.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The name of the log field used for matching in the filter condition.', 'type' => 'string', 'example' => 'hostName', 'title' => ''], + 'Value' => ['description' => 'The field value to be matched in the filter condition.', 'type' => 'string', 'example' => 'portal', 'title' => ''], + 'Operator' => ['description' => 'The method that is used to match the field value. Valid values:'."\n" + ."\n" + .'- contain: contains'."\n" + ."\n" + .'- notContain: does not contain'."\n" + ."\n" + .'- `>`: greater than'."\n" + ."\n" + .'- `<`: less than'."\n" + ."\n" + .'- `>=`: greater than or equal to'."\n" + ."\n" + .'- `<=`: less than or equal to', 'type' => 'string', 'example' => 'contain', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], - ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'DescribeLogMonitorList', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogMonitorList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeLogMonitorList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"IWBjqMYSy0is7zSMGu16****\\",\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"redirectCount\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"SSLConnectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"pingDetail\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HTTPConnectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"errorCode\\\\\\\\\\\\\\":611,\\\\\\\\\\\\\\"ispCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"阿里巴巴\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resolution\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"areaEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"HuaBei\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskEndTimestamp\\\\\\\\\\\\\\":1638422475687,\\\\\\\\\\\\\\"targetIspEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TotalTime\\\\\\\\\\\\\\":1.0,\\\\\\\\\\\\\\"taskStartTimestamp\\\\\\\\\\\\\\":1638422474389,\\\\\\\\\\\\\\"countryCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"中国\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"provinceEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"countryEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"China\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"targetCityEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"curlConnectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"ips\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"route\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tcpConnectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"cityEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HTTPDownloadSpeed\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"HTTPDownloadTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"HTTPResponseCode\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"areaCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"华北\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"546\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"expection\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"suorceIp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"192.168.XX.XX \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Alibaba\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HTTPDNSTime\\\\\\\\\\\\\\":1.0,\\\\\\\\\\\\\\"targetIsp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"curlStarttransferTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"provinceCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"北京市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1638422474000,\\\\\\\\\\\\\\"redirectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"targetCity\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"expect\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HTTPDownloadSize\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"localDns\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"192.168.XX.XX\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"北京市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"afa5c3ce-f944-4363-9edb-ce919a29****\\\\\\\\\\\\\\"}]\\",\\n \\"RequestId\\": \\"67F646FA-ED8A-58C2-B461-451DB52C8B14\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', - 'title' => 'DescribeSiteMonitorLog', - 'description' => 'You can create an instant test task only by using the Alibaba Cloud account that you used to enable Network Analysis and Monitoring.'."\n" - ."\n" - .'This topic provides an example to show how to query the logs of an instant test task whose ID is `afa5c3ce-f944-4363-9edb-ce919a29****`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01E90080-4300-4FAA-B9AE-161956BC350D\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 15,\\n \\"LogMonitorList\\": [\\n {\\n \\"ValueFilterRelation\\": \\"and\\",\\n \\"SlsLogstore\\": \\"testSlS****\\",\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"GroupId\\": 12345,\\n \\"LogId\\": 12345,\\n \\"SlsRegionId\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": 1577766395000,\\n \\"SlsProject\\": \\"sls-project-test****\\",\\n \\"ValueFilter\\": [\\n {\\n \\"Key\\": \\"hostName\\",\\n \\"Value\\": \\"portal\\",\\n \\"Operator\\": \\"contain\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeMetricLast' => [ - 'summary' => 'Queries the latest monitoring data of a metric.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeMetricData' => [ + 'summary' => 'Queries the monitoring data of a metric for a cloud service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n" - ."\n" - .'For more information about metric names, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CPUUtilization', - ], + 'schema' => ['description' => 'The metric that is used to monitor the cloud service.'."\n" + ."\n" + .'For more information about the metrics of cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_idle', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of the monitoring data.'."\n" - ."\n" - .'Valid values: 15, 60, 900, and 3600.'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported. The statistical period of metrics (`MetricName`) varies for each cloud service. The statistical period of metrics is displayed in the `MinPeriods` column on the **Metrics** page for each cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The statistical period of the metric.'."\n" + ."\n" + .'Valid values: 15, 60, 900, and 3600.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported.'."\n" + ."\n" + .'- For more information about the statistical period of a metric that is specified by the `MetricName` parameter, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query monitoring data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-31 10:00:00', - ], + 'schema' => ['description' => 'The start of the time range to query monitoring data.'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.\\`\\`'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.\\`\\`\\`\\` The following examples demonstrate how to determine the period in which monitoring data is queried:'."\n" + ."\n" + .' - If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` parameter to 3600, the specified time range must be less than or equal to 2 days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" + ."\n" + .'The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" + ."\n" + .'- UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- You must set the `StartTime` parameter to a point in time that is later than 00:00:00 UTC on Thursday, January 1, 1970. Otherwise, this parameter is invalid.'."\n" + ."\n" + .'- We recommend that you use UNIX timestamps to prevent time zone-related issues.', 'type' => 'string', 'required' => false, 'example' => '1618368900000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query monitoring data.'."\n" - ."\n" - .'* For second-level data, the start time is obtained by comparing the time that is specified by the StartTime parameter and 20 minutes earlier of the time that is specified by the EndTime parameter. The earlier one of the compared points in time is used as the start time.'."\n" - .'* For minute-level data, the start time is obtained by comparing the time that is specified by the StartTime parameter and 2 hours earlier of the time that is specified by the EndTime parameter. The earlier one of the compared points in time is used as the start time.'."\n" - .'* For hour-level data, the start time is obtained by comparing the time that is specified by the StartTime parameter and two days earlier of the time that is specified by the EndTime parameter. The earlier one of the compared points in time is used as the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-31 10:10:00', - ], + 'schema' => ['description' => 'The end of the time range to query monitoring data.'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.\\`\\`'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.\\`\\`\\`\\` The following examples demonstrate how to determine the period in which monitoring data is queried:'."\n" + ."\n" + .' - If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` parameter to 3600, the specified time range must be less than or equal to 2 days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" + ."\n" + .'The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" + ."\n" + .'- UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.'."\n" + ."\n" + .'> We recommend that you use UNIX timestamps to prevent time zone-related issues.', 'type' => 'string', 'required' => false, 'example' => '1618368960000', 'title' => ''], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'The monitoring dimensions of the specified resource.'."\n" - ."\n" - .'Set the value to a collection of `key:value` pairs. Example: `{"userId":"120886317861****"}` or `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" - ."\n" - .'> You can query a maximum of 50 instances in each request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId":"i-abcdefgh12****"}]', - ], + 'schema' => ['description' => 'The dimensions based on which the resources are queried.'."\n" + ."\n" + .'Set the value to a collection of key-value pairs. A typical key-value pair is `instanceId:i-2ze2d6j5uhg20x47****`.'."\n" + ."\n" + .'> You can query a maximum of 50 instances in a single request.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId": "i-abcdefgh12****"}]', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token.'."\n" - ."\n" - .'* If the number of results exceeds the maximum number of entries allowed on a single page, a pagination token is returned.'."\n" - .'* This token can be used as an input parameter to obtain the next page of results. If all results are obtained, no token is returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '15761432850009dd70bb64cff1f0fff6c0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****', - ], + 'schema' => ['description' => 'The expression that is used to compute the query results in real time.'."\n" + ."\n" + .'> Only the `groupby` expression is supported. This expression is similar to the `GROUP BY` statement that is used in databases.', 'type' => 'string', 'required' => false, 'example' => '{"groupby":["userId","instanceId"]}', 'title' => ''], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 1000. This value indicates that a maximum of 1,000 entries of monitoring data can be returned on each page.'."\n" - ."\n" - .'> The maximum value of the Length parameter for each request is 1440.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], - ], - [ - 'name' => 'Express', - 'in' => 'query', - 'schema' => [ - 'description' => 'The expression that is used to calculate the query results in real time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"groupby":["userId","instanceId"]}', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 1000.'."\n" + ."\n" + .'> The maximum value of the Length parameter in a request is 1440.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The pagination token.'."\n", - 'type' => 'string', - 'example' => 'xxxxxx', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Datapoints' => [ - 'description' => 'The monitoring data.'."\n", - 'type' => 'string', - 'example' => '[{"timestamp":1548777660000,"userId":"123456789876****","instanceId":"i-abcdefgh12****","Minimum":93.1,"Average":99.52,"Maximum":100}]', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'Period' => [ - 'description' => 'The time interval.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '60', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D027', 'title' => ''], + 'Datapoints' => ['description' => 'The monitoring data. The value includes the following fields:'."\n" + ."\n" + .'- `timestamp`: the time when the alert was triggered.'."\n" + ."\n" + .'- `userId`: the ID of the user for which the alert was triggered.'."\n" + ."\n" + .'- `instanceId`: the ID of the instance for which the alert was triggered.'."\n" + ."\n" + .'- `Minimum`, `Average`, and `Maximum`: the aggregation methods.', '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}]', 'title' => ''], + 'Period' => ['description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Valid values: 15, 60, 900, and 3600.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '60', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"xxxxxx\\",\\n \\"RequestId\\": \\"021472A6-25E3-4094-8D00-BA4B6A5486C3\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": \\"[{\\\\\\"timestamp\\\\\\":1548777660000,\\\\\\"userId\\\\\\":\\\\\\"123456789876****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-abcdefgh12****\\\\\\",\\\\\\"Minimum\\\\\\":93.1,\\\\\\"Average\\\\\\":99.52,\\\\\\"Maximum\\\\\\":100}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"Period\\": \\"60\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryMetricListResponse>\\r\\n\\t<Period>60</Period>\\r\\n\\t<Datapoints>\\r\\n\\t\\t<timestamp>1548777660000</timestamp>\\r\\n\\t\\t<Maximum>100</Maximum>\\r\\n\\t\\t<userId>123456789876****</userId>\\r\\n\\t\\t<Minimum>93.1</Minimum>\\r\\n\\t\\t<instanceId>i-abcdefgh12****</instanceId>\\r\\n\\t\\t<Average>99.52</Average>\\r\\n\\t</Datapoints>\\r\\n\\t<RequestId>6A5F022D-AC7C-460E-94AE-B9E75083D027</RequestId>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Code>200</Code>\\r\\n</QueryMetricListResponse>","errorExample":""}]', - 'title' => 'DescribeMetricLast', + 'title' => 'DescribeMetricData', 'description' => '### [](#)Limits'."\n" ."\n" - .'* The total free quota is 1 million calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If the free quota is used up and CloudMonitor Basic (pay-as-you-go) is not activated, these API operations can no longer be called as expected. If you have activated CloudMonitor Basic (pay-as-you-go), these API operations can still be called even if the free quota is used up. After the free quota is used up, you are charged for the excess usage based on the pay-as-you-go billing method. For more information about how to activate CloudMonitor Basic (pay-as-you-go), see [Enable the pay-as-you-go billing method](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG\\&commodityCode=cms_basic_public_cn\\&from_biz_channel=help_bill).'."\n" - .'* Each API operation can be called up to 50 times per second. An Alibaba Cloud account and the Resource Access Management (RAM) users within the account share the quota.'."\n" + .'- The total free quota is 1 million calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If the free quota is used up and CloudMonitor Basic (pay-as-you-go) is not activated, these API operations can no longer be called as expected. If you have activated CloudMonitor Basic (pay-as-you-go), these API operations can still be called even if the free quota is used up. If the free quota is used up, you are automatically charged for the excess usage based on the pay-as-you-go billing method. For more information about how to activate CloudMonitor Basic (pay-as-you-go), see [Enable the pay-as-you-go billing method](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG\\&commodityCode=cms_basic_public_cn\\&from_biz_channel=help_bill).'."\n" ."\n" - .'> If `Throttling.User` or `Request was denied due to user flow control` is returned when you call an API operation, the API operation is throttled. For more information about how to handle the issue, see [How do I handle the throttling of a query API?](~~2615031~~)'."\n" + .'- Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the Resource Access Management (RAM) users within the account share the quota.'."\n" ."\n" - .'### [](#)Precautions'."\n" - ."\n" - .'The storage duration of the monitoring data of each cloud service is related to the `Period` parameter (statistical period). A larger value of the `Period` parameter indicates that the monitoring data is distributed in a larger time range and the storage duration of the monitoring data is longer. The following list describes the specific relationships:'."\n" - ."\n" - .'* The storage duration is 7 days if the value of the `Period` parameter is less than 60 seconds.'."\n" - .'* The storage duration is 31 days if the value of the `Period` parameter is 60 seconds.'."\n" - .'* The storage duration is 91 days if the value of the `Period` parameter is greater than or equal to 300 seconds.'."\n" + .'### [](#)Description'."\n" ."\n" - .'### [](#)Operation description'."\n" + .'> Different from [DescribeMetricList](~~51936~~), the DescribeMetricData operation provides statistical features. You can set the Dimension parameter to `{"instanceId": "i-abcdefgh12****"}` to aggregate all data of your Alibaba Cloud account.'."\n" ."\n" - .'This topic provides an example on how to query the latest monitoring data of the `CPUUtilization` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The returned result indicates that the monitoring data for the instance `i-abcdefgh12****` of the account `123456789876****` is queried at an interval of 60 seconds. The maximum, minimum, and average values of the metric are 100, 93.1, and 99.52.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', + .'This topic provides an example on how to query the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2024-01-23T02:42:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-10T11:06:15.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:QueryMetricData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"6A5F022D-AC7C-460E-94AE-B9E75083D027\\",\\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 \\"Period\\": \\"60\\"\\n}","type":"json"}]', 'extraInfo' => ' ', ], - 'DescribeMetricList' => [ - 'summary' => 'Queries the monitoring data of a metric for a specified cloud service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeMetricLast' => [ + 'summary' => 'Queries the latest monitoring data of a specified metric.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service. Format: acs_service name.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For information about the namespaces of cloud services, see [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'For more information about metric names, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cpu_idle', - ], + 'schema' => ['description' => 'The metric name of the cloud service.'."\n" + ."\n" + .'For information about metric names, see [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CPUUtilization', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which the monitoring data is queried.'."\n" - ."\n" - .'Valid values: 60, 300, and 900.'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'> Configure this parameter based on your business scenario.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Valid values: 15, 60, 900, and 3600.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'> - If you do not specify a statistical period, the monitoring data is queried based on the reporting period that was specified when the metric was registered.'."\n" + .' - The statistical period varies by metric (`MetricName`) for each cloud service. For more information, see the `Min Periods` column on the **Metrics** page of the target cloud service in [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format'."\n" - ."\n" - .'> The specified period includes the end time and excludes the start time. The start time must be earlier than the end time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-30 00:00:00', - ], + 'schema' => ['description' => 'The start time of the query.', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:00:00', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-30 00:10:00', - ], + 'schema' => ['description' => 'The end time of the query.'."\n" + ."\n" + .'- For second-level data, the actual start time of the query is the greater value between the time that is 20 minutes before EndTime and the specified startTime.'."\n" + ."\n" + .'- For minute-level data, the actual start time of the query is the greater value between the time that is 2 hours before EndTime and the specified startTime.'."\n" + ."\n" + .'- For hour-level data, the actual start time of the query is the greater value between the time that is 2 days before EndTime and the specified startTime.', 'type' => 'string', 'required' => false, 'example' => '2019-01-31 10:10:00', 'title' => ''], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'The dimensions that specify the resources whose monitoring data you want to query.'."\n" - ."\n" - .'Set the value to a collection of key-value pairs. A typical key-value pair is `instanceId:i-2ze2d6j5uhg20x47****`.'."\n" - ."\n" - .'> You can query a maximum of 50 instances in a single request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId": "i-abcdefgh12****"}]', - ], + 'schema' => ['description' => 'The monitoring dimensions of the specified resource.'."\n" + ."\n" + .'Format: a collection of `key:value` pairs. Example: `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" + ."\n" + .'> A maximum of 50 instances can be queried in a single request.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The paging token.'."\n" - ."\n" - .'> If this parameter is not specified, the data on the first page is returned. A return value other than Null of this parameter indicates that not all entries have been returned. You can use this value as an input parameter to obtain entries on the next page. The value Null indicates that all query results have been returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****', - ], + 'schema' => ['description' => 'The pagination cursor.'."\n" + ."\n" + .'- If the number of results that match the query conditions exceeds the page size, a pagination cursor is returned.'."\n" + .'- To retrieve the next page of data, use the returned cursor value as the request parameter until no cursor value is returned, which indicates that all data has been retrieved.', 'type' => 'string', 'required' => false, 'example' => '15761432850009dd70bb64cff1f0fff6c0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****', 'title' => ''], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'> The maximum value of the Length parameter in a request is 1440.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The number of entries per page for the monitoring data. This parameter is used for paging.'."\n" + ."\n" + .'Default value: 1000, which indicates 1,000 entries of monitoring data per page.'."\n" + ."\n" + .'> The maximum value of Length in a single request is 1440.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'description' => 'The expression that is used to compute the query results in real time.'."\n" - ."\n" - .'> Only the groupby expression is supported. This expression is similar to the GROUP BY statement that is used in databases.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"groupby":["userId","instanceId"]}', - ], + 'schema' => ['description' => 'The expression for real-time computation on existing query results.', 'type' => 'string', 'required' => false, 'example' => '{"groupby":["userId","instanceId"]}', 'title' => ''], ], ], 'responses' => [ @@ -19350,424 +13568,315 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The paging token.'."\n", - 'type' => 'string', - 'example' => '15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Datapoints' => [ - 'description' => 'The monitoring data.'."\n", - 'type' => 'string', - 'example' => '[{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'Period' => [ - 'description' => 'The interval at which the monitoring data is queried. Unit: seconds. Valid values: 60, 300, and 900.'."\n", - 'type' => 'string', - 'example' => '60', - ], + 'NextToken' => ['description' => 'The pagination cursor.', 'type' => 'string', 'example' => 'xxxxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Datapoints' => ['description' => 'The monitoring data list.', 'type' => 'string', 'example' => '[{"timestamp":1548777660000,"userId":"123456789876****","instanceId":"i-abcdefgh12****","Minimum":93.1,"Average":99.52,"Maximum":100}]', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + .'>A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'Period' => ['description' => 'The time interval.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '60', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****\\",\\n \\"RequestId\\": \\"3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": \\"[{\\\\\\"timestamp\\\\\\":1548777660000,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-abc\\\\\\",\\\\\\"Minimum\\\\\\":9.92,\\\\\\"Average\\\\\\":9.92,\\\\\\"Maximum\\\\\\":9.92}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"Period\\": \\"60\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricListResponse>\\r\\n\\t<Period>60</Period>\\r\\n\\t<Datapoints>\\r\\n\\t\\t<timestamp>1490152860000</timestamp>\\r\\n\\t\\t<Maximum>100</Maximum>\\r\\n\\t\\t<userId>120886317861****</userId>\\r\\n\\t\\t<Minimum>93.1</Minimum>\\r\\n\\t\\t<instanceId>i-abcdefgh12****</instanceId>\\r\\n\\t\\t<Average>99.52</Average>\\r\\n\\t</Datapoints>\\r\\n\\t<RequestId>6A5F022D-AC7C-460E-94AE-B9E75083D027</RequestId>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Code>200</Code>\\r\\n</DescribeMetricListResponse>","errorExample":""}]', - 'title' => 'DescribeMetricList', - 'description' => '## Limits'."\n" + 'title' => 'Query the latest monitoring data of a specified metric', + 'description' => '### Limits'."\n" + .'- The DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations share a free quota of 1,000,000 invocations per month in total. After the free quota is exhausted and you have not activated CloudMonitor Basic pay-as-you-go billing method, you cannot use this API operation normally. If you have activated CloudMonitor Basic pay-as-you-go billing method, this API operation remains available after the free quota is exhausted, and the excess usage is automatically billed. For more information about how to activate the pay-as-you-go billing method, see [Activate pay-as-you-go billing](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG&commodityCode=cms_basic_public_cn&from_biz_channel=help_bill).'."\n" + .'- A single API operation is limited to 50 invocations per second. This limit is shared by an Alibaba Cloud account and all Resource Access Management (RAM) users under the account.'."\n" ."\n" - .'Each API operation can be called up to 50 times per second. An Alibaba Cloud account and the RAM users within the account share the quota. '."\n" - ."\n\n" - .'>This topic provides an example to show how to query the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The returned result indicates that the monitoring data for the instance `i-abcdefgh12****` of the account `120886317861****` is queried at an interval of 60 seconds. The maximum, minimum, and average values of the metric are 100, 93.1, and 99.52.', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + .'> If the response contains `Throttling.User` or `Request was denied due to user flow control` when you invoke this API operation, the request is throttled. For the method to handle this issue, see [How do I handle query API throttling](~~2615031~~).'."\n" + .'### Before you begin'."\n" + .'The storage duration of cloud service monitoring data depends on the `Period` (statistical period). A larger `Period` value results in sparser monitoring data and a longer storage duration. The following list describes the relationship:'."\n" + .'- If `Period` is less than 60 seconds, the storage duration is 7 days.'."\n" + .'- If `Period` is equal to 60 seconds, the storage duration is 31 days.'."\n" + .'- If `Period` is greater than or equal to 300 seconds, the storage duration is 91 days.'."\n" + .'### Operation description'."\n" + .'This topic provides an example of how to query the latest monitoring data of the `CPUUtilization` metric for the cloud service `acs_ecs_dashboard`. The response shows that the maximum value is 100, the minimum value is 93.1, and the average value is 99.52 at 60-second intervals for instance `i-abcdefgh12****` under account `123456789876****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMetricData' => [ - 'summary' => 'Queries the monitoring data of a metric for a cloud service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricLast'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:QueryMetricLast', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"xxxxxx\\",\\n \\"RequestId\\": \\"021472A6-25E3-4094-8D00-BA4B6A5486C3\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": \\"[{\\\\\\"timestamp\\\\\\":1548777660000,\\\\\\"userId\\\\\\":\\\\\\"123456789876****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-abcdefgh12****\\\\\\",\\\\\\"Minimum\\\\\\":93.1,\\\\\\"Average\\\\\\":99.52,\\\\\\"Maximum\\\\\\":100}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"Period\\": \\"60\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeMetricList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For more information, see [Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n" - ."\n" - .'For more information about the metrics of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cpu_idle', - ], + 'schema' => ['description' => 'The name of the metric.'."\n" + ."\n" + .'For more information, see [Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_idle', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of the metric.'."\n" - ."\n" - .'Valid values: 15, 60, 900, and 3600.'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported.'."\n" - ."\n" - .'* For more information about the statistical period of a metric that is specified by the `MetricName` parameter, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Valid values: 15, 60, 900, and 3600.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'> - If you do not set this parameter, the reporting period that was specified when the metric was registered is used.'."\n" + ."\n" + .'- The statistical period of each metric (`MetricName`) of a cloud service is different. For more information, see [Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query monitoring data.'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.``'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.```` The following examples demonstrate how to determine the period in which monitoring data is queried:'."\n" - ."\n" - .' * If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" - .' * If you set the `Period` to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" - .' * If you set the `Period` parameter to 3600, the specified time range must be less than or equal to 2 days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" - ."\n" - .'The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You must set the `StartTime` parameter to a point in time that is later than 00:00:00 UTC on Thursday, January 1, 1970. Otherwise, this parameter is invalid.'."\n" - ."\n" - .'* We recommend that you use UNIX timestamps to prevent time zone-related issues.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1618368900000', - ], + 'schema' => ['description' => 'The beginning of the time range to query. The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on January 1, 1970.'."\n" + ."\n" + .'- Format: YYYY-MM-DD hh:mm:ss.'."\n" + ."\n" + .'> * The time range is a left-open and right-closed interval. The value of \\`StartTime\\` must be earlier than the value of \\`EndTime\\`.'."\n" + ."\n" + .'- The interval between \\`StartTime\\` and \\`EndTime\\` must be less than or equal to 31 days.', 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:00:00', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query monitoring data.'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.``'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.```` The following examples demonstrate how to determine the period in which monitoring data is queried:'."\n" - ."\n" - .' * If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" - .' * If you set the `Period` to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" - .' * If you set the `Period` parameter to 3600, the specified time range must be less than or equal to 2 days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" - ."\n" - .'The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" - .'* UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.'."\n" - ."\n" - .'> We recommend that you use UNIX timestamps to prevent time zone-related issues.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1618368960000', - ], + 'schema' => ['description' => 'The end of the time range to query. The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on January 1, 1970.'."\n" + ."\n" + .'- Format: YYYY-MM-DD hh:mm:ss.'."\n" + ."\n" + .'> The interval between \\`StartTime\\` and \\`EndTime\\` must be less than or equal to 31 days.', 'type' => 'string', 'required' => false, 'example' => '2019-01-30 00:10:00', 'title' => ''], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'The dimensions based on which the resources are queried.'."\n" - ."\n" - .'Set the value to a collection of key-value pairs. A typical key-value pair is `instanceId:i-2ze2d6j5uhg20x47****`.'."\n" - ."\n" - .'> You can query a maximum of 50 instances in a single request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId": "i-abcdefgh12****"}]', - ], + 'schema' => ['description' => 'The dimensions that specify the resources to be monitored.'."\n" + ."\n" + .'Format: a collection of key-value pairs, such as `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" + ."\n" + .'> A single request can be used to query a maximum of 50 instances.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', 'title' => ''], ], [ - 'name' => 'Express', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The expression that is used to compute the query results in real time.'."\n" - ."\n" - .'> Only the `groupby` expression is supported. This expression is similar to the `GROUP BY` statement that is used in databases.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"groupby":["userId","instanceId"]}', - ], + 'schema' => ['description' => 'The pagination cursor.'."\n" + ."\n" + .'> If you do not set this parameter, the first page of data is returned. If a value is returned for this parameter, it indicates that more data is available. To retrieve the next page, use the returned value as the \\`NextToken\\` in your next request. A null value indicates that all data has been retrieved.', 'type' => 'string', 'required' => false, 'example' => '15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****', 'title' => ''], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 1000.'."\n" - ."\n" - .'> The maximum value of the Length parameter in a request is 1440.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The number of entries to return on each page for a paged query.'."\n" + ."\n" + .'> The maximum value of \\`Length\\` in a single request is 1440.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => ['description' => 'The expression that is used for real-time computing based on the query results.'."\n" + ."\n" + .'> Only the groupby expression is supported. This expression is similar to the GROUP BY statement in databases.', 'type' => 'string', 'required' => false, 'example' => '{"groupby":["userId","instanceId"]}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D027', - ], - 'Datapoints' => [ - 'description' => 'The monitoring data. The value includes the following fields:'."\n" - ."\n" - .'* `timestamp`: the time when the alert was triggered.'."\n" - .'* `userId`: the ID of the user for which the alert was triggered.'."\n" - .'* `instanceId`: the ID of the instance for which the alert was triggered.'."\n" - .'* `Minimum`, `Average`, and `Maximum`: the aggregation methods.'."\n", - '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}]', - ], - 'Period' => [ - 'description' => 'The statistical period of the monitoring data.'."\n" - ."\n" - .'Valid values: 15, 60, 900, and 3600.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '60', - ], + 'NextToken' => ['description' => 'The pagination cursor.', 'type' => 'string', 'example' => '15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Datapoints' => ['description' => 'The list of monitoring data.', 'type' => 'string', 'example' => '[{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the call was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'Period' => ['description' => 'The statistical period. Unit: seconds. Valid values: 60, 300, and 900.', 'type' => 'string', 'example' => '60', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"6A5F022D-AC7C-460E-94AE-B9E75083D027\\",\\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 \\"Period\\": \\"60\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricDataResponse>\\r\\n\\t<RequestId>7598FEED-3B79-4B4A-AD01-435F34DA8EDC</RequestId>\\r\\n\\t<Period>60</Period>\\t\\r\\n <Datapoints>[{\\\\\\"timestamp\\\\\\":1618368900000,\\\\\\"Average\\\\\\":95.8291666666667,\\\\\\"Minimum\\\\\\":65.48,\\\\\\"Maximum\\\\\\":100.0},{\\\\\\"timestamp\\\\\\":1618368960000,\\\\\\"Average\\\\\\":95.8683333333333,\\\\\\"Minimum\\\\\\":67.84,\\\\\\"Maximum\\\\\\":100.0}]</Datapoints>\\r\\n\\t<Code>200</Code>\\r\\n</DescribeMetricDataResponse>\\t","errorExample":""}]', - 'title' => 'DescribeMetricData', - 'description' => '### [](#)Limits'."\n" + 'title' => 'DescribeMetricList', + 'summary' => 'The DescribeMetricList operation queries the monitoring data of a specific metric for a cloud service.', + 'description' => '### Limits'."\n" ."\n" - .'* The total free quota is 1 million calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If the free quota is used up and CloudMonitor Basic (pay-as-you-go) is not activated, these API operations can no longer be called as expected. If you have activated CloudMonitor Basic (pay-as-you-go), these API operations can still be called even if the free quota is used up. If the free quota is used up, you are automatically charged for the excess usage based on the pay-as-you-go billing method. For more information about how to activate CloudMonitor Basic (pay-as-you-go), see [Enable the pay-as-you-go billing method](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG\\&commodityCode=cms_basic_public_cn\\&from_biz_channel=help_bill).'."\n" - .'* Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the Resource Access Management (RAM) users within the account share the quota.'."\n" + .'- You have a free quota of 1 million total API calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If you use up the free quota and have not enabled the pay-as-you-go billing method for CloudMonitor Basic, you can no longer use these API operations. If you have enabled the pay-as-you-go billing method, you can continue to use the API operations after the free quota is used up. API calls that exceed the free quota are automatically charged on a pay-as-you-go basis. For more information, see [Enable pay-as-you-go](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG\\&commodityCode=cms_basic_public_cn\\&from_biz_channel=help_bill).'."\n" ."\n" - .'### [](#)Description'."\n" + .'- You can call each API operation up to 50 times per second. This limit is shared between an Alibaba Cloud account and its RAM users.'."\n" ."\n" - .'> Different from [DescribeMetricList](~~51936~~), the DescribeMetricData operation provides statistical features. You can set the Dimension parameter to `{"instanceId": "i-abcdefgh12****"}` to aggregate all data of your Alibaba Cloud account.'."\n" + .'> If you receive the `Throttling.User` or `Request was denied due to user flow control` error message when you call an API operation, the API call is throttled. For more information, see [How do I resolve an API call throttling issue?](~~2615031~~).'."\n" ."\n" - .'This topic provides an example on how to query the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + .'### Notes'."\n" + ."\n" + .'The storage duration of monitoring data for a cloud service depends on the `Period` (statistical period). A larger `Period` value indicates that the monitoring data is less granular and is stored for a longer period. The relationship is as follows:'."\n" + ."\n" + .'- If the value of `Period` is less than 60 seconds, the storage duration is 7 days.'."\n" + ."\n" + .'- If the value of `Period` is 60 seconds, the storage duration is 31 days.'."\n" + ."\n" + .'- If the value of `Period` is 300 seconds or greater, the storage duration is 91 days.'."\n" + ."\n" + .'### Usage notes'."\n" + ."\n" + .'This topic provides an example of how to query the monitoring data of the `cpu_idle` metric for the `acs_ecs_dashboard` cloud service. The response shows the data for the instance `i-abcdefgh12****`, which belongs to the Alibaba Cloud account `120886317861****`. At a 60 second interval, the maximum, minimum, and average values of the metric are 100, 93.1, and 99.52, respectively.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMetricMetaList' => [ - 'summary' => 'Queries the details of metrics that are supported in CloudMonitor.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-03-10T06:01:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-10T11:06:16.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:QueryMetricList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****\\",\\n \\"RequestId\\": \\"3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": \\"[{\\\\\\"timestamp\\\\\\":1548777660000,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-abc\\\\\\",\\\\\\"Minimum\\\\\\":9.92,\\\\\\"Average\\\\\\":9.92,\\\\\\"Maximum\\\\\\":9.92}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"Period\\": \\"60\\"\\n}","type":"json"}]', + ], + 'DescribeMetricMetaList' => [ + 'summary' => 'Queries metrics that are supported in CloudMonitor.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'acs_kvstore', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'acs_kvstore', 'title' => ''], ], [ 'name' => 'Labels', 'in' => 'query', - 'schema' => [ - 'description' => 'The tags for filtering metrics. Specify a JSON string.'."\n" - ."\n" - .'Format: ` [{"name":"tag key","value":"tag value"},{"name":"tag key","value":"tag value"}] `. The following tags are available:'."\n" - ."\n" - .'* metricCategory: the category of the metric.'."\n" - .'* alertEnable: specifies whether to report alerts for the metric.'."\n" - .'* alertUnit: the unit of the metric in the alerts.'."\n" - .'* unitFactor: the factor for metric unit conversion.'."\n" - .'* minAlertPeriod: the minimum interval at which the alert is reported.'."\n" - .'* productCategory: the category of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"name":"productCategory","value":"kvstore_old"}]', - ], + 'schema' => ['description' => 'The tags for filtering metrics. Specify a JSON string.'."\n" + ."\n" + .'Format: `[{"name":"tag key","value":"tag value"},{"name":"tag key","value":"tag value"}] `. The following tags are available:'."\n" + ."\n" + .'- metricCategory: the category of the metric.'."\n" + ."\n" + .'- alertEnable: specifies whether to report alerts for the metric.'."\n" + ."\n" + .'- alertUnit: the unit of the metric in the alerts.'."\n" + ."\n" + .'- unitFactor: the factor for metric unit conversion.'."\n" + ."\n" + .'- minAlertPeriod: the minimum interval at which the alert is reported.'."\n" + ."\n" + .'- productCategory: the category of the service.', 'type' => 'string', 'required' => false, 'example' => '[{"name":"productCategory","value":"kvstore_old"}]', 'title' => ''], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CPUUtilization', - ], + 'schema' => ['description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ @@ -19775,358 +13884,367 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0CCE0AF0-053C-4B13-A583-DC9A85785D49', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '12', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CDE9EAFF-D54E-4024-BBFC-B0AAC883143B', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Resources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Resource' => [ - 'description' => 'The configuration of the metrics in the resources.'."\n", + 'description' => 'The configuration of the metrics in the resources.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'CPUUtilization', - ], - 'Description' => [ - 'description' => 'The metric description.'."\n", - 'type' => 'string', - 'example' => 'CPUUtilization', - ], - 'Labels' => [ - 'description' => 'The tags of the metric, including one or more JSON strings.'."\n" - ."\n" - .'Format: `[{"name":"tag key","value":"tag value"}]`. The `name` can be repeated. The following tags are available:'."\n" - ."\n" - .'* metricCategory: the category of the metric.'."\n" - .'* alertEnable: indicates whether to report alerts for the metric.'."\n" - .'* alertUnit: the unit of the metric in the alerts.'."\n" - .'* unitFactor: the factor for metric unit conversion.'."\n" - .'* minAlertPeriod: the minimum interval at which the alert is reported.'."\n" - .'* productCategory: the category of the service.'."\n", - 'type' => 'string', - 'example' => '[{\\"name\\":\\"alertUnit\\",\\"value\\":\\"Bytes\\"},{\\"name\\":\\"minAlertPeriod\\",\\"value\\":\\"60\\"},{\\"name\\":\\"metricCategory\\",\\"value\\":\\"instanceId\\"},{\\"name\\":\\"instanceType\\",\\"value\\":\\"disaster\\"},{\\"name\\":\\"is_alarm\\",\\"value\\":\\"true\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"kvstore_old\\"}]', - ], - 'Unit' => [ - 'description' => 'The unit of the metric.'."\n", - 'type' => 'string', - 'example' => '%', - ], - 'Dimensions' => [ - 'description' => 'The monitoring dimensions of the resource. Multiple monitoring dimensions are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_kvstore', - ], - 'Periods' => [ - 'description' => 'The statistical periods of the metric. Multiple statistical periods are separated with commas (,).'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '60,300', - ], - 'Statistics' => [ - 'description' => 'The statistical method. Multiple statistical methods are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => 'Average,Minimum,Maximum', - ], + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'ads.diskSize', 'title' => ''], + 'Description' => ['description' => 'The metric description.', 'type' => 'string', 'example' => 'The rated disk capacity', 'title' => ''], + 'Labels' => ['description' => 'The tags of the metric, including one or more JSON strings.'."\n" + ."\n" + .'Format: `[{"name":"tag key","value":"tag value"}]`. The `name` can be repeated. The following tags are available:'."\n" + ."\n" + .'- metricCategory: the category of the metric.'."\n" + ."\n" + .'- alertEnable: indicates whether to report alerts for the metric.'."\n" + ."\n" + .'- alertUnit: the unit of the metric in the alerts.'."\n" + ."\n" + .'- unitFactor: the factor for metric unit conversion.'."\n" + ."\n" + .'- minAlertPeriod: the minimum interval at which the alert is reported.'."\n" + ."\n" + .'- productCategory: the category of the service.', 'type' => 'string', 'example' => '[{\\"name\\":\\"minAlertPeriod\\",\\"value\\":\\"300\\"},{\\"name\\":\\"alertDefault\\",\\"value\\":\\"\\"},{\\"name\\":\\"unitFactor\\",\\"value\\":\\"1\\"},{\\"name\\":\\"alertUnit\\",\\"value\\":\\"Mbytes\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"ads\\"},{\\"name\\":\\"is_alarm\\",\\"value\\":\\"true\\"},{\\"name\\":\\"metricCategory\\",\\"value\\":\\"workerId\\"}]', 'title' => ''], + 'Unit' => ['description' => 'The unit of the metric.', 'type' => 'string', 'example' => 'MB', 'title' => ''], + 'Dimensions' => ['description' => 'The monitoring dimensions of the resource. Multiple monitoring dimensions are separated with commas (,).', 'type' => 'string', 'example' => 'userId,instanceId,tableSchema,workerId', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_ads', 'title' => ''], + 'Periods' => ['description' => 'The statistical periods of the metric. Multiple statistical periods are separated with commas (,).'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'example' => '300', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method. Multiple statistical methods are separated with commas (,).', 'type' => 'string', 'example' => 'Average,Minimum,Maximum', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Parameter invalid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"CDE9EAFF-D54E-4024-BBFC-B0AAC883143B\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"Success\\": true,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"MetricName\\": \\"ads.diskSize\\",\\n \\"Description\\": \\"The rated disk capacity\\",\\n \\"Labels\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"minAlertPeriod\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"300\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"alertDefault\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"unitFactor\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"alertUnit\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Mbytes\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"productCategory\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ads\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"is_alarm\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"metricCategory\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"workerId\\\\\\\\\\\\\\"}]\\",\\n \\"Unit\\": \\"MB\\",\\n \\"Dimensions\\": \\"userId,instanceId,tableSchema,workerId\\",\\n \\"Namespace\\": \\"acs_ads\\",\\n \\"Periods\\": \\"300\\",\\n \\"Statistics\\": \\"Average,Minimum,Maximum\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricMetaListResponse>\\r\\n\\t\\t<TotalCount>1853</TotalCount>\\r\\n\\t\\t<RequestId>CDE9EAFF-D54E-4024-BBFC-B0AAC883143B</RequestId>\\r\\n\\t\\t<Success>true</Success>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Resources>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>磁盘额定容量</Description>\\r\\n\\t\\t\\t\\t<Statistics>Average,Minimum,Maximum</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>ads.diskSize</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"300\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertDefault\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"unitFactor\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"Mbytes\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"productCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"ads\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"workerId\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,instanceId,tableSchema,workerId</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_ads</Namespace>\\r\\n\\t\\t\\t\\t<Periods>300</Periods>\\r\\n\\t\\t\\t\\t<Unit>MB</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>磁盘已用容量</Description>\\r\\n\\t\\t\\t\\t<Statistics>Average,Minimum,Maximum</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>ads.diskUsed</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"Mbytes\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"300\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"workerId\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,instanceId,tableSchema,workerId</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_ads</Namespace>\\r\\n\\t\\t\\t\\t<Periods>300</Periods>\\r\\n\\t\\t\\t\\t<Unit>MB</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>磁盘使用率</Description>\\r\\n\\t\\t\\t\\t<Statistics>Average,Minimum,Maximum</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>ads.diskUsedPercent</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"%\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"300\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"workerId\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,instanceId,tableSchema,workerId</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_ads</Namespace>\\r\\n\\t\\t\\t\\t<Periods>300</Periods>\\r\\n\\t\\t\\t\\t<Unit>%</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>queue的未消费的消息数目</Description>\\r\\n\\t\\t\\t\\t<Statistics>Maximum</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>QueueMessageAccumulation</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertDefault\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"unitFactor\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"count/min\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"productCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"amqp\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"queue\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,regionId,vhostName,queueName</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_amqp</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t\\t<Unit>count/min</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>queue每分钟消息生产量</Description>\\r\\n\\t\\t\\t\\t<Statistics>Value</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>QueueMessageInput</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertDefault\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"n ame\\\\\\":\\\\\\"unitFactor\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"count/min\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"productCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"amqp\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"queue\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,regionId,vhostName,queueName</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_amqp</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t\\t<Unit>count/min</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>queue的未消费的消息数目</Description>\\r\\n\\t\\t\\t\\t<Statistics>Value</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>QueueMessageOutput</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertDefault\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"unitFactor\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"count/min\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"productCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"amqp\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"queue\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,regionId,vhostName,queueName</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_amqp</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t\\t<Unit>count/min</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>实例每分钟产生的消息数量</Description>\\r\\n\\t\\t\\t\\t<Statistics>Value</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>VhostMessageInput</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertDefault\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"unitFactor\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"count/min\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"productCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"amqp\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"vhost\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,regionId,vhostName</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_amqp</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t\\t<Unit>count/min</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>实例每分钟消费的消息数量</Description>\\r\\n\\t\\t\\t\\t<Statistics>Value</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>VhostMessageOutput</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertDefault\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"unitFactor\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"count/min\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"productCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"amqp\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"vhost\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,regionId,vhostName</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_amqp</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t\\t<Unit>count/min</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description></Description>\\r\\n\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>Latency</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"ms\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"instanceId\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,region,apiUid</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_apigateway_dashboard</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300,900</Periods>\\r\\n\\t\\t\\t\\t<Unit>ms</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>时间粒度内http返回码4XX占全部返回码的百分比</Description>\\r\\n\\t\\t\\t\\t<Statistics>Average,Minimum,Maximum</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>code4xx</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"%\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"instanceId\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,instanceId</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_cdn</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t\\t<Unit>%</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t</Resources>\\r\\n</DescribeMetricMetaListResponse>","errorExample":""}]', 'title' => 'DescribeMetricMetaList', - 'description' => 'This operation is used together with DescribeMetricList and DescribeMetricLast. For more information, see [DescribeMetricList](~~51936~~) and [DescribeMetricLast](~~51939~~).'."\n", + 'description' => 'Use this operation together with DescribeMetricList and DescribeMetricLast. For more information, see [DescribeMetricList](~~51936~~) and [DescribeMetricLast](~~51939~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeProjectMeta' => [ - 'summary' => 'Queries the information about monitored services in CloudMonitor.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricMetaList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"CDE9EAFF-D54E-4024-BBFC-B0AAC883143B\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"Success\\": true,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"MetricName\\": \\"ads.diskSize\\",\\n \\"Description\\": \\"The rated disk capacity\\",\\n \\"Labels\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"minAlertPeriod\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"300\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"alertDefault\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"unitFactor\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"alertUnit\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Mbytes\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"productCategory\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ads\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"is_alarm\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"metricCategory\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"workerId\\\\\\\\\\\\\\"}]\\",\\n \\"Unit\\": \\"MB\\",\\n \\"Dimensions\\": \\"userId,instanceId,tableSchema,workerId\\",\\n \\"Namespace\\": \\"acs_ads\\",\\n \\"Periods\\": \\"300\\",\\n \\"Statistics\\": \\"Average,Minimum,Maximum\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeMetricRuleBlackList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Labels', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The tags. Tags are used to filter services.'."\n" - ."\n" - .'You can filter services only by the tag whose `name` is `product`. Example: {"name":"product","value":"ECS"}.'."\n" - ."\n" - .'> We recommend that you do not use the special tags in the CloudMonitor console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"name":"product","value":"ECS"}]', - ], + 'schema' => ['description' => 'The namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'For information about the namespaces of Alibaba Cloud services, see [Cloud service metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', + 'schema' => ['description' => 'The current page number.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order in which the query results are sorted by time. Valid values:'."\n" + ."\n" + .'- DESC (default): descending order.'."\n" + ."\n" + .'- ASC: ascending order.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'DESC', 'title' => ''], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => ['description' => 'The category of the Alibaba Cloud service. For example, Redis has `kvstore_standard` (Standard Edition), `kvstore_sharding` (Cluster Edition), and `kvstore_splitrw` (read/write splitting Edition).', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Valid values: 1 to 100.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The IDs of the alert blacklist policies.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the alert blacklist policy.', 'type' => 'string', 'required' => false, 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', 'title' => ''], 'required' => false, - 'example' => '1', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'Name', 'in' => 'query', + 'schema' => ['description' => 'The name of the alert blacklist policy.'."\n" + ."\n" + .'This parameter supports fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'Blacklist-01', 'title' => ''], + ], + [ + 'name' => 'ScopeType', + 'in' => 'query', + 'schema' => ['description' => 'The effective scope of the alert blacklist policy. Valid values:'."\n" + ."\n" + .'- USER: The alert blacklist policy takes effect only within the current Alibaba Cloud account.'."\n" + ."\n" + .'- GROUP: The alert blacklist policy takes effect within the specified application groups.', 'type' => 'string', 'required' => false, 'example' => 'USER', 'title' => ''], + ], + [ + 'name' => 'IsEnable', + 'in' => 'query', + 'schema' => ['description' => 'The status of the alert blacklist policy. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + .'- false: disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'flat', 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Valid values: 1 to 10000.'."\n" - ."\n" - .'Default value: 30.'."\n" + 'description' => 'The instance IDs in the alert blacklist policy.'."\n" ."\n" - .'> The value of this parameter is not limited. You can view a large number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'Valid values of N: 0 to 10.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID in the alert blacklist policy.', 'type' => 'string', 'required' => false, 'example' => 'i-2ze2d6j5uhg20x47****', 'title' => ''], 'required' => false, - 'example' => '30', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4C2061B2-3B1B-43BF-A4A4-C53426F479C0', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '5', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '12', - ], - 'Resources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Resource' => [ - 'description' => 'The details of the cloud service.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'description' => 'The namespace of the cloud service. Format: `acs_Service name abbreviation`. For more information about namespaces, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'acs_cdn', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'CDN', - ], - 'Labels' => [ - 'description' => 'The tags. Tags are used to filter services.'."\n" - ."\n" - .'Tags are returned in the following format: `[{"name":"Tag key","value":"Tag value"}, {"name":"Tag key","value":"Tag value"}]`. The following tags are commonly used:'."\n" - ."\n" - .'* alertUnit: the unit of the metric value in alerts. If the unit is small, the original metric value may be too large. In this case, you can use the `alertUnit` tag to specify an appropriate unit. This tag is used in CloudMonitor.'."\n" - .'* minAlertPeriod: the minimum time interval to report a new alert. The interval at which monitoring data is reported. The value is usually 1 minute.'."\n" - .'* metricCategory: the service specification. Example: kvstore_sharding. Some Alibaba Cloud services have multiple specifications that are defined in the same namespace. This parameter is used to identify the specifications.'."\n" - .'* is_alarm: indicates whether an alert rule can be configured. We recommend that you do not use the special tags in the CloudMonitor console.'."\n", - 'type' => 'string', - 'example' => '[{"groupFlag":true}]', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D63E76CB-29AA-5B9F-88CE-400A6F28D428', 'title' => ''], + 'Total' => ['description' => 'The total number of alert blacklist policies.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: successful.'."\n" + ."\n" + .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DescribeMetricRuleBlackList' => [ + 'description' => 'The alert blacklist policies.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert blacklist policies.', + 'type' => 'object', + 'properties' => [ + 'EffectiveTime' => ['description' => 'The effective period of the alert blacklist policy.', 'type' => 'string', 'example' => '00:00-23:59', 'title' => ''], + 'UpdateTime' => ['description' => 'The timestamp when the alert blacklist policy was last modified.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1665718373000', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the alert blacklist policy was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'example' => '1665714561000', 'title' => ''], + 'ScopeType' => ['description' => 'The effective scope of the alert blacklist policy. Valid values:'."\n" + ."\n" + .'- USER: The alert blacklist policy takes effect only within the current Alibaba Cloud account.'."\n" + ."\n" + .'- GROUP: The alert blacklist policy takes effect within the specified application groups.', 'type' => 'string', 'example' => 'USER', 'title' => ''], + 'IsEnable' => ['description' => 'The status of the alert blacklist policy. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + ."\n" + .'- false: disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'Category' => ['description' => 'The category of the Alibaba Cloud service. For example, Redis has `kvstore_standard` (Standard Edition), `kvstore_sharding` (Cluster Edition), and `kvstore_splitrw` (read/write splitting Edition).', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'EnableEndTime' => ['description' => 'The start timestamp of the alert blacklist policy.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640608200000', 'title' => ''], + 'Name' => ['description' => 'The name of the alert blacklist policy.', 'type' => 'string', 'example' => 'Blacklist-01', 'title' => ''], + 'EnableStartTime' => ['description' => 'The end timestamp of the alert blacklist policy.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640237400000', 'title' => ''], + 'Id' => ['description' => 'The ID of the alert blacklist policy.', 'type' => 'string', 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', 'title' => ''], + 'Metrics' => [ + 'description' => 'The monitoring metrics of the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The monitoring metrics of the instance.', + 'type' => 'object', + 'properties' => [ + 'Resource' => ['description' => 'The extension dimension information of the instance. For example, `{"device":"C:"}` indicates that the alert blacklist policy is applied to all C drives of the ECS instance under the Alibaba Cloud service.', 'type' => 'string', 'example' => '[{"device":"C:"}]', 'title' => ''], + 'MetricName' => ['description' => 'The monitoring metrics name.', 'type' => 'string', 'example' => 'disk_utilization', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'Instances' => [ + 'description' => 'The instances of the specified Alibaba Cloud service in the alert blacklist policy.', + 'type' => 'array', + 'items' => ['description' => 'The instances of the specified Alibaba Cloud service in the alert blacklist policy.', 'type' => 'string', 'example' => 'i-rj99xc6cptkk64ml****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ScopeValue' => [ + 'description' => 'The application group IDs.', + 'type' => 'array', + 'items' => ['description' => 'The application group IDs. The value is in the JSON Array format.'."\n" + ."\n" + .'> This parameter is returned only when `ScopeType` is set to `GROUP`.', 'type' => 'string', 'example' => '["67****","78****"]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4C2061B2-3B1B-43BF-A4A4-C53426F479C0\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"PageSize\\": \\"5\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Total\\": \\"12\\",\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Namespace\\": \\"acs_cdn\\",\\n \\"Description\\": \\"CDN\\",\\n \\"Labels\\": \\"[{\\\\\\"metricCategory\\\\\\":ecs}]\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeProjectMeta>\\r\\n\\t\\t<PageNumber>1</PageNumber>\\r\\n\\t\\t<PageSize>5</PageSize>\\r\\n\\t\\t<RequestId>4C2061B2-3B1B-43BF-A4A4-C53426F479C0</RequestId>\\r\\n\\t\\t<Success>true</Success>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Total>12</Total>\\r\\n\\t\\t<Resources>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>分析型数据库</Description>\\r\\n\\t\\t\\t\\t<Labels>[{\\"name\\":\\"product\\",\\"value\\":\\"ADS\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"ads\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Namespace>acs_ads</Namespace>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>智能推荐</Description>\\r\\n\\t\\t\\t\\t<Labels>[{\\"name\\":\\"product\\",\\"value\\":\\"AIRec\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"airec\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Namespace>acs_airec</Namespace>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>API网关</Description>\\r\\n\\t\\t\\t\\t<Labels>[{\\"name\\":\\"product\\",\\"value\\":\\"APIGateway\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"apigateway\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Namespace>acs_apigateway_dashboard</Namespace>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>CDN</Description>\\r\\n\\t\\t\\t\\t<Labels>[{\\"name\\":\\"product\\",\\"value\\":\\"CDN\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"cdn\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Namespace>acs_cdn</Namespace>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>云企业网</Description>\\r\\n\\t\\t\\t\\t<Labels>[{\\"name\\":\\"product\\",\\"value\\":\\"CEN\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"cen,cen_flow,cen_vbr\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Namespace>acs_cen</Namespace>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t</Resources>\\r\\n</DescribeProjectMeta>\\r\\n","errorExample":""}]', - 'title' => 'DescribeProjectMeta', - 'description' => 'The information obtained by this operation includes the service description, namespace, and tags.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteExporterOutput' => [ - 'summary' => 'Deletes a configuration set that is used to export monitoring data.', - 'methods' => [ - 'post', + 'title' => 'Query alert blacklist policies', + 'summary' => 'Queries a list of alert blacklist policies.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2023-07-11T01:53:40.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleBlackList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricRuleBlackList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"D63E76CB-29AA-5B9F-88CE-400A6F28D428\\",\\n \\"Total\\": 1,\\n \\"Success\\": true,\\n \\"DescribeMetricRuleBlackList\\": [\\n {\\n \\"EffectiveTime\\": \\"00:00-23:59\\",\\n \\"UpdateTime\\": \\"1665718373000\\",\\n \\"CreateTime\\": \\"1665714561000\\",\\n \\"ScopeType\\": \\"USER\\",\\n \\"IsEnable\\": true,\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Category\\": \\"ecs\\",\\n \\"EnableEndTime\\": 1640608200000,\\n \\"Name\\": \\"Blacklist-01\\",\\n \\"EnableStartTime\\": 1640237400000,\\n \\"Id\\": \\"93514c96-ceb8-47d8-8ee3-93b6d98b****\\",\\n \\"Metrics\\": [\\n {\\n \\"Resource\\": \\"[{\\\\\\"device\\\\\\":\\\\\\"C:\\\\\\"}]\\",\\n \\"MetricName\\": \\"disk_utilization\\"\\n }\\n ],\\n \\"Instances\\": [\\n \\"i-rj99xc6cptkk64ml****\\"\\n ],\\n \\"ScopeValue\\": [\\n \\"[\\\\\\"67****\\\\\\",\\\\\\"78****\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeMetricRuleCount' => [ + 'summary' => 'Queries the number of alert rules in each state.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DestName', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the configuration set.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testName', - ], + 'schema' => ['description' => 'The namespace of the cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], ], ], 'responses' => [ @@ -20134,399 +14252,995 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2DECF751-7AFA-43BB-8C63-2B6B07E51AE1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MetricRuleCount' => [ + 'description' => 'The number of alert rules in each state.', + 'type' => 'object', + 'properties' => [ + 'Ok' => ['description' => 'The number of alert rules without active alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'Nodata' => ['description' => 'The number of alert rules without data.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Disable' => ['description' => 'The number of disabled alert rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Total' => ['description' => 'The total number of alert rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '45', 'title' => ''], + 'Alarm' => ['description' => 'The number of alert rules with active alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + 402 => [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"2DECF751-7AFA-43BB-8C63-2B6B07E51AE1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>success</Message>\\n<RequestId>296AE90D-153C-4612-AF24-75D0F5921976</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'DeleteExporterOutput', + 'title' => 'DescribeMetricRuleCount', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteExporterRule' => [ - 'summary' => 'Deletes a data export rule.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleCount'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricRuleCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"FF38D33A-67C1-40EB-AB65-FAEE51EDB644\\",\\n \\"Success\\": true,\\n \\"MetricRuleCount\\": {\\n \\"Ok\\": 40,\\n \\"Nodata\\": 0,\\n \\"Disable\\": 0,\\n \\"Total\\": 45,\\n \\"Alarm\\": 5\\n }\\n}","type":"json"}]', + ], + 'DescribeMetricRuleList' => [ + 'summary' => 'Query all rules in the alert rule list.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The metric name.'."\n" + ."\n" + .'For information about how to obtain metric names, see [DescribeMetricMetaList](~~98846~~) or [Cloud service metrics](~~163515~~).'."\n" + ."\n" + .'Note: For composite metrics, you can only search by the first metric.', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + ], + [ + 'name' => 'EnableState', + 'in' => 'query', + 'schema' => ['description' => 'The enabled state of the alert rule. Valid values:'."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Cloud service metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Minimum value: 1. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'AlertState', + 'in' => 'query', + 'schema' => ['description' => 'The status of the alert rule. Valid values:'."\n" + .'- OK: Normal.'."\n" + .'- ALARM: Alert.'."\n" + .'- INSUFFICIENT_DATA: No data.', 'type' => 'string', 'required' => false, 'example' => 'OK', 'title' => ''], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => ['description' => 'The monitoring dimensions of the specified resource.'."\n" + ."\n" + .'Format: A collection of `key:value` pairs, for example, `{"userId":"120886317861****"}` and `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.', 'type' => 'string', 'required' => false, 'example' => '{"instanceId":"i-2ze2d6j5uhg20x47****"}', 'title' => ''], + ], + [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data export rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'myRuleName', - ], + 'schema' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'This parameter supports fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'Rule_01', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.'."\n" + ."\n" + .'For information about how to obtain the application group ID, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'example' => '7301****', 'title' => ''], + ], + [ + 'name' => 'RuleIds', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of alert rules. Separate multiple IDs with commas (,). You can query up to 20 alert rules at a time.', 'type' => 'string', 'required' => false, 'example' => 'applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D023', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'>200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '386C6712-335F-5054-930A-CC92B851ECBA', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Alarms' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'description' => 'The list of alert rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => ['description' => 'The mute period. Unit: seconds. Default value: 86400. Minimum value: 3600.'."\n" + ."\n" + .'If the monitoring data continuously exceeds the alert rule threshold, only one alert notification is sent within each mute period.', 'type' => 'integer', 'format' => 'int32', 'example' => '86400', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL when an alert is triggered. CloudMonitor pushes alert information to this URL through a POST request. Currently, only the HTTP protocol is supported.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], + 'ContactGroups' => ['description' => 'The alert contact group.', 'type' => 'string', 'example' => 'ECS_Alarm', 'title' => ''], + 'SourceType' => ['description' => 'The type of the alert rule. Valid value: METRIC, indicating a time series metric alert rule.', 'type' => 'string', 'example' => 'METRIC', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'MailSubject' => ['description' => 'The subject of the alert email.', 'type' => 'string', 'example' => '"${serviceType}-${metricName}-${levelDescription} notification(${dimensions})"', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'The time range during which the alert rule is ineffective.', 'type' => 'string', 'example' => '00:00-05:30', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The time range during which the alert rule is effective.', 'type' => 'string', 'example' => '05:31-23:59', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'Rule_01', 'title' => ''], + 'AlertState' => ['description' => 'The status of the alert rule. Valid values:'."\n" + ."\n" + .'- OK: Normal.'."\n" + ."\n" + .'- ALARM: Alert.'."\n" + ."\n" + .'- INSUFFICIENT_DATA: No data.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Period' => ['description' => 'The aggregation period.', 'type' => 'string', 'example' => '60', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****', 'title' => ''], + 'GroupName' => ['description' => 'The name of the application group.'."\n" + .'> This parameter is displayed if the alert rule is associated with an application group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '7301****', 'title' => ''], + 'Dimensions' => ['description' => 'The dimensions of the alert rule.', 'type' => 'string', 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', 'title' => ''], + 'EnableState' => ['description' => 'The enabled state. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resources' => ['description' => 'The resources associated with the alert rule.', 'type' => 'string', 'example' => '[{\\"instanceId\\":\\"i-2ze2d6j5uhg20x47****\\"}]', 'title' => ''], + 'Escalations' => [ + 'description' => 'The trigger conditions for alerts by severity level.', + 'type' => 'object', + 'properties' => [ + 'Info' => [ + 'description' => 'The trigger conditions of Info-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator for Info-level thresholds. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" + .'- GreaterThanThreshold: greater than.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" + .'- LessThanThreshold: less than.'."\n" + .'- NotEqualToThreshold: not equal to.'."\n" + .'- GreaterThanYesterday: year-over-year increase compared to the same time yesterday.'."\n" + .'- LessThanYesterday: year-over-year decrease compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: year-over-year increase compared to the same time last week.'."\n" + .'- LessThanLastWeek: year-over-year decrease compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: period-over-period increase compared to the previous period.'."\n" + .'- LessThanLastPeriod: period-over-period decrease compared to the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'PreCondition' => ['description' => 'The precondition for Info-level alerts. When the ComparisonOperator parameter is set to year-over-year or period-over-period comparison, this parameter works together with it.'."\n" + ."\n" + .'For example, if this parameter is set to $Average>80, ComparisonOperator is set to GreaterThanYesterday, and Threshold is set to 10, an alert is triggered when the average value is greater than 80 and the value has increased by 10% compared to yesterday.'."\n" + ."\n" + .'>$Average in $Average>0 is a placeholder in the format of $monitoring_result_field_value. CloudMonitor replaces it with the corresponding statistical value or original monitoring value.', 'type' => 'string', 'example' => '$Average>80', 'title' => ''], + 'Times' => ['description' => 'The consecutive number of times for which the Info-level alert condition is met. An alert is triggered only when the condition is met for the specified consecutive times and the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Info-level alerts.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for Info-level alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Warn' => [ + 'description' => 'The trigger conditions of Warn-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator for Warn-level thresholds. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" + .'- GreaterThanThreshold: greater than.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" + .'- LessThanThreshold: less than.'."\n" + .'- NotEqualToThreshold: not equal to.'."\n" + .'- GreaterThanYesterday: year-over-year increase compared to the same time yesterday.'."\n" + .'- LessThanYesterday: year-over-year decrease compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: year-over-year increase compared to the same time last week.'."\n" + .'- LessThanLastWeek: year-over-year decrease compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: period-over-period increase compared to the previous period.'."\n" + .'- LessThanLastPeriod: period-over-period decrease compared to the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'PreCondition' => ['description' => 'The precondition for Warn-level alerts. When the ComparisonOperator parameter is set to year-over-year or period-over-period comparison, this parameter works together with it.'."\n" + ."\n" + .'For example, if this parameter is set to $Average>80, ComparisonOperator is set to GreaterThanYesterday, and Threshold is set to 10, an alert is triggered when the average value is greater than 80 and the value has increased by 10% compared to yesterday.'."\n" + .'> $Average in $Average>0 is a placeholder in the format of $monitoring_result_field_value. CloudMonitor replaces it with the corresponding statistical value or original monitoring value.', 'type' => 'string', 'example' => '$Average>80', 'title' => ''], + 'Times' => ['description' => 'The consecutive number of times for which the Warn-level alert condition is met. An alert is triggered only when the condition is met for the specified consecutive times and the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Warn-level alerts.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for Warn-level alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Critical' => [ + 'description' => 'The trigger conditions of Critical-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator for Critical-level thresholds. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" + .'- GreaterThanThreshold: greater than.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" + .'- LessThanThreshold: less than.'."\n" + .'- NotEqualToThreshold: not equal to.'."\n" + .'- GreaterThanYesterday: year-over-year increase compared to the same time yesterday.'."\n" + .'- LessThanYesterday: year-over-year decrease compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: year-over-year increase compared to the same time last week.'."\n" + .'- LessThanLastWeek: year-over-year decrease compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: period-over-period increase compared to the previous period.'."\n" + .'- LessThanLastPeriod: period-over-period decrease compared to the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'PreCondition' => ['description' => 'The precondition for Critical-level alerts. When the ComparisonOperator parameter is set to year-over-year or period-over-period comparison, this parameter works together with it.'."\n" + ."\n" + .'For example, if this parameter is set to $Average>80, ComparisonOperator is set to GreaterThanYesterday, and Threshold is set to 10, an alert is triggered when the average value is greater than 80 and the value has increased by 10% compared to yesterday.'."\n" + .'>$Average in $Average>0 is a placeholder in the format of `$monitoring_result_field_value`. CloudMonitor replaces it with the corresponding statistical value or original monitoring value.', 'type' => 'string', 'example' => '$Average>80', 'title' => ''], + 'Times' => ['description' => 'The consecutive number of times for which the Critical-level alert condition is met. An alert is triggered only when the condition is met for the specified consecutive times and the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Critical-level alerts.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for Critical-level alerts.', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'NoDataPolicy' => ['description' => 'The method to handle alerts when no monitoring data is found. Valid values:'."\n" + .'- KEEP_LAST_STATE (default): No action is taken.'."\n" + .'- INSUFFICIENT_DATA: The alert content indicates no data.'."\n" + .'- OK: Normal.', 'type' => 'string', 'example' => 'KEEP_LAST_STATE', 'title' => ''], + 'CompositeExpression' => [ + 'description' => 'The alert conditions for multiple metrics.'."\n" + .'> Single-metric and multi-metric conditions are mutually exclusive and cannot be set at the same time.', + 'type' => 'object', + 'properties' => [ + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + .'- CRITICAL: Critical.'."\n" + .'- WARN: Warning.'."\n" + .'- INFO: Information.', 'type' => 'string', 'example' => 'CRITICAL', 'title' => ''], + 'ExpressionList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ExpressionList' => [ + 'description' => 'The list of alert conditions created in standard mode.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name of the cloud service.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'Period' => ['description' => 'The aggregation period of the metric.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method of the metric. Valid values:'."\n" + .'- $Maximum: Maximum value.'."\n" + .'- $Minimum: Minimum value.'."\n" + .'- $Average: Average value.'."\n" + .'- $Availability: Availability (typically used for site monitoring).'."\n" + ."\n" + .'> `$` is the unified prefix for metrics. For supported cloud services, see [Cloud service metrics](~~163515~~).', 'type' => 'string', 'example' => '$Maximum', 'title' => ''], + 'ComparisonOperator' => ['description' => 'The comparison operator for the threshold. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to.'."\n" + .'- GreaterThanThreshold: greater than.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to.'."\n" + .'- LessThanThreshold: less than.'."\n" + .'- NotEqualToThreshold: not equal to.'."\n" + .'- GreaterThanYesterday: year-over-year increase compared to the same time yesterday.'."\n" + .'- LessThanYesterday: year-over-year decrease compared to the same time yesterday.'."\n" + .'- GreaterThanLastWeek: year-over-year increase compared to the same time last week.'."\n" + .'- LessThanLastWeek: year-over-year decrease compared to the same time last week.'."\n" + .'- GreaterThanLastPeriod: period-over-period increase compared to the previous period.'."\n" + .'- LessThanLastPeriod: period-over-period decrease compared to the previous period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '90', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ExpressionListJoin' => ['description' => 'The relationship between multi-metric alert conditions. Valid values:'."\n" + ."\n" + .'- `&&`: An alert is triggered only when all metrics meet the alert conditions. An alert is triggered only when all expressions in ExpressionList are `true`.'."\n" + ."\n" + .'- `||`: An alert is triggered when any one of the metrics meets the alert condition.', 'type' => 'string', 'example' => '||', 'title' => ''], + 'ExpressionRaw' => ['description' => 'The alert conditions created by using expressions. The following scenarios are included but not limited to:'."\n" + ."\n" + .'- Set an alert blocklist for some resources. For example, `$instanceId != \'i-io8kfvcpp7x5****\'` `&&` `$Average > 50` indicates that no alert is triggered even if the `Average` value of the instance `i-io8kfvcpp7x5****` in the alert rule exceeds 50.'."\n" + .'- Set a special alert threshold for a specified instance in the rule. For example, `$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)` indicates that an alert is triggered only when the `Average` value of the instance `i-io8kfvcpp7x5****` exceeds 80, and an alert is triggered when the `Average` value of other instances exceeds 50.'."\n" + .'- Limit the number of instances that exceed the threshold in the rule. For example, `count($Average > 20) > 3` indicates that an alert is triggered only when the number of instances whose `Average` value exceeds 20 is greater than 3.'."\n", 'type' => 'string', 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', 'title' => ''], + 'Times' => ['description' => 'The number of times that the alert condition must be met before an alert notification is sent.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Labels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Labels' => [ + 'description' => 'The tags of the alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key of the alert rule.', 'type' => 'string', 'example' => 'cmsRuleKey', 'title' => ''], + 'Value' => ['description' => 'The tag value of the alert rule.', 'type' => 'string', 'example' => 'cmsRuleValue', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Prometheus' => [ + 'description' => 'Prometheus alerts.'."\n" + ."\n" + .'> This parameter is required only when you create Prometheus alert rules for Enterprise Cloud Monitor.', + 'type' => 'object', + 'properties' => [ + 'PromQL' => ['description' => 'The PromQL query statement.'."\n" + ."\n" + .'> The data obtained by the PromQL query statement is the alert data. Include the alert threshold in the statement.', 'type' => 'string', 'example' => 'CpuUsage{instanceId="xxxx"}[1m]>90', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + .'- CRITICAL: Critical.'."\n" + .'- WARN: Warning.'."\n" + .'- INFO: Information.', 'type' => 'string', 'example' => 'CRITICAL', 'title' => ''], + 'Times' => ['description' => 'The number of times that the alert condition must be met before an alert notification is sent.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Annotations' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Annotations' => [ + 'description' => 'When Prometheus alerts are triggered, the annotation keys and values are rendered to make it easier for you to understand the metrics or alert rules.'."\n" + .'> This feature is equivalent to Prometheus Annotations.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The annotation key.', 'type' => 'string', 'example' => 'summary', 'title' => ''], + 'Value' => ['description' => 'The annotation value.', 'type' => 'string', 'example' => '{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'SendOK' => ['title' => '', 'description' => 'Specifies whether to disable recovery alerts. Valid values: true (yes) and false (no).', 'type' => 'boolean', 'example' => 'true'], + 'ProductCategory' => ['description' => 'The type of the cloud service.', 'type' => 'string', 'example' => 'slb', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the rule was created. The value is a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1760432061000', 'title' => ''], + 'GmtUpdate' => ['description' => 'The time when the rule was last updated. The value is a Unix timestamp.', 'type' => 'string', 'example' => '1760432061000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => 'Parameter error'], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"386C6712-335F-5054-930A-CC92B851ECBA\\",\\n \\"Total\\": \\"1\\",\\n \\"Success\\": true,\\n \\"Alarms\\": {\\n \\"Alarm\\": [\\n {\\n \\"SilenceTime\\": 86400,\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Webhook\\": \\"https://www.aliyun.com\\",\\n \\"ContactGroups\\": \\"ECS_Alarm\\",\\n \\"SourceType\\": \\"METRIC\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"MailSubject\\": \\"\\\\\\"${serviceType}-${metricName}-${levelDescription} notification(${dimensions})\\\\\\"\\",\\n \\"NoEffectiveInterval\\": \\"00:00-05:30\\",\\n \\"EffectiveInterval\\": \\"05:31-23:59\\",\\n \\"RuleName\\": \\"Rule_01\\",\\n \\"AlertState\\": \\"OK\\",\\n \\"Period\\": \\"60\\",\\n \\"RuleId\\": \\"applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****\\",\\n \\"GroupName\\": \\"ECS_Group\\",\\n \\"GroupId\\": \\"7301****\\",\\n \\"Dimensions\\": \\"[{\\\\\\"instanceId\\\\\\":\\\\\\"i-2ze2d6j5uhg20x47****\\\\\\"}]\\",\\n \\"EnableState\\": true,\\n \\"Resources\\": \\"[{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-2ze2d6j5uhg20x47****\\\\\\\\\\\\\\"}]\\",\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"PreCondition\\": \\"$Average>80\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"PreCondition\\": \\"$Average>80\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"PreCondition\\": \\"$Average>80\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n },\\n \\"NoDataPolicy\\": \\"KEEP_LAST_STATE\\",\\n \\"CompositeExpression\\": {\\n \\"Level\\": \\"CRITICAL\\",\\n \\"ExpressionList\\": {\\n \\"ExpressionList\\": [\\n {\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Period\\": 60,\\n \\"Statistics\\": \\"$Maximum\\",\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Threshold\\": \\"90\\"\\n }\\n ]\\n },\\n \\"ExpressionListJoin\\": \\"||\\",\\n \\"ExpressionRaw\\": \\"$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)\\",\\n \\"Times\\": 3\\n },\\n \\"Labels\\": {\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"cmsRuleKey\\",\\n \\"Value\\": \\"cmsRuleValue\\"\\n }\\n ]\\n },\\n \\"Prometheus\\": {\\n \\"PromQL\\": \\"CpuUsage{instanceId=\\\\\\"xxxx\\\\\\"}[1m]>90\\",\\n \\"Level\\": \\"CRITICAL\\",\\n \\"Times\\": 3,\\n \\"Annotations\\": {\\n \\"Annotations\\": [\\n {\\n \\"Key\\": \\"summary\\",\\n \\"Value\\": \\"{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }\\"\\n }\\n ]\\n }\\n },\\n \\"SendOK\\": true,\\n \\"ProductCategory\\": \\"slb\\",\\n \\"GmtCreate\\": 1760432061000,\\n \\"GmtUpdate\\": \\"1760432061000\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query all rules in the alert rule list', + 'description' => 'This topic provides an example on how to query all alert rules in the alert rule list under the current Alibaba Cloud account. The response shows that the alert rule list contains only one alert rule. The name of the alert rule is `Rule_01` and the ID is `applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2025-08-05T09:36:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-18T05:44:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-29T09:45:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T09:43:37.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricRuleList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeMetricRuleTargets' => [ + 'summary' => 'Queries the notification channels of a specified alert rule by calling the DescribeMetricRuleTargets operation.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n\n" + .'For information about how to obtain the alert rule ID, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ae06917_75a8c43178ab66****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Targets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => 'The alert trigger targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert trigger targets.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the alert trigger target.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Format: `acs:{AbbreviatedServiceName}:{regionId}:{userId}:/{ResourceType}/{ResourceName}/message`. The following services are supported: Simple Message Queue (formerly MNS), elastic scaling (ESS), Simple Log Service (SLS), and Function Compute (FC). Example: `acs:mns:ap-southeast-1:120886317861****:/queues/test123/message`. The parameter description for the ARN of Simple Message Queue (formerly MNS) is as follows:'."\n" + ."\n" + .'- {AbbreviatedServiceName}: mns'."\n" + ."\n" + .'- {userId}: the Alibaba Cloud account ID.'."\n" + ."\n" + .'- {regionId}: the region where the Simple Message Queue (formerly MNS) queue or topic resides.'."\n" + ."\n" + .'- {ResourceType}: the type of the resource that accepts alert notifications. Valid values:'."\n" + ."\n" + .' - **queues**: queue.'."\n" + .' - **topics**: topic.'."\n" + ."\n" + .'- {ResourceName}: the resource name.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: information.'."\n" + .'- WARN: warning.'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'example' => 'INFO', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters of the alert callback.', 'type' => 'string', 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"6A5F022D-AC7C-460E-94AE-B9E75083D023\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>success</Message>\\n<RequestId>8B524AE2-FBB1-4202-AA17-B3DEAAC8D861</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'DeleteExporterRule', - 'requestParamsDescription' => ' ', + 'title' => 'Query notification channels of a specified alert rule', + 'description' => '## Usage notes'."\n" + .'This topic provides an example to query the target resources associated with the alert rule `ae06917_75a8c43178ab66****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeExporterOutputList' => [ - 'summary' => 'Queries configuration sets that are used to export monitoring data.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-03-21T06:36:40.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleTargets'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricRuleTargets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"786E92D2-AC66-4250-B76F-F1E2FCDDBA1C\\",\\n \\"Success\\": true,\\n \\"Targets\\": {\\n \\"Target\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Arn\\": \\"acs:mns:cn-hangzhou:120886317861****:/queues/test/message\\",\\n \\"Level\\": \\"INFO\\",\\n \\"JsonParams\\": \\"{\\\\\\"customField1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"customField2\\\\\\":\\\\\\"$.name\\\\\\"}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeMetricRuleTemplateAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The name of the alert template. You must set either `Name` or `TemplateId`.'."\n" + ."\n" + .'For information about how to obtain the alert template name, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS_Template1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - 'default' => '1000', - ], + 'schema' => ['description' => 'The ID of the alert template. You must set either `Name` or `TemplateId`.'."\n" + ."\n" + .'For information about how to obtain the alert template ID, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'string', 'required' => false, 'example' => '70****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Datapoints' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8F3A82AD-DA92-52B0-8EC6-C059D1C3839F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resource' => [ + 'description' => 'The details of the alert template.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'Datapoint' => [ - 'description' => 'The configuration sets for exporting monitoring data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ConfigJson' => [ - 'description' => 'The JSON object that contains the details about the destination to which the monitoring data is exported.'."\n", + 'Description' => ['description' => 'The description of the alert template.', 'type' => 'string', 'example' => 'ECS template', 'title' => ''], + 'Name' => ['description' => 'The name of the alert template.', 'type' => 'string', 'example' => 'ECS_Template1', 'title' => ''], + 'RestVersion' => ['description' => 'The version of the alert template.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the alert template.', 'type' => 'string', 'example' => '70****', 'title' => ''], + 'AlertTemplates' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlertTemplate' => [ + 'description' => 'The alert templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert template.', 'type' => 'object', 'properties' => [ - 'ak' => [ - 'description' => 'The AccessKey ID.'."\n", - 'type' => 'string', - 'example' => 'LTAIpY33********', - ], - 'endpoint' => [ - 'description' => 'The Log Service endpoint to which the monitoring data is exported.'."\n", - 'type' => 'string', - 'example' => 'http://cn-qingdao-share.log.aliyuncs.com', - ], - 'logstore' => [ - 'description' => 'The Logstore.'."\n", - 'type' => 'string', - 'example' => 'monitorlogstore', + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'Selector' => ['description' => 'The extended options of the alert dimension.', 'type' => 'string', 'example' => '{"disk":"/"}', 'title' => ''], + 'Webhook' => ['description' => 'The URL that triggers an alert callback.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'Category' => ['description' => 'The abbreviation of the Alibaba Cloud service name.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'ECS_Rule', 'title' => ''], + 'NoDataPolicy' => ['description' => 'The processing method when no monitoring data is found. Valid values:'."\n" + .'- KEEP_LAST_STATE (default): No action is performed.'."\n" + .'- INSUFFICIENT_DATA: An alert whose content is "Insufficient Data" is triggered.'."\n" + .'- OK: The status is considered normal.', 'type' => 'string', 'example' => 'KEEP_LAST_STATE', 'title' => ''], + 'Escalations' => [ + 'description' => 'The threshold and alert level.', + 'type' => 'object', + 'properties' => [ + 'Info' => [ + 'description' => 'The conditions that trigger Info-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to'."\n" + .'- GreaterThanThreshold: greater than'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to'."\n" + .'- LessThanThreshold: less than'."\n" + .'- NotEqualToThreshold: not equal to'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week'."\n" + .'- LessThanLastWeek: less than the value at the same time last week'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Times' => ['description' => 'The number of retries for Info-level alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Info-level alerts.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for Info-level alerts.'."\n" + ."\n" + .'The valid values of `Statistics` vary based on the Alibaba Cloud service. For more information, see [Alibaba Cloud service metrics](~~163515~~).', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Warn' => [ + 'description' => 'The conditions that trigger Warn-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to'."\n" + .'- GreaterThanThreshold: greater than'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to'."\n" + .'- LessThanThreshold: less than'."\n" + .'- NotEqualToThreshold: not equal to'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week'."\n" + .'- LessThanLastWeek: less than the value at the same time last week'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Times' => ['description' => 'The number of retries for Warn-level alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Warn-level alerts.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for Warn-level alerts.'."\n" + ."\n" + .'The valid values of `Statistics` vary based on the Alibaba Cloud service. For more information, see [Alibaba Cloud service metrics](~~163515~~).', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Critical' => [ + 'description' => 'The conditions that trigger Critical-level alerts.', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => ['description' => 'The comparison operator for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to'."\n" + .'- GreaterThanThreshold: greater than'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to'."\n" + .'- LessThanThreshold: less than'."\n" + .'- NotEqualToThreshold: not equal to'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week'."\n" + .'- LessThanLastWeek: less than the value at the same time last week'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Times' => ['description' => 'The number of retries for Critical-level alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for Critical-level alerts.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for Critical-level alerts.'."\n" + ."\n" + .'The valid values of `Statistics` vary based on the Alibaba Cloud service. For more information, see [Alibaba Cloud service metrics](~~163515~~).', 'type' => 'string', 'example' => 'Average', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'project' => [ - 'description' => 'The Log Service project to which the monitoring data is exported.'."\n", - 'type' => 'string', - 'example' => 'exporter', + 'Labels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Labels' => [ + 'description' => 'The labels of the alert template.', + 'type' => 'array', + 'items' => [ + 'description' => 'The label of the alert template.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the alert template label.', 'type' => 'string', 'example' => 'label1', 'title' => ''], + 'Value' => ['description' => 'The value of the alert template label.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'SilenceTime' => ['description' => 'The mute period. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'CreateTime' => [ - 'description' => 'The time when the configuration set was created. The value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1584016495498', - ], - 'DestName' => [ - 'description' => 'The name of the configuration set.'."\n", - 'type' => 'string', - 'example' => 'exporterOut', - ], - 'DestType' => [ - 'description' => 'The service to which the monitoring data is exported.'."\n" - ."\n" - .'> Only Log Service is supported. More services will be supported in the future.'."\n", - 'type' => 'string', - 'example' => 'SLS', - ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'sucess', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0E657631-CD6C-4C24-9637-98D000B9272C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 412 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0E657631-CD6C-4C24-9637-98D000B9272C\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"sucess\\",\\n \\"PageNumber\\": 1,\\n \\"Total\\": 25,\\n \\"Datapoints\\": {\\n \\"Datapoint\\": [\\n {\\n \\"DestType\\": \\"SLS\\",\\n \\"CreateTime\\": 1584016495498,\\n \\"DestName\\": \\"exporterOut\\",\\n \\"ConfigJson\\": {\\n \\"ak\\": \\"LTAIpY33********\\",\\n \\"endpoint\\": \\"http://cn-qingdao-share.log.aliyuncs.com\\",\\n \\"project\\": \\"exporter\\",\\n \\"logstore\\": \\"monitorlogstore\\",\\n \\"as\\": \\"TxHwuJ8yAb3AULcnny******\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BB30C6D9-8D0D-442E-9484-C15BADE76A21</RequestId>\\n<PageNumber>1</PageNumber>\\n<Total>1</Total>\\n<Datapoints>\\n <Datapoint>\\n <DestType>SLS</DestType>\\n <DestName>desctName1</DestName>\\n <CreateTime>1584016495498</CreateTime>\\n <ConfigJson>\\n <endpoint>http://cn-qingdao-share.log.aliyuncs.com</endpoint>\\n <as>TxHwuJ8yAb3AULcnny******</as>\\n <project>exporter</project>\\n <ak>LTAIpY33********</ak>\\n <logstore>exporter</logstore>\\n </ConfigJson>\\n </Datapoint>\\n</Datapoints>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'DescribeExporterOutputList', - 'requestParamsDescription' => ' ', + 'title' => 'Query alert template details', + 'summary' => 'Queries the details of an alert template by calling the DescribeMetricRuleTemplateAttribute operation.', + 'description' => 'This topic provides an example on how to query the details of the alert template `70****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeExporterRuleList' => [ - 'summary' => 'Queries data export rules.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-04-23T06:00:37.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-04-23T03:08:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-27T11:46:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-26T09:11:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-22T02:14:37.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleTemplateAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricRuleTemplateAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"8F3A82AD-DA92-52B0-8EC6-C059D1C3839F\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"Description\\": \\"ECS template\\",\\n \\"Name\\": \\"ECS_Template1\\",\\n \\"RestVersion\\": \\"1\\",\\n \\"TemplateId\\": \\"70****\\",\\n \\"AlertTemplates\\": {\\n \\"AlertTemplate\\": [\\n {\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Selector\\": \\"{\\\\\\"disk\\\\\\":\\\\\\"/\\\\\\"}\\",\\n \\"Webhook\\": \\"https://www.aliyun.com\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Category\\": \\"ecs\\",\\n \\"RuleName\\": \\"ECS_Rule\\",\\n \\"NoDataPolicy\\": \\"KEEP_LAST_STATE\\",\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Times\\": 5,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n },\\n \\"Labels\\": {\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"label1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n },\\n \\"SilenceTime\\": 3600\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'DescribeMetricRuleTemplateList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert template.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Template1', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The keyword of the alert template name.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '70****', 'title' => ''], + ], + [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1000', - 'default' => '1000', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'History', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to display the history of applying the alert templates to application groups. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false (default)', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sorting order. Valid values:'."\n" + ."\n" + .'- true (default): ascending order'."\n" + ."\n" + .'- false: descending order', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => 'The sorting basis. Valid values:'."\n" + ."\n" + .'- gmtMotified: sorts alert templates by modification time'."\n" + ."\n" + .'- gmtCreate (default): sorts alert templates by creation time', 'type' => 'string', 'required' => false, 'example' => 'gmtCreate', 'title' => ''], ], ], 'responses' => [ @@ -20534,347 +15248,265 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Datapoints' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '659401C0-6214-5C02-972A-CFA929D717B7', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Templates' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Datapoint' => [ - 'description' => 'The details of the data export rules.'."\n", + 'Template' => [ + 'description' => 'The queried alert templates.', 'type' => 'array', 'items' => [ + 'description' => 'None', 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'description' => 'The time when the rule was created. The value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1584024616228', - ], - 'Describe' => [ - 'description' => 'The description of the rule.'."\n", - 'type' => 'string', - 'example' => 'Export monitoring data'."\n", - ], - 'Dimension' => [ - 'description' => 'The associated dimensions.'."\n", - 'type' => 'string', - 'example' => '{"instanceId":"xxxxx"}', - ], - 'DstName' => [ + 'Description' => ['description' => 'The description of the alert template.', 'type' => 'string', 'example' => 'ECS的CPU使用率', 'title' => ''], + 'GmtCreate' => ['description' => 'The timestamp when the alert template was created.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646018798000', 'title' => ''], + 'Name' => ['description' => 'The name of the alert template.', 'type' => 'string', 'example' => 'ECS_Template1', 'title' => ''], + 'RestVersion' => ['description' => 'The version of the alert template.'."\n" + ."\n" + .'Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'GmtModified' => ['description' => 'The timestamp when the alert template was modified.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646054798000', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the alert template.', 'type' => 'integer', 'format' => 'int64', 'example' => '70****', 'title' => ''], + 'ApplyHistories' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'DstName' => [ + 'ApplyHistory' => [ + 'description' => 'The history of applying the alert templates to application groups.', 'type' => 'array', 'items' => [ - 'description' => 'Indicates whether the call is successful. Valid values:'."\n" - ."\n" - .'* `true`: The call is successful.'."\n" - .'* `false`: The call fails.'."\n", - 'type' => 'string', - 'example' => 'exporter1', + 'description' => 'None', + 'type' => 'object', + 'properties' => [ + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '3607****', 'title' => ''], + 'GroupName' => ['description' => 'The name of the application group.', 'type' => 'string', 'example' => 'ECS_Group', 'title' => ''], + 'ApplyTime' => ['description' => 'The timestamp when the alert template was applied to the application group.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646055898000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'Enabled' => [ - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MetricName' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'> For more information, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~28619~~).'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'Namespace' => [ - 'description' => 'The namespace of the service.'."\n" - ."\n" - .'> For more information, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~28619~~).'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'RuleName' => [ - 'description' => 'The name of the data export rule.'."\n", - 'type' => 'string', - 'example' => 'myRuleName', - ], - 'TargetWindows' => [ - 'description' => 'The time window of the exported data.\\'."\n" - .'Multiple windows are separated with commas (,).'."\n" - ."\n" - .'> Data in a time window of less than 60 seconds cannot be exported.'."\n", - 'type' => 'string', - 'example' => '60,300', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'susscess', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6BA047CA-8BC6-40BC-BC8F-FBECF35F1993', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Datapoints\\": {\\n \\"Datapoint\\": [\\n {\\n \\"CreateTime\\": 1667526533000,\\n \\"Describe\\": \\"export test\\",\\n \\"Dimension\\": \\"hotsName\\",\\n \\"DstName\\": {\\n \\"DstName\\": [\\n \\"[]\\"\\n ]\\n },\\n \\"Enabled\\": true,\\n \\"MetricName\\": \\"CPUUtilization\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"RuleName\\": \\"L121-寿险-全能保建议书系统_DefaultEventRule_10842827\\",\\n \\"TargetWindows\\": \\"rule_test\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"6BA047CA-8BC6-40BC-BC8F-FBECF35F1993\\",\\n \\"Success\\": true,\\n \\"Total\\": 1000\\n}","type":"json"}]', - 'title' => 'DescribeExporterRuleList', - 'requestParamsDescription' => ' ', + 'title' => 'DescribeMetricRuleTemplateList', + 'summary' => 'Queries alert templates.', + 'description' => 'This topic provides an example on how to query alert templates. In this example, the following alert templates are returned in the response: `ECS_Template1` and `ECS_Template2`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMetricTop' => [ - 'summary' => 'Queries the latest monitoring data of a metric for a cloud service. The data can be sorted by a specified order.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-03-22T08:53:07.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleTemplateList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMetricRuleTemplateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"659401C0-6214-5C02-972A-CFA929D717B7\\",\\n \\"Total\\": 2,\\n \\"Success\\": true,\\n \\"Templates\\": {\\n \\"Template\\": [\\n {\\n \\"Description\\": \\"ECS的CPU使用率\\",\\n \\"GmtCreate\\": 1646018798000,\\n \\"Name\\": \\"ECS_Template1\\",\\n \\"RestVersion\\": 0,\\n \\"GmtModified\\": 1646054798000,\\n \\"TemplateId\\": 0,\\n \\"ApplyHistories\\": {\\n \\"ApplyHistory\\": [\\n {\\n \\"GroupId\\": 0,\\n \\"GroupName\\": \\"ECS_Group\\",\\n \\"ApplyTime\\": 1646055898000\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeMetricTop' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of the monitoring data.'."\n" - ."\n" - .'Valid values: 15, 60, 900, and 3600.'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported.'."\n" - ."\n" - .'* Statistical periods vary based on the metrics that are specified by `MetricName`. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Valid values: 15, 60, 900, and 3600.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported.'."\n" + ."\n" + .'- Statistical periods vary based on the metrics that are specified by `MetricName`. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n" - ."\n" - .'For more information about metric names, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cpu_idle', - ], + 'schema' => ['description' => 'The metric that is used to monitor the cloud service.'."\n" + ."\n" + .'For more information about metric names, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_idle', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query monitoring data.'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.``'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.````'."\n" - ."\n" - .' * If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" - .' * If you set the `Period` parameter to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" - .' * If you set the `Period` parameter to 3600, the specified time range must be less than or equal to two days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" - ."\n" - .'The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" - .'* Time format: YYYY-MM-DDThh:mm:ssZ'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You must set the `StartTime` parameter to a point in time that is later than 00:00:00 Thursday, January 1, 1970. Otherwise, this parameter is invalid.'."\n" - ."\n" - .'* We recommend that you use UNIX timestamps to prevent time zone-related issues.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-05-08 08:00:00', - ], + 'schema' => ['description' => 'The start of the time range to query monitoring data.'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.\\`\\`'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.\\`\\`\\`\\`'."\n" + ."\n" + .' - If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` parameter to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` parameter to 3600, the specified time range must be less than or equal to two days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" + ."\n" + .'The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" + ."\n" + .'- Time format: YYYY-MM-DDThh:mm:ssZ'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- You must set the `StartTime` parameter to a point in time that is later than 00:00:00 Thursday, January 1, 1970. Otherwise, this parameter is invalid.'."\n" + ."\n" + .'- We recommend that you use UNIX timestamps to prevent time zone-related issues.', 'type' => 'string', 'required' => false, 'example' => '2021-05-08 08:00:00', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query monitoring data.'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.``'."\n" - ."\n" - .'* If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.````'."\n" - ."\n" - .' * If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" - .' * If you set the `Period` parameter to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" - .' * If you set the `Period` parameter to 3600, the specified time range must be less than or equal to two days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" - ."\n" - .'The following formats are supported:'."\n" - ."\n" - .'* UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" - .'* Time format: YYYY-MM-DDThh:mm:ssZ'."\n" - ."\n" - .'> We recommend that you use UNIX timestamps to prevent time zone-related issues.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-05-08 10:00:00', - ], + 'schema' => ['description' => 'The end of the time range to query monitoring data.'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are not specified, the monitoring data of the last statistical period is queried.\\`\\`'."\n" + ."\n" + .'- If the `StartTime` and `EndTime` parameters are specified, the monitoring data of the last statistical period in the specified time range is queried.\\`\\`\\`\\`'."\n" + ."\n" + .' - If you set the `Period` parameter to 15, the specified time range must be less than or equal to 20 minutes. For example, if you set the StartTime parameter to 2021-05-08 08:10:00 and the EndTime parameter to 2021-05-08 08:30:00, the monitoring data of the last 15 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` parameter to 60 or 900, the specified time range must be less than or equal to 2 hours. For example, if you set the Period parameter to 60, the StartTime parameter to 2021-05-08 08:00:00, and the EndTime parameter to 2021-05-08 10:00:00, the monitoring data of the last 60 seconds in the time range is queried.'."\n" + ."\n" + .' - If you set the `Period` parameter to 3600, the specified time range must be less than or equal to two days. For example, if you set the StartTime parameter to 2021-05-08 08:00:00 and the EndTime parameter to 2021-05-10 08:00:00, the monitoring data of the last 3,600 seconds in the time range is queried.'."\n" + ."\n" + .'The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 Thursday, January 1, 1970'."\n" + ."\n" + .'- Time format: YYYY-MM-DDThh:mm:ssZ'."\n" + ."\n" + .'> We recommend that you use UNIX timestamps to prevent time zone-related issues.', 'type' => 'string', 'required' => false, 'example' => '2021-05-08 10:00:00', 'title' => ''], ], [ 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'The monitoring dimensions of the specified resource.'."\n" - ."\n" - .'Set the value to a collection of `key:value` pairs. Example: `{"userId":"120886317861****"}` or `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" - ."\n" - .'> You can query a maximum of 50 instances in each request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId": "i-abcdefgh12****"}]', - ], + 'schema' => ['description' => 'The monitoring dimensions of the specified resource.'."\n" + ."\n" + .'Set the value to a collection of `key:value` pairs. Example: `{"userId":"120886317861****"}` or `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n" + ."\n" + .'> You can query a maximum of 50 instances in each request.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId": "i-2ze2d6j5uhg20x47****"}]', 'title' => ''], ], [ 'name' => 'Orderby', 'in' => 'query', - 'schema' => [ - 'description' => 'The field based on which data is sorted. Valid values:'."\n" - ."\n" - .'* Average'."\n" - .'* Minimum'."\n" - .'* Maximum'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Average', - ], + 'schema' => ['description' => 'The field based on which data is sorted. Valid values:'."\n" + ."\n" + .'- Average'."\n" + ."\n" + .'- Minimum'."\n" + ."\n" + .'- Maximum', 'type' => 'string', 'required' => true, 'example' => 'Average', 'title' => ''], ], [ 'name' => 'OrderDesc', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which data is sorted. Valid values:'."\n" - ."\n" - .'* True: sorts data in ascending order.'."\n" - .'* False (default): sorts data in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'False', - ], + 'schema' => ['description' => 'The order in which data is sorted. Valid values:'."\n" + ."\n" + .'- True: sorts data in ascending order.'."\n" + ."\n" + .'- False (default): sorts data in descending order.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 10.'."\n" - ."\n" - .'> The maximum value of the Length parameter in a request is 1440.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Default value: 10.'."\n" + ."\n" + .'> The maximum value of the Length parameter in a request is 1440.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Express', 'in' => 'query', - 'schema' => [ - 'description' => 'The expression that is used to compute the query results in real time.'."\n" - ."\n" - .'> Only the `groupby` expression is supported. This expression is similar to the GROUP BY statement used in databases.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"groupby":["userId","instanceId"]}', - ], + 'schema' => ['description' => 'The expression that is used to compute the query results in real time.'."\n" + ."\n" + .'> Only the `groupby` expression is supported. This expression is similar to the GROUP BY statement used in databases.', 'type' => 'string', 'required' => false, 'example' => '{"groupby":["userId","instanceId"]}', 'title' => ''], ], ], 'responses' => [ @@ -20882,3232 +15514,2225 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', - ], - 'Datapoints' => [ - 'description' => 'The monitoring data.'."\n", - 'type' => 'string', - 'example' => '[{\\"order\\":1,\\"timestamp\\":1620287520000,\\"userId\\":\\"120886317861****\\",\\"instanceId\\":\\"i-j6ccf7d5fn335qpo****\\",\\"Average\\":99.92,\\"Minimum\\":99.5,\\"Maximum\\":100.0,\\"_count\\":1.0},{\\"order\\":2,\\"timestamp\\":1620287520000,\\"userId\\":\\"120886317861****\\",\\"instanceId\\":\\"i-0xii2bvf42iqvxbp****\\",\\"Average\\":99.91,\\"Minimum\\":99.0,\\"Maximum\\":100.0,\\"_count\\":1.0}]', - ], - 'Period' => [ - 'description' => 'The statistical period of the monitoring data. Unit: seconds. Valid values: 15, 60, 900, and 3600.'."\n", - 'type' => 'string', - 'example' => '60', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', 'title' => ''], + 'Datapoints' => ['description' => 'The monitoring data.', 'type' => 'string', 'example' => '[{\\"order\\":1,\\"timestamp\\":1620287520000,\\"userId\\":\\"120886317861****\\",\\"instanceId\\":\\"i-j6ccf7d5fn335qpo****\\",\\"Average\\":99.92,\\"Minimum\\":99.5,\\"Maximum\\":100.0,\\"_count\\":1.0},{\\"order\\":2,\\"timestamp\\":1620287520000,\\"userId\\":\\"120886317861****\\",\\"instanceId\\":\\"i-0xii2bvf42iqvxbp****\\",\\"Average\\":99.91,\\"Minimum\\":99.0,\\"Maximum\\":100.0,\\"_count\\":1.0}]', 'title' => ''], + 'Period' => ['description' => 'The statistical period of the monitoring data. Unit: seconds. Valid values: 15, 60, 900, and 3600.', 'type' => 'string', 'example' => '60', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42\\",\\n \\"Datapoints\\": \\"[{\\\\\\\\\\\\\\"order\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1620287520000,\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120886317861****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-j6ccf7d5fn335qpo****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":99.92,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":99.5,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0,\\\\\\\\\\\\\\"_count\\\\\\\\\\\\\\":1.0},{\\\\\\\\\\\\\\"order\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1620287520000,\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120886317861****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-0xii2bvf42iqvxbp****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":99.91,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":99.0,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0,\\\\\\\\\\\\\\"_count\\\\\\\\\\\\\\":1.0}]\\",\\n \\"Period\\": \\"60\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricTopResponse>\\r\\n\\t<RequestId>18DC44ED-B058-49B0-9D49-1D6608328E4D</RequestId>\\r\\n\\t<Period>60</Period>\\r\\n\\t<Datapoints>[{\\\\\\"order\\\\\\":1,\\\\\\"timestamp\\\\\\":1620287520000,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-j6ccf7d5fn335qpo****\\\\\\",\\\\\\"Average\\\\\\":99.92,\\\\\\"Minimum\\\\\\":99.5,\\\\\\"Maximum\\\\\\":100.0,\\\\\\"_count\\\\\\":1.0},{\\\\\\"order\\\\\\":2,\\\\\\"timestamp\\\\\\":1620287520000,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-0xii2bvf42iqvxbp****\\\\\\",\\\\\\"Average\\\\\\":99.91,\\\\\\"Minimum\\\\\\":99.0,\\\\\\"Maximum\\\\\\":100.0,\\\\\\"_count\\\\\\":1.0}]</Datapoints>\\r\\n\\t<Code>200</Code>\\r\\n</DescribeMetricTopResponse>\\t","errorExample":""}]', 'title' => 'DescribeMetricTop', + 'summary' => 'Queries the latest monitoring data of a metric for a cloud service. The data can be sorted by a specified order.', 'description' => '### [](#)Limits'."\n" ."\n" - .'* The total free quota is 1 million calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If the free quota is used up and CloudMonitor Basic (pay-as-you-go) is not activated, these API operations can no longer be called as expected. If you have activated CloudMonitor Basic (pay-as-you-go), these API operations can still be called even if the free quota is used up. After the free quota is used up, you are charged for the excess usage based on the pay-as-you-go billing method. For more information about how to activate CloudMonitor Basic (pay-as-you-go), see [Enable the pay-as-you-go billing method](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG\\&commodityCode=cms_basic_public_cn\\&from_biz_channel=help_bill).'."\n" - .'* Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the Resource Access Management (RAM) users within the account share the quota.'."\n" + .'- The total free quota is 1 million calls per month for the DescribeMetricLast, DescribeMetricList, DescribeMetricData, and DescribeMetricTop operations. If the free quota is used up and CloudMonitor Basic (pay-as-you-go) is not activated, these API operations can no longer be called as expected. If you have activated CloudMonitor Basic (pay-as-you-go), these API operations can still be called even if the free quota is used up. After the free quota is used up, you are charged for the excess usage based on the pay-as-you-go billing method. For more information about how to activate CloudMonitor Basic (pay-as-you-go), see [Enable the pay-as-you-go billing method](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG\\&commodityCode=cms_basic_public_cn\\&from_biz_channel=help_bill).'."\n" + ."\n" + .'- Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the Resource Access Management (RAM) users within the account share the quota.'."\n" ."\n" .'### [](#)Precautions'."\n" ."\n" .'The storage duration of the monitoring data of each cloud service is related to the `Period` parameter (statistical period). A larger value of the `Period` parameter indicates that the monitoring data is distributed in a larger time range and the storage duration of the monitoring data is longer. The following list describes the specific relationships:'."\n" ."\n" - .'* The storage duration is 7 days if the value of the `Period` parameter is less than 60 seconds.'."\n" - .'* The storage duration is 31 days if the value of the `Period` parameter is 60 seconds.'."\n" - .'* The storage duration is 91 days if the value of the `Period` is greater than or equal to 300 seconds.'."\n" + .'- The storage duration is 7 days if the value of the `Period` parameter is less than 60 seconds.'."\n" + ."\n" + .'- The storage duration is 31 days if the value of the `Period` parameter is 60 seconds.'."\n" + ."\n" + .'- The storage duration is 91 days if the value of the `Period` is greater than or equal to 300 seconds.'."\n" ."\n" .'### [](#)Operation description'."\n" ."\n" - .'This topic provides an example on how to query the monitoring data of the `cpu_idle` metric in the last 60 seconds for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The monitoring data is sorted in descending order based on the `Average` field.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + .'This topic provides an example on how to query the monitoring data of the `cpu_idle` metric in the last 60 seconds for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The monitoring data is sorted in descending order based on the `Average` field.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutExporterOutput' => [ - 'summary' => 'Creates or modifies a configuration set for exporting monitoring data.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricTop'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:QueryMetricTop', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42\\",\\n \\"Datapoints\\": \\"[{\\\\\\\\\\\\\\"order\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1620287520000,\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120886317861****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-j6ccf7d5fn335qpo****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":99.92,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":99.5,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0,\\\\\\\\\\\\\\"_count\\\\\\\\\\\\\\":1.0},{\\\\\\\\\\\\\\"order\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1620287520000,\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120886317861****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-0xii2bvf42iqvxbp****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":99.91,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":99.0,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0,\\\\\\\\\\\\\\"_count\\\\\\\\\\\\\\":1.0}]\\",\\n \\"Period\\": \\"60\\"\\n}","type":"json"}]', + ], + 'DescribeMonitorGroupCategories' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'DestName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the configuration set.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'exporterConfig', - ], - ], - [ - 'name' => 'ConfigJson', - 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration set for exporting monitoring data. It is a JSON object string. The string must include the following fields:'."\n" - ."\n" - .'* endpoint: the endpoint of Log Service.'."\n" - .'* project: the Log Service project to which monitoring data is exported.'."\n" - .'* logstore: the Log Service Logstore to which the monitoring data is exported.'."\n" - .'* ak: the AccessKey ID.'."\n" - .'* as: the AccessKey secret.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{ "endpoint": "http://cn-qingdao-share.log.aliyuncs.com", "project": "exporter", "logstore": "exporter","ak": "LTAIp*******", "userId": "17754********", "as": "TxHwuJ8yAb3AU******"}', - ], - ], - [ - 'name' => 'Desc', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the configuration set.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Export CPU metrics'."\n", - ], - ], - [ - 'name' => 'DestType', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The service to which the monitoring data is exported.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'sls', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D027', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. true: The request was successful. false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9E0347B0-EBC3-4769-A78D-D96F21C6BB52', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MonitorGroupCategories' => [ + 'description' => 'The cloud services to which the resources in the application group belong and the number of resources that belong to the cloud service.', + 'type' => 'object', + 'properties' => [ + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'MonitorGroupCategory' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CategoryItem' => [ + 'description' => 'The cloud services to which the resources in the application group belong and the number of resources that belong to the cloud service.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Count' => ['description' => 'The number of resources that belong to the cloud service.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Category' => ['description' => 'The abbreviation of the cloud service name.'."\n" + ."\n" + .'> For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"6A5F022D-AC7C-460E-94AE-B9E75083D027\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutExporterOutput>\\n\\t\\t<RequestId>E5DC60DD-2FDE-488F-942C-424FA3E18BF8</RequestId>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</PutExporterOutput>","errorExample":""}]', - 'title' => 'PutExporterOutput', - 'description' => '> The monitoring data can be exported only to Log Service. More services will be supported in the future.'."\n", + 'title' => 'DescribeMonitorGroupCategories', + 'summary' => 'Queries the cloud services to which the resources in an application group belong and the number of resources that belong to each cloud service in the application group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutExporterRule' => [ - 'summary' => 'Creates or modifies a data export rule.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupCategories'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorGroupCategories', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MonitorGroup', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"9E0347B0-EBC3-4769-A78D-D96F21C6BB52\\",\\n \\"Success\\": true,\\n \\"MonitorGroupCategories\\": {\\n \\"GroupId\\": 123456,\\n \\"MonitorGroupCategory\\": {\\n \\"CategoryItem\\": [\\n {\\n \\"Count\\": 1,\\n \\"Category\\": \\"ecs\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'DescribeMonitorGroupDynamicRules' => [ + 'summary' => 'Queries the dynamic rules of an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the rule.'."\n" - ."\n" - .'> If the specified rule exists, the existing rule is modified. Otherwise, a rule is created.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'MyRuleName', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'> For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cpu_total', - ], - ], - [ - 'name' => 'TargetWindows', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time window of the exported data. Unit: seconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* Separate multiple time windows with commas (,).'."\n" - ."\n" - .'* Data in a time window of less than 60 seconds cannot be exported.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '60,300', - ], - ], - [ - 'name' => 'Describe', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the data export rule.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Export CPU metrics'."\n", - ], - ], - [ - 'name' => 'DstNames', + 'name' => 'GroupId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The destination to which the data is exported. Valid values of N: 1 to 20.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'example' => 'distName1', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2170B94A-1576-4D65-900E-2093037CDAF3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Resource' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The resources that are associated with the application group.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Category' => ['description' => 'The type of the cloud service to which the dynamic rule belongs. Valid values:'."\n" + ."\n" + .'- ecs: Elastic Compute Service (ECS)'."\n" + ."\n" + .'- rds: ApsaraDB RDS'."\n" + ."\n" + .'- slb: Server Load Balancer (SLB)', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'FilterRelation' => ['description' => 'The filter condition. Valid values:'."\n" + ."\n" + .'- and: queries the instances that meet all alert rules.'."\n" + ."\n" + .'- or: queries the instances that meet any alert rule.', 'type' => 'string', 'example' => 'and', 'title' => ''], + 'Filters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Filter' => [ + 'description' => 'The dynamic rules of the application group.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The value of the dynamic rule.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Function' => ['description' => 'The method that is used to filter the instances. Valid values:'."\n" + ."\n" + .'- contains: contains'."\n" + ."\n" + .'- startWith: starts with a prefix'."\n" + ."\n" + .'- endWith: ends with a suffix', 'type' => 'string', 'example' => 'contains', 'title' => ''], + 'Name' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'hostName', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'PutExporterRule', + 'title' => 'DescribeMonitorGroupDynamicRules', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeAlertHistoryList' => [ - 'summary' => 'Queries historical alerts.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupDynamicRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorGroupDynamicRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"2170B94A-1576-4D65-900E-2093037CDAF3\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"Resource\\": [\\n {\\n \\"Category\\": \\"ecs\\",\\n \\"FilterRelation\\": \\"and\\",\\n \\"Filters\\": {\\n \\"Filter\\": [\\n {\\n \\"Value\\": \\"1\\",\\n \\"Function\\": \\"contains\\",\\n \\"Name\\": \\"hostName\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeMonitorGroupInstanceAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****', - ], - ], - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'For information about how to query the name of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Rule', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For information about how to query the namespace of a cloud service, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n" - ."\n" - .'For information about how to query the name of a metric, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], - ], - [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7671****', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether alerts are muted. Valid values:'."\n" - ."\n" - .'* 2 (default value): Alerts are muted and are not triggered within the mute period, even if the condition specified in the alert rule is met.'."\n" - .'* 0: Alerts are triggered or cleared.'."\n" - .'* 1: The alert rule is ineffective.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Valid values: 1 to 1000000000.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'State', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the alert. Valid values:'."\n" - ."\n" - .'* ALARM (default value): Alerts are triggered.'."\n" - .'* OK: No alerts are triggered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALARM', - ], - ], - [ - 'name' => 'Ascending', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The order of alerts. Valid values:'."\n" - ."\n" - .'* true (default value): reverse chronological order'."\n" - .'* false: chronological order'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Valid values: 1 to 1000000000.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Total', 'in' => 'query', - 'schema' => [ - 'description' => 'The start timestamp of the historical alerts that you want to query.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1640237400000', - ], + 'schema' => ['description' => 'Specifies whether to return the total number of resources in the specified application group. Valid values:'."\n" + ."\n" + .'- true (default)'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'The end timestamp of the historical alerts that you want to query.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1640608200000', - ], + 'schema' => ['description' => 'The abbreviation of the cloud service name.'."\n" + ."\n" + .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~2513265~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The keyword that is used to search for resources.', 'type' => 'string', 'required' => false, 'example' => 'portal', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The resource ID. Separate multiple resource IDs with commas (,). You can query the details about a maximum of 20 resources at a time.', 'type' => 'string', 'required' => false, 'example' => 'i-m5e0k0bexac8tykr****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C3C69FBE-2262-541F-A409-C52F380BAE63', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AlarmHistoryList' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9FB8EA79-7279-4482-8D6D-3D28EEDD871A', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'Resources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'AlarmHistory' => [ - 'description' => 'The details of historical alerts.'."\n", + 'Resource' => [ + 'description' => 'The resources that are associated with the application group.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether alerts are muted. Valid values:'."\n" - ."\n" - .'* 2 (default): Alerts are muted and are not triggered within the mute period, even if the condition specified in the alert rule is met.'."\n" - .'* 0: Alerts are triggered or cleared.'."\n" - .'* 1: The alert rule is ineffective.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'EvaluationCount' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'State' => [ - 'description' => 'The alert status. Valid values:'."\n" - ."\n" - .'* ALARM: Alerts are triggered.'."\n" - .'* OK: No alerts are triggered.'."\n", - 'type' => 'string', - 'example' => 'ALARM', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'Webhooks' => [ - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'ECS_Rule', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****', - ], - 'LastTime' => [ - 'description' => 'The duration of the alert. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '360133', - ], - 'Value' => [ - 'description' => 'The threshold of the metric value to trigger or clear an alert.'."\n", - 'type' => 'string', - 'example' => '10.58', - ], - 'Expression' => [ - 'description' => 'The expression that is used to trigger alerts.'."\n", - 'type' => 'string', - 'example' => '$Average>=10', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '7671****', - ], - 'AlertTime' => [ - 'description' => 'The timestamp when the alert was triggered. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1640586600000', - ], - 'InstanceName' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'i-bp1cqhiw1za2****', - ], - 'Dimensions' => [ - 'description' => 'The resources that are monitored.'."\n", - 'type' => 'string', - 'example' => '{\\"instanceId\\":\\"i-bp1cqhiw1za2****\\"}', - ], - 'Level' => [ - 'description' => 'The severity level and notification methods of the alert. Valid values:'."\n" - ."\n" - .'* P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'string', - 'example' => 'P4', - ], - 'Contacts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Contact' => [ - 'description' => 'The alert contacts that receive alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert contact that receives alert notifications.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - ], - ], - ], - 'ContactALIIMs' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactALIIM' => [ - 'description' => 'The TradeManager IDs of the alert contacts.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The TradeManager ID of the alert contact.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => 'username@example.com', - ], - ], - ], - ], - 'ContactMails' => [ + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'hostName', 'title' => ''], + 'Dimension' => ['description' => 'The dimensions of the resource that is associated with the application group.', 'type' => 'string', 'example' => '{"instanceId":"i-m5e0k0bexac8tykr****"}', 'title' => ''], + 'Category' => ['description' => 'The name of the cloud service.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-m5e0k0bexac8tykr****', 'title' => ''], + 'NetworkType' => ['description' => 'The network type.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'Desc' => ['description' => 'The resource description.', 'type' => 'string', 'example' => 'desc_test', 'title' => ''], + 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ContactMail' => [ - 'description' => 'The email addresses of the alert contacts.'."\n", + 'Tag' => [ + 'description' => 'The tag of the resource.', 'type' => 'array', 'items' => [ - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'username@example.com', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'instanceNetworkType', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'ContactSmses' => [ + 'Region' => [ + 'description' => 'The region.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'ContactSms' => [ - 'description' => 'The mobile numbers of the alert contacts.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The mobile number of the alert contact.'."\n" - ."\n" - .'> This parameter is valid only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '13900009999', - ], - ], + 'AvailabilityZone' => ['description' => 'The zone.', 'type' => 'string', 'example' => 'cn-hangzhou-f', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'ContactGroups' => [ + 'Vpc' => [ + 'description' => 'The VPC description.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'ContactGroup' => [ - 'description' => 'The alert contact groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - ], + 'VswitchInstanceId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-2ze36seq79n992****', 'title' => ''], + 'VpcInstanceId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-2zew7etgiceg21****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError ', - 'errorMessage' => 'The request processing has failed due to some unknown error. ', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - ], - 'staticInfo' => [ - 'substitutions' => [ - 'Cms::2019-01-01::DescribeAlertLogList', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"C3C69FBE-2262-541F-A409-C52F380BAE63\\",\\n \\"Total\\": \\"2\\",\\n \\"Success\\": true,\\n \\"AlarmHistoryList\\": {\\n \\"AlarmHistory\\": [\\n {\\n \\"Status\\": 2,\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EvaluationCount\\": 3,\\n \\"State\\": \\"ALARM\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Webhooks\\": \\"https://www.aliyun.com\\",\\n \\"RuleName\\": \\"ECS_Rule\\",\\n \\"RuleId\\": \\"applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****\\",\\n \\"LastTime\\": 360133,\\n \\"Value\\": \\"10.58\\",\\n \\"Expression\\": \\"$Average>=10\\",\\n \\"GroupId\\": \\"7671****\\",\\n \\"AlertTime\\": 1640586600000,\\n \\"InstanceName\\": \\"i-bp1cqhiw1za2****\\",\\n \\"Dimensions\\": \\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp1cqhiw1za2****\\\\\\\\\\\\\\"}\\",\\n \\"Level\\": \\"P4\\",\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n \\"Alice\\"\\n ]\\n },\\n \\"ContactALIIMs\\": {\\n \\"ContactALIIM\\": [\\n \\"username@example.com\\"\\n ]\\n },\\n \\"ContactMails\\": {\\n \\"ContactMail\\": [\\n \\"username@example.com\\"\\n ]\\n },\\n \\"ContactSmses\\": {\\n \\"ContactSms\\": [\\n \\"13900009999\\"\\n ]\\n },\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"ECS_Group\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAlertHistoryListResponse>\\r\\n\\t<AlarmHistoryList>\\r\\n\\t\\t<AlarmHistory>\\r\\n\\t\\t\\t<Status>2</Status>\\r\\n\\t\\t\\t<ContactGroups>\\r\\n\\t\\t\\t\\t<ContactGroup>ECS_Group</ContactGroup>\\r\\n\\t\\t\\t</ContactGroups>\\r\\n\\t\\t\\t<RuleId>applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****</RuleId>\\r\\n\\t\\t\\t<Dimensions>{\\\\\\"instanceId\\\\\\":\\\\\\"i-bp1cqhiw1za2****\\\\\\"}</Dimensions>\\r\\n\\t\\t\\t<EvaluationCount>3</EvaluationCount>\\r\\n\\t\\t\\t<ContactMails></ContactMails>\\r\\n\\t\\t\\t<ContactSmses></ContactSmses>\\r\\n\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t<AlertTime>1640586600000</AlertTime>\\r\\n\\t\\t\\t<GroupId>7671****</GroupId>\\r\\n\\t\\t\\t<InstanceName>i-bp1cqhiw1za2****</InstanceName>\\r\\n\\t\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t\\t<Contacts></Contacts>\\r\\n\\t\\t\\t<Expression>$Average>=10</Expression>\\r\\n\\t\\t\\t<State>ALARM</State>\\r\\n\\t\\t\\t<Value>10.58</Value>\\r\\n\\t\\t\\t<Level>P4</Level>\\r\\n\\t\\t\\t<PreLevel>P4</PreLevel>\\r\\n\\t\\t\\t<LastTime>360133</LastTime>\\r\\n\\t\\t\\t<RuleName>ECS_Rule</RuleName>\\r\\n\\t\\t\\t<ContactALIIMs></ContactALIIMs>\\r\\n\\t\\t</AlarmHistory>\\r\\n\\t\\t<AlarmHistory>\\r\\n\\t\\t\\t<Status>0</Status>\\r\\n\\t\\t\\t<ContactGroups>\\r\\n\\t\\t\\t\\t<ContactGroup>ECS_Group</ContactGroup>\\r\\n\\t\\t\\t</ContactGroups>\\r\\n\\t\\t\\t<RuleId>applyTemplate61dc81b5-d357-4cf6-a9b7-9f83****</RuleId>\\r\\n\\t\\t\\t<Dimensions>{\\\\\\"instanceId\\\\\\":\\\\\\"i-bp1cqhiw1za2807s****\\\\\\"}</Dimensions>\\r\\n\\t\\t\\t<EvaluationCount>3</EvaluationCount>\\r\\n\\t\\t\\t<ContactMails></ContactMails>\\r\\n\\t\\t\\t<ContactSmses></ContactSmses>\\r\\n\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t<AlertTime>1640586540000</AlertTime>\\r\\n\\t\\t\\t<GroupId>7671****</GroupId>\\r\\n\\t\\t\\t<InstanceName>i-bp1cqhiw1za2807s****</InstanceName>\\r\\n\\t\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t\\t<Contacts></Contacts>\\r\\n\\t\\t\\t<Expression>$Average>=10</Expression>\\r\\n\\t\\t\\t<State>ALARM</State>\\r\\n\\t\\t\\t<Value>10.13</Value>\\r\\n\\t\\t\\t<Level>P4</Level>\\r\\n\\t\\t\\t<LastTime>300085</LastTime>\\r\\n\\t\\t\\t<RuleName>ECS_Rule</RuleName>\\r\\n\\t\\t\\t<ContactALIIMs>\\r\\n\\t\\t\\t\\t<ContactALIIM>\\\\\\"username@example.com\\\\\\"</ContactALIIM>\\r\\n\\t\\t\\t</ContactALIIMs>\\r\\n\\t\\t</AlarmHistory>\\r\\n\\t</AlarmHistoryList>\\r\\n\\t<RequestId>C3C69FBE-2262-541F-A409-C52F380BAE63</RequestId>\\r\\n\\t<Total>2</Total>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeAlertHistoryListResponse>\\t","errorExample":""}]', - 'title' => 'DescribeAlertHistoryList', - 'description' => 'This API operation is no longer maintained. We recommend that you call the [DescribeAlertLogList](~~201087~~) operation.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeMonitorGroupInstanceAttribute', + 'summary' => 'Queries the resources in an application group.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeAlertLogCount' => [ - 'summary' => 'Queries the statistics of alert logs.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupInstanceAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorGroupInstanceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MonitorGroupInstances', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FB8EA79-7279-4482-8D6D-3D28EEDD871A\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"Total\\": 12,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"InstanceName\\": \\"hostName\\",\\n \\"Dimension\\": \\"{\\\\\\"instanceId\\\\\\":\\\\\\"i-m5e0k0bexac8tykr****\\\\\\"}\\",\\n \\"Category\\": \\"ecs\\",\\n \\"InstanceId\\": \\"i-m5e0k0bexac8tykr****\\",\\n \\"NetworkType\\": \\"vpc\\",\\n \\"Desc\\": \\"desc_test\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"instanceNetworkType\\",\\n \\"Value\\": \\"VPC\\"\\n }\\n ]\\n },\\n \\"Region\\": {\\n \\"AvailabilityZone\\": \\"cn-hangzhou-f\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n },\\n \\"Vpc\\": {\\n \\"VswitchInstanceId\\": \\"vsw-2ze36seq79n992****\\",\\n \\"VpcInstanceId\\": \\"vpc-2zew7etgiceg21****\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeMonitorGroupInstances' => [ + 'summary' => 'Queries the resources in an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The start timestamp of the alert logs to be queried.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'You can query only the alert logs within the last year. If the query time is longer than one year, the return value of the `AlertLogCount` parameter is empty.'."\n" - ."\n" - .'> The interval between the start time (StartTime) and end time (EndTime) must be less than or equal to 15 days. The start time and end time must be specified or left empty at the same time. If you do not specify the start time and end time, the alert logs within the last 15 minutes are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1609988009694', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end timestamp of the alert logs to be queried.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'You can query only the alert logs within the last year. If the query time is longer than one year, the return value of the `AlertLogCount` parameter is empty.'."\n" - ."\n" - .'> The interval between the start time (StartTime) and end time (EndTime) must be less than or equal to 15 days. The start time and end time must be specified or left empty at the same time. If you do not specify the start time and end time, the alert logs within the last 15 minutes are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1610074409694', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL. Valid values:'."\n" - ."\n" - .'* `product`: aggregates data by cloud service.'."\n" - .'* `level`: aggregates data by alert level.'."\n" - .'* `groupId`: aggregates data by application group.'."\n" - .'* `contactGroup`: aggregates data by alert contact group.'."\n" - .'* `product,metricName`: aggregates data both by cloud service and by metric.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123****', 'title' => ''], ], [ - 'name' => 'SearchKey', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword based on which the alert logs to be counted are searched.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The abbreviation of the cloud service name. Valid values of N: 1 to 200.'."\n" + ."\n" + .'> For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'> For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The keyword used to search for instances. Fuzzy search based on instance names is supported.', 'type' => 'string', 'required' => false, 'example' => 'test-s1', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7301****', - ], + 'schema' => ['description' => 'The instance ID. You can query multiple instances by specifying multiple IDs.', 'type' => 'string', 'required' => false, 'example' => 'i-bp12g4xbl4i0brkn****', 'title' => ''], ], - [ - 'name' => 'Product', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The abbreviation of the service name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '97F2A410-9412-499C-9AD1-76EF7EC02DF2', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The information about the resources in the application group.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Category' => ['description' => 'The abbreviation of the service name.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-bp12g4xbl4i0brkn****', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'test-s1', 'title' => ''], + 'Id' => ['description' => 'The resource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123****', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Level', - 'in' => 'query', - 'schema' => [ - 'description' => 'The level and notification method of the alert. Valid values:'."\n" - ."\n" - .'* P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'P4', - ], + ], + 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], [ - 'name' => 'SendStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the alert. Valid values:'."\n" - ."\n" - .'* 0: The alert is triggered or cleared.'."\n" - .'* 1: The alert is generated not during the effective period.'."\n" - .'* 2: The alert is muted and not triggered in a specified period.'."\n" - .'* 3: The host is restarting.'."\n" - .'* 4: Notifications are not sent for the alert.'."\n" - ."\n" - .'When the value of the SendStatus parameter is 0, the value P4 of the Level parameter indicates a triggered alert and the value OK indicates a cleared alert.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - 'name' => 'ContactGroup', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Group', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], ], [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'> For more information about the metrics of different cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DescribeMonitorGroupInstances', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupInstances'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorGroupInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"97F2A410-9412-499C-9AD1-76EF7EC02DF2\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Category\\": \\"ecs\\",\\n \\"InstanceId\\": \\"i-bp12g4xbl4i0brkn****\\",\\n \\"InstanceName\\": \\"test-s1\\",\\n \\"Id\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeMonitorGroupNotifyPolicyList' => [ + 'summary' => 'Queries the list of alert notification pause policies for an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'LastMin', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of alert logs. Unit: minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '360', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'GroupBy', + 'name' => 'PolicyType', 'in' => 'query', 'schema' => [ - 'description' => 'The dimension based on which data is aggregated. This parameter is similar to the Group By clause of SQL statements. Valid values:'."\n" + 'description' => 'The type of the pause notification policy.'."\n" ."\n" - .'* `product`: aggregates data by cloud service.'."\n" - .'* `level`: aggregates data by alert level.'."\n" - .'* `groupId`: aggregates data by application group.'."\n" - .'* `contactGroup`: aggregates data by alert group.'."\n" - .'* `product,metricName`: aggregates data both by cloud service and by metric.'."\n", + .'Currently, only PauseNotify is supported.', 'type' => 'string', 'required' => true, - 'example' => 'product', + 'enum' => ['PauseNotify'], + 'example' => 'PauseNotify', + 'title' => '', ], ], [ - 'name' => 'SourceType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'None'."\n", - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'EventType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the alert event. Valid values:'."\n" - ."\n" - .'* TRIGGERED: The alert is triggered.'."\n" - .'* RESOLVED: The alert is resolved.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TRIGGERED', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'RuleId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'For more information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bfae2ca5b4e07d2c7278772e***********', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '6780****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AlertLogCount' => [ - 'description' => 'The statistics of alert logs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Count' => [ - 'description' => 'The number of alert logs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Logs' => [ - 'description' => 'The details about alert logs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the dimension field based on which alert logs are aggregated.'."\n", - 'type' => 'string', - 'example' => 'product', - ], - 'Value' => [ - 'description' => 'The value of the dimension field based on which alert logs are aggregated.'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6072F026-C441-41A6-B114-35A1E8F8FDD3', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'NotifyPolicyList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NotifyPolicy' => [ + 'description' => 'The list of pause notification policies.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end timestamp.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1551761781273', 'title' => ''], + 'Type' => ['description' => 'The disable type.', 'type' => 'string', 'example' => 'PauseNotify', 'title' => ''], + 'StartTime' => ['description' => 'The start timestamp.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1551761781273', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '6780****', 'title' => ''], + 'Id' => ['description' => 'The ID of the pause notification policy.', 'type' => 'string', 'example' => '123****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Parameter invalid.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error. ', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"1C4A3709-BF52-42EE-87B5-7435F0929585\\",\\n \\"Success\\": true,\\n \\"AlertLogCount\\": [\\n {\\n \\"Count\\": 1,\\n \\"Logs\\": [\\n {\\n \\"Name\\": \\"product\\",\\n \\"Value\\": \\"ECS\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAlertLogCountResponse>\\r\\n\\t<RequestId>0BA67F6D-B699-4E3F-B205-93A5C38A0A2E</RequestId>\\r\\n\\t<AlertLogCount>\\r\\n\\t\\t<Count>1</Count>\\r\\n\\t\\t<Logs>\\r\\n\\t\\t\\t<Value>ECS</Value>\\r\\n\\t\\t\\t<Name>product</Name>\\r\\n\\t\\t</Logs>\\r\\n\\t</AlertLogCount>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeAlertLogCountResponse>\\t","errorExample":""}]', - 'title' => 'DescribeAlertLogCount', - 'description' => 'Queries the statistics of alert logs.'."\n" - ."\n" - .'This topic provides an example on how to query the statistics of alert logs for Elastic Compute Service (ECS) based on the `product` dimension.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Query alert notification pause policies for an application group', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeAlertLogList' => [ - 'summary' => 'Queries alert logs.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupNotifyPolicyList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorGroupNotifyPolicyList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"6072F026-C441-41A6-B114-35A1E8F8FDD3\\",\\n \\"Total\\": 11,\\n \\"Success\\": \\"true\\",\\n \\"NotifyPolicyList\\": {\\n \\"NotifyPolicy\\": [\\n {\\n \\"EndTime\\": 1551761781273,\\n \\"Type\\": \\"PauseNotify\\",\\n \\"StartTime\\": 1551761781273,\\n \\"GroupId\\": \\"6780****\\",\\n \\"Id\\": \\"123****\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeMonitorGroups' => [ + 'summary' => 'You can call the DescribeMonitorGroups operation to query a list of application groups.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start timestamp of the alert logs to be queried.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'You can query only the alert logs within the last year. If the query time is longer than one year, the return value of the `AlertLogList` parameter is empty.'."\n" - ."\n" - .'> The time period between the start time specified by `StartTime` and the end time specified by `EndTime` must be less than or equal to 15 days. You must specify StartTime and EndTime at the same time, or leave StartTime and EndTime empty at the same time. If you do not specify this parameter, the alert logs within the last 15 minutes are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1609988009694', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'SelectContactGroups', 'in' => 'query', - 'schema' => [ - 'description' => 'The end timestamp of the alert logs to be queried.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'You can query only the alert logs within the last year. If the query time is longer than one year, the return value of the `AlertLogList` parameter is empty.'."\n" - ."\n" - .'> The time period between the start time specified by `StartTime` and end time specified by `EndTime` must be less than or equal to 15 days. You must specify StartTime and EndTime at the same time, or leave StartTime and EndTime empty at the same time. If you do not specify this parameter, the alert logs within the last 15 minutes are queried by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1610074409694', - ], + 'schema' => ['description' => 'Specifies whether to include alert contact groups in the response. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Pages start from page 1. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'SearchKey', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The search keyword that is used to query alert logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alert', - ], + 'schema' => ['description' => 'The keyword for the search.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7301****', - ], + 'schema' => ['description' => 'The ID of the instance. This parameter is used to query the application group to which the specified instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'i-abcdefgh12****', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'> For information about how to query the namespace of a cloud service, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => false, 'example' => 'testGroup124', 'title' => ''], ], [ - 'name' => 'Product', + 'name' => 'IncludeTemplateHistory', 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the service name.'."\n" - ."\n" - .'For information about how to obtain the abbreviation of a cloud service name, see [DescribeProductsOfActiveMetricRule](~~114930~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], + 'schema' => ['description' => 'Specifies whether to include the history of alert templates that are applied to the application group in the response. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Level', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The severity level and notification methods of the alert. Valid values:'."\n" + 'description' => 'The type of the application group. Valid values:'."\n" ."\n" - .'* P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'P4', - ], - ], - [ - 'name' => 'SendStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the alert. Valid values:'."\n" + .'- custom: a custom application group.'."\n" ."\n" - .'* 0: The alert is triggered or cleared.'."\n" - .'* 1: The alert is ineffective.'."\n" - .'* 2: The alert is muted.'."\n" - .'* 3: The host is restarting.'."\n" - .'* 4: No alert notification is sent.'."\n" + .'- ehpc\\_cluster: an application group that is synchronized from an E-HPC cluster.'."\n" ."\n" - .'If the value of the SendStatus parameter is 0, the value P4 of the Level parameter indicates a triggered alert and the value OK indicates a cleared alert.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'ContactGroup', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert contact group.'."\n", + .'- kubernetes: an application group that is synchronized from a Container Service for Kubernetes (ACK) cluster.', 'type' => 'string', 'required' => false, - 'example' => 'ECS_Group', + 'enum' => ['custom', 'ehpc_cluster', 'kubernetes', 'tag', 'aone_group', 'resMgr', 'ess'], + 'example' => 'custom', + 'title' => '', ], ], [ - 'name' => 'RuleName', + 'name' => 'DynamicTagRuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], + 'schema' => ['description' => 'The ID of the dynamic tag rule.', 'type' => 'string', 'required' => false, 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', 'title' => ''], ], [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'> For more information about the metrics of different cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IntranetInRate', - ], - ], - [ - 'name' => 'LastMin', + 'name' => 'GroupFounderTagKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of alert logs. Unit: minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '360', - ], + 'schema' => ['description' => 'The tag key of the application group that is created using a dynamic tag rule.', 'type' => 'string', 'required' => false, 'example' => 'GroupKey1', 'title' => ''], ], [ - 'name' => 'GroupBy', + 'name' => 'GroupFounderTagValue', 'in' => 'query', - 'schema' => [ - 'description' => 'The dimensions based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL. Valid values:'."\n" - ."\n" - .'* `product`: aggregates data by cloud service.'."\n" - .'* `level`: aggregates data by alert level.'."\n" - .'* `groupId`: aggregates data by application group.'."\n" - .'* `contactGroup`: aggregates data by alert contact group.'."\n" - .'* `product,metricName`: aggregates data both by cloud service and by metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'product', - ], + 'schema' => ['description' => 'The tag value of the application group that is created using a dynamic tag rule.', 'type' => 'string', 'required' => false, 'example' => 'GroupValue1', 'title' => ''], ], [ - 'name' => 'RuleId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bc369e8_30f87e517ed2fc****', - ], + 'schema' => ['description' => 'The IDs of the application groups. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '92****', 'title' => ''], ], [ - 'name' => 'SourceType', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the alert rule. Valid value: METRIC. This value indicates an alert rule for time series metrics.'."\n", - 'type' => 'string', + 'description' => 'The tags of the application group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tags of the application group.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of tag N. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'tagKey1', 'title' => ''], + 'Value' => ['description' => 'The value of tag N. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'tagValue1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'METRIC', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EventType', + 'name' => 'Types', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the alert event. Valid values:'."\n" - ."\n" - .'* TRIGGERED: The alert is triggered.'."\n" - .'* RESOLVED: The alert is resolved.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TRIGGERED', - ], + 'schema' => ['description' => 'The type of the application group. Valid values:'."\n" + ."\n" + .'- custom: a custom application group.'."\n" + ."\n" + .'- ehpc\\_cluster: an application group that is synchronized from an E-HPC cluster.'."\n" + ."\n" + .'- kubernetes: an application group that is synchronized from a Container Service for Kubernetes (ACK) cluster.'."\n" + ."\n" + .'- tag: an application group that is automatically created based on tags.'."\n" + ."\n" + .'- resMgr: an application group that is created based on a resource group.'."\n" + ."\n" + .'- ess: an application group that is synchronized from Auto Scaling (ESS).', 'type' => 'string', 'required' => false, 'example' => 'custom', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'AlertLogList' => [ - 'description' => 'The queried alert logs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'EventName' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'example' => 'IOHang', - ], - 'Product' => [ - 'description' => 'The identifier of the cloud service. Valid values:'."\n" - ."\n" - .'* If the cloud service is provided by Alibaba Cloud, the abbreviation of the service name is returned. Example: ECS.'."\n" - .'* If the cloud service is not provided by Alibaba Cloud, a value in the `acs_Service keyword` format is returned. Example: acs_networkmonitor.'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], - 'BlackListUUID' => [ - 'description' => 'The ID of the blacklist policy.'."\n", - 'type' => 'string', - 'example' => '8410dbbd-7d30-41c5-94cb-*****', - ], - 'Message' => [ - 'description' => 'The alert information in a JSON string.'."\n", - 'type' => 'string', - 'example' => '{"alertName":"e47aa0ac-4076-44db-a47d-d1083968****_Availability"}', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'LevelChange' => [ - 'description' => 'Indicates whether the alert level was changed. Valid values:'."\n" - ."\n" - .'* `P4->OK`: The alert level was changed from P4 to OK.'."\n" - .'* `P4->P4`: The alert level was still P4.'."\n", - 'type' => 'string', - 'example' => 'P4->OK', - ], - 'InstanceId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'i-m5e1qg6uo38rztr4****', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'd582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime', - ], - 'BlackListName' => [ - 'description' => 'The name of the blacklist policy.'."\n", - 'type' => 'string', - 'example' => '{"id":123,"metricProject":"acs_ecs_dashboard","userId":1736511134389110,"uuid":"8410dbbd-7d30-41c5-94cb-***","name":"alert-***","productCategory":"ecs","instances":[{"instanceId":"host-***"}],"metrics":null,"scopeType":"USER","scopeValue":"","startTime":"0001-01-01T00:00:00Z","endTime":"9999-12-31T23:59:59.999999999+08:00","effectiveTime":null,"isEnable":true,"status":1,"gmtCreate":"2021-11-02T16:35:59+08:00","gmtModified":"2021-11-02T16:35:59+08:00","loadTime":"2021-11-02T16:36:15.213072177+08:00"}', - ], - 'GroupName' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Instances', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '7301****', - ], - 'AlertTime' => [ - 'description' => 'The timestamp that was generated when the alert was triggered.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1610043776621', - ], - 'InstanceName' => [ - 'description' => 'The resource name.'."\n", - 'type' => 'string', - 'example' => 'portalHost', - ], - 'BlackListDetail' => [ - 'description' => 'The details of the blacklist policy.'."\n", - 'type' => 'string', - 'example' => 'BlackListDetail', - ], - 'Level' => [ - 'description' => 'The alert level and the methods that are used to send alert notifications. Valid values:'."\n" - ."\n" - .'* P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'string', - 'example' => 'P4', - ], - 'SendStatus' => [ - 'description' => 'The status of the alert. Valid values:'."\n" - ."\n" - .'* 0: The alert is triggered or cleared.'."\n" - .'* 1: The alert is ineffective.'."\n" - .'* 2: The alert is muted.'."\n" - .'* 3: The host is restarting.'."\n" - .'* 4: No alert notification is sent.'."\n" - ."\n" - .'If the value of the SendStatus parameter is 0, the value P4 of the Level parameter indicates a triggered alert and the value OK indicates a cleared alert.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ExtendedInfo' => [ - 'description' => 'The extended fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the extended field.'."\n", - 'type' => 'string', - 'example' => 'userId', - ], - 'Value' => [ - 'description' => 'The value of the extended field.'."\n", - 'type' => 'string', - 'example' => '120886317861****', - ], - ], - ], - ], - 'Dimensions' => [ - 'description' => 'The dimensions of the resource that triggered alerts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the dimension.'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], - 'Value' => [ - 'description' => 'The value of the dimension.'."\n", - 'type' => 'string', - 'example' => 'i-m5e1qg6uo38rztr4****', - ], - ], - ], - ], - 'WebhookList' => [ - 'description' => 'The callback URLs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'description' => 'The status code of the alert callback.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'url' => [ - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com/webhook.html', - ], - 'message' => [ - 'description' => 'The message returned for the alert callback.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], - ], - 'DingdingWebhookList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The webhook URL of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****', - ], - 'description' => '', - ], - 'ContactOnCallList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The phone number of the alert contact that receives alert phone calls.'."\n" + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F02B299A-D374-4595-9F55-7534D604F132', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the operation was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'The resources that are associated with the monitor group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the linked instance.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the application group. Valid values:'."\n" ."\n" - .'> This parameter applies only to the Alibaba Cloud China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '1368888****', - ], - 'description' => '', - ], - 'ContactMailList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'description' => '', - ], - 'ContactGroups' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - 'description' => '', - ], - 'ContactALIIWWList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The TradeManager ID of the alert contact.'."\n" + .'- custom: a custom application group.'."\n" ."\n" - .'> This parameter applies only to the Alibaba Cloud China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'description' => '', - ], - 'ContactSMSList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The phone number of the alert contact that receives alert text messages.'."\n" + .'- ehpc\\_cluster: an application group that is synchronized from an E-HPC cluster.'."\n" ."\n" - .'> This parameter applies only to the Alibaba Cloud China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '1368888****', - ], - 'description' => '', - ], - 'ContactDingList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The DingTalk chatbot of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - 'description' => '', - ], - 'SendDetail' => [ - 'description' => 'The details about the sending results of alert notifications.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResultCode' => [ - 'description' => 'Indicates whether the alert notifications are sent.'."\n" - ."\n" - .'* If the alert notifications are sent, the value "success" is returned.'."\n" - .'* If the configuration is invalid, no alert notification is sent and an error code is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ChannelResultList' => [ - 'description' => 'The list of sending results that are categorized by notification method.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Channel' => [ - 'description' => 'The method that is used to send alert notifications. Valid values:'."\n" - ."\n" - .'* MAIL: email'."\n" - .'* SMS: text message'."\n" - .'* WEBHOOK: alert callback'."\n" - .'* SLS: Simple Log Service'."\n" - .'* ONCALL: phone call'."\n" - .'* FC: Function Compute'."\n" - .'* MNS: Message Service queue'."\n", - 'type' => 'string', - 'example' => 'MAIL', - ], - 'ResultList' => [ - 'description' => 'The sending results of alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'* If the value of the `Channel` parameter is `WEBHOOK`, the status code is 200 or 500.'."\n" - .'* If the value of the `Channel` parameter is `MAIL`, `SMS`, `SLS`, `ONCALL`, `FC`, or `MNS`, this parameter is empty or not returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID returned when CloudMonitor calls another cloud service.'."\n", - 'type' => 'string', - 'example' => '0BDAF8A8-04DC-5F0C-90E4-724D42C4****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Detail' => [ - 'description' => 'The details of the returned results.'."\n", - 'type' => 'string', - 'example' => '{ }', - ], - 'notifyTargetList' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'The list of notification methods.'."\n", - 'type' => 'string', - 'example' => '1270676********', - ], - 'description' => '', - ], - ], - 'description' => '', + .'- kubernetes: an application group that is synchronized from a Container Service for Kubernetes (ACK) cluster.', 'type' => 'string', 'example' => 'custom', 'title' => ''], + 'GroupFounderTagValue' => ['description' => 'The tag value of the application group that is created using a dynamic tag rule.', 'type' => 'string', 'example' => 'GroupValue1', 'title' => ''], + 'BindUrl' => ['description' => 'The URL that is synchronized from the ACK cluster.', 'type' => 'string', 'example' => 'https://aliyun.com', 'title' => ''], + 'GroupName' => ['description' => 'The name of the application group.', 'type' => 'string', 'example' => 'test123', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'ServiceId' => ['description' => 'The ID of the Alibaba Cloud service.', 'type' => 'string', 'example' => '49****', 'title' => ''], + 'DynamicTagRuleId' => ['description' => 'The ID of the dynamic tag rule.', 'type' => 'string', 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', 'title' => ''], + 'GmtCreate' => ['description' => 'The timestamp when the application group was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1603181891000', 'title' => ''], + 'GroupFounderTagKey' => ['description' => 'The tag key of the application group that is created using a dynamic tag rule.', 'type' => 'string', 'example' => 'GroupKey1', 'title' => ''], + 'GmtModified' => ['description' => 'The timestamp when the application group was modified. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1603181891000', 'title' => ''], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => 'The alert contact groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'An alert contact group.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'description' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - ], - 'Escalation' => [ - 'description' => 'The alert rule based on which the alert is triggered.'."\n", - 'type' => 'object', - 'properties' => [ - 'Expression' => [ - 'description' => 'The description of the alert rule.'."\n" - ."\n" - .'> The content of the alert rule. This parameter indicates the conditions that trigger an alert.'."\n", - 'type' => 'string', - 'example' => '$Average<90', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Level' => [ - 'description' => 'The alert level and the methods that are used to send alert notifications. Valid values:'."\n" - ."\n" - .'* P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'string', - 'example' => 'P4', + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags that are attached to the application group.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag that is attached to the application group.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key of the application group.', 'type' => 'string', 'example' => 'tagKey1', 'title' => ''], + 'Value' => ['description' => 'The tag value of the application group.', 'type' => 'string', 'example' => 'tagValue1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - ], - 'SendResultList' => [ - 'description' => 'The sending results of alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The category of the alert notification method. Valid values:'."\n" - ."\n" - .'* MAIL: email'."\n" - .'* ALIIM: TradeManager'."\n" - .'* SMS: text message'."\n" - .'* CALL: phone call'."\n" - .'* DING: DingTalk chatbot'."\n" - .'* Merged: alert merging'."\n", - 'type' => 'string', - 'example' => 'Mail', + 'TemplateIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateId' => [ + 'description' => 'The IDs of the alert templates.', + 'type' => 'array', + 'items' => ['description' => 'The alert template applied to the application group.', 'type' => 'string', 'example' => '92****', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'Value' => [ - 'description' => 'The notification object corresponding to the alert notification method.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The notification object corresponding to the alert notification method.'."\n", - 'type' => 'string', - 'example' => 'username@example.com', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-aek2hopjh*******', 'title' => ''], + 'TemplateInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EffectTime' => ['description' => 'The effective period.', 'type' => 'integer', 'format' => 'int64', 'example' => '1603181891000', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the alert template.', 'type' => 'string', 'example' => '123***', 'title' => ''], + 'Ver' => ['description' => 'The version of the alert template.', 'type' => 'string', 'example' => '0', 'title' => ''], + ], + 'description' => 'The information about an alert template.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The information about the alert templates.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'LogId' => [ - 'description' => 'The log ID.'."\n", - 'type' => 'string', - 'example' => '7818361[1523]@1671593992[1]', - ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Parameter invalid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1C4A3709-BF52-42EE-87B5-7435F0929585\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"AlertLogList\\": [\\n {\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EventName\\": \\"IOHang\\",\\n \\"Product\\": \\"ECS\\",\\n \\"BlackListUUID\\": \\"8410dbbd-7d30-41c5-94cb-****\\",\\n \\"Message\\": \\"{\\\\\\"alertName\\\\\\":\\\\\\"e47aa0ac-4076-44db-a47d-d1083968****_Availability\\\\\\"}\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"LevelChange\\": \\"P4->OK\\",\\n \\"InstanceId\\": \\"i-m5e1qg6uo38rztr4****\\",\\n \\"RuleName\\": \\"CPU使用率\\",\\n \\"RuleId\\": \\"d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime\\",\\n \\"BlackListName\\": \\"Black_Test\\",\\n \\"GroupName\\": \\"ECS_Instances\\",\\n \\"GroupId\\": \\"7301****\\",\\n \\"AlertTime\\": \\"1610043776621\\",\\n \\"InstanceName\\": \\"portalHost\\",\\n \\"BlackListDetail\\": \\"{\\\\\\"id\\\\\\":12****,\\\\\\"metricProject\\\\\\":\\\\\\"acs_ecs_dashboard\\\\\\",\\\\\\"userId\\\\\\":173651113438****,\\\\\\"uuid\\\\\\":\\\\\\"8410dbbd-7d30-41c5-94cb-****\\\\\\",\\\\\\"name\\\\\\":\\\\\\"alert-****\\\\\\",\\\\\\"productCategory\\\\\\":\\\\\\"ecs\\\\\\",\\\\\\"instances\\\\\\":[{\\\\\\"instanceId\\\\\\":\\\\\\"i-m5e1qg6uo38rztr4****\\\\\\"}],\\\\\\"metrics\\\\\\":null,\\\\\\"scopeType\\\\\\":\\\\\\"USER\\\\\\",\\\\\\"scopeValue\\\\\\":\\\\\\"\\\\\\",\\\\\\"startTime\\\\\\":\\\\\\"0001-01-01T00:00:00Z\\\\\\",\\\\\\"endTime\\\\\\":\\\\\\"9999-12-31T23:59:59.999999999+08:00\\\\\\",\\\\\\"effectiveTime\\\\\\":null,\\\\\\"isEnable\\\\\\":true,\\\\\\"status\\\\\\":1,\\\\\\"gmtCreate\\\\\\":\\\\\\"2021-11-02T16:35:59+08:00\\\\\\",\\\\\\"gmtModified\\\\\\":\\\\\\"2021-11-02T16:35:59+08:00\\\\\\",\\\\\\"loadTime\\\\\\":\\\\\\"2021-11-02T16:36:15.213072177+08:00\\\\\\"}\\",\\n \\"Level\\": \\"P4\\",\\n \\"SendStatus\\": \\"0\\",\\n \\"ExtendedInfo\\": [\\n {\\n \\"Name\\": \\"userId\\",\\n \\"Value\\": \\"100931896542****\\"\\n }\\n ],\\n \\"Dimensions\\": [\\n {\\n \\"Key\\": \\"instanceId\\",\\n \\"Value\\": \\"i-m5e1qg6uo38rztr4****\\"\\n }\\n ],\\n \\"WebhookList\\": [\\n {\\n \\"code\\": \\"200\\",\\n \\"url\\": \\"https://www.aliyun.com/webhook.html\\",\\n \\"message\\": \\"success\\"\\n }\\n ],\\n \\"DingdingWebhookList\\": [\\n \\"https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****\\"\\n ],\\n \\"ContactOnCallList\\": [\\n \\"1368888****\\"\\n ],\\n \\"ContactMailList\\": [\\n \\"username@example.com\\"\\n ],\\n \\"ContactGroups\\": [\\n \\"ECS_Group\\"\\n ],\\n \\"ContactALIIWWList\\": [\\n \\"Alice\\"\\n ],\\n \\"ContactSMSList\\": [\\n \\"1368888****\\"\\n ],\\n \\"ContactDingList\\": [\\n \\"CloudMonitor\\"\\n ],\\n \\"SendDetail\\": {\\n \\"ResultCode\\": \\"success\\",\\n \\"ChannelResultList\\": [\\n {\\n \\"Channel\\": \\"MAIL\\",\\n \\"ResultList\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0BDAF8A8-04DC-5F0C-90E4-724D42C4****\\",\\n \\"Success\\": true,\\n \\"Detail\\": \\"{ }\\",\\n \\"notifyTargetList\\": [\\n \\"MAIL\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"Escalation\\": {\\n \\"Expression\\": \\"$Average<90\\",\\n \\"Times\\": 1,\\n \\"Level\\": \\"P4\\"\\n },\\n \\"SendResultList\\": [\\n {\\n \\"Key\\": \\"MAIL\\",\\n \\"Value\\": [\\n \\"username@example.com\\"\\n ]\\n }\\n ],\\n \\"LogId\\": \\"7510****::e8a472a0-46ae-4ac0-84b1-e46be368****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAlertLogListResponse>\\r\\n\\t<AlertLogList>\\r\\n\\t\\t<GroupName></GroupName>\\r\\n\\t\\t<Message>{\\\\\\"alertName\\\\\\":\\\\\\"d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime\\\\\\",\\\\\\"curLevel\\\\\\":\\\\\\"OK\\\\\\",\\\\\\"dimensions\\\\\\":{\\\\\\"taskId\\\\\\":\\\\\\"d582b9e9-b1c1-4f17-9279-0fe7333a****\\\\\\",\\\\\\"userId\\\\\\":\\\\\\"127067667954****\\\\\\"},\\\\\\"escalation\\\\\\":{\\\\\\"expression\\\\\\":\\\\\\"$Average>=800\\\\\\",\\\\\\"level\\\\\\":P4,\\\\\\"tag\\\\\\":\\\\\\"P4\\\\\\",\\\\\\"times\\\\\\":1}</Message>\\r\\n\\t\\t<RuleId>d582b9e9-b1c1-4f17-9279-0fe7****_ResponseTime</RuleId>\\r\\n\\t\\t<Escalation>\\r\\n\\t\\t\\t<Expression>$Average>=800</Expression>\\r\\n\\t\\t\\t<Times>1</Times>\\r\\n\\t\\t\\t<Level>P4</Level>\\r\\n\\t\\t</Escalation>\\r\\n\\t\\t<SendStatus>0</SendStatus>\\r\\n\\t\\t<Product>acs_ecs_dashboard</Product>\\r\\n\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t<RuleName>CPU使用率</RuleName>\\r\\n\\t\\t<ContactGroups>ECS_Group</ContactGroups>\\r\\n\\t\\t<InstanceId></InstanceId>\\r\\n\\t\\t<LevelChange>P4->OK</LevelChange>\\r\\n\\t\\t<Dimensions>\\r\\n\\t\\t\\t<Value>100931896542****</Value>\\r\\n\\t\\t\\t<Key>userId</Key>\\r\\n\\t\\t</Dimensions>\\r\\n\\t\\t<Dimensions>\\r\\n\\t\\t\\t<Value>i-abcdefgh12****</Value>\\r\\n\\t\\t\\t<Key>instanceId</Key>\\r\\n\\t\\t</Dimensions>\\r\\n\\t\\t<EventName>AlertOk</EventName>\\r\\n\\t\\t<ExtendedInfo>\\r\\n\\t\\t\\t<Value>i-hp34y1eiszazu49y****</Value>\\r\\n\\t\\t\\t<Name>instanceId</Name>\\r\\n\\t\\t</ExtendedInfo>\\r\\n\\t\\t<ExtendedInfo>\\r\\n\\t\\t\\t<Value>12706****</Value>\\r\\n\\t\\t\\t<Name>userId</Name>\\r\\n\\t\\t</ExtendedInfo>\\r\\n\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t<AlertTime>1610085521564</AlertTime>\\r\\n\\t\\t<GroupId>7301****</GroupId>\\r\\n\\t\\t<InstanceName>portalHost</InstanceName>\\r\\n\\t\\t<Level>OK</Level>\\r\\n\\t</AlertLogList>\\r\\n\\t<RequestId>6FCB1AB7-57F7-4DDA-B14E-6468FAFE79D9</RequestId>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeAlertLogListResponse>\\t","errorExample":""}]', - 'title' => 'DescribeAlertLogList', - 'description' => 'You can call the operation to query only the alert logs within the last year.'."\n" - ."\n" - .'This topic provides an example to show how to query the alert logs of Elastic Compute Service (ECS) based on the `product` dimension.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeMonitorGroups', + 'description' => 'This topic provides an example of how to query a list of application groups. The response shows that two application groups are returned: `testGroup124` and `test123`.', + 'requestParamsDescription' => 'For more information about common parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeAlertLogHistogram' => [ - 'summary' => 'Queries the number of alert logs that are generated during each interval within a period of time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-01-10T03:06:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-14T08:13:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-21T09:50:30.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroups'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F02B299A-D374-4595-9F55-7534D604F132\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Total\\": 10,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Type\\": \\"custom\\",\\n \\"GroupFounderTagValue\\": \\"GroupValue1\\",\\n \\"BindUrl\\": \\"https://aliyun.com\\",\\n \\"GroupName\\": \\"test123\\",\\n \\"GroupId\\": 12345,\\n \\"ServiceId\\": \\"49****\\",\\n \\"DynamicTagRuleId\\": \\"6b882d9a-5117-42e2-9d0c-4749a0c6****\\",\\n \\"GmtCreate\\": 1603181891000,\\n \\"GroupFounderTagKey\\": \\"GroupKey1\\",\\n \\"GmtModified\\": 1603181891000,\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Name\\": \\"CloudMonitor\\"\\n }\\n ]\\n },\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tagKey1\\",\\n \\"Value\\": \\"tagValue1\\"\\n }\\n ]\\n },\\n \\"TemplateIds\\": {\\n \\"TemplateId\\": [\\n \\"92****\\"\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-aek2hopjh*******\\",\\n \\"TemplateInfos\\": {\\n \\"TemplateInfo\\": [\\n {\\n \\"EffectTime\\": 1603181891000,\\n \\"TemplateId\\": \\"123***\\",\\n \\"Ver\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeMonitorResourceQuotaAttribute' => [ + 'summary' => 'Queries the quotas of various CloudMonitor resources.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'ShowUsed', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the response includes used quotas. Valid values:'."\n" + .'- true (default): Included.'."\n" + .'- false: Not included.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The start timestamp of the alert logs to be queried.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can query only the alert logs within the last year.'."\n" - ."\n" - .'* The interval between the start time (`StartTime`) and end time (`EndTime`) must be less than or equal to 15 days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1609988009694', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '31BC7201-00F2-47B2-B7B9-6A173076ACE', 'title' => ''], + 'ResourceQuota' => [ + 'description' => 'The quota details of CloudMonitor.', + 'type' => 'object', + 'properties' => [ + 'SuitInfo' => ['description' => 'The current edition of CloudMonitor. Valid values:'."\n" + .'- free: Free Edition.'."\n" + .'- pro: Pro Edition.'."\n" + .'- cms_post: pay-as-you-go.', 'type' => 'string', 'example' => 'pro', 'title' => ''], + 'InstanceId' => ['description' => 'The subscription plan ID.', 'type' => 'string', 'example' => 'cms_edition-cn-n6w20rn****', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time of the plan.', 'type' => 'string', 'example' => '2021-02-28', 'title' => ''], + 'SiteMonitorEcsProbe' => [ + 'description' => 'The quota for site monitoring ECS detection points.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for site monitoring ECS detection points.'."\n" + ."\n" + .'> The maximum number of ECS detection points that can be selected for a single site monitoring task.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for site monitoring ECS detection points included in the plan.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for site monitoring ECS detection points in the plan.'."\n" + ."\n" + .'> The total number of ECS detection points across all site monitoring tasks that have been created.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SiteMonitorOperatorProbe' => [ + 'description' => 'The quota for site monitoring carrier detection points.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for site monitoring carrier detection points.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for site monitoring carrier detection points included in the plan.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for site monitoring carrier detection points in the plan.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SiteMonitorTask' => [ + 'description' => 'The quota for site monitoring tasks.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for site monitoring tasks. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for site monitoring tasks included in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for site monitoring tasks in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SiteMonitorBrowser' => [ + 'description' => 'The quota for browser-based monitoring tasks.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for browser-based monitoring tasks. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for browser-based monitoring tasks included in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for browser-based monitoring tasks in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SiteMonitorMobile' => [ + 'description' => 'The quota for mobile monitoring tasks.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for mobile monitoring tasks. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for mobile monitoring tasks included in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for mobile monitoring tasks in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'CustomMonitor' => [ + 'description' => 'The quota for custom monitoring.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for custom monitoring time series. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1200', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for custom monitoring time series included in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for custom monitoring time series in the plan. Unit: count.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'EventMonitor' => [ + 'description' => 'The quota for event monitoring.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for event monitoring. Unit: 10,000.', 'type' => 'integer', 'format' => 'int32', 'example' => '55', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for event monitoring included in the plan. Unit: 10,000.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for event monitoring in the plan. Unit: 10,000.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'LogMonitor' => [ + 'description' => 'The quota for Log Monitoring.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for Log Monitoring. Unit: MB/min.', 'type' => 'integer', 'format' => 'int32', 'example' => '150', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for Log Monitoring included in the plan. Unit: MB/min.', 'type' => 'integer', 'format' => 'int32', 'example' => '150', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for Log Monitoring in the plan. Unit: MB/min.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Api' => [ + 'description' => 'The API quota.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total API quota. Unit: 10,000 calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'QuotaPackage' => ['description' => 'The API quota included in the plan. Unit: 10,000 calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used API quota in the plan. Unit: calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '9987', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SMS' => [ + 'description' => 'The quota for alert text message packages.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for alert text messages. Unit: messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '550', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for alert text message packages. Unit: messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for alert text message packages. Unit: messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '38', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Phone' => [ + 'description' => 'The quota for alert phone call packages.', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => ['description' => 'The total quota for alert phone calls. Unit: calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '550', 'title' => ''], + 'QuotaPackage' => ['description' => 'The quota for alert phone call packages. Unit: calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'QuotaUsed' => ['description' => 'The used quota for alert phone call packages. Unit: calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'EnterpriseQuota' => [ + 'description' => 'The quota details of Hybrid Cloud Monitoring.', + 'type' => 'object', + 'properties' => [ + 'SuitInfo' => ['description' => 'The description of Hybrid Cloud Monitoring.', 'type' => 'string', 'example' => 'ENTERPRISE', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID of Hybrid Cloud Monitoring.', 'type' => 'string', 'example' => 'cms_enterprise_public_cn-7mz27pd****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end timestamp of the alert logs to be queried.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* You can query only the alert logs within the last year.'."\n" - ."\n" - .'* The interval between the start time (`StartTime`) and end time (`EndTime`) must be less than or equal to 15 days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1609989009694', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], + ], + 'title' => 'Query cloudMonitor resource quotas', + 'requestParamsDescription' => ' For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-07T08:33:21.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorResourceQuotaAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitorResourceQuotaAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"31BC7201-00F2-47B2-B7B9-6A173076ACE\\",\\n \\"ResourceQuota\\": {\\n \\"SuitInfo\\": \\"pro\\",\\n \\"InstanceId\\": \\"cms_edition-cn-n6w20rn****\\",\\n \\"ExpireTime\\": \\"2021-02-28\\",\\n \\"SiteMonitorEcsProbe\\": {\\n \\"QuotaLimit\\": 5,\\n \\"QuotaPackage\\": 5,\\n \\"QuotaUsed\\": 20\\n },\\n \\"SiteMonitorOperatorProbe\\": {\\n \\"QuotaLimit\\": 5,\\n \\"QuotaPackage\\": 5,\\n \\"QuotaUsed\\": 0\\n },\\n \\"SiteMonitorTask\\": {\\n \\"QuotaLimit\\": 25,\\n \\"QuotaPackage\\": 20,\\n \\"QuotaUsed\\": 15\\n },\\n \\"SiteMonitorBrowser\\": {\\n \\"QuotaLimit\\": 50,\\n \\"QuotaPackage\\": 50,\\n \\"QuotaUsed\\": 15\\n },\\n \\"SiteMonitorMobile\\": {\\n \\"QuotaLimit\\": 50,\\n \\"QuotaPackage\\": 50,\\n \\"QuotaUsed\\": 15\\n },\\n \\"CustomMonitor\\": {\\n \\"QuotaLimit\\": 1200,\\n \\"QuotaPackage\\": 1000,\\n \\"QuotaUsed\\": 8\\n },\\n \\"EventMonitor\\": {\\n \\"QuotaLimit\\": 55,\\n \\"QuotaPackage\\": 50,\\n \\"QuotaUsed\\": 2\\n },\\n \\"LogMonitor\\": {\\n \\"QuotaLimit\\": 150,\\n \\"QuotaPackage\\": 150,\\n \\"QuotaUsed\\": 80\\n },\\n \\"Api\\": {\\n \\"QuotaLimit\\": 500,\\n \\"QuotaPackage\\": 500,\\n \\"QuotaUsed\\": 9987\\n },\\n \\"SMS\\": {\\n \\"QuotaLimit\\": 550,\\n \\"QuotaPackage\\": 500,\\n \\"QuotaUsed\\": 38\\n },\\n \\"Phone\\": {\\n \\"QuotaLimit\\": 550,\\n \\"QuotaPackage\\": 500,\\n \\"QuotaUsed\\": 100\\n },\\n \\"EnterpriseQuota\\": {\\n \\"SuitInfo\\": \\"ENTERPRISE\\",\\n \\"InstanceId\\": \\"cms_enterprise_public_cn-7mz27pd****\\"\\n }\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeMonitoringAgentAccessKey' => [ + 'summary' => 'Queries the AccessKey ID and AccessKey secret that are required to install the CloudMonitor agent on a third-party host.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'type' => 'object', + 'properties' => [ + 'AccessKey' => ['description' => 'The AccessKey ID that is required to install the agent.', 'type' => 'string', 'example' => 'E7A27f9****', 'title' => ''], + 'SecretKey' => ['description' => 'The AccessKey secret that is required to install the agent.', 'type' => 'string', 'example' => 'sBjNOUhLylrxMX-Xv1****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C0F655E9-D793-51E6-BD78-CABBCCFC1047', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'SearchKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used to query alert logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alert', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DescribeMonitoringAgentAccessKey', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentAccessKey'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitoringAgentAccessKey', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessKey\\": \\"E7A27f9****\\",\\n \\"SecretKey\\": \\"sBjNOUhLylrxMX-Xv1****\\",\\n \\"RequestId\\": \\"C0F655E9-D793-51E6-BD78-CABBCCFC1047\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\"\\n}","type":"json"}]', + ], + 'DescribeMonitoringAgentConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GroupId', - 'in' => 'query', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7301****', + 'type' => 'object', + 'properties' => [ + 'EnableActiveAlert' => ['description' => 'The cloud services for which proactive alerting is enabled.', 'type' => 'string', 'example' => 'redis,rds,ecs', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E9F4FA2A-54BE-4EF9-9D1D-1A0B1DC86B8D', 'title' => ''], + 'AutoInstall' => ['description' => 'Indicates whether the CloudMonitor agent is automatically installed on existing Elastic Compute Service (ECS) instances. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EnableInstallAgentNewECS' => ['description' => 'Indicates whether the CloudMonitor agent is automatically installed on newly purchased ECS instances. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Product', - 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the Alibaba Cloud service name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DescribeMonitoringAgentConfig', + 'summary' => 'Queries the configurations of the CloudMonitor agent.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentConfig'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitoringAgentConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EnableActiveAlert\\": \\"redis,rds,ecs\\",\\n \\"RequestId\\": \\"E9F4FA2A-54BE-4EF9-9D1D-1A0B1DC86B8D\\",\\n \\"AutoInstall\\": true,\\n \\"Success\\": true,\\n \\"EnableInstallAgentNewECS\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\"\\n}","type":"json"}]', + ], + 'DescribeMonitoringAgentHosts' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the Alibaba Cloud service.'."\n" - ."\n" - .'> For more information about the namespaces of different cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'Level', + 'name' => 'KeyWord', 'in' => 'query', - 'schema' => [ - 'description' => 'The severity level and notification methods of the alert. Valid values:'."\n" - ."\n" - .'* P4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'P4', - ], + 'schema' => ['description' => 'The keyword for a fuzzy search.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'host1'], ], [ - 'name' => 'SendStatus', + 'name' => 'HostName', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert status. Valid values:'."\n" - ."\n" - .'* 0: The alert is triggered or cleared.'."\n" - .'* 1: The alert is ineffective.'."\n" - .'* 2: The alert is muted and not triggered in a specified period.'."\n" - .'* 3: The host is restarting.'."\n" - .'* 4: No alert notification is sent.'."\n" - ."\n" - .'If the value of the SendStatus parameter is 0, the value P4 of the Level parameter indicates a triggered alert and the value OK indicates a cleared alert.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The hostname.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'hostNam1'], ], [ - 'name' => 'ContactGroup', + 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Group', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'i-a3d1q1pm2f9yr29e****'], ], [ - 'name' => 'RuleName', + 'name' => 'SerialNumbers', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], + 'schema' => ['description' => 'The serial number of the host.'."\n" + ."\n" + .'A globally unique serial number is generated after the CloudMonitor agent is successfully installed on a host. Hosts that are not Alibaba Cloud instances do not have an instance ID, but have a serial number.'."\n" + ."\n" + .'> Use this parameter to find a specific monitored host.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'a1ab31a3-1234-40f2-9e95-c8caa8f0****'], ], [ - 'name' => 'MetricName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'> For more information about the metrics of different cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'LastMin', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of alert logs. Unit: minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '360', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" + ."\n" + .'- 10'."\n" + ."\n" + .'- 20'."\n" + ."\n" + .'- 50'."\n" + ."\n" + .'- 100'."\n" + ."\n" + .'> Alibaba Cloud does not limit the maximum value of this parameter. However, setting this parameter to a large value may cause a timeout.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], [ - 'name' => 'GroupBy', + 'name' => 'InstanceRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The dimensions based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL. Valid values:'."\n" - ."\n" - .'* `product`: aggregates data by cloud service.'."\n" - .'* `level`: aggregates data by alert level.'."\n" - .'* `groupId`: aggregates data by application group.'."\n" - .'* `contactGroup`: aggregates data by alert contact group.'."\n" - .'* `product,metricName`: aggregates data both by cloud service and by metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'product', - ], + 'schema' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SourceType', + 'name' => 'AliyunHost', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'None'."\n", - ], + 'schema' => ['description' => 'Specifies whether to filter for Alibaba Cloud Elastic Compute Service (ECS) instances. Valid values:'."\n" + ."\n" + .'- true (default): Returns only ECS instances.'."\n" + ."\n" + .'- false: Returns only hosts that are not ECS instances.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], [ - 'name' => 'EventType', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the alert event. Valid values:'."\n" - ."\n" - .'* TRIGGERED: The alert is triggered.'."\n" - .'* RESOLVED: The alert is resolved.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RESOLVED', - ], + 'schema' => ['description' => 'The status of the host. Valid values:'."\n" + ."\n" + .'- Running: The host is running.'."\n" + ."\n" + .'- Stopped: The host is stopped, the agent is not installed, or the agent installation failed.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Running'], ], [ - 'name' => 'RuleId', + 'name' => 'SysomStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'For more information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ae06917_75a8c43178ab66****', - ], + 'schema' => ['description' => 'The status of SysOM. Valid values:'."\n" + ."\n" + .'- installing: SysOM is being enabled.'."\n" + ."\n" + .'- running: SysOM is running.'."\n" + ."\n" + .'- stopped: SysOM is stopped.'."\n" + ."\n" + .'- uninstalling: SysOM is being disabled.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'running'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AlertLogHistogramList' => [ - 'description' => 'The number of alert logs that were generated during each interval of a time period.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'From' => [ - 'description' => 'The start timestamp of the queried alert logs.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1610074791', - ], - 'To' => [ - 'description' => 'The end timestamp of the queried alert logs.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1610074800', - ], - 'Count' => [ - 'description' => 'The number of alert logs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0'], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates a successful response.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The Request is not authorization.'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'PageTotal' => ['description' => 'The number of pages.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '50'], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'Hosts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Host' => [ + 'description' => 'The list of hosts.', + 'type' => 'array', + 'items' => [ + 'description' => 'The host.', + 'type' => 'object', + 'properties' => [ + 'SerialNumber' => ['description' => 'The serial number of the host. Hosts that are not Alibaba Cloud instances do not have an instance ID, but have a serial number.'."\n" + ."\n" + .'> Use this parameter to find a specific monitored host.', 'type' => 'string', 'title' => '', 'example' => 'x12335-6cc8-4a22-9f21-1a00a719****'], + 'NatIp' => ['description' => 'The NAT IP address.', 'type' => 'string', 'title' => '', 'example' => '192.168.XX.XX'], + 'HostName' => ['description' => 'The hostname.', 'type' => 'string', 'title' => '', 'example' => 'hostIP'], + 'AliUid' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '103201326074****'], + 'NetworkType' => ['description' => 'The network type.', 'type' => 'string', 'title' => '', 'example' => 'vpc'], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'i-a2d5q7pm3f9yr212****'], + 'isAliyunHost' => ['description' => 'Indicates whether the host is an Alibaba Cloud instance. Valid values:'."\n" + ."\n" + .'- true: The host is an Alibaba Cloud instance.'."\n" + ."\n" + .'- false: The host is not an Alibaba Cloud instance.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EipAddress' => ['description' => 'The elastic IP address (EIP).', 'type' => 'string', 'title' => '', 'example' => '192.168.XX.XX'], + 'AgentVersion' => ['description' => 'The agent version.', 'type' => 'string', 'title' => '', 'example' => '3.4.6'], + 'IpGroup' => ['description' => 'The IP address of the host.'."\n" + ."\n" + .'> Multiple IP addresses are separated by commas (,).', 'type' => 'string', 'title' => '', 'example' => '192.168.XX.XX'], + 'EipId' => ['description' => 'The ID of the EIP.', 'type' => 'string', 'title' => '', 'example' => 'eip-bp16i16k9gcezyfrp****'], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'InstanceTypeFamily' => ['description' => 'The ECS instance type family.', 'type' => 'string', 'title' => '', 'example' => 'ecs.n4'], + 'OperatingSystem' => ['description' => 'The operating system.', 'type' => 'string', 'title' => '', 'example' => 'Linux'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"1C4A3709-BF52-42EE-87B5-7435F0929585\\",\\n \\"Success\\": true,\\n \\"AlertLogHistogramList\\": [\\n {\\n \\"From\\": 1610074791,\\n \\"To\\": 1610074800,\\n \\"Count\\": 20\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAlertLogHistogramResponse>\\n <Code>200</Code>\\n <Message>The specified resource is not found.</Message>\\n <RequestId>1C4A3709-BF52-42EE-87B5-7435F0929585</RequestId>\\n <Success>true</Success>\\n <AlertLogHistogramList>\\n <From>1610074791</From>\\n <To>1610074800</To>\\n <Count>20</Count>\\n </AlertLogHistogramList>\\n</DescribeAlertLogHistogramResponse>","errorExample":""}]', - 'title' => 'DescribeAlertLogHistogram', - 'description' => 'This topic provides an example on how to query the number of alert logs for Elastic Compute Service (ECS) based on the `product` dimension.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeMonitoringAgentHosts', + 'summary' => 'You can call the DescribeMonitoringAgentHosts operation to query a list of all hosts, regardless of whether the CloudMonitor agent is installed.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeProductsOfActiveMetricRule' => [ - 'summary' => 'Queries the cloud services for which the initiative alert feature is enabled.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-05-25T09:45:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-29T02:45:43.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentHosts'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitoringAgentHosts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageTotal\\": 50,\\n \\"Total\\": 10,\\n \\"Hosts\\": {\\n \\"Host\\": [\\n {\\n \\"SerialNumber\\": \\"x12335-6cc8-4a22-9f21-1a00a719****\\",\\n \\"NatIp\\": \\"192.168.XX.XX\\",\\n \\"HostName\\": \\"hostIP\\",\\n \\"AliUid\\": 0,\\n \\"NetworkType\\": \\"vpc\\",\\n \\"InstanceId\\": \\"i-a2d5q7pm3f9yr212****\\",\\n \\"isAliyunHost\\": true,\\n \\"EipAddress\\": \\"192.168.XX.XX\\",\\n \\"AgentVersion\\": \\"3.4.6\\",\\n \\"IpGroup\\": \\"192.168.XX.XX\\",\\n \\"EipId\\": \\"eip-bp16i16k9gcezyfrp****\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"InstanceTypeFamily\\": \\"ecs.n4\\",\\n \\"OperatingSystem\\": \\"Linux\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeMonitoringAgentProcesses' => [ + 'summary' => 'Call the DescribeMonitoringAgentProcesses operation to query the list of processes for a specified resource.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-hp3hl3cx1pbahzy8****', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', - ], - 'Datapoints' => [ - 'description' => 'The information about the services for which the initiative alert feature is enabled. Services are separated with commas (,). Valid values:'."\n" - ."\n" - .'* ECS: Elastic Compute Service (ECS)'."\n" - .'* rds: ApsaraDB RDS'."\n" - .'* slb: Server Load Balancer (SLB)'."\n" - .'* redis_standard: Redis Open-Source Edition (standard architecture)'."\n" - .'* redis_sharding: Redis Open-Source Edition (cluster architecture)'."\n" - .'* redis_splitrw: Redis Open-Source Edition (read/write splitting architecture)'."\n" - .'* mongodb: ApsaraDB for MongoDB of the replica set architecture'."\n" - .'* mongodb_sharding: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" - .'* hbase: ApsaraDB for HBase'."\n" - .'* elasticsearch: Elasticsearch'."\n" - .'* opensearch: OpenSearch'."\n", - 'type' => 'string', - 'example' => 'ecs,rds', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AllProductInitMetricRuleList' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C11C0E85-6862-4F25-8D66-D6A5E0882984', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'NodeProcesses' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'AllProductInitMetricRule' => [ - 'description' => 'The information about the services for which one-click alert is enabled.'."\n", + 'NodeProcess' => [ + 'description' => 'The information about the processes.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the services for which one-click alert is enabled.', 'type' => 'object', 'properties' => [ - 'Product' => [ - 'description' => 'The abbreviation of the service name.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'AlertInitConfigList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AlertInitConfig' => [ - 'description' => 'The initial alert rules that are generated after one-click alert is enabled for a service.', - 'type' => 'array', - 'items' => [ - 'description' => 'The initial alert rules that are generated after one-click alert is enabled for a service.', - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'EvaluationCount' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Namespace' => [ - 'description' => 'The namespace of the service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'acs_rds_dashboard', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The method used to calculate metric values that trigger alerts. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - 'Period' => [ - 'description' => 'The aggregation period of monitoring data. Unit: minutes. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => '1m', - ], - 'Level' => [ - 'description' => 'The alert level.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* INFO'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* WARN'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* CRITICAL'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'INFO' => '', - 'WARN' => '', - 'CRITICAL' => '', - ], - 'example' => 'CRITICAL', - ], - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* LessThanThreshold: less than the threshold'."\n" - ."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - ."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - ."\n" - .'* NotEqualToThreshold: does not equal to the threshold'."\n" - ."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - ."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - ."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - ."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - ."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - ."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle', - 'type' => 'string', - 'enumValueTitles' => [ - 'LessThanThreshold' => '', - 'GreaterThanLastWeek' => '', - 'LessThanOrEqualToThreshold' => '', - 'NotEqualToThreshold' => '', - 'GreaterThanLastPeriod' => '', - 'GreaterThanYesterday' => '', - 'LessThanYesterday' => '', - 'LessThanLastWeek' => '', - 'GreaterThanOrEqualToThreshold' => '', - 'GreaterThanThreshold' => '', - 'LessThanLastPeriod' => '', - ], - 'example' => 'GreaterThanOrEqualToThreshold', - ], - ], - ], - ], - ], - ], + 'ProcessName' => ['description' => 'The name of the process.', 'type' => 'string', 'example' => 'java', 'title' => ''], + 'ProcessId' => ['description' => 'The ID of the process.', 'type' => 'integer', 'format' => 'int64', 'example' => '4550102', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '239708487', 'title' => ''], + 'Command' => ['description' => 'The command.', 'type' => 'string', 'example' => '/bin/sh', 'title' => ''], + 'ProcessUser' => ['description' => 'The user that runs the process.', 'type' => 'string', 'example' => 'admin', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'host-gdsmvinvmh6fu', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is not valid.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'The Request is not authorization.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'DescribeMonitoringAgentProcesses', + 'description' => '> Before you call this operation, you must call the CreateMonitoringAgentProcess operation to create a process monitoring task. For more information, see [CreateMonitoringAgentProcess](~~2513212~~).'."\n" + ."\n" + .'This topic provides an example of how to query the list of processes for the resource i-hp3hl3cx1pbahzy8\\*\\*\\*\\*. The response shows the details of the Nginx and HTTP processes.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentProcesses'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitoringAgentProcesses', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"F82E6667-7811-4BA0-842F-5B2DC42BBAAD\\",\\n \\"Datapoints\\": \\"ecs,rds\\",\\n \\"Success\\": true,\\n \\"AllProductInitMetricRuleList\\": {\\n \\"AllProductInitMetricRule\\": [\\n {\\n \\"Product\\": \\"ecs\\",\\n \\"AlertInitConfigList\\": {\\n \\"AlertInitConfig\\": [\\n {\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EvaluationCount\\": \\"3\\",\\n \\"Namespace\\": \\"acs_rds_dashboard\\",\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Period\\": \\"1m\\",\\n \\"Level\\": \\"CRITICAL\\",\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeProductsOfActiveMetricRuleResponse>\\r\\n\\t\\t<RequestId>A4FFAEFF-4225-4EF6-8F63-FAAA8F58289D</RequestId>\\r\\n\\t\\t<AllProductInitMetricRuleList>\\r\\n\\t\\t\\t<AllProductInitMetricRule>\\r\\n\\t\\t\\t\\t<AlertInitConfigList>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>CPUUtilization</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>1m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>95</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>vm.DiskUtilization</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>1m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>95</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>vm.MemoryUtilization</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>1m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>95</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>InternetOutRate_Percent</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>1m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>95</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t</AlertInitConfigList>\\r\\n\\t\\t\\t\\t<Product>ecs</Product>\\r\\n\\t\\t\\t</AllProductInitMetricRule>\\r\\n\\t\\t\\t<AllProductInitMetricRule>\\r\\n\\t\\t\\t\\t<AlertInitConfigList>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>CpuUsage</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>5m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>DiskUsage</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>5m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>IOPSUsage</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>5m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>ConnectionUsage</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>5m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>DataDelay</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>5m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>5</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t</AlertInitConfigList>\\r\\n\\t\\t\\t\\t<Product>rds</Product>\\r\\n\\t\\t\\t</AllProductInitMetricRule>\\r\\n\\t\\t\\t<AllProductInitMetricRule>\\r\\n\\t\\t\\t\\t<AlertInitConfigList>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>DocSizeRatiobyApp</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>1</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>10m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Maximum</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_opensearch</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>85</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>lossqpsbyapp</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>1</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>10m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Maximum</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_opensearch</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>0</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>ComputeResourceRatiobyApp</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>1</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>10m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Maximum</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_opensearch</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>85</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>app_realtime_write_latency</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>1</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>20m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Maximum</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_opensearch</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>1800000</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t</AlertInitConfigList>\\r\\n\\t\\t\\t\\t<Product>opensearch</Product>\\r\\n\\t\\t\\t</AllProductInitMetricRule>\\r\\n\\t\\t</AllProductInitMetricRuleList>\\r\\n\\t\\t<Datapoints>rds,redis_standard</Datapoints>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeProductsOfActiveMetricRuleResponse>","errorExample":""}]', - 'title' => 'DescribeProductsOfActiveMetricRule', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"C11C0E85-6862-4F25-8D66-D6A5E0882984\\",\\n \\"Success\\": true,\\n \\"NodeProcesses\\": {\\n \\"NodeProcess\\": [\\n {\\n \\"ProcessName\\": \\"java\\",\\n \\"ProcessId\\": 4550102,\\n \\"GroupId\\": \\"239708487\\",\\n \\"Command\\": \\"/bin/sh\\",\\n \\"ProcessUser\\": \\"admin\\",\\n \\"InstanceId\\": \\"host-gdsmvinvmh6fu\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'extraInfo' => ' ', ], - 'DescribeActiveMetricRuleList' => [ - 'summary' => 'Queries the details of initiative alert rules.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeMonitoringAgentStatuses' => [ + 'summary' => 'Queries the running status of the CloudMonitor agent by calling the DescribeMonitoringAgentStatuses operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Product', + 'name' => 'InstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the cloud service that supports initiative alert rules.'."\n" - ."\n" - .'For more information about how to obtain the name of a cloud service, see [DescribeProductsOfActiveMetricRule](~~114930~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The instance IDs. Separate multiple instance IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'i-hp3dunahluwajv6f****', 'title' => ''], + ], + [ + 'name' => 'HostAvailabilityTaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the availability monitoring task.'."\n", 'type' => 'string', 'required' => false, 'example' => '126****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Datapoints' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'NodeStatusList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Alarm' => [ - 'description' => 'The details of the alert rules.'."\n", + 'NodeStatus' => [ + 'description' => 'The host status information.'."\n", 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'SilenceTime' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '86400', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'EvaluationCount' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Webhook' => [ - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'example' => 'http://www.aliyun.com', - ], - 'State' => [ - 'description' => 'Indicates whether the alert rule is enabled.'."\n", - 'type' => 'string', - 'example' => 'Enable', - ], - 'ContactGroups' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'SystemDefault_acs_rds_dashboard_CpuUsage', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', - ], - 'Period' => [ - 'description' => 'The aggregation period of monitoring data.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '60', - ], - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used in the alert rule. Valid values:'."\n" - ."\n" - .'* `>`'."\n" - .'* `<`'."\n" - .'* `>=`'."\n" - .'* `<=`'."\n" - .'* `=`'."\n" - .'* `=`'."\n", - 'type' => 'string', - 'example' => '>', - ], - 'EndTime' => [ - 'description' => 'The end of the time period during which the alert rule is effective.'."\n" - ."\n" - .'Unit: hours. For example, the value 23 indicates `23:59:59`.'."\n", - 'type' => 'string', - 'example' => '24', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time period during which the alert rule is effective.'."\n" - ."\n" - .'Unit: hours. For example, the value 00 indicates `00:00:00`.'."\n", - 'type' => 'string', - 'example' => '00', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical method.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - 'Enable' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'* true: The alert rule is enabled.'."\n" - .'* false: The alert rule is disabled.'."\n", + 'Status' => ['description' => 'The status of the CloudMonitor agent. Valid values:'."\n" + ."\n" + .'* running: The CloudMonitor agent is running.'."\n" + .'* stopped: The CloudMonitor agent is stopped.'."\n" + .'* installing: The CloudMonitor agent is being installed.'."\n" + .'* install_faild: The CloudMonitor agent fails to be installed.'."\n" + .'* abnormal: The CloudMonitor agent is not properly installed.'."\n" + .'* not_installed: The CloudMonitor agent is not installed.'."\n", 'type' => 'string', 'example' => 'running', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'i-hp3dunahluwajv6f****', 'title' => ''], + 'AutoInstall' => ['description' => 'Indicates whether the CloudMonitor agent is automatically installed. Valid values:'."\n" + ."\n" + .'* true: The CloudMonitor agent is automatically installed.'."\n" + .'* false: The CloudMonitor agent is not automatically installed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'OsMonitorStatus' => ['description' => 'The status of SysOM. Valid values:'."\n" + ."\n" + .'* installing: SysOM is being installed.'."\n" + .'* running: SysOM is running.'."\n" + .'* stopped: SysOM is stopped.'."\n" + .'* uninstalling: SysOM is being uninstalled.'."\n", 'type' => 'string', 'example' => 'running', 'title' => ''], + 'OsMonitorErrorCode' => ['description' => 'The error status of SysOM. Valid values:'."\n" + ."\n" + .'* `install_fail`: SysOM fails to be installed or an unknown error occurs.'."\n" + .'* `install_assist_invalid`: SysOM fails to be installed because the status of Cloud Assistant is invalid.'."\n" + .'* `install_assist_command_fail`: SysOM fails to be installed because the installation command fails to run.'."\n" + .'* `uninstall_fail`: SysOM fails to be uninstalled or an unknown error occurs.'."\n" + .'* `uninstall_assist_invalid`: SysOM fails to be uninstalled because the status of Cloud Assistant is invalid.'."\n" + .'* `uninstall_assist_command_fail`: SysOM fails to be uninstalled because the uninstallation command fails to run.'."\n", 'type' => 'string', 'example' => 'install_fail', 'title' => ''], + 'OsMonitorErrorDetail' => ['description' => 'The details of the execution error. Valid values:'."\n" + ."\n" + .'* `Command.ErrorCode.Fail.Downlaod.REGIN_ID`: Failed to obtain the region ID.'."\n" + .'* `Command.ErrorCode.Fail.Downlaod.SYSAK`: Failed to download the .rpm package of System Analyse Kit (SysAK).'."\n" + .'* `Command.ErrorCode.Fail.Downlaod.CMON_FILE`: Failed to download the CMON file.'."\n" + .'* `Command.ErrorCode.Fail.Downlaod.BTF`: Failed to start SysAK because the BTF file is not found.'."\n" + .'* `Command.ErrorCode.Fail.Start.SYSAK`: Failed to start SysAK due to an unknown error.'."\n", 'type' => 'string', 'example' => 'Command.ErrorCode.Fail.Downlaod.REGIN_ID', 'title' => ''], + 'OsMonitorVersion' => ['description' => 'The SysOM version.'."\n", 'type' => 'string', 'example' => '1.3.0-12', 'title' => ''], + 'OsMonitorConfig' => ['description' => 'Indicates whether the SysAK monitoring feature is enabled.`` Valid values:'."\n" + ."\n" + .'* `true`: The SysAK monitoring feature is enabled.'."\n" + .'* `false`: the SysAK monitoring feature is disabled.'."\n", 'type' => 'string', 'example' => '{"sysak":true}', 'title' => ''], + 'AgentInstallErrorCode' => ['description' => 'The error code returned when the CloudMonitor agent is installed. Valid values:'."\n" + .'- Common.Timeout: The installation timed out.'."\n" + .'- Common.SLR: The service-linked role for CloudMonitor is unauthorized.'."\n" + .'- Common.OS: The operating system is not supported.'."\n" + .'- Assist.Invalid: Cloud Assistant is not running.'."\n" + .'- Assist.Invoke: An error occurred when the installation program is started.'."\n" + .'- Assist.Execute: An error occurred when the installation program is running.', 'type' => 'string', 'example' => 'Assist.Invalid', 'title' => ''], + 'LoongCollectorVersion' => ['description' => 'LoongCollector Version', 'type' => 'string', 'example' => '0.1.0', 'title' => ''], + 'LoongCollectorStatus' => [ + 'description' => 'LoongCollector Status', + 'enumValueTitles' => ['running' => 'Normal', 'stopped' => 'Stopped'], 'type' => 'string', - 'example' => 'true', + 'example' => 'running', + 'title' => '', ], ], - ], - ], - ], - ], - 'AlertList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Alert' => [ - 'description' => 'The details of the alert rules. The result is in the same structure as that returned by the DescribeMetricRuleList operation.'."\n", - 'type' => 'array', - 'items' => [ 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SilenceTime' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '86400', - ], - 'MetricName' => [ - 'description' => 'The name of the metric.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'Webhook' => [ - 'description' => 'The callback URL.'."\n", - 'type' => 'string', - 'example' => 'http://www.aliyun.com', - ], - 'ContactGroups' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - 'Namespace' => [ - 'description' => 'The namespace of the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is effective.'."\n", - 'type' => 'string', - 'example' => '00:00-23:59', - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is ineffective.'."\n", - 'type' => 'string', - 'example' => '00:00-06:00', - ], - 'MailSubject' => [ - 'description' => 'The subject of the alert notification email.'."\n", - 'type' => 'string', - 'example' => 'ECS_Bucket', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'myAlert', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'ruleIdxxxx', - ], - 'Period' => [ - 'description' => 'The aggregation period of monitoring data.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '60', - ], - 'AlertState' => [ - 'description' => 'The status of the alert rule. Valid values:'."\n" - ."\n" - .'* OK: The alert rule has no active alerts.'."\n" - .'* ALARM: The alert rule has active alerts.'."\n" - .'* INSUFFICIENT_DATA: No data is found.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Dimensions' => [ - 'description' => 'The monitoring data of the specified resource.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'EnableState' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'* true: The alert rule is enabled.'."\n" - .'* false: The alert rule is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resources' => [ - 'description' => 'The resources that are associated with the alert rule.'."\n", - 'type' => 'string', - 'example' => '[{"resource":"_ALL"}]', - ], - 'Escalations' => [ - 'description' => 'The conditions for triggering different levels of alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Info' => [ - 'description' => 'The conditions for triggering Info-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanThreshold', - ], - 'Times' => [ - 'description' => 'The consecutive number of times'."\n" - ."\n" - .'for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Info-level alerts.'."\n", - 'type' => 'string', - 'example' => '95', - ], - 'Statistics' => [ - 'description' => 'The statistical methods for Info-level alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - 'Warn' => [ - 'description' => 'The conditions for triggering Warn-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanThreshold', - ], - 'Times' => [ - 'description' => 'The consecutive number of times'."\n" - ."\n" - .'for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n", - 'type' => 'string', - 'example' => '80', - ], - 'Statistics' => [ - 'description' => 'The statistical methods for Warn-level alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - 'Critical' => [ - 'description' => 'The trigger condition for Critical-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanThreshold', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n", - 'type' => 'string', - 'example' => '99', - ], - 'Statistics' => [ - 'description' => 'The statistical methods for Critical-level alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - ], - ], - ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - '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.', 'description' => 'The specified resource is not found.'], ], - [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"F82E6667-7811-4BA0-842F-5B2DC42BBAAD\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": {\\n \\"Alarm\\": [\\n {\\n \\"SilenceTime\\": \\"86400\\",\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EvaluationCount\\": \\"3\\",\\n \\"Webhook\\": \\"https://www.aliyun.com\\",\\n \\"State\\": \\"Enable\\",\\n \\"ContactGroups\\": \\"ECS_Group\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"RuleName\\": \\"SystemDefault_acs_rds_dashboard_CpuUsage\\",\\n \\"RuleId\\": \\"a151cd6023eacee2f0978e03863cc1697c89508****\\",\\n \\"Period\\": \\"60\\",\\n \\"ComparisonOperator\\": \\">\\",\\n \\"EndTime\\": \\"24\\",\\n \\"StartTime\\": \\"00\\",\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Enable\\": \\"true\\"\\n }\\n ]\\n },\\n \\"AlertList\\": {\\n \\"Alert\\": [\\n {\\n \\"SilenceTime\\": \\"86400\\",\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Webhook\\": \\"http://www.aliyun.com\\",\\n \\"ContactGroups\\": \\"ECS_Group\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"EffectiveInterval\\": \\"00:00-23:59\\",\\n \\"NoEffectiveInterval\\": \\"00:00-06:00\\",\\n \\"MailSubject\\": \\"ECS_Bucket\\",\\n \\"RuleName\\": \\"myAlert\\",\\n \\"RuleId\\": \\"ruleIdxxxx\\",\\n \\"Period\\": \\"60\\",\\n \\"AlertState\\": \\"OK\\",\\n \\"Dimensions\\": \\"\\\\\\"\\\\\\"\\",\\n \\"EnableState\\": true,\\n \\"Resources\\": \\"[{\\\\\\"resource\\\\\\":\\\\\\"_ALL\\\\\\"}]\\",\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"95\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"80\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"99\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeActiveMetricRuleListResponse>\\r\\n\\t\\t<AlertList>\\r\\n\\t\\t\\t<Alert>\\r\\n\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t<ContactGroups>ECS_Group</ContactGroups>\\r\\n\\t\\t\\t\\t<NoEffectiveInterval></NoEffectiveInterval>\\r\\n\\t\\t\\t\\t<MailSubject>${serviceType}-${metricName}-${levelDescription}</MailSubject>\\r\\n\\t\\t\\t\\t<RuleId>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleId>\\r\\n\\t\\t\\t\\t<Period>300</Period>\\r\\n\\t\\t\\t\\t<Dimensions></Dimensions>\\r\\n\\t\\t\\t\\t<EffectiveInterval></EffectiveInterval>\\r\\n\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t<AlertState>INSUFFICIENT_DATA</AlertState>\\r\\n\\t\\t\\t\\t<MetricName>IOPSUsage</MetricName>\\r\\n\\t\\t\\t\\t<EnableState>true</EnableState>\\r\\n\\t\\t\\t\\t<Escalations>\\r\\n\\t\\t\\t\\t\\t<Critical />\\r\\n\\t\\t\\t\\t\\t<Info>\\r\\n\\t\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t\\t<Times>5</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t\\t\\t</Info>\\r\\n\\t\\t\\t\\t\\t<Warn />\\r\\n\\t\\t\\t\\t</Escalations>\\r\\n\\t\\t\\t\\t<Webhook></Webhook>\\r\\n\\t\\t\\t\\t<Resources>[{\\\\\\"resource\\\\\\":\\\\\\"_ALL\\\\\\"}]</Resources>\\r\\n\\t\\t\\t\\t<RuleName>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleName>\\r\\n\\t\\t\\t</Alert>\\r\\n\\t\\t\\t<Alert>\\r\\n\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t<ContactGroups>ECS_Group</ContactGroups>\\r\\n\\t\\t\\t\\t<NoEffectiveInterval></NoEffectiveInterval>\\r\\n\\t\\t\\t\\t<MailSubject>${serviceType}-${metricName}-${levelDescription}</MailSubject>\\r\\n\\t\\t\\t\\t<RuleId>SystemDefault_acs_rds_dashboard_CpuUsage</RuleId>\\r\\n\\t\\t\\t\\t<Period>300</Period>\\r\\n\\t\\t\\t\\t<Dimensions></Dimensions>\\r\\n\\t\\t\\t\\t<EffectiveInterval></EffectiveInterval>\\r\\n\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t<AlertState>INSUFFICIENT_DATA</AlertState>\\r\\n\\t\\t\\t\\t<MetricName>CpuUsage</MetricName>\\r\\n\\t\\t\\t\\t<EnableState>true</EnableState>\\r\\n\\t\\t\\t\\t<Escalations>\\r\\n\\t\\t\\t\\t\\t<Critical />\\r\\n\\t\\t\\t\\t\\t<Info>\\r\\n\\t\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t\\t<Times>5</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t\\t\\t</Info>\\r\\n\\t\\t\\t\\t\\t<Warn />\\r\\n\\t\\t\\t\\t</Escalations>\\r\\n\\t\\t\\t\\t<Webhook></Webhook>\\r\\n\\t\\t\\t\\t<Resources>[{\\\\\\"resource\\\\\\":\\\\\\"_ALL\\\\\\"}]</Resources>\\r\\n\\t\\t\\t\\t<RuleName>SystemDefault_acs_rds_dashboard_CpuUsage</RuleName>\\r\\n\\t\\t\\t</Alert>\\r\\n\\t\\t</AlertList>\\r\\n\\t\\t<Datapoints>\\r\\n\\t\\t\\t<Alarm>\\r\\n\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t<ContactGroups>[\\\\\\"Alice\\\\\\"]</ContactGroups>\\r\\n\\t\\t\\t\\t<ComparisonOperator>GreaterThanThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t<EndTime></EndTime>\\r\\n\\t\\t\\t\\t<RuleId>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleId>\\r\\n\\t\\t\\t\\t<StartTime></StartTime>\\r\\n\\t\\t\\t\\t<Period>300</Period>\\r\\n\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t<MetricName>IOPSUsage</MetricName>\\r\\n\\t\\t\\t\\t<State>INSUFFICIENT_DATA</State>\\r\\n\\t\\t\\t\\t<Enable>true</Enable>\\r\\n\\t\\t\\t\\t<Webhook></Webhook>\\r\\n\\t\\t\\t\\t<RuleName>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleName>\\r\\n\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t</Alarm>\\r\\n\\t\\t\\t<Alarm>\\r\\n\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t<ContactGroups>[\\\\\\"Jim\\\\\\"]</ContactGroups>\\r\\n\\t\\t\\t\\t<ComparisonOperator>GreaterThanThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t<EndTime></EndTime>\\r\\n\\t\\t\\t\\t<RuleId>SystemDefault_acs_rds_dashboard_CpuUsage</RuleId>\\r\\n\\t\\t\\t\\t<StartTime></StartTime>\\r\\n\\t\\t\\t\\t<Period>300</Period>\\r\\n\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t<MetricName>CpuUsage</MetricName>\\r\\n\\t\\t\\t\\t<State>INSUFFICIENT_DATA</State>\\r\\n\\t\\t\\t\\t<Enable>true</Enable>\\r\\n\\t\\t\\t\\t<Webhook></Webhook>\\r\\n\\t\\t\\t\\t<RuleName>SystemDefault_acs_rds_dashboard_CpuUsage</RuleName>\\r\\n\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t</Alarm>\\r\\n\\t\\t</Datapoints>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeActiveMetricRuleListResponse>","errorExample":""}]', - 'title' => 'DescribeActiveMetricRuleList', - 'requestParamsDescription' => ' ', + 'title' => 'Query the running status of the CloudMonitor agent', + 'description' => 'This topic describes how to query the status of the CloudMonitor agent that is installed on the `i-hp3dunahluwajv6f****` instance. The result indicates that the CloudMonitor agent is in the `running` state.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'EnableActiveMetricRule' => [ - 'summary' => 'Enables the initiative alert feature for a cloud service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2023-11-24T04:01:32.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-19T08:42:03.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2023-05-04T09:06:41.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-11-29T02:45:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentStatuses'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitoringAgentStatuses', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F\\",\\n \\"Success\\": true,\\n \\"NodeStatusList\\": {\\n \\"NodeStatus\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"InstanceId\\": \\"i-hp3dunahluwajv6f****\\",\\n \\"AutoInstall\\": true,\\n \\"OsMonitorStatus\\": \\"running\\",\\n \\"OsMonitorErrorCode\\": \\"install_fail\\",\\n \\"OsMonitorErrorDetail\\": \\"Command.ErrorCode.Fail.Downlaod.REGIN_ID\\",\\n \\"OsMonitorVersion\\": \\"1.3.0-12\\",\\n \\"OsMonitorConfig\\": \\"{\\\\\\"sysak\\\\\\":true}\\",\\n \\"AgentInstallErrorCode\\": \\"Assist.Invalid\\",\\n \\"LoongCollectorVersion\\": \\"0.1.0\\",\\n \\"LoongCollectorStatus\\": \\"running\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeMonitoringConfig' => [ + 'summary' => 'Queries the global configurations of the CloudMonitor agent.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'Product', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud service for which you want to enable initiative alert. Valid values:'."\n" - ."\n" - .'* ECS: Elastic Compute Service (ECS)'."\n" - .'* rds: ApsaraDB RDS'."\n" - .'* slb: Server Load Balancer (SLB)'."\n" - .'* redis_standard: Redis Open-Source Edition (standard architecture)'."\n" - .'* redis_sharding: Redis Open-Source Edition (cluster architecture)'."\n" - .'* redis_splitrw: Redis Open-Source Edition (read/write splitting architecture)'."\n" - .'* mongodb: ApsaraDB for MongoDB of the replica set architecture'."\n" - .'* mongodb_sharding: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" - .'* hbase: ApsaraDB for HBase'."\n" - .'* elasticsearch: Elasticsearch'."\n" - .'* opensearch: OpenSearch'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], - ], - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F35654DB-0C9D-4FB3-903F-479BA7663061', 'title' => ''], + 'AutoInstall' => ['description' => 'Indicates whether the CloudMonitor agent is automatically installed on existing Elastic Compute Service (ECS) instances. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EnableInstallAgentNewECS' => ['description' => 'Indicates whether the CloudMonitor agent is automatically installed on new ECS instances. Valid values: Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => ''], ], 403 => [ - [ - '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', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"F82E6667-7811-4BA0-842F-5B2DC42BBAAD\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<EnableActiveMetricRuleResponse>\\n <Code>200</Code>\\n <Success>true</Success>\\n <RequestId>55850888-9CCE-4FD5-B949-5F8947D63929</RequestId>\\n</EnableActiveMetricRuleResponse>","errorExample":""}]', - 'title' => 'EnableActiveMetricRule', + 'title' => 'DescribeMonitoringConfig', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DisableActiveMetricRule' => [ - 'summary' => 'Disables the initiative alert feature for a cloud service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringConfig'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeMonitoringConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F35654DB-0C9D-4FB3-903F-479BA7663061\\",\\n \\"AutoInstall\\": false,\\n \\"Success\\": true,\\n \\"EnableInstallAgentNewECS\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\"\\n}","type":"json"}]', + ], + 'DescribeProductResourceTagKeyList' => [ + 'summary' => 'Call the DescribeProductResourceTagKeyList operation to query all tag keys of cloud resources in a specified region.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Product', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud service for which you want to disable proactive alerting. Valid values:'."\n" - ."\n" - .'* ECS: Elastic Compute Service (ECS)'."\n" - .'* rds: ApsaraDB RDS'."\n" - .'* slb: Server Load Balancer (SLB)'."\n" - .'* redis_standard: Redis Open-Source Edition (standard architecture)'."\n" - .'* redis_sharding: Redis Open-Source Edition (cluster architecture)'."\n" - .'* redis_splitrw: Redis Open-Source Edition (read/write splitting architecture)'."\n" - .'* mongodb: ApsaraDB for MongoDB of the replica set architecture'."\n" - .'* mongodb_sharding: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" - .'* hbase: ApsaraDB for HBase'."\n" - .'* elasticsearch: Elasticsearch'."\n" - .'* opensearch: OpenSearch'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'dbc2826f237e****', 'title' => ''], ], ], 'responses' => [ @@ -24115,550 +17740,336 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The request processing has failed due to some unknown error.', 'title' => ''], + 'NextToken' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'example' => 'dbc2826f237e****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '945ACAA9-89F2-4A62-8913-076FDEDAA8DB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TagKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagKey' => [ + 'description' => 'The tag keys.', + 'type' => 'array', + 'items' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'tag_******', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'DescribeProductResourceTagKeyList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProductResourceTagKeyList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeProductResourceTagKeyList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"F82E6667-7811-4BA0-842F-5B2DC42BBAAD\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DisableActiveMetricRule', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"NextToken\\": \\"dbc2826f237e****\\",\\n \\"RequestId\\": \\"945ACAA9-89F2-4A62-8913-076FDEDAA8DB\\",\\n \\"Success\\": true,\\n \\"TagKeys\\": {\\n \\"TagKey\\": [\\n \\"tag_******\\"\\n ]\\n }\\n}","type":"json"}]', + 'extraInfo' => ' ', ], - 'CreateMetricRuleTemplate' => [ - 'summary' => 'Creates an alert template.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeProductsOfActiveMetricRule' => [ + 'summary' => 'Queries the cloud services for which the initiative alert feature is enabled.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert template.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Template1', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the alert template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Template1', - ], - ], - [ - 'name' => 'AlertTemplates', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The details of the alert template.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Escalations.Info.Threshold' => [ - 'description' => 'The threshold for Info-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain the name of a metric, see [DescribeMetricMetaList](~~98846~~) or [Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_total', - ], - 'Webhook' => [ - 'description' => 'The callback URL.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The callback URL must be accessible over the Internet. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://ww.aliyun.com', - ], - 'Escalations.Warn.Threshold' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], - 'Period' => [ - 'description' => 'The aggregation period of monitoring data. Unit: seconds.'."\n" - ."\n" - .'The default value is the minimum aggregation period. Generally, you do not need to specify the minimum aggregation period.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Rule1', - ], - 'Escalations.Critical.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'Selector' => [ - 'description' => 'The dimension of the alert. It is an extended field.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For example, an alert template is applied to an application group, this parameter is set to `{"disk":"/"}`, and the MetricName parameter is set to `DiskUtilization`. In this case, the generated alert rule is applied to the root disk partition (`"/"`) of all instances in the application group to which the alert template is applied.'."\n" - ."\n" - .'> For more information about the values of extended fields, see [DescribeMetricRuleTemplateAttribute](~~114979~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"disk":"/"}', - ], - 'Escalations.Info.Statistics' => [ - 'description' => 'The statistical method for Info-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Warn.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Escalations.Info.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Category' => [ - 'description' => 'The abbreviation of the cloud service name.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], - 'Escalations.Critical.Threshold' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - 'Escalations.Critical.Statistics' => [ - 'description' => 'The statistical method for Critical-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Critical.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Warn.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the previous monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Info.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Escalations.Warn.Statistics' => [ - 'description' => 'The statistical method for the Warn-level alert.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 200, - ], - ], - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9763ED1A-4D09-41BF-851E-310421750204', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'The ID of the alert template.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', 'title' => ''], + 'Datapoints' => ['description' => 'The information about the services for which the initiative alert feature is enabled. Services are separated with commas (,). Valid values:'."\n" + ."\n" + .'- ECS: Elastic Compute Service (ECS)'."\n" + ."\n" + .'- rds: ApsaraDB RDS'."\n" + ."\n" + .'- slb: Server Load Balancer (SLB)'."\n" + ."\n" + .'- redis\\_standard: Redis Open-Source Edition (standard architecture)'."\n" + ."\n" + .'- redis\\_sharding: Redis Open-Source Edition (cluster architecture)'."\n" + ."\n" + .'- redis\\_splitrw: Redis Open-Source Edition (read/write splitting architecture)'."\n" + ."\n" + .'- mongodb: ApsaraDB for MongoDB of the replica set architecture'."\n" + ."\n" + .'- mongodb\\_sharding: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" + ."\n" + .'- hbase: ApsaraDB for HBase'."\n" + ."\n" + .'- elasticsearch: Elasticsearch'."\n" + ."\n" + .'- opensearch: OpenSearch', 'type' => 'string', 'example' => 'ecs,rds', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AllProductInitMetricRuleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AllProductInitMetricRule' => [ + 'description' => 'The information about the services for which one-click alert is enabled.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the services for which one-click alert is enabled.', + 'type' => 'object', + 'properties' => [ + 'Product' => ['description' => 'The abbreviation of the service name.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'AlertInitConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlertInitConfig' => [ + 'description' => 'The initial alert rules that are generated after one-click alert is enabled for a service.', + 'type' => 'array', + 'items' => [ + 'description' => 'The initial alert rules that are generated after one-click alert is enabled for a service.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'example' => 'cpu_total', 'title' => ''], + 'EvaluationCount' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the service. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'example' => 'acs_rds_dashboard', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'Statistics' => ['description' => 'The method used to calculate metric values that trigger alerts. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'example' => 'Average', 'title' => ''], + 'Period' => ['description' => 'The aggregation period of monitoring data. Unit: minutes. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'example' => '1m', 'title' => ''], + 'Level' => [ + 'description' => 'The alert level.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- INFO'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'- CRITICAL'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->', + 'enumValueTitles' => ['INFO' => '', 'WARN' => '', 'CRITICAL' => ''], + 'type' => 'string', + 'example' => 'CRITICAL', + 'title' => '', + ], + 'ComparisonOperator' => [ + 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: does not equal to the threshold'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', + 'enumValueTitles' => [ + 'LessThanThreshold' => '', 'GreaterThanLastWeek' => '', 'LessThanOrEqualToThreshold' => '', 'NotEqualToThreshold' => '', 'GreaterThanLastPeriod' => '', 'GreaterThanYesterday' => '', 'LessThanYesterday' => '', 'LessThanLastWeek' => '', 'GreaterThanOrEqualToThreshold' => '', 'GreaterThanThreshold' => '', + 'LessThanLastPeriod' => '', + ], + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => ''], ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], - ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], - ], - [ - [ - 'errorCode' => 'InvalidClientTokenId', - 'errorMessage' => 'not allow this operation.', - ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.', 'description' => ''], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], - ], - 412 => [ - [ - 'errorCode' => 'ResourcesOverLimit', - 'errorMessage' => 'Resources over limit.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalFailure', - 'errorMessage' => '%s', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"9763ED1A-4D09-41BF-851E-310421750204\\",\\n \\"Success\\": true,\\n \\"Id\\": 12345\\n}","errorExample":""},{"type":"xml","example":"<CreateMetricRuleTemplateResponse>\\n\\t\\t<RequestId>9763ED1A-4D09-41BF-851E-310421750204</RequestId>\\n\\t\\t<Id>12345</Id>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</CreateMetricRuleTemplateResponse>","errorExample":""}]', - 'title' => 'CreateMetricRuleTemplate', + 'title' => 'DescribeProductsOfActiveMetricRule', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMetricRuleTemplate' => [ - 'summary' => 'Deletes an alert template.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-10-25T07:41:17.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProductsOfActiveMetricRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeProductsOfActiveMetricRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"F82E6667-7811-4BA0-842F-5B2DC42BBAAD\\",\\n \\"Datapoints\\": \\"ecs,rds\\",\\n \\"Success\\": true,\\n \\"AllProductInitMetricRuleList\\": {\\n \\"AllProductInitMetricRule\\": [\\n {\\n \\"Product\\": \\"ecs\\",\\n \\"AlertInitConfigList\\": {\\n \\"AlertInitConfig\\": [\\n {\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EvaluationCount\\": \\"3\\",\\n \\"Namespace\\": \\"acs_rds_dashboard\\",\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Period\\": \\"1m\\",\\n \\"Level\\": \\"CRITICAL\\",\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeProjectMeta' => [ + 'summary' => 'Calls the DescribeProjectMeta operation to query the list of cloud services that support time series monitoring metrics in CloudMonitor.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'Labels', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert template.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123****', - 'docRequired' => true, - ], + 'schema' => ['description' => 'The tags. Tags are used to filter alerts, and each alert can be marked with special tags.'."\n" + ."\n" + .'Currently, only filtering by product is supported. That is, the `name` is `product`. For example: {"name":"product","value":"ECS"}.'."\n" + .'>We do not recommend that you use the special tags for the CloudMonitor console in Alibaba Cloud.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"name":"product","value":"ECS"}]', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Valid values: 1 to 100.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Valid values: 1 to 10000.'."\n" + ."\n" + .'Default value: 30.'."\n" + ."\n" + .'>Currently, Alibaba Cloud does not impose a limit on this parameter. If you need to obtain all results, set the page size to a large value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ @@ -24666,402 +18077,133 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7B63F8CF-D48D-4608-A402-04FB5B2B4B6A', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resource' => [ - 'description' => 'The template information.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C2061B2-3B1B-43BF-A4A4-C53426F479C0', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: true and false. The value true indicates success, and the value false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '12', 'title' => ''], + 'Resources' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'TemplateId' => [ - 'description' => 'The ID of the template.'."\n", - 'type' => 'string', - 'example' => '123****', + 'Resource' => [ + 'description' => 'The information about the cloud service.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Namespace' => ['description' => 'The namespace that is used to distinguish products. Format: `acs_Service abbreviation`. For more information, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'example' => 'acs_cdn', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'CDN', 'title' => ''], + 'Labels' => ['description' => 'The tags. Tags are used to filter alerts, and each alert can be marked with special tags.'."\n" + ."\n" + .'For example, the tags indicate the specification of the product to which the alert belongs, and whether the alert can be set. Format: `[{"name":"Tag name","value":"Tag value"}、{"name":"Tag name","value":"Tag value"}]`. The following common tags are supported:'."\n" + ."\n" + .'- alertUnit: the unit of the alert.'."\n" + .' To prevent the unit of the original reported data from being too small, which causes the value entered in an alert rule to be too large, the `alertUnit` tag is added. Currently, this tag is mainly applied to the CloudMonitor console.'."\n" + ."\n" + .'- minAlertPeriod: the minimum reporting period. The time interval at which monitoring data is reported. The default value is 1 minute.'."\n" + ."\n" + .'- metricCategory: the specification of the product. For example, kvstore_sharding.'."\n" + .' Some Alibaba Cloud products have different specifications that are defined in the same namespace, and this parameter is used to distinguish them.'."\n" + ."\n" + .'- is_alarm: indicates whether alert rules can be set.'."\n" + .' We do not recommend that you use the special tags for the CloudMonitor console in Alibaba Cloud.'."\n" + ."\n", 'type' => 'string', 'example' => '[{"metricCategory":ecs}]', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"7B63F8CF-D48D-4608-A402-04FB5B2B4B6A\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"TemplateId\\": \\"123****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteMetricRuleTemplateResponse>\\r\\n <Resource>\\r\\n <TemplateId>123****</TemplateId>\\r\\n </Resource>\\r\\n <RequestId>7B63F8CF-D48D-4608-A402-04FB5B2B4B6A</RequestId>\\r\\n <Success>true</Success>\\r\\n <Code>200</Code>\\r\\n</DeleteMetricRuleTemplateResponse>","errorExample":""}]', - 'title' => 'DeleteMetricRuleTemplate', + 'title' => 'Queries the list of cloud services that support time series monitoring metrics in CloudMonitor', + 'description' => 'Obtains the information about the connected cloud services, including the description, namespace, and tags of each service.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyMetricRuleTemplate' => [ - 'summary' => 'Modifies an alert template.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProjectMeta'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C2061B2-3B1B-43BF-A4A4-C53426F479C0\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"PageSize\\": \\"5\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Total\\": \\"12\\",\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Namespace\\": \\"acs_cdn\\",\\n \\"Description\\": \\"CDN\\",\\n \\"Labels\\": \\"[{\\\\\\"metricCategory\\\\\\":ecs}]\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeSiteInstantMonitorLog' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'TaskIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert template.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ - 'name' => 'Name', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert template.'."\n" - ."\n" - .'For information about how to obtain the name of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ - 'name' => 'Description', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the alert template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_template1', - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ - 'name' => 'RestVersion', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The version of the alert template. The version changes with the number of times that the alert template is modified.'."\n" - ."\n" - .'For information about how to obtain the version of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ - 'name' => 'AlertTemplates', + 'name' => 'NextToken', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The details of the alert template.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The version of the alert template. The version changes with the number of times that the alert template is modified.'."\n" - ."\n" - .'For information about how to obtain the version of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'Escalations.Info.Threshold' => [ - 'description' => 'The threshold for Info-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain metrics, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], - 'Webhook' => [ - 'description' => 'The callback URL.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The callback URL must be accessible over the Internet. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://apiwebhook.hipac.cn/api/v1/alarm/aly/eregfeeferrtbnmkdszp', - ], - 'Escalations.Warn.Threshold' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], - 'Period' => [ - 'description' => 'The statistical period of the monitoring data.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> If the value is set to 300 seconds, the monitoring data is collected every 300 seconds. If the monitoring data is reported every 1 minute, the alert system calculates the average, maximum, and minimum values of the monitoring data of 5 minutes and checks whether the aggregated values exceed the threshold. To prevent unexpected alerts, we recommend that you set this parameter together with other parameters.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rule1', - ], - 'Escalations.Critical.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'Selector' => [ - 'description' => 'The dimension of the alert. It is an extended field.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For example, an alert template is applied to an application group, this parameter is set to `{"disk":"/"}`, and the MetricName parameter is set to `DiskUtilization`. In this case, the generated alert rule is applied to the root disk partition (`"/"`) of all instances in the application group to which the alert template is applied.'."\n" - ."\n" - .'> For more information about the values of extended fields, see [DescribeMetricRuleTemplateAttribute](~~114979~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"disk":"/"}', - ], - 'Escalations.Info.Statistics' => [ - 'description' => 'The statistical method for Info-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Warn.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Escalations.Info.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Category' => [ - 'description' => 'The abbreviation of the cloud service name.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], - 'Escalations.Critical.Threshold' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - 'Escalations.Critical.Statistics' => [ - 'description' => 'The statistical method for Critical-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Critical.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Warn.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Info.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Escalations.Warn.Statistics' => [ - 'description' => 'The statistical method for Warn-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 200, - ], + 'schema' => ['type' => 'string', 'required' => false], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -25069,612 +18211,892 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9E07117F-F6AE-4F1C-81E8-36FBB4892235', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'NextToken' => ['type' => 'string'], + 'Data' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'string'], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], ], - 'description' => '', ], ], ], 'errorCodes' => [ - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => 'InvalidQueryParameter', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], [ - [ - 'errorCode' => 'InvalidClientTokenId', - 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', - ], - ], - [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], ], 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 412 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalFailure', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"9E07117F-F6AE-4F1C-81E8-36FBB4892235\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyMetricRuleTemplateResponse>\\n\\t\\t<RequestId>97EAC0E2-CD54-4183-95AC-F0C113024E18</RequestId>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</ModifyMetricRuleTemplateResponse>","errorExample":""}]', - 'title' => 'ModifyMetricRuleTemplate', - 'description' => 'This topic provides an example on how to modify an alert template whose version is `1` and ID is `123456`. The alert level is changed to `Critical`. The statistical method is changed to `Average`. The alert threshold comparator is changed to `GreaterThanOrEqualToThreshold`. The alert threshold is changed to `90`. The number of alert retries is changed to `3`. The response shows that the alert template is modified.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeMetricRuleTemplateAttribute' => [ - 'summary' => 'Queries the details of an alert template.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2021-12-01T09:57:02.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n}","type":"json"}]', + ], + 'DescribeSiteMonitorAttribute' => [ + 'summary' => 'Queries the details of a site monitoring task by calling the DescribeSiteMonitorAttribute operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert template. You must specify at least one of the `Name` and `TemplateId` parameters.'."\n" - ."\n" - .'For information about how to obtain the name of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Template1', - ], + 'schema' => ['description' => 'The ID of the monitoring task.', 'type' => 'string', 'required' => true, 'example' => 'cc641dff-c19d-45f3-ad0a-818a0c4f****', 'title' => ''], ], [ - 'name' => 'TemplateId', + 'name' => 'IncludeAlert', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert template. You must specify at least one of the `Name` and `TemplateId` parameters.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '70****', - ], + 'schema' => ['description' => 'Specifies whether the returned task details include alert rules.'."\n" + ."\n" + .'- true: Alert rules are returned.'."\n" + .'- false (default): Alert rules are not returned.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '8F3A82AD-DA92-52B0-8EC6-C059D1C3839F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resource' => [ - 'description' => 'The details of the alert template.'."\n", + 'Code' => ['description' => 'The status code.'."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'MetricRules' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'Description' => [ - 'description' => 'The description of the alert template.'."\n", - 'type' => 'string', + 'MetricRule' => [ + 'description' => 'The alert rules of the monitoring task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert rules of the monitoring task.', + 'type' => 'object', + 'properties' => [ + 'ActionEnable' => ['description' => 'The status of the alert rule. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'AlarmActions' => ['description' => 'The alert contact group to which alert notifications are sent.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + 'ComparisonOperator' => ['description' => 'The comparison operator used in the alert rule. Valid values:'."\n" + ."\n" + .'- `>=`'."\n" + .'- `>`'."\n" + .'- `<=`'."\n" + .'- `<`'."\n" + .'- `=`'."\n" + .'- `!=`'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'example' => 'GreaterThanYesterday', 'title' => ''], + 'Dimensions' => ['description' => 'The dimensions associated with the alert rule.', 'type' => 'string', 'example' => '[{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }]', 'title' => ''], + 'EvaluationCount' => ['description' => 'The number of alert retries.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Expression' => ['description' => 'The expression of the alert rule.', 'type' => 'string', 'example' => '$Availability=30', 'title' => ''], + 'Level' => ['description' => 'The severity level of the alert rule. Valid values:'."\n" + ."\n" + .'- 1: Critical.'."\n" + ."\n" + .'- 2: Warning.'."\n" + ."\n" + .'- 3: Information.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'Availability', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'acs_networkmonitor', 'title' => ''], + 'OkActions' => ['description' => 'The alert contact group that receives alert notifications.', 'type' => 'string', 'example' => '[ "CloudMonitor"]', 'title' => ''], + 'Period' => ['description' => 'The time interval, which is typically the reporting period of the metric. Unit: seconds.'."\n" + ."\n" + .'>If you set a statistical period, data is queried based on the specified period.', 'type' => 'string', 'example' => '15s', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'example' => 'bf071ae_7b7aec3817b0fdf****', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'rule1', 'title' => ''], + 'StateValue' => ['description' => 'The alert status. Valid values:'."\n" + ."\n" + .'- OK: Normal.'."\n" + ."\n" + .'- ALARM: Alerting.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method used for alerting. Valid values:'."\n" + ."\n" + .'- Availability: the percentage of available detection points.'."\n" + .'- AvailableNumber: the number of available detection points.'."\n" + .'- ErrorCodeMaximum: any status code (independent alert).'."\n" + .'- ErrorCodeMinimum: all status codes (combined alert).'."\n" + .'- Average: response time.', 'type' => 'string', 'example' => 'Availability', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], - 'Name' => [ - 'description' => 'The name of the alert template.'."\n", - 'type' => 'string', - 'example' => 'ECS_Template1', - ], - 'RestVersion' => [ - 'description' => 'The version of the alert template.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'TemplateId' => [ - 'description' => 'The ID of the alert template.'."\n", - 'type' => 'string', - 'example' => '70****', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D17DF650-7EBD-54D0-903A-1D4E624D7402', 'title' => ''], + 'SiteMonitors' => [ + 'description' => 'The details of the monitoring task.', + 'type' => 'object', + 'properties' => [ + 'Address' => ['description' => 'The monitored address of the monitoring task.', 'type' => 'string', 'example' => 'https://aliyun.com', 'title' => ''], + 'AgentGroup' => ['description' => 'The type of detection point. Default value: PC.'."\n" + .'Valid values:'."\n" + ."\n" + .'- PC: wired network.'."\n" + ."\n" + .'- MOBILE: mobile network.', 'type' => 'string', 'example' => 'PC', 'title' => ''], + 'CustomSchedule' => [ + 'description' => 'The custom monitoring schedule. You can select a time range from Monday to Sunday for monitoring.', + 'type' => 'object', + 'properties' => [ + 'days' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'days' => [ + 'description' => 'The monitoring day.', + 'type' => 'array', + 'items' => ['description' => 'The monitoring day.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'end_hour' => ['description' => 'The custom monitoring end time.'."\n" + ."\n" + .'Unit: hours.', 'type' => 'integer', 'format' => 'int32', 'example' => '18', 'title' => ''], + 'start_hour' => ['description' => 'The custom monitoring start time.'."\n" + ."\n" + .'Unit: hours.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'time_zone' => ['description' => 'The time zone for custom monitoring.', 'type' => 'string', 'example' => 'local', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'AlertTemplates' => [ + 'Interval' => ['description' => 'The monitoring interval. Unit: minutes. Valid values: 1, 5, 15, 30, and 60.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'IspCities' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'AlertTemplate' => [ - 'description' => 'The queried alert templates.'."\n", + 'IspCity' => [ + 'description' => 'The carrier and city of the detection point.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The carrier and city of the detection point.', 'type' => 'object', 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'Selector' => [ - 'description' => 'The dimension of the alert. It is an extended field.'."\n", - 'type' => 'string', - 'example' => '{"disk":"/"}', - ], - 'Webhook' => [ - 'description' => 'The callback URL to which a request is sent when an alert is triggered.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com', - ], - 'Namespace' => [ - 'description' => 'The namespace of the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'Category' => [ - 'description' => 'The abbreviation of the Alibaba Cloud service name.'."\n", - 'type' => 'string', - 'example' => 'ecs', + 'City' => ['description' => 'The city ID.', 'type' => 'string', 'example' => '738', 'title' => ''], + 'CityName' => ['description' => 'The city name.', 'type' => 'string', 'example' => '北京市', 'title' => ''], + 'Isp' => ['description' => 'The carrier ID.', 'type' => 'string', 'example' => '465', 'title' => ''], + 'IspName' => ['description' => 'The carrier name.', 'type' => 'string', 'example' => '阿里巴巴', 'title' => ''], + 'Type' => ['description' => 'The network type of the detection point. Valid values:'."\n" + .'IDC: IDC data center.'."\n" + .'LASTMILE: residential broadband.'."\n" + .'MOBILE: mobile cellular network.', 'type' => 'string', 'example' => 'IDC', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'OptionJson' => [ + 'description' => 'The extended options. Each monitoring type has different extended options. For more information, see [CreateSiteMonitor](~~115048~~).', + 'type' => 'object', + 'properties' => [ + 'assertions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'assertions' => [ + 'description' => 'The assertion configuration group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The assertion configuration group.', + 'type' => 'object', + 'properties' => [ + 'operator' => ['description' => 'The assertion comparison operator. Valid values:'."\n" + .'- contains: Contains.'."\n" + .'- doesNotContain: Does not contain.'."\n" + .'- matches: Matches a regular expression.'."\n" + .'- doesNotMatch: Does not match a regular expression.'."\n" + .'- is: Equals a numeric value or matches a string.'."\n" + .'- isNot: Does not equal.'."\n" + .'- lessThan: Less than.'."\n" + .'- moreThan: Greater than.', 'type' => 'string', 'example' => 'lessThan', 'title' => ''], + 'property' => ['description' => 'The parsing path for the assertion content.'."\n" + ."\n" + .'- If the assertion type is `body_json`, the path is a `json path`.'."\n" + ."\n" + .'- If the assertion type is `body_xml`, the path is an `xml path`.', 'type' => 'string', 'example' => 'json path', 'title' => ''], + 'target' => ['description' => 'The target value or string for assertion comparison.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'type' => ['description' => 'The assertion type. Valid values:'."\n" + .'- response_time: Checks whether the response time meets expectations.'."\n" + .'- status_code: Checks whether the HTTP response status code meets expectations.'."\n" + .'- header: Checks whether a field in the response header meets expectations.'."\n" + .'- body_text: Checks whether the response body content meets expectations through text matching.'."\n" + .'- body_json: Checks whether the response body content meets expectations through JSON parsing (JSON Path).'."\n" + .'- body_xml: Checks whether the response body content meets expectations through XML parsing (XPath).', 'type' => 'string', 'example' => 'response_time', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'ECS_Rule', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'attempts' => ['description' => 'The number of retries after a DNS failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'auth_info' => [ + 'description' => 'The authentication information.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The authentication type. HTTP Basic Authentication is supported. Valid values: basic.', 'type' => 'string', 'example' => 'basic', 'title' => ''], + 'username' => ['description' => 'The username used for HTTP Basic Authentication.', 'type' => 'string', 'example' => 'test_username', 'title' => ''], + 'password' => ['description' => 'The password used for HTTP Basic Authentication.', 'type' => 'string', 'example' => 'test_password', 'title' => ''], + 'use_cookie_session_key' => ['description' => 'Specifies whether the key is stored in the client cookie for digest authentication.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'grant_type' => ['description' => 'The grant type used in OAuth 2.0 authentication. Valid values: client_credentials and password.', 'type' => 'string', 'example' => 'password', 'title' => ''], + 'client_id' => ['description' => 'The client ID used for client authentication in OAuth 2.0.', 'type' => 'string', 'example' => 'client_id', 'title' => ''], + 'client_secret' => ['description' => 'The client secret used for client authentication in OAuth 2.0.', 'type' => 'string', 'example' => 'client_secret', 'title' => ''], + 'scopes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'scopes' => [ + 'description' => 'The permission scopes requested in OAuth 2.0.', + 'type' => 'array', + 'items' => ['description' => 'A single permission scope requested in OAuth 2.0.', 'type' => 'string', 'example' => 'test_operation', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'NoDataPolicy' => [ - 'description' => 'The method that is used to handle alerts when no monitoring data is found. Valid values:'."\n" - ."\n" - .'* KEEP_LAST_STATE (default): No operation is performed.'."\n" - .'* INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.'."\n" - .'* OK: The status is considered normal.'."\n", - 'type' => 'string', - 'example' => 'KEEP_LAST_STATE', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'token_url' => ['description' => 'The authorization server URL in OAuth 2.0.', 'type' => 'string', 'example' => 'https://www.example.com', 'title' => ''], + 'auth_style' => ['description' => 'The OAuth 2.0 authentication style. Valid values: ROA and RPC.', 'type' => 'string', 'example' => 'ROA', 'title' => ''], + 'access_key_id' => ['description' => 'Supported only in multi-step monitoring. The AccessKey ID used for Alibaba Cloud authentication. We recommend that you use encrypted storage.', 'type' => 'string', 'example' => 'testAk', 'title' => ''], + 'access_key_secret' => ['description' => 'Supported only in multi-step monitoring. The AccessKey secret used for Alibaba Cloud authentication. We recommend that you use encrypted storage.', 'type' => 'string', 'example' => 'testSk', 'title' => ''], + 'region_id' => ['description' => 'Supported only in multi-step monitoring. The region ID of the request when using Alibaba Cloud authentication.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'api_action' => ['description' => 'Supported only in multi-step monitoring. The API action of the request when using Alibaba Cloud operations.', 'type' => 'string', 'example' => 'example_api', 'title' => ''], + 'api_version' => ['description' => 'Supported only in multi-step monitoring. The API version of the request when using Alibaba Cloud operations.', 'type' => 'string', 'example' => '2019-01-01', 'title' => ''], + 'with_addon_resources' => ['description' => 'Supported only in multi-step monitoring. Specifies whether additional resources exist when using Alibaba Cloud authentication for this step.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'service_name' => ['description' => 'The service name of the request when using AWS authentication.', 'type' => 'string', 'example' => 'example_service_name', 'title' => ''], + 'session_token' => ['description' => 'The session token used for AWS authentication.', 'type' => 'string', 'example' => 'example_token', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'blocked_url_list' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'blocked_url_list' => [ + 'description' => 'The list of blocked resource URLs. Path wildcards are supported.', + 'type' => 'array', + 'items' => ['description' => 'The list of blocked resource URLs. Path wildcards are supported.', 'type' => 'string', 'example' => 'www.taobao.com/**', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'browser_headers' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'browser_headers' => [ + 'description' => 'The custom headers. The structure is `{"key": "somekey", "value":"somevalue"}`.', + 'type' => 'array', + 'items' => ['description' => 'The custom headers. The structure is `{"key": "somekey", "value":"somevalue"}`.', 'type' => 'object', 'example' => '{"key":"value"}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'browser_hosts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'browser_hosts' => [ + 'description' => 'The custom hosts. The structure is `{"url":"someurl", "ip":"someip"}`.', + 'type' => 'array', + 'items' => ['description' => 'The custom hosts. The structure is `{"url":"someurl", "ip":"someip"}`.', 'type' => 'string', 'example' => '{"url":"www.taobao.com","ip":"127.0.0.1"}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'browser_info' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'browser_info' => [ + 'description' => 'The browser information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The browser information.', + 'type' => 'object', + 'properties' => [ + 'browser' => ['description' => 'The type of the browser.', 'type' => 'string', 'example' => 'Chrome', 'title' => ''], + 'device' => ['description' => 'The screen type.', 'type' => 'string', 'example' => 'laptop', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Escalations' => [ - 'description' => 'The threshold and the alert level.'."\n", + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'browser_insecure' => ['description' => 'Specifies whether to ignore certificate errors. Valid values:'."\n" + ."\n" + .'- false: Does not ignore certificate errors.'."\n" + .'- true: Ignores certificate errors.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'browser_task_version' => ['description' => 'The browser monitoring version. Valid values:'."\n" + ."\n" + .'- 1: Single-page monitoring.'."\n" + .'- 2: Multi-page monitoring.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'cookie' => ['description' => 'The cookie for the HTTP request.', 'type' => 'string', 'example' => 'lang=en', 'title' => ''], + 'diagnosis_mtr' => ['description' => 'Specifies whether to enable automatic MTR network diagnostics after a task failure. Valid values:'."\n" + .'- false: Disabled.'."\n" + .'- true: Enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'diagnosis_ping' => ['description' => 'Specifies whether to enable automatic PING network latency detection after a task failure. Valid values:'."\n" + .'- false: Disabled.'."\n" + .'- true: Enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'dns_hijack_whitelist' => ['description' => 'The DNS hijacking configuration list.', 'type' => 'string', 'example' => 'www.taobao.com:www.taobao.com.danuoyi.tbcache.com', 'title' => ''], + 'dns_match_rule' => ['description' => 'The DNS matching rule. Valid values:'."\n" + ."\n" + .'- IN_DNS: The expected aliases or IP addresses are all included in the DNS response.'."\n" + .'- DNS_IN: All DNS responses are included in the expected aliases or IP addresses.'."\n" + .'- EQUAL: The DNS response exactly matches the expected aliases or IP addresses.'."\n" + .'- ANY: The DNS response and the expected aliases or IP addresses have an intersection.', 'type' => 'string', 'example' => 'IN_DNS', 'title' => ''], + 'dns_server' => ['description' => 'The IP address of the DNS server.'."\n" + ."\n" + .'> This parameter applies only to the DNS monitoring type.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'dns_type' => ['description' => 'The DNS resolution type. This parameter applies only to the DNS monitoring type. Valid values:'."\n" + .'- A: Specifies the IP address corresponding to a hostname or domain name.'."\n" + .'- CNAME: Maps multiple domain names to another domain name.'."\n" + .'- NS: Specifies the DNS server that resolves a domain name.'."\n" + .'- MX: Points a domain name to a mail server address.'."\n" + .'- TXT: A description of the hostname or domain name. The text length is limited to 512 bytes and is typically used for SPF (Sender Policy Framework) records for anti-spam purposes.', 'type' => 'string', 'example' => 'A', 'title' => ''], + 'empty_message' => ['description' => 'Specifies whether the WebSocket task is allowed to return no message or an empty message. Valid values:'."\n" + .'- false (default): Not allowed.'."\n" + .'- true: Allowed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'expect_exist_string' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'expect_exist_string' => [ + 'description' => 'The list of strings expected to exist on the page.', + 'type' => 'array', + 'items' => ['description' => 'The list of strings expected to exist on the page.', 'type' => 'string', 'example' => 'expected string', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'expect_non_exist_string' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'expect_non_exist_string' => [ + 'description' => 'The list of strings expected not to exist on the page.', + 'type' => 'array', + 'items' => ['description' => 'The list of strings expected not to exist on the page.', 'type' => 'string', 'example' => 'unexpected string', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'expect_value' => ['description' => 'The alias or address to be resolved.'."\n" + ."\n" + .'> This parameter applies only to the DNS monitoring type.', 'type' => 'string', 'example' => 'dns_server', 'title' => ''], + 'failure_rate' => ['description' => 'The packet loss rate.'."\n" + ."\n" + .'> This parameter applies only to the PING monitoring type.', 'type' => 'number', 'format' => 'float', 'example' => '0.4', 'title' => ''], + 'header' => ['description' => 'The HTTP request header.', 'type' => 'string', 'example' => 'testKey:testValue', 'title' => ''], + 'http_method' => ['description' => 'The HTTP request method. Valid values:'."\n" + .'- get '."\n" + .'- post'."\n" + .'- head.', 'type' => 'string', 'example' => 'get', 'title' => ''], + 'ip_network' => [ + 'description' => 'The network type of the task. Valid values: v4, v6, and auto. Default value: v4.', + 'type' => 'string', + 'enum' => [], + 'example' => 'v4', + 'title' => '', + ], + 'isBase64Encode' => ['description' => 'Specifies whether to decode and store the password using Base64. Valid values:'."\n" + .'- true: The password is decoded and stored using Base64.'."\n" + .'- false: The password is not decoded and stored using Base64.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'match_rule' => ['description' => 'Specifies whether alert rules are included. Valid values:'."\n" + .'- 0: Yes.'."\n" + .'- 1: No.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'min_tls_version' => ['description' => 'The minimum TLS version. TLS 1.2 and later are supported by default. TLS 1.0 and 1.1 are disabled. To support these versions, modify the configuration.', 'type' => 'string', 'example' => 'tlsv1.2', 'title' => ''], + 'password' => ['description' => 'The password for SMTP, POP3, or FTP monitoring types.', 'type' => 'string', 'example' => '123****', 'title' => ''], + 'ping_num' => ['description' => 'The number of PING packets for the PING monitoring type.', 'type' => 'integer', 'format' => 'int32', 'example' => '29', 'title' => ''], + 'ping_port' => ['description' => 'The PING port. This parameter applies to TCP PING.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'ping_type' => ['description' => 'The PING protocol type. Valid values:'."\n" + ."\n" + .'- icmp'."\n" + ."\n" + .'- tcp'."\n" + ."\n" + .'- udp.', 'type' => 'string', 'example' => 'icmp', 'default' => 'icmp', 'title' => ''], + 'port' => ['description' => 'The port for TCP, UDP, SMTP, or POP3 monitoring types.', 'type' => 'integer', 'format' => 'int32', 'example' => '110', 'title' => ''], + 'protocol' => ['description' => 'The monitoring protocol.', 'type' => 'string', 'example' => 'TCP', 'title' => ''], + 'quic_enabled' => ['description' => 'Specifies whether the browser monitoring task uses the QUIC protocol. Valid values:'."\n" + .'- true: Uses the QUIC protocol.'."\n" + .'- false: Does not use the QUIC protocol.'."\n" + .'Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'quic_target' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'quic_target' => [ + 'description' => 'The list of sites that are forced to use the QUIC protocol.', + 'type' => 'array', + 'items' => ['description' => 'A site that is forced to use the QUIC protocol. The format is url:port. The port is optional and defaults to 443.', 'type' => 'string', 'example' => 'www.taobao.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'request_content' => ['description' => 'The request content for the HTTP monitoring type.', 'type' => 'string', 'example' => 'aa=bb', 'title' => ''], + 'request_format' => ['description' => 'The format of the HTTP request content. Valid values:'."\n" + .'- hex: hexadecimal.'."\n" + .'- txt: text.', 'type' => 'string', 'example' => 'txt', 'title' => ''], + 'response_content' => ['description' => 'The expected response content to match.', 'type' => 'string', 'example' => 'txt', 'title' => ''], + 'response_format' => ['description' => 'The format of the HTTP response content. Valid values:'."\n" + .'- hex: hexadecimal.'."\n" + .'- txt: text.', 'type' => 'string', 'example' => 'txt', 'title' => ''], + 'retry_delay' => ['description' => 'The number of retries after a monitoring failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'screen_shot' => ['description' => 'Specifies whether to enable page screenshots.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'strict_mode' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'time_out' => ['description' => 'The timeout period. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'traffic_hijack_element_blacklist' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'traffic_hijack_element_blacklist' => [ + 'description' => 'When a redirect occurs, if the URL of a resource loaded by the browser matches an expression in this list, traffic hijacking is considered to have occurred.', + 'type' => 'array', + 'items' => ['description' => 'When a redirect occurs, if the URL of a resource loaded by the browser matches an expression in this list, traffic hijacking is considered to have occurred.', 'type' => 'string', 'example' => 'www.taobao.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'traffic_hijack_element_count' => ['description' => 'When a redirect occurs, if the number of resources loaded by the browser exceeds this value, traffic hijacking is considered to have occurred. When this value is 0, no verification is performed. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'traffic_hijack_element_whitelist' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'traffic_hijack_element_whitelist' => [ + 'description' => 'When a redirect occurs, if the URL of a resource loaded by the browser does not match any expression in this list, traffic hijacking is considered to have occurred.', + 'type' => 'array', + 'items' => ['description' => 'When a redirect occurs, if the URL of a resource loaded by the browser does not match any expression in this list, traffic hijacking is considered to have occurred.', 'type' => 'string', 'example' => 'www.taobao.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'username' => ['description' => 'The username for FTP, SMTP, or POP3.', 'type' => 'string', 'example' => 'testUser', 'title' => ''], + 'waitTime_after_completion' => ['description' => 'The additional wait time after the page is opened in a browser monitoring task.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'scroll_end' => ['description' => 'For browser monitoring tasks, specifies whether to scroll to the bottom of the page after it is opened.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'host_binding' => ['description' => 'The custom host for HTTP tasks. The format is ip1,ip2:address. Multiple mappings can be configured. The left side of the colon contains A records or CNAMEs that the domain name can be resolved to, separated by commas. The right side of the colon is the domain name.', 'type' => 'string', 'example' => '127.0.0.1:www.aliyun.com', 'title' => ''], + 'host_binding_type' => [ + 'description' => 'Specifies how the custom host takes effect. Valid values: 0 (random) and 1 (round-robin).', + 'enumValueTitles' => ['0', '1'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'hops' => ['description' => 'The number of hops for traceroute diagnostics when a PING task fails.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'icmp_timeout_millis' => ['description' => 'The timeout period for a single PING request using the ICMP protocol. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'title' => ''], + 'config_variables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'config_variables' => [ + 'description' => 'The environment variable configuration. This parameter takes effect for multi-step monitoring.', + 'type' => 'array', + 'items' => [ + 'description' => 'Environment variables can be referenced in parameters of different test steps by using the placeholder {{$.variable_name}}. They can also be updated by parsing the response of a test step and referenced in subsequent steps. For sensitive information such as API keys, enable encrypted storage.', 'type' => 'object', 'properties' => [ - 'Info' => [ - 'description' => 'The conditions for triggering Info-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Info-level alerts.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical method for Info-level alerts.'."\n" - ."\n" - .'The value of the `Statistics` parameter varies with the cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - 'Warn' => [ - 'description' => 'The conditions for triggering Warn-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical method for Warn-level alerts.'."\n" - ."\n" - .'The value of the `Statistics` parameter varies with the cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - 'Critical' => [ - 'description' => 'The conditions for triggering Critical-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Threshold' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical method for Critical-level alerts.'."\n" - ."\n" - .'The value of the `Statistics` parameter varies with the cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], + 'name' => ['description' => 'The name of the environment variable.', 'type' => 'string', 'example' => 'variable_name', 'title' => ''], + 'value' => ['description' => 'The value of the variable.', 'type' => 'string', 'example' => 'variable_value', 'title' => ''], + 'secure' => ['description' => 'Specifies whether to use encrypted storage.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'Labels' => [ + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'steps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'steps' => [ + 'description' => 'The step configurations for multi-step monitoring. This parameter takes effect for multi-step monitoring.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration of a single step in multi-step monitoring.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'Labels' => [ - 'description' => 'The tags of the alert template.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the alert template.'."\n", - 'type' => 'string', - 'example' => 'label1', - ], - 'Value' => [ - 'description' => 'The tag value of the alert template.'."\n", - 'type' => 'string', - 'example' => 'value1', + 'name' => ['description' => 'The step name (deprecated).', 'type' => 'string', 'deprecated' => true, 'example' => 'step1', 'title' => ''], + 'step_type' => ['description' => 'The monitoring type of this step. Valid values:'."\n" + .'- http'."\n" + .'- ping'."\n" + .'- tcp'."\n" + .'- udp'."\n" + .'- dns'."\n" + .'- smtp'."\n" + .'- pop3'."\n" + .'- ftp'."\n" + .'- wait'."\n" + ."\n" + .'The wait type represents a wait step.', 'type' => 'string', 'example' => 'http', 'title' => ''], + 'url' => ['description' => 'The URL for a single step in multi-step monitoring.', 'type' => 'string', 'example' => 'https://aliyun.com', 'title' => ''], + 'allow_failure' => ['description' => 'Specifies whether to continue to the next step if the current step fails. Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'is_critical' => ['description' => 'Specifies whether to mark the entire monitoring task as failed if the current step fails. Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'wait_time_in_secs' => ['description' => 'The wait time. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'extracted_variables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'extracted_variables' => [ + 'description' => 'The variable extraction configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration for extracting a single variable.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The variable name.', 'type' => 'string', 'example' => 'test_variable', 'title' => ''], + 'parser' => [ + 'description' => 'The variable extraction method settings.', + 'type' => 'object', + 'properties' => [ + 'parser_type' => ['description' => 'The extraction mode. Valid values: 0 (JSON), 1 (XML), and 2 (regular expression).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'value' => ['description' => 'The variable extraction expression.'."\n" + .'When the extraction method is JSON or XML, the expression supports XML format.'."\n" + .'When the extraction method is regular expression, the string matching this value is extracted.', 'type' => 'string', 'example' => 'x.testkey.arrayvalue[0].innerkey', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'field' => ['description' => 'This parameter takes effect when the variable location is HTTP header. Extracts the key specified by this parameter from the header.', 'type' => 'string', 'example' => 'request_id', 'title' => ''], + 'extracted_type' => ['description' => 'The location from which the variable is extracted. Valid values: 0 (HTTP body) and 1 (HTTP header).', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'option' => ['description' => 'The extended options for this step. Each monitoring type has different extended options. For more information, see [CreateSiteMonitor](~~115048~~).', 'type' => 'string', 'example' => '{"enable_operator_dns": true}', 'title' => ''], + 'step_name' => ['description' => 'The step name.', 'type' => 'string', 'example' => 'step1', 'title' => ''], + 'use_generated_cookie' => ['description' => 'Specifies whether to use the cookies extracted from previous steps. Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'auto_extract_cookie' => ['description' => 'Specifies whether to automatically extract cookies. The set-cookie header in the HTTP response of this step is parsed, and the cookies are available in subsequent monitoring steps. Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'SilenceTime' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'trace_region' => ['description' => 'The deployment region of the target application when integrating with Managed Service for OpenTelemetry.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'trace_type' => ['description' => 'Settings for the Tracing Analysis protocol used when integrating with Managed Service for OpenTelemetry.'."\n" + .'Valid values:'."\n" + .'- OpenTelemetry'."\n" + .'- Zipkin'."\n" + .'- Jaeger.', 'type' => 'string', 'example' => 'OpenTelemetry', 'title' => ''], + 'safe_link' => ['description' => 'This parameter takes effect for SMTP monitoring tasks. Set this parameter to 1 to use a secure connection. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'enable_packet_capture' => ['description' => 'Specifies whether to enable packet capture for this task.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'use_private_crt' => ['title' => '', 'description' => 'Specifies whether to use a private certificate.', 'type' => 'boolean', 'example' => ''], + 'private_crt_file_name' => ['title' => '', 'description' => 'The certificate file name of the private certificate.', 'type' => 'string', 'example' => 'cert.pem'], + 'use_ssl' => ['title' => '', 'description' => 'Specifies whether to use an SSL connection when performing a TCP task.', 'type' => 'boolean', 'example' => 'tlsv1.0'], + 'max_tls_version' => ['title' => '', 'description' => 'The maximum TLS version.', 'type' => 'string', 'example' => 'tlsv1.3'], + 'server_name' => ['title' => '', 'description' => 'The Server Name Indication (SNI).', 'type' => 'string', 'example' => 'www.aliyun.com'], + 'supported_cipher_suits' => ['title' => '', 'description' => 'The supported cipher suites.', 'type' => 'string', 'example' => 'TLS_AES_256_GCM_SHA384'], ], + 'title' => '', + 'example' => '', + ], + 'TaskId' => ['description' => 'The ID of the monitoring task.', 'type' => 'string', 'example' => 'cc641dff-c19d-45f3-ad0a-818a0c4f****', 'title' => ''], + 'TaskName' => ['description' => 'The name of the monitoring task.', 'type' => 'string', 'example' => 'test123', 'title' => ''], + 'TaskState' => ['description' => 'The status of the monitoring task. Valid values:'."\n" + ."\n" + .'- 1: Enabled.'."\n" + .'- 2: Disabled.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TaskType' => ['description' => 'The type of the monitoring task. Site monitoring task types include HTTP(S), PING, TCP, UDP, DNS, SMTP, POP3, and FTP.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'VpcConfig' => [ + 'description' => 'The VPC configuration for the internal network monitoring task.', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The region where the target site of the internal network monitoring task is located.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'SecurityGroupId' => ['description' => 'The ID of the security group associated with the internal network monitoring task.', 'type' => 'string', 'example' => 'sg-xxxxxx', 'title' => ''], + 'VpcId' => ['description' => 'The ID of the VPC associated with the internal network monitoring task.', 'type' => 'string', 'example' => 'vpc-xxxxxx', 'title' => ''], + 'VswitchId' => ['description' => 'The ID of the vSwitch associated with the internal network monitoring task.', 'type' => 'string', 'example' => 'vsw-xxxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'The parameter is missing or invalid. %s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], ], - 412 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'Task Id does not exist', 'description' => ''], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"8F3A82AD-DA92-52B0-8EC6-C059D1C3839F\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"Description\\": \\"ECS模板\\",\\n \\"Name\\": \\"ECS_Template1\\",\\n \\"RestVersion\\": \\"1\\",\\n \\"TemplateId\\": \\"70****\\",\\n \\"AlertTemplates\\": {\\n \\"AlertTemplate\\": [\\n {\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Selector\\": \\"{\\\\\\"disk\\\\\\":\\\\\\"/\\\\\\"}\\",\\n \\"Webhook\\": \\"https://www.aliyun.com\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Category\\": \\"ecs\\",\\n \\"RuleName\\": \\"ECS_Rule\\",\\n \\"NoDataPolicy\\": \\"KEEP_LAST_STATE\\",\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Times\\": 5,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n },\\n \\"Labels\\": {\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"label1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n },\\n \\"SilenceTime\\": 3600\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricRuleTemplateAttributeResponse>\\r\\n\\t<RequestId>8F3A82AD-DA92-52B0-8EC6-C059D1C3839F</RequestId>\\r\\n\\t<Resource>\\r\\n\\t\\t<AlertTemplates>\\r\\n\\t\\t\\t<AlertTemplate>\\r\\n\\t\\t\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t\\t\\t<Category>ecs</Category>\\r\\n\\t\\t\\t\\t<Escalations>\\r\\n\\t\\t\\t\\t\\t<Critical>\\r\\n\\t\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t\\t<Times>5</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>90</Threshold>\\r\\n\\t\\t\\t\\t\\t</Critical>\\r\\n\\t\\t\\t\\t\\t<Info />\\r\\n\\t\\t\\t\\t\\t<Warn />\\r\\n\\t\\t\\t\\t</Escalations>\\r\\n\\t\\t\\t\\t<CompositeExpression />\\r\\n\\t\\t\\t\\t<Webhook></Webhook>\\r\\n\\t\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t\\t<RuleName>ECS_Rule</RuleName>\\r\\n\\t\\t\\t\\t<Selector />\\r\\n\\t\\t\\t</AlertTemplate>\\r\\n\\t\\t</AlertTemplates>\\r\\n\\t\\t<Description></Description>\\r\\n\\t\\t<RestVersion>1</RestVersion>\\r\\n\\t\\t<TemplateId>70****</TemplateId>\\r\\n\\t\\t<Name>ECS_Template1</Name>\\r\\n\\t</Resource>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMetricRuleTemplateAttributeResponse>\\t","errorExample":""}]', - 'title' => 'DescribeMetricRuleTemplateAttribute', - 'description' => 'This topic provides an example on how to query the details of an alert template whose ID is `70****`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Query details of a site monitoring task', + 'description' => 'This topic provides an example on how to query the details of the site monitoring task `cc641dff-c19d-45f3-ad0a-818a0c4f****`. The response shows that the task name is `test123`, the monitored address is `https://aliyun.com`, and the carrier is `Alibaba`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMetricRuleTemplateList' => [ - 'summary' => 'Queries alert templates.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-10-14T05:34:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-26T07:45:34.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-20T09:27:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-27T05:33:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-13T05:55:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-10T06:02:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-28T07:10:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-25T09:01:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-25T10:12:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-24T08:27:35.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ['createdAt' => '2024-09-23T08:45:00.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ['createdAt' => '2024-09-09T11:50:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-05T11:09:56.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-31T06:53:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-16T06:57:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-16T06:23:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-04T08:23:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-22T07:49:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-04T02:58:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-06-15T04:29:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-22T07:54:08.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-06T11:21:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-27T07:31:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-17T07:34:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-16T09:06:08.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-16T09:06:08.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"MetricRules\\": {\\n \\"MetricRule\\": [\\n {\\n \\"ActionEnable\\": \\"true\\",\\n \\"AlarmActions\\": \\"CloudMonitor\\",\\n \\"ComparisonOperator\\": \\"GreaterThanYesterday\\",\\n \\"Dimensions\\": \\"[{\\\\\\"taskId\\\\\\": \\\\\\"cc641dff-c19d-45f3-ad0a-818a0c4f****\\\\\\" }]\\",\\n \\"EvaluationCount\\": \\"3\\",\\n \\"Expression\\": \\"$Availability=30\\",\\n \\"Level\\": \\"2\\",\\n \\"MetricName\\": \\"Availability\\",\\n \\"Namespace\\": \\"acs_networkmonitor\\",\\n \\"OkActions\\": \\"[ \\\\\\"CloudMonitor\\\\\\"]\\",\\n \\"Period\\": \\"15s\\",\\n \\"RuleId\\": \\"bf071ae_7b7aec3817b0fdf****\\",\\n \\"RuleName\\": \\"rule1\\",\\n \\"StateValue\\": \\"OK\\",\\n \\"Statistics\\": \\"Availability\\",\\n \\"Threshold\\": \\"30\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D17DF650-7EBD-54D0-903A-1D4E624D7402\\",\\n \\"SiteMonitors\\": {\\n \\"Address\\": \\"https://aliyun.com\\",\\n \\"AgentGroup\\": \\"PC\\",\\n \\"CustomSchedule\\": {\\n \\"days\\": {\\n \\"days\\": [\\n 1\\n ]\\n },\\n \\"end_hour\\": 18,\\n \\"start_hour\\": 8,\\n \\"time_zone\\": \\"local\\"\\n },\\n \\"Interval\\": \\"1\\",\\n \\"IspCities\\": {\\n \\"IspCity\\": [\\n {\\n \\"City\\": \\"738\\",\\n \\"CityName\\": \\"北京市\\",\\n \\"Isp\\": \\"465\\",\\n \\"IspName\\": \\"阿里巴巴\\",\\n \\"Type\\": \\"IDC\\"\\n }\\n ]\\n },\\n \\"OptionJson\\": {\\n \\"assertions\\": {\\n \\"assertions\\": [\\n {\\n \\"operator\\": \\"lessThan\\",\\n \\"property\\": \\"json path\\",\\n \\"target\\": \\"0\\",\\n \\"type\\": \\"response_time\\"\\n }\\n ]\\n },\\n \\"attempts\\": 3,\\n \\"auth_info\\": {\\n \\"type\\": \\"basic\\",\\n \\"username\\": \\"test_username\\",\\n \\"password\\": \\"test_password\\",\\n \\"use_cookie_session_key\\": false,\\n \\"grant_type\\": \\"password\\",\\n \\"client_id\\": \\"client_id\\",\\n \\"client_secret\\": \\"client_secret\\",\\n \\"scopes\\": {\\n \\"scopes\\": [\\n \\"test_operation\\"\\n ]\\n },\\n \\"token_url\\": \\"https://www.example.com\\",\\n \\"auth_style\\": \\"ROA\\",\\n \\"access_key_id\\": \\"testAk\\",\\n \\"access_key_secret\\": \\"testSk\\",\\n \\"region_id\\": \\"cn-hangzhou\\",\\n \\"api_action\\": \\"example_api\\",\\n \\"api_version\\": \\"2019-01-01\\",\\n \\"with_addon_resources\\": false,\\n \\"service_name\\": \\"example_service_name\\",\\n \\"session_token\\": \\"example_token\\"\\n },\\n \\"blocked_url_list\\": {\\n \\"blocked_url_list\\": [\\n \\"www.taobao.com/**\\"\\n ]\\n },\\n \\"browser_headers\\": {\\n \\"browser_headers\\": [\\n {\\n \\"key\\": \\"value\\"\\n }\\n ]\\n },\\n \\"browser_hosts\\": {\\n \\"browser_hosts\\": [\\n \\"{\\\\\\"url\\\\\\":\\\\\\"www.taobao.com\\\\\\",\\\\\\"ip\\\\\\":\\\\\\"127.0.0.1\\\\\\"}\\"\\n ]\\n },\\n \\"browser_info\\": {\\n \\"browser_info\\": [\\n {\\n \\"browser\\": \\"Chrome\\",\\n \\"device\\": \\"laptop\\"\\n }\\n ]\\n },\\n \\"browser_insecure\\": false,\\n \\"browser_task_version\\": \\"1\\",\\n \\"cookie\\": \\"lang=en\\",\\n \\"diagnosis_mtr\\": false,\\n \\"diagnosis_ping\\": false,\\n \\"dns_hijack_whitelist\\": \\"www.taobao.com:www.taobao.com.danuoyi.tbcache.com\\",\\n \\"dns_match_rule\\": \\"IN_DNS\\",\\n \\"dns_server\\": \\"192.168.XX.XX\\",\\n \\"dns_type\\": \\"A\\",\\n \\"empty_message\\": false,\\n \\"expect_exist_string\\": {\\n \\"expect_exist_string\\": [\\n \\"expected string\\"\\n ]\\n },\\n \\"expect_non_exist_string\\": {\\n \\"expect_non_exist_string\\": [\\n \\"unexpected string\\"\\n ]\\n },\\n \\"expect_value\\": \\"dns_server\\",\\n \\"failure_rate\\": 0.4,\\n \\"header\\": \\"testKey:testValue\\",\\n \\"http_method\\": \\"get\\",\\n \\"ip_network\\": \\"v4\\",\\n \\"isBase64Encode\\": \\"false\\",\\n \\"match_rule\\": 1,\\n \\"min_tls_version\\": \\"tlsv1.2\\",\\n \\"password\\": \\"123****\\",\\n \\"ping_num\\": 29,\\n \\"ping_port\\": 80,\\n \\"ping_type\\": \\"icmp\\",\\n \\"port\\": 110,\\n \\"protocol\\": \\"TCP\\",\\n \\"quic_enabled\\": true,\\n \\"quic_target\\": {\\n \\"quic_target\\": [\\n \\"www.taobao.com\\"\\n ]\\n },\\n \\"request_content\\": \\"aa=bb\\",\\n \\"request_format\\": \\"txt\\",\\n \\"response_content\\": \\"txt\\",\\n \\"response_format\\": \\"txt\\",\\n \\"retry_delay\\": 0,\\n \\"screen_shot\\": false,\\n \\"strict_mode\\": false,\\n \\"time_out\\": 3,\\n \\"traffic_hijack_element_blacklist\\": {\\n \\"traffic_hijack_element_blacklist\\": [\\n \\"www.taobao.com\\"\\n ]\\n },\\n \\"traffic_hijack_element_count\\": 0,\\n \\"traffic_hijack_element_whitelist\\": {\\n \\"traffic_hijack_element_whitelist\\": [\\n \\"www.taobao.com\\"\\n ]\\n },\\n \\"username\\": \\"testUser\\",\\n \\"waitTime_after_completion\\": 3,\\n \\"scroll_end\\": false,\\n \\"host_binding\\": \\"127.0.0.1:www.aliyun.com\\",\\n \\"host_binding_type\\": 0,\\n \\"hops\\": 20,\\n \\"icmp_timeout_millis\\": 3000,\\n \\"config_variables\\": {\\n \\"config_variables\\": [\\n {\\n \\"name\\": \\"variable_name\\",\\n \\"value\\": \\"variable_value\\",\\n \\"secure\\": true\\n }\\n ]\\n },\\n \\"steps\\": {\\n \\"steps\\": [\\n {\\n \\"name\\": \\"step1\\",\\n \\"step_type\\": \\"http\\",\\n \\"url\\": \\"https://aliyun.com\\",\\n \\"allow_failure\\": true,\\n \\"is_critical\\": true,\\n \\"wait_time_in_secs\\": 5,\\n \\"extracted_variables\\": {\\n \\"extracted_variables\\": [\\n {\\n \\"name\\": \\"test_variable\\",\\n \\"parser\\": {\\n \\"parser_type\\": \\"0\\",\\n \\"value\\": \\"x.testkey.arrayvalue[0].innerkey\\"\\n },\\n \\"field\\": \\"request_id\\",\\n \\"extracted_type\\": \\"1\\"\\n }\\n ]\\n },\\n \\"option\\": \\"{\\\\\\"enable_operator_dns\\\\\\": true}\\",\\n \\"step_name\\": \\"step1\\",\\n \\"use_generated_cookie\\": true,\\n \\"auto_extract_cookie\\": true\\n }\\n ]\\n },\\n \\"trace_region\\": \\"cn-hangzhou\\",\\n \\"trace_type\\": \\"OpenTelemetry\\",\\n \\"safe_link\\": 0,\\n \\"enable_packet_capture\\": true,\\n \\"use_private_crt\\": false,\\n \\"private_crt_file_name\\": \\"cert.pem\\",\\n \\"use_ssl\\": true,\\n \\"max_tls_version\\": \\"tlsv1.3\\",\\n \\"server_name\\": \\"www.aliyun.com\\",\\n \\"supported_cipher_suits\\": \\"TLS_AES_256_GCM_SHA384\\"\\n },\\n \\"TaskId\\": \\"cc641dff-c19d-45f3-ad0a-818a0c4f****\\",\\n \\"TaskName\\": \\"test123\\",\\n \\"TaskState\\": \\"1\\",\\n \\"TaskType\\": \\"HTTP\\",\\n \\"VpcConfig\\": {\\n \\"Region\\": \\"cn-beijing\\",\\n \\"SecurityGroupId\\": \\"sg-xxxxxx\\",\\n \\"VpcId\\": \\"vpc-xxxxxx\\",\\n \\"VswitchId\\": \\"vsw-xxxxxx\\"\\n }\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DescribeSiteMonitorData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Template1', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword of the alert template name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], + 'schema' => ['description' => 'The type of the monitored object whose monitoring data is to be queried. Valid values:'."\n" + ."\n" + .'- metric'."\n" + ."\n" + .'- event', 'type' => 'string', 'required' => false, 'example' => 'metric', 'title' => ''], ], [ - 'name' => 'TemplateId', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert template.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '70****', - ], + 'schema' => ['description' => 'The metric name. Valid values:'."\n" + ."\n" + .'- Availability'."\n" + ."\n" + .'- ResponseTime', 'type' => 'string', 'required' => true, 'example' => 'Availability', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The start of the time range to query. The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" + ."\n" + .'- UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.', 'type' => 'string', 'required' => false, 'example' => '1551579637000', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The end of the time range to query. The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970.'."\n" + ."\n" + .'- UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.', 'type' => 'string', 'required' => false, 'example' => '1551581437000', 'title' => ''], ], [ - 'name' => 'History', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to display the history of applying the alert templates to application groups. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false (default)'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The statistical period. The value is an integral multiple of 60. Unit: seconds.'."\n" + ."\n" + .'> The default value equals the minimum interval at which detection requests are sent to the monitored address.', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting order. Valid values:'."\n" - ."\n" - .'* true (default): ascending order'."\n" - .'* false: descending order'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => '49f7b317-7645-4cc9-94fd-ea42e5220930ea42e5220930ea42e522****', 'title' => ''], ], [ - 'name' => 'OrderBy', + 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting basis. Valid values:'."\n" - ."\n" - .'* gmtMotified: sorts alert templates by modification time'."\n" - .'* gmtCreate (default): sorts alert templates by creation time'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gmtCreate', - ], + 'schema' => ['description' => 'The number of data points to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], ], ], 'responses' => [ @@ -25682,299 +19104,172 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '659401C0-6214-5C02-972A-CFA929D717B7', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Templates' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Template' => [ - 'description' => 'The queried alert templates.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the alert template.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'GmtCreate' => [ - 'description' => 'The timestamp when the alert template was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1646018798000', - ], - 'Name' => [ - 'description' => 'The name of the alert template.'."\n", - 'type' => 'string', - 'example' => 'ECS_Template1', - ], - 'RestVersion' => [ - 'description' => 'The version of the alert template.'."\n" - ."\n" - .'Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'GmtModified' => [ - 'description' => 'The timestamp when the alert template was modified.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1646054798000', - ], - 'TemplateId' => [ - 'description' => 'The ID of the alert template.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '70****', - ], - 'ApplyHistories' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApplyHistory' => [ - 'description' => 'The history of applying the alert templates to application groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3607****', - ], - 'GroupName' => [ - 'description' => 'The name of the application group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - 'ApplyTime' => [ - 'description' => 'The timestamp when the alert template was applied to the application group.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1646055898000', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'NextToken' => ['description' => 'The pagination token.', 'type' => 'string', 'example' => 'ea42e5220930ea42e522****', 'title' => ''], + 'Data' => ['description' => 'The monitoring data.', 'type' => 'string', 'example' => '[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954****","taskId":"49f7b317-7645-4cc9-94fd-ea42e522****","timestamp":1551581760000}]', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3febb181-0d98-4af9-8b04-7faf36b048b9', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"659401C0-6214-5C02-972A-CFA929D717B7\\",\\n \\"Total\\": 2,\\n \\"Success\\": true,\\n \\"Templates\\": {\\n \\"Template\\": [\\n {\\n \\"Description\\": \\"ECS的CPU使用率\\",\\n \\"GmtCreate\\": 1646018798000,\\n \\"Name\\": \\"ECS_Template1\\",\\n \\"RestVersion\\": 0,\\n \\"GmtModified\\": 1646054798000,\\n \\"TemplateId\\": 0,\\n \\"ApplyHistories\\": {\\n \\"ApplyHistory\\": [\\n {\\n \\"GroupId\\": 0,\\n \\"GroupName\\": \\"ECS_Group\\",\\n \\"ApplyTime\\": 1646055898000\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricRuleTemplateListResponse>\\r\\n\\t<RequestId>659401C0-6214-5C02-972A-CFA929D717B7</RequestId>\\r\\n\\t<Total>2</Total>\\r\\n\\t<Templates>\\r\\n\\t\\t<Template>\\r\\n\\t\\t\\t<GmtCreate>1606291110000</GmtCreate>\\r\\n\\t\\t\\t<Description></Description>\\r\\n\\t\\t\\t<GmtModified>1646018798000</GmtModified>\\r\\n\\t\\t\\t<RestVersion>0</RestVersion>\\r\\n\\t\\t\\t<TemplateId>70****</TemplateId>\\r\\n\\t\\t\\t<Name>ECS_Template1</Name>\\r\\n\\t\\t</Template>\\r\\n\\t\\t<Template>\\r\\n\\t\\t\\t<GmtCreate>1607420429000</GmtCreate>\\r\\n\\t\\t\\t<Description></Description>\\r\\n\\t\\t\\t<GmtModified>1646017352000</GmtModified>\\r\\n\\t\\t\\t<RestVersion>1</RestVersion>\\r\\n\\t\\t\\t<TemplateId>71****</TemplateId>\\r\\n\\t\\t\\t<Name>ECS_Template2</Name>\\r\\n\\t\\t</Template>\\r\\n\\t</Templates>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMetricRuleTemplateListResponse>\\t","errorExample":""}]', - 'title' => 'DescribeMetricRuleTemplateList', - 'description' => 'This topic provides an example on how to query alert templates. In this example, the following alert templates are returned in the response: `ECS_Template1` and `ECS_Template2`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', + 'title' => 'DescribeSiteMonitorData', + 'summary' => 'Queries the fine-grained monitoring data of a site monitoring task.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'The returned data contains a JSON string that may consist of several or all of the following parameters:'."\n" + ."\n" + .'- Error4XXRate: the percentage of detection results with 4XX status codes.'."\n" + ."\n" + .'- Error6XXRate: the percentage of detection results with 6XX status codes.'."\n" + ."\n" + .'- Error5XXRate: the percentage of detection results with 5XX status codes.'."\n" + ."\n" + .'- Error4XXNumber: the number of detection results with 4XX status codes.'."\n" + ."\n" + .'- Error5XXNumber: the number of detection results with 5XX status codes.'."\n" + ."\n" + .'- Error6XXNumber: the number of detection results with 6XX status codes.'."\n" + ."\n" + .'- Over5totalTime: the percentage of detection requests to which the response time exceeds 5,000 ms.'."\n" + ."\n" + .'- Over3totalTime: the percentage of detection requests to which the response time exceeds 3,000 ms.'."\n" + ."\n" + .'- Over2totalTime: the percentage of detection requests to which the response time exceeds 2,000 ms.'."\n" + ."\n" + .'- Over10FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 10%.'."\n" + ."\n" + .'- Over100FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 99%.'."\n" + ."\n" + .'- Over30FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 30%.'."\n" + ."\n" + .'- Over50FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 50%.'."\n" + ."\n" + .'- Over80FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 80%.'."\n" + ."\n" + .'- Over90FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 90%.'."\n" + ."\n" + .'- Over400NumberRate: the percentage of detection results with status codes that are greater than 400.'."\n" + ."\n" + .'- Over400NumberRate: the percentage of detection results with status codes that are greater than 500.'."\n" + ."\n" + .'- AvailableNumber: the number of available detection points.'."\n" + ."\n" + .'- UnavailableNumber: the number of unavailable detection points.'."\n" + ."\n" + .'- Availability: the availability rate.'."\n" + ."\n" + .'- Unavailability: the unavailability rate.'."\n" + ."\n" + .'- ErrorCodeMaximum: the maximum error code in the detection results that were returned in a specific period. Assume that five status codes are returned in a minute after detection requests are sent from five detection points. The status code in four detection results is 200 and that in one detection result is 404. In this case, the maximum error code is 404.'."\n" + ."\n" + .'- ErrorCodeMinimum: the minimum error code in the detection results returned in a monitoring period. Assume that five status codes are returned in a minute after detection requests are sent from five detection points. The status code in four detection results is 200 and that in one detection result is 404. In this case, the minimum error code is 200.'."\n" + ."\n" + .'> We recommend that you use the AvailableNumber, UnavailableNumber, Availability, Unavailability, ErrorCodeMaximum, or ErrorCodeMinimum metric, whose value is easy to calculate.', 'extraInfo' => ' ', - ], - 'ApplyMetricRuleTemplate' => [ - 'summary' => 'Applies an alert template to an application group to generate an alert rule.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"ea42e5220930ea42e522****\\",\\n \\"Data\\": \\"[{\\\\\\"Maximum\\\\\\":247,\\\\\\"Mimimum\\\\\\":61,\\\\\\"Average\\\\\\":154,\\\\\\"userId\\\\\\":\\\\\\"127067667954****\\\\\\",\\\\\\"taskId\\\\\\":\\\\\\"49f7b317-7645-4cc9-94fd-ea42e522****\\\\\\",\\\\\\"timestamp\\\\\\":1551581760000}]\\",\\n \\"RequestId\\": \\"3febb181-0d98-4af9-8b04-7faf36b048b9\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\"\\n}","type":"json"}]', + ], + 'DescribeSiteMonitorISPCityList' => [ + 'summary' => 'Queries the details of all carrier detection points by calling the DescribeSiteMonitorISPCityList operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'SilenceTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which notifications are not repeatedly sent for an alert. Unit: seconds. Default value: 86400.'."\n" - ."\n" - .'> Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '86400', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group to which the alert template is applied.'."\n" - ."\n" - .'For more information about how to query the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], - ], - [ - 'name' => 'TemplateIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert template.'."\n" - ."\n" - .'For more information about how to query the IDs of alert templates, see [DescribeMetricRuleTemplateList](~~114982~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '700****', - ], - ], - [ - 'name' => 'EnableStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time period during which the alert rule is effective. Valid values: 00 to 23. A value of 00 indicates 00:00 and a value of 23 indicates 23:00.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '00', - ], - ], - [ - 'name' => 'EnableEndTime', + 'name' => 'Isp', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time period during which the alert rule is effective. Valid values: 00 to 23. A value of 00 indicates 00:59 and a value of 23 indicates 23:59.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '23', - ], + 'schema' => ['description' => 'The name or ID of the carrier detection point.'."\n" + ."\n" + .'> Fuzzy match is supported for carrier names.', 'type' => 'string', 'required' => false, 'example' => 'China Unicom', 'title' => ''], ], [ - 'name' => 'NotifyLevel', + 'name' => 'City', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'Set the value to 4. A value of 4 indicates that alert notifications are sent by using TradeManager and DingTalk chatbots.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '4', - ], + 'schema' => ['description' => 'The name or ID of the city where the carrier detection point resides.'."\n" + ."\n" + .'> Fuzzy match is supported for city names.', 'type' => 'string', 'required' => false, 'example' => 'Guiyang', 'title' => ''], ], [ - 'name' => 'ApplyMode', + 'name' => 'IPV6', 'in' => 'query', - 'schema' => [ - 'description' => 'The mode in which the alert template is applied. Valid values:'."\n" - ."\n" - .'* GROUP_INSTANCE_FIRST: The metrics in the application group take precedence. If a metric specified in the alert template does not exist in the application group, the system does not generate an alert rule for the metric based on the alert template.'."\n" - .'* ALARM_TEMPLATE_FIRST: The metrics specified in the alert template take precedence. If a metric specified in the alert template does not exist in the application group, the system still generates an alert rule for the metric based on the alert template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GROUP_INSTANCE_FIRST', - ], + 'schema' => ['description' => 'Specifies whether to query IPv6 probes. Valid values:'."\n" + .'- true (default): Queries IPv6 probes.'."\n" + .'- false: Does not query IPv6 probes.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Webhook', + 'name' => 'IPV4', 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], + 'schema' => ['description' => 'Specifies whether to query IPv4 probes. Valid values:'."\n" + .'- true (default): Queries IPv4 probes.'."\n" + .'- false: Does not query IPv4 probes.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'AppendMode', + 'name' => 'ViewAll', 'in' => 'query', - 'schema' => [ - 'description' => 'The template application policy. Valid values:'."\n" - ."\n" - .'* all (default): deletes all the rules that are created by using the alert template from the selected application group, and then creates alert rules based on the template.'."\n" - .'* append: deletes the rules that are created by using the alert template from the selected application group, and then creates alert rules based on the existing template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'all', - ], + 'schema' => ['description' => 'Specifies whether to return all detection points. Valid values:'."\n" + ."\n" + .'- true (default): Returns all detection points.'."\n" + .'- false: Returns only available detection points.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -25982,131 +19277,147 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3F897F3C-020A-4993-95B4-63ABB84F83E6', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resource' => [ - 'description' => 'The resources that are affected by the alert rule.'."\n", + 'Code' => ['description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B35D7D84-547B-4E61-B909-48A1F8A0C756', 'title' => ''], + 'Success' => ['description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IspCityList' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'AlertResults' => [ - 'description' => 'The details of the generated alert rule.'."\n", + 'IspCity' => [ + 'description' => '探测点列表。', 'type' => 'array', 'items' => [ + 'description' => '探测点列表。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'alert rule is creating, please wait a few minutes.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'test123', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****', + 'CityName.en' => ['description' => '城市名称（英文）。', 'type' => 'string', 'example' => 'Guiyang', 'title' => ''], + 'IPV4ProbeCount' => ['description' => 'IPv4探针数量。', 'type' => 'string', 'example' => '4', 'title' => ''], + 'City' => ['description' => '城市ID。', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Isp' => ['description' => '运营商ID。', 'type' => 'string', 'example' => '232', 'title' => ''], + 'CityName.zh_CN' => ['description' => '城市名称（简体中文）。'."\n" + .'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '贵阳市', 'title' => ''], + 'Region.zh_CN' => ['description' => '省份（简体中文）。'."\n" + .'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '贵州省', 'title' => ''], + 'IspName.zh_CN' => ['description' => '运营商名称（简体中文）。'."\n" + .'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '联通', 'title' => ''], + 'Country.en' => ['description' => '国家（英文）。', 'type' => 'string', 'example' => 'China', 'title' => ''], + 'IPV6ProbeCount' => ['description' => 'IPv6探针数量。', 'type' => 'string', 'example' => '3', 'title' => ''], + 'Region' => ['description' => '省份代码。', 'type' => 'string', 'example' => '264', 'title' => ''], + 'Country' => ['description' => '国家代码。', 'type' => 'string', 'example' => '629', 'title' => ''], + 'IspName.en' => ['description' => '运营商名称（英文）。', 'type' => 'string', 'example' => 'China-Unicom', 'title' => ''], + 'Region.en' => ['description' => '省份（英文）。', 'type' => 'string', 'example' => 'Guizhou', 'title' => ''], + 'Country.zh_CN' => ['description' => '国家（简体中文）。'."\n" + .'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '中国', 'title' => ''], + 'Area.zh_CN' => ['description' => '区域（简体中文）。'."\n" + ."\n" + .'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '西南', 'title' => ''], + 'Area.en' => ['description' => '区域（汉语拼音）。', 'type' => 'string', 'example' => 'XiNan', 'title' => ''], + 'IPPool' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IPPool' => [ + 'description' => 'IP地址池。', + 'type' => 'array', + 'items' => ['description' => 'IP地址池。', 'type' => 'string', 'example' => '["192.68.XX.XX","192.68.XX.XX"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3F897F3C-020A-4993-95B4-63ABB84F83E6\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"GroupId\\": 123456,\\n \\"AlertResults\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"alert rule is creating, please wait a few minutes.\\",\\n \\"Success\\": true,\\n \\"RuleName\\": \\"test123\\",\\n \\"RuleId\\": \\"applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ApplyMetricRuleTemplateResponse>\\r\\n\\t<RequestId>37D4037E-827E-4E66-87DF-F56A22F2884D</RequestId>\\r\\n\\t<Resource>\\r\\n\\t\\t<GroupId>123456</GroupId>\\r\\n\\t\\t<AlertResults>\\r\\n\\t\\t\\t<Message>alert rule is creating, please wait a few minutes.</Message>\\r\\n\\t\\t\\t<RuleId>applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****</RuleId>\\r\\n\\t\\t\\t<Code>202</Code>\\r\\n\\t\\t\\t<RuleName>test123</RuleName>\\r\\n\\t\\t\\t<Success>true</Success>\\r\\n\\t\\t</AlertResults>\\r\\n\\t</Resource>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</ApplyMetricRuleTemplateResponse>","errorExample":""}]', - 'title' => 'ApplyMetricRuleTemplate', - 'description' => 'In this example, the `700****` alert template is applied to the `123456` application group. For the generated alert rule, the ID is `applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****`, and the name is `test123`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Query details of all carrier detection points', + 'description' => '本文将提供一个示例，查询运营商“联通”在“贵阳市”的探测点详情。', + 'requestParamsDescription' => 'For details about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMetricRuleList' => [ - 'summary' => 'Queries alert rules.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2021-10-28T06:46:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T06:46:29.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorISPCityList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorISPCityList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"B35D7D84-547B-4E61-B909-48A1F8A0C756\\",\\n \\"Success\\": \\"true\\",\\n \\"IspCityList\\": {\\n \\"IspCity\\": [\\n {\\n \\"CityName.en\\": \\"Guiyang\\",\\n \\"IPV4ProbeCount\\": \\"4\\",\\n \\"City\\": \\"4\\",\\n \\"Isp\\": \\"232\\",\\n \\"CityName.zh_CN\\": \\"贵阳市\\",\\n \\"Region.zh_CN\\": \\"贵州省\\",\\n \\"IspName.zh_CN\\": \\"联通\\",\\n \\"Country.en\\": \\"China\\",\\n \\"IPV6ProbeCount\\": \\"3\\",\\n \\"Region\\": \\"264\\",\\n \\"Country\\": \\"629\\",\\n \\"IspName.en\\": \\"China-Unicom\\",\\n \\"Region.en\\": \\"Guizhou\\",\\n \\"Country.zh_CN\\": \\"中国\\",\\n \\"Area.zh_CN\\": \\"西南\\",\\n \\"Area.en\\": \\"XiNan\\",\\n \\"IPPool\\": {\\n \\"IPPool\\": [\\n \\"[\\\\\\"192.68.XX.XX\\\\\\",\\\\\\"192.68.XX.XX\\\\\\"]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeSiteMonitorList' => [ + 'summary' => 'Queries the list of site monitoring tasks by calling the DescribeSiteMonitorList operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26114,1582 +19425,657 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'MetricName', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'For information about how to obtain the name of a metric, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], + 'schema' => ['description' => 'The ID of the site monitoring task.', 'type' => 'string', 'required' => false, 'example' => 'a1ecd34a-8157-44d9-b060-14950837****', 'title' => ''], ], [ - 'name' => 'EnableState', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query enabled or disabled alert rules. Valid values:'."\n" - ."\n" - .'* true: queries enabled alert rules.'."\n" - .'* false: queries disabled alert rules.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The type of the site monitoring task. CloudMonitor supports the following types: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.', 'type' => 'string', 'required' => false, 'example' => 'HTTP', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The keyword used to search for site monitoring tasks.'."\n" + ."\n" + .'> Fuzzy match is supported based on the task name or task address.', 'type' => 'string', 'required' => false, 'example' => 'site', 'title' => ''], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the page to return.'."\n" - ."\n" - .'Minimum value: 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Minimum value: 1. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'AlertState', + 'name' => 'TaskState', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the alert rule. Valid values:'."\n" - ."\n" - .'* OK: The alert rule has no active alerts.'."\n" - .'* ALARM: The alert rule has active alerts.'."\n" - .'* INSUFFICIENT_DATA: No data is available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OK', - ], + 'schema' => ['description' => 'The task status. Valid values:'."\n" + ."\n" + .'- 1: Normal.'."\n" + ."\n" + .'- 2: Disabled.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Dimensions', + 'name' => 'AgentGroup', 'in' => 'query', 'schema' => [ - 'description' => 'The monitoring dimensions of the specified resource.'."\n" + 'description' => 'The type of detection points used by the task. Valid values:'."\n" ."\n" - .'Set the value to a collection of `key:value` pairs. Example: `{"userId":"120886317861****"}` or `{"instanceId":"i-2ze2d6j5uhg20x47****"}`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"instanceId":"i-2ze2d6j5uhg20x47****"}', - ], - ], - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n" + .'- PC: PC-based detection points.'."\n" ."\n" - .'This parameter supports fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Rule_01', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n" + .'- MOBILE: mobile-based detection points.'."\n" ."\n" - .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", + .'- FC: internal detection points.', 'type' => 'string', + 'enum' => ['PC', 'MOBILE', 'FC'], 'required' => false, - 'example' => '7301****', - ], - ], - [ - 'name' => 'RuleIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. You can specify up to 20 IDs at a time. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****', + 'example' => 'PC', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '386C6712-335F-5054-930A-CC92B851ECBA', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid values:'."\n" - ."\n" - .'* true: The call is successful.'."\n" - .'* false: The call fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Alarms' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'SiteMonitors' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Alarm' => [ - 'description' => 'The queried alert rules.'."\n", + 'SiteMonitor' => [ + 'description' => 'The list of site monitoring tasks.', 'type' => 'array', 'items' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'SilenceTime' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400. Minimum value: 3600.'."\n" - ."\n" - .'Only one alert is reported during each mute period even if the metric value consecutively exceeds the alert rule threshold several times.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - ], - 'MetricName' => [ - 'description' => 'The name of the metric.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'Webhook' => [ - 'description' => 'The callback URL. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com', - ], - 'ContactGroups' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'example' => 'ECS_Alarm', - ], - 'SourceType' => [ - 'description' => 'The type of the alert rule. Valid value: METRIC. This value indicates an alert rule for time series metrics.'."\n", - 'type' => 'string', - 'example' => 'METRIC', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'MailSubject' => [ - 'description' => 'The subject of the alert notification email.'."\n", - 'type' => 'string', - 'example' => '"${serviceType}-${metricName}-${levelDescription}Notification(${dimensions})"'."\n", - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is ineffective.'."\n", - 'type' => 'string', - 'example' => '00:00-05:30', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is effective.'."\n", - 'type' => 'string', - 'example' => '05:31-23:59', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'Rule_01', - ], - 'AlertState' => [ - 'description' => 'The status of the alert rule. Valid values:'."\n" - ."\n" - .'* OK: The alert rule has no active alerts.'."\n" - .'* ALARM: The alert rule has active alerts.'."\n" - .'* INSUFFICIENT_DATA: No data is available.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Period' => [ - 'description' => 'The statistical period.'."\n", - 'type' => 'string', - 'example' => '60', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****', - ], - 'GroupName' => [ - 'description' => 'The name of the application group.'."\n" - ."\n" - .'> If the alert rule is associated with an application group, the name of the application group is returned in this parameter.'."\n", - 'type' => 'string', - 'example' => 'ECS_Group', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '7301****', - ], - 'Dimensions' => [ - 'description' => 'The dimensions of the alert rule.'."\n", - 'type' => 'string', - 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', - ], - 'EnableState' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'* true: The alert rule is enabled.'."\n" - .'* false: The alert rule is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resources' => [ - 'description' => 'The resources that are associated with the alert rule.'."\n", - 'type' => 'string', - 'example' => '[{\\"instanceId\\":\\"i-2ze2d6j5uhg20x47****\\"}]', - ], - 'Escalations' => [ - 'description' => 'The conditions for triggering different levels of alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Info' => [ - 'description' => 'The conditions for triggering Info-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'PreCondition' => [ - 'description' => 'The additional conditions for triggering Info-level alerts. The additional conditions take effect when the value of the ComparisonOperator parameter is GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod, or LessThanLastPeriod.'."\n" - ."\n" - .'For example, the values of the PreCondition, ComparisonOperator, and Threshold parameters are set to $Average>80, GreaterThanYesterday, and 10, respectively. An alert is triggered only when the average metric value is greater than 80 and 10% greater than the average metric value at the same time yesterday.'."\n" - ."\n" - .'> $Average is a placeholder that consists of `a dollar sign ($) and the statistical method`. CloudMonitor replaces the placeholder with the aggregated value or original value before value comparison.'."\n", - 'type' => 'string', - 'example' => '$Average>80', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Info-level alerts.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical methods for Info-level alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - 'Warn' => [ - 'description' => 'The conditions for triggering Warn-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'PreCondition' => [ - 'description' => 'The additional conditions for triggering Warn-level alerts. The additional conditions take effect when the value of the ComparisonOperator parameter is GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod, or LessThanLastPeriod.'."\n" - ."\n" - .'For example, the values of the PreCondition, ComparisonOperator, and Threshold parameters are set to $Average>80, GreaterThanYesterday, and 10, respectively. An alert is triggered only when the average metric value is greater than 80 and 10% greater than the average metric value at the same time yesterday.'."\n" - ."\n" - .'> $Average is a placeholder that consists of `a dollar sign ($) and the statistical method`. CloudMonitor replaces the placeholder with the aggregated value or original value before value comparison.'."\n", - 'type' => 'string', - 'example' => '$Average>80', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical methods for Warn-level alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - 'Critical' => [ - 'description' => 'The conditions for triggering Critical-level alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'PreCondition' => [ - 'description' => 'The additional conditions for triggering Critical-level alerts. The additional conditions take effect when the value of the ComparisonOperator parameter is GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod, or LessThanLastPeriod.'."\n" - ."\n" - .'For example, the values of the PreCondition, ComparisonOperator, and Threshold parameters are set to $Average>80, GreaterThanYesterday, and 10, respectively. An alert is triggered only when the average metric value is greater than 80 and 10% greater than the average metric value at the same time yesterday.'."\n" - ."\n" - .'> $Average is a placeholder that consists of `a dollar sign ($) and the statistical method`. CloudMonitor replaces the placeholder with the aggregated value or original value before value comparison.'."\n", - 'type' => 'string', - 'example' => '$Average>80', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n", - 'type' => 'string', - 'example' => '90', - ], - 'Statistics' => [ - 'description' => 'The statistical methods for Critical-level alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - ], - ], - ], - ], - 'NoDataPolicy' => [ - 'description' => 'The method that is used to handle alerts when no monitoring data is found. Valid values:'."\n" - ."\n" - .'* KEEP_LAST_STATE (default value): No operation is performed.'."\n" - .'* INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.'."\n" - .'* OK: The status is considered normal.'."\n", - 'type' => 'string', - 'example' => 'KEEP_LAST_STATE', - ], - 'CompositeExpression' => [ - 'description' => 'The trigger conditions for multiple metrics.'."\n" - ."\n" - .'> The trigger conditions for a single metric and multiple metrics are mutually exclusive. You cannot specify trigger conditions for a single metric and multiple metrics at the same time.'."\n", - 'type' => 'object', - 'properties' => [ - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'example' => 'Critical', - ], - 'ExpressionList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ExpressionList' => [ - 'description' => 'The trigger conditions that are created in standard mode.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'Period' => [ - 'description' => 'The aggregation period of the metric.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Statistics' => [ - 'description' => 'The statistical method of the metric. Valid values:'."\n" - ."\n" - .'* $Maximum: the maximum value'."\n" - .'* $Minimum: the minimum value'."\n" - .'* $Average: the average value'."\n" - .'* $Availability: the availability rate (usually used for site monitoring)'."\n" - ."\n" - .'> `$` is the prefix of the metric. For information about the Alibaba Cloud services that are supported by CloudMonitor, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'example' => '$Maximum', - ], - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '90', - ], - ], - ], - ], - ], - ], - 'ExpressionListJoin' => [ - 'description' => 'The relationship between the trigger conditions for multiple metrics. Valid values:'."\n" - ."\n" - .'* `&&`: An alert is triggered only if all metrics meet the trigger conditions. An alert is triggered only if the results of all expressions specified in the ExpressionList parameter are `true`.'."\n" - .'* `||`: An alert is triggered if one of the metrics meets the trigger conditions.'."\n", - 'type' => 'string', - 'example' => '||', - ], - 'ExpressionRaw' => [ - 'description' => 'The trigger conditions that are created by using expressions. You can use expressions to create trigger conditions in the following scenarios:'."\n" - ."\n" - .'* Set an alert blacklist for specific resources. For example, if you specify `$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50`, no alert is triggered when the `average metric value` of the `i-io8kfvcpp7x5****` instance exceeds 50.'."\n" - .'* Set a special alert threshold for a specified instance in the rule. For example, if you specify `$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)`, an alert is triggered when the `average metric value` of the `i-io8kfvcpp7x5****` instance exceeds 80 or the `average metric value` of other instances exceeds 50.'."\n" - .'* Limit the number of instances whose metric values exceed the threshold. For example, if you specify `count($Average > 20) > 3`, an alert is triggered only when the number of instances whose `average metric value` exceeds 20 exceeds three.'."\n", - 'type' => 'string', - 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', - ], - 'Times' => [ - 'description' => 'The number of consecutive triggers. If the number of times that the metric values meet the trigger conditions reaches the value of this parameter, CloudMonitor sends alert notifications.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - ], - ], - 'Labels' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Labels' => [ - 'description' => 'The tags of the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'cmsRuleKey', - ], - 'Value' => [ - 'description' => 'The tag value of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'cmsRuleValue', - ], - ], - ], - ], - ], - ], - 'Prometheus' => [ - 'description' => 'The Prometheus alerts.'."\n" - ."\n" - .'> This parameter is required only if you create a Prometheus alert rule for Hybrid Cloud Monitoring.'."\n", + 'TaskType' => ['description' => 'The type of the site monitoring task. CloudMonitor supports the following types: HTTP, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.', 'type' => 'string', 'example' => 'TCP', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the site monitoring task was last updated.', 'type' => 'string', 'example' => '2022-03-08 17:14:31', 'title' => ''], + 'Interval' => ['description' => 'The monitoring interval. Unit: minutes.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TaskState' => ['description' => 'The task status. Valid values:'."\n" + ."\n" + .'- 1: Normal.'."\n" + ."\n" + .'- 2: Disabled.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2021-11-01 11:05:18', 'title' => ''], + 'TaskName' => ['description' => 'The name of the site monitoring task.', 'type' => 'string', 'example' => 'New monitoring task', 'title' => ''], + 'Address' => ['description' => 'The URL or IP address that is monitored by the task.', 'type' => 'string', 'example' => 'https://aliyun.com', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the site monitoring task.', 'type' => 'string', 'example' => 'f5783760-1b39-4b6b-80e8-453d962a****', 'title' => ''], + 'OptionsJson' => [ + 'description' => 'The extended options. Each monitoring type has different extended options. For more information, see [CreateSiteMonitor](~~115048~~).', 'type' => 'object', 'properties' => [ - 'PromQL' => [ - 'description' => 'The PromQL query statement.'."\n" - ."\n" - .'> The data obtained by using the PromQL query statement is the monitoring data. You must include the alert threshold in this statement.'."\n", - 'type' => 'string', - 'example' => 'CpuUsage{instanceId="xxxx"}[1m]>90', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'example' => 'Critical', - ], - 'Times' => [ - 'description' => 'The number of consecutive triggers. If the number of times that the metric values meet the trigger conditions reaches the value of this parameter, CloudMonitor sends alert notifications.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Annotations' => [ + 'password' => ['description' => 'The password for the SMTP, POP3, or FTP monitoring type.', 'type' => 'string', 'example' => '123****', 'title' => ''], + 'request_format' => ['description' => 'The format of the HTTP request content. Valid values:'."\n" + .'- hex: hexadecimal format.'."\n" + .'- txt: text format.', 'type' => 'string', 'example' => 'hex', 'title' => ''], + 'response_content' => ['description' => 'The matched response content.'."\n" + .'- Hexadecimal format: When the request content is a byte string that cannot be represented by printable characters, you can convert the byte string to a hexadecimal string. The conversion rule is as follows: each byte is converted to a two-character hexadecimal representation. For example, 1 byte (1B) is converted to `01` in hexadecimal, and 27 bytes (27B) is converted to `1B` in hexadecimal. The binary array (in Java format) `{(byte)1, (byte)27}` is converted to `011b` or `011B` in hexadecimal. Site monitoring is case-insensitive for hexadecimal values. Enter the string `011B` in the request content and set the request content format to hexadecimal.'."\n" + ."\n" + .'- Text format: plain text, which is a string composed of printable characters.', 'type' => 'string', 'example' => 'cf0f85', 'title' => ''], + 'failure_rate' => ['description' => 'The packet loss rate.'."\n" + ."\n" + .'> This parameter is applicable only to the PING monitoring type.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], + 'time_out' => ['description' => 'The timeout period. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000', 'title' => ''], + 'header' => ['description' => 'The HTTP request header. The format is `key1:value1`. Multiple headers are separated by line breaks.', 'type' => 'string', 'example' => 'testKey:testValue', 'title' => ''], + 'cookie' => ['description' => 'The cookie text for the HTTP request.', 'type' => 'string', 'example' => 'lang=en', 'title' => ''], + 'port' => ['description' => 'The port for the TCP, UDP, SMTP, or POP3 monitoring type.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'ping_num' => ['description' => 'The number of PING attempts.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'authentication' => ['description' => 'Specifies whether security authentication is enabled. Valid values:'."\n" + .'- 0: Enabled.'."\n" + .'- 1: Disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'http_method' => ['description' => 'The HTTP request method. Valid values:'."\n" + .'- get '."\n" + .'- post'."\n" + .'- head.', 'type' => 'string', 'example' => 'get', 'title' => ''], + 'match_rule' => ['description' => 'Specifies whether alert rules are included. Valid values:'."\n" + .'- 0: Included.'."\n" + .'- 1: Not included.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'dns_match_rule' => ['description' => 'The DNS matching rule. Valid values:'."\n" + ."\n" + .'- IN_DNS: The expected aliases or IP addresses are all included in the DNS response.'."\n" + .'- DNS_IN: All DNS responses are included in the expected aliases or IP addresses.'."\n" + .'- EQUAL: The DNS response exactly matches the expected aliases or IP addresses.'."\n" + .'- ANY: The DNS response and the expected aliases or IP addresses have an intersection.', 'type' => 'string', 'example' => 'IN_DNS', 'title' => ''], + 'request_content' => ['description' => 'The HTTP request content.', 'type' => 'string', 'example' => 'cf0f85', 'title' => ''], + 'username' => ['description' => 'The username for the FTP, SMTP, or POP3 monitoring type.', 'type' => 'string', 'example' => 'testUser', 'title' => ''], + 'response_format' => ['description' => 'The format of the HTTP response content. Valid values:'."\n" + .'- hex: hexadecimal format.'."\n" + .'- txt: text format.', 'type' => 'string', 'example' => 'hex', 'title' => ''], + 'dns_type' => ['description' => 'The DNS resolution type. This parameter is applicable only to the DNS monitoring type. Valid values:'."\n" + .'- A (default): specifies the IP address that corresponds to the hostname or domain name.'."\n" + .'- CNAME: maps multiple domain names to another domain name.'."\n" + .'- NS: specifies the DNS server that resolves the domain name.'."\n" + .'- MX: points the domain name to a mail server address.'."\n" + .'- TXT: the description of the hostname or domain name. The text length is limited to 512 bytes. This type is typically used for Sender Policy Framework (SPF) records for anti-spam purposes.'."\n" + .'- AAAA: the DNS record that resolves a domain name to an IPv6 address.', 'type' => 'string', 'example' => 'A', 'title' => ''], + 'dns_server' => ['description' => 'The domain name or IP address of the specified DNS server.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'enable_operator_dns' => ['description' => 'Specifies whether to use the carrier DNS. Valid values:'."\n" + .'- true (default): Uses the carrier DNS.'."\n" + .'- false: Does not use the carrier DNS. Uses the default DNS or the DNS of the specified server.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'attempts' => ['description' => 'The number of retries after a DNS failure.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'protocol' => ['description' => 'The DNS protocol type. Valid values:'."\n" + .'- udp (default)'."\n" + .'- tcp'."\n" + .'- tcp-tls.', 'type' => 'string', 'example' => 'udp', 'title' => ''], + 'proxy_protocol' => ['description' => 'Specifies whether ProxyProtocol is enabled. Valid values:'."\n" + .'- false (default): ProxyProtocol is disabled.'."\n" + .'- true: ProxyProtocol is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'acceptable_response_code' => ['description' => 'The acceptable status codes. '."\n" + ."\n" + .'> Use assertion configurations instead.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'isBase64Encode' => ['description' => 'Specifies whether to store the password after Base64 decoding. Valid values:'."\n" + .'- true: Stores the password after Base64 decoding.'."\n" + .'- false (default): Does not store the password after Base64 decoding.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'cert_verify' => ['description' => 'Specifies whether to verify the certificate. Valid values:'."\n" + .'- false (default): Skips certificate verification.'."\n" + .'- true: Verifies the certificate.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'unfollow_redirect' => ['description' => 'Specifies whether to follow redirects when a 301 or 302 status code is returned. Valid values:'."\n" + .'- true: Does not follow redirects.'."\n" + .'- false (default): Follows redirects.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'diagnosis_mtr' => ['description' => 'Specifies whether to enable automatic MTR network diagnostics after a task failure. Valid values:'."\n" + .'- false (default): Disables automatic MTR network diagnostics.'."\n" + .'- true: Enables automatic MTR network diagnostics.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'diagnosis_ping' => ['description' => 'Specifies whether to enable automatic Ping network latency detection after a monitoring task failure. Valid values:'."\n" + .'- false (default): Disabled.'."\n" + .'- true: Enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'retry_delay' => ['description' => 'The number of retries after a monitoring failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'assertions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Annotations' => [ - 'description' => 'The annotations of the Prometheus alert rule. When a Prometheus alert is triggered, the system renders the annotated keys and values to help you understand the metrics and alert rule.'."\n" - ."\n" - .'> This parameter is equivalent to the annotations parameter of open source Prometheus.'."\n", + 'assertions' => [ + 'description' => 'The assertion configuration group.', 'type' => 'array', 'items' => [ - 'description' => 'None.'."\n", + 'description' => 'The assertion configuration group.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the annotation.'."\n", - 'type' => 'string', - 'example' => 'summary', - ], - 'Value' => [ - 'description' => 'The value of the annotation.'."\n", - 'type' => 'string', - 'example' => '{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }', - ], + 'property' => ['description' => 'The parsing path for the assertion content.'."\n" + ."\n" + .'- If the assertion type is `body_json`, the path is a `json path`.'."\n" + ."\n" + .'- If the assertion type is `body_xml`, the path is an `xml path`.', 'type' => 'string', 'example' => 'json path', 'title' => ''], + 'type' => ['description' => 'The assertion type. Valid values:'."\n" + .'- response_time: determines whether the response time meets expectations.'."\n" + .'- status_code: determines whether the HTTP response status code meets expectations.'."\n" + .'- header: determines whether a field in the response header meets expectations.'."\n" + .'- body_text: determines whether the response body content meets expectations through text character matching.'."\n" + .'- body_json: determines whether the response body content meets expectations through JSON parsing (JSON Path).'."\n" + .'- body_xml: determines whether the response body content meets expectations through XML parsing (XPath).', 'type' => 'string', 'example' => 'response_time', 'title' => ''], + 'operator' => ['description' => 'The assertion comparison operator. Valid values:'."\n" + .'- contains: contains.'."\n" + .'- doesNotContain: does not contain.'."\n" + .'- matches: matches a regular expression.'."\n" + .'- doesNotMatch: does not match a regular expression.'."\n" + .'- is: equals (numeric or string).'."\n" + .'- isNot: does not equal.'."\n" + .'- lessThan: less than.'."\n" + .'- moreThan: greater than.', 'type' => 'string', 'example' => 'lessThan', 'title' => ''], + 'target' => ['description' => 'The target value or string for assertion comparison.', 'type' => 'string', 'example' => '1000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'ProductCategory' => [ - 'type' => 'string', - ], - 'GmtCreate' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'GmtUpdate' => [ - 'type' => 'string', - ], + 'AgentGroup' => ['description' => 'The type of detection point. Valid values:'."\n" + ."\n" + .'- PC: PC-based.'."\n" + .'- MOBILE: mobile-based.', 'type' => 'string', 'example' => 'PC', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'The Request is not authorization.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"386C6712-335F-5054-930A-CC92B851ECBA\\",\\n \\"Total\\": \\"1\\",\\n \\"Success\\": true,\\n \\"Alarms\\": {\\n \\"Alarm\\": [\\n {\\n \\"SilenceTime\\": 86400,\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Webhook\\": \\"https://www.aliyun.com\\",\\n \\"ContactGroups\\": \\"ECS_Alarm\\",\\n \\"SourceType\\": \\"METRIC\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"MailSubject\\": \\"\\\\\\"${serviceType}-${metricName}-${levelDescription}通知（${dimensions}）\\\\\\"\\",\\n \\"NoEffectiveInterval\\": \\"00:00-05:30\\",\\n \\"EffectiveInterval\\": \\"05:31-23:59\\",\\n \\"RuleName\\": \\"Rule_01\\",\\n \\"AlertState\\": \\"OK\\",\\n \\"Period\\": \\"60\\",\\n \\"RuleId\\": \\"applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****\\",\\n \\"GroupName\\": \\"ECS_Group\\",\\n \\"GroupId\\": \\"7301****\\",\\n \\"Dimensions\\": \\"[{\\\\\\"instanceId\\\\\\":\\\\\\"i-2ze2d6j5uhg20x47****\\\\\\"}]\\",\\n \\"EnableState\\": true,\\n \\"Resources\\": \\"[{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-2ze2d6j5uhg20x47****\\\\\\\\\\\\\\"}]\\",\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"PreCondition\\": \\"$Average>80\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"PreCondition\\": \\"$Average>80\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"PreCondition\\": \\"$Average>80\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n },\\n \\"NoDataPolicy\\": \\"KEEP_LAST_STATE\\",\\n \\"CompositeExpression\\": {\\n \\"Level\\": \\"CRITICAL\\",\\n \\"ExpressionList\\": {\\n \\"ExpressionList\\": [\\n {\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Period\\": 60,\\n \\"Statistics\\": \\"$Maximum\\",\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Threshold\\": \\"90\\"\\n }\\n ]\\n },\\n \\"ExpressionListJoin\\": \\"||\\",\\n \\"ExpressionRaw\\": \\"$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)\\",\\n \\"Times\\": 3\\n },\\n \\"Labels\\": {\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"cmsRuleKey\\",\\n \\"Value\\": \\"cmsRuleValue\\"\\n }\\n ]\\n },\\n \\"Prometheus\\": {\\n \\"PromQL\\": \\"CpuUsage{instanceId=\\\\\\"xxxx\\\\\\"}[1m]>90\\",\\n \\"Level\\": \\"CRITICAL\\",\\n \\"Times\\": 3,\\n \\"Annotations\\": {\\n \\"Annotations\\": [\\n {\\n \\"Key\\": \\"summary\\",\\n \\"Value\\": \\"{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }\\"\\n }\\n ]\\n }\\n },\\n \\"ProductCategory\\": \\"slb\\",\\n \\"GmtCreate\\": 1760432061000,\\n \\"GmtUpdate\\": \\"1760432061000\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricRuleListResponse>\\r\\n\\t<RequestId>386C6712-335F-5054-930A-CC92B851ECBA</RequestId>\\r\\n\\t<Total>1</Total>\\r\\n\\t<Alarms>\\r\\n\\t\\t<Alarm>\\r\\n\\t\\t\\t<GroupName>ECS_Group</GroupName>\\r\\n\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t<ContactGroups>ECS_Alarm</ContactGroups>\\r\\n\\t\\t\\t<NoEffectiveInterval>00:00-05:30</NoEffectiveInterval>\\r\\n\\t\\t\\t<GroupBy>group</GroupBy>\\r\\n\\t\\t\\t<MailSubject>${serviceType}-${metricName}-${levelDescription}通知（${dimensions}）</MailSubject>\\r\\n\\t\\t\\t<SourceType>METRIC</SourceType>\\r\\n\\t\\t\\t<RuleId>applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****</RuleId>\\r\\n\\t\\t\\t<Period>60</Period>\\r\\n\\t\\t\\t<Dimensions>\\r\\n\\t\\t\\t\\t<instanceId>i-2ze2d6j5uhg20x47****</instanceId>\\r\\n\\t\\t\\t</Dimensions>\\r\\n\\t\\t\\t<EffectiveInterval>05:31-23:59</EffectiveInterval>\\r\\n\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t<AlertState>OK</AlertState>\\r\\n\\t\\t\\t<GroupId>7301****</GroupId>\\r\\n\\t\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t\\t<EnableState>true</EnableState>\\r\\n\\t\\t\\t<Escalations>\\r\\n\\t\\t\\t\\t<Critical>\\r\\n\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t<Threshold>90</Threshold>\\r\\n\\t\\t\\t\\t</Critical>\\r\\n\\t\\t\\t\\t<Info>\\r\\n\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t<Threshold>90</Threshold>\\r\\n\\t\\t\\t\\t</Info>\\r\\n\\t\\t\\t\\t<Warn>\\r\\n\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t<Threshold>90</Threshold>\\r\\n\\t\\t\\t\\t</Warn>\\r\\n\\t\\t\\t</Escalations>\\r\\n\\t\\t\\t<Webhook>https://www.aliyun.com</Webhook>\\r\\n\\t\\t\\t<Resources>[{\\\\\\"instanceId\\\\\\":\\\\\\"i-2ze2d6j5uhg20x47****\\\\\\"}]</Resources>\\r\\n\\t\\t\\t<RuleName>Rule_01</RuleName>\\r\\n\\t\\t</Alarm>\\r\\n\\t</Alarms>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMetricRuleListResponse>\\t","errorExample":""}]', - 'title' => 'DescribeMetricRuleList', - 'description' => 'This topic provides an example on how to query all alert rules within your Alibaba Cloud account. The returned result shows that only one alert rule is found. The name of the alert rule is `Rule_01` and the ID is `applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Query site monitoring tasks', + 'description' => 'This topic provides an example of how to query the list of site monitoring tasks for the current account. The response shows that the current account has one site monitoring task named `HanZhou_ECS2`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateGroupMetricRules' => [ - 'summary' => 'Creates one or more alert rules for a specified application group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-05-07T03:43:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-22T07:54:08.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-17T07:34:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-05-30T06:34:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-16T09:06:08.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"SiteMonitors\\": {\\n \\"SiteMonitor\\": [\\n {\\n \\"TaskType\\": \\"TCP\\",\\n \\"UpdateTime\\": \\"2022-03-08 17:14:31\\",\\n \\"Interval\\": \\"1\\",\\n \\"TaskState\\": \\"1\\",\\n \\"CreateTime\\": \\"2021-11-01 11:05:18\\",\\n \\"TaskName\\": \\"New monitoring task\\",\\n \\"Address\\": \\"https://aliyun.com\\",\\n \\"TaskId\\": \\"f5783760-1b39-4b6b-80e8-453d962a****\\",\\n \\"OptionsJson\\": {\\n \\"password\\": \\"123****\\",\\n \\"request_format\\": \\"hex\\",\\n \\"response_content\\": \\"cf0f85\\",\\n \\"failure_rate\\": 0.5,\\n \\"time_out\\": 3000,\\n \\"header\\": \\"testKey:testValue\\",\\n \\"cookie\\": \\"lang=en\\",\\n \\"port\\": 80,\\n \\"ping_num\\": 20,\\n \\"authentication\\": 1,\\n \\"http_method\\": \\"get\\",\\n \\"match_rule\\": 0,\\n \\"dns_match_rule\\": \\"IN_DNS\\",\\n \\"request_content\\": \\"cf0f85\\",\\n \\"username\\": \\"testUser\\",\\n \\"response_format\\": \\"hex\\",\\n \\"dns_type\\": \\"A\\",\\n \\"dns_server\\": \\"192.168.XX.XX\\",\\n \\"enable_operator_dns\\": true,\\n \\"attempts\\": 3,\\n \\"protocol\\": \\"udp\\",\\n \\"proxy_protocol\\": false,\\n \\"acceptable_response_code\\": \\"400\\",\\n \\"isBase64Encode\\": \\"false\\",\\n \\"cert_verify\\": false,\\n \\"unfollow_redirect\\": false,\\n \\"diagnosis_mtr\\": false,\\n \\"diagnosis_ping\\": false,\\n \\"retry_delay\\": 1,\\n \\"assertions\\": {\\n \\"assertions\\": [\\n {\\n \\"property\\": \\"json path\\",\\n \\"type\\": \\"response_time\\",\\n \\"operator\\": \\"lessThan\\",\\n \\"target\\": \\"1000\\"\\n }\\n ]\\n }\\n },\\n \\"AgentGroup\\": \\"PC\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeSiteMonitorLog' => [ + 'summary' => 'Call the DescribeSiteMonitorLog operation to query the detection logs for a one-time detection task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'TaskIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The ID of the detection task. You can specify multiple task IDs. Separate them with commas (,).', 'type' => 'string', 'required' => true, 'example' => 'afa5c3ce-f944-4363-9edb-ce919a29****', 'title' => ''], ], [ - 'name' => 'GroupMetricRules', + 'name' => 'Isp', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The statistical methods for Warn-level alerts. Separate multiple statistical methods with commas (,). Valid values of N: 1 to 200. Valid value:'."\n" - ."\n" - .'* Average: the average value'."\n" - .'* Minimum: the minimum value'."\n" - .'* Maximum: the maximum value'."\n", - 'type' => 'object', - 'properties' => [ - 'Escalations.Info.Threshold' => [ - 'description' => 'The threshold for Info-level alerts. Valid values of N: 1 to 200.', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'MetricName' => [ - 'description' => 'The name of the metric. Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain the name of a metric, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_total', - ], - 'Escalations.Warn.Threshold' => [ - 'description' => 'The threshold for Warn-level alerts. Valid values of N: 1 to 200.', - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is effective. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '05:31-23:59', - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is ineffective. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-05:30', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '456789', - ], - 'Escalations.Critical.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered. Valid values of N: 1 to 200.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Dimensions' => [ - 'description' => 'The dimension of the alert rule. Valid values of N: 1 to 200.'."\n" - ."\n" - .'Set the value to a set of key-value pairs, for example, `userId:120886317861****` or `instanceId:i-m5e1qg6uo38rztr4****`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId":"i-m5e1qg6uo38rztr4****"}]', - ], - 'Escalations.Critical.Threshold' => [ - 'description' => 'The threshold for Critical-level alerts. Valid values of N: 1 to 200.', - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - 'Escalations.Critical.Statistics' => [ - 'description' => 'The statistical methods for Critical-level alerts. Separate multiple statistical methods with commas (,). Valid values of N: 1 to 200. Valid value: '."\n" - ."\n" - .'- Average: the average value'."\n" - .'- Minimum: the minimum value'."\n" - .'- Maximum: the maximum value', - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Warn.ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values of N: 1 to 200. Valid value: '."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'- GreaterThanThreshold: greater than the threshold'."\n" - .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'- LessThanThreshold: less than the threshold'."\n" - .'- NotEqualToThreshold: not equal to the threshold'."\n" - .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Info.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered. Valid values of N: 1 to 200.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'SilenceTime' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met. Valid values of N: 1 to 200.'."\n" - ."\n" - .'Unit: seconds. Default value: 86400. Minimum value: 3600.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], - 'Webhook' => [ - 'description' => 'The callback URL. Valid values of N: 1 to 200.'."\n" - ."\n" - .'The callback URL must be accessible over the Internet. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service. Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], - 'EmailSubject' => [ - 'description' => 'The subject of the alert notification email. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Period' => [ - 'description' => 'The aggregation period of the metric data. Valid values of N: 1 to 200.'."\n" - ."\n" - .'Set the `Period` parameter to an integral multiple of 60. Unit: seconds. Default value: 300.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule. Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Rule1', - ], - 'Escalations.Info.Statistics' => [ - 'description' => 'The statistical methods for Info-level alerts. Separate multiple statistical methods with commas (,). Valid values of N: 1 to 200. Valid value: '."\n" - ."\n" - .'- Average: the average value'."\n" - .'- Minimum: the minimum value'."\n" - .'- Maximum: the maximum value', - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Warn.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered. Valid values of N: 1 to 200.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Escalations.Info.ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values of N: 1 to 200. Valid value: '."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'- GreaterThanThreshold: greater than the threshold'."\n" - .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'- LessThanThreshold: less than the threshold'."\n" - .'- NotEqualToThreshold: not equal to the threshold'."\n" - .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Interval' => [ - 'description' => 'The interval at which CloudMonitor checks whether the alert rule is triggered. Valid values of N: 1 to 200.'."\n" - ."\n" - .'Unit: seconds. The default value is the lowest frequency at which the metric is polled.'."\n" - ."\n" - .'> We recommend that you set the interval to the data aggregation period. If the interval is shorter than the data aggregation period, alerts cannot be triggered due to insufficient data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - 'Category' => [ - 'description' => 'The name of the cloud service. Valid values of N: 1 to 200. Valid value:'."\n" - ."\n" - .'* PolarDB: PolarDB'."\n" - .'* NewBGPDDoS: Anti-DDoS Pro'."\n" - .'* IoTDevice: IoT Platform'."\n" - .'* DRDS: Distributed Relational Database Service (DRDS)'."\n" - .'* VS: Video Surveillance System'."\n" - .'* AMQP: Alibaba Cloud Message Queue for AMQP'."\n" - .'* ADS: AnalyticDB'."\n" - .'* APIGateway: API Gateway'."\n" - .'* InternetSharedBandwidth: EIP Bandwidth Plan'."\n" - .'* CDN: Alibaba Cloud Content Delivery Network (CDN)'."\n" - .'* CEN: Cloud Enterprise Network (CEN)'."\n" - .'* DCDN: Dynamic Route for CDN (DCDN)'."\n" - .'* DDoS: Anti-DDoS'."\n" - .'* ECS: Elastic Compute Service (ECS)'."\n" - .'* DirectMail: Direct Mail'."\n" - .'* Elasticsearch: Elasticsearch'."\n" - .'* EMR: E-MapReduce (EMR)'."\n" - .'* ESS: Auto Scaling'."\n" - .'* FunctionCompute: Function Compute'."\n" - .'* RealtimeCompute: Realtime Compute for Apache Flink'."\n" - .'* GlobalAcceleration: Global Accelerator (GA)'."\n" - .'* Hbase: ApsaraDB for HBase'."\n" - .'* TSDB: Time Series Database (TSDB)'."\n" - .'* IPv6trans: IPv6 Translation Service'."\n" - .'* Kafka: Message Queue for Apache Kafka'."\n" - .'* Kubernetes: Container Service for Kubernetes (ACK)'."\n" - .'* KVstore: ApsaraDB for Redis'."\n" - .'* MNS: Message Service (MNS)'."\n" - .'* MongoDB: ApsaraDB for MongoDB'."\n" - .'* MQ: Message Queue'."\n" - .'* NAT: NAT Gateway'."\n" - .'* OpenAd: Open Ad'."\n" - .'* OpenSearch: Open Search'."\n" - .'* OSS: Object Storage Service (OSS)'."\n" - .'* PCDN: P2P CDN'."\n" - .'* petadata: HybridDB for MySQL'."\n" - .'* RDS: ApsaraDB RDS'."\n" - .'* SCDN: Secure CDN'."\n" - .'* SLB: Server Load Balancer (SLB)'."\n" - .'* SLS: Log Service'."\n" - .'* VideoLive: ApsaraVideo Live'."\n" - .'* VOD: ApsaraVideo VOD'."\n" - .'* EIP: Elastic IP Address (EIP)'."\n" - .'* VPN: VPN Gateway'."\n" - .'* AIRec: Artificial Intelligence Recommendation'."\n" - .'* GPDB: AnalyticDB for PostgreSQL'."\n" - .'* DBS: Database Backup (DBS)'."\n" - .'* SAG: Smart Access Gateway (SAG)'."\n" - .'* Memcache: ApsaraDB for Memcache'."\n" - .'* IOT_EDGE: Link IoT Edge'."\n" - .'* OCS: ApsaraDB for Memcache (previous version)'."\n" - .'* VPC: Express Connect'."\n" - .'* EHPC: Elastic High Performance Computing (E-HPC)'."\n" - .'* MPS: ApsaraVideo Media Processing'."\n" - .'* ENS: Edge Node Service (ENS)'."\n" - .'* MaxCompute_Prepay: MaxCompute'."\n" - .'* IoT_Kubernetes: Edge Application Hosting'."\n" - .'* CMS: CloudMonitor'."\n" - .'* batchcomputenew: Batch Compute'."\n" - .'* HBaseUE: ApsaraDB for HBase Performance-enhanced Edition'."\n" - .'* UIS: Ultimate Internet Service (UIS)'."\n" - .'* nls: Intelligent Speech Interaction'."\n" - .'* ots: Tablestore'."\n" - .'* NAS: File Storage NAS'."\n" - .'* ECI: Elastic Container Instance (ECI)'."\n" - .'* OpenAPI: OpenAPI Explorer'."\n" - .'* pvtzpost: Alibaba Cloud DNS PrivateZone'."\n" - .'* blinkonk8s: Flink on Kubernetes'."\n" - .'* FunctionFlow: Serverless Workflow (SWF)'."\n" - .'* SMC: Server Migration Center (SMC)'."\n" - .'* ddosbgp: Anti-DDoS Origin'."\n" - .'* baas: Blockchain as a Service'."\n" - .'* privatelink: PrivateLink'."\n" - .'* cds: ApsaraDB for Cassandra'."\n" - .'* DDH: Dedicated Host'."\n" - .'* RocketMQ: Message Queue for Apache RocketMQ'."\n" - .'* ECC: Express Cloud Connect'."\n" - .'* hbaseserverless: ApsaraDB for HBase Serverless Edition'."\n" - .'* mns_tmp: Message Service'."\n" - .'* hdr: Hybrid Disaster Recovery (HDR)'."\n" - .'* hbr: Hybrid Backup Recovery (HBR)'."\n" - .'* ADB: AnalyticDB for MySQL V3.0'."\n" - .'* tag: Tag Service'."\n" - .'* GDB: Graph Database'."\n" - .'* WAF: Web Application Firewall (WAF)'."\n" - .'* hcs_sgw: Cloud Storage Gateway (CSG)'."\n" - .'* ipv6gateway: IPv6 Gateway'."\n" - .'* RDS_SAR: ApsaraDB Exclusive Host Group'."\n" - .'* learn: Machine Learning Platform for AI'."\n" - .'* ROS: Resource Orchestration Service (ROS)'."\n" - .'* OOS: Operation Orchestration Service (OOS)'."\n" - .'* bds: Data Synchronization for HBase'."\n" - .'* cfw: Cloud Firewall'."\n" - .'* ddosDip: Anti-DDoS Premium'."\n" - .'* datahub: DataHub'."\n" - .'* hologres: Hologres'."\n" - .'* ExpressConnect: Express Connect'."\n" - .'* dbfs: Database File System (DBFS)'."\n" - .'* clickhouse: ApsaraDB for ClickHouse'."\n" - .'* k8s: Container Service for Kubernetes (ACK)'."\n" - .'* DTS: Data Transmission Service (DTS)'."\n" - .'* AnycastEIP: Anycast Elastic IP Address'."\n" - .'* Lindorm: ApsaraDB for Lindorm'."\n" - .'* config: Cloud Config'."\n" - .'* spark: Databricks DataInsight (DDI)'."\n" - .'* serverless: Serverless App Engine (SAE)'."\n" - .'* alb: Application Load Balancer (ALB)'."\n" - .'* oceanbase: ApsaraDB for OceanBase'."\n" - .'* KMS: Key Management Service (KMS)'."\n" - .'* lvwang: Content Moderation'."\n" - .'* LinkVisual: LinkVisual'."\n" - .'* tair: ApsaraDB for Redis Enhanced Edition (Tair)'."\n" - .'* dlf: Data Lake Formation (DLF)'."\n" - .'* networkmonitor: Site Monitoring'."\n" - .'* pnc: Physical Network Change'."\n" - .'* AIS: Alibaba Cloud Infrastructure'."\n" - .'* cloudgame: Cloud Gaming Platform'."\n" - .'* RTC: Real-Time Communication'."\n" - .'* cloudbox: CloudBox'."\n" - .'* actiontrail: ActionTrail'."\n" - .'* cc: Cloud Connector'."\n" - .'* disk: Elastic Block Storage (EBS)'."\n" - .'* easygene: Genomics Computing Platform'."\n" - .'* cloudphone: Elastic Cloud Phone'."\n" - .'* BMS: Bare Metal Management Service'."\n" - .'* swas: Simple Application Server'."\n" - .'* AvailabilityMonitoring: Availability Monitoring of CloudMonitor', - 'type' => 'string', - 'required' => true, - 'example' => 'ECS', - ], - 'Escalations.Critical.ComparisonOperator' => [ - 'description' => 'The comparison operator that is used to compare the metric value with the threshold. Valid values of N: 1 to 200. Valid value: '."\n" - ."\n" - .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'- GreaterThanThreshold: greater than the threshold'."\n" - .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'- LessThanThreshold: less than the threshold'."\n" - .'- NotEqualToThreshold: not equal to the threshold'."\n" - .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Warn.Statistics' => [ - 'description' => 'The statistical methods for Warn-level alerts. Separate multiple statistical methods with commas (,). Valid values of N: 1 to 200. Valid value: '."\n" - ."\n" - .'- Average: the average value'."\n" - .'- Minimum: the minimum value'."\n" - .'- Maximum: the maximum value', - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'NoDataPolicy' => [ - 'description' => 'The method that is used to handle alerts when no monitoring data is found. Valid values of N: 1 to 200. Valid value:'."\n" - ."\n" - .'* KEEP_LAST_STATE (default value): No operation is performed.'."\n" - .'* INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.'."\n" - .'* OK: The alert rule has no active alerts.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'KEEP_LAST_STATE', - ], - 'ContactGroups' => [ - 'description' => 'The alert contact groups. Valid values of N: 1 to 200.'."\n" - ."\n" - .'For information about how to obtain alert contact groups, see [DescribeContactGroupList](~~114922~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Group', - ], - 'Labels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the alert rule. The specified tag is contained in alert notifications.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value of the alert rule. The specified tag is contained in alert notifications.'."\n" - ."\n" - .'Valid values of N: 1 to 200.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - 'minItems' => 0, - ], - 'Options' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "NotSendOK": true'."\n" - .'}', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 200, - ], + 'schema' => ['description' => 'The carrier ID.', 'type' => 'string', 'required' => false, 'example' => '465', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. Valid value:'."\n" - ."\n" - .'- true: The call is successful.'."\n" - .'- false: The call fails.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resources' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AlertResult' => [ - 'description' => 'The details of the alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The status code that is returned for the alert rule.'."\n" - ."\n" - .'> The status code 200 indicates that the call is successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message that is returned for the alert rule.'."\n", - 'type' => 'string', - 'example' => 'Metric not found.', - ], - 'Success' => [ - 'description' => 'Indicates whether the alert rule was created. Valid value:'."\n" - ."\n" - .'- true: The alert rule was created.'."\n" - .'- false: The alert rule failed to be created.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'ECS_Rule1', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => '456789', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => ['description' => 'The city ID.', 'type' => 'string', 'required' => false, 'example' => '546', 'title' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The metric.'."\n" + ."\n" + .'Only the `ProbeLog` metric is supported.', 'type' => 'string', 'required' => false, 'example' => 'ProbeLog', 'title' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since January 1, 1970.'."\n" + ."\n" + .'- UTC format: YYYY-MM-DDThh:mm:ssZ.'."\n" + ."\n" + .'> * The start time and end time follow the (StartTime, EndTime] pattern. The value of StartTime cannot be the same as or later than the value of EndTime.<br> - Use UNIX timestamps to prevent time zone-related issues.<br>', 'type' => 'string', 'required' => false, 'example' => '1638422474389', 'title' => ''], ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. The following formats are supported:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds that have elapsed since January 1, 1970.'."\n" + ."\n" + .'- UTC format: YYYY-MM-DDThh:mm:ssZ.'."\n" + ."\n" + .'> Use UNIX timestamps to prevent time zone-related issues.', 'type' => 'string', 'required' => false, 'example' => '1638422475687', 'title' => ''], ], - 412 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'If the response is truncated, use the `NextToken` parameter to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'IWBjqMYSy0is7zSMGu16****', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => '500', - 'errorMessage' => '%s', - ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page for a paged query. Valid values: 1 to 1440.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D\\",\\n \\"Success\\": true,\\n \\"Resources\\": {\\n \\"AlertResult\\": [\\n {\\n \\"Code\\": 200,\\n \\"Message\\": \\"Metric not found.\\",\\n \\"Success\\": true,\\n \\"RuleName\\": \\"ECS_Rule1\\",\\n \\"RuleId\\": \\"456789\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateGroupMetricRulesResponse>\\r\\n\\t<RequestId>CED22B00-CFD8-5BDF-A645-CAF7B81FAE45</RequestId>\\r\\n\\t<Resources>\\r\\n\\t\\t<AlertResult>\\r\\n\\t\\t\\t<RuleId>456789</RuleId>\\r\\n\\t\\t\\t<Code>200</Code>\\r\\n\\t\\t\\t<Success>true</Success>\\r\\n\\t\\t\\t<RuleName>ECS_Rule1</RuleName>\\r\\n\\t\\t</AlertResult>\\r\\n\\t</Resources>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</CreateGroupMetricRulesResponse>\\t","errorExample":""}]', - 'title' => 'CreateGroupMetricRules', - 'description' => 'This topic provides an example to show how to create an alert rule for the `cpu_total` metric of Elastic Compute Service (ECS) in the `123456` application group. The ID of the alert rule is `456789`. The name of the alert rule is `ECS_Rule1`. The alert level is `Critical`. The statistical method is `Average`. The comparison operator is `GreaterThanOrEqualToThreshold`. The alert threshold is `90`. The number of alert retries is `3`. The response shows that the alert rule named `ECS_Rule1` is created.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateMetricRuleResources' => [ - 'summary' => 'Associates resources with an alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['description' => 'The filter expression for detection results.'."\n" + ."\n" + .'Simple expressions are supported. For example, you can use the `TotalTime>100` expression to query the detection data whose total response time exceeds 100 milliseconds.', 'type' => 'string', 'required' => false, 'example' => 'TotalTime>100', 'title' => ''], ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'RuleId', + 'name' => 'BrowserInfo', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'i-2ze3w55tr2rcpejpcfap_59c96b85-0339-4f35-ba66-ae4e34d3****', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'This parameter is deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], ], [ - 'name' => 'Overwrite', + 'name' => 'Browser', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'Specifies whether to overwrite existing resources. Valid values:'."\n" - ."\n" - .'* true: The resources submitted this time overwrite the previously associated resources.'."\n" - .'* false: The resources submitted this time do not overwrite the previously associated resources. The associated resources after submission include the previously associated resources and the resources submitted this time.'."\n", + 'description' => 'The type of the browser.', + 'enumValueTitles' => [' Chrome' => 'Chrome', 'Safari' => 'Safari', 'Edge' => 'Edge', 'Firefox' => 'Firefox'], 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'false', + 'example' => 'Chrome', + 'title' => '', ], ], [ - 'name' => 'Resources', + 'name' => 'Device', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The resources that are associated with the alert rule. Set the value to a JSON array.'."\n" - ."\n" - .'> You can add up to 100 resources each time. An alert rule can be associated with up to 3,000 resources.'."\n", + 'description' => 'The type of the device. This parameter specifies the screen size for impersonation.', + 'enumValueTitles' => ['tablet' => 'tablet', 'mobile' => 'mobile', 'laptop' => 'laptop'], 'type' => 'string', - 'required' => true, - 'example' => '[{"instanceId":"i-a2d5q7pm3f9yr29e****"}]', + 'required' => false, + 'example' => 'laptop', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'N/A', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0671A721-0D7A-4F11-BB77-2416325D65AB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'NextToken' => ['description' => 'The token that is used to query the next page.', 'type' => 'string', 'example' => 'IWBjqMYSy0is7zSMGu16****', 'title' => ''], + 'Data' => ['description' => 'The detection logs of the one-time detection task.', 'type' => 'string', 'example' => '[{\\"redirectCount\\":0.0,\\"SSLConnectTime\\":0.0,\\"pingDetail\\":\\"\\",\\"HTTPConnectTime\\":0.0,\\"isp\\":\\"465\\",\\"errorCode\\":611,\\"ispCN\\":\\"阿里巴巴\\",\\"resolution\\":\\"\\",\\"areaEN\\":\\"HuaBei\\",\\"taskEndTimestamp\\":1638422475687,\\"targetIspEN\\":\\"\\",\\"TotalTime\\":1.0,\\"taskStartTimestamp\\":1638422474389,\\"countryCN\\":\\"中国\\",\\"provinceEN\\":\\"Beijing\\",\\"countryEN\\":\\"China\\",\\"targetCityEN\\":\\"\\",\\"curlConnectTime\\":0.0,\\"ips\\":\\"\\",\\"route\\":\\"\\",\\"tcpConnectTime\\":0.0,\\"cityEN\\":\\"Beijing\\",\\"HTTPDownloadSpeed\\":0.0,\\"HTTPDownloadTime\\":0.0,\\"HTTPResponseCode\\":0.0,\\"areaCN\\":\\"华北\\",\\"city\\":\\"546\\",\\"expection\\":\\"\\",\\"suorceIp\\":\\"192.168.XX.XX \\",\\"ispEN\\":\\"Alibaba\\",\\"HTTPDNSTime\\":1.0,\\"targetIsp\\":\\"\\",\\"curlStarttransferTime\\":0.0,\\"provinceCN\\":\\"北京市\\",\\"timestamp\\":1638422474000,\\"redirectTime\\":0.0,\\"targetCity\\":\\"\\", \\"expect\\":\\"\\",\\"HTTPDownloadSize\\":0.0,\\"localDns\\":\\"192.168.XX.XX\\",\\"cityCN\\":\\"北京市\\",\\"taskId\\":\\"afa5c3ce-f944-4363-9edb-ce919a29****\\"}]', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '67F646FA-ED8A-58C2-B461-451DB52C8B14', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the operation was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DescribeSiteMonitorLog', + 'description' => 'Only Alibaba Cloud accounts with Network Analysis and Monitoring activated can create one-time detection tasks.'."\n" + ."\n" + .'This topic provides an example of how to query the detection logs for the one-time detection task `afa5c3ce-f944-4363-9edb-ce919a29****`.', + 'changeSet' => [ + ['createdAt' => '2023-08-22T07:49:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-03T11:31:12.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorLog'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0671A721-0D7A-4F11-BB77-2416325D65AB\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CreateMetricRuleResources', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"IWBjqMYSy0is7zSMGu16****\\",\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"redirectCount\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"SSLConnectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"pingDetail\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HTTPConnectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"errorCode\\\\\\\\\\\\\\":611,\\\\\\\\\\\\\\"ispCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"阿里巴巴\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resolution\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"areaEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"HuaBei\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskEndTimestamp\\\\\\\\\\\\\\":1638422475687,\\\\\\\\\\\\\\"targetIspEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TotalTime\\\\\\\\\\\\\\":1.0,\\\\\\\\\\\\\\"taskStartTimestamp\\\\\\\\\\\\\\":1638422474389,\\\\\\\\\\\\\\"countryCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"中国\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"provinceEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"countryEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"China\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"targetCityEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"curlConnectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"ips\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"route\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tcpConnectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"cityEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HTTPDownloadSpeed\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"HTTPDownloadTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"HTTPResponseCode\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"areaCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"华北\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"546\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"expection\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"suorceIp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"192.168.XX.XX \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Alibaba\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HTTPDNSTime\\\\\\\\\\\\\\":1.0,\\\\\\\\\\\\\\"targetIsp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"curlStarttransferTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"provinceCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"北京市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1638422474000,\\\\\\\\\\\\\\"redirectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"targetCity\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"expect\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HTTPDownloadSize\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"localDns\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"192.168.XX.XX\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"北京市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"afa5c3ce-f944-4363-9edb-ce919a29****\\\\\\\\\\\\\\"}]\\",\\n \\"RequestId\\": \\"67F646FA-ED8A-58C2-B461-451DB52C8B14\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', ], - 'DeleteMetricRuleTargets' => [ - 'summary' => 'Delete the push channels of an alert rule.', - 'methods' => [ - 'post', - 'get', - 'delete', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSiteMonitorQuota' => [ + 'summary' => 'Calls the DescribeSiteMonitorQuota operation to query the quota and version of site monitoring.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ruleId-xxxxxx', - ], - ], - [ - 'name' => 'TargetIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The resource IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource ID. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - ], - 'required' => true, - 'example' => '12345', - 'maxItems' => 5, - ], - ], - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'**Description** The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FailIds' => [ - 'description' => 'The IDs of the resources that failed to be deleted.'."\n", + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Request succeeded.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '26860260-76C6-404E-AB7A-EB98D36A6885', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The quota information.', 'type' => 'object', 'properties' => [ - 'TargetIds' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TargetId' => [ - 'description' => 'The IDs of the resources that failed to be deleted.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the resource that failed to be deleted.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], + 'SiteMonitorOperatorQuotaQuota' => ['description' => 'The quota of non-Alibaba detection points. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'SecondMonitor' => ['description' => 'Indicates whether second-level monitoring is enabled. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + ."\n" + .'- false: disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SiteMonitorQuotaTaskUsed' => ['description' => 'The number of used site monitoring detection task quotas.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'SiteMonitorTaskQuota' => ['description' => 'The quota of site monitoring detection tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'SiteMonitorVersion' => ['description' => 'The version of site monitoring. Valid values:'."\n" + ."\n" + .'- V1: the old version.'."\n" + .' '."\n" + .'- V2: the new version.', 'type' => 'string', 'example' => 'V1', 'title' => ''], + 'SiteMonitorIdcQuota' => ['description' => 'The quota of Alibaba detection points. The free quota is 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], + ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed because of an unknown error, exception or failure.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"786E92D2-AC66-4250-B76F-F1E2FCDDBA1C\\",\\n \\"Success\\": true,\\n \\"FailIds\\": {\\n \\"TargetIds\\": {\\n \\"TargetId\\": [\\n \\"1\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteMetricRuleTargetsResponse>\\r\\n\\t\\t<RequestId>786E92D2-AC66-4250-B76F-F1E2FCDDBA1C</RequestId>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n\\t\\t<FailIds>\\r\\n\\t\\t\\t<TargetIds>1</TargetIds>\\r\\n\\t\\t</FailIds>\\r\\n</DeleteMetricRuleTargetsResponse>","errorExample":""}]', - 'title' => 'DeleteMetricRuleTargets', + 'staticInfo' => [], + 'title' => 'Queries the quota and version of site monitoring', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMetricRules' => [ - 'summary' => 'Deletes one or more alert rules.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-12-27T07:31:02.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorQuota'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Request succeeded.\\",\\n \\"RequestId\\": \\"26860260-76C6-404E-AB7A-EB98D36A6885\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"SiteMonitorOperatorQuotaQuota\\": 0,\\n \\"SecondMonitor\\": false,\\n \\"SiteMonitorQuotaTaskUsed\\": 6,\\n \\"SiteMonitorTaskQuota\\": 10,\\n \\"SiteMonitorVersion\\": \\"V1\\",\\n \\"SiteMonitorIdcQuota\\": 5\\n }\\n}","type":"json"}]', + ], + 'DescribeSiteMonitorStatistics' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'TaskId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'The ID of the alert rule. Valid values of N: 1 to 100.'."\n", - 'example' => 'ab05733c97b7ce239fb1b53393dc1697c7e12****', - ], - 'required' => true, - 'example' => 'ab05733c97b7ce239fb1b53393dc1697c7e12****', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The ID of the site monitoring task.'."\n" + ."\n" + .'For information about how to obtain the ID of a site monitoring task, see [DescribeSiteMonitorList](~~115052~~).', 'type' => 'string', 'required' => true, 'example' => 'ef4cdc8b-9dc7-43e7-810e-f950e56c****', 'title' => ''], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => ['description' => 'The statistical period.'."\n" + ."\n\n" + .'Unit: minutes. Default value: 1440 (1 day). Maximum value: 43200 (30 days).', 'type' => 'string', 'required' => false, 'example' => '1440', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'Unit: milliseconds. Default value: 1 hour before the current time.', 'type' => 'string', 'required' => false, 'example' => '1576142850527', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metric. Valid values:'."\n" + ."\n" + .'- Availability: the availability.'."\n" + .'- ErrorRate: the error rate.'."\n" + .'- ResponseTime: the response time.', 'type' => 'string', 'required' => true, 'example' => 'Availability', 'title' => ''], ], ], 'responses' => [ @@ -27697,514 +20083,340 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates a success.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E5599964-8D0D-40DC-8E90-27A619384B81', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Valid values:'."\n" - ."\n" - .'* true: successful.'."\n" - .'* false: failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + .'> The value 200 indicates that the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], + 'Data' => ['description' => 'The statistical result.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '3AD2724D-E317-4BFB-B422-D6691D071BE1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + ."\n" + .'- true: The call is successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'The specified parameter is not valid.', 'description' => ''], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], - [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ['errorCode' => 'InvalidClientTokenId', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], ], - [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternetServerError', - 'errorMessage' => 'InternetServerError', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"09B3A484-1A2B-5743-BB6B-D796416F2677\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteMetricRules', - 'requestParamsDescription' => ' ', + 'title' => 'Queries the average statistics of a specified metric in a specified site monitoring task.', + 'summary' => 'Queries the average statistics of a specified metric in a specified site monitoring task by calling the DescribeSiteMonitorStatistics operation.', + 'description' => 'This topic provides an example on how to query the average statistics of the `Availability` metric in the site monitoring task whose ID is `ef4cdc8b-9dc7-43e7-810e-f950e56c****`. The returned result shows that the availability is `100`.'."\n" + ."\n\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMetricRuleResources' => [ - 'summary' => 'Disassociates resources from an alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorStatistics'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSiteMonitorStatistics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"100\\",\\n \\"RequestId\\": \\"3AD2724D-E317-4BFB-B422-D6691D071BE1\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'DescribeSyntheticProbeList' => [ + 'summary' => 'Queries a list of detection points.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleId', + 'name' => 'Isp', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rr-bp18017n6iolv****', - ], + 'schema' => ['description' => 'The name or ID of the carrier.', 'type' => 'string', 'example' => 'China Unicom', 'required' => false, 'title' => ''], ], [ - 'name' => 'Resources', + 'name' => 'City', 'in' => 'query', - 'schema' => [ - 'description' => 'The resources that are associated with the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '[{"instanceId":"i-uf6hm9lnlzsarrc7****"}]', - ], + 'schema' => ['description' => 'The name or ID of the city where the carrier detection point is located.', 'type' => 'string', 'example' => 'Beijing', 'required' => false, 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The alert does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D8A35882-90C6-4F03-BBEB-153C180398EA', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'Ipv4', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only IPv4 detection points.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'Ipv6', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only IPv6 detection points.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 'name' => 'ViewAll', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return all detection points. Valid values:'."\n" + ."\n" + .'- false (default): Returns the detection points that are available to you.'."\n" + ."\n" + .'- true: Returns all detection points.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + 'name' => 'MbProbe', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only mobile detection points.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The alert does not exist.\\",\\n \\"RequestId\\": \\"D8A35882-90C6-4F03-BBEB-153C180398EA\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteMetricRuleResourcesResponse>\\n\\t\\t<RequestId>0671A721-0D7A-4F11-BB77-2416325D65AB</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</DeleteMetricRuleResourcesResponse>","errorExample":""}]', - 'title' => 'DeleteMetricRuleResources', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'EnableMetricRules' => [ - 'summary' => 'Enables alert rules.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'LmProbe', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only last-mile detection points.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'RuleId', + 'name' => 'IdcProbe', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the alert rules.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GroupProcess_67800278_2FE7D515-4BBD-447B-BC1A-3F17ED49****', - ], - 'required' => true, - 'example' => 'ab05733c97b7ce239fb1b53393dc1697c123****', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'Specifies whether to return only detection points in data centers.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'IspCityList' => [ + 'description' => 'The list of detection points.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a detection point.', + 'type' => 'object', + 'properties' => [ + 'AreaCn' => ['description' => 'The name of the area in Chinese.', 'type' => 'string', 'example' => '华北', 'title' => ''], + 'AreaEn' => ['description' => 'The name of the area in English.', 'type' => 'string', 'example' => 'Huabei', 'title' => ''], + 'City' => ['description' => 'The city ID.', 'type' => 'string', 'example' => '738', 'title' => ''], + 'CityCn' => ['description' => 'The name of the city in Chinese.', 'type' => 'string', 'example' => '北京', 'title' => ''], + 'CityEn' => ['description' => 'The name of the city in English.', 'type' => 'string', 'example' => 'Beijing', 'title' => ''], + 'Country' => ['description' => 'The country code.', 'type' => 'string', 'example' => '629', 'title' => ''], + 'CountryCn' => ['description' => 'The name of the country in Chinese.', 'type' => 'string', 'example' => '中国', 'title' => ''], + 'CountryEn' => ['description' => 'The name of the country or region in English.', 'type' => 'string', 'example' => 'China', 'title' => ''], + 'IpPool' => [ + 'description' => 'The list of node IP addresses.', + 'type' => 'array', + 'items' => ['description' => 'The node IP address.', 'type' => 'string', 'example' => '1.1.1.1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Isp' => ['description' => 'The carrier ID.', 'type' => 'string', 'example' => '232', 'title' => ''], + 'IspCn' => ['description' => 'The name of the carrier in Chinese.', 'type' => 'string', 'example' => '联通', 'title' => ''], + 'IspEn' => ['description' => 'The name of the carrier in English.', 'type' => 'string', 'example' => 'China-Unicom', 'title' => ''], + 'LmProbeCount' => ['description' => 'The number of last-mile detection points.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'MbProbeCount' => ['description' => 'The number of mobile detection points.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Region' => ['description' => 'The province code.', 'type' => 'string', 'example' => '264', 'title' => ''], + 'RegionCn' => ['description' => 'The name of the province in Chinese.', 'type' => 'string', 'example' => '江西省', 'title' => ''], + 'RegionEn' => ['description' => 'The name of the province in English.', 'type' => 'string', 'example' => 'Jiangxi', 'title' => ''], + 'IdcV4ProbeCount' => ['description' => 'The number of IPv4 detection points in data centers.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'IdcV6ProbeCount' => ['description' => 'The number of IDC IPv6 nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '87170bc7-e28a-4c93-b9bf-90a1dbe84736', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], - 402 => [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], ], 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"IspCityList\\": [\\n {\\n \\"AreaCn\\": \\"华北\\",\\n \\"AreaEn\\": \\"Huabei\\",\\n \\"City\\": \\"738\\",\\n \\"CityCn\\": \\"北京\\",\\n \\"CityEn\\": \\"Beijing\\",\\n \\"Country\\": \\"629\\",\\n \\"CountryCn\\": \\"中国\\",\\n \\"CountryEn\\": \\"China\\",\\n \\"IpPool\\": [\\n \\"1.1.1.1\\"\\n ],\\n \\"Isp\\": \\"232\\",\\n \\"IspCn\\": \\"联通\\",\\n \\"IspEn\\": \\"China-Unicom\\",\\n \\"LmProbeCount\\": 1,\\n \\"MbProbeCount\\": 1,\\n \\"Region\\": \\"264\\",\\n \\"RegionCn\\": \\"江西省\\",\\n \\"RegionEn\\": \\"Jiangxi\\",\\n \\"IdcV4ProbeCount\\": 1,\\n \\"IdcV6ProbeCount\\": 1\\n }\\n ],\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"87170bc7-e28a-4c93-b9bf-90a1dbe84736\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'DescribeSyntheticProbeList', + 'description' => 'This topic provides an example of how to call the DescribeSyntheticProbeList operation to query detection point details for the China Unicom carrier in Beijing.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSyntheticProbeList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:DescribeSyntheticProbeList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FF38D33A-67C1-40EB-AB65-FAEE51EDB644\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<EnableMetricRulesResponse>\\n <Code>200</Code>\\n <Message>success</Message>\\n <RequestId>FF38D33A-67C1-40EB-AB65-FAEE51EDB644</RequestId>\\n <Success>true</Success>\\n</EnableMetricRulesResponse>","errorExample":""}]', - 'title' => 'EnableMetricRules', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DisableMetricRules' => [ - 'summary' => 'Disables alert rules.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSystemEventAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RuleId', + 'name' => 'Product', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of the alert rule. Valid values of N: 1 to 20.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - ], - 'required' => true, - 'example' => 'detect_87****_HTTP_HttpLatency', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The abbreviation of the service name.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the abbreviations of service names.', 'type' => 'string', 'required' => false, 'example' => 'oss', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'RuleId is mandatory for this action.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the system event.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the types of system events.', 'type' => 'string', 'required' => false, 'example' => 'Exception', 'title' => ''], ], [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the system event.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the names of system events.', 'type' => 'string', 'required' => false, 'example' => 'BucketIngressBandwidth', 'title' => ''], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => 'The level of the system event. Valid values:'."\n" + ."\n" + .'- CRITICAL: critical'."\n" + ."\n" + .'- WARN: warning'."\n" + ."\n" + .'- INFO: information', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL', 'title' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the system event.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the statuses of system events.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '12346', 'title' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + [ + 'name' => 'SearchKeywords', + 'in' => 'query', + 'schema' => ['description' => 'The keywords that are used to search for the system event. Valid values:'."\n" + ."\n" + .'- If you want to search for the system event whose content contains a and b, set the value to `a and b`.'."\n" + ."\n" + .'- If you want to search for the system event whose content contains a or b, set the value to `a or b`.', 'type' => 'string', 'required' => false, 'example' => 'cms', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'The value must be a UNIX timestamp. It is the number of seconds that have elapsed since 00:00:00 UTC, January 1, 1970.', 'type' => 'string', 'required' => false, 'example' => '1552199984949', 'title' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'The value must be a UNIX timestamp. It is the number of seconds that have elapsed since 00:00:00 UTC, January 1, 1970.', 'type' => 'string', 'required' => false, 'example' => '1552221584949', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"FF38D33A-67C1-40EB-AB65-FAEE51EDB644\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DisableMetricRules', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeMetricRuleTargets' => [ - 'summary' => 'Queries the resources that are associated with a specified alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return.'."\n" + ."\n" + .'Valid values: 1 to 100000000.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'RuleId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ae06917_75a8c43178ab66****', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Valid values: 1 to 100.'."\n" + ."\n" + .'Default value: 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -28212,155 +20424,181 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Targets' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message that is returned. If the call is successful, `success` is returned. If the call fails, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values: True: The call is successful. false: The call fails.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'SystemEvents' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Target' => [ - 'description' => 'The information about the resource for which alerts are triggered.'."\n", + 'SystemEvent' => [ + 'description' => 'The details of the event.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. Fields:'."\n" - ."\n" - .'* {Service name abbreviation}: the abbreviation of the service name. Valid value: mns.'."\n" - .'* {userId}: the ID of the Alibaba Cloud account.'."\n" - .'* {regionId}: the region ID of the message queue or topic.'."\n" - .'* {Resource type}`: the type of the resource for which alerts are triggered. Valid values: - **queues** - **topics** {Resource name}: the name of the resource. - If the resource type is set to **queues**, the resource name is the name of the message queue. - If the resource type is set to **topics**, the resource name is the name of the topic.`'."\n", - 'type' => 'string', - 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The level of the alert. Valid values:'."\n" - ."\n" - .'* INFO: information'."\n" - .'* WARN: warning'."\n" - .'* CRITICAL: critical'."\n", - 'type' => 'string', - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], + 'Status' => ['description' => 'The status of the event.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'Time' => ['description' => 'The time when the event occurred. The value is a timestamp.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552199984000', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Product' => ['description' => 'The abbreviation of the service name.', 'type' => 'string', 'example' => 'CloudMonitor', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'instanceId1', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'xxxxx-1', 'title' => ''], + 'Name' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'Agent_Status_Stopped', 'title' => ''], + 'Content' => ['description' => 'The details of the event.', 'type' => 'string', 'example' => '[{"product":"CloudMonitor","content":"{\\"ipGroup\\":\\"112.126.XX.XX,10.163.XX.XX\\",\\"tianjimonVersion\\":\\"1.2.22\\"}","groupId":"176,177,178,179,180,692,120812,1663836,96,2028302","time":"1552209568000","resourceId":"acs:ecs:cn-beijing:173651113438****:instance/i-25k35****","level":"CRITICAL","status":"stopped","instanceName":"cmssiteprobebj-6","name":"Agent_Status_Stopped","regionId":"cn-beijing"}]', 'title' => ''], + 'Level' => ['description' => 'The level of the event. Valid values:'."\n" + ."\n" + .'- CRITICAL'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .'- INFO', 'type' => 'string', 'example' => 'WARN', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Id' => ['description' => 'The event ID.', 'type' => 'string', 'example' => 'b936efc9-f621-4e8a-a6eb-076be40e****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"786E92D2-AC66-4250-B76F-F1E2FCDDBA1C\\",\\n \\"Success\\": true,\\n \\"Targets\\": {\\n \\"Target\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Arn\\": \\"acs:mns:cn-hangzhou:120886317861****:/queues/test/message\\",\\n \\"Level\\": \\"INFO\\",\\n \\"JsonParams\\": \\"{\\\\\\"customField1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"customField2\\\\\\":\\\\\\"$.name\\\\\\"}\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricRuleTargetsResponse>\\n\\t<RequestId>786E92D2-AC66-4250-B76F-F1E2FCDDBA1C</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DescribeMetricRuleTargetsResponse>\\t","errorExample":""}]', - 'title' => 'DescribeMetricRuleTargets', - 'description' => '## Limit'."\n" - ."\n" - .'This operation supports only Message Service (MNS) resources. '."\n" - ."\n" - .'>This topic provides an example on how to query the resources that are associated with an alert rule whose ID is `ae06917_75a8c43178ab66****`.', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeSystemEventAttribute', + 'summary' => 'Queries a system event.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMetricRuleCount' => [ - 'summary' => 'Queries the number of alert rules in each state.', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-12-07T03:28:51.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventAttribute'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSystemEventAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"60912C8D-B340-4253-ADE7-61ACDFD25CFC\\",\\n \\"Success\\": \\"true\\",\\n \\"SystemEvents\\": {\\n \\"SystemEvent\\": [\\n {\\n \\"Status\\": \\"normal\\",\\n \\"Time\\": 1552199984000,\\n \\"GroupId\\": \\"12345\\",\\n \\"Product\\": \\"CloudMonitor\\",\\n \\"InstanceName\\": \\"instanceId1\\",\\n \\"ResourceId\\": \\"xxxxx-1\\",\\n \\"Name\\": \\"Agent_Status_Stopped\\",\\n \\"Content\\": \\"[{\\\\\\"product\\\\\\":\\\\\\"CloudMonitor\\\\\\",\\\\\\"content\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"ipGroup\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"112.126.XX.XX,10.163.XX.XX\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tianjimonVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.2.22\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"groupId\\\\\\":\\\\\\"176,177,178,179,180,692,120812,1663836,96,2028302\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1552209568000\\\\\\",\\\\\\"resourceId\\\\\\":\\\\\\"acs:ecs:cn-beijing:173651113438****:instance/i-25k35****\\\\\\",\\\\\\"level\\\\\\":\\\\\\"CRITICAL\\\\\\",\\\\\\"status\\\\\\":\\\\\\"stopped\\\\\\",\\\\\\"instanceName\\\\\\":\\\\\\"cmssiteprobebj-6\\\\\\",\\\\\\"name\\\\\\":\\\\\\"Agent_Status_Stopped\\\\\\",\\\\\\"regionId\\\\\\":\\\\\\"cn-beijing\\\\\\"}]\\",\\n \\"Level\\": \\"WARN\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Id\\": \\"b936efc9-f621-4e8a-a6eb-076be40e****\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeSystemEventCount' => [ + 'summary' => 'Queries the number of events that occurred for each Alibaba Cloud service under the current account.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The name of the Alibaba Cloud service.'."\n" + ."\n" + .'Call the DescribeSystemEventMetaList operation to obtain the value of the `Product` response parameter, which provides the Alibaba Cloud service names for all events under the current Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], [ - 'name' => 'MetricName', + 'name' => 'EventType', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], + 'schema' => ['description' => 'The event type.'."\n" + ."\n" + .'Call the DescribeSystemEventMetaList operation to obtain the value of the `EventType` response parameter, which provides the event types for all Alibaba Cloud services under the current Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => false, 'example' => 'StatusNotification', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The event name.'."\n" + ."\n" + .'Call the DescribeSystemEventMetaList operation to obtain the value of the `Name` response parameter, which provides the event names for all Alibaba Cloud services under the current Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => false, 'example' => 'Instance:StateChange', 'title' => ''], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => 'The event level. Valid values:'."\n" + ."\n" + .'- Critical: critical.'."\n" + ."\n" + .'- Warn: warning.'."\n" + ."\n" + .'- Info: information.'."\n" + ."\n" + .'Call the DescribeSystemEventMetaList operation to obtain the value of the `Level` response parameter, which provides the event levels for all Alibaba Cloud services under the current Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => false, 'example' => 'Info', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The event status.'."\n" + ."\n" + .'Call the DescribeSystemEventMetaList operation to obtain the value of the `Status` response parameter, which provides the event statuses for all Alibaba Cloud services under the current Alibaba Cloud account. For more information, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The application group ID.', 'type' => 'string', 'required' => false, 'example' => '17285****', 'title' => ''], + ], + [ + 'name' => 'SearchKeywords', + 'in' => 'query', + 'schema' => ['description' => 'The keywords contained in the event content for searching. Valid values:'."\n" + ."\n" + .'- To search for event content that contains both a and b, search for `a and b`.'."\n" + ."\n" + .'- To search for event content that contains either a or b, search for `a or b`.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The timestamp of the start time for the event query. Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1635993541000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The timestamp of the end time for the event query. Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1635993921000', 'title' => ''], ], ], 'responses' => [ @@ -28368,2695 +20606,1100 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MetricRuleCount' => [ - 'description' => 'The number of alert rules in each state.'."\n", + 'Code' => ['description' => 'The status code.'."\n" + .'>A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n" + ."\n" + .'If the request is successful, a success message is returned. If the request fails, the failure reason is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C7A7B776-0ACE-5A93-9B07-DE8008D9CCDF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'- true: The operation is successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'SystemEventCounts' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'Ok' => [ - 'description' => 'The number of alert rules without active alerts.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '40', - ], - 'Nodata' => [ - 'description' => 'The number of alert rules without data.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Disable' => [ - 'description' => 'The number of disabled alert rules.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Total' => [ - 'description' => 'The total number of alert rules.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '45', - ], - 'Alarm' => [ - 'description' => 'The number of alert rules with active alerts.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', + 'SystemEventCount' => [ + 'description' => 'The event details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The event details.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The event status.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Time' => ['description' => 'The timestamp when the event occurred. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1635993751000', 'title' => ''], + 'GroupId' => ['description' => 'The application group ID.', 'type' => 'string', 'example' => '17285****', 'title' => ''], + 'Product' => ['description' => 'The Alibaba Cloud service name of the event.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'ECS-test', 'title' => ''], + 'Num' => ['description' => 'The number of events that occurred.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'i-rj99xc6cptkk64ml****', 'title' => ''], + 'Name' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'Instance:StateChange', 'title' => ''], + 'Content' => ['description' => 'The event description.', 'type' => 'string', 'example' => 'Instance status change notification', 'title' => ''], + 'Level' => ['description' => 'The event level. Valid values:'."\n" + ."\n" + .'- Critical: critical.'."\n" + ."\n" + .'- Warn: warning.'."\n" + ."\n" + .'- Info: information.', 'type' => 'string', 'example' => 'Info', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 402 => [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttli∂ngException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"FF38D33A-67C1-40EB-AB65-FAEE51EDB644\\",\\n \\"Success\\": true,\\n \\"MetricRuleCount\\": {\\n \\"Ok\\": 40,\\n \\"Nodata\\": 0,\\n \\"Disable\\": 0,\\n \\"Total\\": 45,\\n \\"Alarm\\": 5\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricRuleCountResponse>\\n <Success>true</Success>\\n <Code>200</Code>\\n <RequestId>FF38D33A-67C1-40EB-AB65-FAEE51EDB644</RequestId>\\n <MetricRuleCount>\\n <Ok>40</Ok>\\n <Disable>0</Disable>\\n <Total>45</Total>\\n <Nodata>0</Nodata>\\n <Alarm>5</Alarm>\\n </MetricRuleCount>\\n</DescribeMetricRuleCountResponse>","errorExample":""}]', - 'title' => 'DescribeMetricRuleCount', - 'requestParamsDescription' => ' ', + 'title' => 'Query the number of events for each Alibaba Cloud service under the current account', + 'description' => '### Background information'."\n" + .'You can call [DescribeSystemEventMetaList](~~114972~~) to obtain the Alibaba Cloud services and their system events supported by CloudMonitor.'."\n" + .'### Operation description'."\n" + .'This topic provides an example of how to query the number of events that occurred for Elastic Compute Service (`ECS`) under the current account. The response shows that a total of 3 events occurred.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeAlertingMetricRuleResources' => [ - 'summary' => 'Queries the resources for which active alerts are triggered based on an alert rule.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventCount'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSystemEventCount', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"C7A7B776-0ACE-5A93-9B07-DE8008D9CCDF\\",\\n \\"Success\\": \\"true\\",\\n \\"SystemEventCounts\\": {\\n \\"SystemEventCount\\": [\\n {\\n \\"Status\\": \\"Normal\\",\\n \\"Time\\": 1635993751000,\\n \\"GroupId\\": \\"17285****\\",\\n \\"Product\\": \\"ECS\\",\\n \\"InstanceName\\": \\"ECS-test\\",\\n \\"Num\\": 3,\\n \\"ResourceId\\": \\"i-rj99xc6cptkk64ml****\\",\\n \\"Name\\": \\"Instance:StateChange\\",\\n \\"Content\\": \\"Instance status change notification\\",\\n \\"Level\\": \\"Info\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeSystemEventHistogram' => [ + 'summary' => 'Queries the number of times a system event occurred during each interval within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleId', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****', - ], + 'schema' => ['description' => 'The abbreviation of the service name.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the abbreviations of service names.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'EventType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group. For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '7671****', - ], + 'schema' => ['description' => 'The event type.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the types of system events.', 'type' => 'string', 'required' => false, 'example' => 'Exception', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The event name.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the names of system events.', 'type' => 'string', 'required' => false, 'example' => 'BucketIngressBandwidth', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Level', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The level of the event. Valid values:'."\n" + ."\n" + .'- CRITICAL'."\n" + ."\n" + .'- WARN'."\n" + ."\n" + .'- INFO', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_mns_new', - ], + 'schema' => ['description' => 'The event status.'."\n" + ."\n" + .'> You can call the [DescribeSystemEventMetaList](~~114972~~) operation to query the status of system events.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''], ], [ - 'name' => 'Dimensions', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The dimensions that specify the resources whose monitoring data you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"userId\\":\\"120886317861****\\",\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\"}', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'AlertBeforeTime', + 'name' => 'SearchKeywords', 'in' => 'query', - 'schema' => [ - 'description' => 'Queries the alerts that were triggered before the specified time. Timestamps in milliseconds are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1698827400000', - ], + 'schema' => ['description' => 'The keywords that are used to search for the system event. Valid values:'."\n" + ."\n" + .'- If you want to search for the system event whose content contains a and b, set the value to `a and b`.'."\n" + ."\n" + .'- If you want to search for the system event whose content contains a or b, set the value to `a or b`.', 'type' => 'string', 'required' => false, 'example' => 'cms', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552209685596', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'required' => false, 'example' => '1552220485596', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The request processing has failed due to some unknown error.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0724011B-D9E0-4B2F-8C51-F17A894CC42C', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Resources' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'SystemEventHistograms' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Resource' => [ - 'description' => 'The resources that are associated with the alert rule.'."\n", + 'SystemEventHistogram' => [ + 'description' => 'The information about the number of times the system event occurred during each interval of a time period.', 'type' => 'array', 'items' => [ - 'description' => 'None'."\n", 'type' => 'object', 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'ActiveMessages', - ], - 'RetryTimes' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'MetricValues' => [ - 'description' => 'The metric value that triggered the alert based on the alert rule. The value is a JSON string.'."\n", - 'type' => 'string', - 'example' => '{\\"timestamp\\":1623727500000,\\"Sum\\":926,\\"value\\":463,\\"Maximum\\":463,\\"Minimum\\":463,\\"Average\\":463,\\"SampleCount\\":2,\\"userId\\":\\"120886317861****\\",\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\"}', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_mns_new', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'test123456789', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****', - ], - 'ProductCategory' => [ - 'description' => 'The type of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'mns', - ], - 'StartTime' => [ - 'description' => 'The time when the resource was associated with the alert rule. The value is a timestamp.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1622427900000', - ], - 'Resource' => [ - 'description' => 'The resources that are monitored.'."\n", - 'type' => 'string', - 'example' => 'userId=120886317861****,region=cn-huhehaote,queue=test-0128', - ], - 'LastModifyTime' => [ - 'description' => 'The time when the alert rule was last modified. The value is a timestamp.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1622827900000', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'> If the alert rule is associated with an application group, the ID of the application group is returned in this parameter.'."\n", - 'type' => 'string', - 'example' => '7671****', - ], - 'Dimensions' => [ - 'description' => 'The dimensions based on which the resources are queried.'."\n", - 'type' => 'string', - 'example' => '{\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\",\\"userId\\":\\"120886317861****\\"}', - ], - 'LastAlertTime' => [ - 'description' => 'The time when the last alert was triggered for the resource based on the alert rule. The value is a timestamp.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1622427900000', - ], - 'Level' => [ - 'description' => 'The severity level and notification methods of the alert. Valid values:'."\n" - ."\n" - .'* 4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Statistics' => [ - 'description' => 'The method used to calculate the metric values that trigger alerts.'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - 'Enable' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'* true: The alert rule is enabled.'."\n" - .'* false: The alert rule is disabled.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Escalation' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Resource' => [ - 'description' => 'The alert rule based on which the alert is triggered.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'PreCondition' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* `>=`'."\n" - .'* `=`'."\n" - .'* `<=`'."\n" - .'* `>`'."\n" - .'* `<`'."\n" - .'* `!=`'."\n", - 'type' => 'string', - 'example' => '>=', - ], - 'Expression' => [ - 'description' => 'The description of the alert rule.'."\n" - ."\n" - .'> This parameter indicates the content of the alert rule. If the metric value meets the alert condition, an alert is triggered.'."\n", - 'type' => 'string', - 'example' => '$Average>=10', - ], - 'Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Tag' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'example' => 'mns', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Level' => [ - 'description' => 'The severity level and notification methods of the alert. Valid values:'."\n" - ."\n" - .'* 4: Alert notifications are sent by using emails and DingTalk chatbots.'."\n" - .'* OK: No alert is generated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'ExpressionListJoin' => [ - 'description' => 'The relationship between multiple metrics. Valid values:'."\n" - ."\n" - .'* &&: If all metrics meet the alert conditions, CloudMonitor sends alert notifications.'."\n" - .'* ||: If one of the metrics meets the alert conditions, CloudMonitor sends alert notifications.'."\n", - 'type' => 'string', - 'example' => '&&', - ], - 'ExpressionList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ExpressionList' => [ - 'description' => 'The description of the multi-metric alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'cpu_total', - ], - 'Period' => [ - 'description' => 'The statistical period of the metric. Unit: seconds. The default value is the interval at which the monitoring data of the metric is collected.'."\n", - 'type' => 'string', - 'example' => '60', - ], - 'Statistics' => [ - 'description' => 'The statistical method of the alert level. Valid values:'."\n" - ."\n" - .'* Maximum'."\n" - .'* Minimum'."\n" - .'* Average'."\n", - 'type' => 'string', - 'example' => 'Average', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'example' => '90', - ], - ], - ], - ], - ], - ], - 'ExpressionRaw' => [ - 'description' => 'The trigger conditions that are created by using expressions. You can use expressions to create trigger conditions in the following scenarios:'."\n" - ."\n" - .'* Set an alert blacklist for specific resources. For example, if you specify `$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50`, no alert is triggered when the `average metric value` of the `i-io8kfvcpp7x5****` instance exceeds 50.'."\n" - .'* Set a special alert threshold for a specified instance in the rule. For example, if you specify `$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)`, an alert is triggered when the `average metric value` of the `i-io8kfvcpp7x5****` instance exceeds 80 or the `average metric value` of other instances exceeds 50.'."\n" - .'* Limit the number of instances whose metric values exceed the threshold. For example, if you specify `count($Average > 20) > 3`, an alert is triggered only when the `average metric value` of more than three instances exceeds 20.'."\n", - 'type' => 'string', - 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', - ], - ], - ], - ], - ], - ], + 'EndTime' => ['description' => 'The end time.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552225753000', 'title' => ''], + 'StartTime' => ['description' => 'The start time.'."\n" + ."\n" + .'This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1552225770000', 'title' => ''], + 'Count' => ['description' => 'The number of times the system event occurred.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\": \\"0724011B-D9E0-4B2F-8C51-F17A894CC42C\\",\\n \\"Total\\": 2,\\n \\"Success\\": true,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"MetricName\\": \\"ActiveMessages\\",\\n \\"RetryTimes\\": \\"3\\",\\n \\"MetricValues\\": \\"{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1623727500000,\\\\\\\\\\\\\\"Sum\\\\\\\\\\\\\\":926,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":463,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":463,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":463,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":463,\\\\\\\\\\\\\\"SampleCount\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120886317861****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"region\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-huhehaote\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"queue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test-0128\\\\\\\\\\\\\\"}\\",\\n \\"Namespace\\": \\"acs_mns_new\\",\\n \\"RuleName\\": \\"test123456789\\",\\n \\"RuleId\\": \\"putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****\\",\\n \\"ProductCategory\\": \\"mns\\",\\n \\"StartTime\\": \\"1622427900000\\",\\n \\"Resource\\": \\"userId=120886317861****,region=cn-huhehaote,queue=test-0128\\",\\n \\"LastModifyTime\\": \\"1622827900000\\",\\n \\"GroupId\\": \\"7671****\\",\\n \\"Dimensions\\": \\"{\\\\\\\\\\\\\\"region\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-huhehaote\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"queue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test-0128\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120886317861****\\\\\\\\\\\\\\"}\\",\\n \\"LastAlertTime\\": \\"1622427900000\\",\\n \\"Level\\": 3,\\n \\"Threshold\\": \\"10\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Enable\\": \\"true\\",\\n \\"Escalation\\": {\\n \\"Resource\\": [\\n {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"PreCondition\\": \\">=\\",\\n \\"Expression\\": \\"$Average>=10\\",\\n \\"Times\\": 1,\\n \\"Tag\\": \\"无\\",\\n \\"Threshold\\": \\"10\\",\\n \\"Level\\": 3,\\n \\"ExpressionListJoin\\": \\"&&\\",\\n \\"ExpressionList\\": {\\n \\"ExpressionList\\": [\\n {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Period\\": \\"60\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Threshold\\": \\"90\\"\\n }\\n ]\\n },\\n \\"ExpressionRaw\\": \\"$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAlertingMetricRuleResourcesResponse>\\r\\n\\t<RequestId>0724011B-D9E0-4B2F-8C51-F17A894CC42C</RequestId>\\r\\n\\t<Message></Message>\\r\\n\\t<Total>2</Total>\\r\\n\\t<Resources>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<RuleId>putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****</RuleId>\\r\\n\\t\\t\\t<Escalation>\\r\\n\\t\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t\\t<Expression>$Average>=10</Expression>\\r\\n\\t\\t\\t\\t\\t<Times>1</Times>\\r\\n\\t\\t\\t\\t\\t<Level>3</Level>\\r\\n\\t\\t\\t\\t\\t<Tag>mns</Tag>\\r\\n\\t\\t\\t\\t</Resource>\\r\\n\\t\\t\\t</Escalation>\\r\\n\\t\\t\\t<Resource>userId=120886317861****,region=cn-huhehaote,queue=test-0128</Resource>\\r\\n\\t\\t\\t<StartTime>1622427900000</StartTime>\\r\\n\\t\\t\\t<Dimensions>{\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-huhehaote\\\\\\",\\\\\\"queue\\\\\\":\\\\\\"test-0128\\\\\\"}</Dimensions>\\r\\n\\t\\t\\t<MetricValues>{\\\\\\"timestamp\\\\\\":1623727500000,\\\\\\"Sum\\\\\\":926,\\\\\\"value\\\\\\":463,\\\\\\"Maximum\\\\\\":463,\\\\\\"Minimum\\\\\\":463,\\\\\\"Average\\\\\\":463,\\\\\\"SampleCount\\\\\\":2,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-huhehaote\\\\\\",\\\\\\"queue\\\\\\":\\\\\\"test-0128\\\\\\"}</MetricValues>\\r\\n\\t\\t\\t<LastModifyTime>1623727904000</LastModifyTime>\\r\\n\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t<Namespace>acs_mns_new</Namespace>\\r\\n\\t\\t\\t<GroupId>7671****</GroupId>\\r\\n\\t\\t\\t<MetricName>ActiveMessages</MetricName>\\r\\n\\t\\t\\t<LastAlertTime>1622427900000</LastAlertTime>\\r\\n\\t\\t\\t<ProductCategory>mns</ProductCategory>\\r\\n\\t\\t\\t<Enable>true</Enable>\\r\\n\\t\\t\\t<Level>3</Level>\\r\\n\\t\\t\\t<RuleName>test123456789</RuleName>\\r\\n\\t\\t\\t<RetryTimes>1</RetryTimes>\\r\\n\\t\\t\\t<Threshold>10</Threshold>\\r\\n\\t\\t</Resource>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<RuleId>putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****</RuleId>\\r\\n\\t\\t\\t<Escalation>\\r\\n\\t\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t\\t<Expression>$Average>=10</Expression>\\r\\n\\t\\t\\t\\t\\t<Times>1</Times>\\r\\n\\t\\t\\t\\t\\t<Level>3</Level>\\r\\n\\t\\t\\t\\t\\t<Tag>mns</Tag>\\r\\n\\t\\t\\t\\t</Resource>\\r\\n\\t\\t\\t</Escalation>\\r\\n\\t\\t\\t<Resource>userId=120886317861****,region=cn-huhehaote,queue=test-022401-1</Resource>\\r\\n\\t\\t\\t<StartTime>1622427900000</StartTime>\\r\\n\\t\\t\\t<Dimensions>{\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-huhehaote\\\\\\",\\\\\\"queue\\\\\\":\\\\\\"test-022401-1\\\\\\"}</Dimensions>\\r\\n\\t\\t\\t<MetricValues>{\\\\\\"timestamp\\\\\\":1623727500000,\\\\\\"queue\\\\\\":\\\\\\"test-022401-1\\\\\\",\\\\\\"Maximum\\\\\\":349,\\\\\\"Minimum\\\\\\":349,\\\\\\"Sum\\\\\\":698,\\\\\\"value\\\\\\":349,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-huhehaote\\\\\\",\\\\\\"Average\\\\\\":349,\\\\\\"SampleCount\\\\\\":2}</MetricValues>\\r\\n\\t\\t\\t<LastModifyTime>1623727904000</LastModifyTime>\\r\\n\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t<Namespace>acs_mns_new</Namespace>\\r\\n\\t\\t\\t<GroupId>7671****</GroupId>\\r\\n\\t\\t\\t<MetricName>ActiveMessages</MetricName>\\r\\n\\t\\t\\t<LastAlertTime>1622427900000</LastAlertTime>\\r\\n\\t\\t\\t<ProductCategory>mns</ProductCategory>\\r\\n\\t\\t\\t<Enable>true</Enable>\\r\\n\\t\\t\\t<Level>3</Level>\\r\\n\\t\\t\\t<RuleName>test123456789</RuleName>\\r\\n\\t\\t\\t<RetryTimes>1</RetryTimes>\\r\\n\\t\\t\\t<Threshold>10</Threshold>\\r\\n\\t\\t</Resource>\\r\\n\\t</Resources>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeAlertingMetricRuleResourcesResponse>\\t","errorExample":""}]', - 'title' => 'DescribeAlertingMetricRuleResources', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'DescribeSystemEventHistogram', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutMetricRuleTargets' => [ - 'summary' => 'Adds or modifies the push channels of an alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventHistogram'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeSystemEventHistogram', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"486029C9-53E1-44B4-85A8-16A571A043FD\\",\\n \\"Success\\": \\"true\\",\\n \\"SystemEventHistograms\\": {\\n \\"SystemEventHistogram\\": [\\n {\\n \\"EndTime\\": 1552225753000,\\n \\"StartTime\\": 1552225770000,\\n \\"Count\\": 2\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeSystemEventMetaList' => [ + 'summary' => 'Queries the meta information of system events by calling the DescribeSystemEventMetaList operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ae06917_75a8c43178ab66****', - ], - ], - [ - 'name' => 'Targets', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'None.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n" - ."\n" - .'For more information about how to obtain the ID of the resource for which alerts are triggered, see [DescribeMetricRuleTargets](~~121592~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Simple Message Queue (formerly MNS) (SMQ), Auto Scaling, Simple Log Service, and Function Compute are supported.'."\n" - ."\n" - .'The following part describes the ARN of SMQ and the parameters in the ARN:'."\n" - ."\n" - .'`acs:mns:{regionId}:{userId}:/{Resource type}/{Resource name}/message`.'."\n" - ."\n" - .'* {regionId}: the region ID of the SMQ queue or topic.'."\n" - ."\n" - .'* {userId}: the ID of the Alibaba Cloud account that owns the resource.'."\n" - ."\n" - .'* {Resource type}: the type of the resource for which alerts are triggered. Valid values:'."\n" - ."\n" - .' * **queues**'."\n" - .' * **topics**'."\n" - ."\n" - .'* {Resource name}: the resource name.'."\n" - ."\n" - .' * If the resource type is **queues**, the resource name is the queue name.'."\n" - .' * If the resource type is **topics**, the resource name is the topic name.'."\n" - ."\n" - .'ARN of Auto Scaling:'."\n" - ."\n" - .'acs:ess:{regionId}:{userId}:scalingGroupId/{Scaling group ID}:scalingRuleId/{Scaling rule ID}'."\n" - ."\n" - .'ARN of Simple Log Service:'."\n" - ."\n" - .'acs:log:{regionId}:{userId}:project/{Project name}/logstore/{Logstore name}'."\n" - ."\n" - .'ARN of Function Compute:'."\n" - ."\n" - .'acs:fc:{regionId}:{userId}:services/{Service name}/functions/{Function name}'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. The parameters are in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 5, - ], - ], - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request processing has failed due to some unknown error.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A569B0D-9055-58AF-9E82-BAEAF95C0FD5', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FailData' => [ - 'description' => 'The failed data.'."\n", + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A6582C8B-E67C-4A19-BC15-EAEFEBDC7995', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'Targets' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Target' => [ - 'description' => 'The information about the resources for which alerts are triggered.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource for which alerts are triggered.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Arn' => [ - 'description' => 'The ARN of the resource. Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. SMQ, Auto Scaling, Simple Log Service, and Function Compute are supported. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. The following part describes the ARN of SMQ and the parameters in the ARN:'."\n" - ."\n" - .'* {Service name abbreviation}: mns.'."\n" - ."\n" - .'* {userId}: the ID of the Alibaba Cloud account.'."\n" - ."\n" - .'* {regionId}: the region ID of the SMQ queue or topic.'."\n" - ."\n" - .'* {Resource type}: the type of the resource for which alerts are triggered. Valid values:'."\n" - ."\n" - .' * **queues**'."\n" - .' * **topics**'."\n" - ."\n" - .'* {Resource name}: the resource name.'."\n" - ."\n" - .' * If the resource type is **queues**, the resource name is the queue name.'."\n" - .' * If the resource type is **topics**, the resource name is the topic name.'."\n", - 'type' => 'string', - 'example' => 'acs:mns:cn-hangzhou:111:/queues/test/message', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* INFO'."\n" - .'* WARN'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'example' => '["INFO", "WARN", "CRITICAL"]', - ], - ], - ], + 'Resource' => [ + 'description' => 'The meta information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The event status.', 'type' => 'string', 'example' => 'failed', 'title' => ''], + 'EventType' => ['description' => 'The event type. Valid values:'."\n" + ."\n" + .'- StatusNotification: fault notification.'."\n" + ."\n" + .'- Exception: exception.'."\n" + ."\n" + .'- Maintenance: O&M.', 'type' => 'string', 'example' => 'Exception', 'title' => ''], + 'Product' => ['description' => 'The abbreviation of the product name.', 'type' => 'string', 'example' => 'ADS', 'title' => ''], + 'NameDesc' => ['description' => 'The description of the event name.', 'type' => 'string', 'example' => 'High query failure rate', 'title' => ''], + 'NameDesc.En' => ['description' => '英文事件名称的描述信息。', 'type' => 'string', 'example' => 'High query failure rate.', 'title' => ''], + 'Name' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'SelectFailureRate', 'title' => ''], + 'StatusDesc' => ['description' => 'The description of the event status.', 'type' => 'string', 'example' => 'Operation Failed', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- CRITICAL: critical.'."\n" + .'- WARN: warning.'."\n" + .'- INFO: information.', 'type' => 'string', 'example' => 'INFO', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 200 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\": \\"6A569B0D-9055-58AF-9E82-BAEAF95C0FD5\\",\\n \\"Success\\": true,\\n \\"FailData\\": {\\n \\"Targets\\": {\\n \\"Target\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Arn\\": \\"acs:mns:cn-hangzhou:111:/queues/test/message\\",\\n \\"Level\\": \\"[\\\\\\"INFO\\\\\\", \\\\\\"WARN\\\\\\", \\\\\\"CRITICAL\\\\\\"]\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<PutMetricRuleTargetsResponse>\\r\\n\\t<RequestId>6A569B0D-9055-58AF-9E82-BAEAF95C0FD5</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</PutMetricRuleTargetsResponse>\\t","errorExample":""}]', - 'title' => 'PutMetricRuleTargets', - 'description' => '# [](#)'."\n" - ."\n" - .'This topic provides an example on how to associate an alert rule with a resource. In this example, the alert rule is `ae06917_75a8c43178ab66****`, the resource is `acs:mns:cn-hangzhou:120886317861****:/queues/test/message`, and the ID of the resource for which alerts are triggered is `1`. The response indicates that the resource is associated with the specified alert rule.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Query meta information of system events', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutResourceMetricRule' => [ - 'summary' => 'Configures an alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventMetaList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"A6582C8B-E67C-4A19-BC15-EAEFEBDC7995\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Resource\\": [\\n {\\n \\"Status\\": \\"failed\\",\\n \\"EventType\\": \\"Exception\\",\\n \\"Product\\": \\"ADS\\",\\n \\"NameDesc\\": \\"High query failure rate\\",\\n \\"NameDesc.En\\": \\"High query failure rate.\\",\\n \\"Name\\": \\"SelectFailureRate\\",\\n \\"StatusDesc\\": \\"Operation Failed\\",\\n \\"Level\\": \\"INFO\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeTagKeyList' => [ + 'summary' => 'Calls the DescribeTagKeyList operation to query a list of tag keys.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'You can specify a new ID or the ID of an existing alert rule. For more information about how to query the IDs of alert rules, see [DescribeMetricRuleList](~~114941~~).'."\n" - ."\n" - .'> If you specify a new ID, a threshold-triggered alert rule is created.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', - ], - ], - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'You can specify a new name or the name of an existing alert rule. For more information about how to query the names of alert rules, see [DescribeMetricRuleList](~~114941~~).'."\n" - ."\n" - .'> If you specify a new name, a threshold-triggered alert rule is created.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test123', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service. For more information about how to query the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> If you create a Prometheus alert rule for Hybrid Cloud Monitoring, you must set this parameter to `acs_prometheus`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name. For more information about how to query metric names, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> If you create a Prometheus alert rule for Hybrid Cloud Monitoring, you must set this parameter to the name of the namespace. For more information about how to query the names of namespaces, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cpu_total', - ], - ], - [ - 'name' => 'Resources', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource information. Examples: `[{"instanceId":"i-uf6j91r34rnwawoo****"}]` and `[{"userId":"100931896542****"}]`.'."\n" - ."\n" - .'For more information about the supported dimensions that are used to query resources, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '[{"instanceId":"i-uf6j91r34rnwawoo****"}]', - ], - ], - [ - 'name' => 'ContactGroups', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert contact groups. Alert notifications are sent to the alert contacts in the alert contact group.'."\n" - ."\n" - .'> An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ECS_Group', - ], - ], - [ - 'name' => 'Webhook', - 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://alert.aliyun.com.com:8080/callback', - ], - ], - [ - 'name' => 'EffectiveInterval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The period of time during which the alert rule is effective.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-23:59', - ], - ], - [ - 'name' => 'NoEffectiveInterval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The period of time during which the alert rule is ineffective.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-06:00', - ], - ], - [ - 'name' => 'SilenceTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400.'."\n" - ."\n" - .'> If an alert is not cleared after the mute period ends, CloudMonitor resends an alert notification.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - 'default' => '86400', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical period of the metric. Unit: seconds. The default value is the interval at which the monitoring data of the metric is collected.'."\n" - ."\n" - .'> For more information about how to query the statistical periods of metrics, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '100', 'example' => '10', 'title' => ''], ], - [ - 'name' => 'Interval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which alerts are triggered based on the alert rule. Unit: seconds.'."\n" - ."\n" - .'> For more information about how to query the statistical periods of metrics, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - ], - [ - 'name' => 'EmailSubject', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The subject of the alert notification email.'."\n", - 'type' => 'string', - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + .'>A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter PageSize is not valid.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B04B8CF3-4489-432D-83BA-6F128E5F2293', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TagKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagKey' => [ + 'description' => 'The tag keys.', + 'type' => 'array', + 'items' => ['description' => 'The tag keys.', 'type' => 'string', 'example' => 't0et07752s_', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', 'example' => '', ], ], - [ - 'name' => 'Escalations.Critical.Statistics', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical methods for Critical-level alerts.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - ], - [ - 'name' => 'Escalations.Critical.ComparisonOperator', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid value:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - ], - [ - 'name' => 'Escalations.Critical.Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - ], - [ - 'name' => 'Escalations.Critical.Times', - 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - ], - [ - 'name' => 'Escalations.Warn.Statistics', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical methods for Warn-level alerts.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - ], - [ - 'name' => 'Escalations.Warn.ComparisonOperator', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid value:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - 'name' => 'Escalations.Warn.Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - 'name' => 'Escalations.Warn.Times', - 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - [ - 'name' => 'Escalations.Info.Statistics', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical methods for Info-level alerts.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - [ - 'name' => 'Escalations.Info.ComparisonOperator', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid value:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], + ], + 'title' => 'Query tag key list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTagKeyList'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ [ - 'name' => 'Escalations.Info.Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for Info-level alerts.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeTagKeyList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Specified parameter PageSize is not valid.\\",\\n \\"RequestId\\": \\"B04B8CF3-4489-432D-83BA-6F128E5F2293\\",\\n \\"Success\\": true,\\n \\"TagKeys\\": {\\n \\"TagKey\\": [\\n \\"t0et07752s_\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeTagValueList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Escalations.Info.Times', - 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'NoDataPolicy', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The method that is used to handle alerts when no monitoring data is found. Valid value:'."\n" - ."\n" - .'* KEEP_LAST_STATE (default): No operation is performed.'."\n" - .'* INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.'."\n" - .'* OK: The status is considered normal.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'KEEP_LAST_STATE', - ], + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Starts from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'CompositeExpression', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The trigger conditions for multiple metrics.'."\n" - ."\n" - .'> The trigger conditions for a single metric and multiple metrics are mutually exclusive. You cannot specify trigger conditions for a single metric and multiple metrics at the same time.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExpressionList' => [ - 'description' => 'The trigger conditions that are created in standard mode.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The trigger conditions that are created in standard mode.', - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], - 'Period' => [ - 'description' => 'The aggregation period of the metric.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - 'Statistics' => [ - 'description' => 'The statistical method of the metric. Valid value:'."\n" - ."\n" - .'* $Maximum: the maximum value'."\n" - .'* $Minimum: the minimum value'."\n" - .'* $Average: the average value'."\n" - .'* $Availability: the availability rate (usually used for site monitoring)'."\n" - ."\n" - .'> `$` is the prefix of the metric. For information about the Alibaba Cloud services that are supported by CloudMonitor, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$Maximum', - ], - 'ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid value:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'ExpressionListJoin' => [ - 'description' => 'The relationship between the trigger conditions for multiple metrics. Valid value:'."\n" - ."\n" - .'* `&&`: An alert is triggered only if all metrics meet the trigger conditions. An alert is triggered only if the results of all expressions specified in the ExpressionList parameter are `true`.'."\n" - .'* `||`: An alert is triggered if one of the metrics meets the trigger conditions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '||', - ], - 'ExpressionRaw' => [ - 'description' => 'The trigger conditions that are created by using expressions. You can use expressions to create trigger conditions in the following scenarios:'."\n" - ."\n" - .'* Set an alert blacklist for specific resources. For example, if you specify `$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50`, no alert is triggered when the `average metric value` of the `i-io8kfvcpp7x5****` instance exceeds 50.'."\n" - .'* Set a special alert threshold for a specified instance in the rule. For example, if you specify `$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)`, an alert is triggered when the `average metric value` of the `i-io8kfvcpp7x5****` instance exceeds 80 or the `average metric value` of other instances exceeds 50.'."\n" - .'* Limit the number of instances whose metric values exceed the threshold. For example, if you specify `count($Average > 20) > 3`, an alert is triggered only when the `average metric value` of more than three instances exceeds 20.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* Critical'."\n" - .'* Warn'."\n" - .'* Info'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Critical', - ], - 'Times' => [ - 'description' => 'The number of consecutive triggers. If the number of times that the metric values meet the trigger conditions reaches the value of this parameter, CloudMonitor sends alert notifications.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '100', 'example' => '10', 'title' => ''], ], [ - 'name' => 'Labels', + 'name' => 'TagKey', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'If the metric meets the specified condition in the alert rule and CloudMonitor sends an alert notification, the tag is also written to the metric and displayed in the alert notification.'."\n" - ."\n" - .'> This parameter is equivalent to the Label parameter of Prometheus alerts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The key of the tag.', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tagKey1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n" - ."\n" - .'> You can use a template parameter to specify a tag value. CloudMonitor replaces the value of the template parameter with an actual tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - ], - ], - [ - 'name' => 'Prometheus', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'Prometheus alerts.'."\n" - ."\n" - .'> This parameter is required only if you create a Prometheus alert rule for Hybrid Cloud Monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'PromQL' => [ - 'description' => 'PromQL statements are supported.'."\n" - ."\n" - .'> The data obtained by using the PromQL query statement is the monitoring data. You must include the alert threshold in this statement.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpuUsage{instanceId="xxxx"}[1m]>90', - ], - 'Level' => [ - 'description' => 'The alert level. Valid values:'."\n" - ."\n" - .'* Critical'."\n" - .'* Warn'."\n" - .'* Info'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Critical', - ], - 'Times' => [ - 'description' => 'The number of consecutive triggers. If the number of times that the metric values meet the trigger conditions reaches the value of this parameter, CloudMonitor sends alert notifications.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Annotations' => [ - 'description' => 'The annotations of the Prometheus alert rule. When a Prometheus alert is triggered, the system renders the annotated keys and values to help you understand the metrics and alert rule.'."\n" - ."\n" - .'> This parameter is equivalent to the annotations parameter of open source Prometheus.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The annotations of the Prometheus alert rule. When a Prometheus alert is triggered, the system renders the annotated keys and values to help you understand the metrics and alert rule.', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the annotation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'summary', - ], - 'Value' => [ - 'description' => 'The value of the annotation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The tag key.'."\n" + ."\n" + .'For more information about how to obtain the tag key, see [DescribeTagKeyList](~~145558~~).', 'type' => 'string', 'required' => true, 'example' => 'tagKey1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The responses code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The request processing has failed due to some unknown error.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65D50468-ECEF-48F1-A6E1-D952E89D9436', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates a successful response.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B04B8CF3-4489-432D-83BA-6F128E4F2295', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TagValues' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagValue' => [ + 'description' => 'The tag values.', + 'type' => 'array', + 'items' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'si-65d55ff37d6c4b4ea3b3', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 429 => [ - [ - 'errorCode' => 'ResourceOverLimit', - 'errorMessage' => 'The resource has exceeded the limit. %s', - ], - ], - 499 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'DescribeTagValueList', + 'summary' => 'Queries the tag values for a specified tag key.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTagValueList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeTagValueList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\": \\"65D50468-ECEF-48F1-A6E1-D952E89D9436\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutResourceMetricRuleResponse>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Message></Message>\\r\\n\\t<RequestId>65D50468-ECEF-48F1-A6E1-D952E89D9436</RequestId>\\r\\n\\t<Success>true</Success>\\r\\n</PutResourceMetricRuleResponse>","errorExample":""}]', - 'title' => 'PutResourceMetricRule', - 'description' => 'This topic provides an example on how to create a threshold-triggered alert rule for the `cpu_total` metric of an Elastic Compute Service (ECS) instance whose ID is `i-uf6j91r34rnwawoo****`. The namespace of ECS metrics is `acs_ecs_dashboard`. The alert contact group of the alert rule is `ECS_Group`. The name of the alert rule is `test123`. The ID of the alert rule is `a151cd6023eacee2f0978e03863cc1697c89508****`. The statistical method for Critical-level alerts is `Average`. The comparison operator for Critical-level alerts is `GreaterThanOrEqualToThreshold`. The threshold for Critical-level alerts is `90`. The consecutive number of times for which the metric value meets the trigger condition before a Critical-level alert is triggered is `3`.'."\n" - ."\n" - .'> Statistics verification was added on August 15, 2024. Only the statistical value of the corresponding metric can be set for the Statistics parameter. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](https://www.alibabacloud.com/help/en/cms/support/appendix-1-metrics).', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"B04B8CF3-4489-432D-83BA-6F128E4F2295\\",\\n \\"Success\\": true,\\n \\"TagValues\\": {\\n \\"TagValue\\": [\\n \\"si-65d55ff37d6c4b4ea3b3\\"\\n ]\\n }\\n}","type":"json"}]', 'extraInfo' => ' ', ], - 'PutResourceMetricRules' => [ - 'summary' => 'Creates multiple alert rules for the specified metric of a specified resource.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeUnhealthyHostAvailability' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Rules', + 'name' => 'Id', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The threshold-triggered alert rules.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n", + 'description' => 'The task ID.', 'type' => 'array', - 'items' => [ - 'description' => 'The statistical methods for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* Maximum: the maximum value'."\n" - .'* Minimum: the minimum value'."\n" - .'* Average: the average value'."\n" - .'* Availability: the availability rate'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must set a collection of the Rules.N.Escalations.Critical.Statistics, Rules.N.Escalations.Critical.ComparisonOperator, Rules.N.Escalations.Critical.Threshold, and Rules.N.Escalations.Critical.Times parameters, a collection of the Rules.N.Escalations.Warn.Statistics, Rules.N.Escalations.Warn.ComparisonOperator, Rules.N.Escalations.Warn.Threshold, and Rules.N.Escalations.Warn.Times parameters, or a collection of the Rules.N.Escalations.Info.Statistics, Rules.N.Escalations.Info.ComparisonOperator, Rules.N.Escalations.Info.Threshold, and Rules.N.Escalations.Info.Times parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Escalations.Info.Threshold' => [ - 'description' => 'The threshold for Info-level alerts.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'For information about how to query the name of a metric, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cpu_total', - ], - 'Escalations.Warn.Threshold' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - 'EffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is effective.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-23:59', - ], - 'NoEffectiveInterval' => [ - 'description' => 'The time period during which the alert rule is ineffective.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-06:00', - ], - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'You can specify a new ID or the ID of an existing alert rule. For information about how to query the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n" - ."\n" - .'> If you specify a new ID, a threshold-triggered alert rule is created.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', - ], - 'Escalations.Critical.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Escalations.Critical.Threshold' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], - 'Escalations.Critical.Statistics' => [ - 'description' => 'The statistical methods for Critical-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Warn.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Info.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Resources' => [ - 'description' => 'The information about the resource. Example: `[{"instanceId":"i-uf6j91r34rnwawoo****"}]` or `[{"userId":"100931896542****"}]`.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'For more information about the supported dimensions that are used to query resources, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '[{"instanceId":"i-uf6j91r34rnwawoo****"}]', - ], - 'SilenceTime' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met.'."\n" - ."\n" - .'Unit: seconds. Default value: 86400.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> If an alert is not cleared after the mute period ends, CloudMonitor resends an alert notification.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], - 'Webhook' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://alert.aliyun.com.com:8080/callback', - ], - 'ContactGroups' => [ - 'description' => 'The alert contact groups. The alert notifications are sent to the alert contacts in the alert contact group.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Group', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'For information about how to query the namespace of a cloud service, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], - 'EmailSubject' => [ - 'description' => 'The subject of the alert notification email.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Period' => [ - 'description' => 'The statistical period of the metric.'."\n" - ."\n" - .'Unit: seconds. The default value is the interval at which the monitoring data of the metric is collected.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> For information about how to query the statistical period of a metric, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'You can specify a new name or the name of an existing alert rule. For information about how to query the name of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n" - ."\n" - .'> If you specify a new name, a threshold-triggered alert rule is created.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test123', - ], - 'Escalations.Info.Statistics' => [ - 'description' => 'The statistical methods for Info-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'Escalations.Warn.Times' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Escalations.Info.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Interval' => [ - 'description' => 'The interval at which alerts are triggered based on the alert rule.'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> For information about how to query the statistical period of a metric, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], - 'Escalations.Critical.ComparisonOperator' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* EqualToThreshold: equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.', - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], - 'Escalations.Warn.Statistics' => [ - 'description' => 'The statistical methods for Warn-level alerts.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for each alert level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], - 'NoDataPolicy' => [ - 'description' => 'The method that is used to handle alerts when no monitoring data is found. Valid values:'."\n" - ."\n" - .'* KEEP_LAST_STATE (default): No operation is performed.'."\n" - .'* INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.'."\n" - .'* OK: The status is considered normal.'."\n" - ."\n" - .'Valid values of N: 1 to 500.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'KEEP_LAST_STATE', - ], - 'Labels' => [ - 'description' => 'If the metric meets the specified condition in the alert rule and CloudMonitor sends an alert notification, the tag is also written to the metric and displayed in the alert notification.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tagKey1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n" - ."\n" - .'> You can use a template parameter to specify a tag value. CloudMonitor replaces the value of the template parameter with an actual tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - 'minItems' => 0, - ], - ], - 'required' => false, - ], + 'items' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123***', 'title' => ''], 'required' => true, - 'maxItems' => 500, + 'example' => '123456', + 'maxItems' => 20, + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request processing has failed due to some unknown error.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15D1440E-BF24-5A41-93E4-36864635179E', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FailedListResult' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: -true: The operation was successful. -false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'UnhealthyList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Target' => [ - 'description' => 'The alert rules that failed to be created for the resource.'."\n", + 'NodeTaskInstance' => [ + 'description' => 'Information about the list of unhealthy servers.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', - ], - 'Result' => [ - 'description' => 'The alert rule that failed to be created.'."\n", + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123******', 'title' => ''], + 'InstanceList' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => '404', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The request processing has failed due to some unknown error.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', + 'String' => [ + 'description' => 'A list of instance IDs.', + 'type' => 'array', + 'items' => ['description' => 'The instances.', 'type' => 'string', 'example' => 'i-*****', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 204 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 206 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 422 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 499 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'DescribeUnhealthyHostAvailability', + 'summary' => 'Call the DescribeUnhealthyHostAvailability operation to query a list of unhealthy servers.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUnhealthyHostAvailability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cms:DescribeUnhealthyHostAvailability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\": \\"15D1440E-BF24-5A41-93E4-36864635179E\\",\\n \\"Success\\": true,\\n \\"FailedListResult\\": {\\n \\"Target\\": [\\n {\\n \\"RuleId\\": \\"a151cd6023eacee2f0978e03863cc1697c89508****\\",\\n \\"Result\\": {\\n \\"Code\\": \\"404\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"Success\\": false\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<PutResourceMetricRulesResponse>\\r\\n\\t<Message></Message>\\r\\n\\t<RequestId>15D1440E-BF24-5A41-93E4-36864635179E</RequestId>\\r\\n\\t<FailedListResult></FailedListResult>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</PutResourceMetricRulesResponse>\\t","errorExample":""}]', - 'title' => 'PutResourceMetricRules', - 'description' => 'This topic provides an example on how to create a threshold-triggered alert rule for the `cpu_total` metric of an Elastic Compute Service (ECS) instance whose ID is `i-uf6j91r34rnwawoo****`. The namespace of ECS metrics is `acs_ecs_dashboard`. The alert contact group of the alert rule is `ECS_Group`. The name of the alert rule is `test123`. The ID of the alert rule is `a151cd6023eacee2f0978e03863cc1697c89508****`. The statistical method for Critical-level alerts is `Average`. The comparison operator for Critical-level alerts is `GreaterThanOrEqualToThreshold`. The threshold for Critical-level alerts is `90`. The consecutive number of times for which the metric value meets the trigger condition before a Critical-level alert is triggered is `3`.'."\n" - ."\n" - .'> Statistics verification was added on August 15, 2024. Only the statistical value of the corresponding metric can be set for the Statistics parameter. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](https://www.alibabacloud.com/help/en/cms/support/appendix-1-metrics).', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"ACBDBB40-DFB6-4F4C-8957-51FFB233969C\\",\\n \\"Success\\": true,\\n \\"UnhealthyList\\": {\\n \\"NodeTaskInstance\\": [\\n {\\n \\"Id\\": 0,\\n \\"InstanceList\\": {\\n \\"String\\": [\\n \\"i-*****\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'extraInfo' => ' ', ], - 'PutGroupMetricRule' => [ - 'summary' => 'Creates or modifies an alert rule for an application group.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DisableActiveMetricRule' => [ + 'summary' => 'Disables the initiative alert feature for a cloud service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => 'The application group ID.'."\n" - ."\n" - .'For more information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '17285****', - ], + 'schema' => ['description' => 'The cloud service for which you want to disable proactive alerting. Valid values:'."\n" + ."\n" + .'- ECS: Elastic Compute Service (ECS)'."\n" + ."\n" + .'- rds: ApsaraDB RDS'."\n" + ."\n" + .'- slb: Server Load Balancer (SLB)'."\n" + ."\n" + .'- redis\\_standard: Redis Open-Source Edition (standard architecture)'."\n" + ."\n" + .'- redis\\_sharding: Redis Open-Source Edition (cluster architecture)'."\n" + ."\n" + .'- redis\\_splitrw: Redis Open-Source Edition (read/write splitting architecture)'."\n" + ."\n" + .'- mongodb: ApsaraDB for MongoDB of the replica set architecture'."\n" + ."\n" + .'- mongodb\\_sharding: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" + ."\n" + .'- hbase: ApsaraDB for HBase'."\n" + ."\n" + .'- elasticsearch: Elasticsearch'."\n" + ."\n" + .'- opensearch: OpenSearch', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], ], - [ - 'name' => 'RuleId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'* When you create an alert rule for the application group, enter the ID of the alert rule.'."\n" - .'* When you modify a specified alert rule in the application group, you must obtain the ID of the alert rule. For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123456', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Category', - 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the cloud service name.'."\n" - ."\n" - .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], + ], + 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'* When you create an alert rule for the application group, enter the name of the alert rule.'."\n" - .'* When you modify a specified alert rule in the application group, you must obtain the name of the alert rule. For more information about how to obtain the name of an alert rule, see [DescribeMetricRuleList](~~114941~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Rule_01', - ], + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], - [ - 'name' => 'MetricName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'For more information about how to obtain the name of a metric, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_total', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], ], [ - 'name' => 'Dimensions', - 'in' => 'query', - 'schema' => [ - 'description' => 'The first-level dimension of the alert rule in the application group.'."\n" - ."\n" - .'Set the value to a set of key-value pairs, for example, `userId:120886317861****` or `instanceId:i-m5e1qg6uo38rztr4****`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"instanceId":"i-m5e1qg6uo38rztr4****"}]', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - [ - 'name' => 'ExtraDimensionJson', - 'in' => 'query', - 'schema' => [ - 'description' => 'The second-level or third-level dimension of the alert rule in the application group.'."\n" - ."\n" - .'Set the value to a set of key-value pairs, for example, `port:80` or `/dev/xvda:d-m5e6yphgzn3aprwu****`.'."\n" - ."\n" - .'If the first-level dimension of the alert rule is `instanceId:i-m5e1qg6uo38rztr4****`, its second-level dimension is the `/dev/xvda:d-m5e6yphgzn3aprwu****` disk in the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}', - ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - 'name' => 'EffectiveInterval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time period during which the alert rule is effective.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '05:31-23:59', - ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - 'name' => 'NoEffectiveInterval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time period during which the alert rule is ineffective.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-05:30', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - [ - 'name' => 'SilenceTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met.'."\n" - ."\n" - .'Unit: seconds. Default value: 86400.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => 'The aggregation period of the metric data.'."\n" - ."\n" - .'Set the `Period` parameter to an integral multiple of 60. Unit: seconds. Default value: 300.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', + ], + 'title' => 'DisableActiveMetricRule', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableActiveMetricRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:DisableActiveMetricRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"F82E6667-7811-4BA0-842F-5B2DC42BBAAD\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DisableEventRules' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Interval', - 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which CloudMonitor checks whether the alert rule is triggered. Unit: seconds.'."\n" - ."\n" - .'> We recommend that you set the interval to the data aggregation period. If the interval is shorter than the data aggregation period, alerts cannot be triggered due to insufficient data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'Webhook', + 'name' => 'RuleNames', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The callback URL.'."\n" - ."\n" - .'The callback URL must be accessible over the Internet. CloudMonitor sends a POST request to push an alert notification to the callback URL that you specify. Only HTTP requests are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', + 'description' => 'The names of the event-triggered alert rules.', + 'type' => 'array', + 'items' => ['description' => 'The name of an event-triggered alert rule.', 'type' => 'string', 'required' => false, 'example' => 'ruleName1', 'title' => ''], + 'required' => true, + 'example' => 'ruleName1', + 'maxItems' => 20, + 'title' => '', ], ], - [ - 'name' => 'EmailSubject', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The subject of the alert notification email.'."\n", - 'type' => 'string', - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3FD0E8B5-F132-4F4E-A081-2878AF378B12', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', 'example' => '', ], ], - [ - 'name' => 'ContactGroups', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert contact group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Group', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - [ - 'name' => 'Escalations.Critical.Statistics', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical methods for Critical-level alerts. Separate multiple statistical methods with commas (,).'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], + 403 => [ + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], - [ - 'name' => 'Escalations.Critical.ComparisonOperator', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - [ - 'name' => 'Escalations.Critical.Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for Critical-level alerts.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', + ], + 'title' => 'DisableEventRules', + 'summary' => 'Disables one or more event-triggered alert rules.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableEventRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:DisableEventRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3FD0E8B5-F132-4F4E-A081-2878AF378B12\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'extraInfo' => ' ', + ], + 'DisableHostAvailability' => [ + 'summary' => 'Disables one or more specified availability monitoring jobs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Escalations.Critical.Times', - 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'Escalations.Warn.Statistics', + 'name' => 'Id', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The statistical methods for Warn-level alerts. Separate multiple statistical methods with commas (,).'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', + 'description' => 'The IDs of the availability monitoring jobs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the availability monitoring job.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''], + 'required' => true, + 'example' => '12345', + 'maxItems' => 20, + 'title' => '', ], ], - [ - 'name' => 'Escalations.Warn.ComparisonOperator', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: true: success. false: failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Escalations.Warn.Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for Warn-level alerts.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - 'name' => 'Escalations.Warn.Times', - 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - 'name' => 'Escalations.Info.Statistics', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical methods for Info-level alerts. Separate multiple statistical methods with commas (,).'."\n" - ."\n" - .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Average', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - [ - 'name' => 'Escalations.Info.ComparisonOperator', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" - ."\n" - .'* GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" - .'* GreaterThanThreshold: greater than the threshold'."\n" - .'* LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" - .'* LessThanThreshold: less than the threshold'."\n" - .'* NotEqualToThreshold: not equal to the threshold'."\n" - .'* GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" - .'* LessThanYesterday: less than the metric value at the same time yesterday'."\n" - .'* GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" - .'* LessThanLastWeek: less than the metric value at the same time last week'."\n" - .'* GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" - .'* LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GreaterThanOrEqualToThreshold', - ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], - [ - 'name' => 'Escalations.Info.Threshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for Info-level alerts.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '90', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - [ - 'name' => 'Escalations.Info.Times', - 'in' => 'query', - 'schema' => [ - 'description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', + ], + 'title' => 'DisableHostAvailability', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableHostAvailability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:DisableHostAvailability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'HostAvailability', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"ACBDBB40-DFB6-4F4C-8957-51FFB233969C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'extraInfo' => ' ', + ], + 'DisableMetricRules' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NoDataPolicy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method that is used to handle alerts when no monitoring data is found. Valid values:'."\n" - ."\n" - .'* KEEP_LAST_STATE (default): No operation is performed.'."\n" - .'* INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered.'."\n" - .'* OK: The status is considered normal.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'KEEP_LAST_STATE', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'Labels', + 'name' => 'RuleId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags of the alert rule.'."\n" - ."\n" - .'The specified tag is contained in alert notifications.'."\n", + 'description' => 'The IDs of the alert rules.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - 'minItems' => 0, - ], - ], - [ - 'name' => 'Options', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'items' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'uuid_a141b055483428c22bab05443287196afa42cb6146', 'title' => ''], + 'required' => true, + 'example' => 'detect_87****_HTTP_HttpLatency', + 'maxItems' => 100, + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Result' => [ - 'description' => 'The result of the request.'."\n", - 'type' => 'object', - 'properties' => [ - 'RuleId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. A value of \\`true\\` indicates success and a value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + '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', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], - 406 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], - 499 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], + ], + 500 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'DisableMetricRules', + 'summary' => 'You can call the DisableMetricRules operation to disable alert rules.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableMetricRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:DisableMetricRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"RuleId\\": \\"123456\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<PutGroupMetricRuleResponse>\\r\\n\\t<Message></Message>\\r\\n\\t<RequestId>461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Result>\\r\\n\\t\\t<RuleId>123456</RuleId>\\r\\n\\t</Result>\\r\\n</PutGroupMetricRuleResponse>","errorExample":""}]', - 'title' => 'PutGroupMetricRule', - 'description' => 'This topic provides an example on how to create an alert rule for the `cpu_total` metric of Elastic Compute Service (ECS) in the `17285****` application group. The ID of the alert rule is `123456`. The name of the alert rule is `Rule_test`. The alert level is `Critical`. The statistical method is `Average`. The alert threshold comparator is `GreaterThanOrEqualToThreshold`. The alert threshold is `90`. The number of alert retries is `3`. The returned result shows that the alert rule is created and the alert rule ID is `123456`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"FF38D33A-67C1-40EB-AB65-FAEE51EDB644\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'extraInfo' => ' ', ], - 'DeleteEventRuleTargets' => [ - 'summary' => 'Deletes the push channels of an event-triggered alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DisableSiteMonitors' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleName', + 'name' => 'TaskIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the event-triggered alert rule.'."\n" - ."\n" - .'For information about how to obtain the name of an event-triggered alert rule, see [DescribeEventRuleList](~~114996~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testRule', - ], - ], - [ - 'name' => 'Ids', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of event-triggered alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'required' => true, - 'maxItems' => 20, - 'example' => '1', - ], + 'schema' => ['description' => 'The IDs of site monitoring tasks. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****,49f7b317-7645-4cc9-94fd-ea42e522****', 'title' => ''], ], ], 'responses' => [ @@ -31064,99 +21707,129 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '7ADD7EFB-7555-4EC1-A3D9-F9955C189CCF', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3fcd12e7-d387-42ee-b77e-661c775bb17f', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The number of detection point records affected by the site monitoring task.', + 'type' => 'object', + 'properties' => [ + 'count' => ['description' => 'The number of detection point records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], + ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ['errorCode' => 'UnauthorizedTasks', 'errorMessage' => 'You are not permitted to operate the specified tasks.', 'description' => 'You are not permitted to operate the specified tasks.'], + ], + [ + ['errorCode' => 'TaskNotExist', 'errorMessage' => 'The specified task does not exist.', 'description' => 'The specified task does not exist.'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successfull\\",\\n \\"RequestId\\": \\"142989D9-CC52-54D0-928D-2C9B1D9F051C\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteEventRuleTargets', - ], - 'DeleteEventRules' => [ - 'summary' => 'Deletes event-triggered alert rules.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Disable one or more site monitoring tasks', + 'summary' => 'Disables one or more site monitoring tasks by calling the DisableSiteMonitors operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-01T07:22:22.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSiteMonitors'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:DisableSiteMonitors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3fcd12e7-d387-42ee-b77e-661c775bb17f\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 0\\n }\\n}","type":"json"}]', + ], + 'EnableActiveMetricRule' => [ + 'summary' => 'Enables the initiative alert feature for a cloud service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleNames', + 'name' => 'Product', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The name of the alert rule. Valid values of N: 1 to 20.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - 'example' => 'rule1', - ], - 'required' => true, - 'example' => 'rule1', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The cloud service for which you want to enable initiative alert. Valid values:'."\n" + ."\n" + .'- ECS: Elastic Compute Service (ECS)'."\n" + ."\n" + .'- rds: ApsaraDB RDS'."\n" + ."\n" + .'- slb: Server Load Balancer (SLB)'."\n" + ."\n" + .'- redis\\_standard: Redis Open-Source Edition (standard architecture)'."\n" + ."\n" + .'- redis\\_sharding: Redis Open-Source Edition (cluster architecture)'."\n" + ."\n" + .'- redis\\_splitrw: Redis Open-Source Edition (read/write splitting architecture)'."\n" + ."\n" + .'- mongodb: ApsaraDB for MongoDB of the replica set architecture'."\n" + ."\n" + .'- mongodb\\_sharding: ApsaraDB for MongoDB of the sharded cluster architecture'."\n" + ."\n" + .'- hbase: ApsaraDB for HBase'."\n" + ."\n" + .'- elasticsearch: Elasticsearch'."\n" + ."\n" + .'- opensearch: OpenSearch', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], ], ], 'responses' => [ @@ -31164,69 +21837,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E5A72B5B-4F44-438C-B68A-147FD5DC53A8', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"45231A42-5A09-5AFF-953C-A5B3D4ED8925\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteEventRules', + 'title' => 'EnableActiveMetricRule', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableActiveMetricRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:EnableActiveMetricRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"F82E6667-7811-4BA0-842F-5B2DC42BBAAD\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'EnableEventRules' => [ - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31234,24 +21919,20 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RuleNames', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'The names of the event rules to enable.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'The name of the event-triggered alert rule. Valid values of N: 1 to 20.'."\n", - ], + 'items' => ['description' => 'The name of the event rule to enable.', 'type' => 'string', 'required' => false, 'example' => 'ruleName1', 'title' => ''], 'required' => true, 'example' => 'ruleName1', 'maxItems' => 20, + 'title' => '', ], ], ], @@ -31260,93 +21941,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '20F2896A-6684-4A04-8255-4155B1593C70', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. It is a unique identifier generated by Alibaba Cloud. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '20F2896A-6684-4A04-8255-4155B1593C70', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'EnableEventRules', + 'summary' => 'The EnableEventRules operation enables one or more event rules.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableEventRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:EnableEventRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"20F2896A-6684-4A04-8255-4155B1593C70\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'EnableEventRules', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], - 'DisableEventRules' => [ - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'EnableHostAvailability' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleNames', + 'name' => 'Id', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'The ID of the availability monitoring task.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'The name of the event-triggered alert rule. Valid values of N: 1 to 20.'."\n", - ], + 'items' => ['description' => 'The ID of the availability monitoring task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''], 'required' => true, - 'example' => 'ruleName1', 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], ], @@ -31355,681 +22023,279 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3FD0E8B5-F132-4F4E-A081-2878AF378B12', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3FD0E8B5-F132-4F4E-A081-2878AF378B12\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DisableEventRules', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeEventRuleAttribute' => [ - 'summary' => 'Queries the details of an event-triggered alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', + 'title' => 'Enable a specified availability monitoring task', + 'summary' => 'Enables a specified availability monitoring task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableHostAvailability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:EnableHostAvailability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"ACBDBB40-DFB6-4F4C-8957-51FFB233969C\\",\\n \\"Success\\": false\\n}","type":"json"}]', + ], + 'EnableMetricRuleBlackList' => [ + 'summary' => 'Enables or disables multiple blacklist policies at a time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RuleName', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the event-triggered alert rule.'."\n" - ."\n" - .'For information about how to obtain the name of an event-triggered alert rule, see [DescribeEventRuleList](~~114996~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testRule', - ], + 'schema' => ['description' => 'The IDs of the blacklist policies. Separate multiple IDs with commas (,). You can specify up to 50 IDs.'."\n" + ."\n" + .'For information about how to obtain the ID of a blacklist policy, see [DescribeMetricRuleBlackList](~~457257~~).'."\n" + ."\n" + .'> You can also set this parameter to a JSON array. Example: `["a9ad2ac2-3ed9-11ed-b878-0242ac12****","5cb8a9a4-198f-4651-a353-f8b28788****"]`.', 'type' => 'string', 'required' => true, 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', 'title' => ''], ], [ - 'name' => 'SilenceTime', + 'name' => 'IsEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met.'."\n" - ."\n" - .'Unit: seconds. Default value: 86400, which indicates one day.'."\n" - ."\n" - .'> Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '86400', - ], + 'schema' => ['description' => 'Specifies whether to enable the blacklist policy. Valid values:'."\n" + ."\n" + .'- true: The blacklist policy is enabled.'."\n" + ."\n" + .'- false (default): The blacklist policy is disabled.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The alert does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9AA3F210-C03D-4C86-8DB6-21C84FF692A1', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Result' => [ - 'description' => 'The details of the event-triggered alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'EventType' => [ - 'description' => 'The event type. Valid values:'."\n" - ."\n" - .'* SYSTEM: system event'."\n" - .'* CUSTOM: custom event'."\n", - 'type' => 'string', - 'example' => 'SYSTEM', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '3607****', - ], - 'Name' => [ - 'description' => 'The name of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'example' => 'test_DefaultEventRule_7378****', - ], - 'Description' => [ - 'description' => 'The description of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'example' => 'Default group event rule.', - ], - 'State' => [ - 'description' => 'The status of the event-triggered alert rule. Valid values:'."\n" - ."\n" - .'* ENABLED'."\n" - .'* DISABLED'."\n", - 'type' => 'string', - 'example' => 'ENABLED', - ], - 'EventPattern' => [ - 'description' => 'The event pattern. This parameter describes the trigger conditions of an event.'."\n", - 'type' => 'object', - 'properties' => [ - 'Product' => [ - 'description' => 'The name of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - 'LevelList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'LevelList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The level of the event-triggered alert rule. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'example' => '["CRITICAL","WARN"] ', - ], - ], - ], - ], - 'StatusList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'StatusList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The status of the event.'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - ], - ], - ], - 'NameList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NameList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the event.'."\n", - 'type' => 'string', - 'example' => 'Agent_Status_Running', - ], - ], - ], - ], - 'EventTypeList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'EventTypeList' => [ - 'description' => 'The types of the event-triggered alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the event-triggered alert rule.'."\n" - ."\n" - .'`*` indicates all types of alert rules.'."\n", - 'type' => 'string', - 'example' => '*', - ], - ], - ], - ], - 'SQLFilter' => [ - 'description' => 'Indicates that logs are filtered based on the specified SQL statement. If the specified conditions are met, an alert is triggered.'."\n", - 'type' => 'string', - 'example' => 'ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222', - ], - 'KeywordFilterObj' => [ - 'description' => 'The keyword for filtering.'."\n", - 'type' => 'object', - 'properties' => [ - 'Keywords' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'keyword' => [ - 'description' => 'The keywords that are used to match events.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The keyword.'."\n", - 'type' => 'string', - 'example' => 'VMException', - ], - ], - ], - ], - 'Relation' => [ - 'description' => 'The relationship between multiple keywords in a condition. Valid values:'."\n" - ."\n" - .'* OR: The relationship between keywords is OR.'."\n" - .'* NOT: The keyword is excluded. The value NOT indicates that all events that do not contain the keywords are matched.'."\n", - 'type' => 'string', - 'example' => 'OR', - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94869866-1621-3652-BBC9-72A47B2AC2F5', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Count' => ['description' => 'The number of blacklist policies that are enabled or disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'EnableMetricRuleBlackList', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableMetricRuleBlackList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:EnableMetricRuleBlackList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The alert does not exist.\\",\\n \\"RequestId\\": \\"9AA3F210-C03D-4C86-8DB6-21C84FF692A1\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"EventType\\": \\"SYSTEM\\",\\n \\"GroupId\\": \\"3607****\\",\\n \\"Name\\": \\"test_DefaultEventRule_7378****\\",\\n \\"Description\\": \\"Default group event rule.\\",\\n \\"State\\": \\"ENABLED\\",\\n \\"EventPattern\\": {\\n \\"Product\\": \\"CloudMonitor\\",\\n \\"LevelList\\": {\\n \\"LevelList\\": [\\n \\"[\\\\\\"CRITICAL\\\\\\",\\\\\\"WARN\\\\\\"] \\"\\n ]\\n },\\n \\"StatusList\\": {\\n \\"StatusList\\": [\\n \\"Running\\"\\n ]\\n },\\n \\"NameList\\": {\\n \\"NameList\\": [\\n \\"Agent_Status_Running\\"\\n ]\\n },\\n \\"EventTypeList\\": {\\n \\"EventTypeList\\": [\\n \\"*\\"\\n ]\\n },\\n \\"SQLFilter\\": \\"ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222\\",\\n \\"KeywordFilterObj\\": {\\n \\"Keywords\\": {\\n \\"keyword\\": [\\n \\"VMException\\"\\n ]\\n },\\n \\"Relation\\": \\"OR\\"\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeEventRuleAttributeResponse>\\r\\n\\t<RequestId>9AA3F210-C03D-4C86-8DB6-21C84FF692A1</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Result>\\r\\n\\t\\t<EventPattern>\\r\\n\\t\\t\\t<NameList>\\r\\n\\t\\t\\t\\t<NameList>Agent_Status_Running</NameList>\\r\\n\\t\\t\\t</NameList>\\r\\n\\t\\t\\t<LevelList>\\r\\n\\t\\t\\t\\t<LevelList>CRITICAL</LevelList>\\r\\n\\t\\t\\t</LevelList>\\r\\n\\t\\t\\t<Product>CloudMonitor</Product>\\r\\n\\t\\t</EventPattern>\\r\\n\\t\\t<Description>Default group event rule</Description>\\r\\n\\t\\t<EventType>SYSTEM</EventType>\\r\\n\\t\\t<State>ENABLED</State>\\r\\n\\t\\t<Name>test_DefaultEventRule_7378****</Name>\\r\\n\\t\\t<GroupId>3607****</GroupId>\\r\\n\\t</Result>\\r\\n</DescribeEventRuleAttributeResponse>\\t","errorExample":""}]', - 'title' => 'DescribeEventRuleAttribute', - 'description' => 'This topic provides an example to show how to query the details of an event-triggered alert rule named `testRule`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"94869866-1621-3652-BBC9-72A47B2AC2F5\\",\\n \\"Success\\": true,\\n \\"Count\\": 1\\n}","type":"json"}]', ], - 'DescribeEventRuleList' => [ - 'summary' => 'Queries event-triggered alert rules.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'EnableMetricRules' => [ + 'summary' => 'Enables alert rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'NamePrefix', - 'in' => 'query', - 'schema' => [ - 'description' => 'The prefix in the name of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'RuleId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The page number.'."\n" + 'description' => 'The IDs of the alert rules.'."\n" ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" + .'Valid values of N: 1 to 100.'."\n" ."\n" - .'Pages start from page 1. Default value: 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7378****', - ], - ], - [ - 'name' => 'IsEnable', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the event-triggered alert rule. Valid values:'."\n" + .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).', + 'type' => 'array', + 'items' => ['description' => 'The ID of the alert rule.'."\n" ."\n" - .'- true (default)'."\n" - .'- false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => 'GroupProcess_67800278_2FE7D515-4BBD-447B-BC1A-3F17ED49****', 'title' => ''], + 'required' => true, + 'example' => 'ab05733c97b7ce239fb1b53393dc1697c123****', + 'maxItems' => 100, + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The event-triggered alert rules.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'User not authorized to operate on the specified resource.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D0E6D82B-16B5-422A-8136-EE5BDC01E415', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '21', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EventRules' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'EventRule' => [ - 'description' => 'The event-triggered alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EventType' => [ - 'description' => 'The type of the event-triggered alert rule. Valid values:'."\n" - ."\n" - .'* SYSTEM: system event-triggered alert rule'."\n" - .'* CUSTOM: custom event-triggered alert rule'."\n", - 'type' => 'string', - 'example' => 'SYSTEM', - ], - 'Description' => [ - 'description' => 'The description of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'example' => 'Default group event rule.', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '7378****', - ], - 'Name' => [ - 'description' => 'The name of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'example' => 'test_DefaultEventRule_7378****', - ], - 'State' => [ - 'description' => 'The status of the event-triggered alert rule. Valid values:'."\n" - ."\n" - .'* ENABLED'."\n" - .'* DISABLED'."\n", - 'type' => 'string', - 'example' => 'ENABLED', - ], - 'EventPattern' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'EventPattern' => [ - 'description' => 'The mode of the event-triggered alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Product' => [ - 'description' => 'The abbreviation of the Alibaba Cloud service name.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor', - ], - 'LevelList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'LevelList' => [ - 'description' => 'The levels of the event-triggered alerts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The level of the event-triggered alert. Valid values:'."\n" - ."\n" - .'* CRITICAL'."\n" - .'* WARN'."\n" - .'* INFO'."\n", - 'type' => 'string', - 'example' => 'CRITICAL', - ], - ], - ], - ], - 'EventTypeList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'EventTypeList' => [ - 'description' => 'The types of the event-triggered alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the event-triggered alert rule.'."\n" - ."\n" - .'`*` indicates all types of alert rules.'."\n", - 'type' => 'string', - 'example' => '*', - ], - ], - ], - ], - 'NameList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NameList' => [ - 'description' => 'The event names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The event name.'."\n", - 'type' => 'string', - 'example' => '["Agent_Status_Stopped"]', - ], - ], - ], - ], - 'CustomFilters' => [ - 'description' => 'The custom filter conditions.'."\n", - 'type' => 'string', - 'example' => 'ECS123', - ], - 'KeywordFilter' => [ - 'description' => 'The keyword for filtering.'."\n", - 'type' => 'object', - 'properties' => [ - 'Keywords' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Keywords' => [ - 'description' => 'The keywords that are used to match events.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The keyword.'."\n", - 'type' => 'string', - 'example' => 'VMException', - ], - ], - ], - ], - 'Relation' => [ - 'description' => 'The relationship between multiple keywords in a condition. Valid values:'."\n" - ."\n" - .'* OR: The relationship between keywords is OR.'."\n" - .'* NOT: The keyword is excluded. The value NOT indicates that all events that do not contain the keywords are matched.'."\n", - 'type' => 'string', - 'example' => 'OR', - ], - ], - ], - 'SQLFilter' => [ - 'description' => 'Indicates that logs are filtered based on the specified SQL statement. If the specified conditions are met, an alert is triggered.'."\n", - 'type' => 'string', - 'example' => 'ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222', - ], - ], - ], - ], - ], - ], - 'SilenceTime' => [ - 'description' => 'The mute period during which new alert notifications are not sent even if the trigger conditions are met.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '86400', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + 402 => [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"D0E6D82B-16B5-422A-8136-EE5BDC01E415\\",\\n \\"Total\\": 21,\\n \\"Success\\": true,\\n \\"EventRules\\": {\\n \\"EventRule\\": [\\n {\\n \\"EventType\\": \\"SYSTEM\\",\\n \\"Description\\": \\"Default group event rule.\\",\\n \\"GroupId\\": \\"7378****\\",\\n \\"Name\\": \\"test_DefaultEventRule_7378****\\",\\n \\"State\\": \\"ENABLED\\",\\n \\"EventPattern\\": {\\n \\"EventPattern\\": [\\n {\\n \\"Product\\": \\"CloudMonitor\\",\\n \\"LevelList\\": {\\n \\"LevelList\\": [\\n \\"CRITICAL\\"\\n ]\\n },\\n \\"EventTypeList\\": {\\n \\"EventTypeList\\": [\\n \\"*\\"\\n ]\\n },\\n \\"NameList\\": {\\n \\"NameList\\": [\\n \\"[\\\\\\"Agent_Status_Stopped\\\\\\"]\\"\\n ]\\n },\\n \\"CustomFilters\\": \\"ECS123\\",\\n \\"KeywordFilter\\": {\\n \\"Keywords\\": {\\n \\"Keywords\\": [\\n \\"VMException\\"\\n ]\\n },\\n \\"Relation\\": \\"OR\\"\\n },\\n \\"SQLFilter\\": \\"ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222\\"\\n }\\n ]\\n },\\n \\"SilenceTime\\": 86400\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeEventRuleListResponse>\\r\\n\\t<RequestId>C8308712-6E7A-4FA0-82AC-80D018DAD168</RequestId>\\r\\n\\t<Total>3</Total>\\r\\n\\t<EventRules>\\r\\n\\t\\t<EventRule>\\r\\n\\t\\t\\t<EventPattern>\\r\\n\\t\\t\\t\\t<NameList>\\r\\n\\t\\t\\t\\t\\t<NameList>*</NameList>\\r\\n\\t\\t\\t\\t</NameList>\\r\\n\\t\\t\\t\\t<LevelList>\\r\\n\\t\\t\\t\\t\\t<LevelList>CRITICAL</LevelList>\\r\\n\\t\\t\\t\\t</LevelList>\\r\\n\\t\\t\\t\\t<EventTypeList>\\r\\n\\t\\t\\t\\t\\t<EventTypeList>*</EventTypeList>\\r\\n\\t\\t\\t\\t</EventTypeList>\\r\\n\\t\\t\\t\\t<Product>CloudMonitor</Product>\\r\\n\\t\\t\\t</EventPattern>\\r\\n\\t\\t\\t<EventType>SYSTEM</EventType>\\r\\n\\t\\t\\t<State>ENABLED</State>\\r\\n\\t\\t\\t<Name>test123</Name>\\r\\n\\t\\t</EventRule>\\r\\n\\t\\t<EventRule>\\r\\n\\t\\t\\t<EventPattern>\\r\\n\\t\\t\\t\\t<NameList>\\r\\n\\t\\t\\t\\t\\t<NameList>*</NameList>\\r\\n\\t\\t\\t\\t</NameList>\\r\\n\\t\\t\\t\\t<LevelList>\\r\\n\\t\\t\\t\\t\\t<LevelList>CRITICAL</LevelList>\\r\\n\\t\\t\\t\\t\\t<LevelList>WARN</LevelList>\\r\\n\\t\\t\\t\\t</LevelList>\\r\\n\\t\\t\\t\\t<Product>*</Product>\\r\\n\\t\\t\\t</EventPattern>\\r\\n\\t\\t\\t<Description>Default group event rule.</Description>\\r\\n\\t\\t\\t<EventType>SYSTEM</EventType>\\r\\n\\t\\t\\t<State>ENABLED</State>\\r\\n\\t\\t\\t<Name>test_DefaultEventRule_7378****</Name>\\r\\n\\t\\t\\t<GroupId>7378****</GroupId>\\r\\n\\t\\t</EventRule>\\r\\n\\t\\t<EventRule>\\r\\n\\t\\t\\t<EventPattern>\\r\\n\\t\\t\\t\\t<NameList>\\r\\n\\t\\t\\t\\t\\t<NameList>*</NameList>\\r\\n\\t\\t\\t\\t</NameList>\\r\\n\\t\\t\\t\\t<LevelList>\\r\\n\\t\\t\\t\\t\\t<LevelList>CRITICAL</LevelList>\\r\\n\\t\\t\\t\\t\\t<LevelList>WARN</LevelList>\\r\\n\\t\\t\\t\\t</LevelList>\\r\\n\\t\\t\\t\\t<Product>*</Product>\\r\\n\\t\\t\\t</EventPattern>\\r\\n\\t\\t\\t<Description>Default group event rule.</Description>\\r\\n\\t\\t\\t<EventType>SYSTEM</EventType>\\r\\n\\t\\t\\t<State>ENABLED</State>\\r\\n\\t\\t\\t<Name>test123_DefaultEventRule_7301****</Name>\\r\\n\\t\\t\\t<GroupId>7301****</GroupId>\\r\\n\\t\\t</EventRule>\\r\\n\\t</EventRules>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeEventRuleListResponse>\\t","errorExample":""}]', - 'title' => 'DescribeEventRuleList', + 'title' => 'EnableMetricRules', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeEventRuleTargetList' => [ - 'summary' => 'Queries event-triggered alert rules.', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableMetricRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:EnableMetricRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FF38D33A-67C1-40EB-AB65-FAEE51EDB644\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'EnableSiteMonitors' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleName', + 'name' => 'TaskIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testRule', - ], + 'schema' => ['description' => 'The ID of the site monitoring task. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****,49f7b317-7645-4cc9-94fd-ea42e522****', 'title' => ''], ], ], 'responses' => [ @@ -32037,650 +22303,147 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '87170bc7-e28a-4c93-b9bf-90a1dbe84736', - ], - 'ContactParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactParameter' => [ - 'description' => 'The information about the recipients if alert notifications are sent to the alert contacts of an alert contact group.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ContactGroupName' => [ - 'description' => 'The name of the alert group.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Level' => [ - 'description' => 'The alert notification methods. Valid values:'."\n" - ."\n" - .'4: Alert notifications are sent by using DingTalk chatbots and emails.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], - ], - ], - 'FcParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'FCParameter' => [ - 'description' => 'The information about the recipients in Function Compute.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ServiceName' => [ - 'description' => 'The name of the Function Compute service.', - 'type' => 'string', - 'example' => 'service1', - ], - 'FunctionName' => [ - 'description' => 'The name of the function.', - 'type' => 'string', - 'example' => 'fcTest1', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the function. '."\n" - ."\n" - .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: '."\n" - ."\n" - .'- Service: the code of an Alibaba Cloud service'."\n" - .'- Region: the region ID'."\n" - .'- Account: the ID of an Alibaba Cloud account'."\n" - .'- ResourceType: the resource type'."\n" - .'- ResourceId: the resource ID', - 'type' => 'string', - 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.', - 'type' => 'string', - 'example' => '3', - ], - 'Region' => [ - 'description' => 'The region where Function Compute is deployed.', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - ], - ], - ], - ], - ], - 'MnsParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MnsParameter' => [ - 'description' => 'The notifications of Simple Message Queue (formerly MNS) (SMQ).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Queue' => [ - 'description' => 'The name of the SMQ queue.'."\n", - 'type' => 'string', - 'example' => 'testQueue', - ], - 'Arn' => [ - 'description' => 'The ARN of the MNS queue. '."\n" - ."\n" - .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: '."\n" - ."\n" - .'- Service: the code of an Alibaba Cloud service'."\n" - .'- Region: the region ID'."\n" - .'- Account: the ID of an Alibaba Cloud account'."\n" - .'- ResourceType: the resource type'."\n" - .'- ResourceId: the resource ID', - 'type' => 'string', - 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', - ], - 'Region' => [ - 'description' => 'The region for SMQ.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'Topic' => [ - 'description' => 'The SMQ topic.'."\n", - 'type' => 'string', - 'example' => 'topic_sample', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'WebhookParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'WebhookParameter' => [ - 'description' => 'The information about the recipients if alert notifications are sent by sending a request to a callback URL.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'description' => 'The callback URL.', - 'type' => 'string', - 'example' => 'http://www.aliyun.com', - ], - 'Method' => [ - 'description' => 'The HTTP request method. Valid values: GET and POST.', - 'type' => 'string', - 'example' => 'GET', - ], - 'Protocol' => [ - 'description' => 'The protocol type.', - 'type' => 'string', - 'example' => 'HTTP', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.', - 'type' => 'string', - 'example' => '5', - ], - ], - ], - ], - ], - ], - 'SlsParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SlsParameter' => [ - 'description' => 'The information about the recipients in Log Service.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Project' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'example' => 'project_test', - ], - 'LogStore' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'example' => 'logstore_test', - ], - 'Arn' => [ - 'description' => 'The ARN of the Log Service Logstore. '."\n" - ."\n" - .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: '."\n" - ."\n" - .'- Service: the code of an Alibaba Cloud service'."\n" - .'- Region: the region ID'."\n" - .'- Account: the ID of an Alibaba Cloud account'."\n" - .'- ResourceType: the resource type'."\n" - .'- ResourceId: the resource ID', - 'type' => 'string', - 'example' => 'acs:log:cn-hangzhou::project/cms-log-mo****/logstore/c***', - ], - 'Region' => [ - 'description' => 'The ID of the region where the Log Service project resides.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.', - 'type' => 'string', - 'example' => '4', - ], - ], - ], - ], - ], - ], - 'OpenApiParameters' => [ + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3fcd12e7-d387-42ee-b77e-661c775bb17f', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The number of detection points that are affected by the site monitoring tasks.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'OpenApiParameters' => [ - 'description' => 'The information about the recipients in OpenAPI Explorer.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Action' => [ - 'description' => 'The name of the API operation.', - 'type' => 'string', - 'example' => 'PutLogs', - ], - 'Arn' => [ - 'description' => 'The ARN of the API operation. '."\n" - ."\n" - .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields: '."\n" - ."\n" - .'- Service: the code of an Alibaba Cloud service'."\n" - .'- Region: the region ID'."\n" - .'- Account: the ID of an Alibaba Cloud account'."\n" - .'- ResourceType: the resource type'."\n" - .'- ResourceId: the resource ID The ARN of the Log Service Logstore. '."\n" - ."\n" - .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields:'."\n" - .'- Service: the code of an Alibaba Cloud service'."\n" - .'- Region: the region ID'."\n" - .'- Account: the ID of an Alibaba Cloud account'."\n" - .'- ResourceType: the resource type'."\n" - .'- ResourceId: the resource ID', - 'type' => 'string', - 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.', - 'type' => 'string', - 'example' => '3', - ], - 'Product' => [ - 'description' => 'The ID of the cloud service to which the API operation belongs.', - 'type' => 'string', - 'example' => 'log', - ], - 'Region' => [ - 'description' => 'The region where the resource resides.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Role' => [ - 'description' => 'The name of the role.', - 'type' => 'string', - 'example' => 'MyRole', - ], - 'Version' => [ - 'description' => 'The version of the API.', - 'type' => 'string', - 'example' => '2019-01-01', - ], - ], - ], - ], + 'count' => ['description' => 'The number of detection points.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], + ], + [ + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ['errorCode' => 'RestrictedUser', 'errorMessage' => 'The user\'s operation is restricted, please register NAAM product code.', 'description' => ''], + ['errorCode' => 'UnauthorizedTasks', 'errorMessage' => 'You are not permitted to operate the specified tasks.', 'description' => 'You are not permitted to operate the specified tasks.'], + ], + [ + ['errorCode' => 'TaskNotExist', 'errorMessage' => 'The specified task does not exist.', 'description' => 'The specified task does not exist.'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"87170bc7-e28a-4c93-b9bf-90a1dbe84736\\",\\n \\"ContactParameters\\": {\\n \\"ContactParameter\\": [\\n {\\n \\"ContactGroupName\\": \\"默认告警通知组\\",\\n \\"Level\\": \\"3\\",\\n \\"Id\\": \\"1\\"\\n }\\n ]\\n },\\n \\"FcParameters\\": {\\n \\"FCParameter\\": [\\n {\\n \\"ServiceName\\": \\"service1\\",\\n \\"FunctionName\\": \\"fcTest1\\",\\n \\"Arn\\": \\"acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***\\",\\n \\"Id\\": \\"3\\",\\n \\"Region\\": \\"cn-qingdao\\"\\n }\\n ]\\n },\\n \\"MnsParameters\\": {\\n \\"MnsParameter\\": [\\n {\\n \\"Queue\\": \\"testQueue\\",\\n \\"Arn\\": \\"acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Id\\": \\"2\\",\\n \\"Topic\\": \\"topic_sample\\"\\n }\\n ]\\n },\\n \\"WebhookParameters\\": {\\n \\"WebhookParameter\\": [\\n {\\n \\"Url\\": \\"http://www.aliyun.com\\",\\n \\"Method\\": \\"GET\\",\\n \\"Protocol\\": \\"HTTP\\",\\n \\"Id\\": \\"5\\"\\n }\\n ]\\n },\\n \\"SlsParameters\\": {\\n \\"SlsParameter\\": [\\n {\\n \\"Project\\": \\"project_test\\",\\n \\"LogStore\\": \\"logstore_test\\",\\n \\"Arn\\": \\"acs:log:cn-hangzhou::project/cms-log-mo****/logstore/c***\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Id\\": \\"4\\"\\n }\\n ]\\n },\\n \\"OpenApiParameters\\": {\\n \\"OpenApiParameters\\": [\\n {\\n \\"Action\\": \\"PutLogs\\",\\n \\"Arn\\": \\"acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***\\",\\n \\"Id\\": \\"3\\",\\n \\"Product\\": \\"log\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Role\\": \\"MyRole\\",\\n \\"Version\\": \\"2019-01-01\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeEventRuleTargetList>\\r\\n\\t\\t<RequestId>87170bc7-e28a-4c93-b9bf-90a1dbe84736</RequestId>\\r\\n\\t\\t<ContactParameters>\\r\\n\\t\\t\\t<ContactParameter>\\r\\n\\t\\t\\t\\t<ContactGroupName>默认告警通知组</ContactGroupName>\\r\\n\\t\\t\\t\\t<Level>3</Level>\\r\\n\\t\\t\\t\\t<Id>1</Id>\\r\\n\\t\\t\\t</ContactParameter>\\r\\n\\t\\t</ContactParameters>\\r\\n\\t\\t<SlsParameters>\\r\\n\\t\\t\\t<SlsParameter>\\r\\n\\t\\t\\t\\t<Project>project_test</Project>\\r\\n\\t\\t\\t\\t<LogStore>logstore_test</LogStore>\\r\\n\\t\\t\\t\\t<Region>cn-hangzhou</Region>\\r\\n\\t\\t\\t\\t<Arn>acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***</Arn>\\r\\n\\t\\t\\t\\t<Id>2</Id>\\r\\n\\t\\t\\t</SlsParameter>\\r\\n\\t\\t</SlsParameters>\\r\\n\\t\\t<Code>200</Code>\\r\\n</DescribeEventRuleTargetList>","errorExample":""}]', - 'title' => 'DescribeEventRuleTargetList', - 'description' => 'This topic provides an example to show how to query the details of an event-triggered alert rule named `testRule`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'EnableSiteMonitors', + 'summary' => 'Enables site monitoring tasks.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutEventRuleTargets' => [ - 'summary' => 'Adds or modifies the push channels of an event-triggered alert rule.', - 'methods' => [ - 'post', - 'get', - 'put', + 'changeSet' => [ + ['createdAt' => '2025-04-01T07:22:22.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-06-19T07:10:45.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSiteMonitors'], ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testEventRule', - ], - ], + 'ramActions' => [ [ - 'name' => 'FcParameters', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The information about the recipients in Function Compute.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'FunctionName' => [ - 'description' => 'The name of the function. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'fc-test', - ], - 'Region' => [ - 'description' => 'The region where Function Compute is deployed. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'ServiceName' => [ - 'description' => 'The name of the Function Compute service. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'fc-test', - ], - 'Id' => [ - 'description' => 'The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:EnableSiteMonitors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 5, - ], - ], - [ - 'name' => 'ContactParameters', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The information about the alert contact groups that receive alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'ContactGroupName' => [ - 'description' => 'The name of the alert contact group. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'Id' => [ - 'description' => 'The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], - 'Level' => [ - 'description' => 'The alert notification methods. Valid values of N: 1 to 5. Valid values:'."\n" - ."\n" - .'4: Alert notifications are sent by using DingTalk and emails.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 5, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3fcd12e7-d387-42ee-b77e-661c775bb17f\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 0\\n }\\n}","type":"json"}]', + ], + 'InstallMonitoringAgent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MnsParameters', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The notifications of Simple Message Queue (formerly MNS) (SMQ).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'description' => 'The region for SMQ. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'Queue' => [ - 'description' => 'The name of the SMQ queue. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'queue1', - ], - 'Id' => [ - 'description' => 'The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Topic' => [ - 'description' => 'The SMQ topic.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'topic_sample', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 5, - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'WebhookParameters', + 'name' => 'Force', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The information about the callback URLs that are used to receive alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Protocol' => [ - 'description' => 'The name of the protocol. Valid values of N: 1 to 5. Valid values:'."\n" - ."\n" - .'* http'."\n" - .'* telnet'."\n" - .'* ping'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http', - ], - 'Url' => [ - 'description' => 'The callback URL. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.aliyun.com', - ], - 'Method' => [ - 'description' => 'The HTTP request method. Valid values of N: 1 to 5.'."\n" - ."\n" - .'Valid values: GET and POST.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], - 'Id' => [ - 'description' => 'The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 5, - ], + 'schema' => ['description' => 'Specifies whether to forcibly install the CloudMonitor agent. Valid values:'."\n" + ."\n" + .'- true (default): Forcibly installs the agent.'."\n" + ."\n" + .'- false: Does not forcibly install the agent.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => 'true', 'title' => ''], ], [ - 'name' => 'SlsParameters', + 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The information about the recipients in Simple Log Service.'."\n", + 'description' => 'The IDs of the Alibaba Cloud hosts.'."\n" + ."\n" + .'You can specify from 1 to 10 instance IDs.'."\n" + ."\n" + .'> You must specify either `InstallCommand` or `InstanceIds`.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'LogStore' => [ - 'description' => 'The name of the Simple Log Service Logstore. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testlogstore', - ], - 'Region' => [ - 'description' => 'The region where Simple Log Service is deployed. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'Project' => [ - 'description' => 'The name of the Simple Log Service project. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testproject', - ], - 'Id' => [ - 'description' => 'The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5', - ], - ], - 'required' => false, - ], + 'items' => ['description' => 'The ID of the Alibaba Cloud host.'."\n" + ."\n" + .'You can specify from 1 to 10 instance IDs.'."\n" + ."\n" + .'> You must specify either `InstallCommand` or `InstanceIds`.', 'type' => 'string', 'required' => false, 'example' => 'i-m5e0k0bexac8tykr****', 'title' => ''], 'required' => false, - 'maxItems' => 5, + 'example' => 'i-m5e0k0bexac8tykr****', + 'maxItems' => 10, + 'title' => '', ], ], [ - 'name' => 'OpenApiParameters', + 'name' => 'InstallCommand', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The parameters of API callback notification.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Action' => [ - 'description' => 'The API name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PutLogs', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Valid values of N: 1 to 5. Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields:'."\n" - ."\n" - .'* Service: the code of a cloud service'."\n" - .'* Region: the region ID'."\n" - .'* Account: the ID of an Alibaba Cloud account'."\n" - .'* ResourceType: the resource type'."\n" - .'* ResourceId: the resource ID'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', - ], - 'Id' => [ - 'description' => 'The ID of the recipient that receives alert notifications sent by an API callback.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - 'Product' => [ - 'description' => 'The ID of the cloud service to which the API operation belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'log', - ], - 'Region' => [ - 'description' => 'The region where the resource resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'Role' => [ - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MyRole', - ], - 'Version' => [ - 'description' => 'The version of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-01-01', - ], - 'JsonParams' => [ - 'description' => 'The parameters of the alert callback. Specify the parameters in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"customField1":"value1","customField2":"$.name"}', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 5, - ], + 'schema' => ['description' => 'The installation command. This command installs the CloudMonitor agent on all Alibaba Cloud hosts that belong to your Alibaba Cloud account. Valid values:'."\n" + ."\n" + .'- `onlyInstallNotHasAgent`: Installs the latest version of the CloudMonitor agent only on Alibaba Cloud hosts where the agent is not installed.'."\n" + ."\n" + .'- `onlyUpgradeAgent`: Upgrades the CloudMonitor agent only on Alibaba Cloud hosts where an earlier version of the agent is installed.'."\n" + ."\n" + .'- `installAndUpgrade`: Installs the latest version of the CloudMonitor agent on Alibaba Cloud hosts where the agent is not installed, and upgrades the agent on Alibaba Cloud hosts where an earlier version of the agent is installed.'."\n" + ."\n" + .'> If you set this parameter, the `InstanceIds` parameter is invalid.', 'type' => 'string', 'required' => false, 'example' => 'onlyInstallNotHasAgent', 'title' => ''], ], ], 'responses' => [ @@ -32688,1854 +22451,1609 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '409C64DA-CF14-45DF-B463-471C790DD15A', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FailedParameterCount' => [ - 'description' => 'The number of resources that failed to be created or modified.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'FailedContactParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactParameter' => [ - 'description' => 'This parameter is returned if the specified alert contact groups in the request failed to be created or modified.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'ContactGroupName' => [ - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Level' => [ - 'description' => 'The alert notification methods. Valid values:'."\n" - ."\n" - .'4: Alert notifications are sent by using DingTalk and emails.'."\n", - 'type' => 'string', - 'example' => '3', - ], - ], - ], - ], - ], - ], - 'FailedMnsParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MnsParameter' => [ - 'description' => 'This parameter is returned if the specified queues in the request failed to be created or modified in SMQ.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Queue' => [ - 'description' => 'The name of the MNS queue.'."\n", - 'type' => 'string', - 'example' => 'testQueue', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Region' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], - ], - ], - 'FailedFcParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'FcParameter' => [ - 'description' => 'This parameter is returned if the specified functions in the request failed to be created or modified in Function Compute.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ServiceName' => [ - 'description' => 'The name of the Function Compute service.'."\n", - 'type' => 'string', - 'example' => 'serviceTest1', - ], - 'FunctionName' => [ - 'description' => 'The name of the function.'."\n", - 'type' => 'string', - 'example' => 'functionTest1', - ], - 'Id' => [ - 'description' => 'The ID of the recipient.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Region' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0BDAF8A8-04DC-5F0C-90E4-724D42C41945', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"409C64DA-CF14-45DF-B463-471C790DD15A\\",\\n \\"Success\\": true,\\n \\"FailedParameterCount\\": \\"2\\",\\n \\"FailedContactParameters\\": {\\n \\"ContactParameter\\": [\\n {\\n \\"ContactGroupName\\": \\"默认报警联系人组\\",\\n \\"Id\\": 2,\\n \\"Level\\": \\"4\\"\\n }\\n ]\\n },\\n \\"FailedMnsParameters\\": {\\n \\"MnsParameter\\": [\\n {\\n \\"Queue\\": \\"testQueue\\",\\n \\"Id\\": 2,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"FailedFcParameters\\": {\\n \\"FcParameter\\": [\\n {\\n \\"ServiceName\\": \\"serviceTest1\\",\\n \\"FunctionName\\": \\"functionTest1\\",\\n \\"Id\\": 1,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomMetric>\\n\\t\\t<RequestId>681CC49A-DD28-4D11-B86F-19D3F71E0EAE</RequestId>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</DeleteCustomMetric>","errorExample":""}]', - 'title' => 'PutEventRuleTargets', - 'requestParamsDescription' => ' ', + 'title' => 'InstallMonitoringAgent', + 'summary' => 'Call the InstallMonitoringAgent operation to install the CloudMonitor agent on specified Alibaba Cloud hosts.', + 'description' => '## Prerequisites'."\n" + ."\n" + .'Ensure that Cloud Assistant is installed on the Alibaba Cloud host. For more information, see [Cloud Assistant overview](~~64601~~).'."\n" + ."\n" + .'## Background information'."\n" + ."\n" + .'This API applies only to Alibaba Cloud hosts, which are Elastic Compute Service (ECS) instances. The success rate for installing the CloudMonitor agent using this API is approximately 95%. If the installation fails, you must manually install the agent. For more information about how to install the CloudMonitor agent, see [Install and uninstall the C++ agent](~~183482~~).'."\n" + ."\n" + .'## Example'."\n" + ."\n" + .'This example shows how to forcibly install the latest version of the CloudMonitor agent on the ECS instance `i-m5e0k0bexac8tykr****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutEventRule' => [ - 'summary' => '创建或者修改事件监控', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-12-27T07:31:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-11-16T08:56:27.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallMonitoringAgent'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:InstallMonitoringAgent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"0BDAF8A8-04DC-5F0C-90E4-724D42C41945\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ModifyGroupMonitoringAgentProcess' => [ + 'summary' => 'Modifies process monitoring in an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RuleName', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'myRuleName', - ], + 'schema' => ['description' => 'The ID of the process monitoring task in the application group.', 'type' => 'string', 'required' => true, 'example' => '92E3065F-0980-4E31-9AA0-BA6****', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group to which the event-triggered alert rule belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7378****', - ], - ], - [ - 'name' => 'EventType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the event-triggered alert rule. Valid values:'."\n" - ."\n" - .'* SYSTEM: system event-triggered alert rule'."\n" - .'* CUSTOM: custom event-triggered alert rule'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SYSTEM', - 'default' => 'SYSTEM', - 'enum' => [ - 'SYSTEM', - 'CUSTOM', - ], - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'example' => '6780****', 'title' => ''], ], [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the event-triggered alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'State', + 'name' => 'MatchExpressFilterRelation', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the event-triggered alert rule. Valid values:'."\n" - ."\n" - .'* ENABLED: enabled'."\n" - .'* DISABLED: disabled'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ENABLED', - 'default' => 'ENABLED', - 'enum' => [ - 'ENABLED', - 'DISABLED', - ], - ], + 'schema' => ['description' => 'This parameter is deprecated and does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'and', 'title' => ''], ], [ - 'name' => 'EventPattern', + 'name' => 'AlertConfig', 'in' => 'query', - 'style' => 'repeatList', + 'style' => 'flat', 'schema' => [ - 'description' => '', + 'description' => 'The alert rule configurations.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'EventTypeList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the event-triggered alert rule. Valid values of N: 1 to 50. Valid values:'."\n" - ."\n" - .'* StatusNotification: fault notifications'."\n" - .'* Exception: exceptions'."\n" - .'* Maintenance: O\\&M'."\n" - .'* \\*: all types'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Exception', - ], - 'required' => false, - 'example' => 'Exception', - 'maxItems' => 5, - ], - 'StatusList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The status of the event-triggered alert rule. Valid values of N: 1 to 50.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Failed', - ], - 'required' => false, - 'example' => 'Failed', - 'maxItems' => 5, - ], - 'Product' => [ - 'description' => 'The type of the cloud service. Valid values of N: 1 to 50.'."\n" - ."\n" - .'> You can call the DescribeSystemEventMetaList operation to query the cloud services that support event-triggered alerts. For more information, see [DescribeSystemEventMetaList](~~114972~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], - 'LevelList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'The level of the event-triggered alert rule. Valid values of N: 1 to 50. Valid values:'."\n" - ."\n" - .'* CRITICAL: critical'."\n" - .'* WARN: warning'."\n" - .'* INFO: information'."\n" - .'* \\*: all levels'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CRITICAL', - ], - 'required' => false, - 'example' => 'CRITICAL', - 'maxItems' => 5, - ], - 'NameList' => [ - 'description' => '', + 'SilenceTime' => ['description' => 'The mute for epoch. Valid values of N: 1 to 200.'."\n" + ."\n" + .'Unit: seconds. Minimum value: 3600 (1 hour). Default value: 86400 (1 day).'."\n" + .'> When monitoring data continuously exceeds the alert rule threshold, only one alert notification is sent within each mute for epoch.', 'type' => 'string', 'required' => false, 'example' => '86400', 'title' => ''], + 'ComparisonOperator' => ['description' => 'The comparison operator for the Critical-level threshold. Valid values of N: 1 to 200. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to'."\n" + .'- GreaterThanThreshold: greater than'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to'."\n" + .'- LessThanThreshold: less than'."\n" + .'- NotEqualToThreshold: not equal to'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week'."\n" + .'- LessThanLastWeek: less than the value at the same time last week'."\n" + .'- GreaterThanLastPeriod: greater than the value in the previous period'."\n" + .'- LessThanLastPeriod: less than the value in the previous period', 'type' => 'string', 'required' => true, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL to which a POST request is sent when an alert is triggered. Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com', 'title' => ''], + 'Times' => ['description' => 'The number of consecutive occurrences of the alert level. Valid values of N: 1 to 200. Default value: 3.'."\n" + ."\n" + .'> An alert is triggered only when the alert level consecutively occurs the specified number of times and the alert threshold is reached.', 'type' => 'string', 'required' => true, 'example' => '3', 'title' => ''], + 'EscalationsLevel' => ['description' => 'The alert level. Valid values of N: 1 to 200. Valid values:'."\n" + .'- critical (default): critical.'."\n" + .'- warn: warning.'."\n" + .'- info: information.', 'type' => 'string', 'required' => true, 'example' => 'warn', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The effective period of the alert rule. Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => '00:00-22:59', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'This parameter is deprecated and does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => '00:00-05:30', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold. Valid values of N: 1 to 200.', 'type' => 'string', 'required' => true, 'example' => '5', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method for alerts. Valid values of N: 1 to 200.'."\n" + ."\n" + .'> Only Average is supported.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'TargetList' => [ + 'description' => 'None.', 'type' => 'array', 'items' => [ - 'description' => 'The name of the event-triggered alert rule. Valid values of N: 1 to 50.'."\n", - 'type' => 'string', + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the alert trigger target.'."\n" + ."\n" + .'For information about how to obtain the ID of the alert trigger target, see [DescribeMetricRuleTargets](~~121592~~).', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.'."\n" + ."\n" + .'For information about how to obtain the resource ARN, see [DescribeMetricRuleTargets](~~121592~~).'."\n" + ."\n" + .'The ARN is in the format of `acs:{ServiceAbbreviation}:{regionId}:{userId}:/{ResourceType}/{ResourceName}/message`. Example: `acs:mns:ap-southeast-1:120886317861****:/queues/test123/message`. The parameters are described as follows:'."\n" + ."\n" + .'- {ServiceAbbreviation}: Only Simple Message Queue (formerly MNS) is supported.'."\n" + ."\n" + .'- {userId}: The Alibaba Cloud account ID.'."\n" + ."\n" + .'- {regionId}: The region where the Simple Message Queue (formerly MNS) queue or topic resides.'."\n" + ."\n" + .'- {ResourceType}: The type of the resource that accepts alerts. Valid values:'."\n" + ."\n" + .' - **queues**: queue.'."\n" + .' - **topics**: topic.'."\n" + ."\n" + .'- {ResourceName}: The resource name.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'required' => false, 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: information.'."\n" + .'- WARN: warning.'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'required' => false, 'example' => '["INFO", "WARN", "CRITICAL"]', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters of the alert callback.', 'type' => 'string', 'required' => false, 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], + ], 'required' => false, - 'example' => 'Agent_Status_Stopped', + 'title' => '', + 'example' => '', ], 'required' => false, - 'example' => 'Agent_Status_Stopped', - 'maxItems' => 20, - ], - 'CustomFilters' => [ - 'description' => 'The keyword that is used to filter events. If the content of an event contains the specified keyword, an alert is automatically triggered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Stopping', - ], - 'SQLFilter' => [ - 'description' => 'The SQL condition that is used to filter events. If the content of an event meets the specified SQL condition, an alert is automatically triggered.'."\n" - ."\n" - .'> The syntax of SQL event filtering is consistent with the query syntax of Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX and Executed', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, - 'maxItems' => 50, - ], - ], - [ - 'name' => 'SilenceTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '86400', + 'maxItems' => 3, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'Data' => [ - 'description' => 'The number of event-triggered alert rules that were created or modified.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0B47C47B-E68A-4429-BB23-370E91889C7D', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"Data\\": \\"1\\",\\n \\"RequestId\\": \\"0B47C47B-E68A-4429-BB23-370E91889C7D\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutEventRuleResponse>\\n\\t\\t<RequestId>0B47C47B-E68A-4429-BB23-370E91889C7D</RequestId>\\n\\t\\t<Data>1</Data>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</PutEventRuleResponse>","errorExample":""}]', - 'title' => 'PutEventRule', - 'description' => 'If the specified rule name does not exist, an event-triggered alert rule is created. If the specified rule name exists, the specified event-triggered alert rule is modified.'."\n" - ."\n" - .'In this example, the `myRuleName` alert rule is created for the `ecs` cloud service.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'title' => 'Modify process monitoring in an application group', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PutCustomEventRule' => [ - 'methods' => [ - 'post', - 'get', - 'put', + 'changeSet' => [ + ['createdAt' => '2022-08-05T04:05:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyGroupMonitoringAgentProcess'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyGroupMonitoringAgentProcess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MonitoringAgentProcess', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"7985D471-3FA8-4EE9-8F4B-45C19DF3D36F\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ModifyHostAvailability' => [ + 'summary' => 'Modifies an availability monitoring task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group. For more information about how to obtain the group ID, see [DescribeCustomEventAttribute](~~115262~~).'."\n" - ."\n" - .'> The value 0 indicates that the reported custom event does not belong to any application Group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7378****', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'RuleId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'> You can specify an existing ID to modify the corresponding alert rule or specify a new ID to create an alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CustomRuleId1', - ], + 'schema' => ['description' => 'The ID of the availability monitoring task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'RuleName', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CustomeRule', - ], + 'schema' => ['description' => 'The name of the availability monitoring task.', 'type' => 'string', 'required' => true, 'example' => 'task2', 'title' => ''], ], [ - 'name' => 'EventName', + 'name' => 'TaskScope', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the custom event. For more information about how to obtain the event name, see [DescribeCustomEventAttribute](~~115262~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'HostDown', - ], + 'schema' => ['description' => 'The detection scope of the availability monitoring task. Valid values:'."\n" + ."\n" + .'- GROUP: All ECS instances in the current application group are used as probes for the detection task.'."\n" + .'- GROUP_SPEC_INSTANCE: Specified ECS instances in the current application group are used as probes for the detection task. If you set this parameter to this value, you must also set InstanceList to specify the ECS instances that initiate detection.', 'type' => 'string', 'required' => false, 'default' => 'GROUP', 'example' => 'GROUP', 'title' => ''], ], [ - 'name' => 'ContactGroups', + 'name' => 'TaskOption.HttpURI', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert contact group that receives alert notifications. Separate multiple contact groups with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Group', - ], + 'schema' => ['description' => 'The URI for HTTP or Telnet detection types.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com'."\n" + .'telnet://127.0.0.1:80', 'title' => ''], ], [ - 'name' => 'Webhook', + 'name' => 'TaskOption.TelnetOrPingHost', 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.aliyun.com', - ], + 'schema' => ['description' => 'The domain name or address to detect.'."\n" + ."\n" + .'> If the detection task type is PING, you must set this parameter. For more information about how to set the detection task type, see [CreateHostAvailability](~~115317~~).', 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com', 'title' => ''], ], [ - 'name' => 'EffectiveInterval', + 'name' => 'TaskOption.HttpResponseCharset', 'in' => 'query', - 'schema' => [ - 'description' => 'The time period during which the alert rule is effective. Valid values: 00:00 to 23:59.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00-23:59', - ], + 'schema' => ['description' => 'The response character set for the HTTP detection type.'."\n" + ."\n" + .'> Only UTF-8 is supported.', 'type' => 'string', 'required' => false, 'example' => 'UTF-8', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'TaskOption.HttpPostContent', 'in' => 'query', - 'schema' => [ - 'description' => 'The cycle that is used to aggregate monitoring data of the custom event. Unit: seconds. Set the value to an integral multiple of 60. Default value: 300.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - 'default' => '300', - ], + 'schema' => ['description' => 'The POST content of the HTTP detection request.', 'type' => 'string', 'required' => false, 'example' => 'params1=value1', 'title' => ''], ], [ - 'name' => 'EmailSubject', + 'name' => 'TaskOption.HttpResponseMatchContent', 'in' => 'query', - 'schema' => [ - 'description' => 'The subject of the alert notification email.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The content to match in the HTTP detection response.', 'type' => 'string', 'required' => false, 'example' => 'ok', 'title' => ''], ], [ - 'name' => 'Threshold', + 'name' => 'TaskOption.HttpMethod', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert threshold.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '99', - ], + 'schema' => ['description' => 'The method for the detection type. Valid values:'."\n" + ."\n" + .'- GET'."\n" + .'- POST'."\n" + .'- HEAD'."\n" + ."\n" + .'> If the detection task type is HTTP, you must set this parameter. For more information about how to set the detection task type, see [CreateHostAvailability](~~115317~~).', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], ], [ - 'name' => 'Level', - 'in' => 'query', - 'schema' => [ - 'description' => 'The level of the alert. Valid values:'."\n" - ."\n" - .'* CRITICAL: critical issue'."\n" - .'* WARN: warning'."\n" - .'* INFO: information'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CRITICAL', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The value 200 indicates that the call was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The request has failed due to a temporary failure of the server.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'AD5DCD82-BD1C-405F-BAED-32302DE9F498', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - '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' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"RequestId\\": \\"AD5DCD82-BD1C-405F-BAED-32302DE9F498\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutCustomEventRuleResponse>\\n\\t<RequestId>AD5DCD82-BD1C-405F-BAED-32302DE9F498</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</PutCustomEventRuleResponse>","errorExample":""}]', - 'title' => 'PutCustomEventRule', - 'description' => 'Before you call this operation, call the PutCustomEvent operation to report the monitoring data of the custom event. For more information, see [PutCustomEvent](~~115012~~).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateMetricRuleBlackList' => [ - 'summary' => 'Creates a blacklist policy.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'Name', + 'name' => 'TaskOption.HttpNegative', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the blacklist policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Blacklist-01', - ], + 'schema' => ['description' => 'The alert rule for matching HTTP response content. Valid values:'."\n" + .'- true: An alert is triggered if the HTTP response content contains the specified alert rule.'."\n" + .'- false: An alert is triggered if the HTTP response content does not contain the specified alert rule.'."\n" + ."\n" + .'> If the detection task type is HTTP, you must set this parameter. For more information about how to set the detection task type, see [CreateHostAvailability](~~115317~~).', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'TaskOption.HttpHeader', 'in' => 'query', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of different cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], + 'schema' => ['description' => 'The header of the HTTP request. The format is `Parameter:Value`. Separate multiple parameters with carriage returns. Example:'."\n" + .'```'."\n" + .'params1:value1'."\n" + .'params2:value2'."\n" + .'```', 'type' => 'string', 'required' => false, 'example' => 'params1:value1', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'TaskOption.Interval', 'in' => 'query', - 'schema' => [ - 'description' => 'The category of the cloud service. For example, ApsaraDB for Redis includes the following categories: ApsaraDB for Redis (standard architecture), ApsaraDB for Redis (cluster architecture), and ApsaraDB for Redis (read/write splitting architecture). In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The detection frequency. Unit: seconds. Valid values: 15, 30, 60, 120, 300, 900, 1800, and 3600.'."\n" + ."\n" + .'> Only CloudMonitor agent 3.5.1 or later supports this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], ], [ - 'name' => 'ScopeType', + 'name' => 'AlertConfig.NotifyType', 'in' => 'query', - 'schema' => [ - 'description' => 'The effective scope of the blacklist policy. Valid values:'."\n" - ."\n" - .'* USER (default): The blacklist policy takes effect only for the current Alibaba Cloud account.'."\n" - .'* GROUP: The blacklist policy takes effect only for the specified application group. For information about how to query the IDs of application groups, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'USER', - ], + 'schema' => ['description' => 'The alert notification type. Valid values:'."\n" + ."\n" + .'<props="china">- 2: Phone call + text message + email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- 1: Text message + email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="china">- 0: Email + DingTalk chatbot.</props>'."\n" + ."\n\n" + .'<props="intl">0: Email + DingTalk chatbot.</props>'."\n" + ."\n" + .'<props="partner">0: Email + DingTalk chatbot.</props>', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'ScopeValue', + 'name' => 'AlertConfig.StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group. The value of this parameter is a JSON array.'."\n" - ."\n" - .'> This parameter must be specified when `ScopeType` is set to `GROUP`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["67****","78****"]', - ], + 'schema' => ['description' => 'The start time when the alert takes effect. Valid values: 0 to 23.'."\n" + ."\n" + .'For example, if AlertConfig.StartTime is set to 0 and AlertConfig.EndTime is set to 22, the alert is effective from 00:00:00 to 22:00:00.'."\n" + ."\n" + .'> If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'EnableStartTime', + 'name' => 'AlertConfig.EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the blacklist policy starts to take effect.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1640237400000', - ], + 'schema' => ['description' => 'The end time when the alert takes effect. Valid values: 0 to 23.'."\n" + ."\n" + .'For example, if AlertConfig.StartTime is set to 0 and AlertConfig.EndTime is set to 22, the alert is effective from 00:00:00 to 22:00:00.'."\n" + ."\n" + .'> If the alert is not within the effective period, no alert notification is sent even if the threshold is exceeded.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22', 'title' => ''], ], [ - 'name' => 'EnableEndTime', + 'name' => 'AlertConfig.SilenceTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the blacklist policy expires.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1640608200000', - ], + 'schema' => ['description' => 'The mute period. Unit: seconds. Default value: 86400 (1 day).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'title' => ''], ], [ - 'name' => 'EffectiveTime', + 'name' => 'AlertConfig.WebHook', 'in' => 'query', - 'schema' => [ - 'description' => 'The time range within which the blacklist policy is effective.'."\n" - ."\n" - .'* If you do not configure this parameter, the blacklist policy is permanently effective.'."\n" - ."\n" - .'* If you configure this parameter, the blacklist policy is effective only within the specified time range. Examples:'."\n" - ."\n" - .' * `03:00-04:59`: The blacklist policy is effective from 03:00 to 05:00 local time. 05:00 local time is excluded.'."\n" - .' * `03:00-04:59 UTC+0700`: The blacklist policy is effective from 03:00 to 05:00 (UTC+7). 05:00 (UTC+7) is excluded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '03:00-04:59', - ], + 'schema' => ['description' => 'The webhook address.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com/webhook.json', 'title' => ''], ], [ - 'name' => 'Instances', + 'name' => 'AlertConfigEscalationList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the instances that belong to the specified cloud service.'."\n", + 'description' => 'The alert configuration list.', 'type' => 'array', 'items' => [ - 'description' => 'The IDs of the instances that belong to the specified cloud service.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n", - 'type' => 'string', + 'description' => 'The alert configuration list.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric for the alert. Valid values of N: 1 to 21. Valid values:'."\n" + ."\n" + .'- HttpStatus: HTTP status code.'."\n" + .'- HttpLatency: HTTP latency.'."\n" + .'- TelnetStatus: Telnet status code.'."\n" + .'- TelnetLatency: Telnet latency.'."\n" + .'- PingLostRate: PING packet loss rate.', 'type' => 'string', 'required' => true, 'example' => 'HttpStatus', 'title' => ''], + 'Value' => ['description' => 'The alert threshold. Valid values of N: 1 to 21.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'Times' => ['description' => 'The number of alert retries. Valid values of N: 1 to 21.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Operator' => ['description' => 'The comparison operator for the alert rule. Valid values of N: 1 to 21. Valid values:'."\n" + ."\n" + .'- `>`'."\n" + .'- `>=`'."\n" + .'- `<`'."\n" + .'- `<=`'."\n" + .'- `=`', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + 'Aggregate' => ['description' => 'The statistical method for the alert. Valid values of N: 1 to 21. The valid values vary based on the metric:'."\n" + ."\n" + .'- HttpStatus: Value.'."\n" + .'- HttpLatency: Average.'."\n" + .'- TelnetStatus: Value.'."\n" + .'- TelnetLatency: Average.'."\n" + .'- PingLostRate: Average.'."\n" + ."\n" + .'> The statistical method for status code metrics is the original value (Value). The statistical method for latency or packet loss rate metrics is the average value (Average).', 'type' => 'string', 'required' => false, 'example' => 'Value', 'title' => ''], + ], 'required' => false, - 'example' => '{"instancceId":"i-bp1ew0zfkjblsuwx****"}', + 'title' => '', + 'example' => '', ], 'required' => true, - 'maxItems' => 100, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Metrics', + 'name' => 'InstanceList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The metrics of the instance.'."\n" + 'description' => 'The list of ECS instances that initiate detection. Valid values of N: 1 to 21.'."\n" ."\n" - .'* If you do not configure this parameter, the blacklist policy applies to all metrics of the specified cloud service.'."\n" - .'* If you configure this parameter, the blacklist policy applies only to the current metric.'."\n", + .'> If `TaskScope` is set to `GROUP_SPEC_INSTANCE`, you must set this parameter.', + 'type' => 'array', + 'items' => ['description' => 'The list of ECS instances that initiate detection. Valid values of N: 1 to 21.'."\n" + ."\n" + .'> If `TaskScope` is set to `GROUP_SPEC_INSTANCE`, you must set this parameter.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'required' => false, + 'example' => 'i-absdfkwl321****', + 'maxItems' => 1000, + 'title' => '', + ], + ], + [ + 'name' => 'AlertConfigTargetList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The alert trigger targets.', 'type' => 'array', 'items' => [ - 'description' => 'None'."\n", + 'description' => 'The alert trigger targets.', 'type' => 'object', 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'disk_utilization', - ], - 'Resource' => [ - 'description' => 'The extended dimension of the instance. For example, `{"device":"C:"}` specifies that the blacklist policy is applied to all C disks of the specified Elastic Compute Service (ECS) instance.'."\n" - ."\n" - .'Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"device":"C:"}', - ], + 'Id' => ['description' => 'The ID of the alert trigger target.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource.'."\n" + ."\n" + .'The format is `acs:{AbbreviatedCloudServiceName}:{regionId}:{userId}:/{ResourceType}/{ResourceName}/message`. Example: `acs:mns:ap-southeast-1:120886317861****:/queues/test123/message`. The following list describes the parameters:'."\n" + ."\n" + .'- {AbbreviatedCloudServiceName}: Only Simple Message Queue (formerly MNS) is supported.'."\n" + ."\n" + .'- {userId}: The Alibaba Cloud account ID.'."\n" + ."\n" + .'- {regionId}: The region where the Simple Message Queue (formerly MNS) queue or topic resides.'."\n" + ."\n" + .'- {ResourceType}: The type of the resource that accepts alerts. Valid values:'."\n" + ."\n" + .' - **queues**: queue.'."\n" + .' - **topics**: topic.'."\n" + ."\n" + .'- {ResourceName}: The name of the resource.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'required' => false, 'example' => 'acs:mns:cn-hangzhou:111:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: information.'."\n" + .'- WARN: warning.'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'required' => false, 'example' => '["INFO", "WARN", "CRITICAL"]', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters for the alert callback.', 'type' => 'string', 'required' => false, 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The request has failed due to a temporary failure of the server.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5C637FA3-3959-3352-8BE6-78CE2ED2D33D', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'The ID of the blacklist policy.'."\n", - 'type' => 'string', - 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '16E815A3-47E1-4290-87F9-D5C99471FF45', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"RequestId\\": \\"5C637FA3-3959-3352-8BE6-78CE2ED2D33D\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"93514c96-ceb8-47d8-8ee3-93b6d98b****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateMetricRuleBlackListResponse>\\n <RequestId>5C637FA3-3959-3352-8BE6-78CE2ED2D33D</RequestId>\\n <Id>93514c96-ceb8-47d8-8ee3-93b6d98b****</Id>\\n <Success>true</Success>\\n</CreateMetricRuleBlackListResponse>","errorExample":""}]', - 'title' => 'CreateMetricRuleBlackList', - 'description' => '### Background information'."\n" - ."\n" - .'* CloudMonitor blocks alert notifications based on the blacklist policies that take effect. To block alert notifications when the value of a metric that belongs to a cloud service reaches the threshold that you specified, add the metric to a blacklist policy.'."\n" - .'* CloudMonitor allows you to create blacklist policies only based on threshold metrics. You cannot create blacklist policies based on system events. For more information about the cloud services and the thresholds of the metrics that are supported by CloudMonitor, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'ModifyMetricRuleBlackList' => [ - 'summary' => 'Modifies a blacklist policy.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Modify an availability monitoring task', + 'description' => 'This topic provides an example on how to change the name of availability monitoring task `12345` in application group `123456` to `task2`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-05T04:05:02.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHostAvailability'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyHostAvailability', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"16E815A3-47E1-4290-87F9-D5C99471FF45\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ModifyHostInfo' => [ + 'summary' => 'Calls the ModifyHostInfo operation to modify the display information of a non-Alibaba Cloud host.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the blacklist policy.'."\n" - ."\n" - .'For information about how to obtain the ID of a blacklist policy, see [DescribeMetricRuleBlackList](~~457257~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', - ], + 'schema' => ['description' => 'The instance ID. Only non-Alibaba Cloud hosts are supported.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'host-R_NSWNV****', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'HostName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the blacklist policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Blacklist-02', - ], + 'schema' => ['description' => 'The host name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'portalHost', 'title' => ''], ], - [ - 'name' => 'Namespace', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates that the call was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EBB5215C-44AB-4000-A2D7-48634FDC4F04', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. The value true indicates that the call was successful. The value false indicates that the call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Category', - 'in' => 'query', - 'schema' => [ - 'description' => 'The category of the cloud service. For example, ApsaraDB for Redis supports the standard architecture, the cluster architecture, and the read/write splitting architecture. In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], - [ - 'name' => 'ScopeType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The effective scope of the blacklist policy. Valid values:'."\n" - ."\n" - .'* USER: The blacklist policy takes effect only within the current Alibaba Cloud account.'."\n" - .'* GROUP (default): The blacklist policy takes effect only within the specified application group. For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'USER', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - 'name' => 'ScopeValue', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the application groups.'."\n" - ."\n" - .'> This parameter is required only when `ScopeType` is set to `GROUP`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["67****","78****"]', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - [ - 'name' => 'EnableStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the blacklist policy starts to take effect.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1640237400000', + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Modify the display information of a non-Alibaba Cloud host', + 'description' => '****', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHostInfo'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyHostInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"EBB5215C-44AB-4000-A2D7-48634FDC4F04\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ModifyHybridMonitorNamespace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EnableEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the blacklist policy expires.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1640608200000', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'EffectiveTime', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The time range within which the blacklist policy is effective. Take note of the following information:'."\n" - ."\n" - .'* If you do not configure this parameter, the blacklist policy is permanently effective.'."\n" - ."\n" - .'* If you configure this parameter, the blacklist policy is effective only within the specified time range. Examples:'."\n" - ."\n" - .' * `03:00-04:59`: The blacklist policy is effective from 03:00 to 05:00 local time. 05:00 local time is excluded.'."\n" - .' * `03:00-04:59 UTC+0700`: The blacklist policy is effective from 03:00 to 05:00 (UTC+7). 05:00 (UTC+7) is excluded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '03:00-04:59', - ], + 'schema' => ['description' => 'The name of the metric store.'."\n" + ."\n" + .'Format: consists of uppercase letters, lowercase letters, digits, and hyphens (-).'."\n" + ."\n" + .'For information about how to obtain the name of a metric store, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => true, 'example' => 'aliyun', 'title' => ''], ], [ - 'name' => 'Instances', + 'name' => 'Description', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the instances that belong to the specified cloud service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the instances that belong to the specified cloud service.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"instancceId":"i-bp1ew0zfkjblsuwx****"}', - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The description of the metric store.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Alibaba Cloud product metric repository.', 'title' => ''], ], [ - 'name' => 'Metrics', + 'name' => 'Spec', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The metrics of the instance.'."\n" + 'description' => 'The data storage duration. Valid values:'."\n" ."\n" - .'* If you do not configure this parameter, the blacklist policy applies to all metrics of the specified cloud service.'."\n" - .'* If you configure this parameter, the blacklist policy applies only to the current metric.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The name of the metric.'."\n" - ."\n" - .'Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'disk_utilization', - ], - 'Resource' => [ - 'description' => 'The extended dimension of the instance. For example, `{"device":"C:"}` specifies that the blacklist policy is applied to all C disks of the specified Elastic Compute Service (ECS) instance.'."\n" - ."\n" - .'Valid values of N: 1 to 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"device":"C:"}', - ], - ], - 'required' => false, - ], + .'- cms.s1.large: 15 days.'."\n" + .'- cms.s1.xlarge: 32 days.'."\n" + .'- cms.s1.2xlarge: 63 days.'."\n" + .'- cms.s1.3xlarge: 93 days.'."\n" + .'- cms.s1.6xlarge: 185 days.'."\n" + .'- cms.s1.12xlarge: 376 days.'."\n" + ."\n" + .'For the prices of different storage duration specifications, see the **Pricing** section in [Dashboard](~~223532~~).', + 'enumValueTitles' => ['cms.s1.12xlarge' => 'cms.s1.12xlarge', 'cms.s1.large' => 'cms.s1.large', 'cms.s1.2xlarge' => 'cms.s1.2xlarge', 'cms.s1.6xlarge' => 'cms.s1.6xlarge', 'cms.s1.3xlarge' => 'cms.s1.3xlarge'], + 'type' => 'string', 'required' => false, - 'maxItems' => 100, + 'docRequired' => false, + 'enum' => [], + 'example' => 'cms.s1.2xlarge', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The error code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '008773AE-1D86-3231-90F9-1AF7F808F9CE', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Count' => [ - 'description' => 'The number of blacklist policies that are modified.'."\n", - 'type' => 'string', - 'example' => '1', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '%s', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E190AB2E-7BF9-59B7-9DDC-7CB1782C5ECD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"008773AE-1D86-3231-90F9-1AF7F808F9CE\\",\\n \\"Success\\": true,\\n \\"Count\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyMetricRuleBlackListResponse>\\n <RequestId>008773AE-1D86-3231-90F9-1AF7F808F9CE</RequestId>\\n <Success>true</Success>\\n <Count>1</Count>\\n</ModifyMetricRuleBlackListResponse>","errorExample":""}]', - 'title' => 'ModifyMetricRuleBlackList', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'DeleteMetricRuleBlackList' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Modify a metric store', + 'summary' => 'Calls the ModifyHybridMonitorNamespace operation to modify a metric store.', + 'description' => 'This topic provides an example on how to change the data storage duration of the metric store `aliyun` to `cms.s1.2xlarge`. The response shows that the metric store is modified.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-06-09T09:38:01.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-04-24T08:29:10.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHybridMonitorNamespace'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:UpdateCustomNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"%s\\",\\n \\"RequestId\\": \\"E190AB2E-7BF9-59B7-9DDC-7CB1782C5ECD\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'ModifyHybridMonitorSLSGroup' => [ + 'summary' => 'Modifies a Logstore group by calling the ModifyHybridMonitorSLSGroup operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'SLSGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Logstore group.'."\n" + ."\n" + .'For information about how to obtain the name of a Logstore group, see [DescribeHybridMonitorSLSGroup](~~429526~~).', 'type' => 'string', 'required' => true, 'example' => 'Logstore_test', 'title' => ''], + ], + [ + 'name' => 'SLSGroupDescription', 'in' => 'query', + 'schema' => ['description' => 'The description of the Logstore group.', 'type' => 'string', 'required' => false, 'example' => 'Logstore group of Alibaba Cloud products.', 'title' => ''], + ], + [ + 'name' => 'SLSGroupConfig', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the blacklist policies. Separate multiple IDs with commas (,). You can specify up to 50 IDs.'."\n" - ."\n" - .'For more information about how to obtain the ID of a blacklist policy, see [DescribeMetricRuleBlackList](~~457257~~).'."\n" + 'description' => 'The configurations of the Logstore group.'."\n" ."\n" - .'> You can also set this parameter to a JSON array. Example: `["a9ad2ac2-3ed9-11ed-b878-0242ac12****","5cb8a9a4-198f-4651-a353-f8b28788****"]`.'."\n", - 'type' => 'string', + .'Valid values of N: 1 to 25.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSRegion' => ['description' => 'The region.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + 'SLSProject' => ['description' => 'The log project.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-project', 'title' => ''], + 'SLSLogstore' => ['description' => 'The Logstore.'."\n" + ."\n" + .'Valid values of N: 1 to 25.', 'type' => 'string', 'required' => true, 'example' => 'Logstore-aliyun-all', 'title' => ''], + 'SLSUserId' => ['description' => 'The member ID.'."\n" + ."\n" + .'Valid values of N: 1 to 25.'."\n" + ."\n" + .'When you invoke this operation by using a management account, you can associate the Alibaba Cloud services of any member in the resource folder with Hybrid Cloud Monitoring through cloud native mode. You can use the resource folder to monitor the Alibaba Cloud services of multiple accounts.'."\n" + ."\n" + .'> If a member uses CloudMonitor for the first time, make sure that the member has completed authorization for the CloudMonitor service-linked role (AliyunServiceRoleForCloudMonitor). For more information, see [CloudMonitor service-linked role](~~170423~~).', 'type' => 'string', 'required' => false, 'example' => '120886317861****', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', + 'maxItems' => 30, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B88D233C-A004-3AB8-AD9C-30CBDD4440C5', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Count' => [ - 'description' => 'The number of blacklist policies that are deleted.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'NotFound.SLSGroup', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 412 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"B88D233C-A004-3AB8-AD9C-30CBDD4440C5\\",\\n \\"Success\\": true,\\n \\"Count\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DeleteMetricRuleBlackListResponse>\\n <RequestId>B88D233C-A004-3AB8-AD9C-30CBDD4440C5</RequestId>\\n <Success>true</Success>\\n <Count>1</Count>\\n</DeleteMetricRuleBlackListResponse>","errorExample":""}]', - 'title' => 'DeleteMetricRuleBlackList', - 'summary' => 'Deletes multiple blacklist policies at a time.', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'DescribeMetricRuleBlackList' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Modify a logstore group', + 'description' => 'This topic provides an example on how to change the Logstore in the `aliyun-project` log project in the `ap-southeast-1` region of the Logstore group `Logstore_test` to `Logstore-aliyun-all`. The response shows that the Logstore group is modified.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHybridMonitorSLSGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:ModifyHybridMonitorSLSGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"NotFound.SLSGroup\\",\\n \\"RequestId\\": \\"66683237-7126-50F8-BBF8-D67ACC919A17\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'ModifyHybridMonitorTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the blacklist policy expired.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The monitoring task ID.'."\n" + ."\n" + .'For information about how to obtain the monitoring task ID, see [DescribeHybridMonitorTaskList](~~428624~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '36****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'The categories of the Alibaba Cloud service. For example, ApsaraDB for Redis includes the following categories: ApsaraDB for Redis (standard architecture), ApsaraDB for Redis (cluster architecture), and ApsaraDB for Redis (read/write splitting architecture). In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The monitoring task name.'."\n" + ."\n" + .'For information about how to obtain the monitoring task ID, see [DescribeHybridMonitorTaskList](~~428624~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'SLS_task', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the call was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'DESC', - ], + 'schema' => ['description' => 'The description of the monitoring task.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'SLS log monitoring data.', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'CollectInterval', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the blacklist policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The collection interval of the metric. Valid values:'."\n" + ."\n" + .'- 15'."\n" + ."\n" + .'- 60'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'string', 'required' => false, 'example' => '15', 'title' => ''], ], [ - 'name' => 'Ids', + 'name' => 'AttachLabels', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'The tags of the metric.', 'type' => 'array', 'items' => [ - 'description' => 'The operation that you want to perform. Set the value to **DescribeMetricRuleBlackList**.'."\n", - 'type' => 'string', + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The tag value of the metric.', 'type' => 'string', 'required' => false, 'example' => 'testValue', 'title' => ''], + 'Name' => ['description' => 'The tag key of the metric.', 'type' => 'string', 'required' => false, 'example' => 'app_service', 'title' => ''], + ], 'required' => false, - 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 20, - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the blacklist policy.'."\n" - ."\n" - .'This parameter supports fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Blacklist-01', - ], - ], - [ - 'name' => 'ScopeType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The effective scope of the blacklist policy. Valid values:'."\n" - ."\n" - .'* USER: The blacklist policy takes effect only within the current Alibaba Cloud account.'."\n" - .'* GROUP: The blacklist policy takes effect only within the specified application group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'USER', - ], - ], - [ - 'name' => 'IsEnable', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the blacklist policy. Valid values:'."\n" - ."\n" - .'* true: The blacklist policy is enabled.'."\n" - .'* false: The blacklist policy is disabled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'InstanceIds', + 'name' => 'SLSProcessConfig', 'in' => 'query', - 'allowEmptyValue' => false, 'style' => 'flat', 'schema' => [ - 'description' => 'The IDs of the instances in the blacklist policy.'."\n" - ."\n" - .'Valid values of N: 0 to 10.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the instance in the blacklist policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-2ze2d6j5uhg20x47****', - ], - 'required' => false, - 'maxItems' => 10, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'None'."\n", + 'description' => 'The SLS log configuration.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The categories of the Alibaba Cloud service. For example, ApsaraDB for Redis includes the following categories: ApsaraDB for Redis (standard architecture), ApsaraDB for Redis (cluster architecture), and ApsaraDB for Redis (read/write splitting architecture). In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'D63E76CB-29AA-5B9F-88CE-400A6F28D428', + 'Filter' => [ + 'description' => 'The filter conditions for parameters in the SLS log.', + 'type' => 'object', + 'properties' => [ + 'Relation' => ['description' => 'The relationship between multiple filter conditions. Valid values:'."\n" + ."\n" + .'- and (default): Logs are processed only when all filter conditions are met.'."\n" + .'- or: Logs are processed when any filter condition is met.', 'type' => 'string', 'required' => false, 'example' => 'and', 'title' => ''], + 'Filters' => [ + 'description' => 'None.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the parameter to filter in the SLS log.', 'type' => 'string', 'required' => false, 'example' => 'code', 'title' => ''], + 'Operator' => [ + 'description' => 'The method used to filter parameter values in the SLS log. Valid values:'."\n" + .'- `contain`: contains.'."\n" + .'- `notContain`: does not contain.'."\n" + .'- `>`: greater than.'."\n" + .'- `<`: less than.'."\n" + .'- `=`: equal to.'."\n" + .'- `!=`: not equal to.'."\n" + .'- `>=`: greater than or equal to.'."\n" + .'- `<=`: less than or equal to.', + 'type' => 'string', + 'enum' => ['>', '>=', '=', '<=', '<', '!=', 'contain', 'notContain'], + 'required' => false, + 'example' => '=', + 'title' => '', + ], + 'Value' => ['description' => 'The filter value of the parameter in the SLS log.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Total' => [ - 'description' => 'The timestamp when the blacklist policy was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'Statistics' => [ + 'description' => 'None.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the parameter for SLS log statistics.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'Function' => ['description' => 'The statistical method used to aggregate log data within a statistical period. Valid values:'."\n" + .'- count: counts the number of occurrences.'."\n" + .'- sum: calculates the sum.'."\n" + .'- avg: calculates the average.'."\n" + .'- max: returns the maximum value.'."\n" + .'- min: returns the minimum value.'."\n" + .'- value: samples within the period.'."\n" + .'- countps: calculates the per-second average of the count for the specified field within the statistical period.'."\n" + .'- sumps: calculates the per-second average of the sum for the specified field within the statistical period.'."\n" + .'- distinct: calculates the number of occurrences of the specified field after deduplication within the statistical period.'."\n" + .'- distribution: calculates the number of occurrences of field values within a specified range.'."\n" + .'- percentile: calculates the distribution value of field values, such as P50.', 'type' => 'string', 'required' => false, 'example' => 'count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the SLS log statistics result.', 'type' => 'string', 'minLength' => 0, 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', 'required' => false, 'example' => 'level_count', 'title' => ''], + 'Parameter1' => ['description' => 'The statistical value of the SLS log.'."\n" + ."\n" + .'- If `Function` is set to `distribution`, this parameter specifies the lower limit of the statistical range. For example, to count the number of 2XX HTTP status codes, set this parameter to 200.'."\n" + ."\n" + .'- If `Function` is set to `percentile`, this parameter specifies the percentile of the statistical distribution. For example, 0.5 indicates P50.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], + 'Parameter2' => ['description' => 'The statistical value of the SLS log.'."\n" + ."\n" + .'> This parameter is required only when `Function` is set to `distribution`. It specifies the upper limit of the statistical range. For example, to count the number of 2XX HTTP status codes, set this parameter to 299.', 'type' => 'string', 'required' => false, 'example' => '299', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of different cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'GroupBy' => [ + 'description' => 'Aggregates data by spatial dimension, which is equivalent to GROUP BY in SQL.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => ['description' => 'The name of the parameter for SLS log statistics.', 'type' => 'string', 'required' => false, 'example' => 'code', 'title' => ''], + 'Alias' => ['description' => 'The alias of the SLS log statistics result.', 'type' => 'string', 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', 'required' => false, 'example' => 'ApiResult', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'DescribeMetricRuleBlackList' => [ - 'description' => 'The queried blacklist policies.'."\n", + 'Express' => [ + 'description' => 'The arithmetic operation result of the extended field in the SLS log statistics result.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'EffectiveTime' => [ - 'description' => 'The time range within which the blacklist policy is effective.'."\n", - 'type' => 'string', - 'example' => '00:00-23:59', - ], - 'UpdateTime' => [ - 'description' => 'The timestamp when the blacklist policy was modified.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1665718373000', - ], - 'CreateTime' => [ - 'description' => 'The timestamp when the blacklist policy was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1665714561000', - ], - 'ScopeType' => [ - 'description' => 'The effective scope of the blacklist policy. Valid values:'."\n" - ."\n" - .'* USER: The blacklist policy takes effect only within the current Alibaba Cloud account.'."\n" - .'* GROUP: The blacklist policy takes effect only within the specified application group.'."\n", - 'type' => 'string', - 'example' => 'USER', - ], - 'IsEnable' => [ - 'description' => 'The status of the blacklist policy. Valid values:'."\n" - ."\n" - .'* true: The blacklist policy is enabled.'."\n" - .'* false: The blacklist policy is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Namespace' => [ - 'description' => 'The namespace of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'Category' => [ - 'description' => 'The category of the cloud service. For example, ApsaraDB for Redis includes the following categories: ApsaraDB for Redis (standard architecture), ApsaraDB for Redis (cluster architecture), and ApsaraDB for Redis (read/write splitting architecture). In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'EnableEndTime' => [ - 'description' => 'The timestamp when the blacklist policy started to take effect.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1640608200000', - ], - 'Name' => [ - 'description' => 'The name of the blacklist policy.'."\n", - 'type' => 'string', - 'example' => 'Blacklist-01', - ], - 'EnableStartTime' => [ - 'description' => 'The timestamp when the blacklist policy expired.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1640237400000', - ], - 'Id' => [ - 'description' => 'The ID of the blacklist policy.'."\n", - 'type' => 'string', - 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', - ], - 'Metrics' => [ - 'description' => 'The metrics of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Resource' => [ - 'description' => 'The extended dimension of the instance. For example, `{"device":"C:"}` specifies that the blacklist policy is applied to all C disks of the specified Elastic Compute Service (ECS) instance.'."\n", - 'type' => 'string', - 'example' => '[{"device":"C:"}]', - ], - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'disk_utilization', - ], - ], - ], - ], - 'Instances' => [ - 'description' => 'The IDs of the instances that belong to the specified cloud service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the instances that belong to the specified cloud service.'."\n", - 'type' => 'string', - 'example' => 'i-rj99xc6cptkk64ml****', - ], - ], - 'ScopeValue' => [ - 'description' => 'The IDs of the application groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the application groups. The value of this parameter is a JSON array.'."\n" - ."\n" - .'> This parameter is returned only if the `ScopeType` parameter is set to `GROUP`.'."\n", - 'type' => 'string', - 'example' => '["67****","78****"]', - ], - ], + 'Express' => ['description' => 'The arithmetic operation result of the extended field in the SLS log statistics result.', 'type' => 'string', 'required' => false, 'example' => 'success_count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the arithmetic operation result of the extended field in the SLS log statistics result.', 'type' => 'string', 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', 'required' => false, 'example' => 'SuccRate', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Invalid.SLSConfig', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '11145B76-566A-5D80-A8A3-FAD98D310079', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"D63E76CB-29AA-5B9F-88CE-400A6F28D428\\",\\n \\"Total\\": 1,\\n \\"Success\\": true,\\n \\"DescribeMetricRuleBlackList\\": [\\n {\\n \\"EffectiveTime\\": \\"00:00-23:59\\",\\n \\"UpdateTime\\": \\"1665718373000\\",\\n \\"CreateTime\\": \\"1665714561000\\",\\n \\"ScopeType\\": \\"USER\\",\\n \\"IsEnable\\": true,\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Category\\": \\"ecs\\",\\n \\"EnableEndTime\\": 1640608200000,\\n \\"Name\\": \\"Blacklist-01\\",\\n \\"EnableStartTime\\": 1640237400000,\\n \\"Id\\": \\"93514c96-ceb8-47d8-8ee3-93b6d98b****\\",\\n \\"Metrics\\": [\\n {\\n \\"Resource\\": \\"[{\\\\\\"device\\\\\\":\\\\\\"C:\\\\\\"}]\\",\\n \\"MetricName\\": \\"disk_utilization\\"\\n }\\n ],\\n \\"Instances\\": [\\n \\"i-rj99xc6cptkk64ml****\\"\\n ],\\n \\"ScopeValue\\": [\\n \\"[\\\\\\"67****\\\\\\",\\\\\\"78****\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricRuleBlackListResponse>\\n <RequestId>D63E76CB-29AA-5B9F-88CE-400A6F28D428</RequestId>\\n <Total>1</Total>\\n <DescribeMetricRuleBlackList>\\n <ScopeType>USER</ScopeType>\\n <Instances>\\n <instancceId>i-rj99xc6cptkk64ml****</instancceId>\\n </Instances>\\n <IsEnable>true</IsEnable>\\n <Metrics>\\n <MetricName>disk_utilization</MetricName>\\n <Resource/>\\n </Metrics>\\n <Category>ecs</Category>\\n <CreateTime>1635714561000</CreateTime>\\n <UpdateTime>1635718373000</UpdateTime>\\n <Id>93514c96-ceb8-47d8-8ee3-93b6d98b****</Id>\\n <Namespace>acs_ecs_dashboard</Namespace>\\n <Name>Blacklist-01</Name>\\n </DescribeMetricRuleBlackList>\\n <Success>true</Success>\\n</DescribeMetricRuleBlackListResponse>","errorExample":""}]', - 'title' => 'DescribeMetricRuleBlackList', - 'summary' => 'Queries blacklist policies.', - 'requestParamsDescription' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - ], - 'EnableMetricRuleBlackList' => [ - 'summary' => 'Enables or disables multiple blacklist policies at a time.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Modify a monitoring task', + 'summary' => 'Modifies the metrics of a Simple Log Service (SLS) log monitoring task by calling the ModifyHybridMonitorTask operation.', + 'description' => 'This topic provides an example on how to change the collection interval of the SLS log monitoring task `36****` to `15` seconds. The response shows that the metric is modified.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [ + ['createdAt' => '2022-07-11T06:44:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-09T02:41:41.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHybridMonitorTask'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyHybridMonitorTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Invalid.SLSConfig\\",\\n \\"RequestId\\": \\"11145B76-566A-5D80-A8A3-FAD98D310079\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'ModifyMetricRuleBlackList' => [ + 'summary' => 'Modifies a blacklist policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', + 'schema' => ['description' => 'The ID of the blacklist policy.'."\n" + ."\n" + .'For information about how to obtain the ID of a blacklist policy, see [DescribeMetricRuleBlackList](~~457257~~).', 'type' => 'string', 'required' => true, 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the blacklist policy.', 'type' => 'string', 'required' => true, 'example' => 'Blacklist-02', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => ['description' => 'The category of the cloud service. For example, ApsaraDB for Redis supports the standard architecture, the cluster architecture, and the read/write splitting architecture. In this case, the valid values of this parameter for ApsaraDB for Redis include `kvstore_standard`, `kvstore_sharding`, and `kvstore_splitrw`.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + ], + [ + 'name' => 'ScopeType', + 'in' => 'query', + 'schema' => ['description' => 'The effective scope of the blacklist policy. Valid values:'."\n" + ."\n" + .'- USER: The blacklist policy takes effect only within the current Alibaba Cloud account.'."\n" + ."\n" + .'- GROUP (default): The blacklist policy takes effect only within the specified application group. For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => false, 'example' => 'USER', 'title' => ''], + ], + [ + 'name' => 'ScopeValue', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of the application groups.'."\n" + ."\n" + .'> This parameter is required only when `ScopeType` is set to `GROUP`.', 'type' => 'string', 'required' => false, 'example' => '["67****","78****"]', 'title' => ''], + ], + [ + 'name' => 'EnableStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The timestamp when the blacklist policy starts to take effect.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1640237400000', 'title' => ''], + ], + [ + 'name' => 'EnableEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The timestamp when the blacklist policy expires.'."\n" + ."\n" + .'Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1640608200000', 'title' => ''], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => ['description' => 'The time range within which the blacklist policy is effective. Take note of the following information:'."\n" + ."\n" + .'- If you do not configure this parameter, the blacklist policy is permanently effective.'."\n" + ."\n" + .'- If you configure this parameter, the blacklist policy is effective only within the specified time range. Examples:'."\n" + ."\n" + .' - `03:00-04:59`: The blacklist policy is effective from 03:00 to 05:00 local time. 05:00 local time is excluded.'."\n" + ."\n" + .' - `03:00-04:59 UTC+0700`: The blacklist policy is effective from 03:00 to 05:00 (UTC+7). 05:00 (UTC+7) is excluded.', 'type' => 'string', 'required' => false, 'example' => '03:00-04:59', 'title' => ''], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the blacklist policies. Separate multiple IDs with commas (,). You can specify up to 50 IDs.'."\n" - ."\n" - .'For information about how to obtain the ID of a blacklist policy, see [DescribeMetricRuleBlackList](~~457257~~).'."\n" + 'description' => 'The IDs of the instances that belong to the specified cloud service.', + 'type' => 'array', + 'items' => ['description' => 'The IDs of the instances that belong to the specified cloud service.'."\n" ."\n" - .'> You can also set this parameter to a JSON array. Example: `["a9ad2ac2-3ed9-11ed-b878-0242ac12****","5cb8a9a4-198f-4651-a353-f8b28788****"]`.'."\n", - 'type' => 'string', + .'Valid values of N: 1 to 100.', 'type' => 'string', 'required' => false, 'example' => '{"instancceId":"i-bp1ew0zfkjblsuwx****"}', 'title' => ''], 'required' => true, - 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'IsEnable', + 'name' => 'Metrics', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to enable the blacklist policy. Valid values:'."\n" + 'description' => 'The metrics of the instance.'."\n" ."\n" - .'* true: The blacklist policy is enabled.'."\n" - .'* false (default): The blacklist policy is disabled.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', + .'- If you do not configure this parameter, the blacklist policy applies to all metrics of the specified cloud service.'."\n" + ."\n" + .'- If you configure this parameter, the blacklist policy applies only to the current metric.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The name of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 10.', 'type' => 'string', 'required' => true, 'example' => 'disk_utilization', 'title' => ''], + 'Resource' => ['description' => 'The extended dimension of the instance. For example, `{"device":"C:"}` specifies that the blacklist policy is applied to all C disks of the specified Elastic Compute Service (ECS) instance.'."\n" + ."\n" + .'Valid values of N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => '{"device":"C:"}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '94869866-1621-3652-BBC9-72A47B2AC2F5', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Count' => [ - 'description' => 'The number of blacklist policies that are enabled or disabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'Code' => ['description' => 'The error code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '008773AE-1D86-3231-90F9-1AF7F808F9CE', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Count' => ['description' => 'The number of blacklist policies that are modified.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'AccessForbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 409 => [ - [ - 'errorCode' => 'ResourceConflict', - 'errorMessage' => 'Concurrent modification of resources.', - ], - [ - 'errorCode' => 'ResourceExist', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'ModifyMetricRuleBlackList', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMetricRuleBlackList'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyMetricRuleBlackList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"94869866-1621-3652-BBC9-72A47B2AC2F5\\",\\n \\"Success\\": true,\\n \\"Count\\": 1\\n}","errorExample":""},{"type":"xml","example":"<EnableMetricRuleBlackListResponse>\\n <RequestId>94869866-1621-3652-BBC9-72A47B2AC2F5</RequestId>\\n <Success>true</Success>\\n <Count>1</Count>\\n</EnableMetricRuleBlackListResponse>","errorExample":""}]', - 'title' => 'EnableMetricRuleBlackList', - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"008773AE-1D86-3231-90F9-1AF7F808F9CE\\",\\n \\"Success\\": true,\\n \\"Count\\": \\"1\\"\\n}","type":"json"}]', ], - 'DeleteContactGroup' => [ - 'summary' => 'Deletes an alert contact group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyMetricRuleTemplate' => [ + 'summary' => 'Modifies an alert template.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ContactGroupName', + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert template.'."\n" + ."\n" + .'For information about how to obtain the ID of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert template.'."\n" + ."\n" + .'For information about how to obtain the name of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'string', 'required' => false, 'example' => 'Template_123', 'title' => ''], + ], + [ + 'name' => 'Description', 'in' => 'query', + 'schema' => ['description' => 'The description of the alert template.', 'type' => 'string', 'required' => false, 'example' => 'ECS_template1', 'title' => ''], + ], + [ + 'name' => 'RestVersion', + 'in' => 'query', + 'schema' => ['description' => 'The version of the alert template. The version changes with the number of times that the alert template is modified.'."\n" + ."\n" + .'For information about how to obtain the version of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AlertTemplates', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'contact_group_2019_templatedfkXQ', - 'docRequired' => true, + 'description' => 'The details of the alert template.', + 'type' => 'array', + 'items' => [ + 'description' => 'The version of the alert template. The version changes with the number of times that the alert template is modified.'."\n" + ."\n" + .'For information about how to obtain the version of an alert template, see [DescribeMetricRuleTemplateList](~~114982~~).', + 'type' => 'object', + 'properties' => [ + 'Escalations.Info.Threshold' => ['description' => 'The threshold for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain metrics, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The callback URL must be accessible over the Internet. CloudMonitor pushes an alert notification to the specified callback URL by sending an HTTP POST request. Only the HTTP protocol is supported.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com', 'title' => ''], + 'Escalations.Warn.Threshold' => ['description' => 'The threshold for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + 'Namespace' => ['description' => 'The namespace of the cloud service.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For information about how to obtain the namespace of a cloud service, see [DescribeMetricMetaList](~~98846~~) or [Appendix 1: Metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'Period' => ['description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> If the value is set to 300 seconds, the monitoring data is collected every 300 seconds. If the monitoring data is reported every 1 minute, the alert system calculates the average, maximum, and minimum values of the monitoring data of 5 minutes and checks whether the aggregated values exceed the threshold. To prevent unexpected alerts, we recommend that you set this parameter together with other parameters.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 200.', 'type' => 'string', 'required' => false, 'example' => 'Rule_123', 'title' => ''], + 'Escalations.Critical.Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + 'Selector' => ['description' => 'The dimension of the alert. It is an extended field.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For example, an alert template is applied to an application group, this parameter is set to `{"disk":"/"}`, and the MetricName parameter is set to `DiskUtilization`. In this case, the generated alert rule is applied to the root disk partition (`"/"`) of all instances in the application group to which the alert template is applied.'."\n" + ."\n" + .'> For more information about the values of extended fields, see [DescribeMetricRuleTemplateAttribute](~~114979~~).', 'type' => 'string', 'required' => false, 'example' => '{"disk":"/"}', 'title' => ''], + 'Escalations.Info.Statistics' => ['description' => 'The statistical method for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Warn.Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Escalations.Info.ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Category' => ['description' => 'The abbreviation of the cloud service name.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'For more information about how to obtain the abbreviation of a cloud service name, see `metricCategory` in the response parameter `Labels` of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], + 'Escalations.Critical.Threshold' => ['description' => 'The threshold for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + 'Escalations.Critical.Statistics' => ['description' => 'The statistical method for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Critical.ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Warn.ComparisonOperator' => ['description' => 'The operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold'."\n" + ."\n" + .'- GreaterThanThreshold: greater than the threshold'."\n" + ."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold'."\n" + ."\n" + .'- LessThanThreshold: less than the threshold'."\n" + ."\n" + .'- NotEqualToThreshold: not equal to the threshold'."\n" + ."\n" + .'- GreaterThanYesterday: greater than the metric value at the same time yesterday'."\n" + ."\n" + .'- LessThanYesterday: less than the metric value at the same time yesterday'."\n" + ."\n" + .'- GreaterThanLastWeek: greater than the metric value at the same time last week'."\n" + ."\n" + .'- LessThanLastWeek: less than the metric value at the same time last week'."\n" + ."\n" + .'- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle'."\n" + ."\n" + .'- LessThanLastPeriod: less than the metric value in the last monitoring cycle'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Info.Times' => ['description' => 'The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Escalations.Warn.Statistics' => ['description' => 'The statistical method for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 200.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` parameter of the specified cloud service. The value of this parameter can be Maximum, Minimum, or Average. For more information about how to obtain the value of this parameter, see [Appendix 1: Metrics](~~163515~~).'."\n" + ."\n" + .'> You must select at least one of the Critical, Warn, and Info alert levels and specify the Statistics, ComparisonOperator, Threshold, and Times parameters for the selected alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], ], @@ -34544,99 +24062,114 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F722BE59-2400-4A64-9C1A-AD886AED9A69', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9E07117F-F6AE-4F1C-81E8-36FBB4892235', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ContactNotExists', - 'errorMessage' => 'ContactGroupName Not Exists', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidClientTokenId', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 412 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalFailure', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F722BE59-2400-4A64-9C1A-AD886AED9A69\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteContactGroupResponse>\\n <RequestId>F722BE59-2400-4A64-9C1A-AD886AED9A69</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteContactGroupResponse>","errorExample":""}]', - 'title' => 'DeleteContactGroup', - 'requestParamsDescription' => ' ', + 'title' => 'ModifyMetricRuleTemplate', + 'description' => 'This topic provides an example on how to modify an alert template whose version is `1` and ID is `123456`. The alert level is changed to `Critical`. The statistical method is changed to `Average`. The alert threshold comparator is changed to `GreaterThanOrEqualToThreshold`. The alert threshold is changed to `90`. The number of alert retries is changed to `3`. The response shows that the alert template is modified.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteContact' => [ - 'summary' => 'Deletes an alert contact.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMetricRuleTemplate'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyMetricRuleTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"9E07117F-F6AE-4F1C-81E8-36FBB4892235\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ModifyMonitorGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ContactName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-01', - 'docRequired' => true, - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => false, 'example' => 'ecs_group', 'title' => ''], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => ['description' => 'The alert contact group.', 'type' => 'string', 'required' => false, 'example' => 'alarm_ecs_group', 'title' => ''], ], ], 'responses' => [ @@ -34644,97 +24177,171 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '50D4CFE1-01E5-4543-939C-18BC01E3EC1C', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C85A2870-5DF4-4269-BC50-ECB5E4591A80', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'ContactNotExists', - 'errorMessage' => 'ContactName does not exist.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 409 => [ + ['errorCode' => 'ResourceConflict', 'errorMessage' => 'Concurrent modification of resources.', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => 'Resources already exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'ModifyMonitorGroup', + 'summary' => 'You can call the ModifyMonitorGroup operation to modify an application group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMonitorGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyMonitorGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MonitorGroup', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"50D4CFE1-01E5-4543-939C-18BC01E3EC1C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteContactResponse>\\n <RequestId>50D4CFE1-01E5-4543-939C-18BC01E3EC1C</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteContactResponse>","errorExample":""}]', - 'title' => 'DeleteContact', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"C85A2870-5DF4-4269-BC50-ECB5E4591A80\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'extraInfo' => ' ', ], - 'DescribeContactListByContactGroup' => [ - 'summary' => 'Queries the alert contacts in an alert contact group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyMonitorGroupInstances' => [ + 'summary' => 'The ModifyMonitorGroupInstances operation modifies the resources in an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ContactGroupName', + 'name' => 'GroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', + 'description' => 'The list of instances. You can specify up to 2,000 instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => 'HostName', 'title' => ''], + 'Category' => ['description' => 'The cloud service to which the resource instance belongs. The following cloud services are supported:'."\n" + ."\n" + .'- ECS (including Alibaba Cloud and third-party hosts)'."\n" + ."\n" + .'- ApsaraDB RDS'."\n" + ."\n" + .'- AnalyticDB'."\n" + ."\n" + .'- SLB'."\n" + ."\n" + .'- VPC (Elastic IP)'."\n" + ."\n" + .'- API Gateway'."\n" + ."\n" + .'- Alibaba Cloud CDN'."\n" + ."\n" + .'- Container Service for Swarm'."\n" + ."\n" + .'- DCDN'."\n" + ."\n" + .'- Anti-DDoS'."\n" + ."\n" + .'- EIP'."\n" + ."\n" + .'- Elasticsearch'."\n" + ."\n" + .'- E-MapReduce'."\n" + ."\n" + .'- Auto Scaling'."\n" + ."\n" + .'- ApsaraDB for HBase'."\n" + ."\n" + .'- IoT Edge'."\n" + ."\n" + .'- Kubernetes pod'."\n" + ."\n" + .'- ApsaraDB for Redis (sharded cluster)'."\n" + ."\n" + .'- ApsaraDB for Redis (read/write splitting)'."\n" + ."\n" + .'- ApsaraDB for Redis (Standard Edition)'."\n" + ."\n" + .'- ApsaraDB for Memcache'."\n" + ."\n" + .'- MNS'."\n" + ."\n" + .'- ApsaraDB for MongoDB (replica set)'."\n" + ."\n" + .'- ApsaraDB for MongoDB (sharded cluster)'."\n" + ."\n" + .'- ApsaraDB for MongoDB (sharded cluster)'."\n" + ."\n" + .'- MNS topic'."\n" + ."\n" + .'- OCS (ApsaraDB for Memcache of earlier versions)'."\n" + ."\n" + .'- OpenSearch'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- PolarDB'."\n" + ."\n" + .'- HybridDB for MySQL'."\n" + ."\n" + .'- Internet Shared Bandwidth'."\n" + ."\n" + .'- SLS'."\n" + ."\n" + .'- VPN Gateway', 'type' => 'string', 'required' => true, 'example' => 'ECS', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the resource instance.', 'type' => 'string', 'required' => true, 'example' => 'i-a2d5q7pm12****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'docRequired' => true, - 'example' => 'CloudMonitor', + 'maxItems' => 2000, + 'title' => '', + 'example' => '', ], ], ], @@ -34743,653 +24350,314 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The group is not exists.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Contacts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Contact' => [ - 'description' => 'The alert contacts that receive alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The time when the alert contact was modified.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552314252000', - ], - 'Name' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'CreateTime' => [ - 'description' => 'The time when the alert contact was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552314252000', - ], - 'Desc' => [ - 'description' => 'The description of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], - 'Channels' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'object', - 'properties' => [ - 'Mail' => [ - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'alice@example.com', - ], - 'AliIM' => [ - 'description' => 'The TradeManager ID of the alert contact.'."\n" - ."\n" - .'> This parameter can be returned only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'DingWebHook' => [ - 'description' => 'The webhook URL of the DingTalk chatbot.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****', - ], - 'SMS' => [ - 'description' => 'The mobile number of the alert contact.'."\n" - ."\n" - .'> This parameter can be returned only on the China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => '1333333****', - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FEC7EDB3-9B08-4AC0-A42A-329F5D14B95A', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. A value of true indicates a success. A value of false indicates a failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Parameter invalid.', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ResourceConflict', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ResourceExist', 'errorMessage' => '%s', 'description' => ''], + ], + 412 => [ + ['errorCode' => 'ResourcesOverLimit', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The group is not exists.\\",\\n \\"RequestId\\": \\"06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83\\",\\n \\"Success\\": true,\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n {\\n \\"UpdateTime\\": 1552323252000,\\n \\"Name\\": \\"Alice\\",\\n \\"CreateTime\\": 1552314252000,\\n \\"Desc\\": \\"ECS\\",\\n \\"Channels\\": {\\n \\"Mail\\": \\"alice@example.com\\",\\n \\"AliIM\\": \\"Alice\\",\\n \\"DingWebHook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****\\",\\n \\"SMS\\": \\"1333333****\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeContactListByContactGroupResponse>\\r\\n\\t<RequestId>96B41DE5-6DC9-4FAF-A790-3D4AA17C1F09</RequestId>\\r\\n\\t<Contacts>\\r\\n\\t\\t<Contact>\\r\\n\\t\\t\\t<Desc></Desc>\\r\\n\\t\\t\\t<CreateTime>1604024233000</CreateTime>\\r\\n\\t\\t\\t<UpdateTime>1604024233000</UpdateTime>\\r\\n\\t\\t\\t<Channels>\\r\\n\\t\\t\\t\\t<SMS></SMS>\\r\\n\\t\\t\\t</Channels>\\r\\n\\t\\t\\t<Name>Alice</Name>\\r\\n\\t\\t</Contact>\\r\\n\\t</Contacts>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeContactListByContactGroupResponse>","errorExample":""}]', - 'title' => 'DescribeContactListByContactGroup', + 'title' => 'ModifyMonitorGroupInstances', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeContactGroupList' => [ - 'summary' => 'Call the DescribeContactGroupList interface to query the list of alarm contact groups.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-13T11:47:48.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMonitorGroupInstances'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifyMonitorGroupInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEC7EDB3-9B08-4AC0-A42A-329F5D14B95A\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ModifySiteMonitor' => [ + 'summary' => 'Modifies a site monitoring task by calling the ModifySiteMonitor operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'Address', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of records per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '100', - ], + 'schema' => ['description' => 'The URL or IP address of the monitoring task.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'Status code. Note that 200 indicates success.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Return message.', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => '916EE694-03C2-47B6-85EE-5054E3C168D3', - ], - 'Total' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '22', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful. Values:'."\n" - ."\n" - .'- true: Success.'."\n" - ."\n" - .'- false: Failure.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ContactGroups' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroup' => [ - 'description' => 'List of alarm contact groups.', - 'type' => 'array', - 'items' => [ - 'description' => 'Alarm contact group.', - 'type' => 'string', - 'example' => '云账号报警联系人', - ], - ], - ], - ], - 'ContactGroupList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroup' => [ - 'description' => 'List of alarm contact groups.', - 'type' => 'array', - 'items' => [ - 'description' => 'Alarm contact group.', - 'type' => 'object', - 'properties' => [ - 'Describe' => [ - 'description' => 'Description information of the alarm contact group.', - 'type' => 'string', - 'example' => 'Devops-运维组', - ], - 'UpdateTime' => [ - 'description' => 'Update time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2025-03-04T02:12:06Z', - ], - 'CreateTime' => [ - 'description' => 'Creation time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2023-06-07T03:52:30Z', - ], - 'EnabledWeeklyReport' => [ - 'description' => 'Indicates whether the weekly report function is enabled.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Name' => [ - 'description' => 'Name.', - 'type' => 'string', - 'example' => 'name', - ], - 'EnableSubscribed' => [ - 'description' => 'Indicates whether the weekly report subscription function is enabled. Values:'."\n" - ."\n" - .'- true: Yes.'."\n" - ."\n" - .'- false: No.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Contacts' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Contact' => [ - 'description' => 'List of contacts.', - 'type' => 'array', - 'items' => [ - 'description' => 'Contact.', - 'type' => 'string', - 'example' => '135xxxx8066', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 200 => [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Illegal parameters.', - ], - ], - 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + 'schema' => ['description' => 'The ID of the monitoring task.', 'type' => 'string', 'required' => true, 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', 'title' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the monitoring task. The name must be 4 to 100 characters in length and can contain letters, digits, underscores (_), and Chinese characters.', 'type' => 'string', 'required' => false, 'example' => 'HanZhou_ECS2', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"916EE694-03C2-47B6-85EE-5054E3C168D3\\",\\n \\"Total\\": 22,\\n \\"Success\\": true,\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"云账号报警联系人\\"\\n ]\\n },\\n \\"ContactGroupList\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Describe\\": \\"Devops-运维组\\",\\n \\"UpdateTime\\": 0,\\n \\"CreateTime\\": 0,\\n \\"EnabledWeeklyReport\\": false,\\n \\"Name\\": \\"name\\",\\n \\"EnableSubscribed\\": false,\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n \\"135xxxx8066\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'Query Alarm Contact Group List', - 'translator' => 'machine', - ], - 'DescribeContactList' => [ - 'summary' => 'Queries alert contacts.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The monitoring frequency. Valid values: 1, 5, and 15. Unit: minutes. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'IspCities', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '100', - ], + 'schema' => ['description' => 'The detection point information. The value is in JSONArray format, for example: `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`, where `city` corresponds to Beijing, Hangzhou, and Qingdao respectively.'."\n" + ."\n" + .'> You can call the DescribeSiteMonitorISPCityList operation to query detection point information. For more information, see [DescribeSiteMonitorISPCityList](~~115045~~). If this parameter is left empty, the system randomly selects three detection points.', 'type' => 'string', 'required' => false, 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'OptionsJson', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The advanced extended options for the protocol type of the monitoring task. Different protocol types correspond to different extended options.', 'type' => 'string', 'required' => false, 'example' => '{"time_out":5000}', 'title' => ''], ], [ - 'name' => 'ContactName', + 'name' => 'AlertIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alice', - ], + 'schema' => ['description' => 'The ID of the alert rule. The ID of an existing alert rule in CloudMonitor. You can call the DescribeMetricRuleList operation to query alert rule IDs. For more information, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => false, 'example' => '49f7c317-7645-4cc9-94fd-ea42e122****', 'title' => ''], ], [ - 'name' => 'ChanelType', + 'name' => 'IntervalUnit', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail: emails'."\n" - .'* DingWebHook: DingTalk chatbots'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Mail', - ], + 'schema' => ['description' => 'The unit of the monitoring metrics.'."\n" + ."\n" + .'Unit: milliseconds (ms).', 'type' => 'string', 'required' => false, 'example' => 'ms', 'title' => ''], ], [ - 'name' => 'ChanelValue', + 'name' => 'CustomSchedule', 'in' => 'query', - 'schema' => [ - 'description' => 'The value specified for the alert notification method.'."\n" - ."\n" - .'> This parameter is required only if you set the `ChanelType` parameter to `Mail`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alice@example.com', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The custom monitoring schedule. You can select a specific time period from Monday to Sunday for monitoring.', 'type' => 'string', 'example' => '{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Contacts' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the node task result.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'Contact' => [ - 'description' => 'The alert contacts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The timestamp when the alert contact was updated.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552356159000', - ], - 'Name' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'CreateTime' => [ - 'description' => 'The timestamp when the alert contact was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1552356159000', - ], - 'Lang' => [ - 'description' => 'The language in which the alert information is displayed. Valid values:'."\n" - ."\n" - .'* zh-cn: simplified Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'example' => 'zh-cn', - ], - 'Desc' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'ContactGroups' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ContactGroup' => [ - 'description' => 'None.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert contact groups.'."\n", - 'type' => 'string', - 'example' => '{ "ContactGroup": [ "ECS_Group", "Jim" ] }', - ], - ], - ], - ], - 'Channels' => [ - 'description' => 'The alert notification method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Mail' => [ - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'Alice@example.com', - ], - 'AliIM' => [ - 'description' => 'The TradeManager ID of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'DingWebHook' => [ - 'description' => 'The webhook URL of the DingTalk chatbot.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****', - ], - 'SMS' => [ - 'description' => 'The phone number of the alert contac.'."\n", - 'type' => 'string', - 'example' => '1333333****', - ], - ], - ], - 'ChannelsState' => [ - 'description' => 'The status of the alert notification method. Valid values: PENDING and OK.'."\n" - ."\n" - .'The email address must be activated after it is added as the value specified for the alert notification method. The value PENDING indicates that the email address is not activated. The value OK indicates that the email address is activated.'."\n", - 'type' => 'object', - 'properties' => [ - 'Mail' => [ - 'description' => 'The status of the email address. Valid values:'."\n" - ."\n" - .'* PENDING: The phone number is not activated. Alert notifications can be sent to the phone number by using text messages only after the phone number is activated.'."\n" - .'* OK: The phone number is activated and can receive alert notifications.'."\n", - 'type' => 'string', - 'example' => 'PENDING', - ], - 'AliIM' => [ - 'description' => 'The status of the TradeManager ID.'."\n" - ."\n" - .'Valid value: OK. The value OK indicates that the TradeManager ID is valid and can receive alert notifications.'."\n" - ."\n" - .'> This parameter applies only to the Alibaba Cloud China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'DingWebHook' => [ - 'description' => 'The status of the DingTalk chatbot.'."\n" - ."\n" - .'Valid value: OK. The value OK indicates that the DingTalk chatbot is normal and alert notifications can be received in a DingTalk group.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'SMS' => [ - 'description' => 'The status of the phone number. Valid values:'."\n" - ."\n" - .'* PENDING: The phone number is not activated. Alert notifications can be sent to the phone number by using text messages only after the phone number is activated.'."\n" - .'* OK: The phone number is activated and can receive alert notifications.'."\n" - ."\n" - .'> This parameter applies only to the Alibaba Cloud China site (aliyun.com).'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - ], - ], - ], - ], - ], + 'count' => ['description' => 'The number of monitoring tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidQueryParameter', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalAddress', 'errorMessage' => 'Illegal HTTP address', 'description' => ''], + ['errorCode' => 'OperationError', 'errorMessage' => 'Operation failed', 'description' => ''], + ['errorCode' => 'TaskNotExists', 'errorMessage' => 'Task does not exist', 'description' => ''], + ['errorCode' => 'OperatorInvalid', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'NameRepeat', 'errorMessage' => 'Task name repeat', 'description' => ''], + ['errorCode' => 'CreateAlarmError', 'errorMessage' => 'Create alarm error', 'description' => ''], + ['errorCode' => 'NameNotExists', 'errorMessage' => 'Task name not exists', 'description' => ''], + ['errorCode' => 'OperatorCityInvalid', 'errorMessage' => 'Invalid Isp.', 'description' => 'Invalid Isp'], ], - 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.', 'description' => 'No permission, please use RAM to authorize'], + ['errorCode' => 'RestrictedUser', 'errorMessage' => 'The user\'s operation is restricted, please register NAAM product code.', 'description' => ''], + ['errorCode' => 'UnauthorizedTasks', 'errorMessage' => 'You are not permitted to operate the specified tasks.', 'description' => 'You are not permitted to operate the specified tasks.'], + ], + [ + ['errorCode' => 'TaskNotExist', 'errorMessage' => 'The specified task does not exist.', 'description' => 'The specified task does not exist.'], + ], + 406 => [ + ['errorCode' => 'ExceedingQuota', 'errorMessage' => 'Exceeding quota limits.', 'description' => 'The number of tasks exceeds the limit'], + ], + 409 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'ThrottlingException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternetServerError', 'errorMessage' => 'System internal error.', 'description' => 'System internal error'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83\\",\\n \\"Total\\": 15,\\n \\"Success\\": true,\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n {\\n \\"UpdateTime\\": 1552356159000,\\n \\"Name\\": \\"Alice\\",\\n \\"CreateTime\\": 1552356159000,\\n \\"Lang\\": \\"zh-cn\\",\\n \\"Desc\\": \\"ECS联系人\\",\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"{ \\\\\\"ContactGroup\\\\\\": [ \\\\t\\\\\\"ECS_Group\\\\\\", \\\\\\"Jim\\\\\\" ] }\\"\\n ]\\n },\\n \\"Channels\\": {\\n \\"Mail\\": \\"Alice@example.com\\",\\n \\"AliIM\\": \\"Alice\\",\\n \\"DingWebHook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****\\",\\n \\"SMS\\": \\"1333333****\\"\\n },\\n \\"ChannelsState\\": {\\n \\"Mail\\": \\"PENDING\\",\\n \\"AliIM\\": \\"OK\\",\\n \\"DingWebHook\\": \\"OK\\",\\n \\"SMS\\": \\"OK\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeContactListResponse>\\r\\n\\t\\t<RequestId>A1267F27-942F-40EE-9254-57FE16E3C9AB</RequestId>\\r\\n\\t\\t<Contacts>\\r\\n\\t\\t\\t<Contact>\\r\\n\\t\\t\\t\\t<Desc>Contact Desc</Desc>\\r\\n\\t\\t\\t\\t<ContactGroups>\\r\\n\\t\\t\\t\\t\\t<ContactGroup>ECS_Group</ContactGroup>\\r\\n\\t\\t\\t\\t\\t<ContactGroup>Jim</ContactGroup>\\r\\n\\t\\t\\t\\t</ContactGroups>\\r\\n\\t\\t\\t\\t<ChannelsState>\\r\\n\\t\\t\\t\\t\\t<SMS>PENDING</SMS>\\r\\n\\t\\t\\t\\t\\t<Mail>OK</Mail>\\r\\n\\t\\t\\t\\t</ChannelsState>\\r\\n\\t\\t\\t\\t<CreateTime>1583307692000</CreateTime>\\r\\n\\t\\t\\t\\t<UpdateTime>1589441072000</UpdateTime>\\r\\n\\t\\t\\t\\t<Channels>\\r\\n\\t\\t\\t\\t\\t<Mail>alice@example.com</Mail>\\r\\n\\t\\t\\t\\t\\t<SMS>155*******</SMS>\\r\\n\\t\\t\\t\\t</Channels>\\r\\n\\t\\t\\t\\t<Name>Alice</Name>\\r\\n\\t\\t\\t\\t<Lang>zh-cn</Lang>\\r\\n\\t\\t\\t</Contact>\\r\\n\\t\\t</Contacts>\\r\\n\\t\\t<Total>25</Total>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeContactListResponse>","errorExample":""}]', - 'title' => 'DescribeContactList', - 'requestParamsDescription' => ' ', + 'title' => 'Modify a site monitoring task', + 'requestParamsDescription' => 'Site monitoring supports the following eight task types. The extended options (OptionsJson) for each task type are described in the following tables.'."\n" + ."\n" + .'- HTTP.'."\n" + ."\n" + .'|Name |Type |Description|'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|http_method |String |The HTTP request method. Valid values: GET, POST, and HEAD. Default value: GET. |'."\n" + .'|header |String |Custom HTTP headers separated by line feeds (\\n).<br>Each header must comply with the HTTP protocol format (key-value pairs separated by a colon). |'."\n" + .'|cookie |String |The cookie, which follows the standard HTTP request format. |'."\n" + .'|request_content |String |The request content. Two formats are supported: JSON and form. If this parameter is not specified, the request does not contain a body. |'."\n" + .'|response_content |String |The expected response content. During monitoring, the first 64 bytes returned by the HTTP server are checked. |'."\n" + .'|match_rule |String |0: The monitoring is successful if the response does not contain response_content.<br>1: The monitoring is successful if the response contains response_content. |'."\n" + .'|username |String |If a username is provided, a BasicAuth header is included in the HTTP request. |'."\n" + .'|password |String |The password for HTTP request authentication. |'."\n" + .'|time_out |int |The timeout period. Unit: milliseconds. Default value: 5. |'."\n" + .'|max_redirect |int |The maximum number of redirects. The default value is 5 for ECS detection points and 2 for carrier detection points.<br>To disable redirects, set this parameter to 0.<br>Valid values: 0 to 50. |.'."\n" + ."\n" + .' '."\n" + .'- PING.'."\n" + ."\n" + .'|Name |Type |Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|failure_rate |int |If the PING failure rate exceeds this value, the monitoring fails and returns 610 (PingAllFail) or 615 (PingPartialFail).<br>Default value: 0.1. |'."\n" + .'|ping_num |int |The number of PING attempts. Default value: 20.<br>Valid values: 1 to 100. |.'."\n" + ."\n" + .'- DNS.'."\n" + ."\n" + .'|Name |Type |Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|dns_server |string |The address of the DNS server. The value can be a domain name or an IP address. |'."\n" + .'|dns_type |string |The DNS query type. Valid values: A, NS, CNAME, MX, TXT, and ANY. |'."\n" + .'|expect_value |string |The list of expected values separated by whitespace characters. |'."\n" + .'|match_rule |string |The relationship between the expected value list and the DNS list. If the specified relationship is not met, the monitoring fails. <br>Empty string or IN_DNS: The expected value list is a subset of the DNS list. <br>DNS_IN: The DNS list is a subset of the expected value list. <br>EQUAL: The DNS list is equal to the expected value list. <br>ANY: The DNS list and the expected value list have a non-empty intersection. |.'."\n" + ."\n" + .'- FTP.'."\n" + ."\n" + .'|Name |Type |Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |The port number of the FTP server. If this parameter is not specified, the default value is used. Default value for FTP: 21. Default value for FTPs: 990. |'."\n" + .'|username |string |The FTP username. If this parameter is not specified, anonymous login is used. |'."\n" + .'|password |string |The FTP password. |.'."\n" + ."\n" + .'- POP3/SMTP.'."\n" + ."\n" + .'|Name |Type |Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |The port number of the POP3 server. Default value for POP3: 110. Default value for POP3s: 995. |'."\n" + .'|username |string |The username for POP3/SMTP. |'."\n" + .'|password |string |The password for POP3/SMTP. |.'."\n" + ."\n" + .'- TCP/UDP.'."\n" + ."\n" + .'|Name |Type |Description |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |The port of the TCP/UDP server. |'."\n" + .'|request_content |string |The request content. If request_format is set to hex, the value of request_content is in hexadecimal compact format. |'."\n" + .'|request_format |string |If request_format is set to other values, request_content is sent to the TCP/UDP server as a plain string. |'."\n" + .'|response_content |string |The response content. If the content returned by the TCP/UDP server does not contain response_content, the monitoring fails.<br>If response_format is set to hex, the value of response_content is in hexadecimal compact format.<br>If response_content is set to other values, response_content is a plain string. |.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-01T07:22:22.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-02-13T09:00:16.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-02-12T07:07:35.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-04T02:58:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-19T07:10:45.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-03T06:48:53.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySiteMonitor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cms:ModifySiteMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"68192f5d-0d45-4b98-9724-892813f86c71\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 1\\n }\\n}","type":"json"}]', ], 'PutContact' => [ - 'summary' => 'Creates or modifies an alert contact.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -35397,97 +24665,62 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ContactName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Alice', - 'docRequired' => true, - ], + 'schema' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Alice', 'title' => ''], ], [ 'name' => 'Describe', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the alert contact.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Instance', - 'docRequired' => true, - ], + 'schema' => ['description' => 'The description of the alert contact.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ECS_Instance', 'title' => ''], ], [ 'name' => 'Channels.SMS', 'in' => 'query', - 'schema' => [ - 'description' => 'The phone number of the alert contact. After you add or modify a phone number, the recipient receives a text message that contains an activation link. The system adds the recipient to the list of alert contacts only after the recipient activates the phone number.'."\n" - ."\n" - .'Specify at least one of the following alert notification methods: email address and DingTalk chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1333333****', - ], + 'schema' => ['description' => 'The phone number of the alert contact. An activation link is sent to the phone number. The alert contact is added only after the link is activated.'."\n" + ."\n" + .'<props="china">Specify at least one of the following contact methods: phone number, email address, DingTalk chatbot, or TradeManager.</props>'."\n" + .'<props="intl">Specify at least one of the following contact methods: email address or DingTalk chatbot.</props>'."\n" + .'<props="partner">Specify at least one of the following contact methods: email address or DingTalk chatbot.</props>.', 'type' => 'string', 'required' => false, 'example' => '1333333****', 'title' => ''], ], [ 'name' => 'Channels.Mail', 'in' => 'query', - 'schema' => [ - 'description' => 'The email address. After you add or modify an email address, the recipient receives an email that contains an activation link. The system adds the recipient to the list of alert contacts only after the recipient activates the email address.'."\n" - ."\n" - .'Specify at least one of the following alert notification methods: email address and DingTalk chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test@aliyun.com', - ], + 'schema' => ['description' => 'The email address of the alert contact. An activation link is sent to the email address. The alert contact is added only after the link is activated.'."\n" + ."\n" + .'<props="china">Specify at least one of the following contact methods: phone number, email address, DingTalk chatbot, or TradeManager.</props>'."\n" + .'<props="intl">Specify at least one of the following contact methods: email address or DingTalk chatbot.</props>'."\n" + .'<props="partner">Specify at least one of the following contact methods: email address or DingTalk chatbot.</props>.', 'type' => 'string', 'required' => false, 'example' => 'test@aliyun.com', 'title' => ''], ], [ 'name' => 'Channels.AliIM', 'in' => 'query', - 'schema' => [ - 'description' => 'The TradeManager ID of the alert contact.'."\n" - ."\n" - .'Specify at least one of the following alert notification methods: email address and DingTalk chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Jim', - ], + 'schema' => ['description' => 'The TradeManager ID of the alert contact.'."\n" + ."\n" + .'<props="china">Specify at least one of the following contact methods: phone number, email address, DingTalk chatbot, or TradeManager.</props>'."\n" + .'<props="intl">Specify at least one of the following contact methods: email address or DingTalk chatbot.</props>'."\n" + .'<props="partner">Specify at least one of the following contact methods: email address or DingTalk chatbot.</props>.', 'type' => 'string', 'required' => false, 'example' => 'Jim', 'title' => ''], ], [ 'name' => 'Channels.DingWebHook', 'in' => 'query', - 'schema' => [ - 'description' => 'The webhook URL of the DingTalk chatbot.'."\n" - ."\n" - .'Specify at least one of the following alert notification methods: email address and DingTalk chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=7d49515e8ebf21106a80a9cc4bb3d247771305d52fb15d6201234565****', - ], + 'schema' => ['description' => 'The webhook URL of the DingTalk chatbot.'."\n" + ."\n" + .'<props="china">Specify at least one of the following contact methods: phone number, email address, DingTalk chatbot, or TradeManager.</props>'."\n" + .'<props="intl">Specify at least one of the following contact methods: email address or DingTalk chatbot.</props>'."\n" + .'<props="partner">Specify at least one of the following contact methods: email address or DingTalk chatbot.</props>.', 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=7d49515e8ebf21106a80a9cc4bb3d247771305d52fb15d6201234565****', 'title' => ''], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language in which the alert information is displayed. Valid values:'."\n" - ."\n" - .'* zh-cn: simplified Chinese'."\n" - .'* en: English'."\n" - ."\n" - .'> If you do not specify this parameter, CloudMonitor identifies the language of the alert information based on the region of your Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh-cn', - ], + 'schema' => ['description' => 'The language in which alert notifications are sent. Valid values:'."\n" + .'- zh-cn: simplified Chinese.'."\n" + .'- en: English.'."\n" + ."\n" + .'> If you do not set this parameter, the language is automatically determined based on the region of the account.', 'type' => 'string', 'required' => false, 'example' => 'zh-cn', 'title' => ''], ], ], 'responses' => [ @@ -35495,136 +24728,104 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The Request is not authorization.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '181C406E-9DE4-484C-9C61-37AE9A1A12EE', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '181C406E-9DE4-484C-9C61-37AE9A1A12EE', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"181C406E-9DE4-484C-9C61-37AE9A1A12EE\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutContactResponse>\\n <Code>200</Code>\\n <RequestId>181C406E-9DE4-484C-9C61-37AE9A1A12EE</RequestId>\\n <Success>true</Success>\\n</PutContactResponse>","errorExample":""}]', - 'title' => 'PutContact', + 'title' => 'Create or modify alert contact information', + 'summary' => 'Calls the PutContact operation to create or modify alert contact information.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutContact'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutContact', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"181C406E-9DE4-484C-9C61-37AE9A1A12EE\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'PutContactGroup' => [ - 'summary' => 'Creates or modifies an alert contact group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Creates or modifies an alert contact group by calling the PutContactGroup operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ContactGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact group.'."\n" - ."\n" - .'For information about how to obtain the name of an alert contact group, see [DescribeContactGroupList](~~114922~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ECS_Group', - ], + 'schema' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'required' => true, 'example' => 'Attendance system group', 'title' => ''], ], [ 'name' => 'Describe', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the alert contact group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS_Alert_Group', - ], + 'schema' => ['description' => 'The description of the alert contact group.', 'type' => 'string', 'required' => false, 'example' => 'Alert test', 'title' => ''], ], [ 'name' => 'EnableSubscribed', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the weekly report subscription feature. Valid values:'."\n" - ."\n" - .'* true: The weekly report subscription feature is enabled.'."\n" - .'* false: The weekly report subscription feature is disabled.'."\n" - ."\n" - .'> You can enable the weekly report subscription feature only for an Alibaba Cloud account that has at least five Elastic Compute Service (ECS) instances.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to enable the subscription feature. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'ContactNames', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the alert contact. Valid values of N: 1 to 100.'."\n", + 'description' => 'The name of the alert contact.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - ], + 'items' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'required' => false, 'example' => 'lucy', 'title' => ''], 'required' => false, - 'example' => 'Alice', 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -35633,4518 +24834,5003 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Illegal parameters.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B4E30DB6-F069-5D0B-A589-2A89F7D62A57', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Illegal parameters.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B4E30DB6-F069-5D0B-A589-2A89F7D62A57', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'InvalidParameterValue', 'errorMessage' => 'Illegal parameters.', 'description' => 'Illegal parameters.'], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'Permission denied', 'description' => 'Permission denied.'], ], [ - [ - 'errorCode' => 'ContactGroup.NotExists', - 'errorMessage' => 'ContactGroup not exists', - ], + ['errorCode' => 'ContactGroup.NotExists', 'errorMessage' => 'ContactGroup not exists', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Create or modify an alert contact group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutContactGroup'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutContactGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Illegal parameters.\\",\\n \\"RequestId\\": \\"B4E30DB6-F069-5D0B-A589-2A89F7D62A57\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'PutContactGroup', - 'description' => 'This topic provides an example on how to create an alert contact group named `ECS_Group`.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'CreateHybridMonitorNamespace' => [ - 'summary' => 'Creates a namespace.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutCustomEvent' => [ + 'summary' => 'Reports custom events.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'EventInfo', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'The name can contain lowercase letters, digits, and hyphens (-).'."\n", - 'type' => 'string', + 'description' => 'The event details.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EventName' => ['description' => 'The event name. Valid values of N: 1 to 50.', 'type' => 'string', 'required' => true, 'example' => 'myEvent', 'title' => ''], + 'Time' => ['description' => 'The time when the event occurred.'."\n" + ."\n" + .'Format: `yyyyMMddTHHmmss.SSSZ`.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You can also specify a UNIX timestamp. Example: 1552199984000. Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '20171013T170923.456+0800', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group. Valid values of N: 1 to 50.'."\n" + ."\n" + .'Default value: 0. This value indicates that the event to be reported does not belong to any application group.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], + 'Content' => ['description' => 'The event content. Valid values of N: 1 to 50.', 'type' => 'string', 'required' => true, 'example' => 'IOException', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'aliyun', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + 'maxItems' => 50, + 'title' => '', 'example' => '', ], ], - [ - 'name' => 'Spec', - 'in' => 'query', - 'schema' => [ - 'description' => 'The data retention period. Valid values:'."\n" - ."\n" - .'* cms.s1.large (Retention Period 15 Days)'."\n" - .'* cms.s1.xlarge (Retention Period 32 Days)'."\n" - .'* cms.s1.2xlarge (Retention Period 63 Days)'."\n" - .'* cms.s1.3xlarge (Retention Period 93 Days) (default)'."\n" - .'* cms.s1.6xlarge (Retention Period 185 Days)'."\n" - .'* cms.s1.12xlarge (Retention Period 367 Days)'."\n" - ."\n" - .'For information about the pricing for different retention periods, see the **Pricing** section in [Billing of the dashboard feature](~~223532~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'cms.s1.large' => 'cms.s1.large', - 'cms.s1.2xlarge' => 'cms.s1.2xlarge', - 'cms.s1.xlarge' => 'cms.s1.xlarge', - 'cms.s1.6xlarge' => 'cms.s1.6xlarge', - 'cms.s1.3xlarge' => 'cms.s1.3xlarge', - ], - 'example' => 'cms.s1.3xlarge', - 'enum' => [], - ], - ], - [ - 'name' => 'NamespaceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The storage scheme of metric data. Valid values:'."\n" - ."\n" - .'* m_prom_user: The metric data is stored in Simple Log Service.'."\n" - .'* m_prom_pool: The metric data is stored in the private storage space provided by CloudMonitor.'."\n" - ."\n" - .'> For more information about the storage schemes of metric data, see [Data storage schemes for Hybrid Cloud Monitoring](~~2594921~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm_prometheus', - ], - ], - [ - 'name' => 'NamespaceRegion', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region where the metric data is stored.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'Namespace.Existed', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3843D23A-FB9E-5DC8-BCCC-458768B79296', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The responses code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '131DD9C8-9A32-4428-AD2E-4E3013B6E3A7', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'PutCustomEvent', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomEvent'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutCustomEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Namespace.Existed\\",\\n \\"RequestId\\": \\"3843D23A-FB9E-5DC8-BCCC-458768B79296\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateHybridMonitorNamespace>\\r\\n\\t<RequestId>3843D23A-FB9E-5DC8-BCCC-458768B79296</RequestId>\\r\\n\\t<Code>Success</Code>\\r\\n\\t<Success>true</Success>\\r\\n</CreateHybridMonitorNamespace>\\t","errorExample":""}]', - 'title' => 'CreateHybridMonitorNamespace', - 'description' => '## [](#)Prerequisites'."\n" - ."\n" - .'Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" - ."\n" - .'## [](#)Operation description'."\n" - ."\n" - .'This topic provides an example on how to create a namespace named `aliyun`. In this example, the data retention period of the namespace is set to `cms.s1.3xlarge`. The returned result indicates that the namespace is created.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"131DD9C8-9A32-4428-AD2E-4E3013B6E3A7\\"\\n}","type":"json"}]', ], - 'ModifyHybridMonitorNamespace' => [ - 'summary' => 'Modifies a namespace.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutCustomEventRule' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'The name can contain letters, digits, and hyphens (-).'."\n" - ."\n" - .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun', - ], + 'schema' => ['description' => 'The ID of the application group. For information about how to obtain the ID, see [DescribeCustomEventAttribute](~~115262~~).'."\n" + ."\n" + .'> A value of 0 indicates that the reported custom event does not belong to any application group.', 'type' => 'string', 'required' => true, 'example' => '7378****', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'> If the alert rule ID already exists, the alert rule is modified. If the alert rule ID does not exist, an alert rule is created.', 'type' => 'string', 'required' => true, 'example' => 'CustomRuleId1', 'title' => ''], ], [ - 'name' => 'Spec', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The data retention period. Valid values:'."\n" - ."\n" - .'* cms.s1.large: Data is stored for 15 days.'."\n" - .'* cms.s1.xlarge: Data is stored for 32 days.'."\n" - .'* cms.s1.2xlarge: Data is stored for 63 days.'."\n" - .'* cms.s1.3xlarge: Data is stored for 93 days.'."\n" - .'* cms.s1.6xlarge: Data is stored for 185 days.'."\n" - .'* cms.s1.12xlarge: Data is stored for 376 days.'."\n" - ."\n" - .'For information about the pricing for different retention periods, see the **Pricing** section in [Billing of the dashboard feature](~~223532~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'cms.s1.12xlarge' => 'cms.s1.12xlarge', - 'cms.s1.large' => 'cms.s1.large', - 'cms.s1.2xlarge' => 'cms.s1.2xlarge', - 'cms.s1.6xlarge' => 'cms.s1.6xlarge', - 'cms.s1.3xlarge' => 'cms.s1.3xlarge', - ], - 'example' => 'cms.s1.2xlarge', - 'enum' => [], - ], + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'CustomeRule', 'title' => ''], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the custom event. For information about how to obtain the name, see [DescribeCustomEventAttribute](~~115262~~).', 'type' => 'string', 'required' => true, 'example' => 'HostDown', 'title' => ''], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => ['description' => 'The alert contact group. Separate multiple contact groups with commas (,).', 'type' => 'string', 'required' => true, 'example' => 'ECS_Group', 'title' => ''], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => ['description' => 'The callback URL to which a POST request is sent when an alert is triggered.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], + ], + [ + 'name' => 'EffectiveInterval', + 'in' => 'query', + 'schema' => ['description' => 'The time period during which the alert rule is effective. Valid values: 00:00-23:59.', 'type' => 'string', 'required' => false, 'example' => '00:00-23:59', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The aggregation period of the monitoring data for the custom event. Unit: seconds. The value must be 60 or a multiple of 60. Default value: 300.', 'type' => 'string', 'required' => false, 'default' => '300', 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'EmailSubject', + 'in' => 'query', + 'schema' => ['description' => 'The subject of the alert email.', 'type' => 'string', 'required' => false, 'example' => 'ECS instance', 'title' => ''], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The alert threshold.', 'type' => 'string', 'required' => true, 'example' => '99', 'title' => ''], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => 'The alert level. Valid values:'."\n" + .'- CRITICAL'."\n" + .'- WARN'."\n" + .'- INFO', 'type' => 'string', 'required' => true, 'example' => 'CRITICAL', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => '%s', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E190AB2E-7BF9-59B7-9DDC-7CB1782C5ECD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates that the call was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request has failed due to a temporary failure of the server.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'AD5DCD82-BD1C-405F-BAED-32302DE9F498', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 499 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Create an alert rule for a custom event', + 'summary' => 'Calls the PutCustomEventRule operation to create an alert rule for a custom event.', + 'description' => 'Before you call this operation, you must call the PutCustomEvent operation to report the monitoring data of the custom event. For more information, see [PutCustomEvent](~~115012~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomEventRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutCustomEventRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"%s\\",\\n \\"RequestId\\": \\"E190AB2E-7BF9-59B7-9DDC-7CB1782C5ECD\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyHybridMonitorNamespace>\\r\\n\\t<RequestId>E190AB2E-7BF9-59B7-9DDC-7CB1782C5ECD</RequestId>\\r\\n\\t<Code>Success</Code>\\r\\n\\t<Success>true</Success>\\r\\n</ModifyHybridMonitorNamespace>\\t","errorExample":""}]', - 'title' => 'ModifyHybridMonitorNamespace', - 'description' => 'This topic provides an example on how to change the data retention period of the `aliyun` namespace to `cms.s1.2xlarge`. The response shows that the namespace is modified.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"RequestId\\": \\"AD5DCD82-BD1C-405F-BAED-32302DE9F498\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DeleteHybridMonitorNamespace' => [ - 'summary' => 'Deletes a namespace.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutCustomMetric' => [ + 'summary' => 'Calls the PutCustomMetric operation to report custom monitoring data.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'MetricList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', + 'description' => 'The list of monitoring data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the reported value. Valid values of N: 1 to 21. Valid values:'."\n" + ."\n" + .'- 0: raw data.'."\n" + .'- 1: aggregate data.'."\n" + ."\n" + .'> When you report aggregate data, we recommend that you report both data with a period of 60 seconds and data with a period of 300 seconds. Otherwise, monitoring data cannot be queried for a time span of more than 7 days.', 'type' => 'string', 'required' => true, 'example' => '0', 'title' => ''], + 'MetricName' => ['description' => 'The name of the metric. Valid values of N: 1 to 21. For more information, see [Metrics of cloud services](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_total', 'title' => ''], + 'Time' => ['description' => 'The time when the metric occurred. Valid values of N: 1 to 21. The following two types of values are supported:'."\n" + .'- UTC time. Format: YYYY-MM-DDThh:mm:ssZ. For example: 20171012T132456.888+0800.'."\n" + .'- A Long-type timestamp. For example: 1508136760000.'."\n", 'type' => 'string', 'required' => false, 'example' => '1508136760000', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the application group. Valid values of N: 1 to 21.'."\n" + ."\n" + .'> If the metric does not belong to any application group, enter 0.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + 'Values' => ['description' => 'The collection of metric values. Valid values of N: 1 to 21.'."\n" + ."\n" + .'> If the type of the reported value is 0, the raw values are reported. CloudMonitor aggregates raw values into multiple values, such as maximum, count, and sum, by period.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"value":10.5}', 'title' => ''], + 'Dimensions' => ['description' => 'The dimension map, which is used to query monitoring data of a specified resource. Valid values of N: 1 to 21.'."\n" + ."\n" + .'Format: a collection of key-value pairs. A commonly used key-value pair collection is: `{"Key":"Value"}`.'."\n" + ."\n" + .'The length of Key and Value is 1 to 64 characters. Characters beyond the first 64 are truncated.'."\n" + ."\n" + .'The values of Key and Value can contain letters, digits, periods (.), hyphens (-), underscores (_), forward slashes (/), and backslashes (\\).'."\n" + ."\n" + .'> Dimensions must be passed in as a JSON string that represents the map object, and must be passed in order. ', 'type' => 'string', 'required' => true, 'example' => '{"sampleName1":"value1","sampleName2":"value2"}', 'title' => ''], + 'Period' => ['description' => 'The aggregation period. Valid values of N: 1 to 21. Unit: seconds. Valid values: 60 and 300.'."\n" + ."\n" + .'> If the type of the reported value is 1, you must set this parameter.', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'aliyun', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Namespace.NotFound', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3843D23A-FB9E-5DC8-BCCC-458768B79296', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request has failed due to a temporary failure of the server.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Report custom monitoring data', + 'description' => '> We recommend that you use the [PutHybridMonitorMetricData](~~383455~~) operation in Enterprise CloudMonitor.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomMetric'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutCustomMetric', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Namespace.NotFound\\",\\n \\"RequestId\\": \\"3843D23A-FB9E-5DC8-BCCC-458768B79296\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteHybridMonitorNamespace>\\r\\n\\t<RequestId>3843D23A-FB9E-5DC8-BCCC-458768B79296</RequestId>\\r\\n\\t<Code>Success</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DeleteHybridMonitorNamespace>\\t","errorExample":""}]', - 'title' => 'DeleteHybridMonitorNamespace', - 'description' => '> If a metric import task is created for metrics in a namespace, you cannot delete the namespace unless you delete the task first.'."\n" - ."\n" - .'This topic provides an example on how to delete a namespace named `aliyun`. The response shows that the namespace is deleted.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"RequestId\\": \\"05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0\\"\\n}","type":"json"}]', ], - 'DescribeHybridMonitorNamespaceList' => [ - 'summary' => 'Queries namespaces and the details of the related metric import tasks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutCustomMetricRule' => [ + 'summary' => 'Creates an alert rule for custom monitoring.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Page numbers start from 1. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the application group to which the custom monitoring data belongs.'."\n" + ."\n" + .'> A value of 0 indicates that the reported custom monitoring data does not belong to any application group.', 'type' => 'string', 'required' => false, 'example' => '7378****', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Page numbers start from 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'> If the alert rule ID already exists, the alert rule is modified. If the alert rule ID does not exist, an alert rule is created.', 'type' => 'string', 'required' => true, 'example' => 'MyRuleId1', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The search keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'aliyun', - ], + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'CpuUsage', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'The name can contain letters, digits, and hyphens (-).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'aliyun-test', - ], + 'schema' => ['description' => 'The name of the metric.'."\n" + ."\n" + .'> For information about how to obtain the metric name, see [DescribeCustomMetricList](~~115005~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_total', 'title' => ''], ], [ - 'name' => 'ShowTaskStatistic', + 'name' => 'Resources', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return the configuration details of metric import tasks for Alibaba Cloud services and the number of metric import tasks for third-party services. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false (default)'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The custom monitoring data to which the alert rule applies. The value consists of the application group ID to which the custom monitoring data belongs and the dimensions of the metric.', 'type' => 'string', 'required' => true, 'example' => '[{"groupId":7378****,"dimension":"instanceId=i-hp3543t5e4sudb3s****"}]', 'title' => ''], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => ['description' => 'The alert contact group. Separate multiple alert contact groups with commas (,).', 'type' => 'string', 'required' => true, 'example' => 'ECS_Group', 'title' => ''], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => ['description' => 'The webhook URL that is called when an alert is triggered. A POST request is sent to this URL.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], + ], + [ + 'name' => 'EffectiveInterval', + 'in' => 'query', + 'schema' => ['description' => 'The time range during which the alert rule is effective. Valid values: 00:00-23:59.', 'type' => 'string', 'required' => false, 'example' => '00:00-23:59', 'title' => ''], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => ['description' => 'The mute for period. Unit: seconds. Default value: 86400 (1 day).'."\n" + ."\n" + .'> If monitoring data continuously exceeds the alert rule threshold, only one alert notification is sent within each mute for period.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '86400', 'example' => '86400', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The aggregation period of the custom monitoring data. Unit: seconds. The value must be 60 or a multiple of 60. Default value: the original reporting period of the custom monitoring data.', 'type' => 'string', 'required' => false, 'default' => '300', 'example' => '300', 'title' => ''], + ], + [ + 'name' => 'EmailSubject', + 'in' => 'query', + 'schema' => ['description' => 'The subject of the alert email.', 'type' => 'string', 'required' => false, 'example' => 'ECS instance', 'title' => ''], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The alert threshold.', 'type' => 'string', 'required' => true, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => ['description' => 'The severity level of the alert. Valid values:'."\n" + .'- CRITICAL: critical.'."\n" + .'- WARN: warning.'."\n" + .'- INFO: information.', 'type' => 'string', 'required' => true, 'example' => 'CRITICAL', 'title' => ''], + ], + [ + 'name' => 'EvaluationCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of retries for the alert.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Statistics', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method for the alert.', 'type' => 'string', 'required' => true, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for the threshold. Valid values:'."\n" + ."\n" + .'- `>=`'."\n" + ."\n" + .'- `=`'."\n" + ."\n" + .'- `<=`'."\n" + ."\n" + .'- `>`'."\n" + ."\n" + .'- `<`'."\n" + ."\n" + .'- `!=`.', 'type' => 'string', 'required' => true, 'example' => '>=', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1EC450A4-3221-5148-B77E-2827576CFE48', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Specified parameter PageSize is not valid.', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DescribeHybridMonitorNamespace' => [ - 'description' => 'The details of the namespaces.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'example' => 'aliyun-test', - ], - 'CreateTime' => [ - 'description' => 'The timestamp that was generated when the namespace was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1652682744000', - ], - 'Namespace' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'aliyun-test', - ], - 'IsDelete' => [ - 'description' => 'Indicates whether the namespace is deleted. Valid values:'."\n" - ."\n" - .'* 0: The namespace is not deleted.'."\n" - .'* 1: The namespace is deleted.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Id' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'example' => '3****', - ], - 'ModifyTime' => [ - 'description' => 'The timestamp that was generated when the namespace was last modified.'."\n", - 'type' => 'string', - 'example' => '1652682744000', - ], - 'Detail' => [ - 'description' => 'The details of the data retention period.'."\n", - 'type' => 'object', - 'properties' => [ - 'Spec' => [ - 'description' => 'The data retention period. Valid values:'."\n" - ."\n" - .'* cms.s1.large (Retention Period 15 Days)'."\n" - .'* cms.s1.xlarge (Retention Period 32 Days)'."\n" - .'* cms.s1.2xlarge (Retention Period 63 Days)'."\n" - .'* cms.s1.3xlarge (Retention Period 93 Days)'."\n" - .'* cms.s1.6xlarge (Retention Period 185 Days)'."\n" - .'* cms.s1.12xlarge (Retention Period 367 Days)'."\n", - 'type' => 'string', - 'example' => 'cms.s1.3xlarge', - ], - 'NamespaceRegion' => [ - 'description' => 'The region where the metric data is stored.'."\n" - ."\n" - .'> This parameter is returned if you select `m_prom_user` for `NamespaceType` when you create a namespace.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'SLSProject' => [ - 'description' => 'The project where the metric data is located.'."\n" - ."\n" - .'> This parameter is returned if you select `m_prom_user` for `NamespaceType` when you create a namespace.'."\n", - 'type' => 'string', - 'example' => 'cms-hybrid-120886317861****-cn-hangzhou-a83d', - ], - 'PrometheusInstanceId' => [ - 'type' => 'string', - ], - ], - ], - 'NotAliyunTaskNumber' => [ - 'description' => 'The number of metric import tasks for third-party services.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AliyunProductMetricList' => [ - 'description' => 'The configuration details of metric import tasks for Alibaba Cloud services.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'description' => 'The account that is used to create the namespace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120886317861****', - ], - 'NamespaceList' => [ - 'description' => 'The namespaces.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Namespace' => [ - 'description' => 'The namespace for the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'example' => 'acs_ecs_dashboard', - ], - 'MetricList' => [ - 'description' => 'The metrics for the Alibaba Cloud service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Period' => [ - 'description' => 'The collection period of the metric.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'List' => [ - 'description' => 'The metrics.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The metric.'."\n", - 'type' => 'string', - 'example' => '["cpu_total"]', - ], - ], - ], - ], - ], - ], - ], - ], - 'YAMLConfig' => [ - 'description' => 'The configuration file of the Alibaba Cloud service that you want to monitor by using Hybrid Cloud Monitoring.'."\n" - ."\n" - .'* namespace: the namespace of the Alibaba Cloud service.'."\n" - .'* metric_list: the metrics of the Alibaba Cloud service.'."\n" - .'* dimension: the resources of the Alibaba Cloud service that you want to monitor by using Hybrid Cloud Monitoring. If you do not specify a dimension, all resources of the Alibaba Cloud service are monitored.'."\n", - 'type' => 'string', - 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: \'\'', - ], - ], - ], - ], - 'NamespaceType' => [ - 'description' => 'The storage scheme of metric data. Valid values:'."\n" - ."\n" - .'* m_prom_user: The metric data is stored in Simple Log Service.'."\n" - .'* m_prom_pool: The metric data is stored in the storage space provided by CloudMonitor.'."\n", - 'type' => 'string', - 'example' => 'm_prom_user', - ], - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. If the call is successful, this parameter is empty. If the call fails, the error message is returned.', 'type' => 'string', 'example' => 'ComparisonOperator is mandatory for this action.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '65D50468-ECEF-48F1-A6E1-D952E89D9432', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'- true: successful.'."\n" + ."\n" + .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => 'Resources already exist.', - ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + 499 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Create a custom monitoring alert rule', + 'description' => 'Before calling this operation, call the PutCustomMetric operation to report custom monitoring data. For more information, see [PutCustomMetric](~~115004~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomMetricRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutCustomMetricRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1EC450A4-3221-5148-B77E-2827576CFE48\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Specified parameter PageSize is not valid.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 1,\\n \\"DescribeHybridMonitorNamespace\\": [\\n {\\n \\"Description\\": \\"aliyun-test\\",\\n \\"CreateTime\\": \\"1652682744000\\",\\n \\"Namespace\\": \\"aliyun-test\\",\\n \\"IsDelete\\": 0,\\n \\"Id\\": \\"3****\\",\\n \\"ModifyTime\\": \\"1652682744000\\",\\n \\"Detail\\": {\\n \\"Spec\\": \\"cms.s1.3xlarge\\",\\n \\"NamespaceRegion\\": \\"cn-hangzhou\\",\\n \\"SLSProject\\": \\"cms-hybrid-120886317861****-cn-hangzhou-a83d\\",\\n \\"PrometheusInstanceId\\": \\"rw-57******************7f\\"\\n },\\n \\"NotAliyunTaskNumber\\": 0,\\n \\"AliyunProductMetricList\\": [\\n {\\n \\"UserId\\": 0,\\n \\"NamespaceList\\": [\\n {\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"MetricList\\": [\\n {\\n \\"Period\\": 60,\\n \\"List\\": [\\n \\"[\\\\\\"cpu_total\\\\\\"]\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"YAMLConfig\\": \\"products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: \'\'\\"\\n }\\n ],\\n \\"NamespaceType\\": \\"aliyun_prometheus\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeHybridMonitorNamespaceListResponse>\\r\\n\\t<RequestId>1EC450A4-3221-5148-B77E-2827576CFE48</RequestId>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<Total>1</Total>\\r\\n\\t<DescribeHybridMonitorNamespace>\\r\\n\\t\\t<ModifyTime>1652682744000</ModifyTime>\\r\\n\\t\\t<Description></Description>\\r\\n\\t\\t<CreateTime>1652682744000</CreateTime>\\r\\n\\t\\t<IsDelete>0</IsDelete>\\r\\n\\t\\t<Id>3****</Id>\\r\\n\\t\\t<Namespace>aliyun-test</Namespace>\\r\\n\\t\\t<Detail>\\r\\n\\t\\t\\t<Spec>cms.s1.3xlarge</Spec>\\r\\n\\t\\t</Detail>\\r\\n\\t</DescribeHybridMonitorNamespace>\\r\\n\\t<Code>Success</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeHybridMonitorNamespaceListResponse>\\t","errorExample":""}]', - 'title' => 'DescribeHybridMonitorNamespaceList', - 'description' => 'In this example, all namespaces within the current account are queried. The response shows that the current account has only one namespace named `aliyun-test`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"ComparisonOperator is mandatory for this action.\\",\\n \\"RequestId\\": \\"65D50468-ECEF-48F1-A6E1-D952E89D9432\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'CreateHybridMonitorTask' => [ - 'summary' => 'Creates a metric import task for an Alibaba Cloud service or creates a metric for logs imported from Simple Log Service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutEventRule' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'aliyun', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the metric import task.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], - ], - [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric import task.'."\n" - ."\n" - .'* If the `TaskType` parameter is set to `aliyun_fc`, enter the name of the metric import task.'."\n" - .'* If the `TaskType` parameter is set to `aliyun_sls`, enter the name of the metric for logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'aliyun_task', - ], - ], - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the metric import task. Valid values:'."\n" - ."\n" - .'* aliyun_fc: metric import tasks for Alibaba Cloud services.'."\n" - .'* aliyun_sls: metrics for logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'aliyun_fc' => 'aliyun_fc', - 'aliyun_sls' => 'aliyun_sls', - ], - 'example' => 'aliyun_fc', - ], - ], - [ - 'name' => 'CollectTargetType', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the collection target.'."\n" - ."\n" - .'* If the `TaskType` parameter is set to `aliyun_fc`, enter `aliyun_fc`.'."\n" - .'* If the `TaskType` parameter is set to `aliyun_sls`, enter the name of the Logstore group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun_fc', - ], + 'schema' => ['description' => 'The name of the Event-triggered Alert Rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'myRuleName', 'title' => ''], ], [ - 'name' => 'CollectInterval', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The collection period of the metric. Valid values:'."\n" - ."\n" - .'* 15'."\n" - .'* 60 (default)'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'> This parameter is required only if the `TaskType` parameter is set to `aliyun_sls`.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 15 => '15', - 60 => '60', - ], - 'example' => '60', - ], + 'schema' => ['description' => 'The ID of the application group to which the Event-triggered Alert Rule belongs.', 'type' => 'string', 'required' => false, 'example' => '7378****', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'EventType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the application group.'."\n" + 'description' => 'The type of the Event-triggered Alert Rule. Valid values:'."\n" ."\n" - .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n" - ."\n" - .'> This parameter is required only if the `TaskType` parameter is set to `aliyun_sls`.'."\n", + .'- SYSTEM: system event.'."\n" + .'- CUSTOM: custom event.', 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => '3607****', + 'default' => 'SYSTEM', + 'enum' => ['SYSTEM', 'CUSTOM'], + 'example' => 'SYSTEM', + 'title' => '', ], ], [ - 'name' => 'YARMConfig', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration file of the Alibaba Cloud service that you want to monitor by using Hybrid Cloud Monitoring.'."\n" - ."\n" - .'* namespace: the namespace of the Alibaba Cloud service. For information about how to query the namespace of an Alibaba Cloud service, see [DescribeMetricMetaList](~~98846~~).'."\n" - .'* metric_list: the metrics of the Alibaba Cloud service. For information about how to query the metrics of an Alibaba Cloud service, see [DescribeMetricMetaList](~~98846~~).'."\n" - ."\n" - .'The following code shows a sample configuration file:'."\n" - ."\n" - .' products:'."\n" - .' - namespace: acs_ecs_dashboard'."\n" - .' metric_info:'."\n" - .' - metric_list:'."\n" - .' - cpu_total'."\n" - .' - cpu_idle'."\n" - .' - diskusage_utilization'."\n" - .' - CPUUtilization'."\n" - .' - DiskReadBPS'."\n" - .' - InternetOut'."\n" - .' - IntranetOut'."\n" - .' - cpu_system'."\n" - .' - namespace: acs_rds_dashboard'."\n" - .' metric_info:'."\n" - .' - metric_list:'."\n" - .' - MySQL_QPS'."\n" - .' - MySQL_TPS'."\n" - ."\n" - .'> This parameter is required only if the `TaskType` parameter is set to `aliyun_fc`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total', - ], + 'schema' => ['description' => 'The description of the Event-triggered Alert Rule.', 'type' => 'string', 'required' => false, 'example' => 'Event alert test', 'title' => ''], ], [ - 'name' => 'TargetUserId', + 'name' => 'State', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the member account.'."\n" - ."\n" - .'If you call this operation by using the management account of a resource directory, you can connect the Alibaba Cloud services that are activated for all members in the resource directory to Hybrid Cloud Monitoring. You can use the resource directory to monitor Alibaba Cloud services across enterprise accounts.'."\n" + 'description' => 'The status of the Event-triggered Alert Rule. Valid values:'."\n" ."\n" - .'> This parameter is required only if the `TaskType` parameter is set to `aliyun_fc`.'."\n", + .'- ENABLED: enabled.'."\n" + .'- DISABLED: disabled.', 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => '120886317861****', + 'default' => 'ENABLED', + 'enum' => ['ENABLED', 'DISABLED'], + 'example' => 'ENABLED', + 'title' => '', ], ], [ - 'name' => 'AttachLabels', + 'name' => 'EventPattern', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags of the metric.'."\n" - ."\n" - .'> This parameter is required only if the `TaskType` parameter is set to `aliyun_sls`.'."\n", + 'description' => 'The pattern of the Event-triggered Alert Rule.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'description' => 'The tag value of the metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testValue', - ], - 'Name' => [ - 'description' => 'The tag key of the metric.'."\n", - 'type' => 'string', + 'EventTypeList' => [ + 'description' => 'The type of the Event-triggered Alert Rule. Valid values of N: 1 to 50. Valid values:'."\n" + ."\n" + .'- StatusNotification: fault notification.'."\n" + ."\n" + .'- Exception: exception.'."\n" + ."\n" + .'- Maintenance: O&M.'."\n" + ."\n" + .'- \\*: unlimited.', + 'type' => 'array', + 'items' => ['description' => 'The type of the Event-triggered Alert Rule. Valid values of N: 1 to 50. Valid values:'."\n" + ."\n" + .'- StatusNotification: fault notification.'."\n" + ."\n" + .'- Exception: exception.'."\n" + ."\n" + .'- Maintenance: O&M.'."\n" + ."\n" + .'- \\*: unlimited.', 'type' => 'string', 'required' => false, 'example' => 'Exception', 'title' => ''], 'required' => false, - 'example' => 'app_service', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'TargetUserIdList', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the member accounts. Separate multiple member account IDs with commas (,).'."\n" - ."\n" - .'> This parameter is required only if you call this operation by using the management account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '120886317861****', - ], - ], - [ - 'name' => 'SLSProcessConfig', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => 'The configurations of the logs that are imported from Simple Log Service.'."\n" - ."\n" - .'> This parameter is required only if the `TaskType` parameter is set to `aliyun_sls`.'."\n", - 'type' => 'object', - 'properties' => [ - 'Filter' => [ - 'description' => 'The conditions that are used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'object', - 'properties' => [ - 'Relation' => [ - 'description' => 'The relationship between multiple filter conditions. Valid values:'."\n" - ."\n" - .'* and (default): Logs are processed only if all filter conditions are met.'."\n" - .'* or: Logs are processed if one of the filter conditions is met.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'or' => 'or', - 'and' => 'and', - ], - 'example' => 'and', - ], - 'Filters' => [ - 'description' => 'The conditions that are used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'code', - ], - 'Operator' => [ - 'description' => 'The method that is used to filter logs imported from Simple Log Service. Valid values:'."\n" - ."\n" - .'* `contain`: contains'."\n" - .'* `notContain`: does not contain'."\n" - .'* `>`: greater than'."\n" - .'* `<`: less than'."\n" - .'* `=`: equal to'."\n" - .'* `! =`: not equal to'."\n" - .'* `>=`: greater than or equal to'."\n" - .'* `<=`: less than or equal to'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '=', - 'enum' => [ - '>', - '>=', - '=', - '<=', - '<', - '!=', - 'contain', - 'notContain', - ], - ], - 'Value' => [ - 'description' => 'The value of the key that is used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'example' => 'Exception', + 'maxItems' => 5, + 'title' => '', ], - 'required' => false, - ], - 'Statistics' => [ - 'description' => 'The method that is used to aggregate logs imported from Simple Log Service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to aggregate logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'Function' => [ - 'description' => 'The function that is used to aggregate the log data of a statistical period. Valid values:'."\n" - ."\n" - .'* count: counts the number.'."\n" - .'* sum: calculates the total value.'."\n" - .'* avg: calculates the average value.'."\n" - .'* max: calculates the maximum value.'."\n" - .'* min: calculates the minimum value.'."\n" - .'* value: collects samples within the statistical period.'."\n" - .'* countps: calculates the number of values of the specified field divided by the total number of seconds within a statistical period.'."\n" - .'* sumps: calculates the sum of the values of the specified field divided by the total number of seconds within a statistical period.'."\n" - .'* distinct: calculates the number of unique values of the specified field within a statistical period.'."\n" - .'* distribution: calculates the number of logs that meet a specified condition within the statistical period.'."\n" - .'* percentile: sorts the values of the specified field in ascending order, and then returns the value that is at the specified percentile within the statistical period. Example: P50.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'count', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregation result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'level_count', - 'minLength' => 0, - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', - ], - 'Parameter1' => [ - 'description' => 'The value of the function that is used to aggregate logs imported from Simple Log Service.'."\n" - ."\n" - .'* If the `Function` parameter is set to `distribution`, this parameter specifies the lower limit of the statistical interval. For example, if you want to calculate the number of HTTP requests whose status code is 2XX, set this parameter to 200.'."\n" - .'* If the `Function` parameter is set to `percentile`, this parameter specifies the percentile at which the expected value is. For example, 0.5 specifies P50.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - ], - 'Parameter2' => [ - 'description' => 'The value of the function that is used to aggregate logs imported from Simple Log Service.'."\n" - ."\n" - .'> This parameter is required only if the `Function` parameter is set to `distribution`. This parameter specifies the upper limit of the statistical interval. For example, if you want to calculate the number of HTTP requests whose status code is 2XX, set this parameter to 299.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '299', - ], - ], + 'StatusList' => [ + 'description' => 'The status of the Event-triggered Alert Rule. Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => ['description' => 'The status of the Event-triggered Alert Rule. Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => 'Failed', 'title' => ''], 'required' => false, + 'example' => 'Failed', + 'maxItems' => 5, + 'title' => '', ], - 'required' => false, - ], - 'GroupBy' => [ - 'description' => 'The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to aggregate logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'code', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregation result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ApiResult', - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', - ], - ], + 'Product' => ['description' => 'The Alibaba Cloud service type. Valid values of N: 1 to 50.'."\n" + ."\n" + .'>For information about the Alibaba Cloud services supported by Event-triggered Alert Rules, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + 'LevelList' => [ + 'description' => 'The level of the Event-triggered Alert Rule. Valid values of N: 1 to 50. Valid values:'."\n" + ."\n" + .'- CRITICAL: critical.'."\n" + ."\n" + .'- WARN: warning.'."\n" + ."\n" + .'- INFO: information.'."\n" + ."\n" + .'- \\*: all levels.', + 'type' => 'array', + 'items' => ['description' => 'The level of the Event-triggered Alert Rule. Valid values of N: 1 to 50. Valid values:'."\n" + ."\n" + .'- CRITICAL: critical.'."\n" + ."\n" + .'- WARN: warning.'."\n" + ."\n" + .'- INFO: information.'."\n" + ."\n" + .'- \\*: all levels.', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL', 'title' => ''], 'required' => false, + 'example' => 'CRITICAL', + 'maxItems' => 5, + 'title' => '', ], - 'required' => false, - ], - 'Express' => [ - 'description' => 'The extended fields that specify the results of basic operations performed on aggregation results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Express' => [ - 'description' => 'The extended field that specifies the result of basic operations performed on aggregation results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'success_count', - ], - 'Alias' => [ - 'description' => 'The alias of the extended field that specifies the result of basic operations performed on aggregation results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SuccRate', - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', - ], - ], + 'NameList' => [ + 'description' => 'The name of the Event-triggered Alert Rule. Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => ['description' => 'The name of the Event-triggered Alert Rule. Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => 'Agent_Status_Stopped', 'title' => ''], 'required' => false, + 'example' => 'Agent_Status_Stopped', + 'maxItems' => 20, + 'title' => '', ], - 'required' => false, + 'CustomFilters' => ['description' => 'The keyword for event filtering. When the event content contains this keyword, an alert is automatically triggered.', 'type' => 'string', 'required' => false, 'example' => 'Stopping', 'title' => ''], + 'SQLFilter' => ['description' => 'The SQL filter for events. When the event content meets the SQL condition, an alert is automatically triggered.'."\n" + .'> The syntax of the SQL event filter is consistent with the query syntax of Simple Log Service (SLS).', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX and Executed', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, + 'required' => true, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CloudAccessId', + 'name' => 'SilenceTime', 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'maxItems' => 50, - 'minItems' => 1, - ], + 'schema' => ['description' => 'The mute period. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '86400', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'yamlConfigFail', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '28CEA2E0-3E90-51B2-A7E8-B1ED75534E49', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'TaskId' => [ - 'description' => 'The ID of the monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '36****', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'>A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'Data' => ['description' => 'The number of rows affected when the Event-triggered Alert Rule is created or modified.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0B47C47B-E68A-4429-BB23-370E91889C7D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"yamlConfigFail\\",\\n \\"RequestId\\": \\"28CEA2E0-3E90-51B2-A7E8-B1ED75534E49\\",\\n \\"Success\\": \\"true\\",\\n \\"TaskId\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CreateHybridMonitorTaskResponse>\\n\\t<TaskId>36****</TaskId>\\n\\t<RequestId>28CEA2E0-3E90-51B2-A7E8-B1ED75534E49</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</CreateHybridMonitorTaskResponse>\\t","errorExample":""}]', - 'title' => 'CreateHybridMonitorTask', - 'description' => '# [](#)Prerequisites'."\n" - ."\n" - .'* Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" - .'* If you want to create a metric for logs imported from Simple Log Service, make sure that you have activated Simple Log Service and created a project and a Logstore. For more information, see [Getting Started](~~54604~~).'."\n" - ."\n" - .'# [](#)Description'."\n" + 'title' => 'Create or modify an event-based alert rule', + 'summary' => 'Creates or modifies an event-based alert rule by calling the PutEventRule operation.', + 'description' => 'If the Event-triggered Alert Rule name does not exist, a new alert rule is created. If the Event-triggered Alert Rule name already exists, the existing alert rule is modified.'."\n" ."\n" - .'This topic provides an example on how to create a metric import task named `aliyun_task` for Elastic Compute Service (ECS). The task imports the `cpu_total` metric to the `aliyun` namespace. The response shows that the metric import task is created.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'ModifyHybridMonitorTask' => [ - 'summary' => 'Modifies a metric for the logs that are imported from Log Service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + .'This topic provides an example of how to create an event-based alert rule named `myRuleName` for the Alibaba Cloud service `ecs`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-12-24T03:35:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-24T03:35:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-24T03:35:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-24T03:35:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-03T08:36:44.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutEventRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutEventRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"Data\\": \\"1\\",\\n \\"RequestId\\": \\"0B47C47B-E68A-4429-BB23-370E91889C7D\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'PutEventRuleTargets' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'RuleName', 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testEventRule', 'title' => ''], + ], + [ + 'name' => 'FcParameters', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the metric import task.'."\n" - ."\n" - .'For information about how to obtain the ID of a metric import task, see [DescribeHybridMonitorTaskList](~~428624~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '36****', + 'description' => 'The Function Compute notification method.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'FunctionName' => ['description' => 'The name of the function. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'fc-test', 'title' => ''], + 'Region' => ['description' => 'The region where the Function Compute service resides. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'ServiceName' => ['description' => 'The service name of the Function Compute service. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'fc-test', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the rule target. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TaskName', + 'name' => 'ContactParameters', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the metric import task.'."\n" - ."\n" - .'For information about how to obtain the ID of a metric import task, see [DescribeHybridMonitorTaskList](~~428624~~).'."\n", - 'type' => 'string', + 'description' => 'The alert contact group notification method.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'ContactGroupName' => ['description' => 'The name of the alert contact group. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'Default alert contact group', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the rule target. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + 'Level' => ['description' => 'The alert notification level. Valid values of N: 1 to 5. Valid values:'."\n" + ."\n" + .'<props="china">- 2: phone call, text message, DingTalk, and email</props>'."\n" + ."\n" + .'<props="china">- 3: text message, DingTalk, and email</props>'."\n" + ."\n" + .'<props="china">- 4: DingTalk and email</props>'."\n" + ."\n" + .'<props="intl">4: DingTalk and email</props>'."\n" + ."\n" + .'<props="partner">4: DingTalk and email</props>.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => 'SLS_task', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Description', + 'name' => 'MnsParameters', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The description of the metric import task.'."\n", - 'type' => 'string', + 'description' => 'The Simple Message Queue (formerly MNS) notification method.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The region where Simple Message Queue (formerly MNS) resides. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'Queue' => ['description' => 'The name of the queue. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'queue1', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the rule target. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'Topic' => ['description' => 'The topic of Simple Message Queue (formerly MNS).', 'type' => 'string', 'required' => false, 'example' => 'topic_sample', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, + 'maxItems' => 5, + 'title' => '', 'example' => '', ], ], [ - 'name' => 'CollectInterval', + 'name' => 'WebhookParameters', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The collection period of the metric. Valid values:'."\n" - ."\n" - .'* 15'."\n" - .'* 60'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', + 'description' => 'The URL callback notification method.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Protocol' => ['description' => 'The protocol name. Valid values of N: 1 to 5. Valid values:'."\n" + ."\n" + .'- http'."\n" + .'- telnet'."\n" + .'- ping.', 'type' => 'string', 'required' => false, 'example' => 'http', 'title' => ''], + 'Url' => ['description' => 'The callback URL. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com', 'title' => ''], + 'Method' => ['description' => 'The request method of the HTTP callback. Valid values of N: 1 to 5.'."\n" + ."\n" + .'Only GET and POST are supported.', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the rule target. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '15', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AttachLabels', + 'name' => 'SlsParameters', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags of the metric.'."\n", + 'description' => 'The Simple Log Service notification method.', 'type' => 'array', 'items' => [ - 'description' => 'None'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'description' => 'The tag value of the metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testValue', - ], - 'Name' => [ - 'description' => 'The tag key of the metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app_service', - ], + 'LogStore' => ['description' => 'The Logstore of Simple Log Service. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'testlogstore', 'title' => ''], + 'Region' => ['description' => 'The region where Simple Log Service resides. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'Project' => ['description' => 'The project of Simple Log Service. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => 'testproject', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the rule target. Valid values of N: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 10, + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SLSProcessConfig', + 'name' => 'OpenApiParameters', 'in' => 'query', - 'style' => 'flat', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of API callback notification parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Action' => ['description' => 'The API name.', 'type' => 'string', 'required' => false, 'example' => 'PutLogs', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Valid values of N: 1 to 5.'."\n" + .'Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:'."\n" + .' - Service: the Alibaba Cloud service.'."\n" + .' - Region: the region ID.'."\n" + .' - Account: the Alibaba Cloud account ID.'."\n" + .' - ResourceType: the resource type.'."\n" + .' - ResourceId: the resource ID.', 'type' => 'string', 'required' => false, 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the API callback notification method.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + 'Product' => ['description' => 'The ID of the Alibaba Cloud service to which the API belongs.', 'type' => 'string', 'required' => false, 'example' => 'log', 'title' => ''], + 'Region' => ['description' => 'The region where the resource resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'Role' => ['description' => 'The role name.', 'type' => 'string', 'required' => false, 'example' => 'MyRole', 'title' => ''], + 'Version' => ['description' => 'The API version.', 'type' => 'string', 'required' => false, 'example' => '2019-01-01', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters of the alert callback.', 'type' => 'string', 'required' => false, 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 5, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The configurations of the logs that are imported from Simple Log Service.'."\n", 'type' => 'object', 'properties' => [ - 'Filter' => [ - 'description' => 'The conditions that are used to filter logs imported from Simple Log Service.'."\n", + 'Code' => ['description' => 'The status code.'."\n" + .'>The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '409C64DA-CF14-45DF-B463-471C790DD15A', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. The value true indicates success. The value false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FailedParameterCount' => ['description' => 'The number of failed parameters.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'FailedContactParameters' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'Relation' => [ - 'description' => 'The relationship between multiple filter conditions. Valid values:'."\n" - ."\n" - .'* and (default): Logs are processed only if all filter conditions are met.'."\n" - .'* or: Logs are processed if one of the filter conditions is met.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'and', - ], - 'Filters' => [ - 'description' => 'None.'."\n", + 'ContactParameter' => [ + 'description' => 'This parameter is returned if the rule targets contain an alert contact group that failed to be created.', 'type' => 'array', 'items' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'code', - ], - 'Operator' => [ - 'description' => 'The method that is used to filter logs imported from Simple Log Service. Valid values:'."\n" - ."\n" - .'* `contain`: contains'."\n" - .'* `notContain`: does not contain'."\n" - .'* `>`: greater than'."\n" - .'* `<`: less than'."\n" - .'* `=`: equal to'."\n" - .'* `! =`: not equal to'."\n" - .'* `>=`: greater than or equal to'."\n" - .'* `<=`: less than or equal to'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '=', - 'enum' => [ - '>', - '>=', - '=', - '<=', - '<', - '!=', - 'contain', - 'notContain', - ], - ], - 'Value' => [ - 'description' => 'The value of the key that is used to filter logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - ], + 'ContactGroupName' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'example' => 'Default alert contact group', 'title' => ''], + 'Id' => ['description' => 'The ID of the rule target.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Level' => ['description' => "\n" + .'The alert notification level. Valid values:'."\n" + ."\n" + .'<props="china">- 2: phone call, text message, DingTalk, and email</props>'."\n" + ."\n" + .'<props="china">- 3: text message, DingTalk, and email</props>'."\n" + ."\n" + .'<props="china">- 4: DingTalk and email</props>'."\n" + ."\n" + .'<props="intl">4: DingTalk and email</props>'."\n" + ."\n" + .'<props="partner">4: DingTalk and email</props>.', 'type' => 'string', 'example' => '4', 'title' => ''], ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'Statistics' => [ - 'description' => 'None.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to aggregate logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'Function' => [ - 'description' => 'The function that is used to aggregate the log data of a statistical period. Valid values:'."\n" - ."\n" - .'* count: counts the number.'."\n" - .'* sum: calculates the total value.'."\n" - .'* avg: calculates the average value.'."\n" - .'* max: calculates the maximum value.'."\n" - .'* min: calculates the minimum value.'."\n" - .'* value: collects samples within the statistical period.'."\n" - .'* countps: calculates the number of values of the specified field divided by the total number of seconds within the statistical period.'."\n" - .'* sumps: calculates the sum of the values of the specified field divided by the total number of seconds within the statistical period.'."\n" - .'* distinct: calculates the number of unique values of the specified field within the statistical period.'."\n" - .'* distribution: calculates the number of logs that meet a specified condition within the statistical period.'."\n" - .'* percentile: sorts the values of the specified field in ascending order, and then returns the value that is at the specified percentile within the statistical period. Example: P50.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'count', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregation result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'level_count', - 'minLength' => 0, - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', - ], - 'Parameter1' => [ - 'description' => 'The value of the function that is used to aggregate logs imported from Simple Log Service.'."\n" - ."\n" - .'* If the `Function` parameter is set to `distribution`, this parameter specifies the lower limit of the statistical interval. For example, if you want to calculate the number of HTTP requests whose status code is 2XX, set this parameter to 200.'."\n" - .'* If the `Function` parameter is set to `percentile`, this parameter specifies the percentile at which the expected value is. For example, 0.5 specifies P50.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - ], - 'Parameter2' => [ - 'description' => 'The value of the function that is used to aggregate logs imported from Simple Log Service.'."\n" - ."\n" - .'> This parameter is required only if the `Function` parameter is set to `distribution`. This parameter specifies the upper limit of the statistical interval. For example, if you want to calculate the number of HTTP requests whose status code is 2XX, set this parameter to 299.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '299', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'GroupBy' => [ - 'description' => 'The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to aggregate logs imported from Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'code', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregation result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ApiResult', - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', + 'FailedMnsParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MnsParameter' => [ + 'description' => 'This parameter is returned if the rule targets contain a Simple Message Queue (formerly MNS) instance that failed to be created.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Queue' => ['description' => 'The name of the queue.', 'type' => 'string', 'example' => 'testQueue', 'title' => ''], + 'Id' => ['description' => 'The ID of the rule target.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Express' => [ - 'description' => 'The extended fields that specify the results of basic operations performed on aggregation results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None.'."\n", - 'type' => 'object', - 'properties' => [ - 'Express' => [ - 'description' => 'The extended field that specifies the result of basic operations performed on aggregation results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'success_count', - ], - 'Alias' => [ - 'description' => 'The alias of the extended field that specifies the result of basic operations performed on aggregation results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SuccRate', - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', + 'FailedFcParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FcParameter' => [ + 'description' => 'This parameter is returned if the rule targets contain a Function Compute service that failed to be created.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'ServiceName' => ['description' => 'The name of the Function Compute service.', 'type' => 'string', 'example' => 'serviceTest1', 'title' => ''], + 'FunctionName' => ['description' => 'The name of the function.', 'type' => 'string', 'example' => 'functionTest1', 'title' => ''], + 'Id' => ['description' => 'The ID of the rule target.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 403 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 500 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'Add or modify notification channels of an alert rule', + 'summary' => 'Adds or modifies the notification channels of an event-triggered alert rule by calling the PutEventRuleTargets operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-12-22T07:44:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-22T07:44:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-22T07:44:57.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutEventRuleTargets'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutEventRuleTargets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"409C64DA-CF14-45DF-B463-471C790DD15A\\",\\n \\"Success\\": true,\\n \\"FailedParameterCount\\": \\"2\\",\\n \\"FailedContactParameters\\": {\\n \\"ContactParameter\\": [\\n {\\n \\"ContactGroupName\\": \\"Default alert contact group\\",\\n \\"Id\\": 2,\\n \\"Level\\": \\"4\\"\\n }\\n ]\\n },\\n \\"FailedMnsParameters\\": {\\n \\"MnsParameter\\": [\\n {\\n \\"Queue\\": \\"testQueue\\",\\n \\"Id\\": 2,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"FailedFcParameters\\": {\\n \\"FcParameter\\": [\\n {\\n \\"ServiceName\\": \\"serviceTest1\\",\\n \\"FunctionName\\": \\"functionTest1\\",\\n \\"Id\\": 1,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'PutExporterOutput' => [ + 'summary' => 'Creates or modifies a monitoring data export configuration by calling the PutExporterOutput operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'DestName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the configuration.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'exporterConfig', 'title' => ''], + ], + [ + 'name' => 'ConfigJson', + 'in' => 'query', + 'schema' => ['description' => 'The configuration of the data export. The value is a JSONObject string that must contain the following fields:'."\n" + ."\n" + .'- endpoint: the domain name that corresponds to the data of Log Service (SLS).'."\n" + .'- project: the project.'."\n" + .'- logstore: the Logstore.'."\n" + .'- ak: the AccessKey ID.'."\n" + .'- as: the AccessKey secret.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{ "endpoint": "http://cn-qingdao-share.log.aliyuncs.com", "project": "exporter", "logstore": "exporter","ak": "LTAIp*******", "userId": "17754********", "as": "TxHwuJ8yAb3AU******"}', 'title' => ''], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => ['description' => 'The description of the configuration.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'CPU metric export', 'title' => ''], + ], + [ + 'name' => 'DestType', + 'in' => 'query', + 'schema' => ['description' => 'The product to which the data is exported.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'sls', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Invalid.SLSConfig', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '11145B76-566A-5D80-A8A3-FAD98D310079', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates that the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D027', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. The value true indicates that the call was successful. The value false indicates that the call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Invalid.SLSConfig\\",\\n \\"RequestId\\": \\"11145B76-566A-5D80-A8A3-FAD98D310079\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyHybridMonitorTaskResponse>\\n <RequestId>11145B76-566A-5D80-A8A3-FAD98D310079</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyHybridMonitorTaskResponse>","errorExample":""}]', - 'title' => 'ModifyHybridMonitorTask', - 'description' => 'This topic provides an example on how to change the collection period of a metric import task whose ID is `36****` to `15` seconds. The task is used to monitor the logs that are imported from Log Service. The returned result indicates that the metric is modified.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'DeleteHybridMonitorTask' => [ - 'summary' => 'Deletes a metric import task for Alibaba Cloud services or a metric for the logs that are imported from Log Service.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Create or modify a monitoring data export configuration', + 'description' => '> Only Log Service (SLS) is supported. More products will be supported in the future.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-21T02:01:45.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutExporterOutput'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutExporterOutput', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"6A5F022D-AC7C-460E-94AE-B9E75083D027\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'PutExporterRule' => [ + 'summary' => 'Invokes the PutExporterRule operation to create or modify export rules.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the metric import task.'."\n" - ."\n" - .'For information about how to obtain the ID of a metric import task, see [DescribeHybridMonitorTaskList](~~428624~~).'."\n" - ."\n" - .'> This parameter is required only if you call this operation to delete metrics for the logs that are imported from Log Service. In this case, the `TaskType` parameter is set to `aliyun_sls`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '36****', - ], + 'schema' => ['description' => 'The name of the rule.'."\n" + ."\n" + .'> If the rule name already exists, the existing rule is modified. Otherwise, a new rule is created.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'rule1_****', 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'The name can contain uppercase letters, lowercase letters, digits, and hyphens (-).'."\n" - ."\n" - .'> This parameter is required only if you call this operation to delete metric import tasks for Alibaba Cloud services. In this case, the `TaskType` parameter is set to `aliyun_fc`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aliyun', - ], + 'schema' => ['description' => 'The namespace of the Alibaba Cloud service. For more information, see [Cloud service metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'TargetUserId', + 'name' => 'MetricName', 'in' => 'query', + 'schema' => ['description' => 'The metric name. For more information, see [Cloud service metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'CPUUtilization', 'title' => ''], + ], + [ + 'name' => 'TargetWindows', + 'in' => 'query', + 'schema' => ['description' => 'The time windows for data export. Unit: seconds.'."\n" + ."\n" + .'> - To export data for multiple windows, separate the windows with commas (,).'."\n" + .'- Exporting data at intervals of less than 60 seconds is not supported.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '60,300', 'title' => ''], + ], + [ + 'name' => 'Describe', + 'in' => 'query', + 'schema' => ['description' => 'The description of the export rules.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'desc_******', 'title' => ''], + ], + [ + 'name' => 'DstNames', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the member account.'."\n" - ."\n" - .'> This parameter is required only if you use a management account to call this operation to query metric import tasks that belong to a member in a resource directory. In this case, the `TaskType` parameter is set to `aliyun_fc`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '120886317861****', + 'description' => 'The destination for data export.', + 'type' => 'array', + 'items' => ['description' => 'The destination for data export.', 'type' => 'string', 'required' => false, 'example' => 'dst_******', 'title' => ''], + 'required' => true, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D6B8103F-7BAD-5FEB-945F-71D991AB8834', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"D6B8103F-7BAD-5FEB-945F-71D991AB8834\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteHybridMonitorTaskResponse>\\n <RequestId>D6B8103F-7BAD-5FEB-945F-71D991AB8834</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteHybridMonitorTaskResponse>","errorExample":""}]', - 'title' => 'DeleteHybridMonitorTask', - 'description' => 'This topic provides an example on how to delete a metric import task whose ID is `36****`. The returned result indicates that the metric import task is deleted.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'DescribeHybridMonitorTaskList' => [ - 'summary' => 'Queries metric import tasks.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Create or modify a data export rule', + 'changeSet' => [ + ['createdAt' => '2023-08-30T08:14:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-10T10:46:10.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutExporterRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutExporterRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'PutGroupMetricRule' => [ + 'summary' => 'Creates or modifies an alert rule in a specified application group.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Keyword', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used for the search.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'task', - ], + 'schema' => ['description' => 'The application group ID.'."\n" + ."\n" + .'For information about how to obtain the application group ID, see [DescribeMonitorGroups](~~115032~~).', 'type' => 'string', 'required' => true, 'example' => '17285****', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the metric import task.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '36****', - ], + 'schema' => ['description' => 'The alert rule ID.'."\n" + ."\n" + .'- To create an alert rule for the application group, enter the alert rule ID.'."\n" + ."\n" + .'- To modify a specified alert rule in the application group, obtain the alert rule ID. For information about how to obtain the alert rule ID, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application group.'."\n" - ."\n" - .'For information about how to obtain the ID of an application group, see [DescribeMonitorGroups](~~115032~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '3607****', - ], + 'schema' => ['description' => 'The abbreviation of the Alibaba Cloud service name.'."\n" + ."\n" + .'For information about how to obtain the abbreviation, see the `metricCategory` tag in the `Labels` response parameter of the [DescribeProjectMeta](~~114916~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The alert rule name.'."\n" + ."\n" + .'- To create an alert rule for the application group, enter the alert rule name.'."\n" + ."\n" + .'- To modify a specified alert rule in the application group, obtain the alert rule name. For information about how to obtain the alert rule name, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => true, 'example' => 'Rule_01', 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'aliyun', - ], + 'schema' => ['description' => 'The namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'For information about how to obtain the namespace, see [DescribeMetricMetaList](~~98846~~) or [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'MetricName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Pages start from page 1. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The metric name.'."\n" + ."\n" + .'For information about how to obtain the metric name, see [DescribeMetricMetaList](~~98846~~) or [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_total', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Dimensions', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The first-level dimensions of the alert rule in the application group.'."\n" + ."\n" + .'Format: a collection of `key:value` pairs, such as `{"userId":"120886317861****"}` and `{"instanceId":"i-m5e1qg6uo38rztr4****"}`.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"i-m5e1qg6uo38rztr4****"}]', 'title' => ''], ], [ - 'name' => 'IncludeAliyunTask', + 'name' => 'ExtraDimensionJson', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the returned result includes metric import tasks for Alibaba Cloud services. Valid values:'."\n" - ."\n" - .'* true (default): The returned result includes metric import tasks for Alibaba Cloud services.'."\n" - .'* false: The returned result excludes metric import tasks for Alibaba Cloud services.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The second-level or third-level dimensions of the alert rule in the application group.'."\n" + ."\n" + .'Format: a collection of `key:value` pairs, such as `port:80` and `/dev/xvda:d-m5e6yphgzn3aprwu****`.'."\n" + ."\n" + .'If the first-level dimension is `{"instanceId":"i-m5e1qg6uo38rztr4****"}`, the second-level dimension is the cloud disk of the instance: `{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}`.', 'type' => 'string', 'required' => false, 'example' => '{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}', 'title' => ''], ], [ - 'name' => 'TaskType', + 'name' => 'EffectiveInterval', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the metric import task. Valid values:'."\n" - ."\n" - .'* aliyun_fc: metric import tasks for Alibaba Cloud services'."\n" - .'* aliyun_sls: metrics for logs imported from Log Service'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'aliyun_sls' => 'aliyun_sls', - ], - 'example' => 'aliyun_fc', - ], + 'schema' => ['description' => 'The effective period during which the alert rule takes effect.', 'type' => 'string', 'required' => false, 'example' => '05:31-23:59', 'title' => ''], ], [ - 'name' => 'TargetUserId', + 'name' => 'NoEffectiveInterval', + 'in' => 'query', + 'schema' => ['description' => 'The time range during which the alert rule is ineffective.', 'type' => 'string', 'required' => false, 'example' => '00:00-05:30', 'title' => ''], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => ['description' => 'The mute period during which CloudMonitor does not repeatedly send alert notifications for the same metric.'."\n" + ."\n" + .'Unit: seconds. Default value: 86400.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The reporting period of monitoring data.'."\n" + ."\n" + .'The value of `Period` is 60 or a multiple of 60. Unit: seconds. Default value: 300.', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The detection period of the alert rule. Unit: seconds.'."\n" + ."\n" + .'> Keep the detection period consistent with the data reporting period. If the detection period is shorter than the data reporting period, alerts may not be triggered due to insufficient data.', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => ['description' => 'The callback URL to which a request is sent when an alert is triggered.'."\n" + ."\n" + .'Enter a URL that is accessible over the Internet. CloudMonitor sends a POST request to push alert information to this URL. Only the HTTP protocol is supported.', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com', 'title' => ''], + ], + [ + 'name' => 'EmailSubject', + 'in' => 'query', + 'schema' => ['description' => 'The subject of the alert email.', 'type' => 'string', 'required' => false, 'example' => 'ECS instance', 'title' => ''], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => ['description' => 'The alert contact group.', 'type' => 'string', 'required' => false, 'example' => 'ECS_Group', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.Statistics', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method for Critical-level alerts. Separate multiple statistical methods with commas (,).'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column that corresponds to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the value, see [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for Critical-level alerts.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.Times', + 'in' => 'query', + 'schema' => ['description' => 'The retry count for Critical-level alerts.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.Statistics', 'in' => 'query', + 'schema' => ['description' => 'The statistical method for Warn-level alerts. Separate multiple statistical methods with commas (,).'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column that corresponds to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the value, see [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for Warn-level alerts.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.Times', + 'in' => 'query', + 'schema' => ['description' => 'The retry count for Warn-level alerts.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.Statistics', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method for Info-level alerts. Separate multiple statistical methods with commas (,).'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column that corresponds to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For information about how to obtain the value, see [Cloud service monitoring](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for Info-level alerts.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.Times', + 'in' => 'query', + 'schema' => ['description' => 'The retry count for Info-level alerts.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'NoDataPolicy', + 'in' => 'query', + 'schema' => ['description' => 'The processing method when no monitoring data is found. Valid values:'."\n" + .'- KEEP_LAST_STATE (default): No action is performed.'."\n" + .'- INSUFFICIENT_DATA: An alert whose content is "Insufficient Data" is triggered.'."\n" + .'- OK: The status is considered normal.', 'type' => 'string', 'required' => false, 'example' => 'KEEP_LAST_STATE', 'title' => ''], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the member account.'."\n" + 'description' => 'The tags of the alert rule.'."\n" ."\n" - .'> This parameter is required only if you use a management account to call this operation to delete the metric import tasks that belong to a member in a resource directory. In this case, the `TaskType` parameter is set to `aliyun_fc`.'."\n", - 'type' => 'integer', - 'format' => 'int64', + .'Tags are included in alert notifications.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '120886317861****', + 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Options', + 'in' => 'query', + 'schema' => ['description' => 'The advanced settings.'."\n" + ."\n" + .'Format: {"key1":"value1","key2":"value2"}. Example: {"NotSendOK":true}. This specifies whether to send alert recovery notifications. The key is NotSendOK, and the value is true (do not send) or false (send, which is the default).', 'type' => 'string', 'required' => false, 'example' => '{"NotSendOK":true}', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '11145B76-566A-5D80-A8A3-FAD98D310079', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n" - ."\n" - .'* If the request was successful, the value `successful` is returned.'."\n" - .'* If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TaskList' => [ - 'description' => 'The metric import tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'YARMConfig' => [ - 'description' => 'The configuration file of the Alibaba Cloud service that you want to monitor by using Hybrid Cloud Monitoring.'."\n" - ."\n" - .'* namespace: the namespace of the Alibaba Cloud service.'."\n" - .'* metric_list: the metrics of the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total', - ], - 'CreateTime' => [ - 'description' => 'The timestamp when the metric import task was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1639382496000', - ], - 'TaskName' => [ - 'description' => 'The name of the metric import task.'."\n", - 'type' => 'string', - 'example' => 'aliyun_task', - ], - 'Namespace' => [ - 'description' => 'The namespace to which the host belongs.'."\n", - 'type' => 'string', - 'example' => 'aliyun', - ], - 'UploadRegion' => [ - 'description' => 'The region where the host resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'NetworkType' => [ - 'description' => 'The network type of the host. Valid values:'."\n" - ."\n" - .'* `vpc`'."\n" - .'* `Internet`'."\n", - 'type' => 'string', - 'example' => 'vpc', - ], - 'CollectTimout' => [ - 'description' => 'The timeout period during which the CloudMonitor agent collects host monitoring data. Valid values:'."\n" - ."\n" - .'* 0'."\n" - .'* 15'."\n" - .'* 30'."\n" - .'* 60'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'CollectTargetEndpoint' => [ - 'description' => 'The URL of the destination from which the CloudMonitor agent collects host monitoring data.'."\n", - 'type' => 'string', - 'example' => 'http://localhost', - ], - 'TaskType' => [ - 'description' => 'The type of the metric import task. Valid values:'."\n" - ."\n" - .'* aliyun_fc: metric import tasks for Alibaba Cloud services'."\n" - .'* aliyun_sls: metrics for logs imported from Log Service'."\n", - 'type' => 'string', - 'example' => 'aliyun_sls', - ], - 'MatchExpressRelation' => [ - 'description' => 'The relationship between the conditions that are used to filter metric import tasks. Valid values:'."\n" - ."\n" - .'* or'."\n" - .'* and'."\n", - 'type' => 'string', - 'example' => 'or', - ], - 'Description' => [ - 'description' => 'The description of the metric import task.'."\n", - 'type' => 'string', - 'example' => 'aliyun', - ], - 'GroupId' => [ - 'description' => 'The ID of the application group.'."\n", - 'type' => 'string', - 'example' => '3607****', - ], - 'CollectInterval' => [ - 'description' => 'The interval at which the CloudMonitor agent collects host monitoring data. Valid values:'."\n" - ."\n" - .'* 15'."\n" - .'* 30'."\n" - .'* 60'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'TargetUserId' => [ - 'description' => 'The ID of the member account.'."\n" - ."\n" - .'> This parameter is displayed only when you call this operation by using a management account.'."\n", - 'type' => 'string', - 'example' => '120886317861****', - ], - 'CollectTargetPath' => [ - 'description' => 'The relative path from which the CloudMonitor agent collects monitoring data.'."\n", - 'type' => 'string', - 'example' => '/metrics', - ], - 'CollectTargetType' => [ - 'description' => 'The type of the monitoring data. Valid values: Spring, Tomcat, Nginx, Tengine, JVM, Redis, and MySQL.'."\n", - 'type' => 'string', - 'example' => 'nginx', - ], - 'TaskId' => [ - 'description' => 'The ID of the metric import task.'."\n", - 'type' => 'string', - 'example' => '36****', - ], - 'AttachLabels' => [ - 'description' => 'The tags of the metric import task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], - 'MatchExpress' => [ - 'description' => 'The conditions that are used to match the instances in the application group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'None'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The keyword that corresponds to the instance name.'."\n", - 'type' => 'string', - 'example' => 'ECS_instance1', - ], - 'Name' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'Function' => [ - 'description' => 'The method that is used to match the instance name. Valid values:'."\n" - ."\n" - .'* startWith: starts with a prefix'."\n" - .'* endWith: ends with a suffix'."\n" - .'* all: matches all'."\n" - .'* equals: equals'."\n" - .'* contains: contains'."\n" - .'* notContains: does not contain'."\n", - 'type' => 'string', - 'example' => 'all', - ], - ], - ], - ], - 'Instances' => [ - 'description' => 'The instances where monitoring data is collected in batches.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'i-hp368focau7dp0hw****', - ], - ], - 'ExtraInfo' => [ - 'description' => 'The additional information of the instance.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'LogFilePath' => [ - 'description' => 'The path where on-premises log data is stored. On-premises log data is stored in the specified path of the host where CloudMonitor is deployed.'."\n" - ."\n" - .'* Windows: The log path must start with a drive letter. Example: `C:\\UserData\\log\\\\*.Log`. You cannot specify wildcard characters in a log path.'."\n" - .'* Linux: The log path must start with a forward slash (/). Example: `/home/appdata/log/**/*.log`. In this example, `/**/` is used to match all files in the appdata directory.'."\n", - 'type' => 'string', - 'example' => 'C:\\UserData\\log\\*.Log', - ], - 'LogSplit' => [ - 'description' => 'The result that is returned after on-premises log data is split based on the specified matching mode.'."\n" - ."\n" - .'> The matching modes of on-premises log data include full regex mode, delimiter mode, and JSON mode.'."\n", - 'type' => 'string', - 'example' => '{"type": "regex","regex": "\\\\d+\\\\.\\\\d+\\\\.\\\\d+\\\\.\\\\d+\\\\s+(\\\\d+)\\\\s+\\\\S+\\\\s+\\\\[\\\\d+/\\\\S+/\\\\d+:\\\\d+:\\\\d+:\\\\d+\\\\s+\\\\+\\\\d+\\\\]\\\\s+(\\\\S+)\\\\s+\\\\S+\\\\s+/\\\\S+/\\\\S+/\\\\S+\\\\s+(\\\\d+)","columns": [{"name": "field1"},{"name": "filed2","translate": {"default": "-","mappings": [{"from": "(\\\\w+)","to": "$1x","type": "regex"}]}},{"name": "filed3","translate": {"default": "-","mappings": [{"from": "NumberRange(100,300)","to": "true","type": "function"}]}}]}', - ], - 'LogProcess' => [ - 'description' => 'The method that is used to aggregate on-premises log data.'."\n", - 'type' => 'string', - 'example' => '[{"metric": "metric1","filters": [{"column": "filed2","type": "include","values": ["222222"]}],"groupBys": [{"column": "filed3","name": "filed3"}],"calculates": [{"column": "field1","name": "avg","type": "avg"}]},{"metric": "metric2","filters": [{"column": "field1","type": "include","values": ["11111"]}],"groupBys": [{"column": "filed2","name": "filed2"}],"calculates": [{"column": "field1","name": "avg","type": "avg"}]}]', - ], - 'LogSample' => [ - 'description' => 'The sample on-premises log.'."\n", - 'type' => 'string', - 'example' => '{"logContent":"100.116.134.26 1119 - [13/Aug/2019:16:55:46 +0800] POST metrichub-cn-hongkong.aliyun.com /agent/metrics/putLines 200 0 \\"-\\" \\"127.0.0.1:7001\\" \\"Go-http-client/1.1\\" \\"-\\" \\"-\\" \\"0a98a21a15656865460656276e\\"","addData":{"field1":["1119","1119"],"filed2":["POSTx","POST"],"filed3":["true","200"]}}', - ], - 'SLSProcess' => [ - 'description' => 'The configurations of the logs that are imported from Log Service.'."\n", - 'type' => 'string', - 'example' => '{"express": [],"filter": {"filters": [{"key": "task_type","operator": "=","value": "1"}]},"groupby": [{"alias": "isp","key": "isp","sqlKey": "t.`isp`","valueKey": "isp"}],"interval": 60,"labels": [{"name": "__cms_app__","type": 0,"value": "sitemonitor"}],"statistics": [{"alias": "http_dns_time_avg","function": "avg","key": "http_dns_time"}]}', - ], - 'SLSProcessConfig' => [ - 'description' => 'The configurations of the logs that are imported from Log Service.'."\n" - ."\n" - .'> This parameter is returned only if the `TaskType` parameter is set to `aliyun_sls`.'."\n", - 'type' => 'object', - 'properties' => [ - 'Filter' => [ - 'description' => 'The conditions that are used to filter logs imported from Log Service.'."\n", - 'type' => 'object', - 'properties' => [ - 'Relation' => [ - 'description' => 'The relationship between multiple filter conditions. Valid values:'."\n" - ."\n" - .'* and (default): Logs are processed only if all filter conditions are met.'."\n" - .'* or: Logs are processed if one of the filter conditions is met.'."\n", - 'type' => 'string', - 'example' => 'and', - ], - 'Filters' => [ - 'description' => 'The conditions that are used to filter logs imported from Log Service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The conditions that are used to filter logs imported from Log Service.'."\n", - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to filter logs imported from Log Service.'."\n", - 'type' => 'string', - 'example' => 'host', - ], - 'Operator' => [ - 'description' => 'The method that is used to filter logs imported from Log Service. Valid values:'."\n" - ."\n" - .'* `contain`: contains'."\n" - .'* `notContain`: does not contain'."\n" - .'* `>`: greater than'."\n" - .'* `<`: less than'."\n" - .'* `=`: equal to'."\n" - .'* `! =`: not equal to'."\n" - .'* `>=`: greater than or equal to'."\n" - .'* `<=`: less than or equal to'."\n", - 'type' => 'string', - 'example' => '=', - ], - 'Value' => [ - 'description' => 'The value of the key that is used to filter logs imported from Log Service.'."\n", - 'type' => 'string', - 'example' => '200', - ], - ], - ], - ], - ], - ], - 'Statistics' => [ - 'description' => 'The methods that are used to aggregate logs imported from Log Service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The method that is used to aggregate logs imported from Log Service.'."\n", - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to aggregate logs imported from Log Service.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'Function' => [ - 'description' => 'The function that is used to aggregate log data within a statistical period. Valid values:'."\n" - ."\n" - .'* count: counts the number.'."\n" - .'* sum: calculates the total value.'."\n" - .'* avg: calculates the average value.'."\n" - .'* max: calculates the maximum value.'."\n" - .'* min: calculates the minimum value.'."\n" - .'* value: collects samples within the statistical period.'."\n" - .'* countps: calculates the average number of the specified field per second by using the following formula: Counted number of the specified field/Total number of seconds within the statistical period.'."\n" - .'* sumps: calculates the average number of the specified field per second by using the following formula: Total value of the specified field/Total number of seconds within the statistical period.'."\n" - .'* distinct: counts the number of logs where the specified field appears within the statistical period.'."\n" - .'* distribution: counts the number of logs that meet a specified condition within the statistical period.'."\n" - .'* percentile: sorts the values of the specified field in ascending order, and then returns the value that is at the specified percentile within the statistical period. Example: P50.'."\n", - 'type' => 'string', - 'example' => 'count', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregation result.'."\n", - 'type' => 'string', - 'example' => 'level_count', - ], - 'Parameter1' => [ - 'description' => 'The value of the function that is used to aggregate logs imported from Log Service.'."\n" - ."\n" - .'* If the `Function` parameter is set to `distribution`, this parameter indicates the lower limit of the statistical interval. For example, 200 indicates that the number of HTTP requests whose status code is 2XX is calculated.'."\n" - .'* If the `Function` parameter is set to `percentile`, this parameter specifies the percentile at which the expected value is. For example, 0.5 specifies P50.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Parameter2' => [ - 'description' => 'The value of the function that is used to aggregate logs imported from Log Service.'."\n" - ."\n" - .'> This parameter is returned only if the `Function` parameter is set to `distribution`. This parameter indicates the upper limit of the statistical interval. For example, 299 indicates that the number of HTTP requests whose status code is 2XX is calculated.'."\n", - 'type' => 'string', - 'example' => '299', - ], - ], - ], - ], - 'GroupBy' => [ - 'description' => 'The dimensions based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.'."\n", - 'type' => 'object', - 'properties' => [ - 'SLSKeyName' => [ - 'description' => 'The name of the key that is used to aggregate logs imported from Log Service.'."\n", - 'type' => 'string', - 'example' => 'code', - ], - 'Alias' => [ - 'description' => 'The alias of the aggregation result.'."\n", - 'type' => 'string', - 'example' => 'ApiResult', - ], - ], - ], - ], - 'Express' => [ - 'description' => 'The extended fields that indicate the results of basic operations that are performed on aggregation results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The extended field that indicates the result of basic operations that are performed on aggregation results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Express' => [ - 'description' => 'The extended field that indicates the result of basic operations that are performed on aggregation results.'."\n", - 'type' => 'string', - 'example' => 'success_count', - ], - 'Alias' => [ - 'description' => 'The alias of the extended field that indicates the result of basic operations that are performed on aggregation results.'."\n", - 'type' => 'string', - 'example' => 'SuccRate', - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'>A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The Request is not authorization.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Result' => [ + 'description' => 'The result of creating or modifying the alert rule.', + 'type' => 'object', + 'properties' => [ + 'RuleId' => ['description' => 'The alert rule ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 499 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Create or modify an alert rule in a specified application group', + 'description' => 'This topic provides an example on how to create an alert rule for the `cpu_total` metric of Elastic Compute Service (ECS) in the application group `17285****`. The alert rule ID is `123456`, the alert rule name is `Rule_test`, the alert level is `Critical`, the statistical method is `Average`, the comparison operator is `GreaterThanOrEqualToThreshold`, the threshold is `90`, and the retry count is `3`. The response shows that the alert rule is created. The alert rule ID is `123456`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-12-13T07:02:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-20T09:52:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-09-14T06:58:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-09-14T06:58:52.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutGroupMetricRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutGroupMetricRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'GroupMetricRule', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"11145B76-566A-5D80-A8A3-FAD98D310079\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 1,\\n \\"TaskList\\": [\\n {\\n \\"YARMConfig\\": \\"products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total\\",\\n \\"CreateTime\\": \\"1639382496000\\",\\n \\"TaskName\\": \\"aliyun_task\\",\\n \\"Namespace\\": \\"aliyun\\",\\n \\"UploadRegion\\": \\"cn-hangzhou\\",\\n \\"NetworkType\\": \\"vpc\\",\\n \\"CollectTimout\\": 15,\\n \\"CollectTargetEndpoint\\": \\"http://localhost\\",\\n \\"TaskType\\": \\"aliyun_sls\\",\\n \\"MatchExpressRelation\\": \\"or\\",\\n \\"Description\\": \\"aliyun\\",\\n \\"GroupId\\": \\"3607****\\",\\n \\"CollectInterval\\": 60,\\n \\"TargetUserId\\": \\"120886317861****\\",\\n \\"CollectTargetPath\\": \\"/metrics\\",\\n \\"CollectTargetType\\": \\"nginx\\",\\n \\"TaskId\\": \\"36****\\",\\n \\"AttachLabels\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"MatchExpress\\": [\\n {\\n \\"Value\\": \\"ECS_instance1\\",\\n \\"Name\\": \\"name\\",\\n \\"Function\\": \\"all\\"\\n }\\n ],\\n \\"Instances\\": [\\n \\"i-hp368focau7dp0hw****\\"\\n ],\\n \\"ExtraInfo\\": \\"test\\",\\n \\"LogFilePath\\": \\"C:\\\\\\\\UserData\\\\\\\\log\\\\\\\\*.Log\\",\\n \\"LogSplit\\": \\"{\\\\\\"type\\\\\\": \\\\\\"regex\\\\\\",\\\\\\"regex\\\\\\": \\\\\\"\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\s+(\\\\\\\\\\\\\\\\d+)\\\\\\\\\\\\\\\\s+\\\\\\\\\\\\\\\\S+\\\\\\\\\\\\\\\\s+\\\\\\\\\\\\\\\\[\\\\\\\\\\\\\\\\d+/\\\\\\\\\\\\\\\\S+/\\\\\\\\\\\\\\\\d+:\\\\\\\\\\\\\\\\d+:\\\\\\\\\\\\\\\\d+:\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\s+\\\\\\\\\\\\\\\\+\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\]\\\\\\\\\\\\\\\\s+(\\\\\\\\\\\\\\\\S+)\\\\\\\\\\\\\\\\s+\\\\\\\\\\\\\\\\S+\\\\\\\\\\\\\\\\s+/\\\\\\\\\\\\\\\\S+/\\\\\\\\\\\\\\\\S+/\\\\\\\\\\\\\\\\S+\\\\\\\\\\\\\\\\s+(\\\\\\\\\\\\\\\\d+)\\\\\\",\\\\\\"columns\\\\\\": [{\\\\\\"name\\\\\\": \\\\\\"field1\\\\\\"},{\\\\\\"name\\\\\\": \\\\\\"filed2\\\\\\",\\\\\\"translate\\\\\\": {\\\\\\"default\\\\\\": \\\\\\"-\\\\\\",\\\\\\"mappings\\\\\\": [{\\\\\\"from\\\\\\": \\\\\\"(\\\\\\\\\\\\\\\\w+)\\\\\\",\\\\\\"to\\\\\\": \\\\\\"$1x\\\\\\",\\\\\\"type\\\\\\": \\\\\\"regex\\\\\\"}]}},{\\\\\\"name\\\\\\": \\\\\\"filed3\\\\\\",\\\\\\"translate\\\\\\": {\\\\\\"default\\\\\\": \\\\\\"-\\\\\\",\\\\\\"mappings\\\\\\": [{\\\\\\"from\\\\\\": \\\\\\"NumberRange(100,300)\\\\\\",\\\\\\"to\\\\\\": \\\\\\"true\\\\\\",\\\\\\"type\\\\\\": \\\\\\"function\\\\\\"}]}}]}\\",\\n \\"LogProcess\\": \\"[{\\\\\\"metric\\\\\\": \\\\\\"metric1\\\\\\",\\\\\\"filters\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"filed2\\\\\\",\\\\\\"type\\\\\\": \\\\\\"include\\\\\\",\\\\\\"values\\\\\\": [\\\\\\"222222\\\\\\"]}],\\\\\\"groupBys\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"filed3\\\\\\",\\\\\\"name\\\\\\": \\\\\\"filed3\\\\\\"}],\\\\\\"calculates\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"field1\\\\\\",\\\\\\"name\\\\\\": \\\\\\"avg\\\\\\",\\\\\\"type\\\\\\": \\\\\\"avg\\\\\\"}]},{\\\\\\"metric\\\\\\": \\\\\\"metric2\\\\\\",\\\\\\"filters\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"field1\\\\\\",\\\\\\"type\\\\\\": \\\\\\"include\\\\\\",\\\\\\"values\\\\\\": [\\\\\\"11111\\\\\\"]}],\\\\\\"groupBys\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"filed2\\\\\\",\\\\\\"name\\\\\\": \\\\\\"filed2\\\\\\"}],\\\\\\"calculates\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"field1\\\\\\",\\\\\\"name\\\\\\": \\\\\\"avg\\\\\\",\\\\\\"type\\\\\\": \\\\\\"avg\\\\\\"}]}]\\",\\n \\"LogSample\\": \\"{\\\\\\"logContent\\\\\\":\\\\\\"100.116.134.26 1119 - [13/Aug/2019:16:55:46 +0800] POST metrichub-cn-hongkong.aliyun.com /agent/metrics/putLines 200 0 \\\\\\\\\\\\\\"-\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"127.0.0.1:7001\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"Go-http-client/1.1\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"-\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"-\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"0a98a21a15656865460656276e\\\\\\\\\\\\\\"\\\\\\",\\\\\\"addData\\\\\\":{\\\\\\"field1\\\\\\":[\\\\\\"1119\\\\\\",\\\\\\"1119\\\\\\"],\\\\\\"filed2\\\\\\":[\\\\\\"POSTx\\\\\\",\\\\\\"POST\\\\\\"],\\\\\\"filed3\\\\\\":[\\\\\\"true\\\\\\",\\\\\\"200\\\\\\"]}}\\",\\n \\"SLSProcess\\": \\"{\\\\\\"express\\\\\\": [],\\\\\\"filter\\\\\\": {\\\\\\"filters\\\\\\": [{\\\\\\"key\\\\\\": \\\\\\"task_type\\\\\\",\\\\\\"operator\\\\\\": \\\\\\"=\\\\\\",\\\\\\"value\\\\\\": \\\\\\"1\\\\\\"}]},\\\\\\"groupby\\\\\\": [{\\\\\\"alias\\\\\\": \\\\\\"isp\\\\\\",\\\\\\"key\\\\\\": \\\\\\"isp\\\\\\",\\\\\\"sqlKey\\\\\\": \\\\\\"t.`isp`\\\\\\",\\\\\\"valueKey\\\\\\": \\\\\\"isp\\\\\\"}],\\\\\\"interval\\\\\\": 60,\\\\\\"labels\\\\\\": [{\\\\\\"name\\\\\\": \\\\\\"__cms_app__\\\\\\",\\\\\\"type\\\\\\": 0,\\\\\\"value\\\\\\": \\\\\\"sitemonitor\\\\\\"}],\\\\\\"statistics\\\\\\": [{\\\\\\"alias\\\\\\": \\\\\\"http_dns_time_avg\\\\\\",\\\\\\"function\\\\\\": \\\\\\"avg\\\\\\",\\\\\\"key\\\\\\": \\\\\\"http_dns_time\\\\\\"}]}\\",\\n \\"SLSProcessConfig\\": {\\n \\"Filter\\": {\\n \\"Relation\\": \\"and\\",\\n \\"Filters\\": [\\n {\\n \\"SLSKeyName\\": \\"host\\",\\n \\"Operator\\": \\"=\\",\\n \\"Value\\": \\"200\\"\\n }\\n ]\\n },\\n \\"Statistics\\": [\\n {\\n \\"SLSKeyName\\": \\"name\\",\\n \\"Function\\": \\"count\\",\\n \\"Alias\\": \\"level_count\\",\\n \\"Parameter1\\": \\"200\\",\\n \\"Parameter2\\": \\"299\\"\\n }\\n ],\\n \\"GroupBy\\": [\\n {\\n \\"SLSKeyName\\": \\"code\\",\\n \\"Alias\\": \\"ApiResult\\"\\n }\\n ],\\n \\"Express\\": [\\n {\\n \\"Express\\": \\"success_count\\",\\n \\"Alias\\": \\"SuccRate\\"\\n }\\n ]\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeHybridMonitorTaskListResponse>\\n\\t<RequestId>11145B76-566A-5D80-A8A3-FAD98D310079</RequestId>\\n\\t<PageSize>10</PageSize>\\n\\t<PageNumber>1</PageNumber>\\n\\t<Total>1</Total>\\n\\t<TaskList>\\n\\t\\t<CollectTimout>15</CollectTimout>\\n\\t\\t<CollectInterval>0</CollectInterval>\\n\\t\\t<Description></Description>\\n\\t\\t<TaskId>36****</TaskId>\\n\\t\\t<CreateTime>1639382496000</CreateTime>\\n\\t\\t<YARMConfig></YARMConfig>\\n\\t\\t<CollectTargetPath></CollectTargetPath>\\n\\t\\t<Namespace>aliyun</Namespace>\\n\\t\\t<GroupId>0</GroupId>\\n\\t\\t<MatchExpressRelation></MatchExpressRelation>\\n\\t\\t<SLSProcess>{\\\\\\"express\\\\\\":[],\\\\\\"filter\\\\\\":{\\\\\\"filters\\\\\\":[]},\\\\\\"groupby\\\\\\":[],\\\\\\"interval\\\\\\":60,\\\\\\"labels\\\\\\":[],\\\\\\"statistics\\\\\\":[{\\\\\\"alias\\\\\\":\\\\\\"referer_count\\\\\\",\\\\\\"function\\\\\\":\\\\\\"count\\\\\\",\\\\\\"key\\\\\\":\\\\\\"referer\\\\\\"}]}</SLSProcess>\\n\\t\\t<CollectTargetEndpoint></CollectTargetEndpoint>\\n\\t\\t<TaskName>aliyun_task</TaskName>\\n\\t\\t<UploadRegion>unknown</UploadRegion>\\n\\t\\t<NetworkType>vpc</NetworkType>\\n\\t\\t<TaskType>aliyun_sls</TaskType>\\n\\t\\t<CollectTargetType></CollectTargetType>\\n\\t\\t<TargetUserId></TargetUserId>\\n\\t</TaskList>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DescribeHybridMonitorTaskListResponse>\\t","errorExample":""}]', - 'title' => 'DescribeHybridMonitorTaskList', - 'description' => 'This topic provides an example on how to query all metric import tasks that belong to the current Alibaba Cloud account. The returned result indicates that the current account has only one metric import task. The metric import task is named `aliyun_task`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"RuleId\\": \\"123456\\"\\n }\\n}","type":"json"}]', ], 'PutHybridMonitorMetricData' => [ - 'summary' => 'Imports the monitoring data of a metric to a namespace of Hybrid Cloud Monitoring.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'For information about how to obtain the name of a namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-aliyun', - ], + 'schema' => ['description' => 'The name of the metric namespace.'."\n" + ."\n" + .'For information about how to obtain the name of a metric namespace, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => true, 'example' => 'default-aliyun', 'title' => ''], ], [ 'name' => 'MetricList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'title' => '上报的监控数据', - 'description' => 'The monitoring data.'."\n" + 'title' => '', + 'description' => 'The list of monitoring data.'."\n" ."\n" - .'Valid values of N: 1 to 100.'."\n", + .'Valid values of N: 1 to 100.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '指标名，只能是英文字母、数字、下划线', - 'description' => 'The metric name.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'The name can contain letters, digits, and underscores (\\_). The name must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CPU_Usage', - 'maxLength' => 128, - 'minLength' => 1, - 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]*$', - ], + 'Name' => ['title' => '', 'description' => 'The name of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'Format: The name can contain uppercase letters, lowercase letters, digits, and underscores (_). The name must start with an uppercase letter or a lowercase letter.', 'type' => 'string', 'required' => true, 'example' => 'CPU_Usage', 'maxLength' => 128, 'minLength' => 1, 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]*$'], 'Labels' => [ - 'title' => '标签，Key只能是英文字母、数字、下划线', - 'description' => 'The tags of the metric.'."\n" + 'title' => '', + 'description' => 'The list of labels of the metric.'."\n" ."\n" - .'Valid values of N: 1 to 100.'."\n", + .'Valid values of N: 1 to 100.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '只能是英文字母、数字、下划线', - 'description' => 'The tag key of the metric.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'The key can contain letters, digits, and underscores (\\_). The key must start with a letter or an underscore (\\_).'."\n" - ."\n" - .'> You must specify both the Key and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IP', - ], - 'Value' => [ - 'description' => 'The tag value of the metric.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'> You must specify both the Key and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX', - ], + 'Key' => ['title' => '', 'description' => 'The key of the label of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'Format: The key can contain uppercase letters, lowercase letters, digits, and underscores (_). The key must start with an uppercase letter, a lowercase letter, or an underscore (_).'."\n" + ."\n" + .'> Key and Value must be set at the same time.', 'type' => 'string', 'example' => 'IP', 'required' => false], + 'Value' => ['description' => 'The value of the label of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'> Key and Value must be set at the same time.', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'example' => 'app、ip、hostName等标识信息', + 'example' => '[{"Key":"app","Value":"testApp"},{"Key":"ip","Value":"192.168.XX.XX"},{"Key":"hostName","Value":"host01"}]', 'maxItems' => 20, ], - 'Value' => [ - 'title' => '监控值，浮点或整型', - 'description' => 'The value of the metric.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'The value must be an integer or a floating-point number.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '90', - 'pattern' => '^[0-9\\.]*$', - ], - 'TS' => [ - 'title' => '时间戳，unix毫秒数，如果不传会使用服务器时间', - 'description' => 'The time when the monitoring data is imported. The value is a timestamp.'."\n" - ."\n" - .'Valid values of N: 1 to 100.'."\n" - ."\n" - .'Unit: milliseconds. By default, the current time is used.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1640776119473', - ], + 'Value' => ['title' => '', 'description' => 'The value of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'Format: an integer or a floating-point number.', 'type' => 'string', 'required' => true, 'example' => '90', 'pattern' => '^[0-9\\.]*$'], + 'TS' => ['title' => '', 'description' => 'The timestamp when the monitoring data was reported.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n" + ."\n" + .'Unit: milliseconds. Default value: the current time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1640776119473'], ], 'required' => true, + 'title' => '', + 'example' => '', ], 'required' => true, 'maxItems' => 100, 'minItems' => 1, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '返回code', - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => '请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5DB1CBCA-D14A-55FA-814F-B4DBD9735F68', - ], + 'Code' => ['title' => '', 'description' => 'The status code.'."\n" + ."\n" + .'> The value 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5DB1CBCA-D14A-55FA-814F-B4DBD9735F68'], 'ErrorDetail' => [ - 'title' => '不合法的指标信息', - 'description' => 'The details of invalid parameters.'."\n" + 'title' => '', + 'description' => 'The details of the invalid parameters.'."\n" ."\n" - .'If a request parameter is invalid, the details of the invalid parameter are returned.'."\n", + .'If the request parameters that you specify do not meet the requirements, the details of the invalid parameters are displayed.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Index' => [ - 'title' => '错误数据在上报列表中的序号，从0开始', - 'description' => 'The position of the error message in the array.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ErrorMessage' => [ - 'title' => '错误信息', - 'description' => 'The error message of the invalid parameter.'."\n", - 'type' => 'string', - 'example' => 'label name :123 not match [a-zA-Z_][a-zA-Z0-9_]*', - ], + 'Index' => ['title' => '', 'description' => 'The position of the error information in the array.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ErrorMessage' => ['title' => '', 'description' => 'The error message that is returned for the invalid parameter.', 'type' => 'string', 'example' => 'label name :123 not match [a-zA-Z_][a-zA-Z0-9_]*'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"5DB1CBCA-D14A-55FA-814F-B4DBD9735F68\\",\\n \\"ErrorDetail\\": [\\n {\\n \\"Index\\": 0,\\n \\"ErrorMessage\\": \\"label name :123 not match [a-zA-Z_][a-zA-Z0-9_]*\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<PutHybridMonitorMetricDataResponse>\\r\\n\\t<RequestId>5DB1CBCA-D14A-55FA-814F-B4DBD9735F68</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n</PutHybridMonitorMetricDataResponse>\\t","errorExample":""}]', - 'title' => 'PutHybridMonitorMetricData', - 'description' => '## [](#)Prerequisites'."\n" - ."\n" - .'Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" - ."\n" - .'## [](#)Limits'."\n" - ."\n" - .'The size of the monitoring data that you import at a time must be less than or equal to 1 MB.'."\n" + 'title' => 'Reports monitoring data to a metric namespace', + 'summary' => 'Reports the specified monitoring data to a specified metric namespace of Enterprise CloudMonitor by calling the PutHybridMonitorMetricData operation.', + 'description' => '## Prerequisites'."\n" + .'Make sure that you have activated Enterprise CloudMonitor. For more information, see [Activate Enterprise CloudMonitor](~~250773~~).'."\n" ."\n" - .'## [](#)Operation description'."\n" + .'## Limits'."\n" + .'The size of the monitoring data that you can report at a time cannot exceed 1 MB.'."\n" ."\n" - .'This topic provides an example on how to import the monitoring data of the `CPU_Usage` metric to the `default-aliyun` namespace of Hybrid Cloud Monitoring.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + .'## Usage notes'."\n" + .'This topic provides an example to show how to report the monitoring data of the `CPU_Usage` metric to the `default-aliyun` metric namespace of Enterprise CloudMonitor.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n" + ."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeHybridMonitorDataList' => [ - 'summary' => 'Queries the monitoring data in a namespace.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2021-12-24T03:08:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-24T03:08:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-24T03:08:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-24T03:08:24.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutHybridMonitorMetricData'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutHybridMonitorMetricData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"5DB1CBCA-D14A-55FA-814F-B4DBD9735F68\\",\\n \\"ErrorDetail\\": [\\n {\\n \\"Index\\": 0,\\n \\"ErrorMessage\\": \\"label name :123 not match [a-zA-Z_][a-zA-Z0-9_]*\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'PutLogMonitor' => [ + 'summary' => 'Creates or modifies a log monitoring metric by calling the PutLogMonitor operation.', + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', + 'name' => 'LogId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n" - ."\n" - .'For more information about how to query the names of namespaces, see [DescribeHybridMonitorNamespaceList](~~428880~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'default-aliyun', - ], + 'schema' => ['description' => 'The ID of the log monitoring metric.', 'type' => 'string', 'required' => false, 'example' => '16****', 'title' => ''], ], [ - 'name' => 'PromSQL', + 'name' => 'SlsRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name.'."\n" - ."\n" - .'> PromQL statements are supported.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'AliyunEcs_cpu_total', - ], + 'schema' => ['description' => 'The region where the Log Service project resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Start', + 'name' => 'SlsProject', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Log Service project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], + ], + [ + 'name' => 'SlsLogstore', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Log Service Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The metric name. For information about the metrics supported by CloudMonitor for Alibaba Cloud services, see [Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'cpu_total', 'title' => ''], + ], + [ + 'name' => 'MetricExpress', + 'in' => 'query', + 'schema' => ['description' => 'The extended field. The extended field provides arithmetic operations on the results of the statistical methods.'."\n" + ."\n" + .'For example, if you configure the total number of HTTP status code requests (TotalNumber) and the number of requests with HTTP status codes greater than 499 (5xxNumber) in the statistical methods, you can use the extended field to calculate the server error rate: 5xxNumber/TotalNumber*100.'."\n" + ."\n" + .'JSON format: {"extend":{"errorPercent":"5xxNumber/TotalNumber*100"}}. Field description:'."\n" + ."\n" + .'- extend: required.'."\n" + ."\n" + .'- errorPercent: the alias of the new field generated from the calculation result. You can specify a custom name. '."\n" + ."\n" + .'- errorPercent: the calculation expression for existing fields.', 'type' => 'string', 'required' => false, 'example' => '{"extend":{"errorPercent":"5XXNumber/TotalNumber*100"}}', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '7301****', 'title' => ''], + ], + [ + 'name' => 'ValueFilterRelation', + 'in' => 'query', + 'schema' => ['description' => 'The logical operator used to combine log filter conditions. Valid values:'."\n" + ."\n" + .'- and'."\n" + ."\n" + .'- or'."\n" + ."\n" + .'> This parameter must be used together with `ValueFilter.N.Key`.', 'type' => 'string', 'required' => true, 'example' => 'and', 'title' => ''], + ], + [ + 'name' => 'Tumblingwindows', + 'in' => 'query', + 'schema' => ['description' => 'The tumbling window size for pre-aggregation. Unit: seconds. CloudMonitor performs an aggregation calculation on the data at the specified interval.', 'type' => 'string', 'required' => false, 'example' => '60,300', 'title' => ''], + ], + [ + 'name' => 'Unit', 'in' => 'query', + 'schema' => ['description' => 'The unit.', 'type' => 'string', 'required' => false, 'example' => 'Percent', 'title' => ''], + ], + [ + 'name' => 'Aggregates', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The start of the time range to query.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The aggregate function definitions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The name of the original field for aggregation. Valid values of N: 1 to 10.', 'type' => 'string', 'required' => true, 'example' => 'sourceCount', 'title' => ''], + 'Function' => ['description' => 'The statistical method used to aggregate log data within a statistical period. Valid values of N: 1 to 10. Valid values:'."\n" + .'- count: counts the number of occurrences.'."\n" + .'- sum: calculates the sum.'."\n" + .'- avg: calculates the average.'."\n" + .'- max: returns the maximum value.'."\n" + .'- min: returns the minimum value.'."\n" + .'- countps: calculates the average count per second for the specified field within the statistical period.'."\n" + .'- sumps: calculates the average sum per second for the specified field within the statistical period.'."\n" + .'- distinct: counts the number of occurrences of the specified field after deduplication within the statistical period.', 'type' => 'string', 'required' => true, 'example' => 'count', 'title' => ''], + 'Alias' => ['description' => 'The alias of the aggregate function. Valid values of N: 1 to 10.', 'type' => 'string', 'required' => true, 'example' => 'Count', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'docRequired' => false, - 'example' => '1653804865', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'End', + 'name' => 'Groupbys', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => false, - 'example' => '1653805225', + 'description' => 'The dimensions used for spatial aggregation. This is equivalent to the Group By clause in SQL, which groups monitoring data by specified dimensions. If no dimension is specified, all monitoring data is aggregated based on the aggregate function.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The name of the Group By field. Valid values of N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => 'cpu', 'title' => ''], + 'Alias' => ['description' => 'The alias of the Group By field. Valid values of N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => 'CPUUtilization', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Period', + 'name' => 'ValueFilter', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The statistical period of the monitoring data.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', + 'description' => 'The filter rules, used together with ValueFilterRelation. This is equivalent to the Where clause in SQL. If this parameter is not specified, all data is processed. For example, if the log contains Level and Error fields and you want to count the number of Error occurrences per minute, you can define the statistical method to sum the Level field with the condition Level=Error.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The name of the log field to match. Valid values of N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => 'lh_source', 'title' => ''], + 'Value' => ['description' => 'The value of the log field to match. Valid values of N: 1 to 10.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'Operator' => ['description' => 'The matching method for the field value. Valid values of N: 1 to 10. Valid values:'."\n" + .'- `contain`: contains.'."\n" + .'- `notContain`: does not contain.'."\n" + .'- `>`: greater than.'."\n" + .'- `<`: less than.'."\n" + .'- `>=`: greater than or equal to.'."\n" + .'- `<=`: less than or equal to.', 'type' => 'string', 'required' => false, 'example' => 'contain', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => '60', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'end timestamp must not be before start time.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C240412F-3F5F-50E2-ACEC-DE808EF9C4BE', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'TimeSeries' => [ - 'description' => 'The returned monitoring data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MetricName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'AliyunEcs_cpu_total', - ], - 'Labels' => [ - 'description' => 'The tags of the time dimension.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'K' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'instanceId', - ], - 'V' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'i-rj99xc6cptkk64ml****', - ], - ], - ], - ], - 'Values' => [ - 'description' => 'The metric values that are collected at different timestamps.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'V' => [ - 'description' => 'The metric value.'."\n", - 'type' => 'string', - 'example' => '0.13', - ], - 'Ts' => [ - 'description' => 'The timestamp that indicates the time when the metric value is collected.'."\n" - ."\n" - .'Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '1653804865', - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Results:'."\n" + ."\n" + .'- If the operation is successful, `successful` is returned.'."\n" + ."\n" + .'- If the operation fails, an error message is returned, such as `alias of aggreate must be set value.`.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '91561287-0802-5F9C-9BDE-404C50D41B06', 'title' => ''], + 'LogId' => ['description' => 'The ID of the log monitoring metric.', 'type' => 'string', 'example' => '16****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + ."\n" + .'- true: The operation is successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'Bad request.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'LimitorError', 'errorMessage' => 'Log monitor limit is not enough', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => 'Resources already exist.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"end timestamp must not be before start time.\\",\\n \\"RequestId\\": \\"C240412F-3F5F-50E2-ACEC-DE808EF9C4BE\\",\\n \\"Success\\": \\"true\\",\\n \\"TimeSeries\\": [\\n {\\n \\"MetricName\\": \\"AliyunEcs_cpu_total\\",\\n \\"Labels\\": [\\n {\\n \\"K\\": \\"instanceId\\",\\n \\"V\\": \\"i-rj99xc6cptkk64ml****\\"\\n }\\n ],\\n \\"Values\\": [\\n {\\n \\"V\\": \\"0.13\\",\\n \\"Ts\\": \\"1653804865\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeHybridMonitorDataList>\\n\\t<TimeSeries>\\n\\t\\t<MetricName>AliyunEcs_cpu_total</MetricName>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.13</V>\\n\\t\\t\\t<Ts>1653804865</Ts>\\n\\t\\t</Values>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.13</V>\\n\\t\\t\\t<Ts>1653804925</Ts>\\n\\t\\t</Values>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.13</V>\\n\\t\\t\\t<Ts>1653804985</Ts>\\n\\t\\t</Values>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.17</V>\\n\\t\\t\\t<Ts>1653805045</Ts>\\n\\t\\t</Values>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.23</V>\\n\\t\\t\\t<Ts>1653805105</Ts>\\n\\t\\t</Values>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.2</V>\\n\\t\\t\\t<Ts>1653805165</Ts>\\n\\t\\t</Values>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.13</V>\\n\\t\\t\\t<Ts>1653805225</Ts>\\n\\t\\t</Values>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>rg-acfmw3ty5y7****</V>\\n\\t\\t\\t<K>rmgroup_id</K>\\n\\t\\t</Labels>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>ESS</V>\\n\\t\\t\\t<K>tag_ess</K>\\n\\t\\t</Labels>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>hostname1</V>\\n\\t\\t\\t<K>hostname</K>\\n\\t\\t</Labels>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>i-rj99xc6cptkk64ml****</V>\\n\\t\\t\\t<K>instanceId</K>\\n\\t\\t</Labels>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>cn-hangzhou</V>\\n\\t\\t\\t<K>regionId</K>\\n\\t\\t</Labels>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>192.168.XX.XX</V>\\n\\t\\t\\t<K>ipgroup</K>\\n\\t\\t</Labels>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>120886317861****</V>\\n\\t\\t\\t<K>userId</K>\\n\\t\\t</Labels>\\n\\t</TimeSeries>\\n\\t<RequestId>C240412F-3F5F-50E2-ACEC-DE808EF9C4BE</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DescribeHybridMonitorDataList>\\t","errorExample":""}]', - 'title' => 'DescribeHybridMonitorDataList', - 'description' => '## [](#)Prerequisites'."\n" - ."\n" - .'Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" - ."\n" - .'## [](#)Limits'."\n" - ."\n" - .'The size of monitoring data that is returned in each call cannot exceed 1.5 MB. If the returned data reaches the upper limit, the query fails. You must reset the query conditions.'."\n" - ."\n" - .'## [](#)Operation description'."\n" - ."\n" - .'This topic provides an example to show how to query the monitoring data of the `AliyunEcs_cpu_total` metric in the `default-aliyun` namespace from `1653804865` (14:14:25 on May 29, 2022) to `1653805225` (14:20:25 on May 29, 2022).'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", - ], - 'CreateHybridMonitorSLSGroup' => [ - 'summary' => 'Creates a Logstore group of Hybrid Cloud Monitoring.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Create or modify a log monitoring metric', + 'description' => 'This topic provides an example of how to create a log monitoring metric named `cpu_total`. The response shows that the log monitoring metric is created. The log monitoring metric ID is `16****`.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-11-04T08:57:18.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-11-04T08:57:18.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutLogMonitor'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutLogMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"91561287-0802-5F9C-9BDE-404C50D41B06\\",\\n \\"LogId\\": \\"16****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'PutMetricRuleTargets' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'SLSGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore group.'."\n" - ."\n" - .'The name must be 2 to 32 characters in length and can contain uppercase letters, lowercase letters, digits, and underscores (\\_). The name must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Logstore_test', - ], - ], - [ - 'name' => 'SLSGroupDescription', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the Logstore group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'For information about how to obtain the alert rule ID, see [DescribeMetricRuleList](~~114941~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ae06917_75a8c43178ab66****', 'title' => ''], ], [ - 'name' => 'SLSGroupConfig', + 'name' => 'Targets', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The configurations of the Logstore group.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", + 'description' => 'None.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'SLSRegion' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - 'SLSProject' => [ - 'description' => 'The Simple Log Service project.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-project', - ], - 'SLSLogstore' => [ - 'description' => 'The Logstore.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Logstore-ECS', - ], - 'SLSUserId' => [ - 'description' => 'The member ID.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n" - ."\n" - .'If you call this operation by using the management account of a resource directory, you can connect the Alibaba Cloud services that are activated for all members in the resource directory to Hybrid Cloud Monitoring. You can use the resource directory to monitor Alibaba Cloud services across enterprise accounts.'."\n" - ."\n" - .'> If a member uses CloudMonitor for the first time, you must make sure that the service-linked role AliyunServiceRoleForCloudMonitor is attached to the member. For more information, see [Manage the service-linked role for CloudMonitor](~~170423~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '120886317861****', - ], + 'Id' => ['description' => 'The ID of the alert trigger target.'."\n" + ."\n" + .'For information about how to obtain the alert trigger target ID, see [DescribeMetricRuleTargets](~~121592~~).', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the resource. Simple Message Queue (formerly MNS), elastic scaling (ESS), Simple Log Service (SLS), and Function Compute (FC) are supported.'."\n" + ."\n" + .'The following section describes the ARN parameter metric description for Simple Message Queue (formerly MNS):'."\n" + ."\n" + .'`acs:mns:{regionId}:{userId}:/{Resource type}/{Resource name}/message`'."\n" + ."\n" + .'- {regionId}: the region where the MSMQ or topic of Simple Message Queue (formerly MNS) resides.'."\n" + .'- {userId}: the Alibaba Cloud account that owns the resource.'."\n" + .'- {Resource type}: the type of the resource that accepts alert notifications. Valid values:'."\n" + ."\n" + .' - **queues**: queue.'."\n" + .' - **topics**: topic.'."\n" + ."\n" + .'- {Resource name}: the name of the resource.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + .' - If the resource type is **topics**, the resource name is the topic name.'."\n" + ."\n" + .'ARN for elastic scaling:'."\n" + ."\n" + .'acs:ess:{regionId}:{userId}:scalingGroupId/{Scaling group ID}:scalingRuleId/{Scaling rule ID}'."\n" + ."\n" + .'ARN for Simple Log Service:'."\n" + ."\n" + .'acs:log:{regionId}:{userId}:project/{Project name}/logstore/{Logstore name}'."\n" + ."\n" + .'ARN for Function Compute:'."\n" + ."\n" + .'acs:fc:{regionId}:{userId}:services/{Service name}/functions/{Function name}.', 'type' => 'string', 'required' => true, 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: information.'."\n" + .'- WARN: warning.'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'required' => false, 'example' => '["INFO", "WARN", "CRITICAL"]', 'title' => ''], + 'JsonParams' => ['description' => 'The JSON-formatted parameters of the alert callback.', 'type' => 'string', 'required' => false, 'example' => '{"customField1":"value1","customField2":"$.name"}', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, - 'maxItems' => 30, - 'minItems' => 1, + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Duplicate.SLSGroup', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request processing has failed due to some unknown error.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A569B0D-9055-58AF-9E82-BAEAF95C0FD5', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: successful.'."\n" + ."\n" + .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FailData' => [ + 'description' => 'The list of failures.', + 'type' => 'object', + 'properties' => [ + 'Targets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => 'The alert trigger targets.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the alert trigger target.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Arn' => ['description' => 'The ARN of the resource. Format: `acs:{Abbreviation of the Alibaba Cloud service}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. Simple Message Queue (formerly MNS), elastic scaling (ESS), Simple Log Service (SLS), and Function Compute (FC) are supported. Example: `acs:mns:ap-southeast-1:120886317861****:/queues/test123/message`. The following section describes the ARN parameter metric description for Simple Message Queue (formerly MNS):'."\n" + ."\n" + .'- {Abbreviation of the Alibaba Cloud service}: mns'."\n" + ."\n" + .'- {userId}: the Alibaba Cloud account ID.'."\n" + ."\n" + .'- {regionId}: the region where the MSMQ or topic of Simple Message Queue (formerly MNS) resides.'."\n" + ."\n" + .'- {Resource type}: the type of the resource that accepts alert notifications. Valid values:'."\n" + ."\n" + .' - **queues**: queue.'."\n" + .' - **topics**: topic.'."\n" + ."\n" + .'- {Resource name}: the name of the resource.'."\n" + ."\n" + .' - If the resource type is **queues**, the resource name is the queue name.'."\n" + .' - If the resource type is **topics**, the resource name is the topic name.', 'type' => 'string', 'example' => 'acs:mns:cn-hangzhou:111:/queues/test/message', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + ."\n" + .'- INFO: information.'."\n" + .'- WARN: warning.'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'example' => '["INFO", "WARN", "CRITICAL"]', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 200 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'ParameterInvalid', - 'errorMessage' => 'The parameter is missing or invalid. %s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'InvalidAuthorization', - 'errorMessage' => 'Permission denied.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => 'The specified resource is not found.', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 500 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 412 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ], + 'title' => 'Add or modify push channels for a specified alert rule', + 'summary' => 'Adds or modifies push channels for a specified alert rule by calling the PutMetricRuleTargets operation.', + 'description' => '## Usage notes'."\n" + .'This topic provides an example on how to associate the resource `acs:mns:ap-southeast-1:120886317861****:/queues/test/message` with the alert rule `ae06917_75a8c43178ab66****`. The alert trigger target ID is `1`. The response shows that the resource is associated.', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-03-21T06:36:40.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutMetricRuleTargets'], ], - 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutMetricRuleTargets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Duplicate.SLSGroup\\",\\n \\"RequestId\\": \\"66683237-7126-50F8-BBF8-D67ACC919A17\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateHybridMonitorSLSGroupResponse>\\n <RequestId>66683237-7126-50F8-BBF8-D67ACC919A17</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateHybridMonitorSLSGroupResponse>","errorExample":""}]', - 'title' => 'CreateHybridMonitorSLSGroup', - 'description' => '### [](#)Prerequisites'."\n" - ."\n" - .'Simple Log Service is activated. A project and a Logstore are created in Simple Log Service. For more information, see [Getting Started](~~54604~~).'."\n" - ."\n" - .'### [](#)Operation description'."\n" - ."\n" - .'This topic provides an example on how to create a Logstore group named `Logstore_test`. The region ID is `cn-hangzhou`. The project is `aliyun-project`. The Logstore is `Logstore-ECS`. The response shows that the Logstore group is created.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\": \\"6A569B0D-9055-58AF-9E82-BAEAF95C0FD5\\",\\n \\"Success\\": true,\\n \\"FailData\\": {\\n \\"Targets\\": {\\n \\"Target\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Arn\\": \\"acs:mns:cn-hangzhou:111:/queues/test/message\\",\\n \\"Level\\": \\"[\\\\\\"INFO\\\\\\", \\\\\\"WARN\\\\\\", \\\\\\"CRITICAL\\\\\\"]\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', ], - 'ModifyHybridMonitorSLSGroup' => [ - 'summary' => 'Modifies a Logstore group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutMonitorGroupDynamicRule' => [ + 'summary' => 'Creates or modifies an alert rule to dynamically add instances that meet the rule to an application group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'SLSGroupName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore group.'."\n" - ."\n" - .'For information about how to obtain the name of a Logstore group, see [DescribeHybridMonitorSLSGroup](~~429526~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Logstore_test', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'SLSGroupDescription', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the Logstore group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'SLSGroupConfig', + 'name' => 'GroupRules', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The configurations of the Logstore group.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", + 'description' => 'None.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'SLSRegion' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - 'SLSProject' => [ - 'description' => 'The Simple Log Service project.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-project', - ], - 'SLSLogstore' => [ - 'description' => 'The Logstore.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n", - 'type' => 'string', + 'FilterRelation' => ['description' => 'The logical operator used between conditional expressions in the alert rule. Valid values of N: 1 to 3. Valid values:'."\n" + ."\n" + .'- and: The instances that meet all the conditional expressions are automatically added to the application group.'."\n" + ."\n" + .'- or: The instances that meet one of the conditional expressions are automatically added to the application group.', 'type' => 'string', 'required' => true, 'example' => 'and', 'title' => ''], + 'Filters' => [ + 'description' => 'None.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The value to be matched with the specified field. Valid values of N: 1 to 3.', 'type' => 'string', 'required' => true, 'example' => 'nginx', 'title' => ''], + 'Name' => ['description' => 'The name of the field based on which instances are filtered. Valid values of N: 1 to 3.'."\n" + ."\n" + .'Only hostnames are supported. Example: hostName.', 'type' => 'string', 'required' => true, 'example' => 'hostName', 'title' => ''], + 'Function' => ['description' => 'The method that is used to filter instances. Valid values of N: 1 to 3. Valid values:'."\n" + ."\n" + .'- contains: contains'."\n" + ."\n" + .'- notContains: does not contain'."\n" + ."\n" + .'- startWith: starts with a prefix'."\n" + ."\n" + .'- endWith: ends with a suffix', 'type' => 'string', 'required' => true, 'example' => 'contains', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'Logstore-aliyun-all', - ], - 'SLSUserId' => [ - 'description' => 'The member ID.'."\n" - ."\n" - .'Valid values of N: 1 to 25.'."\n" - ."\n" - .'If you call this operation by using the management account of a resource directory, you can connect the Alibaba Cloud services that are activated for all members in the resource directory to Hybrid Cloud Monitoring. You can use the resource directory to monitor Alibaba Cloud services across enterprise accounts.'."\n" - ."\n" - .'> If a member uses CloudMonitor for the first time, you must make sure that the service-linked role AliyunServiceRoleForCloudMonitor is attached to the member. For more information, see [Manage the service-linked role for CloudMonitor](~~170423~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '120886317861****', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], + 'Category' => ['description' => 'The cloud service to which the alert rule is applied. Valid values of N: 1 to 3. Valid values:'."\n" + ."\n" + .'- ecs: Elastic Compute Service (ECS)'."\n" + ."\n" + .'- rds: ApsaraDB RDS'."\n" + ."\n" + .'- slb: Server Load Balancer (SLB)', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, - 'maxItems' => 30, - 'minItems' => 1, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'IsAsync', + 'in' => 'query', + 'schema' => ['description' => 'The mode for creating the alert rule. Valid values:'."\n" + ."\n" + .'- true: creates asynchronously'."\n" + ."\n" + .'- false (default): creates synchronously', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'NotFound.SLSGroup', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3E73F1AB-D195-438A-BCA7-2F4355789C58', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + [ + ['errorCode' => 'AccessDeniedException', 'errorMessage' => 'You donot have sufficient access to perform this action.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'LimitExceeded', 'errorMessage' => 'The quota for this customer had been reached.', 'description' => ''], + ], + [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 412 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'OverLimit', 'errorMessage' => 'Matched instances count was over limit', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttli∂ngException', 'errorMessage' => 'The request was denied due to request throttling.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'PutMonitorGroupDynamicRule', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-12-27T07:31:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-01-27T07:02:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-27T07:02:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-27T07:02:52.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutMonitorGroupDynamicRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutMonitorGroupDynamicRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'MonitorGroup', 'arn' => 'acs:cms::{#accountId}:group/{#groupId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"NotFound.SLSGroup\\",\\n \\"RequestId\\": \\"66683237-7126-50F8-BBF8-D67ACC919A17\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyHybridMonitorSLSGroupResponse>\\n <RequestId>66683237-7126-50F8-BBF8-D67ACC919A17</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyHybridMonitorSLSGroupResponse>","errorExample":""}]', - 'title' => 'ModifyHybridMonitorSLSGroup', - 'description' => 'In this example, a Logstore group named `Logstore_test` is modified. The Logstore of the `aliyun-project` project in the `cn-hangzhou` region is changed to `Logstore-aliyun-all`. The response shows that the Logstore group is modified.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3E73F1AB-D195-438A-BCA7-2F4355789C58\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DeleteHybridMonitorSLSGroup' => [ - 'summary' => 'Deletes a Logstore group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutMonitoringConfig' => [ + 'summary' => 'Calls the PutMonitoringConfig operation to set the global configuration of the CloudMonitor agent.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'SLSGroupName', + 'name' => 'AutoInstall', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore group.'."\n" - ."\n" - .'For information about how to obtain the name of a Logstore group, see [DescribeHybridMonitorSLSGroup](~~429526~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Logstore_test', - ], + 'schema' => ['description' => 'This parameter is deprecated and can be ignored.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'EnableInstallAgentNewECS', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to automatically install the CloudMonitor agent on newly purchased ECS instances. Valid values:'."\n" + .'- true (default): The CloudMonitor agent is automatically installed on newly purchased ECS instances.'."\n" + ."\n" + .'- false: The CloudMonitor agent is not automatically installed on newly purchased ECS instances.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'RESOURCE_NOT_FOUND', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '85198BFF-1DE6-556E-B6A4-C77C51C62B8D', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Specified parameter EnableInstallAgentNewECS is not valid.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '109C8095-6FAD-4DBB-B013-6ED18CE4C0B1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - ], - 412 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InvalidAuthorization', 'errorMessage' => 'The Request is not authorization.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Specified parameter EnableInstallAgentNewECS is not valid.\\",\\n \\"RequestId\\": \\"109C8095-6FAD-4DBB-B013-6ED18CE4C0B1\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Set the global configuration of the cloudMonitor agent', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutMonitoringConfig'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutMonitoringConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"RESOURCE_NOT_FOUND\\",\\n \\"RequestId\\": \\"85198BFF-1DE6-556E-B6A4-C77C51C62B8D\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteHybridMonitorSLSGroupResponse>\\n <RequestId>85198BFF-1DE6-556E-B6A4-C77C51C62B8D</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteHybridMonitorSLSGroupResponse>","errorExample":""}]', - 'title' => 'DeleteHybridMonitorSLSGroup', - 'description' => 'This topic provides an example on how to delete a Logstore group named `Logstore_test`. The response shows that the Logstore group is deleted.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", ], - 'DescribeHybridMonitorSLSGroup' => [ - 'summary' => 'Queries Logstore groups.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutResourceMetricRule' => [ + 'summary' => 'Sets an alert rule.', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Keyword', + 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used to search for Logstore groups.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Logstore', - ], + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'You can enter a new alert rule ID or use the ID of an existing alert rule in CloudMonitor. For more information about how to query alert rule IDs, see [DescribeMetricRuleList](~~114941~~).'."\n" + ."\n" + .'> If you enter a new alert rule ID, a threshold alert rule is created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Minimum value: 1. Default value: 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'You can enter a new alert rule name or use the name of an existing alert rule in CloudMonitor. For more information about how to query alert rule names, see [DescribeMetricRuleList](~~114941~~).'."\n" + ."\n" + .'> If you enter a new alert rule name, a threshold alert rule is created.', 'type' => 'string', 'required' => true, 'example' => 'test123', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace of the Alibaba Cloud service. For more information about how to query the namespace of an Alibaba Cloud service, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> If you create a Prometheus alert rule for Hybrid Cloud Monitoring, set this parameter to `acs_prometheus`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metric. For more information about how to query metric names, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> If you create a Prometheus alert rule for Hybrid Cloud Monitoring, this parameter specifies the name of the metric repository. For more information about how to obtain the metric repository name, see [DescribeHybridMonitorNamespaceList](~~428880~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_total', 'title' => ''], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'schema' => ['description' => 'The resource information, such as `[{"instanceId":"i-uf6j91r34rnwawoo****"}]` or `[{"userId":"100931896542****"}]`.'."\n" + ."\n" + .'For more information about the supported monitoring dimensions, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '[{"instanceId":"i-uf6j91r34rnwawoo****"}]', 'title' => ''], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => ['description' => 'The alert contact group. Alert notifications are sent to the alert contacts in the alert contact group.'."\n" + ."\n" + .'> An alert contact group is a group of alert contacts that can contain one or more alert contacts. For more information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ECS_Group', 'title' => ''], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => ['description' => 'The callback URL to which a POST request is sent when an alert is triggered.', 'type' => 'string', 'required' => false, 'example' => 'https://alert.aliyun.com.com:8080/callback', 'title' => ''], + ], + [ + 'name' => 'EffectiveInterval', + 'in' => 'query', + 'schema' => ['description' => 'The effective period of the alert rule.', 'type' => 'string', 'required' => false, 'example' => '00:00-23:59', 'title' => ''], + ], + [ + 'name' => 'NoEffectiveInterval', + 'in' => 'query', + 'schema' => ['description' => 'The time range during which the alert rule is ineffective.', 'type' => 'string', 'required' => false, 'example' => '00:00-06:00', 'title' => ''], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => ['description' => 'The mute period. Unit: seconds. Default value: 86400.'."\n" + ."\n" + .'> The mute period specifies the interval at which an alert notification is re-sent if the alert does not recover to Normal.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '86400', 'example' => '86400', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The statistical period of the metric. Unit: seconds. The default value is the original reporting period of the metric.'."\n" + ."\n" + .'> For more information about how to query the statistical period of a metric, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The trigger period of the alert rule. Unit: seconds.'."\n" + ."\n" + .'> For more information about how to query the statistical period of a metric, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'EmailSubject', + 'in' => 'query', + 'schema' => ['description' => 'The subject of the alert email.', 'type' => 'string', 'required' => false, 'example' => 'ECS instance alert', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.Statistics', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method for the Critical level.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> At least one of the alert levels Critical (critical), Warn (warning), or Info (information) must be settings. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for the Critical level. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for the Critical level.'."\n" + ."\n\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Escalations.Critical.Times', + 'in' => 'query', + 'schema' => ['description' => 'The retry count for the Critical level.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.Statistics', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method for the Warn level.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> At least one of the alert levels Critical (critical), Warn (warning), or Info (information) must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.ComparisonOperator', 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for the Warn level. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for the Warn level.'."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Escalations.Warn.Times', + 'in' => 'query', + 'schema' => ['description' => 'The retry count for the Warn level.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.Statistics', + 'in' => 'query', + 'schema' => ['description' => 'The statistical method for the Info level.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column corresponding to the `MetricName` of the specified Alibaba Cloud service, such as Maximum, Minimum, and Average. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> At least one of the alert levels Critical (critical), Warn (warning), or Info (information) must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.ComparisonOperator', + 'in' => 'query', + 'schema' => ['description' => 'The comparison operator for the Info level. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The threshold for the Info level.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'Escalations.Info.Times', + 'in' => 'query', + 'schema' => ['description' => 'The retry count for the Info level.'."\n" + ."\n" + .'> At least one of the alert levels Critical, Warn, or Info must be set. The parameters Statistics, ComparisonOperator, Threshold, and Times must be set together for the specified alert level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'NoDataPolicy', + 'in' => 'query', + 'schema' => ['description' => 'The processing method when no monitoring data is found. Valid values:'."\n" + ."\n" + .'- KEEP\\_LAST\\_STATE (default): No action is performed.'."\n" + .'- INSUFFICIENT\\_DATA: An alert whose content is "Insufficient Data" is triggered.'."\n" + .'- OK: The status is considered normal.', 'type' => 'string', 'required' => false, 'example' => 'KEEP_LAST_STATE', 'title' => ''], + ], + [ + 'name' => 'CompositeExpression', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The page number.'."\n" + 'description' => 'The alert conditions for multiple metrics.'."\n" ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'string', + .'> Single-metric and multi-metric alert conditions are mutually exclusive and cannot be set at the same time.', + 'type' => 'object', + 'properties' => [ + 'ExpressionList' => [ + 'description' => 'The list of alert conditions created in standard mode.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'MetricName' => ['description' => 'The metric name of the Alibaba Cloud service.', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + 'Period' => ['description' => 'The aggregation period of the metric.'."\n" + ."\n" + .'Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], + 'Statistics' => ['description' => 'The statistical method of the metric. Valid values:'."\n" + .'- $Maximum: maximum value.'."\n" + .'- $Minimum: minimum value.'."\n" + .'- $Average: average value.'."\n" + .'- $Availability: availability rate (typically used for site monitoring).'."\n" + ."\n" + .'> `$` is the unified prefix for metrics. For more information about supported Alibaba Cloud services, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '$Maximum', 'title' => ''], + 'ComparisonOperator' => ['description' => 'The comparison operator for the threshold. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ExpressionListJoin' => ['description' => 'The relationship between multi-metric alert conditions. Valid values: '."\n" + ."\n" + .'- `&&`: An alert is triggered only when all metrics meet the alert conditions. An alert is triggered only when all expressions in ExpressionList evaluate to `true`.'."\n" + ."\n" + .'- `||`: An alert is triggered when any metric meets the alert conditions.', 'type' => 'string', 'required' => false, 'example' => '||', 'title' => ''], + 'ExpressionRaw' => ['description' => 'The alert condition created by using an expression. This includes but is not limited to the following scenarios:'."\n" + ."\n" + .'- Set an alert blacklist for specific resources. For example, `$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50` specifies that no alert is triggered for the instance `i-io8kfvcpp7x5****` even if its `Average` exceeds 50.'."\n" + .'- Set a special alert threshold for a specific instance in the rule. For example, `$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)` specifies that an alert is triggered for the instance `i-io8kfvcpp7x5****` only when its `Average` exceeds 80, while an alert is triggered for other instances when their `Average` exceeds 50.'."\n" + .'- Limit the number of instances that exceed the threshold. For example, `count($Average > 20) > 3` specifies that an alert is triggered only when more than three instances in the alert rule have an `Average` greater than 20.', 'type' => 'string', 'required' => false, 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + .'- CRITICAL: critical.'."\n" + .'- WARN: warning.'."\n" + .'- INFO: information.', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL', 'title' => ''], + 'Times' => ['description' => 'The number of times that the alert condition must be met before an alert notification is sent.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SLSGroupName', + 'name' => 'Labels', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the Logstore group.'."\n", - 'type' => 'string', + 'description' => 'When the metric meets the alert condition and an alert is triggered, the labels are written to the metric and displayed in the alert notification.'."\n" + ."\n" + .'> This feature is the same as the Label feature in Prometheus alerting.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The label key.', 'type' => 'string', 'required' => false, 'example' => 'tagKey1', 'title' => ''], + 'Value' => ['description' => 'The label value.'."\n" + ."\n" + .'> The label value supports template parameters. Template parameters are replaced with actual label values.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'Logstore_test', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Prometheus', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'None.'."\n", + 'description' => 'The Prometheus alert configuration.'."\n" + ."\n" + .'> Set this parameter only when you create a Prometheus alert rule for Hybrid Cloud Monitoring.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'NotFound.SLSGroup', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + 'PromQL' => ['description' => 'The PromQL query statement.'."\n" + ."\n" + .'> The data retrieved by the PromQL query statement is the alert data. Include the alert threshold in this statement.', 'type' => 'string', 'required' => false, 'example' => 'cpuUsage{instanceId="xxxx"}[1m]>90', 'title' => ''], + 'Level' => ['description' => 'The alert level. Valid values:'."\n" + .'- CRITICAL: critical.'."\n" + .'- WARN: warning.'."\n" + .'- INFO: information.', 'type' => 'string', 'required' => false, 'example' => 'CRITICAL', 'title' => ''], + 'Times' => ['description' => 'The number of times that the alert condition must be met before an alert notification is sent.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Annotations' => [ + 'description' => 'The annotations for Prometheus alerting. The annotation keys and values are rendered to help you understand the metrics or alert rules.'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => '', - ], - 'List' => [ - 'description' => 'The queried Logstore groups.'."\n", + .'> This feature is equivalent to the Annotation feature in Prometheus.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'SLSGroupName' => [ - 'description' => 'The name of the Logstore group.'."\n", - 'type' => 'string', - 'format' => 'int64', - 'example' => 'Logstore_test', - ], - 'SLSGroupDescription' => [ - 'description' => 'The description of the Logstore group.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'SLSGroupConfig' => [ - 'description' => 'The configurations of the Logstore group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SLSRegion' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'SLSProject' => [ - 'description' => 'The Simple Log Service project.'."\n", - 'type' => 'string', - 'example' => 'aliyun-project', - ], - 'SLSLogstore' => [ - 'description' => 'The Logstore.'."\n", - 'type' => 'string', - 'example' => 'Logstore-aliyun-all', - ], - 'SLSUserId' => [ - 'description' => 'The member ID.'."\n" - ."\n" - .'**Description** This parameter is returned when you call the operation by using an administrative account.', - 'type' => 'string', - 'example' => '120886317861****', - ], - ], - ], - ], - 'CreateTime' => [ - 'description' => 'The time when the Logstore group was created.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1652845630000', - ], - 'UpdateTime' => [ - 'description' => 'The time when the Logstore group was modified.'."\n" - ."\n" - .'Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1652845630000', - ], + 'Key' => ['description' => 'The annotation key.', 'type' => 'string', 'required' => false, 'example' => 'summary', 'title' => ''], + 'Value' => ['description' => 'The annotation value.', 'type' => 'string', 'required' => false, 'example' => '{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'SendOK', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to send a recovery notification.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request processing has failed due to some unknown error.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '65D50468-ECEF-48F1-A6E1-D952E89D9436', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 409 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 412 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + 429 => [ + ['errorCode' => 'ResourceOverLimit', 'errorMessage' => 'The resource has exceeded the limit. %s', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '%s', + 499 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Set a threshold alert rule for a specified metric of a specified resource', + 'description' => 'This topic provides an example on how to set a threshold alert rule for the `cpu_total` metric of the Elastic Computing Service (ECS) instance `i-uf6j91r34rnwawoo****` in the `acs_ecs_dashboard` namespace. The alert contact group is `ECS_Group`, the alert rule name is `test123`, the alert rule ID is `a151cd6023eacee2f0978e03863cc1697c89508****`, the statistical method for the Critical level is `Average`, the comparison operator for the Critical level is `GreaterThanOrEqualToThreshold`, the threshold for the Critical level is `90`, and the retry count for the Critical level is `3`.'."\n" + .'> As of August 15, 2024, Statistics validation is increased. The statistical value must match the Statistics of the corresponding metric. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](https://www.alibabacloud.com/help/en/cms/support/appendix-1-metrics).', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-01T02:36:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-27T11:46:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-26T09:11:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-05T04:05:02.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-07-29T09:41:36.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutResourceMetricRule'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutResourceMetricRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"NotFound.SLSGroup\\",\\n \\"RequestId\\": \\"66683237-7126-50F8-BBF8-D67ACC919A17\\",\\n \\"Success\\": \\"无。\\",\\n \\"List\\": [\\n {\\n \\"SLSGroupName\\": 0,\\n \\"SLSGroupDescription\\": \\"阿里云产品归属的Logstore组。\\",\\n \\"SLSGroupConfig\\": [\\n {\\n \\"SLSRegion\\": \\"cn-hangzhou\\",\\n \\"SLSProject\\": \\"aliyun-project\\",\\n \\"SLSLogstore\\": \\"Logstore-aliyun-all\\",\\n \\"SLSUserId\\": \\"120886317861****\\"\\n }\\n ],\\n \\"CreateTime\\": \\"1652845630000\\",\\n \\"UpdateTime\\": \\"1652845630000\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 2\\n}","errorExample":""},{"type":"xml","example":"<DescribeHybridMonitorSLSGroupResponse>\\n <RequestId>66683237-7126-50F8-BBF8-D67ACC919A17</RequestId>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>2</Total>\\n <List>\\n <CreateTime>1652845630000</CreateTime>\\n <SLSGroupName>Logstore_test</SLSGroupName>\\n <UpdateTime>1652845630000</UpdateTime>\\n <SLSGroupDescription/>\\n <SLSGroupConfig>\\n <SLSProject>aliyun-project</SLSProject>\\n <SLSRegion>cn-hangzhou</SLSRegion>\\n <SLSLogstore>Logstore-aliyun-all</SLSLogstore>\\n </SLSGroupConfig>\\n </List>\\n <List>\\n <CreateTime>1649230049000</CreateTime>\\n <SLSGroupName>Logstore_aliyun</SLSGroupName>\\n <UpdateTime>1649230049000</UpdateTime>\\n <SLSGroupDescription/>\\n <SLSGroupConfig>\\n <SLSProject>aliyun-test</SLSProject>\\n <SLSRegion>cn-qingdao</SLSRegion>\\n <SLSLogstore>oss_log</SLSLogstore>\\n </SLSGroupConfig>\\n </List>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeHybridMonitorSLSGroupResponse>","errorExample":""}]', - 'title' => 'DescribeHybridMonitorSLSGroup', - 'description' => 'In this example, all Logstore groups within the current account are queried. The response shows that the current account has two Logstore groups: `Logstore_test` and `Logstore_aliyun`.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\": \\"65D50468-ECEF-48F1-A6E1-D952E89D9436\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'Cursor' => [ - 'summary' => 'Defines the range of monitoring data that you want to export. The Cursor information is returned. When you call the BatchExport operation for the first time, you must specify the Cursor information.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PutResourceMetricRules' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'Metric', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n" - ."\n" - .'For more information about the metrics of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_idle', - ], - ], - [ - 'name' => 'Period', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The time interval based on which the metric value is measured.'."\n" - ."\n" - .'Unit: seconds.'."\n" - ."\n" - .'> Generally, the time interval is 60 seconds. For more information about specific values, see the `Period` parameter in [Appendix 1: Metrics](~~163515~~).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '60', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. For example, 2023-01-01T00:00:00Z indicates January 1, 2023, 00:00:00 UTC.'."\n" - ."\n" - .'> In CloudMonitor, the TTL of monitoring data varies with the time granularity. Specify a proper time interval based on the TTL corresponding to the value of the `Period` parameter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1641627000000', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', + 'name' => 'Rules', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'Unit: milliseconds.'."\n" - ."\n" - .'> '."\n" + 'description' => 'The list of threshold alert rules.'."\n" ."\n" - .'* This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. For example, 2023-01-01T00:00:00Z indicates January 1, 2023, 00:00:00 UTC.'."\n" - ."\n" - .'* If you do not set the end time, the end time is infinite. You can leave this parameter empty in real-time export scenarios.'."\n" - .'* In CloudMonitor, the TTL of monitoring data varies with the time granularity. Specify a proper time interval based on the TTL corresponding to the value of the `Period` parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1641645000000', - ], - ], - [ - 'name' => 'Matchers', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The dimension information of the metric.'."\n", + .'Valid values of N: 1 to 50.', 'type' => 'array', 'items' => [ - 'description' => 'The dimension information of the metric.'."\n", + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Escalations.Info.Threshold' => ['description' => 'The threshold for Info-level alerts.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + 'MetricName' => ['description' => 'The metric name.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'For more information about how to query metric names, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => 'cpu_total', 'title' => ''], + 'Escalations.Warn.Threshold' => ['description' => 'The threshold for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + 'EffectiveInterval' => ['description' => 'The effective period of the alert rule.'."\n" + ."\n" + .'Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => '00:00-23:59', 'title' => ''], + 'NoEffectiveInterval' => ['description' => 'The time range during which the alert rule is ineffective.'."\n" + ."\n" + .'Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => '00:00-06:00', 'title' => ''], + 'RuleId' => ['description' => 'The alert rule ID.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'You can enter a new alert rule ID or use an existing alert rule ID in CloudMonitor. For more information about how to query alert rule IDs, see [DescribeMetricRuleList](~~114941~~).'."\n" + ."\n" + .'> If you enter a new alert rule ID, a threshold alert rule is created.', 'type' => 'string', 'required' => true, 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', 'title' => ''], + 'Escalations.Critical.Times' => ['description' => 'The retry count for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Escalations.Critical.Threshold' => ['description' => 'The threshold for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + 'Escalations.Critical.Statistics' => ['description' => 'The statistics method for Critical-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column that corresponds to the `MetricName` of the specified Alibaba Cloud service. Examples: Maximum, Minimum, and Average. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical (critical), Warn (warning), or Info (information). For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Warn.ComparisonOperator' => ['description' => 'The comparison operator for Warn-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Info.Times' => ['description' => 'The retry count for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Resources' => ['description' => 'The resource information, such as `[{"instanceId":"i-uf6j91r34rnwawoo****"}]` or `[{"userId":"100931896542****"}]`.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'For more information about the supported dimensions, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => '[{"instanceId":"i-uf6j91r34rnwawoo****"}]', 'title' => ''], + 'SilenceTime' => ['description' => 'The mute period.'."\n" + ."\n" + .'Unit: seconds. Default value: 86400.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> The mute period specifies the interval at which an alert notification is sent again if the alert is not cleared.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'title' => ''], + 'Webhook' => ['description' => 'The callback URL to which a POST request is sent when an alert is triggered.'."\n" + ."\n" + .'Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => 'https://alert.aliyun.com.com:8080/callback', 'title' => ''], + 'ContactGroups' => ['description' => 'The alert contact group. Alert notifications are sent to the alert contacts in the alert contact group.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> An alert contact group contains one or more alert contacts. For more information about how to create alert contacts and alert contact groups, see [PutContact](~~114923~~) and [PutContactGroup](~~114929~~).', 'type' => 'string', 'required' => true, 'example' => 'ECS_Group', 'title' => ''], + 'Namespace' => ['description' => 'The data namespace of the Alibaba Cloud service.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'For more information about how to query the data namespace of an Alibaba Cloud service, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => true, 'example' => 'acs_ecs_dashboard', 'title' => ''], + 'EmailSubject' => ['description' => 'The subject of the alert email.'."\n" + ."\n" + .'Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => 'ECS instance alert', 'title' => ''], + 'Period' => ['description' => 'The statistical period of the metric.'."\n" + ."\n" + .'Unit: seconds. Default value: the original reporting period of the metric.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> For more information about how to query the statistical period of a metric, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + 'RuleName' => ['description' => 'The alert rule name.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'You can enter a new alert rule name or use an existing alert rule name in CloudMonitor. For more information about how to query alert rule names, see [DescribeMetricRuleList](~~114941~~).'."\n" + ."\n" + .'> If you enter a new alert rule name, a threshold alert rule is created.', 'type' => 'string', 'required' => true, 'example' => 'test123', 'title' => ''], + 'Escalations.Info.Statistics' => ['description' => 'The statistics method for Info-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column that corresponds to the `MetricName` of the specified Alibaba Cloud service. Examples: Maximum, Minimum, and Average. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical (critical), Warn (warning), or Info (information). For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'Escalations.Warn.Times' => ['description' => 'The retry count for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Escalations.Info.ComparisonOperator' => ['description' => 'The comparison operator for Info-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Interval' => ['description' => 'The trigger period of the alert rule.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> For more information about how to query the statistical period of a metric, see [Alibaba Cloud service monitoring metrics](~~163515~~).', 'type' => 'string', 'required' => false, 'example' => '60', 'title' => ''], + 'Escalations.Critical.ComparisonOperator' => ['description' => 'The comparison operator for Critical-level alerts. Valid values:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold: greater than or equal to the threshold.'."\n" + .'- GreaterThanThreshold: greater than the threshold.'."\n" + .'- LessThanOrEqualToThreshold: less than or equal to the threshold.'."\n" + .'- LessThanThreshold: less than the threshold.'."\n" + .'- NotEqualToThreshold: not equal to the threshold.'."\n" + .'- EqualToThreshold: equal to the threshold.'."\n" + .'- GreaterThanYesterday: greater than the value at the same time yesterday.'."\n" + .'- LessThanYesterday: less than the value at the same time yesterday.'."\n" + .'- GreaterThanLastWeek: greater than the value at the same time last week.'."\n" + .'- LessThanLastWeek: less than the value at the same time last week.'."\n" + .'- GreaterThanLastPeriod: greater than the value in the last period.'."\n" + .'- LessThanLastPeriod: less than the value in the last period.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical, Warn, or Info. For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'GreaterThanOrEqualToThreshold', 'title' => ''], + 'Escalations.Warn.Statistics' => ['description' => 'The statistics method for Warn-level alerts.'."\n" + ."\n" + .'Valid values of N: 1 to 50.'."\n" + ."\n" + .'The value of this parameter is determined by the `Statistics` column that corresponds to the `MetricName` of the specified Alibaba Cloud service. Examples: Maximum, Minimum, and Average. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](~~163515~~).'."\n" + ."\n" + .'> You must specify at least one of the following alert levels: Critical (critical), Warn (warning), or Info (information). For the specified alert level, you must set all of the following parameters: Statistics, ComparisonOperator, Threshold, and Times.', 'type' => 'string', 'required' => false, 'example' => 'Average', 'title' => ''], + 'NoDataPolicy' => ['description' => 'The processing method when no monitoring data is found. Valid values:'."\n" + ."\n" + .'- KEEP_LAST_STATE (default): No action is taken.'."\n" + .'- INSUFFICIENT_DATA: An alert whose content is "Insufficient Data" is triggered.'."\n" + .'- OK: The status is considered normal.'."\n" + ."\n" + .'Valid values of N: 1 to 50.', 'type' => 'string', 'required' => false, 'example' => 'KEEP_LAST_STATE', 'title' => ''], + 'Labels' => [ + 'description' => 'When the metric reaches the alert condition and an alert is triggered, the labels are written to the metric and displayed in the alert notification.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The label key.', 'type' => 'string', 'required' => false, 'example' => 'tagKey1', 'title' => ''], + 'Value' => ['description' => 'The label value.'."\n" + ."\n" + .'> The label value supports template parameters. Template parameters are replaced with actual label values.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', + ], + 'SendOK' => ['description' => 'Specifies whether to send a recovery notification.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], 'required' => false, - '$ref' => '#/components/schemas/Matcher', + 'title' => '', + 'example' => '', ], - 'required' => false, + 'required' => true, + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'CursorPopResponse', - 'description' => 'Schema of Response'."\n", + 'description' => 'None.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Cursor' => [ - 'description' => 'Cursor is used as an input parameter for data export in the [BatchExport](~~2329847~~) operation.'."\n", - 'type' => 'string', - 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '915C2D7A-E6A4-17C3-8E13-4DBDD61E7919', + 'Code' => ['description' => 'The HTTP status code.'."\n" + ."\n" + .'> The value 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request processing has failed due to some unknown error.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15D1440E-BF24-5A41-93E4-36864635179E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FailedListResult' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => 'The list of failed results for setting alert rules on resources.', + 'type' => 'array', + 'items' => [ + 'description' => 'None.', + 'type' => 'object', + 'properties' => [ + 'RuleId' => ['description' => 'The alert rule ID.', 'type' => 'string', 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', 'title' => ''], + 'Result' => [ + 'description' => 'The failure result.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '404', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The request processing has failed due to some unknown error.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 204 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 206 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + 406 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 422 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + 499 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + 503 => [ + ['errorCode' => '%s', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'title' => 'Create multiple threshold alert rules for a specified metric of a specified resource', + 'summary' => 'Calls the PutResourceMetricRules operation to create multiple threshold alert rules for a specified metric of a specified resource.', + 'description' => 'This topic provides an example of how to create a threshold alert rule for the `cpu_total` metric of the Elastic Computing Service (ECS) instance `i-uf6j91r34rnwawoo****` in the `acs_ecs_dashboard` namespace. The alert contact group is set to `ECS_Group`, the alert rule name is set to `test123`, the alert rule ID is set to `a151cd6023eacee2f0978e03863cc1697c89508****`, the statistics method for the Critical level is set to `Average`, the comparison operator for the Critical level is set to `GreaterThanOrEqualToThreshold`, the threshold for the Critical level is set to `90`, and the retry count for the Critical level is set to `3`.'."\n" + .'> As of August 15, 2024, Statistics validation is added. You can set the statistics value only to the Statistics value that corresponds to the metric. For more information about how to obtain the value of this parameter, see [Alibaba Cloud service monitoring metrics](https://www.alibabacloud.com/help/en/cms/support/appendix-1-metrics).', + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T09:54:48.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutResourceMetricRules'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cms:PutResourceMetricRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Cursor\\": \\"v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"RequestId\\": \\"915C2D7A-E6A4-17C3-8E13-4DBDD61E7919\\"\\n}","errorExample":""},{"type":"xml","example":"<CursorResponse>\\n\\t<RequestId>915C2D7A-E6A4-17C3-8E13-4DBDD61E7919</RequestId>\\n\\t<Message>success</Message>\\n\\t<Data>\\n\\t\\t<Cursor>eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****</Cursor>\\n\\t</Data>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</CursorResponse>\\t","errorExample":""}]', - 'title' => 'Cursor', - 'description' => '### [](#)Prerequisites'."\n" - ."\n" - .'Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).'."\n" - ."\n" - .'### [](#)Background information'."\n" - ."\n" - .'You can call this operation to obtain the Cursor information and then call the [BatchExport](~~2329847~~) operation to export the monitoring data.'."\n" - ."\n" - .'### [](#)Description'."\n" - ."\n" - .'This topic provides an example on how to define the monitoring data of a specified metric for a specified cloud service. In this example, the namespace of the cloud service is set to `acs_ecs_dashboard`, the metric is set to `cpu_idle`, the start time is set to `1641627000000`, and the end time is set to `1641645000000`. The number of idle CPU cores on your Elastic Compute Service (ECS) instances is measured every 60 seconds from 15:30:00, January 8, 2022 to 20:30:00, January 8, 2022. The `Cursor` information is returned.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\": \\"15D1440E-BF24-5A41-93E4-36864635179E\\",\\n \\"Success\\": true,\\n \\"FailedListResult\\": {\\n \\"Target\\": [\\n {\\n \\"RuleId\\": \\"a151cd6023eacee2f0978e03863cc1697c89508****\\",\\n \\"Result\\": {\\n \\"Code\\": \\"404\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"Success\\": false\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'BatchExport' => [ - 'summary' => 'Exports the monitoring data that is defined in the Cursor operation.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RemoveTags' => [ + 'summary' => 'The RemoveTags operation removes one or more tags.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Namespace', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The namespace of the cloud service.'."\n" - ."\n" - .'For more information about the namespaces of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> The value of this parameter must be the same as the value of the request parameter `Namespace` in the Cursor operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'acs_ecs_dashboard', - ], - ], - [ - 'name' => 'Metric', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The metric that is used to monitor the cloud service.'."\n" - ."\n" - .'For more information about the metrics of cloud services, see [Appendix 1: Metrics](~~163515~~).'."\n" - ."\n" - .'> The value of this parameter must be the same as the value of the request parameter `Metric` in the Cursor operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cpu_idle', - ], - ], - [ - 'name' => 'Cursor', - 'in' => 'formData', - 'schema' => [ - 'description' => 'When you call this operation to export data, you must specify the `Cursor` parameter. You can obtain the value of the `Cursor` parameter by using one of the following methods:'."\n" - ."\n" - .'* When you call this operation for the first time, you must call the Cursor operation to obtain the `Cursor` value. For more information, see [Cursor](~~2330730~~).'."\n" - .'* When you call this operation again, you can obtain the `Cursor` value from the returned data of the last call.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****', - ], - ], - [ - 'name' => 'Length', - 'in' => 'formData', + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The maximum number of data entries that can be returned in each response.'."\n" - ."\n" - .'Valid values: 1 to 10000.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n" + ."\n" + .'> You must specify both the tag key (`Tag.N.Key`) and the tag value (`Tag.N.Value`).', 'type' => 'string', 'required' => true, 'example' => 'Key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n" + ."\n" + .'> You must specify both the tag key (`Tag.N.Key`) and the tag value (`Tag.N.Value`).', 'type' => 'string', 'required' => true, 'example' => 'Value1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '1000', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Measurements', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'GroupIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The statistical methods used to customize the returned data. By default, the measurements based on all statistical methods are returned.'."\n" - ."\n" - .'For example, the `cpu_idle` metric of ECS (`acs_ecs_dashboard`) has three statistical methods: `Average`, `Maximum`, and `Minimum`. If you want to return only the measurements based on the `Average` and `Maximum` statistical methods, set this parameter to `["Average", "Maximum"]`.'."\n" - ."\n" - .'The statistical methods of metrics are displayed in the `Statistics` column on the Metrics page of each cloud service. For more information, see [Appendix 1: Metrics](~~163515~~).'."\n", + 'description' => 'The ID of the application group.', 'type' => 'array', - 'items' => [ - 'description' => 'The statistical method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Maximum', - ], - 'required' => false, + 'items' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], + 'required' => true, + 'example' => '12345', + 'maxItems' => 20, + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'None.'."\n", 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '251402CD-305C-1617-808E-D8C11FC8138D', - ], - 'Cursor' => [ - 'description' => 'The Cursor information that is used to call this operation again.'."\n" - ."\n" - .'> If `null` is returned, the monitoring data is exported.'."\n", - 'type' => 'string', - 'example' => 'v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***', - ], - 'Length' => [ - 'description' => 'The number of data entries returned in this call.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'Anchor' => [ - 'description' => 'The timestamp of the data requested by the backend. A larger timestamp indicates that the data export time is closer to the current time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1678781819000', - ], - 'HasNext' => [ - 'description' => 'Indicates whether the data has been exported. Valid values:'."\n" - ."\n" - .'* true: Some data is not exported.'."\n" - .'* false: All the data is exported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DataResults' => [ - 'description' => 'The data returned in this call.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The exported data. The following parameters are involved:'."\n" - ."\n" - .'* Namespace: the namespace of the cloud service. Example: `acs_ecs_dashboard`.'."\n" - .'* Metric: the name of the metric. Example: `cpu_idle`.'."\n" - .'* Timestamp: the timestamp of the monitoring data. Unit: milliseconds. Example: 1641454680000.'."\n" - .'* Period: the statistical period of the monitoring data. Unit: seconds. Example: 60.'."\n" - .'* Dimensions: the dimensions used to identify the monitored instance, for example, `[{"Label":"userId", "Value":""20654616023382****"}, {"Label":"InstanceId", "Value":""i-2ze2d6j5uhg20x4****"}]`.'."\n" - .'* Associated: the additional information about the monitored instance, such as the tags in key-value pairs. Example: `{"group":"test****", "name":"Alice"}`.'."\n" - .'* Measurements: the statistical methods of the metric. Multiple values are displayed by default. Example: `{"Average":60,"Maximum":85}`.'."\n" - .'* LogTime: the time when the monitoring data is recorded. Unit: milliseconds. For non-raw data (aggregated data), the value of `LogTime` is null.'."\n", - '$ref' => '#/components/schemas/MetricStat', + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> A status code of 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Illegal parameters.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '195390D2-69D0-4D9E-81AA-A7F5BC1B91EB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + ."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Tag' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tags' => [ + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => ['description' => 'The list of removed tags.', 'type' => 'string', 'example' => 'tag1', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', - ], - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 503 => [ - [ - 'errorCode' => '%s', - 'errorMessage' => '%s', + ], + 'title' => 'RemoveTags', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveTags'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:RemoveTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"RequestId\\": \\"251402CD-305C-1617-808E-D8C11FC8138D\\",\\n \\"Cursor\\": \\"v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***\\",\\n \\"Length\\": 1000,\\n \\"Anchor\\": 1678781819000,\\n \\"HasNext\\": true,\\n \\"DataResults\\": [\\n {\\n \\"Namespace\\": \\"\\",\\n \\"Metric\\": \\"\\",\\n \\"Period\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Dimensions\\": [\\n {\\n \\"Label\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Associated\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Measurements\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"LogTime\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<BatchExportResponse>\\n <DataResults>\\n <Associated/>\\n <LogTime/>\\n <Dimensions>\\n <Value>1270676***********</Value>\\n <Label>userId</Label>\\n </Dimensions>\\n <Dimensions>\\n <Value>r-rj9f9s*********</Value>\\n <Label>instanceId</Label>\\n </Dimensions>\\n <Dimensions>\\n <Value>r-rj9f9s19lsu*******</Value>\\n <Label>nodeId</Label>\\n </Dimensions>\\n <Namespace>acs_kvstore</Namespace>\\n <Timestamp>1678781700000</Timestamp>\\n <Metric>SplitrwProxyMaxResponseSize</Metric>\\n <Period>60</Period>\\n <Measurements>\\n <Average>0.583</Average>\\n <Maximum>0.583</Maximum>\\n </Measurements>\\n </DataResults>\\n <RequestId>733A3B5A-F082-1092-B429-1208168FC07F</RequestId>\\n <Code>200</Code>\\n <Length>10</Length>\\n <Message>success</Message>\\n <Cursor>v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy04ZGMwLTZlY2QxZGVhZGY***************</Cursor>\\n <Success>true</Success>\\n <HasNext>true</HasNext>\\n <Anchor>1678781819000</Anchor>\\n</BatchExportResponse>","errorExample":""}]', - 'title' => 'BatchExport', - 'description' => '### [](#)Prerequisites'."\n" - ."\n" - .'The `Cursor` information is returned by calling the [Cursor](~~2330730~~) operation.'."\n" - ."\n" - .'### [](#)Description'."\n" - ."\n" - .'This topic provides an example on how to export the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The `Cursor` information is specified. A maximum of 1,000 data entries can be returned in each response.'."\n", - 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Illegal parameters.\\",\\n \\"RequestId\\": \\"195390D2-69D0-4D9E-81AA-A7F5BC1B91EB\\",\\n \\"Success\\": true,\\n \\"Tag\\": {\\n \\"Tags\\": [\\n \\"tag1\\"\\n ]\\n }\\n}","type":"json"}]', ], - 'DescribeSyntheticProbeList' => [ - 'summary' => 'Queries detection points.', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SendDryRunSystemEvent' => [ + 'summary' => 'Debugs a system event of an Alibaba Cloud service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Isp', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The name of the cloud service.'."\n" + ."\n" + .'> For information about the Alibaba Cloud services that are supported by CloudMonitor, see [Supported cloud services and their system events](~~167388~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'City', + 'name' => 'EventName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The name of the system event.'."\n" + ."\n" + .'> For more information, see [DescribeSystemEventMetaList](~~114972~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent_Status_Stopped', 'title' => ''], ], [ - 'name' => 'Ipv4', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the application group.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'Ipv6', + 'name' => 'EventContent', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The content of the system event.'."\n" + ."\n" + .'> The value of this parameter is a JSON object. We recommend that you include the `product`, `resourceId`, and `regionId` fields in the JSON object.', 'type' => 'string', 'required' => false, 'example' => '{"product":"CloudMonitor","resourceId":"acs:ecs:cn-hongkong:173651113438****:instance/{instanceId}","level":"CRITICAL","instanceName":"instanceName","regionId":"cn-hangzhou","name":"Agent_Status_Stopped","content":{"ipGroup":"0.0.0.0,0.0.0.1","tianjimonVersion":"1.2.11"},"status":"stopped"}', 'title' => ''], ], - [ - 'name' => 'ViewAll', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterInvalid', 'errorMessage' => 'Illegal parameters.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], + ], [ - 'name' => 'MbProbe', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ], + ], + 'title' => 'SendDryRunSystemEvent', + 'description' => 'Tests whether a system event can be triggered as expected. Simulates a system event and verifies the response when the event triggers an alert.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDryRunSystemEvent'], + ], + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cms:SendDryRunSystemEvent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"486029C9-53E1-44B4-85A8-16A571A043FD\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + ], + 'UninstallMonitoringAgent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'LmProbe', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'IdcProbe', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the host.', 'type' => 'string', 'required' => true, 'example' => 'host-****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'IspCityList' => [ - 'description' => 'The queried detection points.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried detection point.'."\n", - 'type' => 'object', - 'properties' => [ - 'AreaCn' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AreaEn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Huabei', - ], - 'City' => [ - 'description' => '', - 'type' => 'string', - 'example' => '738', - ], - 'CityCn' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CityEn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Beijing', - ], - 'Country' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629', - ], - 'CountryCn' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CountryEn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'China', - ], - 'IpPool' => [ - 'description' => 'The IP addresses of the monitored nodes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address of the node.'."\n", - 'type' => 'string', - 'example' => '1.1.1.1', - ], - ], - 'Isp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '232', - ], - 'IspCn' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'IspEn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'China-Unicom', - ], - 'LmProbeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'MbProbeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => '264', - ], - 'RegionCn' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RegionEn' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Jiangxi', - ], - 'IdcV4ProbeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'IdcV6ProbeCount' => [ - 'description' => 'The number of IPv6 nodes in data centers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The specified resource is not found.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '87170bc7-e28a-4c93-b9bf-90a1dbe84736', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Successfully', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '466902B9-2842-40B0-B796-00FE772B6EF3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameterValue', - 'errorMessage' => 'Illegal parameters.', - ], + ['errorCode' => 'ParameterInvalid', 'errorMessage' => '%s', 'description' => ''], ], - [ - [ - 'errorCode' => 'AccessDeniedException', - 'errorMessage' => 'You donot have sufficient access to perform this action.', - ], + 403 => [ + ['errorCode' => 'AccessForbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''], ], [ - [ - 'errorCode' => 'LimitExceeded', - 'errorMessage' => 'The quota for this customer had been reached.', - ], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource is not found.', 'description' => 'The specified resource is not found.'], ], - [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'You are not authorized to operate the specified resource.', - ], + 412 => [ + ['errorCode' => 'AgentStateError', 'errorMessage' => 'Expected agent running state is stopped.', 'description' => 'Uninstall the plug-in when the status is Stopped.'], ], - 406 => [ - [ - 'errorCode' => 'ExceedingQuota', - 'errorMessage' => 'Exceeding quota limits.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'ThrottlingException', - 'errorMessage' => 'The request was denied due to request throttling.', - ], + ], + 'title' => 'UninstallMonitoringAgent', + 'summary' => 'Uninstalls the CloudMonitor agent from a third-party host.', + 'description' => '> This API operation is not applicable to Elastic Compute Service (ECS) instances. To uninstall the agent from an ECS instance, see [Install and uninstall the CloudMonitor agent](~~183482~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-12-27T07:31:04.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallMonitoringAgent'], ], - 500 => [ - [ - 'errorCode' => 'InternalUnknownError', - 'errorMessage' => 'The request processing has failed due to some unknown error.', + 'product' => ['code' => 'cms', 'title' => '云监控'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cms:UninstallMonitoringAgent', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CloudMonitorService', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"IspCityList\\": [\\n {\\n \\"AreaCn\\": \\"华北\\",\\n \\"AreaEn\\": \\"Huabei\\",\\n \\"City\\": \\"738\\",\\n \\"CityCn\\": \\"北京\\",\\n \\"CityEn\\": \\"Beijing\\",\\n \\"Country\\": \\"629\\",\\n \\"CountryCn\\": \\"中国\\",\\n \\"CountryEn\\": \\"China\\",\\n \\"IpPool\\": [\\n \\"1.1.1.1\\"\\n ],\\n \\"Isp\\": \\"232\\",\\n \\"IspCn\\": \\"联通\\",\\n \\"IspEn\\": \\"China-Unicom\\",\\n \\"LmProbeCount\\": 1,\\n \\"MbProbeCount\\": 1,\\n \\"Region\\": \\"264\\",\\n \\"RegionCn\\": \\"江西省\\",\\n \\"RegionEn\\": \\"Jiangxi\\",\\n \\"IdcV4ProbeCount\\": 1,\\n \\"IdcV6ProbeCount\\": 1\\n }\\n ],\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"87170bc7-e28a-4c93-b9bf-90a1dbe84736\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'DescribeSyntheticProbeList', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successfully\\",\\n \\"RequestId\\": \\"466902B9-2842-40B0-B796-00FE772B6EF3\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], ], 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-beijing.aliyuncs.com', 'endpoint' => 'metrics.cn-beijing.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhengzhou-jva', 'regionName' => 'Zhengzhou (China Unicom Joint Venture)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-zhengzhou-jva.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-heyuan.aliyuncs.com', 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-heyuan.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'metrics.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-northeast-2.aliyuncs.com', 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-northeast-1.aliyuncs.com', 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-1.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-2.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-3.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-5.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-5.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-6.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-6.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-7.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-southeast-7.aliyuncs.com'], + ['regionId' => 'ap-southeast-8', 'regionName' => 'Malaysia (Johor)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.ap-southeast-8.aliyuncs.com', 'endpoint' => 'metrics.ap-southeast-8.aliyuncs.com', 'vpc' => 'cms-vpc.ap-southeast-8.aliyuncs.com'], + ['regionId' => 'cn-zhongwei', 'regionName' => 'China (Zhongwei)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-zhongwei.aliyuncs.com', 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', 'vpc' => 'cms-vpc.cn-zhongwei.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-qingdao.aliyuncs.com', 'endpoint' => 'metrics.cn-qingdao.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-wuhan-lr', 'regionName' => 'China (Wuhan - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-wuhan-lr.aliyuncs.com', 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-wuhan-lr.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-shanghai.aliyuncs.com', 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-hongkong.aliyuncs.com', 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-shenzhen.aliyuncs.com', 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-nanjing.aliyuncs.com', 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-nanjing.aliyuncs.com'], + ['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-fuzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-fuzhou.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-chengdu.aliyuncs.com', 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-guangzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-huhehaote.aliyuncs.com', 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metrics.cn-hangzhou.aliyuncs.com', 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-southeast-1', 'regionName' => 'US（Atlanta）', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.us-southeast-1.aliyuncs.com', 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-southeast-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.eu-west-1.aliyuncs.com', 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', 'vpc' => 'metrics-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-west-2', 'regionName' => 'France (Paris)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.eu-west-2.aliyuncs.com', 'endpoint' => 'metrics.eu-west-2.aliyuncs.com', 'vpc' => 'cms-vpc.eu-west-2.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.eu-central-1.aliyuncs.com', 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', 'vpc' => 'metrics-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.us-east-1.aliyuncs.com', 'endpoint' => 'metrics.us-east-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.us-west-1.aliyuncs.com', 'endpoint' => 'metrics.us-west-1.aliyuncs.com', 'vpc' => 'metrics-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'na-south-1', 'regionName' => 'Mexico', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'metrics.na-south-1.aliyuncs.com', 'endpoint' => 'metrics.na-south-1.aliyuncs.com', 'vpc' => 'metrics-vpc.na-south-1.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'metrics.me-east-1.aliyuncs.com', 'endpoint' => 'metrics.me-east-1.aliyuncs.com', 'vpc' => 'metrics-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'metrics.ap-south-1.aliyuncs.com', 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', 'vpc' => 'metrics-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'metrics.me-central-1.aliyuncs.com', 'endpoint' => 'metrics.me-central-1.aliyuncs.com', 'vpc' => 'metrics-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'metrics.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-beijing-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu-gic-1', 'regionName' => 'China (Ulanqab) GIC', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com', 'endpoint' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com', 'vpc' => 'cms-vpc.cn-wulanchabu-gic-1.aliyuncs.com'], + ['regionId' => 'cn-heyuan-acdr-1', 'regionName' => 'Heyuan ACDR Auto', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-heyuan-acdr-1.aliyuncs.com'], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'metrics.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'metrics-vpc.cn-north-2-gov-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccessDeniedException', 'message' => 'You do not have the authority to operate this rule.', 'http_code' => 401, 'description' => 'ess rules cannot be modified in the cloud monitoring console.'], + ['code' => 'AccessForbidden', 'message' => 'No permission, please use Ram for authorization.', 'http_code' => 403, 'description' => 'No permission, please use Ram for authorization.'], + ['code' => 'AgentStateError', 'message' => 'Expected agent running state is stopped.', 'http_code' => 412, 'description' => 'Uninstall the plug-in when the status is Stopped.'], + ['code' => 'BadRequest', 'message' => 'Bad request.', 'http_code' => 400, 'description' => 'Error Parameter Request'], + ['code' => 'ContactNotExists', 'message' => 'ContactName does not exist.', 'http_code' => 404, 'description' => 'The contact name was not found.'], + ['code' => 'CSS_CREATE_ORDER_ERROR', 'message' => 'Create order error', 'http_code' => 400, 'description' => 'Failed to create order'], + ['code' => 'EmptyProbeList', 'message' => 'The selected probe list is empty.', 'http_code' => 400, 'description' => 'The selected probe list is empty'], + ['code' => 'ExceedingQuota', 'message' => 'You have exceeded the task limit.', 'http_code' => 406, 'description' => 'You have exceeded the task limit'], + ['code' => 'ExceedingQuota', 'message' => 'Exceeding quota limits.', 'http_code' => 406, 'description' => 'The number of tasks exceeds the limit'], + ['code' => 'Forbidden', 'message' => 'You are not authorized to operate the specified resource.', 'http_code' => 403, 'description' => 'No permission, please use RAM to authorize'], + ['code' => 'FrequencyLimit', 'message' => 'Frequency too high, please try again later.', 'http_code' => 429, 'description' => 'Frequency too high, please try again later'], + ['code' => 'Illegal Task Name', 'message' => 'The task name of the sitemonitor task is illegal.', 'http_code' => 400, 'description' => 'Site monitoring task name is illegal.'], + ['code' => 'IllegalAddress', 'message' => 'illegal address.', 'http_code' => 400, 'description' => 'Illegal Address'], + ['code' => 'Illgeal Task Name', 'message' => 'The task name for sitemonitor task is illegal.', 'http_code' => 400, 'description' => 'Site monitoring task name is illegal'], + ['code' => 'InsecureParams', 'message' => 'The params for site monitor is insecure.', 'http_code' => 400, 'description' => 'There is a security risk to the parameters of the site monitoring task'], + ['code' => 'InternalError', 'message' => '%s.', 'http_code' => 500, 'description' => '%s'], + ['code' => 'InternalUnknownError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => 'A service runtime error occurred.'], + ['code' => 'InternetServerError', 'message' => 'System internal error.', 'http_code' => 500, 'description' => 'System internal error'], + ['code' => 'InvalidAuthorization', 'message' => 'Permission denied', 'http_code' => 403, 'description' => 'Permission denied.'], + ['code' => 'InvalidAuthorization', 'message' => 'InvalidAuthorization.', 'http_code' => 403, 'description' => 'You do not have the required permissions.'], + ['code' => 'InvalidAuthorization', 'message' => 'Permission denied.', 'http_code' => 403, 'description' => 'You do not have the required permissions.'], + ['code' => 'InvalidAuthorizationTokenExpire', 'message' => 'Authentication token expired, please re-authenticate.', 'http_code' => 403, 'description' => 'Authentication token expired, please re-authenticate'], + ['code' => 'InvalidClientTokenId', 'message' => 'not allow this operation.', 'http_code' => 403, 'description' => 'No permission'], + ['code' => 'InvalidParameter', 'message' => '%s is missing or invalid.', 'http_code' => 400, 'description' => 'The request parameters are invalid or required parameters are missing (such as GroupName, WorkspaceId, GroupId, or region being empty).'], + ['code' => 'InvalidParameter', 'message' => 'Invalid parameter.', 'http_code' => 400, 'description' => 'Parameter error'], + ['code' => 'InvalidParameterValue', 'message' => 'Illegal parameters.', 'http_code' => 400, 'description' => 'Illegal parameters.'], + ['code' => 'InvalidQueryParameter', 'message' => 'Parameter error.', 'http_code' => 400, 'description' => 'Query parameter error'], + ['code' => 'InvalidQueryParameter', 'message' => 'Invalid query parameter.', 'http_code' => 400, 'description' => 'Bad query parameters'], + ['code' => 'MaxRcaTimesExceed', 'message' => 'The maximum reanalysis limit has been reached.', 'http_code' => 400, 'description' => 'The maximum reanalysis limit has been reached.'], + ['code' => 'NameRepeat', 'message' => 'The task name already exists.', 'http_code' => 400, 'description' => 'The task name already exists. Make sure that the task name is not used in protocol-based synthetic tests and synthetic tests for browsers.'], + ['code' => 'NotAuthSLR', 'message' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.', 'http_code' => 403, 'description' => 'The service-linked role AliyunServiceRoleForCloudMonitor is required.'], + ['code' => 'NotFound', 'message' => 'The specified resource is not found.', 'http_code' => 404, 'description' => 'The corresponding resource was not found.'], + ['code' => 'NotFound.EndpointConnector', 'message' => 'endpoint connector not found.', 'http_code' => 404, 'description' => 'endpoint connector does not exist'], + ['code' => 'OperatorCityInvalid', 'message' => 'Invalid Isp.', 'http_code' => 400, 'description' => 'Invalid Isp'], + ['code' => 'OperatorCityInvalid', 'message' => 'Invalid IspCity for certain probes.', 'http_code' => 400, 'description' => 'The isp or city of certain probes provided is invalid.'], + ['code' => 'OperatorCityInvalid', 'message' => 'The synthetic probe info provided is incorrect. The incorrect probe info are as below. %s.', 'http_code' => 400, 'description' => 'The synthetic probe info provided is incorrect.'], + ['code' => 'ParameterInvalid', 'message' => 'The parameter is missing or invalid. %s', 'http_code' => 400, 'description' => 'The parameter is invalid.'], + ['code' => 'ParameterInvalid', 'message' => 'Parameter invalid.', 'http_code' => 400, 'description' => 'The parameter is invalid.'], + ['code' => 'PhoneIsEmptyOrNotVerified', 'message' => 'Contact does not have a phone number configured or not verified.', 'http_code' => 400, 'description' => 'Contact does not have a phone number configured or not verified'], + ['code' => 'RateLimit', 'message' => 'Service rate limit.', 'http_code' => 400, 'description' => 'Service load is high, please try again later'], + ['code' => 'ResourceExist', 'message' => 'Resource already exist .', 'http_code' => 400, 'description' => 'The resource already exists.'], + ['code' => 'ResourceLimit', 'message' => 'Namespace limited.', 'http_code' => 400, 'description' => 'A maximum of 30 indicator warehouses can be created for one account.'], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource is not found.', 'http_code' => 404, 'description' => 'The specified resource is not found.'], + ['code' => 'ResourceNotFound', 'message' => 'Resource % not found.', 'http_code' => 404, 'description' => '已废弃'], + ['code' => 'ResourceNotFound', 'message' => 'The specified resource %s is not found.', 'http_code' => 404, 'description' => 'The specified resource% s does not exist.'], + ['code' => 'ResourceOverLimit', 'message' => 'The resource has exceeded the limit. %s', 'http_code' => 429, 'description' => 'The quantity limit has been exceeded.'], + ['code' => 'RestrictedUser', 'message' => 'The user has no access to this operation. %s.', 'http_code' => 403, 'description' => 'The user does not have permission for the current action.'], + ['code' => 'RmcNotEnabled', 'message' => 'ResourceCenter Service is not enabled.', 'http_code' => 403, 'description' => 'You have not activated Resource Center.'], + ['code' => 'StrategyNameConflict', 'message' => 'The specified strategy name exits already.', 'http_code' => 400, 'description' => 'The specified strategy name already exists'], + ['code' => 'TaskIdNotExist', 'message' => 'Task does not exist.', 'http_code' => 404, 'description' => 'Task does not exist'], + ['code' => 'TaskNotExist', 'message' => 'Task does not exist.', 'http_code' => 400, 'description' => 'Site monitoring task does not exist'], + ['code' => 'TaskNotExist', 'message' => 'The specified task does not exist.', 'http_code' => 404, 'description' => 'The specified task does not exist.'], + ['code' => 'UnauthorizedTasks', 'message' => 'You are not permitted to operate the specified tasks.', 'http_code' => 403, 'description' => 'You are not permitted to operate the specified tasks.'], + ['code' => 'UnsupportedWorkspaceRegion', 'message' => 'Synthetic monitoring is not supported in this workspace region.', 'http_code' => 400, 'description' => 'Synthetic monitoring is not supported in this workspace region.'], + ['code' => 'VerifyCodeIsSent', 'message' => 'Verification code sent too often, please try again later.', 'http_code' => 400, 'description' => 'The verification code is sent too often, please try again later.'], + ['code' => 'WorkspaceNotExist', 'message' => 'The specified workspace does not exist.', 'http_code' => 400, 'description' => 'The workspace does not exist.'], + ['code' => 'InvalidParameter', 'message' => 'The request parameter is invalid or a required parameter is missing.', 'http_code' => 400, 'description' => 'The request parameter is invalid or a required parameter is missing.'], + ['code' => 'InvalidMaxResults', 'message' => 'The MaxResults parameter is invalid.', 'http_code' => 400, 'description' => 'The MaxResults parameter is invalid, must be a positive integer within the allowed limit.'], + ['code' => 'InvalidParameter.NextToken', 'message' => 'The NextToken is invalid or does not match the request parameters.', 'http_code' => 400, 'description' => 'The NextToken is invalid or does not match the request parameters.'], + ['code' => 'InvalidParameter.RegionId', 'message' => 'Unable to determine the region for the observe group.', 'http_code' => 400, 'description' => 'Unable to determine the region: the account has not enabled CloudResource and no central region can be derived.'], + ['code' => 'ObserveGroup.AlreadyExists', 'message' => 'An observe group with the same name already exists in the workspace.', 'http_code' => 409, 'description' => 'An observe group with the same name already exists in the workspace.'], + ['code' => 'DatabaseError', 'message' => 'A database error occurred while processing the request.', 'http_code' => 500, 'description' => 'A database error occurred. Please retry later or contact the administrator.'], + ['code' => 'ObserveGroup.NotFound', 'message' => 'The specified observe group does not exist.', 'http_code' => 404, 'description' => 'The specified observe group does not exist. Please check the ObserveGroupId.'], + ['code' => 'InternalError', 'message' => 'An internal error occurred while processing the request.', 'http_code' => 500, 'description' => 'An internal error occurred (e.g. failed to update Diamond config or deliver MetaQ). Please retry later.'], + ['code' => 'Workspace.NotFound', 'message' => 'The specified workspace does not exist or you have no permission.', 'http_code' => 404, 'description' => 'The specified workspace does not exist or you have no access.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AddTags'], + ], + 'createdAt' => '2024-08-28T10:01:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2024-08-05T11:10:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2024-07-31T06:53:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2024-05-16T06:57:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2024-05-16T06:24:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeleteCustomMetric'], + ], + 'createdAt' => '2024-04-23T06:11:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2024-04-01T02:36:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDynamicTagRuleList'], + ], + 'createdAt' => '2024-03-13T08:11:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ApplyMetricRuleTemplate'], + ], + 'createdAt' => '2024-02-27T07:25:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricData'], + ], + 'createdAt' => '2024-01-23T02:42:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateHybridMonitorTask'], + ], + 'createdAt' => '2023-12-21T08:29:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateGroupMetricRules'], + ['description' => 'Request parameters changed', 'api' => 'PutGroupMetricRule'], + ], + 'createdAt' => '2023-12-13T07:03:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogCount'], + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogHistogram'], + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogList'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeSystemEventAttribute'], + ], + 'createdAt' => '2023-12-07T03:29:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMonitoringAgentStatuses'], + ], + 'createdAt' => '2023-11-24T04:02:02.000Z', + 'description' => '', + ], [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateHybridMonitorNamespace'], + ['description' => 'Response parameters changed', 'api' => 'DescribeHybridMonitorNamespaceList'], + ], + 'createdAt' => '2023-11-21T10:00:42.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'cms.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeProductsOfActiveMetricRule'], + ], + 'createdAt' => '2023-10-25T07:41:42.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertingMetricRuleResources'], + ], + 'createdAt' => '2023-10-20T09:21:18.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-zhengzhou-jva', - 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMonitorResourceQuotaAttribute'], + ], + 'createdAt' => '2023-10-07T08:33:54.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeleteExporterOutput'], + ['description' => 'Response parameters changed', 'api' => 'PutExporterOutput'], + ], + 'createdAt' => '2023-09-21T02:02:14.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeEventRuleList'], + ], + 'createdAt' => '2023-09-19T07:38:12.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2023-09-04T08:23:34.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleAttribute'], + ], + 'createdAt' => '2023-08-31T02:53:22.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-nanjing', - 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeleteExporterRule'], + ['description' => 'Response parameters changed', 'api' => 'DescribeExporterOutputList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeExporterRuleList'], + ['description' => 'Response parameters changed', 'api' => 'PutExporterRule'], + ], + 'createdAt' => '2023-08-30T08:15:06.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-fuzhou', - 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ['description' => 'Request parameters changed', 'api' => 'DescribeSiteMonitorLog'], + ], + 'createdAt' => '2023-08-22T07:50:07.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateSiteMonitor'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ['description' => 'Request parameters changed', 'api' => 'ModifySiteMonitor'], + ], + 'createdAt' => '2023-08-04T03:00:33.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-heyuan', - 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogCount'], + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogHistogram'], + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogList'], + ], + 'createdAt' => '2023-07-27T09:50:34.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeMonitoringAgentStatuses'], + ], + 'createdAt' => '2023-07-19T08:43:59.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeMetricRuleBlackList'], + ], + 'createdAt' => '2023-07-11T01:55:30.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-wuhan-lr', - 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateSiteMonitor'], + ['description' => 'Error codes changed', 'api' => 'EnableSiteMonitors'], + ['description' => 'Error codes changed', 'api' => 'ModifySiteMonitor'], + ], + 'createdAt' => '2023-06-19T07:12:36.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2023-06-15T04:29:56.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMonitoringAgentHosts'], + ], + 'createdAt' => '2023-05-25T09:45:38.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorList'], + ], + 'createdAt' => '2023-05-22T07:54:33.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeMonitoringAgentStatuses'], + ], + 'createdAt' => '2023-05-04T09:07:03.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateMetricRuleBlackList'], + ], + 'createdAt' => '2023-04-23T03:10:12.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2023-04-06T11:21:43.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorLog'], + ], + 'createdAt' => '2023-04-03T11:31:34.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricList'], + ], + 'createdAt' => '2023-03-24T08:24:53.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleAttribute'], + ], + 'createdAt' => '2023-03-24T08:23:03.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-zhongwei', - 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateGroupMonitoringAgentProcess'], + ], + 'createdAt' => '2023-03-24T08:22:35.000Z', + 'description' => '', ], [ - 'regionId' => 'us-east-1', - 'endpoint' => 'metrics.us-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDynamicTagGroup'], + ], + 'createdAt' => '2023-03-24T08:22:29.000Z', + 'description' => '', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'metrics.us-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricData'], + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricList'], + ], + 'createdAt' => '2023-01-10T11:07:35.000Z', + 'description' => 'metric-master查询类API新加坡region转新加坡服务', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeleteExporterRule'], + ['description' => 'Response parameters changed', 'api' => 'PutExporterRule'], + ], + 'createdAt' => '2023-01-10T10:47:11.000Z', + 'description' => 'metric-master海外请求转海外服务', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleTemplateAttribute'], + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2022-12-27T11:48:08.000Z', + 'description' => '报警接口字段N私有', ], [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateHybridMonitorNamespace'], + ['description' => 'Error codes changed', 'api' => 'CreateHybridMonitorTask'], + ['description' => 'Error codes changed', 'api' => 'CreateSiteMonitor'], + ['description' => 'Error codes changed', 'api' => 'DeleteSiteMonitors'], + ['description' => 'Error codes changed', 'api' => 'DescribeSiteMonitorAttribute'], + ['description' => 'Error codes changed', 'api' => 'DescribeSiteMonitorQuota'], + ['description' => 'Error codes changed', 'api' => 'InstallMonitoringAgent'], + ['description' => 'Error codes changed', 'api' => 'PutMonitorGroupDynamicRule'], + ['description' => 'Error codes changed', 'api' => 'UninstallMonitoringAgent'], + ], + 'createdAt' => '2022-12-27T07:33:46.000Z', + 'description' => '更新默认错误码的返回信息', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleTemplateAttribute'], + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2022-12-26T09:12:32.000Z', + 'description' => '报警规则及模板相关API，支持参数N，表示累计了次数后才报警。', ], [ - 'regionId' => 'na-south-1', - 'endpoint' => 'metrics.na-south-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleTemplateAttribute'], + ], + 'createdAt' => '2022-12-22T02:15:23.000Z', + 'description' => '查询报警模板API，增加Labels的查询返回。', ], [ - 'regionId' => 'us-southeast-1', - 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeMonitoringAgentHosts'], + ['description' => 'Request parameters changed', 'api' => 'DescribeMonitoringAgentStatuses'], + ], + 'createdAt' => '2022-11-29T02:47:37.000Z', + 'description' => '增加SysOM探测任务api，并优化主机监控状态的api。', ], [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDynamicTagRuleList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeMonitorGroups'], + ], + 'createdAt' => '2022-11-14T08:16:27.000Z', + 'description' => '1、从资源组创建的动态分组，查询返回对应资源组的id。2、动态分组Tag规则，增加返回的TagKey。', ], [ - 'regionId' => 'me-east-1', - 'endpoint' => 'metrics.me-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeAlertLogList'], + ], + 'createdAt' => '2022-09-29T06:59:38.000Z', + 'description' => '报警日志详情，增加了日志Id字段。', ], [ - 'regionId' => 'me-central-1', - 'endpoint' => 'metrics.me-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeAlertingMetricRuleResources'], + ], + 'createdAt' => '2022-09-01T02:54:22.000Z', + 'description' => '正在报警展示原始的报警表达式。', ], [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteHybridMonitorTask'], + ], + 'createdAt' => '2022-08-09T02:57:45.000Z', + 'description' => '删除企业云监控导入任务的时候，TaskId改为非必填。', ], [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateGroupMonitoringAgentProcess'], + ['description' => 'Request parameters changed', 'api' => 'CreateHostAvailability'], + ['description' => 'Request parameters changed', 'api' => 'ModifyGroupMonitoringAgentProcess'], + ['description' => 'Request parameters changed', 'api' => 'ModifyHostAvailability'], + ['description' => 'Error codes changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2022-08-05T04:06:23.000Z', + 'description' => '1、可用性监控、进程监控支持MNS、SLS、FC等触发规则。2、优化报警规则超配额的错误信息。', ], [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateHybridMonitorSLSGroup'], + ], + 'createdAt' => '2022-08-04T08:56:16.000Z', + 'description' => '优化企业云监控创建日志分组的错误提示信息。', ], [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ModifySiteMonitor'], + ], + 'createdAt' => '2022-08-03T06:49:25.000Z', + 'description' => '增加站点监控断言相关api参数', ], [ - 'regionId' => 'cn-heyuan-acdr-1', - 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2022-07-29T09:42:21.000Z', + 'description' => 'PutResourceMetricRule中Resources字段改为非必填，适应Prometheus报警。', ], [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'BatchCreateInstantSiteMonitor'], + ], + 'createdAt' => '2022-07-22T08:21:08.000Z', + 'description' => '优化一次性拨测api', ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'BatchCreateInstantSiteMonitor'], + ], + 'createdAt' => '2022-07-21T06:24:36.000Z', + 'description' => '增加一次性拨测api，老的拼写错误', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeHybridMonitorTaskList'], + ], + 'createdAt' => '2022-07-20T10:30:20.000Z', + 'description' => '优化企业云监控处理阿里云数据任务的管控API。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutGroupMetricRule'], + ], + 'createdAt' => '2022-07-20T09:53:51.000Z', + 'description' => '创建分组报警规则的时候Category改为非必填。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDynamicTagGroup'], + ], + 'createdAt' => '2022-07-13T10:10:24.000Z', + 'description' => '1、Tag创建应用分组，支持最多3个条件2、可用性监控错误信息，会直接透传。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyHybridMonitorTask'], + ], + 'createdAt' => '2022-07-11T06:45:29.000Z', + 'description' => '更新企业云监控任务，TaskName调整为非必填。', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BatchCreateIntantSiteMonitor'], + ['description' => 'Error codes changed', 'api' => 'CreateInstantSiteMonitor'], + ['description' => 'Error codes changed', 'api' => 'CreateSiteMonitor'], + ], + 'createdAt' => '2022-06-22T09:31:05.000Z', + 'description' => '优化站点监控Api返回的错误信息。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeHybridMonitorSLSGroup'], + ], + 'createdAt' => '2022-06-20T02:43:08.000Z', + 'description' => 'DescribeHybridMonitorSLSGroup查询返回的组名称，修改为string类型。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorList'], + ], + 'createdAt' => '2022-06-17T07:35:16.000Z', + 'description' => '增加是否在任务失败后自动触发对目标IP地址的MTR网络诊断是否在任务失败后自动触发对目标IP的ping网络延时检测', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateHybridMonitorTask'], + ['description' => 'Response parameters changed', 'api' => 'DescribeHybridMonitorTaskList'], + ['description' => 'Error codes changed', 'api' => 'ModifyHybridMonitorNamespace'], + ], + 'createdAt' => '2022-06-09T09:39:44.000Z', + 'description' => '查询企业云监控任务管控API错误码、返回值优化。', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeHybridMonitorDataList'], + ], + 'createdAt' => '2022-05-30T06:46:19.000Z', + 'description' => '当参数或返回信息过大的时候，调整错误返回码。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorList'], + ], + 'createdAt' => '2022-05-30T06:35:31.000Z', + 'description' => '增加返回参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateHybridMonitorTask'], + ], + 'createdAt' => '2022-05-23T04:52:13.000Z', + 'description' => '创建企业云监控采集任务，导入其他账号的数据，支持传入多个用户信息', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateGroupMetricRules'], + ], + 'createdAt' => '2022-05-19T10:19:48.000Z', + 'description' => '增加对STS的支持，优化错误码。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateHybridMonitorTask'], + ['description' => 'Request parameters changed', 'api' => 'ModifyHybridMonitorTask'], + ], + 'createdAt' => '2022-05-06T03:54:52.000Z', + 'description' => '增加企业云监控采集任务管控Api。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleList'], + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2022-04-25T08:58:01.000Z', + 'description' => '报警规则支持PromQL。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateHybridMonitorNamespace'], + ['description' => 'Request parameters changed', 'api' => 'DeleteHybridMonitorNamespace'], + ['description' => 'Request parameters changed', 'api' => 'DescribeHybridMonitorNamespaceList'], + ['description' => 'Request parameters changed', 'api' => 'ModifyHybridMonitorNamespace'], + ], + 'createdAt' => '2022-04-24T08:30:40.000Z', + 'description' => '增加企业云监控数据源相关API。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleTargetList'], + ['description' => 'Request parameters changed', 'api' => 'PutEventRuleTargets'], + ], + 'createdAt' => '2022-04-22T10:15:21.000Z', + 'description' => '报警规则target增加消息服务的target', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeMonitorGroups'], + ], + 'createdAt' => '2022-04-22T08:01:23.000Z', + 'description' => '1、支持查询ess分组2、创建企业云监控数据归集的时候，支持传入多个账号', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'PutMonitorGroupDynamicRule'], + ], + 'createdAt' => '2022-04-22T06:18:29.000Z', + 'description' => '在异步创建动态分组规则的时候，如果分组没有初始化结束，调整返回的错误信息。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutLogMonitor'], + ], + 'createdAt' => '2022-04-21T07:37:29.000Z', + 'description' => '调整filter数量', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'BatchCreateIntantSiteMonitor'], + ], + 'createdAt' => '2022-04-20T06:16:11.000Z', + 'description' => '增加新版本的创建一次性api', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateGroupMetricRules'], + ['description' => 'Request parameters changed', 'api' => 'PutGroupMetricRule'], + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRules'], + ], + 'createdAt' => '2022-04-20T06:14:16.000Z', + 'description' => '报警规则增加Labels。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRules'], + ], + 'createdAt' => '2022-04-20T06:13:58.000Z', + 'description' => '修改label属性', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'BatchCreateOnceSiteMonitor'], + ], + 'createdAt' => '2022-04-18T03:06:12.000Z', + 'description' => '增加一次性拨测api', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'PutLogMonitor'], + ], + 'createdAt' => '2022-04-11T03:35:36.000Z', + 'description' => '增加上报日志监控错误信息映射。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutMonitorGroupDynamicRule'], + ], + 'createdAt' => '2022-04-01T03:59:02.000Z', + 'description' => '创建动态规则增加引导。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleList'], + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2022-03-24T05:52:16.000Z', + 'description' => '增加了多指标监控', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateHostAvailability'], + ['description' => 'Request parameters changed', 'api' => 'DescribeMetricRuleTemplateList'], + ], + 'createdAt' => '2022-03-22T08:55:37.000Z', + 'description' => '1、报警模板增加排序功能2、优化可用性监控的错误码，当达到限制的时候，会返回正确的错误信息。3、增加批量清理分组的api。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeEventRuleAttribute'], + ], + 'createdAt' => '2022-03-21T07:09:30.000Z', + 'description' => '增加个通道沉默', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleTargets'], + ['description' => 'Request parameters changed', 'api' => 'PutEventRuleTargets'], + ['description' => 'Request parameters changed', 'api' => 'PutMetricRuleTargets'], + ], + 'createdAt' => '2022-03-21T06:46:38.000Z', + 'description' => '增加报警规则回调参数。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeMetricRuleList'], + ['description' => 'Error codes changed', 'api' => 'PutResourceMetricRules'], + ], + 'createdAt' => '2022-03-21T06:00:07.000Z', + 'description' => '增加动态报警相关的api', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutMonitorGroupDynamicRule'], + ], + 'createdAt' => '2022-03-03T05:26:10.000Z', + 'description' => '增加检查数量', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ], + 'createdAt' => '2022-02-22T11:34:11.000Z', + 'description' => '站点检控详情里头增加isBase64Encode 字段', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutEventRule'], + ], + 'createdAt' => '2022-02-21T06:46:00.000Z', + 'description' => '事件目标增加为20个', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleList'], + ['description' => 'Request parameters changed', 'api' => 'PutEventRule'], + ], + 'createdAt' => '2022-01-21T08:52:40.000Z', + 'description' => '增加事件报警功能的sql过滤', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeAlertLogList'], + ], + 'createdAt' => '2022-01-13T07:25:23.000Z', + 'description' => '报警历史查询支持RuleId参数。', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeContactGroupList'], + ], + 'createdAt' => '2022-01-11T11:57:53.000Z', + 'description' => '增加查询不到联系人组的错误码映射。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleList'], + ['description' => 'Request parameters changed', 'api' => 'PutEventRule'], + ], + 'createdAt' => '2022-01-11T11:33:01.000Z', + 'description' => '控制台支持资源组权限隔离', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'PutHybridMonitorMetricData'], + ], + 'createdAt' => '2021-12-30T11:51:43.000Z', + 'description' => '调整上报企业云监控数据的API错误提示信息，防止误解。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'PutHybridMonitorMetricData'], + ], + 'createdAt' => '2021-12-24T03:58:17.000Z', + 'description' => '返回值中增加对格式参数错误指标的提示信息。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutEventRule'], + ], + 'createdAt' => '2021-12-24T03:36:44.000Z', + 'description' => '修复sdk的问题', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutHybridMonitorMetricData'], + ], + 'createdAt' => '2021-12-24T03:29:57.000Z', + 'description' => '调整labels的格式为repeatList。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ], + 'createdAt' => '2021-12-24T03:21:02.000Z', + 'description' => '修正生成不了sdk的问题', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutHybridMonitorMetricData'], + ], + 'createdAt' => '2021-12-24T03:09:23.000Z', + 'description' => '调整labels的格式，从map改为List的Key-Value。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleTargetList'], + ], + 'createdAt' => '2021-12-22T08:43:39.000Z', + 'description' => '查询targetapi增加新的方式', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutEventRuleTargets'], + ], + 'createdAt' => '2021-12-22T07:45:45.000Z', + 'description' => '增加一个target', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEventRuleList'], + ['description' => 'Request parameters changed', 'api' => 'PutEventRule'], + ], + 'createdAt' => '2021-12-09T10:17:44.000Z', + 'description' => '事件增加沉默周期', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateInstantSiteMonitor'], + ], + 'createdAt' => '2021-12-07T15:36:24.000Z', + 'description' => '修复一次性探测探测问题', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeSiteInstantMonitorLog'], + ], + 'createdAt' => '2021-12-01T09:57:33.000Z', + 'description' => '增加了一次性拨测探测日志查询功能。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorAttribute'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorList'], + ], + 'createdAt' => '2021-11-18T05:37:00.000Z', + 'description' => 'dns探测匹配类型， dns_match_rule, 原先和http共享了一个参数，类型不一样。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'InstallMonitoringAgent'], + ], + 'createdAt' => '2021-11-18T05:36:49.000Z', + 'description' => 'agent安装支持对用户的全量agent进行操作', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDynamicTagGroup'], + ], + 'createdAt' => '2021-11-04T06:31:02.000Z', + 'description' => '创建tag组express参数为必须参数选项', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDynamicTagRuleList'], + ], + 'createdAt' => '2021-11-04T06:05:13.000Z', + 'description' => '查询动态tag组增加报警联系人的返回', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateSiteMonitor'], + ], + 'createdAt' => '2021-11-03T13:42:17.000Z', + 'description' => '修改一个不用的单位参数', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeAlertLogList'], + ], + 'createdAt' => '2021-10-29T08:11:11.000Z', + 'description' => '移除了total字段，增加了sendresult', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRule'], + ['description' => 'Request parameters changed', 'api' => 'PutResourceMetricRules'], + ], + 'createdAt' => '2021-10-28T09:57:48.000Z', + 'description' => '增加多指标监控和无数据监控参数设置', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateGroupMetricRules'], + ['description' => 'Response parameters changed', 'api' => 'DescribeMetricRuleList'], + ['description' => 'Request parameters changed', 'api' => 'PutGroupMetricRule'], + ], + 'createdAt' => '2021-10-28T09:45:49.000Z', + 'description' => '增加多指标相关的参数和返回', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorISPCityList'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSiteMonitorISPCityList'], + ], + 'createdAt' => '2021-10-28T09:21:47.000Z', + 'description' => '修复问题', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateDynamicTagGroup'], + ['description' => 'Response parameters changed', 'api' => 'CreateMonitorGroupByResourceGroupId'], + ], + 'createdAt' => '2021-10-25T13:10:51.000Z', + 'description' => '创建分组，增加返回id', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorNamespaceList'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHybridMonitorSLSGroup'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableHostAvailability'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutContact'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomMetric'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentStatuses'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDynamicTagGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProjectMeta'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomMetricRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHostAvailability'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMonitorGroupInstances'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertLogList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricMetaList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContactGroup'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHybridMonitorNamespace'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUnhealthyHostAvailability'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventRuleTargets'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHybridMonitorSLSGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricTop'], + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEventRuleTargetList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroupDynamicRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEventCount'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorAgentProcess'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveMetricRuleList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutEventRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorISPCityList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMetricRuleTemplate'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableMetricRuleBlackList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomMetric'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEventRuleAttribute'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleBlackList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitoringAgentProcess'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetricRuleTemplate'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleBlackList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringConfig'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableEventRules'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorDataList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutContactGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventCount'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableMetricRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroupInstances'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroupNotifyPolicy'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupDynamicRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMetricRuleBlackList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleResources'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSyntheticProbeList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHostInfo'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitoringAgentProcess'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentConfig'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroupMonitoringAgentProcess'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupMonitoringAgentProcess'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertingMetricRuleResources'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventAttribute'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHybridMonitorSLSGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventMetaList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleTemplateList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupNotifyPolicyList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutResourceMetricRules'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomEventRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDynamicTagGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactListByContactGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogMonitorAttribute'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupInstances'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleTargets'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleTemplateAttribute'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorData'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSiteMonitors'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemEventHistogram'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutHybridMonitorMetricData'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorTaskList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleList'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutLogMonitor'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomMetricList'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHybridMonitorNamespace'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutCustomEvent'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstantSiteMonitor'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTagValueList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHybridMonitorTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableMetricRules'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutMetricRuleTargets'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Cursor'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricData'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHostAvailability'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveTags'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreateInstantSiteMonitor'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchExport'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEventHistogram'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDynamicTagRuleList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactGroupList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertLogCount'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAlertLogHistogram'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHybridMonitorTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorStatistics'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallMonitoringAgent'], + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroups'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomEventAttribute'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetricRuleTemplate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProductResourceTagKeyList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyMonitorGroup'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutResourceMetricRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetricRuleBlackList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventRules'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableActiveMetricRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentProcesses'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSiteMonitors'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutEventRuleTargets'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDryRunSystemEvent'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupMonitoringAgentProcess'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentHosts'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableEventRules'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogMonitorList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroupMetricRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorAttribute'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSiteMonitors'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSiteMonitor'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableHostAvailability'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutGroupMetricRule'], + ['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupCategories'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProductsOfActiveMetricRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableActiveMetricRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHostAvailabilityList'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHybridMonitorSLSGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleCount'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutMonitorGroupDynamicRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorResourceQuotaAttribute'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutMonitoringConfig'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricRuleTargets'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHybridMonitorTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLogMonitor'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorLog'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetricRuleResources'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroupByResourceGroupId'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySiteMonitor'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMonitorGroup'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroupInstances'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitoringAgentAccessKey'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallMonitoringAgent'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHybridMonitorNamespace'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTagKeyList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyMetricRuleTemplate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContact'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEventRuleList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHostAvailability'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTags'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSiteMonitorQuota'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyGroupMonitoringAgentProcess'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroupNotifyPolicy'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorGroupInstanceAttribute'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetricLast'], + ], + 'product' => ['code' => 'cms', 'title' => 'Cms'], + ], + 'ram' => [ + 'productCode' => 'CloudMonitorService', + 'productName' => 'Cloud Monitor', + 'ramCodes' => ['cms', 'log', 'arms'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [], + 'ramActions' => [], + 'resourceTypes' => [], ], ]; |